include/anna/core/util/Tokenizer.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_Tokenizer_hpp
  38 #define anna_core_util_Tokenizer_hpp
  39
  40 #include <string>
  41
  42 #include <anna/core//DataBlock.hpp>
  43
  44 namespace anna {
  45
  46 class RuntimeException;
  47
  48 /**
  49    Separa la cadena recibida en distintos elementos.
  50 */
  51 class Tokenizer {
  52 public:
  53   typedef char* const* const_iterator;
  54
  55   /**
  56      Constructor.
  57   */
  58   Tokenizer();
  59
  60   /**
  61      Constructor.
  62
  63      @param str Cadena sobre la que aplicar la separacion.
  64      @param separator Caracteres que van a actuar como separador de las subcadenas contenidas en el
  65      primer parametro.
  66   */
  67   Tokenizer(const char* str, const char* separator);
  68
  69   /**
  70      Constructor.
  71
  72      @param str Cadena sobre la que aplicar la separacion.
  73      @param separator Caracteres que van a actuar como separador de las subcadenas contenidas en el
  74      primer parametro.
  75   */
  76   Tokenizer(const std::string& str, const char* separator);
  77
  78   /**
  79    * Destructor.
  80    */
  81   virtual ~Tokenizer();
  82
  83   // Accesores
  84   /**
  85      Devuelve el estado del indicador de activacion de eliminacion de espacios de los extremos.
  86      \return El estado del indicador de activacion de eliminacion de espacios de los extremos.
  87   */
  88   bool activateStrip() const throw() { return a_activateStrip; }
  89
  90   // Operadores
  91
  92   /**
  93      Activa y/o desactiva que activa el sistema que permite recoger los elementos retornadodos
  94      por esta clase sin espacios por delante y por detras.
  95      \param _activateStrip Parametro que indica el estado de activacion o desactivacion.
  96   */
  97   void activateStrip(const bool _activateStrip) throw() { a_activateStrip = _activateStrip; }
  98
  99   /**
 100     @return El elemento que ocupa la posicion i-esima.
 101     \warning Este método tiene una eficiencia de O(1), mejor usar iteradores.
 102   */
 103   const char* at(const int i) throw(RuntimeException);
 104
 105   /**
 106     @return El elemento que ocupa la posicion i-esima.
 107     \warning Este método tiene una eficiencia de O(1), mejor usar iteradores.
 108   */
 109   const char* at(const int i) const throw(RuntimeException);
 110
 111   /**
 112     @return El elemento que ocupa la posicion i-esima.
 113     \warning Este método tiene una eficiencia de O(1), mejor usar iteradores.
 114   */
 115   const char* operator [](const int i) throw(RuntimeException) { return at(i); }
 116
 117   /**
 118     @return El elemento que ocupa la posicion i-esima.
 119     \warning Este método tiene una eficiencia de O(1), mejor usar iteradores.
 120   */
 121   const char* operator [](const int i) const throw(RuntimeException) { return at(i); }
 122
 123   /**
 124      Aplica la separacion sobre la cadena str con el separador recibido como parametro.
 125
 126      @param str Cadena sobre la que aplicar la separacion.
 127      @param separator Caracteres que van a actuar como separador de las subcadenas contenidas en el
 128      primer parametro.
 129
 130      @return Numero de elementos obtenidos al aplicar la separacion.
 131
 132   */
 133   int apply(const std::string& str, const char* separator) throw(RuntimeException) {
 134     return apply(str.c_str(), separator);
 135   }
 136
 137   /**
 138      Aplica la separacion sobre la cadena str con el separador recibido como parametro.
 139
 140      @param str Cadena sobre la que aplicar la separacion.
 141      @param separator Caracteres que van a actuar como separador de las subcadenas contenidas en el
 142      primer parametro.
 143
 144      @return Numero de elementos obtenidos al aplicar la separacion.
 145
 146   */
 147   int apply(const char* str, const char* separator) throw(RuntimeException);
 148
 149   // Metodos
 150   /**
 151      @return El ultimo elemento obtenido la aplicar la separacion.
 152   */
 153   const char* last() const throw(RuntimeException);
 154
 155   /**
 156    * Devuelve el número de elementos obtenidos en la separación.
 157    * \return el número de elementos obtenidos en la separación.
 158    */
 159   int size() const throw() { return a_maxItem; }
 160
 161   /**
 162    * Devuelve el iterador el comiento de los elementos obtenidos por #apply
 163    * \return el iterador el comiento de los elementos obtenidos por #apply
 164    */
 165   const_iterator begin() const throw() { return a_items; }
 166
 167   /**
 168    * Devuelve el iterador al final de los elementos obtenidos por #apply
 169    * \return el iterador al final de los elementos obtenidos por #apply
 170    */
 171   const_iterator end() const throw() { return a_items + a_maxItem; }
 172
 173   /**
 174      Devuelve la cadena referenciada por el iterator recibido como parametro.
 175      \return la cadena referenciada por el iterator recibido como parametro.
 176   */
 177   static const char* data(const_iterator ii) throw() { return *ii; }
 178
 179 private:
 180   static const int MaxItem;
 181
 182   anna::DataBlock a_dataBlock;
 183   bool a_activateStrip;
 184   char** a_items;
 185   int a_maxItem;
 186
 187   static char* strip(char* str) throw();
 188
 189   void indexException(const int index, const char* fromFile, const int fromLine) const throw(RuntimeException);
 190 };
 191
 192 }
 193
 194 #endif