152 lines
		
	
	
	
		
			4.7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			152 lines
		
	
	
	
		
			4.7 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /*
 | |
|  * WPA Supplicant / dbus-based control interface
 | |
|  * Copyright (c) 2006, Dan Williams <dcbw@redhat.com> and Red Hat, Inc.
 | |
|  *
 | |
|  * This software may be distributed under the terms of the BSD license.
 | |
|  * See README for more details.
 | |
|  */
 | |
| 
 | |
| #ifndef DBUS_DICT_HELPERS_H
 | |
| #define DBUS_DICT_HELPERS_H
 | |
| 
 | |
| #include "wpabuf.h"
 | |
| 
 | |
| /*
 | |
|  * Adding a dict to a DBusMessage
 | |
|  */
 | |
| 
 | |
| dbus_bool_t wpa_dbus_dict_open_write(DBusMessageIter *iter,
 | |
| 				     DBusMessageIter *iter_dict);
 | |
| 
 | |
| dbus_bool_t wpa_dbus_dict_close_write(DBusMessageIter *iter,
 | |
| 				      DBusMessageIter *iter_dict);
 | |
| 
 | |
| const char * wpa_dbus_type_as_string(const int type);
 | |
| 
 | |
| dbus_bool_t wpa_dbus_dict_append_string(DBusMessageIter *iter_dict,
 | |
| 					const char *key, const char *value);
 | |
| 
 | |
| dbus_bool_t wpa_dbus_dict_append_bool(DBusMessageIter *iter_dict,
 | |
| 				      const char *key,
 | |
| 				      const dbus_bool_t value);
 | |
| 
 | |
| dbus_bool_t wpa_dbus_dict_append_int16(DBusMessageIter *iter_dict,
 | |
| 				       const char *key,
 | |
| 				       const dbus_int16_t value);
 | |
| 
 | |
| dbus_bool_t wpa_dbus_dict_append_uint16(DBusMessageIter *iter_dict,
 | |
| 					const char *key,
 | |
| 					const dbus_uint16_t value);
 | |
| 
 | |
| dbus_bool_t wpa_dbus_dict_append_int32(DBusMessageIter *iter_dict,
 | |
| 				       const char *key,
 | |
| 				       const dbus_int32_t value);
 | |
| 
 | |
| dbus_bool_t wpa_dbus_dict_append_uint32(DBusMessageIter *iter_dict,
 | |
| 					const char *key,
 | |
| 					const dbus_uint32_t value);
 | |
| 
 | |
| dbus_bool_t wpa_dbus_dict_append_object_path(DBusMessageIter *iter_dict,
 | |
| 					     const char *key,
 | |
| 					     const char *value);
 | |
| 
 | |
| dbus_bool_t wpa_dbus_dict_append_byte_array(DBusMessageIter *iter_dict,
 | |
| 					    const char *key,
 | |
| 					    const char *value,
 | |
| 					    const dbus_uint32_t value_len);
 | |
| 
 | |
| /* Manual construction and addition of array elements */
 | |
| dbus_bool_t wpa_dbus_dict_begin_array(DBusMessageIter *iter_dict,
 | |
| 				      const char *key, const char *type,
 | |
| 				      DBusMessageIter *iter_dict_entry,
 | |
| 				      DBusMessageIter *iter_dict_val,
 | |
| 				      DBusMessageIter *iter_array);
 | |
| 
 | |
| dbus_bool_t wpa_dbus_dict_begin_string_array(DBusMessageIter *iter_dict,
 | |
| 					     const char *key,
 | |
| 					     DBusMessageIter *iter_dict_entry,
 | |
| 					     DBusMessageIter *iter_dict_val,
 | |
| 					     DBusMessageIter *iter_array);
 | |
| 
 | |
| dbus_bool_t wpa_dbus_dict_string_array_add_element(DBusMessageIter *iter_array,
 | |
| 						   const char *elem);
 | |
| 
 | |
| dbus_bool_t wpa_dbus_dict_bin_array_add_element(DBusMessageIter *iter_array,
 | |
| 						const u8 *value,
 | |
| 						size_t value_len);
 | |
| 
 | |
| dbus_bool_t wpa_dbus_dict_end_array(DBusMessageIter *iter_dict,
 | |
| 				    DBusMessageIter *iter_dict_entry,
 | |
| 				    DBusMessageIter *iter_dict_val,
 | |
| 				    DBusMessageIter *iter_array);
 | |
| 
 | |
| 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)
 | |
| {
 | |
| 	return wpa_dbus_dict_end_array(iter_dict, iter_dict_entry,
 | |
| 				       iter_dict_val, iter_array);
 | |
| }
 | |
| 
 | |
| /* Convenience function to add a whole string list */
 | |
| dbus_bool_t wpa_dbus_dict_append_string_array(DBusMessageIter *iter_dict,
 | |
| 					      const char *key,
 | |
| 					      const char **items,
 | |
| 					      const dbus_uint32_t num_items);
 | |
| 
 | |
| dbus_bool_t wpa_dbus_dict_append_wpabuf_array(DBusMessageIter *iter_dict,
 | |
| 					      const char *key,
 | |
| 					      const struct wpabuf **items,
 | |
| 					      const dbus_uint32_t num_items);
 | |
| 
 | |
| /*
 | |
|  * Reading a dict from a DBusMessage
 | |
|  */
 | |
| 
 | |
| /*
 | |
|  * Used only in struct wpa_dbus_dict_entry::array_type internally to identify
 | |
|  * special binary array case.
 | |
|  */
 | |
| #define WPAS_DBUS_TYPE_BINARRAY ((int) '@')
 | |
| 
 | |
| struct wpa_dbus_dict_entry {
 | |
| 	int type;         /** the dbus type of the dict entry's value */
 | |
| 	int array_type;   /** the dbus type of the array elements if the dict
 | |
| 			      entry value contains an array, or the special
 | |
| 			      WPAS_DBUS_TYPE_BINARRAY */
 | |
| 	const char *key;  /** key of the dict entry */
 | |
| 
 | |
| 	/** Possible values of the property */
 | |
| 	union {
 | |
| 		char *str_value;
 | |
| 		char byte_value;
 | |
| 		dbus_bool_t bool_value;
 | |
| 		dbus_int16_t int16_value;
 | |
| 		dbus_uint16_t uint16_value;
 | |
| 		dbus_int32_t int32_value;
 | |
| 		dbus_uint32_t uint32_value;
 | |
| 		dbus_int64_t int64_value;
 | |
| 		dbus_uint64_t uint64_value;
 | |
| 		double double_value;
 | |
| 		char *bytearray_value;
 | |
| 		char **strarray_value;
 | |
| 		struct wpabuf **binarray_value;
 | |
| 	};
 | |
| 	dbus_uint32_t array_len; /** length of the array if the dict entry's
 | |
| 				     value contains an array */
 | |
| };
 | |
| 
 | |
| dbus_bool_t wpa_dbus_dict_open_read(DBusMessageIter *iter,
 | |
| 				    DBusMessageIter *iter_dict,
 | |
| 				    DBusError *error);
 | |
| 
 | |
| dbus_bool_t wpa_dbus_dict_get_entry(DBusMessageIter *iter_dict,
 | |
| 				    struct wpa_dbus_dict_entry *entry);
 | |
| 
 | |
| dbus_bool_t wpa_dbus_dict_has_dict_entry(DBusMessageIter *iter_dict);
 | |
| 
 | |
| void wpa_dbus_dict_entry_clear(struct wpa_dbus_dict_entry *entry);
 | |
| 
 | |
| #endif  /* DBUS_DICT_HELPERS_H */
 | 
