tomlc99

Tomlc99

TOML em c99; Compatível com v1.0.

Se você estiver procurando por uma biblioteca C++, você pode tentar este wrapper: https://github.com/cktan/tomlcpp.

• Compatível com TOML v1.0.0.
• Testado com vários conjuntos de testes, incluindo toml-lang/toml-test e iarna/toml-spec-tests.
• Oferece interface muito simples e intuitiva.

Uso

Consulte o arquivo toml.h para obter detalhes. A seguir está um exemplo simples que analisa este arquivo de configuração:

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

Estas são as etapas usuais para obter valores de um arquivo:

1. Analise o arquivo TOML.
2. Percorra e localize uma tabela no TOML.
3. Extraia valores da tabela.
4. Libere memória alocada.

Abaixo está um exemplo de análise dos valores da tabela de exemplo.

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

Acessando o Conteúdo da Tabela

As tabelas TOML são dicionários onde as pesquisas são feitas usando chaves de string. Em geral, todas as funções de acesso em tabelas são nomeadas toml_*_in(...) .

No caso normal, você conhece a chave e seu tipo de conteúdo, e as recuperações podem ser feitas usando uma destas funções:

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

Você também pode interrogar as chaves de uma tabela usando um índice inteiro:

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

Acessando o conteúdo do array

Matrizes TOML podem ser desrefificadas usando índices inteiros. Em geral, todos os métodos de acesso em arrays são nomeados toml_*_at() .

Para obter o tamanho de um array:

 int size = toml_array_nelem ( arr );

Para obter o conteúdo de um array, use um índice válido e chame uma destas funções:

 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

Algumas funções toml_*_at e toml_*_in retornam uma estrutura toml_datum_t. O sinalizador ok na estrutura indica se a chamada da função foi bem-sucedida. Nesse caso, você pode prosseguir com a leitura do valor correspondente ao tipo de conteúdo.

Por exemplo:

 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: se o valor acessado for uma string ou um timestamp, você deve chamar free(datum.us) ou free(datum.u.ts) respectivamente após o uso. **

Construindo e instalando

Uma marca normal é suficiente. Você também pode simplesmente incluir os arquivos toml.c e toml.h em seu projeto.

Invocar make install instalará os arquivos de cabeçalho e biblioteca em /usr/local/{include,lib}.

Como alternativa, especifique make install prefix=/a/file/path para instalar em /a/file/path/{include,lib}.

Teste

Para testar o conjunto de testes padrão fornecido por toml-lang/toml-test:

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

Para testar o conjunto de testes padrão fornecido por iarna/toml:

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