fileFormat.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.
 */

/*
 *  Data reader class
 */
#ifndef AIMS_IO_FORMAT_H
#define AIMS_IO_FORMAT_H

#include <aims/config/aimsdata_config.h>
#include <aims/def/general.h>
#include <aims/io/datatypecode.h>
#include <string>
#include <map>
#include <vector>
#include <set>


namespace carto
{
  class Mutex;
}

namespace aims
{
  class Finder;

  template<class T> class FileFormat
  {
  public:
    virtual ~FileFormat();
    virtual bool read( const std::string & filename, T & obj, 
                       const carto::AllocatorContext & context, 
                       carto::Object options ) = 0;
    virtual T* read( const std::string & filename, 
                     const carto::AllocatorContext & context, 
                     carto::Object options );
    virtual bool write( const std::string &, const T &,
      carto::Object options = carto::none() );
  };


  class FinderFormat
  {
  public:
    virtual ~FinderFormat();
    virtual bool check( const std::string & filename, Finder & f ) const = 0;
  };


  template<class T> class FileFormatDictionary
  {
  public:
    static void registerFormat( const std::string & formatID, 
                                FileFormat<T>* format,
                                const std::vector<std::string> & extensions,
                                const std::string & before = "" );
    static void unregisterFormat( const std::string & formatID );
    static FileFormat<T>* fileFormat( const std::string & format );
    static const std::map<std::string, std::list<std::string> > & extensions();
    static std::set<std::string> formats();
    static void registerBaseFormats();
    static std::string fileExtension( const std::string & filename );
    static void init();

  private:
    static std::map<std::string, FileFormat<T>*>        & _formats();
    static std::map<std::string, std::list<std::string> > &
        _extensions();
    static carto::Mutex & mutex();
  };


  class IOObjectTypesDictionary
  {
  public:
    typedef std::set<std::string> (*FormatInfo)();
    static void registerType( const std::string & objtype, 
                              const std::string & datatype, FormatInfo info );
    static bool hasType( const std::string & objtype, 
                         const std::string & datatype );
    static std::map<std::string, std::map<std::string, FormatInfo> > & types();
  };

}

#endif