author | mickeyl <mickeyl> | 2003-05-10 14:46:02 (UTC) |
---|---|---|
committer | mickeyl <mickeyl> | 2003-05-10 14:46:02 (UTC) |
commit | 7d97fa637bb1af225b9e5075982b32718b0f78e4 (patch) (unidiff) | |
tree | e06b9043c9fc3c0cf769986ea5e6a4983dbfe784 | |
parent | 8bf3021bf5e86f7f6f6083606d77427adc8d13a7 (diff) | |
download | opie-7d97fa637bb1af225b9e5075982b32718b0f78e4.zip opie-7d97fa637bb1af225b9e5075982b32718b0f78e4.tar.gz opie-7d97fa637bb1af225b9e5075982b32718b0f78e4.tar.bz2 |
- make oApp not return a const app object
- homogenize oconfig documentation
- remove debug output
-rw-r--r-- | libopie2/opiecore/oapplication.h | 2 | ||||
-rw-r--r-- | libopie2/opiecore/oconfig.h | 55 | ||||
-rw-r--r-- | libopie2/opienet/omanufacturerdb.cpp | 6 |
3 files changed, 20 insertions, 43 deletions
diff --git a/libopie2/opiecore/oapplication.h b/libopie2/opiecore/oapplication.h index 1bd34e2..6bc2b1c 100644 --- a/libopie2/opiecore/oapplication.h +++ b/libopie2/opiecore/oapplication.h | |||
@@ -55,25 +55,25 @@ class OApplication: public QPEApplication | |||
55 | * Destructor. Destroys the application object and its children. | 55 | * Destructor. Destroys the application object and its children. |
56 | */ | 56 | */ |
57 | virtual ~OApplication(); | 57 | virtual ~OApplication(); |
58 | /** | 58 | /** |
59 | * @returns the process-wide application object | 59 | * @returns the process-wide application object |
60 | * | 60 | * |
61 | * This is similar to the global @ref QApplication pointer qApp. It | 61 | * This is similar to the global @ref QApplication pointer qApp. It |
62 | * allows access to the single global OApplication object, since | 62 | * allows access to the single global OApplication object, since |
63 | * more than one cannot be created in the same application. It | 63 | * more than one cannot be created in the same application. It |
64 | * saves you the trouble of having to pass the pointer explicitly | 64 | * saves you the trouble of having to pass the pointer explicitly |
65 | * to every function that may require it. | 65 | * to every function that may require it. |
66 | */ | 66 | */ |
67 | static const OApplication* oApplication() { return _instance; }; | 67 | static OApplication* oApplication() { return _instance; }; |
68 | /** | 68 | /** |
69 | * Returns the application name as given during creation. | 69 | * Returns the application name as given during creation. |
70 | * | 70 | * |
71 | * @returns a reference to the application name | 71 | * @returns a reference to the application name |
72 | */ | 72 | */ |
73 | const QCString& appName() const { return _appname; }; | 73 | const QCString& appName() const { return _appname; }; |
74 | /** | 74 | /** |
75 | * @returns the application session config object. | 75 | * @returns the application session config object. |
76 | * | 76 | * |
77 | * @see OConfig | 77 | * @see OConfig |
78 | */ | 78 | */ |
79 | OConfig* config(); | 79 | OConfig* config(); |
diff --git a/libopie2/opiecore/oconfig.h b/libopie2/opiecore/oconfig.h index afe14b1..444d280 100644 --- a/libopie2/opiecore/oconfig.h +++ b/libopie2/opiecore/oconfig.h | |||
@@ -24,93 +24,67 @@ | |||
24 | -. .:....=;==+<; You should have received a copy of the GNU | 24 | -. .:....=;==+<; You should have received a copy of the GNU |
25 | -_. . . )=. = Library General Public License along with | 25 | -_. . . )=. = Library General Public License along with |
26 | -- :-=` this library; see the file COPYING.LIB. | 26 | -- :-=` this library; see the file COPYING.LIB. |
27 | If not, write to the Free Software Foundation, | 27 | If not, write to the Free Software Foundation, |
28 | Inc., 59 Temple Place - Suite 330, | 28 | Inc., 59 Temple Place - Suite 330, |
29 | Boston, MA 02111-1307, USA. | 29 | Boston, MA 02111-1307, USA. |
30 | */ | 30 | */ |
31 | 31 | ||
32 | #ifndef OCONFIG_H | 32 | #ifndef OCONFIG_H |
33 | #define OCONFIG_H | 33 | #define OCONFIG_H |
34 | 34 | ||
35 | //FIXME: Implement for X11 or reuse libqpe/Config there also? | 35 | //FIXME: Implement for X11 or reuse libqpe/Config there also? |
36 | //FIXME: Or rather use QSettings also for libqpe? | ||
36 | 37 | ||
37 | #include <qpe/config.h> | 38 | #include <qpe/config.h> |
38 | 39 | ||
39 | class QColor; | 40 | class QColor; |
40 | class QFont; | 41 | class QFont; |
41 | 42 | ||
42 | /** | 43 | /** |
43 | * A Configuration class based on the Qtopia @ref Config class | 44 | * A Configuration class based on the Qtopia @ref Config class |
44 | * featuring additional handling of color and font entries | 45 | * featuring additional handling of color and font entries |
45 | */ | 46 | */ |
46 | 47 | ||
47 | class OConfig : public Config | 48 | class OConfig : public Config |
48 | { | 49 | { |
49 | public: | 50 | public: |
50 | |||
51 | /** | 51 | /** |
52 | * Constructs a OConfig object. | 52 | * Constructs a OConfig object with a @a name. |
53 | * | ||
54 | * @param name A file to parse. | ||
55 | */ | 53 | */ |
56 | OConfig( const QString &name, Domain domain = User ); | 54 | OConfig( const QString &name, Domain domain = User ); |
57 | |||
58 | /** | 55 | /** |
59 | * Destructs the OConfig object. | 56 | * Destructs the OConfig object. |
60 | * | 57 | * |
61 | * Writes back any dirty configuration entries, and destroys | 58 | * Writes back any dirty configuration entries, and destroys |
62 | * dynamically created objects. | 59 | * dynamically created objects. |
63 | */ | 60 | */ |
64 | virtual ~OConfig(); | 61 | virtual ~OConfig(); |
65 | |||
66 | /** | 62 | /** |
67 | * Returns the name of the group in which we are | 63 | * @returns the name of the current group. |
68 | * searching for keys and from which we are retrieving entries. | 64 | * The current group is used for searching keys and accessing entries. |
69 | * | ||
70 | * @return The current group. | ||
71 | */ | 65 | */ |
72 | const QString& group() { return git.key(); }; | 66 | const QString& group() { return git.key(); }; |
73 | |||
74 | /** | 67 | /** |
75 | * Reads a @ref QColor entry. | 68 | * @returns a @ref QColor entry or a @a default value if the key is not found. |
76 | * | ||
77 | * Read the value of an entry specified by @p pKey in the current group | ||
78 | * and interpret it as a color. | ||
79 | * | ||
80 | * @param pKey The key to search for. | ||
81 | * @param pDefault A default value (null QColor by default) returned if the | ||
82 | * key was not found or if the value cannot be interpreted. | ||
83 | * @return The value for this key. | ||
84 | */ | 69 | */ |
85 | QColor readColorEntry( const QString& key, const QColor* pDefault ) const; | 70 | QColor readColorEntry( const QString& key, const QColor* pDefault ) const; |
86 | |||
87 | /** | 71 | /** |
88 | * Reads a @ref QFont value. | 72 | * @returns a @ref QFont value or a @a default value if the key is not found. |
89 | * | ||
90 | * Read the value of an entry specified by @p pKey in the current group | ||
91 | * and interpret it as a font object. | ||
92 | * | ||
93 | * @param pKey The key to search for. | ||
94 | * @param pDefault A default value (null QFont by default) returned if the | ||
95 | * key was not found or if the read value cannot be interpreted. | ||
96 | * @return The value for this key. | ||
97 | */ | 73 | */ |
98 | QFont readFontEntry( const QString& key, const QFont* pDefault ) const; | 74 | QFont readFontEntry( const QString& key, const QFont* pDefault ) const; |
99 | |||
100 | }; | 75 | }; |
101 | 76 | ||
102 | /** | 77 | /** |
103 | * Helper class to facilitate working with @ref OConfig / @ref OSimpleConfig | 78 | * @brief Helper class for easier use of OConfig groups. |
104 | * groups. | ||
105 | * | 79 | * |
106 | * Careful programmers always set the group of a | 80 | * Careful programmers always set the group of a |
107 | * @ref OConfig object to the group they want to read from | 81 | * @ref OConfig object to the group they want to read from |
108 | * and set it back to the old one of afterwards. This is usually | 82 | * and set it back to the old one of afterwards. This is usually |
109 | * written as: | 83 | * written as: |
110 | * <pre> | 84 | * <pre> |
111 | * | 85 | * |
112 | * QString oldgroup config()->group(); | 86 | * QString oldgroup config()->group(); |
113 | * config()->setGroup( "TheGroupThatIWant" ); | 87 | * config()->setGroup( "TheGroupThatIWant" ); |
114 | * ... | 88 | * ... |
115 | * config()->writeEntry( "Blah", "Blubb" ); | 89 | * config()->writeEntry( "Blah", "Blubb" ); |
116 | * | 90 | * |
@@ -120,47 +94,46 @@ class OConfig : public Config | |||
120 | * In order to facilitate this task, you can use | 94 | * In order to facilitate this task, you can use |
121 | * OConfigGroupSaver. Simply construct such an object ON THE STACK | 95 | * OConfigGroupSaver. Simply construct such an object ON THE STACK |
122 | * when you want to switch to a new group. Then, when the object goes | 96 | * when you want to switch to a new group. Then, when the object goes |
123 | * out of scope, the group will automatically be restored. If you | 97 | * out of scope, the group will automatically be restored. If you |
124 | * want to use several different groups within a function or method, | 98 | * want to use several different groups within a function or method, |
125 | * you can still use OConfigGroupSaver: Simply enclose all work with | 99 | * you can still use OConfigGroupSaver: Simply enclose all work with |
126 | * one group (including the creation of the OConfigGroupSaver object) | 100 | * one group (including the creation of the OConfigGroupSaver object) |
127 | * in one block. | 101 | * in one block. |
128 | * | 102 | * |
129 | * @author Matthias Kalle Dalheimer <Kalle@kde.org> | 103 | * @author Matthias Kalle Dalheimer <Kalle@kde.org> |
130 | * @version $Id$ | 104 | * @version $Id$ |
131 | * @see OConfig | 105 | * @see OConfig |
132 | * @short Helper class for easier use of OConfig groups | ||
133 | */ | 106 | */ |
134 | 107 | ||
135 | class OConfigGroupSaver | 108 | class OConfigGroupSaver |
136 | { | 109 | { |
137 | public: | 110 | public: |
138 | /** | 111 | /** |
139 | * Constructor. You pass a pointer to the OConfigBase-derived | 112 | * Constructor. |
140 | * object you want to work with and a string indicating the _new_ | 113 | * Create the object giving a @config object and a @a group to become |
141 | * group. | 114 | * the current group. |
142 | * @param config The OConfig-derived object this | ||
143 | * OConfigGroupSaver works on. | ||
144 | * @param group The new group that the config object should switch to. | ||
145 | */ | 115 | */ |
146 | OConfigGroupSaver( OConfig* config, QString group ) :_config(config), _oldgroup(config->group() ) | 116 | OConfigGroupSaver( OConfig* config, QString group ) :_config(config), _oldgroup(config->group() ) |
147 | { _config->setGroup( group ); } | 117 | { _config->setGroup( group ); } |
148 | 118 | ||
149 | OConfigGroupSaver( OConfig* config, const char *group ) :_config(config), _oldgroup(config->group()) | 119 | OConfigGroupSaver( OConfig* config, const char *group ) :_config(config), _oldgroup(config->group()) |
150 | { _config->setGroup( group ); } | 120 | { _config->setGroup( group ); } |
151 | 121 | ||
152 | OConfigGroupSaver( OConfig* config, const QCString &group ) : _config(config), _oldgroup(config->group()) | 122 | OConfigGroupSaver( OConfig* config, const QCString &group ) : _config(config), _oldgroup(config->group()) |
153 | { _config->setGroup( group ); } | 123 | { _config->setGroup( group ); } |
154 | 124 | /** | |
125 | * Destructor. | ||
126 | * Restores the last current group. | ||
127 | */ | ||
155 | ~OConfigGroupSaver() { _config->setGroup( _oldgroup ); } | 128 | ~OConfigGroupSaver() { _config->setGroup( _oldgroup ); } |
156 | 129 | ||
157 | OConfig* config() { return _config; }; | 130 | OConfig* config() { return _config; }; |
158 | 131 | ||
159 | private: | 132 | private: |
160 | OConfig* _config; | 133 | OConfig* _config; |
161 | QString _oldgroup; | 134 | QString _oldgroup; |
162 | 135 | ||
163 | OConfigGroupSaver( const OConfigGroupSaver& ); | 136 | OConfigGroupSaver( const OConfigGroupSaver& ); |
164 | OConfigGroupSaver& operator=( const OConfigGroupSaver& ); | 137 | OConfigGroupSaver& operator=( const OConfigGroupSaver& ); |
165 | }; | 138 | }; |
166 | 139 | ||
diff --git a/libopie2/opienet/omanufacturerdb.cpp b/libopie2/opienet/omanufacturerdb.cpp index c185fc5..c3c213c 100644 --- a/libopie2/opienet/omanufacturerdb.cpp +++ b/libopie2/opienet/omanufacturerdb.cpp | |||
@@ -6,25 +6,25 @@ | |||
6 | ** This file may be distributed and/or modified under the terms of the | 6 | ** This file may be distributed and/or modified under the terms of the |
7 | ** GNU General Public License version 2 as published by the Free Software | 7 | ** GNU General Public License version 2 as published by the Free Software |
8 | ** Foundation and appearing in the file LICENSE.GPL included in the | 8 | ** Foundation and appearing in the file LICENSE.GPL included in the |
9 | ** packaging of this file. | 9 | ** packaging of this file. |
10 | ** | 10 | ** |
11 | ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE | 11 | ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE |
12 | ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. | 12 | ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. |
13 | ** | 13 | ** |
14 | **********************************************************************/ | 14 | **********************************************************************/ |
15 | 15 | ||
16 | #include "omanufacturerdb.h" | 16 | #include "omanufacturerdb.h" |
17 | 17 | ||
18 | // Qt | 18 | /* QT */ |
19 | #include <qstring.h> | 19 | #include <qstring.h> |
20 | #include <qfile.h> | 20 | #include <qfile.h> |
21 | #include <qtextstream.h> | 21 | #include <qtextstream.h> |
22 | 22 | ||
23 | OManufacturerDB* OManufacturerDB::_instance = 0; | 23 | OManufacturerDB* OManufacturerDB::_instance = 0; |
24 | 24 | ||
25 | OManufacturerDB* OManufacturerDB::instance() | 25 | OManufacturerDB* OManufacturerDB::instance() |
26 | { | 26 | { |
27 | if ( !OManufacturerDB::_instance ) | 27 | if ( !OManufacturerDB::_instance ) |
28 | { | 28 | { |
29 | qDebug( "OManufacturerDB::instance(): creating OManufacturerDB..." ); | 29 | qDebug( "OManufacturerDB::instance(): creating OManufacturerDB..." ); |
30 | _instance = new OManufacturerDB(); | 30 | _instance = new OManufacturerDB(); |
@@ -72,30 +72,34 @@ OManufacturerDB::OManufacturerDB() | |||
72 | if ( addr[0] == '#' ) | 72 | if ( addr[0] == '#' ) |
73 | { | 73 | { |
74 | continue; | 74 | continue; |
75 | } | 75 | } |
76 | s.skipWhiteSpace(); | 76 | s.skipWhiteSpace(); |
77 | s >> manu; | 77 | s >> manu; |
78 | s.skipWhiteSpace(); | 78 | s.skipWhiteSpace(); |
79 | s >> extManu; | 79 | s >> extManu; |
80 | if ( extManu[0] == '#' ) // we have an extended manufacturer | 80 | if ( extManu[0] == '#' ) // we have an extended manufacturer |
81 | { | 81 | { |
82 | s.skipWhiteSpace(); | 82 | s.skipWhiteSpace(); |
83 | extManu = s.readLine(); | 83 | extManu = s.readLine(); |
84 | #ifdef DEBUG | ||
84 | qDebug( "OManufacturerDB: read '%s' as extended manufacturer string", (const char*) extManu ); | 85 | qDebug( "OManufacturerDB: read '%s' as extended manufacturer string", (const char*) extManu ); |
86 | #endif | ||
85 | manufacturersExt.insert( addr, extManu ); | 87 | manufacturersExt.insert( addr, extManu ); |
86 | } | 88 | } |
87 | else | 89 | else |
88 | s.readLine(); | 90 | s.readLine(); |
91 | #ifdef DEBUG | ||
89 | qDebug( "ManufacturerDB: read tuple %s, %s", (const char*) addr, (const char*) manu ); | 92 | qDebug( "ManufacturerDB: read tuple %s, %s", (const char*) addr, (const char*) manu ); |
93 | #endif | ||
90 | manufacturers.insert( addr, manu ); | 94 | manufacturers.insert( addr, manu ); |
91 | 95 | ||
92 | } | 96 | } |
93 | } | 97 | } |
94 | 98 | ||
95 | } | 99 | } |
96 | 100 | ||
97 | 101 | ||
98 | OManufacturerDB::~OManufacturerDB() | 102 | OManufacturerDB::~OManufacturerDB() |
99 | { | 103 | { |
100 | } | 104 | } |
101 | 105 | ||