20#ifndef Fl_Preferences_H
21# define Fl_Preferences_H
24# include "Fl_Export.H"
131 UNKNOWN_ROOT_TYPE = -1,
140 SYSTEM_L = SYSTEM | C_LOCALE,
141 USER_L = USER | C_LOCALE,
142 CORE_SYSTEM_L = CORE | SYSTEM_L,
143 CORE_USER_L = CORE | USER_L,
144 CORE_SYSTEM = CORE | SYSTEM,
145 CORE_USER = CORE | USER
157 static const char *new_UUID();
163 static const unsigned int NONE = 0x0000;
165 static const unsigned int USER_READ_OK = 0x0001;
167 static const unsigned int USER_WRITE_OK = 0x0002;
169 static const unsigned int USER_OK = USER_READ_OK | USER_WRITE_OK;
171 static const unsigned int SYSTEM_READ_OK = 0x0004;
173 static const unsigned int SYSTEM_WRITE_OK = 0x0008;
175 static const unsigned int SYSTEM_OK = SYSTEM_READ_OK | SYSTEM_WRITE_OK;
177 static const unsigned int APP_OK = SYSTEM_OK | USER_OK;
179 static const unsigned int CORE_READ_OK = 0x0010;
181 static const unsigned int CORE_WRITE_OK = 0x0020;
183 static const unsigned int CORE_OK = CORE_READ_OK | CORE_WRITE_OK;
185 static const unsigned int ALL_READ_OK = USER_READ_OK | SYSTEM_READ_OK | CORE_READ_OK;
187 static const unsigned int ALL_WRITE_OK = USER_WRITE_OK | SYSTEM_WRITE_OK | CORE_WRITE_OK;
189 static const unsigned int ALL = ALL_READ_OK | ALL_WRITE_OK;
191 static void file_access(
unsigned int flags);
192 static unsigned int file_access();
193 static Root filename(
char *buffer,
size_t buffer_size,
Root root,
const char *vendor,
const char *application );
196 Fl_Preferences(
const char *path,
const char *vendor,
const char *application,
Root flags );
205 FL_DEPRECATED(
"in 1.4.0 - use Fl_Preferences(path, vendor, application, flags) instead",
206 Fl_Preferences(
const char *path,
const char *vendor,
const char *application ) );
208 Root filename(
char *buffer,
size_t buffer_size);
220 const char *
name() {
return node->name(); }
224 const char *
path() {
return node->path(); }
227 const char *group(
int num_group );
228 char group_exists(
const char *key );
229 char delete_group(
const char *group );
230 char delete_all_groups();
233 const char *entry(
int index );
234 char entry_exists(
const char *key );
235 char delete_entry(
const char *entry );
236 char delete_all_entries();
240 char set(
const char *entry,
int value );
241 char set(
const char *entry,
float value );
242 char set(
const char *entry,
float value,
int precision );
243 char set(
const char *entry,
double value );
244 char set(
const char *entry,
double value,
int precision );
245 char set(
const char *entry,
const char *value );
246 char set(
const char *entry,
const void *value,
int size );
248 char get(
const char *entry,
int &value,
int defaultValue );
249 char get(
const char *entry,
float &value,
float defaultValue );
250 char get(
const char *entry,
double &value,
double defaultValue );
251 char get(
const char *entry,
char *&value,
const char *defaultValue );
252 char get(
const char *entry,
char *value,
const char *defaultValue,
int maxSize );
253 char get(
const char *entry,
void *&value,
const void *defaultValue,
int defaultSize );
254 char get(
const char *entry,
void *value,
const void *defaultValue,
int defaultSize,
int maxSize );
255 char get(
const char *entry,
void *value,
const void *defaultValue,
int defaultSize,
int *size );
261 char set(
const char *entry,
const std::string &value );
262 char get(
const char *entry, std::string &value,
const std::string &defaultValue );
265 int size(
const char *entry );
267 char get_userdata_path(
char *path,
int pathlen );
274 static const char *newUUID() {
return new_UUID(); }
275 char groupExists(
const char *key ) {
return group_exists(key); }
276 char deleteGroup(
const char *group ) {
return delete_group(group); }
277 char deleteAllGroups() {
return delete_all_groups(); }
278 char entryExists(
const char *key ) {
return entry_exists(key); }
279 char deleteEntry(
const char *entry ) {
return delete_entry(entry); }
280 char deleteAllEntries() {
return delete_all_entries(); }
281 char getUserdataPath(
char *path,
int pathlen ) {
return get_userdata_path(path, pathlen); }
301 Name(
unsigned int n );
302 Name(
const char *format, ... );
308 operator const char *() {
return data_; }
321 static char nameBuffer[128];
322 static char uuidBuffer[40];
324 static unsigned int fileAccess_;
331 Node *first_child_, *next_;
338 int nEntry_, NEntry_;
339 unsigned char dirty_:1;
340 unsigned char top_:1;
341 unsigned char indexed_:1;
344 int nIndex_, NIndex_;
349 static int lastEntrySet;
351 Node(
const char *path );
354 int write( FILE *f );
356 const char *path() {
return path_; }
357 Node *find(
const char *path );
358 Node *search(
const char *path,
int offset=0 );
359 Node *childNode(
int ix );
360 Node *addChild(
const char *path );
361 void setParent(
Node *parent );
362 Node *parent() {
return top_?0L:parent_; }
363 void setRoot(
RootNode *r) { root_node_ = r; top_ = 1; }
367 void clearDirtyFlags();
368 void deleteAllChildren();
371 const char *child(
int ix );
372 void set(
const char *name,
const char *value );
373 void set(
const char *line );
374 void add(
const char *line );
375 const char *get(
const char *name );
376 int getEntry(
const char *name );
377 char deleteEntry(
const char *name );
378 void deleteAllEntries();
379 int nEntry() {
return nEntry_; }
380 Entry &entry(
int i) {
return entry_[i]; }
387 char *vendor_, *application_;
396 char getPath(
char *path,
int pathlen );
397 char *filename() {
return filename_; }
398 Root root() {
return root_type_; }
'Name' provides a simple method to create numerical or more complex procedural names for entries and ...
Definition Fl_Preferences.H:296
Definition Fl_Preferences.H:329
Definition Fl_Preferences.H:384
Fl_Preferences store user settings between application starts.
Definition Fl_Preferences.H:124
Root
Define the scope of the preferences.
Definition Fl_Preferences.H:130
@ USER
Preferences apply only to the current user. Deprecated, see USER_L.
Definition Fl_Preferences.H:133
@ MEMORY
Returned if querying memory mapped preferences.
Definition Fl_Preferences.H:134
ID id()
Return an ID that can later be reused to open more references to this dataset.
Definition Fl_Preferences.H:212
const char * path()
Return the full path to this entry.
Definition Fl_Preferences.H:224
void * ID
Every Fl_Preferences-Group has a unique ID.
Definition Fl_Preferences.H:155
const char * name()
Return the name of this entry.
Definition Fl_Preferences.H:220
static char remove(ID id_)
Remove the group with this ID from a database.
Definition Fl_Preferences.H:216
This file defines compiler-specific macros.
#define FL_DEPRECATED(msg, func)
Enclosing a function or method in FL_DEPRECATED marks it as no longer recommended.
Definition fl_attr.h:57
Definition Fl_Preferences.H:313