tomlc99

tomlc99

TOML en c99; Compatible con v1.0.

Si está buscando una biblioteca C++, puede probar este contenedor: https://github.com/cktan/tomlcpp.

• Compatible con TOML v1.0.0.
• Probado con múltiples conjuntos de pruebas, incluidos toml-lang/toml-test y iarna/toml-spec-tests.
• Proporciona una interfaz muy sencilla e intuitiva.

Uso

Consulte el archivo toml.h para obtener más detalles. El siguiente es un ejemplo simple que analiza este archivo de configuración:

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

Estos son los pasos habituales para obtener valores de un archivo:

1. Analice el archivo TOML.
2. Recorre y localiza una tabla en TOML.
3. Extraer valores de la tabla.
4. Libere la memoria asignada.

A continuación se muestra un ejemplo de cómo analizar los valores de la tabla de ejemplo.

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

Accediendo al contenido de la tabla

Las tablas TOML son diccionarios donde las búsquedas se realizan utilizando claves de cadena. En general, todas las funciones de acceso a las tablas se denominan toml_*_in(...) .

En el caso normal, conoce la clave y su tipo de contenido, y la recuperación se puede realizar utilizando una de estas funciones:

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

También puedes interrogar las claves en una tabla usando un índice entero:

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

Accediendo al contenido de la matriz

Las matrices TOML se pueden eliminar utilizando índices enteros. En general, todos los métodos de acceso a matrices se denominan toml_*_at() .

Para obtener el tamaño de una matriz:

 int size = toml_array_nelem ( arr );

Para obtener el contenido de una matriz, use un índice válido y llame a una de estas funciones:

 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

Algunas funciones toml_*_at y toml_*_in devuelven una estructura toml_datum_t. El indicador ok en la estructura indica si la llamada a la función fue exitosa. De ser así, podrá proceder a leer el valor correspondiente al tipo de contenido.

Por ejemplo:

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

** IMPORTANTE: si el valor al que se accede es una cadena o una marca de tiempo, debe llamar free(datum.us) o free(datum.u.ts) respectivamente después del uso. **

Construyendo e instalando

Una marca normal es suficiente. También puede simplemente incluir los archivos toml.c y toml.h en su proyecto.

Al invocar make install se instalarán los archivos de encabezado y biblioteca en /usr/local/{include,lib}.

Alternativamente, especifique make install prefix=/a/file/path para instalar en /a/file/path/{include,lib}.

Pruebas

Para realizar pruebas con el conjunto de pruebas estándar proporcionado por toml-lang/toml-test:

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

Para realizar pruebas con el conjunto de pruebas estándar proporcionado por iarna/toml:

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