E_Ukit.h
Go to the documentation of this file.
1 #ifndef E_UKIT_H
2 #define E_UKIT_H
3 
4 #include <Eina.h>
5 #include <E_DBus.h>
6 
13 #define E_UDISKS_BUS "org.freedesktop.UDisks"
14 #define E_UDISKS_PATH "/org/freedesktop/UDisks"
15 #define E_UDISKS_INTERFACE "org.freedesktop.UDisks.Device"
16 
17 #define E_UPOWER_BUS "org.freedesktop.UPower"
18 #define E_UPOWER_PATH "/org/freedesktop/UPower"
19 #define E_UPOWER_INTERFACE "org.freedesktop.UPower.Device"
20 
21 /* message return types */
22 
23 typedef struct E_Ukit_Property E_Ukit_Property;
24 typedef struct E_Ukit_Properties E_Ukit_Properties;
25 
26 struct E_Ukit_String_List_Return
27 {
28  Eina_List *strings; /* list of const char * */
29 };
30 
31 struct E_Ukit_Bool_Return
32 {
33  Eina_Bool boolean;
34 };
35 
36 struct E_Ukit_UDI_Return
37 {
38  const char *udi;
39 };
40 
41 struct E_Ukit_Capability
42 {
43  const char *udi;
44  const char *capability;
45 };
46 
47 typedef enum
48 {
49  E_UKIT_PROPERTY_TYPE_STRING,
50  E_UKIT_PROPERTY_TYPE_INT,
51  E_UKIT_PROPERTY_TYPE_UINT32,
52  E_UKIT_PROPERTY_TYPE_UINT64,
53  E_UKIT_PROPERTY_TYPE_INT64,
54  E_UKIT_PROPERTY_TYPE_BOOL,
55  E_UKIT_PROPERTY_TYPE_DOUBLE,
56  E_UKIT_PROPERTY_TYPE_STRLIST
57 } E_Ukit_Property_Type;
58 
59 struct E_Ukit_Property
60 {
61  E_Ukit_Property_Type type;
62  union
63  {
64  const char *s;
65  int i;
66  Eina_Bool b;
67  double d;
68  uint32_t u;
69  uint64_t t;
70  int64_t x;
71  Eina_List *strlist;
72  } val;
73 };
74 
75 struct E_Ukit_Properties
76 {
77  Eina_Hash *properties;
78 };
79 
80 typedef enum
81 {
82  E_UPOWER_BATTERY_UNKNOWN,
83  E_UPOWER_BATTERY_LION,
84  E_UPOWER_BATTERY_LPOLYMER,
85  E_UPOWER_BATTERY_LIRONPHOS,
86  E_UPOWER_BATTERY_LEAD,
87  E_UPOWER_BATTERY_NICAD,
88  E_UPOWER_BATTERY_METALHYDRYDE
89 } E_UPower_Battery_Type;
90 
91 typedef enum
92 {
93  E_UPOWER_STATE_UNKNOWN,
94  E_UPOWER_STATE_CHARGING,
95  E_UPOWER_STATE_DISCHARGING,
96  E_UPOWER_STATE_EMPTY,
97  E_UPOWER_STATE_FULL,
98  E_UPOWER_STATE_PENDINGCHARGE,
99  E_UPOWER_STATE_PENDINGDISCHARGE
100 } E_Upower_State;
101 
102 typedef enum
103 {
104  E_UPOWER_SOURCE_UNKNOWN,
105  E_UPOWER_SOURCE_AC,
106  E_UPOWER_SOURCE_BATTERY,
107  E_UPOWER_SOURCE_UPS,
108  E_UPOWER_SOURCE_MONITOR,
109  E_UPOWER_SOURCE_MOUSE,
110  E_UPOWER_SOURCE_KEYBOARD,
111  E_UPOWER_SOURCE_PDA,
112  E_UPOWER_SOURCE_PHONE
113 } E_Upower_Source;
114 
115 
116 typedef struct E_Ukit_Properties E_Ukit_Get_All_Properties_Return;
117 typedef struct E_Ukit_Property E_Ukit_Get_Property_Return;
118 typedef struct E_Ukit_String_List_Return E_Ukit_String_List_Return;
119 typedef struct E_Ukit_String_List_Return E_Ukit_Get_All_Devices_Return;
120 
121 typedef struct E_Ukit_UDI_Return E_Ukit_Device_Added;
122 typedef struct E_Ukit_UDI_Return E_Ukit_Device_Removed;
123 typedef struct E_Ukit_Capability E_Ukit_New_Capability;
124 
125 #ifdef __cplusplus
126 extern "C" {
127 #endif
128 
129  EAPI int e_ukit_init(void);
130  EAPI int e_ukit_shutdown(void);
131 
132  EAPI DBusPendingCall *e_udisks_get_property(E_DBus_Connection *conn, const char *udi, const char *property, E_DBus_Callback_Func cb_func, void *data);
133  EAPI DBusPendingCall *e_udisks_get_all_properties(E_DBus_Connection *conn, const char *udi, E_DBus_Callback_Func cb_func, void *data);
134  EAPI DBusPendingCall *e_udisks_get_all_devices(E_DBus_Connection *conn, E_DBus_Callback_Func cb_func, void *data);
135 
136  EAPI DBusPendingCall *e_upower_get_property(E_DBus_Connection *conn, const char *udi, const char *property, E_DBus_Callback_Func cb_func, void *data);
137  EAPI DBusPendingCall *e_upower_get_all_properties(E_DBus_Connection *conn, const char *udi, E_DBus_Callback_Func cb_func, void *data);
138  EAPI DBusPendingCall *e_upower_get_all_devices(E_DBus_Connection *conn, E_DBus_Callback_Func cb_func, void *data);
139 
140  EAPI DBusPendingCall * e_upower_suspend_allowed(E_DBus_Connection *conn, E_DBus_Callback_Func cb_func, void *data);
141  EAPI DBusPendingCall * e_upower_suspend(E_DBus_Connection *conn, E_DBus_Callback_Func cb_func, void *data);
142  EAPI DBusPendingCall * e_upower_hibernate(E_DBus_Connection *conn, E_DBus_Callback_Func cb_func, void *data);
143  EAPI DBusPendingCall * e_upower_hibernate_allowed(E_DBus_Connection *conn, E_DBus_Callback_Func cb_func, void *data);
144 
145 /* utility functions */
146  EAPI void e_ukit_property_free(E_Ukit_Property *prop);
147  EAPI const char *e_ukit_property_string_get(E_Ukit_Properties *properties, const char *key, int *err);
148  EAPI Eina_Bool e_ukit_property_bool_get(E_Ukit_Properties *properties, const char *key, int *err);
149  EAPI int e_ukit_property_int_get(E_Ukit_Properties *properties, const char *key, int *err);
150  EAPI uint32_t e_ukit_property_uint32_get(E_Ukit_Properties *properties, const char *key, int *err);
151  EAPI uint64_t e_ukit_property_uint64_get(E_Ukit_Properties *properties, const char *key, int *err);
152  EAPI int64_t e_ukit_property_int64_get(E_Ukit_Properties *properties, const char *key, int *err);
153  EAPI double e_ukit_property_double_get(E_Ukit_Properties *properties, const char *key, int *err);
154  EAPI const Eina_List *e_ukit_property_strlist_get(E_Ukit_Properties *properties, const char *key, int *err);
155 
156 /* (un)mount */
157  EAPI DBusPendingCall *e_udisks_volume_mount(E_DBus_Connection *conn, const char *udi, const char *fstype, Eina_List *options);
158  EAPI DBusPendingCall *e_udisks_volume_unmount(E_DBus_Connection *conn, const char *udi, Eina_List *options);
159  EAPI DBusPendingCall *e_udisks_volume_eject(E_DBus_Connection *conn, const char *udi, Eina_List *options);
160 
161 #ifdef __cplusplus
162 }
163 #endif
164 
169 #endif