muo_logging.h

Go to the documentation of this file.

/*
 * Copyright (C) 2001 Karsten Reincke <reincke@gnukose.org>
 *  
 * 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 program 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *  
 * file <muo_logging.h> version <#1.3.1#> of project <MrProjext>
 */   

#ifndef  MUO_LOGGING_H
#define  MUO_LOGGING_H

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <string>
#include <stdio.h>
#include <stdlib.h>
/* &&& exported preprocessor-defines &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&& */
#define SHOW_NO_MESSAGES 0 
#define SHOW_NM 0  
#define SHOW_SIGNALS 1  
#define SHOW_SM 1 
#define SHOW_SIGNALS_AND_DESCRIPTIONS 2 
#define SHOW_SMADM 2  
#define SHOW_SIGNALS_DESCRIPTIONS_AND_HINTS 3 
#define SHOW_SMADMAHM 3 

#define USE_SHARED_LOGFILE true 
#define USE_OWN_LOGFILE false  
#define WITH_SCREEN_MESSAGES true 
#define WITHOUT_SCREEN_MESSAGES false  

#define USE_TWOLINES true 
#define USE_ONELINE false 
#define SIGNAL_MESSAGE 1  
#define SMESS 1           
#define SM 1              
#define DESCRIPTION_MESSAGE 2 
#define DMESS 2               
#define DM 2                  
#define HINT_MESSAGE 3  
#define HMESS 3         
#define HM 3            
/* &&& class-declarations &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&& */

using namespace std;

namespace krmuo
{

class LoggingUnit
{
  /* &&& attributes &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&& */
  public:
  private:
    unsigned int mMaxVisibleMessageLevel;
    FILE *mScreen;
    const string mLogFileName;
    FILE *mFile;
    bool mUsesSharedLoggingFile;
  protected:
  
  /* &&& methods &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&& */
  
  public:
  
    /* :-: public constructors / init / operators :-:-:-:-:-:-:-: */
    
    LoggingUnit
    ( const unsigned int pMaxVisibleMessageLevel,
      FILE *pScreen);

    LoggingUnit
    ( const unsigned int pMaxVisibleMessageLevel,
      const string& pLogFileName,
      const bool pUsesSharedLoggingFile);
    
    LoggingUnit
    ( const unsigned int pMaxVisibleMessageLevel,
      FILE *pScreen, 
      const string& pLogFileName,
      const bool pUsesSharedLoggingFile);
    
    ~LoggingUnit();                      
          
    /* :-: public getter :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
    /* :-: public setter :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */ 
    inline void turnOffScreenWriting() { mScreen=NULL; };
    
    /* :-: public others :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
    void makeEntry( const string& pLogString,
                    const unsigned int pLogEntryLevel) const;
    void makeEntry( const string& pLogString1,
                    const string& pLogString2, 
                    const unsigned int pLogEntryLevel) const;

    void makeEntry( const string& pLogString1,
                    const string& pLogString2, 
                    const string& pLogString3, 
                    const unsigned int pLogEntryLevel) const;

    void makeEntry( const string& pLogString1,
                    const string& pLogString2,
                    const unsigned int pLogEntryLevel,
                    bool pTwoLine) const;
    void makeEntry( const string& pLogString1,
                    const string& pLogString2,
                    const string& pLogString3,
                    const unsigned int pLogEntryLevel,
                    bool pTwoLine) const;
    void makeEntry( const string& pLogString,
                    const unsigned int pLogUInt, 
                    const unsigned int pLogEntryLevel) const;
    void makeEntry( const string& pLogString,
                    const int pLogInt, 
                    const unsigned int pLogEntryLevel) const;
    
  private:
    /* :-: private constructors / init / operators :-:-:-:-:-:-: */
     LoggingUnit(const LoggingUnit& co);     
    /* :-: private getter -:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
    /* :-: private setter -:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
    /* :-: private others -:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
    void fillTimeLabel(string& pTimeLabel) const;
  protected:
    /* :-: protected getter :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
    /* :-: protected setter :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
    /* :-: protected others :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
  
};
class LoggingSuitcase
{
  /* &&& attributes &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&& */
  public:
  private:
    LoggingUnit mActionLoggingUnit;
    LoggingUnit mWarnLoggingUnit;
    LoggingUnit mErrorLoggingUnit;
  protected:
  
  /* &&& methods &&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&& */
  
  public:
  
    /* :-: public constructors / init / operators :-:-:-:-:-:-:-: */

    LoggingSuitcase
    ( const unsigned int pActionMessageLevel,
      const unsigned int pErrorMessageLevel
    );                       
    
    LoggingSuitcase
    ( const unsigned int pShowActionMessages,
      const unsigned int pShowErrorMessages,
      const string& pLogDirPath,
      const string& pLogFileNameKernel,
      bool pUsesSharedLoggingFile
    );
        
    LoggingSuitcase
    ( const unsigned int pShowActionMessages,
      const unsigned int pShowErrorMessages,
      bool pWithScreenMessages,
      const string& pLogDirPath,
      const string& pLogFileNameKernel,
      bool pUsesSharedLoggingFile
    );

    ~LoggingSuitcase();                      
        
  
    /* :-: public getter :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
    /* :-: public setter :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
    
    inline void turnOffScreenWriting() 
    { 
      mErrorLoggingUnit.turnOffScreenWriting();
      mWarnLoggingUnit.turnOffScreenWriting();
      mActionLoggingUnit.turnOffScreenWriting();
    };
    
    
    /* :-: public others :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
    
    inline
    void makeActionLogEntry
    ( const string& pLogString,
      const unsigned int pLogEntryLevel
    )const
    {
      mActionLoggingUnit.makeEntry(pLogString,pLogEntryLevel);
    }

    inline
    void makeActionLogEntry
    ( const string& pLogString1,
      const string& pLogString2,
      const unsigned int pLogEntryLevel
    )const
    {
      mActionLoggingUnit.makeEntry(pLogString1,pLogString2,pLogEntryLevel);
    }
    
    inline
    void makeActionLogEntry
    ( const string& pLogString1,
      const string& pLogString2,
      const unsigned int pLogEntryLevel,
      bool pTwoLine
    )const
    {
      mActionLoggingUnit.makeEntry(pLogString1,pLogString2,pLogEntryLevel,pTwoLine);
    }
    
    inline
    void makeActionLogEntry
    ( const string& pLogString,
      const unsigned int pLogUInt,
      const unsigned int pLogEntryLevel
    )const
    {
      mActionLoggingUnit.makeEntry(pLogString,pLogUInt,pLogEntryLevel);
    }

    inline
    void makeActionLogEntry
    ( const string& pLogString,
      const int pLogInt,
      const unsigned int pLogEntryLevel
    )const
    {
      mActionLoggingUnit.makeEntry(pLogString,pLogInt,pLogEntryLevel);
    }

    inline
    void makeWarnLogEntry
    ( const string& pLogString,
      const unsigned int pLogEntryLevel
    )const
    {
      mWarnLoggingUnit.makeEntry(pLogString,pLogEntryLevel);
    }

    inline
    void makeWarnLogEntry
    ( const string& pLogString1,
      const string& pLogString2,
      const unsigned int pLogEntryLevel
    )const
    {
      mWarnLoggingUnit.makeEntry(pLogString1,pLogString2,pLogEntryLevel);
    }
    
    inline
    void makeWarnLogEntry
    ( const string& pLogString1,
      const string& pLogString2,
      const unsigned int pLogEntryLevel,
      bool pTwoLine
    )const
    {
      mWarnLoggingUnit.makeEntry(pLogString1,pLogString2,pLogEntryLevel,pTwoLine);
    }
    
    inline
    void makeWarnLogEntry
    ( const string& pLogString,
      const unsigned int pLogUInt,
      const unsigned int pLogEntryLevel
    )const
    {
      mWarnLoggingUnit.makeEntry(pLogString,pLogUInt,pLogEntryLevel);
    }

    inline
    void makeWarnLogEntry
    ( const string& pLogString,
      const int pLogInt,
      const unsigned int pLogEntryLevel
    )const
    {
      mWarnLoggingUnit.makeEntry(pLogString,pLogInt,pLogEntryLevel);
    }
    
    inline
    void makeErrorLogEntry
    ( const string& pLogString,
      const unsigned int pLogEntryLevel
    )const
    {
      mErrorLoggingUnit.makeEntry(pLogString,pLogEntryLevel);
    }

    inline
    void makeErrorLogEntry
    ( const string& pLogString1,
      const string& pLogString2,
      const unsigned int pLogEntryLevel
    )const
    {
      mErrorLoggingUnit.makeEntry(pLogString1,pLogString2,pLogEntryLevel);
    }
    
    inline
    void makeErrorLogEntry
    ( const string& pLogString1,
      const string& pLogString2,
      const unsigned int pLogEntryLevel,
      bool pTwoLine
    )const
    {
      mErrorLoggingUnit.makeEntry(pLogString1,pLogString2,pLogEntryLevel,pTwoLine);
    }
    
    inline
    void makeErrorLogEntry
    ( const string& pLogString,
      const unsigned int pLogUInt,
      const unsigned int pLogEntryLevel
    )const
    {
      mErrorLoggingUnit.makeEntry(pLogString,pLogUInt,pLogEntryLevel);
    }

    inline
    void makeErrorLogEntry
    ( const string& pLogString,
      const int pLogInt,
      const unsigned int pLogEntryLevel
    )const
    {
      mErrorLoggingUnit.makeEntry(pLogString,pLogInt,pLogEntryLevel);
    }
    
  private:
    /* :-: private constructors / init / operators :-:-:-:-:-:-: */
     LoggingSuitcase(const LoggingSuitcase& co);     
    /* :-: private getter -:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
    /* :-: private setter -:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
    /* :-: private others -:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
      
  protected:
    /* :-: protected getter :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
    /* :-: protected setter :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
    /* :-: protected others :-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-:-: */
  
};

}
#endif

---