CConfigFileBase.cpp

Go to the documentation of this file.

/* +------------------------------------------------------------------------+
   |                     Mobile Robot Programming Toolkit (MRPT)            |
   |                          https://www.mrpt.org/                         |
   |                                                                        |
   | Copyright (c) 2005-2020, Individual contributors, see AUTHORS file     |
   | See: https://www.mrpt.org/Authors - All rights reserved.               |
   | Released under BSD License. See: https://www.mrpt.org/License          |
   +------------------------------------------------------------------------+ */

#include "config-precomp.h"  // Precompiled headers

#include <mrpt/config/CConfigFileBase.h>
#include <mrpt/core/exceptions.h>
#include <mrpt/core/format.h>
#include <mrpt/system/os.h>
#include <mrpt/system/string_utils.h>
#include <cmath>  // abs()

#include <mrpt/config.h>
#if MRPT_HAS_YAMLCPP
#include <yaml-cpp/yaml.h>
#endif

using namespace std;
using namespace mrpt::config;
using namespace mrpt::system;
using mrpt::format;

static int MRPT_SAVE_NAME_PADDING = 50;
static int MRPT_SAVE_VALUE_PADDING = 20;
int mrpt::config::MRPT_SAVE_NAME_PADDING() { return ::MRPT_SAVE_NAME_PADDING; }
int mrpt::config::MRPT_SAVE_VALUE_PADDING()
{
    return ::MRPT_SAVE_VALUE_PADDING;
}

CConfigFileBase::~CConfigFileBase() = default;
void CConfigFileBase::write(
    const std::string& section, const std::string& name, double value,
    const int name_padding_width, const int value_padding_width,
    const std::string& comment)
{
    writeString(
        section, name,
        format(
            ((std::abs(value) > 1e-4 && std::abs(value) < 1e4) || value == .0)
                ? "%f"
                : "%e",
            value),
        name_padding_width, value_padding_width, comment);
}
void CConfigFileBase::write(
    const std::string& section, const std::string& name, float value,
    const int name_padding_width, const int value_padding_width,
    const std::string& comment)
{
    writeString(
        section, name,
        format(
            ((std::abs(value) > 1e-4f && std::abs(value) < 1e4f) ||
             value == .0f)
                ? "%f"
                : "%e",
            value),
        name_padding_width, value_padding_width, comment);
}

/** Write a generic string with optional padding and a comment field ("// ...")
 * at the end of the line. */
void CConfigFileBase::writeString(
    const std::string& section, const std::string& name, const std::string& str,
    const int name_padding_width, const int value_padding_width,
    const std::string& comment)
{
    if (name_padding_width < 1 && value_padding_width < 1 && comment.empty())
        this->writeString(section, name, str);  // Default (old) behavior.

    std::string name_pad;
    if (name_padding_width >= 1)
        name_pad = mrpt::format(
            "%*s", -name_padding_width,
            name.c_str());  // negative width: printf right padding
    else
        name_pad = name;

    std::string value_pad;
    if (value_padding_width >= 1)
        value_pad = mrpt::format(
            " %*s", -value_padding_width,
            str.c_str());  // negative width: printf right padding
    else
        value_pad = str;

    if (!comment.empty())
    {
        value_pad += std::string(" // ");
        value_pad += comment;
    }

    this->writeString(section, name_pad, value_pad);
}

/*---------------------------------------------------------------
                    read_double
 ---------------------------------------------------------------*/
double CConfigFileBase::read_double(
    const std::string& section, const std::string& name, double defaultValue,
    bool failIfNotFound) const
{
    return atof(
        readString(section, name, format("%.16e", defaultValue), failIfNotFound)
            .c_str());
}

/*---------------------------------------------------------------
                    read_float
 ---------------------------------------------------------------*/
float CConfigFileBase::read_float(
    const std::string& section, const std::string& name, float defaultValue,
    bool failIfNotFound) const
{
    return (float)atof(
        readString(section, name, format("%.10e", defaultValue), failIfNotFound)
            .c_str());
}

/*---------------------------------------------------------------
                    read_int
 ---------------------------------------------------------------*/
int CConfigFileBase::read_int(
    const std::string& section, const std::string& name, int defaultValue,
    bool failIfNotFound) const
{
    return atoi(
        readString(section, name, format("%i", defaultValue), failIfNotFound)
            .c_str());
}

/*---------------------------------------------------------------
                    read_uint64_t
 ---------------------------------------------------------------*/
uint64_t CConfigFileBase::read_uint64_t(
    const std::string& section, const std::string& name, uint64_t defaultValue,
    bool failIfNotFound) const
{
    string s = readString(
        section, name, format("%lu", (long unsigned int)defaultValue),
        failIfNotFound);
    return mrpt::system::os::_strtoull(s.c_str(), nullptr, 0);
}

/*---------------------------------------------------------------
                    read_bool
 ---------------------------------------------------------------*/
bool CConfigFileBase::read_bool(
    const std::string& section, const std::string& name, bool defaultValue,
    bool failIfNotFound) const
{
    const string s = mrpt::system::lowerCase(trim(readString(
        section, name, string(defaultValue ? "1" : "0"), failIfNotFound)));
    if (s == "true") return true;
    if (s == "false") return false;
    if (s == "yes") return true;
    if (s == "no") return false;
    return (0 != atoi(s.c_str()));
}

/*---------------------------------------------------------------
                    read_string
 ---------------------------------------------------------------*/
std::string CConfigFileBase::read_string(
    const std::string& section, const std::string& name,
    const std::string& defaultValue, bool failIfNotFound) const
{
    return mrpt::system::trim(
        readString(section, name, defaultValue, failIfNotFound));
}

/*---------------------------------------------------------------
                    read_string_first_word
 ---------------------------------------------------------------*/
std::string CConfigFileBase::read_string_first_word(
    const std::string& section, const std::string& name,
    const std::string& defaultValue, bool failIfNotFound) const
{
    string s = readString(section, name, defaultValue, failIfNotFound);
    std::vector<std::string> auxStrs;
    mrpt::system::tokenize(s, "[], \t", auxStrs);
    if (auxStrs.empty())
    {
        if (failIfNotFound)
        {
            THROW_EXCEPTION(format(
                "Value '%s' seems to be present in section '%s' but, are "
                "all whitespaces??",
                name.c_str(), section.c_str()));
        }
        else
            return "";
    }
    else
        return auxStrs[0];
}

bool CConfigFileBase::sectionExists(const std::string& section_name) const
{
    std::vector<std::string> sects;
    getAllSections(sects);
    for (auto& sect : sects)
        if (!mrpt::system::os::_strcmpi(section_name.c_str(), sect.c_str()))
            return true;
    return false;
}

bool CConfigFileBase::keyExists(
    const std::string& section, const std::string& key) const
{
    std::vector<std::string> keys;
    getAllKeys(section, keys);
    for (auto& k : keys)
        if (!mrpt::system::os::_strcmpi(key.c_str(), k.c_str())) return true;
    return false;
}

void CConfigFileBase::setContentFromYAML(const std::string& yaml_block)
{
    MRPT_START
#if MRPT_HAS_YAMLCPP
    this->clear();

    YAML::Node root = YAML::Load(yaml_block);

    // Prepare all data here, then insert into the actual INI file at the end,
    // to ensure that unscoped variables get first.
    using key_values_t = std::map<std::string, std::string>;
    key_values_t unscoped;
    std::map<std::string, key_values_t> sections;

    for (const auto& sect : root)
    {
        const auto sectName = sect.first.as<std::string>();
        // YAML Type: sect.first.Type()

        if (sect.second.size() >= 1)
        {
            // A section:
            for (const auto& kv : sect.second)
            {
                const auto key = kv.first.as<std::string>();
                const auto val = kv.second.as<std::string>();
                sections[sectName].emplace(key, val);
            }
        }
        else
        {
            // an unscoped key-value:
            const auto key = sect.first.as<std::string>();
            const auto val = sect.second.as<std::string>();
            unscoped.emplace(key, val);
        }
    }

    // 1st: unscoped:
    for (const auto& kv : unscoped) this->write("", kv.first, kv.second);

    for (const auto& sect : sections)
        for (const auto& kv : sect.second)
            this->write(sect.first, kv.first, kv.second);

#else
    THROW_EXCEPTION(
        "This method requires building MRPT with yaml-cpp support.");
#endif
    MRPT_END
}

std::string CConfigFileBase::getContentAsYAML() const
{
    MRPT_START
#if MRPT_HAS_YAMLCPP
    YAML::Node n;

    // Sections:
    std::vector<std::string> lstSects;
    getAllSections(lstSects);

    // Unscoped: "" empty section name:
    lstSects.insert(lstSects.begin(), std::string());

    // Go thru values:
    for (const auto& sect : lstSects)
    {
        std::vector<std::string> keys;
        getAllKeys(sect, keys);
        for (const auto& k : keys)
        {
            const auto val = this->readString(sect, k, "");
            if (sect.empty())
                n[k] = val;
            else
                n[sect][k] = val;
        }
    }

    // Convert to string:
    std::stringstream ss;
    ss << n;
    return ss.str();
#else
    THROW_EXCEPTION(
        "This method requires building MRPT with yaml-cpp support.");
#endif
    MRPT_END
}