Debug

Macros
#define	dbgprintf

Typedefs
typedef struct _GSM_Debug_Info	GSM_Debug_Info

Functions
int	smprintf_level (GSM_StateMachine *s, GSM_DebugSeverity severity, const char *format,...)
GSM_Error	GSM_SetDebugFunction (GSM_Log_Function info, void *data, GSM_Debug_Info *privdi)
GSM_Error	GSM_SetDebugFile (const char *info, GSM_Debug_Info *privdi)
GSM_Error	GSM_SetDebugFileDescriptor (FILE *fd, gboolean closable, GSM_Debug_Info *privdi)
GSM_Debug_Info *	GSM_GetGlobalDebug (void)
gboolean	GSM_SetDebugLevel (const char *info, GSM_Debug_Info *privdi)
gboolean	GSM_SetDebugCoding (const char *info, GSM_Debug_Info *privdi)
gboolean	GSM_SetDebugGlobal (gboolean info, GSM_Debug_Info *privdi)
void	GSM_LogError (GSM_StateMachine *s, const char *message, const GSM_Error err)
int	smprintf (GSM_StateMachine *s, const char *format,...)

Detailed Description

Debuging handling.

Macro Definition Documentation

dbgprintf

#define dbgprintf

Prints string to global debug log.

Parameters

format

Format string as for printf.

Returns

Upon successful return, these functions return the number of characters printed (as printf).

Definition at line 72 of file debug.h.

Referenced by Binary2RTTL(), Bitmap2BMP(), BMP2Bitmap(), DecodeXMLUTF8(), Fill_Time_T(), GetLineString(), GetTimeDifference(), GSM_DecodeMMSIndication(), GSM_DecodeNokiaRTTLRingtone(), GSM_DecodeVCARD(), GSM_EncodeEMSSound(), GSM_JADFindData(), GSM_ReadFile(), GSM_ReadRingtoneFile(), GSM_SaveRingtoneRttl(), GSM_SetDebugFile(), GSM_TryReadGammuRC(), loadbin(), loadgif(), loadmmf(), loadnlm(), loadnolngg(), loadnsl(), loadpuremidi(), loadre(), loadrttl(), proxy_connect(), ReadVCALDate(), ReadVCALDateTime(), ReadVCALInt(), and ReadVCALText().

Typedef Documentation

GSM_Debug_Info

typedef struct _GSM_Debug_Info GSM_Debug_Info

Debugging configuration.

Definition at line 28 of file gammu-debug.h.

Function Documentation

GSM_GetGlobalDebug()

GSM_Debug_Info* GSM_GetGlobalDebug

(

void

)

Returns global debug settings.

Returns

Pointer to global settings.

Definition at line 216 of file gsmcomon.c.

References GSM_global_debug.

{
        return &GSM_global_debug;
}

GSM_LogError()

void GSM_LogError	(	GSM_StateMachine *	s,
		const char *	message,
		const GSM_Error	err
	)

Logs error to debug log with additional message.

Parameters

s	State machine structure pointer.
message	String to be show in message.
err	Error code.

Definition at line 221 of file gsmcomon.c.

References ERR_NONE, GSM_ErrorName(), GSM_ErrorString(), and smprintf().

Referenced by GSM_InitConnection_Log().

                                                                                   {
        if (err != ERR_NONE) {
                smprintf(s, "%s failed with error %s[%d]: %s\n", message,
                                GSM_ErrorName(err), err,
                                GSM_ErrorString(err));
        }
}

GSM_SetDebugCoding()

gboolean GSM_SetDebugCoding	(	const char *	info,
		GSM_Debug_Info *	privdi
	)

Sets debug encoding.

Parameters

info	Encoding to set.
privdi	Pointer to debug information data.

Returns

True on success.

Definition at line 227 of file debug.c.

References _GSM_Debug_Info::coding, and TRUE.

{
        privdi->coding = info;
        return TRUE;
}

GSM_SetDebugFile()

GSM_Error GSM_SetDebugFile	(	const char *	info,
		GSM_Debug_Info *	privdi
	)

Sets debug file.

Parameters

info	File path.
privdi	Pointer to debug information data.

Returns

Error code.

Definition at line 144 of file debug.c.

References COMMIT_FLAG, dbgprintf, _GSM_Debug_Info::dl, DL_BINARY, DL_TEXTERROR, DL_TEXTERRORDATE, ERR_CANTOPENFILE, FALSE, GSM_SetDebugFileDescriptor(), and TRUE.

Referenced by GSM_InitConnection_Log().

{
        FILE *testfile;

        if (info == NULL || strlen(info) == 0) {
                return GSM_SetDebugFileDescriptor(NULL, FALSE, privdi);
        }

        switch (privdi->dl) {
                case DL_BINARY:
                        testfile = fopen(info,"wb" COMMIT_FLAG);
                        break;
                case DL_TEXTERROR:
                case DL_TEXTERRORDATE:
                        testfile = fopen(info,"a" COMMIT_FLAG);
                        if (testfile != NULL) {
                                fseek(testfile, 0, SEEK_END);
                                if (ftell(testfile) > 5000000) {
                                        fclose(testfile);
                                        testfile = fopen(info,"w" COMMIT_FLAG);
                                }
                        }
                        break;
                default:
                        testfile = fopen(info,"w" COMMIT_FLAG);
        }

        if (testfile == NULL) {
                dbgprintf(privdi, "Can't open debug file\n");
                return ERR_CANTOPENFILE;
        } else {
                return GSM_SetDebugFileDescriptor(testfile, TRUE, privdi);
        }
}

GSM_SetDebugFileDescriptor()

GSM_Error GSM_SetDebugFileDescriptor	(	FILE *	fd,
		gboolean	closable,
		GSM_Debug_Info *	privdi
	)

Sets debug file.

Parameters

fd	File descriptor.
privdi	Pointer to debug information data.
closable	Whether Gammu can close the file when it is no longer needed for debug output. Please note that stderr or stdout are never closed.

Returns

Error code.

Definition at line 127 of file debug.c.

References _GSM_Debug_Info::closable, _GSM_Debug_Info::df, ERR_NONE, TRUE, and _GSM_Debug_Info::was_lf.

Referenced by GSM_SetDebugFile(), and GSM_TerminateConnection().

{
        privdi->was_lf = TRUE;

        if (privdi->df != NULL
                        && fileno(privdi->df) != fileno(stderr)
                        && fileno(privdi->df) != fileno(stdout)
                        && privdi->closable) {
                fclose(privdi->df);
        }

        privdi->df = fd;
        privdi->closable = closable;

        return ERR_NONE;
}

GSM_SetDebugFunction()

GSM_Error GSM_SetDebugFunction	(	GSM_Log_Function	info,
		void *	data,
		GSM_Debug_Info *	privdi
	)

Sets logging function.

Parameters

info	Function to call.
data	User data to pass as a second parameter to callback.
privdi	Pointer to debug information data.

Returns

Error code.

Definition at line 179 of file debug.c.

References ERR_NONE, _GSM_Debug_Info::log_function, and _GSM_Debug_Info::user_data.

Referenced by GSM_InitConnection_Log().

{
        privdi->log_function = info;
        privdi->user_data = data;
        return ERR_NONE;
}

GSM_SetDebugGlobal()

gboolean GSM_SetDebugGlobal	(	gboolean	info,
		GSM_Debug_Info *	privdi
	)

Enables using of global debugging configuration. Makes no effect on global debug configuration.

Parameters

info	Enable global debug usage..
privdi	Pointer to debug information data.

Returns

True on success.

Definition at line 233 of file debug.c.

References PRINTF_STYLE, TRUE, and _GSM_Debug_Info::use_global.

{
        privdi->use_global = info;
        return TRUE;
}

GSM_SetDebugLevel()

gboolean GSM_SetDebugLevel	(	const char *	info,
		GSM_Debug_Info *	privdi
	)

Sets debug level.

Parameters

info	Level as text.
privdi	Pointer to debug information data.

Returns

True on success.

Definition at line 186 of file debug.c.

References _GSM_Debug_Info::dl, DL_BINARY, DL_NONE, DL_TEXT, DL_TEXTALL, DL_TEXTALLDATE, DL_TEXTDATE, DL_TEXTERROR, DL_TEXTERRORDATE, FALSE, and TRUE.

Referenced by GSM_InitConnection_Log().

{
        if (info == NULL) {
                privdi->dl = DL_NONE;
                return TRUE;
        }
        if (strcasecmp(info, "nothing") == 0) {
                privdi->dl = DL_NONE;
                return TRUE;
        }
        if (strcasecmp(info, "text") == 0) {
                privdi->dl = DL_TEXT;
                return TRUE;
        }
        if (strcasecmp(info, "textall") == 0) {
                privdi->dl = DL_TEXTALL;
                return TRUE;
        }
        if (strcasecmp(info, "binary") == 0) {
                privdi->dl = DL_BINARY;
                return TRUE;
        }
        if (strcasecmp(info, "errors") == 0) {
                privdi->dl = DL_TEXTERROR;
                return TRUE;
        }
        if (strcasecmp(info, "textdate") == 0) {
                privdi->dl = DL_TEXTDATE;
                return TRUE;
        }
        if (strcasecmp(info, "textalldate") == 0) {
                privdi->dl = DL_TEXTALLDATE;
                return TRUE;
        }
        if (strcasecmp(info, "errorsdate") == 0) {
                privdi->dl = DL_TEXTERRORDATE;
                return TRUE;
        }
        return FALSE;
}

smprintf()

int smprintf	(	GSM_StateMachine *	s,
		const char *	format,
			...
	)

Prints string to defined debug log.

Parameters

s	State machine, where to print.
format	Format string as for printf.

Returns

Upon successful return, these functions return the number of characters printed (as printf).

Definition at line 261 of file debug.c.

References dbg_vprintf(), GSM_GetDI(), and PRINTF_STYLE.

Referenced by DUMMY_DeleteFolder(), DUMMY_Error(), DUMMY_GetFolderListing(), DUMMY_GetNextFileFolder(), DUMMY_Initialise(), DUMMY_PreAPICall(), DUMMY_SendSMS(), GSM_CloseConnection(), GSM_CreateFirmwareNumber(), GSM_DispatchMessage(), GSM_DumpMessageBinary_Custom(), GSM_DumpMessageText_Custom(), GSM_InitConnection_Log(), GSM_LogError(), GSM_OSErrorInfo(), GSM_RegisterAllConnections(), GSM_RegisterAllPhoneModules(), GSM_RegisterModule(), GSM_SendSavedSMS(), GSM_TerminateConnection(), GSM_TryGetModel(), lock_device(), N71_65_DecodePhonebook(), N71_65_EncodePhonebookFrame(), N71_65_PackPBKBlock(), N71_65_PB_CopyString(), NOKIA_DecodeDateTime(), NOKIA_EncodeDateTime(), NoneReply(), PHONE_EncodeSMSFrame(), PHONE_FindDataFile(), proxy_write(), and unlock_device().

{
        va_list         argp;
        int             result=0;
        GSM_Debug_Info *curdi;

        curdi = GSM_GetDI(s);

        va_start(argp, format);

        result = dbg_vprintf(curdi, format, argp);

        va_end(argp);
        return result;
}

smprintf_level()

int smprintf_level	(	GSM_StateMachine *	s,
		GSM_DebugSeverity	severity,
		const char *	format,
			...
	)

Prints string to defined debug log.

Parameters

s	State machine, where to print.
severity	Severity of printed message.
format	Format string as for printf.

Returns

Upon successful return, these functions return the number of characters printed (as printf).

Definition at line 278 of file debug.c.

References D_ERROR, D_TEXT, dbg_vprintf(), _GSM_Debug_Info::dl, DL_TEXT, DL_TEXTALL, DL_TEXTALLDATE, DL_TEXTDATE, DL_TEXTERROR, DL_TEXTERRORDATE, and GSM_GetDI().

Referenced by GSM_DispatchMessage(), GSM_InitConnection_Log(), GSM_WaitFor(), and NOKIA_EncodeDateTime().

{
        va_list         argp;
        int             result=0;
        GSM_Debug_Info *curdi;

        curdi = GSM_GetDI(s);

        if (severity == D_TEXT) {
                if (curdi->dl != DL_TEXT &&
                                curdi->dl != DL_TEXTALL &&
                                curdi->dl != DL_TEXTDATE &&
                                curdi->dl != DL_TEXTALLDATE) {
                        return 0;
                }
        } else if (severity == D_ERROR) {
                if (curdi->dl != DL_TEXT &&
                                curdi->dl != DL_TEXTALL &&
                                curdi->dl != DL_TEXTDATE &&
                                curdi->dl != DL_TEXTALLDATE &&
                                curdi->dl != DL_TEXTERROR &&
                                curdi->dl != DL_TEXTERRORDATE) {
                        return 0;
                }
        }
        va_start(argp, format);

        result = dbg_vprintf(curdi, format, argp);

        va_end(argp);
        return result;
}