]>
git.saurik.com Git - wxWidgets.git/blob - contrib/src/stc/gen_iface.py
2 #----------------------------------------------------------------------------
4 # Purpose: Generate stc.h and stc.cpp from the info in Scintilla.iface
10 # Copyright: (c) 2000 by Total Control Software
11 # Licence: wxWindows license
12 #----------------------------------------------------------------------------
15 import sys
, string
, re
, os
16 from fileinput
import FileInput
19 IFACE
= os
.path
.abspath('./scintilla/include/Scintilla.iface')
20 H_TEMPLATE
= os
.path
.abspath('./stc.h.in')
21 CPP_TEMPLATE
= os
.path
.abspath('./stc.cpp.in')
22 H_DEST
= os
.path
.abspath('../../include/wx/stc/stc.h')
23 CPP_DEST
= os
.path
.abspath('./stc.cpp')
26 # Value prefixes to convert
27 valPrefixes
= [('SCI_', ''),
29 ('SCN_', None), # just toss these out...
38 # Message function values that should have a CMD_ constant as well
39 cmdValues
= [ (2300, 2350), 2011, 2013, (2176, 2180) ]
42 # Map some generic typenames to wx types, using return value syntax
49 # Map some generic typenames to wx types, using parameter syntax
52 'string': 'const wxString&',
53 'colour': 'const wxColour&',
57 # Map of method info that needs tweaked. Either the name needs changed, or
58 # the method definition/implementation. Tuple items are:
60 # 1. New method name. None to skip the method, 0 to leave the
62 # 2. Method definition for the .h file, 0 to leave alone
63 # 3. Method implementation for the .cpp file, 0 to leave alone.
64 # 4. tuple of Doc string lines, or 0 to leave alone.
68 'void %s(const wxString& text);',
70 '''void %s(const wxString& text) {
71 wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text);
72 SendMsg(%s, strlen(buf), (long)(const char*)buf);''',
76 'void %s(const wxMemoryBuffer& data);',
78 '''void %s(const wxMemoryBuffer& data) {
79 SendMsg(%s, data.GetDataLen(), (long)data.GetData());''',
82 'GetViewWS' : ( 'GetViewWhiteSpace', 0, 0, 0),
83 'SetViewWS' : ( 'SetViewWhiteSpace', 0, 0, 0),
87 return (unsigned char)SendMsg(%s, pos, 0);''',
90 'GetStyleAt' : ( 0, 0,
92 return (unsigned char)SendMsg(%s, pos, 0);''',
96 'wxMemoryBuffer %s(int startPos, int endPos);',
98 '''wxMemoryBuffer %s(int startPos, int endPos) {
100 if (endPos < startPos) {
105 int len = endPos - startPos;
106 if (!len) return buf;
108 tr.lpstrText = (char*)buf.GetWriteBuf(len*2+1);
109 tr.chrg.cpMin = startPos;
110 tr.chrg.cpMax = endPos;
111 len = SendMsg(%s, 0, (long)&tr);
112 buf.UngetWriteBuf(len);
115 ('Retrieve a buffer of cells.',)),
118 'PositionFromPoint' : (0,
119 'int %s(wxPoint pt);',
121 '''int %s(wxPoint pt) {
122 return SendMsg(%s, pt.x, pt.y);''',
127 '#ifdef SWIG\n wxString %s(int* OUTPUT);\n#else\n wxString GetCurLine(int* linePos=NULL);\n#endif',
129 '''wxString %s(int* linePos) {
130 int len = LineLength(GetCurrentLine());
132 if (linePos) *linePos = 0;
133 return wxEmptyString;
136 wxMemoryBuffer mbuf(len+1);
137 char* buf = (char*)mbuf.GetWriteBuf(len+1);
139 int pos = SendMsg(%s, len+1, (long)buf);
140 mbuf.UngetWriteBuf(len);
142 if (linePos) *linePos = pos;
143 return stc2wx(buf);''',
147 'SetUsePalette' : (None, 0,0,0),
149 'MarkerSetFore' : ('MarkerSetForeground', 0, 0, 0),
150 'MarkerSetBack' : ('MarkerSetBackground', 0, 0, 0),
153 '''void %s(int markerNumber, int markerSymbol,
154 const wxColour& foreground = wxNullColour,
155 const wxColour& background = wxNullColour);''',
157 '''void %s(int markerNumber, int markerSymbol,
158 const wxColour& foreground,
159 const wxColour& background) {
161 SendMsg(%s, markerNumber, markerSymbol);
163 MarkerSetForeground(markerNumber, foreground);
165 MarkerSetBackground(markerNumber, background);''',
167 ('Set the symbol used for a particular marker number,',
168 'and optionally the fore and background colours.')),
170 'SetMarginTypeN' : ('SetMarginType', 0, 0, 0),
171 'GetMarginTypeN' : ('GetMarginType', 0, 0, 0),
172 'SetMarginWidthN' : ('SetMarginWidth', 0, 0, 0),
173 'GetMarginWidthN' : ('GetMarginWidth', 0, 0, 0),
174 'SetMarginMaskN' : ('SetMarginMask', 0, 0, 0),
175 'GetMarginMaskN' : ('GetMarginMask', 0, 0, 0),
176 'SetMarginSensitiveN' : ('SetMarginSensitive', 0, 0, 0),
177 'GetMarginSensitiveN' : ('GetMarginSensitive', 0, 0, 0),
179 'StyleSetFore' : ('StyleSetForeground', 0, 0, 0),
180 'StyleSetBack' : ('StyleSetBackground', 0, 0, 0),
181 'SetSelFore' : ('SetSelForeground', 0, 0, 0),
182 'SetSelBack' : ('SetSelBackground', 0, 0, 0),
183 'SetCaretFore' : ('SetCaretForeground', 0, 0, 0),
184 'StyleSetFont' : ('StyleSetFaceName', 0, 0, 0),
186 'AssignCmdKey' : ('CmdKeyAssign',
187 'void %s(int key, int modifiers, int cmd);',
189 '''void %s(int key, int modifiers, int cmd) {
190 SendMsg(%s, MAKELONG(key, modifiers), cmd);''',
194 'ClearCmdKey' : ('CmdKeyClear',
195 'void %s(int key, int modifiers);',
197 '''void %s(int key, int modifiers) {
198 SendMsg(%s, MAKELONG(key, modifiers));''',
202 'ClearAllCmdKeys' : ('CmdKeyClearAll', 0, 0, 0),
205 'SetStylingEx' : ('SetStyleBytes',
206 'void %s(int length, char* styleBytes);',
208 '''void %s(int length, char* styleBytes) {
209 SendMsg(%s, length, (long)styleBytes);''',
214 'IndicSetStyle' : ('IndicatorSetStyle', 0, 0, 0),
215 'IndicGetStyle' : ('IndicatorGetStyle', 0, 0, 0),
216 'IndicSetFore' : ('IndicatorSetForeground', 0, 0, 0),
217 'IndicGetFore' : ('IndicatorGetForeground', 0, 0, 0),
219 'AutoCShow' : ('AutoCompShow', 0, 0, 0),
220 'AutoCCancel' : ('AutoCompCancel', 0, 0, 0),
221 'AutoCActive' : ('AutoCompActive', 0, 0, 0),
222 'AutoCPosStart' : ('AutoCompPosStart', 0, 0, 0),
223 'AutoCComplete' : ('AutoCompComplete', 0, 0, 0),
224 'AutoCStops' : ('AutoCompStops', 0, 0, 0),
225 'AutoCSetSeparator' : ('AutoCompSetSeparator', 0, 0, 0),
226 'AutoCGetSeparator' : ('AutoCompGetSeparator', 0, 0, 0),
227 'AutoCSelect' : ('AutoCompSelect', 0, 0, 0),
228 'AutoCSetCancelAtStart' : ('AutoCompSetCancelAtStart', 0, 0, 0),
229 'AutoCGetCancelAtStart' : ('AutoCompGetCancelAtStart', 0, 0, 0),
230 'AutoCSetFillUps' : ('AutoCompSetFillUps', 0, 0, 0),
231 'AutoCSetChooseSingle' : ('AutoCompSetChooseSingle', 0, 0, 0),
232 'AutoCGetChooseSingle' : ('AutoCompGetChooseSingle', 0, 0, 0),
233 'AutoCSetIgnoreCase' : ('AutoCompSetIgnoreCase', 0, 0, 0),
234 'AutoCGetIgnoreCase' : ('AutoCompGetIgnoreCase', 0, 0, 0),
235 'AutoCSetAutoHide' : ('AutoCompSetAutoHide', 0, 0, 0),
236 'AutoCGetAutoHide' : ('AutoCompGetAutoHide', 0, 0, 0),
237 'AutoCSetDropRestOfWord' : ('AutoCompSetDropRestOfWord', 0,0,0),
238 'AutoCGetDropRestOfWord' : ('AutoCompGetDropRestOfWord', 0,0,0),
241 'SetHScrollBar' : ('SetUseHorizontalScrollBar', 0, 0, 0),
242 'GetHScrollBar' : ('GetUseHorizontalScrollBar', 0, 0, 0),
244 'GetCaretFore' : ('GetCaretForeground', 0, 0, 0),
246 'GetUsePalette' : (None, 0, 0, 0),
249 '''int %s(int minPos, int maxPos, const wxString& text, int flags=0);''',
251 '''int %s(int minPos, int maxPos,
252 const wxString& text,
255 ft.chrg.cpMin = minPos;
256 ft.chrg.cpMax = maxPos;
257 wxWX2MBbuf buf = wx2stc(text);
258 ft.lpstrText = (char*)(const char*)buf;
260 return SendMsg(%s, flags, (long)&ft);''',
264 '''int %s(bool doDraw,
268 wxDC* target, // Why does it use two? Can they be the same?
270 wxRect pageRect);''',
271 ''' int %s(bool doDraw,
275 wxDC* target, // Why does it use two? Can they be the same?
280 if (endPos < startPos) {
286 fr.hdcTarget = target;
287 fr.rc.top = renderRect.GetTop();
288 fr.rc.left = renderRect.GetLeft();
289 fr.rc.right = renderRect.GetRight();
290 fr.rc.bottom = renderRect.GetBottom();
291 fr.rcPage.top = pageRect.GetTop();
292 fr.rcPage.left = pageRect.GetLeft();
293 fr.rcPage.right = pageRect.GetRight();
294 fr.rcPage.bottom = pageRect.GetBottom();
295 fr.chrg.cpMin = startPos;
296 fr.chrg.cpMax = endPos;
298 return SendMsg(%s, doDraw, (long)&fr);''',
303 'wxString %s(int line);',
305 '''wxString %s(int line) {
306 int len = LineLength(line);
307 if (!len) return wxEmptyString;
309 wxMemoryBuffer mbuf(len+1);
310 char* buf = (char*)mbuf.GetWriteBuf(len+1);
311 SendMsg(%s, line, (long)buf);
312 mbuf.UngetWriteBuf(len);
314 return stc2wx(buf);''',
316 ('Retrieve the contents of a line.',)),
318 'SetSel' : ('SetSelection', 0, 0, 0),
319 'GetSelText' : ('GetSelectedText',
326 GetSelection(&start, &end);
327 int len = end - start;
328 if (!len) return wxEmptyString;
330 wxMemoryBuffer mbuf(len+1);
331 char* buf = (char*)mbuf.GetWriteBuf(len+1);
332 SendMsg(%s, 0, (long)buf);
333 mbuf.UngetWriteBuf(len);
335 return stc2wx(buf);''',
337 ('Retrieve the selected text.',)),
340 'wxString %s(int startPos, int endPos);',
342 '''wxString %s(int startPos, int endPos) {
343 if (endPos < startPos) {
348 int len = endPos - startPos;
349 if (!len) return wxEmptyString;
350 wxMemoryBuffer mbuf(len+1);
351 char* buf = (char*)mbuf.GetWriteBuf(len);
354 tr.chrg.cpMin = startPos;
355 tr.chrg.cpMax = endPos;
356 SendMsg(%s, 0, (long)&tr);
357 mbuf.UngetWriteBuf(len);
359 return stc2wx(buf);''',
361 ('Retrieve a range of text.',)),
363 'PointXFromPosition' : (None, 0, 0, 0),
364 'PointYFromPosition' : (None, 0, 0, 0),
366 'ScrollCaret' : ('EnsureCaretVisible', 0, 0, 0),
367 'ReplaceSel' : ('ReplaceSelection', 0, 0, 0),
368 'Null' : (None, 0, 0, 0),
374 int len = GetTextLength();
375 wxMemoryBuffer mbuf(len+1); // leave room for the null...
376 char* buf = (char*)mbuf.GetWriteBuf(len+1);
377 SendMsg(%s, len+1, (long)buf);
378 mbuf.UngetWriteBuf(len);
380 return stc2wx(buf);''',
382 ('Retrieve all the text in the document.', )),
384 'GetDirectFunction' : (None, 0, 0, 0),
385 'GetDirectPointer' : (None, 0, 0, 0),
387 'CallTipPosStart' : ('CallTipPosAtStart', 0, 0, 0),
388 'CallTipSetHlt' : ('CallTipSetHighlight', 0, 0, 0),
389 'CallTipSetBack' : ('CallTipSetBackground', 0, 0, 0),
392 'ReplaceTarget' : (0,
393 'int %s(const wxString& text);',
396 int %s(const wxString& text) {
397 wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text);
398 return SendMsg(%s, strlen(buf), (long)(const char*)buf);''',
401 'ReplaceTargetRE' : (0,
402 'int %s(const wxString& text);',
405 int %s(const wxString& text) {
406 wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text);
407 return SendMsg(%s, strlen(buf), (long)(const char*)buf);''',
410 'SearchInTarget' : (0,
411 'int %s(const wxString& text);',
414 int %s(const wxString& text) {
415 wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text);
416 return SendMsg(%s, strlen(buf), (long)(const char*)buf);''',
421 # Remove all methods that are key commands since they can be
422 # executed with CmdKeyExecute
423 'LineDown' : (None, 0, 0, 0),
424 'LineDownExtend' : (None, 0, 0, 0),
425 'LineUp' : (None, 0, 0, 0),
426 'LineUpExtend' : (None, 0, 0, 0),
427 'CharLeft' : (None, 0, 0, 0),
428 'CharLeftExtend' : (None, 0, 0, 0),
429 'CharRight' : (None, 0, 0, 0),
430 'CharRightExtend' : (None, 0, 0, 0),
431 'WordLeft' : (None, 0, 0, 0),
432 'WordLeftExtend' : (None, 0, 0, 0),
433 'WordRight' : (None, 0, 0, 0),
434 'WordRightExtend' : (None, 0, 0, 0),
435 'Home' : (None, 0, 0, 0),
436 'HomeExtend' : (None, 0, 0, 0),
437 'LineEnd' : (None, 0, 0, 0),
438 'LineEndExtend' : (None, 0, 0, 0),
439 'DocumentStart' : (None, 0, 0, 0),
440 'DocumentStartExtend' : (None, 0, 0, 0),
441 'DocumentEnd' : (None, 0, 0, 0),
442 'DocumentEndExtend' : (None, 0, 0, 0),
443 'PageUp' : (None, 0, 0, 0),
444 'PageUpExtend' : (None, 0, 0, 0),
445 'PageDown' : (None, 0, 0, 0),
446 'PageDownExtend' : (None, 0, 0, 0),
447 'EditToggleOvertype' : (None, 0, 0, 0),
448 'Cancel' : (None, 0, 0, 0),
449 'DeleteBack' : (None, 0, 0, 0),
450 'Tab' : (None, 0, 0, 0),
451 'BackTab' : (None, 0, 0, 0),
452 'NewLine' : (None, 0, 0, 0),
453 'FormFeed' : (None, 0, 0, 0),
454 'VCHome' : (None, 0, 0, 0),
455 'VCHomeExtend' : (None, 0, 0, 0),
456 'ZoomIn' : (None, 0, 0, 0),
457 'ZoomOut' : (None, 0, 0, 0),
458 'DelWordLeft' : (None, 0, 0, 0),
459 'DelWordRight' : (None, 0, 0, 0),
460 'LineCut' : (None, 0, 0, 0),
461 'LineDelete' : (None, 0, 0, 0),
462 'LineTranspose' : (None, 0, 0, 0),
463 'LowerCase' : (None, 0, 0, 0),
464 'UpperCase' : (None, 0, 0, 0),
465 'LineScrollDown' : (None, 0, 0, 0),
466 'LineScrollUp' : (None, 0, 0, 0),
467 'DeleteBackNotLine' : (None, 0, 0, 0),
470 'GetDocPointer' : (0,
473 return (void*)SendMsg(%s);''',
476 'SetDocPointer' : (0,
477 'void %s(void* docPointer);',
478 '''void %s(void* docPointer) {
479 SendMsg(%s, 0, (long)docPointer);''',
482 'CreateDocument' : (0,
485 return (void*)SendMsg(%s);''',
488 'AddRefDocument' : (0,
489 'void %s(void* docPointer);',
490 '''void %s(void* docPointer) {
491 SendMsg(%s, (long)docPointer);''',
494 'ReleaseDocument' : (0,
495 'void %s(void* docPointer);',
496 '''void %s(void* docPointer) {
497 SendMsg(%s, (long)docPointer);''',
501 '''void %s(int codePage) {
503 wxASSERT_MSG(codePage == wxSTC_CP_UTF8,
504 wxT("Only wxSTC_CP_UTF8 may be used when wxUSE_UNICODE is on."));
506 wxASSERT_MSG(codePage != wxSTC_CP_UTF8,
507 wxT("wxSTC_CP_UTF8 may not be used when wxUSE_UNICODE is off."));
509 SendMsg(%s, codePage);''',
510 ("Set the code page used to interpret the bytes of the document as characters.",) ),
513 'GrabFocus' : (None, 0, 0, 0),
514 'SetFocus' : ('SetSTCFocus', 0, 0, 0),
515 'GetFocus' : ('GetSTCFocus', 0, 0, 0),
522 #----------------------------------------------------------------------------
524 def processIface(iface
, h_tmplt
, cpp_tmplt
, h_dest
, cpp_dest
):
530 fi
= FileInput(iface
)
533 if line
[:2] == '##' or line
== '':
538 if line
[:2] == '# ': # a doc string
539 curDocStrings
.append(line
[2:])
542 parseVal(line
[4:], values
, curDocStrings
)
545 elif op
== 'fun ' or op
== 'set ' or op
== 'get ':
546 parseFun(line
[4:], methods
, curDocStrings
, values
)
550 if string
.strip(line
[4:]) == 'Deprecated':
551 break # skip the rest of the file
557 print '***** Unknown line type: ', line
562 data
['VALUES'] = processVals(values
)
563 defs
, imps
= processMethods(methods
)
564 data
['METHOD_DEFS'] = defs
565 data
['METHOD_IMPS'] = imps
568 h_text
= open(h_tmplt
).read()
569 cpp_text
= open(cpp_tmplt
).read()
571 # do the substitutions
572 h_text
= h_text
% data
573 cpp_text
= cpp_text
% data
575 # write out destination files
576 open(h_dest
, 'w').write(h_text
)
577 open(cpp_dest
, 'w').write(cpp_text
)
581 #----------------------------------------------------------------------------
583 def processVals(values
):
585 for name
, value
, docs
in values
:
589 text
.append('// ' + x
)
590 text
.append('#define %s %s' % (name
, value
))
591 return string
.join(text
, '\n')
593 #----------------------------------------------------------------------------
595 def processMethods(methods
):
599 for retType
, name
, number
, param1
, param2
, docs
in methods
:
600 retType
= retTypeMap
.get(retType
, retType
)
601 params
= makeParamString(param1
, param2
)
603 name
, theDef
, theImp
, docs
= checkMethodOverride(name
, number
, docs
)
608 # Build the method definition for the .h file
612 defs
.append(' // ' + x
)
614 theDef
= ' %s %s(%s);' % (retType
, name
, params
)
617 # Build the method implementation string
621 imps
.append('// ' + x
)
623 theImp
= '%s wxStyledTextCtrl::%s(%s) {\n ' % (retType
, name
, params
)
625 if retType
== 'wxColour':
626 theImp
= theImp
+ 'long c = '
627 elif retType
!= 'void':
628 theImp
= theImp
+ 'return '
629 theImp
= theImp
+ 'SendMsg(%s, %s, %s)' % (number
,
630 makeArgString(param1
),
631 makeArgString(param2
))
632 if retType
== 'bool':
633 theImp
= theImp
+ ' != 0'
634 if retType
== 'wxColour':
635 theImp
= theImp
+ ';\n return wxColourFromLong(c)'
637 theImp
= theImp
+ ';\n}'
641 return string
.join(defs
, '\n'), string
.join(imps
, '\n')
644 #----------------------------------------------------------------------------
646 def checkMethodOverride(name
, number
, docs
):
647 theDef
= theImp
= None
648 if methodOverrideMap
.has_key(name
):
649 item
= methodOverrideMap
[name
]
655 theDef
= ' ' + (item
[1] % name
)
657 theImp
= item
[2] % ('wxStyledTextCtrl::'+name
, number
) + '\n}'
661 print "*************", name
664 return name
, theDef
, theImp
, docs
666 #----------------------------------------------------------------------------
668 def makeArgString(param
):
675 return '(long)(const char*)wx2stc(%s)' % name
677 return 'wxColourAsLong(%s)' % name
681 #----------------------------------------------------------------------------
683 def makeParamString(param1
, param2
):
686 aType
= paramTypeMap
.get(param
[0], param
[0])
687 return aType
+ ' ' + param
[1]
694 st
= st
+ doOne(param2
)
698 #----------------------------------------------------------------------------
700 def parseVal(line
, values
, docs
):
701 name
, val
= string
.split(line
, '=')
703 # remove prefixes such as SCI, etc.
704 for old
, new
in valPrefixes
:
709 name
= new
+ name
[lo
:]
712 values
.append( ('wxSTC_' + name
, val
, docs
) )
714 #----------------------------------------------------------------------------
716 funregex
= re
.compile(r
'\s*([a-zA-Z0-9_]+)' # <ws>return type
717 '\s+([a-zA-Z0-9_]+)=' # <ws>name=
719 '\(([ a-zA-Z0-9_]*),' # (param,
720 '([ a-zA-Z0-9_]*)\)') # param)
722 def parseFun(line
, methods
, docs
, values
):
723 def parseParam(param
):
724 param
= string
.strip(param
)
728 param
= tuple(string
.split(param
))
731 mo
= funregex
.match(line
)
733 print "***** Line doesn't match! : " + line
735 retType
, name
, number
, param1
, param2
= mo
.groups()
737 param1
= parseParam(param1
)
738 param2
= parseParam(param2
)
740 # Special case. For the key command functionss we want a value defined too
741 num
= string
.atoi(number
)
743 if (type(v
) == type(()) and v
[0] <= num
< v
[1]) or v
== num
:
744 parseVal('CMD_%s=%s' % (string
.upper(name
), number
), values
, docs
)
746 #if retType == 'void' and not param1 and not param2:
748 methods
.append( (retType
, name
, number
, param1
, param2
, tuple(docs
)) )
751 #----------------------------------------------------------------------------
755 # TODO: parse command line args to replace default input/output files???
758 processIface(IFACE
, H_TEMPLATE
, CPP_TEMPLATE
, H_DEST
, CPP_DEST
)
762 if __name__
== '__main__':
765 #----------------------------------------------------------------------------