Merge "Cleanup VC-manager internal functions" into tizen

[platform/core/uifw/voice-control.git] / include / voice_control_command_expand.h

diff --git a/include/voice_control_command_expand.h b/include/voice_control_command_expand.h
old mode 100755 (executable)
new mode 100644 (file)
index 62d83ad..ca353e7
--- a/include/voice_control_command_expand.h
+++ b/include/voice_control_command_expand.h
@@ -42,6 +42,12 @@ typedef enum {
        VC_CMD_FORMAT_PARTIAL                   /**< Partial matched command */
 } vc_cmd_format_e;
 
+#define VC_SEARCH_NONE_LEVEL 0
+#define VC_SEARCH_TEXT_LEVEL 1
+#define VC_SEARCH_WORD_LEVEL 2
+#define VC_SEARCH_CHAR_LEVEL 3
+#define VC_SEARCH_PRON_LEVEL 4
+
 /**
 * @brief Sets command domain
 * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@@ -95,22 +101,19 @@ int vc_cmd_get_domain(vc_cmd_h vc_command, int* domain);
 int vc_cmd_list_remove_all(vc_cmd_list_h vc_cmd_list, bool free_command);
 
 /**
-* @brief Retrieves all commands of command list using callback function.
+* @brief Gets the commands list which consists of specific type of commands such as foreground or background.
 * @since_tizen 3.0
-*
-* @param[in] vc_cmd_list The command list handle
-* @param[in] callback Callback function to invoke
-* @param[in] user_data The user data to be passed to the callback function
-*
-* @return 0 on success, otherwise a negative error value
+* @privilege %http://tizen.org/privilege/recorder
+* @param[in] original The original command list handle
+* @param[in] type The command type wants to get
+* @param[out] filtered The filtered command list handle
+* @return @c 0 on success,
+*                otherwise a negative error value
 * @retval #VC_ERROR_NONE Successful
 * @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
+* @retval #VC_ERROR_OPERATION_FAILED Operation failure
 * @retval #VC_ERROR_PERMISSION_DENIED Permission denied
 * @retval #VC_ERROR_NOT_SUPPORTED Not supported
-*
-* @post        This function invokes vc_cmd_list_cb() repeatedly for getting commands.
-*
-* @see vc_cmd_list_cb()
 */
 int vc_cmd_list_filter_by_type(vc_cmd_list_h original, int type, vc_cmd_list_h* filtered);
 
@@ -178,7 +181,7 @@ int vc_cmd_set_unfixed_command(vc_cmd_h vc_command, const char* command);
 int vc_cmd_get_nlu_json(vc_cmd_h vc_cmd, char** json);
 
 /**
-* @brief Gets the datetime value from the setence.
+* @brief Gets the datetime value from the sentence.
 * @since_tizen 3.0
 *
 * @param[in] text The sentence to analyze
@@ -199,12 +202,33 @@ int vc_cmd_get_nlu_json(vc_cmd_h vc_cmd, char** json);
 */
 int vc_cmd_get_datetime(const char *text, time_t *result, char **remain);
 
+/**
+* @brief Gets the commands list of commands similar to the text
+* @since_tizen 4.0
+*
+* @param[in] command The text to find the similar commands
+* @param[in] src_list The command list handle of all registered foreground and widget type commands
+* @param[out] dst_list The commands list handle to similar commands
+* @param[in] search_level The search level selecting depth of algorithm
+*
+* @remark This function can modify @a src_list by the result, So if you want to keep the content of @a src_list,
+*      make a copy of @a src_list before running this function. And also, you need to create the list handle of
+*      @a dst_list before running this function, because this function does not create the handle internally.
+*
+* @return 0 on success, otherwise a negative error value
+* @retval #VC_ERROR_NONE Successful
+* @retval #VC_ERROR_OPERATION_FAILED operation failure
+* @retval #VC_ERROR_OUT_OF_MEMORY Not enough memory
+* @retval #VC_ERROR_INVALID_PARAMETER Invalid parameter
+*/
+int vc_cmd_get_partially_matched_cmd_list(const char *command, vc_cmd_list_h src_list, vc_cmd_list_h dst_list, int search_level);
+
 #ifdef __cplusplus
 }
 #endif
 
 /**
- * @}@}
+ * @}
  */
 
 #endif /* __VOICE_CONTROL_COMMAND_EXPAND_H__ */