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 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
|
/*
* This file is part of gtkD.
*
* gtkD is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 3
* of the License, or (at your option) any later version, with
* some exceptions, please read the COPYING file.
*
* gtkD is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with gtkD; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
*/
// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage
module glib.VariantType;
private import glib.ConstructionException;
private import glib.Str;
private import glib.c.functions;
public import glib.c.types;
public import gtkc.glibtypes;
private import gtkd.Loader;
/**
* 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.org/doc/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 can exist (since #GtkBin is an abstract class),
* but a #GtkWindow can certainly be instantiated, and you would say
* that the #GtkWindow is a #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' or 'm', 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)}))". In order to not hit memory limits, #GVariant
* imposes a limit on recursion depth of 65 nested containers. This is the
* limit in the D-Bus specification (64) plus one to allow a #GDBusMessage to
* be nested in a top-level tuple.
*
* 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_SIGNATURE; 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.
*/
public class VariantType
{
/** the main Gtk struct */
protected GVariantType* gVariantType;
protected bool ownedRef;
/** Get the main Gtk struct */
public GVariantType* getVariantTypeStruct(bool transferOwnership = false)
{
if (transferOwnership)
ownedRef = false;
return gVariantType;
}
/** the main Gtk struct as a void* */
protected void* getStruct()
{
return cast(void*)gVariantType;
}
/**
* Sets our main struct and passes it to the parent class.
*/
public this (GVariantType* gVariantType, bool ownedRef = false)
{
this.gVariantType = gVariantType;
this.ownedRef = ownedRef;
}
~this ()
{
if ( Linker.isLoaded(LIBRARY_GLIB) && ownedRef )
g_variant_type_free(gVariantType);
}
/**
* Constructs the type corresponding to a maybe instance containing
* type type or Nothing.
*
* It is appropriate to call free() on the return value.
*
* Params:
* element = a VariantType
*
* Return: a new maybe VariantType
*
* Since 2.24
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public static VariantType newMaybe(VariantType element)
{
auto p = g_variant_type_new_maybe((element is null) ? null : element.getVariantTypeStruct());
if(p is null)
{
throw new ConstructionException("null returned by new_maybe");
}
return new VariantType(cast(GVariantType*) p);
}
/**
*/
/**
* Creates a new #GVariantType corresponding to the type string given
* by @type_string. It is appropriate to call g_variant_type_free() on
* the return value.
*
* It is a programmer error to call this function with an invalid type
* string. Use g_variant_type_string_is_valid() if you are unsure.
*
* Params:
* typeString = a valid GVariant type string
*
* Returns: a new #GVariantType
*
* Since: 2.24
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(string typeString)
{
auto __p = g_variant_type_new(Str.toStringz(typeString));
if(__p is null)
{
throw new ConstructionException("null returned by new");
}
this(cast(GVariantType*) __p);
}
/**
* Constructs the type corresponding to an array of elements of the
* type @type.
*
* It is appropriate to call g_variant_type_free() on the return value.
*
* Params:
* element = a #GVariantType
*
* Returns: a new array #GVariantType
*
* Since 2.24
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(VariantType element)
{
auto __p = g_variant_type_new_array((element is null) ? null : element.getVariantTypeStruct());
if(__p is null)
{
throw new ConstructionException("null returned by new_array");
}
this(cast(GVariantType*) __p);
}
/**
* Constructs the type corresponding to a dictionary entry with a key
* of type @key and a value of type @value.
*
* It is appropriate to call g_variant_type_free() on the return value.
*
* Params:
* key = a basic #GVariantType
* value = a #GVariantType
*
* Returns: a new dictionary entry #GVariantType
*
* Since 2.24
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(VariantType key, VariantType value)
{
auto __p = g_variant_type_new_dict_entry((key is null) ? null : key.getVariantTypeStruct(), (value is null) ? null : value.getVariantTypeStruct());
if(__p is null)
{
throw new ConstructionException("null returned by new_dict_entry");
}
this(cast(GVariantType*) __p);
}
/**
* Constructs a new tuple type, from @items.
*
* @length is the number of items in @items, or -1 to indicate that
* @items is %NULL-terminated.
*
* It is appropriate to call g_variant_type_free() on the return value.
*
* Params:
* items = an array of #GVariantTypes, one for each item
*
* Returns: a new tuple #GVariantType
*
* Since 2.24
*
* Throws: ConstructionException GTK+ fails to create the object.
*/
public this(VariantType[] items)
{
GVariantType*[] itemsArray = new GVariantType*[items.length];
for ( int i = 0; i < items.length; i++ )
{
itemsArray[i] = items[i].getVariantTypeStruct();
}
auto __p = g_variant_type_new_tuple(itemsArray.ptr, cast(int)items.length);
if(__p is null)
{
throw new ConstructionException("null returned by new_tuple");
}
this(cast(GVariantType*) __p);
}
/**
* Makes a copy of a #GVariantType. It is appropriate to call
* g_variant_type_free() on the return value. @type may not be %NULL.
*
* Returns: a new #GVariantType
*
* Since 2.24
*/
public VariantType copy()
{
auto __p = g_variant_type_copy(gVariantType);
if(__p is null)
{
return null;
}
return new VariantType(cast(GVariantType*) __p, true);
}
/**
* Returns a newly-allocated copy of the type string corresponding to
* @type. The returned string is nul-terminated. It is appropriate to
* call g_free() on the return value.
*
* Returns: the corresponding type string
*
* Since 2.24
*/
public string dupString()
{
auto retStr = g_variant_type_dup_string(gVariantType);
scope(exit) Str.freeString(retStr);
return Str.toString(retStr);
}
/**
* Determines the element type of an array or maybe type.
*
* This function may only be used with array or maybe types.
*
* Returns: the element type of @type
*
* Since 2.24
*/
public VariantType element()
{
auto __p = g_variant_type_element(gVariantType);
if(__p is null)
{
return null;
}
return new VariantType(cast(GVariantType*) __p);
}
/**
* Compares @type1 and @type2 for equality.
*
* Only returns %TRUE if the types are exactly equal. Even if one type
* is an indefinite type and the other is a subtype of it, %FALSE will
* be returned if they are not exactly equal. If you want to check for
* subtypes, use g_variant_type_is_subtype_of().
*
* The argument types of @type1 and @type2 are only #gconstpointer to
* allow use with #GHashTable without function pointer casting. For
* both arguments, a valid #GVariantType must be provided.
*
* Params:
* type2 = a #GVariantType
*
* Returns: %TRUE if @type1 and @type2 are exactly equal
*
* Since 2.24
*/
public bool equal(VariantType type2)
{
return g_variant_type_equal(gVariantType, (type2 is null) ? null : type2.getVariantTypeStruct()) != 0;
}
/**
* Determines the first item type of a tuple or dictionary entry
* type.
*
* This function may only be used with tuple or dictionary entry types,
* but must not be used with the generic tuple type
* %G_VARIANT_TYPE_TUPLE.
*
* In the case of a dictionary entry type, this returns the type of
* the key.
*
* %NULL is returned in case of @type being %G_VARIANT_TYPE_UNIT.
*
* This call, together with g_variant_type_next() provides an iterator
* interface over tuple and dictionary entry types.
*
* Returns: the first item type of @type, or %NULL
*
* Since 2.24
*/
public VariantType first()
{
auto __p = g_variant_type_first(gVariantType);
if(__p is null)
{
return null;
}
return new VariantType(cast(GVariantType*) __p);
}
/**
* Frees a #GVariantType that was allocated with
* g_variant_type_copy(), g_variant_type_new() or one of the container
* type constructor functions.
*
* In the case that @type is %NULL, this function does nothing.
*
* Since 2.24
*/
public void free()
{
g_variant_type_free(gVariantType);
ownedRef = false;
}
/**
* Returns the length of the type string corresponding to the given
* @type. This function must be used to determine the valid extent of
* the memory region returned by g_variant_type_peek_string().
*
* Returns: the length of the corresponding type string
*
* Since 2.24
*/
public size_t getStringLength()
{
return g_variant_type_get_string_length(gVariantType);
}
/**
* Hashes @type.
*
* The argument type of @type is only #gconstpointer to allow use with
* #GHashTable without function pointer casting. A valid
* #GVariantType must be provided.
*
* Returns: the hash value
*
* Since 2.24
*/
public uint hash()
{
return g_variant_type_hash(gVariantType);
}
/**
* Determines if the given @type is an array type. This is true if the
* type string for @type starts with an 'a'.
*
* This function returns %TRUE for any indefinite type for which every
* definite subtype is an array type -- %G_VARIANT_TYPE_ARRAY, for
* example.
*
* Returns: %TRUE if @type is an array type
*
* Since 2.24
*/
public bool isArray()
{
return g_variant_type_is_array(gVariantType) != 0;
}
/**
* Determines if the given @type is a basic type.
*
* Basic types are booleans, bytes, integers, doubles, strings, object
* paths and signatures.
*
* Only a basic type may be used as the key of a dictionary entry.
*
* This function returns %FALSE for all indefinite types except
* %G_VARIANT_TYPE_BASIC.
*
* Returns: %TRUE if @type is a basic type
*
* Since 2.24
*/
public bool isBasic()
{
return g_variant_type_is_basic(gVariantType) != 0;
}
/**
* Determines if the given @type is a container type.
*
* Container types are any array, maybe, tuple, or dictionary
* entry types plus the variant type.
*
* This function returns %TRUE for any indefinite type for which every
* definite subtype is a container -- %G_VARIANT_TYPE_ARRAY, for
* example.
*
* Returns: %TRUE if @type is a container type
*
* Since 2.24
*/
public bool isContainer()
{
return g_variant_type_is_container(gVariantType) != 0;
}
/**
* Determines if the given @type is definite (ie: not indefinite).
*
* A type is definite if its type string does not contain any indefinite
* type characters ('*', '?', or 'r').
*
* A #GVariant instance may not have an indefinite type, so calling
* this function on the result of g_variant_get_type() will always
* result in %TRUE being returned. Calling this function on an
* indefinite type like %G_VARIANT_TYPE_ARRAY, however, will result in
* %FALSE being returned.
*
* Returns: %TRUE if @type is definite
*
* Since 2.24
*/
public bool isDefinite()
{
return g_variant_type_is_definite(gVariantType) != 0;
}
/**
* Determines if the given @type is a dictionary entry type. This is
* true if the type string for @type starts with a '{'.
*
* This function returns %TRUE for any indefinite type for which every
* definite subtype is a dictionary entry type --
* %G_VARIANT_TYPE_DICT_ENTRY, for example.
*
* Returns: %TRUE if @type is a dictionary entry type
*
* Since 2.24
*/
public bool isDictEntry()
{
return g_variant_type_is_dict_entry(gVariantType) != 0;
}
/**
* Determines if the given @type is a maybe type. This is true if the
* type string for @type starts with an 'm'.
*
* This function returns %TRUE for any indefinite type for which every
* definite subtype is a maybe type -- %G_VARIANT_TYPE_MAYBE, for
* example.
*
* Returns: %TRUE if @type is a maybe type
*
* Since 2.24
*/
public bool isMaybe()
{
return g_variant_type_is_maybe(gVariantType) != 0;
}
/**
* Checks if @type is a subtype of @supertype.
*
* This function returns %TRUE if @type is a subtype of @supertype. All
* types are considered to be subtypes of themselves. Aside from that,
* only indefinite types can have subtypes.
*
* Params:
* supertype = a #GVariantType
*
* Returns: %TRUE if @type is a subtype of @supertype
*
* Since 2.24
*/
public bool isSubtypeOf(VariantType supertype)
{
return g_variant_type_is_subtype_of(gVariantType, (supertype is null) ? null : supertype.getVariantTypeStruct()) != 0;
}
/**
* Determines if the given @type is a tuple type. This is true if the
* type string for @type starts with a '(' or if @type is
* %G_VARIANT_TYPE_TUPLE.
*
* This function returns %TRUE for any indefinite type for which every
* definite subtype is a tuple type -- %G_VARIANT_TYPE_TUPLE, for
* example.
*
* Returns: %TRUE if @type is a tuple type
*
* Since 2.24
*/
public bool isTuple()
{
return g_variant_type_is_tuple(gVariantType) != 0;
}
/**
* Determines if the given @type is the variant type.
*
* Returns: %TRUE if @type is the variant type
*
* Since 2.24
*/
public bool isVariant()
{
return g_variant_type_is_variant(gVariantType) != 0;
}
/**
* Determines the key type of a dictionary entry type.
*
* This function may only be used with a dictionary entry type. Other
* than the additional restriction, this call is equivalent to
* g_variant_type_first().
*
* Returns: the key type of the dictionary entry
*
* Since 2.24
*/
public VariantType key()
{
auto __p = g_variant_type_key(gVariantType);
if(__p is null)
{
return null;
}
return new VariantType(cast(GVariantType*) __p);
}
/**
* Determines the number of items contained in a tuple or
* dictionary entry type.
*
* This function may only be used with tuple or dictionary entry types,
* but must not be used with the generic tuple type
* %G_VARIANT_TYPE_TUPLE.
*
* In the case of a dictionary entry type, this function will always
* return 2.
*
* Returns: the number of items in @type
*
* Since 2.24
*/
public size_t nItems()
{
return g_variant_type_n_items(gVariantType);
}
/**
* Determines the next item type of a tuple or dictionary entry
* type.
*
* @type must be the result of a previous call to
* g_variant_type_first() or g_variant_type_next().
*
* If called on the key type of a dictionary entry then this call
* returns the value type. If called on the value type of a dictionary
* entry then this call returns %NULL.
*
* For tuples, %NULL is returned when @type is the last item in a tuple.
*
* Returns: the next #GVariantType after @type, or %NULL
*
* Since 2.24
*/
public VariantType next()
{
auto __p = g_variant_type_next(gVariantType);
if(__p is null)
{
return null;
}
return new VariantType(cast(GVariantType*) __p);
}
/**
* Returns the type string corresponding to the given @type. The
* result is not nul-terminated; in order to determine its length you
* must call g_variant_type_get_string_length().
*
* To get a nul-terminated string, see g_variant_type_dup_string().
*
* Returns: the corresponding type string (not nul-terminated)
*
* Since 2.24
*/
public string peekString()
{
return Str.toString(g_variant_type_peek_string(gVariantType));
}
/**
* Determines the value type of a dictionary entry type.
*
* This function may only be used with a dictionary entry type.
*
* Returns: the value type of the dictionary entry
*
* Since 2.24
*/
public VariantType value()
{
auto __p = g_variant_type_value(gVariantType);
if(__p is null)
{
return null;
}
return new VariantType(cast(GVariantType*) __p);
}
/** */
public static VariantType checked(string arg0)
{
auto __p = g_variant_type_checked_(Str.toStringz(arg0));
if(__p is null)
{
return null;
}
return new VariantType(cast(GVariantType*) __p);
}
/** */
public static size_t stringGetDepth(string typeString)
{
return g_variant_type_string_get_depth_(Str.toStringz(typeString));
}
/**
* Checks if @type_string is a valid GVariant type string. This call is
* equivalent to calling g_variant_type_string_scan() and confirming
* that the following character is a nul terminator.
*
* Params:
* typeString = a pointer to any string
*
* Returns: %TRUE if @type_string is exactly one valid type string
*
* Since 2.24
*/
public static bool stringIsValid(string typeString)
{
return g_variant_type_string_is_valid(Str.toStringz(typeString)) != 0;
}
/**
* Scan for a single complete and valid GVariant type string in @string.
* The memory pointed to by @limit (or bytes beyond it) is never
* accessed.
*
* If a valid type string is found, @endptr is updated to point to the
* first character past the end of the string that was found and %TRUE
* is returned.
*
* If there is no valid type string starting at @string, or if the type
* string does not end before @limit then %FALSE is returned.
*
* For the simple case of checking if a string is a valid type string,
* see g_variant_type_string_is_valid().
*
* Params:
* string_ = a pointer to any string
* limit = the end of @string, or %NULL
* endptr = location to store the end pointer, or %NULL
*
* Returns: %TRUE if a valid type string was found
*
* Since: 2.24
*/
public static bool stringScan(string string_, string limit, out string endptr)
{
char* outendptr = null;
auto __p = g_variant_type_string_scan(Str.toStringz(string_), Str.toStringz(limit), &outendptr) != 0;
endptr = Str.toString(outendptr);
return __p;
}
}
|