From 3993d7063abe2c3f69dfddb7e7b8337590dba7d9 Mon Sep 17 00:00:00 2001 From: Kibum Kim Date: Sat, 7 Jan 2012 01:11:42 +0900 Subject: Git init --- AUTHORS | 5 + INSTALL | 12 + LICENSE | 21 ++ Makefile | 63 ++++ README | 11 + debian/changelog | 7 + debian/compat | 1 + debian/control | 19 ++ debian/copyright | 25 ++ debian/dirs | 2 + debian/docs | 1 + debian/iniparser-dev.install.in | 4 + debian/iniparser.install.in | 1 + debian/iniparser.pc.in | 9 + debian/rules | 107 +++++++ html/doxygen.css | 358 +++++++++++++++++++++++ html/doxygen.png | Bin 0 -> 1281 bytes html/globals_func.html | 54 ++++ html/index.html | 156 ++++++++++ html/iniparser_8h.html | 629 ++++++++++++++++++++++++++++++++++++++++ html/iniparser_8main.html | 19 ++ html/tab_b.gif | Bin 0 -> 35 bytes html/tab_l.gif | Bin 0 -> 706 bytes html/tab_r.gif | Bin 0 -> 2585 bytes html/tabs.css | 102 +++++++ packaging/iniparser.spec | 71 +++++ src/dictionary.c | 514 ++++++++++++++++++++++++++++++++ src/dictionary.h | 244 ++++++++++++++++ src/iniparser.c | 536 ++++++++++++++++++++++++++++++++++ src/iniparser.h | 296 +++++++++++++++++++ src/strlib.c | 211 ++++++++++++++ src/strlib.h | 108 +++++++ test/Makefile | 24 ++ test/iniexample.c | 117 ++++++++ 34 files changed, 3727 insertions(+) create mode 100644 AUTHORS create mode 100644 INSTALL create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 README create mode 100644 debian/changelog create mode 100644 debian/compat create mode 100644 debian/control create mode 100644 debian/copyright create mode 100644 debian/dirs create mode 100644 debian/docs create mode 100644 debian/iniparser-dev.install.in create mode 100644 debian/iniparser.install.in create mode 100644 debian/iniparser.pc.in create mode 100755 debian/rules create mode 100644 html/doxygen.css create mode 100644 html/doxygen.png create mode 100644 html/globals_func.html create mode 100644 html/index.html create mode 100644 html/iniparser_8h.html create mode 100644 html/iniparser_8main.html create mode 100644 html/tab_b.gif create mode 100644 html/tab_l.gif create mode 100644 html/tab_r.gif create mode 100644 html/tabs.css create mode 100644 packaging/iniparser.spec create mode 100644 src/dictionary.c create mode 100644 src/dictionary.h create mode 100644 src/iniparser.c create mode 100644 src/iniparser.h create mode 100644 src/strlib.c create mode 100644 src/strlib.h create mode 100644 test/Makefile create mode 100644 test/iniexample.c diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..f3dc876 --- /dev/null +++ b/AUTHORS @@ -0,0 +1,5 @@ +Author for this package: +Nicolas Devillard + +Many thanks to the many people who contributed ideas, code, suggestions, +corrections, enhancements. diff --git a/INSTALL b/INSTALL new file mode 100644 index 0000000..0d319b2 --- /dev/null +++ b/INSTALL @@ -0,0 +1,12 @@ + +iniParser installation instructions +----------------------------------- + +1. Modify the Makefile to suit your environment. +2. Type 'make' to make the library. +3. Type 'make check' to make the test program. +4. Type 'test/iniexample' to launch the test program. + +Enjoy! +N. Devillard +Tue Jan 14 11:52:03 CET 2003 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2eae408 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +Copyright (c) 2000 by Nicolas Devillard. +MIT License + +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and associated documentation files (the "Software"), +to deal in the Software without restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..bc5d612 --- /dev/null +++ b/Makefile @@ -0,0 +1,63 @@ +# +# iniparser Makefile +# + +# Compiler settings +CC = gcc +CFLAGS = -O3 -fPIC + +# Ar settings to build the library +AR = ar +ARFLAGS = rcv + +SHLD = ${CC} ${CFLAGS} +LDSHFLAGS = -shared -Wl,-Bsymbolic -Wl,-rpath -Wl,/usr/lib -Wl,-rpath,/usr/lib +LDFLAGS = -Wl,-rpath -Wl,/usr/lib -Wl,-rpath,/usr/lib + +# Set RANLIB to ranlib on systems that require it (Sun OS < 4, Mac OSX) +# RANLIB = ranlib +RANLIB = true + +RM = rm -f + + +# Implicit rules + +SUFFIXES = .o .c .h .a .so .sl + +COMPILE.c=$(CC) $(CFLAGS) -c +.c.o: + @(echo "compiling $< ...") + @($(COMPILE.c) -o $@ $<) + + +SRCS = src/iniparser.c \ + src/dictionary.c \ + src/strlib.c + +OBJS = $(SRCS:.c=.o) + + +default: libiniparser.a libiniparser.so + +libiniparser.a: $(OBJS) + @($(AR) $(ARFLAGS) libiniparser.a $(OBJS)) + @($(RANLIB) libiniparser.a) + +libiniparser.so: $(OBJS) + @$(SHLD) $(LDSHFLAGS) -o $@.0 $(OBJS) $(LDFLAGS) \ + -Wl,-soname=`basename $@`.0 + +clean: + $(RM) $(OBJS) + +veryclean: + $(RM) $(OBJS) libiniparser.a libiniparser.so* + rm -rf ./html ; mkdir html + cd test ; $(MAKE) veryclean + +docs: + @(cd doc ; $(MAKE)) + +check: + @(cd test ; $(MAKE)) diff --git a/README b/README new file mode 100644 index 0000000..466d079 --- /dev/null +++ b/README @@ -0,0 +1,11 @@ + +Welcome to iniParser! + +This modules offers parsing of ini files from the C level. +See a complete documentation in HTML format, from this directory +open the file html/index.html with any HTML-capable browser. + +Enjoy! + +N.Devillard +Thu Nov 17 12:31:42 CET 2005 diff --git a/debian/changelog b/debian/changelog new file mode 100644 index 0000000..1d8244b --- /dev/null +++ b/debian/changelog @@ -0,0 +1,7 @@ +iniparser (2.17-1slp2-9) unstable; urgency=low + + * Initial Release + * Git: unmodified/iniparser + * Tag: iniparser_2.17-1slp2-9 + + -- MyoungJune Park Wed, 07 Dec 2011 13:54:44 +0900 diff --git a/debian/compat b/debian/compat new file mode 100644 index 0000000..7ed6ff8 --- /dev/null +++ b/debian/compat @@ -0,0 +1 @@ +5 diff --git a/debian/control b/debian/control new file mode 100644 index 0000000..be7353e --- /dev/null +++ b/debian/control @@ -0,0 +1,19 @@ +Source: iniparser +Section: libs +Priority: extra +Maintainer: Mike McCormack , MyoungJune Park +Uploaders: Mike McCormack , MyoungJune Park +Build-Depends: debhelper (>= 5), autotools-dev +Standards-Version: 3.7.2 + +Package: iniparser +Architecture: any +Section: libs +Depends: ${shlibs:Depends}, ${misc:Depends} +Description: ini file parser library + +Package: iniparser-dev +Section: libdevel +Architecture: any +Depends: iniparser(= ${binary:Version}), ${misc:Depends} +Description: ini file parser library (headers) diff --git a/debian/copyright b/debian/copyright new file mode 100644 index 0000000..94c27b3 --- /dev/null +++ b/debian/copyright @@ -0,0 +1,25 @@ + +The original source can always be found at: +http://ndevilla.free.fr/iniparser/ + +Copyright (c) 2000 by Nicolas Devillard. + +License: MIT License + +Permission is hereby granted, free of charge, to any person obtaining a +copy of this software and associated documentation files (the "Software"), +to deal in the Software without restriction, including without limitation +the rights to use, copy, modify, merge, publish, distribute, sublicense, +and/or sell copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/debian/dirs b/debian/dirs new file mode 100644 index 0000000..ca882bb --- /dev/null +++ b/debian/dirs @@ -0,0 +1,2 @@ +usr/bin +usr/sbin diff --git a/debian/docs b/debian/docs new file mode 100644 index 0000000..e845566 --- /dev/null +++ b/debian/docs @@ -0,0 +1 @@ +README diff --git a/debian/iniparser-dev.install.in b/debian/iniparser-dev.install.in new file mode 100644 index 0000000..c1edf98 --- /dev/null +++ b/debian/iniparser-dev.install.in @@ -0,0 +1,4 @@ +@PREFIX@/include/* +@PREFIX@/lib/pkgconfig/* +@PREFIX@/lib/*.so +@PREFIX@/lib/*.a diff --git a/debian/iniparser.install.in b/debian/iniparser.install.in new file mode 100644 index 0000000..a7c24c5 --- /dev/null +++ b/debian/iniparser.install.in @@ -0,0 +1 @@ +@PREFIX@/lib/*.so.* diff --git a/debian/iniparser.pc.in b/debian/iniparser.pc.in new file mode 100644 index 0000000..dbdfc6f --- /dev/null +++ b/debian/iniparser.pc.in @@ -0,0 +1,9 @@ +prefix = @PREFIX@ +libdir = @LIBDIR@ +includedir = @INCLUDEDIR@ + +Name : iniparser +Description : This modules offers parsing of ini files from the C level. +Version : @VERSION@ +Libs : -L${libdir} -liniparser +Cflags : -I${includedir} diff --git a/debian/rules b/debian/rules new file mode 100755 index 0000000..4dbeb1c --- /dev/null +++ b/debian/rules @@ -0,0 +1,107 @@ +#!/usr/bin/make -f +# -*- makefile -*- +# Sample debian/rules that uses debhelper. +# This file was originally written by Joey Hess and Craig Small. +# As a special exception, when this file is copied by dh-make into a +# dh-make output file, you may use that output file without restriction. +# This special exception was added by Craig Small in version 0.37 of dh-make. + +# Uncomment this to turn on verbose mode. +#export DH_VERBOSE=1 + + +# These are used for cross-compiling and for saving the configure script +# from having to guess our platform (since we know it already) +DEB_HOST_GNU_TYPE ?= $(shell dpkg-architecture -qDEB_HOST_GNU_TYPE) +DEB_BUILD_GNU_TYPE ?= $(shell dpkg-architecture -qDEB_BUILD_GNU_TYPE) + +CFLAGS ?= -Wall -g +LDFLAGS ?= +PREFIX ?= /usr +DATADIR ?= /opt + +INCLUDEDIR=$(PREFIX)/include/ +INSTDIR=$(CURDIR)/debian/tmp +LIBDIR=$(PREFIX)/lib/ +VERSION=2.17 + +ifneq (,$(findstring noopt,$(DEB_BUILD_OPTIONS))) + CFLAGS += -O0 +else + CFLAGS += -O2 +endif + +LDFLAGS += -Wl,--rpath=$(PREFIX)/lib -Wl,--hash-style=both -Wl,--as-needed + +build: build-stamp + +build-stamp: + dh_testdir + + # Add here commands to compile the package. + make prefix="$(PREFIX)" + + for f in `find $(CURDIR)/debian/ -name "*.in"`; do \ + cat $$f > $${f%.in}; \ + sed -i -e "s#@PREFIX@#$(PREFIX)#g" $${f%.in}; \ + sed -i -e "s#@DATADIR@#$(DATADIR)#g" $${f%.in}; \ + sed -i -e "s#@INCLUDEDIR@#$(INCLUDEDIR)#g" $${f%.in}; \ + sed -i -e "s#@LIBDIR@#$(LIBDIR)#g" $${f%.in}; \ + sed -i -e "s#@VERSION@#$(VERSION)#g" $${f%.in}; \ + done + + touch $@ + +clean: + dh_testdir + dh_testroot + rm -f build-stamp + + # Add here commands to clean up after the build process. + -$(MAKE) distclean + + for f in `find $(CURDIR)/debian/ -name "*.in"`; do \ + rm -f $${f%.in}; \ + done + + dh_clean + +install: build + dh_testdir + dh_testroot + dh_clean -k + dh_installdirs + + # Add here commands to install the package into debian/iniparser. + mkdir -p $(INSTDIR)/$(LIBDIR) + install -m 644 libiniparser.so.0 $(INSTDIR)/$(LIBDIR) + install -m 644 libiniparser.a $(INSTDIR)/$(LIBDIR) + ln -s libiniparser.so.0 $(INSTDIR)/$(LIBDIR)/libiniparser.so + mkdir -p $(INSTDIR)/$(INCLUDEDIR) + install -m 644 src/*.h $(INSTDIR)/$(INCLUDEDIR) + mkdir -p $(INSTDIR)/$(LIBDIR)/pkgconfig + cp $(CURDIR)/debian/iniparser.pc $(INSTDIR)/$(LIBDIR)/pkgconfig + +# Build architecture-independent files here. +binary-indep: build install +# We have nothing to do by default. + +# Build architecture-dependent files here. +binary-arch: build install + dh_testdir + dh_testroot + dh_install --sourcedir=debian/tmp + dh_installman + dh_link + dh_strip + dh_compress + dh_fixperms + dh_makeshlibs + dh_installdeb + dh_shlibdeps + dh_gencontrol + dh_md5sums + dh_builddeb + +binary: binary-indep binary-arch +.PHONY: build clean binary-indep binary-arch binary install diff --git a/html/doxygen.css b/html/doxygen.css new file mode 100644 index 0000000..c7db1a8 --- /dev/null +++ b/html/doxygen.css @@ -0,0 +1,358 @@ +BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV { + font-family: Geneva, Arial, Helvetica, sans-serif; +} +BODY,TD { + font-size: 90%; +} +H1 { + text-align: center; + font-size: 160%; +} +H2 { + font-size: 120%; +} +H3 { + font-size: 100%; +} +CAPTION { font-weight: bold } +DIV.qindex { + width: 100%; + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; + line-height: 140%; +} +DIV.nav { + width: 100%; + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + padding: 2px; + line-height: 140%; +} +DIV.navtab { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} +TD.navtab { + font-size: 70%; +} +A.qindex { + text-decoration: none; + font-weight: bold; + color: #1A419D; +} +A.qindex:visited { + text-decoration: none; + font-weight: bold; + color: #1A419D +} +A.qindex:hover { + text-decoration: none; + background-color: #ddddff; +} +A.qindexHL { + text-decoration: none; + font-weight: bold; + background-color: #6666cc; + color: #ffffff; + border: 1px double #9295C2; +} +A.qindexHL:hover { + text-decoration: none; + background-color: #6666cc; + color: #ffffff; +} +A.qindexHL:visited { text-decoration: none; background-color: #6666cc; color: #ffffff } +A.el { text-decoration: none; font-weight: bold } +A.elRef { font-weight: bold } +A.code:link { text-decoration: none; font-weight: normal; color: #0000FF} +A.code:visited { text-decoration: none; font-weight: normal; color: #0000FF} +A.codeRef:link { font-weight: normal; color: #0000FF} +A.codeRef:visited { font-weight: normal; color: #0000FF} +A:hover { text-decoration: none; background-color: #f2f2ff } +DL.el { margin-left: -1cm } +.fragment { + font-family: monospace, fixed; + font-size: 95%; +} +PRE.fragment { + border: 1px solid #CCCCCC; + background-color: #f5f5f5; + margin-top: 4px; + margin-bottom: 4px; + margin-left: 2px; + margin-right: 8px; + padding-left: 6px; + padding-right: 6px; + padding-top: 4px; + padding-bottom: 4px; +} +DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px } + +DIV.groupHeader { + margin-left: 16px; + margin-top: 12px; + margin-bottom: 6px; + font-weight: bold; +} +DIV.groupText { margin-left: 16px; font-style: italic; font-size: 90% } +BODY { + background: white; + color: black; + margin-right: 20px; + margin-left: 20px; +} +TD.indexkey { + background-color: #e8eef2; + font-weight: bold; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px; + border: 1px solid #CCCCCC; +} +TD.indexvalue { + background-color: #e8eef2; + font-style: italic; + padding-right : 10px; + padding-top : 2px; + padding-left : 10px; + padding-bottom : 2px; + margin-left : 0px; + margin-right : 0px; + margin-top : 2px; + margin-bottom : 2px; + border: 1px solid #CCCCCC; +} +TR.memlist { + background-color: #f0f0f0; +} +P.formulaDsp { text-align: center; } +IMG.formulaDsp { } +IMG.formulaInl { vertical-align: middle; } +SPAN.keyword { color: #008000 } +SPAN.keywordtype { color: #604020 } +SPAN.keywordflow { color: #e08000 } +SPAN.comment { color: #800000 } +SPAN.preprocessor { color: #806020 } +SPAN.stringliteral { color: #002080 } +SPAN.charliteral { color: #008080 } +.mdescLeft { + padding: 0px 8px 4px 8px; + font-size: 80%; + font-style: italic; + background-color: #FAFAFA; + border-top: 1px none #E0E0E0; + border-right: 1px none #E0E0E0; + border-bottom: 1px none #E0E0E0; + border-left: 1px none #E0E0E0; + margin: 0px; +} +.mdescRight { + padding: 0px 8px 4px 8px; + font-size: 80%; + font-style: italic; + background-color: #FAFAFA; + border-top: 1px none #E0E0E0; + border-right: 1px none #E0E0E0; + border-bottom: 1px none #E0E0E0; + border-left: 1px none #E0E0E0; + margin: 0px; +} +.memItemLeft { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memItemRight { + padding: 1px 8px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplItemLeft { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: none; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplItemRight { + padding: 1px 8px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: none; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + background-color: #FAFAFA; + font-size: 80%; +} +.memTemplParams { + padding: 1px 0px 0px 8px; + margin: 4px; + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-color: #E0E0E0; + border-right-color: #E0E0E0; + border-bottom-color: #E0E0E0; + border-left-color: #E0E0E0; + border-top-style: solid; + border-right-style: none; + border-bottom-style: none; + border-left-style: none; + color: #606060; + background-color: #FAFAFA; + font-size: 80%; +} +.search { color: #003399; + font-weight: bold; +} +FORM.search { + margin-bottom: 0px; + margin-top: 0px; +} +INPUT.search { font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +TD.tiny { font-size: 75%; +} +a { + color: #1A41A8; +} +a:visited { + color: #2A3798; +} +.dirtab { padding: 4px; + border-collapse: collapse; + border: 1px solid #84b0c7; +} +TH.dirtab { background: #e8eef2; + font-weight: bold; +} +HR { height: 1px; + border: none; + border-top: 1px solid black; +} + +/* Style for detailed member documentation */ +.memtemplate { + font-size: 80%; + color: #606060; + font-weight: normal; +} +.memnav { + background-color: #e8eef2; + border: 1px solid #84b0c7; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} +.memitem { + padding: 4px; + background-color: #eef3f5; + border-width: 1px; + border-style: solid; + border-color: #dedeee; + -moz-border-radius: 8px 8px 8px 8px; +} +.memname { + white-space: nowrap; + font-weight: bold; +} +.memdoc{ + padding-left: 10px; +} +.memproto { + background-color: #d5e1e8; + width: 100%; + border-width: 1px; + border-style: solid; + border-color: #84b0c7; + font-weight: bold; + -moz-border-radius: 8px 8px 8px 8px; +} +.paramkey { + text-align: right; +} +.paramtype { + white-space: nowrap; +} +.paramname { + color: #602020; + font-style: italic; + white-space: nowrap; +} +/* End Styling for detailed member documentation */ + +/* for the tree view */ +.ftvtree { + font-family: sans-serif; + margin:0.5em; +} +.directory { font-size: 9pt; font-weight: bold; } +.directory h3 { margin: 0px; margin-top: 1em; font-size: 11pt; } +.directory > h3 { margin-top: 0; } +.directory p { margin: 0px; white-space: nowrap; } +.directory div { display: none; margin: 0px; } +.directory img { vertical-align: -30%; } diff --git a/html/doxygen.png b/html/doxygen.png new file mode 100644 index 0000000..f0a274b Binary files /dev/null and b/html/doxygen.png differ diff --git a/html/globals_func.html b/html/globals_func.html new file mode 100644 index 0000000..dc5c712 --- /dev/null +++ b/html/globals_func.html @@ -0,0 +1,54 @@ + + + + + +iniparser 2.x + + + + + + + +
+ +
+  +

+

+ + + diff --git a/html/index.html b/html/index.html new file mode 100644 index 0000000..a095755 --- /dev/null +++ b/html/index.html @@ -0,0 +1,156 @@ + + + + + +iniparser 2.x + + + + + + + +

iniparser documentation

+

+

2.x

+

+Introduction

+iniParser is a simple C library offering ini file parsing services. The library is pretty small (less than 1500 lines of C) and robust, and does not depend on any other external library to compile. It is written in ANSI C and should compile anywhere without difficulty.

+

+

+What is an ini file?

+An ini file is an ASCII file describing simple parameters (character strings, integers, floating-point values or booleans) in an explicit format, easy to use and modify for users.

+An ini file is segmented into Sections, declared by the following syntax:

+

+    [Section Name]
+

+i.e. the section name enclosed in square brackets, alone on a line. Sections names are allowed to contain any character but square brackets or linefeeds. Slashes (/) are also reserved for hierarchical sections (see below).

+In any section are zero or more variables, declared with the following syntax:

+

+    Key = value ; comment
+

+The key is any string (possibly containing blanks). The value is any character on the right side of the equal sign. Values can be given enclosed with quotes. If no quotes are present, the value is understood as containing all characters between the first and the last non-blank characters. The following declarations are identical:

+

+    Hello = "this is a long string value" ; comment
+    Hello = this is a long string value ; comment
+

+The semicolon and comment at the end of the line are optional. If there is a comment, it starts from the first character after the semicolon up to the end of the line.

+Comments in an ini file are:

+

    +
  • Lines starting with a hash sign
  • Blank lines (only blanks or tabs)
  • Comments given on value lines after the semicolon (if present)
+

+

+

+Compiling/installing the library

+Edit the Makefile to indicate the C compiler you want to use, the options to provide to compile ANSI C, and possibly the options to pass to the ar program on your machine to build a library (.a) from a set of object (.o) files.

+Defaults are set for the gcc compiler and the standard ar library builder.

+Type 'make', that should do it.

+To use the library in your programs, add the following line on top of your module:

+

    #include "iniparser.h"
+

+And link your program with the iniparser library by adding -liniparser.a to the compile line.

+See the file test/initest.c for an example.

+

+

+Library reference

+The library is completely documented in its header file. On-line documentation has been generated and can be consulted here:

+

+

+

+

+Using the parser

+Comments are discarded by the parser. Then sections are identified, and in each section a new entry is created for every keyword found. The keywords are stored with the following syntax:

+

+    [Section]
+    Keyword = value ; comment
+

+is converted to the following key pair:

+

+    ("section:keyword", "value")
+

+This means that if you want to retrieve the value that was stored in the section called Pizza, in the keyword Cheese, you would make a request to the dictionary for "pizza:cheese". All section and keyword names are converted to lowercase before storage in the structure. The value side is conserved as it has been parsed, though.

+Section names are also stored in the structure. They are stored using as key the section name, and a NULL associated value. They can be queried through iniparser_find_entry().

+To launch the parser, simply use the function called iniparser_load(), which takes an input file name and returns a newly allocated dictionary structure. This latter object should remain opaque to the user and only accessed through the following accessor functions:

+

+

+Finally, discard this structure using iniparser_freedict().

+All values parsed from the ini file are stored as strings. The getint, getdouble and getboolean accessors are just converting these strings to the requested type on the fly, but you could basically perform this conversion by yourself after having called the getstr accessor.

+Notice that the iniparser_getboolean() function will return an integer (0 or 1), trying to make sense of what was found in the file. Strings starting with "y", "Y", "t", "T" or "1" are considered true values (return 1), strings starting with "n", "N", "f", "F", "0" are considered false (return 0). This allows flexible handling of boolean answers.

+If you want to add extra information into the structure that was not present in the ini file, you can use iniparser_setstr() to insert a string.

+

+

+A word about the implementation

+The dictionary structure is a pretty simple dictionary implementation which might find some uses in other applications. If you are curious, look into the source.

+

+

+Hierarchical ini files

+ini files are nice to present informations to the user in a readable format, but lack a very useful feature: the possibility of organizing data in a hierarchical (tree-like) fashion. The following convention can be used to make ini files obtain this second dimension:

+A section depends on another section if it contains its name as a prefix, separated by slashes (/). For example: we have 2 main sections in the ini file. The first one is called Pizza and has two child subsections called Cheese and Ham. The second main section in the ini file is called Wine and has two child subsections called Year and Grape. As a tree, this could appear as:

+

+    |
+    +-- Pizza
+    |     +-- Cheese
+    |     +-- Ham
+    +-- Wine
+         +--- Year
+         +--- Grape
+

+In an ini file, that would be converted to:

+

+    [Pizza]
+
+    [Pizza/Cheese]
+    Name   = Gorgonzola ;
+    Origin = Italy ;
+
+    [Pizza/Ham]
+    Name   = Parma ;
+    Origin = Italy ;
+
+    [Wine]
+
+    [Wine/Year]
+    Value = 1998 ;
+
+    [Wine/Grape]
+    Name   = Cabernet Sauvignon ;
+    Origin = Chile ;
+

+This proposal is actually more related to the way people write ini files, more than the parser presented here. But it is certainly a useful way of making tree-like data declarations without going through painful formats like XML.

+Accessing the above tree would give something like (error checking removed for clarity sake):

+

    dictionary * d ;
+
+    d = iniparser_load("example.ini");
+
+    printf("cheese name is %s\n", iniparser_getstr(d, "pizza/cheese:name"));
+    printf("grape name is %s\n",  iniparser_getstr(d, "wine/grape:name"));
+
+    iniparser_freedict(d);
+

+The whole ini file above is represented in the dictionary as the following list of pairs:

+

+    key                             value
+
+    "pizza"                         NULL
+    "pizza/cheese"                  NULL
+    "pizza/cheese:name"             "Gorgonzola"
+    "pizza/cheese:origin"           "Italy"
+    "pizza/ham"                     NULL
+    "pizza/ham:name"                "Parma"
+    "pizza/ham:origin"              "Italy"
+    "wine"                          NULL
+    "wine/year"                     NULL
+    "wine/year:value"               "1998"
+    "wine/grape"                    NULL
+    "wine/grape:name"               "Cabernet Sauvignon"
+    "wine/grape:origin"             "Chile"
+

+

+

+Authors

+Nicolas Devillard (ndevilla AT free DOT fr). + + diff --git a/html/iniparser_8h.html b/html/iniparser_8h.html new file mode 100644 index 0000000..9a7d5ec --- /dev/null +++ b/html/iniparser_8h.html @@ -0,0 +1,629 @@ + + + + + +iniparser 2.x + + + + + + + +

iniparser.h File Reference

Parser for ini files. More... +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Functions

int iniparser_getnsec (dictionary *d)
 Get number of sections in a dictionary.
char * iniparser_getsecname (dictionary *d, int n)
 Get name for section n in a dictionary.
void iniparser_dump_ini (dictionary *d, FILE *f)
 Save a dictionary to a loadable ini file.
void iniparser_dump (dictionary *d, FILE *f)
 Dump a dictionary to an opened file pointer.
char * iniparser_getstr (dictionary *d, const char *key)
 Get the string associated to a key, return NULL if not found.
char * iniparser_getstring (dictionary *d, const char *key, char *def)
 Get the string associated to a key.
int iniparser_getint (dictionary *d, const char *key, int notfound)
 Get the string associated to a key, convert to an int.
double iniparser_getdouble (dictionary *d, char *key, double notfound)
 Get the string associated to a key, convert to a double.
int iniparser_getboolean (dictionary *d, const char *key, int notfound)
 Get the string associated to a key, convert to a boolean.
int iniparser_setstr (dictionary *ini, char *entry, char *val)
 Set an entry in a dictionary.
void iniparser_unset (dictionary *ini, char *entry)
 Delete an entry in a dictionary.
int iniparser_find_entry (dictionary *ini, char *entry)
 Finds out if a given entry exists in a dictionary.
dictionary * iniparser_load (const char *ininame)
 Parse an ini file and return an allocated dictionary object.
void iniparser_freedict (dictionary *d)
 Free all memory associated to an ini dictionary.
+

Detailed Description

+Parser for ini files. +

+

Author:
N. Devillard
+
Date:
Mar 2000
+
Version:
Revision
1.23
+
+

Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
void iniparser_dump (dictionary *  d,
FILE *  f 
)
+
+
+ +

+Dump a dictionary to an opened file pointer. +

+

Parameters:
+ + + +
d Dictionary to dump.
f Opened file pointer to dump to.
+
+
Returns:
void
+This function prints out the contents of a dictionary, one element by line, onto the provided file pointer. It is OK to specify stderr or stdout as output files. This function is meant for debugging purposes mostly. +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void iniparser_dump_ini (dictionary *  d,
FILE *  f 
)
+
+
+ +

+Save a dictionary to a loadable ini file. +

+

Parameters:
+ + + +
d Dictionary to dump
f Opened file pointer to dump to
+
+
Returns:
void
+This function dumps a given dictionary into a loadable ini file. It is Ok to specify stderr or stdout as output files. +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
int iniparser_find_entry (dictionary *  ini,
char *  entry 
)
+
+
+ +

+Finds out if a given entry exists in a dictionary. +

+

Parameters:
+ + + +
ini Dictionary to search
entry Name of the entry to look for
+
+
Returns:
integer 1 if entry exists, 0 otherwise
+Finds out if a given entry exists in the dictionary. Since sections are stored as keys with NULL associated values, this is the only way of querying for the presence of sections in a dictionary. +
+

+ +

+
+ + + + + + + + + +
void iniparser_freedict (dictionary *  d  ) 
+
+
+ +

+Free all memory associated to an ini dictionary. +

+

Parameters:
+ + +
d Dictionary to free
+
+
Returns:
void
+Free all memory associated to an ini dictionary. It is mandatory to call this function before the dictionary object gets out of the current context. +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
int iniparser_getboolean (dictionary *  d,
const char *  key,
int  notfound 
)
+
+
+ +

+Get the string associated to a key, convert to a boolean. +

+

Parameters:
+ + + + +
d Dictionary to search
key Key string to look for
notfound Value to return in case of error
+
+
Returns:
integer
+This function queries a dictionary for a key. A key as read from an ini file is given as "section:key". If the key cannot be found, the notfound value is returned.

+A true boolean is found if one of the following is matched:

+

    +
  • A string starting with 'y'
  • A string starting with 'Y'
  • A string starting with 't'
  • A string starting with 'T'
  • A string starting with '1'
+

+A false boolean is found if one of the following is matched:

+

    +
  • A string starting with 'n'
  • A string starting with 'N'
  • A string starting with 'f'
  • A string starting with 'F'
  • A string starting with '0'
+

+The notfound value returned if no boolean is identified, does not necessarily have to be 0 or 1. +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
double iniparser_getdouble (dictionary *  d,
char *  key,
double  notfound 
)
+
+
+ +

+Get the string associated to a key, convert to a double. +

+

Parameters:
+ + + + +
d Dictionary to search
key Key string to look for
notfound Value to return in case of error
+
+
Returns:
double
+This function queries a dictionary for a key. A key as read from an ini file is given as "section:key". If the key cannot be found, the notfound value is returned. +
+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
int iniparser_getint (dictionary *  d,
const char *  key,
int  notfound 
)
+
+
+ +

+Get the string associated to a key, convert to an int. +

+

Parameters:
+ + + + +
d Dictionary to search
key Key string to look for
notfound Value to return in case of error
+
+
Returns:
integer
+This function queries a dictionary for a key. A key as read from an ini file is given as "section:key". If the key cannot be found, the notfound value is returned.

+Supported values for integers include the usual C notation so decimal, octal (starting with 0) and hexadecimal (starting with 0x) are supported. Examples:

+

    +
  • "42" -> 42
  • "042" -> 34 (octal -> decimal)
  • "0x42" -> 66 (hexa -> decimal)
+

+Warning: the conversion may overflow in various ways. Conversion is totally outsourced to strtol(), see the associated man page for overflow handling.

+Credits: Thanks to A. Becker for suggesting strtol() +

+

+ +

+
+ + + + + + + + + +
int iniparser_getnsec (dictionary *  d  ) 
+
+
+ +

+Get number of sections in a dictionary. +

+

Parameters:
+ + +
d Dictionary to examine
+
+
Returns:
int Number of sections found in dictionary
+This function returns the number of sections found in a dictionary. The test to recognize sections is done on the string stored in the dictionary: a section name is given as "section" whereas a key is stored as "section:key", thus the test looks for entries that do not contain a colon.

+This clearly fails in the case a section name contains a colon, but this should simply be avoided.

+This function returns -1 in case of error. +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
char* iniparser_getsecname (dictionary *  d,
int  n 
)
+
+
+ +

+Get name for section n in a dictionary. +

+

Parameters:
+ + + +
d Dictionary to examine
n Section number (from 0 to nsec-1).
+
+
Returns:
Pointer to char string
+This function locates the n-th section in a dictionary and returns its name as a pointer to a string statically allocated inside the dictionary. Do not free or modify the returned string!

+This function returns NULL in case of error. +

+

+ +

+
+ + + + + + + + + + + + + + + + + + +
char* iniparser_getstr (dictionary *  d,
const char *  key 
)
+
+
+ +

+Get the string associated to a key, return NULL if not found. +

+

Parameters:
+ + + +
d Dictionary to search
key Key string to look for
+
+
Returns:
pointer to statically allocated character string, or NULL.
+This function queries a dictionary for a key. A key as read from an ini file is given as "section:key". If the key cannot be found, NULL is returned. The returned char pointer is pointing to a string allocated in the dictionary, do not free or modify it.

+This function is only provided for backwards compatibility with previous versions of iniparser. It is recommended to use iniparser_getstring() instead. +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
char* iniparser_getstring (dictionary *  d,
const char *  key,
char *  def 
)
+
+
+ +

+Get the string associated to a key. +

+

Parameters:
+ + + + +
d Dictionary to search
key Key string to look for
def Default value to return if key not found.
+
+
Returns:
pointer to statically allocated character string
+This function queries a dictionary for a key. A key as read from an ini file is given as "section:key". If the key cannot be found, the pointer passed as 'def' is returned. The returned char pointer is pointing to a string allocated in the dictionary, do not free or modify it. +
+

+ +

+
+ + + + + + + + + +
dictionary* iniparser_load (const char *  ininame  ) 
+
+
+ +

+Parse an ini file and return an allocated dictionary object. +

+

Parameters:
+ + +
ininame Name of the ini file to read.
+
+
Returns:
Pointer to newly allocated dictionary
+This is the parser for ini files. This function is called, providing the name of the file to be read. It returns a dictionary object that should not be accessed directly, but through accessor functions instead.

+The returned dictionary must be freed using iniparser_freedict(). +

+

+ +

+
+ + + + + + + + + + + + + + + + + + + + + + + + +
int iniparser_setstr (dictionary *  ini,
char *  entry,
char *  val 
)
+
+
+ +

+Set an entry in a dictionary. +

+

Parameters:
+ + + + +
ini Dictionary to modify.
entry Entry to modify (entry name)
val New value to associate to the entry.
+
+
Returns:
int 0 if Ok, -1 otherwise.
+If the given entry can be found in the dictionary, it is modified to contain the provided value. If it cannot be found, -1 is returned. It is Ok to set val to NULL. +
+

+ +

+
+ + + + + + + + + + + + + + + + + + +
void iniparser_unset (dictionary *  ini,
char *  entry 
)
+
+
+ +

+Delete an entry in a dictionary. +

+

Parameters:
+ + + +
ini Dictionary to modify
entry Entry to delete (entry name)
+
+
Returns:
void
+If the given entry can be found, it is deleted from the dictionary. +
+

+ + + diff --git a/html/iniparser_8main.html b/html/iniparser_8main.html new file mode 100644 index 0000000..a00eed2 --- /dev/null +++ b/html/iniparser_8main.html @@ -0,0 +1,19 @@ + + + + + +iniparser 2.x + + + + + + + +

iniparser.main File Reference

+ +
+ + + diff --git a/html/tab_b.gif b/html/tab_b.gif new file mode 100644 index 0000000..0d62348 Binary files /dev/null and b/html/tab_b.gif differ diff --git a/html/tab_l.gif b/html/tab_l.gif new file mode 100644 index 0000000..9b1e633 Binary files /dev/null and b/html/tab_l.gif differ diff --git a/html/tab_r.gif b/html/tab_r.gif new file mode 100644 index 0000000..ce9dd9f Binary files /dev/null and b/html/tab_r.gif differ diff --git a/html/tabs.css b/html/tabs.css new file mode 100644 index 0000000..a61552a --- /dev/null +++ b/html/tabs.css @@ -0,0 +1,102 @@ +/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ + +DIV.tabs +{ + float : left; + width : 100%; + background : url("tab_b.gif") repeat-x bottom; + margin-bottom : 4px; +} + +DIV.tabs UL +{ + margin : 0px; + padding-left : 10px; + list-style : none; +} + +DIV.tabs LI, DIV.tabs FORM +{ + display : inline; + margin : 0px; + padding : 0px; +} + +DIV.tabs FORM +{ + float : right; +} + +DIV.tabs A +{ + float : left; + background : url("tab_r.gif") no-repeat right top; + border-bottom : 1px solid #84B0C7; + font-size : x-small; + font-weight : bold; + text-decoration : none; +} + +DIV.tabs A:hover +{ + background-position: 100% -150px; +} + +DIV.tabs A:link, DIV.tabs A:visited, +DIV.tabs A:active, DIV.tabs A:hover +{ + color: #1A419D; +} + +DIV.tabs SPAN +{ + float : left; + display : block; + background : url("tab_l.gif") no-repeat left top; + padding : 5px 9px; + white-space : nowrap; +} + +DIV.tabs INPUT +{ + float : right; + display : inline; + font-size : 1em; +} + +DIV.tabs TD +{ + font-size : x-small; + font-weight : bold; + text-decoration : none; +} + + + +/* Commented Backslash Hack hides rule from IE5-Mac \*/ +DIV.tabs SPAN {float : none;} +/* End IE5-Mac hack */ + +DIV.tabs A:hover SPAN +{ + background-position: 0% -150px; +} + +DIV.tabs LI#current A +{ + background-position: 100% -150px; + border-width : 0px; +} + +DIV.tabs LI#current SPAN +{ + background-position: 0% -150px; + padding-bottom : 6px; +} + +DIV.nav +{ + background : none; + border : none; + border-bottom : 1px solid #84B0C7; +} diff --git a/packaging/iniparser.spec b/packaging/iniparser.spec new file mode 100644 index 0000000..c37831e --- /dev/null +++ b/packaging/iniparser.spec @@ -0,0 +1,71 @@ +Name: iniparser +Summary: Stand-alone ini file parsing library +Version: 2.17 +Release: 1 +Group: Applications/Databases +License: MIT +URL: http://ndevilla.free.fr/iniparser/ +Source: http://ndevilla.free.fr/iniparser/iniparser-%{version}.tar.gz +Requires(post): /sbin/ldconfig +Requires(postun): /sbin/ldconfig + +%description +iniparser is a free stand-alone ini file parsing library. +It is written in portable ANSI C and should compile anywhere. +iniparser is distributed under an MIT license. + +%package devel +Summary: Development tools for stand-alone ini file parsing library +Group: Development/Libraries +Requires: %{name} = %{version}-%{release} + +%description devel +This package contains the header files and development documentation +for %{name}. If you like to develop programs using %{name}, you will need +to install %{name}-devel. + +%prep +%setup -q + +%build + +LDFLAGS="-Wl,--rpath=%{_prefix}/lib -Wl,--hash-style=both -Wl,--as-needed $LDFLAGS" \ + make prefix=%{_prefix} + +make %{?jobs:-j%jobs} + +%install +rm -rf %{buildroot} + +mkdir -p $RPM_BUILD_ROOT/%{_libdir} +install -m 755 libiniparser.so.0 $RPM_BUILD_ROOT/%{_libdir} +ln -s libiniparser.so.0 $RPM_BUILD_ROOT/%{_libdir}/libiniparser.so +mkdir -p $RPM_BUILD_ROOT/%{_includedir} +install -m 755 src/*.h $RPM_BUILD_ROOT/%{_includedir} +install -m 755 src/*.h $RPM_BUILD_ROOT/%{_includedir} +mkdir -p $RPM_BUILD_ROOT/%{_libdir}/pkgconfig +cat > $RPM_BUILD_ROOT/%{_libdir}/pkgconfig/%{name}.pc < +#include +#include +#include + + +/** Maximum value size for integers and doubles. */ +#define MAXVALSZ 1024 + +/** Minimal allocated number of entries in a dictionary */ +#define DICTMINSZ 128 + +/** Invalid key token */ +#define DICT_INVALID_KEY ((char*)-1) + + +/*--------------------------------------------------------------------------- + Private functions + ---------------------------------------------------------------------------*/ + +/* Doubles the allocated size associated to a pointer */ +/* 'size' is the current allocated size. */ +static void * mem_double(void * ptr, int size) +{ + void * newptr ; + + newptr = calloc(2*size, 1); + memcpy(newptr, ptr, size); + free(ptr); + return newptr ; +} + + +/*--------------------------------------------------------------------------- + Function codes + ---------------------------------------------------------------------------*/ + +/*-------------------------------------------------------------------------*/ +/** + @brief Compute the hash key for a string. + @param key Character string to use for key. + @return 1 unsigned int on at least 32 bits. + + This hash function has been taken from an Article in Dr Dobbs Journal. + This is normally a collision-free function, distributing keys evenly. + The key is stored anyway in the struct so that collision can be avoided + by comparing the key itself in last resort. + */ +/*--------------------------------------------------------------------------*/ + +unsigned dictionary_hash(char * key) +{ + int len ; + unsigned hash ; + int i ; + + len = strlen(key); + for (hash=0, i=0 ; i>6) ; + } + hash += (hash <<3); + hash ^= (hash >>11); + hash += (hash <<15); + return hash ; +} + + +/*-------------------------------------------------------------------------*/ +/** + @brief Create a new dictionary object. + @param size Optional initial size of the dictionary. + @return 1 newly allocated dictionary objet. + + This function allocates a new dictionary object of given size and returns + it. If you do not know in advance (roughly) the number of entries in the + dictionary, give size=0. + */ +/*--------------------------------------------------------------------------*/ + +dictionary * dictionary_new(int size) +{ + dictionary * d ; + + /* If no size was specified, allocate space for DICTMINSZ */ + if (sizesize = size ; + d->val = (char **)calloc(size, sizeof(char*)); + d->key = (char **)calloc(size, sizeof(char*)); + d->hash = (unsigned int *)calloc(size, sizeof(unsigned)); + return d ; +} + + +/*-------------------------------------------------------------------------*/ +/** + @brief Delete a dictionary object + @param d dictionary object to deallocate. + @return void + + Deallocate a dictionary object and all memory associated to it. + */ +/*--------------------------------------------------------------------------*/ + +void dictionary_del(dictionary * d) +{ + int i ; + + if (d==NULL) return ; + for (i=0 ; isize ; i++) { + if (d->key[i]!=NULL) + free(d->key[i]); + if (d->val[i]!=NULL) + free(d->val[i]); + } + free(d->val); + free(d->key); + free(d->hash); + free(d); + return ; +} + + + +/*-------------------------------------------------------------------------*/ +/** + @brief Get a value from a dictionary. + @param d dictionary object to search. + @param key Key to look for in the dictionary. + @param def Default value to return if key not found. + @return 1 pointer to internally allocated character string. + + This function locates a key in a dictionary and returns a pointer to its + value, or the passed 'def' pointer if no such key can be found in + dictionary. The returned character pointer points to data internal to the + dictionary object, you should not try to free it or modify it. + */ +/*--------------------------------------------------------------------------*/ +char * dictionary_get(dictionary * d, char * key, char * def) +{ + unsigned hash ; + int i ; + + hash = dictionary_hash(key); + for (i=0 ; isize ; i++) { + if (d->key==NULL) + continue ; + /* Compare hash */ + if (hash==d->hash[i]) { + /* Compare string, to avoid hash collisions */ + if (!strcmp(key, d->key[i])) { + return d->val[i] ; + } + } + } + return def ; +} + +/*-------------------------------------------------------------------------*/ +/** + @brief Get a value from a dictionary, as a char. + @param d dictionary object to search. + @param key Key to look for in the dictionary. + @param def Default value for the key if not found. + @return char + + This function locates a key in a dictionary using dictionary_get, + and returns the first char of the found string. + */ +/*--------------------------------------------------------------------------*/ +char dictionary_getchar(dictionary * d, char * key, char def) +{ + char * v ; + + if ((v=dictionary_get(d,key,DICT_INVALID_KEY))==DICT_INVALID_KEY) { + return def ; + } else { + return v[0] ; + } +} + + +/*-------------------------------------------------------------------------*/ +/** + @brief Get a value from a dictionary, as an int. + @param d dictionary object to search. + @param key Key to look for in the dictionary. + @param def Default value for the key if not found. + @return int + + This function locates a key in a dictionary using dictionary_get, + and applies atoi on it to return an int. If the value cannot be found + in the dictionary, the default is returned. + */ +/*--------------------------------------------------------------------------*/ +int dictionary_getint(dictionary * d, char * key, int def) +{ + char * v ; + + if ((v=dictionary_get(d,key,DICT_INVALID_KEY))==DICT_INVALID_KEY) { + return def ; + } else { + return atoi(v); + } +} + +/*-------------------------------------------------------------------------*/ +/** + @brief Get a value from a dictionary, as a double. + @param d dictionary object to search. + @param key Key to look for in the dictionary. + @param def Default value for the key if not found. + @return double + + This function locates a key in a dictionary using dictionary_get, + and applies atof on it to return a double. If the value cannot be found + in the dictionary, the default is returned. + */ +/*--------------------------------------------------------------------------*/ +double dictionary_getdouble(dictionary * d, char * key, double def) +{ + char * v ; + + if ((v=dictionary_get(d,key,DICT_INVALID_KEY))==DICT_INVALID_KEY) { + return def ; + } else { + return atof(v); + } +} + + +/*-------------------------------------------------------------------------*/ +/** + @brief Set a value in a dictionary. + @param d dictionary object to modify. + @param key Key to modify or add. + @param val Value to add. + @return void + + If the given key is found in the dictionary, the associated value is + replaced by the provided one. If the key cannot be found in the + dictionary, it is added to it. + + It is Ok to provide a NULL value for val, but NULL values for the dictionary + or the key are considered as errors: the function will return immediately + in such a case. + + Notice that if you dictionary_set a variable to NULL, a call to + dictionary_get will return a NULL value: the variable will be found, and + its value (NULL) is returned. In other words, setting the variable + content to NULL is equivalent to deleting the variable from the + dictionary. It is not possible (in this implementation) to have a key in + the dictionary without value. + */ +/*--------------------------------------------------------------------------*/ + +void dictionary_set(dictionary * d, char * key, char * val) +{ + int i ; + unsigned hash ; + + if (d==NULL || key==NULL) return ; + + /* Compute hash for this key */ + hash = dictionary_hash(key) ; + /* Find if value is already in blackboard */ + if (d->n>0) { + for (i=0 ; isize ; i++) { + if (d->key[i]==NULL) + continue ; + if (hash==d->hash[i]) { /* Same hash value */ + if (!strcmp(key, d->key[i])) { /* Same key */ + /* Found a value: modify and return */ + if (d->val[i]!=NULL) + free(d->val[i]); + d->val[i] = val ? strdup(val) : NULL ; + /* Value has been modified: return */ + return ; + } + } + } + } + /* Add a new value */ + /* See if dictionary needs to grow */ + if (d->n==d->size) { + + /* Reached maximum size: reallocate blackboard */ + d->val = (char **)mem_double(d->val, d->size * sizeof(char*)) ; + d->key = (char **)mem_double(d->key, d->size * sizeof(char*)) ; + d->hash = (unsigned int *)mem_double(d->hash, d->size * sizeof(unsigned)) ; + + /* Double size */ + d->size *= 2 ; + } + + /* Insert key in the first empty slot */ + for (i=0 ; isize ; i++) { + if (d->key[i]==NULL) { + /* Add key here */ + break ; + } + } + /* Copy key */ + d->key[i] = strdup(key); + d->val[i] = val ? strdup(val) : NULL ; + d->hash[i] = hash; + d->n ++ ; + return ; +} + +/*-------------------------------------------------------------------------*/ +/** + @brief Delete a key in a dictionary + @param d dictionary object to modify. + @param key Key to remove. + @return void + + This function deletes a key in a dictionary. Nothing is done if the + key cannot be found. + */ +/*--------------------------------------------------------------------------*/ +void dictionary_unset(dictionary * d, char * key) +{ + unsigned hash ; + int i ; + + if (key == NULL) { + return; + } + + hash = dictionary_hash(key); + for (i=0 ; isize ; i++) { + if (d->key[i]==NULL) + continue ; + /* Compare hash */ + if (hash==d->hash[i]) { + /* Compare string, to avoid hash collisions */ + if (!strcmp(key, d->key[i])) { + /* Found key */ + break ; + } + } + } + if (i>=d->size) + /* Key not found */ + return ; + + free(d->key[i]); + d->key[i] = NULL ; + if (d->val[i]!=NULL) { + free(d->val[i]); + d->val[i] = NULL ; + } + d->hash[i] = 0 ; + d->n -- ; + return ; +} + + +/*-------------------------------------------------------------------------*/ +/** + @brief Set a key in a dictionary, providing an int. + @param d Dictionary to update. + @param key Key to modify or add + @param val Integer value to store (will be stored as a string). + @return void + + This helper function calls dictionary_set() with the provided integer + converted to a string using %d. + */ +/*--------------------------------------------------------------------------*/ + + +void dictionary_setint(dictionary * d, char * key, int val) +{ + char sval[MAXVALSZ]; + sprintf(sval, "%d", val); + dictionary_set(d, key, sval); +} + + +/*-------------------------------------------------------------------------*/ +/** + @brief Set a key in a dictionary, providing a double. + @param d Dictionary to update. + @param key Key to modify or add + @param val Double value to store (will be stored as a string). + @return void + + This helper function calls dictionary_set() with the provided double + converted to a string using %g. + */ +/*--------------------------------------------------------------------------*/ + + +void dictionary_setdouble(dictionary * d, char * key, double val) +{ + char sval[MAXVALSZ]; + sprintf(sval, "%g", val); + dictionary_set(d, key, sval); +} + + + +/*-------------------------------------------------------------------------*/ +/** + @brief Dump a dictionary to an opened file pointer. + @param d Dictionary to dump + @param f Opened file pointer. + @return void + + Dumps a dictionary onto an opened file pointer. Key pairs are printed out + as @c [Key]=[Value], one per line. It is Ok to provide stdout or stderr as + output file pointers. + */ +/*--------------------------------------------------------------------------*/ + +void dictionary_dump(dictionary * d, FILE * out) +{ + int i ; + + if (d==NULL || out==NULL) return ; + if (d->n<1) { + fprintf(out, "empty dictionary\n"); + return ; + } + for (i=0 ; isize ; i++) { + if (d->key[i]) { + fprintf(out, "%20s\t[%s]\n", + d->key[i], + d->val[i] ? d->val[i] : "UNDEF"); + } + } + return ; +} + + + +/* Example code */ +#ifdef TESTDIC +#define NVALS 20000 +int main(int argc, char *argv[]) +{ + dictionary * d ; + char * val ; + int i ; + char cval[90] ; + + /* allocate blackboard */ + printf("allocating...\n"); + d = dictionary_new(0); + + /* Set values in blackboard */ + printf("setting %d values...\n", NVALS); + for (i=0 ; in != 0) { + printf("error deleting values\n"); + } + + printf("deallocating...\n"); + dictionary_del(d); + return 0 ; +} +#endif +/* vim: set ts=4 et sw=4 tw=75 */ diff --git a/src/dictionary.h b/src/dictionary.h new file mode 100644 index 0000000..b332680 --- /dev/null +++ b/src/dictionary.h @@ -0,0 +1,244 @@ + +/*-------------------------------------------------------------------------*/ +/** + @file dictionary.h + @author N. Devillard + @date Aug 2000 + @version $Revision: 1.11 $ + @brief Implements a dictionary for string variables. + + This module implements a simple dictionary object, i.e. a list + of string/string associations. This object is useful to store e.g. + informations retrieved from a configuration file (ini files). +*/ +/*--------------------------------------------------------------------------*/ + +/* + $Id: dictionary.h,v 1.11 2002-06-17 09:30:46 ndevilla Exp $ + $Author: ndevilla $ + $Date: 2002-06-17 09:30:46 $ + $Revision: 1.11 $ +*/ + +#ifndef _DICTIONARY_H_ +#define _DICTIONARY_H_ + +/*--------------------------------------------------------------------------- + Includes + ---------------------------------------------------------------------------*/ + +#include +#include +#include +#include + +/*--------------------------------------------------------------------------- + New types + ---------------------------------------------------------------------------*/ + + +/*-------------------------------------------------------------------------*/ +/** + @brief Dictionary object + + This object contains a list of string/string associations. Each + association is identified by a unique string key. Looking up values + in the dictionary is speeded up by the use of a (hopefully collision-free) + hash function. + */ +/*-------------------------------------------------------------------------*/ +typedef struct _dictionary_ { + int n ; /** Number of entries in dictionary */ + int size ; /** Storage size */ + char ** val ; /** List of string values */ + char ** key ; /** List of string keys */ + unsigned * hash ; /** List of hash values for keys */ +} dictionary ; + + +/*--------------------------------------------------------------------------- + Function prototypes + ---------------------------------------------------------------------------*/ + +/*-------------------------------------------------------------------------*/ +/** + @brief Compute the hash key for a string. + @param key Character string to use for key. + @return 1 unsigned int on at least 32 bits. + + This hash function has been taken from an Article in Dr Dobbs Journal. + This is normally a collision-free function, distributing keys evenly. + The key is stored anyway in the struct so that collision can be avoided + by comparing the key itself in last resort. + */ +/*--------------------------------------------------------------------------*/ +unsigned dictionary_hash(char * key); + +/*-------------------------------------------------------------------------*/ +/** + @brief Create a new dictionary object. + @param size Optional initial size of the dictionary. + @return 1 newly allocated dictionary objet. + + This function allocates a new dictionary object of given size and returns + it. If you do not know in advance (roughly) the number of entries in the + dictionary, give size=0. + */ +/*--------------------------------------------------------------------------*/ +dictionary * dictionary_new(int size); + +/*-------------------------------------------------------------------------*/ +/** + @brief Delete a dictionary object + @param d dictionary object to deallocate. + @return void + + Deallocate a dictionary object and all memory associated to it. + */ +/*--------------------------------------------------------------------------*/ +void dictionary_del(dictionary * vd); + +/*-------------------------------------------------------------------------*/ +/** + @brief Get a value from a dictionary. + @param d dictionary object to search. + @param key Key to look for in the dictionary. + @param def Default value to return if key not found. + @return 1 pointer to internally allocated character string. + + This function locates a key in a dictionary and returns a pointer to its + value, or the passed 'def' pointer if no such key can be found in + dictionary. The returned character pointer points to data internal to the + dictionary object, you should not try to free it or modify it. + */ +/*--------------------------------------------------------------------------*/ +char * dictionary_get(dictionary * d, char * key, char * def); + + +/*-------------------------------------------------------------------------*/ +/** + @brief Get a value from a dictionary, as a char. + @param d dictionary object to search. + @param key Key to look for in the dictionary. + @param def Default value for the key if not found. + @return char + + This function locates a key in a dictionary using dictionary_get, + and returns the first char of the found string. + */ +/*--------------------------------------------------------------------------*/ +char dictionary_getchar(dictionary * d, char * key, char def) ; + +/*-------------------------------------------------------------------------*/ +/** + @brief Get a value from a dictionary, as an int. + @param d dictionary object to search. + @param key Key to look for in the dictionary. + @param def Default value for the key if not found. + @return int + + This function locates a key in a dictionary using dictionary_get, + and applies atoi on it to return an int. If the value cannot be found + in the dictionary, the default is returned. + */ +/*--------------------------------------------------------------------------*/ +int dictionary_getint(dictionary * d, char * key, int def); + +/*-------------------------------------------------------------------------*/ +/** + @brief Get a value from a dictionary, as a double. + @param d dictionary object to search. + @param key Key to look for in the dictionary. + @param def Default value for the key if not found. + @return double + + This function locates a key in a dictionary using dictionary_get, + and applies atof on it to return a double. If the value cannot be found + in the dictionary, the default is returned. + */ +/*--------------------------------------------------------------------------*/ +double dictionary_getdouble(dictionary * d, char * key, double def); + +/*-------------------------------------------------------------------------*/ +/** + @brief Set a value in a dictionary. + @param d dictionary object to modify. + @param key Key to modify or add. + @param val Value to add. + @return void + + If the given key is found in the dictionary, the associated value is + replaced by the provided one. If the key cannot be found in the + dictionary, it is added to it. + + It is Ok to provide a NULL value for val, but NULL values for the dictionary + or the key are considered as errors: the function will return immediately + in such a case. + + Notice that if you dictionary_set a variable to NULL, a call to + dictionary_get will return a NULL value: the variable will be found, and + its value (NULL) is returned. In other words, setting the variable + content to NULL is equivalent to deleting the variable from the + dictionary. It is not possible (in this implementation) to have a key in + the dictionary without value. + */ +/*--------------------------------------------------------------------------*/ +void dictionary_set(dictionary * vd, char * key, char * val); + +/*-------------------------------------------------------------------------*/ +/** + @brief Delete a key in a dictionary + @param d dictionary object to modify. + @param key Key to remove. + @return void + + This function deletes a key in a dictionary. Nothing is done if the + key cannot be found. + */ +/*--------------------------------------------------------------------------*/ +void dictionary_unset(dictionary * d, char * key); + + +/*-------------------------------------------------------------------------*/ +/** + @brief Set a key in a dictionary, providing an int. + @param d Dictionary to update. + @param key Key to modify or add + @param val Integer value to store (will be stored as a string). + @return void + + This helper function calls dictionary_set() with the provided integer + converted to a string using %d. + */ +/*--------------------------------------------------------------------------*/ +void dictionary_setint(dictionary * d, char * key, int val); + +/*-------------------------------------------------------------------------*/ +/** + @brief Set a key in a dictionary, providing a double. + @param d Dictionary to update. + @param key Key to modify or add + @param val Double value to store (will be stored as a string). + @return void + + This helper function calls dictionary_set() with the provided double + converted to a string using %g. + */ +/*--------------------------------------------------------------------------*/ +void dictionary_setdouble(dictionary * d, char * key, double val); + +/*-------------------------------------------------------------------------*/ +/** + @brief Dump a dictionary to an opened file pointer. + @param d Dictionary to dump + @param f Opened file pointer. + @return void + + Dumps a dictionary onto an opened file pointer. Key pairs are printed out + as @c [Key]=[Value], one per line. It is Ok to provide stdout or stderr as + output file pointers. + */ +/*--------------------------------------------------------------------------*/ +void dictionary_dump(dictionary * d, FILE * out); + +#endif diff --git a/src/iniparser.c b/src/iniparser.c new file mode 100644 index 0000000..0934087 --- /dev/null +++ b/src/iniparser.c @@ -0,0 +1,536 @@ + +/*-------------------------------------------------------------------------*/ +/** + @file iniparser.c + @author N. Devillard + @date Mar 2000 + @version $Revision: 2.17 $ + @brief Parser for ini files. +*/ +/*--------------------------------------------------------------------------*/ + +/* + $Id: iniparser.c,v 2.17 2007-05-27 13:03:43 ndevilla Exp $ + $Author: ndevilla $ + $Date: 2007-05-27 13:03:43 $ + $Revision: 2.17 $ +*/ + +/*--------------------------------------------------------------------------- + Includes + ---------------------------------------------------------------------------*/ + +#include "iniparser.h" +#include "strlib.h" + +#define ASCIILINESZ 1024 +#define INI_INVALID_KEY ((char*)-1) + +/*--------------------------------------------------------------------------- + Private to this module + ---------------------------------------------------------------------------*/ + +/* Private: add an entry to the dictionary */ +static void iniparser_add_entry( + dictionary * d, + char * sec, + char * key, + char * val) +{ + char longkey[2*ASCIILINESZ+1]; + + /* Make a key as section:keyword */ + if (key!=NULL) { + sprintf(longkey, "%s:%s", sec, key); + } else { + strcpy(longkey, sec); + } + + /* Add (key,val) to dictionary */ + dictionary_set(d, longkey, val); + return ; +} + + +/*-------------------------------------------------------------------------*/ +/** + @brief Get number of sections in a dictionary + @param d Dictionary to examine + @return int Number of sections found in dictionary + + This function returns the number of sections found in a dictionary. + The test to recognize sections is done on the string stored in the + dictionary: a section name is given as "section" whereas a key is + stored as "section:key", thus the test looks for entries that do not + contain a colon. + + This clearly fails in the case a section name contains a colon, but + this should simply be avoided. + + This function returns -1 in case of error. + */ +/*--------------------------------------------------------------------------*/ + +int iniparser_getnsec(dictionary * d) +{ + int i ; + int nsec ; + + if (d==NULL) return -1 ; + nsec=0 ; + for (i=0 ; isize ; i++) { + if (d->key[i]==NULL) + continue ; + if (strchr(d->key[i], ':')==NULL) { + nsec ++ ; + } + } + return nsec ; +} + + +/*-------------------------------------------------------------------------*/ +/** + @brief Get name for section n in a dictionary. + @param d Dictionary to examine + @param n Section number (from 0 to nsec-1). + @return Pointer to char string + + This function locates the n-th section in a dictionary and returns + its name as a pointer to a string statically allocated inside the + dictionary. Do not free or modify the returned string! + + This function returns NULL in case of error. + */ +/*--------------------------------------------------------------------------*/ + +char * iniparser_getsecname(dictionary * d, int n) +{ + int i ; + int foundsec ; + + if (d==NULL || n<0) return NULL ; + foundsec=0 ; + for (i=0 ; isize ; i++) { + if (d->key[i]==NULL) + continue ; + if (strchr(d->key[i], ':')==NULL) { + foundsec++ ; + if (foundsec>n) + break ; + } + } + if (foundsec<=n) { + return NULL ; + } + return d->key[i] ; +} + + +/*-------------------------------------------------------------------------*/ +/** + @brief Dump a dictionary to an opened file pointer. + @param d Dictionary to dump. + @param f Opened file pointer to dump to. + @return void + + This function prints out the contents of a dictionary, one element by + line, onto the provided file pointer. It is OK to specify @c stderr + or @c stdout as output files. This function is meant for debugging + purposes mostly. + */ +/*--------------------------------------------------------------------------*/ +void iniparser_dump(dictionary * d, FILE * f) +{ + int i ; + + if (d==NULL || f==NULL) return ; + for (i=0 ; isize ; i++) { + if (d->key[i]==NULL) + continue ; + if (d->val[i]!=NULL) { + fprintf(f, "[%s]=[%s]\n", d->key[i], d->val[i]); + } else { + fprintf(f, "[%s]=UNDEF\n", d->key[i]); + } + } + return ; +} + +/*-------------------------------------------------------------------------*/ +/** + @brief Save a dictionary to a loadable ini file + @param d Dictionary to dump + @param f Opened file pointer to dump to + @return void + + This function dumps a given dictionary into a loadable ini file. + It is Ok to specify @c stderr or @c stdout as output files. + */ +/*--------------------------------------------------------------------------*/ + +void iniparser_dump_ini(dictionary * d, FILE * f) +{ + int i, j ; + char keym[ASCIILINESZ+1]; + int nsec ; + char * secname ; + int seclen ; + + if (d==NULL || f==NULL) return ; + + nsec = iniparser_getnsec(d); + if (nsec<1) { + /* No section in file: dump all keys as they are */ + for (i=0 ; isize ; i++) { + if (d->key[i]==NULL) + continue ; + fprintf(f, "%s = %s\n", d->key[i], d->val[i]); + } + return ; + } + for (i=0 ; isize ; j++) { + if (d->key[j]==NULL) + continue ; + if (!strncmp(d->key[j], keym, seclen+1)) { + fprintf(f, + "%-30s = %s\n", + d->key[j]+seclen+1, + d->val[j] ? d->val[j] : ""); + } + } + } + fprintf(f, "\n"); + return ; +} + + + + +/*-------------------------------------------------------------------------*/ +/** + @brief Get the string associated to a key, return NULL if not found + @param d Dictionary to search + @param key Key string to look for + @return pointer to statically allocated character string, or NULL. + + This function queries a dictionary for a key. A key as read from an + ini file is given as "section:key". If the key cannot be found, + NULL is returned. + The returned char pointer is pointing to a string allocated in + the dictionary, do not free or modify it. + + This function is only provided for backwards compatibility with + previous versions of iniparser. It is recommended to use + iniparser_getstring() instead. + */ +/*--------------------------------------------------------------------------*/ +char * iniparser_getstr(dictionary * d, const char * key) +{ + return iniparser_getstring(d, key, NULL); +} + + +/*-------------------------------------------------------------------------*/ +/** + @brief Get the string associated to a key + @param d Dictionary to search + @param key Key string to look for + @param def Default value to return if key not found. + @return pointer to statically allocated character string + + This function queries a dictionary for a key. A key as read from an + ini file is given as "section:key". If the key cannot be found, + the pointer passed as 'def' is returned. + The returned char pointer is pointing to a string allocated in + the dictionary, do not free or modify it. + */ +/*--------------------------------------------------------------------------*/ +char * iniparser_getstring(dictionary * d, const char * key, char * def) +{ + char * lc_key ; + char * sval ; + + if (d==NULL || key==NULL) + return def ; + + if (!(lc_key = strdup(strlwc(key)))) { + return NULL; + } + sval = dictionary_get(d, lc_key, def); + free(lc_key); + return sval ; +} + + + +/*-------------------------------------------------------------------------*/ +/** + @brief Get the string associated to a key, convert to an int + @param d Dictionary to search + @param key Key string to look for + @param notfound Value to return in case of error + @return integer + + This function queries a dictionary for a key. A key as read from an + ini file is given as "section:key". If the key cannot be found, + the notfound value is returned. + + Supported values for integers include the usual C notation + so decimal, octal (starting with 0) and hexadecimal (starting with 0x) + are supported. Examples: + + "42" -> 42 + "042" -> 34 (octal -> decimal) + "0x42" -> 66 (hexa -> decimal) + + Warning: the conversion may overflow in various ways. Conversion is + totally outsourced to strtol(), see the associated man page for overflow + handling. + + Credits: Thanks to A. Becker for suggesting strtol() + */ +/*--------------------------------------------------------------------------*/ +int iniparser_getint(dictionary * d, const char * key, int notfound) +{ + char * str ; + + str = iniparser_getstring(d, key, INI_INVALID_KEY); + if (str==INI_INVALID_KEY) return notfound ; + return (int)strtol(str, NULL, 0); +} + + +/*-------------------------------------------------------------------------*/ +/** + @brief Get the string associated to a key, convert to a double + @param d Dictionary to search + @param key Key string to look for + @param notfound Value to return in case of error + @return double + + This function queries a dictionary for a key. A key as read from an + ini file is given as "section:key". If the key cannot be found, + the notfound value is returned. + */ +/*--------------------------------------------------------------------------*/ +double iniparser_getdouble(dictionary * d, char * key, double notfound) +{ + char * str ; + + str = iniparser_getstring(d, key, INI_INVALID_KEY); + if (str==INI_INVALID_KEY) return notfound ; + return atof(str); +} + + + +/*-------------------------------------------------------------------------*/ +/** + @brief Get the string associated to a key, convert to a boolean + @param d Dictionary to search + @param key Key string to look for + @param notfound Value to return in case of error + @return integer + + This function queries a dictionary for a key. A key as read from an + ini file is given as "section:key". If the key cannot be found, + the notfound value is returned. + + A true boolean is found if one of the following is matched: + + - A string starting with 'y' + - A string starting with 'Y' + - A string starting with 't' + - A string starting with 'T' + - A string starting with '1' + + A false boolean is found if one of the following is matched: + + - A string starting with 'n' + - A string starting with 'N' + - A string starting with 'f' + - A string starting with 'F' + - A string starting with '0' + + The notfound value returned if no boolean is identified, does not + necessarily have to be 0 or 1. + */ +/*--------------------------------------------------------------------------*/ +int iniparser_getboolean(dictionary * d, const char * key, int notfound) +{ + char * c ; + int ret ; + + c = iniparser_getstring(d, key, INI_INVALID_KEY); + if (c==INI_INVALID_KEY) return notfound ; + if (c[0]=='y' || c[0]=='Y' || c[0]=='1' || c[0]=='t' || c[0]=='T') { + ret = 1 ; + } else if (c[0]=='n' || c[0]=='N' || c[0]=='0' || c[0]=='f' || c[0]=='F') { + ret = 0 ; + } else { + ret = notfound ; + } + return ret; +} + + +/*-------------------------------------------------------------------------*/ +/** + @brief Finds out if a given entry exists in a dictionary + @param ini Dictionary to search + @param entry Name of the entry to look for + @return integer 1 if entry exists, 0 otherwise + + Finds out if a given entry exists in the dictionary. Since sections + are stored as keys with NULL associated values, this is the only way + of querying for the presence of sections in a dictionary. + */ +/*--------------------------------------------------------------------------*/ + +int iniparser_find_entry( + dictionary * ini, + char * entry +) +{ + int found=0 ; + if (iniparser_getstring(ini, entry, INI_INVALID_KEY)!=INI_INVALID_KEY) { + found = 1 ; + } + return found ; +} + + + +/*-------------------------------------------------------------------------*/ +/** + @brief Set an entry in a dictionary. + @param ini Dictionary to modify. + @param entry Entry to modify (entry name) + @param val New value to associate to the entry. + @return int 0 if Ok, -1 otherwise. + + If the given entry can be found in the dictionary, it is modified to + contain the provided value. If it cannot be found, -1 is returned. + It is Ok to set val to NULL. + */ +/*--------------------------------------------------------------------------*/ + +int iniparser_setstr(dictionary * ini, char * entry, char * val) +{ + dictionary_set(ini, strlwc(entry), val); + return 0 ; +} + +/*-------------------------------------------------------------------------*/ +/** + @brief Delete an entry in a dictionary + @param ini Dictionary to modify + @param entry Entry to delete (entry name) + @return void + + If the given entry can be found, it is deleted from the dictionary. + */ +/*--------------------------------------------------------------------------*/ +void iniparser_unset(dictionary * ini, char * entry) +{ + dictionary_unset(ini, strlwc(entry)); +} + + +/*-------------------------------------------------------------------------*/ +/** + @brief Parse an ini file and return an allocated dictionary object + @param ininame Name of the ini file to read. + @return Pointer to newly allocated dictionary + + This is the parser for ini files. This function is called, providing + the name of the file to be read. It returns a dictionary object that + should not be accessed directly, but through accessor functions + instead. + + The returned dictionary must be freed using iniparser_freedict(). + */ +/*--------------------------------------------------------------------------*/ + +dictionary * iniparser_load(const char * ininame) +{ + dictionary * d ; + char lin[ASCIILINESZ+1]; + char sec[ASCIILINESZ+1]; + char key[ASCIILINESZ+1]; + char val[ASCIILINESZ+1]; + char * where ; + FILE * ini ; + int lineno ; + + if ((ini=fopen(ininame, "r"))==NULL) { + return NULL ; + } + + sec[0]=0; + + /* + * Initialize a new dictionary entry + */ + if (!(d = dictionary_new(0))) { + fclose(ini); + return NULL; + } + lineno = 0 ; + while (fgets(lin, ASCIILINESZ, ini)!=NULL) { + lineno++ ; + where = strskp(lin); /* Skip leading spaces */ + if (*where==';' || *where=='#' || *where==0) + continue ; /* Comment lines */ + else { + if (sscanf(where, "[%[^]]", sec)==1) { + /* Valid section name */ + strcpy(sec, strlwc(sec)); + iniparser_add_entry(d, sec, NULL, NULL); + } else if (sscanf (where, "%[^=] = \"%[^\"]\"", key, val) == 2 + || sscanf (where, "%[^=] = '%[^\']'", key, val) == 2 + || sscanf (where, "%[^=] = %[^;#]", key, val) == 2) { + strcpy(key, strlwc(strcrop(key))); + /* + * sscanf cannot handle "" or '' as empty value, + * this is done here + */ + if (!strcmp(val, "\"\"") || !strcmp(val, "''")) { + val[0] = (char)0; + } else { + strcpy(val, strcrop(val)); + } + iniparser_add_entry(d, sec, key, val); + } + } + } + fclose(ini); + return d ; +} + + + +/*-------------------------------------------------------------------------*/ +/** + @brief Free all memory associated to an ini dictionary + @param d Dictionary to free + @return void + + Free all memory associated to an ini dictionary. + It is mandatory to call this function before the dictionary object + gets out of the current context. + */ +/*--------------------------------------------------------------------------*/ + +void iniparser_freedict(dictionary * d) +{ + dictionary_del(d); +} + +/* vim: set ts=4 et sw=4 tw=75 */ diff --git a/src/iniparser.h b/src/iniparser.h new file mode 100644 index 0000000..5bbd904 --- /dev/null +++ b/src/iniparser.h @@ -0,0 +1,296 @@ + +/*-------------------------------------------------------------------------*/ +/** + @file iniparser.h + @author N. Devillard + @date Mar 2000 + @version $Revision: 1.23 $ + @brief Parser for ini files. +*/ +/*--------------------------------------------------------------------------*/ + +/* + $Id: iniparser.h,v 1.23 2006-09-27 11:03:35 ndevilla Exp $ + $Author: ndevilla $ + $Date: 2006-09-27 11:03:35 $ + $Revision: 1.23 $ +*/ + +#ifndef _INIPARSER_H_ +#define _INIPARSER_H_ + +/*--------------------------------------------------------------------------- + Includes + ---------------------------------------------------------------------------*/ + +#include +#include +#include + +/* + * The following #include is necessary on many Unixes but not Linux. + * It is not needed for Windows platforms. + * Uncomment it if needed. + */ +/* #include */ + +#include "dictionary.h" + +/*-------------------------------------------------------------------------*/ +/** + @brief Get number of sections in a dictionary + @param d Dictionary to examine + @return int Number of sections found in dictionary + + This function returns the number of sections found in a dictionary. + The test to recognize sections is done on the string stored in the + dictionary: a section name is given as "section" whereas a key is + stored as "section:key", thus the test looks for entries that do not + contain a colon. + + This clearly fails in the case a section name contains a colon, but + this should simply be avoided. + + This function returns -1 in case of error. + */ +/*--------------------------------------------------------------------------*/ + +int iniparser_getnsec(dictionary * d); + + +/*-------------------------------------------------------------------------*/ +/** + @brief Get name for section n in a dictionary. + @param d Dictionary to examine + @param n Section number (from 0 to nsec-1). + @return Pointer to char string + + This function locates the n-th section in a dictionary and returns + its name as a pointer to a string statically allocated inside the + dictionary. Do not free or modify the returned string! + + This function returns NULL in case of error. + */ +/*--------------------------------------------------------------------------*/ + +char * iniparser_getsecname(dictionary * d, int n); + + +/*-------------------------------------------------------------------------*/ +/** + @brief Save a dictionary to a loadable ini file + @param d Dictionary to dump + @param f Opened file pointer to dump to + @return void + + This function dumps a given dictionary into a loadable ini file. + It is Ok to specify @c stderr or @c stdout as output files. + */ +/*--------------------------------------------------------------------------*/ + +void iniparser_dump_ini(dictionary * d, FILE * f); + +/*-------------------------------------------------------------------------*/ +/** + @brief Dump a dictionary to an opened file pointer. + @param d Dictionary to dump. + @param f Opened file pointer to dump to. + @return void + + This function prints out the contents of a dictionary, one element by + line, onto the provided file pointer. It is OK to specify @c stderr + or @c stdout as output files. This function is meant for debugging + purposes mostly. + */ +/*--------------------------------------------------------------------------*/ +void iniparser_dump(dictionary * d, FILE * f); + +/*-------------------------------------------------------------------------*/ +/** + @brief Get the string associated to a key, return NULL if not found + @param d Dictionary to search + @param key Key string to look for + @return pointer to statically allocated character string, or NULL. + + This function queries a dictionary for a key. A key as read from an + ini file is given as "section:key". If the key cannot be found, + NULL is returned. + The returned char pointer is pointing to a string allocated in + the dictionary, do not free or modify it. + + This function is only provided for backwards compatibility with + previous versions of iniparser. It is recommended to use + iniparser_getstring() instead. + */ +/*--------------------------------------------------------------------------*/ +char * iniparser_getstr(dictionary * d, const char * key); + + +/*-------------------------------------------------------------------------*/ +/** + @brief Get the string associated to a key + @param d Dictionary to search + @param key Key string to look for + @param def Default value to return if key not found. + @return pointer to statically allocated character string + + This function queries a dictionary for a key. A key as read from an + ini file is given as "section:key". If the key cannot be found, + the pointer passed as 'def' is returned. + The returned char pointer is pointing to a string allocated in + the dictionary, do not free or modify it. + */ +/*--------------------------------------------------------------------------*/ +char * iniparser_getstring(dictionary * d, const char * key, char * def); + +/*-------------------------------------------------------------------------*/ +/** + @brief Get the string associated to a key, convert to an int + @param d Dictionary to search + @param key Key string to look for + @param notfound Value to return in case of error + @return integer + + This function queries a dictionary for a key. A key as read from an + ini file is given as "section:key". If the key cannot be found, + the notfound value is returned. + + Supported values for integers include the usual C notation + so decimal, octal (starting with 0) and hexadecimal (starting with 0x) + are supported. Examples: + + - "42" -> 42 + - "042" -> 34 (octal -> decimal) + - "0x42" -> 66 (hexa -> decimal) + + Warning: the conversion may overflow in various ways. Conversion is + totally outsourced to strtol(), see the associated man page for overflow + handling. + + Credits: Thanks to A. Becker for suggesting strtol() + */ +/*--------------------------------------------------------------------------*/ +int iniparser_getint(dictionary * d, const char * key, int notfound); + +/*-------------------------------------------------------------------------*/ +/** + @brief Get the string associated to a key, convert to a double + @param d Dictionary to search + @param key Key string to look for + @param notfound Value to return in case of error + @return double + + This function queries a dictionary for a key. A key as read from an + ini file is given as "section:key". If the key cannot be found, + the notfound value is returned. + */ +/*--------------------------------------------------------------------------*/ +double iniparser_getdouble(dictionary * d, char * key, double notfound); + +/*-------------------------------------------------------------------------*/ +/** + @brief Get the string associated to a key, convert to a boolean + @param d Dictionary to search + @param key Key string to look for + @param notfound Value to return in case of error + @return integer + + This function queries a dictionary for a key. A key as read from an + ini file is given as "section:key". If the key cannot be found, + the notfound value is returned. + + A true boolean is found if one of the following is matched: + + - A string starting with 'y' + - A string starting with 'Y' + - A string starting with 't' + - A string starting with 'T' + - A string starting with '1' + + A false boolean is found if one of the following is matched: + + - A string starting with 'n' + - A string starting with 'N' + - A string starting with 'f' + - A string starting with 'F' + - A string starting with '0' + + The notfound value returned if no boolean is identified, does not + necessarily have to be 0 or 1. + */ +/*--------------------------------------------------------------------------*/ +int iniparser_getboolean(dictionary * d, const char * key, int notfound); + + +/*-------------------------------------------------------------------------*/ +/** + @brief Set an entry in a dictionary. + @param ini Dictionary to modify. + @param entry Entry to modify (entry name) + @param val New value to associate to the entry. + @return int 0 if Ok, -1 otherwise. + + If the given entry can be found in the dictionary, it is modified to + contain the provided value. If it cannot be found, -1 is returned. + It is Ok to set val to NULL. + */ +/*--------------------------------------------------------------------------*/ + +int iniparser_setstr(dictionary * ini, char * entry, char * val); + +/*-------------------------------------------------------------------------*/ +/** + @brief Delete an entry in a dictionary + @param ini Dictionary to modify + @param entry Entry to delete (entry name) + @return void + + If the given entry can be found, it is deleted from the dictionary. + */ +/*--------------------------------------------------------------------------*/ +void iniparser_unset(dictionary * ini, char * entry); + +/*-------------------------------------------------------------------------*/ +/** + @brief Finds out if a given entry exists in a dictionary + @param ini Dictionary to search + @param entry Name of the entry to look for + @return integer 1 if entry exists, 0 otherwise + + Finds out if a given entry exists in the dictionary. Since sections + are stored as keys with NULL associated values, this is the only way + of querying for the presence of sections in a dictionary. + */ +/*--------------------------------------------------------------------------*/ +int iniparser_find_entry(dictionary * ini, char * entry) ; + +/*-------------------------------------------------------------------------*/ +/** + @brief Parse an ini file and return an allocated dictionary object + @param ininame Name of the ini file to read. + @return Pointer to newly allocated dictionary + + This is the parser for ini files. This function is called, providing + the name of the file to be read. It returns a dictionary object that + should not be accessed directly, but through accessor functions + instead. + + The returned dictionary must be freed using iniparser_freedict(). + */ +/*--------------------------------------------------------------------------*/ +dictionary * iniparser_load(const char * ininame); + +/*-------------------------------------------------------------------------*/ +/** + @brief Free all memory associated to an ini dictionary + @param d Dictionary to free + @return void + + Free all memory associated to an ini dictionary. + It is mandatory to call this function before the dictionary object + gets out of the current context. + */ +/*--------------------------------------------------------------------------*/ +void iniparser_freedict(dictionary * d); + +#endif diff --git a/src/strlib.c b/src/strlib.c new file mode 100644 index 0000000..f0d85ae --- /dev/null +++ b/src/strlib.c @@ -0,0 +1,211 @@ + +/*-------------------------------------------------------------------------*/ +/** + @file strlib.c + @author N. Devillard + @date Jan 2001 + @version $Revision: 1.9 $ + @brief Various string handling routines to complement the C lib. + + This modules adds a few complementary string routines usually missing + in the standard C library. +*/ +/*--------------------------------------------------------------------------*/ + +/* + $Id: strlib.c,v 1.9 2006-09-27 11:04:11 ndevilla Exp $ + $Author: ndevilla $ + $Date: 2006-09-27 11:04:11 $ + $Revision: 1.9 $ +*/ + +/*--------------------------------------------------------------------------- + Includes + ---------------------------------------------------------------------------*/ + +#include +#include + +#include "strlib.h" + +/*--------------------------------------------------------------------------- + Defines + ---------------------------------------------------------------------------*/ +#define ASCIILINESZ 1024 + +/*--------------------------------------------------------------------------- + Function codes + ---------------------------------------------------------------------------*/ + + +/*-------------------------------------------------------------------------*/ +/** + @brief Convert a string to lowercase. + @param s String to convert. + @return ptr to statically allocated string. + + This function returns a pointer to a statically allocated string + containing a lowercased version of the input string. Do not free + or modify the returned string! Since the returned string is statically + allocated, it will be modified at each function call (not re-entrant). + */ +/*--------------------------------------------------------------------------*/ + +char * strlwc(const char * s) +{ + static char l[ASCIILINESZ+1]; + int i ; + + if (s==NULL) return NULL ; + memset(l, 0, ASCIILINESZ+1); + i=0 ; + while (s[i] && i l) { + if (!isspace((int)*(last-1))) + break ; + last -- ; + } + *last = (char)0; + return l ; +} + + + +/*-------------------------------------------------------------------------*/ +/** + @brief Remove blanks at the beginning and the end of a string. + @param s String to parse. + @return ptr to statically allocated string. + + This function returns a pointer to a statically allocated string, + which is identical to the input string, except that all blank + characters at the end and the beg. of the string have been removed. + Do not free or modify the returned string! Since the returned string + is statically allocated, it will be modified at each function call + (not re-entrant). + */ +/*--------------------------------------------------------------------------*/ +char * strstrip(char * s) +{ + static char l[ASCIILINESZ+1]; + char * last ; + + if (s==NULL) return NULL ; + + while (isspace((int)*s) && *s) s++; + + memset(l, 0, ASCIILINESZ+1); + strcpy(l, s); + last = l + strlen(l); + while (last > l) { + if (!isspace((int)*(last-1))) + break ; + last -- ; + } + *last = (char)0; + + return (char*)l ; +} + +/* Test code */ +#ifdef TEST +int main(int argc, char * argv[]) +{ + char * str ; + + str = "\t\tI'm a lumberkack and I'm OK " ; + printf("lowercase: [%s]\n", strlwc(str)); + printf("uppercase: [%s]\n", strupc(str)); + printf("skipped : [%s]\n", strskp(str)); + printf("cropped : [%s]\n", strcrop(str)); + printf("stripped : [%s]\n", strstrip(str)); + + return 0 ; +} +#endif +/* vim: set ts=4 et sw=4 tw=75 */ diff --git a/src/strlib.h b/src/strlib.h new file mode 100644 index 0000000..cd70a62 --- /dev/null +++ b/src/strlib.h @@ -0,0 +1,108 @@ + +/*-------------------------------------------------------------------------*/ +/** + @file strlib.h + @author N. Devillard + @date Jan 2001 + @version $Revision: 1.4 $ + @brief Various string handling routines to complement the C lib. + + This modules adds a few complementary string routines usually missing + in the standard C library. +*/ +/*--------------------------------------------------------------------------*/ + +/* + $Id: strlib.h,v 1.4 2006-09-27 11:04:11 ndevilla Exp $ + $Author: ndevilla $ + $Date: 2006-09-27 11:04:11 $ + $Revision: 1.4 $ +*/ + +#ifndef _STRLIB_H_ +#define _STRLIB_H_ + +/*--------------------------------------------------------------------------- + Includes + ---------------------------------------------------------------------------*/ + +#include +#include + +/*--------------------------------------------------------------------------- + Function codes + ---------------------------------------------------------------------------*/ + +/*-------------------------------------------------------------------------*/ +/** + @brief Convert a string to lowercase. + @param s String to convert. + @return ptr to statically allocated string. + + This function returns a pointer to a statically allocated string + containing a lowercased version of the input string. Do not free + or modify the returned string! Since the returned string is statically + allocated, it will be modified at each function call (not re-entrant). + */ +/*--------------------------------------------------------------------------*/ +char * strlwc(const char * s); + +/*-------------------------------------------------------------------------*/ +/** + @brief Convert a string to uppercase. + @param s String to convert. + @return ptr to statically allocated string. + + This function returns a pointer to a statically allocated string + containing an uppercased version of the input string. Do not free + or modify the returned string! Since the returned string is statically + allocated, it will be modified at each function call (not re-entrant). + */ +/*--------------------------------------------------------------------------*/ +char * strupc(char * s); + +/*-------------------------------------------------------------------------*/ +/** + @brief Skip blanks until the first non-blank character. + @param s String to parse. + @return Pointer to char inside given string. + + This function returns a pointer to the first non-blank character in the + given string. + */ +/*--------------------------------------------------------------------------*/ +char * strskp(char * s); + +/*-------------------------------------------------------------------------*/ +/** + @brief Remove blanks at the end of a string. + @param s String to parse. + @return ptr to statically allocated string. + + This function returns a pointer to a statically allocated string, + which is identical to the input string, except that all blank + characters at the end of the string have been removed. + Do not free or modify the returned string! Since the returned string + is statically allocated, it will be modified at each function call + (not re-entrant). + */ +/*--------------------------------------------------------------------------*/ +char * strcrop(char * s); + +/*-------------------------------------------------------------------------*/ +/** + @brief Remove blanks at the beginning and the end of a string. + @param s String to parse. + @return ptr to statically allocated string. + + This function returns a pointer to a statically allocated string, + which is identical to the input string, except that all blank + characters at the end and the beg. of the string have been removed. + Do not free or modify the returned string! Since the returned string + is statically allocated, it will be modified at each function call + (not re-entrant). + */ +/*--------------------------------------------------------------------------*/ +char * strstrip(char * s) ; + +#endif diff --git a/test/Makefile b/test/Makefile new file mode 100644 index 0000000..aa8fcb2 --- /dev/null +++ b/test/Makefile @@ -0,0 +1,24 @@ +# +# iniparser tests Makefile +# + +CC = gcc +CFLAGS = -g -I../src +LFLAGS = -L.. -liniparser +AR = ar +ARFLAGS = rcv +RM = rm -f + + +default: all + +all: iniexample + +iniexample: iniexample.c + $(CC) $(CFLAGS) -o iniexample iniexample.c -I../src -L.. -liniparser + +clean veryclean: + $(RM) iniexample example.ini + + + diff --git a/test/iniexample.c b/test/iniexample.c new file mode 100644 index 0000000..5e8e71c --- /dev/null +++ b/test/iniexample.c @@ -0,0 +1,117 @@ +#include +#include +#include +#include + +#include "iniparser.h" + +void create_example_ini_file(void); +int parse_ini_file(char * ini_name); + +int main(int argc, char * argv[]) +{ + int status ; + + if (argc<2) { + create_example_ini_file(); + status = parse_ini_file("example.ini"); + } else { + status = parse_ini_file(argv[1]); + } + return status ; +} + +void create_example_ini_file(void) +{ + FILE * ini ; + + ini = fopen("example.ini", "w"); + fprintf(ini, "\n\ +#\n\ +# This is an example of ini file\n\ +#\n\ +\n\ +[Pizza]\n\ +\n\ +Ham = yes ;\n\ +Mushrooms = TRUE ;\n\ +Capres = 0 ;\n\ +Cheese = NO ;\n\ +\n\ +\n\ +[Wine]\n\ +\n\ +Grape = Cabernet Sauvignon ;\n\ +Year = 1989 ;\n\ +Country = Spain ;\n\ +Alcohol = 12.5 ;\n\ +\n\ +#\n\ +# end of file\n\ +#\n"); + + fclose(ini); +} + + +int parse_ini_file(char * ini_name) +{ + dictionary * ini ; + + /* Some temporary variables to hold query results */ + int b ; + int i ; + double d ; + char * s ; + + ini = iniparser_load(ini_name); + if (ini==NULL) { + fprintf(stderr, "cannot parse file [%s]", ini_name); + return -1 ; + } + iniparser_dump(ini, stderr); + + /* Get pizza attributes */ + printf("Pizza:\n"); + + b = iniparser_getboolean(ini, "pizza:ham", -1); + printf("Ham: [%d]\n", b); + b = iniparser_getboolean(ini, "pizza:mushrooms", -1); + printf("Mushrooms: [%d]\n", b); + b = iniparser_getboolean(ini, "pizza:capres", -1); + printf("Capres: [%d]\n", b); + b = iniparser_getboolean(ini, "pizza:cheese", -1); + printf("Cheese: [%d]\n", b); + + /* Get wine attributes */ + printf("Wine:\n"); + s = iniparser_getstr(ini, "wine:grape"); + if (s) { + printf("grape: [%s]\n", s); + } else { + printf("grape: not found\n"); + } + i = iniparser_getint(ini, "wine:year", -1); + if (i>0) { + printf("year: [%d]\n", i); + } else { + printf("year: not found\n"); + } + s = iniparser_getstr(ini, "wine:country"); + if (s) { + printf("country: [%s]\n", s); + } else { + printf("country: not found\n"); + } + d = iniparser_getdouble(ini, "wine:alcohol", -1.0); + if (d>0.0) { + printf("alcohol: [%g]\n", d); + } else { + printf("alcohol: not found\n"); + } + + iniparser_freedict(ini); + return 0 ; +} + + -- cgit v1.2.3