file src/logger.cpp

[No description available] More…

Namespaces

Name
Gambit
TODO: see if we can use this one:
Gambit::Logging
Forward declare minimial logging components needed to use logger.

Classes

Name
structGambit::Logging::ensure_construction_order

Detailed Description

Author:

Date:

  • 2014 Mar
  • 2014 Mar

Master source file for Gambit logging

The LogMaster object is statically declared here, so this should be in its own compilation unit. The function defined here lets you retrieve this static log object in the other compilation units. To use this function, include the header “log.hpp” in your file.

Authors (add name and date if you modify):

Source code 

//   GAMBIT: Global and Modular BSM Inference Tool
//   *********************************************
///  \file
///
///  Master source file for Gambit logging
///
///  The LogMaster object is statically declared
///  here, so this should be in its own compilation
///  unit. The function defined here lets you
///  retrieve this static log object in the other
///  compilation units. To use this function,
///  include the header "log.hpp" in your file.
///
///  *********************************************
///
///  Authors (add name and date if you modify):
///   
///  \author Ben Farmer
///          (benjamin.farmer@monash.edu.au)
///  \date 2014 Mar
///
///  \author Pat Scott
///          (patscott@physics.mcgill.ca)
///  \date 2014 Mar
///
///  *********************************************

#include "gambit/Logs/logger.hpp"    // Forward declaration of retriever function 'logger()' and helper functions
#include "gambit/Logs/logmaster.hpp" // Full declaration of LogMaster class
#include "gambit/Logs/logging.hpp"

namespace Gambit
{
  namespace Logging
  {
     // This is an empty struct that I use simple to ensure that the logger LogTag "catalogues" are constructed before the logger itself. This ensures that they are destructed *after* the logger, which is important because we need them to exist during destruction of the logger.
     struct ensure_construction_order
     {
       ensure_construction_order()
       {
         // call the functions which retrieve the catalogues/maps, thus ensuring those objects are constructed.
         msgtypes();
         flags();
         components();
         tag2str();
       }
     };
     
     /// {@ Stream functions overloads for working with the logger

     /// @{ Stream functions for use with LogMaster
     LogMaster& operator<<(LogMaster& logobj, const std::string& in)
     {
        logobj.input(in);
        return logobj;
     }

     /// Handle LogTag input
     LogMaster& operator<<(LogMaster& logobj, const LogTag& tag)
     {
        logobj.input(tag);
        return logobj;
     }

     /// Handle end of message character
     LogMaster& operator<<(LogMaster& logobj, const endofmessage& eom)
     {
        logobj.input(eom);
        return logobj;
     }

     /// Handle various stream manipulators
     LogMaster& operator<<(LogMaster& logobj, const manip1 fp)
     {
        logobj.input(fp);
        return logobj;
     }

     LogMaster& operator<<(LogMaster& logobj, const manip2 fp)
     {
        logobj.input(fp);
        return logobj;
     }

     LogMaster& operator<<(LogMaster& logobj, const manip3 fp)
     {
        logobj.input(fp);
        return logobj;
     }

     /// @}
  }
 
  // Log retriever function
  Logging::LogMaster& logger()
  {
      // I assume that these being static, the constructor for x will only get called once.
      // With the LogMaster constructed last out of these object, it should be destructed first, thus the other objects should be available for use in the LogMaster destructor.
      static Logging::ensure_construction_order x;
      static Logging::LogMaster global_log;
      return global_log;
  }

} // end namespace Gambit

Updated on 2023-06-26 at 21:36:54 +0000