gammu-misc.h File Reference

#include <stdio.h>
#include <gammu-file.h>
#include <gammu-config.h>
#include <unistd.h>

Include dependency graph for gammu-misc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	MAX(a, b)   ((a)>(b) ? (a) : (b))
#define	MIN(a, b)   ((a)<(b) ? (a) : (b))
#define	GSM_GNUC_PREREQ(maj, min)   0
#define	PRINTF_STYLE(f, a)
#define	SCANF_STYLE(f, a)
#define	WARNUNUSED
#define	UNUSED
#define	NORETURN
#define	__FUNCTION__WORKING

Functions
size_t	GetLine (FILE *File, char *Line, int count)
const char *	GetGammuVersion (void)
const char *	GetCompiler (void)
const char *	GetOS (void)
const char *	GetGammuLocalePath (void)
void	GSM_InitLocales (const char *path)
void	EncodeHexBin (char *dest, const unsigned char *src, size_t len)
gboolean	GSM_IsNewerVersion (const char *latest_version, const char *current_version)
GSM_Error	GSM_SetPower (GSM_StateMachine *s, gboolean on)

Detailed Description

Author

Michal Čihař

Miscellaneous helper functions.

Definition in file gammu-misc.h.

Macro Definition Documentation

__FUNCTION__WORKING

#define __FUNCTION__WORKING

Definition at line 128 of file gammu-misc.h.

GSM_GNUC_PREREQ

#define GSM_GNUC_PREREQ	(		maj,
			min
	)		0

Definition at line 84 of file gammu-misc.h.

MAX

#define MAX	(		a,
			b
	)		((a)>(b) ? (a) : (b))

Definition at line 68 of file gammu-misc.h.

Referenced by PHONE_FindDataFile().

MIN

#define MIN	(		a,
			b
	)		((a)<(b) ? (a) : (b))

Definition at line 70 of file gammu-misc.h.

Referenced by GSM_EncodeSMSFrameText(), N71_65_EncodePhonebookFrame(), and VC_StoreBase64().

NORETURN

#define NORETURN

Definition at line 111 of file gammu-misc.h.

PRINTF_STYLE

#define PRINTF_STYLE	(		f,
			a
	)

Definition at line 92 of file gammu-misc.h.

Referenced by dbg_write(), GSM_IdentifyFileFormat(), GSM_SetDebugGlobal(), smfprintf(), smprintf(), and VC_StoreLine().

SCANF_STYLE

#define SCANF_STYLE	(		f,
			a
	)

Definition at line 93 of file gammu-misc.h.

UNUSED

#define UNUSED

Definition at line 105 of file gammu-misc.h.

Referenced by NOKIA_EncodeDateTime().

WARNUNUSED

#define WARNUNUSED

Definition at line 99 of file gammu-misc.h.

Function Documentation

EncodeHexBin()

void EncodeHexBin	(	char *	dest,
		const unsigned char *	src,
		size_t	len
	)

Encodes text to hexadecimal binary representation.

Definition at line 426 of file coding.c.

References EncodeWithHexBinAlphabet().

Referenced by EncodeHexUnicode().

{
        size_t i, outpos = 0;

        for (i = 0; i < len; i++) {
                dest[outpos++] = EncodeWithHexBinAlphabet(src[i] >> 4);
                dest[outpos++] = EncodeWithHexBinAlphabet(src[i] & 0xF);
        }
        dest[outpos] = 0;
}

GetCompiler()

const char* GetCompiler

(

void

)

Gets compiler which was used to compile Gammu library.

Definition at line 659 of file misc.c.

{
        static char Buffer[100] = {0x00};

        /* Value was already calculated */
        if (Buffer[0] != 0) return Buffer;

#ifdef _MSC_VER
        if (_MSC_VER == 1200) { /* ? */
                snprintf(Buffer, sizeof(Buffer) - 1, "MS VC 6.0");
        } else if (_MSC_VER == 1300) {
                snprintf(Buffer, sizeof(Buffer) - 1, "MS VC .NET 2002");
        } else if (_MSC_VER == 1310) {
                snprintf(Buffer, sizeof(Buffer) - 1, "MS VC .NET 2003");
        } else if (_MSC_VER == 1400) {
                snprintf(Buffer, sizeof(Buffer) - 1, "MS VC .NET 2005");
        } else {
                snprintf(Buffer, sizeof(Buffer) - 1, "MS VC %i",_MSC_VER);
        }
#elif defined(__BORLANDC__)
        snprintf(Buffer, sizeof(Buffer) - 1, "Borland C++ %i",__BORLANDC__);
#elif defined(__MINGW32__)
        snprintf(Buffer, sizeof(Buffer) - 1, "GCC %i.%i, MinGW %i.%i", __GNUC__, __GNUC_MINOR__, __MINGW32_MAJOR_VERSION, __MINGW32_MINOR_VERSION);
#elif defined(__CYGWIN__)
        snprintf(Buffer, sizeof(Buffer) - 1, "GCC %i.%i, Cygwin %i.%i", __GNUC__, __GNUC_MINOR__, CYGWIN_VERSION_DLL_MAJOR, CYGWIN_VERSION_DLL_MINOR);
#elif defined(__GNUC__)
        snprintf(Buffer, sizeof(Buffer) - 1, "GCC %i.%i", __GNUC__, __GNUC_MINOR__);
#elif defined(DJGPP)
        snprintf(Buffer, sizeof(Buffer) - 1, "djgpp %d.%d", __DJGPP, __DJGPP_MINOR);
#elif defined(__SUNPRO_CC)
        snprintf(Buffer, sizeof(Buffer) - 1, "Sun C++ %x", __SUNPRO_CC);
#elif defined(__INTEL_COMPILER)
        snprintf(Buffer, sizeof(Buffer) - 1, "Intel Compiler %ld", __INTEL_COMPILER);
#else
        snprintf(Buffer, sizeof(Buffer) - 1, "unknown compiler");
#endif

        return Buffer;
}

GetGammuLocalePath()

const char* GetGammuLocalePath

(

void

)

Returns path to Gammu locales.

Definition at line 200 of file gsmcomon.c.

References LOCALE_PATH.

{
#ifdef LOCALE_PATH
        static const char Buffer[] = LOCALE_PATH;
        return Buffer;
#else
        return NULL;
#endif
}

GetGammuVersion()

const char* GetGammuVersion

(

void

)

Gets Gammu library version.

Definition at line 210 of file gsmcomon.c.

References GAMMU_VERSION.

{
        static const char Buffer[] = GAMMU_VERSION;
        return Buffer;
}

GetLine()

size_t GetLine	(	FILE *	File,
		char *	Line,
		int	count
	)

Reads single line from file.

Parameters

File	File descriptor to read from.
Line	Buffer where t ostore result.
count	Maximal length of text which can be stored in buffer.

Returns

Length of read line, -1 on error.

Definition at line 370 of file misc.c.

{
        int num;

        if (fgets(Line, count, File) != NULL) {
                num = strlen(Line) - 1;
                while (num > 0) {
                        if (Line[num] != '\n' && Line[num] != '\r') break;
                        Line[num--] = '\0';
                }
                return strlen(Line);
        }
        return -1;
}

GetOS()

const char* GetOS

(

void

)

Gets host OS.

Definition at line 537 of file misc.c.

References FALSE, and TRUE.

Referenced by GSM_InitConnection_Log().

{
#ifdef WIN32
        OSVERSIONINFOEX Ver;
        gboolean                Extended = TRUE;
#else
#  ifdef HAVE_SYS_UTSNAME_H
        struct utsname  Ver;
#  endif
#endif
        static char     Buffer[100] = {0x00};

        /* Value was already calculated */
        if (Buffer[0] != 0) return Buffer;

#ifdef WIN32
        memset(&Ver,0,sizeof(OSVERSIONINFOEX));
        Ver.dwOSVersionInfoSize = sizeof(OSVERSIONINFOEX);

        if (!GetVersionEx((OSVERSIONINFO *)&Ver)) {
                Extended                = FALSE;
                Ver.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
                if (!GetVersionEx((OSVERSIONINFO *)&Ver)) {
                        snprintf(Buffer, sizeof(Buffer) - 1, "Windows");
                        return Buffer;
                }
        }

        /* ----------------- 9x family ------------------ */

        /* no info about Win95 SP1, Win95 OSR2.1, Win95 OSR2.5.... */
        if (Ver.dwMajorVersion == 4 && Ver.dwMinorVersion == 0 && Ver.dwBuildNumber == 950) {
                snprintf(Buffer, sizeof(Buffer) - 1, "Windows 95");
        } else if (Ver.dwMajorVersion == 4 && Ver.dwMinorVersion == 0 && Ver.dwBuildNumber == 1111) {
                snprintf(Buffer, sizeof(Buffer) - 1, "Windows 95 OSR2.x");

        /* no info about Win98 SP1.... */
        } else if (Ver.dwMajorVersion == 4 && Ver.dwMinorVersion == 10 && Ver.dwBuildNumber == 1998) {
                snprintf(Buffer, sizeof(Buffer) - 1, "Windows 98");
        } else if (Ver.dwMajorVersion == 4 && Ver.dwMinorVersion == 10 && Ver.dwBuildNumber == 2222) {
                snprintf(Buffer, sizeof(Buffer) - 1, "Windows 98 SE");

        } else if (Ver.dwMajorVersion == 4 && Ver.dwMinorVersion == 90 && Ver.dwBuildNumber == 3000) {
                snprintf(Buffer, sizeof(Buffer) - 1, "Windows ME");

        /* ---------------- NT family ------------------- */

        } else if (Ver.dwMajorVersion == 4 && Ver.dwMinorVersion == 0 && Ver.dwBuildNumber == 1381) {
                snprintf(Buffer, sizeof(Buffer) - 1, "Windows NT 4.0");

        } else if (Ver.dwMajorVersion == 5 && Ver.dwMinorVersion == 0 && Ver.dwBuildNumber == 2195) {
                snprintf(Buffer, sizeof(Buffer) - 1, "Windows 2000");

        } else if (Ver.dwMajorVersion == 5 && Ver.dwMinorVersion == 1 && Ver.dwBuildNumber == 2600) {
                snprintf(Buffer, sizeof(Buffer) - 1, "Windows XP");
#if _MSC_VER > 1200 /* 6.0 has it undeclared */
                if (Extended) {
                        if (Ver.wSuiteMask & VER_SUITE_PERSONAL) {
                                snprintf(Buffer+strlen(Buffer), sizeof(Buffer) - 1 - strlen(Buffer)," Home");
                        } else {
                                snprintf(Buffer+strlen(Buffer), sizeof(Buffer) - 1 - strlen(Buffer)," Pro");
                        }
                }
#endif

        } else if (Ver.dwMajorVersion == 5 && Ver.dwMinorVersion == 2) {
                snprintf(Buffer, sizeof(Buffer) - 1, "Windows 2003");

        } else if (Ver.dwMajorVersion == 6 && Ver.dwMinorVersion == 0) {
                snprintf(Buffer, sizeof(Buffer) - 1, "Windows Vista");

        } else if (Ver.dwMajorVersion == 6 && Ver.dwMinorVersion > 0) {
                snprintf(Buffer, sizeof(Buffer) - 1, "Windows Server 2007");

        } else {
                snprintf(Buffer, sizeof(Buffer) - 1, "Windows %i.%i.%i",(int)Ver.dwMajorVersion,(int)Ver.dwMinorVersion,(int)Ver.dwBuildNumber);
        }

        if (Extended && Ver.wServicePackMajor != 0) {
                snprintf(Buffer+strlen(Buffer), sizeof(Buffer) - 1 - strlen(Buffer)," SP%i",Ver.wServicePackMajor);
        }
#elif defined(HAVE_SYS_UTSNAME_H)
        uname(&Ver);
        snprintf(Buffer, sizeof(Buffer) - 1, "%s, kernel %s (%s)", Ver.sysname, Ver.release, Ver.version);
#elif defined(__FreeBSD__)
        snprintf(Buffer, sizeof(Buffer) - 1, "FreeBSD");
#elif defined(__NetBSD__)
        snprintf(Buffer, sizeof(Buffer) - 1, "NetBSD");
#elif defined(__OpenBSD__)
        snprintf(Buffer, sizeof(Buffer) - 1, "OpenBSD");
#elif defined(__GNU__)
        snprintf(Buffer, sizeof(Buffer) - 1, "GNU/Hurd");
#elif defined(sun) || defined(__sun) || defined(__sun__)
#  ifdef __SVR4
        snprintf(Buffer, sizeof(Buffer) - 1, "Sun Solaris");
#  else
        snprintf(Buffer, sizeof(Buffer) - 1, "SunOS");
#  endif
#elif defined(hpux) || defined(__hpux) || defined(__hpux__)
        snprintf(Buffer, sizeof(Buffer) - 1, "HP-UX");
#elif defined(ultrix) || defined(__ultrix) || defined(__ultrix__)
        snprintf(Buffer, sizeof(Buffer) - 1, "DEC Ultrix");
#elif defined(sgi) || defined(__sgi)
        snprintf(Buffer, sizeof(Buffer) - 1, "SGI Irix");
#elif defined(__osf__)
        snprintf(Buffer, sizeof(Buffer) - 1, "OSF Unix");
#elif defined(bsdi) || defined(__bsdi__)
        snprintf(Buffer, sizeof(Buffer) - 1, "BSDI Unix");
#elif defined(_AIX)
        snprintf(Buffer, sizeof(Buffer) - 1, "AIX Unix");
#elif defined(_UNIXWARE)
        snprintf(Buffer, sizeof(Buffer) - 1, "SCO Unixware");
#elif defined(DGUX)
        snprintf(Buffer, sizeof(Buffer) - 1, "DG Unix");
#elif defined(__QNX__)
        snprintf(Buffer, sizeof(Buffer) - 1, "QNX");
#else
        snprintf(Buffer, sizeof(Buffer) - 1, "unknown OS");
#endif
        return Buffer;
}

GSM_InitLocales()

void GSM_InitLocales

(

const char *

path

)

Initializes locales. This sets up things needed for proper string conversion from local charset as well as initializes gettext based translation.

Parameters

path	Path to gettext translation. If NULL compiled in default is used.

GSM_IsNewerVersion()

gboolean GSM_IsNewerVersion	(	const char *	latest_version,
		const char *	current_version
	)

Returns TRUE if firmware version is newer.

Parameters

latest_version	String containing version (eg. latest available).
current_version	String containing version (eg. current one).

Returns

True if latest_version > current_version.

Definition at line 699 of file misc.c.

References FALSE, and TRUE.

{
        size_t i;
        size_t len = strlen(latest_version);

        for (i = 0; i < len ; i++) {
                if (latest_version[i] > current_version[i]) {
                        return TRUE;
                }
        }

        return FALSE;
}

GSM_SetPower()

GSM_Error GSM_SetPower	(	GSM_StateMachine *	s,
		gboolean	on
	)

Set Power On/Off the phone

Parameters

s	State machine pointer.
on	TRUE to power on the phone, FALSE to power off

Returns

Error code.

Power on/off the phone.

Definition at line 307 of file api.c.

References CHECK_PHONE_CONNECTION, GSM_Phone::Functions, _GSM_StateMachine::Phone, PRINT_LOG_ERROR, and GSM_Phone_Functions::SetPower.

{
        GSM_Error err;

        CHECK_PHONE_CONNECTION();

        err = s->Phone.Functions->SetPower(s, on);
        PRINT_LOG_ERROR(err);
        return err;
}