Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
XMLFile.h
Go to the documentation of this file.
1 // --------------------------------------------------------------------------
2 // OpenMS -- Open-Source Mass Spectrometry
3 // --------------------------------------------------------------------------
4 // Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
5 // ETH Zurich, and Freie Universitaet Berlin 2002-2013.
6 //
7 // This software is released under a three-clause BSD license:
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of any author or any participating institution
14 // may be used to endorse or promote products derived from this software
15 // without specific prior written permission.
16 // For a full list of authors, refer to the file AUTHORS.
17 // --------------------------------------------------------------------------
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 // ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
22 // INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
28 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 //
30 // --------------------------------------------------------------------------
31 // $Maintainer: Andreas Bertsch $
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34 
35 #ifndef OPENMS_FORMAT_XMLFILE_H
36 #define OPENMS_FORMAT_XMLFILE_H
37 
38 // OpenMS includes
41 
42 #include <xercesc/framework/XMLFormatter.hpp>
43 
44 namespace OpenMS
45 {
46  namespace Internal
47  {
48  class XMLHandler;
49 
51  class OPENMS_DLLAPI XMLFile
52  {
53 
54 public:
55 
57  XMLFile();
59  XMLFile(const String & schema_location, const String & version);
61  virtual ~XMLFile();
62 
71  bool isValid(const String & filename, std::ostream & os = std::cerr);
72 
74  const String & getVersion() const;
75 
76 protected:
83  void parse_(const String & filename, XMLHandler * handler);
84 
90  void save_(const String & filename, XMLHandler * handler) const;
91 
94 
97 
100 
101  void enforceEncoding_(const String& encoding);
102  };
103 
104  // implementation of an XMLFormatTarget
105  class OPENMS_DLLAPI OpenMSXMLFormatTarget :
106  public xercesc::XMLFormatTarget
107  {
108 
109 public:
110 
111  OpenMSXMLFormatTarget(std::string & str) :
112  XMLFormatTarget(),
113  str_(str)
114  {
115  }
116 
117  virtual void writeChars(const XMLByte * const toWrite, const XMLSize_t count, xercesc::XMLFormatter * const /*formatter*/)
118  {
119  str_.append((const char * const)toWrite, count);
120  }
121 
122  std::string & str_;
123  };
124 
131  void OPENMS_DLLAPI writeXMLEscape(const String & to_escape, std::ostream & os);
132 
139  String OPENMS_DLLAPI writeXMLEscape(const String & to_escape);
140 
147  String OPENMS_DLLAPI encodeTab(const String & to_encode);
148  } // namespace Internal
149 } // namespace OpenMS
150 
151 #endif // OPENMS_FOMAT_XMLFILE_H
String encodeTab(const String &to_encode)
Encodes tabs &#39;&#39; in the string as &amp;#x9; and returns the encoded string.
String schema_version_
Version string.
Definition: XMLFile.h:96
void writeXMLEscape(const String &to_escape, std::ostream &os)
Escapes a string to be storable into an XML File.
A more convenient string class.
Definition: String.h:56
Base class for XML handlers.
Definition: XMLHandler.h:89
virtual void writeChars(const XMLByte *const toWrite, const XMLSize_t count, xercesc::XMLFormatter *const )
Definition: XMLFile.h:117
std::string & str_
Definition: XMLFile.h:122
String enforced_encoding_
Encoding string that replaces the encoding (system dependend or specified in the XML). Disabled if empty. Used as a workaround for XTandem output xml.
Definition: XMLFile.h:99
OpenMSXMLFormatTarget(std::string &str)
Definition: XMLFile.h:111
String schema_location_
XML schema file location.
Definition: XMLFile.h:93
Base class for loading/storing XML files that have a handler derived from XMLHandler.
Definition: XMLFile.h:51

OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:23 using doxygen 1.8.5