vpException.h

/*
 * ViSP, open source Visual Servoing Platform software.
 * Copyright (C) 2005 - 2024 by Inria. All rights reserved.
 *
 * This software is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * See the file LICENSE.txt at the root directory of this source
 * distribution for additional information about the GNU GPL.
 *
 * For using ViSP with software that can not be combined with the GNU
 * GPL, please contact Inria about acquiring a ViSP Professional
 * Edition License.
 *
 * See https://visp.inria.fr for more information.
 *
 * This software was developed at:
 * Inria Rennes - Bretagne Atlantique
 * Campus Universitaire de Beaulieu
 * 35042 Rennes Cedex
 * France
 *
 * If you have questions regarding the use of this file, please contact
 * Inria at visp@inria.fr
 *
 * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
 * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
 *
 * Description:
 * Exception handling.
 */

 
#ifndef VP_EXCEPTION_H
#define VP_EXCEPTION_H
 
#include <visp3/core/vpConfig.h>
 
#include <iostream>
#include <stdarg.h>
#include <string>
 
BEGIN_VISP_NAMESPACE
class VISP_EXPORT vpException : public std::exception
{
public:
  enum generalExceptionEnum
  {
    memoryAllocationError,       
    memoryFreeError,             
    functionNotImplementedError, 
    ioError,                     
    cannotUseConstructorError,   
    notImplementedError,         
    divideByZeroError,           
    dimensionError,              
    fatalError,                  
    badValue,                    
    notInitialized               
  };

  vpException(int code, const char *format, va_list args);
  vpException(int code, const char *format, ...);

  vpException(int code, const std::string &msg);

#if (VISP_CXX_STANDARD == VISP_CXX_STANDARD_98)
  virtual ~vpException() throw() { }
#endif
  VP_EXPLICIT vpException(int code);


  int getCode() const;

  const std::string &getStringMessage() const;

  const char *getMessage() const;

#if (VISP_CXX_STANDARD >= VISP_CXX_STANDARD_11)
  const char *what() const VP_NOEXCEPT VP_OVERRIDE;
#else
  const char *what() const throw();
#endif

  friend VISP_EXPORT std::ostream &operator<<(std::ostream &os, const vpException &art);
 
protected:
  int code;

  std::string message;

  void setMessage(const char *format, va_list args);

  vpException() : code(notInitialized), message("") { }
 
};
END_VISP_NAMESPACE
#endif