fileUtils.h File Reference

Go to the source code of this file.

Macros
#define	HI_WORD(x)
#define	LO_WORD(x)
#define	HI_BYTE(x)
#define	LO_BYTE(x)

Functions
long	getFileSize (const char *fname)
	Return the total size of the given file by opening it and seeking to the end.
bool	doesFileExist (const char *fname)
	Returns true if the file at the given path exists.
const char *	get_filename (const char *filename)
	Get the filename part of a file path, after the last '/'.
bool	isSourceFileNewer (const char *sourceFile, const char *destFile)
	Returns true if the file sourceFile has a last-modified time after that of destFile, or if destFile does not exist.
bool	deleteFile (const char *path)
	Delete the file at the given path in a cross-platform way.
bool	getOptionsFromIniFile (processorOptions_t *options, const char *file)
	Parse the file with the given name as an INI file and write its data to options.
void	deleteOptions (processorOptions_t *options)
	Deallocates memory for a processorOptions_t.
const char *	getFullOptionKey (char *tmp, size_t n, const optPair_t *option)
	Writes the <section>.<key> value to the given buffer and returns the key.
const char *	getStrOption (const processorOptions_t *options, const char *name)
	Retrieve an option by name and return its value as a string, or NULL if the key is not found.
int	getIntOption (const processorOptions_t *options, const char *name, int defaultVal)
	Retrieve an option by name from the given options list and parse it as an integer, using a default value if it cannot be found or is not an integer.
bool	getBoolOption (const processorOptions_t *options, const char *name, bool defaultVal)
	Retrieve an option by name from the given options list and parse it as a boolean, using a default value if it cannot be found or is not a boolean.
bool	hasOption (const processorOptions_t *options, const char *name)
	Searches the given options list for a key with the given name.

Macro Definition Documentation

HI_WORD

#define HI_WORD

(

x

)

Value:

((x >> 16) & 0xFFFF)

LO_WORD

#define LO_WORD

(

x

)

Value:

((x) & 0xFFFF)

HI_BYTE

#define HI_BYTE

(

x

)

Value:

((x >> 8) & 0xFF)

LO_BYTE

#define LO_BYTE

(

x

)

Value:

((x) & 0xFF)

Function Documentation

getFileSize()

long getFileSize

(

const char *

fname

)

Return the total size of the given file by opening it and seeking to the end.

Parameters

fname

The path to the file to measure

Returns

long The total size of the file in bytes

doesFileExist()

bool doesFileExist

(

const char *

fname

)

Returns true if the file at the given path exists.

Parameters

fname

The path to the file to check

Returns

true if the file exists

false if the file does not exist or otherwise cannot be read

get_filename()

const char * get_filename

(

const char *

filename

)

Get the filename part of a file path, after the last '/'.

Parameters

filename

The path to return the filename of

Returns

const char* A pointer to the filename within filename

isSourceFileNewer()

bool isSourceFileNewer	(	const char *	sourceFile,
		const char *	destFile )

Returns true if the file sourceFile has a last-modified time after that of destFile, or if destFile does not exist.

Parameters

sourceFile	The path to the "source" file, from which destFile is generated
destFile	The path to the "destination" file path, which should be regenerated if older than sourceFile.

Returns

true sourceFile was modified after destFile, so destFile should be updated

false destFile was modified after sourceFile, so destFile does not need to be updated

deleteFile()

bool deleteFile

(

const char *

path

)

Delete the file at the given path in a cross-platform way.

Parameters

path	The file to delete

Returns

true if the file was successfully deleted

false if there was an error deleting the file

getOptionsFromIniFile()

bool getOptionsFromIniFile	(	processorOptions_t *	options,
		const char *	file )

Parse the file with the given name as an INI file and write its data to options.

Parameters

options	An uninitialized options array to write INI file data to
file	The path to the INI file to read

Returns

true If the INI file was successfully parsed

false If there was an error parsing the INI file or it could not be read

deleteOptions()

void deleteOptions

(

processorOptions_t *

options

)

Deallocates memory for a processorOptions_t.

Parameters

options

A pointer to the processorOptions_t to delete memory for

getFullOptionKey()

const char * getFullOptionKey	(	char *	buf,
		size_t	n,
		const optPair_t *	option )

Writes the <section>.<key> value to the given buffer and returns the key.

If the given option has no section, the original key may be returned without using the buffer.

Parameters

buf	The buffer to write the key to if necessary
n	The maximum number of characters to write to buf
option	The option to write the key name of

Returns

char* A pointer to buf or option->name

getStrOption()

const char * getStrOption	(	const processorOptions_t *	options,
		const char *	name )

Retrieve an option by name and return its value as a string, or NULL if the key is not found.

Parameters

options	The options list to search
name	The key name to search for

Returns

const char* The value of the found key, or NULL

getIntOption()

int getIntOption	(	const processorOptions_t *	options,
		const char *	name,
		int	defaultVal )

Retrieve an option by name from the given options list and parse it as an integer, using a default value if it cannot be found or is not an integer.

Parameters

options	The options list to search
name	The key name to search for
defaultVal	A value to return if the key cannot be found or the value is not an integer

Returns

int The parsed value, or the default value

getBoolOption()

bool getBoolOption	(	const processorOptions_t *	options,
		const char *	name,
		bool	defaultVal )

Retrieve an option by name from the given options list and parse it as a boolean, using a default value if it cannot be found or is not a boolean.

The following values are considered as true: yes, true, 1, y, t, on And the following values are considered as false: no, false, 0, n, f, off Matching is case-insensitive. If the option value matches none of these strings, the default value will be returned instead.

Parameters

options	The options list to search
name	The name of the key to search
defaultVal	A value to return if the value is not found or not a boolean

Returns

true

false

hasOption()

bool hasOption	(	const processorOptions_t *	options,
		const char *	name )

Searches the given options list for a key with the given name.

Parameters

options	The options list to search
name	The key name to search for

Returns

true if the key was contained in the options list

false if the key was not found