Branch data     Line data    Source code

       1                 :            : /******************************************************************************
       2                 :            :  * Top contributors (to current version):
       3                 :            :  *   Andres Noetzli, Morgan Deters, Mathias Preiner
       4                 :            :  *
       5                 :            :  * This file is part of the cvc5 project.
       6                 :            :  *
       7                 :            :  * Copyright (c) 2009-2024 by the authors listed in the file AUTHORS
       8                 :            :  * in the top-level source directory and their institutional affiliations.
       9                 :            :  * All rights reserved.  See the file COPYING in the top-level source
      10                 :            :  * directory for licensing information.
      11                 :            :  * ****************************************************************************
      12                 :            :  *
      13                 :            :  * Options-related exceptions.
      14                 :            :  */
      15                 :            : 
      16                 :            : #include "cvc5_public.h"
      17                 :            : 
      18                 :            : #ifndef CVC5__OPTION_EXCEPTION_H
      19                 :            : #define CVC5__OPTION_EXCEPTION_H
      20                 :            : 
      21                 :            : #include <cvc5/cvc5_export.h>
      22                 :            : 
      23                 :            : #include "base/exception.h"
      24                 :            : 
      25                 :            : namespace cvc5::internal {
      26                 :            : 
      27                 :            : /**
      28                 :            :  * Class representing an option-parsing exception such as badly-typed
      29                 :            :  * or missing arguments, arguments out of bounds, etc.
      30                 :            :  */
      31                 :            : class CVC5_EXPORT OptionException : public cvc5::internal::Exception
      32                 :            : {
      33                 :            :  public:
      34                 :      11841 :   OptionException(const std::string& s) : cvc5::internal::Exception(s_errPrefix + s) {}
      35                 :            : 
      36                 :            :   /**
      37                 :            :    * Get the error message without the prefix that is automatically added for
      38                 :            :    * OptionExceptions.
      39                 :            :    */
      40                 :            :   std::string getRawMessage() const
      41                 :            :   {
      42                 :            :     return getMessage().substr(s_errPrefix.size());
      43                 :            :   }
      44                 :            : 
      45                 :            :  private:
      46                 :            :   /** The string to be added in front of the actual error message */
      47                 :            :   static const std::string s_errPrefix;
      48                 :            : }; /* class OptionException */
      49                 :            : 
      50                 :            : }  // namespace cvc5::internal
      51                 :            : 
      52                 :            : #endif /* CVC5__OPTION_EXCEPTION_H */