forked from robotpy/robotpy-cppheaderparser
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCppHeaderParser.py
More file actions
3781 lines (3280 loc) · 134 KB
/
CppHeaderParser.py
File metadata and controls
3781 lines (3280 loc) · 134 KB
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
#!/usr/bin/python
#
# Author: Jashua R. Cloutier (contact via https://bitbucket.org/senex)
# Project: http://senexcanis.com/open-source/cppheaderparser/
#
# Copyright (C) 2011, Jashua R. Cloutier
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in
# the documentation and/or other materials provided with the
# distribution.
#
# * Neither the name of Jashua R. Cloutier nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission. Stories,
# blog entries etc making reference to this project may mention the
# name Jashua R. Cloutier in terms of project originator/creator etc.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
#
# The CppHeaderParser.py script is written in Python 2.4 and released to
# the open source community for continuous improvements under the BSD
# 2.0 new license, which can be found at:
#
# http://www.opensource.org/licenses/bsd-license.php
#
from __future__ import print_function
from collections import deque
import os
import sys
import re
import io
import inspect
from .lexer import Lexer
from .doxygen import extract_doxygen_method_params
try:
from .version import __version__
except ImportError:
__version__ = "devel"
version = __version__
# Controls error_print
print_errors = 1
# Controls warning_print
print_warnings = 1
# Controls debug_print
debug = 1 if os.environ.get("CPPHEADERPARSER_DEBUG") == "1" else 0
# Controls trace_print
debug_trace = 0
if sys.version_info >= (3, 3):
# `raise e from src_e` syntax only supported on python 3.3+
exec("def raise_exc(e, src_e): raise e from src_e", globals())
else:
def raise_exc(e, src_e):
raise e
def error_print(fmt, *args):
if print_errors:
fmt = "[%4d] " + fmt
args = (inspect.currentframe().f_back.f_lineno,) + args
print(fmt % args)
def warning_print(fmt, *args):
if print_warnings:
fmt = "[%4d] " + fmt
args = (inspect.currentframe().f_back.f_lineno,) + args
print(fmt % args)
if debug:
class _debug_caller_lineno:
def __str__(self):
return str(inspect.currentframe().f_back.f_back.f_back.f_lineno)
debug_caller_lineno = _debug_caller_lineno()
def debug_print(fmt, *args):
fmt = "[%4d] " + fmt
args = (inspect.currentframe().f_back.f_lineno,) + args
print(fmt % args)
else:
debug_caller_lineno = None
def debug_print(fmt, *args):
pass
if debug_trace:
def trace_print(*args):
sys.stdout.write("[%s]" % (inspect.currentframe().f_back.f_lineno))
for a in args:
sys.stdout.write(" %s" % a)
sys.stdout.write("\n")
else:
def trace_print(*args):
pass
#: Access specifiers
supportedAccessSpecifier = ["public", "protected", "private"]
#: Symbols to ignore, usually special macros
ignoreSymbols = ["Q_OBJECT"]
# Track what was added in what order and at what depth
parseHistory = []
def is_namespace(nameStack):
"""Determines if a namespace is being specified"""
if len(nameStack) == 0:
return False
if nameStack[0] == "namespace":
return True
return False
_fundamentals = {
"size_t",
"struct",
"union",
"unsigned",
"signed",
"bool",
"char",
"short",
"int",
"float",
"double",
"long",
"void",
"*",
}
def is_fundamental(s):
for a in s.split():
if a not in _fundamentals:
return False
return True
def is_function_pointer_stack(stack):
"""Count how many non-nested paranthesis are in the stack. Useful for determining if a stack is a function pointer"""
paren_depth = 0
paren_count = 0
star_after_first_paren = False
last_e = None
for e in stack:
if e == "(":
paren_depth += 1
elif e == ")" and paren_depth > 0:
paren_depth -= 1
if paren_depth == 0:
paren_count += 1
elif e == "*" and last_e == "(" and paren_count == 0 and paren_depth == 1:
star_after_first_paren = True
last_e = e
if star_after_first_paren and paren_count == 2:
return True
else:
return False
def is_method_namestack(stack):
r = False
if "(" not in stack:
r = False
elif stack[0] == "typedef":
r = False # TODO deal with typedef function prototypes
# elif '=' in stack and stack.index('=') < stack.index('(') and stack[stack.index('=')-1] != 'operator': r = False #disabled July6th - allow all operators
elif "operator" in stack:
r = True # allow all operators
elif "{" in stack and stack.index("{") < stack.index("("):
r = False # struct that looks like a method/class
elif "(" in stack and ")" in stack:
if stack[-1] == ":":
r = True
elif "{" in stack and "}" in stack:
r = True
elif stack[-1] == ";":
if is_function_pointer_stack(stack):
r = False
else:
r = True
elif "{" in stack:
r = True # ideally we catch both braces... TODO
else:
r = False
# Test for case of property set to something with parens such as "static const int CONST_A = (1 << 7) - 1;"
if r and "(" in stack and "=" in stack and "operator" not in stack:
if stack.index("=") < stack.index("("):
r = False
return r
def is_property_namestack(nameStack):
r = False
if "(" not in nameStack and ")" not in nameStack:
r = True
elif (
"(" in nameStack
and "=" in nameStack
and nameStack.index("=") < nameStack.index("(")
):
r = True
# See if we are a function pointer
if not r and is_function_pointer_stack(nameStack):
r = True
return r
def is_enum_namestack(nameStack):
"""Determines if a namestack is an enum namestack"""
if not nameStack:
return False
if nameStack[0] == "enum":
return True
if len(nameStack) > 1 and nameStack[0] == "typedef" and nameStack[1] == "enum":
return True
return False
def set_location_info(thing, location):
filename, line_number = location
if filename:
thing["filename"] = filename
thing["line_number"] = line_number
_nhack = re.compile(r"[A-Za-z_][A-Za-z0-9_]*")
def _split_namespace(namestack):
"""
Given a list of name elements, find the namespace portion
and return that as a string
:rtype: Tuple[str, list]
"""
# TODO: this should be using tokens instead of nhack
typename = None
if namestack and namestack[0] == "typename":
typename = namestack[0]
namestack = namestack[1:]
last_colon = None
for i, n in enumerate(namestack):
if n == "::":
last_colon = i
if i and n != "::" and not _nhack.match(n):
break
if last_colon:
ns, namestack = (
"".join(namestack[: last_colon + 1]),
namestack[last_colon + 1 :],
)
else:
ns = ""
if typename:
namestack = [typename] + namestack
return ns, namestack
def _iter_ns_str_reversed(namespace):
"""
Take a namespace string, and yield successively smaller portions
of it (ex foo::bar::baz::, foo::bar::, foo::). The last item yielded
will always be an empty string
"""
if namespace:
parts = namespace.split("::")
for i in range(len(parts) - 1, 0, -1):
yield "::".join(parts[:i]) + "::"
yield ""
def _split_by_comma(namestack):
while namestack:
if "," not in namestack:
yield namestack
break
idx = namestack.index(",")
ns = namestack[:idx]
yield ns
namestack = namestack[idx + 1 :]
class TagStr(str):
"""Wrapper for a string that allows us to store the line number associated with it"""
def __new__(cls, *args, **kwargs):
location = kwargs.pop("location")
s = str.__new__(cls, *args, **kwargs)
s.location = location
return s
class CppParseError(Exception):
def __init__(self, msg, tok=None):
Exception.__init__(self, msg)
self.tok = tok
class CppTemplateParam(dict):
"""
Dictionary that contains the following:
- ``decltype`` - If True, this is a decltype
- ``param`` - Parameter value or typename
- ``params`` - Only present if a template specialization. Is a list of
:class:`.CppTemplateParam`
- ``...`` - If True, indicates a parameter pack
"""
def __init__(self):
self["param"] = ""
self["decltype"] = False
self["..."] = False
def __str__(self):
s = []
if self["decltype"]:
s.append("decltype")
s.append(self["param"])
params = self.get("params")
if params is not None:
s.append("<%s>" % ",".join(str(p) for p in params))
if self["..."]:
if s:
s[-1] = s[-1] + "..."
else:
s.append("...")
return "".join(s)
class CppBaseDecl(dict):
"""
Dictionary that contains the following
- ``access`` - Anything in supportedAccessSpecifier
- ``class`` - Name of the type, along with template specializations
- ``decl_name`` - Name of the type only
- ``decl_params`` - Only present if a template specialization (Foo<int>).
Is a list of :class:`.CppTemplateParam`.
- ``decltype`` - True/False indicates a decltype, the contents are in
``decl_name``
- ``virtual`` - True/False indicates virtual inheritance
- ``...`` - True/False indicates a parameter pack
"""
def __init__(self, default_access):
self["access"] = default_access
self["class"] = ""
self["decl_name"] = ""
self["decltype"] = False
self["virtual"] = False
self["..."] = False
def _fix_classname(self):
# set class to the full decl for legacy reasons
params = self.get("decl_params")
if self["decltype"]:
s = "decltype"
else:
s = ""
s += self["decl_name"]
if params:
s += "<%s>" % (",".join(str(p) for p in params))
if self["..."]:
s += "..."
return s
def _consume_parens(stack):
i = 0
sl = len(stack)
nested = 1
while i < sl:
t = stack[i]
i += 1
if t == ")":
nested -= 1
if nested == 0:
return i
elif t == "(":
nested += 1
raise CppParseError("Unmatched (")
def _parse_template_decl(stack):
debug_print("_parse_template_decl: %s", stack)
params = []
param = CppTemplateParam()
i = 0
sl = len(stack)
init = True
require_ending = False
while i < sl:
t = stack[i]
i += 1
if init:
init = False
if t == "decltype":
param["decltype"] = True
continue
if t == ",":
params.append(param)
init = True
require_ending = False
param = CppTemplateParam()
continue
elif t == ">":
params.append(param)
return params, i - 1
if require_ending:
raise CppParseError("expected comma, found %s" % t)
if t == "...":
param["..."] = True
require_ending = True
elif t == "(":
s = stack[i:]
n = _consume_parens(s)
i += n
param["param"] = param["param"] + "".join(s[:n])
else:
if t and t[0] == "<":
param["params"], n = _parse_template_decl([t[1:]] + stack[i:])
i += n
else:
param["param"] = param["param"] + t
raise CppParseError("Unmatched <")
def _parse_cppclass_name(c, stack):
# ignore first thing
i = 1
sl = len(stack)
name = ""
require_ending = False
while i < sl:
t = stack[i]
i += 1
if t == ":":
if i >= sl:
raise CppParseError("class decl ended with ':'")
break
elif t == "::":
name += "::"
continue
elif t == "final":
c["final"] = True
continue
if require_ending:
raise CppParseError("Unexpected '%s' in class" % ("".join(stack[i - 1 :])))
if t and t[0] == "<":
c["class_params"], n = _parse_template_decl([t[1:]] + stack[i:])
i += n
require_ending = True
else:
name += t
c["namespace"] = ""
# backwards compat
if name.startswith("anon-"):
if (
name.startswith("anon-class-")
or name.startswith("anon-struct-")
or name.startswith("anon-union-")
):
name = "<" + name + ">"
c["name"] = name
c["bare_name"] = name
debug_print("Found class '%s'", name)
# backwards compat
classParams = c.get("class_params")
if classParams is not None:
c["name"] = c["name"] + "<%s>" % ",".join(str(p) for p in classParams)
return i
def _parse_cpp_base(stack, default_access):
debug_print("Parsing base: %s (access %s)", stack, default_access)
inherits = []
i = 0
sl = len(stack)
init = True
base = CppBaseDecl(default_access)
require_ending = False
while i < sl:
t = stack[i]
i += 1
if init:
if t in supportedAccessSpecifier:
base["access"] = t
continue
elif t == "virtual":
base["virtual"] = True
continue
init = False
if t == "decltype":
base["decltype"] = True
continue
if t == ",":
inherits.append(base)
base = CppBaseDecl(default_access)
init = True
require_ending = False
continue
if require_ending:
if t == "::":
if "decl_params" in base:
base["decl_name"] = base._fix_classname()
del base["decl_params"]
base["..."]
require_ending = False
else:
raise CppParseError("expected comma, found '%s'" % t)
if t == "(":
s = stack[i:]
n = _consume_parens(s)
i += n
base["decl_name"] = base["decl_name"] + "".join(s[:n])
elif t == "...":
base["..."] = True
require_ending = True
else:
if t[0] == "<":
base["decl_params"], n = _parse_template_decl([t[1:]] + stack[i:])
i += n
require_ending = True
else:
base["decl_name"] = base["decl_name"] + t
# backwards compat
inherits.append(base)
for base in inherits:
base["class"] = base._fix_classname()
return inherits
class CppClass(dict):
"""
Dictionary that contains at least the following keys:
* ``name`` - Name of the class
* ``doxygen`` - Doxygen comments associated with the class if they exist
* ``inherits`` - List of Classes that this one inherits. Values are
:class:`.CppBaseDecl`
* ``methods`` - Dictionary where keys are from supportedAccessSpecifier
and values are a lists of :class:`.CppMethod`
* ``namespace`` - Namespace of class
* ``properties`` - Dictionary where keys are from supportedAccessSpecifier
and values are lists of :class:`.CppVariable`
* ``enums`` - Dictionary where keys are from supportedAccessSpecifier and
values are lists of :class:`.CppEnum`
* ``nested_classes`` - Classes and structs defined within this class
* ``final`` - True if final
* ``abstract`` - True if abstract
* ``using`` - Using directives in this class scope: key is name for lookup,
value is :class:`.CppVariable`
* ``parent`` - If not None, the class that this class is nested in
An example of how this could look is as follows::
{
'name': ""
'inherits':[]
'methods':
{
'public':[],
'protected':[],
'private':[]
},
'properties':
{
'public':[],
'protected':[],
'private':[]
},
'enums':
{
'public':[],
'protected':[],
'private':[]
}
}
"""
def get_all_methods(self):
r = []
for typ in supportedAccessSpecifier:
r += self["methods"][typ]
return r
def get_all_method_names(self):
r = []
for typ in supportedAccessSpecifier:
r += self.get_method_names(typ) # returns list
return r
def get_all_pure_virtual_methods(self):
r = {}
for typ in supportedAccessSpecifier:
r.update(self.get_pure_virtual_methods(typ)) # returns dict
return r
def get_method_names(self, type="public"):
return [meth["name"] for meth in self["methods"][type]]
def get_pure_virtual_methods(self, type="public"):
r = {}
for meth in self["methods"][type]:
if meth["pure_virtual"]:
r[meth["name"]] = meth
return r
def _lookup_type(self, name):
# TODO: should have indexes for these lookups... and they
# should be more unified
for access in supportedAccessSpecifier:
for e in self["enums"][access]:
if e.get("name") == name:
return {
"enum": self["name"] + "::" + e["name"],
"type": e["name"],
"namespace": e["namespace"],
}
for n in self["nested_classes"]:
if n["name"] == name:
return {"raw_type": self["name"] + "::" + n["name"], "type": n["name"]}
def __init__(self, nameStack, curTemplate, doxygen, location, defaultAccess):
self["nested_classes"] = []
self["parent"] = None
self["abstract"] = False
self["final"] = False
self._public_enums = {}
self._public_typedefs = {}
self._public_forward_declares = []
self["namespace"] = ""
self["using"] = {}
debug_print("Class: %s", nameStack)
debug_print("Template: %s", curTemplate)
if len(nameStack) < 2:
nameStack.insert(1, "") # anonymous struct
if doxygen:
self["doxygen"] = doxygen
# consume name of class, with any namespaces or templates
n = _parse_cppclass_name(self, nameStack)
# consume bases
baseStack = nameStack[n:]
if baseStack:
self["inherits"] = _parse_cpp_base(baseStack, defaultAccess)
else:
self["inherits"] = []
set_location_info(self, location)
if curTemplate:
self["template"] = curTemplate
trace_print("Setting template to", self["template"])
methodAccessSpecificList = {}
propertyAccessSpecificList = {}
enumAccessSpecificList = {}
typedefAccessSpecificList = {}
forwardAccessSpecificList = {}
for accessSpecifier in supportedAccessSpecifier:
methodAccessSpecificList[accessSpecifier] = []
propertyAccessSpecificList[accessSpecifier] = []
enumAccessSpecificList[accessSpecifier] = []
typedefAccessSpecificList[accessSpecifier] = []
forwardAccessSpecificList[accessSpecifier] = []
self["methods"] = methodAccessSpecificList
self["properties"] = propertyAccessSpecificList
self["enums"] = enumAccessSpecificList
self["typedefs"] = typedefAccessSpecificList
self["forward_declares"] = forwardAccessSpecificList
def show(self):
"""Convert class to a string"""
namespace_prefix = ""
if self["namespace"]:
namespace_prefix = self["namespace"] + "::"
rtn = "%s %s" % (self["declaration_method"], namespace_prefix + self["name"])
if self["final"]:
rtn += " final"
if self["abstract"]:
rtn += " (abstract)\n"
else:
rtn += "\n"
if "doxygen" in list(self.keys()):
rtn += self["doxygen"] + "\n"
if "parent" in list(self.keys()) and self["parent"]:
rtn += "parent class: " + self["parent"]["name"] + "\n"
if "inherits" in list(self.keys()):
rtn += " Inherits: "
for inheritClass in self["inherits"]:
if inheritClass["virtual"]:
rtn += "virtual "
rtn += "%s %s, " % (inheritClass["access"], inheritClass["class"])
rtn += "\n"
rtn += " {\n"
for accessSpecifier in supportedAccessSpecifier:
rtn += " %s\n" % (accessSpecifier)
# Enums
if len(self["enums"][accessSpecifier]):
rtn += " <Enums>\n"
for enum in self["enums"][accessSpecifier]:
rtn += " %s\n" % (repr(enum))
# Properties
if len(self["properties"][accessSpecifier]):
rtn += " <Properties>\n"
for property in self["properties"][accessSpecifier]:
rtn += " %s\n" % (repr(property))
# Methods
if len(self["methods"][accessSpecifier]):
rtn += " <Methods>\n"
for method in self["methods"][accessSpecifier]:
rtn += "\t\t" + method.show() + "\n"
rtn += " }\n"
print(rtn)
def __str__(self):
"""Convert class to a string"""
namespace_prefix = ""
if self["namespace"]:
namespace_prefix = self["namespace"] + "::"
rtn = "%s %s" % (self["declaration_method"], namespace_prefix + self["name"])
if self["final"]:
rtn += " final"
if self["abstract"]:
rtn += " (abstract)\n"
else:
rtn += "\n"
if "doxygen" in list(self.keys()):
rtn += self["doxygen"] + "\n"
if "parent" in list(self.keys()) and self["parent"]:
rtn += "parent class: " + self["parent"]["name"] + "\n"
if "inherits" in list(self.keys()) and len(self["inherits"]):
rtn += "Inherits: "
for inheritClass in self["inherits"]:
if inheritClass.get("virtual", False):
rtn += "virtual "
rtn += "%s %s, " % (inheritClass["access"], inheritClass["class"])
rtn += "\n"
rtn += "{\n"
for accessSpecifier in supportedAccessSpecifier:
rtn += "%s\n" % (accessSpecifier)
# Enums
if len(self["enums"][accessSpecifier]):
rtn += " // Enums\n"
for enum in self["enums"][accessSpecifier]:
rtn += " %s\n" % (repr(enum))
# Properties
if len(self["properties"][accessSpecifier]):
rtn += " // Properties\n"
for property in self["properties"][accessSpecifier]:
rtn += " %s\n" % (repr(property))
# Methods
if len(self["methods"][accessSpecifier]):
rtn += " // Methods\n"
for method in self["methods"][accessSpecifier]:
rtn += " %s\n" % (repr(method))
rtn += "}\n"
return rtn
class CppUnion(CppClass):
"""
Dictionary that contains at least the following keys:
* ``name`` - Name of the union
* ``doxygen`` - Doxygen comments associated with the union if they exist
* ``members`` - List of members of the union
"""
def __init__(self, nameStack, doxygen, location):
CppClass.__init__(self, nameStack, None, doxygen, location, "public")
self["members"] = self["properties"]["public"]
def transform_to_union_keys(self):
print("union keys: %s" % list(self.keys()))
for key in [
"inherits",
"parent",
"abstract",
"namespace",
"typedefs",
"methods",
]:
del self[key]
def show(self):
"""Convert class to a string"""
print(self)
def __str__(self):
"""Convert class to a string"""
namespace_prefix = ""
if self["namespace"]:
namespace_prefix = self["namespace"] + "::"
rtn = "%s %s" % (self["declaration_method"], namespace_prefix + self["name"])
if self["abstract"]:
rtn += " (abstract)\n"
else:
rtn += "\n"
if "doxygen" in list(self.keys()):
rtn += self["doxygen"] + "\n"
if "parent" in list(self.keys()) and self["parent"]:
rtn += "parent class: " + self["parent"]["name"] + "\n"
rtn += "{\n"
for member in self["members"]:
rtn += " %s\n" % (repr(member))
rtn += "}\n"
return rtn
class _CppMethod(dict):
def _params_helper1(self, stack):
# deal with "throw" keyword
if "throw" in stack:
stack = stack[: stack.index("throw")]
## remove GCC keyword __attribute__(...) and preserve returns ##
cleaned = []
hit = False
hitOpen = 0
hitClose = 0
for a in stack:
if a == "__attribute__":
hit = True
if hit:
if a == "(":
hitOpen += 1
elif a == ")":
hitClose += 1
if a == ")" and hitOpen == hitClose:
hit = False
else:
cleaned.append(a)
stack = cleaned
# also deal with attribute((const)) function prefix #
# TODO this needs to be better #
if len(stack) > 5:
a = "".join(stack)
if a.startswith("((__const__))"):
stack = stack[5:]
elif a.startswith("__attribute__((__const__))"):
stack = stack[6:]
stack = stack[stack.index("(") + 1 :]
if not stack:
return []
if (
len(stack) >= 3 and stack[0] == ")" and stack[1] == ":"
): # is this always a constructor?
self["constructor"] = True
return []
stack.reverse()
_end_ = stack.index(")")
stack.reverse()
stack = stack[: len(stack) - (_end_ + 1)]
if "(" not in stack:
return stack # safe to return, no defaults that init a class
return stack
def _params_helper2(self, params):
for p in params:
p["method"] = self # save reference in variable to parent method
p["parent"] = self
if "::" in p["type"]:
ns = p["type"].split("::")[0]
if ns not in Resolver.NAMESPACES and ns in Resolver.CLASSES:
p["type"] = self["namespace"] + p["type"]
else:
p["namespace"] = self["namespace"]
class CppMethod(_CppMethod):
"""
Dictionary that contains at least the following keys:
* ``rtnType`` - Return type of the method (ex. "int")
* ``name`` - Name of the method
* ``doxygen`` - Doxygen comments associated with the method if they exist
* ``parameters`` - List of :class:`.CppVariable`
* ``parent`` - If not None, the class this method belongs to
"""
def show(self):
r = ["method name: %s (%s)" % (self["name"], self["debug"])]
if self["returns"]:
r.append("returns: %s" % self["returns"])
if self["parameters"]:
r.append("number arguments: %s" % len(self["parameters"]))
if self["pure_virtual"]:
r.append("pure virtual: %s" % self["pure_virtual"])
if self["constructor"]:
r.append("constructor")
if self["destructor"]:
r.append("destructor")
return "\n\t\t ".join(r)
def __init__(self, nameStack, curClass, methinfo, curTemplate, doxygen, location):
debug_print("Method: %s", nameStack)
debug_print("Template: %s", curTemplate)
if doxygen:
self["doxygen"] = doxygen