1

/* $Id$ */

     2

     3

/** @file ini_type.h Types related to reading/writing '*.ini' files. */

     4

     5

#ifndef INI_TYPE_H

     6

#define INI_TYPE_H

     7

     8

/** Types of groups */

     9

enum IniGroupType {

    10

	IGT_VARIABLES = 0, ///< values of the form "landscape = hilly"

    11

	IGT_LIST      = 1, ///< a list of values, seperated by \n and terminated by the next group block

    12

};

    13

    14

/** A single "line" in an ini file. */

    15

struct IniItem {

    16

	IniItem *next; ///< The next item in this group

    17

	char *name;    ///< The name of this item

    18

	char *value;   ///< The value of this item

    19

	char *comment; ///< The comment associated with this item

    20

    21

	IniItem(struct IniGroup *parent, const char *name, size_t len = 0);

    22

	~IniItem();

    23

};

    24

    25

/** A group within an ini file. */

    26

struct IniGroup {

    27

	IniGroup *next;      ///< the next group within this file

    28

	IniGroupType type;   ///< type of group

    29

	IniItem *item;       ///< the first item in the group

    30

	IniItem **last_item; ///< the last item in the group

    31

	char *name;          ///< name of group

    32

	char *comment;       ///< comment for group

    33

    34

	/**

    35

	 * Construct a new in-memory group of an Ini file.

    36

	 * @param parent the file we belong to

    37

	 * @param name   the name of the group

    38

	 * @param len    the length of the name of the group

    39

	 */

    40

	IniGroup(struct IniFile *parent, const char *name, size_t len = 0);

    41

    42

	/** Free everything we loaded. */

    43

	~IniGroup();

    44

    45

	/**

    46

	 * Get the item with the given name, and if it doesn't exist

    47

	 * and create is true it creates a new item.

    48

	 * @param name   name of the item to find.

    49

	 * @param create whether to create an item when not found or not.

    50

	 * @return the requested item or NULL if not found.

    51

	 */

    52

	IniItem *GetItem(const char *name, bool create);

    53

};

    54

    55

/** The complete ini file. */

    56

struct IniFile {

    57

	IniGroup *group;               ///< the first group in the ini

    58

	IniGroup **last_group;         ///< the last group in the ini

    59

	char *comment;                 ///< last comment in file

    60

	const char **list_group_names; ///< NULL terminated list with group names that are lists

    61

    62

	/**

    63

	 * Construct a new in-memory Ini file representation.

    64

	 * @param list_group_names A NULL terminated list with groups that should be

    65

	 *                         loaded as lists instead of variables.

    66

	 */

    67

	IniFile(const char **list_group_names = NULL);

    68

    69

	/** Free everything we loaded. */

    70

	~IniFile();

    71

    72

	/**

    73

	 * Get the group with the given name, and if it doesn't exist

    74

	 * create a new group.

    75

	 * @param name name of the group to find.

    76

	 * @param len  the maximum length of said name.

    77

	 * @return the requested group.

    78

	 */

    79

	IniGroup *GetGroup(const char *name, size_t len = 0);

    80

    81

	/**

    82

	 * Remove the group with the given name.

    83

	 * @param name name of the group to remove.

    84

	 */

    85

	void RemoveGroup(const char *name);

    86

    87

	/**

    88

	 * Load the Ini file's data from the disk.

    89

	 * @param filename the file to load.

    90

	 * @pre nothing has been loaded yet.

    91

	 */

    92

	void LoadFromDisk(const char *filename);

    93

    94

	/**

    95

	 * Save the Ini file's data to the disk.

    96

	 * @param filename the file to save to.

    97

	 * @return true if saving succeeded.

    98

	 */

    99

	bool SaveToDisk(const char *filename);

   100

};

   101

   102

#endif /* INI_TYPE */