src/Utils/Utils_SALOME_Exception.hxx

   1 // Copyright (C) 2007-2023  CEA, EDF, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 //  SALOME Utils : general SALOME's definitions and tools
  24 //  File   : Utils_SALOME_Exception.hxx
  25 //  Author : Antoine YESSAYAN, EDF
  26 //  Module : SALOME
  27 //  $Header$
  28 //
  29 #pragma once
  30
  31 #include <exception>
  32 #include <sstream>
  33 #include <string>
  34
  35 #ifdef LOCALIZED
  36 #undef LOCALIZED
  37 #endif
  38 #if defined(_DEBUG_) || defined(_DEBUG)
  39 #define LOCALIZED(message) #message, __FILE__, __LINE__
  40 #else
  41 #define LOCALIZED(message) #message
  42 #endif
  43
  44 //swig tool on Linux doesn't pass defines from header SALOME_Utils.hxx
  45 //therefore (temporary solution) defines are placed below
  46
  47 #ifdef WIN32
  48 #if defined UTILS_EXPORTS || defined OpUtil_EXPORTS
  49 #define UTILS_EXPORT __declspec(dllexport)
  50 #else
  51 #define UTILS_EXPORT __declspec(dllimport)
  52 #undef LOCALIZED
  53 #define LOCALIZED(message) #message
  54 #endif
  55 #else
  56 #define UTILS_EXPORT
  57 #endif
  58
  59 class SALOME_Exception;
  60
  61 UTILS_EXPORT std::ostream &operator<<(std::ostream &, const SALOME_Exception &);
  62
  63 UTILS_EXPORT std::string makeText(const char *text, const char *fileName, const unsigned int lineNumber);
  64
  65 class UTILS_EXPORT SALOME_Exception : public std::exception
  66 {
  67 protected:
  68   std::string _text;
  69 public:
  70   SALOME_Exception() = delete;
  71   SALOME_Exception(const std::string& text):_text(text) { }
  72   SALOME_Exception(const char *text, const char *fileName = nullptr, const unsigned int lineNumber = 0);
  73   virtual ~SALOME_Exception() noexcept;
  74   UTILS_EXPORT friend std::ostream &operator<<(std::ostream &os, const SALOME_Exception &ex);
  75   virtual const char *what(void) const noexcept;
  76 };
  77
  78 #define THROW_SALOME_EXCEPTION(text)      \
  79 {                                         \
  80     std::ostringstream oss; oss << text;  \
  81     throw SALOME_Exception(oss.str());    \
  82 }