विन्यास फाइल। Libconfig पुस्तकालय

परिचय

किसी तरह से मैं अपने सर्वर में कॉन्फ़िगरेशन आईएनआई फाइल या जसन को कैसे तेज कर सकता हूं, मैं विकल्पों के माध्यम से हल कर रहा था, लेकिन किसी कारण से वे असहज या बहुत सरल थे, या साइकिल। और हालाँकि मुझे xml कॉन्फ़िगरेशन बहुत पसंद है, कभी-कभी यह बहुत बड़ी फ़ाइलों के रूप में होती है और बहुत कम संख्या में सेटिंग्स के लिए बहुत सारे पाठ लिखने में असुविधा होती है। एक बार एक मित्र ने इस विषय पर एक प्रश्न पूछा, तो उसने मुझे एक पुस्तकालय दिया। वह यम के साथ मिश्रित जोंस को याद दिलाती है।



पुस्तकालय में दो इंटरफेस हैं: कार्यात्मक और वस्तु। वे बहुत समान हैं, चूंकि ऑब्जेक्ट आंतरिक रूप से एक कार्यात्मक कार्यान्वयन का उपयोग करता है, लेकिन इस पोस्ट में कुछ मतभेदों पर चर्चा की गई है।


सेटअप और कनेक्शन
कॉन्फ़िगरेशन फ़ाइल
C में उपयोग करें
सी ++ में उपयोग

सेटअप और कनेक्शन

पुस्तकालय कई रिपॉजिटरी में है, इसलिए स्थापना सरल है:

$ sudo aptitude install libconfig8 libconfig8-dev libconfig++ libconfig++-dev 

स्रोत कोड में, C ++ केवल एक समावेश के साथ जुड़ा हुआ है:

 #include <libconfig.h++> 

या

 #include <libconfig.hh> 

या C के लिए

 #include <libconfig.h> 

कॉन्फ़िगरेशन फ़ाइल

कॉन्फ़िगरेशन फ़ाइल निम्न प्रकार की एक संरचना है:

 # Example application configuration file version = "1.0"; application: { window: { title = "My Application"; size = { w = 640; h = 480; }; pos = { x = 350; y = 250; }; }; list = ( ( "abc", 123, true ), 1.234, ( /* an empty list */) ); books = ( { title = "Treasure Island"; author = "Robert Louis Stevenson"; price = 29.95; qty = 5; }, { title = "Snow Crash"; author = "Neal Stephenson"; price = 9.99; qty = 8; } ); misc: { pi = 3.141592654; bigint = 9223372036854775807L; columns = [ "Last Name", "First Name", "MI" ]; bitmask = 0x1FC3; }; }; 

कॉन्फ़िगरेशन में मुख्य प्रकार की प्रविष्टियाँ निम्न प्रकार हैं:

तत्व (सेटिंग)

यह कॉन्फ़िगरेशन संरचना का न्यूनतम महत्वपूर्ण हिस्सा है और इसमें कुंजी-मूल्य का रूप है:

 name = value; 

या

 name : value 

समूह (समूह)

समूहों में किसी भी संख्या में तत्व हो सकते हैं, लेकिन प्रत्येक तत्व में समूह के भीतर एक अद्वितीय कुंजी होनी चाहिए। यह ब्रेसिज़ में लिखा है:

 { settings... } 

ऐरे (Arrays)

वे किसी भी संख्या में तत्व होते हैं, यहां तक ​​कि शून्य भी, लेकिन सभी तत्वों में केवल मान शामिल होते हैं और सरणी के भीतर एक ही स्केलर प्रकार होना चाहिए। वर्ग कोष्ठक में लिखता है:

 [ value, value ... ] 

सूची (सूचियां)

सूचियों में शून्य या अधिक स्केलर तत्व, सरणियाँ, समूह या सूचियाँ हैं। इसे कोष्ठक में लिखा गया है:

 ( value, value ... ) 

पूर्णांक मान (पूर्णांक)

वे सामान्य दशमलव तरीके (written 0-9) या हेक्साडेसिमल (0xA-f) में लिखे जाते हैं। लेकिन पूर्णांक मान -2147483648..2147483647 (32 बिट) सीमा तक सीमित हैं, लेकिन यदि बड़ी रेंज की आवश्यकता है, तो अंत में एक 'एल' जोड़ा जाता है।

 3578934 897893450934L 

आंशिक फ्लोटिंग पॉइंट नंबर (फ्लोट्स)

इसे सामान्य तरीके से दर्ज भी किया जाता है।

 3.1415 

'ई' के साथ घातीय संकेतन मानक है।

बुलियन वैल्यू (बुलियन)

मानों को 'सही' या 'गलत' लिखा जाता है और केस-असंवेदनशील (बिना उद्धरण के, निश्चित रूप से) होते हैं।

लाइन्स (स्ट्रिंग्स)

के रूप में दोहरे उद्धरण चिह्नों में लिखा है

 "     " 

।
निम्न विकल्पों के परिणामस्वरूप समान स्ट्रिंग मान होगा:

 "  " "  " 

 "  " /*  */ "  " //  " " 

।

टिप्पणियाँ

कॉन्फ़िगरेशन में, C ++ में तीन प्रकार के परिचित हैं:

• # लाइन के अंत में एक पंक्ति
• // लाइन के अंत तक सिंगल लाइन भी
• लाइन ब्रेक सहित / * ... * / मल्टी-लाइन टिप्पणी

बाहरी कनेक्शन (शामिल)

यह सामान्य रूप से, सबसे स्वादिष्ट स्वादिष्ट है।

 # file: quote.cfg quote = "Criticism may not be agreeable, but it is necessary." " It fulfils the same function as pain in the human" " body. It calls attention to an unhealthy state of" " things.\n" "\t--Winston Churchill"; 

 # file: test.cfg info: { name = "Winston Churchill"; @include "quote.cfg" country = "UK"; }; 

एपीआई के साथ

इस भाग में, मैं सभी कार्यों का वर्णन नहीं करूँगा, केवल मुख्य वाले, क्योंकि वे आम तौर पर समान हैं, और मुख्य बारीकियों।

नीचे इस्तेमाल किए गए कार्यों का विवरण

 #include <stdio.h> #include <stdlib.h> #include <libconfig.h> /*      'example.cfg'     */ int main(int argc, char **argv) { /*   . */ config_t cfg; config_setting_t *setting; const char *str; config_init(&cfg); /*   */ /*  .  ,    */ if(! config_read_file(&cfg, "example.cfg")) { fprintf(stderr, "%s:%d - %s\n", config_error_file(&cfg), config_error_line(&cfg), config_error_text(&cfg)); config_destroy(&cfg); return(EXIT_FAILURE); } /*    "name". */ if(config_lookup_string(&cfg, "name", &str)) printf("Store name: %s\n\n", str); else fprintf(stderr, "No 'name' setting in configuration file.\n"); /*     . */ setting = config_lookup(&cfg, "inventory.books"); if(setting != NULL) { int count = config_setting_length(setting); int i; printf("%-30s %-30s %-6s %s\n", "TITLE", "AUTHOR", "PRICE", "QTY"); for(i = 0; i < count; ++i) { config_setting_t *book = config_setting_get_elem(setting, i); /*    ,      . */ const char *title, *author; double price; int qty; if(!(config_setting_lookup_string(book, "title", &title) && config_setting_lookup_string(book, "author", &author) && config_setting_lookup_float(book, "price", &price) && config_setting_lookup_int(book, "qty", &qty))) continue; printf("%-30s %-30s $%6.2f %3d\n", title, author, price, qty); } putchar('\n'); } /*     . */ setting = config_lookup(&cfg, "inventory.movies"); if(setting != NULL) { unsigned int count = config_setting_length(setting); unsigned int i; printf("%-30s %-10s %-6s %s\n", "TITLE", "MEDIA", "PRICE", "QTY"); for(i = 0; i < count; ++i) { config_setting_t *movie = config_setting_get_elem(setting, i); /*    ,     . */ const char *title, *media; double price; int qty; if(!(config_setting_lookup_string(movie, "title", &title) && config_setting_lookup_string(movie, "media", &media) && config_setting_lookup_float(movie, "price", &price) && config_setting_lookup_int(movie, "qty", &qty))) continue; printf("%-30s %-10s $%6.2f %3d\n", title, media, price, qty); } putchar('\n'); } config_destroy(&cfg); /*   ,      */ return(EXIT_SUCCESS); } 

कार्यक्षमता का एक छोटा सा विवरण

प्रलेखन में पूर्ण विवरण।

config_t - कॉन्फ़िगरेशन फ़ाइल का प्रकार (यह एक प्रविष्टि नहीं है)। मोटे तौर पर, मुख्य कंटेनर।
config_setting_t - कॉन्फ़िगरेशन आइटम का ऑब्जेक्ट। उदाहरण कंटेनर द्वारा खोजे जाने वाले आइटम के लिए लौटाए गए पॉइंटर का उपयोग करता है।
int config_read_file (config_t * config, const char * filename) - फ़ंक्शन मेमोरी में फाइल फ़ाइलनाम को पढ़ता है और टाइप config_t के ऑब्जेक्ट को पॉप्युलेट करता है। आप फ़ाइल से नहीं पढ़ सकते हैं, लेकिन तुरंत config_read_string () को लाइन "फ़ीड" करें या फ़ाइल डिस्क्रिप्टर को config_read () दें
int config_lookup_string (const config_t * config, const char * path, const char ** value) - खोज करता है और एक मान के रूप में स्ट्रिंग मान के लिए दिए गए पथ पथ पर config config के अंदर एक मान देता है।
config_setting_t * config_lookup (const config_t * config, const char * path) - दिए गए आंतरिक पथ द्वारा कॉन्फ़िगरेशन के अंदर रिकॉर्ड की खोज करता है और उसे वापस करता है।
config_setting_t * config_setting_get_elem (const config_setting_t * सेटिंग, अहस्ताक्षरित इंट इंडेक्स) - सरणियों के लिए उपयोग किया जाता है, क्रम में ऐसे और इस तरह के नंबर के साथ तत्वों को वापस करने के लिए सूची
int config_setting_lookup_string (कॉन्स्टेबल config_setting_t * सेटिंग, कास्ट char * name, const char ** value * -
दिए गए सेटिंग प्रविष्टि के सापेक्ष नाम तत्व के बच्चे का मूल्य लौटाता है
जब एक विशिष्ट रिकॉर्ड में मूल्य प्राप्त करना आवश्यक होता है, तो कार्य करता है
int config_setting_get_int (const config_setting_t * सेटिंग)

C ++ API

एक ही उदाहरण है, लेकिन C ++ में। साइट पर पूर्ण प्रलेखन

 #include <iostream> #include <iomanip> #include <cstdlib> #include <libconfig.h++> using namespace std; using namespace libconfig; // ,    'example.cfg'     int main(int argc, char **argv) { Config cfg; //  .     //   ++   ,    try { cfg.readFile("example.cfg"); } catch(const FileIOException &fioex) { std::cerr << "I/O error while reading file." << std::endl; return(EXIT_FAILURE); } catch(const ParseException &pex) { std::cerr << "Parse error at " << pex.getFile() << ":" << pex.getLine() << " - " << pex.getError() << std::endl; return(EXIT_FAILURE); } //   . try { string name = cfg.lookup("name"); cout << "Store name: " << name << endl << endl; } catch(const SettingNotFoundException &nfex) { cerr << "No 'name' setting in configuration file." << endl; } const Setting& root = cfg.getRoot(); //     . try { const Setting &books = root["inventory"]["books"]; int count = books.getLength(); cout << setw(30) << left << "TITLE" << " " << setw(30) << left << "AUTHOR" << " " << setw(6) << left << "PRICE" << " " << "QTY" << endl; for(int i = 0; i < count; ++i) { const Setting &book = books[i]; //    ,     . string title, author; double price; int qty; if(!(book.lookupValue("title", title) && book.lookupValue("author", author) && book.lookupValue("price", price) && book.lookupValue("qty", qty))) continue; cout << setw(30) << left << title << " " << setw(30) << left << author << " " << '$' << setw(6) << right << price << " " << qty << endl; } cout << endl; } catch(const SettingNotFoundException &nfex) { // Ignore. } //     . try { const Setting &movies = root["inventory"]["movies"]; int count = movies.getLength(); cout << setw(30) << left << "TITLE" << " " << setw(10) << left << "MEDIA" << " " << setw(6) << left << "PRICE" << " " << "QTY" << endl; for(int i = 0; i < count; ++i) { const Setting &movie = movies[i]; //   ,    . string title, media; double price; int qty; if(!(movie.lookupValue("title", title) && movie.lookupValue("media", media) && movie.lookupValue("price", price) && movie.lookupValue("qty", qty))) continue; cout << setw(30) << left << title << " " << setw(10) << left << media << " " << '$' << setw(6) << right << price << " " << qty << endl; } cout << endl; } catch(const SettingNotFoundException &nfex) { // Ignore. } return(EXIT_SUCCESS); } 

यहां कार्यात्मक शैली में समान सिद्धांत, केवल उस कॉन्फ़िगरेशन से डेटा प्राप्त करने से पहले आपको रूट तत्व cfg.getRoot () प्राप्त करने की आवश्यकता होती है ; और उसके बाद ही वह बाकी तत्वों की ओर मुड़ता है। आपको यह भी ध्यान रखने की आवश्यकता है कि अपवाद लगभग सभी त्रुटियों पर फेंक दिए गए हैं

निष्कर्ष

सुविधाजनक विन्यास पढ़ने के अलावा, एपीआई मीडिया को विन्यास तत्व बनाने और लिखने के लिए कार्यक्षमता भी प्रदान करता है।

लाइब्रेरी वेबसाइट पर प्रलेखन [en] में सब कुछ है।

स्रोत के साथ उदाहरण आते हैं। उन्हें कंसोल में निम्नलिखित कमांड के साथ डाउनलोड किया जा सकता है:

 $ apt-get source libconfig++ 

या सीधे लिंक के लिए स्रोत से।

प्रलेखन HTML और पीडीएफ प्रारूपों में प्रस्तुत किया गया है।
GNU LGPL लाइसेंस।