tomlc99

tomlc99

TOML en c99 ; Conforme à la version 1.0.

Si vous recherchez une bibliothèque C++, vous pouvez essayer ce wrapper : https://github.com/cktan/tomlcpp.

• Compatible avec TOML v1.0.0.
• Testé avec plusieurs suites de tests, notamment toml-lang/toml-test et iarna/toml-spec-tests.
• Fournit une interface très simple et intuitive.

Usage

Veuillez consulter le fichier toml.h pour plus de détails. Voici un exemple simple qui analyse ce fichier de configuration :

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

Voici les étapes habituelles pour obtenir les valeurs d'un fichier :

1. Analysez le fichier TOML.
2. Parcourez et localisez une table dans TOML.
3. Extrayez les valeurs du tableau.
4. Libérez la mémoire allouée.

Vous trouverez ci-dessous un exemple d'analyse des valeurs de l'exemple de table.

 #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 ;
}

Accéder au contenu du tableau

Les tables TOML sont des dictionnaires dans lesquels les recherches sont effectuées à l'aide de clés de chaîne. En général, toutes les fonctions d'accès aux tables sont nommées toml_*_in(...) .

Dans le cas normal, vous connaissez la clé et son type de contenu, et les récupérations peuvent être effectuées à l'aide de l'une de ces fonctions :

 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 );

Vous pouvez également interroger les clés d'une table à l'aide d'un index entier :

 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 );
}

Accès au contenu du tableau

Les tableaux TOML peuvent être supprimés à l'aide d'indices entiers. En général, toutes les méthodes d'accès aux tableaux sont nommées toml_*_at() .

Pour obtenir la taille d'un tableau :

 int size = toml_array_nelem ( arr );

Pour obtenir le contenu d'un tableau, utilisez un index valide et appelez l'une de ces fonctions :

 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

Certaines fonctions toml_*_at et toml_*_in renvoient une structure toml_datum_t. L'indicateur ok dans la structure indique si l'appel de fonction a réussi. Si tel est le cas, vous pouvez procéder à la lecture de la valeur correspondant au type de contenu.

Par exemple:

 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 */
}

** IMPORTANT : si la valeur consultée est une chaîne ou un horodatage, vous devez appeler respectivement free(datum.us) ou free(datum.u.ts) après utilisation. **

Construire et installer

Une marque normale suffit. Vous pouvez également simplement inclure les fichiers toml.c et toml.h dans votre projet.

L'appel de make install installera les fichiers d'en-tête et de bibliothèque dans /usr/local/{include,lib}.

Vous pouvez également spécifier make install prefix=/a/file/path à installer dans /a/file/path/{include,lib}.

Essai

Pour tester par rapport à l'ensemble de tests standard fourni par toml-lang/toml-test :

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

Pour tester par rapport à l'ensemble de tests standard fourni par iarna/toml :

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