ncurses: densify HandleKey()

[vlc] / include / vlc_services_discovery.h

diff --git a/include/vlc_services_discovery.h b/include/vlc_services_discovery.h
index 956b77b65f943f9660858ebc07d51a9e27daea36..0b8b329bf37f4e81e805fa89bc39e996baab1d5d 100644 (file)
--- a/include/vlc_services_discovery.h
+++ b/include/vlc_services_discovery.h
@@ -51,9 +51,14 @@ struct services_discovery_t
     char *psz_name;
     config_chain_t *p_cfg;
 
+    int ( *pf_control ) ( services_discovery_t *, int, va_list );
+
     services_discovery_sys_t *p_sys;
 };
 
+/**
+ * Service discovery categories
+ */
 enum services_discovery_category_e
 {
     SD_CAT_DEVICES = 1,
@@ -62,18 +67,61 @@ enum services_discovery_category_e
     SD_CAT_MYCOMPUTER
 };
 
+/**
+ * Service discovery control commands
+ */
+enum services_discovery_command_e
+{
+    SD_CMD_SEARCH = 1,          /**< arg1 = query */
+    SD_CMD_CAPABILITIES         /**< arg1 = services_discovery_descriptor_t* */
+};
+
+/**
+ * Service discovery capabilities
+ */
+enum services_discovery_capability_e
+{
+    SD_CAP_SEARCH = 1
+};
+
+/**
+ * Service discovery descriptor
+ */
+typedef struct
+{
+    char *psz_short_desc;
+    char *psz_icon_url;
+    char *psz_url;
+    int   i_capabilities;
+} services_discovery_descriptor_t;
+
 /***********************************************************************
  * Service Discovery
  ***********************************************************************/
 
+/**
+ * Ask for a research in the SD
+ * @param p_sd: the Service Discovery
+ * @param i_control: the command to issue
+ * @param args: the argument list
+ * @return VLC_SUCCESS in case of success, the error code overwise
+ */
+static inline int vlc_sd_control( services_discovery_t *p_sd, int i_control, va_list args )
+{
+    if( p_sd->pf_control )
+        return p_sd->pf_control( p_sd, i_control, args );
+    else
+        return VLC_EGENERIC;
+}
+
 /* Get the services discovery modules names to use in Create(), in a null
  * terminated string array. Array and string must be freed after use. */
-VLC_EXPORT( char **, vlc_sd_GetNames, ( vlc_object_t *, char ***, int ** ) );
+VLC_EXPORT( char **, vlc_sd_GetNames, ( vlc_object_t *, char ***, int ** ) LIBVLC_USED );
 #define vlc_sd_GetNames(obj, pln, pcat ) \
         vlc_sd_GetNames(VLC_OBJECT(obj), pln, pcat)
 
 /* Creation of a service_discovery object */
-VLC_EXPORT( services_discovery_t *, vlc_sd_Create, ( vlc_object_t *, const char * ) );
+VLC_EXPORT( services_discovery_t *, vlc_sd_Create, ( vlc_object_t *, const char * ) LIBVLC_USED );
 VLC_EXPORT( bool, vlc_sd_Start, ( services_discovery_t * ) );
 VLC_EXPORT( void, vlc_sd_Stop, ( services_discovery_t * ) );
 VLC_EXPORT( void, vlc_sd_Destroy, ( services_discovery_t * ) );
@@ -85,10 +133,10 @@ static inline void vlc_sd_StopAndDestroy( services_discovery_t * p_this )
 }
 
 /* Read info from discovery object */
-VLC_EXPORT( char *,                 services_discovery_GetLocalizedName, ( services_discovery_t * p_this ) );
+VLC_EXPORT( char *,                 services_discovery_GetLocalizedName, ( services_discovery_t * p_this ) LIBVLC_USED );
 
 /* Receive event notification (preferred way to get new items) */
-VLC_EXPORT( vlc_event_manager_t *,  services_discovery_EventManager, ( services_discovery_t * p_this ) );
+VLC_EXPORT( vlc_event_manager_t *,  services_discovery_EventManager, ( services_discovery_t * p_this ) LIBVLC_USED );
 
 /* Used by services_discovery to post update about their items */
     /* About the psz_category, it is a legacy way to add info to the item,