Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
Safe Haskell | None |
Language | Haskell2010 |
- Exported types
- Methods
- variantTypeChecked_
- variantTypeCopy
- variantTypeDupString
- variantTypeElement
- variantTypeEqual
- variantTypeFirst
- variantTypeFree
- variantTypeGetStringLength
- variantTypeHash
- variantTypeIsArray
- variantTypeIsBasic
- variantTypeIsContainer
- variantTypeIsDefinite
- variantTypeIsDictEntry
- variantTypeIsMaybe
- variantTypeIsSubtypeOf
- variantTypeIsTuple
- variantTypeIsVariant
- variantTypeKey
- variantTypeNItems
- variantTypeNew
- variantTypeNewArray
- variantTypeNewDictEntry
- variantTypeNewMaybe
- variantTypeNewTuple
- variantTypeNext
- variantTypeStringIsValid
- variantTypeStringScan
- variantTypeValue
This section introduces the GVariant type system. It is based, in large part, on the D-Bus type system, with two major changes and some minor lifting of restrictions. The [D-Bus specification](http:/dbus.freedesktop.orgdoc/dbus-specification.html), therefore, provides a significant amount of information that is useful when working with GVariant.
The first major change with respect to the D-Bus type system is the introduction of maybe (or "nullable") types. Any type in GVariant can be converted to a maybe type, in which case, "nothing" (or "null") becomes a valid value. Maybe types have been added by introducing the character "m" to type strings.
The second major change is that the GVariant type system supports the concept of "indefinite types" -- types that are less specific than the normal types found in D-Bus. For example, it is possible to speak of "an array of any type" in GVariant, where the D-Bus type system would require you to speak of "an array of integers" or "an array of strings". Indefinite types have been added by introducing the characters "*", "?" and "r" to type strings.
Finally, all arbitrary restrictions relating to the complexity of types are lifted along with the restriction that dictionary entries may only appear nested inside of arrays.
Just as in D-Bus, GVariant types are described with strings ("type strings"). Subject to the differences mentioned above, these strings are of the same form as those found in DBus. Note, however: D-Bus always works in terms of messages and therefore individual type strings appear nowhere in its interface. Instead, "signatures" are a concatenation of the strings of the type of each argument in a message. GVariant deals with single values directly so GVariant type strings always describe the type of exactly one value. This means that a D-Bus signature string is generally not a valid GVariant type string -- except in the case that it is the signature of a message containing exactly one argument.
An indefinite type is similar in spirit to what may be called an abstract type in other type systems. No value can exist that has an indefinite type as its type, but values can exist that have types that are subtypes of indefinite types. That is to say, g_variant_get_type() will never return an indefinite type, but calling g_variant_is_of_type() with an indefinite type may return %TRUE. For example, you cannot have a value that represents "an array of no particular type", but you can have an "array of integers" which certainly matches the type of "an array of no particular type", since "array of integers" is a subtype of "array of no particular type".
This is similar to how instances of abstract classes may not directly exist in other type systems, but instances of their non-abstract subtypes may. For example, in GTK, no object that has the type of GtkBin is an abstract class), but a #GtkWindow can certainly be instantiated, and you would say that the GtkBin (since #GtkWindow is a subclass of #GtkBin).
## GVariant Type Strings
A GVariant type string can be any of the following:
- any basic type string (listed below)
- "v", "r" or "*"
- one of the characters
a
orm
, followed by another type string - the character '(', followed by a concatenation of zero or more other type strings, followed by the character ')'
- the character '{', followed by a basic type string (see below), followed by another type string, followed by the character '}'
A basic type string describes a basic type (as per g_variant_type_is_basic()) and is always a single character in length. The valid basic type strings are "b", "y", "n", "q", "i", "u", "x", "t", "h", "d", "s", "o", "g" and "?".
The above definition is recursive to arbitrary depth. "aaaaai" and "(ui(nq((y)))s)" are both valid type strings, as is "a(aa(ui)(qna{ya(yd)}))".
The meaning of each of the characters is as follows:
- b
: the type string of %G_VARIANT_TYPE_BOOLEAN; a boolean value.
- y
: the type string of %G_VARIANT_TYPE_BYTE; a byte.
- n
: the type string of %G_VARIANT_TYPE_INT16; a signed 16 bit integer.
- q
: the type string of %G_VARIANT_TYPE_UINT16; an unsigned 16 bit integer.
- i
: the type string of %G_VARIANT_TYPE_INT32; a signed 32 bit integer.
- u
: the type string of %G_VARIANT_TYPE_UINT32; an unsigned 32 bit integer.
- x
: the type string of %G_VARIANT_TYPE_INT64; a signed 64 bit integer.
- t
: the type string of %G_VARIANT_TYPE_UINT64; an unsigned 64 bit integer.
- h
: the type string of %G_VARIANT_TYPE_HANDLE; a signed 32 bit value
that, by convention, is used as an index into an array of file
descriptors that are sent alongside a D-Bus message.
- d
: the type string of %G_VARIANT_TYPE_DOUBLE; a double precision
floating point value.
- s
: the type string of %G_VARIANT_TYPE_STRING; a string.
- o
: the type string of %G_VARIANT_TYPE_OBJECT_PATH; a string in the form
of a D-Bus object path.
- g
: the type string of %G_VARIANT_TYPE_STRING; a string in the form of
a D-Bus type signature.
- ?
: the type string of %G_VARIANT_TYPE_BASIC; an indefinite type that
is a supertype of any of the basic types.
- v
: the type string of %G_VARIANT_TYPE_VARIANT; a container type that
contain any other type of value.
- a
: used as a prefix on another type string to mean an array of that
type; the type string "ai", for example, is the type of an array of
signed 32-bit integers.
- m
: used as a prefix on another type string to mean a "maybe", or
"nullable", version of that type; the type string "ms", for example,
is the type of a value that maybe contains a string, or maybe contains
nothing.
- `()`: used to enclose zero or more other concatenated type strings to
create a tuple type; the type string "(is)", for example, is the type of
a pair of an integer and a string.
- r
: the type string of %G_VARIANT_TYPE_TUPLE; an indefinite type that is
a supertype of any tuple type, regardless of the number of items.
- `{}`: used to enclose a basic type string concatenated with another type
string to create a dictionary entry type, which usually appears inside of
an array to form a dictionary; the type string "a{sd}", for example, is
the type of a dictionary that maps strings to double precision floating
point values.
The first type (the basic type) is the key type and the second type is
the value type. The reason that the first type is restricted to being a
basic type is so that it can easily be hashed.
- *
: the type string of %G_VARIANT_TYPE_ANY; the indefinite type that is
a supertype of all types. Note that, as with all type strings, this
character represents exactly one type. It cannot be used inside of tuples
to mean "any number of items".
Any type string of a container that contains an indefinite type is, itself, an indefinite type. For example, the type string "a*" (corresponding to %G_VARIANT_TYPE_ARRAY) is an indefinite type that is a supertype of every array type. "(*s)" is a supertype of all tuples that contain exactly two items where the second item is a string.
"a{?*}" is an indefinite type that is a supertype of all arrays containing dictionary entries where the key is any basic type and the value is any type at all. This is, by definition, a dictionary, so this type string corresponds to %G_VARIANT_TYPE_DICTIONARY. Note that, due to the restriction that the key of a dictionary entry must be a basic type, "{**}" is not a valid type string.
- newtype VariantType = VariantType (ForeignPtr VariantType)
- noVariantType :: Maybe VariantType
- variantTypeChecked_ :: MonadIO m => Text -> m VariantType
- data VariantTypeCopyMethodInfo
- variantTypeCopy :: MonadIO m => VariantType -> m VariantType
- data VariantTypeDupStringMethodInfo
- variantTypeDupString :: MonadIO m => VariantType -> m Text
- data VariantTypeElementMethodInfo
- variantTypeElement :: MonadIO m => VariantType -> m VariantType
- data VariantTypeEqualMethodInfo
- variantTypeEqual :: MonadIO m => VariantType -> VariantType -> m Bool
- data VariantTypeFirstMethodInfo
- variantTypeFirst :: MonadIO m => VariantType -> m VariantType
- data VariantTypeFreeMethodInfo
- variantTypeFree :: MonadIO m => VariantType -> m ()
- data VariantTypeGetStringLengthMethodInfo
- variantTypeGetStringLength :: MonadIO m => VariantType -> m Word64
- data VariantTypeHashMethodInfo
- variantTypeHash :: MonadIO m => VariantType -> m Word32
- data VariantTypeIsArrayMethodInfo
- variantTypeIsArray :: MonadIO m => VariantType -> m Bool
- data VariantTypeIsBasicMethodInfo
- variantTypeIsBasic :: MonadIO m => VariantType -> m Bool
- data VariantTypeIsContainerMethodInfo
- variantTypeIsContainer :: MonadIO m => VariantType -> m Bool
- data VariantTypeIsDefiniteMethodInfo
- variantTypeIsDefinite :: MonadIO m => VariantType -> m Bool
- data VariantTypeIsDictEntryMethodInfo
- variantTypeIsDictEntry :: MonadIO m => VariantType -> m Bool
- data VariantTypeIsMaybeMethodInfo
- variantTypeIsMaybe :: MonadIO m => VariantType -> m Bool
- data VariantTypeIsSubtypeOfMethodInfo
- variantTypeIsSubtypeOf :: MonadIO m => VariantType -> VariantType -> m Bool
- data VariantTypeIsTupleMethodInfo
- variantTypeIsTuple :: MonadIO m => VariantType -> m Bool
- data VariantTypeIsVariantMethodInfo
- variantTypeIsVariant :: MonadIO m => VariantType -> m Bool
- data VariantTypeKeyMethodInfo
- variantTypeKey :: MonadIO m => VariantType -> m VariantType
- data VariantTypeNItemsMethodInfo
- variantTypeNItems :: MonadIO m => VariantType -> m Word64
- variantTypeNew :: MonadIO m => Text -> m VariantType
- variantTypeNewArray :: MonadIO m => VariantType -> m VariantType
- variantTypeNewDictEntry :: MonadIO m => VariantType -> VariantType -> m VariantType
- variantTypeNewMaybe :: MonadIO m => VariantType -> m VariantType
- variantTypeNewTuple :: MonadIO m => [VariantType] -> m VariantType
- data VariantTypeNextMethodInfo
- variantTypeNext :: MonadIO m => VariantType -> m VariantType
- variantTypeStringIsValid :: MonadIO m => Text -> m Bool
- variantTypeStringScan :: MonadIO m => Text -> Maybe Text -> m (Bool, Text)
- data VariantTypeValueMethodInfo
- variantTypeValue :: MonadIO m => VariantType -> m VariantType
Exported types
newtype VariantType Source
Methods
variantTypeChecked_
variantTypeChecked_ :: MonadIO m => Text -> m VariantType Source
variantTypeCopy
data VariantTypeCopyMethodInfo Source
((~) * signature (m VariantType), MonadIO m) => MethodInfo * VariantTypeCopyMethodInfo VariantType signature |
variantTypeCopy :: MonadIO m => VariantType -> m VariantType Source
variantTypeDupString
data VariantTypeDupStringMethodInfo Source
((~) * signature (m Text), MonadIO m) => MethodInfo * VariantTypeDupStringMethodInfo VariantType signature |
variantTypeDupString :: MonadIO m => VariantType -> m Text Source
variantTypeElement
data VariantTypeElementMethodInfo Source
((~) * signature (m VariantType), MonadIO m) => MethodInfo * VariantTypeElementMethodInfo VariantType signature |
variantTypeElement :: MonadIO m => VariantType -> m VariantType Source
variantTypeEqual
data VariantTypeEqualMethodInfo Source
((~) * signature (VariantType -> m Bool), MonadIO m) => MethodInfo * VariantTypeEqualMethodInfo VariantType signature |
variantTypeEqual :: MonadIO m => VariantType -> VariantType -> m Bool Source
variantTypeFirst
data VariantTypeFirstMethodInfo Source
((~) * signature (m VariantType), MonadIO m) => MethodInfo * VariantTypeFirstMethodInfo VariantType signature |
variantTypeFirst :: MonadIO m => VariantType -> m VariantType Source
variantTypeFree
data VariantTypeFreeMethodInfo Source
((~) * signature (m ()), MonadIO m) => MethodInfo * VariantTypeFreeMethodInfo VariantType signature |
variantTypeFree :: MonadIO m => VariantType -> m () Source
variantTypeGetStringLength
data VariantTypeGetStringLengthMethodInfo Source
((~) * signature (m Word64), MonadIO m) => MethodInfo * VariantTypeGetStringLengthMethodInfo VariantType signature |
variantTypeGetStringLength :: MonadIO m => VariantType -> m Word64 Source
variantTypeHash
data VariantTypeHashMethodInfo Source
((~) * signature (m Word32), MonadIO m) => MethodInfo * VariantTypeHashMethodInfo VariantType signature |
variantTypeHash :: MonadIO m => VariantType -> m Word32 Source
variantTypeIsArray
data VariantTypeIsArrayMethodInfo Source
((~) * signature (m Bool), MonadIO m) => MethodInfo * VariantTypeIsArrayMethodInfo VariantType signature |
variantTypeIsArray :: MonadIO m => VariantType -> m Bool Source
variantTypeIsBasic
data VariantTypeIsBasicMethodInfo Source
((~) * signature (m Bool), MonadIO m) => MethodInfo * VariantTypeIsBasicMethodInfo VariantType signature |
variantTypeIsBasic :: MonadIO m => VariantType -> m Bool Source
variantTypeIsContainer
data VariantTypeIsContainerMethodInfo Source
((~) * signature (m Bool), MonadIO m) => MethodInfo * VariantTypeIsContainerMethodInfo VariantType signature |
variantTypeIsContainer :: MonadIO m => VariantType -> m Bool Source
variantTypeIsDefinite
data VariantTypeIsDefiniteMethodInfo Source
((~) * signature (m Bool), MonadIO m) => MethodInfo * VariantTypeIsDefiniteMethodInfo VariantType signature |
variantTypeIsDefinite :: MonadIO m => VariantType -> m Bool Source
variantTypeIsDictEntry
data VariantTypeIsDictEntryMethodInfo Source
((~) * signature (m Bool), MonadIO m) => MethodInfo * VariantTypeIsDictEntryMethodInfo VariantType signature |
variantTypeIsDictEntry :: MonadIO m => VariantType -> m Bool Source
variantTypeIsMaybe
data VariantTypeIsMaybeMethodInfo Source
((~) * signature (m Bool), MonadIO m) => MethodInfo * VariantTypeIsMaybeMethodInfo VariantType signature |
variantTypeIsMaybe :: MonadIO m => VariantType -> m Bool Source
variantTypeIsSubtypeOf
data VariantTypeIsSubtypeOfMethodInfo Source
((~) * signature (VariantType -> m Bool), MonadIO m) => MethodInfo * VariantTypeIsSubtypeOfMethodInfo VariantType signature |
variantTypeIsSubtypeOf :: MonadIO m => VariantType -> VariantType -> m Bool Source
variantTypeIsTuple
data VariantTypeIsTupleMethodInfo Source
((~) * signature (m Bool), MonadIO m) => MethodInfo * VariantTypeIsTupleMethodInfo VariantType signature |
variantTypeIsTuple :: MonadIO m => VariantType -> m Bool Source
variantTypeIsVariant
data VariantTypeIsVariantMethodInfo Source
((~) * signature (m Bool), MonadIO m) => MethodInfo * VariantTypeIsVariantMethodInfo VariantType signature |
variantTypeIsVariant :: MonadIO m => VariantType -> m Bool Source
variantTypeKey
data VariantTypeKeyMethodInfo Source
((~) * signature (m VariantType), MonadIO m) => MethodInfo * VariantTypeKeyMethodInfo VariantType signature |
variantTypeKey :: MonadIO m => VariantType -> m VariantType Source
variantTypeNItems
data VariantTypeNItemsMethodInfo Source
((~) * signature (m Word64), MonadIO m) => MethodInfo * VariantTypeNItemsMethodInfo VariantType signature |
variantTypeNItems :: MonadIO m => VariantType -> m Word64 Source
variantTypeNew
variantTypeNew :: MonadIO m => Text -> m VariantType Source
variantTypeNewArray
variantTypeNewArray :: MonadIO m => VariantType -> m VariantType Source
variantTypeNewDictEntry
variantTypeNewDictEntry :: MonadIO m => VariantType -> VariantType -> m VariantType Source
variantTypeNewMaybe
variantTypeNewMaybe :: MonadIO m => VariantType -> m VariantType Source
variantTypeNewTuple
variantTypeNewTuple :: MonadIO m => [VariantType] -> m VariantType Source
variantTypeNext
data VariantTypeNextMethodInfo Source
((~) * signature (m VariantType), MonadIO m) => MethodInfo * VariantTypeNextMethodInfo VariantType signature |
variantTypeNext :: MonadIO m => VariantType -> m VariantType Source
variantTypeStringIsValid
variantTypeStringIsValid :: MonadIO m => Text -> m Bool Source
variantTypeStringScan
variantTypeValue
data VariantTypeValueMethodInfo Source
((~) * signature (m VariantType), MonadIO m) => MethodInfo * VariantTypeValueMethodInfo VariantType signature |
variantTypeValue :: MonadIO m => VariantType -> m VariantType Source