reader.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_IO_READER_H
#define SOMAIO_IO_READER_H
//--- soma-io ----------------------------------------------------------------
#include <soma-io/config/soma_config.h>
#include <soma-io/datasource/datasourcelist.h>
#include <soma-io/allocator/allocator.h>
//--- cartobase --------------------------------------------------------------
#include <cartobase/object/object.h>
//--- system -----------------------------------------------------------------
#include <string>
//----------------------------------------------------------------------------

namespace soma
{

  template <typename T>
  class Reader
  {
  public:
    //========================================================================
    //   C O N S T R U C T O R S
    //========================================================================
    Reader();
    Reader( const std::string & filename );
    Reader( carto::rc_ptr<DataSource> ds );
    Reader( carto::rc_ptr<DataSourceInfo> dsi );
    Reader( std::istream & stream );
    virtual ~Reader();

    //========================================================================
    //   R E A D I N G
    //========================================================================
    virtual bool read( T & obj, carto::Object header = carto::none(),
                       int passbegin = 1, int passend = 4 );

    virtual T* read( carto::Object header = carto::none(),
                     int passbegin = 1, int passend = 4 );

    //========================================================================
    //   D A T A S O U R C E I N F O
    //========================================================================
    const carto::rc_ptr<DataSourceInfo> & dataSourceInfo() const 
            { return _datasourceinfo; }
          carto::rc_ptr<DataSourceInfo> & dataSourceInfo()
            { return _datasourceinfo; }

    //========================================================================
    //   A L L O C A T O R
    //========================================================================
    void setAllocatorContext( const AllocatorContext & ac );
    const AllocatorContext & allocatorContext() const;

    //========================================================================
    //   O P T I O N S
    //========================================================================
    void setOptions( carto::Object options );
    carto::Object   options() const;
    carto::Object & options();

    //========================================================================
    //   D A T A S O U R C E
    //========================================================================
    // these methods are kept for compability. They manipulate the "default" 
    // datasource
    const carto::rc_ptr<DataSource> dataSource() const;
          carto::rc_ptr<DataSource> dataSource();
    void attach( carto::rc_ptr<DataSource> ds );
    void attach( const std::string & filename, offset_t offset = 0 );
    void attach( std::istream & stream );

    //========================================================================
    //   C O N T R O L
    //========================================================================
    void flush();
    void close();
    // void flushAll();
    // void closeAll();

    //========================================================================
    //   U T I L I T I E S
    //========================================================================
    // is it actually used or implemented somewhere ?
    static std::string extension( const std::string & filename );

  protected:
    carto::rc_ptr<DataSourceInfo>  _datasourceinfo;
    AllocatorContext               _alloccontext;
    carto::Object                  _options;
  };

  extern template class Reader<carto::GenericObject>;
  extern template class Reader<carto::Object>;
}

//============================================================================
//   S T R E A M   O P E R A T O R
//============================================================================
template <class T>
inline soma::Reader<T> &
operator >> ( soma::Reader<T> & reader, T & thing )
{
  reader.read( thing );
  return reader;
}

#endif