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>
26 //----------------------------------------------------------------------
28 const wxChar
* wxSTCNameStr
= wxT("stcwindow");
30 DEFINE_EVENT_TYPE( wxEVT_STC_CHANGE
)
31 DEFINE_EVENT_TYPE( wxEVT_STC_STYLENEEDED
)
32 DEFINE_EVENT_TYPE( wxEVT_STC_CHARADDED
)
33 DEFINE_EVENT_TYPE( wxEVT_STC_SAVEPOINTREACHED
)
34 DEFINE_EVENT_TYPE( wxEVT_STC_SAVEPOINTLEFT
)
35 DEFINE_EVENT_TYPE( wxEVT_STC_ROMODIFYATTEMPT
)
36 DEFINE_EVENT_TYPE( wxEVT_STC_KEY
)
37 DEFINE_EVENT_TYPE( wxEVT_STC_DOUBLECLICK
)
38 DEFINE_EVENT_TYPE( wxEVT_STC_UPDATEUI
)
39 DEFINE_EVENT_TYPE( wxEVT_STC_MODIFIED
)
40 DEFINE_EVENT_TYPE( wxEVT_STC_MACRORECORD
)
41 DEFINE_EVENT_TYPE( wxEVT_STC_MARGINCLICK
)
42 DEFINE_EVENT_TYPE( wxEVT_STC_NEEDSHOWN
)
43 DEFINE_EVENT_TYPE( wxEVT_STC_POSCHANGED
)
44 DEFINE_EVENT_TYPE( wxEVT_STC_PAINTED
)
45 DEFINE_EVENT_TYPE( wxEVT_STC_USERLISTSELECTION
)
46 DEFINE_EVENT_TYPE( wxEVT_STC_URIDROPPED
)
47 DEFINE_EVENT_TYPE( wxEVT_STC_DWELLSTART
)
48 DEFINE_EVENT_TYPE( wxEVT_STC_DWELLEND
)
49 DEFINE_EVENT_TYPE( wxEVT_STC_START_DRAG
)
50 DEFINE_EVENT_TYPE( wxEVT_STC_DRAG_OVER
)
51 DEFINE_EVENT_TYPE( wxEVT_STC_DO_DROP
)
54 BEGIN_EVENT_TABLE(wxStyledTextCtrl
, wxControl
)
55 EVT_PAINT (wxStyledTextCtrl::OnPaint
)
56 EVT_SCROLLWIN (wxStyledTextCtrl::OnScrollWin
)
57 EVT_SCROLL (wxStyledTextCtrl::OnScroll
)
58 EVT_SIZE (wxStyledTextCtrl::OnSize
)
59 EVT_LEFT_DOWN (wxStyledTextCtrl::OnMouseLeftDown
)
61 // Let Scintilla see the double click as a second click
62 EVT_LEFT_DCLICK (wxStyledTextCtrl::OnMouseLeftDown
)
64 EVT_MOTION (wxStyledTextCtrl::OnMouseMove
)
65 EVT_LEFT_UP (wxStyledTextCtrl::OnMouseLeftUp
)
67 EVT_RIGHT_UP (wxStyledTextCtrl::OnMouseRightUp
)
69 EVT_CONTEXT_MENU (wxStyledTextCtrl::OnContextMenu
)
71 EVT_MOUSEWHEEL (wxStyledTextCtrl::OnMouseWheel
)
72 EVT_CHAR (wxStyledTextCtrl::OnChar
)
73 EVT_KEY_DOWN (wxStyledTextCtrl::OnKeyDown
)
74 EVT_KILL_FOCUS (wxStyledTextCtrl::OnLoseFocus
)
75 EVT_SET_FOCUS (wxStyledTextCtrl::OnGainFocus
)
76 EVT_SYS_COLOUR_CHANGED (wxStyledTextCtrl::OnSysColourChanged
)
77 EVT_ERASE_BACKGROUND (wxStyledTextCtrl::OnEraseBackground
)
78 EVT_MENU_RANGE (-1, -1, wxStyledTextCtrl::OnMenu
)
79 EVT_LISTBOX_DCLICK (-1, wxStyledTextCtrl::OnListBox
)
83 IMPLEMENT_CLASS(wxStyledTextCtrl
, wxControl
)
84 IMPLEMENT_DYNAMIC_CLASS(wxStyledTextEvent
, wxCommandEvent
)
86 // forces the linking of the lexer modules
87 int Scintilla_LinkLexers();
89 //----------------------------------------------------------------------
90 // Constructor and Destructor
92 wxStyledTextCtrl::wxStyledTextCtrl(wxWindow
*parent
,
97 const wxString
& name
) :
98 wxControl(parent
, id
, pos
, size
,
99 style
| wxVSCROLL
| wxHSCROLL
| wxWANTS_CHARS
| wxCLIP_CHILDREN
,
100 wxDefaultValidator
, name
)
102 Scintilla_LinkLexers();
103 m_swx
= new ScintillaWX(this);
105 m_lastKeyDownConsumed
= FALSE
;
109 // Put Scintilla into unicode (UTF-8) mode
110 SetCodePage(wxSTC_CP_UTF8
);
115 wxStyledTextCtrl::~wxStyledTextCtrl() {
120 //----------------------------------------------------------------------
122 long wxStyledTextCtrl::SendMsg(int msg
, long wp
, long lp
) {
124 return m_swx
->WndProc(msg
, wp
, lp
);
132 #define MAKELONG(a, b) ((a) | ((b) << 16))
135 static long wxColourAsLong(const wxColour
& co
) {
136 return (((long)co
.Blue() << 16) |
137 ((long)co
.Green() << 8) |
141 static wxColour
wxColourFromLong(long c
) {
143 clr
.Set(c
& 0xff, (c
>> 8) & 0xff, (c
>> 16) & 0xff);
148 static wxColour
wxColourFromSpec(const wxString
& spec
) {
149 // spec should be "#RRGGBB"
150 long red
, green
, blue
;
151 red
= green
= blue
= 0;
152 spec
.Mid(1,2).ToLong(&red
, 16);
153 spec
.Mid(3,2).ToLong(&green
, 16);
154 spec
.Mid(5,2).ToLong(&blue
, 16);
155 return wxColour(red
, green
, blue
);
159 //----------------------------------------------------------------------
160 // BEGIN generated section. The following code is automatically generated
161 // by gen_iface.py from the contents of Scintilla.iface. Do not edit
162 // this file. Edit stc.cpp.in or gen_iface.py instead and regenerate.
166 // END of generated section
167 //----------------------------------------------------------------------
170 // Returns the line number of the line with the caret.
171 int wxStyledTextCtrl::GetCurrentLine() {
172 int line
= LineFromPosition(GetCurrentPos());
177 // Extract style settings from a spec-string which is composed of one or
178 // more of the following comma separated elements:
180 // bold turns on bold
181 // italic turns on italics
182 // fore:#RRGGBB sets the foreground colour
183 // back:#RRGGBB sets the background colour
184 // face:[facename] sets the font face name to use
185 // size:[num] sets the font size in points
186 // eol turns on eol filling
187 // underline turns on underlining
189 void wxStyledTextCtrl::StyleSetSpec(int styleNum
, const wxString
& spec
) {
191 wxStringTokenizer
tkz(spec
, ",");
192 while (tkz
.HasMoreTokens()) {
193 wxString token
= tkz
.GetNextToken();
195 wxString option
= token
.BeforeFirst(':');
196 wxString val
= token
.AfterFirst(':');
198 if (option
== "bold")
199 StyleSetBold(styleNum
, true);
201 else if (option
== "italic")
202 StyleSetItalic(styleNum
, true);
204 else if (option
== "underline")
205 StyleSetUnderline(styleNum
, true);
207 else if (option
== "eol")
208 StyleSetEOLFilled(styleNum
, true);
210 else if (option
== "size") {
212 if (val
.ToLong(&points
))
213 StyleSetSize(styleNum
, points
);
216 else if (option
== "face")
217 StyleSetFaceName(styleNum
, val
);
219 else if (option
== "fore")
220 StyleSetForeground(styleNum
, wxColourFromSpec(val
));
222 else if (option
== "back")
223 StyleSetBackground(styleNum
, wxColourFromSpec(val
));
228 // Set style size, face, bold, italic, and underline attributes from
229 // a wxFont's attributes.
230 void wxStyledTextCtrl::StyleSetFont(int styleNum
, wxFont
& font
) {
231 int size
= font
.GetPointSize();
232 wxString faceName
= font
.GetFaceName();
233 bool bold
= font
.GetWeight() == wxBOLD
;
234 bool italic
= font
.GetStyle() != wxNORMAL
;
235 bool under
= font
.GetUnderlined();
237 // TODO: add encoding/charset mapping
238 StyleSetFontAttr(styleNum
, size
, faceName
, bold
, italic
, under
);
241 // Set all font style attributes at once.
242 void wxStyledTextCtrl::StyleSetFontAttr(int styleNum
, int size
,
243 const wxString
& faceName
,
244 bool bold
, bool italic
,
246 StyleSetSize(styleNum
, size
);
247 StyleSetFaceName(styleNum
, faceName
);
248 StyleSetBold(styleNum
, bold
);
249 StyleSetItalic(styleNum
, italic
);
250 StyleSetUnderline(styleNum
, underline
);
252 // TODO: add encoding/charset mapping
256 // Perform one of the operations defined by the wxSTC_CMD_* constants.
257 void wxStyledTextCtrl::CmdKeyExecute(int cmd
) {
262 // Set the left and right margin in the edit area, measured in pixels.
263 void wxStyledTextCtrl::SetMargins(int left
, int right
) {
265 SetMarginRight(right
);
269 // Retrieve the start and end positions of the current selection.
270 void wxStyledTextCtrl::GetSelection(int* startPos
, int* endPos
) {
271 if (startPos
!= NULL
)
272 *startPos
= SendMsg(SCI_GETSELECTIONSTART
);
274 *endPos
= SendMsg(SCI_GETSELECTIONEND
);
278 // Retrieve the point in the window where a position is displayed.
279 wxPoint
wxStyledTextCtrl::PointFromPosition(int pos
) {
280 int x
= SendMsg(SCI_POINTXFROMPOSITION
, 0, pos
);
281 int y
= SendMsg(SCI_POINTYFROMPOSITION
, 0, pos
);
282 return wxPoint(x
, y
);
285 // Scroll enough to make the given line visible
286 void wxStyledTextCtrl::ScrollToLine(int line
) {
287 m_swx
->DoScrollToLine(line
);
291 // Scroll enough to make the given column visible
292 void wxStyledTextCtrl::ScrollToColumn(int column
) {
293 m_swx
->DoScrollToColumn(column
);
298 //----------------------------------------------------------------------
301 void wxStyledTextCtrl::OnPaint(wxPaintEvent
& evt
) {
303 wxRegion region
= GetUpdateRegion();
305 m_swx
->DoPaint(&dc
, region
.GetBox());
308 void wxStyledTextCtrl::OnScrollWin(wxScrollWinEvent
& evt
) {
309 if (evt
.GetOrientation() == wxHORIZONTAL
)
310 m_swx
->DoHScroll(evt
.GetEventType(), evt
.GetPosition());
312 m_swx
->DoVScroll(evt
.GetEventType(), evt
.GetPosition());
315 void wxStyledTextCtrl::OnScroll(wxScrollEvent
& evt
) {
316 wxScrollBar
* sb
= wxDynamicCast(evt
.GetEventObject(), wxScrollBar
);
318 if (sb
->IsVertical())
319 m_swx
->DoVScroll(evt
.GetEventType(), evt
.GetPosition());
321 m_swx
->DoHScroll(evt
.GetEventType(), evt
.GetPosition());
325 void wxStyledTextCtrl::OnSize(wxSizeEvent
& evt
) {
326 wxSize sz
= GetClientSize();
327 m_swx
->DoSize(sz
.x
, sz
.y
);
331 void wxStyledTextCtrl::OnMouseLeftDown(wxMouseEvent
& evt
) {
332 wxPoint pt
= evt
.GetPosition();
333 m_swx
->DoButtonDown(Point(pt
.x
, pt
.y
), m_stopWatch
.Time(),
334 evt
.ShiftDown(), evt
.ControlDown(), evt
.AltDown());
337 void wxStyledTextCtrl::OnMouseMove(wxMouseEvent
& evt
) {
338 wxPoint pt
= evt
.GetPosition();
339 m_swx
->DoButtonMove(Point(pt
.x
, pt
.y
));
342 void wxStyledTextCtrl::OnMouseLeftUp(wxMouseEvent
& evt
) {
343 wxPoint pt
= evt
.GetPosition();
344 m_swx
->DoButtonUp(Point(pt
.x
, pt
.y
), m_stopWatch
.Time(),
349 void wxStyledTextCtrl::OnMouseRightUp(wxMouseEvent
& evt
) {
350 wxPoint pt
= evt
.GetPosition();
351 m_swx
->DoContextMenu(Point(pt
.x
, pt
.y
));
355 void wxStyledTextCtrl::OnContextMenu(wxContextMenuEvent
& evt
) {
356 wxPoint pt
= evt
.GetPosition();
357 ScreenToClient(&pt
.x
, &pt
.y
);
358 m_swx
->DoContextMenu(Point(pt
.x
, pt
.y
));
362 void wxStyledTextCtrl::OnMouseWheel(wxMouseEvent
& evt
) {
363 m_swx
->DoMouseWheel(evt
.GetWheelRotation(),
365 evt
.GetLinesPerAction(),
370 void wxStyledTextCtrl::OnChar(wxKeyEvent
& evt
) {
371 int key
= evt
.GetKeyCode();
373 // On (some?) non-US keyboards the AltGr key is required to enter some
374 // common characters. It comes to us as both Alt and Ctrl down so we need
375 // to let the char through in that case, otherwise if only ctrl or only
376 // alt let's skip it.
377 bool ctrl
= evt
.ControlDown();
378 bool alt
= evt
.AltDown();
379 bool skip
= ((ctrl
|| alt
) && ! (ctrl
&& alt
));
381 //printf("OnChar key:%%d consumed:%%d ctrl:%%d alt:%%d skip:%%d\n",
382 // key, m_lastKeyDownConsumed, ctrl, alt, skip);
384 if (key
<= WXK_START
&& /*key >= 32 &&*/ !m_lastKeyDownConsumed
&& !skip
) {
385 m_swx
->DoAddChar(key
);
392 void wxStyledTextCtrl::OnKeyDown(wxKeyEvent
& evt
) {
393 int key
= evt
.GetKeyCode();
394 bool shift
= evt
.ShiftDown(),
395 ctrl
= evt
.ControlDown(),
398 int processed
= m_swx
->DoKeyDown(key
, shift
, ctrl
, alt
, &m_lastKeyDownConsumed
);
400 // printf("key: %%d shift: %%d ctrl: %%d alt: %%d processed: %%d consumed: %%d\n",
401 // key, shift, ctrl, alt, processed, m_lastKeyDownConsumed);
403 if (!processed
&& !m_lastKeyDownConsumed
)
408 void wxStyledTextCtrl::OnLoseFocus(wxFocusEvent
& evt
) {
409 m_swx
->DoLoseFocus();
413 void wxStyledTextCtrl::OnGainFocus(wxFocusEvent
& evt
) {
414 m_swx
->DoGainFocus();
418 void wxStyledTextCtrl::OnSysColourChanged(wxSysColourChangedEvent
& evt
) {
419 m_swx
->DoSysColourChange();
423 void wxStyledTextCtrl::OnEraseBackground(wxEraseEvent
& evt
) {
424 // do nothing to help avoid flashing
429 void wxStyledTextCtrl::OnMenu(wxCommandEvent
& evt
) {
430 m_swx
->DoCommand(evt
.GetId());
434 void wxStyledTextCtrl::OnListBox(wxCommandEvent
& evt
) {
435 m_swx
->DoOnListBox();
439 //----------------------------------------------------------------------
440 // Turn notifications from Scintilla into events
443 void wxStyledTextCtrl::NotifyChange() {
444 wxStyledTextEvent
evt(wxEVT_STC_CHANGE
, GetId());
445 evt
.SetEventObject(this);
446 GetEventHandler()->ProcessEvent(evt
);
449 void wxStyledTextCtrl::NotifyParent(SCNotification
* _scn
) {
450 SCNotification
& scn
= *_scn
;
451 wxStyledTextEvent
evt(0, GetId());
453 evt
.SetEventObject(this);
454 evt
.SetPosition(scn
.position
);
456 evt
.SetModifiers(scn
.modifiers
);
458 switch (scn
.nmhdr
.code
) {
459 case SCN_STYLENEEDED
:
460 evt
.SetEventType(wxEVT_STC_STYLENEEDED
);
464 evt
.SetEventType(wxEVT_STC_CHARADDED
);
467 case SCN_SAVEPOINTREACHED
:
468 evt
.SetEventType(wxEVT_STC_SAVEPOINTREACHED
);
471 case SCN_SAVEPOINTLEFT
:
472 evt
.SetEventType(wxEVT_STC_SAVEPOINTLEFT
);
475 case SCN_MODIFYATTEMPTRO
:
476 evt
.SetEventType(wxEVT_STC_ROMODIFYATTEMPT
);
480 evt
.SetEventType(wxEVT_STC_KEY
);
483 case SCN_DOUBLECLICK
:
484 evt
.SetEventType(wxEVT_STC_DOUBLECLICK
);
488 evt
.SetEventType(wxEVT_STC_UPDATEUI
);
492 evt
.SetEventType(wxEVT_STC_MODIFIED
);
493 evt
.SetModificationType(scn
.modificationType
);
495 // The unicode conversion MUST have a null byte to terminate the
496 // string so move it into a buffer first and give it one.
497 wxMemoryBuffer
buf(scn
.length
+1);
498 buf
.AppendData((void*)scn
.text
, scn
.length
);
500 evt
.SetText(wxString(buf
, wxConvUTF8
));
502 evt
.SetLength(scn
.length
);
503 evt
.SetLinesAdded(scn
.linesAdded
);
504 evt
.SetLine(scn
.line
);
505 evt
.SetFoldLevelNow(scn
.foldLevelNow
);
506 evt
.SetFoldLevelPrev(scn
.foldLevelPrev
);
509 case SCN_MACRORECORD
:
510 evt
.SetEventType(wxEVT_STC_MACRORECORD
);
511 evt
.SetMessage(scn
.message
);
512 evt
.SetWParam(scn
.wParam
);
513 evt
.SetLParam(scn
.lParam
);
516 case SCN_MARGINCLICK
:
517 evt
.SetEventType(wxEVT_STC_MARGINCLICK
);
518 evt
.SetMargin(scn
.margin
);
522 evt
.SetEventType(wxEVT_STC_NEEDSHOWN
);
523 evt
.SetLength(scn
.length
);
527 evt
.SetEventType(wxEVT_STC_PAINTED
);
530 case SCN_USERLISTSELECTION
:
531 evt
.SetEventType(wxEVT_STC_USERLISTSELECTION
);
532 evt
.SetListType(scn
.listType
);
533 evt
.SetText(scn
.text
);
537 evt
.SetEventType(wxEVT_STC_URIDROPPED
);
538 evt
.SetText(scn
.text
);
542 evt
.SetEventType(wxEVT_STC_DWELLSTART
);
548 evt
.SetEventType(wxEVT_STC_DWELLEND
);
557 GetEventHandler()->ProcessEvent(evt
);
561 //----------------------------------------------------------------------
562 //----------------------------------------------------------------------
563 //----------------------------------------------------------------------
565 wxStyledTextEvent::wxStyledTextEvent(wxEventType commandType
, int id
)
566 : wxCommandEvent(commandType
, id
)
571 m_modificationType
= 0;
584 m_dragAllowMove
= FALSE
;
585 m_dragResult
= wxDragNone
;
588 bool wxStyledTextEvent::GetShift() const { return (m_modifiers
& SCI_SHIFT
) != 0; }
589 bool wxStyledTextEvent::GetControl() const { return (m_modifiers
& SCI_CTRL
) != 0; }
590 bool wxStyledTextEvent::GetAlt() const { return (m_modifiers
& SCI_ALT
) != 0; }
593 wxStyledTextEvent::wxStyledTextEvent(const wxStyledTextEvent
& event
):
594 wxCommandEvent(event
)
596 m_position
= event
.m_position
;
598 m_modifiers
= event
.m_modifiers
;
599 m_modificationType
= event
.m_modificationType
;
600 m_text
= event
.m_text
;
601 m_length
= event
.m_length
;
602 m_linesAdded
= event
.m_linesAdded
;
603 m_line
= event
.m_line
;
604 m_foldLevelNow
= event
.m_foldLevelNow
;
605 m_foldLevelPrev
= event
.m_foldLevelPrev
;
607 m_margin
= event
.m_margin
;
609 m_message
= event
.m_message
;
610 m_wParam
= event
.m_wParam
;
611 m_lParam
= event
.m_lParam
;
613 m_listType
= event
.m_listType
;
617 m_dragText
= event
.m_dragText
;
618 m_dragAllowMove
=event
.m_dragAllowMove
;
619 m_dragResult
= event
.m_dragResult
;
622 //----------------------------------------------------------------------
623 //----------------------------------------------------------------------