libstdc++-v3/include/bits/regex_error.h

   1 // class template regex -*- C++ -*-
   2
   3 // Copyright (C) 2010 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the
   7 // terms of the GNU General Public License as published by the
   8 // Free Software Foundation; either version 3, or (at your option)
   9 // 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
  14 // GNU General Public License for more details.
  15
  16 // Under Section 7 of GPL version 3, you are granted additional
  17 // permissions described in the GCC Runtime Library Exception, version
  18 // 3.1, as published by the Free Software Foundation.
  19
  20 // You should have received a copy of the GNU General Public License and
  21 // a copy of the GCC Runtime Library Exception along with this program;
  22 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
  23 // <http://www.gnu.org/licenses/>.
  24
  25 /**
  26  * @file bits/regex_error.h
  27  * @brief Error and exception objects for the std regex library.
  28  *
  29  *  This is an internal header file, included by other library headers.
  30  *  You should not attempt to use it directly.
  31  */
  32
  33 namespace std
  34 {
  35
  36 namespace regex_constants
  37 {
  38   /**
  39    * @name 5.3 Error Types
  40    */
  41   //@{
  42
  43   enum error_type
  44     {
  45       _S_error_collate,
  46       _S_error_ctype,
  47       _S_error_escape,
  48       _S_error_backref,
  49       _S_error_brack,
  50       _S_error_paren,
  51       _S_error_brace,
  52       _S_error_badbrace,
  53       _S_error_range,
  54       _S_error_space,
  55       _S_error_badrepeat,
  56       _S_error_complexity,
  57       _S_error_stack,
  58       _S_error_last
  59     };
  60
  61   /** The expression contained an invalid collating element name. */
  62   static const error_type error_collate(_S_error_collate);
  63
  64   /** The expression contained an invalid character class name. */
  65   static const error_type error_ctype(_S_error_ctype);
  66
  67   /**
  68    * The expression contained an invalid escaped character, or a trailing
  69    * escape.
  70    */
  71   static const error_type error_escape(_S_error_escape);
  72
  73   /** The expression contained an invalid back reference. */
  74   static const error_type error_backref(_S_error_backref);
  75
  76   /** The expression contained mismatched [ and ]. */
  77   static const error_type error_brack(_S_error_brack);
  78
  79   /** The expression contained mismatched ( and ). */
  80   static const error_type error_paren(_S_error_paren);
  81
  82   /** The expression contained mismatched { and } */
  83   static const error_type error_brace(_S_error_brace);
  84
  85   /** The expression contained an invalid range in a {} expression. */
  86   static const error_type error_badbrace(_S_error_badbrace);
  87
  88   /**
  89    * The expression contained an invalid character range,
  90    * such as [b-a] in most encodings.
  91    */
  92   static const error_type error_range(_S_error_range);
  93
  94   /**
  95    * There was insufficient memory to convert the expression into a
  96    * finite state machine.
  97    */
  98   static const error_type error_space(_S_error_space);
  99
 100   /**
 101    * One of <em>*?+{<em> was not preceded by a valid regular expression.
 102    */
 103   static const error_type error_badrepeat(_S_error_badrepeat);
 104
 105   /**
 106    * The complexity of an attempted match against a regular expression
 107    * exceeded a pre-set level.
 108    */
 109   static const error_type error_complexity(_S_error_complexity);
 110
 111   /**
 112    * There was insufficient memory to determine whether the
 113    * regular expression could match the specified character sequence.
 114    */
 115   static const error_type error_stack(_S_error_stack);
 116
 117   //@}
 118 }
 119
 120   // [7.8] Class regex_error
 121   /**
 122    * @brief A regular expression exception class.
 123    * @ingroup exceptions
 124    *
 125    * The regular expression library throws objects of this class on error.
 126    */
 127   class regex_error
 128   : public std::runtime_error
 129   {
 130   public:
 131     /**
 132      * @brief Constructs a regex_error object.
 133      *
 134      * @param ecode the regex error code.
 135      */
 136     explicit
 137     regex_error(regex_constants::error_type __ecode)
 138     : std::runtime_error("regex_error"), _M_code(__ecode)
 139     { }
 140
 141     /**
 142      * @brief Gets the regex error code.
 143      *
 144      * @returns the regex error code.
 145      */
 146     regex_constants::error_type
 147     code() const
 148     { return _M_code; }
 149
 150   protected:
 151     regex_constants::error_type _M_code;
 152   };
 153
 154
 155   inline void
 156   __throw_regex_error(regex_constants::error_type __ecode)
 157   { throw regex_error(__ecode); }
 158
 159 } // namespace std
 160