view Framework/StoneException.h @ 947:1091b2adeb5a toa2019081001

Fixed animation frame stopping when returning false + big work on the OpenGL objects to make them lost context-safe + debug code to forcefully tag a context as lost + debug macros
author Benjamin Golinvaux <bgo@osimis.io>
date Sat, 10 Aug 2019 13:07:31 +0200
parents 101073b3e855
children 32eaf4929b08
line wrap: on
line source

/**
 * Stone of Orthanc
 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
 * Department, University Hospital of Liege, Belgium
 * Copyright (C) 2017-2019 Osimis S.A., Belgium
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License
 * as published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version.
 *
 * 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
 * Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 **/


#pragma once

#include "Core/OrthancException.h"
#include <boost/lexical_cast.hpp>

namespace OrthancStone
{
  enum ErrorCode
  {
    ErrorCode_Success,
    ErrorCode_OrthancError, // this StoneException is actually an OrthancException with an Orthanc error code
    ErrorCode_ApplicationException, // this StoneException is specific to an application (and should have its own internal error code)
    ErrorCode_NotImplemented, // case not implemented

    ErrorCode_PromiseSingleSuccessHandler, // a Promise can only have a single success handler
    ErrorCode_PromiseSingleFailureHandler, // a Promise can only have a single failure handler

    ErrorCode_CanOnlyAddOneLayerAtATime,
    ErrorCode_CommandJsonInvalidFormat,
    ErrorCode_WebGLContextLost,
    ErrorCode_Last
  };



  class StoneException
  {
  protected:
    OrthancStone::ErrorCode     errorCode_;

  public:
    explicit StoneException(ErrorCode errorCode) :
      errorCode_(errorCode)
    {
    }

    ErrorCode GetErrorCode() const
    {
      return errorCode_;
    }

    virtual const char* What() const
    {
      return "TODO: EnumerationToString for StoneException";
    }
  };

  class OpenGLContextLostException : public StoneException
  {
  public:
    explicit OpenGLContextLostException(void* context)
      : StoneException(ErrorCode_WebGLContextLost)
      , context_(context)
    {
    }
    virtual const char* What() const
    {
      return "The OpenGL/WebGL context has been lost!";
    }
    void* context_;
  };

  class StoneOrthancException : public StoneException
  {
  protected:
    Orthanc::OrthancException&  orthancException_;

  public:
    explicit StoneOrthancException(Orthanc::OrthancException& orthancException) :
      StoneException(ErrorCode_OrthancError),
      orthancException_(orthancException)
    {
    }

    Orthanc::ErrorCode GetOrthancErrorCode() const
    {
      return orthancException_.GetErrorCode();
    }

    virtual const char* What() const
    {
      return orthancException_.What();
    }
  };

  class StoneApplicationException : public StoneException
  {
  protected:
    int applicationErrorCode_;

  public:
    explicit StoneApplicationException(int applicationErrorCode) :
      StoneException(ErrorCode_ApplicationException),
      applicationErrorCode_(applicationErrorCode)
    {
    }

    int GetApplicationErrorCode() const
    {
      return applicationErrorCode_;
    }

    virtual const char* What() const
    {
      return boost::lexical_cast<std::string>(applicationErrorCode_).c_str();
    }
  };

}

// See https://isocpp.org/wiki/faq/misc-technical-issues#macros-with-multi-stmts
// (or google "Multiple lines macro C++ faq lite" if link is dead)
#define ORTHANC_ASSERT2(cond,streamChainMessage) \
    if (!(cond)) { \
      std::stringstream sst; \
      sst << "Assertion failed. Condition = \"" #cond "\" Message = \"" << streamChainMessage << "\""; \
      std::string sstr = sst.str(); \
      throw ::Orthanc::OrthancException(::Orthanc::ErrorCode_InternalError,sstr.c_str()); \
    } else (void)0

#define ORTHANC_ASSERT1(cond) \
    if (!(cond)) { \
      std::stringstream sst; \
      sst << "Assertion failed. Condition = \"" #cond "\""; \
      std::string sstr = sst.str(); \
      throw ::Orthanc::OrthancException(::Orthanc::ErrorCode_InternalError,sstr.c_str()); \
    } else (void)0

# define ORTHANC_EXPAND( x ) x 
# define GET_ORTHANC_ASSERT(_1,_2,NAME,...) NAME
# define ORTHANC_ASSERT(...) ORTHANC_EXPAND(GET_ORTHANC_ASSERT(__VA_ARGS__, ORTHANC_ASSERT2, ORTHANC_ASSERT1, UNUSED)(__VA_ARGS__))

/*
Explanation:

ORTHANC_ASSERT(a)
ORTHANC_EXPAND(GET_ORTHANC_ASSERT(a, ORTHANC_ASSERT2, ORTHANC_ASSERT1, UNUSED)(a))
ORTHANC_EXPAND(ORTHANC_ASSERT1(a))
ORTHANC_ASSERT1(a)

ORTHANC_ASSERT(a,b)
ORTHANC_EXPAND(GET_ORTHANC_ASSERT(a, b, ORTHANC_ASSERT2, ORTHANC_ASSERT1, UNUSED)(a,b))
ORTHANC_EXPAND(ORTHANC_ASSERT2(a,b))
ORTHANC_ASSERT2(a,b)

Note: ORTHANC_EXPAND is required for some older compilers (MS v100 cl.exe )
*/