Should YAML::detail::iterator_value really be part of the detail namespace? (Support for C++20 ranges)

オープン
#1,507 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
cpp
領域
api

調査の方向性

The question is whether YAML::detail::iterator_value, which the reproducer in the issue uses directly, should be promoted to public API so that YAML::Node works with C++20 ranges such as std::ranges::all_of. Start by finding where that type is declared and how YAML::Node's iterator exposes its value type, then compare with the iterator-based loop in the wiki. Done means a maintainer has decided on the public type name and its exposure, and the change is covered by a test that iterates a node with a range algorithm.

索引モデルが issue の本文から書いたものです。

説明

A yaml node technically satisfies the the requirements for a range - however, the range value type of a YAML::Node is not technically part of the public interface of yaml-cpp. Consider the following example

#include <cstdlib>
#include <string_view>

#include <algorithm>
#include <cstring>
#include <iostream>

#include <yaml-cpp/yaml.h>

constexpr std::string_view SRC =
    "scrambled-eggs:\n"
    "  ingredient.egg: 2\n"
    "  ingredient.butter: 1 tbsp\n"
    "  ingredient.salt: 1 pinch";

bool IsIngredient(const std::string_view Path)
{
    return std::strstr(Path.data(), "ingredient.") != nullptr;
}

bool IsValid(const YAML::detail::iterator_value & Value)
{
    return IsIngredient(Value.first.Scalar());
}

int main()
{
    const YAML::Node Src = YAML::Load(SRC.data());
    const YAML::Node RecipeConfig = Src["scrambled-eggs"];

    const bool AllValid = std::ranges::all_of(RecipeConfig, IsValid);
    std::cout << "All valid ingredients? " << (AllValid? "Yes" : "No") << "\n";
    return EXIT_SUCCESS;
}

This is prefectly valid C++20 code - it compiles and outputs All valid ingredients? Yes. However, you might argue that this isn't perfectly valid yaml-cpp code, since it uses an internal data type YAML::detail::iterator_value which I don't think is part of the public API? However, this code is much more concise, and - at the risk of sounding subjective - I would also argue much more legible than the equivalent code using an iterator-based for-loop as suggested in the wiki pages.

So I guess the point of this post is to make a request that the iterator value of a YAML::Node should be part of the public API and not be an internal detail.

主要言語
C++
スター
6.1k
フォーク
2.2k
平均マージ
22時間 2分
マージ済み PR(30日)
1

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

jbeder/yaml-cpp のほかの issue

jbeder/yaml-cpp の issue をすべて見る

似ている issue

C++ の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。