E57Exception.h

Go to the documentation of this file.

/*
 * Original work Copyright 2009 - 2010 Kevin Ackley (kackley@gwi.net)
 * Modified work Copyright 2018 - 2020 Andy Maloney <asmaloney@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person or organization
 * obtaining a copy of the software and accompanying documentation covered by
 * this license (the "Software") to use, reproduce, display, distribute,
 * execute, and transmit the Software, and to prepare derivative works of the
 * Software, and to permit third-parties to whom the Software is furnished to
 * do so, all subject to the following:
 *
 * The copyright notices in the Software and this entire statement, including
 * the above license grant, this restriction and the following disclaimer,
 * must be included in all copies of the Software, in whole or in part, and
 * all derivative works of the Software, unless such copies or derivative
 * works are solely in the form of machine-executable object code generated by
 * a source language processor.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */
 
#pragma once
 
#include <exception>
#include <iostream>
#include <string>
 
#include "E57Export.h"
 
namespace e57
{
   enum ErrorCode
   {
      // N.B.  *** When changing error strings here, remember to update the error
      // strings in E57Exception.cpp ****
      E57_SUCCESS = 0,                         
      E57_ERROR_BAD_CV_HEADER = 1,             
      E57_ERROR_BAD_CV_PACKET = 2,             
      E57_ERROR_CHILD_INDEX_OUT_OF_BOUNDS = 3, 
      E57_ERROR_SET_TWICE = 4,                 
      E57_ERROR_HOMOGENEOUS_VIOLATION = 5,     
      E57_ERROR_VALUE_NOT_REPRESENTABLE = 6,   
      E57_ERROR_SCALED_VALUE_NOT_REPRESENTABLE = 7, 
      E57_ERROR_REAL64_TOO_LARGE = 8,            
      E57_ERROR_EXPECTING_NUMERIC = 9,           
      E57_ERROR_EXPECTING_USTRING = 10,          
      E57_ERROR_INTERNAL = 11,                   
      E57_ERROR_BAD_XML_FORMAT = 12,             
      E57_ERROR_XML_PARSER = 13,                 
      E57_ERROR_BAD_API_ARGUMENT = 14,           
      E57_ERROR_FILE_IS_READ_ONLY = 15,          
      E57_ERROR_BAD_CHECKSUM = 16,               
      E57_ERROR_OPEN_FAILED = 17,                
      E57_ERROR_CLOSE_FAILED = 18,               
      E57_ERROR_READ_FAILED = 19,                
      E57_ERROR_WRITE_FAILED = 20,               
      E57_ERROR_LSEEK_FAILED = 21,               
      E57_ERROR_PATH_UNDEFINED = 22,             
      E57_ERROR_BAD_BUFFER = 23,                 
      E57_ERROR_NO_BUFFER_FOR_ELEMENT = 24,      
      E57_ERROR_BUFFER_SIZE_MISMATCH = 25,       
      E57_ERROR_BUFFER_DUPLICATE_PATHNAME = 26,  
      E57_ERROR_BAD_FILE_SIGNATURE = 27,         
      E57_ERROR_UNKNOWN_FILE_VERSION = 28,       
      E57_ERROR_BAD_FILE_LENGTH = 29,            
      E57_ERROR_XML_PARSER_INIT = 30,            
      E57_ERROR_DUPLICATE_NAMESPACE_PREFIX = 31, 
      E57_ERROR_DUPLICATE_NAMESPACE_URI = 32,    
      E57_ERROR_BAD_PROTOTYPE = 33,              
      E57_ERROR_BAD_CODECS = 34,                 
      E57_ERROR_VALUE_OUT_OF_BOUNDS = 35,        
      E57_ERROR_CONVERSION_REQUIRED = 36,        
      E57_ERROR_BAD_PATH_NAME = 37,              
      E57_ERROR_NOT_IMPLEMENTED = 38,            
      E57_ERROR_BAD_NODE_DOWNCAST = 39,          
      E57_ERROR_WRITER_NOT_OPEN = 40,            
      E57_ERROR_READER_NOT_OPEN = 41,            
      E57_ERROR_NODE_UNATTACHED = 42,            
      E57_ERROR_ALREADY_HAS_PARENT = 43,         
      E57_ERROR_DIFFERENT_DEST_IMAGEFILE = 44,   
      E57_ERROR_IMAGEFILE_NOT_OPEN = 45,         
      E57_ERROR_BUFFERS_NOT_COMPATIBLE = 46,     
      E57_ERROR_TOO_MANY_WRITERS = 47,           
      E57_ERROR_TOO_MANY_READERS = 48,           
      E57_ERROR_BAD_CONFIGURATION = 49,          
      E57_ERROR_INVARIANCE_VIOLATION = 50        
   };
 
   class E57_DLL E57Exception : public std::exception
   {
   public:
      void report( const char *reportingFileName = nullptr, int reportingLineNumber = 0,
                   const char *reportingFunctionName = nullptr, std::ostream &os = std::cout ) const;
      ErrorCode errorCode() const;
      std::string context() const;
      const char *what() const noexcept override;
 
      // For debugging purposes:
      const char *sourceFileName() const;
      const char *sourceFunctionName() const;
      int sourceLineNumber() const;
 
      E57Exception() = delete;
      E57Exception( ErrorCode ecode, const std::string &context, const std::string &srcFileName = nullptr,
                    int srcLineNumber = 0, const char *srcFunctionName = nullptr );
      ~E57Exception() noexcept override = default;
 
   protected:
      ErrorCode errorCode_;
      std::string context_;
      std::string sourceFileName_;
      const char *sourceFunctionName_;
      int sourceLineNumber_;
   };
 
   namespace Utilities
   {
      // Get latest version of ASTM standard supported, and library id string
      E57_DLL void getVersions( int &astmMajor, int &astmMinor, std::string &libraryId );
 
      E57_DLL std::string errorCodeToString( ErrorCode ecode );
   }
}