1 /*
2 * WPA Supplicant / dbus-based control interface
3 * Copyright (c) 2006, Dan Williams <dcbw@redhat.com> and Red Hat, Inc.
4 *
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
7 */
8
9 #ifndef DBUS_DICT_HELPERS_H
10 #define DBUS_DICT_HELPERS_H
11
12 #include "wpabuf.h"
13
14 /*
15 * Adding a dict to a DBusMessage
16 */
17
18 dbus_bool_t wpa_dbus_dict_open_write(DBusMessageIter *iter,
19 DBusMessageIter *iter_dict);
20
21 dbus_bool_t wpa_dbus_dict_close_write(DBusMessageIter *iter,
22 DBusMessageIter *iter_dict);
23
24 const char * wpa_dbus_type_as_string(const int type);
25
26 dbus_bool_t wpa_dbus_dict_append_string(DBusMessageIter *iter_dict,
27 const char *key, const char *value);
28
29 dbus_bool_t wpa_dbus_dict_append_bool(DBusMessageIter *iter_dict,
30 const char *key,
31 const dbus_bool_t value);
32
33 dbus_bool_t wpa_dbus_dict_append_int16(DBusMessageIter *iter_dict,
34 const char *key,
35 const dbus_int16_t value);
36
37 dbus_bool_t wpa_dbus_dict_append_uint16(DBusMessageIter *iter_dict,
38 const char *key,
39 const dbus_uint16_t value);
40
41 dbus_bool_t wpa_dbus_dict_append_int32(DBusMessageIter *iter_dict,
42 const char *key,
43 const dbus_int32_t value);
44
45 dbus_bool_t wpa_dbus_dict_append_uint32(DBusMessageIter *iter_dict,
46 const char *key,
47 const dbus_uint32_t value);
48
49 dbus_bool_t wpa_dbus_dict_append_uint64(DBusMessageIter *iter_dict,
50 const char *key,
51 const dbus_uint64_t value);
52
53 dbus_bool_t wpa_dbus_dict_append_object_path(DBusMessageIter *iter_dict,
54 const char *key,
55 const char *value);
56
57 dbus_bool_t wpa_dbus_dict_append_byte_array(DBusMessageIter *iter_dict,
58 const char *key,
59 const char *value,
60 const dbus_uint32_t value_len);
61
62 /* Manual construction and addition of array elements */
63 dbus_bool_t wpa_dbus_dict_begin_array(DBusMessageIter *iter_dict,
64 const char *key, const char *type,
65 DBusMessageIter *iter_dict_entry,
66 DBusMessageIter *iter_dict_val,
67 DBusMessageIter *iter_array);
68
69 dbus_bool_t wpa_dbus_dict_begin_string_array(DBusMessageIter *iter_dict,
70 const char *key,
71 DBusMessageIter *iter_dict_entry,
72 DBusMessageIter *iter_dict_val,
73 DBusMessageIter *iter_array);
74
75 dbus_bool_t wpa_dbus_dict_string_array_add_element(DBusMessageIter *iter_array,
76 const char *elem);
77
78 dbus_bool_t wpa_dbus_dict_bin_array_add_element(DBusMessageIter *iter_array,
79 const u8 *value,
80 size_t value_len);
81
82 dbus_bool_t wpa_dbus_dict_end_array(DBusMessageIter *iter_dict,
83 DBusMessageIter *iter_dict_entry,
84 DBusMessageIter *iter_dict_val,
85 DBusMessageIter *iter_array);
86
87 static inline dbus_bool_t
wpa_dbus_dict_end_string_array(DBusMessageIter * iter_dict,DBusMessageIter * iter_dict_entry,DBusMessageIter * iter_dict_val,DBusMessageIter * iter_array)88 wpa_dbus_dict_end_string_array(DBusMessageIter *iter_dict,
89 DBusMessageIter *iter_dict_entry,
90 DBusMessageIter *iter_dict_val,
91 DBusMessageIter *iter_array)
92 {
93 return wpa_dbus_dict_end_array(iter_dict, iter_dict_entry,
94 iter_dict_val, iter_array);
95 }
96
97 /* Convenience function to add a whole string list */
98 dbus_bool_t wpa_dbus_dict_append_string_array(DBusMessageIter *iter_dict,
99 const char *key,
100 const char **items,
101 const dbus_uint32_t num_items);
102
103 dbus_bool_t wpa_dbus_dict_append_wpabuf_array(DBusMessageIter *iter_dict,
104 const char *key,
105 const struct wpabuf **items,
106 const dbus_uint32_t num_items);
107
108 /*
109 * Reading a dict from a DBusMessage
110 */
111
112 /*
113 * Used only in struct wpa_dbus_dict_entry::array_type internally to identify
114 * special binary array case.
115 */
116 #define WPAS_DBUS_TYPE_BINARRAY ((int) '@')
117
118 struct wpa_dbus_dict_entry {
119 int type; /** the dbus type of the dict entry's value */
120 int array_type; /** the dbus type of the array elements if the dict
121 entry value contains an array, or the special
122 WPAS_DBUS_TYPE_BINARRAY */
123 const char *key; /** key of the dict entry */
124
125 /** Possible values of the property */
126 union {
127 char *str_value;
128 char byte_value;
129 dbus_bool_t bool_value;
130 dbus_int16_t int16_value;
131 dbus_uint16_t uint16_value;
132 dbus_int32_t int32_value;
133 dbus_uint32_t uint32_value;
134 dbus_int64_t int64_value;
135 dbus_uint64_t uint64_value;
136 double double_value;
137 char *bytearray_value;
138 char **strarray_value;
139 struct wpabuf **binarray_value;
140 };
141 dbus_uint32_t array_len; /** length of the array if the dict entry's
142 value contains an array */
143 };
144
145 dbus_bool_t wpa_dbus_dict_open_read(DBusMessageIter *iter,
146 DBusMessageIter *iter_dict,
147 DBusError *error);
148
149 dbus_bool_t wpa_dbus_dict_get_entry(DBusMessageIter *iter_dict,
150 struct wpa_dbus_dict_entry *entry);
151
152 dbus_bool_t wpa_dbus_dict_has_dict_entry(DBusMessageIter *iter_dict);
153
154 void wpa_dbus_dict_entry_clear(struct wpa_dbus_dict_entry *entry);
155
156 #endif /* DBUS_DICT_HELPERS_H */
157