PROJECT(libzypp)
# Library
-IF ( ${LIB} )
+IF ( DEFINED LIB )
SET ( LIB_INSTALL_DIR "${CMAKE_INSTALL_PREFIX}/${LIB}" )
-ELSE ( ${LIB} )
+ELSE ( DEFINED LIB )
IF ( EXISTS "${CMAKE_INSTALL_PREFIX}/lib64" )
SET( LIB_SUFFIX "64" )
ENDIF ( EXISTS "${CMAKE_INSTALL_PREFIX}/lib64" )
SET ( LIB_INSTALL_DIR "${CMAKE_INSTALL_PREFIX}/lib${LIB_SUFFIX}" )
-ENDIF ( ${LIB} )
+ENDIF ( DEFINED LIB )
MESSAGE(STATUS "Libraries will be installed in ${LIB_INSTALL_DIR}" )
####################################################################
# CONFIGURATION #
GET_FILENAME_COMPONENT(_potBasename ${_potFile} NAME_WE)
GET_FILENAME_COMPONENT(_absPotFile ${_potFile} ABSOLUTE)
- MESSAGE( STATUS "pot: ${_potFile} converted to ${_potBasename}")
+#MESSAGE( STATUS "pot: ${_potFile} converted to ${_potBasename}")
SET(_addToAll)
IF(${_firstPoFile} STREQUAL "ALL")
%build
mkdir build
cd build
-cmake -DCMAKE_INSTALL_PREFIX=%{prefix} -DLIB=${_lib} -DCMAKE_SKIP_RPATH=1 ..
+cmake -DCMAKE_INSTALL_PREFIX=%{prefix} -DLIB=%{_lib} -DCMAKE_SKIP_RPATH=1 ..
CXXFLAGS="$RPM_OPT_FLAGS" \
make %{?jobs:-j %jobs}
make -C doc/autodoc %{?jobs:-j %jobs}
DESTINATION ${CMAKE_INSTALL_PREFIX}/include/zypp/parser
)
+SET( zypp_parser_inifile_SRCS
+ parser/inifile/ini_file.cpp
+)
+
+SET( zypp_parser_inifile_HEADERS
+ parser/inifile/ini_file.hpp
+)
+
+INSTALL( FILES
+ ${zypp_parser_inifile_HEADERS}
+ DESTINATION ${CMAKE_INSTALL_PREFIX}/include/zypp/parser/inifile
+)
+
SET( zypp_parser_tagfile_SRCS
parser/tagfile/ParseException.cc
parser/tagfile/TagFileParser.cc
${zypp_target_modalias_SRCS}
${zypp_target_SRCS}
${zypp_parser_yum_SRCS}
+${zypp_parser_inifile_SRCS}
${zypp_detail_SRCS}
${zypp_pool_SRCS}
)
${zypp_target_modalias_HEADERS}
${zypp_target_HEADERS}
${zypp_parser_yum_HEADERS}
+${zypp_parser_inifile_HEADERS}
${zypp_detail_HEADERS}
${zypp_pool_HEADERS}
)
MACRO( SET_LOGGROUP _group _files )
SET_SOURCE_FILES_PROPERTIES( ${_files} COMPILE_FLAGS -DZYPP_BASE_LOGGER_LOGGROUP=\\"${_group}\\" )
FOREACH (_currentFile ${ARGN})
- MESSAGE( STATUS "setting loggroup to \"${_group}\" for ${_currentFile}" )
+#MESSAGE( STATUS "setting loggroup to \"${_group}\" for ${_currentFile}" )
SET_SOURCE_FILES_PROPERTIES( ${_currentFile} COMPILE_FLAGS -DZYPP_BASE_LOGGER_LOGGROUP=\\"${_group}\\" )
ENDFOREACH (_currentFile ${ARGN})
ENDMACRO( SET_LOGGROUP )
--- /dev/null
+# Configuration file (really a shell script!)
+name=ini_file
+version=1.0
--- /dev/null
+//
+// Copyright (c) 2006 Alexis Wilke
+//
+// Boost Software License - Version 1.0 - August 17th, 2003
+//
+// Permission is hereby granted, free of charge, to any person or organization
+// obtaining a copy of the software and accompanying documentation covered by
+// this license (the "Software") to use, reproduce, display, distribute,
+// execute, and transmit the Software, and to prepare derivative works of the
+// Software, and to permit third-parties to whom the Software is furnished to
+// do so, all subject to the following:
+//
+// The copyright notices in the Software and this entire statement, including
+// the above license grant, this restriction and the following disclaimer,
+// must be included in all copies of the Software, in whole or in part, and
+// all derivative works of the Software, unless such copies or derivative
+// works are solely in the form of machine-executable object code generated by
+// a source language processor.
+//
+// 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, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+// DEALINGS IN THE SOFTWARE.
+//
+// Find documentation on the home website:
+//
+// http://boost-extras.sourceforge.net/
+// http://boost-extras.sourceforge.net/ini_file/ini_file.html
+//
+#include "ini_file.hpp"
+#include <iostream>
+
+namespace ini_file
+{
+const param param_map::m_empty("");
+const section section_map::m_empty("");
+
+std::istream& operator >> (std::istream& in, section_map& _section_map)
+{
+ boost::shared_ptr<section> sec;
+ boost::shared_ptr<param> par;
+ std::string result, comment, name;
+ char c, quote;
+ const char *s, *e;
+ int line, i;
+
+ line = 0;
+ while(!in.eof() && !!in) {
+ ++line;
+ getline(in, result);
+//std::cout << "Line = <<" << result << ">>" << std::endl;
+ if(result.size() == 0) continue;
+ switch(c = result[0]) {
+ case ';':
+ // comment
+ if(comment.size() > 0) {
+ comment += "\n";
+ }
+ s = result.c_str() + 1;
+ while(isspace(*s)) {
+ ++s;
+ }
+ comment += s;
+ break;
+
+ case '[':
+ // section
+ s = result.c_str() + 1;
+ e = result.c_str() + result.size();
+ while(s < e && isspace(s[0])) {
+ ++s;
+ }
+ while(e > s && isspace(e[-1])) {
+ --e;
+ }
+ if(e[-1] != ']') {
+ // name must end with ']' + optional spaces
+ throw ini_exceptions::invalid_section_name();
+ }
+ --e;
+ while(e > s && isspace(e[-1])) {
+ --e;
+ }
+ if(e == s) {
+ // name mustn't be empty
+ throw ini_exceptions::invalid_section_name();
+ }
+ // valid section name, create section
+ sec.reset(new section(result.substr(s - result.c_str(), e - s)));
+ sec->set_comment(comment);
+ comment.clear();
+ _section_map.insert(sec);
+ break;
+
+ default:
+ // make sure the variable starts with a letter or _
+ // (there is no spec. for that, but it feels sensical;
+ // should that apply to section names?)
+ if((c >= 'a' || c <= 'z')
+ && (c >= 'A' || c <= 'Z')
+ && c == '_') {
+ if(isspace(c)) {
+ // note the loop does not test 'result[0]'
+ // since we just checked it (it's in 'c')
+ i = result.size() - 1;
+ while(i > 0 && isspace(result[i])) {
+ --i;
+ }
+ if(i == 0) {
+ // empty line with just spaces
+ continue;
+ }
+ }
+ // unsure what this is
+ throw ini_exceptions::invalid_param_name();
+ }
+ if(!sec) {
+ // variables before a section is not valid
+ throw ini_exceptions::param_without_section();
+ }
+ s = result.c_str();
+ e = s + 1;
+ while(!isspace(*e) && *e != '=') {
+ ++e;
+ }
+ // This case cannot happen since we start with e = s + 1.
+ //if(e == s) {
+ // // empty variable names are not acceptable
+ // throw ini_exceptions::invalid_param_name();
+ //}
+ par.reset(new param(result.substr(0, e - s)));
+ while(isspace(*e)) {
+ ++e;
+ }
+ if(*e != '=') {
+ // variable names must be followed by '='
+ throw ini_exceptions::invalid_parameter();
+ }
+ ++e;
+ while(isspace(*e)) {
+ ++e;
+ }
+ quote = *e;
+ if(quote == '"' || quote == '\'') {
+ // quoted value
+ ++e;
+ s = e;
+ while(*e != quote && *e != '\0') {
+ // allow escaping, but keep the backslashes
+ // TODO: which is wrong!
+ if(*e == '\\' && e[1] == quote) {
+ ++e;
+ }
+ ++e;
+ }
+ if(*e != quote) {
+ throw ini_exceptions::invalid_quotation();
+ }
+ // warning: we ignore what follows
+ }
+ else {
+ s = e;
+ e = result.c_str() + result.size();
+ while(e > s && isspace(e[-1])) {
+ --e;
+ }
+ }
+ par->set_value(result.substr(s - result.c_str(), e - s));
+ par->set_comment(comment);
+ comment.clear();
+ sec->insert(par);
+ break;
+
+ }
+ }
+ return in;
+}
+
+namespace details
+{
+std::ostream& operator << (std::ostream& out, const name& _name)
+{
+ return out << _name.get_name();
+}
+std::ostream& operator << (std::ostream& out, const comment& _comment)
+{
+ // TODO:
+ // we would need a filter for comments, but I'm not too sure we can
+ // do that (i.e. add a filter, write the comment, remove the filter)
+ bool new_line = true;
+ std::string::const_iterator i;
+ std::string::const_iterator end = _comment.get_comment().end();
+ for(i = _comment.get_comment().begin(); i != end; ++i) {
+ if(*i == '\r' || *i == '\n') {
+ out << *i;
+ new_line = true;
+ }
+ else {
+ if(new_line) {
+ out << "; ";
+ }
+ new_line = false;
+ out << *i;
+ }
+ }
+ if(!new_line) {
+ out << std::endl;
+ }
+ return out;
+}
+}
+
+std::ostream& operator << (std::ostream& out, const param& _param)
+{
+ if(_param.get_name().size() == 0) {
+ if(_param.get_value().size() == 0) {
+ return out;
+ }
+ throw ini_exceptions::param_name_missing();
+ }
+
+ // output <comment> and then '<name>='
+ out << static_cast<const details::comment&>(_param)
+ << static_cast<const details::name&>(_param)
+ << '=';
+
+ // output <value>, check whether we need quotation
+ const std::string& value = _param.get_value();
+ const char *s = value.c_str();
+ const char *e = s + value.size();
+ if(*s == '"' || *s == '\'' || isspace(*s) || (e > s && isspace(e[-1]))) {
+ // need quotation to not lose any data
+ char quote = '\0';
+ while(*s != '\0') {
+ if(*s == '\'') {
+ quote = '"';
+ break;
+ }
+ if(*s == '"') {
+ quote = '\'';
+ break;
+ }
+ ++s;
+ }
+ s = value.c_str();
+ out << quote;
+ while(*s != '\0') {
+ if(*s == quote) {
+ out << "\\";
+ }
+ out << *s;
+ ++s;
+ }
+ out << quote;
+ }
+ else {
+ // no quotation necessary
+ out << value;
+ }
+
+ out << std::endl;
+}
+
+
+std::ostream& operator << (std::ostream& out, const param_map& _param_map)
+{
+ param_map::const_iterator i = _param_map.begin();
+ param_map::const_iterator end = _param_map.end();
+ while(i != end) {
+ out << *(*i).second;
+ ++i;
+ }
+ return out;
+}
+
+std::ostream& operator << (std::ostream& out, const section& _section)
+{
+ if(_section.get_name().size() == 0) {
+ if(_section.size() == 0) {
+ return out;
+ }
+ throw ini_exceptions::section_name_missing();
+ }
+
+ return out
+ << static_cast<const details::comment&>(_section)
+ << '[' << static_cast<const details::name&>(_section) << ']' << std::endl
+ << static_cast<const param_map&>(_section);
+}
+std::ostream& operator << (std::ostream& out, const section_map& _section_map)
+{
+ section_map::const_iterator i = _section_map.begin();
+ section_map::const_iterator end = _section_map.end();
+ while(i != end) {
+ out << *(*i).second;
+ out << std::endl;
+ ++i;
+ }
+ return out;
+}
+
+
+
+
+} // namespace ini_file
+// vim: ts=4
--- /dev/null
+//
+// Copyright (c) 2006 Alexis Wilke
+//
+// Boost Software License - Version 1.0 - August 17th, 2003
+//
+// Permission is hereby granted, free of charge, to any person or organization
+// obtaining a copy of the software and accompanying documentation covered by
+// this license (the "Software") to use, reproduce, display, distribute,
+// execute, and transmit the Software, and to prepare derivative works of the
+// Software, and to permit third-parties to whom the Software is furnished to
+// do so, all subject to the following:
+//
+// The copyright notices in the Software and this entire statement, including
+// the above license grant, this restriction and the following disclaimer,
+// must be included in all copies of the Software, in whole or in part, and
+// all derivative works of the Software, unless such copies or derivative
+// works are solely in the form of machine-executable object code generated by
+// a source language processor.
+//
+// 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, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+// DEALINGS IN THE SOFTWARE.
+//
+// Find documentation on the home website:
+//
+// http://boost-extras.sourceforge.net/
+// http://boost-extras.sourceforge.net/ini_file/ini_file.html
+//
+#ifndef BOOST_EXTRAS_INI_FILE
+#define BOOST_EXTRAS_INI_FILE 1
+
+#include <boost/shared_ptr.hpp>
+#include <exception>
+#include <string>
+#include <map>
+#include <iostream>
+
+namespace ini_file
+{
+
+
+namespace ini_exceptions
+{
+ class ini_file_exception : std::exception {};
+ class section_name_missing : ini_file_exception {};
+ class invalid_section_name : ini_file_exception {};
+ class param_name_missing : ini_file_exception {};
+ class invalid_param_name : ini_file_exception {};
+ class invalid_parameter : ini_file_exception {};
+ class param_without_section : ini_file_exception {};
+ class invalid_quotation : ini_file_exception {};
+} // namespace ini_exceptions
+
+
+namespace details
+{
+struct name
+{
+ name(const std::string& _name) : m_name(_name) {}
+ virtual ~name() {}
+ //void set_name(const std::string& _name) { m_name = _name; }
+ const std::string& get_name() const { return m_name; }
+
+private:
+ const std::string m_name;
+};
+extern std::ostream& operator << (std::ostream& out, const name& _name);
+struct comment
+{
+ virtual ~comment() {}
+ void set_comment(const std::string& _comment) { m_comment = _comment; }
+ const std::string& get_comment() const { return m_comment; }
+
+private:
+ std::string m_comment;
+};
+extern std::ostream& operator << (std::ostream& out, const comment& _comment);
+} // namespace details
+
+
+struct param : details::name, details::comment
+{
+ param(const std::string& _name) : details::name(_name) {}
+ void set_value(const std::string& _value) { m_value = _value; }
+ const std::string& get_value() const { return m_value; }
+
+ param& operator = (const std::string& _value) { set_value(_value); return *this; }
+ operator const std::string& () const { return m_value; }
+private:
+ std::string m_value;
+};
+namespace details
+{
+typedef std::map<std::string, boost::shared_ptr<param> > param_map_t;
+}
+struct param_map : details::param_map_t
+{
+ void insert(boost::shared_ptr<param> _p)
+ {
+ if(_p) {
+ details::param_map_t::insert(details::param_map_t::value_type(_p->get_name(), _p));
+ }
+ }
+ param& operator [] (const std::string& _name)
+ {
+ details::param_map_t::iterator i = details::param_map_t::find(_name);
+ if(i == end()) {
+ boost::shared_ptr<param> p(new param(_name));
+ insert(p);
+ return *p;
+ }
+ return *i->second;
+ }
+ const param& operator [] (const std::string& _name) const
+ {
+ details::param_map_t::const_iterator i = details::param_map_t::find(_name);
+ if(i == end()) return m_empty;
+ return *i->second;
+ }
+
+private:
+ static const param m_empty;
+};
+
+
+
+struct section : details::name, details::comment, param_map
+{
+ section(const std::string& _name) : details::name(_name) {}
+};
+namespace details
+{
+typedef std::map<std::string, boost::shared_ptr<section> > section_map_t;
+}
+struct section_map : details::section_map_t
+{
+ void insert(boost::shared_ptr<section> _s)
+ {
+ if(_s) {
+ details::section_map_t::insert(details::section_map_t::value_type(_s->get_name(), _s));
+ }
+ }
+ const section& operator [] (const std::string& _name) const
+ {
+ details::section_map_t::const_iterator i = details::section_map_t::find(_name);
+ if(i == end()) return m_empty;
+ return *i->second;
+ }
+ section& operator [] (const std::string& _name)
+ {
+ details::section_map_t::iterator i = details::section_map_t::find(_name);
+ if(i == end()) {
+ boost::shared_ptr<section> s(new section(_name));
+ insert(s);
+ return *s;
+ }
+ return *i->second;
+ }
+private:
+ static const section m_empty;
+};
+
+
+
+
+
+extern std::istream& operator >> (std::istream& in, section_map& _section_map);
+
+extern std::ostream& operator << (std::ostream& out, const param& _param);
+extern std::ostream& operator << (std::ostream& out, const section& _section);
+
+extern std::ostream& operator << (std::ostream& out, const param_map& _param_map);
+extern std::ostream& operator << (std::ostream& out, const section_map& _section_map);
+
+
+
+} // namespace ini_file
+
+
+#endif // #ifdef BOOST_EXTRAS_INI_FILE
+// vim: ts=4
--- /dev/null
+<html>
+<head>
+ <title>ini_file</title>
+ <style>
+ body {
+ margin: 0px;
+ }
+ .code {
+ font-family: monospace;
+ background-color: #f8f8f8;
+ border: 1px solid #c0c0c0;
+ margin: 5px;
+ }
+ .fig {
+ color: grey;
+ font-style: italic;
+ font-size: 80%;
+ }
+ </style>
+</head>
+<body>
+ <div style="margin: 15px;">
+ <h1>ini_file helpers</h1>
+
+ <p>
+ Go to the <a href="http://boost-extras.sourceforge.net/documentation.html">Boost-Extra Home Page</a>.
+ </p>
+
+ <h2>Summary</h2>
+
+ <blockquote>
+ <ul>
+ <li><a href="#introduction">Introduction</a></li>
+ <li><a href="#usage">Usage</a></li>
+ <li><a href="#thread">Thread Consideration</a></li>
+ <li><a href="#advantages">Advantages of these Classes</a></li>
+ <li><a href="#synopsis">Synopsis</a></li>
+ <li><a href="#members">Members</a></li>
+ <ul>
+ <li><a href="#ini_exceptions">ini_exceptions</a></li>
+ <li><a href="#param">param</a></li>
+ <li><a href="#param_map">param_map</a></li>
+ <li><a href="#section">section</a></li>
+ <li><a href="#section_map">section_map</a></li>
+ <li><a href="#helpers">Helper Functions</a></li>
+ </ul>
+ <li><a href="ini_file_header.html">ini_file.hpp</a></li>
+ </ul>
+ </blockquote>
+
+
+ <h2><a name="introduction">Introduction</a></h2>
+ <p>
+ The <b>ini_file</b> classes are used to read and write INI files.
+ The format of an INI file is defined as follow:
+ </p>
+ <ul>
+ <li>Files are composed of comments, sections and parameters</li>
+ <li>Comments start with a semi-colon (;) at the very beginning
+ of a line</li>
+ <li>Sections names are defined between square brackets ([ and ]) and
+ start at the very beginning of a line</li>
+ <li>Parameters are defined as a name, followed by an equal sign
+ followed by a value. There can be spaces before and after the
+ equal sign. Spaces at the end of a value are also trimmed.</li>
+ <li>Empty lines are legal and skipped silently.</li>
+ </ul>
+ <p>
+ There is an example:
+ </p>
+<pre class="code">
+
+ <font color="blue">; INI file sample</font>
+ <font color="purple">[section1]</font>
+ <font color="green">var1=value1</font>
+ <font color="green">var2 = value2</font>
+
+ <font color="purple">[section2]</font>
+ <font color="green">var3= value3</font>
+ <font color="green">var4 =value4</font>
+
+</pre>
+<center><span class="fig">Example 1. file format definition</span></center>
+
+
+ <h2><a name="usage">Usage</a></h2>
+ <p>
+ An INI file is represented by a set of sections and one set of
+ parameters per section. Sets are defined as maps. Sections and
+ parameters have a name, a comment and parameters also have a
+ value. All of these objects are represented below:
+ </p>
+ <p>
+ <table align="center"><tbody><tr><td align="center">
+ <div style="border: 1px black solid; padding: 10px; text-align: center;">
+ <img src="ini_file.png" width="509" height="265"/>
+ </div>
+ <span class="fig">Fig 1. Representation of the ini_file classes.</span>
+ </td></tr></tbody></table>
+ </p>
+
+ <p>
+ So creating and saving an INI file comes down to:
+ </p>
+
+ <ul>
+ <li>instantiating a <b>section_map</b> object;</li>
+ <li>adding parameters in sections;</li>
+ <li>saving the INI file with the << operator.</li>
+ </ul>
+
+<pre class="code">
+
+ <font color="blue">// create an ini file and save it to std::cout</font>
+ int main(int argc, char *argv[])
+ {
+ ini_file::section_map ini;
+
+ ini["section1"]["var1"] = "value of var1";
+ ini["section1"]["var2"] = "value of var2";
+ ini["section2"]["var3"] = "value of var3";
+ ini["section2"]["var4"] = "value of var4";
+
+ std::cout << ini;
+ };
+
+</pre>
+<center><span class="fig">Example 2. create an INI file</span></center>
+
+ <p>
+ In a similar fashion, it is possible to read and use an INI file by:
+ </p>
+
+ <ul>
+ <li>instantiating a <b>section_map</b> object;</li>
+ <li>reading an INI file with the >> operator;</li>
+ <li>getting the parameters value.</li>
+ </ul>
+
+<pre class="code">
+
+ <font color="blue">// read an ini file from a stream and print out the content</font>
+ int main(int argc, char *argv[])
+ {
+ ini_file::section_map ini;
+
+ {
+ // first we create a file that we can then read
+ std::fstream output;
+ output.open("test_file.ini", std::fstream::out);
+ output << "; This is an auto-generated test file." << std::endl;
+ output << "[section1]" << std::endl;
+ output << "var1=This is variable ONE" << std::endl;
+ output << "var2=This is variable TWO" << std::endl;
+ output << "[section2]" << std::endl;
+ output << "var3 = \" This is \\\"variable\\\" THREE \" " << std::endl;
+ output << "; Comment on variable 4" << std::endl;
+ output << "var4=This is variable FOUR" << std::endl;
+ } // file closes
+
+ // now try to read it and print out the content
+ std::fstream input;
+ input.open("test_file.ini", std::fstream::in);
+
+ input >> ini;
+
+ std::cout << "section1 -> " << ini["section1"];
+ std::cout << "section1.var1 -> " << ini["section1"]["var1"];
+ std::cout << "section1.var2 -> " << ini["section1"]["var2"];
+ std::cout << "section2 -> " << ini["section2"];
+ std::cout << "section2.var3 -> " << ini["section2"]["var3"];
+ std::cout << "section2.var4 -> " << ini["section2"]["var4"];
+ };
+
+</pre>
+<center><span class="fig">Example 3. reading an INI file and print the data</span></center>
+
+
+
+
+ <h2><a name="thread">Thread</a></h2>
+ <p>
+ These classes are not thread safe. However, if read once from disk and
+ then used only as constant objects, it will work even if accessed between
+ multiple threads (assuming that the boost::shared_ptr<> is thread
+ safe.)
+ </p>
+
+
+
+ <h2><a name="advantages">Advantages of these Classes</a></h2>
+
+ <p>
+ Ease of use to read and write INI files including comments
+ (comments aren't getting lost.)
+ </p>
+
+
+
+
+ <h2><a name="synopsis">Synopsis</a></h2>
+
+<blockquote>
+<pre class="code">
+
+ namespace ini_file
+ {
+ namespace ini_exceptions
+ {
+ class ini_file_exception : std::exception {};
+ class section_name_missing : ini_file_exception {};
+ class invalid_section_name : ini_file_exception {};
+ class param_name_missing : ini_file_exception {};
+ class invalid_param_name : ini_file_exception {};
+ class invalid_parameter : ini_file_exception {};
+ class param_without_section : ini_file_exception {};
+ class invalid_quotation : ini_file_exception {};
+ } // namespace ini_exceptions
+
+ struct param : ...
+ {
+ param(const std::string& _name);
+ const std::string& get_name() const;
+ void set_comment(const std::string& _comment);
+ const std::string& get_comment() const;
+ void set_value(const std::string& _value);
+ const std::string& get_value() const;
+ param& operator = (const std::string& _value);
+ operator const std::string& () const;
+ };
+
+ struct param_map : ...
+ {
+ void insert(boost::shared_ptr<param> _p);
+ param& operator [] (const std::string& _name);
+ const param& operator [] (const std::string& _name) const;
+ };
+
+ struct section : ...
+ {
+ section(const std::string& _name);
+ const std::string& get_name() const;
+ void set_comment(const std::string& _comment);
+ const std::string& get_comment() const;
+ void insert(boost::shared_ptr<param> _p);
+ param& operator [] (const std::string& _name);
+ const param& operator [] (const std::string& _name) const;
+ };
+
+ struct section_map : ...
+ {
+ void insert(boost::shared_ptr<section> _p);
+ section& operator [] (const std::string& _name);
+ const section& operator [] (const std::string& _name) const;
+ };
+
+ extern std::istream& operator >> (std::istream& in, section_map& _section_map);
+
+ extern std::ostream& operator << (std::ostream& out, const param& _param);
+ extern std::ostream& operator << (std::ostream& out, const section& _section);
+
+ extern std::ostream& operator << (std::ostream& out, const param_map& _param_map);
+ extern std::ostream& operator << (std::ostream& out, const section_map& _section_map);
+ }
+
+</pre>
+</blockquote>
+
+
+
+ <h2><a name="members">Members</a></h2>
+
+ <h3> <a name="ini_exceptions">ini_exceptions</a></h3>
+
+ <ul>
+ <li><b>ini_file_exception</b></li>
+ <p>
+ All the ini_file exceptions derive from <b>ini_file_exception</b>.
+ In order to catch all the exceptions at once, catch this exception.
+ </p>
+ <li><b>section_name_missing</b></li>
+ <p>
+ This exception is thrown when a section with no name is being saved.
+ </p>
+ <li><b>invalid_section_name</b></li>
+ <p>
+ This exception is thrown when the parser reading a file finds a line
+ which starts with '[' and either does not finish with ']' or defines
+ an empty name (only spaces or just '[]').
+ </p>
+ <li><b>param_name_missing</b></li>
+ <p>
+ This exception is thrown when a parameter with no name is being saved.
+ </p>
+ <li><b>invalid_param_name</b></li>
+ <p>
+ This exception is thrown when the parser finds a parameter name which
+ does not start with one of these characters: [a-zA-Z_].
+ </p>
+ <li><b>invalid_parameter</b></li>
+ <p>
+ This exception is thrown when parsing a file and the variable name is
+ not followed by an equal sign and a value.
+ </p>
+ <li><b>param_without_section</b></li>
+ <p>
+ This exception is thrown when parsing a file and a variable is found
+ before a section.
+ </p>
+ <li><b>invalid_quotation</b></li>
+ <p>
+ This exception is thrown when parsing a quoted parameter which has no
+ closing quotation.
+ </p>
+ </ul>
+
+
+
+
+
+
+ <h3> <a name="param">param</a></h3>
+
+ <blockquote>
+ <pre>param(const std::string& _name);</pre>
+ <blockquote>
+ <p>
+ <b>Preconditions:</b> the parameter name is not empty; though this is
+ currently not enforced since we need a default parameter with an empty
+ name (see the [] operators.)
+ </p>
+ <p>
+ <b>Effects:</b> create a parameter named <code>_name</code>.
+ </p>
+ <p>
+ <b>Postconditions:</b> the parameter name cannot be changed.
+ </p>
+ <p>
+ <b>Throws:</b> nothing
+ </p>
+ </blockquote>
+ </blockquote>
+
+ <blockquote>
+ <pre>const std::string& get_name() const;</pre>
+ <blockquote>
+ <p>
+ <b>Postconditions:</b> the returned string cannot be modified.
+ </p>
+ <p>
+ <b>Throws:</b> nothing
+ </p>
+ </blockquote>
+ </blockquote>
+
+ <blockquote>
+ <pre>void set_comment(const std::string& comment);</pre>
+ <blockquote>
+ <p>
+ <b>Effects:</b> assigns a comment to that object. Comments
+ are written right before parameters. Comments read right
+ before a paramater are assigned to that parameter.
+ </p>
+ <p>
+ <b>Throws:</b> nothing
+ </p>
+ </blockquote>
+ </blockquote>
+
+ <blockquote>
+ <pre>const std::string& get_comment() const;</pre>
+ <blockquote>
+ <p>
+ <b>Postconditions:</b> the returned string cannot be modified; use
+ <b>set_comment()</b> to modify a comment.
+ </p>
+ <p>
+ <b>Throws:</b> nothing
+ </p>
+ </blockquote>
+ </blockquote>
+
+ <blockquote>
+ <pre>void set_value(const std::string& _value);
+param& operator = (const std::string& _value)</pre>
+ <blockquote>
+ <p>
+ <b>Effects:</b> assigns a new value to the parameter. Anything is
+ valid except a new line character and a null character. If the
+ parameter value starts or ends with spaces or quotes, the value
+ will be saved quoted.
+ </p>
+ <p>
+ <b>Throws:</b> nothing
+ </p>
+ </blockquote>
+ </blockquote>
+
+ <blockquote>
+ <pre>const std::string& get_value() const;
+operator const std::string& () const;</pre>
+ <blockquote>
+ <p>
+ <b>Effects:</b> retrieve the current value of the parameter.
+ </p>
+ <p>
+ <b>Throws:</b> nothing
+ </p>
+ </blockquote>
+ </blockquote>
+
+
+
+
+ <h3> <a name="param_map">param_map</a></h3>
+
+ <blockquote>
+ <pre>void insert(boost::shared_ptr<param> _p);</pre>
+ <blockquote>
+ <p>
+ <b>Precondition:</b> if the pointer is null, nothing happens and the
+ function returns right away.
+ </p>
+ <p>
+ <b>Effects:</b> add the specified parameter in the map of parameters.
+ The use of a map makes it faster to retrieve parameters. However, this
+ means you lose the possible ordering from input files.
+ </p>
+ <p>
+ <b>Throws:</b> memory allocation exceptions
+ </p>
+ </blockquote>
+ </blockquote>
+
+ <blockquote>
+ <pre>param& operator [] (const std::string& _name);
+const param& operator [] (const std::string& _name) const;</pre>
+ <blockquote>
+ <p>
+ <b>Precondition:</b> if a parameter with the specified <code>_name</code>
+ does not exist:
+ <ul>
+ <li><i>Non-constant parameter map</i></li>
+ <p>
+ When the non-constant operator is used, a new parameter
+ is created if none already exist with that <code>_name</code>.
+ </p>
+ <p>
+ <li><i>Constant parameter map</i></li>
+ <p>
+ When the constant operator is used, it returns an empty
+ parameter which must not be modified.
+ That empty parameter is not part of the map.
+ </p>
+ </ul>
+ </p>
+ <p>
+ <b>Effects:</b> return the empty parameter, an existing parameter or
+ a new parameter with the specified <code>_name</code>.
+ </p>
+ <p>
+ <b>Throws:</b> memory allocation exceptions
+ </p>
+ </blockquote>
+ </blockquote>
+
+
+
+
+
+
+ <h3> <a name="section">section</a></h3>
+
+ <blockquote>
+ <pre>section(const std::string& _name);</pre>
+ <blockquote>
+ <p>
+ <b>Preconditions:</b> the parameter name is not empty; though this is
+ currently not enforced since we need a default parameter with an empty
+ name (see the [] operators.)
+ </p>
+ <p>
+ <b>Effects:</b> create a section named <code>_name</code>.
+ </p>
+ <p>
+ <b>Postconditions:</b> the section name cannot be changed.
+ </p>
+ <p>
+ <b>Throws:</b> nothing
+ </p>
+ </blockquote>
+ </blockquote>
+
+ <blockquote>
+ <pre>const std::string& get_name() const;</pre>
+ <blockquote>
+ <p>
+ <b>Postconditions:</b> the returned string cannot be modified.
+ </p>
+ <p>
+ <b>Throws:</b> nothing
+ </p>
+ </blockquote>
+ </blockquote>
+
+ <blockquote>
+ <pre>void set_comment(const std::string& comment);</pre>
+ <blockquote>
+ <p>
+ <b>Effects:</b> assigns a comment to that object. Comments
+ are written right before sections. Comments read right
+ before a section are assigned to that section. Comments
+ read right after a section are assigned the the first
+ parameter. If there is no parameter, it is assigned to
+ the next section. If there is no other section or parameter,
+ it is lost.
+ </p>
+ <p>
+ <b>Throws:</b> nothing
+ </p>
+ </blockquote>
+ </blockquote>
+
+ <blockquote>
+ <pre>const std::string& get_comment() const;</pre>
+ <blockquote>
+ <p>
+ <b>Postconditions:</b> the returned string cannot be modified; use
+ <b>set_comment()</b> to modify a comment.
+ </p>
+ <p>
+ <b>Throws:</b> nothing
+ </p>
+ </blockquote>
+ </blockquote>
+
+ <blockquote>
+ <pre>void insert(boost::shared_ptr<param> _p);</pre>
+ <blockquote>
+ <p>
+ <b>Precondition:</b> if the pointer is null, nothing happens and the
+ function returns right away.
+ </p>
+ <p>
+ <b>Effects:</b> add the specified parameter in the map of parameters.
+ The use of a map makes it faster to retrieve parameters. However, this
+ means you lose the possible ordering from input files.
+ </p>
+ <p>
+ <b>Throws:</b> memory allocation exceptions
+ </p>
+ </blockquote>
+ </blockquote>
+
+ <blockquote>
+ <pre>param& operator [] (const std::string& _name);
+const param& operator [] (const std::string& _name) const;</pre>
+ <blockquote>
+ <p>
+ <b>Precondition:</b> if a parameter with the specified <code>_name</code>
+ does not exist:
+ <ul>
+ <li><i>Non-constant parameter map</i></li>
+ <p>
+ When the non-constant operator is used, a new parameter
+ is created if none already exist with that <code>_name</code>.
+ </p>
+ <p>
+ <li><i>Constant parameter map</i></li>
+ <p>
+ When the constant operator is used, it returns an empty
+ parameter which must not be modified.
+ That empty parameter is not part of the map.
+ </p>
+ </ul>
+ </p>
+ <p>
+ <b>Effects:</b> return the empty parameter, an existing parameter or
+ a new parameter with the specified <code>_name</code>.
+ </p>
+ <p>
+ <b>Throws:</b> memory allocation exceptions
+ </p>
+ </blockquote>
+ </blockquote>
+
+
+
+
+
+ <h3> <a name="section_map">section_map</a></h3>
+
+ <blockquote>
+ <pre>void insert(boost::shared_ptr<section> _s);</pre>
+ <blockquote>
+ <p>
+ <b>Precondition:</b> if the pointer is null, nothing happens and the
+ function returns right away.
+ </p>
+ <p>
+ <b>Effects:</b> add the specified section in the map of sections.
+ The use of a map makes it faster to retrieve sections. However, this
+ means you lose the possible ordering from input files.
+ </p>
+ <p>
+ <b>Throws:</b> memory allocation exceptions
+ </p>
+ </blockquote>
+ </blockquote>
+
+ <blockquote>
+ <pre>section& operator [] (const std::string& _name);
+const section& operator [] (const std::string& _name) const;</pre>
+ <blockquote>
+ <p>
+ <b>Precondition:</b> if a section with the specified <code>_name</code>
+ does not exist:
+ <ul>
+ <li><i>Non-constant section map</i></li>
+ <p>
+ When the non-constant operator is used, a new section
+ is created if none already exist with that <code>_name</code>.
+ </p>
+ <p>
+ <li><i>Constant section map</i></li>
+ <p>
+ When the constant operator is used, it returns an empty
+ section which must not be modified.
+ That empty section is not part of the map.
+ </p>
+ </ul>
+ </p>
+ <p>
+ <b>Effects:</b> return the empty section, an existing section or
+ a new section with the specified <code>_name</code>.
+ </p>
+ <p>
+ <b>Throws:</b> memory allocation exceptions
+ </p>
+ </blockquote>
+ </blockquote>
+
+
+
+ <h3> <a name="helpers">Helper functions</a></h3>
+
+ <blockquote>
+ <pre>extern std::istream& operator >> (std::istream& in, section_map& _section_map);
+
+extern std::ostream& operator << (std::ostream& out, const param& _param);
+extern std::ostream& operator << (std::ostream& out, const section& _section);
+
+extern std::ostream& operator << (std::ostream& out, const param_map& _param_map);
+extern std::ostream& operator << (std::ostream& out, const section_map& _section_map);
+</pre>
+ <blockquote>
+ <p>
+ <b>Precondition:</b> to write a parameter, section or a map thereof, all the
+ parameters and sections must have a valid name (i.e. not empty.) A section
+ can be empty (have no parameters.)
+ </p>
+ <p>
+ <b>Effects:</b> the >> oparator appends the content of the input stream
+ to the specified <code>_section_map</code>. If the input includes sections
+ and parameters which already exist in the <code>_section_map</code>, they
+ will be overwritten (i.e. thus you can define defaults before to use the
+ >> operator.) The << operators print out the specified parameter. In
+ all cases, the output ends with a newline. A section ends with an empty
+ line. To save a section map to an init file, use the << operator
+ accepting a <code>_section_map</code> reference.
+ </p>
+ <p>
+ <b>Throws:</b> the output operators (<<) can throw the
+ <b>ini_exceptions::param_name_missing</b> or
+ <b>ini_exceptions::section_name_missing</b> exceptions.
+ The input operator (>>) can throw many different exceptions
+ when the input file is invalid:
+ <ul>
+ <li><b>ini_exceptions::invalid_section_name</b></li>
+ <li><b>ini_exceptions::invalid_param_name</b></li>
+ <li><b>ini_exceptions::param_without_section</b></li>
+ <li><b>ini_exceptions::invalid_parameter</b></li>
+ <li><b>ini_exceptions::invalid_quotation</b></li>
+ </ul>
+ </p>
+ </blockquote>
+ </blockquote>
+
+
+ </div>
+
+ <hr/>
+
+ <p style="font-size: 75%; text-align: center;">
+ <u>Copyright (c) 2006 Alexis Wilke</u><br/>
+ <br/>
+ <i>Permission to copy, use, modify, sell and distribute this document is granted provided<br/>
+ this copyright notice appears in all copies. This document is provided "as is" without<br/>
+ express or implied warranty, and with no claim as to its suitability for any purpose.</i>
+ </p>
+</body>
+<!--
+ vim: ts=2
+-->
+</html>
--- /dev/null
+//
+// Copyright (c) 2006 Alexis Wilke
+//
+// Boost Software License - Version 1.0 - August 17th, 2003
+//
+// Permission is hereby granted, free of charge, to any person or organization
+// obtaining a copy of the software and accompanying documentation covered by
+// this license (the "Software") to use, reproduce, display, distribute,
+// execute, and transmit the Software, and to prepare derivative works of the
+// Software, and to permit third-parties to whom the Software is furnished to
+// do so, all subject to the following:
+//
+// The copyright notices in the Software and this entire statement, including
+// the above license grant, this restriction and the following disclaimer,
+// must be included in all copies of the Software, in whole or in part, and
+// all derivative works of the Software, unless such copies or derivative
+// works are solely in the form of machine-executable object code generated by
+// a source language processor.
+//
+// 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, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+// DEALINGS IN THE SOFTWARE.
+//
+// Find documentation on the home website:
+//
+// http://boost-extras.sourceforge.net/
+// http://boost-extras.sourceforge.net/ini_file/ini_file.html
+//
+#include <ini_file.hpp>
+#include <iostream>
+#include <fstream>
+
+// select sample with -DSAMPLE=<1, 2 or 3> on the command line
+
+
+int main(int argc, char *argv[])
+{
+#if SAMPLE == 1
+ ini_file::section_map ini;
+
+ ini["section1"]["var1"] = "value of var1";
+ ini["section1"]["var2"] = "value of var2";
+ ini["section2"]["var3"] = "value of var3";
+ ini["section2"]["var4"] = "value of var4";
+
+ ini["section1"].set_comment("This is section1 comment");
+ ini["section2"].set_comment("This is section2 comment");
+ ini["section2"]["var4"].set_comment("This is var4 comment");
+
+ std::cout << ini;
+#elif SAMPLE == 2
+ ini_file::section_map ini;
+
+ {
+ // first we create a file that we can then read
+ std::fstream output;
+ output.open("test_file.ini", std::fstream::out);
+ output << "; This is an auto-generated test file." << std::endl;
+ output << "[section1]" << std::endl;
+ output << "var1=This is variable ONE" << std::endl;
+ output << "var2=This is variable TWO" << std::endl;
+ output << "[section2]" << std::endl;
+ output << "var3 = \" This is \\\"variable\\\" THREE \" " << std::endl;
+ output << "; Comment on variable 4" << std::endl;
+ output << "var4=This is variable FOUR" << std::endl;
+ } // file closes
+
+ // now try to read it and print out the content
+ std::fstream input;
+ input.open("test_file.ini", std::fstream::in);
+
+ input >> ini;
+
+ std::cout << "section1 -> " << ini["section1"];
+ std::cout << "section1.var1 -> " << ini["section1"]["var1"];
+ std::cout << "section1.var2 -> " << ini["section1"]["var2"];
+ std::cout << "section2 -> " << ini["section2"];
+ std::cout << "section2.var3 -> " << ini["section2"]["var3"];
+ std::cout << "section2.var4 -> " << ini["section2"]["var4"];
+#elif SAMPLE == 3
+ {
+ ini_file::section_map s;
+
+ boost::shared_ptr<ini_file::section> sec(new ini_file::section("section1"));
+ sec->set_comment("this is a long comment\nwith a new-line");
+
+ boost::shared_ptr<ini_file::param> p(new ini_file::param("var1"));
+ p->set_value("this is the value of var1");
+ sec->insert(p);
+
+ s.insert(sec);
+
+ sec.reset(new ini_file::section("section2"));
+ sec->set_comment("this is yet another long comment\nwith a new-line!!!");
+
+ p.reset(new ini_file::param("var2"));
+ p->set_value("this is the value of var2");
+ p->set_comment("and v2 has a comment too!\n");
+ sec->insert(p);
+
+ s.insert(sec);
+
+ s["section3"]["var3"].set_value("this is variable number three");
+ s["section3"]["var4"] = "another variable in section3";
+
+
+ // test reading parameters values
+ std::cout << "section1 -> " << s["section1"];
+ std::cout << "section1.var1 -> " << s["section1"]["var1"];
+ std::cout << "section2.var2 -> " << s["section2"]["var2"];
+ std::cout << "unknown_section = " << const_cast<const ini_file::section_map&>(s)["unknown_section"] << std::endl;
+
+ std::string what = s["section3"]["var4"];
+ std::cout << "extracted content of section3.var4 -> " << what << std::endl;
+
+ std::cout << "*********** Output ini file (std::cout << /ini_file::section_map/) ******" << std::endl;
+ std::cout << s;
+ std::cout << "*****************" << std::endl;
+ }
+#else
+ std::cerr << "error: no -DSAMPLE=<1,2 or 3> was specified when compiling" << std::endl;
+#endif
+
+ return 0;
+}
+
+
+// vim: ts=4
projects / platform / upstream / libzypp.git / commitdiff
