liberipc/src/eripctoolbar.c File Reference

#include <stdio.h>
#include <stddef.h>
#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include <unistd.h>
#include "eripc.h"
#include "eripcclient.h"
#include "eripctoolbar.h"
#include "eripcparser.h"

Go to the source code of this file.

Classes
struct	iconMap_t
Functions
int	tbGetIconNumber (void)
const char *	tbGetIconName (int iconID)
int	tbAppendPlatformIcon (erClientChannel_t channel, int uaID, int iconID, int signal)
int	tbSynchronise (erClientChannel_t channel, int uaID, int signal)
int	tbRemovePlatformIcon (erClientChannel_t channel, int uaID, int iconID)
int	tbSetStatePlatformIcon (erClientChannel_t channel, int uaID, int iconID, int iconState)
int	tbDisableUpdate (erClientChannel_t channel, int uaID)
int	tbEnableUpdate (erClientChannel_t channel, int uaID)
int	tbSelectIconSet (erClientChannel_t channel, int uaID)
int	tbClearIconSet (erClientChannel_t channel, int uaID)
int	tbParseCommand (char *szCommand, erIpcCmd_t *pCmd)
int	tbReportIconClicked (erClientChannel_t channel, int signal, int iconID, int iconState)
int	tbReportSynchronised (erClientChannel_t channel, int signal)
Variables
static const iconMap_t	g_icon_map_table []

---

Function Documentation

int tbAppendPlatformIcon	(	erClientChannel_t	channel,
		int	uaID,
		int	iconID,
		int	signal
	)

Append icon with identifier iconID in icon set of application uaID

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	uaID	application identifier
	iconID	icon identifier
	signal	Signal that will be sent to the application when this icon is clicked

Returns:

A value of 0 signals success

Definition at line 143 of file eripctoolbar.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "tbAppendPlatformIcon");
    cmd.cc = (int) ccTbAppendPlatformIcon;
    cmd.nArg = 3;
    sprintf(cmd.arg[0], "%d", uaID);
    sprintf(cmd.arg[1], "%d", iconID);
    sprintf(cmd.arg[2], "%d", signal);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int tbClearIconSet	(	erClientChannel_t	channel,
		int	uaID
	)

Remove all Icons from an Icon set

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	uaID	application identifier

Returns:

A value of 0 signals success

Definition at line 234 of file eripctoolbar.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "tbClearIconSet");
    cmd.cc = (int) ccTbClearIconSet;
    cmd.nArg = 1;
    sprintf(cmd.arg[0], "%d", uaID);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int tbDisableUpdate	(	erClientChannel_t	channel,
		int	uaID
	)

All effective changes to the Icon state are postponed until a call to tbEnableUpdate

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	uaID	application identifier

Returns:

A value of 0 signals success

Definition at line 198 of file eripctoolbar.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "tbDisableUpdate");
    cmd.cc = (int) ccTbDisableUpdate;
    cmd.nArg = 1;
    sprintf(cmd.arg[0], "%d", uaID);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int tbEnableUpdate	(	erClientChannel_t	channel,
		int	uaID
	)

Make all postponed changes to the Icon state effective

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	uaID	application identifier

Returns:

A value of 0 signals success

Definition at line 210 of file eripctoolbar.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "tbEnableUpdate");
    cmd.cc = (int) ccTbEnableUpdate;
    cmd.nArg = 1;
    sprintf(cmd.arg[0], "%d", uaID);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

const char* tbGetIconName

(

int

iconID

)

Definition at line 122 of file eripctoolbar.c.

{
    int         i, nIcons;
    const char* iconName = NULL;
    
    nIcons = tbGetIconNumber();
    if ((iconID >= 0) && (iconID <= nIcons))
    {
        for (i = 0; i < nIcons; i++)
        {
            if (g_icon_map_table[i].iconID == iconID)
            {
                iconName = g_icon_map_table[i].iconName;
                break;
            }
        }
    }

    return iconName;
}

Here is the call graph for this function:

int tbGetIconNumber

(

void

)

Definition at line 115 of file eripctoolbar.c.

{
    int nIcons;
    nIcons = sizeof(g_icon_map_table) / sizeof(g_icon_map_table[0]);
    return nIcons;
}

int tbParseCommand	(	char *	szCommand,
		erIpcCmd_t *	pCmd
	)

Definition at line 252 of file eripctoolbar.c.

{
    int     i;
    char   *pChar;
    int     cmdcode;
    char    szToken[TB_MAXCHARONLINE];
    int     nReqArgs = 0;

    pCmd->cc = (int) ccUndefined;
    for (i = 0; i < TB_N_ARG; i++)
    {
        strcpy(pCmd->arg[i], "");
    }

    // Parse Command
    pChar = szCommand;
    i = 0;
    while (*pChar != '\0')
    {
        szToken[i] = '\0';
        if (*pChar == ',')
        {
            pChar++;
            break;
        }
        szToken[i] = *pChar++;
        i++;
        szToken[i] = '\0';
    }

    // We have found the command Token. Figure out what the command is.
    // TODO: stop doing this hardcoded, rely on a smart datastructure instead.

    if (isdigit(szToken[0]))
    {
        cmdcode = atoi(szToken);
    }
    else
    {
        cmdcode = -1;
    }
    if (strcmp(szToken, "tbAppendPlatformIcon") == 0 || cmdcode == ccTbAppendPlatformIcon)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccTbAppendPlatformIcon;
        nReqArgs = 3;
        pCmd->nArg = 3;
    }
    else if (strcmp(szToken, "tbRemovePlatformIcon") == 0 || cmdcode == ccTbRemovePlatformIcon)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccTbRemovePlatformIcon;
        nReqArgs = 2;
        pCmd->nArg = 2;
    }
    else if (strcmp(szToken, "tbSetStatePlatformIcon") == 0 || cmdcode == ccTbSetStatePlatformIcon)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccTbSetStatePlatformIcon;
        nReqArgs = 3;
        pCmd->nArg = 3;
    }
    else if (strcmp(szToken, "tbDisableUpdate") == 0 || cmdcode == ccTbDisableUpdate)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccTbDisableUpdate;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }
    else if (strcmp(szToken, "tbEnableUpdate") == 0 || cmdcode == ccTbEnableUpdate)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccTbEnableUpdate;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }
    else if (strcmp(szToken, "tbSelectIconSet") == 0 || cmdcode == ccTbSelectIconSet)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccTbSelectIconSet;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }
    else if (strcmp(szToken, "tbClearIconSet") == 0 || cmdcode == ccTbClearIconSet)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccTbClearIconSet;
        nReqArgs = 1;
        pCmd->nArg = 1;
    }
    else if (strcmp(szToken, "tbSynchronise") == 0 || cmdcode == ccTbSynchronise)
    {
        strcpy(pCmd->name, szToken);
        pCmd->cc = (int) ccTbSynchronise;
        nReqArgs = 2;
        pCmd->nArg = 2;
    }
    else
    {
        strcpy(pCmd->name, "Undefined");
        pCmd->cc = (int) ccUndefined;
        fprintf(stderr, "%s: Command %s \n", __FUNCTION__, szToken);
        fprintf(stderr, "Error parsing (%s). Command undefined\n", szCommand);
        pCmd->nArg = -1;
        return -1;
    }

    if (nReqArgs > 0)
    {
        erIpcGetArgs(pChar, pCmd, nReqArgs);
    }
    return 0;
}

Here is the call graph for this function:

int tbRemovePlatformIcon	(	erClientChannel_t	channel,
		int	uaID,
		int	iconID
	)

Remove icon with identifier iconID in icon set of application uaID

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	uaID	application identifier
	iconID	icon identifier

Returns:

A value of 0 signals success

Definition at line 170 of file eripctoolbar.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "tbRemovePlatformIcon");
    cmd.cc = (int) ccTbRemovePlatformIcon;
    cmd.nArg = 2;
    sprintf(cmd.arg[0], "%d", uaID);
    sprintf(cmd.arg[1], "%d", iconID);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int tbReportIconClicked	(	erClientChannel_t	channel,
		int	signal,
		int	iconID,
		int	iconState
	)

Definition at line 368 of file eripctoolbar.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "tbIconClicked");
    cmd.cc = signal;
    cmd.nArg = 2;
    sprintf(cmd.arg[0], "%d", iconID);
    sprintf(cmd.arg[1], "%d", iconState);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int tbReportSynchronised	(	erClientChannel_t	channel,
		int	signal
	)

Definition at line 382 of file eripctoolbar.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "tbSynchronise");
    cmd.cc = signal;
    cmd.nArg = 0;

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int tbSelectIconSet	(	erClientChannel_t	channel,
		int	uaID
	)

Select and display an Icon set

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	uaID	application identifier

Returns:

A value of 0 signals success

Definition at line 222 of file eripctoolbar.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "tbSelectIconSet");
    cmd.cc = (int) ccTbSelectIconSet;
    cmd.nArg = 1;
    sprintf(cmd.arg[0], "%d", uaID);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int tbSetStatePlatformIcon	(	erClientChannel_t	channel,
		int	uaID,
		int	iconID,
		int	iconState
	)

Set state (i.e. bitmap image) for icon with identifier iconID in icon set of application uaID

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	uaID	application identifier
	iconID	icon identifier
	iconState	icon state, i.e. index in bitmap images

Returns:

A value of 0 signals success

Definition at line 184 of file eripctoolbar.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "tbSetStatePlatformIcon");
    cmd.cc = (int) ccTbSetStatePlatformIcon;
    cmd.nArg = 3;
    sprintf(cmd.arg[0], "%d", uaID);
    sprintf(cmd.arg[1], "%d", iconID);
    sprintf(cmd.arg[2], "%d", iconState);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

int tbSynchronise	(	erClientChannel_t	channel,
		int	uaID,
		int	signal
	)

Acknowledge "synchronise" message

Parameters:

	channel	Opaque datastructure that contains info on communication channel
	uaID	application identifier
	signal	Signal that will be sent to the application

Returns:

A value of 0 signals success

Definition at line 157 of file eripctoolbar.c.

{
    erIpcCmd_t cmd;

    strcpy(cmd.name, "tbSynchronise");
    cmd.cc = (int) ccTbSynchronise;
    cmd.nArg = 2;
    sprintf(cmd.arg[0], "%d", uaID);
    sprintf(cmd.arg[1], "%d", signal);

    return erIpcSndCommand(channel, &cmd);
}

Here is the call graph for this function:

---

Variable Documentation

const iconMap_t g_icon_map_table[] [static]

Definition at line 45 of file eripctoolbar.c.