oberror.h

Go to the documentation of this file.

/**********************************************************************
oberror.h - Handle error messages, warnings, notices, etc.
 
Copyright (C) 2002 by Stefan Kebekus
Some portions Copyright (C) 2003-2005 by Geoffrey R. Hutchison
 
This file is part of the Open Babel project.
For more information, see <http://openbabel.sourceforge.net/>
 
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation version 2 of the License.
 
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.
***********************************************************************/

#ifndef OB_ERROR_H
#define OB_ERROR_H

#include "babelconfig.h"

#ifndef EXTERN
#  define EXTERN extern
#endif

#if HAVE_IOSTREAM
#include <iostream>
#elif HAVE_IOSTREAM_H
#include <iostream.h>
#endif
#if HAVE_SSTREAM
        #include <sstream>
#elif
        #include <sstream.h>
#endif
#include <string>
#include <vector>
#include <deque>

namespace OpenBabel
{

enum obMessageLevel {
   obError,     
   obWarning,   
   obInfo,      
   obAuditMsg,  
   obDebug      
};

class OBAPI OBError
{
public:

  OBError( const std::string &method = "",
           const std::string &errorMsg = "",
           const std::string &explanation = "",
           const std::string &possibleCause = "",
           const std::string &suggestedRemedy = "",
           const obMessageLevel = obDebug );

  std::string message(void) const;
  
  friend std::ostream& operator<< ( std::ostream &os, const OBError &er )
    { return os << er.message(); };

  std::string    GetMethod()            { return _method;          }
  std::string    GetError()             { return _errorMsg;        }
  std::string    GetExplanation()       { return _explanation;     }
  std::string    GetPossibleCause()     { return _possibleCause;   }
  std::string    GetSuggestedRemedy()   { return _suggestedRemedy; }
  obMessageLevel GetLevel()             { return _level;           }

 protected:

    std::string _method;
    std::string _errorMsg;
    std::string _explanation;
    std::string _possibleCause;
    std::string _suggestedRemedy;

    obMessageLevel _level;
};

class OBAPI OBMessageHandler
  {
  public:
    OBMessageHandler();
    ~OBMessageHandler();
    
    void ThrowError(OBError err);
    void ThrowError(const std::string &method, const std::string &errorMsg, 
                    obMessageLevel level = obDebug);

    std::vector<std::string> GetMessagesOfLevel(const obMessageLevel);

    void StartLogging() { _logging = true; }
    void StopLogging()  { _logging = false; }

    void SetMaxLogEntries(unsigned int max) { _maxEntries = max; }
    unsigned int GetMaxLogEntries() { return _maxEntries; }

    void ClearLog() { _messageList.clear(); }

    void SetOutputLevel(const obMessageLevel level) { _outputLevel = level; }
    obMessageLevel GetOutputLevel() { return _outputLevel; }

    void SetOutputStream(std::ostream *os) { _outputStream = os; }
    std::ostream* GetOutputStream() { return _outputStream; }

    bool StartErrorWrap();
    bool StopErrorWrap();

  protected:
    std::deque<OBError>    _messageList;

    obMessageLevel         _outputLevel;

    // self-explanatory
    std::ostream          *_outputStream;

    bool                   _logging;
    unsigned int           _maxEntries;

    std::streambuf        *_inWrapStreamBuf;
    std::streambuf        *_filterStreamBuf;
  }; 

EXTERN OBMessageHandler obErrorLog;

 class OBAPI obLogBuf : public std::stringbuf
  {
    public:
      virtual ~obLogBuf() { sync(); }
    
    protected:
    int sync()
    {
      obErrorLog.ThrowError("", str(), obInfo);
      str(std::string()); // clear the buffer
                        return 0;
    }
  };

} // end namespace OpenBabel

#endif

---

This file is part of the documentation for Open Babel, version 2.0.2.

Documentation copyright © 1998-2005, the Open Babel Developers.
Open Babel is hosted by:
Generated on Thu Nov 30 20:18:01 2006 by  1.5.1.