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
|
# -*- Mode: Python -*-
# GObject-Introspection - a framework for introspecting GObject libraries
# Copyright (C) 2008 Johan Dahlin
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.
#
# AnnotationParser - parses gtk-doc annotations
from .ast import (Array, Bitfield, Callback, Class, Enum, Field, Function,
Interface, List, Map, Parameter, Record, Return, Type, Union,
Varargs,
default_array_types,
BASIC_GIR_TYPES,
PARAM_DIRECTION_INOUT,
PARAM_DIRECTION_IN,
PARAM_DIRECTION_OUT,
PARAM_TRANSFER_NONE,
PARAM_TRANSFER_CONTAINER,
PARAM_TRANSFER_FULL,
TYPE_ANY, TYPE_NONE)
from .odict import odict
from .glibast import GLibBoxed
# All gtk-doc comments needs to start with this:
_COMMENT_HEADER = '*\n '
# Tags - annotations applyed to comment blocks
TAG_SINCE = 'Since'
TAG_DEPRECATED = 'Deprecated'
TAG_RETURNS = 'Returns'
TAG_RETURNS_ALT = 'Return value'
# Options - annotations for parameters and return values
OPT_ALLOW_NONE = 'allow-none'
OPT_ARRAY = 'array'
OPT_ELEMENT_TYPE = 'element-type'
OPT_IN = 'in'
OPT_INOUT = 'inout'
OPT_INOUT_ALT = 'in-out'
OPT_OUT = 'out'
OPT_SCOPE = 'scope'
OPT_TRANSFER = 'transfer'
OPT_TYPE = 'type'
# Array options - array specific annotations
OPT_ARRAY_FIXED_SIZE = 'fixed-size'
OPT_ARRAY_LENGTH = 'length'
OPT_ARRAY_ZERO_TERMINATED = 'zero-terminated'
class InvalidAnnotationError(Exception):
pass
class DocBlock(object):
def __init__(self, name):
self.name = name
self.value = None
self.tags = odict()
self.comment = None
def __repr__(self):
return '<DocBlock %r>' % (self.name, )
def get(self, name):
if name == TAG_RETURNS:
value = self.tags.get(name)
if value is None:
return self.tags.get(TAG_RETURNS_ALT)
else:
return value
else:
return self.tags.get(name)
class DocTag(object):
def __init__(self, name):
self.name = name
self.options = []
self.comment = None
class Option(object):
def __init__(self, option):
self._array = []
self._dict = {}
for p in option.split(' '):
if '=' in p:
name, value = p.split('=', 1)
else:
name = p
value = None
self._dict[name] = value
if value is None:
self._array.append(name)
else:
self._array.append((name, value))
def __repr__(self):
return '<Option %r>' % (self._array, )
def one(self):
assert len(self._array) == 1
return self._array[0]
def flat(self):
return self._array
def all(self):
return self._dict
class AnnotationParser(object):
def __init__(self, namespace, source_scanner, transformer):
self._blocks = {}
self._namespace = namespace
self._transformer = transformer
for comment in source_scanner.get_comments():
self._parse_comment(comment)
def parse(self):
aa = AnnotationApplier(self._blocks, self._transformer)
aa.parse(self._namespace)
def _parse_comment(self, comment):
# We're looking for gtk-doc comments here, they look like this:
# /**
# * symbol:
#
# symbol is currently one of:
# - function: gtk_widget_show
# - signal: GtkWidget::destroy
# - property: GtkWidget:visible
#
comment = comment.lstrip()
if not comment.startswith(_COMMENT_HEADER):
return
comment = comment[len(_COMMENT_HEADER):]
comment = comment.strip()
if not comment.startswith('* '):
return
comment = comment[2:]
pos = comment.find('\n ')
if pos == -1:
return
block_name = comment[:pos]
block_name = block_name.strip()
if not block_name.endswith(':'):
return
block = DocBlock(block_name[:-1])
comment_lines = []
for line in comment[pos+1:].split('\n'):
line = line.lstrip()
line = line[2:].strip() # Skip ' *'
if not line:
continue
if line.startswith('@'):
line = line[1:]
elif not ': ' in line:
comment_lines.append(line)
continue
tag = self._parse_tag(line)
block.tags[tag.name] = tag
block.comment = '\n'.join(comment_lines)
self._blocks[block.name] = block
def _parse_tag(self, raw):
# Tag: bar
# Tag: bar opt1 opt2
parts = raw.split(': ', 1)
if len(parts) == 1:
tag_name = parts[0]
value = ''
else:
tag_name, value = parts
options, rest = self._parse_options(value)
tag = DocTag(tag_name)
tag.value = value
tag.options = options
tag.comment = rest
return tag
def _parse_options(self, value):
# (foo)
# (bar opt1 opt2...)
opened = -1
options = {}
last = None
for i, c in enumerate(value):
if c == '(' and opened == -1:
opened = i+1
if c == ')' and opened != -1:
segment = value[opened:i]
parts = segment.split(' ', 1)
if len(parts) == 2:
name, option = parts
elif len(parts) == 1:
name = parts[0]
option = None
else:
raise AssertionError
if option is not None:
option = Option(option)
options[name] = option
last = i + 2
opened = -1
if last is not None:
rest = value[last:].strip()
else:
rest = None
return options, rest
class AnnotationApplier(object):
def __init__(self, blocks, transformer):
self._blocks = blocks
self._transformer = transformer
def _get_tag(self, block, tag_name):
if block is None:
return None
return block.get(tag_name)
def parse(self, namespace):
for node in namespace.nodes:
self._parse_node(node)
# Boring parsing boilerplate.
def _parse_node(self, node):
if isinstance(node, Function):
self._parse_function(node)
elif isinstance(node, Enum):
self._parse_enum(node)
elif isinstance(node, Bitfield):
self._parse_bitfield(node)
elif isinstance(node, Class):
self._parse_class(node)
elif isinstance(node, Interface):
self._parse_interface(node)
elif isinstance(node, Callback):
self._parse_callback(node)
elif isinstance(node, Record):
self._parse_record(node)
elif isinstance(node, Union):
self._parse_union(node)
elif isinstance(node, GLibBoxed):
self._parse_boxed(node)
def _parse_class(self, class_):
block = self._blocks.get(class_.type_name)
self._parse_version(class_, block)
self._parse_constructors(class_.constructors)
self._parse_methods(class_.methods)
self._parse_methods(class_.static_methods)
self._parse_properties(class_, class_.properties)
self._parse_signals(class_, class_.signals)
self._parse_fields(class_, class_.fields)
if block:
class_.doc = block.comment
def _parse_interface(self, interface):
block = self._blocks.get(interface.type_name)
self._parse_version(interface, block)
self._parse_methods(interface.methods)
self._parse_properties(interface, interface.properties)
self._parse_signals(interface, interface.signals)
self._parse_fields(interface, interface.fields)
if block:
interface.doc = block.comment
def _parse_record(self, record):
block = self._blocks.get(record.symbol)
self._parse_version(record, block)
self._parse_constructors(record.constructors)
self._parse_fields(record, record.fields)
if isinstance(record, GLibBoxed):
self._parse_methods(record.methods)
if block:
record.doc = block.comment
def _parse_boxed(self, boxed):
block = self._blocks.get(boxed.name)
self._parse_version(boxed, block)
self._parse_constructors(boxed.constructors)
self._parse_methods(boxed.methods)
if block:
boxed.doc = block.comment
def _parse_union(self, union):
block = self._blocks.get(union.name)
self._parse_fields(union, union.fields)
self._parse_constructors(union.constructors)
if isinstance(union, GLibBoxed):
self._parse_methods(union.methods)
if block:
union.doc = block.comment
def _parse_enum(self, enum):
block = self._blocks.get(enum.symbol)
self._parse_version(enum, block)
if block:
enum.doc = block.comment
def _parse_bitfield(self, bitfield):
block = self._blocks.get(bitfield.symbol)
self._parse_version(bitfield, block)
if block:
bitfield.doc = block.comment
def _parse_constructors(self, constructors):
for ctor in constructors:
self._parse_function(ctor)
def _parse_fields(self, parent, fields):
for field in fields:
self._parse_field(parent, field)
def _parse_properties(self, parent, properties):
for prop in properties:
self._parse_property(parent, prop)
def _parse_methods(self, methods):
for method in methods:
self._parse_function(method)
def _parse_signals(self, parent, signals):
for signal in signals:
self._parse_signal(parent, signal)
def _parse_property(self, parent, prop):
block = self._blocks.get('%s:%s' % (parent.type_name, prop.name))
self._parse_version(prop, block)
self._parse_deprecated(prop, block)
if block:
prop.doc = block.comment
def _parse_callback(self, callback):
block = self._blocks.get(callback.ctype)
self._parse_version(callback, block)
self._parse_params(callback, callback.parameters, block)
self._parse_return(callback, callback.retval, block)
if block:
callback.doc = block.comment
def _parse_function(self, func):
block = self._blocks.get(func.symbol)
self._parse_version(func, block)
self._parse_deprecated(func, block)
self._parse_params(func, func.parameters, block)
self._parse_return(func, func.retval, block)
if block:
func.doc = block.comment
def _parse_signal(self, parent, signal):
block = self._blocks.get('%s::%s' % (parent.type_name, signal.name))
self._parse_version(signal, block)
self._parse_deprecated(signal, block)
# We're only attempting to name the signal parameters if
# the number of parameter tags (@foo) is the same or greater
# than the number of signal parameters
if block and len(block.tags) > len(signal.parameters):
names = block.tags.items()
else:
names = []
for i, param in enumerate(signal.parameters):
if names:
name, tag = names[i+1]
param.name = name
options = getattr(tag, 'options', {})
param_type = options.get(OPT_TYPE)
if param_type:
param.type.name = param_type.one()
else:
tag = None
self._parse_param(signal, param, tag)
self._parse_return(signal, signal.retval, block)
if block:
signal.doc = block.comment
def _parse_field(self, parent, field):
if isinstance(field, Callback):
self._parse_callback(field)
def _parse_params(self, parent, params, block):
for param in params:
tag = self._get_tag(block, param.name)
self._parse_param(parent, param, tag)
def _parse_return(self, parent, return_, block):
tag = self._get_tag(block, TAG_RETURNS)
options = getattr(tag, 'options', {})
self._parse_param_ret_common(parent, return_, options)
if tag is not None and tag.comment is not None:
return_.doc = tag.comment
def _parse_param(self, parent, param, tag):
options = getattr(tag, 'options', {})
if isinstance(parent, Function):
scope = options.get(OPT_SCOPE)
if scope:
param.scope = scope.one()
param.transfer = PARAM_TRANSFER_NONE
self._parse_param_ret_common(parent, param, options)
if tag is not None and tag.comment is not None:
param.doc = tag.comment
def _parse_param_ret_common(self, parent, node, options):
node.direction = self._extract_direction(node, options)
container_type = self._extract_container_type(
parent, node, options)
if container_type is not None:
node.type = container_type
if node.direction is None:
node.direction = self._guess_direction(node)
node.transfer = self._extract_transfer(parent, node, options)
if OPT_ALLOW_NONE in options:
node.allow_none = True
assert node.transfer is not None
def _extract_direction(self, node, options):
if (OPT_INOUT in options or
OPT_INOUT_ALT in options):
direction = PARAM_DIRECTION_INOUT
elif OPT_OUT in options:
direction = PARAM_DIRECTION_OUT
elif OPT_IN in options:
direction = PARAM_DIRECTION_IN
else:
direction = node.direction
return direction
def _guess_array(self, node):
ctype = node.type.ctype
if ctype is None:
return False
if not ctype.endswith('*'):
return False
if node.type.canonical in default_array_types:
return True
return False
def _extract_container_type(self, parent, node, options):
has_element_type = OPT_ELEMENT_TYPE in options
has_array = OPT_ARRAY in options
# FIXME: This is a hack :-(
if (not isinstance(node, Field) and
(not has_element_type and
(node.direction is None
or node.direction == PARAM_DIRECTION_IN))):
if self._guess_array(node):
has_array = True
if has_array:
container_type = self._parse_array(parent, node, options)
elif has_element_type:
container_type = self._parse_element_type(parent, node, options)
else:
container_type = None
return container_type
def _parse_array(self, parent, node, options):
array_opt = options.get(OPT_ARRAY)
if array_opt:
array_values = array_opt.all()
else:
array_values = {}
element_type = options.get(OPT_ELEMENT_TYPE)
if element_type is not None:
element_type_name = element_type.one()
else:
element_type_name = node.type.name
container_type = Array(node.type.ctype,
element_type_name)
if OPT_ARRAY_ZERO_TERMINATED in array_values:
container_type.zeroterminated = array_values.get(
OPT_ARRAY_ZERO_TERMINATED) == '1'
length = array_values.get(OPT_ARRAY_LENGTH)
if length is not None:
param_index = parent.get_parameter_index(length)
container_type.length_param_index = param_index
# For in parameters we're incorrectly deferring
# char/unsigned char to utf8 when a length annotation
# is specified.
if (isinstance(node, Parameter) and
node.type.name == 'utf8' and
self._guess_direction(node) == PARAM_DIRECTION_IN):
# FIXME: unsigned char/guchar should be uint8
container_type.element_type = 'int8'
container_type.size = array_values.get(OPT_ARRAY_FIXED_SIZE)
return container_type
def _parse_element_type(self, parent, node, options):
element_type_opt = options.get(OPT_ELEMENT_TYPE)
element_type = element_type_opt.flat()
if node.type.name in ['GLib.List', 'GLib.SList']:
assert len(element_type) == 1
etype = Type(element_type[0])
container_type = List(
node.type.name,
node.type.ctype,
self._transformer.resolve_param_type(etype))
elif node.type.name in ['GLib.HashTable']:
assert len(element_type) == 2
key_type = Type(element_type[0])
value_type = Type(element_type[1])
container_type = Map(
node.type.name,
node.type.ctype,
self._transformer.resolve_param_type(key_type),
self._transformer.resolve_param_type(value_type))
else:
print 'FIXME: unhandled element-type container:', node
return container_type
def _extract_transfer(self, parent, node, options):
transfer_opt = options.get(OPT_TRANSFER)
if transfer_opt is None:
transfer = self._guess_transfer(node, options)
else:
transfer = transfer_opt.one()
if transfer is None:
transfer = PARAM_TRANSFER_FULL
if transfer not in [PARAM_TRANSFER_NONE,
PARAM_TRANSFER_CONTAINER,
PARAM_TRANSFER_FULL]:
raise InvalidAnnotationError(
"transfer for %s of %r is invalid (%r), must be one of "
"none, container, full." % (node, parent.name, transfer))
return transfer
def _parse_version(self, node, block):
since_tag = self._get_tag(block, TAG_SINCE)
if since_tag is None:
return
node.version = since_tag.value
def _parse_deprecated(self, node, block):
deprecated_tag = self._get_tag(block, TAG_DEPRECATED)
if deprecated_tag is None:
return
value = deprecated_tag.value
if ': ' in value:
version, desc = value.split(': ')
else:
desc = value
version = None
node.deprecated = desc
if version is not None:
node.deprecated_version = version
def _guess_direction(self, node):
if node.direction:
return node.direction
is_pointer = False
if node.type.ctype:
is_pointer = '*' in node.type.ctype
if is_pointer and node.type.name in BASIC_GIR_TYPES:
return PARAM_DIRECTION_OUT
return PARAM_DIRECTION_IN
def _guess_transfer(self, node, options):
if node.transfer is not None:
return node.transfer
if isinstance(node.type, Array):
return PARAM_TRANSFER_NONE
# Anything with 'const' gets none
if node.type.is_const:
return PARAM_TRANSFER_NONE
elif node.type.name in [TYPE_NONE, TYPE_ANY]:
return PARAM_TRANSFER_NONE
elif isinstance(node.type, Varargs):
return PARAM_TRANSFER_NONE
elif isinstance(node, Parameter):
if node.direction in [PARAM_DIRECTION_INOUT,
PARAM_DIRECTION_OUT]:
return PARAM_TRANSFER_FULL
# This one is a hack for compatibility; the transfer
# for string parameters really has no defined meaning.
elif node.type.canonical == 'utf8':
return PARAM_TRANSFER_FULL
else:
return PARAM_TRANSFER_NONE
elif isinstance(node, Return):
if (node.type.canonical in BASIC_GIR_TYPES or
(node.type.canonical in [TYPE_NONE, TYPE_ANY] and
node.type.is_const)):
return PARAM_TRANSFER_NONE
else:
return PARAM_TRANSFER_FULL
elif isinstance(node, Field):
return PARAM_TRANSFER_NONE
else:
raise AssertionError(node)
|