statusMessageReporting.h File Reference

#include <stdio.h>
#include <stdarg.h>

Go to the source code of this file.

Data Structures
struct	statusMessageReporting

Macros
#define	smr_maximumPackageNameSize   256

Typedefs
typedef int(*	smr_userInterface )(void *userData, char **smr)
typedef struct statusMessageReporting	statusMessageReporting

Enumerations
enum	smr_status { smr_status_Ok, smr_status_Info, smr_status_Error, smr_status_Fatal }

Functions
int	smr_initialize (statusMessageReporting *smr)
int	smr_release (statusMessageReporting *smr)
int	smr_setMessageInfo (statusMessageReporting *smr, void *userInterface, const char *file, int line, int code, const char *fmt,...)
int	smr_vsetMessageInfo (statusMessageReporting *smr, void *userInterface, const char *file, int line, int code, const char *fmt, va_list *args)
int	smr_setMessageError (statusMessageReporting *smr, void *userInterface, const char *file, int line, int code, const char *fmt,...)
int	smr_vsetMessageError (statusMessageReporting *smr, void *userInterface, const char *file, int line, int code, const char *fmt, va_list *args)
char *	smr_allocateFormatMessage (const char *fmt,...)
char *	smr_vallocateFormatMessage (const char *fmt, va_list *args)
int	smr_isOk (statusMessageReporting *smr)
int	smr_isInfo (statusMessageReporting *smr)
int	smr_isError (statusMessageReporting *smr)
int	smr_isFatal (statusMessageReporting *smr)
const char *	smr_getMessage (statusMessageReporting *smr)
char *	smr_getFullMessage (statusMessageReporting *smr)
void	smr_print (statusMessageReporting *smr, FILE *f, int clear)

Macro Definition Documentation

#define smr_maximumPackageNameSize   256

Definition at line 47 of file statusMessageReporting.h.

Typedef Documentation

typedef int(* smr_userInterface)(void *userData, char **smr)

Definition at line 49 of file statusMessageReporting.h.

typedef struct statusMessageReporting statusMessageReporting

Enumeration Type Documentation

enum smr_status

Enumerator
smr_status_Ok
smr_status_Info
smr_status_Error
smr_status_Fatal

Definition at line 48 of file statusMessageReporting.h.

{ smr_status_Ok, smr_status_Info, smr_status_Error, smr_status_Fatal };

Function Documentation

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

Definition at line 121 of file statusMessageReporting.cc.

References smr_vallocateFormatMessage().

                                                        {

    char *s;
    va_list args;

    va_start( args, fmt );
    s = smr_vallocateFormatMessage( fmt, &args );
    va_end( args );
    return( s );
}

char* smr_getFullMessage

(

statusMessageReporting *

smr

)

Definition at line 247 of file statusMessageReporting.cc.

References statusMessageReporting::line, statusMessageReporting::message, and statusMessageReporting::packageName.

                                                        {

    return( smr_getFullMessage2( "%s\nAt line %d of %s", smr->message, smr->line, smr->packageName ) );
}

const char* smr_getMessage

(

statusMessageReporting *

smr

)

Definition at line 240 of file statusMessageReporting.cc.

References statusMessageReporting::message.

                                                          {

    return( smr->message );
}

int smr_initialize

(

statusMessageReporting *

smr

)

Definition at line 57 of file statusMessageReporting.cc.

References statusMessageReporting::code, statusMessageReporting::line, statusMessageReporting::message, statusMessageReporting::packageName, smr_status_Ok, and statusMessageReporting::status.

Referenced by G4GIDI_map::G4GIDI_map(), G4GIDI_target::init(), and smr_release().

                                                  {

    smr->status = smr_status_Ok;
    smr->packageName[0] = 0;
    smr->line= -1;
    smr->code = 0;
    smr->message = NULL;
    return( 0 );
}

int smr_isError

(

statusMessageReporting *

smr

)

Definition at line 224 of file statusMessageReporting.cc.

References smr_status_Error, smr_status_Fatal, and statusMessageReporting::status.

                                               { 

    if( smr == NULL ) return( 1 );
    return( ( smr->status == smr_status_Error ) || ( smr->status == smr_status_Fatal ) );
}

int smr_isFatal

(

statusMessageReporting *

smr

)

Definition at line 232 of file statusMessageReporting.cc.

References smr_status_Fatal, and statusMessageReporting::status.

                                               { 

    if( smr == NULL ) return( 1 );
    return( smr->status == smr_status_Fatal );
}

int smr_isInfo

(

statusMessageReporting *

smr

)

Definition at line 216 of file statusMessageReporting.cc.

References smr_status_Info, and statusMessageReporting::status.

                                              { 

    if( smr == NULL ) return( 1 );
    return( smr->status == smr_status_Info );
}

int smr_isOk

(

statusMessageReporting *

smr

)

Definition at line 208 of file statusMessageReporting.cc.

References smr_status_Ok, and statusMessageReporting::status.

Referenced by G4GIDI_map::G4GIDI_map(), G4GIDI_target::init(), tpia_angularEnergy_SampleEp(), tpia_channel_getFromElement(), tpia_decayChannel_sampleProductsAtE(), tpia_frame_setFromString(), tpia_map_findTarget(), tpia_map_readFile(), tpia_misc_pointerToAttributeIfAllOk(), tpia_miscNameToZAm(), tpia_particle_getInternalID(), tpia_product_getFromElement(), tpia_target_getEnergyGridAtTIndex(), tpia_target_getTotalCrossSectionAtTIndex(), tpia_target_heated_read(), tpia_target_read(), xData_parseEndOfXML(), xData_parseInitialize(), xData_parseReadFile(), and xData_parseString().

                                            { 

    if( smr == NULL ) return( 1 );
    return( smr->status == smr_status_Ok );
}

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

Definition at line 267 of file statusMessageReporting.cc.

References statusMessageReporting::line, statusMessageReporting::message, statusMessageReporting::packageName, and smr_release().

Referenced by G4GIDI_map::G4GIDI_map(), and G4GIDI_target::init().

                                                                  {

    if( smr->message != NULL ) fprintf( f, "%s\nAt line %d of %s\n", smr->message, smr->line, smr->packageName );
    if( clear ) smr_release( smr );
}

int smr_release

(

statusMessageReporting *

smr

)

Definition at line 69 of file statusMessageReporting.cc.

References free(), statusMessageReporting::message, and smr_initialize().

Referenced by smr_print(), G4GIDI_map::~G4GIDI_map(), and G4GIDI_target::~G4GIDI_target().

                                               {

    if( smr->message != NULL ) {
        if( smr->message != smr_mallocFailed ) free( smr->message );
    }
    return( smr_initialize( smr ) );
}

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

Definition at line 100 of file statusMessageReporting.cc.

References smr_status_Error, and status.

Referenced by getRowStartEndAtIndex(), tpia_decayChannel_sampleProductsAtE(), tpia_depot_addTargetFromMap(), tpia_frame_getColumn(), tpia_frame_setColumn(), tpia_frame_setFromString(), tpia_frame_toString(), tpia_map_readFile(), tpia_misc_pointerToAttributeIfAllOk(), tpia_misc_setMessageError_Element(), tpia_miscNameToZAm(), tpia_particleMass_AMU(), tpia_target_getHeatedTargetAtIndex_ReadIfNeeded(), tpia_target_getHeatedTargetAtTIndex(), tpia_target_getTotalCrossSectionAtTIndex(), tpia_target_heated_getChannelAtIndex_smr(), tpia_target_read(), tpia_target_readHeatedTarget(), xData_1d_x_copyData(), xData_convertAttributeTo_xData_Int(), xData_convertAttributeToDouble(), xData_getCommonData(), xData_getOneElementByTagName(), xData_is_xDataType(), xData_parseEndOfXML(), xData_parseInitialize(), xData_parseReadFile(), xData_realloc(), xData_setMessageError_ReturnInt(), xData_stringTo_double(), xData_stringTo_xData_Int(), xData_xDataTypeConvertAttributes(), and xDataMisc_getAbsPath().

                                                                                                                                        {

    int status;
    va_list args;

    va_start( args, fmt );
    status = smr_setMessage( smr, userInterface, file, line, code, smr_status_Error, fmt, &args );
    va_end( args );
    return( status );
}

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

Definition at line 79 of file statusMessageReporting.cc.

References smr_status_Info, and status.

Referenced by tpia_map_findTarget(), and tpia_map_toXMLString().

                                                                                                                                       {

    int status;
    va_list args;

    va_start( args, fmt );
    status = smr_setMessage( smr, userInterface, file, line, code, smr_status_Info, fmt, &args );
    va_end( args );
    return( status );
}

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

Definition at line 134 of file statusMessageReporting.cc.

References n, and realloc().

Referenced by smr_allocateFormatMessage(), and tpia_misc_setMessageError_Element().

                                                                   {

    int n, size = 128;
    char *message = NULL;
    va_list args_;

    while( 1 ) {
        if( ( message = (char *) realloc( message, size ) ) == NULL ) return( NULL );
        //TK110426
#if defined WIN32
        args_ = *args;
#elif defined __IBMCPP__
        va_copy( args_, *args );
#else
        __va_copy( args_, *args );
#endif
        n = vsnprintf( message, size, fmt, args_ );
        va_end( args_ );
        if( ( n > -1 ) && ( n < size ) ) break;
        if( n > -1 ) {      /* glibc 2.1 */
            size = n + 3; }
        else {              /* glibc 2.0 */
            size += 128;
        }
    }
    return( message );
}

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

Definition at line 113 of file statusMessageReporting.cc.

References smr_status_Error, and status.

Referenced by tpia_misc_setMessageError_Element().

                                                                                                                                                   {

    int status = smr_setMessage( smr, userInterface, file, line, code, smr_status_Error, fmt, args );
    return( status );
}

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

Definition at line 92 of file statusMessageReporting.cc.

References smr_status_Info, and status.

                                                                                                                                                  {

    int status = smr_setMessage( smr, userInterface, file, line, code, smr_status_Info, fmt, args );
    return( status );
}