]> git.saurik.com Git - wxWidgets.git/blobdiff - src/stc/gen_iface.py
fix MSVC warnings about possibly uninitialized variables; some reindentation
[wxWidgets.git] / src / stc / gen_iface.py
old mode 100644 (file)
new mode 100755 (executable)
index 9a6c188..ed71e5d
@@ -1,4 +1,4 @@
-#!/bin/env python
+#!/usr/bin/env python
 #----------------------------------------------------------------------------
 # Name:         gen_iface.py
 # Purpose:      Generate stc.h and stc.cpp from the info in Scintilla.iface
@@ -21,7 +21,7 @@ H_TEMPLATE    = os.path.abspath('./stc.h.in')
 CPP_TEMPLATE  = os.path.abspath('./stc.cpp.in')
 H_DEST        = os.path.abspath('../../include/wx/stc/stc.h')
 CPP_DEST      = os.path.abspath('./stc.cpp')
-DOCSTR_DEST   = os.path.abspath('../../../wxPython/contrib/stc/_stc_gendocs.i')
+DOCSTR_DEST   = '/dev/null' #os.path.abspath('../../../wxPython/contrib/stc/_stc_gendocs.i')
 
 
 # Value prefixes to convert
@@ -37,16 +37,17 @@ valPrefixes = [('SCI_', ''),
 ]
 
 # Message function values that should have a CMD_ constant generated
-cmdValues = [ (2300, 2349),
-              2011,
+cmdValues = [ 2011,
               2013,
               (2176, 2180),
+              (2300, 2349),
               (2390, 2393),
               (2395, 2396),
               2404,
               (2413, 2416),
               (2426, 2442),
               (2450, 2455),
+              2518,
             ]
 
 
@@ -84,14 +85,14 @@ methodOverrideMap = {
 
                  '''void %s(const wxString& text) {
                     wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text);
-                    SendMsg(%s, strlen(buf), (long)(const char*)buf);''',
+                    SendMsg(%s, strlen(buf), (sptr_t)(const char*)buf);''',
                  0),
 
     'AddStyledText' : (0,
                        'void %s(const wxMemoryBuffer& data);',
 
                        '''void %s(const wxMemoryBuffer& data) {
-                          SendMsg(%s, data.GetDataLen(), (long)data.GetData());''',
+                          SendMsg(%s, data.GetDataLen(), (sptr_t)data.GetData());''',
                        0),
 
     'AppendText' : (0,
@@ -99,7 +100,7 @@ methodOverrideMap = {
 
                  '''void %s(const wxString& text) {
                     wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text);
-                    SendMsg(%s, strlen(buf), (long)(const char*)buf);''',
+                    SendMsg(%s, strlen(buf), (sptr_t)(const char*)buf);''',
                  0),
 
     'GetViewWS' : ( 'GetViewWhiteSpace', 0, 0, 0),
@@ -107,13 +108,13 @@ methodOverrideMap = {
 
     'GetCharAt' :
     ( 0, 0,
-      '''int %s(int pos) {
+      '''int %s(int pos) const {
          return (unsigned char)SendMsg(%s, pos, 0);''',
       0),
 
     'GetStyleAt' :
     ( 0, 0,
-      '''int %s(int pos) {
+      '''int %s(int pos) const {
          return (unsigned char)SendMsg(%s, pos, 0);''',
       0),
 
@@ -134,7 +135,7 @@ methodOverrideMap = {
         tr.lpstrText = (char*)buf.GetWriteBuf(len*2+1);
         tr.chrg.cpMin = startPos;
         tr.chrg.cpMax = endPos;
-        len = SendMsg(%s, 0, (long)&tr);
+        len = SendMsg(%s, 0, (sptr_t)&tr);
         buf.UngetWriteBuf(len);
         return buf;''',
 
@@ -143,9 +144,9 @@ methodOverrideMap = {
 
     'PositionFromPoint' :
     (0,
-     'int %s(wxPoint pt);',
+     'int %s(wxPoint pt) const;',
 
-     '''int %s(wxPoint pt) {
+     '''int %s(wxPoint pt) const {
         return SendMsg(%s, pt.x, pt.y);''',
      0),
 
@@ -163,7 +164,7 @@ methodOverrideMap = {
         wxMemoryBuffer mbuf(len+1);
         char* buf = (char*)mbuf.GetWriteBuf(len+1);
 
-        int pos = SendMsg(%s, len+1, (long)buf);
+        int pos = SendMsg(%s, len+1, (sptr_t)buf);
         mbuf.UngetWriteBuf(len);
         mbuf.AppendByte(0);
         if (linePos)  *linePos = pos;
@@ -203,12 +204,14 @@ methodOverrideMap = {
         // convert bmp to a xpm in a string
         wxMemoryOutputStream strm;
         wxImage img = bmp.ConvertToImage();
+        if (img.HasAlpha())
+            img.ConvertAlphaToMask();
         img.SaveFile(strm, wxBITMAP_TYPE_XPM);
         size_t len = strm.GetSize();
         char* buff = new char[len+1];
         strm.CopyTo(buff, len);
         buff[len] = 0;
-        SendMsg(%s, markerNumber, (long)buff);
+        SendMsg(%s, markerNumber, (sptr_t)buff);
         delete [] buff;
         ''',
      ('Define a marker from a bitmap',)),
@@ -223,14 +226,30 @@ methodOverrideMap = {
     'SetMarginSensitiveN' : ('SetMarginSensitive', 0, 0, 0),
     'GetMarginSensitiveN' : ('GetMarginSensitive', 0, 0, 0),
 
+
+    'StyleGetFore' : ('StyleGetForeground', 0, 0, 0),
+    'StyleGetBack' : ('StyleGetBackground', 0, 0, 0),
     'StyleSetFore' : ('StyleSetForeground', 0, 0, 0),
     'StyleSetBack' : ('StyleSetBackground', 0, 0, 0),
     'SetSelFore' : ('SetSelForeground', 0, 0, 0),
     'SetSelBack' : ('SetSelBackground', 0, 0, 0),
     'SetCaretFore' : ('SetCaretForeground', 0, 0, 0),
+    'StyleGetFont' :
+    ('StyleGetFaceName',
+     'wxString %s(int style);',
+      '''wxString %s(int style) {
+         long msg = %s;
+         long len = SendMsg(msg, style, 0);
+         wxMemoryBuffer mbuf(len+1);
+         char* buf = (char*)mbuf.GetWriteBuf(len+1);
+         SendMsg(msg, style, (sptr_t)buf);
+         mbuf.UngetWriteBuf(len);
+         mbuf.AppendByte(0);
+         return stc2wx(buf);''',
+         ('Get the font facename of a style',)),
     'StyleSetFont' : ('StyleSetFaceName', 0, 0, 0),
     'StyleSetCharacterSet' : (None, 0, 0, 0),
-    
+
     'AssignCmdKey' :
     ('CmdKeyAssign',
      'void %s(int key, int modifiers, int cmd);',
@@ -256,7 +275,7 @@ methodOverrideMap = {
      'void %s(int length, char* styleBytes);',
 
      '''void %s(int length, char* styleBytes) {
-        SendMsg(%s, length, (long)styleBytes);''',
+        SendMsg(%s, length, (sptr_t)styleBytes);''',
      0),
 
 
@@ -264,6 +283,8 @@ methodOverrideMap = {
     'IndicGetStyle' : ('IndicatorGetStyle', 0, 0, 0),
     'IndicSetFore' : ('IndicatorSetForeground', 0, 0, 0),
     'IndicGetFore' : ('IndicatorGetForeground', 0, 0, 0),
+    'IndicSetUnder': ('IndicatorSetUnder', 0, 0, 0),
+    'IndicGetUnder': ('IndicatorGetUnder', 0, 0, 0),
 
     'SetWhitespaceFore' : ('SetWhitespaceForeground', 0, 0, 0),
     'SetWhitespaceBack' : ('SetWhitespaceBackground', 0, 0, 0),
@@ -291,6 +312,11 @@ methodOverrideMap = {
     'AutoCGetTypeSeparator' : ('AutoCompGetTypeSeparator', 0, 0, 0),
     'AutoCSetTypeSeparator' : ('AutoCompSetTypeSeparator', 0, 0, 0),
     'AutoCGetCurrent'       : ('AutoCompGetCurrent', 0, 0, 0),
+    'AutoCSetMaxWidth'      : ('AutoCompSetMaxWidth', 0, 0, 0),
+    'AutoCGetMaxWidth'      : ('AutoCompGetMaxWidth', 0, 0, 0),
+    'AutoCSetMaxHeight'     : ('AutoCompSetMaxHeight', 0, 0, 0),
+    'AutoCGetMaxHeight'     : ('AutoCompGetMaxHeight', 0, 0, 0),
+    'AutoCGetMaxHeight'     : ('AutoCompGetMaxHeight', 0, 0, 0),
 
     'RegisterImage' :
     (0,
@@ -299,12 +325,14 @@ methodOverrideMap = {
         // convert bmp to a xpm in a string
         wxMemoryOutputStream strm;
         wxImage img = bmp.ConvertToImage();
+        if (img.HasAlpha())
+            img.ConvertAlphaToMask();
         img.SaveFile(strm, wxBITMAP_TYPE_XPM);
         size_t len = strm.GetSize();
         char* buff = new char[len+1];
         strm.CopyTo(buff, len);
         buff[len] = 0;
-        SendMsg(%s, type, (long)buff);
+        SendMsg(%s, type, (sptr_t)buff);
         delete [] buff;
      ''',
      ('Register an image for use in autocompletion lists.',)),
@@ -337,7 +365,7 @@ methodOverrideMap = {
             wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text);
             ft.lpstrText = (char*)(const char*)buf;
 
-            return SendMsg(%s, flags, (long)&ft);''',
+            return SendMsg(%s, flags, (sptr_t)&ft);''',
      0),
 
     'FormatRange' :
@@ -346,14 +374,14 @@ methodOverrideMap = {
                int    startPos,
                int    endPos,
                wxDC*  draw,
-               wxDC*  target, 
+               wxDC*  target,
                wxRect renderRect,
                wxRect pageRect);''',
      ''' int %s(bool   doDraw,
                 int    startPos,
                 int    endPos,
                 wxDC*  draw,
-                wxDC*  target, 
+                wxDC*  target,
                 wxRect renderRect,
                 wxRect pageRect) {
              RangeToFormat fr;
@@ -376,36 +404,36 @@ methodOverrideMap = {
              fr.chrg.cpMin = startPos;
              fr.chrg.cpMax = endPos;
 
-             return SendMsg(%s, doDraw, (long)&fr);''',
+             return SendMsg(%s, doDraw, (sptr_t)&fr);''',
      0),
 
 
     'GetLine' :
     (0,
-     'wxString %s(int line);',
+     'wxString %s(int line) const;',
 
-     '''wxString %s(int line) {
+     '''wxString %s(int line) const {
          int len = LineLength(line);
          if (!len) return wxEmptyString;
 
          wxMemoryBuffer mbuf(len+1);
          char* buf = (char*)mbuf.GetWriteBuf(len+1);
-         SendMsg(%s, line, (long)buf);
+         SendMsg(%s, line, (sptr_t)buf);
          mbuf.UngetWriteBuf(len);
          mbuf.AppendByte(0);
          return stc2wx(buf);''',
 
      ('Retrieve the contents of a line.',)),
 
-    'SetSel' : ('SetSelection', 0, 0, 0),
+    'SetSel' : (None, 0,0,0), #'SetSelection', 0, 0, 0),
 
     'GetSelText' :
     ('GetSelectedText',
      'wxString %s();',
 
      '''wxString %s() {
-         int   start;
-         int   end;
+         long   start;
+         long   end;
 
          GetSelection(&start, &end);
          int   len  = end - start;
@@ -413,7 +441,7 @@ methodOverrideMap = {
 
          wxMemoryBuffer mbuf(len+2);
          char* buf = (char*)mbuf.GetWriteBuf(len+1);
-         SendMsg(%s, 0, (long)buf);
+         SendMsg(%s, 0, (sptr_t)buf);
          mbuf.UngetWriteBuf(len);
          mbuf.AppendByte(0);
          return stc2wx(buf);''',
@@ -439,7 +467,7 @@ methodOverrideMap = {
          tr.lpstrText = buf;
          tr.chrg.cpMin = startPos;
          tr.chrg.cpMax = endPos;
-         SendMsg(%s, 0, (long)&tr);
+         SendMsg(%s, 0, (sptr_t)&tr);
          mbuf.UngetWriteBuf(len);
          mbuf.AppendByte(0);
          return stc2wx(buf);''',
@@ -455,13 +483,13 @@ methodOverrideMap = {
 
     'GetText' :
     (0,
-     'wxString %s();',
+     'wxString %s() const;',
 
-     '''wxString %s() {
+     '''wxString %s() const {
          int len  = GetTextLength();
          wxMemoryBuffer mbuf(len+1);   // leave room for the null...
          char* buf = (char*)mbuf.GetWriteBuf(len+1);
-         SendMsg(%s, len+1, (long)buf);
+         SendMsg(%s, len+1, (sptr_t)buf);
          mbuf.UngetWriteBuf(len);
          mbuf.AppendByte(0);
          return stc2wx(buf);''',
@@ -479,7 +507,11 @@ methodOverrideMap = {
 
     'SetHotspotActiveFore' : ('SetHotspotActiveForeground', 0, 0, 0),
     'SetHotspotActiveBack' : ('SetHotspotActiveBackground', 0, 0, 0),
+    'GetHotspotActiveFore' : ('GetHotspotActiveForeground', 0, 0, 0),
+    'GetHotspotActiveBack' : ('GetHotspotActiveBackground', 0, 0, 0),
 
+    'GetCaretLineBack' : ('GetCaretLineBackground', 0, 0, 0),
+    'SetCaretLineBack' : ('SetCaretLineBackground', 0, 0, 0),
 
     'ReplaceTarget' :
     (0,
@@ -488,7 +520,7 @@ methodOverrideMap = {
      '''
      int %s(const wxString& text) {
          wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text);
-         return SendMsg(%s, strlen(buf), (long)(const char*)buf);''',
+         return SendMsg(%s, strlen(buf), (sptr_t)(const char*)buf);''',
      0),
 
     'ReplaceTargetRE' :
@@ -498,7 +530,7 @@ methodOverrideMap = {
      '''
      int %s(const wxString& text) {
          wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text);
-         return SendMsg(%s, strlen(buf), (long)(const char*)buf);''',
+         return SendMsg(%s, strlen(buf), (sptr_t)(const char*)buf);''',
      0),
 
     'SearchInTarget' :
@@ -508,14 +540,52 @@ methodOverrideMap = {
      '''
      int %s(const wxString& text) {
          wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text);
-         return SendMsg(%s, strlen(buf), (long)(const char*)buf);''',
+         return SendMsg(%s, strlen(buf), (sptr_t)(const char*)buf);''',
      0),
 
     # not sure what to do about these yet
     'TargetAsUTF8' :       ( None, 0, 0, 0),
     'SetLengthForEncode' : ( None, 0, 0, 0),
     'EncodedFromUTF8' :    ( None, 0, 0, 0),
-    
+
+
+    'GetProperty' :
+    (0,
+     'wxString %s(const wxString& key);',
+
+     '''wxString %s(const wxString& key) {
+         int len = SendMsg(SCI_GETPROPERTY, (sptr_t)(const char*)wx2stc(key), 0);
+         if (!len) return wxEmptyString;
+
+         wxMemoryBuffer mbuf(len+1);
+         char* buf = (char*)mbuf.GetWriteBuf(len+1);
+         SendMsg(%s, (uptr_t)(const char*)wx2stc(key), (sptr_t)buf);
+         mbuf.UngetWriteBuf(len);
+         mbuf.AppendByte(0);
+         return stc2wx(buf);''',
+     ("Retrieve a 'property' value previously set with SetProperty.",)),
+
+    'GetPropertyExpanded' :
+    (0,
+     'wxString %s(const wxString& key);',
+
+     '''wxString %s(const wxString& key) {
+         int len = SendMsg(SCI_GETPROPERTYEXPANDED, (uptr_t)(const char*)wx2stc(key), 0);
+         if (!len) return wxEmptyString;
+
+         wxMemoryBuffer mbuf(len+1);
+         char* buf = (char*)mbuf.GetWriteBuf(len+1);
+         SendMsg(%s, (uptr_t)(const char*)wx2stc(key), (sptr_t)buf);
+         mbuf.UngetWriteBuf(len);
+         mbuf.AppendByte(0);
+         return stc2wx(buf);''',
+     ("Retrieve a 'property' value previously set with SetProperty,",
+      "with '$()' variable replacement on returned buffer.")),
+
+    'GetPropertyInt'   : (0, 0, 0,
+       ("Retrieve a 'property' value previously set with SetProperty,",
+        "interpreted as an int AFTER any '$()' variable replacement.")),
+
 
     'GetDocPointer' :
     (0,
@@ -528,7 +598,7 @@ methodOverrideMap = {
     (0,
      'void %s(void* docPointer);',
      '''void %s(void* docPointer) {
-         SendMsg(%s, 0, (long)docPointer);''',
+         SendMsg(%s, 0, (sptr_t)docPointer);''',
      0),
 
     'CreateDocument' :
@@ -542,14 +612,14 @@ methodOverrideMap = {
     (0,
      'void %s(void* docPointer);',
      '''void %s(void* docPointer) {
-         SendMsg(%s, 0, (long)docPointer);''',
+         SendMsg(%s, 0, (sptr_t)docPointer);''',
      0),
 
     'ReleaseDocument' :
     (0,
      'void %s(void* docPointer);',
      '''void %s(void* docPointer) {
-         SendMsg(%s, 0, (long)docPointer);''',
+         SendMsg(%s, 0, (sptr_t)docPointer);''',
      0),
 
     'SetCodePage' :
@@ -577,11 +647,27 @@ methodOverrideMap = {
 
     'LoadLexerLibrary' : (None, 0,0,0),
 
+    'SetPositionCache' : ('SetPositionCacheSize', 0, 0, 0),
+    'GetPositionCache' : ('GetPositionCacheSize', 0, 0, 0),
+
 
     '' : ('', 0, 0, 0),
 
     }
 
+# all Scintilla getters are transformed into const member of wxSTC class but
+# some non-getter methods are also logically const and this set contains their
+# names (notice that it's useless to include here methods manually overridden
+# above)
+constNonGetterMethods = set((
+    'LineFromPosition',
+    'PositionFromLine',
+    'LineLength',
+    'CanPaste',
+    'CanRedo',
+    'CanUndo',
+))
+
 #----------------------------------------------------------------------------
 
 def processIface(iface, h_tmplt, cpp_tmplt, h_dest, cpp_dest, docstr_dest):
@@ -607,7 +693,7 @@ def processIface(iface, h_tmplt, cpp_tmplt, h_dest, cpp_dest, docstr_dest):
             curDocStrings = []
 
         elif op == 'fun ' or op == 'set ' or op == 'get ':
-            parseFun(line[4:], methods, curDocStrings, cmds)
+            parseFun(line[4:], methods, curDocStrings, cmds, op == 'get ')
             curDocStrings = []
 
         elif op == 'cat ':
@@ -669,7 +755,7 @@ def processMethods(methods):
     imps = []
     dstr = []
 
-    for retType, name, number, param1, param2, docs in methods:
+    for retType, name, number, param1, param2, docs, is_const in methods:
         retType = retTypeMap.get(retType, retType)
         params = makeParamString(param1, param2)
 
@@ -682,14 +768,17 @@ def processMethods(methods):
         st = 'DocStr(wxStyledTextCtrl::%s,\n' \
              '"%s", "");\n' % (name, '\n'.join(docs))
         dstr.append(st)
-        
+
         # Build the method definition for the .h file
         if docs:
             defs.append('')
             for x in docs:
                 defs.append('    // ' + x)
         if not theDef:
-            theDef = '    %s %s(%s);' % (retType, name, params)
+            theDef = '    %s %s(%s)' % (retType, name, params)
+            if is_const:
+                theDef = theDef + ' const'
+            theDef = theDef + ';'
         defs.append(theDef)
 
         # Build the method implementation string
@@ -698,8 +787,10 @@ def processMethods(methods):
             for x in docs:
                 imps.append('// ' + x)
         if not theImp:
-            theImp = '%s wxStyledTextCtrl::%s(%s) {\n    ' % (retType, name, params)
-
+            theImp = '%s wxStyledTextCtrl::%s(%s)' % (retType, name, params)
+            if is_const:
+                theImp = theImp + ' const'
+            theImp = theImp + '\n{\n    '
             if retType == 'wxColour':
                 theImp = theImp + 'long c = '
             elif retType != 'void':
@@ -750,7 +841,7 @@ def makeArgString(param):
     typ, name = param
 
     if typ == 'string':
-        return '(long)(const char*)wx2stc(%s)' % name
+        return '(sptr_t)(const char*)wx2stc(%s)' % name
     if typ == 'colour':
         return 'wxColourAsLong(%s)' % name
 
@@ -797,7 +888,7 @@ funregex = re.compile(r'\s*([a-zA-Z0-9_]+)'  # <ws>return type
                       '\(([ a-zA-Z0-9_]*),'  # (param,
                       '([ a-zA-Z0-9_]*)\)')  # param)
 
-def parseFun(line, methods, docs, values):
+def parseFun(line, methods, docs, values, is_const):
     def parseParam(param):
         param = string.strip(param)
         if param == '':
@@ -820,13 +911,14 @@ def parseFun(line, methods, docs, values):
     for v in cmdValues:
         if (type(v) == type(()) and v[0] <= num <= v[1]) or v == num:
             parseVal('CMD_%s=%s' % (string.upper(name), number), values, docs)
-            
+
             # if we are not also doing a function for CMD values, then
             # just return, otherwise fall through to the append blow.
             if not FUNC_FOR_CMD:
                 return
-                
-    methods.append( (retType, name, number, param1, param2, tuple(docs)) )
+
+    methods.append( (retType, name, number, param1, param2, tuple(docs),
+                     is_const or name in constNonGetterMethods) )
 
 
 #----------------------------------------------------------------------------
@@ -835,6 +927,10 @@ def parseFun(line, methods, docs, values):
 def main(args):
     # TODO: parse command line args to replace default input/output files???
 
+    if not os.path.exists(IFACE):
+        print 'Please run this script from src/stc subdirectory.'
+        sys.exit(1)
+
     # Now just do it
     processIface(IFACE, H_TEMPLATE, CPP_TEMPLATE, H_DEST, CPP_DEST, DOCSTR_DEST)