tomlc99

tomlc99

TOML in c99; v1.0-kompatibel.

Wenn Sie nach einer C++-Bibliothek suchen, können Sie diesen Wrapper ausprobieren: https://github.com/cktan/tomlcpp.

• Kompatibel mit TOML v1.0.0.
• Getestet mit mehreren Testsuiten, einschließlich toml-lang/toml-test und iarna/toml-spec-tests.
• Bietet eine sehr einfache und intuitive Benutzeroberfläche.

Verwendung

Weitere Informationen finden Sie in der Datei toml.h Das Folgende ist ein einfaches Beispiel, das diese Konfigurationsdatei analysiert:

[ server ]
	host = " www.example.com "
	port = [ 8080 , 8181 , 8282 ]

Dies sind die üblichen Schritte zum Abrufen von Werten aus einer Datei:

1. Analysieren Sie die TOML-Datei.
2. Durchlaufen und Suchen einer Tabelle in TOML.
3. Extrahieren Sie Werte aus der Tabelle.
4. Geben Sie zugewiesenen Speicher frei.

Unten finden Sie ein Beispiel für das Parsen der Werte aus der Beispieltabelle.

 #include <stdio.h>
#include <string.h>
#include <errno.h>
#include <stdlib.h>
#include "toml.h"

static void error ( const char * msg , const char * msg1 )
{
    fprintf ( stderr , "ERROR: %s%sn" , msg , msg1 ? msg1 : "" );
    exit ( 1 );
}


int main ()
{
    FILE * fp ;
    char errbuf [ 200 ];

    // 1. Read and parse toml file
    fp = fopen ( "sample.toml" , "r" );
    if (! fp ) {
        error ( "cannot open sample.toml - " , strerror ( errno ));
    }

    toml_table_t * conf = toml_parse_file ( fp , errbuf , sizeof ( errbuf ));
    fclose ( fp );

    if (! conf ) {
        error ( "cannot parse - " , errbuf );
    }

    // 2. Traverse to a table.
    toml_table_t * server = toml_table_in ( conf , "server" );
    if (! server ) {
        error ( "missing [server]" , "" );
    }

    // 3. Extract values
    toml_datum_t host = toml_string_in ( server , "host" );
    if (! host . ok ) {
        error ( "cannot read server.host" , "" );
    }

    toml_array_t * portarray = toml_array_in ( server , "port" );
    if (! portarray ) {
        error ( "cannot read server.port" , "" );
    }

    printf ( "host: %sn" , host . u . s );
    printf ( "port: " );
    for ( int i = 0 ; ; i ++ ) {
        toml_datum_t port = toml_int_at ( portarray , i );
        if (! port . ok ) break ;
        printf ( "%d " , ( int ) port . u . i );
    }
    printf ( "n" );

    // 4. Free memory
    free ( host . u . s );
    toml_free ( conf );
    return 0 ;
}

Auf Tabelleninhalte zugreifen

TOML-Tabellen sind Wörterbücher, in denen die Suche mithilfe von Zeichenfolgenschlüsseln erfolgt. Im Allgemeinen heißen alle Zugriffsfunktionen auf Tabellen toml_*_in(...) .

Im Normalfall kennen Sie den Schlüssel und seinen Inhaltstyp, und der Abruf kann mit einer dieser Funktionen erfolgen:

 toml_string_in ( tab , key );
toml_bool_in ( tab , key );
toml_int_in ( tab , key );
toml_double_in ( tab , key );
toml_timestamp_in ( tab , key );
toml_table_in ( tab , key );
toml_array_in ( tab , key );

Sie können die Schlüssel in einer Tabelle auch über einen Integer-Index abfragen:

 toml_table_t * tab = toml_parse_file (...);
for ( int i = 0 ; ; i ++ ) {
    const char * key = toml_key_in ( tab , i );
    if (! key ) break ;
    printf ( "key %d: %sn" , i , key );
}

Zugriff auf Array-Inhalte

TOML-Arrays können mithilfe ganzzahliger Indizes derefiert werden. Im Allgemeinen heißen alle Zugriffsmethoden auf Arrays toml_*_at() .

So ermitteln Sie die Größe eines Arrays:

 int size = toml_array_nelem ( arr );

Um den Inhalt eines Arrays abzurufen, verwenden Sie einen gültigen Index und rufen Sie eine dieser Funktionen auf:

 toml_string_at ( arr , idx );
toml_bool_at ( arr , idx );
toml_int_at ( arr , idx );
toml_double_at ( arr , idx );
toml_timestamp_at ( arr , idx );
toml_table_at ( arr , idx );
toml_array_at ( arr , idx );

toml_datum_t

Einige toml_*_at und toml_*_in -Funktionen geben eine toml_datum_t-Struktur zurück. Das ok -Flag in der Struktur zeigt an, ob der Funktionsaufruf erfolgreich war. Wenn ja, können Sie mit dem Lesen des Werts fortfahren, der der Art des Inhalts entspricht.

Zum Beispiel:

 toml_datum_t host = toml_string_in(tab, "host");
if (host.ok) {
	printf("host: %sn", host.u.s);
	free(host.u.s);   /* FREE applies to string and timestamp types only */
}

** WICHTIG: Wenn es sich bei dem Wert, auf den zugegriffen wird, um einen String oder einen Zeitstempel handelt, müssen Sie nach der Verwendung free(datum.us) bzw. free(datum.u.ts) aufrufen. **

Bauen und installieren

Ein normales Fabrikat reicht aus. Sie können die Dateien toml.c und toml.h auch einfach in Ihr Projekt einbinden.

Durch den Aufruf make install werden die Header- und Bibliotheksdateien in /usr/local/{include,lib} installiert.

Alternativ können Sie make install prefix=/a/file/path angeben, um in /a/file/path/{include,lib} zu installieren.

Testen

So testen Sie anhand des von toml-lang/toml-test bereitgestellten Standardtestsatzes:

% make
% cd test1
% bash build.sh   # do this once
% bash run.sh     # this will run the test suite

So testen Sie anhand des von iarna/toml bereitgestellten Standardtestsatzes:

% make
% cd test2
% bash build.sh   # do this once
% bash run.sh     # this will run the test suite