PlainXMLFormatter.h

Go to the documentation of this file.

/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2012-2026 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
// Output formatter for plain XML output
/****************************************************************************/
#pragma once
#include <config.h>
 
#include "OutputFormatter.h"
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class PlainXMLFormatter : public OutputFormatter {
public:
    PlainXMLFormatter(const int defaultIndentation = 0);
 
    virtual ~PlainXMLFormatter() { }
 
    bool writeXMLHeader(std::ostream& into, const std::string& rootElement,
                        const std::map<SumoXMLAttr, std::string>& attrs, bool writeMetadata,
                        bool includeConfig);
 
    void openTag(std::ostream& into, const std::string& xmlElement);
 
    void openTag(std::ostream& into, const SumoXMLTag& xmlElement);
 
    bool closeTag(std::ostream& into, const std::string& comment = "");
 
    void writePreformattedTag(std::ostream& into, const std::string& val);
 
    void writePadding(std::ostream& into, const std::string& val);
 
    template <class T>
    static void writeAttr(std::ostream& into, const std::string& attr, const T& val, const bool escape) {
        UNUSED_PARAMETER(escape);
        into << " " << attr << "=\"" << toString(val, into.precision()) << "\"";
    }
 
    template <class T>
    static void writeAttr(std::ostream& into, const SumoXMLAttr attr, const T& val, const bool escape) {
        UNUSED_PARAMETER(escape);
        into << " " << toString(attr) << "=\"" << toString(val, into.precision()) << "\"";
    }
 
    static void writeAttr(std::ostream& into, const std::string& attr, const std::string& val, const bool escape);
    static void writeAttr(std::ostream& into, const SumoXMLAttr attr, const std::string& val, const bool escape);
 
    void writeTime(std::ostream& into, const SumoXMLAttr attr, const SUMOTime val) {
        into << " " << toString(attr) << "=\"" << time2string(val) << "\"";
    }
 
    bool wroteHeader() const {
        return !myXMLStack.empty();
    }
 
private:
    std::vector<std::string> myXMLStack;
 
    int myDefaultIndentation;
 
    bool myHavePendingOpener;
};