src/Misc/MsqError.hpp

Go to the documentation of this file.

/* ***************************************************************** 
    MESQUITE -- The Mesh Quality Improvement Toolkit

    Copyright 2004 Sandia Corporation and Argonne National
    Laboratory.  Under the terms of Contract DE-AC04-94AL85000 
    with Sandia Corporation, the U.S. Government retains certain 
    rights in this software.

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 of the License, or (at your option) any later version.

    This library 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
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License 
    (lgpl.txt) along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   
  ***************************************************************** */

#ifndef MSQ_ERROR_HPP
#define MSQ_ERROR_HPP

#include "Mesquite.hpp"

#ifdef MSQ_USE_OLD_IO_HEADERS
class ostream;
#else
#include <iosfwd>
#endif

#ifdef MSQ_USE_OLD_STD_HEADERS
#  include <list.h>
#else
#  include <list>
#endif

#include <string>

namespace Mesquite
{


#ifndef MSQ_FUNCTION
#  define MSQ_FUNCTION ""
#endif


#define MSQ_CHKERR(err)  (err.error() && err.push(MSQ_FUNCTION,__FILE__,__LINE__))

#define MSQ_ERRRTN(err)  if (MSQ_CHKERR(err)) return

#define MSQ_ERRZERO(err)  if (MSQ_CHKERR(err)) return 0

#define MSQ_SETERR(err) \
Mesquite::MsqError::setter(err, MSQ_FUNCTION,__FILE__,__LINE__).set

class MsqError {
public:

    /* NOTE: If you add an error to this list, make sure
       a) you add it *before* LAST_ERROR_CODE
       b) you add the corresponding string in MsqError.cpp
     */
  enum ErrorCode {
    NO_ERROR          =  0,
    UNKNOWN_ERROR,         
    OUT_OF_MEMORY,         
    INVALID_ARG ,          
    NOT_INITIALIZED,       
    INVALID_STATE,         
    FILE_ACCESS,           
    FILE_FORMAT,           
    PARSE_ERROR,           
    IO_ERROR,              
    INVALID_MESH,          
    NO_PD_STORAGE_MODE,    
    NOT_IMPLEMENTED,       
    INTERNAL_ERROR,        
    INTERRUPTED,           
    TAG_ALREADY_EXISTS,    
    TAG_NOT_FOUND,         
    LAST_ERROR_CODE
  };
  
  void clear(); 
  
  inline bool error() const       { return NO_ERROR != errorCode; }
  inline operator bool() const    { return NO_ERROR != errorCode; }

  MsqError() : errorCode(NO_ERROR) { } 
  
  virtual ~MsqError();

 /* ************************************************************ *
  *            Low-level access to error data
  * ************************************************************ */  

  inline ErrorCode error_code() const    { return errorCode; }

  struct Trace {
    msq_std::string function;
    msq_std::string file;
    int line;
    
    Trace( const char* fun, const char* fil, int lin )
     : function(fun), file(fil), line(lin) {}
  };
  
  const char* error_message() const;
  
  typedef msq_std::list<Trace> StackTrace;

  inline const StackTrace& stack() const { return stackTrace; }


 /* ************************************************************ *
  *                        Set error data
  * ************************************************************ */  
  
  virtual bool push( const char* function, const char* file, int line );
  
  virtual bool set_error( ErrorCode num, const char* msg = 0 );
  
  class Setter {
    public:
      Setter(MsqError& err, const char* function, const char* file, int line) 
        : mErr(err), functionName(function), fileName(file), lineNumber(line) {}
      
      bool set( ErrorCode num );
      bool set( const char* message, ErrorCode num );
      bool set( const msq_std::string& message, ErrorCode num );
      bool set( ErrorCode num, const char* format, ... )
      #ifdef __GNUC__
        __attribute__ ((format (printf, 3, 4)))
      #endif
        ; // ending semicolon for set( ErrorCode num, const char* format, ... )
    private:
      MsqError& mErr;
      const char* functionName;
      const char* fileName;
      int lineNumber;
  };

  static inline Setter setter( MsqError& err, const char* function, const char* file, int line )
  { return Setter( err, function, file, line ); }

private:

  ErrorCode errorCode;
  msq_std::string errorMessage;
  StackTrace stackTrace;
};


msq_stdio::ostream& operator<<( msq_stdio::ostream&, const MsqError& );
msq_stdio::ostream& operator<<( msq_stdio::ostream&, const MsqError::Trace& );

class MsqPrintError : public MsqError
{
  public:
    MsqPrintError( msq_stdio::ostream& stream )
      : outputStream(stream) {}
    
    virtual ~MsqPrintError( );
    
  private:
      
    msq_std::ostream& outputStream;
};

} // namespace


#endif