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
|
# -*- coding: utf-8 -*-
# -*- Mode: Python -*-
# GObject-Introspection - a framework for introspecting GObject libraries
# Copyright (C) 2008-2010 Johan Dahlin
# Copyright (C) 2012-2013 Dieter Verfaillie <dieterv@optionexplicit.be>
#
# 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.
#
'''
GTK-Doc comment block format
----------------------------
A GTK-Doc comment block is built out of multiple parts. Each part can be further
divided into fields which are separated by a colon ("``:``") delimiter.
Known parts and the fields they are constructed from look like the following
(optional fields are enclosed in square brackets)::
┌───────────────────────────────────────────────────────────┐
│ /** │ ─▷ start token
├────────────────────┬──────────────────────────────────────┤
│ * identifier_name │ [: annotations] │ ─▷ identifier part
├────────────────────┼─────────────────┬────────────────────┤
│ * @parameter_name │ [: annotations] │ : description │ ─▷ parameter part
├────────────────────┴─────────────────┴────────────────────┤
│ * │ ─▷ comment block description
│ * comment_block_description │
├─────────────┬─────────────────┬───────────┬───────────────┤
│ * tag_name │ [: annotations] │ [: value] │ : description │ ─▷ tag part
├─────────────┴─────────────────┴───────────┴───────────────┤
│ */ │ ─▷ end token
└───────────────────────────────────────────────────────────┘
There are two conditions that must be met before a comment block is recognized
as a GTK-Doc comment block:
#. The comment block is opened with a GTK-Doc start token ("``/**``")
#. The first line following the start token contains a valid identifier part
Once a GTK-Doc comment block has been identified as such and has been stripped
from its start and end tokens the remaining parts have to be written in a
specific order:
#. There must be exactly 1 `identifier` part on the first line of the
comment block which consists of:
* a required `identifier_name` field
* an optional `annotations` field
#. Zero or more `parameter` parts, each consisting of:
* a required `parameter_name` field
* an optional `annotations` field
* a required `description` field (can be the empty string)
#. One optional `comment block description` part which must begin with at
least 1 empty line signaling the start of this part.
#. Zero or more `tag` parts, each consisting of:
* a required `tag_name` field
* an optional `annotations` field
* an optional `value` field
* a required `description` field (can be the empty string)
Additionally, the following restrictions are in effect:
#. Separating parts with an empty line:
* `identifier` and `parameter` parts cannot be separated from each other by
an empty line as this would signal the start of the
`comment block description` part (see above).
* it is required to separate the `comment block description` part from the
`identifier` or `parameter` parts with an empty line (see above)
* `comment block description` and `tag` parts can optionally be separated
by an empty line
#. Parts and fields cannot span multiple lines, except for:
* the `comment_block_description` part
* `parameter description` and `tag description` fields
#. Taking the above restrictions into account, spanning multiple paragraphs is
limited to the `comment block description` part and `tag description` fields.
Refer to the `GTK-Doc manual`_ for more detailed usage information.
.. _GTK-Doc manual:
http://developer.gnome.org/gtk-doc-manual/1.18/documenting.html.en
'''
import re
from . import message
from .collections import OrderedDict
# GTK-Doc comment block parts
PART_IDENTIFIER = 'identifier'
PART_PARAMETERS = 'parameters'
PART_DESCRIPTION = 'description'
PART_TAGS = 'tags'
# Identifiers
IDENTIFIER_SECTION = 'section'
IDENTIFIER_SYMBOL = 'symbol'
IDENTIFIER_PROPERTY = 'property'
IDENTIFIER_SIGNAL = 'signal'
# Tags - annotations applied to comment blocks
TAG_VFUNC = 'virtual'
TAG_SINCE = 'since'
TAG_STABILITY = 'stability'
TAG_DEPRECATED = 'deprecated'
TAG_RETURNS = 'returns'
TAG_RETURNVALUE = 'return value'
TAG_DESCRIPTION = 'description'
TAG_ATTRIBUTES = 'attributes'
TAG_RENAME_TO = 'rename to'
TAG_TYPE = 'type'
TAG_UNREF_FUNC = 'unref func'
TAG_REF_FUNC = 'ref func'
TAG_SET_VALUE_FUNC = 'set value func'
TAG_GET_VALUE_FUNC = 'get value func'
TAG_TRANSFER = 'transfer'
TAG_VALUE = 'value'
_ALL_TAGS = [TAG_VFUNC,
TAG_SINCE,
TAG_STABILITY,
TAG_DEPRECATED,
TAG_RETURNS,
TAG_RETURNVALUE,
TAG_DESCRIPTION,
TAG_ATTRIBUTES,
TAG_RENAME_TO,
TAG_TYPE,
TAG_UNREF_FUNC,
TAG_REF_FUNC,
TAG_SET_VALUE_FUNC,
TAG_GET_VALUE_FUNC,
TAG_TRANSFER,
TAG_VALUE]
# Annotations - applied to parameters and return values
ANN_ALLOW_NONE = 'allow-none'
ANN_ARRAY = 'array'
ANN_ATTRIBUTE = 'attribute'
ANN_CLOSURE = 'closure'
ANN_DESTROY = 'destroy'
ANN_ELEMENT_TYPE = 'element-type'
ANN_FOREIGN = 'foreign'
ANN_IN = 'in'
ANN_INOUT = 'inout'
ANN_INOUT_ALT = 'in-out'
ANN_OUT = 'out'
ANN_SCOPE = 'scope'
ANN_TRANSFER = 'transfer'
ANN_TYPE = 'type'
ANN_SKIP = 'skip'
ANN_CONSTRUCTOR = 'constructor'
ANN_METHOD = 'method'
ALL_ANNOTATIONS = [
ANN_ALLOW_NONE,
ANN_ARRAY,
ANN_ATTRIBUTE,
ANN_CLOSURE,
ANN_DESTROY,
ANN_ELEMENT_TYPE,
ANN_FOREIGN,
ANN_IN,
ANN_INOUT,
ANN_INOUT_ALT,
ANN_OUT,
ANN_SCOPE,
ANN_TRANSFER,
ANN_TYPE,
ANN_SKIP,
ANN_CONSTRUCTOR,
ANN_METHOD]
# Array options - array specific annotation options
OPT_ARRAY_FIXED_SIZE = 'fixed-size'
OPT_ARRAY_LENGTH = 'length'
OPT_ARRAY_ZERO_TERMINATED = 'zero-terminated'
# Out options
OPT_OUT_CALLER_ALLOCATES = 'caller-allocates'
OPT_OUT_CALLEE_ALLOCATES = 'callee-allocates'
# Scope options
OPT_SCOPE_ASYNC = 'async'
OPT_SCOPE_CALL = 'call'
OPT_SCOPE_NOTIFIED = 'notified'
# Transfer options
OPT_TRANSFER_NONE = 'none'
OPT_TRANSFER_CONTAINER = 'container'
OPT_TRANSFER_FULL = 'full'
OPT_TRANSFER_FLOATING = 'floating'
#The following regular expression programs are built to:
# - match (or substitute) a single comment block line at a time;
# - support (but remains untested) LOCALE and UNICODE modes.
# Program matching the start of a comment block.
#
# Results in 0 symbolic groups.
COMMENT_START_RE = re.compile(
r'''
^ # start
\s* # 0 or more whitespace characters
/ # 1 forward slash character
\*{2} # exactly 2 asterisk characters
\s* # 0 or more whitespace characters
$ # end
''',
re.VERBOSE)
# Program matching the end of a comment block. We need to take care
# of comment ends that aren't on their own line for legacy support
# reasons. See https://bugzilla.gnome.org/show_bug.cgi?id=689354
#
# Results in 1 symbolic group:
# - group 1 = description
COMMENT_END_RE = re.compile(
r'''
^ # start
\s* # 0 or more whitespace characters
(?P<description>.*?) # description text
\s* # 0 or more whitespace characters
\*+ # 1 or more asterisk characters
/ # 1 forward slash character
\s* # 0 or more whitespace characters
$ # end
''',
re.VERBOSE)
# Pattern matching the ' * ' at the beginning of every
# line inside a comment block.
COMMENT_ASTERISK_RE = re.compile(
r'''
^ # start
\s* # 0 or more whitespace characters
\* # 1 asterisk character
\s? # 0 or 1 whitespace characters
# WARNING: removing more than 1
# whitespace character breaks
# embedded example program indentation
''',
re.VERBOSE)
# Program matching the indentation at the beginning of every
# line (stripped from the ' * ') inside a comment block.
#
# Results in 1 symbolic group:
# - group 1 = indentation
COMMENT_INDENTATION_RE = re.compile(
r'''
^
(?P<indentation>\s*) # 0 or more whitespace characters
.*
$
''',
re.VERBOSE)
# Pattern matching an empty line.
EMPTY_LINE_RE = re.compile(
r'''
^ # start
\s* # 0 or more whitespace characters
$ # end
''',
re.VERBOSE)
# Program matching SECTION identifiers.
#
# Results in 2 symbolic groups:
# - group 1 = delimiter
# - group 2 = section_name
SECTION_RE = re.compile(
r'''
^ # start
\s* # 0 or more whitespace characters
SECTION # SECTION
\s* # 0 or more whitespace characters
(?P<delimiter>:?) # delimiter
\s* # 0 or more whitespace characters
(?P<section_name>\w\S+)? # section name
\s* # 0 or more whitespace characters
$
''',
re.VERBOSE)
# Program matching symbol (function, constant, struct and enum) identifiers.
#
# Results in 3 symbolic groups:
# - group 1 = symbol_name
# - group 2 = delimiter
# - group 3 = annotations
SYMBOL_RE = re.compile(
r'''
^ # start
\s* # 0 or more whitespace characters
(?P<symbol_name>[\w-]*\w) # symbol name
\s* # 0 or more whitespace characters
(?P<delimiter>:?) # delimiter
\s* # 0 or more whitespace characters
(?P<annotations>(?:\(.*?\)\s*)*) # annotations
\s* # 0 or more whitespace characters
$ # end
''',
re.VERBOSE)
# Program matching property identifiers.
#
# Results in 4 symbolic groups:
# - group 1 = class_name
# - group 2 = property_name
# - group 3 = delimiter
# - group 4 = annotations
PROPERTY_RE = re.compile(
r'''
^ # start
\s* # 0 or more whitespace characters
(?P<class_name>[\w]+) # class name
\s* # 0 or more whitespace characters
:{1} # required colon
\s* # 0 or more whitespace characters
(?P<property_name>[\w-]*\w) # property name
\s* # 0 or more whitespace characters
(?P<delimiter>:?) # delimiter
\s* # 0 or more whitespace characters
(?P<annotations>(?:\(.*?\)\s*)*) # annotations
\s* # 0 or more whitespace characters
$ # end
''',
re.VERBOSE)
# Program matching signal identifiers.
#
# Results in 4 symbolic groups:
# - group 1 = class_name
# - group 2 = signal_name
# - group 3 = delimiter
# - group 4 = annotations
SIGNAL_RE = re.compile(
r'''
^ # start
\s* # 0 or more whitespace characters
(?P<class_name>[\w]+) # class name
\s* # 0 or more whitespace characters
:{2} # 2 required colons
\s* # 0 or more whitespace characters
(?P<signal_name>[\w-]*\w) # signal name
\s* # 0 or more whitespace characters
(?P<delimiter>:?) # delimiter
\s* # 0 or more whitespace characters
(?P<annotations>(?:\(.*?\)\s*)*) # annotations
\s* # 0 or more whitespace characters
$ # end
''',
re.VERBOSE)
# Program matching parameters.
#
# Results in 4 symbolic groups:
# - group 1 = parameter_name
# - group 2 = annotations
# - group 3 = delimiter
# - group 4 = description
PARAMETER_RE = re.compile(
r'''
^ # start
\s* # 0 or more whitespace characters
@ # @ character
(?P<parameter_name>[\w-]*\w|\.\.\.) # parameter name
\s* # 0 or more whitespace characters
:{1} # required colon
\s* # 0 or more whitespace characters
(?P<annotations>(?:\(.*?\)\s*)*) # annotations
(?P<delimiter>:?) # delimiter
\s* # 0 or more whitespace characters
(?P<description>.*?) # description
\s* # 0 or more whitespace characters
$ # end
''',
re.VERBOSE)
# Program matching tags.
#
# Results in 4 symbolic groups:
# - group 1 = tag_name
# - group 2 = annotations
# - group 3 = delimiter
# - group 4 = description
_all_tags = '|'.join(_ALL_TAGS).replace(' ', '\\ ')
TAG_RE = re.compile(
r'''
^ # start
\s* # 0 or more whitespace characters
(?P<tag_name>''' + _all_tags + r''') # tag name
\s* # 0 or more whitespace characters
:{1} # required colon
\s* # 0 or more whitespace characters
(?P<annotations>(?:\(.*?\)\s*)*) # annotations
(?P<delimiter>:?) # delimiter
\s* # 0 or more whitespace characters
(?P<description>.*?) # description
\s* # 0 or more whitespace characters
$ # end
''',
re.VERBOSE | re.IGNORECASE)
# Program matching multiline annotation continuations.
# This is used on multiline parameters and tags (but not on the first line) to
# generate warnings about invalid annotations spanning multiple lines.
#
# Results in 3 symbolic groups:
# - group 2 = annotations
# - group 3 = delimiter
# - group 4 = description
MULTILINE_ANNOTATION_CONTINUATION_RE = re.compile(
r'''
^ # start
\s* # 0 or more whitespace characters
(?P<annotations>(?:\(.*?\)\s*)*) # annotations
(?P<delimiter>:) # delimiter
\s* # 0 or more whitespace characters
(?P<description>.*?) # description
\s* # 0 or more whitespace characters
$ # end
''',
re.VERBOSE)
class DocBlock(object):
def __init__(self, name):
self.name = name
self.annotations = DocAnnotations()
self.value = None
self.tags = OrderedDict()
self.description = None
self.params = OrderedDict()
self.position = None
def __cmp__(self, other):
# Note: This is used by g-ir-annotation-tool, which does a ``sorted(blocks.values())``,
# meaning that keeping this around makes update-glib-annotations.py patches
# easier to review.
return cmp(self.name, other.name)
def __repr__(self):
return '<DocBlock %r %r>' % (self.name, self.annotations)
def to_gtk_doc(self):
annotations = ''
if self.annotations:
annotations += ' '
annotations += ' '.join('(%s)' % o for o in self.annotations)
lines = [self.name]
if 'SECTION' not in self.name:
lines[0] += ':'
lines[0] += annotations
for param in self.params.values():
lines.append(param.to_gtk_doc_param())
if self.description:
lines.append('')
for l in self.description.split('\n'):
lines.append(l)
if self.tags:
lines.append('')
for tag in self.tags.values():
lines.append(tag.to_gtk_doc_tag())
comment = ''
comment += '/**\n'
for line in lines:
line = line.rstrip()
if line:
comment += ' * %s\n' % (line, )
else:
comment += ' *\n'
comment += ' */\n'
return comment
def validate(self):
for param in self.params.values():
param.validate()
for tag in self.tags.values():
tag.validate()
class DocTag(object):
def __init__(self, block, name):
self.block = block
self.name = name
self.annotations = DocAnnotations()
self.description = None
self.value = ''
self.position = None
def __repr__(self):
return '<DocTag %r %r>' % (self.name, self.annotations)
def _validate_annotation(self, ann_name, options, required=False,
n_params=None, choices=None):
if required and options is None:
message.warn('%s annotation needs a value' % (ann_name, ), self.position)
return
if n_params is not None:
if n_params == 0:
s = 'no value'
elif n_params == 1:
s = 'one value'
else:
s = '%d values' % (n_params, )
if ((n_params > 0 and (options is None or options.length() != n_params))
or n_params == 0 and options is not None):
if options is None:
length = 0
else:
length = options.length()
message.warn('%s annotation needs %s, not %d' % (ann_name, s, length),
self.position)
return
if choices is not None:
option = options.one()
if option not in choices:
message.warn('invalid %s annotation value: %r' % (ann_name, option, ),
self.position)
return
def _validate_array(self, ann_name, options):
if options is None:
return
for option, value in options.all().items():
if option in [OPT_ARRAY_ZERO_TERMINATED, OPT_ARRAY_FIXED_SIZE]:
try:
int(value)
except (TypeError, ValueError):
if value is None:
message.warn('array option %s needs a value' % (option, ),
positions=self.position)
else:
message.warn('invalid array %s option value %r, '
'must be an integer' % (option, value, ),
positions=self.position)
elif option == OPT_ARRAY_LENGTH:
if value is None:
message.warn('array option length needs a value',
positions=self.position)
else:
message.warn('invalid array annotation value: %r' % (option, ),
self.position)
def _validate_closure(self, ann_name, options):
if options is not None and options.length() > 1:
message.warn('closure takes at most 1 value, %d given' % (options.length(), ),
self.position)
def _validate_element_type(self, ann_name, options):
self._validate_annotation(ann_name, options, required=True)
if options is None:
message.warn('element-type takes at least one value, none given',
self.position)
return
if options.length() > 2:
message.warn('element-type takes at most 2 values, %d given' % (options.length(), ),
self.position)
return
def _validate_out(self, ann_name, options):
if options is None:
return
if options.length() > 1:
message.warn('out annotation takes at most 1 value, %d given' % (options.length(), ),
self.position)
return
option = options.one()
if option not in [OPT_OUT_CALLEE_ALLOCATES,
OPT_OUT_CALLER_ALLOCATES]:
message.warn("out annotation value is invalid: %r" % (option, ),
self.position)
return
def _get_gtk_doc_value(self):
def serialize_one(option, value, fmt, fmt2):
if value:
if type(value) != str:
value = ' '.join((serialize_one(k, v, '%s=%s', '%s')
for k, v in value.all().items()))
return fmt % (option, value)
else:
return fmt2 % (option, )
annotations = []
for ann_name, options in self.annotations.items():
annotations.append(serialize_one(ann_name, options, '(%s %s)', '(%s)'))
if annotations:
return ' '.join(annotations) + ': '
else:
return self.value
def to_gtk_doc_param(self):
return '@%s: %s%s' % (self.name, self._get_gtk_doc_value(), self.description)
def to_gtk_doc_tag(self):
return '%s: %s%s' % (self.name.capitalize(),
self._get_gtk_doc_value(),
self.description or '')
def validate(self):
if self.name == TAG_ATTRIBUTES:
# The 'Attributes:' tag allows free form annotations so the
# validation below is most certainly going to fail.
return
for ann_name, value in self.annotations.items():
if ann_name == ANN_ALLOW_NONE:
self._validate_annotation(ann_name, value, n_params=0)
elif ann_name == ANN_ARRAY:
self._validate_array(ann_name, value)
elif ann_name == ANN_ATTRIBUTE:
self._validate_annotation(ann_name, value, n_params=2)
elif ann_name == ANN_CLOSURE:
self._validate_closure(ann_name, value)
elif ann_name == ANN_DESTROY:
self._validate_annotation(ann_name, value, n_params=1)
elif ann_name == ANN_ELEMENT_TYPE:
self._validate_element_type(ann_name, value)
elif ann_name == ANN_FOREIGN:
self._validate_annotation(ann_name, value, n_params=0)
elif ann_name == ANN_IN:
self._validate_annotation(ann_name, value, n_params=0)
elif ann_name in [ANN_INOUT, ANN_INOUT_ALT]:
self._validate_annotation(ann_name, value, n_params=0)
elif ann_name == ANN_OUT:
self._validate_out(ann_name, value)
elif ann_name == ANN_SCOPE:
self._validate_annotation(
ann_name, value, required=True,
n_params=1,
choices=[OPT_SCOPE_ASYNC,
OPT_SCOPE_CALL,
OPT_SCOPE_NOTIFIED])
elif ann_name == ANN_SKIP:
self._validate_annotation(ann_name, value, n_params=0)
elif ann_name == ANN_TRANSFER:
self._validate_annotation(
ann_name, value, required=True,
n_params=1,
choices=[OPT_TRANSFER_FULL,
OPT_TRANSFER_CONTAINER,
OPT_TRANSFER_NONE,
OPT_TRANSFER_FLOATING])
elif ann_name == ANN_TYPE:
self._validate_annotation(ann_name, value, required=True,
n_params=1)
elif ann_name == ANN_CONSTRUCTOR:
self._validate_annotation(ann_name, value, n_params=0)
elif ann_name == ANN_METHOD:
self._validate_annotation(ann_name, value, n_params=0)
else:
message.warn('unknown annotation: %s' % (ann_name, ),
self.position)
class DocAnnotations(object):
def __init__(self):
self.values = []
self.position = None
def __repr__(self):
return '<DocAnnotations %r>' % (self.values, )
def __getitem__(self, item):
for key, value in self.values:
if key == item:
return value
raise KeyError
def __nonzero__(self):
return bool(self.values)
def __iter__(self):
return (k for k, v in self.values)
def add(self, name, value):
self.values.append((name, value))
def get(self, item, default=None):
for key, value in self.values:
if key == item:
return value
return default
def getall(self, item):
for key, value in self.values:
if key == item:
yield value
def items(self):
return iter(self.values)
class DocOption(object):
def __init__(self, tag, option):
self.tag = tag
self._array = []
self._dict = OrderedDict()
# (annotation option1=value1 option2=value2) etc
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 '<DocOption %r>' % (self._array, )
def length(self):
return len(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 GtkDocCommentBlockParser(object):
"""
GTK-Doc comment block parser.
Parses GTK-Doc comment blocks into a parse tree built out of :class:`DockBlock`,
:class:`DocTag`, :class:`DocAnnotations` and :class:`DocOption` objects. This
parser tries to accept malformed input whenever possible and does not emit
syntax errors. However, it does emit warnings at the slightest indication
of malformed input when possible. It is usually a good idea to heed these
warnings as malformed input is known to result in invalid GTK-Doc output.
A GTK-Doc comment block can be constructed out of multiple parts that can
be combined to write different types of documentation.
See `GTK-Doc's documentation`_ to learn more about possible valid combinations.
Each part can be further divided into fields which are separated by `:` characters.
Possible parts and the fields they are constructed from look like the
following (optional fields are enclosed in square brackets):
.. code-block:: c
/**
* identifier_name [:annotations]
* @parameter_name [:annotations] [:description]
*
* comment_block_description
* tag_name [:annotations] [:description]
*/
The order in which the different parts have to be specified is important::
- There has to be exactly 1 `identifier` part on the first line of the
comment block which consists of:
* an `identifier_name` field
* an optional `annotations` field
- Followed by 0 or more `parameters` parts, each consisting of:
* a `parameter_name` field
* an optional `annotations` field
* an optional `description` field
- Followed by at least 1 empty line signaling the beginning of
the `comment_block_description` part
- Followed by an optional `comment block description` part.
- Followed by 0 or more `tag` parts, each consisting of:
* a `tag_name` field
* an optional `annotations` field
* an optional `description` field
Additionally, the following restrictions are in effect::
- Parts can optionally be separated by an empty line, except between
the `parameter` parts and the `comment block description` part where
an empty line is required (see above).
- Parts and fields cannot span multiple lines, except for
`parameter descriptions`, `tag descriptions` and the
`comment_block_description` fields.
- `parameter descriptions` fields can not span multiple paragraphs.
- `tag descriptions` and `comment block description` fields can
span multiple paragraphs.
.. NOTE:: :class:`GtkDocCommentBlockParser` functionality is heavily based on gtkdoc-mkdb's
`ScanSourceFile()`_ function and is currently in sync with GTK-Doc
commit `47abcd5`_.
.. _GTK-Doc's documentation:
http://developer.gnome.org/gtk-doc-manual/1.18/documenting.html.en
.. _ScanSourceFile():
http://git.gnome.org/browse/gtk-doc/tree/gtkdoc-mkdb.in#n3722
.. _47abcd5: 47abcd53b8489ebceec9e394676512a181c1f1f6
"""
def parse_comment_blocks(self, comments):
'''
Parse multiple GTK-Doc comment blocks.
:param comments: an iterable of ``(comment, filename, lineno)`` tuples
:returns: a dictionary mapping identifier names to :class:`GtkDocCommentBlock` objects
'''
comment_blocks = {}
for (comment, filename, lineno) in comments:
try:
comment_block = self.parse_comment_block(comment, filename, lineno)
except Exception:
message.warn('unrecoverable parse error, please file a GObject-Introspection '
'bug report including the complete comment block at the '
'indicated location.', message.Position(filename, lineno))
continue
if comment_block is not None:
# Note: previous versions of this parser did not check
# if an identifier was already stored in comment_blocks,
# so when multiple comment blocks where encountered documenting
# the same identifier the last one seen "wins".
# Keep this behavior for backwards compatibility, but
# emit a warning.
if comment_block.name in comment_blocks:
message.warn("multiple comment blocks documenting '%s:' identifier." %
(comment_block.name, ),
comment_block.position)
comment_blocks[comment_block.name] = comment_block
return comment_blocks
def parse_comment_block(self, comment, filename, lineno):
'''
Parse a single GTK-Doc comment block.
:param comment: string representing the GTK-Doc comment block including it's
start ("``/**``") and end ("``*/``") tokens.
:param filename: source file name where the comment block originated from
:param lineno: line number in the source file where the comment block starts
:returns: a :class:`GtkDocCommentBlock` object or ``None``
'''
# Assign line numbers to each line of the comment block,
# which will later be used as the offset to calculate the
# real line number in the source file
comment_lines = list(enumerate(comment.split('\n')))
# Check for the start the comment block.
if COMMENT_START_RE.match(comment_lines[0][1]):
del comment_lines[0]
else:
# Not a GTK-Doc comment block.
return None
# Check for the end the comment block.
line_offset, line = comment_lines[-1]
result = COMMENT_END_RE.match(line)
if result:
description = result.group('description')
if description:
comment_lines[-1] = (line_offset, description)
position = message.Position(filename, lineno + line_offset)
marker = ' ' * result.end('description') + '^'
message.warn("Comments should end with */ on a new line:\n%s\n%s" %
(line, marker),
position)
else:
del comment_lines[-1]
else:
# Not a GTK-Doc comment block.
return None
# If we get this far, we must be inside something
# that looks like a GTK-Doc comment block.
return self._parse_comment_block(comment_lines, filename, lineno)
def _parse_comment_block(self, comment_lines, filename, lineno):
"""
Parses a single GTK-Doc comment block already stripped from its
comment start (/**) and comment end (*/) marker lines.
:param comment_lines: list of (line_offset, line) tuples representing a
GTK-Doc comment block already stripped from it's
start (/**) and end (*/) marker lines
:param filename: source file name where the comment block originated from
:param lineno: line in the source file where the comment block starts
:returns: a :class:`DocBlock` object or ``None``
.. NOTE:: If you are tempted to refactor this method and split it
further up (for example into _parse_identifier(), _parse_parameters(),
_parse_description(), _parse_tags() methods) then please resist the
urge. It is considered important that this method should be more or
less easily comparable with gtkdoc-mkdb's `ScanSourceFile()`_ function.
The different parsing steps are marked with a comment surrounded
by `#` characters in an attempt to make it clear what is going on.
.. _ScanSourceFile():
http://git.gnome.org/browse/gtk-doc/tree/gtkdoc-mkdb.in#n3722
"""
comment_block = None
part_indent = None
line_indent = None
in_part = None
identifier = None
current_param = None
current_tag = None
returns_seen = False
for line_offset, line in comment_lines:
position = message.Position(filename, line_offset + lineno)
# Store the original line (without \n) and column offset
# so we can generate meaningful warnings later on.
original_line = line
column_offset = 0
# Get rid of the ' * ' at the start of the line.
result = COMMENT_ASTERISK_RE.match(line)
if result:
column_offset = result.end(0)
line = line[result.end(0):]
# Store indentation level of the line.
result = COMMENT_INDENTATION_RE.match(line)
line_indent = len(result.group('indentation').replace('\t', ' '))
####################################################################
# Check for GTK-Doc comment block identifier.
####################################################################
if not comment_block:
if not identifier:
result = SECTION_RE.match(line)
if result:
identifier = IDENTIFIER_SECTION
identifier_name = 'SECTION:%s' % (result.group('section_name'), )
column = result.start('section_name') + column_offset
if not identifier:
result = SYMBOL_RE.match(line)
if result:
identifier = IDENTIFIER_SYMBOL
identifier_name = '%s' % (result.group('symbol_name'), )
column = result.start('symbol_name') + column_offset
if not identifier:
result = PROPERTY_RE.match(line)
if result:
identifier = IDENTIFIER_PROPERTY
identifier_name = '%s:%s' % (result.group('class_name'),
result.group('property_name'))
column = result.start('property_name') + column_offset
if not identifier:
result = SIGNAL_RE.match(line)
if result:
identifier = IDENTIFIER_SIGNAL
identifier_name = '%s::%s' % (result.group('class_name'),
result.group('signal_name'))
column = result.start('signal_name') + column_offset
if identifier:
in_part = PART_IDENTIFIER
part_indent = line_indent
comment_block = DocBlock(identifier_name)
comment_block.position = position
if 'delimiter' in result.groupdict() and result.group('delimiter') != ':':
delimiter_start = result.start('delimiter')
delimiter_column = column_offset + delimiter_start
marker = ' ' * delimiter_column + '^'
message.warn("missing ':' at column %s:\n%s\n%s" %
(delimiter_column + 1, original_line, marker),
position)
if 'annotations' in result.groupdict():
comment_block.annotations = self.parse_annotations(comment_block,
result.group('annotations'))
continue
else:
# If we get here, the identifier was not recognized, so
# ignore the rest of the block just like the old annotation
# parser did. Doing this is a bit more strict than
# gtkdoc-mkdb (which continues to search for the identifier
# until either it is found or the end of the block is
# reached). In practice, however, ignoring the block is the
# right thing to do because sooner or later some long
# descriptions will contain something matching an identifier
# pattern by accident.
marker = ' ' * column_offset + '^'
message.warn('ignoring unrecognized GTK-Doc comment block, identifier not '
'found:\n%s\n%s' % (original_line, marker),
position)
return None
####################################################################
# Check for comment block parameters.
####################################################################
result = PARAMETER_RE.match(line)
if result:
param_name = result.group('parameter_name')
param_annotations = result.group('annotations')
param_description = result.group('description')
if in_part == PART_IDENTIFIER:
in_part = PART_PARAMETERS
part_indent = line_indent
if in_part != PART_PARAMETERS:
column = result.start('parameter_name') + column_offset
marker = ' ' * column + '^'
message.warn("'@%s' parameter unexpected at this location:\n%s\n%s" %
(param_name, original_line, marker),
position)
# Old style GTK-Doc allowed return values to be specified as
# parameters instead of tags.
if param_name.lower() == TAG_RETURNS:
param_name = TAG_RETURNS
if not returns_seen:
returns_seen = True
else:
message.warn("encountered multiple 'Returns' parameters or tags for "
"'%s'." % (comment_block.name, ),
position)
elif param_name in comment_block.params.keys():
column = result.start('parameter_name') + column_offset
marker = ' ' * column + '^'
message.warn("multiple '@%s' parameters for identifier '%s':\n%s\n%s" %
(param_name, comment_block.name, original_line, marker),
position)
tag = DocTag(comment_block, param_name)
tag.position = position
tag.description = param_description
if param_annotations:
tag.annotations = self.parse_annotations(tag, param_annotations)
if param_name == TAG_RETURNS:
comment_block.tags[param_name] = tag
else:
comment_block.params[param_name] = tag
current_param = tag
continue
####################################################################
# Check for comment block description.
#
# When we are parsing comment block parameters or the comment block
# identifier (when there are no parameters) and encounter an empty
# line, we must be parsing the comment block description.
####################################################################
if (EMPTY_LINE_RE.match(line) and in_part in [PART_IDENTIFIER, PART_PARAMETERS]):
in_part = PART_DESCRIPTION
part_indent = line_indent
continue
####################################################################
# Check for GTK-Doc comment block tags.
####################################################################
result = TAG_RE.match(line)
if result and line_indent <= part_indent:
tag_name = result.group('tag_name')
tag_annotations = result.group('annotations')
tag_description = result.group('description')
marker = ' ' * (result.start('tag_name') + column_offset) + '^'
# Deprecated GTK-Doc Description: tag
if tag_name.lower() == TAG_DESCRIPTION:
message.warn("GTK-Doc tag \"Description:\" has been deprecated:\n%s\n%s" %
(original_line, marker),
position)
in_part = PART_DESCRIPTION
part_indent = line_indent
if not comment_block.description:
comment_block.description = tag_description
else:
comment_block.description += '\n' + tag_description
continue
# Now that the deprecated stuff is out of the way, continue parsing real tags
if in_part == PART_DESCRIPTION:
in_part = PART_TAGS
part_indent = line_indent
if in_part != PART_TAGS:
column = result.start('tag_name') + column_offset
marker = ' ' * column + '^'
message.warn("'%s:' tag unexpected at this location:\n%s\n%s" %
(tag_name, original_line, marker),
position)
if tag_name.lower() in [TAG_RETURNS, TAG_RETURNVALUE]:
if not returns_seen:
returns_seen = True
else:
message.warn("encountered multiple 'Returns' parameters or tags for "
"'%s'." % (comment_block.name, ),
position)
tag = DocTag(comment_block, TAG_RETURNS)
tag.position = position
tag.description = tag_description
if tag_annotations:
tag.annotations = self.parse_annotations(tag, tag_annotations)
comment_block.tags[TAG_RETURNS] = tag
current_tag = tag
continue
else:
if tag_name.lower() in comment_block.tags.keys():
column = result.start('tag_name') + column_offset
marker = ' ' * column + '^'
message.warn("multiple '%s:' tags for identifier '%s':\n%s\n%s" %
(tag_name, comment_block.name, original_line, marker),
position)
tag = DocTag(comment_block, tag_name.lower())
tag.position = position
tag.value = tag_description
if tag_annotations:
if tag_name.lower() == TAG_ATTRIBUTES:
tag.annotations = self.parse_annotations(tag, tag_annotations)
else:
message.warn("annotations not supported for tag '%s:'." %
(tag_name, ),
position)
comment_block.tags[tag_name.lower()] = tag
current_tag = tag
continue
####################################################################
# If we get here, we must be in the middle of a multiline
# comment block, parameter or tag description.
####################################################################
if in_part in [PART_IDENTIFIER, PART_DESCRIPTION]:
if not comment_block.description:
comment_block.description = line
else:
comment_block.description += '\n' + line
continue
elif in_part == PART_PARAMETERS:
self._validate_multiline_annotation_continuation(line, original_line,
column_offset, position)
# Append to parameter description.
current_param.description += ' ' + line.strip()
continue
elif in_part == PART_TAGS:
self._validate_multiline_annotation_continuation(line, original_line,
column_offset, position)
# Append to tag description.
if current_tag.name.lower() in [TAG_RETURNS, TAG_RETURNVALUE]:
current_tag.description += ' ' + line.strip()
else:
current_tag.value += ' ' + line.strip()
continue
########################################################################
# Finished parsing this comment block.
########################################################################
if comment_block:
# We have picked up a couple of \n characters that where not
# intended. Strip those.
if comment_block.description:
comment_block.description = comment_block.description.strip()
for tag in comment_block.tags.values():
self._clean_comment_block_part(tag)
for param in comment_block.params.values():
self._clean_comment_block_part(param)
# Validate and store block.
comment_block.validate()
return comment_block
else:
return None
def _clean_comment_block_part(self, part):
if part.description:
part.description = part.description.strip()
else:
part.description = None
if part.value:
part.value = part.value.strip()
else:
part.value = ''
def _validate_multiline_annotation_continuation(self, line, original_line,
column_offset, position):
'''
Validate parameters and tags (except the first line) and generate
warnings about invalid annotations spanning multiple lines.
:param line: line to validate, stripped from ' * ' at start of the line.
:param original_line: original line to validate (used in warning messages)
:param column_offset: column width of ' * ' at the time it was stripped from `line`
:param position: position of `line` in the source file
'''
result = MULTILINE_ANNOTATION_CONTINUATION_RE.match(line)
if result:
column = result.start('annotations') + column_offset
marker = ' ' * column + '^'
message.warn('ignoring invalid multiline annotation continuation:\n'
'%s\n%s' % (original_line, marker),
position)
@classmethod
def parse_annotations(cls, tag, value):
# (annotation)
# (annotation opt1 opt2 ...)
# (annotation opt1=value1 opt2=value2 ...)
opened = -1
annotations = DocAnnotations()
annotations.position = tag.position
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 = DocOption(tag, option)
annotations.add(name, option)
opened = -1
return annotations
|