xml_utils.h

Go to the documentation of this file.

/*+-------------------------------------------------------------------------+
  |                       MultiVehicle simulator (libmvsim)                 |
  |                                                                         |
  | Copyright (C) 2014-2023  Jose Luis Blanco Claraco                       |
  | Copyright (C) 2017  Borys Tymchenko (Odessa Polytechnic University)     |
  | Distributed under 3-clause BSD License                                  |
  |   See COPYING                                                           |
  +-------------------------------------------------------------------------+ */
#pragma once

#include <mvsim/TParameterDefinitions.h>
#include <mvsim/basic_types.h>

#include <map>
#include <memory>
#include <rapidxml.hpp>
#include <set>
#include <string>
#include <tuple>

// Fwd decl:
namespace mrpt::math
{
class TPolygon2D;
}  // namespace mrpt::math

namespace mrpt::system
{
class COutputLogger;
}

namespace mvsim
{
struct XML_Doc_Data
{
        using Ptr = std::shared_ptr<XML_Doc_Data>;

        std::string documentData;
        std::shared_ptr<rapidxml::xml_document<>> doc;
};

std::tuple<std::shared_ptr<rapidxml::xml_document<>>, rapidxml::xml_node<>*>
        readXmlTextAndGetRoot(
                const std::string& xmlData, const std::string& pathToFile);

std::tuple<XML_Doc_Data::Ptr, rapidxml::xml_node<>*> readXmlAndGetRoot(
        const std::string& pathToFile,
        const std::map<std::string, std::string>& variables,
        const std::set<std::string>& varsRetain = {});

std::string parse_variables(
        const std::string& in, const std::map<std::string, std::string>& variables,
        const std::set<std::string>& varsRetain);

void parse_xmlnode_attribs(
        const rapidxml::xml_node<char>& xml_node,
        const TParameterDefinitions& params,
        const std::map<std::string, std::string>& variableNamesValues = {},
        const char* functionNameContext = "");

bool parse_xmlnode_as_param(
        const rapidxml::xml_node<char>& xml_node,
        const TParameterDefinitions& params,
        const std::map<std::string, std::string>& variableNamesValues = {},
        const char* functionNameContext = "");

void parse_xmlnode_children_as_param(
        const rapidxml::xml_node<char>& xml_node,
        const TParameterDefinitions& params,
        const std::map<std::string, std::string>& variableNamesValues = {},
        const char* functionNameContext = "",
        mrpt::system::COutputLogger* logger = nullptr);

template <class NODE_LIST>
void parse_xmlnodelist_children_as_param(
        NODE_LIST& lst_nodes, const TParameterDefinitions& params,
        const char* functionNameContext = "")
{
        for (auto& node : lst_nodes)
                parse_xmlnode_children_as_param(*node, params, functionNameContext);
}

// Bits:

mrpt::math::TPose2D parseXYPHI(
        const std::string& s, bool allow_missing_angle = false,
        double default_angle_radians = 0.0,
        const std::map<std::string, std::string>& variableNamesValues = {});

void parse_xmlnode_shape(
        const rapidxml::xml_node<char>& xml_node, mrpt::math::TPolygon2D& out_poly,
        const char* functionNameContext = "");
}  // namespace mvsim