soma-io  5.0.5
minfXML2.h
Go to the documentation of this file.
1 /* This software and supporting documentation are distributed by
2  * Institut Federatif de Recherche 49
3  * CEA/NeuroSpin, Batiment 145,
4  * 91191 Gif-sur-Yvette cedex
5  * France
6  *
7  * This software is governed by the CeCILL-B license under
8  * French law and abiding by the rules of distribution of free software.
9  * You can use, modify and/or redistribute the software under the
10  * terms of the CeCILL-B license as circulated by CEA, CNRS
11  * and INRIA at the following URL "http://www.cecill.info".
12  *
13  * As a counterpart to the access to the source code and rights to copy,
14  * modify and redistribute granted by the license, users are provided only
15  * with a limited warranty and the software's author, the holder of the
16  * economic rights, and the successive licensors have only limited
17  * liability.
18  *
19  * In this respect, the user's attention is drawn to the risks associated
20  * with loading, using, modifying and/or developing or reproducing the
21  * software by the user in light of its specific status of free software,
22  * that may mean that it is complicated to manipulate, and that also
23  * therefore means that it is reserved for developers and experienced
24  * professionals having in-depth computer knowledge. Users are therefore
25  * encouraged to load and test the software's suitability as regards their
26  * requirements in conditions enabling the security of their systems and/or
27  * data to be ensured and, more generally, to use and operate it in the
28  * same conditions as regards security.
29  *
30  * The fact that you are presently reading this means that you have had
31  * knowledge of the CeCILL-B license and that you accept its terms.
32  */
33 
34 #ifndef SOMAIO_UTILITIES_MINFXML2_H
35 #define SOMAIO_UTILITIES_MINFXML2_H
36 //--- soma-io ----------------------------------------------------------------
37 #include <soma-io/config/soma_config.h>
38 #include <soma-io/datasource/filedatasource.h>
39 //--- cartobase --------------------------------------------------------------
40 #include <cartobase/object/object.h>
41 #include <cartobase/object/syntax.h>
42 #include <cartobase/type/string_conversion.h>
43 //----------------------------------------------------------------------------
44 
45 namespace soma {
46 
47 
48 //----------------------------------------------------------------------------
49 // XML tags and attributes
50 //----------------------------------------------------------------------------
51 
52 
53 extern const std::string minfTag;
54 extern const std::string noneTag;
55 extern const std::string trueTag;
56 extern const std::string falseTag;
57 extern const std::string numberTag;
58 extern const std::string stringTag;
59 extern const std::string listTag;
60 extern const std::string dictionaryTag;
61 extern const std::string factoryTag;
62 extern const std::string xhtmlTag;
63 extern const std::string referenceTag;
64 
65 extern const std::string expanderAttribute;
66 extern const std::string lengthAttribute;
67 extern const std::string nameAttribute;
68 extern const std::string objectTypeAttribute;
69 extern const std::string identifierAttribute;
70 
71 
72 //-----------------------------------------------------------------------------
73 carto::Object readDictionaryMinfXML( const std::string &fileName,
74  carto::rc_ptr<carto::SyntaxSet> syntax
75  = carto::rc_ptr<carto::SyntaxSet>() );
76 carto::Object readDictionaryMinfXML( DataSource &source,
77  carto::rc_ptr<carto::SyntaxSet> syntax
78  = carto::rc_ptr<carto::SyntaxSet>() );
79 void readDictionaryMinfXML( const std::string &fileName,
80  carto::Object &dictionary,
81  carto::rc_ptr<carto::SyntaxSet> syntax
82  = carto::rc_ptr<carto::SyntaxSet>() );
83 void readDictionaryMinfXML( DataSource &source,
84  carto::Object &dictionary,
85  carto::rc_ptr<carto::SyntaxSet> syntax
86  = carto::rc_ptr<carto::SyntaxSet>() );
90 void init_libXML();
91 
92 
93 //----------------------------------------------------------------------------
94 class ObjectListener : public virtual carto::RCObject
95 {
96 public:
97  virtual ~ObjectListener();
98 
99  virtual void nextObject( const carto::Object & ) = 0;
100  virtual void noMoreObject() = 0;
101 };
102 
103 
104 //----------------------------------------------------------------------------
105 class MinfTreeExpander;
106 class MinfNodeExpander : public virtual carto::RCObject
107 {
108 public:
109  virtual ~MinfNodeExpander();
110 
111  virtual std::string startStructure( MinfTreeExpander &,
112  const std::string &nodeType,
113  const std::string &identifier,
114  carto::Object attributes,
115  const std::string &parentSyntax=std::string(),
116  const std::string &name=std::string() ) = 0;
117  virtual void endStructure( MinfTreeExpander &, const std::string &nodeType ) = 0;
118  virtual void atom( MinfTreeExpander &, carto::Object, const std::string &identifier ) = 0;
119  virtual void reference( MinfTreeExpander &, const std::string &identifier ) = 0;
120 };
121 
122 
123 //----------------------------------------------------------------------------
124 class MinfTreeExpander : public virtual carto::RCObject
125 {
126 public:
127  MinfTreeExpander();
128  virtual ~MinfTreeExpander();
129 
130  void push( carto::rc_ptr< MinfNodeExpander > );
131  carto::rc_ptr< MinfNodeExpander > pop();
132 
133  void addReference( const std::string &identifier, carto::Object value );
134  carto::Object getReferencedObject( const std::string &identifier );
135 
136  virtual std::string startStructure( const std::string &nodeType,
137  const std::string &identifier,
138  carto::Object attributes,
139  const std::string &parentSyntax=std::string(),
140  const std::string &name=std::string() );
141  virtual void endStructure( const std::string &nodeType );
142  virtual void atom( carto::Object, const std::string &identifier );
143  virtual void reference( const std::string &identifier );
144 
145 private:
146  std::list< carto::rc_ptr< MinfNodeExpander > > _stack;
147  std::map< std::string, carto::Object > _references;
148 };
149 
150 
151 //----------------------------------------------------------------------------
152 class DefaultMinfNodeExpander : public MinfNodeExpander
153 {
154 public:
155  DefaultMinfNodeExpander( carto::rc_ptr< ObjectListener > ol
156  = carto::rc_ptr< ObjectListener >(),
157  carto::rc_ptr<carto::SyntaxSet> syntax
158  = carto::rc_ptr<carto::SyntaxSet>() );
159  DefaultMinfNodeExpander( carto::rc_ptr<carto::SyntaxSet> syntax );
160  virtual ~DefaultMinfNodeExpander();
161 
162  virtual std::string startStructure( MinfTreeExpander &,
163  const std::string &nodeType,
164  const std::string &identifier,
165  carto::Object attributes,
166  const std::string &parentSyntax=std::string(),
167  const std::string &name=std::string() );
168  virtual void endStructure( MinfTreeExpander &, const std::string &nodeType );
169  virtual void atom( MinfTreeExpander &, carto::Object, const std::string &identifier );
170  virtual void reference( MinfTreeExpander &, const std::string &identifier );
171 
172 private:
173 
174  carto::rc_ptr< ObjectListener > _objectListener;
175 
176 protected:
177 
178  carto::rc_ptr<carto::SyntaxSet> _syntax;
179 };
180 
181 
182 //----------------------------------------------------------------------------
183 class SingleDictionaryExpander : public DefaultMinfNodeExpander
184 {
185 public:
186  SingleDictionaryExpander( carto::Object dictionary,
187  carto::rc_ptr<carto::SyntaxSet> syntax );
188  virtual ~SingleDictionaryExpander();
189 
190  virtual std::string startStructure( MinfTreeExpander &,
191  const std::string &nodeType,
192  const std::string &identifier,
193  carto::Object attributes,
194  const std::string &parentSyntax=std::string(),
195  const std::string &name=std::string() );
196 
197 private:
198 
199  carto::Object _dictionary;
200 };
201 
202 
203 //----------------------------------------------------------------------------
204 class ListBuilder : public ObjectListener
205 {
206 public:
207  ListBuilder();
208  ListBuilder( carto::Object );
209  ListBuilder( carto::rc_ptr< ObjectListener > );
210  ListBuilder( carto::Object, carto::rc_ptr< ObjectListener > );
211  virtual ~ListBuilder();
212 
213  virtual void nextObject( const carto::Object & );
214  virtual void noMoreObject();
215 
216  carto::Object result;
217 private:
218 
219  carto::rc_ptr< ObjectListener > _objectListener;
220 };
221 
222 
223 //----------------------------------------------------------------------------
224 class DictionaryBuilder : public ObjectListener
225 {
226 public:
227  DictionaryBuilder();
228  DictionaryBuilder( carto::Object );
229  DictionaryBuilder( carto::rc_ptr< ObjectListener > );
230  DictionaryBuilder( carto::Object, carto::rc_ptr< ObjectListener > );
231  virtual ~DictionaryBuilder();
232 
233  virtual void nextObject( const carto::Object & );
234  virtual void noMoreObject();
235 
236  carto::Object result;
237 
238 private:
239 
240  carto::Object _key;
241  carto::rc_ptr< ObjectListener > _objectListener;
242 };
243 
244 
245 
246 //----------------------------------------------------------------------------
247 class MinfXMLReader : public virtual carto::RCObject
248 {
249 public:
250  MinfXMLReader( MinfTreeExpander &, carto::rc_ptr<carto::SyntaxSet> syntax );
251  void read( const std::string & );
252  void read( DataSource & );
253 
254 private:
255 
256  MinfTreeExpander &_expander;
257  carto::rc_ptr< carto::SyntaxSet > _syntax;
258 };
259 
260 
261 //----------------------------------------------------------------------------
262 // class TestMinfTreeExpander : public virtual MinfNodeExpander
263 // {
264 // public:
265 // TestMinfTreeExpander();
266 // virtual ~TestMinfTreeExpander();
267 //
268 // virtual void startStructure( MinfTreeExpander &,
269 // const std::string &nodeType,
270 // const std::string &identifier,
271 // carto::Object attributes );
272 // virtual void endStructure( MinfTreeExpander &, const std::string &nodeType );
273 // virtual void atom( MinfTreeExpander &, carto::Object, const std::string &identifier );
274 // virtual void reference( MinfTreeExpander &, const std::string &identifier );
275 //
276 // private:
277 //
278 // int _level;
279 // };
280 
281 } // namespace soma
282 
283 #endif // ifndef SOMAIO_UTILITIES_MINFXML2_H
soma_config.h
soma::ObjectListener::~ObjectListener
virtual ~ObjectListener()
soma::trueTag
const std::string trueTag
soma::stringTag
const std::string stringTag
soma::DefaultMinfNodeExpander::_syntax
carto::rc_ptr< carto::SyntaxSet > _syntax
Definition: minfXML2.h:178
soma::ObjectListener::nextObject
virtual void nextObject(const carto::Object &)=0
soma::identifierAttribute
const std::string identifierAttribute
soma::referenceTag
const std::string referenceTag
string_conversion.h
soma::DataSource
Abstraction layer for various data sources (file, buffer, socket...).
Definition: datasource.h:64
soma
Definition: allocator.h:48
soma::init_libXML
void init_libXML()
just to force initializing libxml2, needs to be called once from the main thread in a multi-threaded ...
soma::dictionaryTag
const std::string dictionaryTag
soma::numberTag
const std::string numberTag
soma::factoryTag
const std::string factoryTag
carto::rc_ptr< carto::SyntaxSet >
soma::DictionaryBuilder::result
carto::Object result
Definition: minfXML2.h:236
soma::objectTypeAttribute
const std::string objectTypeAttribute
soma::ListBuilder::result
carto::Object result
Definition: minfXML2.h:216
soma::expanderAttribute
const std::string expanderAttribute
soma::lengthAttribute
const std::string lengthAttribute
soma::falseTag
const std::string falseTag
soma::listTag
const std::string listTag
soma::readDictionaryMinfXML
carto::Object readDictionaryMinfXML(const std::string &fileName, carto::rc_ptr< carto::SyntaxSet > syntax=carto::rc_ptr< carto::SyntaxSet >())
soma::xhtmlTag
const std::string xhtmlTag
soma::noneTag
const std::string noneTag
soma::nameAttribute
const std::string nameAttribute
soma::minfTag
const std::string minfTag
soma::ObjectListener::noMoreObject
virtual void noMoreObject()=0