CSVFormatter.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 CSV output
/****************************************************************************/
#pragma once
#include <config.h>
 
#include <memory>
#include <algorithm>
#include "OutputFormatter.h"
#include <utils/common/ToString.h>
#include <utils/common/Translation.h>
 
 
// ===========================================================================
// class definitions
// ===========================================================================
class CSVFormatter : public OutputFormatter {
public:
    CSVFormatter(const std::string& columnNames, const char separator = ';');
 
    virtual ~CSVFormatter() override { }
 
    bool writeXMLHeader(std::ostream& into, const std::string& rootElement,
                        const std::map<SumoXMLAttr, std::string>& attrs, bool /* writeMetadata */,
                        bool /* includeConfig */) override;
 
    void openTag(std::ostream& into, const std::string& xmlElement) override;
 
    void openTag(std::ostream& into, const SumoXMLTag& xmlElement) override;
 
    bool closeTag(std::ostream& into, const std::string& comment = "") override;
 
    template <class T>
    void writeAttr(std::ostream& into, const SumoXMLAttr attr, const T& val, const bool isNull, const bool escape) {
        UNUSED_PARAMETER(escape);
        checkAttr(attr);
        myValues.emplace_back(isNull ? "" : toString(val, into.precision()));
    }
 
    template <class T>
    void writeAttr(std::ostream& into, const std::string& attr, const T& val, const bool isNull, const bool escape) {
        UNUSED_PARAMETER(escape);
        assert(!myCheckColumns);
        checkHeader(attr);
        myValues.emplace_back(isNull ? "" : toString(val, into.precision()));
    }
 
    void writeAttr(std::ostream& /* into */, const SumoXMLAttr attr, const std::string& val, const bool isNull, const bool escape) {
        checkAttr(attr);
        myValues.emplace_back(isNull ? "" : (escape ? StringUtils::escapeCSV(val, mySeparator) : val));
    }
    void writeAttr(std::ostream& /* into */, const std::string& attr, const std::string& val, const bool isNull, const bool escape) {
        assert(!myCheckColumns);
        checkHeader(attr);
        myValues.emplace_back(isNull ? "" : (escape ? StringUtils::escapeCSV(val, mySeparator) : val));
    }
 
    void writeTime(std::ostream& /* into */, const SumoXMLAttr attr, const SUMOTime val) override {
        checkAttr(attr);
        myValues.emplace_back(time2string(val));
    }
 
    bool wroteHeader() const override {
        return myWroteHeader;
    }
 
    void setExpectedAttributes(const SumoXMLAttrMask& expected, const int depth) override {
        myExpectedAttrs = expected;
        myMaxDepth = depth;
        myCheckColumns = expected.any();
    }
 
private:
    inline void checkAttr(const SumoXMLAttr attr) {
        if (myCheckColumns && myMaxDepth == (int)myXMLStack.size()) {
            mySeenAttrs.set(attr);
            if (!myExpectedAttrs.test(attr)) {
                throw ProcessError(TLF("Unexpected attribute '%', this file format does not support CSV output yet.", toString(attr)));
            }
        }
        checkHeader(attr);
    }
 
    template <class ATTR_TYPE>
    inline void checkHeader(const ATTR_TYPE& attr) {
        myNeedsWrite = true;
        if (!myWroteHeader) {
            std::string headerName = toString(attr);
            std::string prefix;
            for (const auto& entry : myXMLStack) {
                prefix += entry.first + "_";
            }
            const std::string fullHeaderName = prefix + headerName;
            if (myHeaderFormat != "plain") {
                headerName = myXMLStack.back().first + "_" + headerName;
            }
            const auto colIt = std::find(myFullHeader.begin(), myFullHeader.end(), fullHeaderName);
            if (colIt == myFullHeader.end()) {
                for (std::string& row : myBufferedRows) {
                    row += mySeparator;
                }
                myValues.resize(myHeader.size());
                myHeader.emplace_back(headerName);
                myFullHeader.emplace_back(fullHeaderName);
            } else {
                // there might be missing attributes inbetween, so make sure header position and value size match
                myValues.resize(std::distance(myFullHeader.begin(), colIt));
            }
        }
    }
 
    const std::string myHeaderFormat;
 
    const char mySeparator;
 
    std::vector<std::string> myHeader;
 
    std::vector<std::string> myFullHeader;
 
    std::vector<std::pair<const std::string, int> > myXMLStack;
 
    std::vector<std::string> myValues;
 
    int myMaxDepth = 1000;
 
    bool myWroteHeader = false;
 
    bool myNeedsWrite = false;
 
    bool myHaveRootAttrs = false;
 
    std::vector<std::string> myBufferedRows;
 
    bool myCheckColumns = false;
 
    SumoXMLAttrMask myExpectedAttrs;
 
    SumoXMLAttrMask mySeenAttrs;
};