include/anna/io/AbstractReader.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_io_AbstractReader_hpp
  38 #define anna_io_AbstractReader_hpp
  39
  40 #include <stdio.h>
  41 #include <string>
  42
  43 #include <anna/core/RuntimeException.hpp>
  44
  45 namespace anna {
  46
  47 namespace io {
  48
  49 /**
  50    Lector de ficheros de texto.
  51 */
  52 class AbstractReader {
  53 public:
  54   /**
  55      Destructor.
  56   */
  57   virtual ~AbstractReader();
  58
  59   /**
  60      Devuelve la estructura de bajo nivel con la que leemos el archivo.
  61      \return La estructura de bajo nivel con la que leemos el archivo.
  62   */
  63   FILE* getFile() throw() { return a_file; }
  64
  65   /**
  66      Devuelve \em true si el fichero indicado en el constructor puede ser tratado
  67      \em false en otro caso.
  68      \return \em true si el fichero indicado en el constructor puede ser tratado
  69      \em false en otro caso.
  70   */
  71   bool isok() const throw() { return a_file != NULL; }
  72
  73   /**
  74      Prepara esta instancia para trabajar con un nuevo archivo.
  75      \param filename Nombre del archivo con el que trabajar.
  76   */
  77   void open(const std::string& filename) throw(anna::RuntimeException);
  78
  79   /**
  80      Libera los recursos del fichero.
  81   */
  82   void close() throw();
  83
  84 protected:
  85   FILE* a_file;
  86
  87   /**
  88      Constructor.
  89      \param maxLength Longitud maxima de linea del fichero a tratar.
  90      \warning Con esta clase solo podemos tratar archivos de texto. Si utilizamos este constructor
  91      debemos invocar al método open antes de usar cualquier otro método de la clase.
  92   */
  93   AbstractReader();
  94
  95   /**
  96      Constructor.
  97      \param filename Ruta completa del fichero a leer.
  98      \warning Con esta clase solo podemos tratar archivos de texto.
  99   */
 100   explicit AbstractReader(const char* filename);
 101
 102   /**
 103      Constructor.
 104      \param filename Ruta completa del fichero a leer.
 105      \warning Con esta clase solo podemos tratar archivos de texto.
 106   */
 107   explicit AbstractReader(const std::string& filename);
 108
 109   /*
 110    * Verifica que el fichero fué abierto correctamente.
 111    * \warning Exclusivamente de uso interno.
 112    */
 113   void verify() throw(RuntimeException);
 114
 115 private:
 116   const std::string a_filename;
 117   RuntimeException* a_ex;
 118 };
 119
 120 }
 121 }
 122 #endif