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