]>
vaikene.ee Git - evaf/blob - src/libs/Common/inifile.h
b795e6a9435dc02dfc222c7af964094b93649801
2 * @file Common/inifile.h
3 * @brief Class for reading and writing parameter values in INI files.
6 * Copyright (c) 2011 Enar Vaikene
8 * This file is part of the eVaf C++ cross-platform application development framework.
10 * This file can be used under the terms of the GNU General Public License
11 * version 3.0 as published by the Free Software Foundation and appearing in
12 * the file LICENSE included in the packaging of this file. Please review the
13 * the following information to ensure the GNU General Public License version
14 * 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html.
16 * Alternatively, this file may be used in accordance with the Commercial License
17 * Agreement provided with the Software.
20 #ifndef __COMMON_INIFILE_H
21 #define __COMMON_INIFILE_H
23 #include "libcommon.h"
33 } // namespace eVaf::Common::Internal
36 * Class for reading and writing parameter values in INI files.
38 * The IniFile class provides access to parameter values in a standard INI file. Every parameter value is
39 * identified by a section/key name pair. Key names can be prefixed with 'windows:' or 'linux:' if the
40 * parameter value is specific for the given platform. This allows entering platform-specific parameter
41 * values to the INI file. INI files can contain comment lines that start with ';' or '#'. Comments are
42 * preserved when new values are written to the INI file.
44 * Values in INI files are stored as strings and the IniFile class expects them to use specific formats if
45 * the returned value is supposed to be of a different data type. The following list shows the expected format
46 * of different data types:
48 * @li Bool - '0', 'false', 'off', 'no' are equal to false and '1', 'true', 'on', 'yes' are equal to true;
49 * @li Char - a single character or an ASCII code as '\0NNN' or '\0xNN';
50 * @li Date - date string in the ISO 8601 format YYYY-MM-DD;
51 * @li DateTime - date and time string in the ISO 8601 format YYY-MM-DDTHH:MM:SSTZD;
52 * @li Double - the decimal point is always '.' regardless of the locale;
53 * @li Int - only base 10 (decimal) is allowed;
54 * @li Time - 24h time string in the format HH:MM:SS
55 * @li UInt - base 16 (hex) if the string is prefixed with '0x'; base 8 if the string starts with '0'; otherwise
56 * the value is expected to be base 10 (decimal).
58 class COMMON_EXPORT IniFile
63 * Creates the INI file object
64 * @param fileName Name of the INI file
65 * @param mode File opening mode
67 IniFile(QString
const & fileName
, QIODevice::OpenMode mode
= QIODevice::ReadWrite
);
73 * Returns true if the object is valid
75 * The isValid() method returns true if the INI file is can be used. Use this
76 * method after creating the object to verify that opening the INI file in the specified
82 * Returns the last error message.
84 * The errorString() method returns a human-readable error message if an operation with the INI file failed.
86 QString
errorString() const;
89 * Reads a value from the INI file.
90 * @param paramName Name of the parameter
91 * @param defaultValue Default value returned if the parameter value cannot be read
92 * @return The value from the INI file or an invalid QVariant if failed
94 * The getValue() method reads a parameter value from the INI file. Parameters are identified by a section and key name pair
95 * in the format '<section>/<key>'. For example, if the section is called 'general' and the key is called 'log_level',
96 * then the name of the parameter should be given as 'general/log_level'. Parameter names are case insensitive.
98 * If the parameter cannot be read because it is not found in the INI file or the INI file object is invalid, returns the
99 * default value. If reading the parameter fails by any other reasons, returns an invalid QVariant value (QVariant::Invalid).
101 * If the default value is of a valid and known QVariant type, then its type is used to validate and optionally convert
102 * the string read from the INI file. For example:
103 * @li If the value in the INI file is 'abc' and the default value an integer value, then validation
104 * fails and the method returns the default value;
105 * @li If the default value is a boolean value, then the method accepts '1', 'true', 'on' and 'yes' as valid values.
107 QVariant
getValue(QString
const & paramName
, QVariant
const & defaultValue
= QVariant::Invalid
);
110 * Writes a value to the INI file.
111 * @param paramName Name of the parameter
112 * @param value The value of the value
113 * @return True if succeeded and false if not
115 * The setValue() method writes a parameter value to the INI file. Parameters are identified by a section and key name pair
116 * in the format '<section>/<key>'. For example, if the section is called 'general' and the key is called 'log_level',
117 * the the name of the parameter should be given as 'general/log_level'. Parameter names are case insensitive.
119 * The method returns true if the parameter value was written into the INI file and false if not. Use the errorString() method
120 * to get a human-readable error string if writing to the INI file fails.
122 bool setValue(QString
const & paramName
, QVariant
const & value
);
127 /// Pointer to the internal implementation of the class
128 Internal::IniFileImpl
* d
;
132 } // namespace eVaf::Common