Add backward compatibility and remarks
[src/app-framework-binder.git] / include / afb / afb-binding.h
index 5a6f9bc..82f702e 100644 (file)
  *
  * Functions of bindings of afb-daemon are accessible by authorized clients
  * through the apis module of afb-daemon.
- *
- * A binding is a shared library. This shared library must have at least one
- * exported symbol for being registered in afb-daemon.
- *
  */
 
 #define AFB_BINDING_LOWER_VERSION     1
 #define AFB_BINDING_UPPER_VERSION     2
-#define AFB_BINDING_DEFAULT_VERSION   1
 
 #ifndef AFB_BINDING_VERSION
-#define AFB_BINDING_VERSION   AFB_BINDING_DEFAULT_VERSION
+#define AFB_BINDING_VERSION   1
+#pragma GCC warning "\
+\n\
+\n\
+  AFB_BINDING_VERSION should be defined before including <afb/afb-binding.h>\n\
+  AFB_BINDING_VERSION defines the version of binding that you use.\n\
+  Currently, known versions are 1 or 2.\n\
+  Setting now AFB_BINDING_VERSION to 1 (version 1 by default)\n\
+  NOTE THAT VERSION 2 IS NOW RECOMMENDED!\n\
+  Consider to add one of the following define before including <afb/afb-binding.h>:\n\
+\n\
+    #define AFB_BINDING_VERSION 1\n\
+    #define AFB_BINDING_VERSION 2\n\
+\n\
+  Note that in some case it will enforce you to include <stdio.h>\n\
+"
+#include <stdio.h> /* old version side effect */
+#else
+#  if AFB_BINDING_VERSION == 1
+#    pragma GCC warning "Using binding version 1, consider to switch to version 2"
+#  endif
+#endif
+
+#if AFB_BINDING_VERSION != 0
+# if AFB_BINDING_VERSION < AFB_BINDING_LOWER_VERSION || AFB_BINDING_VERSION > AFB_BINDING_UPPER_VERSION
+#  error "Unsupported binding version AFB_BINDING_VERSION " #AFB_BINDING_VERSION
+# endif
 #endif
 
 /*
  * Some function of the library are exported to afb-daemon.
  */
 
-#include "afb-auth.h"
-#include "afb-req-itf.h"
-#include "afb-event-itf.h"
-#include "afb-service-itf.h"
-#include "afb-daemon-itf.h"
 #include "afb-binding-v1.h"
 #include "afb-binding-v2.h"
 
+typedef struct afb_verb_desc_v1         afb_verb_desc_v1;
+typedef struct afb_binding_desc_v1      afb_binding_desc_v1;
+typedef struct afb_binding_v1           afb_binding_v1;
+typedef struct afb_binding_interface_v1 afb_binding_interface_v1;
+
+typedef struct afb_verb_v2              afb_verb_v2;
+typedef struct afb_binding_v2           afb_binding_v2;
+
+typedef enum   afb_auth_type            afb_auth_type;
+typedef struct afb_auth                 afb_auth;
+typedef struct afb_daemon               afb_daemon;
+typedef struct afb_event                afb_event;
+typedef struct afb_arg                  afb_arg;
+typedef struct afb_req                  afb_req;
+typedef struct afb_service              afb_service;
+
+#if 0
+/* these typedef's shouldn't be needed */
+typedef enum   afb_binding_type_v1      afb_binding_type_v1;
+typedef enum   afb_mode_v1              afb_mode_v1;
+typedef enum   afb_session_flags_v1     afb_session_flags_v1;
+typedef enum   afb_session_flags_v2     afb_session_flags_v2;
+typedef struct afb_binding_data_v2      afb_binding_data_v2;
+typedef struct afb_daemon_itf           afb_daemon_itf;
+typedef struct afb_event_itf            afb_event_itf;
+typedef struct afb_req_itf              afb_req_itf;
+typedef struct afb_service_itf          afb_service_itf;
+#endif
+
+/***************************************************************************************************/
+
+#if AFB_BINDING_VERSION == 1
+
+# define afb_binding           afb_binding_v1
+# define afb_binding_interface afb_binding_interface_v1
+
+# define AFB_SESSION_NONE      AFB_SESSION_NONE_V1
+# define AFB_SESSION_CREATE    AFB_SESSION_CREATE_V1
+# define AFB_SESSION_CLOSE     AFB_SESSION_CLOSE_V1
+# define AFB_SESSION_RENEW     AFB_SESSION_RENEW_V1
+# define AFB_SESSION_CHECK     AFB_SESSION_CHECK_V1
+
+# define AFB_SESSION_LOA_GE    AFB_SESSION_LOA_GE_V1
+# define AFB_SESSION_LOA_LE    AFB_SESSION_LOA_LE_V1
+# define AFB_SESSION_LOA_EQ    AFB_SESSION_LOA_EQ_V1
+
+# define AFB_SESSION_LOA_SHIFT AFB_SESSION_LOA_SHIFT_V1
+# define AFB_SESSION_LOA_MASK  AFB_SESSION_LOA_MASK_V1
+
+# define AFB_SESSION_LOA_0     AFB_SESSION_LOA_0_V1
+# define AFB_SESSION_LOA_1     AFB_SESSION_LOA_1_V1
+# define AFB_SESSION_LOA_2     AFB_SESSION_LOA_2_V1
+# define AFB_SESSION_LOA_3     AFB_SESSION_LOA_3_V1
+# define AFB_SESSION_LOA_4     AFB_SESSION_LOA_4_V1
+
+# define AFB_SESSION_LOA_LE_0  AFB_SESSION_LOA_LE_0_V1
+# define AFB_SESSION_LOA_LE_1  AFB_SESSION_LOA_LE_1_V1
+# define AFB_SESSION_LOA_LE_2  AFB_SESSION_LOA_LE_2_V1
+# define AFB_SESSION_LOA_LE_3  AFB_SESSION_LOA_LE_3_V1
+
+# define AFB_SESSION_LOA_EQ_0  AFB_SESSION_LOA_EQ_0_V1
+# define AFB_SESSION_LOA_EQ_1  AFB_SESSION_LOA_EQ_1_V1
+# define AFB_SESSION_LOA_EQ_2  AFB_SESSION_LOA_EQ_2_V1
+# define AFB_SESSION_LOA_EQ_3  AFB_SESSION_LOA_EQ_3_V1
+
+# define AFB_SESSION_LOA_GE_0  AFB_SESSION_LOA_GE_0_V1
+# define AFB_SESSION_LOA_GE_1  AFB_SESSION_LOA_GE_1_V1
+# define AFB_SESSION_LOA_GE_2  AFB_SESSION_LOA_GE_2_V1
+# define AFB_SESSION_LOA_GE_3  AFB_SESSION_LOA_GE_3_V1
+
+# if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO)
+
+#  define ERROR                        AFB_ERROR_V1
+#  define WARNING              AFB_WARNING_V1
+#  define NOTICE               AFB_NOTICE_V1
+#  define INFO                 AFB_INFO_V1
+#  define DEBUG                        AFB_DEBUG_V1
+
+#  define REQ_ERROR            AFB_REQ_ERROR_V1
+#  define REQ_WARNING          AFB_REQ_WARNING_V1
+#  define REQ_NOTICE           AFB_REQ_NOTICE_V1
+#  define REQ_INFO             AFB_REQ_INFO_V1
+#  define REQ_DEBUG            AFB_REQ_DEBUG_V1
+
+# endif
+
+#define afb_daemon_get_event_loop      afb_daemon_get_event_loop_v1
+#define afb_daemon_get_user_bus                afb_daemon_get_user_bus_v1
+#define afb_daemon_get_system_bus      afb_daemon_get_system_bus_v1
+#define afb_daemon_broadcast_event     afb_daemon_broadcast_event_v1
+#define afb_daemon_make_event          afb_daemon_make_event_v1
+#define afb_daemon_verbose             afb_daemon_verbose_v1
+#define afb_daemon_rootdir_get_fd      afb_daemon_rootdir_get_fd_v1
+#define afb_daemon_rootdir_open_locale afb_daemon_rootdir_open_locale_v1
+#define afb_daemon_queue_job           afb_daemon_queue_job_v1
+
+#define afb_service_call               afb_service_call_v1
+#define afb_service_call_sync          afb_service_call_sync_v1
+
+#endif
+
+/***************************************************************************************************/
+
+#if AFB_BINDING_VERSION == 2
+
+# define afb_binding           afb_binding_v2
+
+# define AFB_SESSION_NONE      AFB_SESSION_NONE_V2
+# define AFB_SESSION_CLOSE     AFB_SESSION_CLOSE_V2
+# define AFB_SESSION_RENEW     AFB_SESSION_REFRESH_V2
+# define AFB_SESSION_REFRESH   AFB_SESSION_REFRESH_V2
+# define AFB_SESSION_CHECK     AFB_SESSION_CHECK_V2
+
+# define AFB_SESSION_LOA_MASK  AFB_SESSION_LOA_MASK_V2
+
+# define AFB_SESSION_LOA_0     AFB_SESSION_LOA_0_V2
+# define AFB_SESSION_LOA_1     AFB_SESSION_LOA_1_V2
+# define AFB_SESSION_LOA_2     AFB_SESSION_LOA_2_V2
+# define AFB_SESSION_LOA_3     AFB_SESSION_LOA_3_V2
+
+# if !defined(AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO)
+
+#  define ERROR                        AFB_ERROR_V2
+#  define WARNING              AFB_WARNING_V2
+#  define NOTICE               AFB_NOTICE_V2
+#  define INFO                 AFB_INFO_V2
+#  define DEBUG                        AFB_DEBUG_V2
+
+#  define REQ_ERROR            AFB_REQ_ERROR_V2
+#  define REQ_WARNING          AFB_REQ_WARNING_V2
+#  define REQ_NOTICE           AFB_REQ_NOTICE_V2
+#  define REQ_INFO             AFB_REQ_INFO_V2
+#  define REQ_DEBUG            AFB_REQ_DEBUG_V2
+
+# endif
+
+#define afb_daemon_get_event_loop      afb_daemon_get_event_loop_v2
+#define afb_daemon_get_user_bus                afb_daemon_get_user_bus_v2
+#define afb_daemon_get_system_bus      afb_daemon_get_system_bus_v2
+#define afb_daemon_broadcast_event     afb_daemon_broadcast_event_v2
+#define afb_daemon_make_event          afb_daemon_make_event_v2
+#define afb_daemon_verbose             afb_daemon_verbose_v2
+#define afb_daemon_rootdir_get_fd      afb_daemon_rootdir_get_fd_v2
+#define afb_daemon_rootdir_open_locale afb_daemon_rootdir_open_locale_v2
+#define afb_daemon_queue_job           afb_daemon_queue_job_v2
+
+#define afb_service_call               afb_service_call_v2
+#define afb_service_call_sync          afb_service_call_sync_v2
+
+#endif
+