A toolkit for working with phylogenetic data.
v0.24.0
utils/formats/xml/writer.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_UTILS_FORMATS_XML_WRITER_H_
2 #define GENESIS_UTILS_FORMATS_XML_WRITER_H_
3 
4 /*
5  Genesis - A toolkit for working with phylogenetic data.
6  Copyright (C) 2014-2020 Lucas Czech
7 
8  This program is free software: you can redistribute it and/or modify
9  it under the terms of the GNU General Public License as published by
10  the Free Software Foundation, either version 3 of the License, or
11  (at your option) any later version.
12 
13  This program is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  GNU General Public License for more details.
17 
18  You should have received a copy of the GNU General Public License
19  along with this program. If not, see <http://www.gnu.org/licenses/>.
20 
21  Contact:
22  Lucas Czech <lucas.czech@h-its.org>
23  Exelixis Lab, Heidelberg Institute for Theoretical Studies
24  Schloss-Wolfsbrunnenweg 35, D-69118 Heidelberg, Germany
25 */
26 
35 
36 #include <string>
37 #include <unordered_map>
38 
39 namespace genesis {
40 namespace utils {
41 
42 // =================================================================================================
43 // Forward declarations
44 // =================================================================================================
45 
46 class XmlComment;
47 class XmlMarkup;
48 class XmlElement;
49 class XmlDocument;
50 \
51 // =================================================================================================
52 // Xml Writer
53 // =================================================================================================
54 
58 class XmlWriter
59 {
60  typedef std::unordered_map<std::string, std::string> StringMapType;
61 
62  // ---------------------------------------------------------------------
63  // Printing
64  // ---------------------------------------------------------------------
65 
66 public:
67 
68  void write( XmlDocument const& document, std::shared_ptr<utils::BaseOutputTarget> target ) const;
69 
70  // -----------------------------------------------------
71  // Internal
72  // -----------------------------------------------------
73 
74 protected:
75 
76  void print_comment_ ( XmlComment const* value, std::ostream& os ) const;
77  void print_markup_ ( XmlMarkup const* value, std::ostream& os ) const;
78  void print_element_ ( XmlElement const* value, const int indent_level, std::ostream& os ) const;
79 
80  std::string print_attributes_list_( StringMapType attr ) const;
81 
82  // -----------------------------------------------------
83  // Members
84  // -----------------------------------------------------
85 
86 public:
87 
91  int indent = 4;
92 };
93 
94 } // namespace utils
95 } // namespace genesis
96 
97 #endif // include guard
void print_comment_(XmlComment const *value, std::ostream &os) const
Print an XML comment.
std::string print_attributes_list_(StringMapType attr) const
Print a list of XML attributes.
void print_element_(XmlElement const *value, const int indent_level, std::ostream &os) const
Print an XML element.
int indent
Indent used for printing the XML elements.
Container namespace for all symbols of genesis in order to keep them separate when used as a library...
void print_markup_(XmlMarkup const *value, std::ostream &os) const
Print an XML markup (simple text).
void write(XmlDocument const &document, std::shared_ptr< utils::BaseOutputTarget > target) const