/usr/include/glibmm-2.4/glibmm/varianttype.h is in libglibmm-2.4-dev 2.42.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | // -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GLIBMM_VARIANTTYPE_H
#define _GLIBMM_VARIANTTYPE_H
/* Copyright 2010 The glibmm Development Team
*
* This library 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 2.1 of the License, or (at your option) any later version.
*
* This library 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 this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <glibmmconfig.h>
#include <glib-object.h> //For gsize
#include <string>
#include <vector>
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GVariantType GVariantType;
#endif //DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
/** VariantType - The VariantBase type system.
* The VariantBase type system is based, in large part, on the D-Bus type
* system, with two major changes and some minor lifting of restrictions. <a
* href="http://dbus.freedesktop.org/doc/dbus-specification.html">The
* D-Bus specification</a>, therefore, provides a significant amount of
* information that is useful when working with VariantBase.
*
* The first major change with respect to the D-Bus type system is the
* introduction of maybe (or "nullable") types. Any type in VariantBase
* 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 VariantBase 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 VariantBase, 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, VariantBase types are described with strings ("type
* strings"). Subject to the differences mentioned above, these strings are of
* the same form as those found in D-Bus. 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. VariantBase deals with single
* values directly so VariantBase type strings always describe the type
* of exactly one value. This means that a D-Bus signature string is generally
* not a valid VariantBase 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, VariantBase::get_type() will never
* return an indefinite type, but calling VariantBase::is_of_type() with
* an indefinite type may return <tt>true</tt>. 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 gtkmm, no object that has the type of Gtk::Bin can exist (since
* Gtk::Bin is an abstract class), but a Gtk::Window can certainly be
* instantiated, and you would say that the Gtk::Window is a Gtk::Bin (since
* Gtk::Window is a subclass of Gtk::Bin).
*
* See the underlying GVariantType documentation for <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariantType.html#gvariant-typestrings">detailed description of the VariantBase type strings</a>.
*
* @newin{2,28}
* @ingroup Variant
*/
class VariantType
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef VariantType CppObjectType;
typedef GVariantType BaseObjectType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
/** Constructs an invalid object.
* E.g. for output arguments to methods. There is not much you can do with
* the object before it has been assigned a valid value.
*/
VariantType();
// Use make_a_copy=true when getting it directly from a struct.
explicit VariantType(GVariantType* castitem, bool make_a_copy = false);
VariantType(const VariantType& src);
VariantType& operator=(const VariantType& src);
~VariantType();
GVariantType* gobj() { return gobject_; }
const GVariantType* gobj() const { return gobject_; }
///Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
GVariantType* gobj_copy() const;
protected:
GVariantType* gobject_;
private:
public:
/** Copy the C item into a new VariantType instance.
*/
explicit VariantType(const GVariantType* castitem);
/** Creates a new VariantType corresponding to the type string given by @a type_string.
*
* It is a programmer error to call this function with an invalid type string. Use string_is_valid() if you are unsure.
*/
explicit VariantType(const std::string& type_string);
VariantType& operator=(const GVariantType* castitem);
//The C parameters are actually const, but gmmproc doesn't understand that,
//so we add a m4 conversion to satisfy it:
/** Constructs the type corresponding to an array of elements of the
* type @a type.
*
* It is appropriate to call g_variant_type_free() on the return value.
*
* @newin{2,24}
*
* @return A new array VariantType.
*/
static VariantType create_array(const VariantType& element);
/** Constructs the type corresponding to a maybe instance containing
* type @a type or Nothing.
*
* It is appropriate to call g_variant_type_free() on the return value.
*
* @newin{2,24}
*
* @return A new maybe VariantType.
*/
static VariantType create_maybe(const VariantType& element);
/** Constructs a new tuple type, from @a items.
*
* @param items A vector of VariantTypes, one for each item.
* @return A new tuple VariantType.
*
* @newin{2,36}
*/
static VariantType create_tuple(const std::vector<VariantType>& items);
/** Constructs the type corresponding to a dictionary entry with a key
* of type @a key and a value of type @a value.
*
* It is appropriate to call g_variant_type_free() on the return value.
*
* @newin{2,24}
*
* @param value A VariantType.
* @return A new dictionary entry VariantType.
*/
static VariantType create_dict_entry(const VariantType& key, const VariantType& value);
//TODO: Use something instead of gsize?
/** Returns the length of the type string corresponding to the given
* @a type. This function must be used to determine the valid extent of
* the memory region returned by g_variant_type_peek_string().
*
* @newin{2,24}
*
* @return The length of the corresponding type string.
*/
gsize _get_string_length() const;
/** Returns the type string corresponding to the given @a 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().
*
* @newin{2,24}
*
* @return The corresponding type string (not nul-terminated).
*/
std::string get_string() const;
/** Determines if the given @a type is definite (ie: not indefinite).
*
* A type is definite if its type string does not contain any indefinite
* type characters ('*', '?', or 'r').
*
* A Variant instance may not have an indefinite type, so calling
* this function on the result of g_variant_get_type() will always
* result in <tt>true</tt> being returned. Calling this function on an
* indefinite type like VARIANT_TYPE_ARRAY, however, will result in
* <tt>false</tt> being returned.
*
* @newin{2,24}
*
* @return <tt>true</tt> if @a type is definite.
*/
bool is_definite() const;
/** Determines if the given @a type is a container type.
*
* Container types are any array, maybe, tuple, or dictionary
* entry types plus the variant type.
*
* This function returns <tt>true</tt> for any indefinite type for which every
* definite subtype is a container -- VARIANT_TYPE_ARRAY, for
* example.
*
* @newin{2,24}
*
* @return <tt>true</tt> if @a type is a container type.
*/
bool is_container() const;
/** Determines if the given @a 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 <tt>false</tt> for all indefinite types except
* VARIANT_TYPE_BASIC.
*
* @newin{2,24}
*
* @return <tt>true</tt> if @a type is a basic type.
*/
bool is_basic() const;
/** Determines if the given @a type is a maybe type. This is true if the
* type string for @a type starts with an 'm'.
*
* This function returns <tt>true</tt> for any indefinite type for which every
* definite subtype is a maybe type -- VARIANT_TYPE_MAYBE, for
* example.
*
* @newin{2,24}
*
* @return <tt>true</tt> if @a type is a maybe type.
*/
bool is_maybe() const;
/** Determines if the given @a type is an array type. This is true if the
* type string for @a type starts with an 'a'.
*
* This function returns <tt>true</tt> for any indefinite type for which every
* definite subtype is an array type -- VARIANT_TYPE_ARRAY, for
* example.
*
* @newin{2,24}
*
* @return <tt>true</tt> if @a type is an array type.
*/
bool is_array() const;
/** Determines if the given @a type is a tuple type. This is true if the
* type string for @a type starts with a '(' or if @a type is
* VARIANT_TYPE_TUPLE.
*
* This function returns <tt>true</tt> for any indefinite type for which every
* definite subtype is a tuple type -- VARIANT_TYPE_TUPLE, for
* example.
*
* @newin{2,24}
*
* @return <tt>true</tt> if @a type is a tuple type.
*/
bool is_tuple() const;
/** Determines if the given @a type is a dictionary entry type. This is
* true if the type string for @a type starts with a '{'.
*
* This function returns <tt>true</tt> for any indefinite type for which every
* definite subtype is a dictionary entry type --
* VARIANT_TYPE_DICT_ENTRY, for example.
*
* @newin{2,24}
*
* @return <tt>true</tt> if @a type is a dictionary entry type.
*/
bool is_dict_entry() const;
/** Determines if the given @a type is the variant type.
*
* @newin{2,24}
*
* @return <tt>true</tt> if @a type is the variant type.
*/
bool is_variant() const;
/** Hashes @a type.
*
* The argument type of @a type is only #gconstpointer to allow use with
* HashTable without function pointer casting. A valid
* VariantType must be provided.
*
* @newin{2,24}
*
* @param type A VariantType.
* @return The hash value.
*/
guint hash() const;
/** Compares @a *this and @a other for equality.
*
* Only returns <tt>true</tt> if the types are exactly equal. Even if one type
* is an indefinite type and the other is a subtype of it, <tt>false</tt> will
* be returned if they are not exactly equal. If you want to check for
* subtypes, use is_subtype_of().
*
* @param other The VariantType to compare with.
* @return <tt>true</tt> if @a *this and @a other are exactly equal.
*
* @newin{2,24}
*/
bool equal(const VariantType& other) const;
/** Checks if @a type is a subtype of @a supertype.
*
* This function returns <tt>true</tt> if @a type is a subtype of @a supertype. All
* types are considered to be subtypes of themselves. Aside from that,
* only indefinite types can have subtypes.
*
* @newin{2,24}
*
* @param supertype A VariantType.
* @return <tt>true</tt> if @a type is a subtype of @a supertype.
*/
bool is_subtype_of(const VariantType& supertype) const;
// It's necessary to take an extra reference of the 'const GVariantType*'
// returned by g_variant_type_element() because it doesn't do that already.
/** Determines the element type of an array or maybe type.
*
* This function may only be used with array or maybe types.
*
* @newin{2,24}
*
* @return The element type of @a type.
*/
VariantType element() const;
/** 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
* VARIANT_TYPE_TUPLE.
*
* In the case of a dictionary entry type, this returns the type of
* the key.
*
* <tt>0</tt> is returned in case of @a type being VARIANT_TYPE_UNIT.
*
* This call, together with g_variant_type_next() provides an iterator
* interface over tuple and dictionary entry types.
*
* @newin{2,24}
*
* @return The first item type of @a type, or <tt>0</tt>.
*/
VariantType first() const;
/** Determines the next item type of a tuple or dictionary entry
* type.
*
* @a 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 <tt>0</tt>.
*
* For tuples, <tt>0</tt> is returned when @a type is the last item in a tuple.
*
* @newin{2,24}
*
* @return The next VariantType after @a type, or <tt>0</tt>.
*/
VariantType next() const;
/** 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
* VARIANT_TYPE_TUPLE.
*
* In the case of a dictionary entry type, this function will always
* return 2.
*
* @newin{2,24}
*
* @return The number of items in @a type.
*/
gsize n_items() const;
/** 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().
*
* @newin{2,24}
*
* @return The key type of the dictionary entry.
*/
VariantType key() const;
/** Determines the value type of a dictionary entry type.
*
* This function may only be used with a dictionary entry type.
*
* @newin{2,24}
*
* @return The value type of the dictionary entry.
*/
VariantType value() const;
// This function is part of unexposed API in gvarianttypeinfo.{h,c} for an
// also unexposed GVariantTypeInfo structure of glib.
};
extern const VariantType VARIANT_TYPE_BOOL;
extern const VariantType VARIANT_TYPE_BYTE;
extern const VariantType VARIANT_TYPE_INT16;
extern const VariantType VARIANT_TYPE_UINT16;
extern const VariantType VARIANT_TYPE_INT32;
extern const VariantType VARIANT_TYPE_UINT32;
extern const VariantType VARIANT_TYPE_INT64;
extern const VariantType VARIANT_TYPE_UINT64;
extern const VariantType VARIANT_TYPE_DOUBLE;
extern const VariantType VARIANT_TYPE_STRING;
extern const VariantType VARIANT_TYPE_OBJECT_PATH;
extern const VariantType VARIANT_TYPE_SIGNATURE;
extern const VariantType VARIANT_TYPE_VARIANT;
extern const VariantType VARIANT_TYPE_HANDLE;
extern const VariantType VARIANT_TYPE_UNIT;
extern const VariantType VARIANT_TYPE_ANY;
extern const VariantType VARIANT_TYPE_BASIC;
extern const VariantType VARIANT_TYPE_MAYBE;
extern const VariantType VARIANT_TYPE_ARRAY;
extern const VariantType VARIANT_TYPE_TUPLE;
extern const VariantType VARIANT_TYPE_DICT_ENTRY;
extern const VariantType VARIANT_TYPE_DICTIONARY;
extern const VariantType VARIANT_TYPE_STRING_ARRAY;
extern const VariantType VARIANT_TYPE_BYTESTRING;
extern const VariantType VARIANT_TYPE_BYTESTRING_ARRAY;
} // namespace Glib
namespace Glib
{
/** A Glib::wrap() method for this object.
*
* @param object The C instance.
* @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
* @result A C++ instance that wraps this C instance.
*
* @relates Glib::VariantType
*/
Glib::VariantType wrap(GVariantType* object, bool take_copy = false);
} // namespace Glib
#endif /* _GLIBMM_VARIANTTYPE_H */
|