IException.h

Go to the documentation of this file.

#ifndef IException_h
#define IException_h

 
/* SPDX-License-Identifier: CC0-1.0 */
 
#include <exception>
#include <string>
 
#include "FileName.h"
 
template <typename T> class QList;
 
class QString;

#define _FILEINFO_ Isis::FileName(__FILE__).name().toStdString().c_str(),__LINE__
 
namespace Isis {
  class Pvl;

  class IException : public std::exception {
    public:
 
       /*
       * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
       * If at all possible do not change the enumeration values for the
       * error codes.  The reason why is it that will change the return
       * status of error messages.  Ground data processing groups (e.g.,
       * HiRISE, LROC, Messenger) will sometime test on the error return
       * values in their scripts.  By keeping the enumerations the same
       * we improve backward compatibility.
       * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
       */
      enum ErrorType {
        Unknown = 1,

        User,

        Programmer,

        Io
      };
 
      IException();
 
      IException(ErrorType type, const char *message,
                 const char *fileName, int lineNumber);
 
      IException(ErrorType type, const std::string &message,
                 const char *fileName, int lineNumber);
 
      IException(ErrorType type, const QString &message,
                 const char *fileName, int lineNumber);
 
      IException(const IException &caughtException,
                 ErrorType newExceptionType, const char *message,
                 const char *fileName, int lineNumber);
 
      IException(const IException &caughtException,
                 ErrorType newExceptionType, const std::string &message,
                 const char *fileName, int lineNumber);
 
      IException(const IException &caughtException,
                 ErrorType newExceptionType, const QString &message,
                 const char *fileName, int lineNumber);
 
      IException(const IException &other);
 
      ~IException() throw();
 
      const char *what() const throw();
 
      void append(const IException &exceptionSource);
 
      ErrorType errorType() const;
      static QString errorTypeToString(ErrorType t);
      void print() const;
      void print(bool printFileInfo) const;
      Pvl toPvl() const;
      QString toString() const;
      QString toString(bool printFileInfo) const;
 
      void swap(IException &other);
      IException &operator=(const IException &rhs);
 
    private:
      static IException createStackTrace();
      static ErrorType stringToErrorType(const QString &s);
      char *buildWhat() const;
      void deleteEmptyMemberStrings();
 
    private:
      char * m_what;

      ErrorType m_errorType;

      QString * m_message;

      QString * m_fileName;

      int m_lineNumber;

      QList<IException> * m_previousExceptions;
  };
};
 
#endif