StRoot: StUtilities/StMessageManager.h Source File

00001 
00015 #ifndef ClassStMessageManager
00016 #define ClassStMessageManager
00017 
00018 #include "StMessage.h"
00019 #include "StMessTypeList.h"
00020 #include "StMessageCounter.h"
00021 
00022 #ifndef ClassMessVec
00023 #define ClassMessVec
00024 typedef StVector(StMessage*) messVec;
00025 typedef StVector(StMessage*)::iterator messVecIter;
00026 typedef StVector(messVec*) messTypeVec;
00027 #endif
00028 
00029 #include "StMessMgr.h"
00030 
00031 class StMessageManager : public StMessMgr {
00032 
00033  private:
00034    static StMessMgr* mInstance;       
00035    StMessTypeList* messTypeList;      
00036    StMessageCounter* messCounter;     
00037    char* curType;                     
00038    char* curOpt;                      
00039    int building;
00040    int remember;
00041 
00042  protected:
00043    StMessageManager();
00044    StMessageManager(const StMessageManager&);
00045    messVec messList;
00046    messTypeVec messCollection;
00047    virtual messVecIter FindMessageIter(const char* s1, const char* s2="",
00048          const char* s3="", const char* s4="", messVec* list=0);
00049    virtual        void BuildMessage(const char* mess="", const char* type="",
00050          const char* opt=0);
00051    virtual void IgnoreRepeats() { StMessage::IgnoreRepeats(); }
00052    virtual void AllowRepeats() { StMessage::AllowRepeats(); }
00053 
00054 
00055  public:
00056    virtual ~StMessageManager();
00057    static StMessMgr* Instance();      
00058 
00059    virtual std::ostream& OperatorShift(std::ostream& os, StMessage* stm);
00060 
00061 // Generic Messages:
00062    virtual ostrstream& Message(const char* mess="", const char* type="",
00063          const char* opt=0,const char *sourceFileName=0, int lineNumber=-1);
00064    virtual       void Print();
00065    virtual        int PrintList(messVec* list);
00066    virtual        int PrintAll() {return PrintList(&messList); }
00067    virtual const messVec* GetAll() {return (&messList);}
00068    virtual StMessage* FindMessage(const char* s1, const char* s2="",
00069          const char* s3="", const char* s4="", messVec* list=0);
00070    virtual   messVec* FindMessageList(const char* s1, const char* s2="",
00071          const char* s3="", const char* s4="", messVec* list=0);
00072    virtual        int RemoveMessage(StMessage* mess);
00073    virtual        int RemoveMessage(const char* s1, const char* s2="",
00074          const char* s3="", const char* s4="")
00075          {return RemoveMessage(FindMessage(s1,s2,s3,s4));}
00076    virtual       void SetLimit(const char* str, int n=0)
00077          {messCounter->SetLimit(str,n);}
00078    virtual        int GetLimit(const char* str)
00079          {return messCounter->GetLimit(str);}
00080    virtual       void ListLimits() {messCounter->ListLimits();}
00081    virtual       void RemoveLimit(const char* str) {SetLimit(str,-1);}
00082    virtual       void SetLevel(Int_t logLevel);
00083    virtual      Int_t GetLevel(Int_t logLevel) const;
00084    virtual const char *GetName() const;
00085    virtual       void SwitchOff(const char* str) {SetLimit(str,0);}
00086    virtual       void SwitchOn(const char* str) {RemoveLimit(str);}
00087    virtual       void FixOn(const char* str) {SetLimit(str,-5);}
00088    virtual       void NoLimits() {messCounter->NoLimits();}
00089    virtual       void Summary(size_t nTerms=1);
00090    virtual       void MemorySummary();
00091    virtual       void MemoryOn() {remember=1;}
00092    virtual       void MemoryOff() {remember=0;}
00093    virtual        int AddType(const char* type, const char* text);
00094    virtual        int ListTypes() {return messTypeList->ListTypes();}
00095 
00096 // Info Messages:
00097    virtual ostrstream& Info(const char* mess="", const char* opt="O",const char *sourceFileName=0, int lineNumber=-1)
00098          { return Message(mess, "I", opt);}
00099    virtual        int PrintInfos() {return PrintList(messCollection[1]); }
00100    virtual const messVec* GetInfos() {return (messCollection[1]);}
00101    virtual StMessage* FindInfo(const char* s1, const char* s2="",
00102          const char* s3="", const char* s4="")
00103          {return FindMessage(s1,s2,s3,s4,messCollection[1]);}
00104    virtual messVec* FindInfoList(const char* s1, const char* s2="",
00105          const char* s3="", const char* s4="")
00106          {return FindMessageList(s1,s2,s3,s4,messCollection[1]);}
00107 
00108 // Warning Messages:
00109    virtual ostrstream& Warning(const char* mess="", const char* opt="E",const char *sourceFileName=0, int lineNumber=-1)
00110          { return Message(mess, "W", opt,sourceFileName,lineNumber);}
00111    virtual        int PrintWarnings() {return PrintList(messCollection[2]); }
00112    virtual const messVec* GetWarnings() {return (messCollection[2]);}
00113    virtual StMessage* FindWarning(const char* s1, const char* s2="",
00114          const char* s3="", const char* s4="")
00115          {return FindMessage(s1,s2,s3,s4,messCollection[2]);}
00116    virtual messVec* FindWarningList(const char* s1, const char* s2="",
00117          const char* s3="", const char* s4="")
00118          {return FindMessageList(s1,s2,s3,s4,messCollection[2]);}
00119 
00120 // Error Messages:
00121    virtual ostrstream& Error(const char* mess="", const char* opt="E",const char *sourceFileName=0, int lineNumber=-1)
00122          { return Message(mess, "E", opt,sourceFileName,lineNumber);}
00123    virtual        int PrintErrors() {return PrintList(messCollection[3]); }
00124    virtual const messVec* GetErrors() {return (messCollection[3]);}
00125    virtual StMessage* FindError(const char* s1, const char* s2="",
00126          const char* s3="", const char* s4="")
00127          {return FindMessage(s1,s2,s3,s4,messCollection[3]);}
00128    virtual messVec* FindErrorList(const char* s1, const char* s2="",
00129          const char* s3="", const char* s4="")
00130          {return FindMessageList(s1,s2,s3,s4,messCollection[3]);}
00131 
00132 // Debug Messages:
00133    virtual ostrstream& Debug(const char* mess="", const char* opt="OT",const char *sourceFileName=0, int lineNumber=-1)
00134          { return Message(mess, "D", opt,sourceFileName,lineNumber);}
00135    virtual        int PrintDebug() {return PrintList(messCollection[4]); }
00136    virtual const messVec* GetDebugs() {return (messCollection[4]);}
00137    virtual StMessage* FindDebug(const char* s1, const char* s2="",
00138          const char* s3="", const char* s4="")
00139          {return FindMessage(s1,s2,s3,s4,messCollection[4]);}
00140    virtual messVec* FindDebugList(const char* s1, const char* s2="",
00141          const char* s3="", const char* s4="")
00142          {return FindMessageList(s1,s2,s3,s4,messCollection[4]);}
00143 
00144 // QAInfo Messages:
00145    virtual ostrstream& QAInfo(const char* mess="", const char* opt="OS",const char *sourceFileName=0, int lineNumber=-1)
00146          { return Message(mess, "Q", opt,sourceFileName,lineNumber);}
00147    virtual        int PrintQAInfo() {return PrintList(messCollection[5]); }
00148    virtual const messVec* GetQAInfos() {return (messCollection[5]);}
00149    virtual StMessage* FindQAInfo(const char* s1, const char* s2="",
00150          const char* s3="", const char* s4="")
00151          {return FindMessage(s1,s2,s3,s4,messCollection[5]);}
00152    virtual messVec* FindQAInfoList(const char* s1, const char* s2="",
00153          const char* s3="", const char* s4="")
00154          {return FindMessageList(s1,s2,s3,s4,messCollection[5]);}
00155 
00156 // UCMInfo Messages:
00157    virtual ostrstream& UCMInfo(const char* mess="", const char* opt="OS",const char *sourceFileName=0, int lineNumber=-1)
00158          { return Message(mess, "U", opt,sourceFileName,lineNumber);}
00159    virtual        int PrintUCMInfo() {return PrintList(messCollection[6]); }
00160    virtual const messVec* GetUCMInfos() {return (messCollection[6]);}
00161    virtual StMessage* FindUCMInfo(const char* s1, const char* s2="",
00162          const char* s3="", const char* s4="")
00163          {return FindMessage(s1,s2,s3,s4,messCollection[6]);}
00164    virtual messVec* FindUCMInfoList(const char* s1, const char* s2="",
00165          const char* s3="", const char* s4="")
00166          {return FindMessageList(s1,s2,s3,s4,messCollection[6]);}
00167 
00168 // "As is" Messages:
00169    virtual ostrstream& out(const char* mess="")
00170          {return Message(mess,"I","OP-");}
00171    virtual ostrstream& err(const char* mess="")
00172          {return Message(mess,"E","EP-");}
00173 
00174    virtual       void PrintInfo();
00175 // Fatal Messages:
00176    virtual ostrstream& Fatal(const char* mess="", const char* opt="E",const char *sourceFileName=0, int lineNumber=-1)
00177    { return Message(mess, "E", opt,sourceFileName,lineNumber);}
00178 
00179 };
00180 
00181 
00182 #endif
00183 
00184 // $Id: StMessageManager.h,v 1.29 2009/06/22 22:36:01 fine Exp $
00185 // $Log: StMessageManager.h,v $
00186 // Revision 1.29  2009/06/22 22:36:01  fine
00187 // Add the new dedicated UCM logger, It should force the recompilation of many STAR packages
00188 //
00189 // Revision 1.28  2008/05/15 23:40:24  fine
00190 // Change the abstarct class return type to separate the different STAR streams
00191 //
00192 // Revision 1.27  2007/01/25 06:28:06  fine
00193 // connect Logger and Maker debug levels
00194 //
00195 // Revision 1.26  2007/01/25 06:11:37  fine
00196 // Add the new StMess abstarct interfaces GetLevel/SetLevel
00197 //
00198 // Revision 1.25  2004/04/15 21:28:02  fine
00199 // Remove the redundant StMessageManager RootCint dictionary. User shoudl use the base StMessMgr class anyway
00200 //
00201 // Revision 1.24  2004/04/15 16:03:38  fine
00202 // move StMessMgr class to St_base and change the interface
00203 //
00204 // Revision 1.22  2004/01/28 00:09:14  genevb
00205 // Messages (except Debug) default to no time-date stamp
00206 //
00207 // Revision 1.21  2003/09/25 21:19:22  genevb
00208 // Some new cout-like functions and friend functions, some doxygen-ization
00209 //
00210 // Revision 1.20  2001/05/14 20:53:20  genevb
00211 // Add features to examine memory use, switch from TDatime to time_t
00212 //
00213 // Revision 1.19  2000/06/07 00:05:36  genevb
00214 // Added FixOn(), enforcing no limits on a specific message type/string
00215 //
00216 // Revision 1.18  2000/05/23 19:03:38  genevb
00217 // Correct interface for MessageOut(), update docs
00218 //
00219 // Revision 1.17  2000/03/30 16:12:55  genevb
00220 // Add NoLimits() capability to turn off message limiting.
00221 //
00222 // Revision 1.16  2000/02/29 16:41:57  genevb
00223 // Fortran-compliant interface
00224 //
00225 // Revision 1.15  2000/01/25 16:01:29  fisyak
00226 // Devorce with StAF
00227 //
00228 // Revision 1.14  2000/01/05 19:53:46  genevb
00229 // Fixed CC5 warnings, and several other small improvements under the hood
00230 //
00231 // Revision 1.13  1999/08/10 22:07:35  genevb
00232 // Added QAInfo message types
00233 //
00234 // Revision 1.12  1999/07/23 16:56:40  genevb
00235 // Fix extern C prototypes, default options for omitted types, Linux bug with multi-line messages
00236 //
00237 // Revision 1.11  1999/07/17 00:23:24  genevb
00238 // Fixed bug when option fields are empty in FORTRAN, and let type limits be set before types are even added
00239 //
00240 // Revision 1.10  1999/07/08 22:58:18  genevb
00241 // Created an abstract interface with StMessMgr.h hiding template implementation from others, a few other small fixes
00242 //
00243 // Revision 1.9  1999/07/01 23:32:53  genevb
00244 // Change default message typing
00245 //
00246 // Revision 1.8  1999/07/01 01:24:46  genevb
00247 // Fixed FORTRAN character string bug on linux, removed a memory leak from Summary()
00248 //
00249 // Revision 1.7  1999/06/29 23:32:42  genevb
00250 // Handle multi-line calls to fortran routines better
00251 //
00252 // Revision 1.5  1999/06/28 15:42:13  genevb
00253 // Added Debug message class
00254 //
00255 // Revision 1.4  1999/06/28 02:40:56  genevb
00256 // Additional backward compatibilit with MSG (msg_enable, msg_enabled, msg_disable
00257 //
00258 // Revision 1.3  1999/06/24 23:23:59  genevb
00259 // Added message call for compatibility with old fortran code
00260 //
00261 // Revision 1.2  1999/06/24 16:30:43  genevb
00262 // Fixed some memory leaks
00263 //
00264 // Revision 1.1  1999/06/23 15:17:53  genevb
00265 // Introduction of StMessageManager
00266 //
00267 //