pgpreffile.cpp File Reference

#include "pgpreffile.h"
#include "brmisc.h"
#include "shstream.h"
#include "ststring.h"
#include "pfprefs.h"
#include "mmmemory.h"
#include "clstdlib.h"
#include "fmfile.h"
#include "brglobalmemorymanager.h"
#include <string.h>
#include <stdio.h>

Include dependency graph for pgpreffile.cpp:

Classes
struct	LineEntry_t
struct	PrefFileEntry_t
struct	PrefFileSection_t
struct	PrefFileComment_t
struct	PrefFile_t
Typedefs
typedef struct LineEntry_t	LineEntry_t
typedef struct PrefFileComment_t	PrefFileComment_t
Enumerations
enum	LineEntry_e { LINEENTRY_ROOT, LINEENTRY_SECTION, LINEENTRY_ENTRY, LINEENTRY_COMMENT }
Functions
static void BURGER_API	LineEntryAddComment (LineEntry_t *Input, const char *Text)
PrefFile_t *BURGER_API	PrefFileNew (void)
PrefFile_t *BURGER_API	PrefFileNewFromMemory (const char *Data, Word32 Length)
PrefFile_t *BURGER_API	PrefFileNewFromFile (const char *FileName)
PrefFile_t *BURGER_API	PrefFileNewFromFileAlways (const char *FileName)
void BURGER_API	PrefFileDelete (PrefFile_t *Input)
Word BURGER_API	PrefFileSaveFile (PrefFile_t *Input, const char *FileName)
PrefFileSection_t *BURGER_API	PrefFileFindSection (PrefFile_t *Input, const char *SectionName)
PrefFileSection_t *BURGER_API	PrefFileFindSectionAlways (PrefFile_t *Input, const char *SectionName)
char *BURGER_API	PrefFileGetList (PrefFile_t *Input)
PrefFileEntry_t *BURGER_API	PrefFileSectionFindEntry (PrefFileSection_t *Input, const char *EntryName)
static void BURGER_API	PrefFileDeleteLine (LineEntry_t *LinePtr)
void BURGER_API	PrefFileDeleteSection (PrefFile_t *Input, const char *SectionName)
void BURGER_API	PrefFileDeletePrefFileSection (PrefFile_t *, PrefFileSection_t *SectionPtr)
PrefFileSection_t *BURGER_API	PrefFileAddSection (PrefFile_t *Input, const char *SectionName)
Word BURGER_API	PrefFileIsEntryPresent (PrefFile_t *Input, const char *SectionName, const char *EntryName)
char *BURGER_API	PrefFileSectionGetList (PrefFileSection_t *Input)
char *BURGER_API	PrefFileSectionGetRaw (PrefFileSection_t *Input, const char *EntryName)
Word BURGER_API	PrefFileSectionGetBoolean (PrefFileSection_t *Input, const char *EntryName, Word Default)
Word BURGER_API	PrefFileSectionGetWord (PrefFileSection_t *Input, const char *EntryName, Word Default, Word Min, Word Max)
int BURGER_API	PrefFileSectionGetInt (PrefFileSection_t *Input, const char *EntryName, int Default, int Min, int Max)
float BURGER_API	PrefFileSectionGetFloat (PrefFileSection_t *Input, const char *EntryName, float Default, float Min, float Max)
double BURGER_API	PrefFileSectionGetDouble (PrefFileSection_t *Input, const char *EntryName, double Default, double Min, double Max)
void BURGER_API	PrefFileSectionGetString (PrefFileSection_t *Input, const char *EntryName, const char *Default, char *Buffer, Word BufferSize)
void BURGER_API	PrefFileSectionGetDualString (PrefFileSection_t *Input, const char *EntryName, const char *Default, char *Buffer, Word BufferSize, const char *Default2, char *Buffer2, Word BufferSize2)
void BURGER_API	PrefFileSectionGetMem (PrefFileSection_t *Input, const char *EntryName, const Word8 *Default, Word8 *Buffer, Word BufferSize)
void BURGER_API	PrefFileSectionGetWordArray (PrefFileSection_t *Input, const char *EntryName, const Word *Default, Word *Buffer, Word BufferSize)
void BURGER_API	PrefFileSectionAddEntry (PrefFileSection_t *Input, const char *EntryName, const char *Default)
void BURGER_API	PrefFileSectionPutRaw (PrefFileSection_t *Input, const char *EntryName, const char *RawString)
void BURGER_API	PrefFileSectionPutBoolean (PrefFileSection_t *Input, const char *EntryName, Word Data)
void BURGER_API	PrefFileSectionPutWord (PrefFileSection_t *Input, const char *EntryName, Word Data)
void BURGER_API	PrefFileSectionPutWordHex (PrefFileSection_t *Input, const char *EntryName, Word Data)
void BURGER_API	PrefFileSectionPutInt (PrefFileSection_t *Input, const char *EntryName, int Data)
void BURGER_API	PrefFileSectionPutFloat (PrefFileSection_t *Input, const char *EntryName, float Data)
void BURGER_API	PrefFileSectionPutDouble (PrefFileSection_t *Input, const char *EntryName, double Data)
void BURGER_API	PrefFileSectionPutString (PrefFileSection_t *Input, const char *EntryName, const char *Data)
void BURGER_API	PrefFileSectionPutDualString (PrefFileSection_t *Input, const char *EntryName, const char *Data, const char *Data2)
void BURGER_API	PrefFileSectionPutMem (PrefFileSection_t *Input, const char *EntryName, const Word8 *Data, Word Length)
void BURGER_API	PrefFileSectionPutWordArray (PrefFileSection_t *Input, const char *EntryName, const Word *Data, Word Count)
Variables
static const char	TrueWord [] = "TRUE"
static const char	FalseWord [] = "FALSE"

---

Typedef Documentation

typedef struct LineEntry_t LineEntry_t

typedef struct PrefFileComment_t PrefFileComment_t

---

Enumeration Type Documentation

enum LineEntry_e

Enumerator:

LINEENTRY_ROOT
LINEENTRY_SECTION
LINEENTRY_ENTRY
LINEENTRY_COMMENT

---

Function Documentation

static void BURGER_API LineEntryAddComment	(	LineEntry_t *	Input,
		const char *	Text
	)		[static]

PrefFileSection_t* BURGER_API PrefFileAddSection	(	PrefFile_t *	Input,
		const char *	SectionName
	)

void BURGER_API PrefFileDelete

(

PrefFile_t *

Input

)

static void BURGER_API PrefFileDeleteLine

(

LineEntry_t *

LinePtr

)

[static]

void BURGER_API PrefFileDeletePrefFileSection	(	PrefFile_t *	,
		PrefFileSection_t *	SectionPtr
	)

void BURGER_API PrefFileDeleteSection	(	PrefFile_t *	Input,
		const char *	SectionName
	)

PrefFileSection_t* BURGER_API PrefFileFindSection	(	PrefFile_t *	Input,
		const char *	SectionName
	)

PrefFileSection_t* BURGER_API PrefFileFindSectionAlways	(	PrefFile_t *	Input,
		const char *	SectionName
	)

char* BURGER_API PrefFileGetList

(

PrefFile_t *

Input

)

Word BURGER_API PrefFileIsEntryPresent	(	PrefFile_t *	Input,
		const char *	SectionName,
		const char *	EntryName
	)

PrefFile_t* BURGER_API PrefFileNew

(

void

)

PrefFile_t* BURGER_API PrefFileNewFromFile

(

const char *

FileName

)

PrefFile_t* BURGER_API PrefFileNewFromFileAlways

(

const char *

FileName

)

PrefFile_t* BURGER_API PrefFileNewFromMemory	(	const char *	Data,
		Word32	Length
	)

Word BURGER_API PrefFileSaveFile	(	PrefFile_t *	Input,
		const char *	FileName
	)

void BURGER_API PrefFileSectionAddEntry	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		const char *	Default
	)

PrefFileEntry_t* BURGER_API PrefFileSectionFindEntry	(	PrefFileSection_t *	Input,
		const char *	EntryName
	)

Word BURGER_API PrefFileSectionGetBoolean	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		Word	Default
	)

double BURGER_API PrefFileSectionGetDouble	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		double	Default,
		double	Min,
		double	Max
	)

void BURGER_API PrefFileSectionGetDualString	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		const char *	Default,
		char *	Buffer,
		Word	BufferSize,
		const char *	Default2,
		char *	Buffer2,
		Word	BufferSize2
	)

float BURGER_API PrefFileSectionGetFloat	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		float	Default,
		float	Min,
		float	Max
	)

int BURGER_API PrefFileSectionGetInt	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		int	Default,
		int	Min,
		int	Max
	)

char* BURGER_API PrefFileSectionGetList

(

PrefFileSection_t *

Input

)

void BURGER_API PrefFileSectionGetMem	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		const Word8 *	Default,
		Word8 *	Buffer,
		Word	BufferSize
	)

char* BURGER_API PrefFileSectionGetRaw	(	PrefFileSection_t *	Input,
		const char *	EntryName
	)

void BURGER_API PrefFileSectionGetString	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		const char *	Default,
		char *	Buffer,
		Word	BufferSize
	)

Word BURGER_API PrefFileSectionGetWord	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		Word	Default,
		Word	Min,
		Word	Max
	)

void BURGER_API PrefFileSectionGetWordArray	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		const Word *	Default,
		Word *	Buffer,
		Word	BufferSize
	)

void BURGER_API PrefFileSectionPutBoolean	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		Word	Data
	)

void BURGER_API PrefFileSectionPutDouble	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		double	Data
	)

void BURGER_API PrefFileSectionPutDualString	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		const char *	Data,
		const char *	Data2
	)

void BURGER_API PrefFileSectionPutFloat	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		float	Data
	)

void BURGER_API PrefFileSectionPutInt	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		int	Data
	)

void BURGER_API PrefFileSectionPutMem	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		const Word8 *	Data,
		Word	Length
	)

void BURGER_API PrefFileSectionPutRaw	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		const char *	RawString
	)

void BURGER_API PrefFileSectionPutString	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		const char *	Data
	)

void BURGER_API PrefFileSectionPutWord	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		Word	Data
	)

void BURGER_API PrefFileSectionPutWordArray	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		const Word *	Data,
		Word	Count
	)

void BURGER_API PrefFileSectionPutWordHex	(	PrefFileSection_t *	Input,
		const char *	EntryName,
		Word	Data
	)

---

Variable Documentation

const char FalseWord[] = "FALSE" [static]

const char TrueWord[] = "TRUE" [static]