StRoot: StUtilities/StMessage.cxx Source File

00001 
00002 //                                                                      //
00003 // StMessage                                                            //
00004 //                                                                      //
00005 // This is the class of messages used by StMessageManager in STAR.      //
00006 // Messages have a type and message specified at instantiation,         //
00007 // and also include a time-date stamp and options for printing.         //
00008 //                                                                      //
00010 
00011 #ifdef __ROOT__
00012 #include "TROOT.h"
00013 #endif
00014 #include <assert.h>
00015 #include <ctype.h>
00016 #include <string.h>
00017 #include "StMessage.h"
00018 #include "StMessageCounter.h"
00019 #include "Stsstream.h"
00020 #include "StMessageStream.h"
00021 
00022 static StMessageCounter* messCounter = StMessageCounter::Instance();
00023 
00024 static ostrstream messBuffer;
00025 static char space = ' ';
00026 static char tab = '\t';
00027 
00028 int StMessage::repeats=1;
00029 static ostrstream lastMessBuffer;
00030 
00031 #ifdef __ROOT__
00032 ClassImp(StMessage)
00033 #endif
00034 
00035 //_____________________________________________________________________________
00036 StMessage::StMessage(const char *mess, const char *ty, const char* opt) {
00037   time(&messTime);
00038   *type = *ty;
00039   type[1] = 0;
00040   SetOptions(opt);
00041 //  location = "Unknown";
00042 //  runNumber = 0;
00043   int len = strlen(mess);
00044   while (mess[--len] == space) {}     // remove trailing spaces
00045   message = new char[(++len + 1)];
00046   for (int i=0;i<len;i++) {
00047     message[i]=mess[i];
00048     if (mess[i]=='\n')          continue;
00049     if (mess[i]=='\t')          continue;
00050     if (!iscntrl(mess[i]))      continue;
00051     assert(0);
00052   }
00053   message[len]=0;
00054   Print(0);
00055 }
00056 //_____________________________________________________________________________
00057 StMessage::~StMessage() {
00058   delete [] message;
00059 }
00060 //_____________________________________________________________________________
00061 int StMessage::Print(int nChars) {
00062 //_nChars_:___mode__:_printing_
00063 //   <0   : view    : as intended, no limits, use options
00064 //   =0   : normal  : as intended, use limits, use options
00065 //   >0   : summary : stdout upto nChars/first endofline, no limits, no options
00066   static const char* leader = "St";
00067   static const char* insert0 = "";
00068   static const char* insert1 = ": ";
00069   static const char* insert2 = " <";
00070   static const char* insert3 = ">";
00071   static const char* endofline = "\n";
00072   int printIt=1;
00073   if (!nChars) {
00074     printIt = messCounter->CheckLimit(message,type);
00075   }
00076   messBuffer.seekp(0);
00077   if (printIt) {
00078     const char* insert;
00079     if (!(option & kMessOptP)) {
00080       if (!(option & kMessOptS)) messBuffer << leader;   // "No St" option
00081       const char* temp(StMessTypeList::Instance()->Text(type));
00082       if (temp) messBuffer << temp;
00083       insert = insert1;
00084     } else insert = insert0;
00085     if ((nChars != 0) && (strchr(message,tab))) {        // If nChars, replace
00086       char* message2 = new char[strlen(message)+1];      // tabs with spaces
00087       char* m0 = message;
00088       char* m1 = message2;
00089       while (*m0) {                                      // Go to end of string
00090         if (*m0==tab) *m1 = space;                       // tab => space,
00091         else *m1 = *m0;                                  // otherwise copy
00092         m0++; m1++;
00093       }
00094       *m1 = 0; 
00095       messBuffer << insert << message2;                  // ": ",message
00096       delete [] message2;
00097     } else {
00098       messBuffer << insert << message;                   // ": ",message
00099     }
00100     if (nChars<=0) {
00101       if (option & kMessOptT) {                          // "time" option
00102         char* temp2 = (ctime(&messTime) + 4);            // First 4 are day
00103         *(temp2 + 20) = 0;                               // 24th is end-line
00104         messBuffer << insert2 << temp2 << insert3 ;      // " (",time,")"
00105       }
00106       messBuffer << endofline;                           // "\n" end-line
00107     }
00108   }
00109   const char* addedMessage=0;
00110   if (nChars == 0) {
00111     addedMessage = messCounter->str();                   // Any limit message
00112   } else {
00113     if (nChars>0) {
00114       if (messBuffer.tellp() >= nChars)
00115         messBuffer.seekp(nChars-1);   // set end-of-string at nChars
00116       int noReturns = strcspn(messBuffer.str(),endofline);
00117       if (noReturns < messBuffer.tellp()) messBuffer.seekp(noReturns);
00118     } else
00119       nChars = 0;
00120   }
00121   messBuffer << ends;
00122   if (!repeats) {
00123     if (!strcmp(messBuffer.str(),lastMessBuffer.str())) {
00124       return messBuffer.tellp();
00125     } else {
00126       lastMessBuffer.seekp(0);
00127       lastMessBuffer << messBuffer.str() << ends;
00128     }
00129   }
00130   if ((option & kMessOptO) || (nChars != 0)) {
00131     myout << messBuffer.str();
00132     if (addedMessage) myout << addedMessage;
00133     myout.flush();
00134   }
00135   if ((option & kMessOptE) && (nChars == 0)) {
00136     myerr << messBuffer.str();
00137     if (addedMessage) myout << addedMessage;
00138     myerr.flush();
00139   }
00140   return messBuffer.tellp();
00141 }
00142 //_____________________________________________________________________________
00143 char* StMessage::GetOptions() const {
00144   static char optStr[32]; // Use single, static instance to avoid memory leak
00145   char* sPtr = optStr;
00146   if (option & kMessOptO) sprintf(sPtr++,"%c",'O');
00147   if (option & kMessOptE) sprintf(sPtr++,"%c",'E');
00148   if (option & kMessOptS) sprintf(sPtr++,"%c",'S');
00149   if (option & kMessOptT) sprintf(sPtr++,"%c",'T');
00150   if (option & kMessOptP) sprintf(sPtr++,"%c",'P');
00151   if (option & kMessOptDash) sprintf(sPtr++,"%c",'-');
00152   (*sPtr) = 0; // Terminate string
00153   return optStr;
00154 }
00155 //_____________________________________________________________________________
00156 void StMessage::SetOptions(const char* opt) {
00157   option = kMessOptNone;
00158   if (!opt) return;
00159   int len = strlen(opt);
00160   while (len--) {
00161     switch (toupper(opt[len])) {
00162       case ('O') : { option |= kMessOptO; break; }
00163       case ('E') : { option |= kMessOptE; break; }
00164       case ('S') : { option |= kMessOptS; break; }
00165       case ('T') : { option |= kMessOptT; break; }
00166       case ('P') : { option |= kMessOptP; break; }
00167       case ('-') : { option |= kMessOptDash; break; }
00168       default : {}
00169     }
00170   }
00171 }
00172 //_____________________________________________________________________________
00173 size_t StMessage::GetMemoryUsage() {
00174   size_t msize = strlen(message) + 1;
00175   msize += sizeof(*this);                   // Determine overhead
00176   return msize;
00177 }
00178 //_____________________________________________________________________________
00179 void StMessage::PrintInfo() {
00180   printf("**************************************************************\n");
00181   printf("* $Id: StMessage.cxx,v 1.27 2004/04/02 22:17:14 genevb Exp $\n");
00182 //  printf("* %s    *\n",m_VersionCVS);
00183   printf("**************************************************************\n");
00184 }
00185 //_____________________________________________________________________________
00186 int StMessage::InitBuffer() {
00187   // Initialize buffer with 1088 bytes.
00188   messBuffer << ch64 << ch64 << ch64 << ch64 << ch64 << ch64 << ch64 << ch64
00189      << ch64 << ch64 << ch64 << ch64 << ch64 << ch64 << ch64 << ch64 << ch64;
00190   return messBuffer.tellp();
00191 }
00192 
00193 int tmpp = StMessage::InitBuffer();
00194 
00195 //_____________________________________________________________________________
00196 // $Id: StMessage.cxx,v 1.27 2004/04/02 22:17:14 genevb Exp $
00197 // $Log: StMessage.cxx,v $
00198 // Revision 1.27  2004/04/02 22:17:14  genevb
00199 // Added protected Ignore/AllowRepeats() for friend StBFChain class
00200 //
00201 // Revision 1.26  2004/03/01 17:52:13  fisyak
00202 // Add include for assert (osf required)
00203 //
00204 // Revision 1.25  2004/01/28 00:09:14  genevb
00205 // Messages (except Debug) default to no time-date stamp
00206 //
00207 // Revision 1.24  2003/10/01 20:06:50  genevb
00208 // Initialize and test ostrstream buffer sizes (support for gcc before 3.2)
00209 //
00210 // Revision 1.23  2003/09/25 21:18:14  genevb
00211 // Changed option storage
00212 //
00213 // Revision 1.22  2003/09/22 01:30:41  perev
00214 //  some cleanup
00215 //
00216 // Revision 1.21  2003/09/02 17:59:20  perev
00217 // gcc 3.2 updates + WarnOff
00218 //
00219 // Revision 1.20  2001/05/14 20:53:20  genevb
00220 // Add features to examine memory use, switch from TDatime to time_t
00221 //
00222 // Revision 1.19  2000/01/05 19:53:46  genevb
00223 // Fixed CC5 warnings, and several other small improvements under the hood
00224 //
00225 // Revision 1.18  1999/12/28 21:29:55  porter
00226 // added 'using std::vector' and a (char*) cast to allow compilation
00227 // using solaris CC5.  Many warnings of const char* vs char* still
00228 // exist but will await Gene's return to fix these
00229 //
00230 // Revision 1.17  1999/09/16 15:50:25  genevb
00231 // Fixed a bug in over-writing memory when calling from FORTRAN, use char=0 instead of strcpy
00232 //
00233 // Revision 1.16  1999/09/14 15:42:03  genevb
00234 // Some bug fixes, workaround for nulls in strings
00235 //
00236 // Revision 1.15  1999/09/11 23:12:23  fisyak
00237 // Add cast for HP
00238 //
00239 // Revision 1.14  1999/09/10 21:05:55  genevb
00240 // Some workarounds for RedHat6.0
00241 //
00242 // Revision 1.13  1999/08/10 22:07:35  genevb
00243 // Added QAInfo message types
00244 //
00245 // Revision 1.12  1999/07/22 00:17:47  genevb
00246 // make messBuffer static
00247 //
00248 // Revision 1.11  1999/07/15 05:15:06  genevb
00249 // Fixed an odd bug with seekp(0) on an empty stream buffer
00250 //
00251 // Revision 1.10  1999/07/08 22:58:18  genevb
00252 // Created an abstract interface with StMessMgr.h hiding template implementation from others, a few other small fixes
00253 //
00254 // Revision 1.9  1999/07/01 01:24:46  genevb
00255 // Fixed FORTRAN character string bug on linux, removed a memory leak from Summary()
00256 //
00257 // Revision 1.7  1999/06/30 04:18:45  genevb
00258 // Fixes: summary wrap-around, unsigned ints, last character of message, <> for time; no KNOWN remaining bugs
00259 //
00260 // Revision 1.6  1999/06/29 23:32:41  genevb
00261 // Handle multi-line calls to fortran routines better
00262 //
00263 // Revision 1.5  1999/06/29 19:17:14  genevb
00264 // Lots of fixes..
00265 //
00266 // Revision 1.3  1999/06/26 00:24:52  genevb
00267 // Fixed const type mismatches
00268 //
00269 // Revision 1.2  1999/06/24 16:30:41  genevb
00270 // Fixed some memory leaks
00271 //
00272 // Revision 1.1  1999/06/23 15:17:46  genevb
00273 // Introduction of StMessageManager
00274 //
00275 // Revision 1.0  1999/01/27 10:28:29  genevb
00276 //