diff options
| -rw-r--r-- | src/homescreen.cpp | 47 | ||||
| -rw-r--r-- | src/hs-helper.cpp | 85 |
2 files changed, 120 insertions, 12 deletions
diff --git a/src/homescreen.cpp b/src/homescreen.cpp index 85ea99f..5de15b8 100644 --- a/src/homescreen.cpp +++ b/src/homescreen.cpp @@ -57,13 +57,13 @@ static void pingSample(struct afb_req request) /** * tap_shortcut notify for homescreen * When Shortcut area is tapped, notify these applciations - * + * * #### Parameters * Request key * - application_name : application name * * #### Return - * Nothing + * None * */ static void tap_shortcut (struct afb_req request) @@ -100,7 +100,7 @@ static void tap_shortcut (struct afb_req request) * - display_message : message for display * * #### Return - * Nothing + * None * */ static void on_screen_message (struct afb_req request) @@ -137,7 +137,7 @@ static void on_screen_message (struct afb_req request) * - reply_message : message for reply * * #### Return - * Nothing + * None * */ static void on_screen_reply (struct afb_req request) @@ -173,9 +173,7 @@ static void on_screen_reply (struct afb_req request) * - event : Event name. Event list is written in libhomescreen.cpp * * #### Return - * Nothing - * - * #### Note + * None * */ static void subscribe(struct afb_req request) @@ -213,9 +211,7 @@ static void subscribe(struct afb_req request) * - event : Event name. Event list is written in libhomescreen.cpp * * #### Return - * Nothing - * - * #### Note + * None * */ static void unsubscribe(struct afb_req request) @@ -260,12 +256,32 @@ static const struct afb_verb_v2 verbs[]= { {NULL } /* marker for end of the array */ }; +/** + * homescreen binding preinit function + * + * #### Parameters + * - null + * + * #### Return + * None + * + */ static int preinit() { HMI_NOTICE("homescreen-service","binding preinit (was register)"); return 0; } +/** + * homescreen binding init function + * + * #### Parameters + * - null + * + * #### Return + * None + * + */ static int init() { HMI_NOTICE("homescreen-service","binding init"); @@ -290,6 +306,17 @@ static int init() return 0; } +/** + * homescreen binding event function + * + * #### Parameters + * - event : event name + * - object : event json object + * + * #### Return + * None + * + */ static void onevent(const char *event, struct json_object *object) { HMI_NOTICE("homescreen-service","on_event %s", event); diff --git a/src/hs-helper.cpp b/src/hs-helper.cpp index 452ae24..a599fdd 100644 --- a/src/hs-helper.cpp +++ b/src/hs-helper.cpp @@ -26,7 +26,18 @@ const char* evlist[] = { "reserved" }; - +/** + * 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 + * + */ REQ_ERROR get_value_uint16(const struct afb_req request, const char *source, uint16_t *out_id) { char* endptr; @@ -51,6 +62,18 @@ REQ_ERROR get_value_uint16(const struct afb_req request, const char *source, uin return REQ_OK; } +/** + * 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 + * + */ REQ_ERROR get_value_int16(const struct afb_req request, const char *source, int16_t *out_id) { char* endptr; @@ -75,6 +98,18 @@ REQ_ERROR get_value_int16(const struct afb_req request, const char *source, int1 return REQ_OK; } +/** + * 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 + * + */ REQ_ERROR get_value_int32(const struct afb_req request, const char *source, int32_t *out_id) { char* endptr; @@ -99,6 +134,18 @@ REQ_ERROR get_value_int32(const struct afb_req request, const char *source, int3 return REQ_OK; } +/** + * 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 + * + */ void hs_add_object_to_json_object(struct json_object* j_obj, int count,...) { va_list args; @@ -113,6 +160,18 @@ void hs_add_object_to_json_object(struct json_object* j_obj, int count,...) va_end(args); } +/** + * 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 + * + */ void hs_add_object_to_json_object_str(struct json_object* j_obj, int count,...) { va_list args; @@ -127,7 +186,19 @@ void hs_add_object_to_json_object_str(struct json_object* j_obj, int count,...) va_end(args); } - +/** + * 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 + * + */ void hs_add_object_to_json_object_func(struct json_object* j_obj, const char* verb_name, int count, ...) { va_list args; @@ -145,6 +216,16 @@ void hs_add_object_to_json_object_func(struct json_object* j_obj, const char* ve va_end(args); } +/** + * search event position in event list + * + * #### Parameters + * - value : searched event name + * + * #### Return + * event's index in event list + * + */ int hs_search_event_name_index(const char* value) { size_t buf_size = 50; |