| Top |
| GVariant | |
| enum | GVariantClass |
| struct | GVariantIter |
| struct | GVariantBuilder |
| struct | GVariantDict |
| enum | GVariantParseError |
GVariant is a variant datatype; it stores a value along with information about the type of that value. The range of possible values is determined by the type. The type system used by GVariant is GVariantType.
GVariant instances always have a type and a value (which are given at construction time). The type and value of a GVariant instance can never change other than by the GVariant itself being destroyed. A GVariant cannot contain a pointer.
GVariant is reference counted using g_variant_ref()
and
g_variant_unref()
. GVariant also has floating reference counts --
see g_variant_ref_sink()
.
GVariant is completely threadsafe. A GVariant instance can be concurrently accessed in any way from any number of threads without problems.
GVariant is heavily optimised for dealing with data in serialised form. It works particularly well with data located in memory-mapped files. It can perform nearly all deserialisation operations in a small constant time, usually touching only a single memory page. Serialised GVariant data can also be sent over the network.
GVariant is largely compatible with D-Bus. Almost all types of GVariant instances can be sent over D-Bus. See GVariantType for exceptions. (However, GVariant's serialisation format is not the same as the serialisation format of a D-Bus message body: use GDBusMessage, in the gio library, for those.)
For space-efficiency, the GVariant serialisation format does not
automatically include the variant's length, type or endianness,
which must either be implied from context (such as knowledge that a
particular file format always contains a little-endian
G_VARIANT_TYPE_VARIANT
which occupies the whole length of the file)
or supplied out-of-band (for instance, a length, type and/or endianness
indicator could be placed at the beginning of a file, network message
or network stream).
A GVariant's size is limited mainly by any lower level operating
system constraints, such as the number of bits in gsize. For
example, it is reasonable to have a 2GB file mapped into memory
with GMappedFile, and call g_variant_new_from_data()
on it.
For convenience to C programmers, GVariant features powerful varargs-based value construction and destruction. This feature is designed to be embedded in other libraries.
There is a Python-inspired text language for describing GVariant values. GVariant includes a printer for this language and a parser with type inferencing.
GVariant tries to be quite efficient with respect to memory use. This section gives a rough idea of how much memory is used by the current implementation. The information here is subject to change in the future.
The memory allocated by GVariant can be grouped into 4 broad purposes: memory for serialised data, memory for the type information cache, buffer management memory and memory for the GVariant structure itself.
This is the memory that is used for storing GVariant data in serialised form. This is what would be sent over the network or what would end up on disk, not counting any indicator of the endianness, or of the length or type of the top-level variant.
The amount of memory required to store a boolean is 1 byte. 16, 32 and 64 bit integers and double precision floating point numbers use their "natural" size. Strings (including object path and signature strings) are stored with a nul terminator, and as such use the length of the string plus 1 byte.
Maybe types use no space at all to represent the null value and use the same amount of space (sometimes plus one byte) as the equivalent non-maybe-typed value to represent the non-null case.
Arrays use the amount of space required to store each of their members, concatenated. Additionally, if the items stored in an array are not of a fixed-size (ie: strings, other arrays, etc) then an additional framing offset is stored for each item. The size of this offset is either 1, 2 or 4 bytes depending on the overall size of the container. Additionally, extra padding bytes are added as required for alignment of child values.
Tuples (including dictionary entries) use the amount of space required to store each of their members, concatenated, plus one framing offset (as per arrays) for each non-fixed-sized item in the tuple, except for the last one. Additionally, extra padding bytes are added as required for alignment of child values.
Variants use the same amount of space as the item inside of the variant, plus 1 byte, plus the length of the type string for the item inside the variant.
As an example, consider a dictionary mapping strings to variants. In the case that the dictionary is empty, 0 bytes are required for the serialisation.
If we add an item "width" that maps to the int32 value of 500 then we will use 4 byte to store the int32 (so 6 for the variant containing it) and 6 bytes for the string. The variant must be aligned to 8 after the 6 bytes of the string, so that's 2 extra bytes. 6 (string) + 2 (padding) + 6 (variant) is 14 bytes used for the dictionary entry. An additional 1 byte is added to the array as a framing offset making a total of 15 bytes.
If we add another entry, "title" that maps to a nullable string that happens to have a value of null, then we use 0 bytes for the null value (and 3 bytes for the variant to contain it along with its type string) plus 6 bytes for the string. Again, we need 2 padding bytes. That makes a total of 6 + 2 + 3 = 11 bytes.
We now require extra padding between the two items in the array. After the 14 bytes of the first item, that's 2 bytes required. We now require 2 framing offsets for an extra two bytes. 14 + 2 + 11 + 2 = 29 bytes to encode the entire two-item dictionary.
For each GVariant type that currently exists in the program a type information structure is kept in the type information cache. The type information structure is required for rapid deserialisation.
Continuing with the above example, if a GVariant exists with the type "a{sv}" then a type information struct will exist for "a{sv}", "{sv}", "s", and "v". Multiple uses of the same type will share the same type information. Additionally, all single-digit types are stored in read-only static memory and do not contribute to the writable memory footprint of a program using GVariant.
Aside from the type information structures stored in read-only memory, there are two forms of type information. One is used for container types where there is a single element type: arrays and maybe types. The other is used for container types where there are multiple element types: tuples and dictionary entries.
Array type info structures are 6 * sizeof (void *), plus the memory required to store the type string itself. This means that on 32-bit systems, the cache entry for "a{sv}" would require 30 bytes of memory (plus malloc overhead).
Tuple type info structures are 6 * sizeof (void *), plus 4 * sizeof (void *) for each item in the tuple, plus the memory required to store the type string itself. A 2-item tuple, for example, would have a type information structure that consumed writable memory in the size of 14 * sizeof (void *) (plus type string) This means that on 32-bit systems, the cache entry for "{sv}" would require 61 bytes of memory (plus malloc overhead).
This means that in total, for our "a{sv}" example, 91 bytes of type information would be allocated.
The type information cache, additionally, uses a GHashTable to store and lookup the cached items and stores a pointer to this hash table in static storage. The hash table is freed when there are zero items in the type cache.
Although these sizes may seem large it is important to remember that a program will probably only have a very small number of different types of values in it and that only one type information structure is required for many different values of the same type.
GVariant uses an internal buffer management structure to deal
with the various different possible sources of serialised data
that it uses. The buffer is responsible for ensuring that the
correct call is made when the data is no longer in use by
GVariant. This may involve a g_free()
or a g_slice_free()
or
even g_mapped_file_unref()
.
One buffer management structure is used for each chunk of serialised data. The size of the buffer management structure is 4 * (void *). On 32-bit systems, that's 16 bytes.
The size of a GVariant structure is 6 * (void *). On 32-bit systems, that's 24 bytes.
GVariant structures only exist if they are explicitly created with API calls. For example, if a GVariant is constructed out of serialised data for the example given above (with the dictionary) then although there are 9 individual values that comprise the entire dictionary (two keys, two values, two variants containing the values, two dictionary entries, plus the dictionary itself), only 1 GVariant instance exists -- the one referring to the dictionary.
If calls are made to start accessing the other values then
GVariant instances will exist for those values only for as long
as they are in use (ie: until you call g_variant_unref()
). The
type information is shared. The serialised data and the buffer
management structure for that serialised data is shared by the
child.
To put the entire example together, for our dictionary mapping
strings to variants (with two entries, as given above), we are
using 91 bytes of memory for type information, 29 byes of memory
for the serialised data, 16 bytes for buffer management and 24
bytes for the GVariant instance, or a total of 160 bytes, plus
malloc overhead. If we were to use g_variant_get_child_value()
to
access the two dictionary entries, we would use an additional 48
bytes. If we were to have other dictionaries of the same type, we
would use more memory for the serialised data and buffer
management for those dictionaries, but the type information would
be shared.
void
g_variant_unref (GVariant *value
);
Decreases the reference count of value
. When its reference count
drops to 0, the memory used by the variant is freed.
Since 2.24
GVariant *
g_variant_ref (GVariant *value
);
Increases the reference count of value
.
Since 2.24
GVariant *
g_variant_ref_sink (GVariant *value
);
GVariant uses a floating reference count system. All functions with
names starting with g_variant_new_
return floating
references.
Calling g_variant_ref_sink()
on a GVariant with a floating reference
will convert the floating reference into a full reference. Calling
g_variant_ref_sink()
on a non-floating GVariant results in an
additional normal reference being added.
In other words, if the value
is floating, then this call "assumes
ownership" of the floating reference, converting it to a normal
reference. If the value
is not floating, then this call adds a
new normal reference increasing the reference count by one.
All calls that result in a GVariant instance being inserted into a
container will call g_variant_ref_sink()
on the instance. This means
that if the value was just created (and has only its floating
reference) then the container will assume sole ownership of the value
at that point and the caller will not need to unreference it. This
makes certain common styles of programming much easier while still
maintaining normal refcounting semantics in situations where values
are not floating.
Since 2.24
gboolean
g_variant_is_floating (GVariant *value
);
Checks whether value
has a floating reference count.
This function should only ever be used to assert that a given variant
is or is not floating, or for debug purposes. To acquire a reference
to a variant that might be floating, always use g_variant_ref_sink()
or g_variant_take_ref()
.
See g_variant_ref_sink()
for more information about floating reference
counts.
Since 2.26
GVariant *
g_variant_take_ref (GVariant *value
);
If value
is floating, sink it. Otherwise, do nothing.
Typically you want to use g_variant_ref_sink()
in order to
automatically do the correct thing with respect to floating or
non-floating references, but there is one specific scenario where
this function is helpful.
The situation where this function is helpful is when creating an API that allows the user to provide a callback function that returns a GVariant. We certainly want to allow the user the flexibility to return a non-floating reference from this callback (for the case where the value that is being returned already exists).
At the same time, the style of the GVariant API makes it likely that for newly-created GVariant instances, the user can be saved some typing if they are allowed to return a GVariant with a floating reference.
Using this function on the return value of the user's callback allows the user to do whichever is more convenient for them. The caller will alway receives exactly one full reference to the value: either the one that was returned in the first place, or a floating reference that has been converted to a full reference.
This function has an odd interaction when combined with
g_variant_ref_sink()
running at the same time in another thread on
the same GVariant instance. If g_variant_ref_sink()
runs first then
the result will be that the floating reference is converted to a hard
reference. If g_variant_take_ref()
runs first then the result will
be that the floating reference is converted to a hard reference and
an additional reference on top of that one is added. It is best to
avoid this situation.
const GVariantType *
g_variant_get_type (GVariant *value
);
Determines the type of value
.
The return value is valid for the lifetime of value
and must not
be freed.
Since 2.24
const gchar *
g_variant_get_type_string (GVariant *value
);
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 GVariant and must not be freed.
Since 2.24
gboolean g_variant_is_of_type (GVariant *value
,const GVariantType *type
);
Checks if a value has a type matching the provided type.
Since 2.24
gboolean
g_variant_is_container (GVariant *value
);
Checks if value
is a container.
Since 2.24
gint g_variant_compare (gconstpointer one
,gconstpointer two
);
Compares one
and two
.
The types of one
and two
are gconstpointer only to allow use of
this function with GTree, GPtrArray, etc. They must each be a
GVariant.
Comparison is only defined for basic types (ie: booleans, numbers,
strings). For booleans, FALSE
is less than TRUE
. Numbers are
ordered in the usual way. Strings are in ASCII lexographical order.
It is a programmer error to attempt to compare container values or two values that have types that are not exactly equal. For example, you cannot compare a 32-bit signed integer with a 32-bit unsigned integer. Also note that this function is not particularly well-behaved when it comes to comparison of doubles; in particular, the handling of incomparable values (ie: NaN) is undefined.
If you only require an equality comparison, g_variant_equal()
is more
general.
Since 2.26
GVariantClass
g_variant_classify (GVariant *value
);
Classifies value
according to its top-level type.
Since 2.24
gboolean g_variant_check_format_string (GVariant *value
,const gchar *format_string
,gboolean copy_only
);
Checks if calling g_variant_get()
with format_string
on value
would
be valid from a type-compatibility standpoint. format_string
is
assumed to be a valid format string (from a syntactic standpoint).
If copy_only
is TRUE
then this function additionally checks that it
would be safe to call g_variant_unref()
on value
immediately after
the call to g_variant_get()
without invalidating the result. This is
only possible if deep copies are made (ie: there are no pointers to
the data inside of the soon-to-be-freed GVariant instance). If this
check fails then a g_critical()
is printed and FALSE
is returned.
This function is meant to be used by functions that wish to provide
varargs accessors to GVariant values of uncertain values (eg:
g_variant_lookup()
or g_menu_model_get_item_attribute()
).
Since 2.34
void g_variant_get (GVariant *value
,const gchar *format_string
,...
);
Deconstructs a GVariant instance.
Think of this function as an analogue to scanf()
.
The arguments that are expected by this function are entirely
determined by format_string
. format_string
also restricts the
permissible types of value
. It is an error to give a value with
an incompatible type. See the section on
GVariant format strings.
Please note that the syntax of the format string is very likely to be
extended in the future.
format_string
determines the C types that are used for unpacking
the values and also determines if the values are copied or borrowed,
see the section on
GVariant format strings.
Since 2.24
void g_variant_get_va (GVariant *value
,const gchar *format_string
,const gchar **endptr
,va_list *app
);
This function is intended to be used by libraries based on GVariant
that want to provide g_variant_get()
-like functionality to their
users.
The API is more general than g_variant_get()
to allow a wider range
of possible uses.
format_string
must still point to a valid format string, but it only
need to be nul-terminated if endptr
is NULL
. If endptr
is
non-NULL
then it is updated to point to the first character past the
end of the format string.
app
is a pointer to a va_list. The arguments, according to
format_string
, are collected from this va_list and the list is left
pointing to the argument following the last.
These two generalisations allow mixing of multiple calls to
g_variant_new_va()
and g_variant_get_va()
within a single actual
varargs call by the user.
format_string
determines the C types that are used for unpacking
the values and also determines if the values are copied or borrowed,
see the section on
GVariant format strings.
Since 2.24
GVariant * g_variant_new (const gchar *format_string
,...
);
Creates a new GVariant instance.
Think of this function as an analogue to g_strdup_printf()
.
The type of the created instance and the arguments that are expected
by this function are determined by format_string
. See the section on
GVariant format strings. Please note that
the syntax of the format string is very likely to be extended in the
future.
The first character of the format string must not be '*' '?' '@' or 'r'; in essence, a new GVariant must always be constructed by this function (and not merely passed through it unmodified).
Note that the arguments must be of the correct width for their types
specified in format_string
. This can be achieved by casting them. See
the GVariant varargs documentation.
1 2 3 4 5 6 7 8 |
MyFlags some_flags = FLAG_ONE | FLAG_TWO; const gchar *some_strings[] = { "a", "b", "c", NULL }; GVariant *new_variant; new_variant = g_variant_new ("(t^as)", /<!-- -->* This cast is required. *<!-- -->/ (guint64) some_flags, some_strings); |
Since 2.24
GVariant * g_variant_new_va (const gchar *format_string
,const gchar **endptr
,va_list *app
);
This function is intended to be used by libraries based on
GVariant that want to provide g_variant_new()
-like functionality
to their users.
The API is more general than g_variant_new()
to allow a wider range
of possible uses.
format_string
must still point to a valid format string, but it only
needs to be nul-terminated if endptr
is NULL
. If endptr
is
non-NULL
then it is updated to point to the first character past the
end of the format string.
app
is a pointer to a va_list. The arguments, according to
format_string
, are collected from this va_list and the list is left
pointing to the argument following the last.
Note that the arguments in app
must be of the correct width for their
types specified in format_string
when collected into the va_list.
See the [GVariant varargs documentation][gvariant-varargs.
These two generalisations allow mixing of multiple calls to
g_variant_new_va()
and g_variant_get_va()
within a single actual
varargs call by the user.
The return value will be floating if it was a newly created GVariant instance (for example, if the format string was "(ii)"). In the case that the format_string was '*', '?', 'r', or a format starting with '@' then the collected GVariant pointer will be returned unmodified, without adding any additional references.
In order to behave correctly in all cases it is necessary for the
calling function to g_variant_ref_sink()
the return result before
returning control to the user that originally provided the pointer.
At this point, the caller will have their own full reference to the
result. This can also be done by adding the result to a container,
or by passing it to another g_variant_new()
call.
format_string |
a string that is prefixed with a format string |
|
endptr |
location to store the end pointer,
or |
[allow-none][default NULL] |
app |
a pointer to a va_list |
Since 2.24
GVariant *
g_variant_new_boolean (gboolean value
);
Creates a new boolean GVariant instance -- either TRUE
or FALSE
.
Since 2.24
GVariant *
g_variant_new_byte (guchar value
);
Creates a new byte GVariant instance.
Since 2.24
GVariant *
g_variant_new_int16 (gint16 value
);
Creates a new int16 GVariant instance.
Since 2.24
GVariant *
g_variant_new_uint16 (guint16 value
);
Creates a new uint16 GVariant instance.
Since 2.24
GVariant *
g_variant_new_int32 (gint32 value
);
Creates a new int32 GVariant instance.
Since 2.24
GVariant *
g_variant_new_uint32 (guint32 value
);
Creates a new uint32 GVariant instance.
Since 2.24
GVariant *
g_variant_new_int64 (gint64 value
);
Creates a new int64 GVariant instance.
Since 2.24
GVariant *
g_variant_new_uint64 (guint64 value
);
Creates a new uint64 GVariant instance.
Since 2.24
GVariant *
g_variant_new_handle (gint32 value
);
Creates a new handle GVariant instance.
By convention, handles are indexes into an array of file descriptors that are sent alongside a D-Bus message. If you're not interacting with D-Bus, you probably don't need them.
Since 2.24
GVariant *
g_variant_new_double (gdouble value
);
Creates a new double GVariant instance.
Since 2.24
GVariant *
g_variant_new_string (const gchar *string
);
Creates a string GVariant with the contents of string
.
string
must be valid utf8.
Since 2.24
GVariant *
g_variant_new_take_string (gchar *string
);
Creates a string GVariant with the contents of string
.
string
must be valid utf8.
This function consumes string
. g_free()
will be called on string
when it is no longer required.
You must not modify or access string
in any other way after passing
it to this function. It is even possible that string
is immediately
freed.
Since 2.38
GVariant * g_variant_new_printf (const gchar *format_string
,...
);
Creates a string-type GVariant using printf formatting.
This is similar to calling g_strdup_printf()
and then
g_variant_new_string()
but it saves a temporary variable and an
unnecessary copy.
Since 2.38
GVariant *
g_variant_new_object_path (const gchar *object_path
);
Creates a D-Bus object path GVariant with the contents of string
.
string
must be a valid D-Bus object path. Use
g_variant_is_object_path()
if you're not sure.
Since 2.24
gboolean
g_variant_is_object_path (const gchar *string
);
Determines if a given string is a valid D-Bus object path. You
should ensure that a string is a valid D-Bus object path before
passing it to g_variant_new_object_path()
.
A valid object path starts with '/' followed by zero or more sequences of characters separated by '/' characters. Each sequence must contain only the characters "A-Z[0-9]_". No sequence (including the one following the final '/' character) may be empty.
Since 2.24
GVariant *
g_variant_new_signature (const gchar *signature
);
Creates a D-Bus type signature GVariant with the contents of
string
. string
must be a valid D-Bus type signature. Use
g_variant_is_signature()
if you're not sure.
Since 2.24
gboolean
g_variant_is_signature (const gchar *string
);
Determines if a given string is a valid D-Bus type signature. You
should ensure that a string is a valid D-Bus type signature before
passing it to g_variant_new_signature()
.
D-Bus type signatures consist of zero or more definite GVariantType strings in sequence.
Since 2.24
GVariant *
g_variant_new_variant (GVariant *value
);
Boxes value
. The result is a GVariant instance representing a
variant containing the original value.
If child
is a floating reference (see g_variant_ref_sink()
), the new
instance takes ownership of child
.
Since 2.24
GVariant * g_variant_new_strv (const gchar * const *strv
,gssize length
);
Constructs an array of strings GVariant from the given array of strings.
If length
is -1 then strv
is NULL
-terminated.
strv |
an array of strings. |
[array length=length][element-type utf8] |
length |
the length of |
Since 2.24
GVariant * g_variant_new_objv (const gchar * const *strv
,gssize length
);
Constructs an array of object paths GVariant from the given array of strings.
Each string must be a valid GVariant object path; see
g_variant_is_object_path()
.
If length
is -1 then strv
is NULL
-terminated.
strv |
an array of strings. |
[array length=length][element-type utf8] |
length |
the length of |
Since 2.30
GVariant *
g_variant_new_bytestring (const gchar *string
);
Creates an array-of-bytes GVariant with the contents of string
.
This function is just like g_variant_new_string()
except that the
string need not be valid utf8.
The nul terminator character at the end of the string is stored in the array.
string |
a normal nul-terminated string in no particular encoding. |
[array zero-terminated=1][element-type guint8] |
Since 2.26
GVariant * g_variant_new_bytestring_array (const gchar * const *strv
,gssize length
);
Constructs an array of bytestring GVariant from the given array of strings.
If length
is -1 then strv
is NULL
-terminated.
Since 2.26
gboolean
g_variant_get_boolean (GVariant *value
);
Returns the boolean value of value
.
It is an error to call this function with a value
of any type
other than G_VARIANT_TYPE_BOOLEAN
.
Since 2.24
guchar
g_variant_get_byte (GVariant *value
);
Returns the byte value of value
.
It is an error to call this function with a value
of any type
other than G_VARIANT_TYPE_BYTE
.
Since 2.24
gint16
g_variant_get_int16 (GVariant *value
);
Returns the 16-bit signed integer value of value
.
It is an error to call this function with a value
of any type
other than G_VARIANT_TYPE_INT16
.
Since 2.24
guint16
g_variant_get_uint16 (GVariant *value
);
Returns the 16-bit unsigned integer value of value
.
It is an error to call this function with a value
of any type
other than G_VARIANT_TYPE_UINT16
.
Since 2.24
gint32
g_variant_get_int32 (GVariant *value
);
Returns the 32-bit signed integer value of value
.
It is an error to call this function with a value
of any type
other than G_VARIANT_TYPE_INT32
.
Since 2.24
guint32
g_variant_get_uint32 (GVariant *value
);
Returns the 32-bit unsigned integer value of value
.
It is an error to call this function with a value
of any type
other than G_VARIANT_TYPE_UINT32
.
Since 2.24
gint64
g_variant_get_int64 (GVariant *value
);
Returns the 64-bit signed integer value of value
.
It is an error to call this function with a value
of any type
other than G_VARIANT_TYPE_INT64
.
Since 2.24
guint64
g_variant_get_uint64 (GVariant *value
);
Returns the 64-bit unsigned integer value of value
.
It is an error to call this function with a value
of any type
other than G_VARIANT_TYPE_UINT64
.
Since 2.24
gint32
g_variant_get_handle (GVariant *value
);
Returns the 32-bit signed integer value of value
.
It is an error to call this function with a value
of any type other
than G_VARIANT_TYPE_HANDLE
.
By convention, handles are indexes into an array of file descriptors that are sent alongside a D-Bus message. If you're not interacting with D-Bus, you probably don't need them.
Since 2.24
gdouble
g_variant_get_double (GVariant *value
);
Returns the double precision floating point value of value
.
It is an error to call this function with a value
of any type
other than G_VARIANT_TYPE_DOUBLE
.
Since 2.24
const gchar * g_variant_get_string (GVariant *value
,gsize *length
);
Returns the string value of a GVariant instance with a string
type. This includes the types G_VARIANT_TYPE_STRING
,
G_VARIANT_TYPE_OBJECT_PATH
and G_VARIANT_TYPE_SIGNATURE
.
The string will always be utf8 encoded.
If length
is non-NULL
then the length of the string (in bytes) is
returned there. For trusted values, this information is already
known. For untrusted values, a strlen()
will be performed.
It is an error to call this function with a value
of any type
other than those three.
The return value remains valid as long as value
exists.
Since 2.24
gchar * g_variant_dup_string (GVariant *value
,gsize *length
);
Similar to g_variant_get_string()
except that instead of returning
a constant string, the string is duplicated.
The string will always be utf8 encoded.
The return value must be freed using g_free()
.
Since 2.24
GVariant *
g_variant_get_variant (GVariant *value
);
Unboxes value
. The result is the GVariant instance that was
contained in value
.
Since 2.24
const gchar ** g_variant_get_strv (GVariant *value
,gsize *length
);
Gets the contents of an array of strings GVariant. This call
makes a shallow copy; the return result should be released with
g_free()
, but the individual strings must not be modified.
If length
is non-NULL
then the number of elements in the result
is stored there. In any case, the resulting array will be
NULL
-terminated.
For an empty array, length
will be set to 0 and a pointer to a
NULL
pointer will be returned.
Since 2.24
gchar ** g_variant_dup_strv (GVariant *value
,gsize *length
);
Gets the contents of an array of strings GVariant. This call
makes a deep copy; the return result should be released with
g_strfreev()
.
If length
is non-NULL
then the number of elements in the result
is stored there. In any case, the resulting array will be
NULL
-terminated.
For an empty array, length
will be set to 0 and a pointer to a
NULL
pointer will be returned.
Since 2.24
const gchar ** g_variant_get_objv (GVariant *value
,gsize *length
);
Gets the contents of an array of object paths GVariant. This call
makes a shallow copy; the return result should be released with
g_free()
, but the individual strings must not be modified.
If length
is non-NULL
then the number of elements in the result
is stored there. In any case, the resulting array will be
NULL
-terminated.
For an empty array, length
will be set to 0 and a pointer to a
NULL
pointer will be returned.
Since 2.30
gchar ** g_variant_dup_objv (GVariant *value
,gsize *length
);
Gets the contents of an array of object paths GVariant. This call
makes a deep copy; the return result should be released with
g_strfreev()
.
If length
is non-NULL
then the number of elements in the result
is stored there. In any case, the resulting array will be
NULL
-terminated.
For an empty array, length
will be set to 0 and a pointer to a
NULL
pointer will be returned.
Since 2.30
const gchar *
g_variant_get_bytestring (GVariant *value
);
Returns the string value of a GVariant instance with an array-of-bytes type. The string has no particular encoding.
If the array does not end with a nul terminator character, the empty
string is returned. For this reason, you can always trust that a
non-NULL
nul-terminated string will be returned by this function.
If the array contains a nul terminator character somewhere other than the last byte then the returned string is the string, up to the first such nul character.
It is an error to call this function with a value
that is not an
array of bytes.
The return value remains valid as long as value
exists.
Since 2.26
gchar * g_variant_dup_bytestring (GVariant *value
,gsize *length
);
Similar to g_variant_get_bytestring()
except that instead of
returning a constant string, the string is duplicated.
The return value must be freed using g_free()
.
a newly allocated string.
[transfer full][array zero-terminated=1 length=length][element-type guint8]
Since 2.26
const gchar ** g_variant_get_bytestring_array (GVariant *value
,gsize *length
);
Gets the contents of an array of array of bytes GVariant. This call
makes a shallow copy; the return result should be released with
g_free()
, but the individual strings must not be modified.
If length
is non-NULL
then the number of elements in the result is
stored there. In any case, the resulting array will be
NULL
-terminated.
For an empty array, length
will be set to 0 and a pointer to a
NULL
pointer will be returned.
Since 2.26
gchar ** g_variant_dup_bytestring_array (GVariant *value
,gsize *length
);
Gets the contents of an array of array of bytes GVariant. This call
makes a deep copy; the return result should be released with
g_strfreev()
.
If length
is non-NULL
then the number of elements in the result is
stored there. In any case, the resulting array will be
NULL
-terminated.
For an empty array, length
will be set to 0 and a pointer to a
NULL
pointer will be returned.
Since 2.26
GVariant * g_variant_new_maybe (const GVariantType *child_type
,GVariant *child
);
Depending on if child
is NULL
, either wraps child
inside of a
maybe container or creates a Nothing instance for the given type
.
At least one of child_type
and child
must be non-NULL
.
If child_type
is non-NULL
then it must be a definite type.
If they are both non-NULL
then child_type
must be the type
of child
.
If child
is a floating reference (see g_variant_ref_sink()
), the new
instance takes ownership of child
.
child_type |
the GVariantType of the child, or |
[allow-none] |
child |
the child value, or |
[allow-none] |
Since 2.24
GVariant * g_variant_new_array (const GVariantType *child_type
,GVariant * const *children
,gsize n_children
);
Creates a new GVariant array from children
.
child_type
must be non-NULL
if n_children
is zero. Otherwise, the
child type is determined by inspecting the first element of the
children
array. If child_type
is non-NULL
then it must be a
definite type.
The items of the array are taken from the children
array. No entry
in the children
array may be NULL
.
All items in the array must have the same type, which must be the
same as child_type
, if given.
If the children
are floating references (see g_variant_ref_sink()
), the
new instance takes ownership of them as if via g_variant_ref_sink()
.
child_type |
the element type of the new array. |
[allow-none] |
children |
an array of GVariant pointers, the children. |
[allow-none][array length=n_children] |
n_children |
the length of |
Since 2.24
GVariant * g_variant_new_tuple (GVariant * const *children
,gsize n_children
);
Creates a new tuple GVariant out of the items in children
. The
type is determined from the types of children
. No entry in the
children
array may be NULL
.
If n_children
is 0 then the unit tuple is constructed.
If the children
are floating references (see g_variant_ref_sink()
), the
new instance takes ownership of them as if via g_variant_ref_sink()
.
children |
the items to make the tuple out of. |
[array length=n_children] |
n_children |
the length of |
Since 2.24
GVariant * g_variant_new_dict_entry (GVariant *key
,GVariant *value
);
Creates a new dictionary entry GVariant. key
and value
must be
non-NULL
. key
must be a value of a basic type (ie: not a container).
If the key
or value
are floating references (see g_variant_ref_sink()
),
the new instance takes ownership of them as if via g_variant_ref_sink()
.
Since 2.24
GVariant * g_variant_new_fixed_array (const GVariantType *element_type
,gconstpointer elements
,gsize n_elements
,gsize element_size
);
Provides access to the serialised data for an array of fixed-sized items.
value
must be an array with fixed-sized elements. Numeric types are
fixed-size as are tuples containing only other fixed-sized types.
element_size
must be the size of a single element in the array.
For example, if calling this function for an array of 32-bit integers,
you might say sizeof(gint32). This value isn't used except for the purpose
of a double-check that the form of the serialised data matches the caller's
expectation.
n_elements
, which must be non-NULL
is set equal to the number of
items in the array.
element_type |
the GVariantType of each element |
|
elements |
a pointer to the fixed array of contiguous elements |
|
n_elements |
the number of elements |
|
element_size |
the size of each element |
Since 2.32
GVariant *
g_variant_get_maybe (GVariant *value
);
Given a maybe-typed GVariant instance, extract its value. If the
value is Nothing, then this function returns NULL
.
Since 2.24
gsize
g_variant_n_children (GVariant *value
);
Determines the number of children in a container GVariant instance. This includes variants, maybes, arrays, tuples and dictionary entries. It is an error to call this function on any other type of GVariant.
For variants, the return value is always 1. For values with maybe types, it is always zero or one. For arrays, it is the length of the array. For tuples it is the number of tuple items (which depends only on the type). For dictionary entries, it is always 2
This function is O(1).
Since 2.24
GVariant * g_variant_get_child_value (GVariant *value
,gsize index_
);
Reads a child item out of a container GVariant instance. This includes variants, maybes, arrays, tuples and dictionary entries. It is an error to call this function on any other type of GVariant.
It is an error if index_
is greater than the number of child items
in the container. See g_variant_n_children()
.
The returned value is never floating. You should free it with
g_variant_unref()
when you're done with it.
This function is O(1).
Since 2.24
void g_variant_get_child (GVariant *value
,gsize index_
,const gchar *format_string
,...
);
Reads a child item out of a container GVariant instance and
deconstructs it according to format_string
. This call is
essentially a combination of g_variant_get_child_value()
and
g_variant_get()
.
format_string
determines the C types that are used for unpacking
the values and also determines if the values are copied or borrowed,
see the section on
GVariant format strings.
Since 2.24
GVariant * g_variant_lookup_value (GVariant *dictionary
,const gchar *key
,const GVariantType *expected_type
);
Looks up a value in a dictionary GVariant.
This function works with dictionaries of the type a{s*} (and equally well with type a{o*}, but we only further discuss the string case for sake of clarity).
In the event that dictionary
has the type a{sv}, the expected_type
string specifies what type of value is expected to be inside of the
variant. If the value inside the variant has a different type then
NULL
is returned. In the event that dictionary
has a value type other
than v then expected_type
must directly match the key type and it is
used to unpack the value directly or an error occurs.
In either case, if key
is not found in dictionary
, NULL
is returned.
If the key is found and the value has the correct type, it is
returned. If expected_type
was specified then any non-NULL
return
value will have this type.
This function is currently implemented with a linear scan. If you plan to do many lookups then GVariantDict may be more efficient.
dictionary |
a dictionary GVariant |
|
key |
the key to lookup in the dictionary |
|
expected_type |
a GVariantType, or |
[allow-none] |
Since 2.28
gboolean g_variant_lookup (GVariant *dictionary
,const gchar *key
,const gchar *format_string
,...
);
Looks up a value in a dictionary GVariant.
This function is a wrapper around g_variant_lookup_value()
and
g_variant_get()
. In the case that NULL
would have been returned,
this function returns FALSE
. Otherwise, it unpacks the returned
value and returns TRUE
.
format_string
determines the C types that are used for unpacking
the values and also determines if the values are copied or borrowed,
see the section on
GVariant format strings.
This function is currently implemented with a linear scan. If you plan to do many lookups then GVariantDict may be more efficient.
dictionary |
a dictionary GVariant |
|
key |
the key to lookup in the dictionary |
|
format_string |
a GVariant format string |
|
... |
the arguments to unpack the value into |
Since 2.28
gconstpointer g_variant_get_fixed_array (GVariant *value
,gsize *n_elements
,gsize element_size
);
Provides access to the serialised data for an array of fixed-sized items.
value
must be an array with fixed-sized elements. Numeric types are
fixed-size, as are tuples containing only other fixed-sized types.
element_size
must be the size of a single element in the array,
as given by the section on
serialized data memory.
In particular, arrays of these fixed-sized types can be interpreted
as an array of the given C type, with element_size
set to the size
the appropriate type:
G_VARIANT_TYPE_INT16
(etc.): gint16 (etc.)
G_VARIANT_TYPE_BOOLEAN
: guchar (not gboolean!)
For example, if calling this function for an array of 32-bit integers, you might say sizeof(gint32). This value isn't used except for the purpose of a double-check that the form of the serialised data matches the caller's expectation.
n_elements
, which must be non-NULL
is set equal to the number of
items in the array.
value |
a GVariant array with fixed-sized elements |
|
n_elements |
a pointer to the location to store the number of items. |
[out] |
element_size |
the size of each element |
Since 2.24
gsize
g_variant_get_size (GVariant *value
);
Determines the number of bytes that would be required to store value
with g_variant_store()
.
If value
has a fixed-sized type then this function always returned
that fixed size.
In the case that value
is already in serialised form or the size has
already been calculated (ie: this function has been called before)
then this function is O(1). Otherwise, the size is calculated, an
operation which is approximately O(n) in the number of values
involved.
Since 2.24
gconstpointer
g_variant_get_data (GVariant *value
);
Returns a pointer to the serialised form of a GVariant instance.
The returned data may not be in fully-normalised form if read from an
untrusted source. The returned data must not be freed; it remains
valid for as long as value
exists.
If value
is a fixed-sized value that was deserialised from a
corrupted serialised container then NULL
may be returned. In this
case, the proper thing to do is typically to use the appropriate
number of nul bytes in place of value
. If value
is not fixed-sized
then NULL
is never returned.
In the case that value
is already in serialised form, this function
is O(1). If the value is not already in serialised form,
serialisation occurs implicitly and is approximately O(n) in the size
of the result.
To deserialise the data returned by this function, in addition to the
serialised data, you must know the type of the GVariant, and (if the
machine might be different) the endianness of the machine that stored
it. As a result, file formats or network messages that incorporate
serialised GVariants must include this information either
implicitly (for instance "the file always contains a
G_VARIANT_TYPE_VARIANT
and it is always in little-endian order") or
explicitly (by storing the type and/or endianness in addition to the
serialised data).
Since 2.24
GBytes *
g_variant_get_data_as_bytes (GVariant *value
);
Returns a pointer to the serialised form of a GVariant instance.
The semantics of this function are exactly the same as
g_variant_get_data()
, except that the returned GBytes holds
a reference to the variant data.
Since 2.36
void g_variant_store (GVariant *value
,gpointer data
);
Stores the serialised form of value
at data
. data
should be
large enough. See g_variant_get_size()
.
The stored data is in machine native byte order but may not be in
fully-normalised form if read from an untrusted source. See
g_variant_get_normal_form()
for a solution.
As with g_variant_get_data()
, to be able to deserialise the
serialised variant successfully, its type and (if the destination
machine might be different) its endianness must also be available.
This function is approximately O(n) in the size of data
.
Since 2.24
GVariant * g_variant_new_from_data (const GVariantType *type
,gconstpointer data
,gsize size
,gboolean trusted
,GDestroyNotify notify
,gpointer user_data
);
Creates a new GVariant instance from serialised data.
type
is the type of GVariant instance that will be constructed.
The interpretation of data
depends on knowing the type.
data
is not modified by this function and must remain valid with an
unchanging value until such a time as notify
is called with
user_data
. If the contents of data
change before that time then
the result is undefined.
If data
is trusted to be serialised data in normal form then
trusted
should be TRUE
. This applies to serialised data created
within this process or read from a trusted location on the disk (such
as a file installed in /usr/lib alongside your application). You
should set trusted to FALSE
if data
is read from the network, a
file in the user's home directory, etc.
If data
was not stored in this machine's native endianness, any multi-byte
numeric values in the returned variant will also be in non-native
endianness. g_variant_byteswap()
can be used to recover the original values.
notify
will be called with user_data
when data
is no longer
needed. The exact time of this call is unspecified and might even be
before this function returns.
type |
a definite GVariantType |
|
data |
the serialised data. |
[array length=size][element-type guint8] |
size |
the size of |
|
trusted |
|
|
notify |
function to call when |
[scope async] |
user_data |
data for |
Since 2.24
GVariant * g_variant_new_from_bytes (const GVariantType *type
,GBytes *bytes
,gboolean trusted
);
Constructs a new serialised-mode GVariant instance. This is the inner interface for creation of new serialised values that gets called from various functions in gvariant.c.
A reference is taken on bytes
.
Since 2.36
GVariant *
g_variant_byteswap (GVariant *value
);
Performs a byteswapping operation on the contents of value
. The
result is that all multi-byte numeric data contained in value
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.
Since 2.24
GVariant *
g_variant_get_normal_form (GVariant *value
);
Gets a GVariant instance that has the same value as value
and is
trusted to be in normal form.
If value
is already trusted to be in normal form then a new
reference to value
is returned.
If value
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 value
is found not to be in normal form then a new trusted
GVariant is created with the same value as value
.
It makes sense to call this function if you've received GVariant data from untrusted sources and you want to ensure your serialised output is definitely in normal form.
Since 2.24
gboolean
g_variant_is_normal_form (GVariant *value
);
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 GVariant
using g_variant_new_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
.
Since 2.24
guint
g_variant_hash (gconstpointer value
);
Generates a hash value for a GVariant 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 GHashTable. value
must be a GVariant.
Since 2.24
gboolean g_variant_equal (gconstpointer one
,gconstpointer two
);
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 GHashTable. They must each be a GVariant.
Since 2.24
gchar * g_variant_print (GVariant *value
,gboolean type_annotate
);
Pretty-prints value
in the format understood by g_variant_parse()
.
The format is described here.
If type_annotate
is TRUE
, then type information is included in
the output.
Since 2.24
GString * g_variant_print_string (GVariant *value
,GString *string
,gboolean type_annotate
);
Behaves as g_variant_print()
, but operates on a GString.
If string
is non-NULL
then it is appended to and returned. Else,
a new empty GString is allocated and it is returned.
Since 2.24
GVariantIter *
g_variant_iter_copy (GVariantIter *iter
);
Creates a new heap-allocated GVariantIter to iterate over the
container that was being iterated over by iter
. Iteration begins on
the new iterator from the current position of the old iterator but
the two copies are independent past that point.
Use g_variant_iter_free()
to free the return value when you no longer
need it.
A reference is taken to the container that iter
is iterating over
and will be releated only when g_variant_iter_free()
is called.
Since 2.24
void
g_variant_iter_free (GVariantIter *iter
);
Frees a heap-allocated GVariantIter. Only call this function on
iterators that were returned by g_variant_iter_new()
or
g_variant_iter_copy()
.
Since 2.24
gsize g_variant_iter_init (GVariantIter *iter
,GVariant *value
);
Initialises (without allocating) a GVariantIter. iter
may be
completely uninitialised prior to this call; its old value is
ignored.
The iterator remains valid for as long as value
exists, and need not
be freed in any way.
Since 2.24
gsize
g_variant_iter_n_children (GVariantIter *iter
);
Queries the number of child items in the container that we are iterating over. This is the total number of items -- not the number of items remaining.
This function might be useful for preallocation of arrays.
Since 2.24
GVariantIter *
g_variant_iter_new (GVariant *value
);
Creates a heap-allocated GVariantIter for iterating over the items
in value
.
Use g_variant_iter_free()
to free the return value when you no longer
need it.
A reference is taken to value
and will be released only when
g_variant_iter_free()
is called.
Since 2.24
GVariant *
g_variant_iter_next_value (GVariantIter *iter
);
Gets the next item in the container. If no more items remain then
NULL
is returned.
Use g_variant_unref()
to drop your reference on the return value when
you no longer need it.
Here is an example for iterating with g_variant_iter_next_value()
:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
// recursively iterate a container void iterate_container_recursive (GVariant *container) { GVariantIter iter; GVariant *child; g_variant_iter_init (&iter, container); while ((child = g_variant_iter_next_value (&iter))) { g_print ("type '%s'\n", g_variant_get_type_string (child)); if (g_variant_is_container (child)) iterate_container_recursive (child); g_variant_unref (child); } } |
Since 2.24
gboolean g_variant_iter_next (GVariantIter *iter
,const gchar *format_string
,...
);
Gets the next item in the container and unpacks it into the variable
argument list according to format_string
, returning TRUE
.
If no more items remain then FALSE
is returned.
All of the pointers given on the variable arguments list of this function are assumed to point at uninitialised memory. It is the responsibility of the caller to free all of the values returned by the unpacking process.
Here is an example for memory management with g_variant_iter_next()
:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
// Iterates a dictionary of type 'a{sv}' void iterate_dictionary (GVariant *dictionary) { GVariantIter iter; GVariant *value; gchar *key; g_variant_iter_init (&iter, dictionary); while (g_variant_iter_next (&iter, "{sv}", &key, &value)) { g_print ("Item '%s' has type '%s'\n", key, g_variant_get_type_string (value)); // must free data for ourselves g_variant_unref (value); g_free (key); } } |
For a solution that is likely to be more convenient to C programmers
when dealing with loops, see g_variant_iter_loop()
.
format_string
determines the C types that are used for unpacking
the values and also determines if the values are copied or borrowed.
See the section on GVariant format strings.
Since 2.24
gboolean g_variant_iter_loop (GVariantIter *iter
,const gchar *format_string
,...
);
Gets the next item in the container and unpacks it into the variable
argument list according to format_string
, returning TRUE
.
If no more items remain then FALSE
is returned.
On the first call to this function, the pointers appearing on the variable argument list are assumed to point at uninitialised memory. On the second and later calls, it is assumed that the same pointers will be given and that they will point to the memory as set by the previous call to this function. This allows the previous values to be freed, as appropriate.
This function is intended to be used with a while loop as
demonstrated in the following example. This function can only be
used when iterating over an array. It is only valid to call this
function with a string constant for the format string and the same
string constant must be used each time. Mixing calls to this
function and g_variant_iter_next()
or g_variant_iter_next_value()
on
the same iterator causes undefined behavior.
If you break out of a such a while loop using g_variant_iter_loop()
then
you must free or unreference all the unpacked values as you would with
g_variant_get()
. Failure to do so will cause a memory leak.
Here is an example for memory management with g_variant_iter_loop()
:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
// Iterates a dictionary of type 'a{sv}' void iterate_dictionary (GVariant *dictionary) { GVariantIter iter; GVariant *value; gchar *key; g_variant_iter_init (&iter, dictionary); while (g_variant_iter_loop (&iter, "{sv}", &key, &value)) { g_print ("Item '%s' has type '%s'\n", key, g_variant_get_type_string (value)); // no need to free 'key' and 'value' here // unless breaking out of this loop } } |
For most cases you should use g_variant_iter_next()
.
This function is really only useful when unpacking into GVariant or
GVariantIter in order to allow you to skip the call to
g_variant_unref()
or g_variant_iter_free()
.
For example, if you are only looping over simple integer and string
types, g_variant_iter_next()
is definitely preferred. For string
types, use the '&' prefix to avoid allocating any memory at all (and
thereby avoiding the need to free anything as well).
format_string
determines the C types that are used for unpacking
the values and also determines if the values are copied or borrowed.
See the section on GVariant format strings.
Since 2.24
void
g_variant_builder_unref (GVariantBuilder *builder
);
Decreases the reference count on builder
.
In the event that there are no more references, releases all memory associated with the GVariantBuilder.
Don't call this on stack-allocated GVariantBuilder instances or bad things will happen.
Since 2.24
GVariantBuilder *
g_variant_builder_ref (GVariantBuilder *builder
);
Increases the reference count on builder
.
Don't call this on stack-allocated GVariantBuilder instances or bad things will happen.
Since 2.24
GVariantBuilder *
g_variant_builder_new (const GVariantType *type
);
Allocates and initialises a new GVariantBuilder.
You should call g_variant_builder_unref()
on the return value when it
is no longer needed. The memory will not be automatically freed by
any other call.
In most cases it is easier to place a GVariantBuilder directly on
the stack of the calling function and initialise it with
g_variant_builder_init()
.
Since 2.24
void g_variant_builder_init (GVariantBuilder *builder
,const GVariantType *type
);
Initialises a GVariantBuilder structure.
type
must be non-NULL
. It specifies the type of container to
construct. It can be an indefinite type such as
G_VARIANT_TYPE_ARRAY
or a definite type such as "as" or "(ii)".
Maybe, array, tuple, dictionary entry and variant-typed values may be
constructed.
After the builder is initialised, values are added using
g_variant_builder_add_value()
or g_variant_builder_add()
.
After all the child values are added, g_variant_builder_end()
frees
the memory associated with the builder and returns the GVariant that
was created.
This function completely ignores the previous contents of builder
.
On one hand this means that it is valid to pass in completely
uninitialised memory. On the other hand, this means that if you are
initialising over top of an existing GVariantBuilder you need to
first call g_variant_builder_clear()
in order to avoid leaking
memory.
You must not call g_variant_builder_ref()
or
g_variant_builder_unref()
on a GVariantBuilder that was initialised
with this function. If you ever pass a reference to a
GVariantBuilder outside of the control of your own code then you
should assume that the person receiving that reference may try to use
reference counting; you should use g_variant_builder_new()
instead of
this function.
Since 2.24
void
g_variant_builder_clear (GVariantBuilder *builder
);
Releases all memory associated with a GVariantBuilder without freeing the GVariantBuilder structure itself.
It typically only makes sense to do this on a stack-allocated
GVariantBuilder if you want to abort building the value part-way
through. This function need not be called if you call
g_variant_builder_end()
and it also doesn't need to be called on
builders allocated with g_variant_builder_new (see
g_variant_builder_unref()
for that).
This function leaves the GVariantBuilder structure set to all-zeros. It is valid to call this function on either an initialised GVariantBuilder or one that is set to all-zeros but it is not valid to call this function on uninitialised memory.
Since 2.24
void g_variant_builder_add_value (GVariantBuilder *builder
,GVariant *value
);
Adds value
to builder
.
It is an error to call this function in any way that would create an inconsistent value to be constructed. Some examples of this are putting different types of items into an array, putting the wrong types or number of items in a tuple, putting more than one value into a variant, etc.
If value
is a floating reference (see g_variant_ref_sink()
),
the builder
instance takes ownership of value
.
Since 2.24
void g_variant_builder_add (GVariantBuilder *builder
,const gchar *format_string
,...
);
Adds to a GVariantBuilder.
This call is a convenience wrapper that is exactly equivalent to
calling g_variant_new()
followed by g_variant_builder_add_value()
.
Note that the arguments must be of the correct width for their types
specified in format_string
. This can be achieved by casting them. See
the GVariant varargs documentation.
This function might be used as follows:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
GVariant * make_pointless_dictionary (void) { GVariantBuilder builder; int i; g_variant_builder_init (&builder, G_VARIANT_TYPE_ARRAY); for (i = 0; i < 16; i++) { gchar buf[3]; sprintf (buf, "%d", i); g_variant_builder_add (&builder, "{is}", i, buf); } return g_variant_builder_end (&builder); } |
builder |
||
format_string |
a GVariant varargs format string |
|
... |
arguments, as per |
Since 2.24
void g_variant_builder_add_parsed (GVariantBuilder *builder
,const gchar *format
,...
);
Adds to a GVariantBuilder.
This call is a convenience wrapper that is exactly equivalent to
calling g_variant_new_parsed()
followed by
g_variant_builder_add_value()
.
Note that the arguments must be of the correct width for their types
specified in format_string
. This can be achieved by casting them. See
the GVariant varargs documentation.
This function might be used as follows:
1 2 3 4 5 6 7 8 9 10 11 12 |
GVariant * make_pointless_dictionary (void) { GVariantBuilder builder; int i; g_variant_builder_init (&builder, G_VARIANT_TYPE_ARRAY); g_variant_builder_add_parsed (&builder, "{'width', <%i>}", 600); g_variant_builder_add_parsed (&builder, "{'title', <%s>}", "foo"); g_variant_builder_add_parsed (&builder, "{'transparency', <0.5>}"); return g_variant_builder_end (&builder); } |
Since 2.26
GVariant *
g_variant_builder_end (GVariantBuilder *builder
);
Ends the builder process and returns the constructed value.
It is not permissible to use builder
in any way after this call
except for reference counting operations (in the case of a
heap-allocated GVariantBuilder) or by reinitialising it with
g_variant_builder_init()
(in the case of stack-allocated).
It is an error to call this function in any way that would create an inconsistent value to be constructed (ie: insufficient number of items added to a container with a specific number of children required). It is also an error to call this function if the builder was created with an indefinite array or maybe type and no children have been added; in this case it is impossible to infer the type of the empty array.
Since 2.24
void g_variant_builder_open (GVariantBuilder *builder
,const GVariantType *type
);
Opens a subcontainer inside the given builder
. When done adding
items to the subcontainer, g_variant_builder_close()
must be called.
It is an error to call this function in any way that would cause an inconsistent value to be constructed (ie: adding too many values or a value of an incorrect type).
Since 2.24
void
g_variant_builder_close (GVariantBuilder *builder
);
Closes the subcontainer inside the given builder
that was opened by
the most recent call to g_variant_builder_open()
.
It is an error to call this function in any way that would create an inconsistent value to be constructed (ie: too few values added to the subcontainer).
Since 2.24
void
g_variant_dict_unref (GVariantDict *dict
);
Decreases the reference count on dict
.
In the event that there are no more references, releases all memory associated with the GVariantDict.
Don't call this on stack-allocated GVariantDict instances or bad things will happen.
Since 2.40
GVariantDict *
g_variant_dict_ref (GVariantDict *dict
);
Increases the reference count on dict
.
Don't call this on stack-allocated GVariantDict instances or bad things will happen.
Since 2.40
GVariantDict *
g_variant_dict_new (GVariant *from_asv
);
Allocates and initialises a new GVariantDict.
You should call g_variant_dict_unref()
on the return value when it
is no longer needed. The memory will not be automatically freed by
any other call.
In some cases it may be easier to place a GVariantDict directly on
the stack of the calling function and initialise it with
g_variant_dict_init()
. This is particularly useful when you are
using GVariantDict to construct a GVariant.
Since 2.40
void g_variant_dict_init (GVariantDict *dict
,GVariant *from_asv
);
Initialises a GVariantDict structure.
If from_asv
is given, it is used to initialise the dictionary.
This function completely ignores the previous contents of dict
. On
one hand this means that it is valid to pass in completely
uninitialised memory. On the other hand, this means that if you are
initialising over top of an existing GVariantDict you need to first
call g_variant_dict_clear()
in order to avoid leaking memory.
You must not call g_variant_dict_ref()
or g_variant_dict_unref()
on a
GVariantDict that was initialised with this function. If you ever
pass a reference to a GVariantDict outside of the control of your
own code then you should assume that the person receiving that
reference may try to use reference counting; you should use
g_variant_dict_new()
instead of this function.
Since 2.40
void
g_variant_dict_clear (GVariantDict *dict
);
Releases all memory associated with a GVariantDict without freeing the GVariantDict structure itself.
It typically only makes sense to do this on a stack-allocated
GVariantDict if you want to abort building the value part-way
through. This function need not be called if you call
g_variant_dict_end()
and it also doesn't need to be called on dicts
allocated with g_variant_dict_new (see g_variant_dict_unref()
for
that).
It is valid to call this function on either an initialised
GVariantDict or one that was previously cleared by an earlier call
to g_variant_dict_clear()
but it is not valid to call this function
on uninitialised memory.
Since 2.40
gboolean g_variant_dict_contains (GVariantDict *dict
,const gchar *key
);
Checks if key
exists in dict
.
Since 2.40
gboolean g_variant_dict_lookup (GVariantDict *dict
,const gchar *key
,const gchar *format_string
,...
);
Looks up a value in a GVariantDict.
This function is a wrapper around g_variant_dict_lookup_value()
and
g_variant_get()
. In the case that NULL
would have been returned,
this function returns FALSE
. Otherwise, it unpacks the returned
value and returns TRUE
.
format_string
determines the C types that are used for unpacking the
values and also determines if the values are copied or borrowed, see the
section on GVariant format strings.
dict |
||
key |
the key to lookup in the dictionary |
|
format_string |
a GVariant format string |
|
... |
the arguments to unpack the value into |
Since 2.40
GVariant * g_variant_dict_lookup_value (GVariantDict *dict
,const gchar *key
,const GVariantType *expected_type
);
Looks up a value in a GVariantDict.
If key
is not found in dictionary
, NULL
is returned.
The expected_type
string specifies what type of value is expected.
If the value associated with key
has a different type then NULL
is
returned.
If the key is found and the value has the correct type, it is
returned. If expected_type
was specified then any non-NULL
return
value will have this type.
dict |
||
key |
the key to lookup in the dictionary |
|
expected_type |
a GVariantType, or |
[allow-none] |
Since 2.40
void g_variant_dict_insert (GVariantDict *dict
,const gchar *key
,const gchar *format_string
,...
);
Inserts a value into a GVariantDict.
This call is a convenience wrapper that is exactly equivalent to
calling g_variant_new()
followed by g_variant_dict_insert_value()
.
dict |
||
key |
the key to insert a value for |
|
format_string |
a GVariant varargs format string |
|
... |
arguments, as per |
Since 2.40
void g_variant_dict_insert_value (GVariantDict *dict
,const gchar *key
,GVariant *value
);
Inserts (or replaces) a key in a GVariantDict.
value
is consumed if it is floating.
Since 2.40
gboolean g_variant_dict_remove (GVariantDict *dict
,const gchar *key
);
Removes a key and its associated value from a GVariantDict.
Since 2.40
GVariant *
g_variant_dict_end (GVariantDict *dict
);
Returns the current value of dict
as a GVariant of type
G_VARIANT_TYPE_VARDICT
, clearing it in the process.
It is not permissible to use dict
in any way after this call except
for reference counting operations (in the case of a heap-allocated
GVariantDict) or by reinitialising it with g_variant_dict_init()
(in
the case of stack-allocated).
Since 2.40
#define G_VARIANT_PARSE_ERROR (g_variant_parse_error_quark ())
Error domain for GVariant text format parsing. Specific error codes are not currently defined for this domain. See GError for information on error domains.
GVariant * g_variant_parse (const GVariantType *type
,const gchar *text
,const gchar *limit
,const gchar **endptr
,GError **error
);
Parses a GVariant from a text representation.
A single GVariant is parsed from the content of text
.
The format is described here.
The memory at limit
will never be accessed and the parser behaves as
if the character at limit
is the nul terminator. This has the
effect of bounding text
.
If endptr
is non-NULL
then text
is permitted to contain data
following the value that this function parses and endptr
will be
updated to point to the first character past the end of the text
parsed by this function. If endptr
is NULL
and there is extra data
then an error is returned.
If type
is non-NULL
then the value will be parsed to have that
type. This may result in additional parse errors (in the case that
the parsed value doesn't fit the type) but may also result in fewer
errors (in the case that the type would have been ambiguous, such as
with empty arrays).
In the event that the parsing is successful, the resulting GVariant is returned.
In case of any error, NULL
will be returned. If error
is non-NULL
then it will be set to reflect the error that occurred.
Officially, the language understood by the parser is "any string
produced by g_variant_print()
".
GVariant * g_variant_new_parsed_va (const gchar *format
,va_list *app
);
Parses format
and returns the result.
This is the version of g_variant_new_parsed()
intended to be used
from libraries.
The return value will be floating if it was a newly created GVariant
instance. In the case that format
simply specified the collection
of a GVariant pointer (eg: format
was "%*") then the collected
GVariant pointer will be returned unmodified, without adding any
additional references.
Note that the arguments in app
must be of the correct width for their types
specified in format
when collected into the va_list. See
the GVariant varargs documentation.
In order to behave correctly in all cases it is necessary for the
calling function to g_variant_ref_sink()
the return result before
returning control to the user that originally provided the pointer.
At this point, the caller will have their own full reference to the
result. This can also be done by adding the result to a container,
or by passing it to another g_variant_new()
call.
GVariant * g_variant_new_parsed (const gchar *format
,...
);
Parses format
and returns the result.
format
must be a text format GVariant with one extension: at any
point that a value may appear in the text, a '%' character followed
by a GVariant format string (as per g_variant_new()
) may appear. In
that case, the same arguments are collected from the argument list as
g_variant_new()
would have collected.
Note that the arguments must be of the correct width for their types
specified in format
. This can be achieved by casting them. See
the GVariant varargs documentation.
Consider this simple example:
1 |
g_variant_new_parsed ("[('one', 1), ('two', %i), (%s, 3)]", 2, "three"); |
In the example, the variable argument parameters are collected and filled in as if they were part of the original string to produce the result of
1 |
[('one', 1), ('two', 2), ('three', 3)] |
This function is intended only to be used with format
as a string
literal. Any parse error is fatal to the calling process. If you
want to parse data from untrusted sources, use g_variant_parse()
.
You may not use this function to return, unmodified, a single
GVariant pointer from the argument list. ie: format
may not solely
be anything along the lines of "%*", "%?", "%r", or anything starting
with "%@".
gchar * g_variant_parse_error_print_context (GError *error
,const gchar *source_str
);
Pretty-prints a message showing the context of a GVariant parse error within the string for which parsing was attempted.
The resulting string is suitable for output to the console or other monospace media where newlines are treated in the usual way.
The message will typically look something like one of the following:
1 2 3 |
unterminated string constant: (1, 2, 3, 'abc ^^^^ |
or
1 2 3 |
unable to find a common type: [1, 2, 3, 'str'] ^ ^^^^^ |
The format of the message may change in a future version.
error
must have come from a failed attempt to g_variant_parse()
and
source_str
must be exactly the same string that caused the error.
If source_str
was not nul-terminated when you passed it to
g_variant_parse()
then you must add nul termination before using this
function.
error |
a GError from the GVariantParseError domain |
|
source_str |
the string that was given to the parser |
Since 2.40
typedef struct _GVariant GVariant;
GVariant is an opaque data structure and can only be accessed using the following functions.
Since 2.24
The range of possible top-level types of GVariant instances.
|
The GVariant is a boolean. |
||
|
The GVariant is a byte. |
||
|
The GVariant is a signed 16 bit integer. |
||
|
The GVariant is an unsigned 16 bit integer. |
||
|
The GVariant is a signed 32 bit integer. |
||
|
The GVariant is an unsigned 32 bit integer. |
||
|
The GVariant is a signed 64 bit integer. |
||
|
The GVariant is an unsigned 64 bit integer. |
||
|
The GVariant is a file handle index. |
||
|
The GVariant is a double precision floating point value. |
||
|
The GVariant is a normal string. |
||
|
The GVariant is a D-Bus object path string. |
||
|
The GVariant is a D-Bus signature string. |
||
|
The GVariant is a variant. |
||
|
The GVariant is a maybe-typed value. |
||
|
The GVariant is an array. |
||
|
The GVariant is a tuple. |
||
|
The GVariant is a dictionary entry. |
Since 2.24
struct GVariantIter { };
GVariantIter is an opaque data structure and can only be accessed using the following functions.
struct GVariantBuilder { };
A utility type for constructing container-type GVariant instances.
This is an opaque structure and may only be accessed using the following functions.
GVariantBuilder is not threadsafe in any way. Do not attempt to access it from more than one thread.
struct GVariantDict { };
GVariantDict is a mutable interface to GVariant dictionaries.
It can be used for doing a sequence of dictionary lookups in an efficient way on an existing GVariant dictionary or it can be used to construct new dictionaries with a hashtable-like interface. It can also be used for taking existing dictionaries and modifying them in order to create new ones.
GVariantDict can only be used with G_VARIANT_TYPE_VARDICT
dictionaries.
It is possible to use GVariantDict allocated on the stack or on the
heap. When using a stack-allocated GVariantDict, you begin with a
call to g_variant_dict_init()
and free the resources with a call to
g_variant_dict_clear()
.
Heap-allocated GVariantDict follows normal refcounting rules: you
allocate it with g_variant_dict_new()
and use g_variant_dict_ref()
and g_variant_dict_unref()
.
g_variant_dict_end() is used to convert the GVariantDict back into a
dictionary-type GVariant. When used with stack-allocated instances,
this also implicitly frees all associated memory, but for
heap-allocated instances, you must still call g_variant_dict_unref()
afterwards.
You will typically want to use a heap-allocated GVariantDict when you expose it as part of an API. For most other uses, the stack-allocated form will be more convenient.
Consider the following two examples that do the same thing in each style: take an existing dictionary and look up the "count" uint32 key, adding 1 to it if it is found, or returning an error if the key is not found. Each returns the new dictionary as a floating GVariant.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
GVariant * add_to_count (GVariant *orig, GError **error) { GVariantDict dict; guint32 count; g_variant_dict_init (&dict, orig); if (!g_variant_dict_lookup (&dict, "count", "u", &count)) { g_set_error (...); g_variant_dict_clear (&dict); return NULL; } g_variant_dict_insert (&dict, "count", "u", count + 1); return g_variant_dict_end (&dict); } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
GVariant * add_to_count (GVariant *orig, GError **error) { GVariantDict *dict; GVariant *result; guint32 count; dict = g_variant_dict_new (orig); if (g_variant_dict_lookup (dict, "count", "u", &count)) { g_variant_dict_insert (dict, "count", "u", count + 1); result = g_variant_dict_end (dict); } else { g_set_error (...); result = NULL; } g_variant_dict_unref (dict); return result; } |
Since 2.40
Error codes returned by parsing text-format GVariants.
|
generic error (unused) |
||
|
a non-basic GVariantType was given where a basic type was expected |
||
|
cannot infer the GVariantType |
||
|
an indefinite GVariantType was given where a definite type was expected |
||
|
extra data after parsing finished |
||
|
invalid character in number or unicode escape |
||
|
not a valid GVariant format string |
||
|
not a valid object path |
||
|
not a valid type signature |
||
|
not a valid GVariant type string |
||
|
could not find a common type for array entries |
||
|
the numerical value is out of range of the given type |
||
|
the numerical value is out of range for any type |
||
|
cannot parse as variant of the specified type |
||
|
an unexpected token was encountered |
||
|
an unknown keyword was encountered |
||
|
unterminated string constant |
||
|
no value given |


Gary Barlow thrills fans with 'amazing' throwback snap of him and Robbie Williams from 1992
To celebrate his mate's achievement
by Paul HironsTake That's Gary Barlow has wowed fans with a throwback snap of him and former bandmate Robbie Williams.
Gary, 48, shared the photo - taken in 1992 - to celebrate Robbie's record-equalling 13th career number one album, the most by a solo artist.
Read more: Gary Barlow thrills fans with 'beautiful' wife Dawn on holiday
Wearing muscle vests and looking fresh-faced in the throwback posted onto Twitter, Gary captioned the image: "We pay tribute to the guy who’s number one for the 13th time @robbiewilliams.
"Here’s a shot from 1992 at a gig in Portsmouth. Congratulations mate. #lookatus."
And it wasn't long before many of Gary's 4.2million followers took to the social media site to express their joy at the snap.
Read more: Robbie Williams gatecrashes Loose Women in hilarious blunder live on air
One follower said: "You're so beautiful as always Gary sunshine, you're the sweetest.
"I love this picture."
"Amazing. Love you two so much," another wrote.
Finally a third joked: "What do you mean? Surely that pic was taken last week."
Leave us a comment on our Facebook page @EntertainmentDailyFix and let us know what you think of this story.


{% extends "layout.html" %} {% block page_title %} DBS Prototype {% endblock %} {% set main_question = "Please print this screen" %} {% block content %} {% include 'includes/phase_banner_alpha.html' %} Back {% include 'includes/error_summary.html' %}{# include if this page has validation requirements #} {{ main_question }} You will need to print this screen and take it to the Post Office after completing your application. Your application will not be processed until you have taken this screen and your documents to the Post Office. The documents you said you can bring with you are: {% if documents %} {% for doc in documents %} {{ doc }} {% endfor %} {% endif %} THERE WILL BE BARCODES ON HERE RETURNED FROM THE POST OFFICE API {% endblock %}
You will need to print this screen and take it to the Post Office after completing your application.
Your application will not be processed until you have taken this screen and your documents to the Post Office.
The documents you said you can bring with you are:
THERE WILL BE BARCODES ON HERE RETURNED FROM THE POST OFFICE API


- main(String[]) - Static method in enum bui.Geography
-
main - tests the enum initialization, and the return values for first and last
columns of each enum
- main(String[]) - Static method in class bui.ImageSet
-
- main(String[]) - Static method in class bui.Img
-
- main(String[]) - Static method in class bui.MapCanvas
-
- main(String[]) - Static method in class bui.MapShell
-
- main(String[]) - Static method in class bui.MiniMapCanvas
-
- main(String[]) - Static method in class bui.Snippet10
-
- main(String[]) - Static method in class bui.Stats
-
- main(String[]) - Static method in enum bui.Structure
-
main - tests the enum initialization, and the return values for first and last
columns of each enum
- main(String[]) - Static method in enum bui.Zone
-
- map - Variable in class bui.MapCanvas
-
used by constructor to retain the current ascii game map
- map - Variable in class bui.MapShell
-
- map_images - Variable in class bui.MapShell
-
- MapCanvas - Class in bui
-
Creates a drawable canvas by subclassing SWT.canvas and drawing the images provided
through the Img and ImgSet classes as a game map on the canvas.
- MapCanvas(Shell, GameMap, ImageSet) - Constructor for class bui.MapCanvas
-
constructor calls the parent super constructor, sets up private attributes
and then calls the onLoad function to initialize the game map.
- MapShell - Class in bui
-
MapShell is main() and the core of the user GUI.
- MapShell() - Constructor for class bui.MapShell
-
constructor
- MayorPercentage - Variable in class bui.MapShell
-
- mini_canvas - Variable in class bui.MapShell
-
- mini_child - Variable in class bui.MapCanvas
-
the keyboard movement needs to be able to update the minimap
so the minimap constructor sets this reference.
- mini_map - Variable in class bui.MiniMapCanvas
-
- MiniMapCanvas - Class in bui
-
A minimap to parallel the full size game map and facilitate navigation
subclass of MapCanvas that overrides the viewPortDraw method with a colored
pixel for each tile.
- MiniMapCanvas(Shell, GameMap, ImageSet, MapCanvas, Text, Text) - Constructor for class bui.MiniMapCanvas
-
constructor
- money - Variable in class bui.OutcomeControl
-
- mouseDoubleClick(MouseEvent) - Method in class bui.MapCanvas
-
Double click on the full size map changes the active tile, but
not<\b> the x_, y_ori pair.
- mouseDoubleClick(MouseEvent) - Method in class bui.MiniMapCanvas
-
Double click on MiniMap changes the active Tile and
also<\b> x_ and y_ori for the full size MapCanvas.
- mouseDown(MouseEvent) - Method in class bui.MapCanvas
-
stub required to implement MouseListener
- mouseMove(MouseEvent) - Method in class bui.MapCanvas
-
stub required to implement MouseMoveListener
- mouseUp(MouseEvent) - Method in class bui.MapCanvas
-
stub required to implement MouseListener


Name in session is: {{request.session.counter}} Times
delete
add sessions to counter
add sessions to counter of 2


Notice: Although webdot can still be configured as a public server, we no longer provide such a server ourselves and we don't recommend that others do so either. Webdot contains no mechanisms for limiting the load on a public server. Instead we recommend that you set up a server just for your own graphs.
If a public WebDot server is available then graphs can be served without installing WebDot locally. For example, if there is a graph at: http://www.graphviz.org/demo.dot
then this img tag in an html web page:
<img src="http://webdot.graphviz.org/cgi-bin/webdot/http://www.graphviz.org/demo.dot.dot.png" alt="graph from public webdot server"> |
will produce the graph layout at the top of this page.


Read the Docs YAML Config¶
Read the Docs now has support for configuring builds with a YAML file. The file, readthedocs.yml, must be in the root directory of your project.
Warning
This feature is in a beta state. Please file an issue if you find anything wrong.
Supported Settings¶
formats¶
- Default:
htmlzip
,pdf
,epub
- Options:
htmlzip
,pdf
,epub
,none
The formats of your documentation you want to be built.
Choose none
to build none of the formats.
Note
We will always build an HTML & JSON version of your documentation. These are used for web serving & search indexing, respectively.
# Don't build any extra formats
formats:
- none
# Build PDF & ePub
formats:
- epub
- pdf
requirements_file¶
- Default: None
- Type: Path (specified from the root of the project)
The path to your Pip requirements file.
requirements_file: requirements/docs.txt
conda¶
The conda
block allows for configuring our support for Conda.
conda.file¶
- Default: None
- Type: Path (specified from the root of the project)
The file option specified the Conda environment file to use.
conda:
file: environment.yml
Note
Conda is only supported via the YAML file.
python¶
The python
block allows you to configure aspects of the Python executable
used for building documentation.
python.version¶
- Default:
2
- Options:
2
,3
The version of Python to use when building your documentation.
python:
version: 3
python.setup_py_install¶
- Default: False
- Type: Boolean
When true, install your project into the Virtualenv with
python setup.py install
when building documentation.
python:
setup_py_install: true
python.pip_install¶
- Default: False
- Type: Boolean
When true, install your project into the Virtualenv with pip when building documentation.
python:
pip_install: true
python.extra_requirements¶
- Default:
[]
- Type: List
List of extra requirements sections to install, additionally to the
package default dependencies. Only works if python.pip_install
option
above is set to True
.
Let’s say your Python package has a setup.py
which looks like this:
from setuptools import setup
setup(
name="my_package",
# (...)
install_requires=[
'requests',
'simplejson'],
extras_require={
'tests': [
'nose',
'pycodestyle >= 2.1.0'],
'docs': [
'sphinx >= 1.4',
'sphinx_rtd_theme']}
)
Then to have all dependencies from the tests
and docs
sections
installed in addition to the default requests
and simplejson
, use the
extra_requirements
as such:
python:
extra_requirements:
- tests
- docs
Behind the scene the following Pip command will be run:
$ pip install -e .[tests,docs]


1 Samuel 19:15
And Saul sent the messengers again to see David, saying, Bring him up to me in the bed, that I may slay him.


railo-context.Component coldbox.system.ioc.Builder
The WireBox builder for components, java, etc. I am in charge of building stuff and integration dsl builders.
| Constructor Summary | |
|---|---|
|
init(any<Injector> injector)
Constructor. |
| Method Summary | |
|---|---|
any
|
buildArgumentCollection(any<Mapping> mapping, any argumentArray, any targetObject)
Build arguments for a mapping and return the structure representation. |
any
|
buildCFC(any<Mapping> mapping, [any<struct> initArguments='[runtime expression]'])
Build a cfc class via mappings. |
any
|
buildDSLDependency(any definition, any targetID, [any targetObject=''])
Build a DSL Dependency, if not found, returns null. |
any
|
buildFactoryMethod(any<Mapping> mapping, [any<struct> initArguments='[runtime expression]'])
Build an object using a factory method. |
any
|
buildFeed(any<Mapping> mapping)
Build an rss feed the WireBox way. |
any
|
buildJavaClass(any<Mapping> mapping)
Build a Java class via mappings. |
any
|
buildProviderMixer()
Used to provider providers via mixers on targeted objects. |
any
|
buildSimpleDSL(any dsl, any targetID, [any targetObject=''])
Build a DSL Dependency using a simple dsl string. |
any
|
buildWebservice(any<Mapping> mapping, [any<struct> initArguments='[runtime expression]'])
Build a webservice object. |
private any
|
getByTypeDSL(any definition, [any targetObject])
Get dependencies using the mapped type. |
any<struct>
|
getCustomDSL()
Get the registered custom dsl instances structure. |
private any
|
getJavaDSL(any definition, [any targetObject])
Get a Java object. |
private any
|
getModelDSL(any definition, [any targetObject])
Get dependencies using the model dependency DSL. |
private any
|
getProviderDSL(any definition, [any targetObject=''])
Get dependencies using the our provider pattern DSL. |
private any
|
getWireBoxDSL(any definition, [any targetObject])
Get dependencies using the wirebox dependency DSL. |
any
|
registerCustomBuilders()
Register custom DSL builders with this main wirebox builder. |
any
|
registerDSL(any namespace, any path)
A direct way of registering custom DSL namespaces. |
void
|
toVirtualInheritance(any mapping, any target)
Do our virtual inheritance magic. |
| Methods inherited from class railo-context.Component |
|---|
| None |
| Constructor Detail |
|---|
Constructor. If called without a configuration binder, then WireBox will instantiate the default configuration binder found in: coldbox.system.ioc.config.DefaultBinder
injector
- The linked WireBox injector| Method Detail |
|---|
Build arguments for a mapping and return the structure representation
mapping
- The mapping to constructargumentArray
- The argument array of datatargetObject
- The target object we are building the DSL dependency forBuild a cfc class via mappings
mapping
- The mapping to constructinitArguments
- The constructor structure of arguments to passthrough when initializing the instanceBuild a DSL Dependency, if not found, returns null
definition
- The dependency definition structure: name, dsl as keystargetID
- The target ID we are building this dependency fortargetObject
- The target object we are building the DSL dependency for. If empty, means we are just requesting buildingBuild an object using a factory method
mapping
- The mapping to constructinitArguments
- The constructor structure of arguments to passthrough when initializing the instanceBuild an rss feed the WireBox way
mapping
- The mapping to constructBuild a Java class via mappings
mapping
- The mapping to constructUsed to provider providers via mixers on targeted objects
Build a DSL Dependency using a simple dsl string
dsl
- The dsl string to buildtargetID
- The target ID we are building this dependency fortargetObject
- The target object we are building the DSL dependency forBuild a webservice object
mapping
- The mapping to constructinitArguments
- The constructor structure of arguments to passthrough when initializing the instanceGet dependencies using the mapped type
definition
- The dependency definition structuretargetObject
- The target object we are building the DSL dependency for. If empty, means we are just requesting buildingGet the registered custom dsl instances structure
Get a Java object
definition
- The dependency definition structuretargetObject
- The target object we are building the DSL dependency for. If empty, means we are just requesting buildingGet dependencies using the model dependency DSL
definition
- The dependency definition structuretargetObject
- The target object we are building the DSL dependency for. If empty, means we are just requesting buildingGet dependencies using the our provider pattern DSL
definition
- The dependency definition structuretargetObject
- The target object we are building the DSL dependency for. If empty, means we are just requesting buildingGet dependencies using the wirebox dependency DSL
definition
- The dependency definition structuretargetObject
- The target object we are building the DSL dependency for. If empty, means we are just requesting buildingRegister custom DSL builders with this main wirebox builder
A direct way of registering custom DSL namespaces
namespace
- The namespace you would like to registerpath
- The instantiation path to the CFC that implements this scope, it must have an init() method and implement: coldbox.system.ioc.dsl.IDSLBuilderDo our virtual inheritance magic
mapping
- The mapping to convert totarget
- The target object


Travel and Entertainment Search
Keyword
*
Please enter a keyword.
Category
Default
Airport
Amusement Park
Aquarium
Art Gallery
Bakery
Bar
Beauty Salon
Bowling Alley
Bus Station
Cafe
Campground
Car Rental
Casino
Lodging
Movie Theater
Museum
Night Club
Park
Parking
Restaurant
Shopping Mall
Stadium
Subway station
Taxi Stand
Train station
Transit Station
Travel Agency
Zoo
Distance(miles)
From
*
Current location
Other. Please specify:
Please enter a location.
Search
Clear
Results
Favorites


Stephen Curtin
8726 East Devonshire Avenue
Scottsdale, AZ 85251
602-738-2340 -- mobile
Email<EMAIL_ADDRESS>Web: www.scurtin.com
SUMMARY
Results-oriented professional with over 20 years of hands-on experience in all aspects of corporate information system management. Includes development, maintenance, conversion and production support coupled with technical skills in Web database, PC/client-server and mainframe environments. I am a lifelong learner and enjoy the challenges, opportunities and learning opportunities new technologies present. IProven track record as an achiever and a team player.
TECHNICAL SKILLS
|
Active Server Pages |
IBM Mainframe |
MVC |
SAS |
|
Apache 2 |
Javascript |
MySQL |
SharePoint 2007 |
|
C# |
JQuery |
Oracle 9i |
SQL Server |
|
COBOL |
JQuery UI |
Oracle PL/SQL |
SQL Server 2005/2008 |
|
CSS & CSS 3 |
LAMP Stack |
PHP |
SSRS SSIS |
|
Drupal 7 |
Linux |
PowerBuilder |
Visual Studio 2010 |
|
GIT |
Lotus Notes |
Responsive Web |
VMware |
|
GITHub |
Microsoft Office |
Design |
EDUCATION
Certificate, Windows 2000, Boston University, February 2001
Certificate, Unix, C, C+, Worcester Polytechnic Institute, August 1998
Certificate, Client-Server Development, Clark University, August 1995
B.S., Management Information Systems, Northeastern University, September 1986
Microsoft ¡V MCP (Microsoft Certified Professional)
EMPLOYMENT
1/2015 – Present
Training
After being laid off in early January of this year, I took a look at my current skills and the direction that web technologies were taking and realized how significantly my skills had eroded.  It has been a Mini Bootcamp situation.Using a variety of training on a daily basis, utilizing both video, books and VPS my skill level has increased significantly. Some of the technologies I have encountered include :
|
HTML5 / CSS 3 |
Native JavaScript |
jQuery / Jquery UI |
HTTP concepts including Restful Services |
Git and GitHub |
Twitter Bootstrap |
Angular |
Node |
Gulp |
Json / XML |
|
LAMP Stack – install and support |
Unix Command Line |
Ubuntu experience |
External API creation utiling Kimono Labs (screen scraping) |
Symphony Framework & |
Chrome / Firefox Dev Tools |
Sublime / Brackets / PHPStorm |
MySql / MongoDB |
|
|
|
Laravel 5.0 |
1/2015- 1/2015
Web Developer
State of Arizona Department of Corrections, Phoenix, AZ
Responsible for the Department’s Drupal Website. This included daily monitoring, site content updates and Drupal modifications site as directed. Served as the primary interface to the system for a community of 10,000 employees.
5/2013 – 5/2014 Web Developer
State of Arizona Department of Emergency Management, Phoenix, AZ
Developed several Drupal 7 applications. These applications were built using the Linux LAMP stack. My initial project was an agency-wide address book, which consolidated all DEMA employees’ information and phone numbers into one database. CSS, Javascript and JQuery were used as well to enhance the application. Other applications include the development of Surveys to gather feedback from team members throughout the State.
9/2012 – 10/2012 Contractor
Magellan, Phoenix, AZ
Contract position as a member of the ClaimTrak Development Team. Responsible for modifications to the ClaimTrak System. Duties included program development using OMNIS and database assignments using SQL Server 2005.
6/2011 – 6/2012 Web Developer
State of Arizona Board of Nursing, Phoenix, AZ
Developed a web-based Intranet Reporting System using SQL Server Reporting Services. Consolidating data from different sources, the construction of key indicator and operational reports were implemented with an automatic nightly update. Use of these new reports allowed agency resources to be allocated in a more efficient manner. Implemented several .Net web based applications that streamlined previous manual and Access solutions.
7/2007 – 5/2011 Web Developer
State of Arizona Department of Emergency Management, Phoenix, AZ
Responsible for the development and maintenance of our DEMA Intranet. I have developed applications that collect Credit Card, Purchase Orders, Requisitions and Reporting applications. These applications are integrated with our SQL Server 2005 Database. The applications and online reporting are built with ASP, ASP .Net and Microsoft Reporting Services. Also responsible for the administration, development and training in our SharePoint 2007 rollout.
3/2007 – 5/2007 Academic Advisor & Computer Lab Assistant
Pinnacle High School, Tempe, AZ
Responsible for 150 students a semester. Activities include monitoring students¡¦ progress in their classes, assisting them with selection of additional classes, monitoring their attendance and supporting them in their studies.
8/2005 – 3/2007 Instructor
The Bryman School, Phoenix, AZ
Responsible for delivering technical courses to young adult learners with a wide range of abilities. I played an active role in the learning process. In addition to formal classroom instruction, I worked with students individually to help them master the course content.
7/2001 – 4/2005 Senior Intranet Web Developer
Bank One, Phoenix, AZ
Developed enterprise Intranet applications for the Retail Lending Organization, including vehicle repossession systems. Applications were developed in ASP, ASP .NET, ADO, ADO .Net on an Oracle 9i platform. Responsible for training and mentoring several junior staff members.
8/1998 – 11/2000 Senior Intranet Web Developer
Textron Systems, Wilmington, MA
Lead the development/deployment of the first N-Tier Intranet application using web technologies. Implemented using Visual Interdev 6.0, ASP, ADO, Oracle 7.0 (stored procedures), VB 6.0 (COM). This system tracks the progress of a product from inception to completion. Mentored other staff members in the creation of N-Tier development. This includes developing their knowledge and skills in Visual Interdev 6.0, ASP, ADO, Oracle 7.0, VB 6.0 (COM Development), IE 5.0 DOM Object Model, Remote Data Services and Javascript.
6/1997 – 6/1998 Client/Server Developer/Systems Analyst
John Hancock Insurance, Boston, MA
Developer on ACT (Accounting, Calculations & Transactions) project. As a member of the Accounting Team, I worked closely with the internal business community to capture business requirements for Pension Accounting. At the completion of the requirement phase of the project, I successfully generated a prototype using Powerbuilder 5.0/PFC, which was used in JAD sessions. Utilized SQR to perform data conversions.
1/1997 – 6/1997 Systems Analyst
Capital Leasing, Framingham, MA
Powerbuilder 5.0 Developer on PCVAN System utilizing PFC and SQLAnywhere.
1987 – 1997 Systems Analyst
Polaroid Corporation, Waltham, MA
Lead Powerbuilder 4.0 Developer on the Common Ordering System. Designed, developed and implemented a paperless EDI based purchasing for the Polaroid community. Developed Powerbuilder 4.0 / SQL Server 6.5 Management Reporting System for the Purchasing Organization tracking spending by buyer and commodity.
1982 – 1987 Senior Programmer Analyst
Textron, Wilmington, MA
Provided support to over 1,000 clients in areas of implementation and feasibility advice, introductory and specialized training program and product support, and individual ad hoc consulting. Developed, maintained, and enhanced financial systems using packaged software MSA, INSCI, COBOL, VSAM, SAS, RAMIS and IDMS on an IBM 3083 MVS/CMS/TSO/ISPF OS/JCL environment.
1980 – 1982 Programmer
Commercial Union, Boston, MA
Worked in an IBM 3030 and 370 MVS/ISPF environment. Responsible for the development of a COBOL-based User Chargeback System.
1976 – 1980 Computer Operator
New England Gas & Electric, Cambridge, MA
Operated an IBM 370 Computer.


Making Gainz
Home
About
Contact
The Development Team
Backend Developer
April's GitHub
Web React 1 Developer
Cameron's GitHub
Web React 2 Developer
Nathan's GitHub
UI Developer
Seth's GitHub


Stub
- an empty page has been created
Review
- ready for review by
Complete
- page is active
Checked-Out
- page is being worked on
Archive-Todo
- page needs approval for archiving
Archived
- page has been archived
Intranet-Todo
- page needs approval for move to intranet
Intraneted
- page has been moved to intranet
Node #:
Old:
New
Chunk
Status
Stub
Review
Complete
Checked-Out
Archive-Todo
Archived
Intranet-Todo
Intraneted
History for:
(currently points to
)
Date/Time
Action
Author
Email
Password
Lane Migration Tracker
If you need an account here, please see Kyle Schmidt in IT
Add a New Link
Login
Highlight a Chunk:
Node #
New Url
Old Url
Chunk
Status
Last Edit
Last Edit time