summaryrefslogtreecommitdiff
path: root/src/lib/eeze/eeze_sensor_private.h
blob: 759925af2394962b7c400a75cc67b027dfbf48e5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
#ifndef EEZE_SENSOR_PRIVATE_H
#define EEZE_SENSOR_PRIVATE_H
#include <stdio.h>
#include <stdlib.h>
#include <stdbool.h>

#include <Eeze_Sensor.h>

#ifndef EEZE_SENSOR_COLOR_DEFAULT
#define EEZE_SENSOR_COLOR_DEFAULT EINA_COLOR_BLUE
#endif
extern int _eeze_sensor_log_dom;
#ifdef CRI
#undef CRI
#endif
#ifdef ERR
#undef ERR
#endif
#ifdef INF
#undef INF
#endif
#ifdef WARN
#undef WARN
#endif
#ifdef DBG
#undef DBG
#endif

#define CRI(...)  EINA_LOG_DOM_CRIT(_eeze_sensor_log_dom, __VA_ARGS__)
#define DBG(...)  EINA_LOG_DOM_DBG(_eeze_sensor_log_dom, __VA_ARGS__)
#define INF(...)  EINA_LOG_DOM_INFO(_eeze_sensor_log_dom, __VA_ARGS__)
#define WARN(...) EINA_LOG_DOM_WARN(_eeze_sensor_log_dom, __VA_ARGS__)
#define ERR(...)  EINA_LOG_DOM_ERR(_eeze_sensor_log_dom, __VA_ARGS__)

/**
 * @typedef Eeze_Sensor
 * @since 1.8
 *
 * Internal data structure to hold the information about loaded and available runtime modules of
 * Eeze_Sensor.
 */
typedef struct _Eeze_Sensor
{
   Eina_Array *modules_array;  /**< Array of available runtime modules */
   Eina_Hash  *modules; /**< Hash with loaded modules */
}  Eeze_Sensor;

/**
 * @typedef Eeze_Sensor_Module;
 * @since 1.8
 *
 * Internal data structure for the modules. It mainly holds function pointers each modules provides
 * to be called from the Eeze_Sensor core to access the data provided by the module.
 */
typedef struct _Eeze_Sensor_Module
{
   Eina_Bool (*init)(void); /**< Pointer to module init function */
   Eina_Bool (*shutdown)(void); /**< Pointer to module shutdown function */
   Eina_Bool (*async_read)(Eeze_Sensor_Obj *obj, void *user_data); /**< Pointer to module async_read function */
   Eina_Bool (*read)(Eeze_Sensor_Obj *obj); /**< Pointer to module read function */
   Eina_List *sensor_list; /**< List of sensor objects attached to the module */
} Eeze_Sensor_Module;

/**
 * @brief Register a module to eeze_sensor core.
 * @param name Module name used for reference internally.
 * @param mod Sensor module to be registered.
 * @return EINA_TRUE is the module was successfully registered. EINA_FALSE is not.
 *
 * Private functions for modules to register itself to eeze sensor core to
 * advertise their functionality. These registered modules will then be accessed
 * based on a priority that is currently hardcoded in the code. Once more module
 * are available we need to re-consider this approach.
 *
 * @since 1.8
 */
EAPI Eina_Bool eeze_sensor_module_register(const char *name, Eeze_Sensor_Module *mod);

/**
 * @brief Unregister a module from eeze_sensor core.
 * @param name Module name used for reference internally.
 * @return EINA_TRUE is the module was successfully unregistered. EINA_FALSE is not.
 *
 * Private functions for modules to unregister itself from eeze sensor core.
 *
 * @since 1.8
 */
EAPI Eina_Bool eeze_sensor_module_unregister(const char *name);

/**
 * @brief Fetch the sensor object by type from the sensor object list
 * @param type Sensor type to fetch from the list of sensor objects.
 * @return The sensor object matching the given type
 *
 * @since 1.8
 */
EAPI Eeze_Sensor_Obj    *eeze_sensor_obj_get(Eeze_Sensor_Type type);

/**
 * @brief Initialize the Eeze sensor subsystem.
 * @return EINA_TRUE for success and EINA_FALSE for failure
 *
 * This function must be called before using any of the Eeze_Sensor
 * functionality to make sure the subsystem is setup correctly for usage. If
 * you already call #eeze_init in your program this is already been take care
 * of and there is no need to call this to initialize this subsystem manually.
 *
 * @since 1.8
 */
Eina_Bool            eeze_sensor_init(void);

/**
 * @brief Clean up and shutdown the Eeze sensor subsystem.
 *
 * This function must be called when now longer using Eeze_Sensor to allow the
 * subsystem to shutdown cleanly. If you already called #eeze_shutdown this is
 * already been taken care of and there is no need to call this to shutdown this
 * subsystem manually.
 *
 * @since 1.8
 */
void                 eeze_sensor_shutdown(void);

#endif // EEZE_SENSOR_PRIVATE_H