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

	/**

    22

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

    23

	 * @param parent the group we belong to

    24

	 * @param name   the name of the item

    25

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

    26

	 */

    27

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

    28

    29

	/** Free everything we loaded. */

    30

	~IniItem();

    31

    32

	/**

    33

	 * Replace the current value with another value.

    34

	 * @param value the value to replace with.

    35

	 */

    36

	void SetValue(const char *value);

    37

};

    38

    39

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

    40

struct IniGroup {

    41

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

    42

	IniGroupType type;   ///< type of group

    43

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

    44

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

    45

	char *name;          ///< name of group

    46

	char *comment;       ///< comment for group

    47

    48

	/**

    49

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

    50

	 * @param parent the file we belong to

    51

	 * @param name   the name of the group

    52

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

    53

	 */

    54

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

    55

    56

	/** Free everything we loaded. */

    57

	~IniGroup();

    58

    59

	/**

    60

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

    61

	 * and create is true it creates a new item.

    62

	 * @param name   name of the item to find.

    63

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

    64

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

    65

	 */

    66

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

    67

};

    68

    69

/** The complete ini file. */

    70

struct IniFile {

    71

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

    72

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

    73

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

    74

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

    75

    76

	/**

    77

	 * Construct a new in-memory Ini file representation.

    78

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

    79

	 *                         loaded as lists instead of variables.

    80

	 */

    81

	IniFile(const char **list_group_names = NULL);

    82

    83

	/** Free everything we loaded. */

    84

	~IniFile();

    85

    86

	/**

    87

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

    88

	 * create a new group.

    89

	 * @param name name of the group to find.

    90

	 * @param len  the maximum length of said name.

    91

	 * @return the requested group.

    92

	 */

    93

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

    94

    95

	/**

    96

	 * Remove the group with the given name.

    97

	 * @param name name of the group to remove.

    98

	 */

    99

	void RemoveGroup(const char *name);

   100

   101

	/**

   102

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

   103

	 * @param filename the file to load.

   104

	 * @pre nothing has been loaded yet.

   105

	 */

   106

	void LoadFromDisk(const char *filename);

   107

   108

	/**

   109

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

   110

	 * @param filename the file to save to.

   111

	 * @return true if saving succeeded.

   112

	 */

   113

	bool SaveToDisk(const char *filename);

   114

};

   115

   116

#endif /* INI_TYPE_H */