include/anna/core/util/RegularExpression.hpp

   1 // ANNA - Anna is Not 'N' Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_core_util_RegularExpression_hpp
  38 #define anna_core_util_RegularExpression_hpp
  39
  40
  41 // STL
  42 #include <string>
  43
  44 // C
  45 #include <regex.h>
  46
  47 #include <anna/core/RuntimeException.hpp>
  48
  49
  50 namespace anna {
  51
  52 /**
  53 * Class helper to manage regular expressions with efficiency (first compile & keep pattern, then reuse match procedure with different values)
  54 */
  55 class RegularExpression {
  56
  57   std::string a_pattern;
  58
  59   bool a_compiled;
  60   regex_t a_preg;
  61
  62
  63   void freeRegex() throw();
  64   void compile() throw(anna::RuntimeException);
  65
  66 public:
  67
  68   RegularExpression(const std::string & pattern = "") : a_pattern(pattern), a_compiled(false) {};
  69   ~RegularExpression() { freeRegex(); }
  70
  71
  72   // set
  73
  74   /**
  75   * Set the pattern for regular expression
  76   *
  77   * @param pattern Pattern
  78   */
  79   void setPattern(const std::string & pattern) throw();
  80
  81
  82   // get
  83
  84   /**
  85   * Get the current pattern for the regular expression
  86   *
  87   * @return Pattern
  88   */
  89   const std::string & getPattern(void) const throw() { return a_pattern; }
  90
  91
  92   // helpers
  93   /**
  94   * Check if value fulfill regular expression
  95   *
  96   * @return Boolean about if value provided match regular expression
  97   */
  98   bool isLike(const std::string & value) throw();
  99
 100   /**
 101   * Same as #isLike
 102   */
 103   bool match(const std::string & value) throw() { return isLike(value); }
 104
 105   /**
 106   * Operator ==
 107   *
 108   * @param re Instance from RegularExpression class
 109   *
 110   * @return Returns re == this comparison based on private 'pattern' member
 111   */
 112   bool operator == (const RegularExpression & re) const;
 113
 114   /**
 115   * Operator <
 116   *
 117   * @param re Instance from RegularExpression class
 118   *
 119   * @return Returns re < this comparison based on private 'pattern' member
 120   */
 121   bool operator < (const RegularExpression & re) const;
 122 };
 123
 124 };
 125
 126
 127 #endif