api-v3: First draft

This commit introduces the bindings v3 API for bindings.

The documentation has still to be improved and will come
very soon.

Change-Id: I8f9007370e29f671fdfd1da87fff7372a17db7af
Signed-off-by: José Bollo <jose.bollo@iot.bzh>

1 files changed, 71 insertions, 212 deletions

diff --git a/include/afb/afb-binding.h b/include/afb/afb-binding.h
index 37305991..085dc388 100644
--- a/include/afb/afb-binding.h
+++ b/include/afb/afb-binding.h
@@ -17,246 +17,105 @@
 
 #pragma once
 
+/**
+ * @mainpage
+ *
+ * @section brief Brief introduction
+ *
+ * This is part of the AGL framework micro-service binder and is provided as the
+ * API for writing bindings.
+ *
+ * The normal usage is to include only one file as below:
+ *
+ * ```C
+ * #define AFB_BINDING_VERSION 3
+ * #include <afb/afb-binding.h>
+ * ```
+ *
+ * @example tuto-1.c
+ * @example tuto-2.c
+ */
+/**
+ * @file afb/afb-binding.h
+ */
+
 #include <stdarg.h>
+#include <stdint.h>
+struct json_object;
 
-/*****************************************************************************
- * This files is the main file to include for writing bindings dedicated to
+/**
+ * @def AFB_BINDING_INTERFACE_VERSION
+
+ *  * Version of the binding interface.
  *
- *                      AFB-DAEMON
+ * This is intended to be test for tuning condition code.
+ * It is of the form MAJOR * 1000 + REVISION.
  *
- * Functions of bindings of afb-daemon are accessible by authorized clients
- * through the apis module of afb-daemon.
+ * @see AFB_BINDING_UPPER_VERSION that should match MAJOR
  */
+#define AFB_BINDING_INTERFACE_VERSION 3000
 
+/**
+ * @def AFB_BINDING_LOWER_VERSION
+ *
+ * Lowest binding API version supported.
+ *
+ * @see AFB_BINDING_VERSION
+ * @see AFB_BINDING_UPPER_VERSION
+ */
 #define AFB_BINDING_LOWER_VERSION     1
-#define AFB_BINDING_UPPER_VERSION     2
+
+/**
+ * @def AFB_BINDING_UPPER_VERSION
+ *
+ * Upper binding API version supported.
+ *
+ * @see AFB_BINDING_VERSION
+ * @see AFB_BINDING_LOWER_VERSION
+ */
+#define AFB_BINDING_UPPER_VERSION     3
+
+/**
+ * @def AFB_BINDING_VERSION
+ *
+ * This macro must be defined before including <afb/afb-binding.h> to set
+ * the required binding API.
+ */
 
 #ifndef AFB_BINDING_VERSION
-#define AFB_BINDING_VERSION   1
-#pragma GCC warning "\
+#error "\
 \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\
+  Currently the version to use is 3 (older versions: 1 is obsolete, 2 is legacy).\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\
+    #define AFB_BINDING_VERSION 3\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"
+#    pragma GCC warning "Using binding version 1, consider to switch to version 3"
+#  endif
+#  if AFB_BINDING_VERSION == 2
+#    pragma GCC warning "Using binding version 2, consider to switch to version 3"
 #  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
+#  error "Unsupported binding version AFB_BINDING_VERSION"
 # endif
 #endif
 
-/*
- * Some function of the library are exported to afb-daemon.
- */
-
+/***************************************************************************************************/
+#include "afb-binding-predefs.h"
 #include "afb-binding-v1.h"
 #include "afb-binding-v2.h"
-#include "afb-binding-vdyn.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_stored_req           afb_stored_req;
-typedef struct afb_service              afb_service;
-
-typedef struct afb_dynapi               afb_dynapi;
-typedef struct afb_request              afb_request;
-typedef struct afb_eventid              afb_eventid;
-
-#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
-
-# define AFB_ERROR		AFB_ERROR_V1
-# define AFB_WARNING		AFB_WARNING_V1
-# define AFB_NOTICE		AFB_NOTICE_V1
-# define AFB_INFO		AFB_INFO_V1
-# define AFB_DEBUG		AFB_DEBUG_V1
-
-# define AFB_REQ_ERROR		AFB_REQ_ERROR_V1
-# define AFB_REQ_WARNING	AFB_REQ_WARNING_V1
-# define AFB_REQ_NOTICE		AFB_REQ_NOTICE_V1
-# define AFB_REQ_INFO		AFB_REQ_INFO_V1
-# define AFB_REQ_DEBUG		AFB_REQ_DEBUG_V1
-
-#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_daemon_require_api		afb_daemon_require_api_v1
-#define afb_daemon_rename_api		afb_daemon_rename_api_v1
-
-#define afb_service_call		afb_service_call_v1
-#define afb_service_call_sync		afb_service_call_sync_v1
-
-#define afb_req_store			afb_req_store_v1
-#define afb_req_unstore			afb_req_unstore_v1
-
-#endif
-
-/***************************************************************************************************/
-
-#if AFB_BINDING_VERSION == 2
-
-# define afb_binding		afb_binding_v2
-# define afb_get_verbosity	afb_get_verbosity_v2
-# define afb_get_daemon		afb_get_daemon_v2
-# define afb_get_service	afb_get_service_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
-
-# define AFB_ERROR		AFB_ERROR_V2
-# define AFB_WARNING		AFB_WARNING_V2
-# define AFB_NOTICE		AFB_NOTICE_V2
-# define AFB_INFO		AFB_INFO_V2
-# define AFB_DEBUG		AFB_DEBUG_V2
-
-# define AFB_REQ_ERROR		AFB_REQ_ERROR_V2
-# define AFB_REQ_WARNING	AFB_REQ_WARNING_V2
-# define AFB_REQ_NOTICE		AFB_REQ_NOTICE_V2
-# define AFB_REQ_INFO		AFB_REQ_INFO_V2
-# define AFB_REQ_DEBUG		AFB_REQ_DEBUG_V2
-
-#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_daemon_unstore_req		afb_daemon_unstore_req_v2
-#define afb_daemon_require_api		afb_daemon_require_api_v2
-#define afb_daemon_rename_api		afb_daemon_rename_api_v2
-
-#define afb_service_call		afb_service_call_v2
-#define afb_service_call_sync		afb_service_call_sync_v2
-
-#define afb_req_store			afb_req_store_v2
-#define afb_req_unstore			afb_daemon_unstore_req_v2
-
-#endif
-
-/***************************************************************************************************/
-
-#if AFB_BINDING_VERSION >= 2
-
-# define afb_verbose_error()	(afb_get_verbosity() >= AFB_VERBOSITY_LEVEL_ERROR)
-# define afb_verbose_warning()	(afb_get_verbosity() >= AFB_VERBOSITY_LEVEL_WARNING)
-# define afb_verbose_notice()	(afb_get_verbosity() >= AFB_VERBOSITY_LEVEL_NOTICE)
-# define afb_verbose_info()	(afb_get_verbosity() >= AFB_VERBOSITY_LEVEL_INFO)
-# define afb_verbose_debug()	(afb_get_verbosity() >= AFB_VERBOSITY_LEVEL_DEBUG)
-
-#endif
-
-/***************************************************************************************************/
-
-#if defined(AFB_BINDING_PRAGMA_KEEP_VERBOSE_UNPREFIX)
-# define ERROR			AFB_ERROR
-# define WARNING		AFB_WARNING
-# define NOTICE			AFB_NOTICE
-# define INFO			AFB_INFO
-# define DEBUG			AFB_DEBUG
-
-# define REQ_ERROR		AFB_REQ_ERROR
-# define REQ_WARNING		AFB_REQ_WARNING
-# define REQ_NOTICE		AFB_REQ_NOTICE
-# define REQ_INFO		AFB_REQ_INFO
-# define REQ_DEBUG		AFB_REQ_DEBUG
+#include "afb-binding-v3.h"
+#if defined(AFB_BINDING_WANT_DYNAPI)
+#  include "afb-dynapi-legacy.h"
 #endif
+#include "afb-binding-postdefs.h"