The base class used to wrap glib's GVariant API. More...
#include <glibmm/variant.h>
Public Member Functions | |
VariantBase () | |
VariantBase (GVariant* castitem, bool make_a_copy=false) | |
VariantBase (const VariantBase& src) | |
VariantBase& | operator= (const VariantBase& src) |
~VariantBase () | |
GVariant* | gobj () |
const GVariant* | gobj () const |
GVariant* | gobj_copy () const |
Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs. | |
void | init (const GVariant* cobject, bool take_a_reference=false) |
Replace the underlying GVariant. | |
VariantType | get_type () const |
Determines the type of value. | |
std::string | get_type_string () const |
Returns the type string of value. | |
bool | is_floating () const |
bool | is_of_type (const VariantType& type) const |
Checks if a value has a type matching the provided type. | |
bool | is_container () const |
Checks if value is a container. | |
GVariantClass | classify () const |
Classifies value according to its top-level type. | |
Glib::ustring | print (bool type_annotate=false) const |
Pretty-prints value in the format understood by g_variant_parse(). | |
guint | hash () const |
Generates a hash value for a Variant instance. | |
bool | equal (const VariantBase& other) const |
Checks if one and two have the same type and value. | |
void | get_normal_form (VariantBase& result) const |
Gets a VariantBase instance that has the same value as this variant and is trusted to be in normal form. | |
bool | is_normal_form () const |
Checks if value is in normal form. | |
void | byteswap (VariantBase& result) const |
Performs a byteswapping operation on the contents of this variant. | |
Protected Attributes | |
GVariant* | gobject_ |
Related Functions | |
(Note that these are not member functions.) | |
Glib::VariantBase | wrap (GVariant* object, bool take_copy=false) |
A Glib::wrap() method for this object. |
The base class used to wrap glib's GVariant API.
Glib::VariantBase::VariantBase | ( | ) |
Glib::VariantBase::VariantBase | ( | GVariant * | castitem, | |
bool | make_a_copy = false | |||
) | [explicit] |
Glib::VariantBase::VariantBase | ( | const VariantBase& | src | ) |
Glib::VariantBase::~VariantBase | ( | ) |
void Glib::VariantBase::byteswap | ( | VariantBase& | result | ) | const |
Performs a byteswapping operation on the contents of this variant.
The result is that all multi-byte numeric data contained in the variant is byteswapped. That includes 16, 32, and 64bit signed and unsigned integers as well as file handles and double precision floating point values.
This function is an identity mapping on any value that does not contain multi-byte numeric data. That include strings, booleans, bytes and containers containing only these things (recursively).
The returned value is always in normal form and is marked as trusted.
result | : A Location in which to store the byteswapped form of this variant. |
GVariantClass Glib::VariantBase::classify | ( | ) | const |
Classifies value according to its top-level type.
bool Glib::VariantBase::equal | ( | const VariantBase& | other | ) | const |
Checks if one and two have the same type and value.
The types of one and two are gconstpointer only to allow use of this function with HashTable. They must each be a Variant.
true
if one and two are equal. void Glib::VariantBase::get_normal_form | ( | VariantBase& | result | ) | const |
Gets a VariantBase instance that has the same value as this variant and is trusted to be in normal form.
If this variant is already trusted to be in normal form then a new reference to the variant is returned.
If this variant is not already trusted, then it is scanned to check if it is in normal form. If it is found to be in normal form then it is marked as trusted and a new reference to it is returned.
If this variant is found not to be in normal form then a new trusted VariantBase is created with the same value as this variant.
It makes sense to call this function if you've received variant data from untrusted sources and you want to ensure your serialised output is definitely in normal form.
result | A Location in which to store the trusted VariantBase. |
VariantType Glib::VariantBase::get_type | ( | ) | const |
Determines the type of value.
The return value is valid for the lifetime of value and must not be freed.
std::string Glib::VariantBase::get_type_string | ( | ) | const |
Returns the type string of value.
Unlike the result of calling g_variant_type_peek_string(), this string is nul-terminated. This string belongs to Variant and must not be freed.
const GVariant* Glib::VariantBase::gobj | ( | ) | const [inline] |
GVariant* Glib::VariantBase::gobj | ( | ) | [inline] |
GVariant* Glib::VariantBase::gobj_copy | ( | ) | const |
Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
guint Glib::VariantBase::hash | ( | ) | const |
Generates a hash value for a Variant instance.
The output of this function is guaranteed to be the same for a given value only per-process. It may change between different processor architectures or even different versions of GLib. Do not use this function as a basis for building protocols or file formats.
The type of value is gconstpointer only to allow use of this function with HashTable. value must be a Variant.
value | A basic Variant value as a gconstpointer. |
void Glib::VariantBase::init | ( | const GVariant * | cobject, | |
bool | take_a_reference = false | |||
) |
Replace the underlying GVariant.
This is for use by methods that take a VariantBase& as an output parameter.
cobject | The GVariant* obtained from a C function. | |
take_a_reference | Whether this method should take a reference, for instance if the C function has not given one. |
bool Glib::VariantBase::is_container | ( | ) | const |
Checks if value is a container.
true
if value is a container. bool Glib::VariantBase::is_floating | ( | ) | const |
bool Glib::VariantBase::is_normal_form | ( | ) | const |
Checks if value is in normal form.
The main reason to do this is to detect if a given chunk of serialised data is in normal form: load the data into a Variant using Glib::variant_create_from_data() and then use this function to check.
If value is found to be in normal form then it will be marked as being trusted. If the value was already marked as being trusted then this function will immediately return true
.
true
if value is in normal form. bool Glib::VariantBase::is_of_type | ( | const VariantType& | type | ) | const |
Checks if a value has a type matching the provided type.
type | A VariantType. |
true
if the type of value matches type. VariantBase& Glib::VariantBase::operator= | ( | const VariantBase& | src | ) |
Glib::ustring Glib::VariantBase::print | ( | bool | type_annotate = false |
) | const |
Pretty-prints value in the format understood by g_variant_parse().
If type_annotate is true
, then type information is included in the output.
type_annotate | true if type information should be included in the output. |
Glib::VariantBase wrap | ( | GVariant * | object, | |
bool | take_copy = false | |||
) | [related] |
A Glib::wrap() method for this object.
object | The C instance. | |
take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref. |
GVariant* Glib::VariantBase::gobject_ [protected] |