在 yaml-cpp 中操作节点

Posted 2023-02-16

【中文标题】在 yaml-cpp 中操作节点

【英文标题】：Manipulating nodes in yaml-cpp

【发布时间】：2018-03-27 13:37:01

【问题描述】：

我目前正在处理一个我想使用库yaml-cpp 配置的项目。现在我正在尝试编写一个函数，它给出了一个标签/字符串向量（例如，“A”、“B”、“C”）和一些参数值（例如，31）。然后该函数应该为每个标签插入一个映射节点（如果这样的节点不存在），将其映射到后续节点，最后使用参数值创建一个标量节点。在所述示例调用之后，配置应因此读取

A:
  B:
    C: 31

您可以在下面看到一个干净简单的实现的尝试：

配置.hpp

class Config 

public:

    template<typename T>
    static void setConfigParam(const std::vector<std::string> &tags,
            T value) 
        assert(tags.size() > 0);
        assert(config);
        YAML::Node parentNode = config;
        for(int i=0; i < tags.size()-1; i++) 
            const std::string & tag = tags.at(i);
            if(parentNode[tag]) 
                YAML::Node childNode = parentNode[tag];
                parentNode = childNode;
            
            else 
                YAML::Node childNode(YAML::NodeType::Map);
                parentNode[tag] = childNode;
                parentNode = childNode;
            
        
        parentNode[tags.back()] = value;
        std::cout << "Config:\n" << config << "\n\n";
    

private:

    static YAML::Node config;

;

YAML::Node Config::config(YAML::NodeType::Map);

Test.cpp

#include "Config.hpp"

int main(int argc, char **argv) 
    int val1 = 3;
    vector<string> tags1 = "A1","B1","C1","D1";
    Config::setConfigParam(tags1, val1);
    string val2 = "test";
    vector<string> tags2 = "A1","B1","C1","D2";
    Config::setConfigParam(tags2, val2);
    bool val3 = true;
    vector<string> tags3 = "A1","B1","C1";
    Config::setConfigParam(tags3, val3);
    double val4 = 2.385;
    vector<string> tags4 = "A1","B2","C1";
    Config::setConfigParam(tags4, val4);

函数setConfigParam()的问题似乎是线条

YAML::Node parentNode = config;

和

parentNode = childNode

根据我对tutorial 的理解，第一行显然创建了节点parentNode 作为config 的别名。在每个函数调用中，第二行的第一次执行将现有的config 对象替换为新创建的childNode。但是，在剩余的迭代中，config 不再完全重置，而是按预期进行调整。

如果一切正常，输出应该是：

Config:
A1:
  B1:
    C1:
      D1: 3

Config:
A1:
  B1:
    C1:
      D1: 3
      D2: test

Config:
A1:
  B1:
    C1: true

Config:
A1:
  B1:
    C1: true
  B2:
    C1: 2.385

上面代码的实际输出是

Config:
B1:
  C1:
    D1: 3

Config:
B1:
  C1:
    D2: test

Config:
B1:
  C1: true

Config:
B2:
  C1: 2.385

我试图通过使用指针来防止提到的问题，最后设法提出了以下实现，至少在测试代码中可以正常工作：

template<typename T>
static void setConfigParam(const std::vector<std::string> &tags,
        T value) 
    int numTags = tags.size();
    // Reads root node.
    assert(numTags > 0);
    assert(config);
    YAML::Node* parentNode = &config;
    // Determines index of first non-existing node.
    int i=0;
    for(; i < numTags-1; i++) 
        const std::string & tag = tags.at(i);
        if((*parentNode)[tag]) 
            auto childNode = (*parentNode)[tag];
            parentNode = &childNode;
        
        else 
            break;
        
    
    // Note: necessary because *parentNode will later point
    // to a different node due to lib behavior .
    YAML::Node lastExistingNode = *parentNode;
    // Sets node value and creates missing nodes.
    if(i == numTags - 1) 
        lastExistingNode[tags.back()] = value;
    
    else 
        YAML::Node newNode;
        newNode = value;
        for(int j = tags.size()-1; j>i; j--) 
            YAML::Node tmpNode;
            tmpNode[tags.at(j)] = newNode;
            newNode = tmpNode;
        
        // Inserts missing nodes.
        lastExistingNode[tags.at(i)] = newNode;
    
    std::cout << "Config:\n" << config << "\n\n";

但是，我相信必须有一个更简单、更清洁的解决方案。因此，我非常感谢有关如何通过更简单的实现使函数正常工作的任何想法，特别是因为库中没有太多文档。

【问题讨论】：

第一个代码 sn-p 的实际输出是什么？您只需告诉我们您期望会是什么。

我的问题已同时得到解答，但为了清晰起见，我对其进行了编辑以添加实际输出。

【参考方案1】：

在您的第一个示例中，分配给现有节点的行为与您的预期不同。详情请见this issue。

您的带有指针的示例解决了这个问题，但它还有另一个问题：它取消了对堆栈变量的引用。

改为使用递归解决方案：

template<typename T, typename Iter>
void setConfigParam(YAML::Node node, Iter begin, Iter end, T value) 
  if (begin == end) 
    return;
  
  const auto& tag = *begin;
  if (std::next(begin) == end) 
    node[tag] = value;
    return;
  
  if (!node[tag]) 
    node[tag] = YAML::Node(YAML::NodeType::Map);
  
  setConfigParam(node[tag], std::next(begin), end, value);

【讨论】：

您的实现按预期工作，但感谢您的链接，我还发现了 reset() 的函数 YAML::Node，它允许非递归实现更接近我最初的尝试。也感谢您指出指针问题。