| OpenMS 2.5.0

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-2020.
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: Timo Sachsenberg $
32 // $Authors: Marc Sturm $
33 // --------------------------------------------------------------------------
34
35 #pragma once
36
37 // OpenMS includes
38 #include <OpenMS/CONCEPT/Types.h>
39 #include <OpenMS/DATASTRUCTURES/String.h>
40
41 namespace OpenMS
42 {
43 namespace Internal
44 {
45 class XMLHandler;
46
48 class OPENMS_DLLAPI XMLFile
49 {
50
51 public:
52
54 XMLFile();
56 XMLFile(const String& schema_location, const String& version);
58 virtual ~XMLFile();
59
71 bool isValid(const String& filename, std::ostream& os);
72
74 const String& getVersion() const;
75
76 protected:
83 void parse_(const String& filename, XMLHandler* handler);
84
92 void parseBuffer_(const std::string & buffer, XMLHandler * handler);
93
99 void save_(const String& filename, XMLHandler* handler) const;
100
102 String schema_location_;
103
105 String schema_version_;
106
108 String enforced_encoding_;
109
110 void enforceEncoding_(const String& encoding);
111 };
112
119 String OPENMS_DLLAPI encodeTab(const String& to_encode);
120 } // namespace Internal
121 } // namespace OpenMS
122
123
OpenMS::String
A more convenient string class.
Definition: String.h:58
Types.h
OpenMS::Internal::XMLFile
Base class for loading/storing XML files that have a handler derived from XMLHandler.
Definition: XMLFile.h:48
String.h
OpenMS::Internal::XMLFile::schema_version_
String schema_version_
Version string.
Definition: XMLFile.h:105
OpenMS
Main OpenMS namespace.
Definition: FeatureDeconvolution.h:46
OpenMS::Internal::XMLFile::schema_location_
String schema_location_
XML schema file location.
Definition: XMLFile.h:102
OpenMS::Internal::XMLFile::enforced_encoding_
String enforced_encoding_
Encoding string that replaces the encoding (system dependent or specified in the XML). Disabled if empty. Used as a workaround for XTandem output xml.
Definition: XMLFile.h:108
OpenMS::Internal::encodeTab
String encodeTab(const String &to_encode)
Encodes tabs &#39;&#39; in the string as &#x9; and returns the encoded string.
OpenMS::Internal::XMLHandler
Base class for XML handlers.
Definition: XMLHandler.h:151