tomlc99

tomlc99

TOML في 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