def __init__(self, name, parent=None, docstring=None, cpp_namespace=None):
"""
Note: this is an abstract base class, see L{Module}
:param name: module name
:param parent: parent L{module<Module>} (i.e. the one that contains this submodule) or None if this is a root module
:param docstring: docstring to use for this module
:param cpp_namespace: C++ namespace prefix associated with this module
:return: a new module object
"""
super(ModuleBase, self).__init__()
self.parent = parent
self.docstring = docstring
self.submodules = []
self.enums = []
self.typedefs = [] # list of (wrapper, alias) tuples
self._forward_declarations_declared = False
self.cpp_namespace = cpp_namespace
if self.parent is None:
error_return = 'return MOD_ERROR;'
self.after_forward_declarations = MemoryCodeSink()
else:
self.after_forward_declarations = None
self.parent.submodules.append(self)
error_return = 'return NULL;'
self.prefix = None
self.init_function_name = None
self._name = None
self.name = name
path = self.get_namespace_path()
if path and path[0] == '::':
del path[0]
self.cpp_namespace_prefix = '::'.join(path)
self.declarations = DeclarationsScope()
self.functions = {} # name => OverloadedFunction
self.classes = []
self.containers = []
self.exceptions = []
self.before_init = CodeBlock(error_return, self.declarations)
self.after_init = CodeBlock(error_return,
self.declarations,
predecessor=self.before_init)
self.c_function_name_transformer = None
self.set_strip_prefix(name + '_')
if parent is None:
self.header = MemoryCodeSink()
self.body = MemoryCodeSink()
self.one_time_definitions = {}
self.includes = []
else:
self.header = parent.header
self.body = parent.body
self.one_time_definitions = parent.one_time_definitions
self.includes = parent.includes
self._current_section = '__main__'
def __init__(self, code_sink):
super(_MonolithicSinkManager, self).__init__()
self.final_code_sink = code_sink
self.null_sink = NullCodeSink()
self.includes = MemoryCodeSink()
self.code_sink = MemoryCodeSink()
utils.write_preamble(code_sink)
def generate_callback_classes(out, callbacks):
for callback_impl_num, template_parameters in enumerate(callbacks):
sink = MemoryCodeSink()
cls_name = "ns3::Callback< %s >" % ', '.join(template_parameters)
class_name = "PythonCallbackImpl%i" % callback_impl_num
sink.writeln( % (class_name, ', '.join(template_parameters), class_name, class_name, class_name, class_name))
sink.indent()
callback_return = template_parameters[0]
return_ctype = ctypeparser.parse_type(callback_return)
if ('const' in return_ctype.remove_modifiers()):
kwargs = {'is_const': True}
else:
kwargs = {}
try:
return_type = ReturnValue.new(str(return_ctype), **kwargs)
except (typehandlers.TypeLookupError, typehandlers.TypeConfigurationError), ex:
warnings.warn("***** Unable to register callback; Return value '%s' error (used in %s): %r"
% (callback_return, cls_name, ex),
Warning)
continue
arguments = []
ok = True
callback_parameters = [arg for arg in template_parameters[1:] if arg != 'ns3::empty']
for arg_num, arg_type in enumerate(callback_parameters):
arg_name = 'arg%i' % (arg_num+1)
param_ctype = ctypeparser.parse_type(arg_type)
if ('const' in param_ctype.remove_modifiers()):
kwargs = {'is_const': True}
else:
kwargs = {}
try:
arguments.append(Parameter.new(str(param_ctype), arg_name, **kwargs))
except (typehandlers.TypeLookupError, typehandlers.TypeConfigurationError), ex:
warnings.warn("***** Unable to register callback; parameter '%s %s' error (used in %s): %r"
% (arg_type, arg_name, cls_name, ex),
Warning)
ok = False
def do_generate(self, out, module_file_base_name=None):
"""(internal) Generates the module."""
assert isinstance(out, _SinkManager)
if self.parent is None:
## generate the include directives (only the root module)
forward_declarations_sink = MemoryCodeSink()
if not self._forward_declarations_declared:
self.generate_forward_declarations(forward_declarations_sink)
self.after_forward_declarations.flush_to(forward_declarations_sink)
if self.parent is None:
for include in self.includes:
out.get_includes_code_sink().writeln("#include %s" % include)
self.includes = None
forward_declarations_sink.flush_to(out.get_includes_code_sink())
else:
assert module_file_base_name is None, "only root modules can generate with alternate module_file_base_name"
## generate the submodules
for submodule in self.submodules:
submodule.do_generate(out)
m = self.declarations.declare_variable('PyObject*', 'm')
assert m == 'm'
if module_file_base_name is None:
mod_init_name = '.'.join(self.get_module_path())
else:
mod_init_name = module_file_base_name
self.before_init.write_code('#if PY_VERSION_HEX >= 0x03000000')
self.before_init.write_code(
"m = PyModule_Create(&%s_moduledef);"
% (self.name))
self.before_init.write_code('#else')
self.before_init.write_code(
"m = Py_InitModule3((char *) \"%s\", %s_functions, %s);"
% (mod_init_name, self.prefix,
self.docstring and '"'+self.docstring+'"' or 'NULL'))
self.before_init.write_code('#endif')
self.before_init.write_error_check("m == NULL")
main_sink = out.get_main_code_sink()
## generate the function wrappers
py_method_defs = []
if self.functions:
main_sink.writeln('/* --- module functions --- */')
main_sink.writeln()
for func_name, overload in self.functions.items():
sink, header_sink = out.get_code_sink_for_wrapper(overload)
sink.writeln()
try:
utils.call_with_error_handling(overload.generate, (sink,), {}, overload)
except utils.SkipWrapper:
continue
try:
utils.call_with_error_handling(overload.generate_declaration, (main_sink,), {}, overload)
except utils.SkipWrapper:
continue
sink.writeln()
py_method_defs.append(overload.get_py_method_def(func_name))
del sink
## generate the function table
main_sink.writeln("static PyMethodDef %s_functions[] = {"
% (self.prefix,))
main_sink.indent()
for py_method_def in py_method_defs:
main_sink.writeln(py_method_def)
main_sink.writeln("{NULL, NULL, 0, NULL}")
main_sink.unindent()
main_sink.writeln("};")
## generate the classes
if self.classes:
main_sink.writeln('/* --- classes --- */')
main_sink.writeln()
for class_ in [c for c in self.classes if c.import_from_module]:
sink, header_sink = out.get_code_sink_for_wrapper(class_)
sink.writeln()
class_.generate(sink, self)
sink.writeln()
for class_ in [c for c in self.classes if not c.import_from_module]:
sink, header_sink = out.get_code_sink_for_wrapper(class_)
sink.writeln()
class_.generate(sink, self)
sink.writeln()
## generate the containers
if self.containers:
main_sink.writeln('/* --- containers --- */')
main_sink.writeln()
for container in self.containers:
sink, header_sink = out.get_code_sink_for_wrapper(container)
sink.writeln()
container.generate(sink, self)
sink.writeln()
## generate the exceptions
if self.exceptions:
main_sink.writeln('/* --- exceptions --- */')
main_sink.writeln()
for exc in self.exceptions:
sink, header_sink = out.get_code_sink_for_wrapper(exc)
sink.writeln()
exc.generate(sink, self)
sink.writeln()
# typedefs
for (wrapper, alias) in self.typedefs:
if isinstance(wrapper, CppClass):
cls = wrapper
cls.generate_typedef(self, alias)
## generate the enums
if self.enums:
main_sink.writeln('/* --- enumerations --- */')
main_sink.writeln()
for enum in self.enums:
sink, header_sink = out.get_code_sink_for_wrapper(enum)
sink.writeln()
enum.generate(sink)
enum.generate_declaration(header_sink, self)
sink.writeln()
## register the submodules
if self.submodules:
submodule_var = self.declarations.declare_variable('PyObject*', 'submodule')
for submodule in self.submodules:
self.after_init.write_code('%s = %s();' % (
submodule_var, submodule.init_function_name))
self.after_init.write_error_check('%s == NULL' % submodule_var)
self.after_init.write_code('Py_INCREF(%s);' % (submodule_var,))
self.after_init.write_code('PyModule_AddObject(m, (char *) "%s", %s);'
% (submodule.name, submodule_var,))
## flush the header section
self.header.flush_to(out.get_includes_code_sink())
## flush the body section
self.body.flush_to(main_sink)
## now generate the module init function itself
main_sink.writeln('#if PY_VERSION_HEX >= 0x03000000\n'
'static struct PyModuleDef %s_moduledef = {\n'
' PyModuleDef_HEAD_INIT,\n'
' "%s",\n'
' %s,\n'
' -1,\n'
' %s_functions,\n'
'};\n'
'#endif' % (self.name, mod_init_name,
self.docstring and '"'+self.docstring+'"' or 'NULL',
self.prefix))
main_sink.writeln()
if self.parent is None:
main_sink.writeln('''
#if PY_VERSION_HEX >= 0x03000000
#define MOD_ERROR NULL
#define MOD_INIT(name) PyObject* PyInit_##name(void)
#define MOD_RETURN(val) val
#else
#define MOD_ERROR
#define MOD_INIT(name) void init##name(void)
#define MOD_RETURN(val)
#endif
#if defined(__cplusplus)
extern "C"
#endif
#if defined(__GNUC__) && __GNUC__ >= 4
__attribute__ ((visibility("default")))
#endif
''')
else:
main_sink.writeln("static PyObject *")
if self.parent is None:
main_sink.writeln("MOD_INIT(%s)" % (self.name,))
elif module_file_base_name is None:
main_sink.writeln("%s(void)" % (self.init_function_name,))
else:
main_sink.writeln("init%s(void)" % (module_file_base_name,))
main_sink.writeln('{')
main_sink.indent()
self.declarations.get_code_sink().flush_to(main_sink)
self.before_init.sink.flush_to(main_sink)
self.after_init.write_cleanup()
self.after_init.sink.flush_to(main_sink)
if self.parent is not None:
main_sink.writeln("return m;")
else:
main_sink.writeln("return MOD_RETURN(m);")
main_sink.unindent()
main_sink.writeln('}')
def generate_callback_classes(out, callbacks):
for callback_impl_num, template_parameters in enumerate(callbacks):
sink = MemoryCodeSink()
cls_name = "ns3::Callback< %s >" % ', '.join(template_parameters)
#print >> sys.stderr, "***** trying to register callback: %r" % cls_name
class_name = "PythonCallbackImpl%i" % callback_impl_num
sink.writeln('''
class %s : public ns3::CallbackImpl<%s>
{
public:
PyObject *m_callback;
%s(PyObject *callback)
{
Py_INCREF(callback);
m_callback = callback;
}
virtual ~%s()
{
Py_DECREF(m_callback);
m_callback = NULL;
}
virtual bool IsEqual(ns3::Ptr<const ns3::CallbackImplBase> other_base) const
{
const %s *other = dynamic_cast<const %s*> (ns3::PeekPointer (other_base));
if (other != NULL)
return (other->m_callback == m_callback);
else
return false;
}
''' % (class_name, ', '.join(template_parameters), class_name, class_name,
class_name, class_name))
sink.indent()
callback_return = template_parameters[0]
return_ctype = ctypeparser.parse_type(callback_return)
if ('const' in return_ctype.remove_modifiers()):
kwargs = {'is_const': True}
else:
kwargs = {}
try:
return_type = ReturnValue.new(str(return_ctype), **kwargs)
except (typehandlers.TypeLookupError,
typehandlers.TypeConfigurationError), ex:
warnings.warn(
"***** Unable to register callback; Return value '%s' error (used in %s): %r"
% (callback_return, cls_name, ex), Warning)
continue
arguments = []
ok = True
callback_parameters = [
arg for arg in template_parameters[1:] if arg != 'ns3::empty'
]
for arg_num, arg_type in enumerate(callback_parameters):
arg_name = 'arg%i' % (arg_num + 1)
param_ctype = ctypeparser.parse_type(arg_type)
if ('const' in param_ctype.remove_modifiers()):
kwargs = {'is_const': True}
else:
kwargs = {}
try:
arguments.append(
Parameter.new(str(param_ctype), arg_name, **kwargs))
except (typehandlers.TypeLookupError,
typehandlers.TypeConfigurationError), ex:
warnings.warn(
"***** Unable to register callback; parameter '%s %s' error (used in %s): %r"
% (arg_type, arg_name, cls_name, ex), Warning)
ok = False
def generate_callback_classes(module, callbacks):
out = module.after_forward_declarations
for callback_impl_num, template_parameters in enumerate(callbacks):
sink = MemoryCodeSink()
cls_name = "ns3::Callback< %s >" % ', '.join(template_parameters)
#print >> sys.stderr, "***** trying to register callback: %r" % cls_name
class_name = "PythonCallbackImpl%i" % callback_impl_num
sink.writeln('''
class %s : public ns3::CallbackImpl<%s>
{
public:
PyObject *m_callback;
%s(PyObject *callback)
{
Py_INCREF(callback);
m_callback = callback;
}
virtual ~%s()
{
PyGILState_STATE __py_gil_state;
__py_gil_state = (PyEval_ThreadsInitialized() ? PyGILState_Ensure() : (PyGILState_STATE) 0);
Py_DECREF(m_callback);
m_callback = NULL;
PyGILState_Release(__py_gil_state);
}
virtual bool IsEqual(ns3::Ptr<const ns3::CallbackImplBase> other_base) const
{
const %s *other = dynamic_cast<const %s*> (ns3::PeekPointer (other_base));
if (other != NULL)
return (other->m_callback == m_callback);
else
return false;
}
''' % (class_name, ', '.join(template_parameters), class_name, class_name,
class_name, class_name))
sink.indent()
callback_return = template_parameters[0]
return_ctype = ctypeparser.parse_type(callback_return)
if ('const' in return_ctype.remove_modifiers()):
kwargs = {'is_const': True}
else:
kwargs = {}
try:
return_type = ReturnValue.new(str(return_ctype), **kwargs)
except (typehandlers.TypeLookupError,
typehandlers.TypeConfigurationError) as ex:
warnings.warn(
"***** Unable to register callback; Return value '%s' error (used in %s): %r"
% (callback_return, cls_name, ex), Warning)
continue
arguments = []
ok = True
callback_parameters = [
arg for arg in template_parameters[1:] if arg != 'ns3::empty'
]
for arg_num, arg_type in enumerate(callback_parameters):
arg_name = 'arg%i' % (arg_num + 1)
param_ctype = ctypeparser.parse_type(arg_type)
if ('const' in param_ctype.remove_modifiers()):
kwargs = {'is_const': True}
else:
kwargs = {}
try:
param = Parameter.new(str(param_ctype), arg_name, **kwargs)
cpp_class = getattr(param, "cpp_class", None)
if isinstance(cpp_class, cppclass.CppClass):
# check if the "helper class" can be constructed
if cpp_class.helper_class is not None:
cpp_class.helper_class.generate_forward_declarations(
MemoryCodeSink())
if cpp_class.helper_class.cannot_be_constructed:
cpp_class.helper_class = None
cpp_class.helper_class_disabled = True
arguments.append(param)
except (typehandlers.TypeLookupError,
typehandlers.TypeConfigurationError) as ex:
warnings.warn(
"***** Unable to register callback; parameter '%s %s' error (used in %s): %r"
% (arg_type, arg_name, cls_name, ex), Warning)
ok = False
if not ok:
try:
typehandlers.return_type_matcher.lookup(
cls_name)[0].DISABLED = True
except typehandlers.TypeLookupError:
pass
try:
typehandlers.param_type_matcher.lookup(
cls_name)[0].DISABLED = True
except typehandlers.TypeLookupError:
pass
continue
wrapper = CallbackImplProxyMethod(return_type, arguments)
wrapper.generate(sink, 'operator()', decl_modifiers=[])
sink.unindent()
sink.writeln('};\n')
print("Flushing to ", out, file=sys.stderr)
sink.flush_to(out)
def generate_callback_classes(out, callbacks):
for callback_impl_num, template_parameters in enumerate(callbacks):
sink = MemoryCodeSink()
cls_name = "ns3::Callback< %s >" % ', '.join(template_parameters)
#print >> sys.stderr, "***** trying to register callback: %r" % cls_name
class_name = "PythonCallbackImpl%i" % callback_impl_num
sink.writeln('''
class %s : public ns3::CallbackImpl<%s>
{
public:
PyObject *m_callback;
%s(PyObject *callback)
{
Py_INCREF(callback);
m_callback = callback;
}
virtual ~%s()
{
PyGILState_STATE __py_gil_state;
__py_gil_state = (PyEval_ThreadsInitialized() ? PyGILState_Ensure() : (PyGILState_STATE) 0);
Py_DECREF(m_callback);
m_callback = NULL;
PyGILState_Release(__py_gil_state);
}
virtual bool IsEqual(ns3::Ptr<const ns3::CallbackImplBase> other_base) const
{
const %s *other = dynamic_cast<const %s*> (ns3::PeekPointer (other_base));
if (other != NULL)
return (other->m_callback == m_callback);
else
return false;
}
''' % (class_name, ', '.join(template_parameters), class_name, class_name,
class_name, class_name))
sink.indent()
callback_return = template_parameters[0]
return_ctype = ctypeparser.parse_type(callback_return)
if ('const' in return_ctype.remove_modifiers()):
kwargs = {'is_const': True}
else:
kwargs = {}
try:
return_type = ReturnValue.new(str(return_ctype), **kwargs)
except (typehandlers.TypeLookupError,
typehandlers.TypeConfigurationError) as ex:
warnings.warn(
"***** Unable to register callback; Return value '%s' error (used in %s): %r"
% (callback_return, cls_name, ex), Warning)
continue
arguments = []
ok = True
callback_parameters = [
arg for arg in template_parameters[1:] if arg != 'ns3::empty'
]
for arg_num, arg_type in enumerate(callback_parameters):
arg_name = 'arg%i' % (arg_num + 1)
param_ctype = ctypeparser.parse_type(arg_type)
if ('const' in param_ctype.remove_modifiers()):
kwargs = {'is_const': True}
else:
kwargs = {}
try:
arguments.append(
Parameter.new(str(param_ctype), arg_name, **kwargs))
except (typehandlers.TypeLookupError,
typehandlers.TypeConfigurationError) as ex:
warnings.warn(
"***** Unable to register callback; parameter '%s %s' error (used in %s): %r"
% (arg_type, arg_name, cls_name, ex), Warning)
ok = False
if not ok:
continue
wrapper = CallbackImplProxyMethod(return_type, arguments)
wrapper.generate(sink, 'operator()', decl_modifiers=[])
sink.unindent()
sink.writeln('};\n')
sink.flush_to(out)
class PythonCallbackParameter(Parameter):
"Class handlers"
CTYPES = [cls_name]
print("***** registering callback handler: %r" %
ctypeparser.normalize_type_string(cls_name),
file=sys.stderr)
DIRECTIONS = [Parameter.DIRECTION_IN]
PYTHON_CALLBACK_IMPL_NAME = class_name
TEMPLATE_ARGS = template_parameters
def convert_python_to_c(self, wrapper):
"parses python args to get C++ value"
assert isinstance(wrapper, typehandlers.ForwardWrapperBase)
if self.default_value is None:
py_callback = wrapper.declarations.declare_variable(
'PyObject*', self.name)
wrapper.parse_params.add_parameter('O',
['&' + py_callback],
self.name)
wrapper.before_call.write_error_check(
'!PyCallable_Check(%s)' % py_callback,
'PyErr_SetString(PyExc_TypeError, "parameter \'%s\' must be callbale");'
% self.name)
callback_impl = wrapper.declarations.declare_variable(
'ns3::Ptr<%s>' % self.PYTHON_CALLBACK_IMPL_NAME,
'%s_cb_impl' % self.name)
wrapper.before_call.write_code(
"%s = ns3::Create<%s> (%s);" %
(callback_impl, self.PYTHON_CALLBACK_IMPL_NAME,
py_callback))
wrapper.call_params.append(
'ns3::Callback<%s> (%s)' %
(', '.join(self.TEMPLATE_ARGS), callback_impl))
else:
py_callback = wrapper.declarations.declare_variable(
'PyObject*', self.name, 'NULL')
wrapper.parse_params.add_parameter('O',
['&' + py_callback],
self.name,
optional=True)
value = wrapper.declarations.declare_variable(
'ns3::Callback<%s>' % ', '.join(self.TEMPLATE_ARGS),
self.name + '_value', self.default_value)
wrapper.before_call.write_code("if (%s) {" %
(py_callback, ))
wrapper.before_call.indent()
wrapper.before_call.write_error_check(
'!PyCallable_Check(%s)' % py_callback,
'PyErr_SetString(PyExc_TypeError, "parameter \'%s\' must be callbale");'
% self.name)
wrapper.before_call.write_code(
"%s = ns3::Callback<%s> (ns3::Create<%s> (%s));" %
(value, ', '.join(self.TEMPLATE_ARGS),
self.PYTHON_CALLBACK_IMPL_NAME, py_callback))
wrapper.before_call.unindent()
wrapper.before_call.write_code(
"}") # closes: if (py_callback) {
wrapper.call_params.append(value)
def convert_c_to_python(self, wrapper):
raise typehandlers.NotSupportedError(
"Reverse wrappers for ns3::Callback<...> types "
"(python using callbacks defined in C++) not implemented.")
