Erbsland Qt TOML Parser Overview

Welcome to the Erbsland Qt TOML Parser, a highly reliable and secure TOML parser that integrates seamlessly with both Qt5 and Qt6 environments. This parser is fully aligned with the TOML 1.0 specification and is also compatible with the current draft of TOML 1.1. Designed with a modern and clean C++ code base, it promises ease of inspection and understanding.

A distinctive feature of this parser is its inherent strict and dependable UTF-8 parsing, which operates independently of the Qt library. Beyond merely returning the data from the parsed document, our parser provides a value structure that includes the start and end locations of each parsed table and value. This feature is instrumental in generating informative and useful error messages.

Key Features

• Compliance with TOML 1.0 and TOML 1.1 specifications
• Dependency-free for maximum compatibility
• Robust and secure
• Compatibility with both Qt5 and Qt6
• User-friendly interface
• Modern, clean C++ code base
• Strict UTF-8 parsing, independent of Qt library

Getting Started

The Erbsland Qt TOML parser is ready to be included as a git submodule in your project and can be linked as a static library. Thanks to its lack of dependencies, it is highly flexible and can be conveniently incorporated into any build system.

Here's a quick peek at how you can use it:

#include <erbsland/qt/toml/Parser.hpp>

using elqt::toml;

void readConfiguration() {
    Parser parser{};
    try {
        auto toml = parser.parseFileOrThrow(QStringLiteral("config.toml"));
        // ...
    } catch (const Error &error) {
        // ...
    }
}

For a practical illustration, please visit our Example Project.

Documentation

Detailed documentation can be found here:

👉 Documentation 👈

Feedback and Requests

We greatly value your feedback and suggestions. Please use the GitHub issue tracker for bug reports or feature requests:

👉 Report an Issue 👈

License

Copyright © 2023 Tobias Erbsland https://erbsland.dev/ and EducateIT GmbH https://educateit.ch/ According to the copyright terms specified in the file "COPYRIGHT.md".

SPDX-License-Identifier: LGPL-3.0-or-later

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see https://www.gnu.org/licenses/.