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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
|
# -*- Mode: Python -*-
# GObject-Introspection - a framework for introspecting GObject libraries
# Copyright (C) 2008 Johan Dahlin
# Copyright (C) 2008, 2009 Red Hat, Inc.
#
# 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 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., 59 Temple Place - Suite 330,
# Boston, MA 02111-1307, USA.
#
import copy
import operator
from itertools import chain
from collections import OrderedDict
from . import message
from .sourcescanner import CTYPE_TYPEDEF, CSYMBOL_TYPE_TYPEDEF
from .message import Position
from .utils import to_underscores
class Type(object):
"""
A Type can be either:
* A reference to a node (target_giname)
* A reference to a "fundamental" type like 'utf8'
* A "foreign" type - this can be any string."
If none are specified, then it's in an "unresolved" state. An
unresolved type can have two data sources; a "ctype" which comes
from a C type string, or a gtype_name (from g_type_name()).
"""
def __init__(self,
ctype=None,
gtype_name=None,
target_fundamental=None,
target_giname=None,
target_foreign=None,
_target_unknown=False,
is_const=False,
origin_symbol=None,
complete_ctype=None):
self.ctype = ctype
self.gtype_name = gtype_name
self.origin_symbol = origin_symbol
if _target_unknown:
assert isinstance(self, TypeUnknown)
elif target_fundamental:
assert target_giname is None
assert target_foreign is None
elif target_giname:
assert '.' in target_giname
assert target_fundamental is None
assert target_foreign is None
elif target_foreign:
assert ctype is not None
assert target_giname is None
assert target_fundamental is None
else:
assert (ctype is not None) or (gtype_name is not None)
self.target_fundamental = target_fundamental
self.target_giname = target_giname
self.target_foreign = target_foreign
self.is_const = is_const
self.complete_ctype = complete_ctype
@property
def resolved(self):
return (self.target_fundamental or
self.target_giname or
self.target_foreign)
@property
def unresolved_string(self):
if self.ctype:
return self.ctype
elif self.gtype_name:
return self.gtype_name
elif self.target_giname:
return self.target_giname
else:
assert False
@classmethod
def create_from_gtype_name(cls, gtype_name):
"""Parse a GType name (as from g_type_name()), and return a
Type instance. Note that this function performs namespace lookup,
in contrast to the other create_type() functions."""
# First, is it a fundamental?
fundamental = type_names.get(gtype_name)
if fundamental is not None:
return cls(target_fundamental=fundamental.target_fundamental,
ctype=fundamental.ctype)
if gtype_name == 'GHashTable':
return Map(TYPE_ANY, TYPE_ANY, gtype_name=gtype_name)
elif gtype_name == 'GByteArray':
return Array('GLib.ByteArray', TYPE_UINT8, gtype_name=gtype_name)
elif gtype_name in ('GArray', 'GPtrArray'):
return Array('GLib.' + gtype_name[1:], TYPE_ANY,
gtype_name=gtype_name)
elif gtype_name == 'GStrv':
bare_utf8 = TYPE_STRING.clone()
bare_utf8.ctype = None
return Array(None, bare_utf8, ctype=None, gtype_name=gtype_name,
is_const=False)
return cls(gtype_name=gtype_name)
def get_giname(self):
assert self.target_giname is not None
return self.target_giname.split('.')[1]
def _compare(self, other, op):
if self.target_fundamental:
return op(self.target_fundamental, other.target_fundamental)
elif self.target_giname:
return op(self.target_giname, other.target_giname)
elif self.target_foreign:
return op(self.target_foreign, other.target_foreign)
else:
return op(self.ctype, other.ctype)
def __lt__(self, other):
return self._compare(other, operator.lt)
def __gt__(self, other):
return self._compare(other, operator.gt)
def __ge__(self, other):
return self._compare(other, operator.ge)
def __le__(self, other):
return self._compare(other, operator.le)
def __eq__(self, other):
return self._compare(other, operator.eq)
def __ne__(self, other):
return self._compare(other, operator.ne)
def __hash__(self):
return hash((self.target_fundamental, self.target_giname,
self.target_foreign, self.ctype))
def is_equiv(self, typeval):
"""Return True if the specified types are compatible at
an introspection level, disregarding their C types.
A sequence may be given for typeval, in which case
this function returns True if the type is compatible with
any."""
if isinstance(typeval, (list, tuple)):
for val in typeval:
if self.is_equiv(val):
return True
return False
return self == typeval
def clone(self):
return Type(target_fundamental=self.target_fundamental,
target_giname=self.target_giname,
target_foreign=self.target_foreign,
ctype=self.ctype,
is_const=self.is_const)
def __str__(self):
if self.target_fundamental:
return self.target_fundamental
elif self.target_giname:
return self.target_giname
elif self.target_foreign:
return self.target_foreign
def __repr__(self):
if self.target_fundamental:
data = 'target_fundamental=%s, ' % (self.target_fundamental, )
elif self.target_giname:
data = 'target_giname=%s, ' % (self.target_giname, )
elif self.target_foreign:
data = 'target_foreign=%s, ' % (self.target_foreign, )
else:
data = ''
return '%s(%sctype=%s)' % (self.__class__.__name__, data, self.ctype)
class TypeUnknown(Type):
def __init__(self):
Type.__init__(self, _target_unknown=True)
# Fundamental types, two special ones
TYPE_NONE = Type(target_fundamental='none', ctype='void')
TYPE_ANY = Type(target_fundamental='gpointer', ctype='gpointer')
# Fundamental types, "Basic" types
TYPE_BOOLEAN = Type(target_fundamental='gboolean', ctype='gboolean')
TYPE_INT8 = Type(target_fundamental='gint8', ctype='gint8')
TYPE_UINT8 = Type(target_fundamental='guint8', ctype='guint8')
TYPE_INT16 = Type(target_fundamental='gint16', ctype='gint16')
TYPE_UINT16 = Type(target_fundamental='guint16', ctype='guint16')
TYPE_INT32 = Type(target_fundamental='gint32', ctype='gint32')
TYPE_UINT32 = Type(target_fundamental='guint32', ctype='guint32')
TYPE_INT64 = Type(target_fundamental='gint64', ctype='gint64')
TYPE_UINT64 = Type(target_fundamental='guint64', ctype='guint64')
TYPE_CHAR = Type(target_fundamental='gchar', ctype='gchar')
TYPE_SHORT = Type(target_fundamental='gshort', ctype='gshort')
TYPE_USHORT = Type(target_fundamental='gushort', ctype='gushort')
TYPE_INT = Type(target_fundamental='gint', ctype='gint')
TYPE_UINT = Type(target_fundamental='guint', ctype='guint')
TYPE_LONG = Type(target_fundamental='glong', ctype='glong')
TYPE_ULONG = Type(target_fundamental='gulong', ctype='gulong')
TYPE_SIZE = Type(target_fundamental='gsize', ctype='gsize')
TYPE_SSIZE = Type(target_fundamental='gssize', ctype='gssize')
TYPE_INTPTR = Type(target_fundamental='gintptr', ctype='gintptr')
TYPE_UINTPTR = Type(target_fundamental='guintptr', ctype='guintptr')
# C99 types
TYPE_LONG_LONG = Type(target_fundamental='long long', ctype='long long')
TYPE_LONG_ULONG = Type(target_fundamental='unsigned long long',
ctype='unsigned long long')
TYPE_FLOAT = Type(target_fundamental='gfloat', ctype='gfloat')
TYPE_DOUBLE = Type(target_fundamental='gdouble', ctype='gdouble')
# ?
TYPE_LONG_DOUBLE = Type(target_fundamental='long double',
ctype='long double')
TYPE_UNICHAR = Type(target_fundamental='gunichar', ctype='gunichar')
# C types with semantics overlaid
TYPE_GTYPE = Type(target_fundamental='GType', ctype='GType')
TYPE_STRING = Type(target_fundamental='utf8', ctype='gchar*')
TYPE_FILENAME = Type(target_fundamental='filename', ctype='gchar*')
TYPE_VALIST = Type(target_fundamental='va_list', ctype='va_list')
BASIC_TYPES = [TYPE_BOOLEAN, TYPE_INT8, TYPE_UINT8, TYPE_INT16,
TYPE_UINT16, TYPE_INT32, TYPE_UINT32, TYPE_INT64,
TYPE_UINT64, TYPE_CHAR, TYPE_SHORT, TYPE_USHORT, TYPE_INT,
TYPE_UINT, TYPE_LONG, TYPE_ULONG, TYPE_SIZE, TYPE_SSIZE,
TYPE_LONG_LONG, TYPE_LONG_ULONG,
TYPE_FLOAT, TYPE_DOUBLE,
TYPE_LONG_DOUBLE, TYPE_UNICHAR, TYPE_GTYPE]
BASIC_GIR_TYPES = [TYPE_INTPTR, TYPE_UINTPTR]
BASIC_GIR_TYPES.extend(BASIC_TYPES)
GIR_TYPES = [TYPE_NONE, TYPE_ANY]
GIR_TYPES.extend(BASIC_GIR_TYPES)
GIR_TYPES.extend([TYPE_STRING, TYPE_FILENAME, TYPE_VALIST])
# These are the only basic types that are guaranteed to
# be as big as a pointer (and thus are allowed in GPtrArray)
POINTER_TYPES = [TYPE_ANY, TYPE_INTPTR, TYPE_UINTPTR]
INTROSPECTABLE_BASIC = list(GIR_TYPES)
for v in [TYPE_NONE, TYPE_ANY,
TYPE_LONG_LONG, TYPE_LONG_ULONG,
TYPE_LONG_DOUBLE, TYPE_VALIST]:
INTROSPECTABLE_BASIC.remove(v)
type_names = {}
for typeval in GIR_TYPES:
type_names[typeval.target_fundamental] = typeval
basic_type_names = {}
for typeval in BASIC_GIR_TYPES:
basic_type_names[typeval.target_fundamental] = typeval
# C builtin
type_names['char'] = TYPE_CHAR
type_names['signed char'] = TYPE_INT8
type_names['unsigned char'] = TYPE_UINT8
type_names['short'] = TYPE_SHORT
type_names['signed short'] = TYPE_SHORT
type_names['unsigned short'] = TYPE_USHORT
type_names['int'] = TYPE_INT
type_names['signed int'] = TYPE_INT
type_names['unsigned short int'] = TYPE_USHORT
type_names['signed'] = TYPE_INT
type_names['unsigned int'] = TYPE_UINT
type_names['unsigned'] = TYPE_UINT
type_names['long'] = TYPE_LONG
type_names['signed long'] = TYPE_LONG
type_names['unsigned long'] = TYPE_ULONG
type_names['unsigned long int'] = TYPE_ULONG
type_names['float'] = TYPE_FLOAT
type_names['double'] = TYPE_DOUBLE
type_names['char*'] = TYPE_STRING
type_names['void*'] = TYPE_ANY
type_names['void'] = TYPE_NONE
# Also alias the signed one here
type_names['signed long long'] = TYPE_LONG_LONG
# C99 stdint exact width types
type_names['int8_t'] = TYPE_INT8
type_names['uint8_t'] = TYPE_UINT8
type_names['int16_t'] = TYPE_INT16
type_names['uint16_t'] = TYPE_UINT16
type_names['int32_t'] = TYPE_INT32
type_names['uint32_t'] = TYPE_UINT32
type_names['int64_t'] = TYPE_INT64
type_names['uint64_t'] = TYPE_UINT64
# A few additional GLib type aliases
type_names['guchar'] = TYPE_UINT8
type_names['gchararray'] = TYPE_STRING
type_names['gchar*'] = TYPE_STRING
type_names['goffset'] = TYPE_INT64
type_names['gunichar2'] = TYPE_UINT16
type_names['gsize'] = TYPE_SIZE
type_names['gssize'] = TYPE_SSIZE
type_names['gintptr'] = TYPE_INTPTR
type_names['guintptr'] = TYPE_UINTPTR
type_names['gconstpointer'] = TYPE_ANY
type_names['grefcount'] = TYPE_INT
type_names['gatomicrefcount'] = TYPE_INT
# We used to support these; continue to do so
type_names['any'] = TYPE_ANY
type_names['boolean'] = TYPE_BOOLEAN
type_names['uint'] = TYPE_UINT
type_names['ulong'] = TYPE_ULONG
# C stdio, used in GLib public headers; squash this for now here
# until we move scanning into GLib and can (skip)
type_names['FILE*'] = TYPE_ANY
# One off C unix type definitions; note some of these may be GNU Libc
# specific. If someone is actually bitten by this, feel free to do
# the required configure goop to determine their size and replace
# here.
#
# We don't want to encourage people to use these in their APIs because
# they compromise the platform-independence that GLib gives you.
# These are here mostly to avoid blowing when random platform-specific
# methods are added under #ifdefs inside GLib itself. We could just (skip)
# the relevant methods, but on the other hand, since these types are just
# integers it's easy enough to expand them.
type_names['size_t'] = type_names['gsize']
type_names['ssize_t'] = type_names['gssize']
type_names['time_t'] = TYPE_LONG
type_names['off_t'] = type_names['gsize']
type_names['pid_t'] = TYPE_INT
type_names['uid_t'] = TYPE_UINT
type_names['gid_t'] = TYPE_UINT
type_names['dev_t'] = TYPE_INT
type_names['socklen_t'] = TYPE_INT32
# Obj-C
type_names['id'] = TYPE_ANY
# Parameters
PARAM_DIRECTION_IN = 'in'
PARAM_DIRECTION_OUT = 'out'
PARAM_DIRECTION_INOUT = 'inout'
PARAM_SCOPE_CALL = 'call'
PARAM_SCOPE_ASYNC = 'async'
PARAM_SCOPE_NOTIFIED = 'notified'
PARAM_TRANSFER_NONE = 'none'
PARAM_TRANSFER_CONTAINER = 'container'
PARAM_TRANSFER_FULL = 'full'
SIGNAL_FIRST = 'first'
SIGNAL_LAST = 'last'
SIGNAL_CLEANUP = 'cleanup'
SIGNAL_MUST_COLLECT = 'must-collect'
class Namespace(object):
def __init__(self, name, version, identifier_prefixes=None, symbol_prefixes=None):
self.name = name
self.version = version
if identifier_prefixes is not None:
self.identifier_prefixes = identifier_prefixes
else:
self.identifier_prefixes = [name]
if symbol_prefixes is not None:
self.symbol_prefixes = symbol_prefixes
else:
ps = self.identifier_prefixes
self.symbol_prefixes = [to_underscores(p).lower() for p in ps]
# cache upper-cased versions
self._ucase_symbol_prefixes = [p.upper() for p in self.symbol_prefixes]
self.names = OrderedDict() # Maps from GIName -> node
self.aliases = {} # Maps from GIName -> GIName
self.type_names = {} # Maps from GTName -> node
self.ctypes = {} # Maps from CType -> node
self.symbols = {} # Maps from function symbols -> Function
# Immediate includes only, not their transitive closure:
self.includes = set() # Include
self.shared_libraries = [] # str
self.c_includes = [] # str
self.exported_packages = [] # str
def type_from_name(self, name, ctype=None):
"""Backwards compatibility method for older .gir files, which
only use the 'name' attribute. If name refers to a fundamental type,
create a Type object referncing it. If name is already a
fully-qualified GIName like 'Foo.Bar', returns a Type targeting it .
Otherwise a Type targeting name qualififed with the namespace name is
returned."""
if name in type_names:
return Type(target_fundamental=name, ctype=ctype)
if '.' in name:
target = name
else:
target = '%s.%s' % (self.name, name)
return Type(target_giname=target, ctype=ctype)
def track(self, node):
"""Doesn't directly append the function to our own namespace,
but adds it to things like ctypes, symbols, and type_names.
"""
assert isinstance(node, Node)
if node.namespace is self:
return
assert node.namespace is None
node.namespace = self
if isinstance(node, Alias):
self.aliases[node.name] = node
elif isinstance(node, Registered) and node.gtype_name is not None:
self.type_names[node.gtype_name] = node
elif isinstance(node, Function):
self.symbols[node.symbol] = node
if isinstance(node, (Compound, Class, Interface, Boxed)):
for fn in chain(node.methods, node.static_methods, node.constructors):
if not isinstance(fn, Function):
continue
fn.namespace = self
self.symbols[fn.symbol] = fn
if isinstance(node, (Compound, Class, Interface)):
for f in node.fields:
f.namespace = self
if isinstance(node, (Class, Interface)):
for m in chain(node.signals, node.properties):
m.namespace = self
if isinstance(node, (Enum, Bitfield)):
for fn in node.static_methods:
if not isinstance(fn, Function):
continue
fn.namespace = self
self.symbols[fn.symbol] = fn
for member in node.members:
member.namespace = self
self.symbols[member.symbol] = member
if hasattr(node, 'ctype'):
self.ctypes[node.ctype] = node
def append(self, node, replace=False):
previous = self.names.get(node.name)
if previous is not None:
if not replace:
raise ValueError("Namespace conflict: %r" % (node, ))
self.remove(previous)
self.track(node)
self.names[node.name] = node
def remove(self, node):
if isinstance(node, Alias):
del self.aliases[node.name]
elif isinstance(node, Registered) and node.gtype_name is not None:
del self.type_names[node.gtype_name]
if hasattr(node, 'ctype'):
del self.ctypes[node.ctype]
if isinstance(node, Function):
del self.symbols[node.symbol]
node.namespace = None
self.names.pop(node.name, None)
def float(self, node):
"""Like remove(), but doesn't unset the node's namespace
back-reference, and it's still possible to look up
functions via get_by_symbol()."""
if isinstance(node, Function):
symbol = node.symbol
self.remove(node)
self.symbols[symbol] = node
node.namespace = self
def __iter__(self):
return iter(self.names)
def items(self):
return self.names.items()
def values(self):
return self.names.values()
def get(self, name):
return self.names.get(name)
def get_by_ctype(self, ctype):
return self.ctypes.get(ctype)
def get_by_symbol(self, symbol):
return self.symbols.get(symbol)
def walk(self, callback):
for node in self.values():
node.walk(callback, [])
class Include(object):
def __init__(self, name, version):
self.name = name
self.version = version
@classmethod
def from_string(cls, string):
return cls(*string.split('-', 1))
def _compare(self, other, op):
return op((self.name, self.version), (other.name, other.version))
def __lt__(self, other):
return self._compare(other, operator.lt)
def __gt__(self, other):
return self._compare(other, operator.gt)
def __ge__(self, other):
return self._compare(other, operator.ge)
def __le__(self, other):
return self._compare(other, operator.le)
def __eq__(self, other):
return self._compare(other, operator.eq)
def __ne__(self, other):
return self._compare(other, operator.ne)
def __hash__(self):
return hash(str(self))
def __str__(self):
return '%s-%s' % (self.name, self.version)
class Annotated(object):
"""An object which has a few generic metadata
properties."""
def __init__(self):
self.version = None
self.version_doc = None
self.skip = False
self.introspectable = True
self.attributes = OrderedDict()
self.stability = None
self.stability_doc = None
self.deprecated = None
self.deprecated_doc = None
self.doc = None
self.doc_position = None
class Node(Annotated):
"""A node is a type of object which is uniquely identified by its
(namespace, name) pair. When combined with a ., this is called a
GIName. It's possible for nodes to contain or point to other nodes."""
c_name = property(lambda self: self.namespace.name + self.name if self.namespace else
self.name)
gi_name = property(lambda self: '%s.%s' % (self.namespace.name, self.name))
def __init__(self, name=None):
Annotated.__init__(self)
self.namespace = None # Should be set later by Namespace.append()
self.name = name
self.foreign = False
self.file_positions = set()
self._parent = None
def _get_parent(self):
if self._parent is not None:
return self._parent
else:
return self.namespace
def _set_parent(self, value):
self._parent = value
parent = property(_get_parent, _set_parent)
def create_type(self):
"""Create a Type object referencing this node."""
assert self.namespace is not None
return Type(target_giname=('%s.%s' % (self.namespace.name, self.name)))
def _compare(self, other, op):
return op((self.namespace, self.name), (other.namespace, other.name))
def __lt__(self, other):
return self._compare(other, operator.lt)
def __gt__(self, other):
return self._compare(other, operator.gt)
def __ge__(self, other):
return self._compare(other, operator.ge)
def __le__(self, other):
return self._compare(other, operator.le)
def __eq__(self, other):
return self._compare(other, operator.eq)
def __ne__(self, other):
return self._compare(other, operator.ne)
def __hash__(self):
return hash((self.namespace, self.name))
def __repr__(self):
return "%s('%s')" % (self.__class__.__name__, self.name)
def inherit_file_positions(self, node):
self.file_positions.update(node.file_positions)
def add_file_position(self, position):
self.file_positions.add(position)
def get_main_position(self):
if not self.file_positions:
return None
res = None
for position in self.file_positions:
if position.is_typedef:
res = position
else:
return position
return res
def add_symbol_reference(self, symbol):
if symbol.source_filename:
self.add_file_position(Position(symbol.source_filename, symbol.line,
is_typedef=symbol.type in (CTYPE_TYPEDEF, CSYMBOL_TYPE_TYPEDEF)))
def walk(self, callback, chain):
res = callback(self, chain)
assert res in (True, False), "Walk function must return boolean, not %r" % (res, )
if not res:
return False
chain.append(self)
self._walk(callback, chain)
chain.pop()
def _walk(self, callback, chain):
pass
class DocSection(Node):
def __init__(self, name=None):
Node.__init__(self, name)
class Registered:
"""A node that (possibly) has gtype_name and get_type."""
def __init__(self, gtype_name, get_type):
assert (gtype_name is None and get_type is None) or \
(gtype_name is not None and get_type is not None)
self.gtype_name = gtype_name
self.get_type = get_type
class Callable(Node):
def __init__(self, name, retval, parameters, throws):
Node.__init__(self, name)
self.retval = retval
self.parameters = parameters
self.throws = not not throws
self.instance_parameter = None # Parameter
self.parent = None # A Class or Interface
def _get_retval(self):
return self._retval
def _set_retval(self, value):
self._retval = value
if self._retval is not None:
self._retval.parent = self
retval = property(_get_retval, _set_retval)
def _get_instance_parameter(self):
return self._instance_parameter
def _set_instance_parameter(self, value):
self._instance_parameter = value
if value is not None:
value.parent = self
instance_parameter = property(_get_instance_parameter,
_set_instance_parameter)
def _get_parameters(self):
return self._parameters
def _set_parameters(self, value):
self._parameters = value
for param in self._parameters:
param.parent = self
parameters = property(_get_parameters, _set_parameters)
# Returns all parameters, including the instance parameter
@property
def all_parameters(self):
if self.instance_parameter is not None:
return [self.instance_parameter] + self.parameters
else:
return self.parameters
def get_parameter_index(self, name):
for i, parameter in enumerate(self.parameters):
if parameter.argname == name:
return i
raise ValueError("Unknown argument %s" % (name, ))
def get_parameter(self, name):
for parameter in self.all_parameters:
if parameter.argname == name:
return parameter
raise ValueError("Unknown argument %s" % (name, ))
class FunctionMacro(Node):
def __init__(self, name, parameters, symbol):
Node.__init__(self, name)
self.symbol = symbol
self.parameters = parameters
self.introspectable = False
class Function(Callable):
def __init__(self, name, retval, parameters, throws, symbol):
Callable.__init__(self, name, retval, parameters, throws)
self.symbol = symbol
self.is_method = False
self.is_constructor = False
self.shadowed_by = None # C symbol string
self.shadows = None # C symbol string
self.moved_to = None # namespaced function name string
self.internal_skipped = False # if True, this func will not be written to GIR
def clone(self):
clone = copy.copy(self)
# copy the parameters array so a change to self.parameters does not
# influence clone.parameters.
clone.parameters = self.parameters[:]
for param in clone.parameters:
param.parent = clone
return clone
def is_type_meta_function(self):
# Named correctly
if not (self.name.endswith('_get_type') or self.name.endswith('_get_gtype')):
return False
# Doesn't have any parameters
if self.parameters:
return False
# Returns GType
rettype = self.retval.type
if (not rettype.is_equiv(TYPE_GTYPE) and rettype.target_giname != 'Gtk.Type'):
message.warn("function '%s' returns '%r', not a GType" % (self.name, rettype))
return False
return True
class ErrorQuarkFunction(Function):
def __init__(self, name, retval, parameters, throws, symbol, error_domain):
Function.__init__(self, name, retval, parameters, throws, symbol)
self.error_domain = error_domain
class VFunction(Callable):
def __init__(self, name, retval, parameters, throws):
Callable.__init__(self, name, retval, parameters, throws)
self.invoker = None
@classmethod
def from_callback(cls, name, cb):
obj = cls(name, cb.retval, cb.parameters[1:],
cb.throws)
return obj
class Varargs(Type):
def __init__(self):
Type.__init__(self, '<varargs>', target_fundamental='<varargs>')
class Array(Type):
C = '<c>'
GLIB_ARRAY = 'GLib.Array'
GLIB_BYTEARRAY = 'GLib.ByteArray'
GLIB_PTRARRAY = 'GLib.PtrArray'
def __init__(self, array_type, element_type, **kwargs):
Type.__init__(self, target_fundamental='<array>',
**kwargs)
if (array_type is None or array_type == self.C):
self.array_type = self.C
else:
assert array_type in (self.GLIB_ARRAY,
self.GLIB_BYTEARRAY,
self.GLIB_PTRARRAY), array_type
self.array_type = array_type
assert isinstance(element_type, Type)
self.element_type = element_type
self.zeroterminated = True
self.length_param_name = None
self.size = None
def clone(self):
arr = Array(self.array_type, self.element_type)
arr.zeroterminated = self.zeroterminated
arr.length_param_name = self.length_param_name
arr.size = self.size
return arr
class List(Type):
def __init__(self, name, element_type, **kwargs):
Type.__init__(self, target_fundamental='<list>',
**kwargs)
self.name = name
assert isinstance(element_type, Type)
self.element_type = element_type
def clone(self):
return List(self.name, self.element_type)
class Map(Type):
def __init__(self, key_type, value_type, **kwargs):
Type.__init__(self, target_fundamental='<map>', **kwargs)
assert isinstance(key_type, Type)
self.key_type = key_type
assert isinstance(value_type, Type)
self.value_type = value_type
def clone(self):
return Map(self.key_type, self.value_type)
class Alias(Node):
def __init__(self, name, target, ctype=None):
Node.__init__(self, name)
self.target = target
self.ctype = ctype
class TypeContainer(Annotated):
"""A fundamental base class for Return and Parameter."""
def __init__(self, typenode, nullable, not_nullable, transfer, direction):
Annotated.__init__(self)
self.type = typenode
self.nullable = nullable
self.not_nullable = not_nullable
self.direction = direction
if transfer is not None:
self.transfer = transfer
elif typenode and typenode.is_const:
self.transfer = PARAM_TRANSFER_NONE
else:
self.transfer = None
class Parameter(TypeContainer):
"""An argument to a function."""
def __init__(self, argname, typenode, direction=None,
transfer=None, nullable=False, optional=False,
allow_none=False, scope=None,
caller_allocates=False, not_nullable=False):
TypeContainer.__init__(self, typenode, nullable, not_nullable,
transfer, direction)
self.argname = argname
self.optional = optional
self.parent = None # A Callable
if allow_none:
if self.direction == PARAM_DIRECTION_OUT:
self.optional = True
else:
self.nullable = True
self.scope = scope
self.caller_allocates = caller_allocates
self.closure_name = None
self.destroy_name = None
@property
def name(self):
return self.argname
class Return(TypeContainer):
"""A return value from a function."""
def __init__(self, rtype, nullable=False, not_nullable=False,
transfer=None):
TypeContainer.__init__(self, rtype, nullable, not_nullable, transfer,
direction=PARAM_DIRECTION_OUT)
self.parent = None # A Callable
class Enum(Node, Registered):
def __init__(self, name, ctype,
gtype_name=None,
get_type=None,
c_symbol_prefix=None,
members=None):
Node.__init__(self, name)
Registered.__init__(self, gtype_name, get_type)
self.c_symbol_prefix = c_symbol_prefix
self.ctype = ctype
self.members = members
for member in members:
member.parent = self
# Associated error domain name
self.error_domain = None
self.static_methods = []
def _walk(self, callback, chain):
for meth in self.static_methods:
meth.walk(callback, chain)
class Bitfield(Node, Registered):
def __init__(self, name, ctype,
gtype_name=None,
c_symbol_prefix=None,
get_type=None,
members=None):
Node.__init__(self, name)
Registered.__init__(self, gtype_name, get_type)
self.ctype = ctype
self.c_symbol_prefix = c_symbol_prefix
self.members = members
for member in members:
member.parent = self
self.static_methods = []
def _walk(self, callback, chain):
for meth in self.static_methods:
meth.walk(callback, chain)
class Member(Annotated):
def __init__(self, name, value, symbol, nick):
Annotated.__init__(self)
self.name = name
self.value = value
self.symbol = symbol
self.nick = nick
self.parent = None
def _compare(self, other, op):
return op(self.name, other.name)
def __lt__(self, other):
return self._compare(other, operator.lt)
def __gt__(self, other):
return self._compare(other, operator.gt)
def __ge__(self, other):
return self._compare(other, operator.ge)
def __le__(self, other):
return self._compare(other, operator.le)
def __eq__(self, other):
return self._compare(other, operator.eq)
def __ne__(self, other):
return self._compare(other, operator.ne)
def __hash__(self):
return hash(self.name)
def __repr__(self):
return "%s('%s')" % (self.__class__.__name__, self.name)
class Compound(Node, Registered):
def __init__(self, name,
ctype=None,
gtype_name=None,
get_type=None,
c_symbol_prefix=None,
disguised=False,
tag_name=None):
Node.__init__(self, name)
Registered.__init__(self, gtype_name, get_type)
self.ctype = ctype
self.methods = []
self.static_methods = []
self.fields = []
self.constructors = []
self.disguised = disguised
self.gtype_name = gtype_name
self.get_type = get_type
self.c_symbol_prefix = c_symbol_prefix
self.tag_name = tag_name
def add_gtype(self, gtype_name, get_type):
self.gtype_name = gtype_name
self.get_type = get_type
self.namespace.type_names[gtype_name] = self
def _walk(self, callback, chain):
for ctor in self.constructors:
ctor.walk(callback, chain)
for func in self.methods:
func.walk(callback, chain)
for func in self.static_methods:
func.walk(callback, chain)
for field in self.fields:
if field.anonymous_node is not None:
field.anonymous_node.walk(callback, chain)
def get_field(self, name):
for field in self.fields:
if field.name == name:
return field
raise ValueError("Unknown field %s" % (name, ))
def get_field_index(self, name):
for i, field in enumerate(self.fields):
if field.name == name:
return i
raise ValueError("Unknown field %s" % (name, ))
class Field(Annotated):
def __init__(self, name, typenode, readable, writable, bits=None,
anonymous_node=None):
Annotated.__init__(self)
assert (typenode or anonymous_node)
self.name = name
self.type = typenode
self.readable = readable
self.writable = writable
self.bits = bits
self.anonymous_node = anonymous_node
self.private = False
self.namespace = None
self.parent = None # a compound
def _compare(self, other, op):
return op(self.name, other.name)
def __lt__(self, other):
return self._compare(other, operator.lt)
def __gt__(self, other):
return self._compare(other, operator.gt)
def __ge__(self, other):
return self._compare(other, operator.ge)
def __le__(self, other):
return self._compare(other, operator.le)
def __eq__(self, other):
return self._compare(other, operator.eq)
def __ne__(self, other):
return self._compare(other, operator.ne)
def __hash__(self):
return hash(self.name)
def __repr__(self):
return "%s('%s')" % (self.__class__.__name__, self.name)
class Record(Compound):
def __init__(self, name,
ctype=None,
gtype_name=None,
get_type=None,
c_symbol_prefix=None,
disguised=False,
tag_name=None):
Compound.__init__(self, name,
ctype=ctype,
gtype_name=gtype_name,
get_type=get_type,
c_symbol_prefix=c_symbol_prefix,
disguised=disguised,
tag_name=tag_name)
# If non-None, this record defines the FooClass C structure
# for some Foo GObject (or similar for GInterface)
self.is_gtype_struct_for = None
class Union(Compound):
def __init__(self, name,
ctype=None,
gtype_name=None,
get_type=None,
c_symbol_prefix=None,
disguised=False,
tag_name=None):
Compound.__init__(self, name,
ctype=ctype,
gtype_name=gtype_name,
get_type=get_type,
c_symbol_prefix=c_symbol_prefix,
disguised=disguised,
tag_name=tag_name)
class Boxed(Node, Registered):
"""A boxed type with no known associated structure/union."""
def __init__(self, name,
gtype_name=None,
get_type=None,
c_symbol_prefix=None):
assert gtype_name is not None
assert get_type is not None
Node.__init__(self, name)
Registered.__init__(self, gtype_name, get_type)
if get_type is not None:
assert c_symbol_prefix is not None
self.c_symbol_prefix = c_symbol_prefix
self.constructors = []
self.methods = []
self.static_methods = []
def _walk(self, callback, chain):
for ctor in self.constructors:
ctor.walk(callback, chain)
for meth in self.methods:
meth.walk(callback, chain)
for meth in self.static_methods:
meth.walk(callback, chain)
class Signal(Callable):
def __init__(self, name, retval, parameters, when=None,
no_recurse=False, detailed=False, action=False,
no_hooks=False):
Callable.__init__(self, name, retval, parameters, False)
self.when = when
self.no_recurse = no_recurse
self.detailed = detailed
self.action = action
self.no_hooks = no_hooks
class Class(Node, Registered):
def __init__(self, name, parent_type,
ctype=None,
gtype_name=None,
get_type=None,
c_symbol_prefix=None,
is_abstract=False):
Node.__init__(self, name)
Registered.__init__(self, gtype_name, get_type)
self.ctype = ctype
self.c_symbol_prefix = c_symbol_prefix
self.parent_type = parent_type
self.fundamental = False
self.unref_func = None
self.ref_func = None
self.set_value_func = None
self.get_value_func = None
# When we're in the scanner, we keep around a list
# of parents so that we can transparently fall back
# if there are 'hidden' parents
self.parent_chain = []
self.glib_type_struct = None
self.is_abstract = is_abstract
self.methods = []
self.virtual_methods = []
self.static_methods = []
self.interfaces = []
self.constructors = []
self.properties = []
self.fields = []
self.signals = []
def _walk(self, callback, chain):
for meth in self.methods:
meth.walk(callback, chain)
for meth in self.virtual_methods:
meth.walk(callback, chain)
for meth in self.static_methods:
meth.walk(callback, chain)
for ctor in self.constructors:
ctor.walk(callback, chain)
for field in self.fields:
if field.anonymous_node:
field.anonymous_node.walk(callback, chain)
for sig in self.signals:
sig.walk(callback, chain)
for prop in self.properties:
prop.walk(callback, chain)
class Interface(Node, Registered):
def __init__(self, name, parent_type,
ctype=None,
gtype_name=None,
get_type=None,
c_symbol_prefix=None):
Node.__init__(self, name)
Registered.__init__(self, gtype_name, get_type)
self.ctype = ctype
self.c_symbol_prefix = c_symbol_prefix
self.parent_type = parent_type
self.parent_chain = []
self.methods = []
self.signals = []
self.static_methods = []
self.virtual_methods = []
self.glib_type_struct = None
self.properties = []
self.fields = []
self.prerequisites = []
# Not used yet, exists just to avoid an exception in
# Namespace.append()
self.constructors = []
def _walk(self, callback, chain):
for meth in self.methods:
meth.walk(callback, chain)
for meth in self.static_methods:
meth.walk(callback, chain)
for meth in self.virtual_methods:
meth.walk(callback, chain)
for field in self.fields:
if field.anonymous_node:
field.anonymous_node.walk(callback, chain)
for sig in self.signals:
sig.walk(callback, chain)
class Constant(Node):
def __init__(self, name, value_type, value, ctype):
Node.__init__(self, name)
self.value_type = value_type
self.value = value
self.ctype = ctype
class Property(Node):
def __init__(self, name, typeobj, readable, writable,
construct, construct_only, transfer=None):
Node.__init__(self, name)
self.type = typeobj
self.readable = readable
self.writable = writable
self.construct = construct
self.construct_only = construct_only
if transfer is None:
self.transfer = PARAM_TRANSFER_NONE
else:
self.transfer = transfer
self.parent = None # A Class or Interface
class Callback(Callable):
def __init__(self, name, retval, parameters, throws, ctype=None):
Callable.__init__(self, name, retval, parameters, throws)
self.ctype = ctype
|