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
|
#---------------------------------------------------------------------------
# Name: etg/utils.py
# Author: Robin Dunn
#
# Created: 19-Dec-2010
# Copyright: (c) 2010-2020 by Total Control Software
# License: wxWindows License
#---------------------------------------------------------------------------
import etgtools
import etgtools.tweaker_tools as tools
PACKAGE = "wx"
MODULE = "_core"
NAME = "utils" # 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 = [ 'utils_8h.xml',
'wxWindowDisabler',
'wxBusyCursor',
'wxVersionInfo',
]
#---------------------------------------------------------------------------
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.
module.addHeaderCode('#include <wx/utils.h>')
module.addHeaderCode('#include <wx/power.h>')
c = module.find('wxWindowDisabler')
assert isinstance(c, etgtools.ClassDef)
c.mustHaveApp()
c.addPrivateCopyCtor()
# add context manager methods
c.addPyMethod('__enter__', '(self)', 'return self')
c.addPyMethod('__exit__', '(self, exc_type, exc_val, exc_tb)', 'pass')
module.find('wxQsort').ignore()
module.find('wxGetEmailAddress').findOverload('buf').ignore()
module.find('wxGetHostName').findOverload('buf').ignore()
module.find('wxGetUserId').findOverload('buf').ignore()
module.find('wxGetUserName').findOverload('buf').ignore()
module.find('wxSortCallback').ignore()
module.find('wxLoadUserResource').findOverload('pLen').ignore()
module.find('wxLoadUserResource').findOverload('outData').ignore()
module.find('wxGetFreeMemory').ignore()
module.find('wxGetLinuxDistributionInfo').ignore()
module.find('wxGetDisplayName').ignore()
module.find('wxSetDisplayName').ignore()
module.find('wxPostDelete').ignore()
# TODO: Can this be added back? It was removed because of compiler errors.
module.find('wxGetDiskSpace').ignore()
# deprecated and removed
module.find('wxUsleep').ignore()
# ignore all the environment related functions
for item in module.allItems():
if 'Env' in item.name:
item.ignore()
module.find('wxGetenv').ignore()
# Keep just the first wxExecute overload
f = module.find('wxExecute')
f.overloads = []
f.mustHaveApp()
module.find('wxGetOsVersion.major').out = True
module.find('wxGetOsVersion.minor').out = True
c = module.find('wxBusyCursor')
c.mustHaveApp()
# add context manager methods
c.addPyMethod('__enter__', '(self)', 'return self')
c.addPyMethod('__exit__', '(self, exc_type, exc_val, exc_tb)', 'pass')
f = module.find('wxNewId')
f.clearDeprecated()
f.deprecated = """\
IDs generated by this function can possibly conflict with IDs used elsewhere in
the application code. It is recommended to instead use the ``wx.ID_ANY`` ID to
assign generated IDs for the controls, menu items and etc. that you create in the
application. These IDs are guaranteed to not conflict with the other IDs that
are in use in the application. For those cases where you need to create an ID
that can be used more than once then please see :func:`wx.NewIdRef`.""".replace('\n', ' ')
for funcname in ['wxBell',
'wxBeginBusyCursor',
'wxEndBusyCursor',
'wxShutdown',
'wxInfoMessageBox',
'wxIsBusy',
'wxGetMousePosition',
'wxGetKeyState',
'wxGetMouseState',
]:
f = module.find(funcname)
f.mustHaveApp()
#-----------------------------------------------------------------
tools.doCommonTweaks(module)
tools.runGenerators(module)
#---------------------------------------------------------------------------
if __name__ == '__main__':
run()
|