rockbox/apps/plugins/lib/configfile.h
Teruaki Kawashima 462771066b correct comment in configfile.h, FS#11292 by Chris Savery.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@28234 a1c6a512-1295-4272-9138-f99709370657
2010-10-10 14:34:07 +00:00

81 lines
2.8 KiB
C

/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Copyright (C) 2002 Linus Nielsen Feltzing
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
****************************************************************************/
#ifndef CONFIGFILE_H
#define CONFIGFILE_H
#define TYPE_INT 1
#define TYPE_ENUM 2
#define TYPE_STRING 3
#define TYPE_BOOL 4
struct configdata
{
int type; /* See TYPE_ macros above */
int min; /* Min value for integers, should be 0 for enums */
int max; /* Max value for integers, value count for enums,
buffer size for strings */
union
{
int *int_p;
bool *bool_p;
char *string;
}; /* Pointer to value, a union of the possible types */
char *name; /* Pointer to the name of the item */
char **values; /* List of strings for enums, NULL if not enum */
};
/* configfile_save - Given configdata entries this function will
create a config file with these entries, destroying any
previous config file of the same name */
int configfile_save(const char *filename, struct configdata *cfg,
int num_items, int version);
int configfile_load(const char *filename, struct configdata *cfg,
int num_items, int min_version);
/* configfile_get_value - Given a key name, this function will
return the integer value for that key.
Input:
filename = config file filename
name = (name/value) pair name entry
Return:
value if (name/value) pair is found
-1 if entry is not found
*/
int configfile_get_value(const char* filename, const char* name);
/* configure_update_entry - Given a key name and integer value
this function will update the entry if found, or add it if
not found.
Input:
filename = config file filename
name = (name/value) pair name entry
val = new value for (name/value) pair
Return:
1 if the (name/value) pair was found and updated with the new value
0 if the (name/value) pair was added as a new entry
-1 if error
*/
int configfile_update_entry(const char* filename, const char* name, int val);
#endif