statusMessageReporting.h File Reference

Go to the source code of this file.

Classes
struct	statusMessageReport
struct	statusMessageReporting

Macros
#define	smr_unknownID   0
#define	smr_tooManyIDs   1
#define	smr_invalidID   2
#define	smr_errnoID   3
#define	smr_smrID   4
#define	smr_maximumNumberOfRegisteredLibraries   128
#define	smr_maximumFileNameSize   1024
#define	smr_codeNULL   0
#define	smr_codeFileIO   -1
#define	smr_codeMemoryAllocating   -2
#define	smr_malloc2(smr, size, zero, forItem)   smr_malloc( smr, size, zero, forItem, __FILE__, __LINE__, __func__ )
#define	smr_realloc2(smr, old, size, forItem)   smr_realloc( smr, old, size, forItem, __FILE__, __LINE__, __func__ )
#define	smr_allocateCopyString2(smr, s, forItem)   smr_allocateCopyString( smr, s, forItem, __FILE__, __LINE__, __func__ )
#define	smr_allocateCopyStringN2(smr, s, n, forItem)   smr_allocateCopyStringN( smr, s, n, forItem, __FILE__, __LINE__, __func__ )
#define	smr_setReportInfo2(smr, libraryID, code, fmt,...)   smr_setReportInfo( smr, NULL, __FILE__, __LINE__, __func__, libraryID, code, fmt, __VA_ARGS__ )
#define	smr_setReportInfo2p(smr, libraryID, code, fmt)   smr_setReportInfo( smr, NULL, __FILE__, __LINE__, __func__, libraryID, code, fmt )
#define	smr_vsetReportInfo2(smr, libraryID, code, fmt, args)   smr_vsetReportInfo( smr, NULL, __FILE__, __LINE__, __func__, libraryID, code, fmt, args )
#define	smr_setReportWarning2(smr, libraryID, code, fmt,...)   smr_setReportWarning( smr, NULL, __FILE__, __LINE__, __func__, libraryID, code, fmt, __VA_ARGS__ )
#define	smr_setReportWarning2p(smr, libraryID, code, fmt)   smr_setReportWarning( smr, NULL, __FILE__, __LINE__, __func__, libraryID, code, fmt )
#define	smr_vsetReportWarning2(smr, libraryID, code, fmt, args)   smr_vsetReportWarning( smr, NULL, __FILE__, __LINE__, __func__, libraryID, code, fmt, args )
#define	smr_setReportError2(smr, libraryID, code, fmt,...)   smr_setReportError( smr, NULL, __FILE__, __LINE__, __func__, libraryID, code, fmt, __VA_ARGS__ )
#define	smr_setReportError2p(smr, libraryID, code, fmt)   smr_setReportError( smr, NULL, __FILE__, __LINE__, __func__, libraryID, code, fmt )
#define	smr_vsetReportError2(smr, libraryID, code, fmt, args)   smr_vsetReportError( smr, NULL, __FILE__, __LINE__, __func__, libraryID, code, fmt, args )
#define	smr_setReportInfo3(smr, userInterface, libraryID, code, fmt,...)   smr_setReportInfo( smr, userInterface, __FILE__, __LINE__, __func__, libraryID, code, fmt, __VA_ARGS__ )
#define	smr_setReportInfo3p(smr, userInterface, libraryID, code, fmt)   smr_setReportInfo( smr, userInterface, __FILE__, __LINE__, __func__, libraryID, code, fmt )
#define	smr_vsetReportInfo3(smr, userInterface, libraryID, code, fmt, args)   smr_vsetReportInfo( smr, userInterface, __FILE__, __LINE__, __func__, libraryID, code, fmt, args )
#define	smr_setReportWarning3(smr, userInterface, libraryID, code, fmt,...)   smr_setReportWarning( smr, userInterface, __FILE__, __LINE__, __func__, libraryID, code, fmt, __VA_ARGS__ )
#define	smr_setReportWarning3p(smr, userInterface, libraryID, code, fmt)   smr_setReportWarning( smr, userInterface, __FILE__, __LINE__, __func__, libraryID, code, fmt )
#define	smr_vsetReportWarning3(smr, userInterface, libraryID, code, fmt, args)   smr_vsetReportWarning( smr, userInterface, __FILE__, __LINE__, __func__, libraryID, code, fmt, args )
#define	smr_setReportError3(smr, userInterface, libraryID, code, fmt,...)   smr_setReportError( smr, userInterface, __FILE__, __LINE__, __func__, libraryID, code, fmt, __VA_ARGS__ )
#define	smr_setReportError3p(smr, userInterface, libraryID, code, fmt)   smr_setReportError( smr, userInterface, __FILE__, __LINE__, __func__, libraryID, code, fmt )
#define	smr_vsetReportError3(smr, userInterface, libraryID, code, fmt, args)   smr_vsetReportError( smr, userInterface, __FILE__, __LINE__, __func__, libraryID, code, fmt, args )

Typedefs
typedef char *(*	smr_userInterface )(void *userData)
typedef struct statusMessageReport	statusMessageReport
typedef struct statusMessageReporting	statusMessageReporting

Enumerations
enum	smr_status { smr_status_Ok = 0, smr_status_Info, smr_status_Warning, smr_status_Error }

Functions
int	smr_setup (void)
int	smr_cleanup (void)
int	smr_registerLibrary (char const *libraryName)
int	smr_numberOfRegisteredLibraries (void)
char const *	smr_getRegisteredLibrariesName (int ID)
statusMessageReporting *	smr_new (statusMessageReporting *smr, enum smr_status verbosity, int append)
int	smr_initialize (statusMessageReporting *smr, enum smr_status verbosity, int append)
void	smr_release (statusMessageReporting *smr)
void *	smr_free (statusMessageReporting **smr)
statusMessageReporting *	smr_clone (statusMessageReporting *smr)
int	smr_setReportInfo (statusMessageReporting *smr, void *userInterface, char const *file, int line, char const *function, int libraryID, int code, char const *fmt,...)
int	smr_vsetReportInfo (statusMessageReporting *smr, void *userInterface, char const *file, int line, char const *function, int libraryID, int code, char const *fmt, va_list *args)
int	smr_setReportWarning (statusMessageReporting *smr, void *userInterface, char const *file, int line, char const *function, int libraryID, int code, char const *fmt,...)
int	smr_vsetReportWarning (statusMessageReporting *smr, void *userInterface, char const *file, int line, char const *function, int libraryID, int code, char const *fmt, va_list *args)
int	smr_setReportError (statusMessageReporting *smr, void *userInterface, char const *file, int line, char const *function, int libraryID, int code, char const *fmt,...)
int	smr_vsetReportError (statusMessageReporting *smr, void *userInterface, char const *file, int line, char const *function, int libraryID, int code, char const *fmt, va_list *args)
enum smr_status	smr_highestStatus (statusMessageReporting *smr)
int	smr_isOk (statusMessageReporting *smr)
int	smr_isInfo (statusMessageReporting *smr)
int	smr_isWarning (statusMessageReporting *smr)
int	smr_isError (statusMessageReporting *smr)
int	smr_isWarningOrError (statusMessageReporting *smr)
int	smr_isReportOk (statusMessageReport *report)
int	smr_isReportInfo (statusMessageReport *report)
int	smr_isReportWarning (statusMessageReport *report)
int	smr_isReportError (statusMessageReport *report)
int	smr_isReportWarningOrError (statusMessageReport *report)
int	smr_numberOfReports (statusMessageReporting *smr)
statusMessageReport *	smr_firstReport (statusMessageReporting *smr)
statusMessageReport *	smr_nextReport (statusMessageReport *report)
enum smr_status	smr_getVerbosity (statusMessageReporting *smr)
int	smr_getAppend (statusMessageReporting *smr)
int	smr_getLibraryID (statusMessageReport *report)
int	smr_getCode (statusMessageReport *report)
int	smr_getLine (statusMessageReport *report)
char const *	smr_getFile (statusMessageReport *report)
char const *	smr_getFunction (statusMessageReport *report)
char const *	smr_getMessage (statusMessageReport *report)
char *	smr_copyMessage (statusMessageReport *report)
char *	smr_copyFullMessage (statusMessageReport *report)
void	smr_print (statusMessageReporting *smr, int clear)
void	smr_write (statusMessageReporting *smr, FILE *f, int clear)
void	smr_reportPrint (statusMessageReport *report)
void	smr_reportWrite (statusMessageReport *report, FILE *f)
char const *	smr_statusToString (enum smr_status status)
char *	smr_allocateFormatMessage (char const *fmt,...)
char *	smr_vallocateFormatMessage (char const *fmt, va_list *args)
void *	smr_malloc (statusMessageReporting *smr, size_t size, int zero, char const *forItem, char const *file, int line, char const *function)
void *	smr_realloc (statusMessageReporting *smr, void *pOld, size_t size, char const *forItem, char const *file, int line, char const *function)
void *	smr_freeMemory (void **p)
char *	smr_allocateCopyString (statusMessageReporting *smr, char const *s, char const *forItem, char const *file, int line, char const *function)
char *	smr_allocateCopyStringN (statusMessageReporting *smr, char const *s, size_t n, char const *forItem, char const *file, int line, char const *function)

Macro Definition Documentation

#define smr_unknownID   0

#define smr_tooManyIDs   1

#define smr_invalidID   2

#define smr_errnoID   3

#define smr_smrID   4

#define smr_maximumNumberOfRegisteredLibraries   128

#define smr_maximumFileNameSize   1024

#define smr_codeNULL   0

#define smr_codeFileIO   -1

#define smr_codeMemoryAllocating   -2

#define smr_malloc2	(		smr,
			size,
			zero,
			forItem
	)		smr_malloc( smr, size, zero, forItem, __FILE__, __LINE__, __func__ )

#define smr_realloc2	(		smr,
			old,
			size,
			forItem
	)		smr_realloc( smr, old, size, forItem, __FILE__, __LINE__, __func__ )

#define smr_allocateCopyString2	(		smr,
			s,
			forItem
	)		smr_allocateCopyString( smr, s, forItem, __FILE__, __LINE__, __func__ )

#define smr_allocateCopyStringN2	(		smr,
			s,
			n,
			forItem
	)		smr_allocateCopyStringN( smr, s, n, forItem, __FILE__, __LINE__, __func__ )

#define smr_setReportInfo2	(		smr,
			libraryID,
			code,
			fmt,
			...
	)		smr_setReportInfo( smr, NULL, __FILE__, __LINE__, __func__, libraryID, code, fmt, __VA_ARGS__ )

#define smr_setReportInfo2p	(		smr,
			libraryID,
			code,
			fmt
	)		smr_setReportInfo( smr, NULL, __FILE__, __LINE__, __func__, libraryID, code, fmt )

#define smr_vsetReportInfo2	(		smr,
			libraryID,
			code,
			fmt,
			args
	)		smr_vsetReportInfo( smr, NULL, __FILE__, __LINE__, __func__, libraryID, code, fmt, args )

#define smr_setReportWarning2	(		smr,
			libraryID,
			code,
			fmt,
			...
	)		smr_setReportWarning( smr, NULL, __FILE__, __LINE__, __func__, libraryID, code, fmt, __VA_ARGS__ )

#define smr_setReportWarning2p	(		smr,
			libraryID,
			code,
			fmt
	)		smr_setReportWarning( smr, NULL, __FILE__, __LINE__, __func__, libraryID, code, fmt )

#define smr_vsetReportWarning2	(		smr,
			libraryID,
			code,
			fmt,
			args
	)		smr_vsetReportWarning( smr, NULL, __FILE__, __LINE__, __func__, libraryID, code, fmt, args )

#define smr_setReportError2	(		smr,
			libraryID,
			code,
			fmt,
			...
	)		smr_setReportError( smr, NULL, __FILE__, __LINE__, __func__, libraryID, code, fmt, __VA_ARGS__ )

#define smr_setReportError2p	(		smr,
			libraryID,
			code,
			fmt
	)		smr_setReportError( smr, NULL, __FILE__, __LINE__, __func__, libraryID, code, fmt )

#define smr_vsetReportError2	(		smr,
			libraryID,
			code,
			fmt,
			args
	)		smr_vsetReportError( smr, NULL, __FILE__, __LINE__, __func__, libraryID, code, fmt, args )

#define smr_setReportInfo3	(		smr,
			userInterface,
			libraryID,
			code,
			fmt,
			...
	)		smr_setReportInfo( smr, userInterface, __FILE__, __LINE__, __func__, libraryID, code, fmt, __VA_ARGS__ )

#define smr_setReportInfo3p	(		smr,
			userInterface,
			libraryID,
			code,
			fmt
	)		smr_setReportInfo( smr, userInterface, __FILE__, __LINE__, __func__, libraryID, code, fmt )

#define smr_vsetReportInfo3	(		smr,
			userInterface,
			libraryID,
			code,
			fmt,
			args
	)		smr_vsetReportInfo( smr, userInterface, __FILE__, __LINE__, __func__, libraryID, code, fmt, args )

#define smr_setReportWarning3	(		smr,
			userInterface,
			libraryID,
			code,
			fmt,
			...
	)		smr_setReportWarning( smr, userInterface, __FILE__, __LINE__, __func__, libraryID, code, fmt, __VA_ARGS__ )

#define smr_setReportWarning3p	(		smr,
			userInterface,
			libraryID,
			code,
			fmt
	)		smr_setReportWarning( smr, userInterface, __FILE__, __LINE__, __func__, libraryID, code, fmt )

#define smr_vsetReportWarning3	(		smr,
			userInterface,
			libraryID,
			code,
			fmt,
			args
	)		smr_vsetReportWarning( smr, userInterface, __FILE__, __LINE__, __func__, libraryID, code, fmt, args )

#define smr_setReportError3	(		smr,
			userInterface,
			libraryID,
			code,
			fmt,
			...
	)		smr_setReportError( smr, userInterface, __FILE__, __LINE__, __func__, libraryID, code, fmt, __VA_ARGS__ )

#define smr_setReportError3p	(		smr,
			userInterface,
			libraryID,
			code,
			fmt
	)		smr_setReportError( smr, userInterface, __FILE__, __LINE__, __func__, libraryID, code, fmt )

#define smr_vsetReportError3	(		smr,
			userInterface,
			libraryID,
			code,
			fmt,
			args
	)		smr_vsetReportError( smr, userInterface, __FILE__, __LINE__, __func__, libraryID, code, fmt, args )

Typedef Documentation

typedef char*(* smr_userInterface)(void *userData)

typedef struct statusMessageReport statusMessageReport

typedef struct statusMessageReporting statusMessageReporting

Enumeration Type Documentation

enum smr_status

Enumerator
smr_status_Ok
smr_status_Info
smr_status_Warning
smr_status_Error

Function Documentation

int smr_setup

(

void

)

int smr_cleanup

(

void

)

int smr_registerLibrary

(

char const *

libraryName

)

int smr_numberOfRegisteredLibraries

(

void

)

char const* smr_getRegisteredLibrariesName

(

int

ID

)

statusMessageReporting* smr_new	(	statusMessageReporting *	smr,
		enum smr_status	verbosity,
		int	append
	)

int smr_initialize	(	statusMessageReporting *	smr,
		enum smr_status	verbosity,
		int	append
	)

void smr_release

(

statusMessageReporting *

smr

)

void* smr_free

(

statusMessageReporting **

smr

)

statusMessageReporting* smr_clone

(

statusMessageReporting *

smr

)

int smr_setReportInfo	(	statusMessageReporting *	smr,
		void *	userInterface,
		char const *	file,
		int	line,
		char const *	function,
		int	libraryID,
		int	code,
		char const *	fmt,
			...
	)

int smr_vsetReportInfo	(	statusMessageReporting *	smr,
		void *	userInterface,
		char const *	file,
		int	line,
		char const *	function,
		int	libraryID,
		int	code,
		char const *	fmt,
		va_list *	args
	)

int smr_setReportWarning	(	statusMessageReporting *	smr,
		void *	userInterface,
		char const *	file,
		int	line,
		char const *	function,
		int	libraryID,
		int	code,
		char const *	fmt,
			...
	)

int smr_vsetReportWarning	(	statusMessageReporting *	smr,
		void *	userInterface,
		char const *	file,
		int	line,
		char const *	function,
		int	libraryID,
		int	code,
		char const *	fmt,
		va_list *	args
	)

int smr_setReportError	(	statusMessageReporting *	smr,
		void *	userInterface,
		char const *	file,
		int	line,
		char const *	function,
		int	libraryID,
		int	code,
		char const *	fmt,
			...
	)

int smr_vsetReportError	(	statusMessageReporting *	smr,
		void *	userInterface,
		char const *	file,
		int	line,
		char const *	function,
		int	libraryID,
		int	code,
		char const *	fmt,
		va_list *	args
	)

enum smr_status smr_highestStatus

(

statusMessageReporting *

smr

)

int smr_isOk

(

statusMessageReporting *

smr

)

int smr_isInfo

(

statusMessageReporting *

smr

)

int smr_isWarning

(

statusMessageReporting *

smr

)

int smr_isError

(

statusMessageReporting *

smr

)

int smr_isWarningOrError

(

statusMessageReporting *

smr

)

int smr_isReportOk

(

statusMessageReport *

report

)

int smr_isReportInfo

(

statusMessageReport *

report

)

int smr_isReportWarning

(

statusMessageReport *

report

)

int smr_isReportError

(

statusMessageReport *

report

)

int smr_isReportWarningOrError

(

statusMessageReport *

report

)

int smr_numberOfReports

(

statusMessageReporting *

smr

)

statusMessageReport* smr_firstReport

(

statusMessageReporting *

smr

)

statusMessageReport* smr_nextReport

(

statusMessageReport *

report

)

enum smr_status smr_getVerbosity

(

statusMessageReporting *

smr

)

int smr_getAppend

(

statusMessageReporting *

smr

)

int smr_getLibraryID

(

statusMessageReport *

report

)

int smr_getCode

(

statusMessageReport *

report

)

int smr_getLine

(

statusMessageReport *

report

)

char const* smr_getFile

(

statusMessageReport *

report

)

char const* smr_getFunction

(

statusMessageReport *

report

)

char const* smr_getMessage

(

statusMessageReport *

report

)

char* smr_copyMessage

(

statusMessageReport *

report

)

char* smr_copyFullMessage

(

statusMessageReport *

report

)

void smr_print	(	statusMessageReporting *	smr,
		int	clear
	)

void smr_write	(	statusMessageReporting *	smr,
		FILE *	f,
		int	clear
	)

void smr_reportPrint

(

statusMessageReport *

report

)

void smr_reportWrite	(	statusMessageReport *	report,
		FILE *	f
	)

char const* smr_statusToString

(

enum smr_status

status

)

char* smr_allocateFormatMessage	(	char const *	fmt,
			...
	)

char* smr_vallocateFormatMessage	(	char const *	fmt,
		va_list *	args
	)

void* smr_malloc	(	statusMessageReporting *	smr,
		size_t	size,
		int	zero,
		char const *	forItem,
		char const *	file,
		int	line,
		char const *	function
	)

void* smr_realloc	(	statusMessageReporting *	smr,
		void *	pOld,
		size_t	size,
		char const *	forItem,
		char const *	file,
		int	line,
		char const *	function
	)

void* smr_freeMemory

(

void **

p

)

char* smr_allocateCopyString	(	statusMessageReporting *	smr,
		char const *	s,
		char const *	forItem,
		char const *	file,
		int	line,
		char const *	function
	)

char* smr_allocateCopyStringN	(	statusMessageReporting *	smr,
		char const *	s,
		size_t	n,
		char const *	forItem,
		char const *	file,
		int	line,
		char const *	function
	)