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");
34 #define MAKELONG(a, b) ((a) | ((b) << 16))
37 static long wxColourAsLong(const wxColour
& co
) {
38 return (((long)co
.Blue() << 16) |
39 ((long)co
.Green() << 8) |
43 static wxColour
wxColourFromLong(long c
) {
45 clr
.Set(c
& 0xff, (c
>> 8) & 0xff, (c
>> 16) & 0xff);
50 static wxColour
wxColourFromSpec(const wxString
& spec
) {
51 // spec should be "#RRGGBB"
52 long red
, green
, blue
;
53 red
= green
= blue
= 0;
54 spec
.Mid(1,2).ToLong(&red
, 16);
55 spec
.Mid(3,2).ToLong(&green
, 16);
56 spec
.Mid(5,2).ToLong(&blue
, 16);
57 return wxColour(red
, green
, blue
);
60 //----------------------------------------------------------------------
62 DEFINE_EVENT_TYPE( wxEVT_STC_CHANGE
)
63 DEFINE_EVENT_TYPE( wxEVT_STC_STYLENEEDED
)
64 DEFINE_EVENT_TYPE( wxEVT_STC_CHARADDED
)
65 DEFINE_EVENT_TYPE( wxEVT_STC_SAVEPOINTREACHED
)
66 DEFINE_EVENT_TYPE( wxEVT_STC_SAVEPOINTLEFT
)
67 DEFINE_EVENT_TYPE( wxEVT_STC_ROMODIFYATTEMPT
)
68 DEFINE_EVENT_TYPE( wxEVT_STC_KEY
)
69 DEFINE_EVENT_TYPE( wxEVT_STC_DOUBLECLICK
)
70 DEFINE_EVENT_TYPE( wxEVT_STC_UPDATEUI
)
71 DEFINE_EVENT_TYPE( wxEVT_STC_MODIFIED
)
72 DEFINE_EVENT_TYPE( wxEVT_STC_MACRORECORD
)
73 DEFINE_EVENT_TYPE( wxEVT_STC_MARGINCLICK
)
74 DEFINE_EVENT_TYPE( wxEVT_STC_NEEDSHOWN
)
75 DEFINE_EVENT_TYPE( wxEVT_STC_POSCHANGED
)
76 DEFINE_EVENT_TYPE( wxEVT_STC_PAINTED
)
77 DEFINE_EVENT_TYPE( wxEVT_STC_USERLISTSELECTION
)
78 DEFINE_EVENT_TYPE( wxEVT_STC_URIDROPPED
)
79 DEFINE_EVENT_TYPE( wxEVT_STC_DWELLSTART
)
80 DEFINE_EVENT_TYPE( wxEVT_STC_DWELLEND
)
81 DEFINE_EVENT_TYPE( wxEVT_STC_START_DRAG
)
82 DEFINE_EVENT_TYPE( wxEVT_STC_DRAG_OVER
)
83 DEFINE_EVENT_TYPE( wxEVT_STC_DO_DROP
)
86 BEGIN_EVENT_TABLE(wxStyledTextCtrl
, wxControl
)
87 EVT_PAINT (wxStyledTextCtrl::OnPaint
)
88 EVT_SCROLLWIN (wxStyledTextCtrl::OnScrollWin
)
89 EVT_SCROLL (wxStyledTextCtrl::OnScroll
)
90 EVT_SIZE (wxStyledTextCtrl::OnSize
)
91 EVT_LEFT_DOWN (wxStyledTextCtrl::OnMouseLeftDown
)
92 #if defined(__WXMSW__) || defined(__WXMAC__)
93 // Let Scintilla see the double click as a second click
94 EVT_LEFT_DCLICK (wxStyledTextCtrl::OnMouseLeftDown
)
96 EVT_MOTION (wxStyledTextCtrl::OnMouseMove
)
97 EVT_LEFT_UP (wxStyledTextCtrl::OnMouseLeftUp
)
98 #if defined(__WXGTK__) || defined(__WXMAC__)
99 EVT_RIGHT_UP (wxStyledTextCtrl::OnMouseRightUp
)
101 EVT_CONTEXT_MENU (wxStyledTextCtrl::OnContextMenu
)
103 EVT_MOUSEWHEEL (wxStyledTextCtrl::OnMouseWheel
)
104 EVT_CHAR (wxStyledTextCtrl::OnChar
)
105 EVT_KEY_DOWN (wxStyledTextCtrl::OnKeyDown
)
106 EVT_KILL_FOCUS (wxStyledTextCtrl::OnLoseFocus
)
107 EVT_SET_FOCUS (wxStyledTextCtrl::OnGainFocus
)
108 EVT_SYS_COLOUR_CHANGED (wxStyledTextCtrl::OnSysColourChanged
)
109 EVT_ERASE_BACKGROUND (wxStyledTextCtrl::OnEraseBackground
)
110 EVT_MENU_RANGE (-1, -1, wxStyledTextCtrl::OnMenu
)
111 EVT_LISTBOX_DCLICK (-1, wxStyledTextCtrl::OnListBox
)
115 IMPLEMENT_CLASS(wxStyledTextCtrl
, wxControl
)
116 IMPLEMENT_DYNAMIC_CLASS(wxStyledTextEvent
, wxCommandEvent
)
118 // forces the linking of the lexer modules
119 int Scintilla_LinkLexers();
121 //----------------------------------------------------------------------
122 // Constructor and Destructor
124 wxStyledTextCtrl::wxStyledTextCtrl(wxWindow
*parent
,
129 const wxString
& name
) :
130 wxControl(parent
, id
, pos
, size
,
131 style
| wxVSCROLL
| wxHSCROLL
| wxWANTS_CHARS
| wxCLIP_CHILDREN
,
132 wxDefaultValidator
, name
)
134 Scintilla_LinkLexers();
135 m_swx
= new ScintillaWX(this);
137 m_lastKeyDownConsumed
= FALSE
;
141 // Put Scintilla into unicode (UTF-8) mode
142 SetCodePage(wxSTC_CP_UTF8
);
147 wxStyledTextCtrl::~wxStyledTextCtrl() {
152 //----------------------------------------------------------------------
154 long wxStyledTextCtrl::SendMsg(int msg
, long wp
, long lp
) {
156 return m_swx
->WndProc(msg
, wp
, lp
);
161 //----------------------------------------------------------------------
162 // BEGIN generated section. The following code is automatically generated
163 // by gen_iface.py from the contents of Scintilla.iface. Do not edit
164 // this file. Edit stc.cpp.in or gen_iface.py instead and regenerate.
168 // END of generated section
169 //----------------------------------------------------------------------
172 // Returns the line number of the line with the caret.
173 int wxStyledTextCtrl::GetCurrentLine() {
174 int line
= LineFromPosition(GetCurrentPos());
179 // Extract style settings from a spec-string which is composed of one or
180 // more of the following comma separated elements:
182 // bold turns on bold
183 // italic turns on italics
184 // fore:#RRGGBB sets the foreground colour
185 // back:#RRGGBB sets the background colour
186 // face:[facename] sets the font face name to use
187 // size:[num] sets the font size in points
188 // eol turns on eol filling
189 // underline turns on underlining
191 void wxStyledTextCtrl::StyleSetSpec(int styleNum
, const wxString
& spec
) {
193 wxStringTokenizer
tkz(spec
, wxT(","));
194 while (tkz
.HasMoreTokens()) {
195 wxString token
= tkz
.GetNextToken();
197 wxString option
= token
.BeforeFirst(':');
198 wxString val
= token
.AfterFirst(':');
200 if (option
== wxT("bold"))
201 StyleSetBold(styleNum
, true);
203 else if (option
== wxT("italic"))
204 StyleSetItalic(styleNum
, true);
206 else if (option
== wxT("underline"))
207 StyleSetUnderline(styleNum
, true);
209 else if (option
== wxT("eol"))
210 StyleSetEOLFilled(styleNum
, true);
212 else if (option
== wxT("size")) {
214 if (val
.ToLong(&points
))
215 StyleSetSize(styleNum
, points
);
218 else if (option
== wxT("face"))
219 StyleSetFaceName(styleNum
, val
);
221 else if (option
== wxT("fore"))
222 StyleSetForeground(styleNum
, wxColourFromSpec(val
));
224 else if (option
== wxT("back"))
225 StyleSetBackground(styleNum
, wxColourFromSpec(val
));
230 // Set style size, face, bold, italic, and underline attributes from
231 // a wxFont's attributes.
232 void wxStyledTextCtrl::StyleSetFont(int styleNum
, wxFont
& font
) {
233 int size
= font
.GetPointSize();
234 wxString faceName
= font
.GetFaceName();
235 bool bold
= font
.GetWeight() == wxBOLD
;
236 bool italic
= font
.GetStyle() != wxNORMAL
;
237 bool under
= font
.GetUnderlined();
239 // TODO: add encoding/charset mapping
240 StyleSetFontAttr(styleNum
, size
, faceName
, bold
, italic
, under
);
243 // Set all font style attributes at once.
244 void wxStyledTextCtrl::StyleSetFontAttr(int styleNum
, int size
,
245 const wxString
& faceName
,
246 bool bold
, bool italic
,
248 StyleSetSize(styleNum
, size
);
249 StyleSetFaceName(styleNum
, faceName
);
250 StyleSetBold(styleNum
, bold
);
251 StyleSetItalic(styleNum
, italic
);
252 StyleSetUnderline(styleNum
, underline
);
254 // TODO: add encoding/charset mapping
258 // Perform one of the operations defined by the wxSTC_CMD_* constants.
259 void wxStyledTextCtrl::CmdKeyExecute(int cmd
) {
264 // Set the left and right margin in the edit area, measured in pixels.
265 void wxStyledTextCtrl::SetMargins(int left
, int right
) {
267 SetMarginRight(right
);
271 // Retrieve the start and end positions of the current selection.
272 void wxStyledTextCtrl::GetSelection(int* startPos
, int* endPos
) {
273 if (startPos
!= NULL
)
274 *startPos
= SendMsg(SCI_GETSELECTIONSTART
);
276 *endPos
= SendMsg(SCI_GETSELECTIONEND
);
280 // Retrieve the point in the window where a position is displayed.
281 wxPoint
wxStyledTextCtrl::PointFromPosition(int pos
) {
282 int x
= SendMsg(SCI_POINTXFROMPOSITION
, 0, pos
);
283 int y
= SendMsg(SCI_POINTYFROMPOSITION
, 0, pos
);
284 return wxPoint(x
, y
);
287 // Scroll enough to make the given line visible
288 void wxStyledTextCtrl::ScrollToLine(int line
) {
289 m_swx
->DoScrollToLine(line
);
293 // Scroll enough to make the given column visible
294 void wxStyledTextCtrl::ScrollToColumn(int column
) {
295 m_swx
->DoScrollToColumn(column
);
300 //----------------------------------------------------------------------
303 void wxStyledTextCtrl::OnPaint(wxPaintEvent
& evt
) {
305 wxRegion region
= GetUpdateRegion();
307 m_swx
->DoPaint(&dc
, region
.GetBox());
310 void wxStyledTextCtrl::OnScrollWin(wxScrollWinEvent
& evt
) {
311 if (evt
.GetOrientation() == wxHORIZONTAL
)
312 m_swx
->DoHScroll(evt
.GetEventType(), evt
.GetPosition());
314 m_swx
->DoVScroll(evt
.GetEventType(), evt
.GetPosition());
317 void wxStyledTextCtrl::OnScroll(wxScrollEvent
& evt
) {
318 wxScrollBar
* sb
= wxDynamicCast(evt
.GetEventObject(), wxScrollBar
);
320 if (sb
->IsVertical())
321 m_swx
->DoVScroll(evt
.GetEventType(), evt
.GetPosition());
323 m_swx
->DoHScroll(evt
.GetEventType(), evt
.GetPosition());
327 void wxStyledTextCtrl::OnSize(wxSizeEvent
& evt
) {
328 wxSize sz
= GetClientSize();
329 m_swx
->DoSize(sz
.x
, sz
.y
);
332 void wxStyledTextCtrl::OnMouseLeftDown(wxMouseEvent
& evt
) {
334 wxPoint pt
= evt
.GetPosition();
335 m_swx
->DoButtonDown(Point(pt
.x
, pt
.y
), m_stopWatch
.Time(),
336 evt
.ShiftDown(), evt
.ControlDown(), evt
.AltDown());
339 void wxStyledTextCtrl::OnMouseMove(wxMouseEvent
& evt
) {
340 wxPoint pt
= evt
.GetPosition();
341 m_swx
->DoButtonMove(Point(pt
.x
, pt
.y
));
344 void wxStyledTextCtrl::OnMouseLeftUp(wxMouseEvent
& evt
) {
345 wxPoint pt
= evt
.GetPosition();
346 m_swx
->DoButtonUp(Point(pt
.x
, pt
.y
), m_stopWatch
.Time(),
351 void wxStyledTextCtrl::OnMouseRightUp(wxMouseEvent
& evt
) {
352 wxPoint pt
= evt
.GetPosition();
353 m_swx
->DoContextMenu(Point(pt
.x
, pt
.y
));
357 void wxStyledTextCtrl::OnContextMenu(wxContextMenuEvent
& evt
) {
358 wxPoint pt
= evt
.GetPosition();
359 ScreenToClient(&pt
.x
, &pt
.y
);
360 m_swx
->DoContextMenu(Point(pt
.x
, pt
.y
));
364 void wxStyledTextCtrl::OnMouseWheel(wxMouseEvent
& evt
) {
365 m_swx
->DoMouseWheel(evt
.GetWheelRotation(),
367 evt
.GetLinesPerAction(),
372 void wxStyledTextCtrl::OnChar(wxKeyEvent
& evt
) {
373 int key
= evt
.GetKeyCode();
375 // On (some?) non-US keyboards the AltGr key is required to enter some
376 // common characters. It comes to us as both Alt and Ctrl down so we need
377 // to let the char through in that case, otherwise if only ctrl or only
378 // alt let's skip it.
379 bool ctrl
= evt
.ControlDown();
380 bool alt
= evt
.AltDown();
381 bool skip
= ((ctrl
|| alt
) && ! (ctrl
&& alt
));
383 // printf("OnChar key:%%d consumed:%%d ctrl:%%d alt:%%d skip:%%d\n",
384 // key, m_lastKeyDownConsumed, ctrl, alt, skip);
386 if (key
<= WXK_START
&& /*key >= 32 &&*/ !m_lastKeyDownConsumed
&& !skip
) {
387 m_swx
->DoAddChar(key
);
394 void wxStyledTextCtrl::OnKeyDown(wxKeyEvent
& evt
) {
395 int key
= evt
.GetKeyCode();
396 bool shift
= evt
.ShiftDown(),
397 ctrl
= evt
.ControlDown(),
400 int processed
= m_swx
->DoKeyDown(key
, shift
, ctrl
, alt
, &m_lastKeyDownConsumed
);
402 // printf("KeyDn key:%%d shift:%%d ctrl:%%d alt:%%d processed:%%d consumed:%%d\n",
403 // key, shift, ctrl, alt, processed, m_lastKeyDownConsumed);
405 if (!processed
&& !m_lastKeyDownConsumed
)
410 void wxStyledTextCtrl::OnLoseFocus(wxFocusEvent
& evt
) {
411 m_swx
->DoLoseFocus();
415 void wxStyledTextCtrl::OnGainFocus(wxFocusEvent
& evt
) {
416 m_swx
->DoGainFocus();
420 void wxStyledTextCtrl::OnSysColourChanged(wxSysColourChangedEvent
& evt
) {
421 m_swx
->DoSysColourChange();
425 void wxStyledTextCtrl::OnEraseBackground(wxEraseEvent
& evt
) {
426 // do nothing to help avoid flashing
431 void wxStyledTextCtrl::OnMenu(wxCommandEvent
& evt
) {
432 m_swx
->DoCommand(evt
.GetId());
436 void wxStyledTextCtrl::OnListBox(wxCommandEvent
& evt
) {
437 m_swx
->DoOnListBox();
441 //----------------------------------------------------------------------
442 // Turn notifications from Scintilla into events
445 void wxStyledTextCtrl::NotifyChange() {
446 wxStyledTextEvent
evt(wxEVT_STC_CHANGE
, GetId());
447 evt
.SetEventObject(this);
448 GetEventHandler()->ProcessEvent(evt
);
451 void wxStyledTextCtrl::NotifyParent(SCNotification
* _scn
) {
452 SCNotification
& scn
= *_scn
;
453 wxStyledTextEvent
evt(0, GetId());
455 evt
.SetEventObject(this);
456 evt
.SetPosition(scn
.position
);
458 evt
.SetModifiers(scn
.modifiers
);
460 switch (scn
.nmhdr
.code
) {
461 case SCN_STYLENEEDED
:
462 evt
.SetEventType(wxEVT_STC_STYLENEEDED
);
466 evt
.SetEventType(wxEVT_STC_CHARADDED
);
469 case SCN_SAVEPOINTREACHED
:
470 evt
.SetEventType(wxEVT_STC_SAVEPOINTREACHED
);
473 case SCN_SAVEPOINTLEFT
:
474 evt
.SetEventType(wxEVT_STC_SAVEPOINTLEFT
);
477 case SCN_MODIFYATTEMPTRO
:
478 evt
.SetEventType(wxEVT_STC_ROMODIFYATTEMPT
);
482 evt
.SetEventType(wxEVT_STC_KEY
);
485 case SCN_DOUBLECLICK
:
486 evt
.SetEventType(wxEVT_STC_DOUBLECLICK
);
490 evt
.SetEventType(wxEVT_STC_UPDATEUI
);
494 evt
.SetEventType(wxEVT_STC_MODIFIED
);
495 evt
.SetModificationType(scn
.modificationType
);
497 // The unicode conversion MUST have a null byte to terminate the
498 // string so move it into a buffer first and give it one.
499 wxMemoryBuffer
buf(scn
.length
+1);
500 buf
.AppendData((void*)scn
.text
, scn
.length
);
502 evt
.SetText(stc2wx(buf
));
504 evt
.SetLength(scn
.length
);
505 evt
.SetLinesAdded(scn
.linesAdded
);
506 evt
.SetLine(scn
.line
);
507 evt
.SetFoldLevelNow(scn
.foldLevelNow
);
508 evt
.SetFoldLevelPrev(scn
.foldLevelPrev
);
511 case SCN_MACRORECORD
:
512 evt
.SetEventType(wxEVT_STC_MACRORECORD
);
513 evt
.SetMessage(scn
.message
);
514 evt
.SetWParam(scn
.wParam
);
515 evt
.SetLParam(scn
.lParam
);
518 case SCN_MARGINCLICK
:
519 evt
.SetEventType(wxEVT_STC_MARGINCLICK
);
520 evt
.SetMargin(scn
.margin
);
524 evt
.SetEventType(wxEVT_STC_NEEDSHOWN
);
525 evt
.SetLength(scn
.length
);
529 evt
.SetEventType(wxEVT_STC_PAINTED
);
532 case SCN_USERLISTSELECTION
:
533 evt
.SetEventType(wxEVT_STC_USERLISTSELECTION
);
534 evt
.SetListType(scn
.listType
);
535 evt
.SetText(scn
.text
);
539 evt
.SetEventType(wxEVT_STC_URIDROPPED
);
540 evt
.SetText(scn
.text
);
544 evt
.SetEventType(wxEVT_STC_DWELLSTART
);
550 evt
.SetEventType(wxEVT_STC_DWELLEND
);
559 GetEventHandler()->ProcessEvent(evt
);
563 //----------------------------------------------------------------------
564 //----------------------------------------------------------------------
565 //----------------------------------------------------------------------
567 wxStyledTextEvent::wxStyledTextEvent(wxEventType commandType
, int id
)
568 : wxCommandEvent(commandType
, id
)
573 m_modificationType
= 0;
586 m_dragAllowMove
= FALSE
;
587 #if wxUSE_DRAG_AND_DROP
588 m_dragResult
= wxDragNone
;
592 bool wxStyledTextEvent::GetShift() const { return (m_modifiers
& SCI_SHIFT
) != 0; }
593 bool wxStyledTextEvent::GetControl() const { return (m_modifiers
& SCI_CTRL
) != 0; }
594 bool wxStyledTextEvent::GetAlt() const { return (m_modifiers
& SCI_ALT
) != 0; }
597 wxStyledTextEvent::wxStyledTextEvent(const wxStyledTextEvent
& event
):
598 wxCommandEvent(event
)
600 m_position
= event
.m_position
;
602 m_modifiers
= event
.m_modifiers
;
603 m_modificationType
= event
.m_modificationType
;
604 m_text
= event
.m_text
;
605 m_length
= event
.m_length
;
606 m_linesAdded
= event
.m_linesAdded
;
607 m_line
= event
.m_line
;
608 m_foldLevelNow
= event
.m_foldLevelNow
;
609 m_foldLevelPrev
= event
.m_foldLevelPrev
;
611 m_margin
= event
.m_margin
;
613 m_message
= event
.m_message
;
614 m_wParam
= event
.m_wParam
;
615 m_lParam
= event
.m_lParam
;
617 m_listType
= event
.m_listType
;
621 m_dragText
= event
.m_dragText
;
622 m_dragAllowMove
=event
.m_dragAllowMove
;
623 #if wxUSE_DRAG_AND_DROP
624 m_dragResult
= event
.m_dragResult
;
628 //----------------------------------------------------------------------
629 //----------------------------------------------------------------------