config_file.h File Reference

Definition of functions which handles the configuration file. More...

#include "utility.h"
#include "game_configuration.h"

Go to the source code of this file.

Macros
#define	_CONFIG_FILE_H_
	Include guard.

Functions
bool	existsConfigurationFile ()
	Checks by filename if a game configuration file exists.
GameConfiguration	getConfigurationFromFile ()
	Load the game configuration from the file. It checks if the file exists.
void	saveConfigurationToFile (GameConfiguration configuration, bool overwriteIfExists)
	Save the given configuration to the game configuration file. It overwrites an existing file if and only if overwriteIfExists is set to true.

Detailed Description

Definition of functions which handles the configuration file.

Definition in file config_file.h.

Macro Definition Documentation

_CONFIG_FILE_H_

#define _CONFIG_FILE_H_

Include guard.

Definition at line 26 of file config_file.h.

Function Documentation

existsConfigurationFile()

bool existsConfigurationFile

(

)

Checks by filename if a game configuration file exists.

Returns

True if exists, false otherwise.

Definition at line 23 of file config_file.c.

getConfigurationFromFile()

GameConfiguration getConfigurationFromFile

(

)

Load the game configuration from the file. It checks if the file exists.

Returns

The game configuration loaded from the file, otherwise the default game configuration.

Definition at line 33 of file config_file.c.

saveConfigurationToFile()

void saveConfigurationToFile	(	GameConfiguration	configuration,
		bool	overwriteIfExists )

Save the given configuration to the game configuration file. It overwrites an existing file if and only if overwriteIfExists is set to true.

Parameters

configuration	The game configuration to be saved.
overwriteIfExists	Overwriting allowed flag.

Definition at line 89 of file config_file.c.