-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathGIRepository-2.0.gir
4152 lines (4123 loc) · 188 KB
/
GIRepository-2.0.gir
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
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository version="1.2"
xmlns="http://www.gtk.org/introspection/core/1.0"
xmlns:c="http://www.gtk.org/introspection/c/1.0"
xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
<include name="GObject" version="2.0"/>
<package name="gobject-introspection-1.0"/>
<c:include name="girepository.h"/>
<namespace name="GIRepository"
version="2.0"
shared-library="libgirepository-1.0.so.1"
c:identifier-prefixes="GI"
c:symbol-prefixes="g">
<alias name="ArgInfo" c:type="GIArgInfo">
<doc xml:space="preserve">Represents an argument.</doc>
<type name="BaseInfo" c:type="GIBaseInfo"/>
</alias>
<alias name="CallableInfo" c:type="GICallableInfo">
<doc xml:space="preserve">Represents a callable, either #GIFunctionInfo, #GICallbackInfo or
#GIVFuncInfo.</doc>
<type name="BaseInfo" c:type="GIBaseInfo"/>
</alias>
<alias name="CallbackInfo" c:type="GICallbackInfo">
<doc xml:space="preserve">Represents a callback, eg arguments and return value.</doc>
<type name="BaseInfo" c:type="GIBaseInfo"/>
</alias>
<alias name="ConstantInfo" c:type="GIConstantInfo">
<doc xml:space="preserve">Represents a constant.</doc>
<type name="BaseInfo" c:type="GIBaseInfo"/>
</alias>
<alias name="EnumInfo" c:type="GIEnumInfo">
<doc xml:space="preserve">Represents an enum or a flag.</doc>
<type name="BaseInfo" c:type="GIBaseInfo"/>
</alias>
<alias name="FieldInfo" c:type="GIFieldInfo">
<doc xml:space="preserve">Represents a field of a #GIStructInfo or a #GIUnionInfo.</doc>
<type name="BaseInfo" c:type="GIBaseInfo"/>
</alias>
<alias name="FunctionInfo" c:type="GIFunctionInfo">
<doc xml:space="preserve">Represents a function, eg arguments and return value.</doc>
<type name="BaseInfo" c:type="GIBaseInfo"/>
</alias>
<alias name="InterfaceInfo" c:type="GIInterfaceInfo">
<doc xml:space="preserve">Represents an interface.</doc>
<type name="BaseInfo" c:type="GIBaseInfo"/>
</alias>
<alias name="ObjectInfo" c:type="GIObjectInfo">
<doc xml:space="preserve">Represents an object.</doc>
<type name="BaseInfo" c:type="GIBaseInfo"/>
</alias>
<alias name="PropertyInfo" c:type="GIPropertyInfo">
<doc xml:space="preserve">Represents a property of a #GIObjectInfo or a #GIInterfaceInfo.</doc>
<type name="BaseInfo" c:type="GIBaseInfo"/>
</alias>
<alias name="RegisteredTypeInfo" c:type="GIRegisteredTypeInfo">
<doc xml:space="preserve">Represent a registered type.</doc>
<type name="BaseInfo" c:type="GIBaseInfo"/>
</alias>
<alias name="SignalInfo" c:type="GISignalInfo">
<doc xml:space="preserve">Represents a signal.</doc>
<type name="BaseInfo" c:type="GIBaseInfo"/>
</alias>
<alias name="StructInfo" c:type="GIStructInfo">
<doc xml:space="preserve">Represents a struct.</doc>
<type name="BaseInfo" c:type="GIBaseInfo"/>
</alias>
<alias name="TypeInfo" c:type="GITypeInfo">
<doc xml:space="preserve">Represents type information, direction, transfer etc.</doc>
<type name="BaseInfo" c:type="GIBaseInfo"/>
</alias>
<alias name="UnionInfo" c:type="GIUnionInfo">
<doc xml:space="preserve">Represents a union.</doc>
<type name="BaseInfo" c:type="GIBaseInfo"/>
</alias>
<alias name="VFuncInfo" c:type="GIVFuncInfo">
<doc xml:space="preserve">Represents a virtual function.</doc>
<type name="BaseInfo" c:type="GIBaseInfo"/>
</alias>
<alias name="ValueInfo" c:type="GIValueInfo">
<doc xml:space="preserve">Represents a enum value of a #GIEnumInfo.</doc>
<type name="BaseInfo" c:type="GIBaseInfo"/>
</alias>
<union name="Argument" c:type="GIArgument">
<doc xml:space="preserve">Stores an argument of varying type</doc>
<field name="v_boolean" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="gboolean" c:type="gboolean"/>
</field>
<field name="v_int8" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="gint8" c:type="gint8"/>
</field>
<field name="v_uint8" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="guint8" c:type="guint8"/>
</field>
<field name="v_int16" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="gint16" c:type="gint16"/>
</field>
<field name="v_uint16" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="guint16" c:type="guint16"/>
</field>
<field name="v_int32" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="gint32" c:type="gint32"/>
</field>
<field name="v_uint32" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="guint32" c:type="guint32"/>
</field>
<field name="v_int64" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="gint64" c:type="gint64"/>
</field>
<field name="v_uint64" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="guint64" c:type="guint64"/>
</field>
<field name="v_float" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="gfloat" c:type="gfloat"/>
</field>
<field name="v_double" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="gdouble" c:type="gdouble"/>
</field>
<field name="v_short" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="gshort" c:type="gshort"/>
</field>
<field name="v_ushort" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="gushort" c:type="gushort"/>
</field>
<field name="v_int" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="gint" c:type="gint"/>
</field>
<field name="v_uint" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="guint" c:type="guint"/>
</field>
<field name="v_long" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="glong" c:type="glong"/>
</field>
<field name="v_ulong" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="gulong" c:type="gulong"/>
</field>
<field name="v_ssize" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="gssize" c:type="gssize"/>
</field>
<field name="v_size" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="gsize" c:type="gsize"/>
</field>
<field name="v_string" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="utf8" c:type="gchar*"/>
</field>
<field name="v_pointer" writable="1">
<doc xml:space="preserve">TODO</doc>
<type name="gpointer" c:type="gpointer"/>
</field>
</union>
<enumeration name="ArrayType" c:type="GIArrayType">
<doc xml:space="preserve">The type of array in a #GITypeInfo.</doc>
<member name="c" value="0" c:identifier="GI_ARRAY_TYPE_C">
<doc xml:space="preserve">a C array, char[] for instance</doc>
</member>
<member name="array" value="1" c:identifier="GI_ARRAY_TYPE_ARRAY">
<doc xml:space="preserve">a @GArray array</doc>
</member>
<member name="ptr_array"
value="2"
c:identifier="GI_ARRAY_TYPE_PTR_ARRAY">
<doc xml:space="preserve">a #GPtrArray array</doc>
</member>
<member name="byte_array"
value="3"
c:identifier="GI_ARRAY_TYPE_BYTE_ARRAY">
<doc xml:space="preserve">a #GByteArray array</doc>
</member>
</enumeration>
<record name="AttributeIter" c:type="GIAttributeIter">
<doc xml:space="preserve">An opaque structure used to iterate over attributes
in a #GIBaseInfo struct.</doc>
<field name="data" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="data2" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="data3" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="data4" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
</record>
<record name="BaseInfo"
c:type="GIBaseInfo"
glib:type-name="GIBaseInfo"
glib:get-type="g_base_info_gtype_get_type"
c:symbol-prefix="base_info_gtype">
<doc xml:space="preserve">GIBaseInfo is the common base struct of all other *Info structs
accessible through the #GIRepository API.
All other structs can be casted to a #GIBaseInfo, for instance:
<example>
<title>Casting a #GIFunctionInfo to #GIBaseInfo</title>
<programlisting>
GIFunctionInfo *function_info = ...;
GIBaseInfo *info = (GIBaseInfo*)function_info;
</programlisting>
</example>
Most #GIRepository APIs returning a #GIBaseInfo is actually creating a new struct, in other
words, g_base_info_unref() has to be called when done accessing the data.
GIBaseInfos are normally accessed by calling either
g_irepository_find_by_name(), g_irepository_find_by_gtype() or g_irepository_get_info().
<example>
<title>Getting the Button of the Gtk typelib</title>
<programlisting>
GIBaseInfo *button_info = g_irepository_find_by_name(NULL, "Gtk", "Button");
... use button_info ...
g_base_info_unref(button_info);
</programlisting>
</example>
<refsect1 id="gi-gibaseinfo.struct-hierarchy" role="struct_hierarchy">
<title role="struct_hierarchy.title">Struct hierarchy</title>
<synopsis>
GIBaseInfo
+----<link linkend="gi-GIArgInfo">GIArgInfo</link>
+----<link linkend="gi-GICallableInfo">GICallableInfo</link>
+----<link linkend="gi-GIConstantInfo">GIConstantInfo</link>
+----<link linkend="gi-GIFieldInfo">GIFieldInfo</link>
+----<link linkend="gi-GIPropertyInfo">GIPropertyInfo</link>
+----<link linkend="gi-GIRegisteredTypeInfo">GIRegisteredTypeInfo</link>
+----<link linkend="gi-GITypeInfo">GITypeInfo</link>
</synopsis>
</refsect1></doc>
<field name="dummy1" readable="0" private="1">
<type name="gint32" c:type="gint32"/>
</field>
<field name="dummy2" readable="0" private="1">
<type name="gint32" c:type="gint32"/>
</field>
<field name="dummy3" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="dummy4" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="dummy5" readable="0" private="1">
<type name="gpointer" c:type="gpointer"/>
</field>
<field name="dummy6" readable="0" private="1">
<type name="guint32" c:type="guint32"/>
</field>
<field name="dummy7" readable="0" private="1">
<type name="guint32" c:type="guint32"/>
</field>
<field name="padding" readable="0" private="1">
<array zero-terminated="0" c:type="gpointer" fixed-size="4">
<type name="gpointer" c:type="gpointer"/>
</array>
</field>
<method name="equal" c:identifier="g_base_info_equal">
<doc xml:space="preserve">Compare two #GIBaseInfo.
Using pointer comparison is not practical since many functions return
different instances of #GIBaseInfo that refers to the same part of the
TypeLib; use this function instead to do #GIBaseInfo comparisons.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if and only if @info1 equals @info2.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="info1" transfer-ownership="none">
<doc xml:space="preserve">a #GIBaseInfo</doc>
<type name="BaseInfo" c:type="GIBaseInfo*"/>
</instance-parameter>
<parameter name="info2" transfer-ownership="none">
<doc xml:space="preserve">a #GIBaseInfo</doc>
<type name="BaseInfo" c:type="GIBaseInfo*"/>
</parameter>
</parameters>
</method>
<method name="get_attribute" c:identifier="g_base_info_get_attribute">
<doc xml:space="preserve">Retrieve an arbitrary attribute associated with this node.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The value of the attribute, or %NULL if no such attribute exists</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GIBaseInfo</doc>
<type name="BaseInfo" c:type="GIBaseInfo*"/>
</instance-parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">a freeform string naming an attribute</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_container" c:identifier="g_base_info_get_container">
<doc xml:space="preserve">Obtain the container of the @info. The container is the parent
GIBaseInfo. For instance, the parent of a #GIFunctionInfo is an
#GIObjectInfo or #GIInterfaceInfo.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the container</doc>
<type name="BaseInfo" c:type="GIBaseInfo*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GIBaseInfo</doc>
<type name="BaseInfo" c:type="GIBaseInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_name" c:identifier="g_base_info_get_name">
<doc xml:space="preserve">Obtain the name of the @info. What the name represents depends on
the #GIInfoType of the @info. For instance for #GIFunctionInfo it is
the name of the function.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the name of @info or %NULL if it lacks a name.</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GIBaseInfo</doc>
<type name="BaseInfo" c:type="GIBaseInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_namespace" c:identifier="g_base_info_get_namespace">
<doc xml:space="preserve">Obtain the namespace of @info.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the namespace</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GIBaseInfo</doc>
<type name="BaseInfo" c:type="GIBaseInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_type" c:identifier="g_base_info_get_type">
<doc xml:space="preserve">Obtain the info type of the GIBaseInfo.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the info type of @info</doc>
<type name="InfoType" c:type="GIInfoType"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GIBaseInfo</doc>
<type name="BaseInfo" c:type="GIBaseInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="get_typelib" c:identifier="g_base_info_get_typelib">
<doc xml:space="preserve">Obtain the typelib this @info belongs to</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">the typelib.</doc>
<type name="Typelib" c:type="GITypelib*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GIBaseInfo</doc>
<type name="BaseInfo" c:type="GIBaseInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="is_deprecated" c:identifier="g_base_info_is_deprecated">
<doc xml:space="preserve">Obtain whether the @info is represents a metadata which is
deprecated or not.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if deprecated</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GIBaseInfo</doc>
<type name="BaseInfo" c:type="GIBaseInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="iterate_attributes"
c:identifier="g_base_info_iterate_attributes">
<doc xml:space="preserve">Iterate over all attributes associated with this node. The iterator
structure is typically stack allocated, and must have its first
member initialized to %NULL. Attributes are arbitrary namespaced key–value
pairs which can be attached to almost any item. They are intended for use
by software higher in the toolchain than bindings, and are distinct from
normal GIR annotations.
Both the @name and @value should be treated as constants
and must not be freed.
<example>
<title>Iterating over attributes</title>
<programlisting>
void
print_attributes (GIBaseInfo *info)
{
GIAttributeIter iter = { 0, };
char *name;
char *value;
while (g_base_info_iterate_attributes (info, &iter, &name, &value))
{
g_print ("attribute name: %s value: %s", name, value);
}
}
</programlisting>
</example></doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">%TRUE if there are more attributes</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GIBaseInfo</doc>
<type name="BaseInfo" c:type="GIBaseInfo*"/>
</instance-parameter>
<parameter name="iterator"
direction="inout"
caller-allocates="0"
transfer-ownership="full">
<doc xml:space="preserve">a #GIAttributeIter structure, must be initialized; see below</doc>
<type name="AttributeIter" c:type="GIAttributeIter*"/>
</parameter>
<parameter name="name"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve">Returned name, must not be freed</doc>
<type name="utf8" c:type="char**"/>
</parameter>
<parameter name="value"
direction="out"
caller-allocates="0"
transfer-ownership="none">
<doc xml:space="preserve">Returned name, must not be freed</doc>
<type name="utf8" c:type="char**"/>
</parameter>
</parameters>
</method>
<method name="ref" c:identifier="g_base_info_ref" introspectable="0">
<doc xml:space="preserve">Increases the reference count of @info.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the same @info.</doc>
<type name="BaseInfo" c:type="GIBaseInfo*"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GIBaseInfo</doc>
<type name="BaseInfo" c:type="GIBaseInfo*"/>
</instance-parameter>
</parameters>
</method>
<method name="unref" c:identifier="g_base_info_unref" introspectable="0">
<doc xml:space="preserve">Decreases the reference count of @info. When its reference count
drops to 0, the info is freed.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<instance-parameter name="info" transfer-ownership="none">
<doc xml:space="preserve">a #GIBaseInfo</doc>
<type name="BaseInfo" c:type="GIBaseInfo*"/>
</instance-parameter>
</parameters>
</method>
</record>
<enumeration name="Direction" c:type="GIDirection">
<doc xml:space="preserve">The direction of a #GIArgInfo.</doc>
<member name="in" value="0" c:identifier="GI_DIRECTION_IN">
<doc xml:space="preserve">in argument.</doc>
</member>
<member name="out" value="1" c:identifier="GI_DIRECTION_OUT">
<doc xml:space="preserve">out argument.</doc>
</member>
<member name="inout" value="2" c:identifier="GI_DIRECTION_INOUT">
<doc xml:space="preserve">in and out argument.</doc>
</member>
</enumeration>
<bitfield name="FieldInfoFlags" c:type="GIFieldInfoFlags">
<doc xml:space="preserve">Flags for a #GIFieldInfo.</doc>
<member name="readable" value="1" c:identifier="GI_FIELD_IS_READABLE">
<doc xml:space="preserve">field is readable.</doc>
</member>
<member name="writable" value="2" c:identifier="GI_FIELD_IS_WRITABLE">
<doc xml:space="preserve">field is writable.</doc>
</member>
</bitfield>
<bitfield name="FunctionInfoFlags" c:type="GIFunctionInfoFlags">
<doc xml:space="preserve">Flags for a #GIFunctionInfo struct.</doc>
<member name="is_method" value="1" c:identifier="GI_FUNCTION_IS_METHOD">
<doc xml:space="preserve">is a method.</doc>
</member>
<member name="is_constructor"
value="2"
c:identifier="GI_FUNCTION_IS_CONSTRUCTOR">
<doc xml:space="preserve">is a constructor.</doc>
</member>
<member name="is_getter" value="4" c:identifier="GI_FUNCTION_IS_GETTER">
<doc xml:space="preserve">is a getter of a #GIPropertyInfo.</doc>
</member>
<member name="is_setter" value="8" c:identifier="GI_FUNCTION_IS_SETTER">
<doc xml:space="preserve">is a setter of a #GIPropertyInfo.</doc>
</member>
<member name="wraps_vfunc"
value="16"
c:identifier="GI_FUNCTION_WRAPS_VFUNC">
<doc xml:space="preserve">represents a virtual function.</doc>
</member>
<member name="throws" value="32" c:identifier="GI_FUNCTION_THROWS">
<doc xml:space="preserve">the function may throw an error.</doc>
</member>
</bitfield>
<enumeration name="InfoType" c:type="GIInfoType">
<doc xml:space="preserve">The type of a GIBaseInfo struct.</doc>
<member name="invalid" value="0" c:identifier="GI_INFO_TYPE_INVALID">
<doc xml:space="preserve">invalid type</doc>
</member>
<member name="function" value="1" c:identifier="GI_INFO_TYPE_FUNCTION">
<doc xml:space="preserve">function, see #GIFunctionInfo</doc>
</member>
<member name="callback" value="2" c:identifier="GI_INFO_TYPE_CALLBACK">
<doc xml:space="preserve">callback, see #GIFunctionInfo</doc>
</member>
<member name="struct" value="3" c:identifier="GI_INFO_TYPE_STRUCT">
<doc xml:space="preserve">struct, see #GIStructInfo</doc>
</member>
<member name="boxed" value="4" c:identifier="GI_INFO_TYPE_BOXED">
<doc xml:space="preserve">boxed, see #GIStructInfo or #GIUnionInfo</doc>
</member>
<member name="enum" value="5" c:identifier="GI_INFO_TYPE_ENUM">
<doc xml:space="preserve">enum, see #GIEnumInfo</doc>
</member>
<member name="flags" value="6" c:identifier="GI_INFO_TYPE_FLAGS">
<doc xml:space="preserve">flags, see #GIEnumInfo</doc>
</member>
<member name="object" value="7" c:identifier="GI_INFO_TYPE_OBJECT">
<doc xml:space="preserve">object, see #GIObjectInfo</doc>
</member>
<member name="interface" value="8" c:identifier="GI_INFO_TYPE_INTERFACE">
<doc xml:space="preserve">interface, see #GIInterfaceInfo</doc>
</member>
<member name="constant" value="9" c:identifier="GI_INFO_TYPE_CONSTANT">
<doc xml:space="preserve">contant, see #GIConstantInfo</doc>
</member>
<member name="invalid_0"
value="10"
c:identifier="GI_INFO_TYPE_INVALID_0">
<doc xml:space="preserve">deleted, used to be GI_INFO_TYPE_ERROR_DOMAIN.</doc>
</member>
<member name="union" value="11" c:identifier="GI_INFO_TYPE_UNION">
<doc xml:space="preserve">union, see #GIUnionInfo</doc>
</member>
<member name="value" value="12" c:identifier="GI_INFO_TYPE_VALUE">
<doc xml:space="preserve">enum value, see #GIValueInfo</doc>
</member>
<member name="signal" value="13" c:identifier="GI_INFO_TYPE_SIGNAL">
<doc xml:space="preserve">signal, see #GISignalInfo</doc>
</member>
<member name="vfunc" value="14" c:identifier="GI_INFO_TYPE_VFUNC">
<doc xml:space="preserve">virtual function, see #GIVFuncInfo</doc>
</member>
<member name="property" value="15" c:identifier="GI_INFO_TYPE_PROPERTY">
<doc xml:space="preserve">GObject property, see #GIPropertyInfo</doc>
</member>
<member name="field" value="16" c:identifier="GI_INFO_TYPE_FIELD">
<doc xml:space="preserve">struct or union field, see #GIFieldInfo</doc>
</member>
<member name="arg" value="17" c:identifier="GI_INFO_TYPE_ARG">
<doc xml:space="preserve">argument of a function or callback, see #GIArgInfo</doc>
</member>
<member name="type" value="18" c:identifier="GI_INFO_TYPE_TYPE">
<doc xml:space="preserve">type information, see #GITypeInfo</doc>
</member>
<member name="unresolved"
value="19"
c:identifier="GI_INFO_TYPE_UNRESOLVED">
<doc xml:space="preserve">unresolved type, a type which is not present in
the typelib, or any of its dependencies.</doc>
</member>
</enumeration>
<callback name="ObjectInfoGetValueFunction"
c:type="GIObjectInfoGetValueFunction"
introspectable="0">
<doc xml:space="preserve">Extract an object instance out of @value</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the object instance</doc>
<type name="gpointer" c:type="void*"/>
</return-value>
<parameters>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">a #GValue</doc>
<type name="GObject.Value" c:type="const GValue*"/>
</parameter>
</parameters>
</callback>
<callback name="ObjectInfoRefFunction"
c:type="GIObjectInfoRefFunction"
introspectable="0">
<doc xml:space="preserve">Increases the reference count of an object instance.</doc>
<return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve">the object instance</doc>
<type name="gpointer" c:type="void*"/>
</return-value>
<parameters>
<parameter name="object"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">object instance pointer</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</callback>
<callback name="ObjectInfoSetValueFunction"
c:type="GIObjectInfoSetValueFunction"
introspectable="0">
<doc xml:space="preserve">Update @value and attach the object instance pointer @object to it.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="value" transfer-ownership="none">
<doc xml:space="preserve">a #GValue</doc>
<type name="GObject.Value" c:type="GValue*"/>
</parameter>
<parameter name="object"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">object instance pointer</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</callback>
<callback name="ObjectInfoUnrefFunction"
c:type="GIObjectInfoUnrefFunction"
introspectable="0">
<doc xml:space="preserve">Decreases the reference count of an object instance.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="object"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">object instance pointer</doc>
<type name="gpointer" c:type="void*"/>
</parameter>
</parameters>
</callback>
<class name="Repository"
c:symbol-prefix="irepository"
c:type="GIRepository"
parent="GObject.Object"
glib:type-name="GIRepository"
glib:get-type="g_irepository_get_type"
glib:type-struct="RepositoryClass">
<doc xml:space="preserve">#GIRepository is used to manage repositories of namespaces. Namespaces
are represented on disk by type libraries (.typelib files).
### Discovery of type libraries
#GIRepository will typically look for a `girepository-1.0` directory
under the library directory used when compiling gobject-introspection.
It is possible to control the search paths programmatically, using
g_irepository_prepend_search_path(). It is also possible to modify
the search paths by using the `GI_TYPELIB_PATH` environment variable.
The environment variable takes precedence over the default search path
and the g_irepository_prepend_search_path() calls.</doc>
<function name="dump" c:identifier="g_irepository_dump" throws="1">
<return-value transfer-ownership="none">
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="arg" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="error_quark" c:identifier="g_irepository_error_quark">
<return-value transfer-ownership="none">
<type name="GLib.Quark" c:type="GQuark"/>
</return-value>
</function>
<function name="get_default" c:identifier="g_irepository_get_default">
<doc xml:space="preserve">Returns the singleton process-global default #GIRepository. It is
not currently supported to have multiple repositories in a
particular process, but this function is provided in the unlikely
eventuality that it would become possible, and as a convenience for
higher level language bindings to conform to the GObject method
call conventions.
All methods on #GIRepository also accept %NULL as an instance
parameter to mean this default repository, which is usually more
convenient for C.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">The global singleton #GIRepository</doc>
<type name="Repository" c:type="GIRepository*"/>
</return-value>
</function>
<function name="get_option_group"
c:identifier="g_irepository_get_option_group">
<doc xml:space="preserve">Obtain the option group for girepository, it's used
by the dumper and for programs that wants to provide
introspection information</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the option group</doc>
<type name="GLib.OptionGroup" c:type="GOptionGroup*"/>
</return-value>
</function>
<function name="get_search_path"
c:identifier="g_irepository_get_search_path">
<doc xml:space="preserve">Returns the current search path #GIRepository will use when loading
typelib files. The list is internal to #GIRespository and should not
be freed, nor should its string elements.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">#GSList of strings</doc>
<type name="GLib.SList" c:type="GSList*">
<type name="filename"/>
</type>
</return-value>
</function>
<function name="prepend_library_path"
c:identifier="g_irepository_prepend_library_path">
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="directory" transfer-ownership="none">
<type name="utf8" c:type="const char*"/>
</parameter>
</parameters>
</function>
<function name="prepend_search_path"
c:identifier="g_irepository_prepend_search_path">
<doc xml:space="preserve">Prepends @directory to the typelib search path.
See also: g_irepository_get_search_path().</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="directory" transfer-ownership="none">
<doc xml:space="preserve">directory name to prepend to the typelib
search path</doc>
<type name="filename" c:type="const char*"/>
</parameter>
</parameters>
</function>
<method name="enumerate_versions"
c:identifier="g_irepository_enumerate_versions">
<doc xml:space="preserve">Obtain an unordered list of versions (either currently loaded or
available) for @namespace_ in this @repository.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">the array of versions.</doc>
<type name="GLib.List" c:type="GList*">
<type name="utf8"/>
</type>
</return-value>
<parameters>
<instance-parameter name="repository"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A #GIRepository or %NULL for the singleton
process-global default #GIRepository</doc>
<type name="Repository" c:type="GIRepository*"/>
</instance-parameter>
<parameter name="namespace_" transfer-ownership="none">
<doc xml:space="preserve">GI namespace, e.g. "Gtk"</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="find_by_error_domain"
c:identifier="g_irepository_find_by_error_domain"
version="1.29.17">
<doc xml:space="preserve">Searches for the enum type corresponding to the given #GError
domain. Before calling this function for a particular namespace,
you must call g_irepository_require() once to load the namespace, or
otherwise ensure the namespace has already been loaded.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">#GIEnumInfo representing metadata about @domain's
enum type, or %NULL</doc>
<type name="EnumInfo" c:type="GIEnumInfo*"/>
</return-value>
<parameters>
<instance-parameter name="repository"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A #GIRepository or %NULL for the singleton
process-global default #GIRepository</doc>
<type name="Repository" c:type="GIRepository*"/>
</instance-parameter>
<parameter name="domain" transfer-ownership="none">
<doc xml:space="preserve">a #GError domain</doc>
<type name="GLib.Quark" c:type="GQuark"/>
</parameter>
</parameters>
</method>
<method name="find_by_gtype" c:identifier="g_irepository_find_by_gtype">
<doc xml:space="preserve">Searches all loaded namespaces for a particular #GType. Note that
in order to locate the metadata, the namespace corresponding to
the type must first have been loaded. There is currently no
mechanism for determining the namespace which corresponds to an
arbitrary GType - thus, this function will operate most reliably
when you know the GType to originate from be from a loaded namespace.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">#GIBaseInfo representing metadata about @type, or %NULL</doc>
<type name="BaseInfo" c:type="GIBaseInfo*"/>
</return-value>
<parameters>
<instance-parameter name="repository"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A #GIRepository or %NULL for the singleton
process-global default #GIRepository</doc>
<type name="Repository" c:type="GIRepository*"/>
</instance-parameter>
<parameter name="gtype" transfer-ownership="none">
<doc xml:space="preserve">GType to search for</doc>
<type name="GType" c:type="GType"/>
</parameter>
</parameters>
</method>
<method name="find_by_name" c:identifier="g_irepository_find_by_name">
<doc xml:space="preserve">Searches for a particular entry in a namespace. Before calling
this function for a particular namespace, you must call
g_irepository_require() once to load the namespace, or otherwise
ensure the namespace has already been loaded.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">#GIBaseInfo representing metadata about @name, or %NULL</doc>
<type name="BaseInfo" c:type="GIBaseInfo*"/>
</return-value>
<parameters>
<instance-parameter name="repository"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A #GIRepository or %NULL for the singleton
process-global default #GIRepository</doc>
<type name="Repository" c:type="GIRepository*"/>
</instance-parameter>
<parameter name="namespace_" transfer-ownership="none">
<doc xml:space="preserve">Namespace which will be searched</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="name" transfer-ownership="none">
<doc xml:space="preserve">Entry name to find</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_c_prefix" c:identifier="g_irepository_get_c_prefix">
<doc xml:space="preserve">This function returns the "C prefix", or the C level namespace
associated with the given introspection namespace. Each C symbol
starts with this prefix, as well each #GType in the library.
Note: The namespace must have already been loaded using a function
such as g_irepository_require() before calling this function.</doc>
<return-value transfer-ownership="none">
<doc xml:space="preserve">C namespace prefix, or %NULL if none associated</doc>
<type name="utf8" c:type="const gchar*"/>
</return-value>
<parameters>
<instance-parameter name="repository"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A #GIRepository or %NULL for the singleton
process-global default #GIRepository</doc>
<type name="Repository" c:type="GIRepository*"/>
</instance-parameter>
<parameter name="namespace_" transfer-ownership="none">
<doc xml:space="preserve">Namespace to inspect</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_dependencies"
c:identifier="g_irepository_get_dependencies">
<doc xml:space="preserve">Return an array of all (transitive) versioned dependencies for
@namespace_. Returned strings are of the form
<code>namespace-version</code>.
Note: @namespace_ must have already been loaded using a function
such as g_irepository_require() before calling this function.
To get only the immediate dependencies for @namespace_, use
g_irepository_get_immediate_dependencies().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">Zero-terminated string array of all versioned
dependencies</doc>
<array c:type="gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="repository"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A #GIRepository or %NULL for the singleton
process-global default #GIRepository</doc>
<type name="Repository" c:type="GIRepository*"/>
</instance-parameter>
<parameter name="namespace_" transfer-ownership="none">
<doc xml:space="preserve">Namespace of interest</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_immediate_dependencies"
c:identifier="g_irepository_get_immediate_dependencies"
version="1.44">
<doc xml:space="preserve">Return an array of the immediate versioned dependencies for @namespace_.
Returned strings are of the form <code>namespace-version</code>.
Note: @namespace_ must have already been loaded using a function
such as g_irepository_require() before calling this function.
To get the transitive closure of dependencies for @namespace_, use
g_irepository_get_dependencies().</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">Zero-terminated string array of immediate versioned
dependencies</doc>
<array c:type="gchar**">
<type name="utf8"/>
</array>
</return-value>
<parameters>
<instance-parameter name="repository"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A #GIRepository or %NULL for the singleton
process-global default #GIRepository</doc>
<type name="Repository" c:type="GIRepository*"/>
</instance-parameter>
<parameter name="namespace_" transfer-ownership="none">
<doc xml:space="preserve">Namespace of interest</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
</parameters>
</method>
<method name="get_info" c:identifier="g_irepository_get_info">
<doc xml:space="preserve">This function returns a particular metadata entry in the
given namespace @namespace_. The namespace must have
already been loaded before calling this function.
See g_irepository_get_n_infos() to find the maximum number of
entries.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">#GIBaseInfo containing metadata</doc>
<type name="BaseInfo" c:type="GIBaseInfo*"/>
</return-value>
<parameters>
<instance-parameter name="repository"
transfer-ownership="none"
nullable="1"
allow-none="1">
<doc xml:space="preserve">A #GIRepository or %NULL for the singleton
process-global default #GIRepository</doc>
<type name="Repository" c:type="GIRepository*"/>
</instance-parameter>
<parameter name="namespace_" transfer-ownership="none">
<doc xml:space="preserve">Namespace to inspect</doc>
<type name="utf8" c:type="const gchar*"/>
</parameter>
<parameter name="index" transfer-ownership="none">
<doc xml:space="preserve">0-based offset into namespace metadata for entry</doc>
<type name="gint" c:type="gint"/>
</parameter>
</parameters>
</method>
<method name="get_loaded_namespaces"
c:identifier="g_irepository_get_loaded_namespaces">
<doc xml:space="preserve">Return the list of currently loaded namespaces.</doc>
<return-value transfer-ownership="full">
<doc xml:space="preserve">List of namespaces</doc>