minfXML2.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_UTILITIES_MINFXML2_H
#define SOMAIO_UTILITIES_MINFXML2_H
//--- soma-io ----------------------------------------------------------------
#include <soma-io/config/soma_config.h>
#include <soma-io/datasource/filedatasource.h>
//--- cartobase --------------------------------------------------------------
#include <cartobase/object/object.h>
#include <cartobase/object/syntax.h>
#include <cartobase/type/string_conversion.h>
//----------------------------------------------------------------------------
 
namespace soma {
 
 
//----------------------------------------------------------------------------
// XML tags and attributes
//----------------------------------------------------------------------------
 
 
extern const std::string minfTag;
extern const std::string noneTag;
extern const std::string trueTag;
extern const std::string falseTag;
extern const std::string numberTag;
extern const std::string stringTag;
extern const std::string listTag;
extern const std::string dictionaryTag;
extern const std::string factoryTag;
extern const std::string xhtmlTag;
extern const std::string referenceTag;
 
extern const std::string expanderAttribute;
extern const std::string lengthAttribute;
extern const std::string nameAttribute;
extern const std::string objectTypeAttribute;
extern const std::string identifierAttribute;
 
 
//-----------------------------------------------------------------------------
carto::Object readDictionaryMinfXML( const std::string &fileName, 
                                     carto::rc_ptr<carto::SyntaxSet> syntax 
                                       = carto::rc_ptr<carto::SyntaxSet>() );
carto::Object readDictionaryMinfXML( DataSource &source, 
                                     carto::rc_ptr<carto::SyntaxSet> syntax 
                                       = carto::rc_ptr<carto::SyntaxSet>() );
void readDictionaryMinfXML( const std::string &fileName, 
                            carto::Object &dictionary, 
                            carto::rc_ptr<carto::SyntaxSet> syntax 
                              = carto::rc_ptr<carto::SyntaxSet>() );
void readDictionaryMinfXML( DataSource &source, 
                            carto::Object &dictionary, 
                            carto::rc_ptr<carto::SyntaxSet> syntax 
                              = carto::rc_ptr<carto::SyntaxSet>() );
void init_libXML();
 
 
//----------------------------------------------------------------------------
class ObjectListener : public virtual carto::RCObject
{
public:
  virtual ~ObjectListener();
 
  virtual void nextObject( const carto::Object & ) = 0;
  virtual void noMoreObject() = 0;
};
 
 
//----------------------------------------------------------------------------
class MinfTreeExpander;
class MinfNodeExpander : public virtual carto::RCObject
{
public:
  virtual ~MinfNodeExpander();
 
  virtual std::string startStructure( MinfTreeExpander &,
                               const std::string &nodeType,
                               const std::string &identifier,
                               carto::Object attributes,
                               const std::string &parentSyntax=std::string(), 
                               const std::string &name=std::string() ) = 0;
  virtual void endStructure( MinfTreeExpander &, const std::string &nodeType ) = 0;
  virtual void atom( MinfTreeExpander &, carto::Object, const std::string &identifier  ) = 0;
  virtual void reference( MinfTreeExpander &, const std::string &identifier ) = 0;
};
 
 
//----------------------------------------------------------------------------
class MinfTreeExpander : public virtual carto::RCObject
{
public:
  MinfTreeExpander();
  virtual ~MinfTreeExpander();
 
  void push( carto::rc_ptr< MinfNodeExpander > );
  carto::rc_ptr< MinfNodeExpander > pop();
 
  void addReference( const std::string &identifier, carto::Object value );
  carto::Object getReferencedObject( const std::string &identifier );
 
  virtual std::string startStructure( const std::string &nodeType,
                               const std::string &identifier,
                               carto::Object attributes,
                               const std::string &parentSyntax=std::string(), 
                               const std::string &name=std::string() );
  virtual void endStructure( const std::string &nodeType );
  virtual void atom( carto::Object, const std::string &identifier  );
  virtual void reference( const std::string &identifier );
 
private:
  std::list< carto::rc_ptr< MinfNodeExpander > > _stack;
  std::map< std::string, carto::Object > _references;
};
 
 
//----------------------------------------------------------------------------
class DefaultMinfNodeExpander : public MinfNodeExpander
{
public:
  DefaultMinfNodeExpander( carto::rc_ptr< ObjectListener > ol 
                             = carto::rc_ptr< ObjectListener >(),
                           carto::rc_ptr<carto::SyntaxSet> syntax 
                             = carto::rc_ptr<carto::SyntaxSet>() );
  DefaultMinfNodeExpander( carto::rc_ptr<carto::SyntaxSet> syntax );
  virtual ~DefaultMinfNodeExpander();
 
  virtual std::string startStructure( MinfTreeExpander &,
                               const std::string &nodeType,
                               const std::string &identifier,
                               carto::Object attributes,
                               const std::string &parentSyntax=std::string(), 
                               const std::string &name=std::string() );
  virtual void endStructure( MinfTreeExpander &, const std::string &nodeType );
  virtual void atom( MinfTreeExpander &, carto::Object, const std::string &identifier  );
  virtual void reference( MinfTreeExpander &, const std::string &identifier );
 
private:
 
  carto::rc_ptr< ObjectListener > _objectListener;
 
protected:
 
  carto::rc_ptr<carto::SyntaxSet> _syntax;
};
 
 
//----------------------------------------------------------------------------
class SingleDictionaryExpander : public DefaultMinfNodeExpander
{
public:
  SingleDictionaryExpander( carto::Object dictionary, 
                            carto::rc_ptr<carto::SyntaxSet> syntax );
  virtual ~SingleDictionaryExpander();
 
  virtual std::string startStructure( MinfTreeExpander &,
                               const std::string &nodeType,
                               const std::string &identifier,
                               carto::Object attributes,
                               const std::string &parentSyntax=std::string(), 
                               const std::string &name=std::string() );
 
private:
 
  carto::Object _dictionary;
};
 
 
//----------------------------------------------------------------------------
class ListBuilder : public ObjectListener
{
public:
  ListBuilder();
  ListBuilder( carto::Object );
  ListBuilder( carto::rc_ptr< ObjectListener > );
  ListBuilder( carto::Object, carto::rc_ptr< ObjectListener > );
  virtual ~ListBuilder();
 
  virtual void nextObject( const carto::Object & );
  virtual void noMoreObject();
 
  carto::Object result;
private:
 
  carto::rc_ptr< ObjectListener > _objectListener;
};
 
 
//----------------------------------------------------------------------------
class DictionaryBuilder : public ObjectListener
{
public:
  DictionaryBuilder();
  DictionaryBuilder( carto::Object );
  DictionaryBuilder( carto::rc_ptr< ObjectListener > );
  DictionaryBuilder( carto::Object, carto::rc_ptr< ObjectListener > );
  virtual ~DictionaryBuilder();
 
  virtual void nextObject( const carto::Object & );
  virtual void noMoreObject();
 
  carto::Object result;
 
private:
 
  carto::Object _key;
  carto::rc_ptr< ObjectListener > _objectListener;
};
 
 
 
//----------------------------------------------------------------------------
class MinfXMLReader : public virtual carto::RCObject
{
public:
  MinfXMLReader( MinfTreeExpander &, carto::rc_ptr<carto::SyntaxSet> syntax );
  void read( const std::string & );
  void read( DataSource & );
 
private:
 
  MinfTreeExpander &_expander;
  carto::rc_ptr< carto::SyntaxSet > _syntax;
};
 
 
//----------------------------------------------------------------------------
// class TestMinfTreeExpander : public virtual MinfNodeExpander
// {
// public:
//   TestMinfTreeExpander();
//   virtual ~TestMinfTreeExpander();
// 
//   virtual void startStructure( MinfTreeExpander &,
//                                const std::string &nodeType,
//                                const std::string &identifier,
//                                carto::Object attributes );
//   virtual void endStructure( MinfTreeExpander &, const std::string &nodeType );
//   virtual void atom( MinfTreeExpander &, carto::Object, const std::string &identifier  );
//   virtual void reference( MinfTreeExpander &, const std::string &identifier );
// 
// private:
// 
//   int _level;
// };
 
} // namespace soma
 
#endif // ifndef SOMAIO_UTILITIES_MINFXML2_H