CoinUtils  2.10.14
CoinMessageHandler.hpp
Go to the documentation of this file.
1 /* $Id: CoinMessageHandler.hpp 1514 2011-12-10 23:35:23Z lou $ */
2 // Copyright (C) 2002, International Business Machines
3 // Corporation and others. All Rights Reserved.
4 // This code is licensed under the terms of the Eclipse Public License (EPL).
5 
6 #ifndef CoinMessageHandler_H
7 #define CoinMessageHandler_H
8 
9 #include "CoinUtilsConfig.h"
10 #include "CoinPragma.hpp"
11 
12 #include <iostream>
13 #include <cstdio>
14 #include <string>
15 #include <vector>
16 
31 /*
32  I (jjf) am strongly in favo(u)r of language support for an open
33  source project, but I have tried to make it as lightweight as
34  possible in the sense that only a subset of messages need to be
35  defined - the rest default to US English. There will be different
36  sets of messages for each component - so at present there is a
37  Clp component and a Coin component.
38 
39  Because messages are only used in a controlled environment and have no
40  impact on code and are tested by other tests I have included tests such
41  as language and derivation in other unit tests.
42 */
43 /*
44  Where there are derived classes I (jjf) have started message numbers at 1001.
45 */
46 
47 
59 
60 public:
67  const char * message);
75 
78  void replaceMessage(const char * message);
81 
85  inline int externalNumber() const
86  {return externalNumber_;}
92  inline void setExternalNumber(int number)
93  {externalNumber_=number;}
95  inline char severity() const
96  {return severity_;}
98  inline void setDetail(int level)
99  {detail_=static_cast<char> (level);}
101  inline int detail() const
102  {return detail_;}
104  inline char * message() const
105  {return message_;}
107 
110  int externalNumber_;
113  char detail_;
115  char severity_;
117  mutable char message_[400];
119 };
120 
129 
130 public:
136  enum Language {
137  us_en = 0,
139  it
140  };
141 
145  CoinMessages(int numberMessages=0);
153 
161  void addMessage(int messageNumber, const CoinOneMessage & message);
167  void replaceMessage(int messageNumber, const char * message);
169  inline Language language() const
170  {return language_;}
172  void setLanguage(Language newlanguage)
173  {language_ = newlanguage;}
175  void setDetailMessage(int newLevel, int messageNumber);
183  void setDetailMessages(int newLevel, int numberMessages,
184  int * messageNumbers);
186  void setDetailMessages(int newLevel, int low, int high);
187 
189  inline int getClass() const
190  { return class_;}
192  void toCompact();
194  void fromCompact();
196 
199  int numberMessages_;
204  char source_[5];
206  int class_;
214 };
215 
216 // for convenience eol
220 };
221 
328 
330 
331 public:
336  virtual int print() ;
339  virtual void checkSeverity() ;
341 
355  virtual CoinMessageHandler * clone() const;
357 
359  inline int detail(int messageNumber, const CoinMessages &normalMessage) const
361  { return normalMessage.message_[messageNumber]->detail();}
363  inline int logLevel() const
364  { return logLevel_;}
382  void setLogLevel(int value);
384  inline int logLevel(int which) const
385  { return logLevels_[which];}
390  void setLogLevel(int which, int value);
391 
393  void setPrecision(unsigned int new_precision);
395  inline int precision() { return (g_precision_) ; }
396 
398  void setPrefix(bool yesNo);
400  bool prefix() const;
406  inline double doubleValue(int position) const
407  { return doubleValue_[position];}
412  inline int numberDoubleFields() const
413  {return static_cast<int>(doubleValue_.size());}
419  inline int intValue(int position) const
420  { return longValue_[position];}
425  inline int numberIntFields() const
426  {return static_cast<int>(longValue_.size());}
432  inline char charValue(int position) const
433  { return charValue_[position];}
438  inline int numberCharFields() const
439  {return static_cast<int>(charValue_.size());}
445  inline std::string stringValue(int position) const
446  { return stringValue_[position];}
451  inline int numberStringFields() const
452  {return static_cast<int>(stringValue_.size());}
453 
456  {return currentMessage_;}
458  inline std::string currentSource() const
459  {return source_;}
461  inline const char * messageBuffer() const
462  {return messageBuffer_;}
464  inline int highestNumber() const
465  {return highestNumber_;}
467  inline FILE * filePointer() const
468  { return fp_;}
470  inline void setFilePointer(FILE * fp)
471  { fp_ = fp;}
473 
482  CoinMessageHandler &message(int messageNumber,
483  const CoinMessages &messages) ;
484 
499 
512  CoinMessageHandler &message(int externalNumber, const char *source,
513  const char *msg,
514  char severity, int detail = -1) ;
515 
521 #if COIN_BIG_INDEX==1
522 
526  CoinMessageHandler & operator<< (long longvalue);
527 #endif
528 #if COIN_BIG_INDEX==2
529 
533  CoinMessageHandler & operator<< (long long longvalue);
534 #endif
535 
539  CoinMessageHandler & operator<< (double doublevalue);
544  CoinMessageHandler & operator<< (const std::string& stringvalue);
549  CoinMessageHandler & operator<< (char charvalue);
554  CoinMessageHandler & operator<< (const char *stringvalue);
564  int finish();
575 
577 
586 #define COIN_NUM_LOG 4
587 #define COIN_MESSAGE_HANDLER_MAX_BUFFER_SIZE 1000
589 protected:
592  std::vector<double> doubleValue_;
594  std::vector<int> longValue_;
595  std::vector<char> charValue_;
596  std::vector<std::string> stringValue_;
602  int prefix_;
608  char * format_;
612  char * messageOut_;
614  std::string source_;
627  FILE * fp_;
629  char g_format_[8];
633 
634 private:
635 
637  void gutsOfCopy(const CoinMessageHandler &rhs) ;
638 
643  char *nextPerCent(char *start, const bool initial = false) ;
644 
650 
652  void calcPrintStatus(int msglvl, int msgclass) ;
653 
654 
655 };
656 
657 //#############################################################################
663 bool
665 
666 #endif
CoinMessageHandler::logLevel
int logLevel(int which) const
Get alternative log level.
Definition: CoinMessageHandler.hpp:384
CoinOneMessage::detail_
char detail_
Will only print if detail matches.
Definition: CoinMessageHandler.hpp:113
CoinMessageHandler::intValue
int intValue(int position) const
Values of integer fields already processed.
Definition: CoinMessageHandler.hpp:419
CoinMessages::toCompact
void toCompact()
Moves to compact format.
CoinMessageHandler::nextPerCent
char * nextPerCent(char *start, const bool initial=false)
Internal function to locate next format code.
CoinMessages::setDetailMessages
void setDetailMessages(int newLevel, int low, int high)
Change detail level for all messages with low <= ID number < high.
CoinMessageHandler::source_
std::string source_
Current source of message.
Definition: CoinMessageHandler.hpp:614
CoinOneMessage::CoinOneMessage
CoinOneMessage(int externalNumber, char detail, const char *message)
Normal constructor.
CoinMessageHandler::messageBuffer_
char messageBuffer_[COIN_MESSAGE_HANDLER_MAX_BUFFER_SIZE]
Output buffer.
Definition: CoinMessageHandler.hpp:610
CoinMessages::addMessage
void addMessage(int messageNumber, const CoinOneMessage &message)
Installs a new message in the specified index position.
CoinMessageHandler::messageOut_
char * messageOut_
Position in output buffer.
Definition: CoinMessageHandler.hpp:612
CoinMessageHandler::currentMessage_
CoinOneMessage currentMessage_
Current message.
Definition: CoinMessageHandler.hpp:604
CoinMessageHandler::prefix_
int prefix_
Whether we want prefix (may get more subtle so is int)
Definition: CoinMessageHandler.hpp:602
CoinMessageHandler::numberIntFields
int numberIntFields() const
Number of integer fields already processed.
Definition: CoinMessageHandler.hpp:425
CoinMessageHandler::setLogLevel
void setLogLevel(int value)
Set current log (detail) level.
CoinMessages::numberMessages_
int numberMessages_
Number of messages.
Definition: CoinMessageHandler.hpp:200
CoinMessageHandler::doubleValue_
std::vector< double > doubleValue_
values in message
Definition: CoinMessageHandler.hpp:593
CoinMessageHandler::setLogLevel
void setLogLevel(int which, int value)
Set alternative log level value.
CoinMessageHandler::precision
int precision()
Current number of significant digits for printing floating point numbers.
Definition: CoinMessageHandler.hpp:395
CoinMessageHandler::clone
virtual CoinMessageHandler * clone() const
Clone.
CoinMessageHandler::print
virtual int print()
Print message, return 0 normally.
CoinMessageHandler::printStatus_
int printStatus_
0 - Normal.
Definition: CoinMessageHandler.hpp:623
CoinMessages::message_
CoinOneMessage ** message_
Messages.
Definition: CoinMessageHandler.hpp:212
CoinMessageHandler::message
CoinMessageHandler & message(int externalNumber, const char *source, const char *msg, char severity, int detail=-1)
Print a complete message.
CoinMessageHandler::CoinMessageHandler
CoinMessageHandler()
Constructor.
CoinMessages::us_en
@ us_en
Definition: CoinMessageHandler.hpp:137
CoinOneMessage::~CoinOneMessage
~CoinOneMessage()
Destructor.
CoinMessages::operator=
CoinMessages & operator=(const CoinMessages &)
assignment operator.
CoinMessages
Class to hold and manipulate an array of massaged messages.
Definition: CoinMessageHandler.hpp:128
CoinMessages::getClass
int getClass() const
Returns class.
Definition: CoinMessageHandler.hpp:189
CoinMessageHandler::setPrecision
void setPrecision(unsigned int new_precision)
Set the number of significant digits for printing floating point numbers.
CoinMessageHandler::detail
int detail(int messageNumber, const CoinMessages &normalMessage) const
Get detail level of a message.
Definition: CoinMessageHandler.hpp:360
CoinOneMessage::severity
char severity() const
Severity.
Definition: CoinMessageHandler.hpp:95
CoinMessageHandler::CoinMessageHandler
CoinMessageHandler(const CoinMessageHandler &)
The copy constructor.
CoinMessages::uk_en
@ uk_en
Definition: CoinMessageHandler.hpp:138
CoinPragma.hpp
CoinMessageHandler::setFilePointer
void setFilePointer(FILE *fp)
Set new file pointer.
Definition: CoinMessageHandler.hpp:470
CoinMessageHandler::setPrefix
void setPrefix(bool yesNo)
Switch message prefix on or off.
CoinMessageHandler::operator=
CoinMessageHandler & operator=(const CoinMessageHandler &)
Assignment operator.
CoinMessageHandler::logLevel_
int logLevel_
Log level.
Definition: CoinMessageHandler.hpp:598
CoinMessages::replaceMessage
void replaceMessage(int messageNumber, const char *message)
Replaces the text of the specified message.
CoinMessageHandler::doubleValue
double doubleValue(int position) const
Values of double fields already processed.
Definition: CoinMessageHandler.hpp:406
CoinOneMessage::message_
char message_[400]
Messages (in correct language) (not all 400 may exist)
Definition: CoinMessageHandler.hpp:117
CoinMessages::language_
Language language_
Language.
Definition: CoinMessageHandler.hpp:202
CoinMessages::class_
int class_
Class - see later on before CoinMessageHandler.
Definition: CoinMessageHandler.hpp:206
CoinOneMessage::replaceMessage
void replaceMessage(const char *message)
Replace message text (e.g., text in a different language)
CoinMessageHandler
Base class for message handling.
Definition: CoinMessageHandler.hpp:327
CoinMessages::it
@ it
Definition: CoinMessageHandler.hpp:139
CoinMessageHandler::CoinMessageHandler
CoinMessageHandler(FILE *fp)
Constructor to put to file pointer (won't be closed)
CoinMessageHandler::charValue_
std::vector< char > charValue_
Definition: CoinMessageHandler.hpp:595
CoinOneMessage::externalNumber
int externalNumber() const
Get message ID number.
Definition: CoinMessageHandler.hpp:85
CoinMessageHandler::charValue
char charValue(int position) const
Values of char fields already processed.
Definition: CoinMessageHandler.hpp:432
CoinMessageHandler::stringValue_
std::vector< std::string > stringValue_
Definition: CoinMessageHandler.hpp:596
CoinMessageHandler::printing
CoinMessageHandler & printing(bool onOff)
Enable or disable printing of an optional portion of a message.
CoinMessageHandler::messageBuffer
const char * messageBuffer() const
Output buffer.
Definition: CoinMessageHandler.hpp:461
CoinMessageHandler::checkSeverity
virtual void checkSeverity()
Check message severity - if too bad then abort.
CoinOneMessage
Class for one massaged message.
Definition: CoinMessageHandler.hpp:58
CoinMessages::source_
char source_[5]
Source (null-terminated string, maximum 4 characters).
Definition: CoinMessageHandler.hpp:204
CoinMessageHandler::highestNumber_
int highestNumber_
Highest message number (indicates any errors)
Definition: CoinMessageHandler.hpp:625
CoinMessageHandler::stringValue
std::string stringValue(int position) const
Values of string fields already processed.
Definition: CoinMessageHandler.hpp:445
CoinOneMessage::externalNumber_
int externalNumber_
number to print out (also determines severity)
Definition: CoinMessageHandler.hpp:111
CoinMessages::~CoinMessages
~CoinMessages()
Destructor.
CoinUtilsConfig.h
CoinMessageHandler::logLevels_
int logLevels_[COIN_NUM_LOG]
Log levels.
Definition: CoinMessageHandler.hpp:600
CoinMessageHandler::currentMessage
CoinOneMessage currentMessage() const
Current message.
Definition: CoinMessageHandler.hpp:455
CoinOneMessage::message
char * message() const
Return the message text.
Definition: CoinMessageHandler.hpp:104
CoinMessages::CoinMessages
CoinMessages(const CoinMessages &)
The copy constructor.
CoinMessageNewline
@ CoinMessageNewline
Definition: CoinMessageHandler.hpp:219
CoinMessageHandler::gutsOfCopy
void gutsOfCopy(const CoinMessageHandler &rhs)
The body of the copy constructor and the assignment operator.
CoinOneMessage::severity_
char severity_
Severity.
Definition: CoinMessageHandler.hpp:115
CoinOneMessage::setExternalNumber
void setExternalNumber(int number)
Set message ID number.
Definition: CoinMessageHandler.hpp:92
CoinMessageHandler::logLevel
int logLevel() const
Get current log (detail) level.
Definition: CoinMessageHandler.hpp:363
COIN_MESSAGE_HANDLER_MAX_BUFFER_SIZE
#define COIN_MESSAGE_HANDLER_MAX_BUFFER_SIZE
Maximum length of constructed message (characters)
Definition: CoinMessageHandler.hpp:588
CoinOneMessage::setDetail
void setDetail(int level)
Set detail level.
Definition: CoinMessageHandler.hpp:98
CoinOneMessage::CoinOneMessage
CoinOneMessage()
Default constructor.
CoinMessageHandler::internalNumber_
int internalNumber_
Internal number for use with enums.
Definition: CoinMessageHandler.hpp:606
CoinMessageHandler::longValue_
std::vector< int > longValue_
Definition: CoinMessageHandler.hpp:594
CoinMessageHandler::fp_
FILE * fp_
File pointer.
Definition: CoinMessageHandler.hpp:627
CoinMessageHandler::~CoinMessageHandler
virtual ~CoinMessageHandler()
Destructor.
CoinMessageHandler::message
CoinMessageHandler & message(int messageNumber, const CoinMessages &messages)
Start a message.
CoinMessages::CoinMessages
CoinMessages(int numberMessages=0)
Constructor with number of messages.
CoinMessageHandler::operator<<
CoinMessageHandler & operator<<(int intvalue)
Process an integer parameter value.
CoinOneMessage::CoinOneMessage
CoinOneMessage(const CoinOneMessage &)
The copy constructor.
CoinMessageHandler::message
CoinMessageHandler & message(int detail=-1)
Start or continue a message.
CoinMessageHandler::g_precision_
int g_precision_
Current number of significant digits for floating point numbers.
Definition: CoinMessageHandler.hpp:631
CoinMessages::setLanguage
void setLanguage(Language newlanguage)
Set language.
Definition: CoinMessageHandler.hpp:172
CoinMessageHandler::finish
int finish()
Finish (and print) the message.
CoinMessageHandlerUnitTest
bool CoinMessageHandlerUnitTest()
A function that tests the methods in the CoinMessageHandler class.
CoinMessageHandler::highestNumber
int highestNumber() const
Highest message number (indicates any errors)
Definition: CoinMessageHandler.hpp:464
CoinMessageHandler::format_
char * format_
Format string for message (remainder)
Definition: CoinMessageHandler.hpp:608
CoinMessages::lengthMessages_
int lengthMessages_
Length of fake CoinOneMessage array.
Definition: CoinMessageHandler.hpp:210
CoinMessages::language
Language language() const
Language.
Definition: CoinMessageHandler.hpp:169
CoinMessageHandler::g_format_
char g_format_[8]
Current format for floating point numbers.
Definition: CoinMessageHandler.hpp:629
CoinMessageMarker
CoinMessageMarker
Definition: CoinMessageHandler.hpp:217
CoinMessageEol
@ CoinMessageEol
Definition: CoinMessageHandler.hpp:218
CoinMessages::fromCompact
void fromCompact()
Moves from compact format.
CoinMessages::Language
Language
Supported languages.
Definition: CoinMessageHandler.hpp:136
CoinMessageHandler::numberStringFields
int numberStringFields() const
Number of string fields already processed.
Definition: CoinMessageHandler.hpp:451
CoinMessageHandler::filePointer
FILE * filePointer() const
Get current file pointer.
Definition: CoinMessageHandler.hpp:467
COIN_NUM_LOG
#define COIN_NUM_LOG
Log levels will be by type and will then use type given in CoinMessage::class_.
Definition: CoinMessageHandler.hpp:586
CoinMessages::setDetailMessage
void setDetailMessage(int newLevel, int messageNumber)
Change detail level for one message.
CoinOneMessage::detail
int detail() const
Get detail level.
Definition: CoinMessageHandler.hpp:101
CoinMessageHandler::calcPrintStatus
void calcPrintStatus(int msglvl, int msgclass)
Decide if this message should print.
CoinMessageHandler::internalPrint
int internalPrint()
Internal printing function.
CoinMessageHandler::prefix
bool prefix() const
Current setting for printing message prefix.
CoinMessageHandler::currentSource
std::string currentSource() const
Source of current message.
Definition: CoinMessageHandler.hpp:458
CoinMessageHandler::numberCharFields
int numberCharFields() const
Number of char fields already processed.
Definition: CoinMessageHandler.hpp:438
CoinMessageHandler::numberDoubleFields
int numberDoubleFields() const
Number of double fields already processed.
Definition: CoinMessageHandler.hpp:412
CoinMessages::setDetailMessages
void setDetailMessages(int newLevel, int numberMessages, int *messageNumbers)
Change detail level for several messages.
CoinOneMessage::operator=
CoinOneMessage & operator=(const CoinOneMessage &)
assignment operator.
CoinMessageHandler::CoinMessageHandlerUnitTest
friend bool CoinMessageHandlerUnitTest()
A function that tests the methods in the CoinMessageHandler class.