tomlc99

tomlc99

ТОМЛ в c99; Совместимость с версией 1.0.

Если вы ищете библиотеку C++, вы можете попробовать эту оболочку: https://github.com/cktan/tomlcpp.

• Совместим с TOML v1.0.0.
• Протестировано с использованием нескольких наборов тестов, включая toml-lang/toml-test и iarna/toml-spec-tests.
• Обеспечивает очень простой и интуитивно понятный интерфейс.

Использование

Подробности смотрите в файле toml.h Ниже приведен простой пример анализа этого файла конфигурации:

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

Это обычные шаги для получения значений из файла:

1. Разберите файл TOML.
2. Перейдите и найдите таблицу в TOML.
3. Извлеките значения из таблицы.
4. Освободите выделенную память.

Ниже приведен пример анализа значений из таблицы примера.

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

Доступ к содержимому таблицы

Таблицы TOML — это словари, в которых поиск осуществляется с использованием строковых ключей. Обычно все функции доступа к таблицам называются toml_*_in(...) .

В обычном случае вы знаете ключ и тип его содержимого, и извлечение можно выполнить с помощью одной из этих функций:

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

Вы также можете запросить ключи в таблице, используя целочисленный индекс:

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

Доступ к содержимому массива

Массивы TOML можно разыменовать с использованием целочисленных индексов. В общем, все методы доступа к массивам называются toml_*_at() .

Чтобы получить размер массива:

 int size = toml_array_nelem ( arr );

Чтобы получить содержимое массива, используйте действительный индекс и вызовите одну из этих функций:

 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

Некоторые функции toml_*_at и toml_*_in возвращают структуру toml_datum_t. Флаг ok в структуре указывает, был ли вызов функции успешным. Если да, вы можете продолжить чтение значения, соответствующего типу контента.

Например:

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

** ВАЖНО: если доступное значение является строкой или меткой времени, после использования необходимо вызвать free(datum.us) или free(datum.u.ts) соответственно. **

Сборка и установка

Обычной марки вполне достаточно. Вы также можете просто включить файлы toml.c и toml.h в свой проект.

Вызов make install установит файлы заголовка и библиотеки в /usr/local/{include,lib}.

Альтернативно, укажите make install prefix=/a/file/path для установки в /a/file/path/{include,lib}.

Тестирование

Чтобы протестировать стандартный набор тестов, предоставленный toml-lang/toml-test:

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

Чтобы протестировать стандартный набор тестов, предоставленный iarna/toml:

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