libvdo
vdo-map.h
Go to the documentation of this file.
1 
9 #ifndef __VDO_MAP_H__
10 #define __VDO_MAP_H__
11 
12 #include <glib-object.h>
13 #include "vdo-types.h"
14 
15 G_BEGIN_DECLS
16 
58 #define VDO_TYPE_MAP (vdo_map_get_type())
59 G_DECLARE_FINAL_TYPE(VdoMap, vdo_map, VDO, MAP, GObject)
60 
61 
76 #define vdo_map_get_printf(self, type, def, len, format, ...) __extension__ ({\
77  gchar name[len];\
78  g_snprintf(name, len, format, __VA_ARGS__);\
79  vdo_map_get_##type(self, name, def);\
80 })
81 
82 #define vdo_map_get_boolean_printf(self, def, len, format, ...) __extension__ ({\
83  gchar name[len];\
84  g_snprintf(name, len, format, __VA_ARGS__);\
85  vdo_map_get_boolean(self, name, def);\
86 })
87 
88 #define vdo_map_get_string_printf(self, def, len, format, ...) __extension__ ({\
89  gchar name[len];\
90  g_snprintf(name, len, format, __VA_ARGS__);\
91  vdo_map_get_string(self, name, NULL, def);\
92 })
93 
94 #define vdo_map_dup_string_printf(self, def, len, format, ...) __extension__ ({\
95  gchar name[len];\
96  g_snprintf(name, len, format, __VA_ARGS__);\
97  vdo_map_dup_string(self, name, def);\
98 })
99 
109 #define vdo_map_set_printf(self, type, value, len, format, ...) {\
110  gchar name[len];\
111  g_snprintf(name, len, format, __VA_ARGS__);\
112  vdo_map_set_##type(self, name, value);\
113 }
114 
115 #define vdo_map_set_boolean_printf(self, value, len, format, ...) {\
116  gchar name[len];\
117  g_snprintf(name, len, format, __VA_ARGS__);\
118  vdo_map_set_boolean(self, name, value);\
119 }
120 
128 #define vdo_map_remove_printf(self, len, format, ...) {\
129  gchar name[len];\
130  g_snprintf(name, len, format, __VA_ARGS__);\
131  vdo_map_remove(self, name);\
132 }
133 
140 
148 VdoMap* vdo_map_clone(const VdoMap* other);
149 
157 gboolean vdo_map_empty(const VdoMap *self);
158 
166 gsize vdo_map_size(const VdoMap *self);
167 
174 void vdo_map_swap(VdoMap *lhs, VdoMap *rhs);
175 
184 gboolean vdo_map_contains(const VdoMap *self, const gchar *name);
185 
198 gboolean vdo_map_contains_va(const VdoMap *self, ...);
199 
212 gboolean vdo_map_contains_strv(const VdoMap *self, const gchar * const *names);
213 
224 gboolean vdo_map_entry_equals(const VdoMap *self, const VdoMap *map, const gchar *name);
225 
236 gboolean vdo_map_entry_updates(const VdoMap *self, const VdoMap *map, const gchar *name);
237 
246 gboolean vdo_map_equals(const VdoMap *self, const VdoMap *map);
247 
262 gboolean vdo_map_equals_va(const VdoMap *self, const VdoMap *map, ...);
263 
278 gboolean vdo_map_equals_strv(const VdoMap *self, const VdoMap *map, const gchar * const *names);
279 
286 void vdo_map_remove(VdoMap *self, const gchar *name);
287 
298 void vdo_map_remove_va(VdoMap *self, ...);
299 
310 void vdo_map_remove_strv(VdoMap *self, const gchar * const *names);
311 
317 void vdo_map_clear(VdoMap *self);
318 
329 VdoMap *vdo_map_filter_prefix(const VdoMap *self, const gchar *prefix);
330 
345 VdoMap *vdo_map_filter_va(const VdoMap *self, ...);
346 
361 VdoMap *vdo_map_filter_strv(const VdoMap *self, const gchar * const *names);
362 
369 void vdo_map_merge(VdoMap *self, const VdoMap *map);
370 
381 void vdo_map_copy_value(VdoMap *self, const gchar *src, const gchar *dst);
382 
388 void vdo_map_dump(const VdoMap *self);
389 
391 guchar vdo_map_get_byte(const VdoMap *self, const gchar *name, guchar def);
392 gint16 vdo_map_get_int16(const VdoMap *self, const gchar *name, gint16 def);
393 guint16 vdo_map_get_uint16(const VdoMap *self, const gchar *name, guint16 def);
394 guint32* vdo_map_get_uint32x2(const VdoMap *self, const gchar *name, guint32 def[2]);
395 guint32* vdo_map_get_uint32x4(const VdoMap *self, const gchar *name, guint32 def[4]);
396 gdouble* vdo_map_get_doublex4(const VdoMap *self, const gchar *name, gdouble def[4]);
397 
410 gboolean vdo_map_get_boolean(const VdoMap *self, const gchar *name, gboolean def);
411 
424 gint32 vdo_map_get_int32(const VdoMap *self, const gchar *name, gint32 def);
425 
438 guint32 vdo_map_get_uint32(const VdoMap *self, const gchar *name, guint32 def);
439 
452 gint64 vdo_map_get_int64(const VdoMap *self, const gchar *name, gint64 def);
453 
466 guint64 vdo_map_get_uint64(const VdoMap *self, const gchar *name, guint64 def);
467 
480 gdouble vdo_map_get_double(const VdoMap *self, const gchar *name, gdouble def);
481 
495 const gchar *vdo_map_get_string(const VdoMap *self, const gchar *name, gsize *size, const gchar *def);
496 
509 gchar *vdo_map_dup_string(const VdoMap *self, const gchar *name, const gchar *def);
510 
523 VdoPair32i vdo_map_get_pair32i(const VdoMap *self, const gchar *name, VdoPair32i def);
524 
537 VdoPair32u vdo_map_get_pair32u(const VdoMap *self, const gchar *name, VdoPair32u def);
538 
551 VdoQuad32i vdo_map_get_quad32i(const VdoMap *self, const gchar *name, VdoQuad32i def);
552 
565 VdoQuad32u vdo_map_get_quad32u(const VdoMap *self, const gchar *name, VdoQuad32u def);
566 
568 void vdo_map_set_byte(VdoMap *self, const gchar *name, guchar value);
569 void vdo_map_set_int16(VdoMap *self, const gchar *name, gint16 value);
570 void vdo_map_set_uint16(VdoMap *self, const gchar *name, guint16 value);
571 void vdo_map_set_uint32x2(VdoMap *self, const gchar *name, const guint32 value[2]);
572 void vdo_map_set_uint32x4(VdoMap *self, const gchar *name, const guint32 value[4]);
573 void vdo_map_set_doublex4(VdoMap *self, const gchar *name, const gdouble value[4]);
574 
585 void vdo_map_set_boolean(VdoMap *self, const gchar *name, gboolean value);
586 
597 void vdo_map_set_int32(VdoMap *self, const gchar *name, gint32 value);
598 
609 void vdo_map_set_uint32(VdoMap *self, const gchar *name, guint32 value);
610 
621 void vdo_map_set_int64(VdoMap *self, const gchar *name, gint64 value);
622 
633 void vdo_map_set_uint64(VdoMap *self, const gchar *name, guint64 value);
634 
645 void vdo_map_set_double(VdoMap *self, const gchar *name, gdouble value);
646 
657 void vdo_map_set_string(VdoMap *self, const gchar *name, const gchar *value);
658 
669 void vdo_map_set_pair32i(VdoMap *self, const gchar *name, VdoPair32i value);
670 
681 void vdo_map_set_pair32u(VdoMap *self, const gchar *name, VdoPair32u value);
682 
693 void vdo_map_set_quad32i(VdoMap *self, const gchar *name, VdoQuad32i value);
694 
705 void vdo_map_set_quad32u(VdoMap *self, const gchar *name, VdoQuad32u value);
706 
707 G_END_DECLS
708 
709 #endif
A class representing a dictionary mapping keys to values.
guint32 vdo_map_get_uint32(const VdoMap *self, const gchar *name, guint32 def)
Returns the value which the key name is associated with.
guint64 vdo_map_get_uint64(const VdoMap *self, const gchar *name, guint64 def)
Returns the value which the key name is associated with.
gboolean vdo_map_equals(const VdoMap *self, const VdoMap *map)
Checks if all entries in this map and the specified map are equal.
gint32 vdo_map_get_int32(const VdoMap *self, const gchar *name, gint32 def)
Returns the value which the key name is associated with.
gboolean vdo_map_get_boolean(const VdoMap *self, const gchar *name, gboolean def)
Returns the value which the key name is associated with.
void vdo_map_set_pair32i(VdoMap *self, const gchar *name, VdoPair32i value)
Sets the value associated with the specified key.
gboolean vdo_map_contains_strv(const VdoMap *self, const gchar *const *names)
Checks if this map contains the specified set of keys.
void vdo_map_set_quad32u(VdoMap *self, const gchar *name, VdoQuad32u value)
Sets the value associated with the specified key.
void vdo_map_swap(VdoMap *lhs, VdoMap *rhs)
Swaps the contents of two maps.
void vdo_map_copy_value(VdoMap *self, const gchar *src, const gchar *dst)
Copies the value associated with the key src to an entry with the key dst.
gboolean vdo_map_empty(const VdoMap *self)
Checks if this map is empty.
void vdo_map_set_uint64(VdoMap *self, const gchar *name, guint64 value)
Sets the value associated with the specified key.
gboolean vdo_map_contains_va(const VdoMap *self,...)
Checks if this map contains the specified set of keys.
VdoMap * vdo_map_filter_prefix(const VdoMap *self, const gchar *prefix)
Returns a new map containing all entries from this map with a key that matches the specified prefix.
gchar * vdo_map_dup_string(const VdoMap *self, const gchar *name, const gchar *def)
Returns the value which the key name is associated with.
VdoMap * vdo_map_filter_strv(const VdoMap *self, const gchar *const *names)
Returns a new map containing all entries from this map with the specified keys.
void vdo_map_remove(VdoMap *self, const gchar *name)
Removes the entry with the specified key from this map.
const gchar * vdo_map_get_string(const VdoMap *self, const gchar *name, gsize *size, const gchar *def)
Returns the value which the key name is associated with.
gboolean vdo_map_equals_strv(const VdoMap *self, const VdoMap *map, const gchar *const *names)
Checks if all of the specified entries in this map and the specified map are equal.
VdoQuad32u vdo_map_get_quad32u(const VdoMap *self, const gchar *name, VdoQuad32u def)
Returns the value which the key name is associated with.
void vdo_map_set_quad32i(VdoMap *self, const gchar *name, VdoQuad32i value)
Sets the value associated with the specified key.
VdoPair32i vdo_map_get_pair32i(const VdoMap *self, const gchar *name, VdoPair32i def)
Returns the value which the key name is associated with.
void vdo_map_set_boolean(VdoMap *self, const gchar *name, gboolean value)
Sets the value associated with the specified key.
VdoMap * vdo_map_new(void)
Constructs a new empty VdoMap.
void vdo_map_dump(const VdoMap *self)
Print a string representation of this map to stdout.
void vdo_map_set_double(VdoMap *self, const gchar *name, gdouble value)
Sets the value associated with the specified key.
void vdo_map_set_uint32(VdoMap *self, const gchar *name, guint32 value)
Sets the value associated with the specified key.
void vdo_map_set_pair32u(VdoMap *self, const gchar *name, VdoPair32u value)
Sets the value associated with the specified key.
VdoQuad32i vdo_map_get_quad32i(const VdoMap *self, const gchar *name, VdoQuad32i def)
Returns the value which the key name is associated with.
VdoMap * vdo_map_clone(const VdoMap *other)
Creates a deep copy of the specified VdoMap.
gsize vdo_map_size(const VdoMap *self)
Returns the number of entries in this map.
gboolean vdo_map_entry_updates(const VdoMap *self, const VdoMap *map, const gchar *name)
Checks if the specified key in the specified map is mapped to a value that differs from the one in th...
void vdo_map_set_string(VdoMap *self, const gchar *name, const gchar *value)
Sets the value associated with the specified key.
gboolean vdo_map_entry_equals(const VdoMap *self, const VdoMap *map, const gchar *name)
Checks if the specified entry in this map and the specified map are equal.
void vdo_map_remove_va(VdoMap *self,...)
Removes all entries with the specified keys from this map.
void vdo_map_clear(VdoMap *self)
Removes all of the entries from this map.
gdouble vdo_map_get_double(const VdoMap *self, const gchar *name, gdouble def)
Returns the value which the key name is associated with.
void vdo_map_set_int32(VdoMap *self, const gchar *name, gint32 value)
Sets the value associated with the specified key.
VdoPair32u vdo_map_get_pair32u(const VdoMap *self, const gchar *name, VdoPair32u def)
Returns the value which the key name is associated with.
void vdo_map_set_int64(VdoMap *self, const gchar *name, gint64 value)
Sets the value associated with the specified key.
gint64 vdo_map_get_int64(const VdoMap *self, const gchar *name, gint64 def)
Returns the value which the key name is associated with.
void vdo_map_merge(VdoMap *self, const VdoMap *map)
Merges the specified map into this map.
VdoMap * vdo_map_filter_va(const VdoMap *self,...)
Returns a new map containing all entries from this map with the specified keys.
gboolean vdo_map_equals_va(const VdoMap *self, const VdoMap *map,...)
Checks if all of the specified entries in this map and the specified map are equal.
void vdo_map_remove_strv(VdoMap *self, const gchar *const *names)
Removes all entries with the specified keys from this map.
gboolean vdo_map_contains(const VdoMap *self, const gchar *name)
Checks if this map contains the specified key.
VDO common type definitions.