program_wide_logger.h

Go to the documentation of this file.

#ifndef PROGRAM_WIDE_LOGGER_GROUP
#define PROGRAM_WIDE_LOGGER_GROUP

/*****************************************************************************\
*                                                                             *
*  Name   : program_wide_logger facility                                      *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 1992-$now By Author.  This program is free software; you can  *
* redistribute it and/or modify it under the terms of the GNU General Public  *
* License as published by the Free Software Foundation; either version 2 of   *
* the License or (at your option) any later version.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/

#include "build_configuration.h"

// forward.
class locked_logger;
class log_base;

/* @file program_wide_logger.h
 Provides a per-program logging subsystem that can be used from almost
 anywhere in the source code.  It is important that the very lowest-level
 code in basis not do pwl-logging, since those classes are used to implement
 the program wide logger.
*/

// the program wide logger feature is a globally defined log_base object that
// can be switched out to perform different types of logging.

/*
 // a clue for static applications; gendeps will still see the include.
 #include <loggers/program_wide_logger.cpp>
*/

#ifndef OMIT_PROGRAM_WIDE_LOGGER
  log_base BASIS_EXTERN &program_wide_logger();

  locked_logger BASIS_EXTERN &real_program_wide_logger();

  log_base BASIS_EXTERN *retask_program_wide_logger(log_base *new_logger);

#else
  // faux logger for when we don't want to have all the machinery hooked in.
  #define program_wide_logger real_program_wide_logger
  #include <stdio.h>
  #ifndef __WIN32__
    #define EOL_FOR_LOCKED_LOGGER "\n"
  #else
    #define EOL_FOR_LOCKED_LOGGER "\r\n"
  #endif
  class locked_logger : public virtual object_base
  { public: IMPLEMENT_CLASS_NAME("locked_logger");
    outcome log(const istring &s, int formal(filt) = 0)
        { printf("%s" EOL_FOR_LOCKED_LOGGER, s.s()); return common::OKAY; }
    bool member(int formal(to_check)) { return true; }
    void eol(int formal(to_set)) {}
  };
  locked_logger BASIS_EXTERN &real_program_wide_logger();
#endif

#endif // outer guard.

---