]>
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 ft.lpstrText = (char*)(const char*)wx2stc(text);
259 return SendMsg(%s, flags, (long)&ft);''',
263 '''int %s(bool doDraw,
267 wxDC* target, // Why does it use two? Can they be the same?
269 wxRect pageRect);''',
270 ''' int %s(bool doDraw,
274 wxDC* target, // Why does it use two? Can they be the same?
279 if (endPos < startPos) {
285 fr.hdcTarget = target;
286 fr.rc.top = renderRect.GetTop();
287 fr.rc.left = renderRect.GetLeft();
288 fr.rc.right = renderRect.GetRight();
289 fr.rc.bottom = renderRect.GetBottom();
290 fr.rcPage.top = pageRect.GetTop();
291 fr.rcPage.left = pageRect.GetLeft();
292 fr.rcPage.right = pageRect.GetRight();
293 fr.rcPage.bottom = pageRect.GetBottom();
294 fr.chrg.cpMin = startPos;
295 fr.chrg.cpMax = endPos;
297 return SendMsg(%s, doDraw, (long)&fr);''',
302 'wxString %s(int line);',
304 '''wxString %s(int line) {
305 int len = LineLength(line);
306 if (!len) return wxEmptyString;
308 wxMemoryBuffer mbuf(len+1);
309 char* buf = (char*)mbuf.GetWriteBuf(len+1);
310 SendMsg(%s, line, (long)buf);
311 mbuf.UngetWriteBuf(len);
313 return stc2wx(buf);''',
315 ('Retrieve the contents of a line.',)),
317 'SetSel' : ('SetSelection', 0, 0, 0),
318 'GetSelText' : ('GetSelectedText',
325 GetSelection(&start, &end);
326 int len = end - start;
327 if (!len) return wxEmptyString;
329 wxMemoryBuffer mbuf(len+1);
330 char* buf = (char*)mbuf.GetWriteBuf(len+1);
331 SendMsg(%s, 0, (long)buf);
332 mbuf.UngetWriteBuf(len);
334 return stc2wx(buf);''',
336 ('Retrieve the selected text.',)),
339 'wxString %s(int startPos, int endPos);',
341 '''wxString %s(int startPos, int endPos) {
342 if (endPos < startPos) {
347 int len = endPos - startPos;
348 if (!len) return wxEmptyString;
349 wxMemoryBuffer mbuf(len+1);
350 char* buf = (char*)mbuf.GetWriteBuf(len);
353 tr.chrg.cpMin = startPos;
354 tr.chrg.cpMax = endPos;
355 SendMsg(%s, 0, (long)&tr);
356 mbuf.UngetWriteBuf(len);
358 return stc2wx(buf);''',
360 ('Retrieve a range of text.',)),
362 'PointXFromPosition' : (None, 0, 0, 0),
363 'PointYFromPosition' : (None, 0, 0, 0),
365 'ScrollCaret' : ('EnsureCaretVisible', 0, 0, 0),
366 'ReplaceSel' : ('ReplaceSelection', 0, 0, 0),
367 'Null' : (None, 0, 0, 0),
373 int len = GetTextLength();
374 wxMemoryBuffer mbuf(len+1); // leave room for the null...
375 char* buf = (char*)mbuf.GetWriteBuf(len+1);
376 SendMsg(%s, len+1, (long)buf);
377 mbuf.UngetWriteBuf(len);
379 return stc2wx(buf);''',
381 ('Retrieve all the text in the document.', )),
383 'GetDirectFunction' : (None, 0, 0, 0),
384 'GetDirectPointer' : (None, 0, 0, 0),
386 'CallTipPosStart' : ('CallTipPosAtStart', 0, 0, 0),
387 'CallTipSetHlt' : ('CallTipSetHighlight', 0, 0, 0),
388 'CallTipSetBack' : ('CallTipSetBackground', 0, 0, 0),
391 'ReplaceTarget' : (0,
392 'int %s(const wxString& text);',
395 int %s(const wxString& text) {
396 wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text);
397 return SendMsg(%s, strlen(buf), (long)(const char*)buf);''',
400 'ReplaceTargetRE' : (0,
401 'int %s(const wxString& text);',
404 int %s(const wxString& text) {
405 wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text);
406 return SendMsg(%s, strlen(buf), (long)(const char*)buf);''',
409 'SearchInTarget' : (0,
410 'int %s(const wxString& text);',
413 int %s(const wxString& text) {
414 wxWX2MBbuf buf = (wxWX2MBbuf)wx2stc(text);
415 return SendMsg(%s, strlen(buf), (long)(const char*)buf);''',
420 # Remove all methods that are key commands since they can be
421 # executed with CmdKeyExecute
422 'LineDown' : (None, 0, 0, 0),
423 'LineDownExtend' : (None, 0, 0, 0),
424 'LineUp' : (None, 0, 0, 0),
425 'LineUpExtend' : (None, 0, 0, 0),
426 'CharLeft' : (None, 0, 0, 0),
427 'CharLeftExtend' : (None, 0, 0, 0),
428 'CharRight' : (None, 0, 0, 0),
429 'CharRightExtend' : (None, 0, 0, 0),
430 'WordLeft' : (None, 0, 0, 0),
431 'WordLeftExtend' : (None, 0, 0, 0),
432 'WordRight' : (None, 0, 0, 0),
433 'WordRightExtend' : (None, 0, 0, 0),
434 'Home' : (None, 0, 0, 0),
435 'HomeExtend' : (None, 0, 0, 0),
436 'LineEnd' : (None, 0, 0, 0),
437 'LineEndExtend' : (None, 0, 0, 0),
438 'DocumentStart' : (None, 0, 0, 0),
439 'DocumentStartExtend' : (None, 0, 0, 0),
440 'DocumentEnd' : (None, 0, 0, 0),
441 'DocumentEndExtend' : (None, 0, 0, 0),
442 'PageUp' : (None, 0, 0, 0),
443 'PageUpExtend' : (None, 0, 0, 0),
444 'PageDown' : (None, 0, 0, 0),
445 'PageDownExtend' : (None, 0, 0, 0),
446 'EditToggleOvertype' : (None, 0, 0, 0),
447 'Cancel' : (None, 0, 0, 0),
448 'DeleteBack' : (None, 0, 0, 0),
449 'Tab' : (None, 0, 0, 0),
450 'BackTab' : (None, 0, 0, 0),
451 'NewLine' : (None, 0, 0, 0),
452 'FormFeed' : (None, 0, 0, 0),
453 'VCHome' : (None, 0, 0, 0),
454 'VCHomeExtend' : (None, 0, 0, 0),
455 'ZoomIn' : (None, 0, 0, 0),
456 'ZoomOut' : (None, 0, 0, 0),
457 'DelWordLeft' : (None, 0, 0, 0),
458 'DelWordRight' : (None, 0, 0, 0),
459 'LineCut' : (None, 0, 0, 0),
460 'LineDelete' : (None, 0, 0, 0),
461 'LineTranspose' : (None, 0, 0, 0),
462 'LowerCase' : (None, 0, 0, 0),
463 'UpperCase' : (None, 0, 0, 0),
464 'LineScrollDown' : (None, 0, 0, 0),
465 'LineScrollUp' : (None, 0, 0, 0),
466 'DeleteBackNotLine' : (None, 0, 0, 0),
469 'GetDocPointer' : (0,
472 return (void*)SendMsg(%s);''',
475 'SetDocPointer' : (0,
476 'void %s(void* docPointer);',
477 '''void %s(void* docPointer) {
478 SendMsg(%s, 0, (long)docPointer);''',
481 'CreateDocument' : (0,
484 return (void*)SendMsg(%s);''',
487 'AddRefDocument' : (0,
488 'void %s(void* docPointer);',
489 '''void %s(void* docPointer) {
490 SendMsg(%s, (long)docPointer);''',
493 'ReleaseDocument' : (0,
494 'void %s(void* docPointer);',
495 '''void %s(void* docPointer) {
496 SendMsg(%s, (long)docPointer);''',
500 '''void %s(int codePage) {
502 wxASSERT_MSG(codePage == wxSTC_CP_UTF8,
503 wxT("Only wxSTC_CP_UTF8 may be used when wxUSE_UNICODE is on."));
505 wxASSERT_MSG(codePage != wxSTC_CP_UTF8,
506 wxT("wxSTC_CP_UTF8 may not be used when wxUSE_UNICODE is off."));
508 SendMsg(%s, codePage);''',
509 ("Set the code page used to interpret the bytes of the document as characters.",) ),
512 'GrabFocus' : (None, 0, 0, 0),
513 'SetFocus' : ('SetSTCFocus', 0, 0, 0),
514 'GetFocus' : ('GetSTCFocus', 0, 0, 0),
521 #----------------------------------------------------------------------------
523 def processIface(iface
, h_tmplt
, cpp_tmplt
, h_dest
, cpp_dest
):
529 fi
= FileInput(iface
)
532 if line
[:2] == '##' or line
== '':
537 if line
[:2] == '# ': # a doc string
538 curDocStrings
.append(line
[2:])
541 parseVal(line
[4:], values
, curDocStrings
)
544 elif op
== 'fun ' or op
== 'set ' or op
== 'get ':
545 parseFun(line
[4:], methods
, curDocStrings
, values
)
549 if string
.strip(line
[4:]) == 'Deprecated':
550 break # skip the rest of the file
556 print '***** Unknown line type: ', line
561 data
['VALUES'] = processVals(values
)
562 defs
, imps
= processMethods(methods
)
563 data
['METHOD_DEFS'] = defs
564 data
['METHOD_IMPS'] = imps
567 h_text
= open(h_tmplt
).read()
568 cpp_text
= open(cpp_tmplt
).read()
570 # do the substitutions
571 h_text
= h_text
% data
572 cpp_text
= cpp_text
% data
574 # write out destination files
575 open(h_dest
, 'w').write(h_text
)
576 open(cpp_dest
, 'w').write(cpp_text
)
580 #----------------------------------------------------------------------------
582 def processVals(values
):
584 for name
, value
, docs
in values
:
588 text
.append('// ' + x
)
589 text
.append('#define %s %s' % (name
, value
))
590 return string
.join(text
, '\n')
592 #----------------------------------------------------------------------------
594 def processMethods(methods
):
598 for retType
, name
, number
, param1
, param2
, docs
in methods
:
599 retType
= retTypeMap
.get(retType
, retType
)
600 params
= makeParamString(param1
, param2
)
602 name
, theDef
, theImp
, docs
= checkMethodOverride(name
, number
, docs
)
607 # Build the method definition for the .h file
611 defs
.append(' // ' + x
)
613 theDef
= ' %s %s(%s);' % (retType
, name
, params
)
616 # Build the method implementation string
620 imps
.append('// ' + x
)
622 theImp
= '%s wxStyledTextCtrl::%s(%s) {\n ' % (retType
, name
, params
)
624 if retType
== 'wxColour':
625 theImp
= theImp
+ 'long c = '
626 elif retType
!= 'void':
627 theImp
= theImp
+ 'return '
628 theImp
= theImp
+ 'SendMsg(%s, %s, %s)' % (number
,
629 makeArgString(param1
),
630 makeArgString(param2
))
631 if retType
== 'bool':
632 theImp
= theImp
+ ' != 0'
633 if retType
== 'wxColour':
634 theImp
= theImp
+ ';\n return wxColourFromLong(c)'
636 theImp
= theImp
+ ';\n}'
640 return string
.join(defs
, '\n'), string
.join(imps
, '\n')
643 #----------------------------------------------------------------------------
645 def checkMethodOverride(name
, number
, docs
):
646 theDef
= theImp
= None
647 if methodOverrideMap
.has_key(name
):
648 item
= methodOverrideMap
[name
]
654 theDef
= ' ' + (item
[1] % name
)
656 theImp
= item
[2] % ('wxStyledTextCtrl::'+name
, number
) + '\n}'
660 print "*************", name
663 return name
, theDef
, theImp
, docs
665 #----------------------------------------------------------------------------
667 def makeArgString(param
):
674 return '(long)(const char*)wx2stc(%s)' % name
676 return 'wxColourAsLong(%s)' % name
680 #----------------------------------------------------------------------------
682 def makeParamString(param1
, param2
):
685 aType
= paramTypeMap
.get(param
[0], param
[0])
686 return aType
+ ' ' + param
[1]
693 st
= st
+ doOne(param2
)
697 #----------------------------------------------------------------------------
699 def parseVal(line
, values
, docs
):
700 name
, val
= string
.split(line
, '=')
702 # remove prefixes such as SCI, etc.
703 for old
, new
in valPrefixes
:
708 name
= new
+ name
[lo
:]
711 values
.append( ('wxSTC_' + name
, val
, docs
) )
713 #----------------------------------------------------------------------------
715 funregex
= re
.compile(r
'\s*([a-zA-Z0-9_]+)' # <ws>return type
716 '\s+([a-zA-Z0-9_]+)=' # <ws>name=
718 '\(([ a-zA-Z0-9_]*),' # (param,
719 '([ a-zA-Z0-9_]*)\)') # param)
721 def parseFun(line
, methods
, docs
, values
):
722 def parseParam(param
):
723 param
= string
.strip(param
)
727 param
= tuple(string
.split(param
))
730 mo
= funregex
.match(line
)
732 print "***** Line doesn't match! : " + line
734 retType
, name
, number
, param1
, param2
= mo
.groups()
736 param1
= parseParam(param1
)
737 param2
= parseParam(param2
)
739 # Special case. For the key command functionss we want a value defined too
740 num
= string
.atoi(number
)
742 if (type(v
) == type(()) and v
[0] <= num
< v
[1]) or v
== num
:
743 parseVal('CMD_%s=%s' % (string
.upper(name
), number
), values
, docs
)
745 #if retType == 'void' and not param1 and not param2:
747 methods
.append( (retType
, name
, number
, param1
, param2
, tuple(docs
)) )
750 #----------------------------------------------------------------------------
754 # TODO: parse command line args to replace default input/output files???
757 processIface(IFACE
, H_TEMPLATE
, CPP_TEMPLATE
, H_DEST
, CPP_DEST
)
761 if __name__
== '__main__':
764 #----------------------------------------------------------------------------