JobCMsgModule.cxx

Go to the documentation of this file.

// $Id: JobCMsgModule.cxx,v 1.10 2005/03/03 19:34:39 tagg Exp $
//
// A job module to configure the message service
//
// messier@huhepl.harvard.edu
#include "JobControl/JobCMsgModule.h"
#include <list>
#include <string>
#include <cstring> // strcmp, strlen
#include "MessageService/MsgService.h"
#include "JobControl/JobCommand.h"
#include "JobControl/JobCModuleRegistry.h" // JOBCMODULE macro

CVSID("$Id: JobCMsgModule.cxx,v 1.10 2005/03/03 19:34:39 tagg Exp $");
JOBMODULE(JobCMsgModule,"Msg","Configure the message service");

//......................................................................

static void sorry() 
{
  MSG("JobC", Msg::kWarning) << "Sorry, command not implemented\n";
}

//......................................................................

JobCMsgModule::JobCMsgModule() {}

//......................................................................

JobCMsgModule::~JobCMsgModule() {}

//......................................................................

void JobCMsgModule::Attach(const char* msgstream, const char* os)
{
//======================================================================
// Purpose: Attach an output stream to a given message stream. Expected
// order of options: <msg_stream_name>::<log_level> <output_stream>
//  
// Inputs: cmd - the job command
//======================================================================
  if (msgstream == 0 || os == 0 ) {
    MSG("JobC", Msg::kWarning) <<
      "usage: /" << this->GetName() << "/Attach <stream> <level> <ostream>\n";
    return;
  }
  else {
    string stream; // Which stream?
    string level;  // Which priority?
    MsgStream *m;
    
    JobCommand::SplitLine(msgstream, ':', stream, level);
    Msg::LogLevel_t lvl = Msg::GetLevelCode(level.c_str());
    
    m = MsgService::Instance()->GetStream(stream.c_str());
    m->AttachOStream(lvl,os);
  }
}

//......................................................................

void JobCMsgModule::Concat()
{ 
  sorry(); 
}

//......................................................................

void JobCMsgModule::Format(const char* msgstream,
                           const char* fmtflags,
                           bool raiseFlag)
{
//======================================================================
// Purpose: Set format flags for a given message stream.
// 
// Inputs: 
//   msgstream : The stream to affect. Format is <msgname>::<loglevel>
//   fmtflags  : List of format flags to affect (space, comma, sepatated)
//   raiseFlag : true=raise the format flags, false=lower the flags
//======================================================================
  string stream;
  string level;
  MsgStream *ms;
  Msg::LogLevel_t lvl;

  JobCommand::SplitLine(msgstream, ':', stream, level);
  ms = MsgService::Instance()->GetStream(stream.c_str());
  
  lvl = 0;
  lvl = Msg::GetLevelCode(level.c_str());

  // Walk over the input string and strip out the individual format flags
  vector<string> fmtlist;
  JobCommand::StringTok(fmtlist,fmtflags," +,");
  vector<string>::iterator itr(fmtlist.begin());
  vector<string>::iterator itrEnd(fmtlist.end());
  for (; itr!=itrEnd; ++itr) {
    int format = Msg::GetFormatCode( (*itr).c_str() );   
    if (raiseFlag) { ms->AddFormat(lvl,format);    }
    else           { ms->RemoveFormat(lvl,format); }
  }
}

//......................................................................

void JobCMsgModule::SetDefaultFormat(const char* fmtflags,
                                     const char* level )
{
//======================================================================
// Purpose: Sets the default format flags for all newly created streams
// 
// Inputs: 
//   fmtflags  : List of format flags to affect (space, comma, sepatated)
//   level     : What format level. Blank = all levels
//======================================================================
  Int_t lvl;

  lvl = Msg::GetLevelCode(level);
  if(lvl==-1) lvl=99;

  // Walk over the input string and strip out the individual format flags
  int format = 0;
  vector<string> fmtlist;
  JobCommand::StringTok(fmtlist,fmtflags," +,");
  vector<string>::iterator itr(fmtlist.begin());
  vector<string>::iterator itrEnd(fmtlist.end());
  for (; itr!=itrEnd; ++itr) {
    format |= Msg::GetFormatCode( (*itr).c_str() );   
  }

  MsgService::Instance()->SetDefaultFormat(format,lvl);

}

//......................................................................

void JobCMsgModule::HandleCommand(JobCommand *cmd) 
{
//======================================================================
// Purpose: Handle a command related to the message service
// configuration
//
// Inputs: cmd - a job command
//======================================================================
  string c = cmd->PopCmd();

  if (c == "SetLevel")   {
    const char *stream = cmd->PopOpt();
    const char *level  = cmd->PopOpt();
    this->SetLevel(stream, level);
    return;
  }
  if (c == "Attach") {
    const char *stream = cmd->PopOpt();
    const char *os     = cmd->PopOpt();
    this->Attach(stream, os);
    return;
  }
  if (c == "Format") {
    std::string stream = cmd->PopOpt();
    std::string flags  = cmd->PopOpt();
    std::string add    = cmd->PopOpt();
    if (add == "Remove") {
      this->Format(stream.c_str(), flags.c_str(), false);
    }
    else {
      this->Format(stream.c_str(), flags.c_str(), true);
    }
    return;
  }
  if (c == "Concat") {
    this->Concat();
    return;
  }
  if (c == "Report") {
    this->Report();
    return;
  }
  if (c == "Stats") {
    this->Stats();
    return;
  }
  else {
    MSG("JobC",Msg::kWarning) << 
      "Module " << this->GetName() << 
      " does not implement command " << c << "." << endl;    
  }
}

//......................................................................

void JobCMsgModule::Help() 
{
//======================================================================
// Purpose: Print help for this module
//======================================================================
#define _NL_ <<"\n"<<
  const char *n = this->GetName();
  MSG("JobC",Msg::kInfo) <<
    "Help for '" << this->GetName() << "' module:\n" <<
    " " << this->GetName() << 
    " is a module for configuring the message service. It can be used" _NL_
    " to set log levels, direct output, set formats etc. for the" _NL_
    " various package streams. For example, to lower the print" _NL_
    " threshold for the stream 'Trk' use:" _NL_
    " /Msg/SetLevel Trk Debug" _NL_
    "" _NL_
    " Possible commands are:" _NL_
    "" _NL_
    " /" << n << "/SetLevel <stream> <level>" _NL_
    "" _NL_
    "  Set the log level for <stream> to <level> where <level> is" _NL_
    "  Verbose,Debug,Info,Error,Warning,Fatal" _NL_
    "" _NL_
    " /" << n << "/Attach <stream>::<loglevel> <ostream>" _NL_
    "" _NL_
    "  Attach the output stream <ostream> to the list of output streams" _NL_
    "  messages sent to <stream> of type <loglevel> get send to." _NL_
    "  <ostream> can be cout, cerr, clog, or file name. <loglevel> can" _NL_
    "  be Verbose, Debug, Info, Warning, Error, Fatal, or All." _NL_
    "" _NL_
    " /" << n << "/Format <stream>::<loglevel> <Add/Remove> <format>" _NL_
    "" _NL_
    "  Add/Remove additional tags to messages. Possibilities are:" _NL_
    "  Priority, Time, File, CVSId, Line, Host, and PID."  << 
    "" _NL_ endl;
}

//......................................................................

void JobCMsgModule::Stats()
{  
  MsgService::Instance()->PrintStatistics();
}

//......................................................................

void JobCMsgModule::Report() 
{  
  cerr << (*MsgService::Instance());
}

//......................................................................

void JobCMsgModule::Reset() 
{ 
  sorry(); 
}

//......................................................................

void JobCMsgModule::SetLevel(const char* stream, const char* level)
{
//======================================================================
// Purpose: Set the print threshold for a given stream. Expects options
// in the following order: <stream_name> <level>
//
// Inputs: cmd - job command
//======================================================================
  MsgStream *s = MsgService::Instance()->GetStream(stream);
  if (s==0) {
    MSG("JobC", Msg::kWarning) <<
      "Can not find message stream " << stream << "." << endl;
    return;
  }
  
  Msg::LogLevel_t lvl = Msg::GetLevelCode(level);
  if (lvl>=0) {
    MSG("JobC", Msg::kDebug) << 
      "Setting level '" << level << "' for stream " << stream << "\n";
    s->SetLogLevel(lvl);
  }
  else {
    MSG("JobC", Msg::kInfo) << 
      "'" << level << "' is not valid log level. " <<
      "Using default log level 'Info'" << endl;
    s->SetLogLevel(Msg::kInfo);
  }
}

---