X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e1a93f46d5d7851a90764844059b286ca738dcd6..ed8f0b067521d3b86db3a73c5843aea6f3b13605:/src/stc/gen_iface.py diff --git a/src/stc/gen_iface.py b/src/stc/gen_iface.py old mode 100644 new mode 100755 index 4c7d15bcca..ff2b7b6360 --- a/src/stc/gen_iface.py +++ b/src/stc/gen_iface.py @@ -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 @@ -8,7 +8,7 @@ # Created: 5-Sept-2000 # RCS-ID: $Id$ # Copyright: (c) 2000 by Total Control Software -# Licence: wxWindows license +# Licence: wxWindows licence #---------------------------------------------------------------------------- @@ -21,6 +21,10 @@ 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') +if len(sys.argv) > 1 and sys.argv[1] == '--wxpython': + DOCSTR_DEST = os.path.abspath('../../../wxPython/src/_stc_gendocs.i') +else: + DOCSTR_DEST = '/dev/null' # Value prefixes to convert @@ -28,6 +32,7 @@ valPrefixes = [('SCI_', ''), ('SC_', ''), ('SCN_', None), # just toss these out... ('SCEN_', None), + ('SC_EFF', None), ('SCE_', ''), ('SCLEX_', 'LEX_'), ('SCK_', 'KEY_'), @@ -35,8 +40,23 @@ valPrefixes = [('SCI_', ''), ('SCWS_', 'WS_'), ] -# Message function values that should have a CMD_ constant as well -cmdValues = [ (2300, 2350), 2011, 2013, (2176, 2180) ] +# Message function values that should have a CMD_ constant generated +cmdValues = [ 2011, + 2013, + (2176, 2180), + (2300, 2349), + (2390, 2393), + (2395, 2396), + 2404, + (2413, 2416), + (2426, 2442), + (2450, 2455), + 2518, + ] + + +# Should a funciton be also generated for the CMDs? +FUNC_FOR_CMD = 1 # Map some generic typenames to wx types, using return value syntax @@ -68,93 +88,140 @@ methodOverrideMap = { 'void %s(const wxString& text);', '''void %s(const wxString& text) { - SendMsg(%s, text.Len(), (long)text.c_str());''', + wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text); + SendMsg(%s, strlen(buf), (sptr_t)(const char*)buf);''', 0), 'AddStyledText' : (0, - 'void %s(const wxString& text);', + 'void %s(const wxMemoryBuffer& data);', - '''void %s(const wxString& text) { - SendMsg(%s, text.Len(), (long)text.c_str());''', + '''void %s(const wxMemoryBuffer& data) { + SendMsg(%s, data.GetDataLen(), (sptr_t)data.GetData());''', 0), - 'GetViewWS' : ( 'GetViewWhiteSpace', 0, 0, 0), - 'SetViewWS' : ( 'SetViewWhiteSpace', 0, 0, 0), - - 'GetStyledText' : (0, - 'wxString %s(int startPos, int endPos);', - - '''wxString %s(int startPos, int endPos) { - wxString text; - if (endPos < startPos) { - int temp = startPos; - startPos = endPos; - endPos = temp; - } - int len = endPos - startPos; - if (!len) return ""; - TextRange tr; - tr.lpstrText = text.GetWriteBuf(len*2); - tr.chrg.cpMin = startPos; - tr.chrg.cpMax = endPos; - SendMsg(%s, 0, (long)&tr); - text.UngetWriteBuf(len*2); - return text;''', - - ('Retrieve a buffer of cells.',)), - - - 'PositionFromPoint' : (0, - 'int %s(wxPoint pt);', - - '''int %s(wxPoint pt) { - return SendMsg(%s, pt.x, pt.y);''', - - 0), - - 'GetCurLine' : (0, - '#ifdef SWIG\n wxString %s(int* OUTPUT);\n#else\n wxString GetCurLine(int* linePos=NULL);\n#endif', - - '''wxString %s(int* linePos) { - wxString text; - int len = LineLength(GetCurrentLine()); - if (!len) { - if (linePos) *linePos = 0; - return ""; - } - // Need an extra byte because SCI_GETCURLINE writes a null to the string - char* buf = text.GetWriteBuf(len+1); + 'AppendText' : (0, + 'void %s(const wxString& text);', - int pos = SendMsg(%s, len+1, (long)buf); - text.UngetWriteBuf(len); - if (linePos) *linePos = pos; + '''void %s(const wxString& text) { + wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text); + SendMsg(%s, strlen(buf), (sptr_t)(const char*)buf);''', + 0), - return text;''', + 'GetViewWS' : ( 'GetViewWhiteSpace', 0, 0, 0), + 'SetViewWS' : ( 'SetViewWhiteSpace', 0, 0, 0), - 0), + 'GetCharAt' : + ( 0, 0, + '''int %s(int pos) const { + return (unsigned char)SendMsg(%s, pos, 0);''', + 0), + + 'GetStyleAt' : + ( 0, 0, + '''int %s(int pos) const { + return (unsigned char)SendMsg(%s, pos, 0);''', + 0), + + 'GetStyledText' : + (0, + 'wxMemoryBuffer %s(int startPos, int endPos);', + + '''wxMemoryBuffer %s(int startPos, int endPos) { + wxMemoryBuffer buf; + if (endPos < startPos) { + int temp = startPos; + startPos = endPos; + endPos = temp; + } + int len = endPos - startPos; + if (!len) return buf; + TextRange tr; + tr.lpstrText = (char*)buf.GetWriteBuf(len*2+1); + tr.chrg.cpMin = startPos; + tr.chrg.cpMax = endPos; + len = SendMsg(%s, 0, (sptr_t)&tr); + buf.UngetWriteBuf(len); + return buf;''', + + ('Retrieve a buffer of cells.',)), + + + 'PositionFromPoint' : + (0, + 'int %s(wxPoint pt) const;', + + '''int %s(wxPoint pt) const { + return SendMsg(%s, pt.x, pt.y);''', + 0), + + 'GetCurLine' : + (0, + '#ifdef SWIG\n wxString %s(int* OUTPUT);\n#else\n wxString GetCurLine(int* linePos=NULL);\n#endif', + + '''wxString %s(int* linePos) { + int len = LineLength(GetCurrentLine()); + if (!len) { + if (linePos) *linePos = 0; + return wxEmptyString; + } + + wxMemoryBuffer mbuf(len+1); + char* buf = (char*)mbuf.GetWriteBuf(len+1); + + int pos = SendMsg(%s, len+1, (sptr_t)buf); + mbuf.UngetWriteBuf(len); + mbuf.AppendByte(0); + if (linePos) *linePos = pos; + return stc2wx(buf);''', + + 0), 'SetUsePalette' : (None, 0,0,0), 'MarkerSetFore' : ('MarkerSetForeground', 0, 0, 0), 'MarkerSetBack' : ('MarkerSetBackground', 0, 0, 0), - 'MarkerDefine' : (0, - '''void %s(int markerNumber, int markerSymbol, - const wxColour& foreground = wxNullColour, - const wxColour& background = wxNullColour);''', - - '''void %s(int markerNumber, int markerSymbol, - const wxColour& foreground, - const wxColour& background) { + 'MarkerSymbolDefined' : ('GetMarkerSymbolDefined', 0, 0, 0), + + 'MarkerDefine' : + (0, + '''void %s(int markerNumber, int markerSymbol, + const wxColour& foreground = wxNullColour, + const wxColour& background = wxNullColour);''', + + '''void %s(int markerNumber, int markerSymbol, + const wxColour& foreground, + const wxColour& background) { + + SendMsg(%s, markerNumber, markerSymbol); + if (foreground.Ok()) + MarkerSetForeground(markerNumber, foreground); + if (background.Ok()) + MarkerSetBackground(markerNumber, background);''', + + ('Set the symbol used for a particular marker number,', + 'and optionally the fore and background colours.')), + + + 'MarkerDefinePixmap' : + ('MarkerDefineBitmap', + '''void %s(int markerNumber, const wxBitmap& bmp);''', + '''void %s(int markerNumber, const wxBitmap& bmp) { + // 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, (sptr_t)buff); + delete [] buff; + ''', + ('Define a marker from a bitmap',)), - SendMsg(%s, markerNumber, markerSymbol); - if (foreground.Ok()) - MarkerSetForeground(markerNumber, foreground); - if (background.Ok()) - MarkerSetBackground(markerNumber, background);''', - - ('Set the symbol used for a particular marker number,', - 'and optionally the for and background colours.')), 'SetMarginTypeN' : ('SetMarginType', 0, 0, 0), 'GetMarginTypeN' : ('GetMarginType', 0, 0, 0), @@ -165,48 +232,138 @@ methodOverrideMap = { 'SetMarginSensitiveN' : ('SetMarginSensitive', 0, 0, 0), 'GetMarginSensitiveN' : ('GetMarginSensitive', 0, 0, 0), + 'MarginGetText' : + (0, + 'wxString %s(int line) const;', + + '''wxString %s(int line) const { + long msg = %s; + long len = SendMsg(msg, line, 0); + + wxMemoryBuffer mbuf(len+1); + char* buf = (char*)mbuf.GetWriteBuf(len+1); + SendMsg(msg, line, (sptr_t)buf); + mbuf.UngetWriteBuf(len); + mbuf.AppendByte(0); + return stc2wx(buf);''', + 0), + + 'MarginGetStyles' : + (0, + 'wxString %s(int line) const;', + + '''wxString %s(int line) const { + long msg = %s; + long len = SendMsg(msg, line, 0); + + wxMemoryBuffer mbuf(len+1); + char* buf = (char*)mbuf.GetWriteBuf(len+1); + SendMsg(msg, line, (sptr_t)buf); + mbuf.UngetWriteBuf(len); + mbuf.AppendByte(0); + return stc2wx(buf);''', + 0), + + 'SetAdditionalSelFore' : ('SetAdditionalSelForeground', 0, 0, 0), + 'SetAdditionalSelBack' : ('SetAdditionalSelBackground', 0, 0, 0), + 'SetAdditionalCaretFore' : ('SetAdditionalCaretForeground', 0, 0, 0), + 'GetAdditionalCaretFore' : ('GetAdditionalCaretForeground', 0, 0, 0), + + 'AnnotationGetText' : + (0, + 'wxString %s(int line) const;', + + '''wxString %s(int line) const { + long msg = %s; + long len = SendMsg(msg, line, 0); + + wxMemoryBuffer mbuf(len+1); + char* buf = (char*)mbuf.GetWriteBuf(len+1); + SendMsg(msg, line, (sptr_t)buf); + mbuf.UngetWriteBuf(len); + mbuf.AppendByte(0); + return stc2wx(buf);''', + 0), + + 'AnnotationGetStyles' : + (0, + 'wxString %s(int line) const;', + + '''wxString %s(int line) const { + long msg = %s; + long len = SendMsg(msg, line, 0); + + wxMemoryBuffer mbuf(len+1); + char* buf = (char*)mbuf.GetWriteBuf(len+1); + SendMsg(msg, line, (sptr_t)buf); + mbuf.UngetWriteBuf(len); + mbuf.AppendByte(0); + return stc2wx(buf);''', + 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), - - # need to fix this to map between wx and scintilla encoding flags, leave it out for now... 'StyleSetCharacterSet' : (None, 0, 0, 0), - 'AssignCmdKey' : ('CmdKeyAssign', - 'void %s(int key, int modifiers, int cmd);', + 'AssignCmdKey' : + ('CmdKeyAssign', + 'void %s(int key, int modifiers, int cmd);', - '''void %s(int key, int modifiers, int cmd) { - SendMsg(%s, MAKELONG(key, modifiers), cmd);''', + '''void %s(int key, int modifiers, int cmd) { + SendMsg(%s, MAKELONG(key, modifiers), cmd);''', + 0), - 0), - 'ClearCmdKey' : ('CmdKeyClear', - 'void %s(int key, int modifiers);', + 'ClearCmdKey' : + ('CmdKeyClear', + 'void %s(int key, int modifiers);', - '''void %s(int key, int modifiers) { - SendMsg(%s, MAKELONG(key, modifiers));''', - - 0), + '''void %s(int key, int modifiers) { + SendMsg(%s, MAKELONG(key, modifiers));''', + 0), 'ClearAllCmdKeys' : ('CmdKeyClearAll', 0, 0, 0), - 'SetStylingEx' : ('SetStyleBytes', - 'void %s(int length, char* styleBytes);', - - '''void %s(int length, char* styleBytes) { - SendMsg(%s, length, (long)styleBytes);''', + 'SetStylingEx' : + ('SetStyleBytes', + 'void %s(int length, char* styleBytes);', - 0), + '''void %s(int length, char* styleBytes) { + SendMsg(%s, length, (sptr_t)styleBytes);''', + 0), + 'IndicSetAlpha' : ('IndicatorSetAlpha', 0, 0, 0), + 'IndicGetAlpha' : ('IndicatorGetAlpha', 0, 0, 0), 'IndicSetStyle' : ('IndicatorSetStyle', 0, 0, 0), '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), 'AutoCShow' : ('AutoCompShow', 0, 0, 0), 'AutoCCancel' : ('AutoCompCancel', 0, 0, 0), @@ -226,132 +383,173 @@ methodOverrideMap = { 'AutoCGetIgnoreCase' : ('AutoCompGetIgnoreCase', 0, 0, 0), 'AutoCSetAutoHide' : ('AutoCompSetAutoHide', 0, 0, 0), 'AutoCGetAutoHide' : ('AutoCompGetAutoHide', 0, 0, 0), + 'AutoCSetDropRestOfWord' : ('AutoCompSetDropRestOfWord', 0,0,0), + 'AutoCGetDropRestOfWord' : ('AutoCompGetDropRestOfWord', 0,0,0), + 'AutoCGetTypeSeparator' : ('AutoCompGetTypeSeparator', 0, 0, 0), + 'AutoCSetTypeSeparator' : ('AutoCompSetTypeSeparator', 0, 0, 0), + 'AutoCGetCurrent' : ('AutoCompGetCurrent', 0, 0, 0), + 'AutoCGetCurrentText' : (None, 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, + '''void %s(int type, const wxBitmap& bmp);''', + '''void %s(int type, const wxBitmap& bmp) { + // 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, (sptr_t)buff); + delete [] buff; + ''', + ('Register an image for use in autocompletion lists.',)), + + + 'ClearRegisteredImages' : (0, 0, 0, + ('Clear all the registered images.',)), 'SetHScrollBar' : ('SetUseHorizontalScrollBar', 0, 0, 0), 'GetHScrollBar' : ('GetUseHorizontalScrollBar', 0, 0, 0), + 'SetVScrollBar' : ('SetUseVerticalScrollBar', 0, 0, 0), + 'GetVScrollBar' : ('GetUseVerticalScrollBar', 0, 0, 0), + 'GetCaretFore' : ('GetCaretForeground', 0, 0, 0), 'GetUsePalette' : (None, 0, 0, 0), - 'FindText' : (0, - '''int %s(int minPos, int maxPos, - const wxString& text, - bool caseSensitive, bool wholeWord);''', - '''int %s(int minPos, int maxPos, - const wxString& text, - bool caseSensitive, bool wholeWord) { - TextToFind ft; - int flags = 0; - - flags |= caseSensitive ? SCFIND_MATCHCASE : 0; - flags |= wholeWord ? SCFIND_WHOLEWORD : 0; - ft.chrg.cpMin = minPos; - ft.chrg.cpMax = maxPos; - ft.lpstrText = (char*)text.c_str(); - - return SendMsg(%s, flags, (long)&ft);''', - 0), - - 'FormatRange' : (0, - '''int %s(bool doDraw, - int startPos, - int endPos, - wxDC* draw, - wxDC* target, // Why does it use two? Can they be the same? - wxRect renderRect, - wxRect pageRect);''', - ''' int %s(bool doDraw, - int startPos, - int endPos, - wxDC* draw, - wxDC* target, // Why does it use two? Can they be the same? - wxRect renderRect, - wxRect pageRect) { - RangeToFormat fr; - - if (endPos < startPos) { - int temp = startPos; - startPos = endPos; - endPos = temp; - } - fr.hdc = draw; - fr.hdcTarget = target; - fr.rc.top = renderRect.GetTop(); - fr.rc.left = renderRect.GetLeft(); - fr.rc.right = renderRect.GetRight(); - fr.rc.bottom = renderRect.GetBottom(); - fr.rcPage.top = pageRect.GetTop(); - fr.rcPage.left = pageRect.GetLeft(); - fr.rcPage.right = pageRect.GetRight(); - fr.rcPage.bottom = pageRect.GetBottom(); - fr.chrg.cpMin = startPos; - fr.chrg.cpMax = endPos; - - return SendMsg(%s, doDraw, (long)&fr);''', - 0), - - - 'GetLine' : (0, - 'wxString %s(int line);', - - '''wxString %s(int line) { - wxString text; - int len = LineLength(line); - if (!len) return ""; - char* buf = text.GetWriteBuf(len); - - int pos = SendMsg(%s, line, (long)buf); - text.UngetWriteBuf(len); - - return text;''', - - ('Retrieve the contents of a line.',)), - - 'SetSel' : ('SetSelection', 0, 0, 0), - 'GetSelText' : ('GetSelectedText', - 'wxString %s();', - - '''wxString %s() { - wxString text; - int start; - int end; - - GetSelection(&start, &end); - int len = end - start; - if (!len) return ""; - char* buff = text.GetWriteBuf(len); - - SendMsg(%s, 0, (long)buff); - text.UngetWriteBuf(len); - return text;''', - - ('Retrieve the selected text.',)), - - 'GetTextRange' : (0, - 'wxString %s(int startPos, int endPos);', - - '''wxString %s(int startPos, int endPos) { - wxString text; - if (endPos < startPos) { - int temp = startPos; - startPos = endPos; - endPos = temp; - } - int len = endPos - startPos; - if (!len) return ""; - char* buff = text.GetWriteBuf(len); - TextRange tr; - tr.lpstrText = buff; - tr.chrg.cpMin = startPos; - tr.chrg.cpMax = endPos; - - SendMsg(%s, 0, (long)&tr); - text.UngetWriteBuf(len); - return text;''', - - ('Retrieve a range of text.',)), + 'FindText' : + (0, + '''int %s(int minPos, int maxPos, const wxString& text, int flags=0);''', + + '''int %s(int minPos, int maxPos, + const wxString& text, + int flags) { + TextToFind ft; + ft.chrg.cpMin = minPos; + ft.chrg.cpMax = maxPos; + wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text); + ft.lpstrText = (char*)(const char*)buf; + + return SendMsg(%s, flags, (sptr_t)&ft);''', + 0), + + 'FormatRange' : + (0, + '''int %s(bool doDraw, + int startPos, + int endPos, + wxDC* draw, + wxDC* target, + wxRect renderRect, + wxRect pageRect);''', + ''' int %s(bool doDraw, + int startPos, + int endPos, + wxDC* draw, + wxDC* target, + wxRect renderRect, + wxRect pageRect) { + RangeToFormat fr; + + if (endPos < startPos) { + int temp = startPos; + startPos = endPos; + endPos = temp; + } + fr.hdc = draw; + fr.hdcTarget = target; + fr.rc.top = renderRect.GetTop(); + fr.rc.left = renderRect.GetLeft(); + fr.rc.right = renderRect.GetRight(); + fr.rc.bottom = renderRect.GetBottom(); + fr.rcPage.top = pageRect.GetTop(); + fr.rcPage.left = pageRect.GetLeft(); + fr.rcPage.right = pageRect.GetRight(); + fr.rcPage.bottom = pageRect.GetBottom(); + fr.chrg.cpMin = startPos; + fr.chrg.cpMax = endPos; + + return SendMsg(%s, doDraw, (sptr_t)&fr);''', + 0), + + + 'GetLine' : + (0, + 'wxString %s(int line) const;', + + '''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, (sptr_t)buf); + mbuf.UngetWriteBuf(len); + mbuf.AppendByte(0); + return stc2wx(buf);''', + + ('Retrieve the contents of a line.',)), + + 'SetSel' : (None, 0,0,0), #'SetSelection', 0, 0, 0), + + 'GetSelText' : + ('GetSelectedText', + 'wxString %s();', + + '''wxString %s() { + long start; + long end; + + GetSelection(&start, &end); + int len = end - start; + if (!len) return wxEmptyString; + + wxMemoryBuffer mbuf(len+2); + char* buf = (char*)mbuf.GetWriteBuf(len+1); + SendMsg(%s, 0, (sptr_t)buf); + mbuf.UngetWriteBuf(len); + mbuf.AppendByte(0); + return stc2wx(buf);''', + + ('Retrieve the selected text.',)), + + + 'GetTextRange' : + (0, + 'wxString %s(int startPos, int endPos);', + + '''wxString %s(int startPos, int endPos) { + if (endPos < startPos) { + int temp = startPos; + startPos = endPos; + endPos = temp; + } + int len = endPos - startPos; + if (!len) return wxEmptyString; + wxMemoryBuffer mbuf(len+1); + char* buf = (char*)mbuf.GetWriteBuf(len); + TextRange tr; + tr.lpstrText = buf; + tr.chrg.cpMin = startPos; + tr.chrg.cpMax = endPos; + SendMsg(%s, 0, (sptr_t)&tr); + mbuf.UngetWriteBuf(len); + mbuf.AppendByte(0); + return stc2wx(buf);''', + + ('Retrieve a range of text.',)), 'PointXFromPosition' : (None, 0, 0, 0), 'PointYFromPosition' : (None, 0, 0, 0), @@ -360,153 +558,211 @@ methodOverrideMap = { 'ReplaceSel' : ('ReplaceSelection', 0, 0, 0), 'Null' : (None, 0, 0, 0), - 'GetText' : (0, - 'wxString %s();', + 'GetText' : + (0, + 'wxString %s() const;', - '''wxString %s() { - wxString text; - int len = GetTextLength(); - char* buff = text.GetWriteBuf(len+1); // leave room for the null... + '''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, (sptr_t)buf); + mbuf.UngetWriteBuf(len); + mbuf.AppendByte(0); + return stc2wx(buf);''', - SendMsg(%s, len+1, (long)buff); - text.UngetWriteBuf(len); - return text;''', - - ('Retrieve all the text in the document.', )), + ('Retrieve all the text in the document.', )), 'GetDirectFunction' : (None, 0, 0, 0), 'GetDirectPointer' : (None, 0, 0, 0), - 'CallTipPosStart' : ('CallTipPosAtStart', 0, 0, 0), - 'CallTipSetHlt' : ('CallTipSetHighlight', 0, 0, 0), - 'CallTipSetBack' : ('CallTipSetBackground', 0, 0, 0), - + 'CallTipPosStart' : ('CallTipPosAtStart', 0, 0, 0), + 'CallTipSetHlt' : ('CallTipSetHighlight', 0, 0, 0), + 'CallTipSetBack' : ('CallTipSetBackground', 0, 0, 0), + 'CallTipSetFore' : ('CallTipSetForeground', 0, 0, 0), + 'CallTipSetForeHlt' : ('CallTipSetForegroundHighlight', 0, 0, 0), + + '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, + 'int %s(const wxString& text);', + + ''' + int %s(const wxString& text) { + wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text); + return SendMsg(%s, strlen(buf), (sptr_t)(const char*)buf);''', + 0), + + 'ReplaceTargetRE' : + (0, + 'int %s(const wxString& text);', + + ''' + int %s(const wxString& text) { + wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text); + return SendMsg(%s, strlen(buf), (sptr_t)(const char*)buf);''', + 0), + + 'SearchInTarget' : + (0, + 'int %s(const wxString& text);', + + ''' + int %s(const wxString& text) { + wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text); + 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, + 'void* %s();', + '''void* %s() { + return (void*)SendMsg(%s);''', + 0), + + 'SetDocPointer' : + (0, + 'void %s(void* docPointer);', + '''void %s(void* docPointer) { + SendMsg(%s, 0, (sptr_t)docPointer);''', + 0), + + 'CreateDocument' : + (0, + 'void* %s();', + '''void* %s() { + return (void*)SendMsg(%s);''', + 0), + + 'AddRefDocument' : + (0, + 'void %s(void* docPointer);', + '''void %s(void* docPointer) { + SendMsg(%s, 0, (sptr_t)docPointer);''', + 0), + + 'ReleaseDocument' : + (0, + 'void %s(void* docPointer);', + '''void %s(void* docPointer) { + SendMsg(%s, 0, (sptr_t)docPointer);''', + 0), + + 'SetCodePage' : + (0, + 0, + '''void %s(int codePage) { +#if wxUSE_UNICODE + wxASSERT_MSG(codePage == wxSTC_CP_UTF8, + wxT("Only wxSTC_CP_UTF8 may be used when wxUSE_UNICODE is on.")); +#else + wxASSERT_MSG(codePage != wxSTC_CP_UTF8, + wxT("wxSTC_CP_UTF8 may not be used when wxUSE_UNICODE is off.")); +#endif + SendMsg(%s, codePage);''', + ("Set the code page used to interpret the bytes of the document as characters.",) ), - 'ReplaceTarget' : (0, - 'int %s(const wxString& text);', - - ''' - int %s(const wxString& text) { - return SendMsg(%s, text.Len(), (long)text.c_str()); - ''', - - 0), - 'ReplaceTargetRE' : (0, - 'int %s(const wxString& text);', - - ''' - int %s(const wxString& text) { - return SendMsg(%s, text.Len(), (long)text.c_str()); - ''', - - 0), - - 'SearchInTarget' : (0, - 'int %s(const wxString& text);', - - ''' - int %s(const wxString& text) { - return SendMsg(%s, text.Len(), (long)text.c_str()); - ''', - - 0), - - - - # Remove all methods that are key commands since they can be - # executed with CmdKeyExecute - 'LineDown' : (None, 0, 0, 0), - 'LineDownExtend' : (None, 0, 0, 0), - 'LineUp' : (None, 0, 0, 0), - 'LineUpExtend' : (None, 0, 0, 0), - 'CharLeft' : (None, 0, 0, 0), - 'CharLeftExtend' : (None, 0, 0, 0), - 'CharRight' : (None, 0, 0, 0), - 'CharRightExtend' : (None, 0, 0, 0), - 'WordLeft' : (None, 0, 0, 0), - 'WordLeftExtend' : (None, 0, 0, 0), - 'WordRight' : (None, 0, 0, 0), - 'WordRightExtend' : (None, 0, 0, 0), - 'Home' : (None, 0, 0, 0), - 'HomeExtend' : (None, 0, 0, 0), - 'LineEnd' : (None, 0, 0, 0), - 'LineEndExtend' : (None, 0, 0, 0), - 'DocumentStart' : (None, 0, 0, 0), - 'DocumentStartExtend' : (None, 0, 0, 0), - 'DocumentEnd' : (None, 0, 0, 0), - 'DocumentEndExtend' : (None, 0, 0, 0), - 'PageUp' : (None, 0, 0, 0), - 'PageUpExtend' : (None, 0, 0, 0), - 'PageDown' : (None, 0, 0, 0), - 'PageDownExtend' : (None, 0, 0, 0), - 'EditToggleOvertype' : (None, 0, 0, 0), - 'Cancel' : (None, 0, 0, 0), - 'DeleteBack' : (None, 0, 0, 0), - 'Tab' : (None, 0, 0, 0), - 'BackTab' : (None, 0, 0, 0), - 'NewLine' : (None, 0, 0, 0), - 'FormFeed' : (None, 0, 0, 0), - 'VCHome' : (None, 0, 0, 0), - 'VCHomeExtend' : (None, 0, 0, 0), - 'ZoomIn' : (None, 0, 0, 0), - 'ZoomOut' : (None, 0, 0, 0), - 'DelWordLeft' : (None, 0, 0, 0), - 'DelWordRight' : (None, 0, 0, 0), - 'LineCut' : (None, 0, 0, 0), - 'LineDelete' : (None, 0, 0, 0), - 'LineTranspose' : (None, 0, 0, 0), - 'LowerCase' : (None, 0, 0, 0), - 'UpperCase' : (None, 0, 0, 0), - 'LineScrollDown' : (None, 0, 0, 0), - 'LineScrollUp' : (None, 0, 0, 0), - - - 'GetDocPointer' : (0, - 'void* %s();', - '''void* %s() { - return (void*)SendMsg(%s);''', - 0), - - 'SetDocPointer' : (0, - 'void %s(void* docPointer);', - '''void %s(void* docPointer) { - SendMsg(%s, 0, (long)docPointer);''', - 0), + 'GrabFocus' : (None, 0, 0, 0), - 'CreateDocument' : (0, - 'void* %s();', - '''void* %s() { - return (void*)SendMsg(%s);''', - 0), + # Rename some that would otherwise hide the wxWindow methods + 'SetFocus' : ('SetSTCFocus', 0, 0, 0), + 'GetFocus' : ('GetSTCFocus', 0, 0, 0), + 'SetCursor' : ('SetSTCCursor', 0, 0, 0), + 'GetCursor' : ('GetSTCCursor', 0, 0, 0), - 'AddRefDocument' : (0, - 'void %s(void* docPointer);', - '''void %s(void* docPointer) { - SendMsg(%s, (long)docPointer);''', - 0), + 'LoadLexerLibrary' : (None, 0,0,0), - 'ReleaseDocument' : (0, - 'void %s(void* docPointer);', - '''void %s(void* docPointer) { - SendMsg(%s, (long)docPointer);''', - 0), + 'SetPositionCache' : ('SetPositionCacheSize', 0, 0, 0), + 'GetPositionCache' : ('GetPositionCacheSize', 0, 0, 0), - 'GrabFocus' : (None, 0, 0, 0), - 'SetFocus' : ('SetSTCFocus', 0, 0, 0), - 'GetFocus' : ('GetSTCFocus', 0, 0, 0), + 'GetLexerLanguage' : (None, 0, 0, 0), + 'SetFontQuality' : (None, 0, 0, 0), + 'GetFontQuality' : (None, 0, 0, 0), + 'SetSelection' : (None, 0, 0, 0), + 'GetCharacterPointer' : (0, + 'const char* %s();', + 'const char* %s() {\n' + ' return (const char*)SendMsg(%s, 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 = ( + 'LineFromPosition', + 'PositionFromLine', + 'LineLength', + 'CanPaste', + 'CanRedo', + 'CanUndo', +) + #---------------------------------------------------------------------------- -def processIface(iface, h_tmplt, cpp_tmplt, h_dest, cpp_dest): +def processIface(iface, h_tmplt, cpp_tmplt, h_dest, cpp_dest, docstr_dest): curDocStrings = [] values = [] methods = [] + cmds = [] # parse iface file fi = FileInput(iface) @@ -525,7 +781,7 @@ def processIface(iface, h_tmplt, cpp_tmplt, h_dest, cpp_dest): curDocStrings = [] elif op == 'fun ' or op == 'set ' or op == 'get ': - parseFun(line[4:], methods, curDocStrings, values) + parseFun(line[4:], methods, curDocStrings, cmds, op == 'get ') curDocStrings = [] elif op == 'cat ': @@ -535,6 +791,12 @@ def processIface(iface, h_tmplt, cpp_tmplt, h_dest, cpp_dest): elif op == 'evt ': pass + elif op == 'enu ': + pass + + elif op == 'lex ': + pass + else: print '***** Unknown line type: ', line @@ -542,7 +804,8 @@ def processIface(iface, h_tmplt, cpp_tmplt, h_dest, cpp_dest): # process templates data = {} data['VALUES'] = processVals(values) - defs, imps = processMethods(methods) + data['CMDS'] = processVals(cmds) + defs, imps, docstrings = processMethods(methods) data['METHOD_DEFS'] = defs data['METHOD_IMPS'] = imps @@ -557,9 +820,13 @@ def processIface(iface, h_tmplt, cpp_tmplt, h_dest, cpp_dest): # write out destination files open(h_dest, 'w').write(h_text) open(cpp_dest, 'w').write(cpp_text) + open(docstr_dest, 'w').write(docstrings) +def joinWithNewLines(values): + return string.join(values, '\n') + #---------------------------------------------------------------------------- def processVals(values): @@ -570,15 +837,16 @@ def processVals(values): for x in docs: text.append('// ' + x) text.append('#define %s %s' % (name, value)) - return string.join(text, '\n') + return joinWithNewLines(text) #---------------------------------------------------------------------------- def processMethods(methods): defs = [] 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) @@ -587,13 +855,21 @@ def processMethods(methods): if name is None: continue + # Build docstrings + st = 'DocStr(wxStyledTextCtrl::%s,\n' \ + '"%s", "");\n' % (name, joinWithNewLines(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 @@ -602,8 +878,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': @@ -620,7 +898,7 @@ def processMethods(methods): imps.append(theImp) - return string.join(defs, '\n'), string.join(imps, '\n') + return joinWithNewLines(defs), joinWithNewLines(imps), joinWithNewLines(dstr) #---------------------------------------------------------------------------- @@ -630,14 +908,18 @@ def checkMethodOverride(name, number, docs): if methodOverrideMap.has_key(name): item = methodOverrideMap[name] - if item[0] != 0: - name = item[0] - if item[1] != 0: - theDef = ' ' + (item[1] % name) - if item[2] != 0: - theImp = item[2] % ('wxStyledTextCtrl::'+name, number) + '\n}' - if item[3] != 0: - docs = item[3] + try: + if item[0] != 0: + name = item[0] + if item[1] != 0: + theDef = ' ' + (item[1] % name) + if item[2] != 0: + theImp = item[2] % ('wxStyledTextCtrl::'+name, number) + '\n}' + if item[3] != 0: + docs = item[3] + except: + print "*************", name + raise return name, theDef, theImp, docs @@ -650,7 +932,7 @@ def makeArgString(param): typ, name = param if typ == 'string': - return '(long)%s.c_str()' % name + return '(sptr_t)(const char*)wx2stc(%s)' % name if typ == 'colour': return 'wxColourAsLong(%s)' % name @@ -695,9 +977,9 @@ funregex = re.compile(r'\s*([a-zA-Z0-9_]+)' # return type '\s+([a-zA-Z0-9_]+)=' # name= '([0-9]+)' # number '\(([ a-zA-Z0-9_]*),' # (param, - '([ 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 == '': @@ -715,15 +997,19 @@ def parseFun(line, methods, docs, values): param1 = parseParam(param1) param2 = parseParam(param2) - # Special case. For the key command functionss we want a value defined too + # Special case. For the key command functions we want a value defined too num = string.atoi(number) 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, ()) + if (type(v) == type(()) and v[0] <= num <= v[1]) or v == num: + parseVal('CMD_%s=%s' % (string.upper(name), number), values, docs) - #if retType == 'void' and not param1 and not param2: + # 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) ) #---------------------------------------------------------------------------- @@ -732,8 +1018,12 @@ 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) + processIface(IFACE, H_TEMPLATE, CPP_TEMPLATE, H_DEST, CPP_DEST, DOCSTR_DEST)