Super-2024-Swadge-FW/fileUtils_8h_source.html

#ifndef _FILE_UTILS_H_

#define _FILE_UTILS_H_


#include <stdbool.h>


#include "assets_preprocessor.h"


#define HI_WORD(x) ((x >> 16) & 0xFFFF)

#define LO_WORD(x) ((x) & 0xFFFF)

#define HI_BYTE(x) ((x >> 8) & 0xFF)

#define LO_BYTE(x) ((x) & 0xFF)


long getFileSize(const char* fname);

bool doesFileExist(const char* fname);

const char* get_filename(const char* filename);

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

bool deleteFile(const char* path);


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

void deleteOptions(processorOptions_t* options);

const char* getFullOptionKey(char* tmp, size_t n, const optPair_t* option);

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

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

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

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


#endif

assets_preprocessor.h

optPair_t
Holds a single key-value pair.
Definition assets_preprocessor.h:682

processorOptions_t
Holds a list of key-value option pairs.
Definition assets_preprocessor.h:708

deleteOptions
void deleteOptions(processorOptions_t *options)
Deallocates memory for a processorOptions_t.
Definition fileUtils.c:631

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,...
Definition fileUtils.c:682

hasOption
bool hasOption(const processorOptions_t *options, const char *name)
Searches the given options list for a key with the given name.
Definition fileUtils.c:787

get_filename
const char * get_filename(const char *filename)
Get the filename part of a file path, after the last '/'.
Definition fileUtils.c:56

getFileSize
long getFileSize(const char *fname)
Return the total size of the given file by opening it and seeking to the end.
Definition fileUtils.c:29

getFullOptionKey
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.
Definition fileUtils.c:613

deleteFile
bool deleteFile(const char *path)
Delete the file at the given path in a cross-platform way.
Definition fileUtils.c:115

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.
Definition fileUtils.c:653

doesFileExist
bool doesFileExist(const char *fname)
Returns true if the file at the given path exists.
Definition fileUtils.c:45

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 val...
Definition fileUtils.c:728

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.
Definition fileUtils.c:565

isSourceFileNewer
bool isSourceFileNewer(const char *sourceFile, const char *destFile)
Returns true if the file sourceFile has a last-modified time after that of destFile,...
Definition fileUtils.c:75