GrafX2: readini.c File Reference

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <ctype.h>
#include "const.h"
#include "errors.h"
#include "global.h"
#include "misc.h"
#include "readini.h"
#include "setup.h"
#include "realpath.h"
#include "io.h"
#include "windows.h"
#include "gfx2log.h"
#include "gfx2mem.h"

Include dependency graph for readini.c:

Functions
void	Load_INI_clear_string (char *str, byte keep_comments)
	Clean a line of the ini file. More...

int	Load_INI_seek_pattern (const char buffer, const char pattern)
	Search for a substring in a string. More...

static int	Load_INI_reach_group (FILE file, char buffer, const char *group)
	Read lines until a group is found. More...

static int	Load_INI_get_string (FILE file, char buffer, const char option_name, char return_code, byte raw_text)
	Find the next string in the .INI file. More...

static int	Load_INI_get_value (const char str, int index, int *value)
	Read a value from the string. More...

static int	Load_INI_get_values (FILE file, char buffer, const char option_name, int nb_expected_values, int values)
	Read all values from a string. More...

int	Load_INI (T_Config *conf)
	Load config from the gfx2.ini file. More...

Function Documentation

◆ Load_INI_clear_string()

void Load_INI_clear_string	(	char *	str,
		byte	keep_comments
	)

Clean a line of the ini file.

Suppress all leading and trailing spaces
convert the key to uppercase

Comments start with ";". The result will be in the following format : KEY=value

Parameters

[in,out]	str
[in]	keep_comments	if set, the comments are kept

Referenced by Load_INI_get_string(), Load_INI_get_values(), Load_INI_reach_group(), Save_INI_reach_group(), Save_INI_set_strings(), and Save_INI_set_values().

◆ Load_INI_seek_pattern()

int Load_INI_seek_pattern	(	const char *	buffer,
		const char *	pattern
	)

Search for a substring in a string.

Parameters

buffer	the string to search into
pattern	the string to search for

Returns: 0 if the pattern was not found; >0 the position (+1) where the pattern was found

Referenced by Load_INI_get_string(), Load_INI_get_value(), Load_INI_get_values(), Load_INI_reach_group(), Save_INI_reach_group(), Save_INI_set_strings(), and Save_INI_set_values().

◆ Load_INI_reach_group()

static int Load_INI_reach_group	(	FILE *	file,
		char *	buffer,
		const char *	group
	)

static

Read lines until a group is found.

Returns: 0 when the group is reached; ERROR_INI_CORRUPTED if the group is not found

References ERROR_INI_CORRUPTED, Line_number_in_INI_file, Load_INI_clear_string(), and Load_INI_seek_pattern().

Referenced by Load_INI().

◆ Load_INI_get_string()

static int Load_INI_get_string	(	FILE *	file,
		char *	buffer,
		const char *	option_name,
		char *	return_code,
		byte	raw_text
	)

static

Find the next string in the .INI file.

Parameters

file	INI file currently opened
buffer	Current text buffer, preserved from one call to the next
option_name	string to search
return_code	the found value will be copied there. (must be allocaed)
raw_text	Boolean: true to return the raw value (up to end-of-line), false to strip comments.

Returns: 0 when OK; ERROR_INI_CORRUPTED if the option is not found

References ERROR_INI_CORRUPTED, Line_number_in_INI_file, Load_INI_clear_string(), Load_INI_seek_pattern(), and NULL.

Referenced by Load_INI().

◆ Load_INI_get_value()

static int Load_INI_get_value	(	const char *	str,
		int *	index,
		int *	value
	)

static

Read a value from the string.

GrafX2 is updated according to the number of characters read from the source string.

Parameters

str	the source string (option "values")
index	a pointer to the current index in the source string
value	the read value will be put there

Returns: 0; ERROR_INI_CORRUPTED

References ERROR_INI_CORRUPTED, and Load_INI_seek_pattern().

Referenced by Load_INI_get_values().

◆ Load_INI_get_values()

static int Load_INI_get_values	(	FILE *	file,
		char *	buffer,
		const char *	option_name,
		int	nb_expected_values,
		int *	values
	)

static

Read all values from a string.

The values are comma separated

Parameters

	file	handle to gfx2.ini
	buffer	Current text buffer, preserved from one call to the next
	option_name	name of the option to read
	nb_expected_values	number of values to read from the line
[out]	values	the values will be put there