2 * WPA Supplicant / dbus-based control interface
3 * Copyright (c) 2006, Dan Williams <dcbw@redhat.com> and Red Hat, Inc.
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
9 #ifndef DBUS_DICT_HELPERS_H
10 #define DBUS_DICT_HELPERS_H
15 * Adding a dict to a DBusMessage
18 dbus_bool_t wpa_dbus_dict_open_write(DBusMessageIter *iter,
19 DBusMessageIter *iter_dict);
21 dbus_bool_t wpa_dbus_dict_close_write(DBusMessageIter *iter,
22 DBusMessageIter *iter_dict);
24 const char * wpa_dbus_type_as_string(const int type);
26 dbus_bool_t wpa_dbus_dict_append_string(DBusMessageIter *iter_dict,
27 const char *key, const char *value);
29 dbus_bool_t wpa_dbus_dict_append_byte(DBusMessageIter *iter_dict,
30 const char *key, const char value);
32 dbus_bool_t wpa_dbus_dict_append_bool(DBusMessageIter *iter_dict,
34 const dbus_bool_t value);
36 dbus_bool_t wpa_dbus_dict_append_int16(DBusMessageIter *iter_dict,
38 const dbus_int16_t value);
40 dbus_bool_t wpa_dbus_dict_append_uint16(DBusMessageIter *iter_dict,
42 const dbus_uint16_t value);
44 dbus_bool_t wpa_dbus_dict_append_int32(DBusMessageIter *iter_dict,
46 const dbus_int32_t value);
48 dbus_bool_t wpa_dbus_dict_append_uint32(DBusMessageIter *iter_dict,
50 const dbus_uint32_t value);
52 dbus_bool_t wpa_dbus_dict_append_int64(DBusMessageIter *iter_dict,
54 const dbus_int64_t value);
56 dbus_bool_t wpa_dbus_dict_append_uint64(DBusMessageIter *iter_dict,
58 const dbus_uint64_t value);
60 dbus_bool_t wpa_dbus_dict_append_double(DBusMessageIter *iter_dict,
64 dbus_bool_t wpa_dbus_dict_append_object_path(DBusMessageIter *iter_dict,
68 dbus_bool_t wpa_dbus_dict_append_byte_array(DBusMessageIter *iter_dict,
71 const dbus_uint32_t value_len);
73 /* Manual construction and addition of array elements */
74 dbus_bool_t wpa_dbus_dict_begin_array(DBusMessageIter *iter_dict,
75 const char *key, const char *type,
76 DBusMessageIter *iter_dict_entry,
77 DBusMessageIter *iter_dict_val,
78 DBusMessageIter *iter_array);
80 dbus_bool_t wpa_dbus_dict_begin_string_array(DBusMessageIter *iter_dict,
82 DBusMessageIter *iter_dict_entry,
83 DBusMessageIter *iter_dict_val,
84 DBusMessageIter *iter_array);
86 dbus_bool_t wpa_dbus_dict_string_array_add_element(DBusMessageIter *iter_array,
89 dbus_bool_t wpa_dbus_dict_bin_array_add_element(DBusMessageIter *iter_array,
93 dbus_bool_t wpa_dbus_dict_end_array(DBusMessageIter *iter_dict,
94 DBusMessageIter *iter_dict_entry,
95 DBusMessageIter *iter_dict_val,
96 DBusMessageIter *iter_array);
98 static inline dbus_bool_t
99 wpa_dbus_dict_end_string_array(DBusMessageIter *iter_dict,
100 DBusMessageIter *iter_dict_entry,
101 DBusMessageIter *iter_dict_val,
102 DBusMessageIter *iter_array)
104 return wpa_dbus_dict_end_array(iter_dict, iter_dict_entry,
105 iter_dict_val, iter_array);
108 /* Convenience function to add a whole string list */
109 dbus_bool_t wpa_dbus_dict_append_string_array(DBusMessageIter *iter_dict,
112 const dbus_uint32_t num_items);
114 dbus_bool_t wpa_dbus_dict_append_wpabuf_array(DBusMessageIter *iter_dict,
116 const struct wpabuf **items,
117 const dbus_uint32_t num_items);
120 * Reading a dict from a DBusMessage
124 * Used only in struct wpa_dbus_dict_entry::array_type internally to identify
125 * special binary array case.
127 #define WPAS_DBUS_TYPE_BINARRAY ((int) '@')
129 struct wpa_dbus_dict_entry {
130 int type; /** the dbus type of the dict entry's value */
131 int array_type; /** the dbus type of the array elements if the dict
132 entry value contains an array, or the special
133 WPAS_DBUS_TYPE_BINARRAY */
134 const char *key; /** key of the dict entry */
136 /** Possible values of the property */
140 dbus_bool_t bool_value;
141 dbus_int16_t int16_value;
142 dbus_uint16_t uint16_value;
143 dbus_int32_t int32_value;
144 dbus_uint32_t uint32_value;
145 dbus_int64_t int64_value;
146 dbus_uint64_t uint64_value;
148 char *bytearray_value;
149 char **strarray_value;
150 struct wpabuf **binarray_value;
152 dbus_uint32_t array_len; /** length of the array if the dict entry's
153 value contains an array */
156 dbus_bool_t wpa_dbus_dict_open_read(DBusMessageIter *iter,
157 DBusMessageIter *iter_dict,
160 dbus_bool_t wpa_dbus_dict_get_entry(DBusMessageIter *iter_dict,
161 struct wpa_dbus_dict_entry *entry);
163 dbus_bool_t wpa_dbus_dict_has_dict_entry(DBusMessageIter *iter_dict);
165 void wpa_dbus_dict_entry_clear(struct wpa_dbus_dict_entry *entry);
167 #endif /* DBUS_DICT_HELPERS_H */