bioformats  5.1.8
XMLTools.h
1 /*
2  * #%L
3  * OME-BIOFORMATS C++ library for image IO.
4  * Copyright © 2006 - 2016 Open Microscopy Environment:
5  * - Massachusetts Institute of Technology
6  * - National Institutes of Health
7  * - University of Dundee
8  * - Board of Regents of the University of Wisconsin-Madison
9  * - Glencoe Software, Inc.
10  * %%
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions are met:
13  *
14  * 1. Redistributions of source code must retain the above copyright notice,
15  * this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright notice,
17  * this list of conditions and the following disclaimer in the documentation
18  * and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  *
32  * The views and conclusions contained in the software and documentation are
33  * those of the authors and should not be interpreted as representing official
34  * policies, either expressed or implied, of any organization.
35  * #L%
36  */
37 
38 #ifndef OME_BIOFORMATS_XMLTOOLS_H
39 #define OME_BIOFORMATS_XMLTOOLS_H
40 
41 #include <ome/common/xml/dom/Document.h>
42 
43 namespace ome
44 {
45  namespace bioformats
46  {
47 
48  /*
49  * Utility functions for XML processing. This is an equivalent to
50  * the Java XMLtools implementation, with the following
51  * differences:
52  *
53  * createBuilder: Not required; handled internally by common::xml::dom.
54  * createDocument: Use ome::common::xml::dom::createDocument(qualifiedName).
55  * parseDOM(file): Use ome::common::xml::dom::createDocument(file)
56  * parseDOM(string): Use ome::common::xml::dom::createDocument(string)
57  * parseDOM(stream): Use ome::common::xml::dom::createDocument(steam)
58  *
59  * dumpXML(): Use ome::common::xml::dom::writeDocument(doc, string);
60  * writeXML(stream): Use ome::common::xml::dom::writeDocument(doc, stream);
61  *
62  * validateXML(doc): Use ome::common::xml::dom::validate(doc)
63  *
64  * All parseXML SAX methods are currently unimplemented.
65  *
66  * XSLT transforms:
67  * getStylesheet currently unimplemented.
68  * avoidUndeclaredNamespaces currently unimplemented.
69  * transformXML currently unimplemented.
70  *
71  * Helpers:
72  * checkUTF8: May not be required if xerces can handle it.
73  * error/fatalError/warning: Not implemented, may not be required here.
74  */
75 
82  std::string
83  escapeXML(const std::string& s);
84 
94  std::string
95  sanitizeXML(const std::string& s);
96 
105  bool
106  validateXML(const std::string& s,
107  const std::string& loc = "XML");
108 
109  }
110 }
111 
112 #endif // OME_BIOFORMATS_XMLTOOLS_H
113 
114 /*
115  * Local Variables:
116  * mode:C++
117  * End:
118  */
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
std::string escapeXML(const std::string &s)
Replace special characters with XML entities in an XML string.
Definition: XMLTools.cpp:64
bool validateXML(const std::string &s, const std::string &)
Validate XML in an XML string.
Definition: XMLTools.cpp:132
std::string sanitizeXML(const std::string &s)
Filter control codes and invalid sequences in an XML string.
Definition: XMLTools.cpp:99