areader.h

Go to the documentation of this file.

/* This software and supporting documentation are distributed by
 *     Institut Federatif de Recherche 49
 *     CEA/NeuroSpin, Batiment 145,
 *     91191 Gif-sur-Yvette cedex
 *     France
 *
 * This software is governed by the CeCILL-B license under
 * French law and abiding by the rules of distribution of free software.
 * You can  use, modify and/or redistribute the software under the
 * terms of the CeCILL-B license as circulated by CEA, CNRS
 * and INRIA at the following URL "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 *
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the
 * same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-B license and that you accept its terms.
 */

#ifndef SOMAIO_READER_AREADER_H
#define SOMAIO_READER_AREADER_H
//--- soma-io ----------------------------------------------------------------
#include <soma-io/config/soma_config.h>
#include <soma-io/datasource/datasource.h>
//--- cartobase --------------------------------------------------------------
#include <cartobase/config/cartobase_config.h>
#ifndef CARTOBASE_OBJECT_SYNTAX_H
  #include <cartobase/object/syntax.h>
#endif
#include <cartobase/object/object.h>
//----------------------------------------------------------------------------

namespace soma
{

  //=========================================================================
  //    C L A S S  D E C L A R A T I O N
  //=========================================================================

  class CARTOBASE_API AttributedReader
  {

  public:

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------

    typedef void (*Helper)( carto::GenericObject&, const std::string&, 
                            DataSource &);
    typedef std::map<std::string,Helper> HelperSet;


    //------------------------------------------------------------------------
    //------------------------------------------------------------------------

    AttributedReader( carto::rc_ptr<DataSource> ds,
                      const carto::SyntaxSet& rules,
                      const HelperSet& helpers = HelperSet() );

    AttributedReader(const std::string& filename,
                     const carto::SyntaxSet& rules,
                     const HelperSet& helpers = HelperSet());

    AttributedReader(const carto::SyntaxSet& rules,
                     const HelperSet& helpers = HelperSet());

    virtual ~AttributedReader();


    //------------------------------------------------------------------------
    //------------------------------------------------------------------------

    void open(const std::string& filename);
    void attach( carto::rc_ptr<DataSource> ds );
    void attach( std::istream & stream, int line_num = 1 );

    void close();
    carto::rc_ptr<DataSource> dataSource() { return _datasource; }


    //------------------------------------------------------------------------
    //------------------------------------------------------------------------

    virtual std::string name() const;

    int line() const;


    //------------------------------------------------------------------------
    //------------------------------------------------------------------------

    bool operator!() const;

    bool is_open() const;

    bool eof() const;


  protected:

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------

    void readAttribute(carto::GenericObject& object, 
                       const std::string& semantic);

    // DO NOT USE! DEPRECIATED
    void readAttribute(carto::GenericObject* object, 
                       const std::string& semantic)
      __attribute__((__deprecated__));


    //------------------------------------------------------------------------
    //------------------------------------------------------------------------

    carto::SyntaxSet _rules;

    carto::rc_ptr<DataSource> _datasource;

    HelperSet _helpers;


  private:

    void init();

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------

    AttributedReader(const AttributedReader&);

    AttributedReader& operator=(const AttributedReader&);

  };

}

#endif