BESDebug.h

// BESDebug.h
 
// This file is part of bes, A C++ back-end server implementation framework
// for the OPeNDAP Data Access Protocol.
 
// Copyright (c) 2004-2009 University Corporation for Atmospheric Research
// Author: Patrick West <pwest@ucar.edu> and Jose Garcia <jgarcia@ucar.edu>
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
//
// You can contact University Corporation for Atmospheric Research at
// 3080 Center Green Drive, Boulder, CO 80301
 
// (c) COPYRIGHT University Corporation for Atmospheric Research 2004-2005
// Please read the full copyright statement in the file COPYRIGHT_UCAR.
//
// Authors:
//      pwest       Patrick West <pwest@ucar.edu>
//      jgarcia     Jose Garcia <jgarcia@ucar.edu>

 
#ifndef I_BESDebug_h
#define I_BESDebug_h 1
 
#include <iostream>
#include <map>
#include <string>
#include <mutex>
 
// Helper function for writing debug log lines
std::string get_debug_log_line_prefix();
 
static std::mutex bes_debug_log_mutex;

#ifdef NDEBUG
#define BESDEBUG( x, y )
#else
#define BESDEBUG( x, y ) do { if( BESDebug::IsSet( x ) ) *(BESDebug::GetStrm()) << get_debug_log_line_prefix() << "["<< x << "] " << y ; } while( 0 )
#endif // NDEBUG
 
#ifdef NDEBUG
#define BESISDEBUG( x ) (false)
#else
#define BESISDEBUG( x ) BESDebug::IsSet( x )
#endif
 
class BESDebug {
private:
    // The time to make 10000000 calls to IsSet with a std::map was 3 763 862 us and
    // to make the same calls to IsSet with a std::unordered_map was 2 675 492 us
    // jhrg 4/12/23
    // typedef std::unordered_map<std::string, bool> DebugMap;
    using DebugMap = std::map<std::string, bool>;
 
    static DebugMap _debug_map;
    static std::ostream *_debug_strm;
    static bool _debug_strm_created;
 
public:
    static const DebugMap &debug_map()
    {
        return _debug_map;
    }
 
    // Moved to the .cc file to avoid <algorithm> in a header file. jhrg 4/14/23
    static void Set(const std::string &flagName, bool value);

    static void Register(const std::string &flagName)
    {
        auto i = _debug_map.find(flagName);
        if (i == _debug_map.end()) {
            auto a = _debug_map.find("all");
            if (a == _debug_map.end()) {
                _debug_map[flagName] = false;
            }
            else {
                _debug_map[flagName] = true;
            }
        }
    }

    static bool IsSet(const std::string &flagName)
    {
        auto i = _debug_map.find(flagName);
        if (i != _debug_map.end())
            return (*i).second;
        else
            i = _debug_map.find("all");
 
        if (i != _debug_map.end())
            return (*i).second;
        else
            return false;
    }

    static std::ostream * GetStrm()
    {
        return _debug_strm;
    }

    static void SetStrm(std::ostream *strm, bool created)
    {
        if (_debug_strm_created && _debug_strm) {
            _debug_strm->flush();
            delete _debug_strm;
            _debug_strm = nullptr;
        }
        else if (_debug_strm) {
            _debug_strm->flush();
        }
        if (!strm) {
            _debug_strm = &std::cerr;
            _debug_strm_created = false;
        }
        else {
            _debug_strm = strm;
            _debug_strm_created = created;
        }
    }
 
    static void SetUp(const std::string &values);
    static void Help(std::ostream &strm);
    static bool IsContextName(const std::string &name);
    static std::string GetOptionsString();
};
 
#endif // I_BESDebug_h