include/anna/io/TextReader.hpp

   1 // ANNA - Anna is Not Nothingness 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_io_TextReader_hpp
  38 #define anna_io_TextReader_hpp
  39
  40 #include <anna/io/AbstractReader.hpp>
  41
  42 namespace anna {
  43
  44 namespace io {
  45
  46 /**
  47    Lector de ficheros de texto.
  48 */
  49 class TextReader : public AbstractReader {
  50 public:
  51   /**
  52      Constructor.
  53      \param maxLength Longitud máxima de línea del fichero a tratar.
  54      \warning Con esta clase solo podemos tratar archivos de texto. Si utilizamos este constructor
  55      debemos invocar al método open antes de usar cualquier otro método de la clase.
  56   */
  57   TextReader(const int maxLength = 512);
  58
  59   /**
  60      Constructor.
  61      \param filename Ruta completa del fichero a leer.
  62      \param maxLength Longitud máxima de línea del fichero a tratar.
  63      \warning Con esta clase solo podemos tratar archivos de texto.
  64   */
  65   TextReader(const char* filename, const int maxLength = 512);
  66
  67   /**
  68      Constructor.
  69      \param filename Ruta completa del fichero a leer.
  70      \param maxLength Longitud máxima de línea del fichero a tratar.
  71      \warning Con esta clase solo podemos tratar archivos de texto.
  72   */
  73   TextReader(const std::string& filename, const int maxLength = 512);
  74
  75   /**
  76      Destructor.
  77   */
  78   virtual ~TextReader();
  79
  80   /**
  81      Devuelve el contenido de la línea actual o NULL si se ha llegado al fin del fichero.
  82      \return El contenido de la línea actual o NULL si se ha llegado al fin del fichero.
  83   */
  84   const char* fetch() throw(anna::RuntimeException);
  85
  86 private:
  87   char* a_buffer;
  88   const int a_maxLength;
  89 };
  90
  91 }
  92 }
  93 #endif