writer.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_WRITER_H
#define SOMAIO_IO_WRITER_H
//--- soma-io ----------------------------------------------------------------
#include <soma-io/config/soma_config.h>
//--- cartobase --------------------------------------------------------------
#include <cartobase/object/object.h>
//----------------------------------------------------------------------------

namespace soma
{
  class DataSource;
  class DataSourceInfo;

  class GenericWriter
  {
  public:
    GenericWriter();
    GenericWriter( carto::rc_ptr<DataSource> ds );
    GenericWriter( const std::string & filename );
    GenericWriter( std::ostream & stream );
    virtual ~GenericWriter();

    template <typename T>
    bool write( const T & obj, carto::Object options = carto::none() );

    virtual std::string writtenObjectType() const = 0;

    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 );
    void attach( std::ostream & stream );

    void flush();
    void close();

  protected:
    carto::rc_ptr<DataSourceInfo>  _datasourceinfo;
  };


  // Specialize write<Object> to be the same as write<GenericObject>
  template <> inline bool GenericWriter::write( const carto::Object & obj,
                                                carto::Object options )
  {
    return write( *obj, options );
  }


  template<class T> class Writer : public GenericWriter
  {
  public:
    /* Note: constructors used to be inline, but this triggered a
       compiler/linker bug on MacOS 10.5, so we moved them to non-inline.
    */
    Writer();
    Writer( carto::rc_ptr<DataSource> ds );
    Writer( const std::string& filename );
    Writer( std::ostream & stream );
    virtual ~Writer();

    virtual bool write( const T & obj,
                        carto::Object options = carto::none(),
                        int passbegin = 1 , int passend = 4 );

    virtual std::string writtenObjectType() const;
  };


  // Specialize Writer<Object> to be the same as Writer<GenericObject>
  template <> inline bool Writer<carto::Object>::write(
    const carto::Object & obj, carto::Object options,
    int passbegin, int passend )
  {
    Writer<carto::GenericObject> w( dataSource() );
    return w.write( *obj, options, passbegin, passend );
  }

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

template <class T>
inline soma::GenericWriter &
operator << ( soma::GenericWriter & writer, const T & thing )
{
  writer.write( thing );
  return writer;
}


template <class T>
inline soma::Writer<T> &
operator << ( soma::Writer<T> & writer, const T & thing )
{
  writer.write( thing );
  return writer;
}


#endif