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  *  Do not attempt to use it directly. @headername{regex}
  31  */
  32
  33 _GLIBCXX_BEGIN_NAMESPACE(std)
  34
  35 namespace regex_constants
  36 {
  37   /**
  38    * @name 5.3 Error Types
  39    */
  40   //@{
  41
  42   enum error_type
  43     {
  44       _S_error_collate,
  45       _S_error_ctype,
  46       _S_error_escape,
  47       _S_error_backref,
  48       _S_error_brack,
  49       _S_error_paren,
  50       _S_error_brace,
  51       _S_error_badbrace,
  52       _S_error_range,
  53       _S_error_space,
  54       _S_error_badrepeat,
  55       _S_error_complexity,
  56       _S_error_stack,
  57       _S_error_last
  58     };
  59
  60   /** The expression contained an invalid collating element name. */
  61   static const error_type error_collate(_S_error_collate);
  62
  63   /** The expression contained an invalid character class name. */
  64   static const error_type error_ctype(_S_error_ctype);
  65
  66   /**
  67    * The expression contained an invalid escaped character, or a trailing
  68    * escape.
  69    */
  70   static const error_type error_escape(_S_error_escape);
  71
  72   /** The expression contained an invalid back reference. */
  73   static const error_type error_backref(_S_error_backref);
  74
  75   /** The expression contained mismatched [ and ]. */
  76   static const error_type error_brack(_S_error_brack);
  77
  78   /** The expression contained mismatched ( and ). */
  79   static const error_type error_paren(_S_error_paren);
  80
  81   /** The expression contained mismatched { and } */
  82   static const error_type error_brace(_S_error_brace);
  83
  84   /** The expression contained an invalid range in a {} expression. */
  85   static const error_type error_badbrace(_S_error_badbrace);
  86
  87   /**
  88    * The expression contained an invalid character range,
  89    * such as [b-a] in most encodings.
  90    */
  91   static const error_type error_range(_S_error_range);
  92
  93   /**
  94    * There was insufficient memory to convert the expression into a
  95    * finite state machine.
  96    */
  97   static const error_type error_space(_S_error_space);
  98
  99   /**
 100    * One of <em>*?+{<em> was not preceded by a valid regular expression.
 101    */
 102   static const error_type error_badrepeat(_S_error_badrepeat);
 103
 104   /**
 105    * The complexity of an attempted match against a regular expression
 106    * exceeded a pre-set level.
 107    */
 108   static const error_type error_complexity(_S_error_complexity);
 109
 110   /**
 111    * There was insufficient memory to determine whether the
 112    * regular expression could match the specified character sequence.
 113    */
 114   static const error_type error_stack(_S_error_stack);
 115
 116   //@}
 117 }
 118
 119   // [7.8] Class regex_error
 120   /**
 121    * @brief A regular expression exception class.
 122    * @ingroup exceptions
 123    *
 124    * The regular expression library throws objects of this class on error.
 125    */
 126   class regex_error
 127   : public std::runtime_error
 128   {
 129   public:
 130     /**
 131      * @brief Constructs a regex_error object.
 132      *
 133      * @param ecode the regex error code.
 134      */
 135     explicit
 136     regex_error(regex_constants::error_type __ecode)
 137     : std::runtime_error("regex_error"), _M_code(__ecode)
 138     { }
 139
 140     /**
 141      * @brief Gets the regex error code.
 142      *
 143      * @returns the regex error code.
 144      */
 145     regex_constants::error_type
 146     code() const
 147     { return _M_code; }
 148
 149   protected:
 150     regex_constants::error_type _M_code;
 151   };
 152
 153
 154   inline void
 155   __throw_regex_error(regex_constants::error_type __ecode)
 156   { throw regex_error(__ecode); }
 157
 158 _GLIBCXX_END_NAMESPACE