hs-helper.h File Reference

#include <afb/afb-binding.h>
#include <json-c/json.h>

Go to the source code of this file.

Macros
#define	AFB_BINDING_VERSION   3
#define	AFB_EVENT_BAD_REQUEST   100
#define	AFB_REQ_SUBSCRIBE_ERROR   101
#define	AFB_REQ_UNSUBSCRIBE_ERROR   102
#define	AFB_REQ_SHOWNOTIFICATION_ERROR   103
#define	AFB_REQ_SHOWINFORMATION_ERROR   104

Typedefs
typedef enum REQ_ERROR	REQ_ERROR

Enumerations
enum	REQ_ERROR { REQ_FAIL = -1, REQ_OK =0, NOT_NUMBER, OUT_RANGE }

Functions
REQ_ERROR	get_value_uint16 (const afb_req_t request, const char *source, uint16_t *out_id)
REQ_ERROR	get_value_int16 (const afb_req_t request, const char *source, int16_t *out_id)
REQ_ERROR	get_value_int32 (const afb_req_t request, const char *source, int32_t *out_id)
void	hs_add_object_to_json_object (struct json_object *j_obj, int count,...)
void	hs_add_object_to_json_object_str (struct json_object *j_obj, int count,...)
void	hs_add_object_to_json_object_func (struct json_object *j_obj, const char *verb_name, int count,...)
int	hs_search_event_name_index (const char *value)

Variables
const char *	evlist []
const char	_error []
const char	_application_id []
const char	_display_message []
const char	_reply_message []

Macro Definition Documentation

#define AFB_BINDING_VERSION   3

Definition at line 19 of file hs-helper.h.

#define AFB_EVENT_BAD_REQUEST   100

Definition at line 23 of file hs-helper.h.

#define AFB_REQ_SHOWINFORMATION_ERROR   104

Definition at line 27 of file hs-helper.h.

#define AFB_REQ_SHOWNOTIFICATION_ERROR   103

Definition at line 26 of file hs-helper.h.

#define AFB_REQ_SUBSCRIBE_ERROR   101

Definition at line 24 of file hs-helper.h.

#define AFB_REQ_UNSUBSCRIBE_ERROR   102

Definition at line 25 of file hs-helper.h.

Typedef Documentation

typedef enum REQ_ERROR REQ_ERROR

Enumeration Type Documentation

enum REQ_ERROR

Enumerator
REQ_FAIL
REQ_OK
NOT_NUMBER
OUT_RANGE

Definition at line 29 of file hs-helper.h.

{
  REQ_FAIL = -1,
  REQ_OK=0,
  NOT_NUMBER,
  OUT_RANGE
}REQ_ERROR;

Function Documentation

REQ_ERROR get_value_int16	(	const afb_req_t	request,
		const char *	source,
		int16_t *	out_id
	)

get int16 value from source

Parameters

• request : Describes the request by bindings from afb-daemon
• source : input source
• out_id : output int16 value

Return

error code

Definition at line 82 of file hs-helper.cpp.

{
    char* endptr;
    const char* tmp = afb_req_value (request, source);
    if(!tmp)
    {
        return REQ_FAIL;
    }
    long tmp_id = strtol(tmp,&endptr,10);

    /* error check of range */
    if( (tmp_id > INT16_MAX) || (tmp_id < INT16_MIN) )
    {
        return OUT_RANGE;
    }
    if(*endptr != '\0')
    {
        return NOT_NUMBER;
    }

    *out_id = (int16_t)tmp_id;
    return REQ_OK;
}

REQ_ERROR get_value_int32	(	const afb_req_t	request,
		const char *	source,
		int32_t *	out_id
	)

get int32 value from source

Parameters

• request : Describes the request by bindings from afb-daemon
• source : input source
• out_id : output int32 value

Return

error code

Definition at line 118 of file hs-helper.cpp.

{
    char* endptr;
    const char* tmp = afb_req_value (request, source);
    if(!tmp)
    {
        return REQ_FAIL;
    }
    long tmp_id = strtol(tmp,&endptr,10);

    /* error check of range */
    if( (tmp_id > INT32_MAX) || (tmp_id < INT32_MIN) )
    {
        return OUT_RANGE;
    }
    if(*endptr != '\0')
    {
        return NOT_NUMBER;
    }

    *out_id = (int32_t)tmp_id;
    return REQ_OK;
}

REQ_ERROR get_value_uint16	(	const afb_req_t	request,
		const char *	source,
		uint16_t *	out_id
	)

get uint16 value from source

Parameters

• request : Describes the request by bindings from afb-daemon
• source : input source
• out_id : output uint16 value

Return

error code

Definition at line 46 of file hs-helper.cpp.

{
    char* endptr;
    const char* tmp = afb_req_value (request, source);
    if(!tmp)
    {
        return REQ_FAIL;
    }
    long tmp_id = strtol(tmp,&endptr,10);

    /* error check of range */
    if( (tmp_id > UINT16_MAX) || (tmp_id < 0) )
    {
        return OUT_RANGE;
    }
    if(*endptr != '\0')
    {
        return NOT_NUMBER;
    }

    *out_id = (uint16_t)tmp_id;
    return REQ_OK;
}

void hs_add_object_to_json_object	(	struct json_object *	j_obj,
		int	count,
			...
	)

add int object to json object

Parameters

• j_obj : the json object will join in int json object
• count : input parameter number
• ... : parameter list

Return

None

Definition at line 154 of file hs-helper.cpp.

{
    va_list args;
    va_start(args, count);
    for(int i = 0; i < count; ++i )
    {
        char *key = va_arg(args, char*);
        int value = va_arg(args, int);
        json_object_object_add(j_obj, key, json_object_new_int((int32_t)value));
        ++i;
    }
    va_end(args);
}

void hs_add_object_to_json_object_func	(	struct json_object *	j_obj,
		const char *	verb_name,
		int	count,
			...
	)

add new json object to json object

Parameters

• j_obj : the json object will join in new json object
• verb_name : new json object's verb value
• count : input parameter number
• ... : parameter list

Return

None

Definition at line 207 of file hs-helper.cpp.

{
    va_list args;
    va_start(args, count);

    json_object_object_add(j_obj,"verb", json_object_new_string(verb_name));

    for(int i = 0; i < count; ++i )
    {
        char *key = va_arg(args, char*);
        int value = va_arg(args, int);
        json_object_object_add(j_obj, key, json_object_new_int((int32_t)value));
        ++i;
    }
    va_end(args);
}

void hs_add_object_to_json_object_str	(	struct json_object *	j_obj,
		int	count,
			...
	)

add string object to json object

Parameters

• j_obj : the json object will join in string json object
• count : input parameter number
• ... : parameter list

Return

None

Definition at line 180 of file hs-helper.cpp.

{
    va_list args;
    va_start(args, count);
    for(int i = 0; i < count; ++i )
    {
        char *key = va_arg(args, char*);
        char *value = va_arg(args, char*);
        json_object_object_add(j_obj, key, json_object_new_string(value));
        ++i;
    }
    va_end(args);
}

int hs_search_event_name_index

(

const char *

value

)

search event position in event list

Parameters

• value : searched event name

Return

event's index in event list

Definition at line 234 of file hs-helper.cpp.

{
    size_t buf_size = 50;
    size_t size = sizeof evlist / sizeof *evlist;
    int ret = -1;
    for(size_t i = 0 ; i < size ; ++i)
    {
        if(!strncmp(value, evlist[i], buf_size))
        {
            ret = i;
            break;
        }
    }
    return ret;
}

Variable Documentation

const char _application_id[]

Definition at line 28 of file homescreen.cpp.

const char _display_message[]

Definition at line 29 of file homescreen.cpp.

const char _error[]

Definition at line 27 of file homescreen.cpp.

const char _reply_message[]

Definition at line 30 of file homescreen.cpp.

const char* evlist[]

Definition at line 22 of file hs-helper.cpp.