docs/doxygen/scripts/common.py

   1 # format: class : {method : (prototype1, prototype2)}
   2 # using a "*" means all prototypes
   3 ignored_methods = {
   4     "wxIcon": {'wxIcon': (['const char', 'int', 'int'], )},
   5 }
   6
   7 # these classes are either replaced by different data types in bindings, or have equivalent / better
   8 # functionality provided by the target language.
   9 excluded_classes = [
  10         "wxAny",
  11         "wxAnyValueType",
  12         "wxArchiveClassFactory",
  13         "wxArchiveEntry",
  14         "wxArchiveInputStream",
  15         "wxArchiveIterator",
  16         "wxArchiveNotifier",
  17         "wxArchiveOutputStream",
  18         "wxArray< T >",
  19         "wxArrayString",
  20         "wxAutomationObject",
  21         "wxBufferedInputStream",
  22         "wxBufferedOutputStream",
  23         "wxCharBuffer",
  24         "wxCharTypeBuffer",
  25         "wxClassInfo",
  26         "wxCmdLineParser",
  27         "wxCondition",
  28         "wxConnection",
  29         "wxConnectionBase",
  30         "wxConvAuto",
  31         "wxCountingOutputStream",
  32         "wxCriticalSection",
  33         "wxCriticalSectionLocker",
  34         "wxCSConv",
  35         "wxDatagramSocket",
  36         "wxDataInputStream",
  37         "wxDataOutputStream",
  38         "wxDir",
  39         "wxDirTraverser",
  40         "wxFFile",
  41         "wxFFileInputStream",
  42         "wxFFileOutputStream",
  43         "wxFile",
  44         "wxFileInputStream",
  45         "wxFileName",
  46         "wxFileOutputStream",
  47         "wxFileStream",
  48         "wxFilterClassFactory",
  49         "wxFilterInputStream",
  50         "wxFilterOutputStream",
  51         "wxFSFile",
  52         "wxFSVolume",
  53         "wxFTP",
  54         "wxHashMap",
  55         "wxHashSet",
  56         "wxHashTable",
  57         "wxHTTP",
  58         "wxImage::HSVValue",
  59         "wxImage::RGBValue",
  60         "wxInputStream",
  61         "wxIPAddress",
  62         "wxIPV4Address",
  63         "wxList< T >",
  64         "wxLongLong",
  65         "wxMBConv",
  66         "wxMBConvFile",
  67         "wxMBConvUTF7",
  68         "wxMBConvUTF8",
  69         "wxMBConvUTF16",
  70         "wxMBConvUTF32",
  71         "wxMemoryBuffer",
  72         "wxMemoryFSHandler",
  73         "wxMemoryInputStream",
  74         "wxMemoryOutputStream",
  75         "wxMessageQueue< T >",
  76         "wxModule",
  77         "wxMutex",
  78         "wxMutexLocker",
  79         "wxNode< T >",
  80         "wxObjectDataPtr< T >",
  81         "wxObjectRefData",
  82         "wxOutputStream",
  83         "wxProcess",
  84         "wxProcessEvent",
  85         "wxProtocol",
  86         "wxProtocolLog",
  87         "wxRecursionGuard",
  88         "wxRecursionGuardFlag",
  89         "wxRegKey",
  90         "wxScopedArray",
  91         "wxScopedCharTypeBuffer",
  92         "wxScopedPtr",
  93         "wxScopedPtr< T >",
  94         "wxSharedPtr< T >",
  95         "wxServer",
  96         "wxSockAddress",
  97         "wxSocketBase",
  98         "wxSocketClient",
  99         "wxSocketEvent",
 100         "wxSocketInputStream",
 101         "wxSocketOutputStream",
 102         "wxSortedArrayString",
 103         "wxStopWatch",
 104         "wxStreamBase",
 105         "wxStreamBuffer",
 106         "wxStreamToTextRedirector",
 107         "wxString",
 108         "wxStringBuffer",
 109         "wxStringBufferLength",
 110         "wxStringClientData",
 111         "wxStringInputStream",
 112         "wxStringOutputStream",
 113         "wxTarClassFactory",
 114         "wxTarEntry",
 115         "wxTarInputStream",
 116         "wxTarOutputStream",
 117         "wxTCPClient",
 118         "wxTCPConnection",
 119         "wxTCPServer",
 120         "wxTempFile",
 121         "wxTempFileOutputStream",
 122         "wxTextInputStream",
 123         "wxTextOutputStream",
 124         "wxThread",
 125         "wxThreadEvent",
 126         "wxThreadHelper",
 127         "wxULongLong",
 128         "wxUniChar",
 129         "wxUniCharRef",
 130         "wxURI",
 131         "wxURL",
 132         "wxUString",
 133         "wxVariant",
 134         "wxVariantData",
 135         "wxVector< T >",
 136         "wxVector< T >::reverse_iterator",
 137         "wxWCharBuffer",
 138         "wxWeakRef< T >",
 139         "wxWeakRefDynamic< T >",
 140         "wxZipInputStream",
 141         "wxZipOutputStream",
 142         "wxZlibInputStream",
 143         "wxZlibOutputStream",
 144         ]
 145
 146 def get_first_value(alist):
 147     if len(alist) > 0:
 148         return alist[0]
 149     else:
 150         return ""
 151
 152 def make_enums(aclass):
 153     retval = ""
 154     for enum in aclass.enums:
 155         retval += "enum %s {\n" % enum
 156         num_values = len(aclass.enums[enum])
 157         for value in aclass.enums[enum]:
 158             retval += "    %s" % value
 159             if not value == aclass.enums[enum][-1]:
 160                 retval += ", "
 161             retval += "\n"
 162         retval += "};\n\n"
 163
 164     return retval