bindings/python/ns3modulescan.py
author Craig Dowell <craigdo@ee.washington.edu>
Fri, 12 Feb 2010 16:20:59 -0800
changeset 6047 09841960107d
parent 6029 096af1414c37
parent 5980 7929ba7d13bd
child 6139 3202621a634c
permissions -rw-r--r--
remove ascii-writer, pcap-writer, branch merge
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
     1
#! /usr/bin/env python
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
     2
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
     3
import sys
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
     4
import os.path
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
     5
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
     6
import pybindgen.settings
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
     7
from pybindgen.gccxmlparser import ModuleParser, PygenClassifier, PygenSection, WrapperWarning
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
     8
from pybindgen.typehandlers.codesink import FileCodeSink
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
     9
from pygccxml.declarations import templates
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    10
from pygccxml.declarations.class_declaration import class_t
5755
4214e2d08941 Patch the bad default_value given by gccxml in the case of MilliSeconds(0)
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5753
diff changeset
    11
from pygccxml.declarations.calldef import free_function_t, member_function_t, constructor_t, calldef_t
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    12
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    13
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    14
## we need the smart pointer type transformation to be active even
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    15
## during gccxml scanning.
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    16
import ns3modulegen_core_customizations
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    17
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    18
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    19
## silence gccxmlparser errors; we only want error handling in the
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    20
## generated python script, not while scanning.
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    21
class ErrorHandler(pybindgen.settings.ErrorHandler):
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    22
    def handle_error(self, dummy_wrapper, dummy_exception, dummy_traceback_):
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    23
        return True
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    24
pybindgen.settings.error_handler = ErrorHandler()
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    25
import warnings
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    26
warnings.filterwarnings(category=WrapperWarning, action='ignore')
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    27
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    28
type_annotations = {
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    29
    '::ns3::AttributeChecker': {
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    30
        'automatic_type_narrowing': 'true',
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    31
        'allow_subclassing': 'false',
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    32
        },
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    33
    '::ns3::AttributeValue': {
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    34
        'automatic_type_narrowing': 'true',
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    35
        'allow_subclassing': 'false',
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    36
        },
3929
909b0a724ed3 Bug 289: CommandLine::AddValue is not wrapped
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3755
diff changeset
    37
909b0a724ed3 Bug 289: CommandLine::AddValue is not wrapped
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3755
diff changeset
    38
    '::ns3::CommandLine': {
909b0a724ed3 Bug 289: CommandLine::AddValue is not wrapped
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3755
diff changeset
    39
        'allow_subclassing': 'true', # needed so that AddValue is able to set attributes on the object
909b0a724ed3 Bug 289: CommandLine::AddValue is not wrapped
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3755
diff changeset
    40
        },
909b0a724ed3 Bug 289: CommandLine::AddValue is not wrapped
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3755
diff changeset
    41
4749
af227579ab64 Don't python-bind the class NscTcpL4Protocol, it is implementation detail.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 4086
diff changeset
    42
    '::ns3::NscTcpL4Protocol': {
af227579ab64 Don't python-bind the class NscTcpL4Protocol, it is implementation detail.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 4086
diff changeset
    43
        'ignore': 'true', # this class is implementation detail
af227579ab64 Don't python-bind the class NscTcpL4Protocol, it is implementation detail.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 4086
diff changeset
    44
        },
af227579ab64 Don't python-bind the class NscTcpL4Protocol, it is implementation detail.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 4086
diff changeset
    45
af227579ab64 Don't python-bind the class NscTcpL4Protocol, it is implementation detail.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 4086
diff changeset
    46
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    47
    'ns3::RandomVariable::RandomVariable(ns3::RandomVariableBase const & variable) [constructor]': {
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    48
        'ignore': None,
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    49
        },
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    50
    'ns3::RandomVariableBase * ns3::RandomVariable::Peek() const [member function]': {
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    51
        'ignore': None,
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    52
        },
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    53
    'void ns3::RandomVariable::GetSeed(uint32_t * seed) const [member function]': {
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    54
        'params': {'seed':{'direction':'out',
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    55
                           'array_length':'6'}}
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    56
        },
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    57
    'bool ns3::TypeId::LookupAttributeByName(std::string name, ns3::TypeId::AttributeInfo * info) const [member function]': {
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    58
        'params': {'info':{'transfer_ownership': 'false'}}
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    59
        },
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    60
    'static bool ns3::TypeId::LookupByNameFailSafe(std::string name, ns3::TypeId * tid) [member function]': {
3753
a84a48233eb3 A more pythonic wrapper for ns3.TypeId.LookupByNameFailSafe
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3537
diff changeset
    61
        'ignore': None, # manually wrapped in 
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    62
        },
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    63
    'bool ns3::TraceSourceAccessor::ConnectWithoutContext(ns3::ObjectBase * obj, ns3::CallbackBase const & cb) const [member function]': {
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    64
        'params': {'obj': {'transfer_ownership':'false'}}
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    65
        },
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    66
    'bool ns3::TraceSourceAccessor::Connect(ns3::ObjectBase * obj, std::string context, ns3::CallbackBase const & cb) const [member function]': {
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    67
        'params': {'obj': {'transfer_ownership':'false'}}
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    68
        },
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    69
    'bool ns3::TraceSourceAccessor::DisconnectWithoutContext(ns3::ObjectBase * obj, ns3::CallbackBase const & cb) const [member function]': {
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    70
        'params': {'obj': {'transfer_ownership':'false'}}
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    71
        },
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    72
    'bool ns3::TraceSourceAccessor::Disconnect(ns3::ObjectBase * obj, std::string context, ns3::CallbackBase const & cb) const [member function]': {
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    73
        'params': {'obj': {'transfer_ownership':'false'}}
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    74
        },
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    75
    'bool ns3::AttributeAccessor::Set(ns3::ObjectBase * object, ns3::AttributeValue const & value) const [member function]': {
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    76
        'params': {'object': {'transfer_ownership':'false'}}
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    77
        },
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    78
    'ns3::EmpiricalVariable::EmpiricalVariable(ns3::RandomVariableBase const & variable) [constructor]': {
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    79
        'ignore': None
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    80
        },
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    81
    'static ns3::AttributeList * ns3::AttributeList::GetGlobal() [member function]': {
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    82
        'caller_owns_return': 'false'
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    83
        },
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    84
    'void ns3::CommandLine::Parse(int argc, char * * argv) const [member function]': {
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    85
        'ignore': None # manually wrapped
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    86
        },
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    87
    'extern void ns3::PythonCompleteConstruct(ns3::Ptr<ns3::Object> object, ns3::TypeId typeId, ns3::AttributeList const & attributes) [free function]': {
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    88
        'ignore': None # used transparently by, should not be wrapped
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    89
        },
5980
7929ba7d13bd Python: add needed annotations to ns3::GlobalRouter::GetInjectedRoute and ns3::Ipv4GlobalRouting::GetRoute. Fixes bug #809.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5879
diff changeset
    90
    'ns3::Ipv4RoutingTableEntry * ns3::GlobalRouter::GetInjectedRoute(uint32_t i) [member function]': {
7929ba7d13bd Python: add needed annotations to ns3::GlobalRouter::GetInjectedRoute and ns3::Ipv4GlobalRouting::GetRoute. Fixes bug #809.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5879
diff changeset
    91
        'params': {'return': { 'caller_owns_return': 'false',}},
7929ba7d13bd Python: add needed annotations to ns3::GlobalRouter::GetInjectedRoute and ns3::Ipv4GlobalRouting::GetRoute. Fixes bug #809.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5879
diff changeset
    92
        },
7929ba7d13bd Python: add needed annotations to ns3::GlobalRouter::GetInjectedRoute and ns3::Ipv4GlobalRouting::GetRoute. Fixes bug #809.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5879
diff changeset
    93
    'ns3::Ipv4RoutingTableEntry * ns3::Ipv4GlobalRouting::GetRoute(uint32_t i) [member function]': {
7929ba7d13bd Python: add needed annotations to ns3::GlobalRouter::GetInjectedRoute and ns3::Ipv4GlobalRouting::GetRoute. Fixes bug #809.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5879
diff changeset
    94
        'params': {'return': { 'caller_owns_return': 'false',}},
7929ba7d13bd Python: add needed annotations to ns3::GlobalRouter::GetInjectedRoute and ns3::Ipv4GlobalRouting::GetRoute. Fixes bug #809.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5879
diff changeset
    95
        },
7929ba7d13bd Python: add needed annotations to ns3::GlobalRouter::GetInjectedRoute and ns3::Ipv4GlobalRouting::GetRoute. Fixes bug #809.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5879
diff changeset
    96
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    97
    }
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    98
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
    99
def get_ns3_relative_path(path):
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   100
    l = []
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   101
    head = path
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   102
    while head:
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   103
        head, tail = os.path.split(head)
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   104
        if tail == 'ns3':
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   105
            return os.path.join(*l)
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   106
        l.insert(0, tail)
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   107
    raise AssertionError("is the path %r inside ns3?!" % path)
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   108
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   109
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   110
def pre_scan_hook(dummy_module_parser,
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   111
                  pygccxml_definition,
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   112
                  global_annotations,
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   113
                  parameter_annotations):
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   114
    ns3_header = get_ns3_relative_path(pygccxml_definition.location.file_name)
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   115
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   116
    ## Note: we don't include line numbers in the comments because
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   117
    ## those numbers are very likely to change frequently, which would
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   118
    ## cause needless changes, since the generated python files are
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   119
    ## kept under version control.
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   120
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   121
    #global_annotations['pygen_comment'] = "%s:%i: %s" % \
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   122
    #    (ns3_header, pygccxml_definition.location.line, pygccxml_definition)
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   123
    global_annotations['pygen_comment'] = "%s: %s" % \
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   124
        (ns3_header, pygccxml_definition)
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   125
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   126
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   127
    ## handle ns3::Object::GetObject (left to its own devices,
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   128
    ## pybindgen will generate a mangled name containing the template
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   129
    ## argument type name).
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   130
    if isinstance(pygccxml_definition, member_function_t) \
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   131
            and pygccxml_definition.parent.name == 'Object' \
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   132
            and pygccxml_definition.name == 'GetObject':
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   133
        template_args = templates.args(pygccxml_definition.demangled_name)
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   134
        if template_args == ['ns3::Object']:
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   135
            global_annotations['template_instance_names'] = 'ns3::Object=>GetObject'
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   136
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   137
    ## Don't wrap Simulator::Schedule* (manually wrapped)
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   138
    if isinstance(pygccxml_definition, member_function_t) \
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   139
            and pygccxml_definition.parent.name == 'Simulator' \
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   140
            and pygccxml_definition.name.startswith('Schedule'):
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   141
        global_annotations['ignore'] = None
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   142
4086
37dbf76b4c66 Bug 375: Ctrl-C does not always work when running Python simulations
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3929
diff changeset
   143
    # manually wrapped
3511
eb17407147c3 Python: re-scan API; unblock python threads during Simulator::Run; new pybindgen brings improved thread safety for virtual methods.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3484
diff changeset
   144
    if isinstance(pygccxml_definition, member_function_t) \
eb17407147c3 Python: re-scan API; unblock python threads during Simulator::Run; new pybindgen brings improved thread safety for virtual methods.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3484
diff changeset
   145
            and pygccxml_definition.parent.name == 'Simulator' \
eb17407147c3 Python: re-scan API; unblock python threads during Simulator::Run; new pybindgen brings improved thread safety for virtual methods.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3484
diff changeset
   146
            and pygccxml_definition.name == 'Run':
4086
37dbf76b4c66 Bug 375: Ctrl-C does not always work when running Python simulations
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3929
diff changeset
   147
        global_annotations['ignore'] = True
3511
eb17407147c3 Python: re-scan API; unblock python threads during Simulator::Run; new pybindgen brings improved thread safety for virtual methods.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3484
diff changeset
   148
5755
4214e2d08941 Patch the bad default_value given by gccxml in the case of MilliSeconds(0)
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5753
diff changeset
   149
    ## http://www.gccxml.org/Bug/view.php?id=9915
4214e2d08941 Patch the bad default_value given by gccxml in the case of MilliSeconds(0)
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5753
diff changeset
   150
    if isinstance(pygccxml_definition, calldef_t):
4214e2d08941 Patch the bad default_value given by gccxml in the case of MilliSeconds(0)
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5753
diff changeset
   151
        for arg in pygccxml_definition.arguments:
4214e2d08941 Patch the bad default_value given by gccxml in the case of MilliSeconds(0)
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5753
diff changeset
   152
            if arg.default_value is None:
4214e2d08941 Patch the bad default_value given by gccxml in the case of MilliSeconds(0)
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5753
diff changeset
   153
                continue
4214e2d08941 Patch the bad default_value given by gccxml in the case of MilliSeconds(0)
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5753
diff changeset
   154
            if "ns3::MilliSeconds( )" == arg.default_value:
4214e2d08941 Patch the bad default_value given by gccxml in the case of MilliSeconds(0)
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5753
diff changeset
   155
                arg.default_value = "ns3::MilliSeconds(0)"
3511
eb17407147c3 Python: re-scan API; unblock python threads during Simulator::Run; new pybindgen brings improved thread safety for virtual methods.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3484
diff changeset
   156
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   157
    ## classes
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   158
    if isinstance(pygccxml_definition, class_t):
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   159
        # no need for helper classes to allow subclassing in Python, I think...
6029
096af1414c37 tell pybindgen not to disable inheritance on classes that end with Helper, and rescan
Craig Dowell <craigdo@ee.washington.edu>
parents: 5879
diff changeset
   160
        #if pygccxml_definition.name.endswith('Helper'):
096af1414c37 tell pybindgen not to disable inheritance on classes that end with Helper, and rescan
Craig Dowell <craigdo@ee.washington.edu>
parents: 5879
diff changeset
   161
        #    global_annotations['allow_subclassing'] = 'false'
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   162
5879
12a17646ad8e python: fix scanning to correctly look for the new SimpleRefCount templated class and declare it is reference counted
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5778
diff changeset
   163
        if pygccxml_definition.decl_string.startswith('::ns3::SimpleRefCount<'):
12a17646ad8e python: fix scanning to correctly look for the new SimpleRefCount templated class and declare it is reference counted
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5778
diff changeset
   164
            global_annotations['incref_method'] = 'Ref'
12a17646ad8e python: fix scanning to correctly look for the new SimpleRefCount templated class and declare it is reference counted
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5778
diff changeset
   165
            global_annotations['decref_method'] = 'Unref'
12a17646ad8e python: fix scanning to correctly look for the new SimpleRefCount templated class and declare it is reference counted
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5778
diff changeset
   166
            global_annotations['peekref_method'] = 'GetReferenceCount'
12a17646ad8e python: fix scanning to correctly look for the new SimpleRefCount templated class and declare it is reference counted
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5778
diff changeset
   167
            global_annotations['automatic_type_narrowing'] = 'true'
12a17646ad8e python: fix scanning to correctly look for the new SimpleRefCount templated class and declare it is reference counted
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5778
diff changeset
   168
            return
12a17646ad8e python: fix scanning to correctly look for the new SimpleRefCount templated class and declare it is reference counted
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5778
diff changeset
   169
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   170
        if pygccxml_definition.decl_string.startswith('::ns3::Callback<'):
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   171
            # manually handled in ns3modulegen_core_customizations.py
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   172
            global_annotations['ignore'] = None
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   173
            return
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   174
3537
ab1673dcdf58 Python: ignore TracedCallback classes for the time being: they were never usable and were triggering pybindgen generate code compilation problems.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3511
diff changeset
   175
        if pygccxml_definition.decl_string.startswith('::ns3::TracedCallback<'):
ab1673dcdf58 Python: ignore TracedCallback classes for the time being: they were never usable and were triggering pybindgen generate code compilation problems.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3511
diff changeset
   176
            global_annotations['ignore'] = None
ab1673dcdf58 Python: ignore TracedCallback classes for the time being: they were never usable and were triggering pybindgen generate code compilation problems.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3511
diff changeset
   177
            return
ab1673dcdf58 Python: ignore TracedCallback classes for the time being: they were never usable and were triggering pybindgen generate code compilation problems.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3511
diff changeset
   178
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   179
        if pygccxml_definition.decl_string.startswith('::ns3::Ptr<'):
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   180
            # handled by pybindgen "type transformation"
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   181
            global_annotations['ignore'] = None
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   182
            return
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   183
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   184
        # table driven class customization
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   185
        try:
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   186
            annotations = type_annotations[pygccxml_definition.decl_string]
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   187
        except KeyError:
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   188
            pass
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   189
        else:
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   190
            global_annotations.update(annotations)
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   191
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   192
    ## free functions
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   193
    if isinstance(pygccxml_definition, free_function_t):
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   194
        if pygccxml_definition.name == 'PeekPointer':
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   195
            global_annotations['ignore'] = None
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   196
            return
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   197
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   198
    ## table driven methods/constructors/functions customization
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   199
    if isinstance(pygccxml_definition, (free_function_t, member_function_t, constructor_t)):
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   200
        try:
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   201
            annotations = type_annotations[str(pygccxml_definition)]
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   202
        except KeyError:
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   203
            pass
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   204
        else:
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   205
            for key,value in annotations.items():
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   206
                if key == 'params':
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   207
                    parameter_annotations.update (value)
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   208
                    del annotations['params']
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   209
            global_annotations.update(annotations)
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   210
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   211
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   212
# def post_scan_hook(dummy_module_parser, dummy_pygccxml_definition, pybindgen_wrapper):
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   213
#     ## classes
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   214
#     if isinstance(pybindgen_wrapper, CppClass):
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   215
#         if pybindgen_wrapper.name.endswith('Checker'):
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   216
#             print >> sys.stderr, "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!", pybindgen_wrapper
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   217
#             #pybindgen_wrapper.set_instance_creation_function(AttributeChecker_instance_creation_function)
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   218
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   219
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   220
def scan_callback_classes(module_parser, callback_classes_file):
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   221
    callback_classes_file.write("callback_classes = [\n")
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   222
    for cls in module_parser.module_namespace.classes(function=module_parser.location_filter,
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   223
                                                      recursive=False):
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   224
        if not cls.name.startswith("Callback<"):
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   225
            continue
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   226
        assert templates.is_instantiation(cls.decl_string), "%s is not a template instantiation" % cls
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   227
        dummy_cls_name, template_parameters = templates.split(cls.decl_string)
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   228
        callback_classes_file.write("    %r,\n" % template_parameters)
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   229
    callback_classes_file.write("]\n")
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   230
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   231
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   232
class MyPygenClassifier(PygenClassifier):
5753
8c105b521d1b Python: rescan; need new 'section precedence' API from PyBindGen; other PBG bug fixes pulled from new version.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5249
diff changeset
   233
    def __init__(self, headers_map, section_precendences):
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   234
        self.headers_map = headers_map
5753
8c105b521d1b Python: rescan; need new 'section precedence' API from PyBindGen; other PBG bug fixes pulled from new version.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5249
diff changeset
   235
        self.section_precendences = section_precendences
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   236
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   237
    def classify(self, pygccxml_definition):
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   238
        name = os.path.basename(pygccxml_definition.location.file_name)
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   239
        try:
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   240
            return self.headers_map[name]
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   241
        except KeyError:
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   242
            return '__main__'
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   243
5753
8c105b521d1b Python: rescan; need new 'section precedence' API from PyBindGen; other PBG bug fixes pulled from new version.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5249
diff changeset
   244
    def get_section_precedence(self, section_name):
8c105b521d1b Python: rescan; need new 'section precedence' API from PyBindGen; other PBG bug fixes pulled from new version.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5249
diff changeset
   245
        if section_name == '__main__':
8c105b521d1b Python: rescan; need new 'section precedence' API from PyBindGen; other PBG bug fixes pulled from new version.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5249
diff changeset
   246
            return -1
8c105b521d1b Python: rescan; need new 'section precedence' API from PyBindGen; other PBG bug fixes pulled from new version.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5249
diff changeset
   247
        return self.section_precendences[section_name]
8c105b521d1b Python: rescan; need new 'section precedence' API from PyBindGen; other PBG bug fixes pulled from new version.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5249
diff changeset
   248
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   249
5249
85cde7d987ed Python: allow multiple api definitions directories, one per data model.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 4749
diff changeset
   250
def ns3_module_scan(top_builddir, pygen_file_name, everything_h, cflags):
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   251
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   252
    ns3_modules = eval(sys.stdin.read())
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   253
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   254
    ## do a topological sort on the modules graph
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   255
    from topsort import topsort
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   256
    graph = []
5778
bb28b3985514 python scanning: order from chaos: pre-sort the ns3 module dependency graph to improve stability of the result
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5755
diff changeset
   257
    module_names = ns3_modules.keys()
bb28b3985514 python scanning: order from chaos: pre-sort the ns3 module dependency graph to improve stability of the result
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5755
diff changeset
   258
    module_names.sort()
bb28b3985514 python scanning: order from chaos: pre-sort the ns3 module dependency graph to improve stability of the result
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5755
diff changeset
   259
    for ns3_module_name in module_names:
bb28b3985514 python scanning: order from chaos: pre-sort the ns3 module dependency graph to improve stability of the result
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5755
diff changeset
   260
        ns3_module_deps = list(ns3_modules[ns3_module_name][0])
bb28b3985514 python scanning: order from chaos: pre-sort the ns3 module dependency graph to improve stability of the result
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5755
diff changeset
   261
        ns3_module_deps.sort()
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   262
        for dep in ns3_module_deps:
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   263
            graph.append((dep, ns3_module_name))
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   264
    sorted_ns3_modules = topsort(graph)
3409
94ac3e381075 The 'everything.h' header file is only used for Python bindings and should be generated into bindings/python/, not ns3/.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3408
diff changeset
   265
    #print >> sys.stderr, "******* topological sort: ", sorted_ns3_modules
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   266
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   267
    sections = [PygenSection('__main__', FileCodeSink(open(pygen_file_name, "wt")))]
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   268
    headers_map = {} # header_name -> section_name
5753
8c105b521d1b Python: rescan; need new 'section precedence' API from PyBindGen; other PBG bug fixes pulled from new version.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5249
diff changeset
   269
    section_precendences = {} # section_name -> precedence
8c105b521d1b Python: rescan; need new 'section precedence' API from PyBindGen; other PBG bug fixes pulled from new version.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5249
diff changeset
   270
    for prec, ns3_module in enumerate(sorted_ns3_modules):
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   271
        section_name = "ns3_module_%s" % ns3_module.replace('-', '_')
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   272
        file_name = os.path.join(os.path.dirname(pygen_file_name), "%s.py" % section_name)
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   273
        sections.append(PygenSection(section_name, FileCodeSink(open(file_name, "wt")),
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   274
                                     section_name + "__local"))
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   275
        for header in ns3_modules[ns3_module][1]:
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   276
            headers_map[header] = section_name
5753
8c105b521d1b Python: rescan; need new 'section precedence' API from PyBindGen; other PBG bug fixes pulled from new version.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5249
diff changeset
   277
        section_precendences[section_name] = prec
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   278
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   279
    module_parser = ModuleParser('ns3', 'ns3')
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   280
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   281
    module_parser.add_pre_scan_hook(pre_scan_hook)
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   282
    #module_parser.add_post_scan_hook(post_scan_hook)
3474
dac9146297c8 Define NS3_ASSERT_ENABLE and NS3_LOG_ENABLE, to make sure we pick up all definitions (such as the logging APIs)
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3467
diff changeset
   283
dac9146297c8 Define NS3_ASSERT_ENABLE and NS3_LOG_ENABLE, to make sure we pick up all definitions (such as the logging APIs)
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3467
diff changeset
   284
    gccxml_options = dict(
dac9146297c8 Define NS3_ASSERT_ENABLE and NS3_LOG_ENABLE, to make sure we pick up all definitions (such as the logging APIs)
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3467
diff changeset
   285
        include_paths=[top_builddir],
dac9146297c8 Define NS3_ASSERT_ENABLE and NS3_LOG_ENABLE, to make sure we pick up all definitions (such as the logging APIs)
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3467
diff changeset
   286
         define_symbols={
3484
ebdeeb7cd463 When python scanning API, remove again the NS3_LOG_ENABLE define; it is no longer needed.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3474
diff changeset
   287
            #'NS3_ASSERT_ENABLE': None,
ebdeeb7cd463 When python scanning API, remove again the NS3_LOG_ENABLE define; it is no longer needed.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3474
diff changeset
   288
            #'NS3_LOG_ENABLE': None,
5249
85cde7d987ed Python: allow multiple api definitions directories, one per data model.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 4749
diff changeset
   289
            },
85cde7d987ed Python: allow multiple api definitions directories, one per data model.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 4749
diff changeset
   290
        cflags=('--gccxml-cxxflags %r' % (cflags,))
3474
dac9146297c8 Define NS3_ASSERT_ENABLE and NS3_LOG_ENABLE, to make sure we pick up all definitions (such as the logging APIs)
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3467
diff changeset
   291
        )
dac9146297c8 Define NS3_ASSERT_ENABLE and NS3_LOG_ENABLE, to make sure we pick up all definitions (such as the logging APIs)
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3467
diff changeset
   292
3409
94ac3e381075 The 'everything.h' header file is only used for Python bindings and should be generated into bindings/python/, not ns3/.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3408
diff changeset
   293
    module_parser.parse_init([everything_h],
3474
dac9146297c8 Define NS3_ASSERT_ENABLE and NS3_LOG_ENABLE, to make sure we pick up all definitions (such as the logging APIs)
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3467
diff changeset
   294
                             None, whitelist_paths=[top_builddir, os.path.dirname(everything_h)],
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   295
                             #includes=['"ns3/everything.h"'],
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   296
                             pygen_sink=sections,
5753
8c105b521d1b Python: rescan; need new 'section precedence' API from PyBindGen; other PBG bug fixes pulled from new version.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 5249
diff changeset
   297
                             pygen_classifier=MyPygenClassifier(headers_map, section_precendences),
3474
dac9146297c8 Define NS3_ASSERT_ENABLE and NS3_LOG_ENABLE, to make sure we pick up all definitions (such as the logging APIs)
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 3467
diff changeset
   298
                             gccxml_options=gccxml_options)
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   299
    module_parser.scan_types()
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   300
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   301
    callback_classes_file = open(os.path.join(os.path.dirname(pygen_file_name), "callbacks_list.py"), "wt")
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   302
    scan_callback_classes(module_parser, callback_classes_file)
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   303
    callback_classes_file.close()
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   304
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   305
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   306
    module_parser.scan_methods()
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   307
    module_parser.scan_functions()
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   308
    module_parser.parse_finalize()
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   309
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   310
    for section in sections:
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   311
        section.code_sink.file.close()
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   312
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   313
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   314
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   315
if __name__ == '__main__':
5249
85cde7d987ed Python: allow multiple api definitions directories, one per data model.
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents: 4749
diff changeset
   316
    ns3_module_scan(sys.argv[1], sys.argv[3], sys.argv[2], sys.argv[4])
3408
2cc40b3e4fa5 python bindings
Gustavo J. A. M. Carneiro <gjc@inescporto.pt>
parents:
diff changeset
   317