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
|
#---------------------------------------------------------------------------
# Name: etg/windowid.py
# Author: Robin Dunn
#
# Created: 15-Nov-2010
# Copyright: (c) 2010-2020 by Total Control Software
# License: wxWindows License
#---------------------------------------------------------------------------
import etgtools
import etgtools.tweaker_tools as tools
from etgtools import ClassDef, MethodDef, ParamDef
PACKAGE = "wx"
MODULE = "_core"
NAME = "windowid" # Base name of the file to generate to for this script
DOCSTRING = ""
# The classes and/or the basename of the Doxygen XML files to be processed by
# this script.
ITEMS = [ 'wxIdManager' ]
#---------------------------------------------------------------------------
def run():
# Parse the XML file(s) building a collection of Extractor objects
module = etgtools.ModuleDef(PACKAGE, MODULE, NAME, DOCSTRING)
etgtools.parseDoxyXML(module, ITEMS)
#-----------------------------------------------------------------
# Tweak the parsed meta objects in the module object as needed for
# customizing the generated code and docstrings.
c = module.find('wxIdManager')
assert isinstance(c, etgtools.ClassDef)
# no tweaks needed for this class
# wxWindowIDRef is not documented (and probably rightly so) but we're going
# to use it from Python anyway to help with preallocating IDs in a way that
# allows them to be reused and be also be protected from conflicts from
# other auto allocated IDs.
# First, add definitions of the existing C++ class and its elements
klass = ClassDef(name='wxWindowIDRef', bases = [],
briefDoc="""\
A wxWindowIDRef object wraps an ID value and marks it as being in-use until all references to that ID are gone.
""",
items = [
MethodDef(name='wxWindowIDRef', className='wxWindowIDRef', isCtor=True,
briefDoc='Default constructor',
overloads=[
MethodDef(name='wxWindowIDRef', className='wxWindowIDRef', isCtor=True,
briefDoc='Create reference from an ID',
items=[ ParamDef(type='int', name='id') ]),
MethodDef(name='wxWindowIDRef', className='wxWindowIDRef', isCtor=True,
briefDoc='Copy an ID reference',
items=[ ParamDef(type='const wxWindowIDRef&', name='idref') ]),
]),
MethodDef(name='~wxWindowIDRef', className='wxWindowIDRef', isDtor=True),
MethodDef(type='int', name='GetValue',
briefDoc='Get the ID value'),
])
# Now tweak it a bit
klass.addCppMethod('int', 'GetId', '()',
doc="Alias for GetValue allowing the IDRef to be passed as the source parameter to :meth:`wx.EvtHandler.Bind`.",
body="""\
return self->GetValue();
""")
klass.addCppMethod('int', '__int__', '()',
doc="Alias for GetValue allowing the IDRef to be passed as the WindowID parameter when creating widgets or other places an integer type is needed.",
body="return self->GetValue();")
klass.addCppMethod('int', '__index__', '()',
doc="See :meth:`__int__`",
body="return self->GetValue();")
klass.addCppMethod('bool', '__eq__', '(wxWindowID id)', "return self->GetValue() == id;")
klass.addCppMethod('bool', '__ne__', '(wxWindowID id)', "return self->GetValue() != id;")
klass.addCppMethod('bool', '__lt__', '(wxWindowID id)', "return self->GetValue() < id;")
klass.addCppMethod('bool', '__gt__', '(wxWindowID id)', "return self->GetValue() > id;")
klass.addCppMethod('bool', '__le__', '(wxWindowID id)', "return self->GetValue() <= id;")
klass.addCppMethod('bool', '__ge__', '(wxWindowID id)', "return self->GetValue() >= id;")
klass.addPyMethod('__repr__', '(self)', 'return "WindowIDRef: {}".format(self.GetId())')
klass.addPyMethod('__hash__', '(self)', 'return hash(self.GetValue())')
# and finish it up by adding it to the module
module.addItem(klass)
# Now, let's add a new Python function to the global scope that reserves an
# ID (or range) and returns a ref object for it.
module.addPyFunction('NewIdRef', '(count=1)',
doc="""\
Reserves a new Window ID (or range of WindowIDs) and returns a
:class:`wx.WindowIDRef` object (or list of them) that will help
manage the reservation of that ID.
This function is intended to be a drop-in replacement of the old
and deprecated :func:`wx.NewId` function, with the added benefit
that the ID should never conflict with an in-use ID or other IDs
generated by this function.
""",
body="""\
if count == 1:
return WindowIDRef(IdManager.ReserveId())
else:
start = IdManager.ReserveId(count)
IDRefs = []
for id in range(start, start+count):
IDRefs.append(WindowIDRef(id))
return IDRefs
""")
#-----------------------------------------------------------------
tools.doCommonTweaks(module)
tools.runGenerators(module)
#---------------------------------------------------------------------------
if __name__ == '__main__':
run()
|
