datasourceinfoloader.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_DATASOURCEINFO_DATASOURCEINFOLOADER_H
#define SOMAIO_DATASOURCEINFO_DATASOURCEINFOLOADER_H
//--- soma-io ----------------------------------------------------------------
#include <soma-io/config/soma_config.h>
#include <soma-io/io/formatdictionary.h>                    // IOObjectTypesDictionary
//--- cartobase --------------------------------------------------------------
#include <cartobase/object/syntax.h>                              // SyntaxSet
#include <cartobase/object/object.h>                        // usage of none()
//--- system -----------------------------------------------------------------
#include <vector>
#include <string>
//----------------------------------------------------------------------------

namespace soma
{
  class FormatChecker;
  class DataSource;
  class DataSourceInfo;
  
  class DataSourceInfoLoader
  {
    public:
      enum State { Unchecked, Ok, Error };
      DataSourceInfoLoader();
      ~DataSourceInfoLoader();

      static void registerFormat( const std::string & fmtid, 
                                  FormatChecker* format, 
                                  const std::vector<std::string> & 
                                    extensions );
      static FormatChecker* formatInfo( const std::string & format );

      DataSourceInfo check( DataSourceInfo dsi, 
                            carto::Object options = carto::none(),
                            int passbegin = 1, int passend = 3 );

      State state() const;
      std::string errorMessage() const;
      void launchException();

      static carto::Object readMinf( DataSource & ds, 
                                     carto::Object base = carto::none(),
                                     carto::Object options = carto::none() );
      static carto::SyntaxSet & minfSyntax();

      static std::set<std::string> extensions( const std::string & format );
      
      static std::set<std::string> formats( const std::string & ext );

      static std::set<std::string> readFormats(const std::string & ext,
                                               const std::string & data_type_name);

      static std::set<std::string> writeFormats(const std::string & ext,
                                                const std::string & data_type_name);

    protected:
      static std::set<std::string> formats(
          const std::string & ext, 
          soma::IOObjectTypesDictionary::FormatInfo & format_info
      );
      
      struct Private;
      Private *d;
  };
  
}

#endif