1 ////////////////////////////////////////////////////////////////////////////
3 // Purpose: A wxWindows implementation of Scintilla. This class is the
4 // one meant to be used directly by wx applications. It does not
5 // derive directly from the Scintilla classes, but instead
6 // delegates most things to the real Scintilla class.
7 // This allows the use of Scintilla without polluting the
8 // namespace with all the classes and identifiers from Scintilla.
12 // Created: 13-Jan-2000
14 // Copyright: (c) 2000 by Total Control Software
15 // Licence: wxWindows license
16 /////////////////////////////////////////////////////////////////////////////
20 #include "wx/stc/stc.h"
21 #include "ScintillaWX.h"
23 #include <wx/tokenzr.h>
25 // The following code forces a reference to all of the Scintilla lexers.
26 // If we don't do something like this, then the linker tends to "optimize"
27 // them away. (eric@sourcegear.com)
29 int wxForceScintillaLexers(void)
31 extern LexerModule lmAda
;
32 extern LexerModule lmAVE
;
33 extern LexerModule lmConf
;
34 extern LexerModule lmCPP
;
35 extern LexerModule lmNncrontab
;
36 extern LexerModule lmEiffel
;
37 extern LexerModule lmHTML
;
38 extern LexerModule lmLISP
;
39 extern LexerModule lmLua
;
40 extern LexerModule lmBatch
; // In LexOthers.cxx
41 extern LexerModule lmPascal
;
42 extern LexerModule lmPerl
;
43 extern LexerModule lmPython
;
44 extern LexerModule lmRuby
;
45 extern LexerModule lmSQL
;
46 extern LexerModule lmVB
;
73 //----------------------------------------------------------------------
75 const wxChar
* wxSTCNameStr
= "stcwindow";
77 DEFINE_EVENT_TYPE( wxEVT_STC_CHANGE
)
78 DEFINE_EVENT_TYPE( wxEVT_STC_STYLENEEDED
)
79 DEFINE_EVENT_TYPE( wxEVT_STC_CHARADDED
)
80 DEFINE_EVENT_TYPE( wxEVT_STC_SAVEPOINTREACHED
)
81 DEFINE_EVENT_TYPE( wxEVT_STC_SAVEPOINTLEFT
)
82 DEFINE_EVENT_TYPE( wxEVT_STC_ROMODIFYATTEMPT
)
83 DEFINE_EVENT_TYPE( wxEVT_STC_KEY
)
84 DEFINE_EVENT_TYPE( wxEVT_STC_DOUBLECLICK
)
85 DEFINE_EVENT_TYPE( wxEVT_STC_UPDATEUI
)
86 DEFINE_EVENT_TYPE( wxEVT_STC_MODIFIED
)
87 DEFINE_EVENT_TYPE( wxEVT_STC_MACRORECORD
)
88 DEFINE_EVENT_TYPE( wxEVT_STC_MARGINCLICK
)
89 DEFINE_EVENT_TYPE( wxEVT_STC_NEEDSHOWN
)
90 DEFINE_EVENT_TYPE( wxEVT_STC_POSCHANGED
)
91 DEFINE_EVENT_TYPE( wxEVT_STC_PAINTED
)
92 DEFINE_EVENT_TYPE( wxEVT_STC_USERLISTSELECTION
)
93 DEFINE_EVENT_TYPE( wxEVT_STC_URIDROPPED
)
94 DEFINE_EVENT_TYPE( wxEVT_STC_DWELLSTART
)
95 DEFINE_EVENT_TYPE( wxEVT_STC_DWELLEND
)
96 DEFINE_EVENT_TYPE( wxEVT_STC_START_DRAG
)
97 DEFINE_EVENT_TYPE( wxEVT_STC_DRAG_OVER
)
98 DEFINE_EVENT_TYPE( wxEVT_STC_DO_DROP
)
101 BEGIN_EVENT_TABLE(wxStyledTextCtrl
, wxControl
)
102 EVT_PAINT (wxStyledTextCtrl::OnPaint
)
103 EVT_SCROLLWIN (wxStyledTextCtrl::OnScrollWin
)
104 EVT_SCROLL (wxStyledTextCtrl::OnScroll
)
105 EVT_SIZE (wxStyledTextCtrl::OnSize
)
106 EVT_LEFT_DOWN (wxStyledTextCtrl::OnMouseLeftDown
)
108 // Let Scintilla see the double click as a second click
109 EVT_LEFT_DCLICK (wxStyledTextCtrl::OnMouseLeftDown
)
111 EVT_MOTION (wxStyledTextCtrl::OnMouseMove
)
112 EVT_LEFT_UP (wxStyledTextCtrl::OnMouseLeftUp
)
114 EVT_RIGHT_UP (wxStyledTextCtrl::OnMouseRightUp
)
116 EVT_CONTEXT_MENU (wxStyledTextCtrl::OnContextMenu
)
118 EVT_MOUSEWHEEL (wxStyledTextCtrl::OnMouseWheel
)
119 EVT_CHAR (wxStyledTextCtrl::OnChar
)
120 EVT_KEY_DOWN (wxStyledTextCtrl::OnKeyDown
)
121 EVT_KILL_FOCUS (wxStyledTextCtrl::OnLoseFocus
)
122 EVT_SET_FOCUS (wxStyledTextCtrl::OnGainFocus
)
123 EVT_SYS_COLOUR_CHANGED (wxStyledTextCtrl::OnSysColourChanged
)
124 EVT_ERASE_BACKGROUND (wxStyledTextCtrl::OnEraseBackground
)
125 EVT_MENU_RANGE (-1, -1, wxStyledTextCtrl::OnMenu
)
126 EVT_LISTBOX_DCLICK (-1, wxStyledTextCtrl::OnListBox
)
130 IMPLEMENT_CLASS(wxStyledTextCtrl
, wxControl
)
131 IMPLEMENT_DYNAMIC_CLASS(wxStyledTextEvent
, wxCommandEvent
)
133 //----------------------------------------------------------------------
134 // Constructor and Destructor
136 wxStyledTextCtrl::wxStyledTextCtrl(wxWindow
*parent
,
141 const wxString
& name
) :
142 wxControl(parent
, id
, pos
, size
,
143 style
| wxVSCROLL
| wxHSCROLL
| wxWANTS_CHARS
| wxCLIP_CHILDREN
,
144 wxDefaultValidator
, name
)
146 m_swx
= new ScintillaWX(this);
148 m_lastKeyDownConsumed
= FALSE
;
154 wxStyledTextCtrl::~wxStyledTextCtrl() {
159 //----------------------------------------------------------------------
161 long wxStyledTextCtrl::SendMsg(int msg
, long wp
, long lp
) {
163 return m_swx
->WndProc(msg
, wp
, lp
);
171 #define MAKELONG(a, b) ((a) | ((b) << 16))
174 static long wxColourAsLong(const wxColour
& co
) {
175 return (((long)co
.Blue() << 16) |
176 ((long)co
.Green() << 8) |
180 static wxColour
wxColourFromLong(long c
) {
182 clr
.Set(c
& 0xff, (c
>> 8) & 0xff, (c
>> 16) & 0xff);
187 static wxColour
wxColourFromSpec(const wxString
& spec
) {
188 // spec should be #RRGGBB
190 int red
= strtol(spec
.Mid(1,2), &junk
, 16);
191 int green
= strtol(spec
.Mid(3,2), &junk
, 16);
192 int blue
= strtol(spec
.Mid(5,2), &junk
, 16);
193 return wxColour(red
, green
, blue
);
197 //----------------------------------------------------------------------
198 // BEGIN generated section. The following code is automatically generated
199 // by gen_iface.py from the contents of Scintilla.iface. Do not edit
200 // this file. Edit stc.cpp.in or gen_iface.py instead and regenerate.
204 // END of generated section
205 //----------------------------------------------------------------------
208 // Returns the line number of the line with the caret.
209 int wxStyledTextCtrl::GetCurrentLine() {
210 int line
= LineFromPosition(GetCurrentPos());
215 // Extract style settings from a spec-string which is composed of one or
216 // more of the following comma separated elements:
218 // bold turns on bold
219 // italic turns on italics
220 // fore:#RRGGBB sets the foreground colour
221 // back:#RRGGBB sets the background colour
222 // face:[facename] sets the font face name to use
223 // size:[num] sets the font size in points
224 // eol turns on eol filling
225 // underline turns on underlining
227 void wxStyledTextCtrl::StyleSetSpec(int styleNum
, const wxString
& spec
) {
229 wxStringTokenizer
tkz(spec
, ",");
230 while (tkz
.HasMoreTokens()) {
231 wxString token
= tkz
.GetNextToken();
233 wxString option
= token
.BeforeFirst(':');
234 wxString val
= token
.AfterFirst(':');
236 if (option
== "bold")
237 StyleSetBold(styleNum
, true);
239 else if (option
== "italic")
240 StyleSetItalic(styleNum
, true);
242 else if (option
== "underline")
243 StyleSetUnderline(styleNum
, true);
245 else if (option
== "eol")
246 StyleSetEOLFilled(styleNum
, true);
248 else if (option
== "size") {
250 if (val
.ToLong(&points
))
251 StyleSetSize(styleNum
, points
);
254 else if (option
== "face")
255 StyleSetFaceName(styleNum
, val
);
257 else if (option
== "fore")
258 StyleSetForeground(styleNum
, wxColourFromSpec(val
));
260 else if (option
== "back")
261 StyleSetBackground(styleNum
, wxColourFromSpec(val
));
266 // Set style size, face, bold, italic, and underline attributes from
267 // a wxFont's attributes.
268 void wxStyledTextCtrl::StyleSetFont(int styleNum
, wxFont
& font
) {
269 int size
= font
.GetPointSize();
270 wxString faceName
= font
.GetFaceName();
271 bool bold
= font
.GetWeight() == wxBOLD
;
272 bool italic
= font
.GetStyle() != wxNORMAL
;
273 bool under
= font
.GetUnderlined();
275 // TODO: add encoding/charset mapping
276 StyleSetFontAttr(styleNum
, size
, faceName
, bold
, italic
, under
);
279 // Set all font style attributes at once.
280 void wxStyledTextCtrl::StyleSetFontAttr(int styleNum
, int size
,
281 const wxString
& faceName
,
282 bool bold
, bool italic
,
284 StyleSetSize(styleNum
, size
);
285 StyleSetFaceName(styleNum
, faceName
);
286 StyleSetBold(styleNum
, bold
);
287 StyleSetItalic(styleNum
, italic
);
288 StyleSetUnderline(styleNum
, underline
);
290 // TODO: add encoding/charset mapping
294 // Perform one of the operations defined by the wxSTC_CMD_* constants.
295 void wxStyledTextCtrl::CmdKeyExecute(int cmd
) {
300 // Set the left and right margin in the edit area, measured in pixels.
301 void wxStyledTextCtrl::SetMargins(int left
, int right
) {
303 SetMarginRight(right
);
307 // Retrieve the start and end positions of the current selection.
308 void wxStyledTextCtrl::GetSelection(int* startPos
, int* endPos
) {
309 if (startPos
!= NULL
)
310 *startPos
= SendMsg(SCI_GETSELECTIONSTART
);
312 *endPos
= SendMsg(SCI_GETSELECTIONEND
);
316 // Retrieve the point in the window where a position is displayed.
317 wxPoint
wxStyledTextCtrl::PointFromPosition(int pos
) {
318 int x
= SendMsg(SCI_POINTXFROMPOSITION
, 0, pos
);
319 int y
= SendMsg(SCI_POINTYFROMPOSITION
, 0, pos
);
320 return wxPoint(x
, y
);
323 // Scroll enough to make the given line visible
324 void wxStyledTextCtrl::ScrollToLine(int line
) {
325 m_swx
->DoScrollToLine(line
);
329 // Scroll enough to make the given column visible
330 void wxStyledTextCtrl::ScrollToColumn(int column
) {
331 m_swx
->DoScrollToColumn(column
);
336 //----------------------------------------------------------------------
339 void wxStyledTextCtrl::OnPaint(wxPaintEvent
& evt
) {
341 wxRegion region
= GetUpdateRegion();
343 m_swx
->DoPaint(&dc
, region
.GetBox());
346 void wxStyledTextCtrl::OnScrollWin(wxScrollWinEvent
& evt
) {
347 if (evt
.GetOrientation() == wxHORIZONTAL
)
348 m_swx
->DoHScroll(evt
.GetEventType(), evt
.GetPosition());
350 m_swx
->DoVScroll(evt
.GetEventType(), evt
.GetPosition());
353 void wxStyledTextCtrl::OnScroll(wxScrollEvent
& evt
) {
354 wxScrollBar
* sb
= wxDynamicCast(evt
.GetEventObject(), wxScrollBar
);
356 if (sb
->IsVertical())
357 m_swx
->DoVScroll(evt
.GetEventType(), evt
.GetPosition());
359 m_swx
->DoHScroll(evt
.GetEventType(), evt
.GetPosition());
363 void wxStyledTextCtrl::OnSize(wxSizeEvent
& evt
) {
364 wxSize sz
= GetClientSize();
365 m_swx
->DoSize(sz
.x
, sz
.y
);
368 void wxStyledTextCtrl::OnMouseLeftDown(wxMouseEvent
& evt
) {
369 wxPoint pt
= evt
.GetPosition();
370 m_swx
->DoButtonDown(Point(pt
.x
, pt
.y
), m_stopWatch
.Time(),
371 evt
.ShiftDown(), evt
.ControlDown(), evt
.AltDown());
374 void wxStyledTextCtrl::OnMouseMove(wxMouseEvent
& evt
) {
375 wxPoint pt
= evt
.GetPosition();
376 m_swx
->DoButtonMove(Point(pt
.x
, pt
.y
));
379 void wxStyledTextCtrl::OnMouseLeftUp(wxMouseEvent
& evt
) {
380 wxPoint pt
= evt
.GetPosition();
381 m_swx
->DoButtonUp(Point(pt
.x
, pt
.y
), m_stopWatch
.Time(),
386 void wxStyledTextCtrl::OnMouseRightUp(wxMouseEvent
& evt
) {
387 wxPoint pt
= evt
.GetPosition();
388 m_swx
->DoContextMenu(Point(pt
.x
, pt
.y
));
392 void wxStyledTextCtrl::OnContextMenu(wxContextMenuEvent
& evt
) {
393 wxPoint pt
= evt
.GetPosition();
394 ScreenToClient(&pt
.x
, &pt
.y
);
395 m_swx
->DoContextMenu(Point(pt
.x
, pt
.y
));
399 void wxStyledTextCtrl::OnMouseWheel(wxMouseEvent
& evt
) {
400 m_swx
->DoMouseWheel(evt
.GetWheelRotation(),
402 evt
.GetLinesPerAction(),
407 void wxStyledTextCtrl::OnChar(wxKeyEvent
& evt
) {
408 long key
= evt
.KeyCode();
410 // printf("OnChar key:%%d consumed:%%d ctrl:%%d alt:%%d\n",
411 // key, m_lastKeyDownConsumed, evt.ControlDown(), evt.AltDown());
414 // \|@#¬[]{}?£$~ ã,õ,Ã,Õ, ñ, Ñ
416 // On (some?) non-US keyboards the AltGr key is required to enter some
417 // common characters. It comes to us as both Alt and Ctrl down so we need
418 // to let the char through in that case, otherwise if only ctrl or only
419 // alt let's skip it.
420 bool ctrl
= evt
.ControlDown();
421 bool alt
= evt
.AltDown();
422 bool skip
= ((ctrl
|| alt
) && ! (ctrl
&& alt
));
424 if (key
<= 0xff && key
>= 32 && !m_lastKeyDownConsumed
&& !skip
) {
425 m_swx
->DoAddChar(key
);
432 void wxStyledTextCtrl::OnKeyDown(wxKeyEvent
& evt
) {
433 long key
= evt
.KeyCode();
434 bool shift
= evt
.ShiftDown(),
435 ctrl
= evt
.ControlDown(),
438 int processed
= m_swx
->DoKeyDown(key
, shift
, ctrl
, alt
, &m_lastKeyDownConsumed
);
440 // printf("key: %%d shift: %%d ctrl: %%d alt: %%d processed: %%d consumed: %%d\n",
441 // key, shift, ctrl, alt, processed, m_lastKeyDownConsumed);
443 if (!processed
&& !m_lastKeyDownConsumed
)
448 void wxStyledTextCtrl::OnLoseFocus(wxFocusEvent
& evt
) {
449 m_swx
->DoLoseFocus();
453 void wxStyledTextCtrl::OnGainFocus(wxFocusEvent
& evt
) {
454 m_swx
->DoGainFocus();
458 void wxStyledTextCtrl::OnSysColourChanged(wxSysColourChangedEvent
& evt
) {
459 m_swx
->DoSysColourChange();
463 void wxStyledTextCtrl::OnEraseBackground(wxEraseEvent
& evt
) {
464 // do nothing to help avoid flashing
469 void wxStyledTextCtrl::OnMenu(wxCommandEvent
& evt
) {
470 m_swx
->DoCommand(evt
.GetId());
474 void wxStyledTextCtrl::OnListBox(wxCommandEvent
& evt
) {
475 m_swx
->DoOnListBox();
479 //----------------------------------------------------------------------
480 // Turn notifications from Scintilla into events
483 void wxStyledTextCtrl::NotifyChange() {
484 wxStyledTextEvent
evt(wxEVT_STC_CHANGE
, GetId());
485 evt
.SetEventObject(this);
486 GetEventHandler()->ProcessEvent(evt
);
489 void wxStyledTextCtrl::NotifyParent(SCNotification
* _scn
) {
490 SCNotification
& scn
= *_scn
;
491 wxStyledTextEvent
evt(0, GetId());
493 evt
.SetEventObject(this);
494 evt
.SetPosition(scn
.position
);
496 evt
.SetModifiers(scn
.modifiers
);
498 switch (scn
.nmhdr
.code
) {
499 case SCN_STYLENEEDED
:
500 evt
.SetEventType(wxEVT_STC_STYLENEEDED
);
504 evt
.SetEventType(wxEVT_STC_CHARADDED
);
507 case SCN_SAVEPOINTREACHED
:
508 evt
.SetEventType(wxEVT_STC_SAVEPOINTREACHED
);
511 case SCN_SAVEPOINTLEFT
:
512 evt
.SetEventType(wxEVT_STC_SAVEPOINTLEFT
);
515 case SCN_MODIFYATTEMPTRO
:
516 evt
.SetEventType(wxEVT_STC_ROMODIFYATTEMPT
);
520 evt
.SetEventType(wxEVT_STC_KEY
);
523 case SCN_DOUBLECLICK
:
524 evt
.SetEventType(wxEVT_STC_DOUBLECLICK
);
528 evt
.SetEventType(wxEVT_STC_UPDATEUI
);
532 evt
.SetEventType(wxEVT_STC_MODIFIED
);
533 evt
.SetModificationType(scn
.modificationType
);
535 evt
.SetText(wxString(scn
.text
, scn
.length
));
536 evt
.SetLength(scn
.length
);
537 evt
.SetLinesAdded(scn
.linesAdded
);
538 evt
.SetLine(scn
.line
);
539 evt
.SetFoldLevelNow(scn
.foldLevelNow
);
540 evt
.SetFoldLevelPrev(scn
.foldLevelPrev
);
543 case SCN_MACRORECORD
:
544 evt
.SetEventType(wxEVT_STC_MACRORECORD
);
545 evt
.SetMessage(scn
.message
);
546 evt
.SetWParam(scn
.wParam
);
547 evt
.SetLParam(scn
.lParam
);
550 case SCN_MARGINCLICK
:
551 evt
.SetEventType(wxEVT_STC_MARGINCLICK
);
552 evt
.SetMargin(scn
.margin
);
556 evt
.SetEventType(wxEVT_STC_NEEDSHOWN
);
557 evt
.SetLength(scn
.length
);
561 evt
.SetEventType(wxEVT_STC_POSCHANGED
);
565 evt
.SetEventType(wxEVT_STC_PAINTED
);
568 case SCN_USERLISTSELECTION
:
569 evt
.SetEventType(wxEVT_STC_USERLISTSELECTION
);
570 evt
.SetListType(scn
.listType
);
571 evt
.SetText(scn
.text
);
575 evt
.SetEventType(wxEVT_STC_URIDROPPED
);
576 evt
.SetText(scn
.text
);
580 evt
.SetEventType(wxEVT_STC_DWELLSTART
);
586 evt
.SetEventType(wxEVT_STC_DWELLEND
);
595 GetEventHandler()->ProcessEvent(evt
);
599 //----------------------------------------------------------------------
600 //----------------------------------------------------------------------
601 //----------------------------------------------------------------------
603 wxStyledTextEvent::wxStyledTextEvent(wxEventType commandType
, int id
)
604 : wxCommandEvent(commandType
, id
)
609 m_modificationType
= 0;
622 m_dragAllowMove
= FALSE
;
623 m_dragResult
= wxDragNone
;
626 bool wxStyledTextEvent::GetShift() const { return (m_modifiers
& SCI_SHIFT
) != 0; }
627 bool wxStyledTextEvent::GetControl() const { return (m_modifiers
& SCI_CTRL
) != 0; }
628 bool wxStyledTextEvent::GetAlt() const { return (m_modifiers
& SCI_ALT
) != 0; }
631 wxStyledTextEvent::wxStyledTextEvent(const wxStyledTextEvent
& event
):
632 wxCommandEvent(event
)
634 m_position
= event
.m_position
;
636 m_modifiers
= event
.m_modifiers
;
637 m_modificationType
= event
.m_modificationType
;
638 m_text
= event
.m_text
;
639 m_length
= event
.m_length
;
640 m_linesAdded
= event
.m_linesAdded
;
641 m_line
= event
.m_line
;
642 m_foldLevelNow
= event
.m_foldLevelNow
;
643 m_foldLevelPrev
= event
.m_foldLevelPrev
;
645 m_margin
= event
.m_margin
;
647 m_message
= event
.m_message
;
648 m_wParam
= event
.m_wParam
;
649 m_lParam
= event
.m_lParam
;
651 m_listType
= event
.m_listType
;
655 m_dragText
= event
.m_dragText
;
656 m_dragAllowMove
=event
.m_dragAllowMove
;
657 m_dragResult
= event
.m_dragResult
;
660 //----------------------------------------------------------------------
661 //----------------------------------------------------------------------