parser.hpp #

ファイルまたは文字列をパースする関数と、それが用いる例外を定義します。

parseは失敗した場合に例外を送出しますが、try_parseはエラー情報を返します。

`parse` #

与えられたファイルの内容をパースし、toml::basic_valueを返します。

失敗した場合はtoml::syntax_errorが送出されます。

basic_valueの持つ型情報はtemplateで、TOML言語のバージョンはtoml::specで指定します。

`parse(std::string filename, toml::spec)` #

namespace toml
{
template<typename TC = type_config>
basic_value<TC>
parse(std::string fname,
      spec s = spec::default_version());
}

ファイル名を受け取って、その内容をパースします。

ファイルの読み込みに失敗した場合、file_io_errorが送出されます。

パースに失敗した場合、syntax_errorが送出されます。

`parse(const char (&)[N] filename, toml::spec)` #

namespace toml
{
template<typename TC = type_config, std::size_t N>
basic_value<TC>
parse(const char (&fname)[N],
      spec s = spec::default_version());
}

文字列リテラルを受け取って、そのファイルの内容をパースします。

ファイルの読み込みに失敗した場合、file_io_errorが送出されます。

パースに失敗した場合、syntax_errorが送出されます。

`parse(std::filesystem::path, toml::spec)` #

namespace toml
{
template<typename TC = type_config>
basic_value<TC>
parse(const std::filesystem::path& fpath,
      spec s = spec::default_version());
}

<filesystem>が利用可能な場合のみ定義されます。

ファイルパスを受け取って、そのファイルの内容をパースします。

ファイルの読み込みに失敗した場合、file_io_errorが送出されます。

パースに失敗した場合、syntax_errorが送出されます。

`parse(std::istream&, std::string filename, toml::spec)` #

namespace toml
{
template<typename TC = type_config>
basic_value<TC>
parse(std::istream& is,
      std::string fname = "unknown file",
      spec s = spec::default_version());
}

std::istream&を受け取ってその内容をパースします。

標準ライブラリが改行文字を自動変換することによるファイルサイズと文字数との不整合を避けるため、 std::ios::binaryを使ってバイナリモードで開いてください。

ファイル名の情報は第三引数で受け取ります。ファイル名が渡されなかった場合、"unknown file"になります。

`parse(FILE*, std::string filename, toml::spec)` #

namespace toml
{
template<typename TC = type_config>
result<basic_value<TC>, std::vector<error_info>>
parse(FILE* fp,
      std::string filename,
      spec s = spec::default_version());
}

FILE*が指すファイルを読み込んでパースします。

標準ライブラリが改行文字を自動変換することによるファイルサイズと文字数との不整合を避けるため、 fopenには"rb"などを渡してバイナリモードで開いてください。

ファイルの読み込みに失敗した場合、errnoが含まれたfile_io_errorが送出されます。

パースに失敗した場合、syntax_errorが送出されます。

`parse(std::vector<unsigned char>, std::string filename, toml::spec)` #

namespace toml
{
template<typename TC = type_config>
basic_value<TC>
parse(std::vector<unsigned char> content,
      std::string filename,
      spec s = spec::default_version());
}

バイト列をTOMLファイルとしてパースします。

パースに失敗した場合、syntax_errorが送出されます。

`parse_str` #

`parse_str(std::string, toml::spec)` #

namespace toml
{
template<typename TC = type_config>
basic_value<TC>
parse_str(std::string content,
          spec s = spec::default_version(),
          cxx::source_location loc = cxx::source_location::current());
}

文字列をTOMLファイルとしてパースします。

失敗した場合はtoml::syntax_errorが送出されます。

basic_valueの持つ型情報はtemplateで、TOML言語のバージョンはtoml::specで指定します。

第三引数のcxx::source_locationを手動で設定する必要は通常ありません。 std::source_location, std::experimental::source_location, __builtin_FILEのいずれかが利用可能な場合、 parse_strが呼ばれた地点の情報が位置情報として保存されます。

`try_parse` #

与えられたファイルの内容をパースし、成功した場合はtoml::basic_valueを、失敗した場合はstd::vector<toml::error_info>を返します。

basic_valueの持つ型情報はtemplateで、TOML言語のバージョンはtoml::specで指定します。

try_parseはparseと異なりsyntax_errorなどのtoml11で定義された例外は投げませんが、標準ライブラリから送出される例外はそのまま送出されることに注意してください。
例えば、std::ifstreamの内部で起きたエラーや、std::vectorでのメモリ枯渇などは例外を送出します。