Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
PlainXMLFormatter.cpp
Go to the documentation of this file.
1/****************************************************************************/
2// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3// Copyright (C) 2012-2025 German Aerospace Center (DLR) and others.
4// This program and the accompanying materials are made available under the
5// terms of the Eclipse Public License 2.0 which is available at
6// https://www.eclipse.org/legal/epl-2.0/
7// This Source Code may also be made available under the following Secondary
8// Licenses when the conditions for such availability set forth in the Eclipse
9// Public License 2.0 are satisfied: GNU General Public License, version 2
10// or later which is available at
11// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
12// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
13/****************************************************************************/
19// Static storage of an output device and its base (abstract) implementation
20/****************************************************************************/
21#include <config.h>
22
25#include "PlainXMLFormatter.h"
26
27
28// ===========================================================================
29// member method definitions
30// ===========================================================================
31PlainXMLFormatter::PlainXMLFormatter(const int defaultIndentation)
32 : OutputFormatter(OutputFormatterType::XML), myDefaultIndentation(defaultIndentation), myHavePendingOpener(false) {
33}
34
35
36bool
37PlainXMLFormatter::writeXMLHeader(std::ostream& into, const std::string& rootElement,
38 const std::map<SumoXMLAttr, std::string>& attrs, bool includeConfig) {
39 if (myXMLStack.empty()) {
40 OptionsCont::getOptions().writeXMLHeader(into, includeConfig);
41 openTag(into, rootElement);
42 for (std::map<SumoXMLAttr, std::string>::const_iterator it = attrs.begin(); it != attrs.end(); ++it) {
43 writeAttr(into, it->first, it->second);
44 }
45 into << ">\n";
46 myHavePendingOpener = false;
47 return true;
48 }
49 return false;
50}
51
52
53void
54PlainXMLFormatter::openTag(std::ostream& into, const std::string& xmlElement) {
56 into << ">\n";
57 }
59 into << std::string(4 * (myXMLStack.size() + myDefaultIndentation), ' ') << "<" << xmlElement;
60 myXMLStack.push_back(xmlElement);
61}
62
63
64void
65PlainXMLFormatter::openTag(std::ostream& into, const SumoXMLTag& xmlElement) {
66 openTag(into, toString(xmlElement));
67}
68
69
70bool
71PlainXMLFormatter::closeTag(std::ostream& into, const std::string& comment) {
72 if (!myXMLStack.empty()) {
74 into << "/>" << comment << "\n";
75 myHavePendingOpener = false;
76 } else {
77 const std::string indent(4 * (myXMLStack.size() + myDefaultIndentation - 1), ' ');
78 into << indent << "</" << myXMLStack.back() << ">" << comment << "\n";
79 }
80 myXMLStack.pop_back();
81 return true;
82 }
83 return false;
84}
85
86
87void
88PlainXMLFormatter::writePreformattedTag(std::ostream& into, const std::string& val) {
90 into << ">\n";
91 myHavePendingOpener = false;
92 }
93 into << val;
94}
95
96
97void
98PlainXMLFormatter::writePadding(std::ostream& into, const std::string& val) {
99 into << val;
100}
101
102
103/****************************************************************************/
OutputFormatterType
SumoXMLTag
Numbers representing SUMO-XML - element names.
std::string toString(const T &t, std::streamsize accuracy=gPrecision)
Definition ToString.h:46
void writeXMLHeader(std::ostream &os, const bool includeConfig=true) const
Writes a standard XML header, including the configuration.
static OptionsCont & getOptions()
Retrieves the options.
Abstract base class for output formatters.
bool closeTag(std::ostream &into, const std::string &comment="")
Closes the most recently opened tag.
bool myHavePendingOpener
whether a closing ">" might be missing
PlainXMLFormatter(const int defaultIndentation=0)
Constructor.
int myDefaultIndentation
The initial indentation level.
static void writeAttr(std::ostream &into, const std::string &attr, const T &val)
writes an arbitrary attribute
std::vector< std::string > myXMLStack
The stack of begun xml elements.
void writePadding(std::ostream &into, const std::string &val)
writes arbitrary padding
bool writeXMLHeader(std::ostream &into, const std::string &rootElement, const std::map< SumoXMLAttr, std::string > &attrs, bool includeConfig=true)
Writes an XML header with optional configuration.
void writePreformattedTag(std::ostream &into, const std::string &val)
writes a preformatted tag to the device but ensures that any pending tags are closed
void openTag(std::ostream &into, const std::string &xmlElement)
Opens an XML tag.