IMessageSvc.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#pragma once
 
#include <GaudiKernel/IInterface.h>
#include <iostream>
#include <string>
 
class StatusCode;
class Message;

namespace MSG {
  enum Level { NIL = 0, VERBOSE, DEBUG, INFO, WARNING, ERROR, FATAL, ALWAYS, NUM_LEVELS };
  enum Color { BLACK = 0, RED, GREEN, YELLOW, BLUE, PURPLE, CYAN, WHITE, NUM_COLORS };
} // namespace MSG

class GAUDI_API IMessageSvc : virtual public IInterface {
public:
  DeclareInterfaceID( IMessageSvc, 2, 0 );

  virtual void reportMessage( const Message& msg, int outputLevel ) = 0;

  virtual void reportMessage( const Message& message ) = 0;

  virtual void reportMessage( const StatusCode& code, std::string_view source = "" ) = 0;

  virtual void reportMessage( std::string source, int type, std::string message ) = 0;

  virtual void insertMessage( const StatusCode& code, Message message ) = 0;

  virtual void eraseMessage() = 0;

  virtual void eraseMessage( const StatusCode& code ) = 0;

  virtual void eraseMessage( const StatusCode& code, const Message& message ) = 0;

  virtual void insertStream( int type, std::string name, std::ostream* stream ) = 0;

  virtual void eraseStream() = 0;

  virtual void eraseStream( int message_type ) = 0;

  virtual void eraseStream( int type, std::ostream* stream ) = 0;

  virtual void eraseStream( std::ostream* stream ) = 0;

  virtual std::ostream* defaultStream() const = 0;

  virtual void setDefaultStream( std::ostream* stream ) = 0;

  virtual int outputLevel() const = 0;

  virtual int outputLevel( std::string_view source ) const = 0;

  virtual void setOutputLevel( int new_level ) = 0;

  virtual void setOutputLevel( std::string_view source, int new_level ) = 0;

  virtual bool useColor() const = 0;

  virtual std::string getLogColor( int logLevel ) const = 0;

  virtual int messageCount( MSG::Level level ) const = 0;
};
 
class GAUDI_API IInactiveMessageCounter : virtual public IInterface {
public:
  DeclareInterfaceID( IInactiveMessageCounter, 2, 0 );

  virtual void incrInactiveCount( MSG::Level level, std::string_view src ) = 0;
};