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"
24 #include <wx/tokenzr.h>
25 #include <wx/mstream.h>
30 //----------------------------------------------------------------------
32 const wxChar
* wxSTCNameStr
= wxT("stcwindow");
38 #define MAKELONG(a, b) ((a) | ((b) << 16))
41 static long wxColourAsLong(const wxColour
& co
) {
42 return (((long)co
.Blue() << 16) |
43 ((long)co
.Green() << 8) |
47 static wxColour
wxColourFromLong(long c
) {
49 clr
.Set(c
& 0xff, (c
>> 8) & 0xff, (c
>> 16) & 0xff);
54 static wxColour
wxColourFromSpec(const wxString
& spec
) {
55 // spec should be "#RRGGBB"
56 long red
, green
, blue
;
57 red
= green
= blue
= 0;
58 spec
.Mid(1,2).ToLong(&red
, 16);
59 spec
.Mid(3,2).ToLong(&green
, 16);
60 spec
.Mid(5,2).ToLong(&blue
, 16);
61 return wxColour(red
, green
, blue
);
64 //----------------------------------------------------------------------
66 DEFINE_EVENT_TYPE( wxEVT_STC_CHANGE
)
67 DEFINE_EVENT_TYPE( wxEVT_STC_STYLENEEDED
)
68 DEFINE_EVENT_TYPE( wxEVT_STC_CHARADDED
)
69 DEFINE_EVENT_TYPE( wxEVT_STC_SAVEPOINTREACHED
)
70 DEFINE_EVENT_TYPE( wxEVT_STC_SAVEPOINTLEFT
)
71 DEFINE_EVENT_TYPE( wxEVT_STC_ROMODIFYATTEMPT
)
72 DEFINE_EVENT_TYPE( wxEVT_STC_KEY
)
73 DEFINE_EVENT_TYPE( wxEVT_STC_DOUBLECLICK
)
74 DEFINE_EVENT_TYPE( wxEVT_STC_UPDATEUI
)
75 DEFINE_EVENT_TYPE( wxEVT_STC_MODIFIED
)
76 DEFINE_EVENT_TYPE( wxEVT_STC_MACRORECORD
)
77 DEFINE_EVENT_TYPE( wxEVT_STC_MARGINCLICK
)
78 DEFINE_EVENT_TYPE( wxEVT_STC_NEEDSHOWN
)
79 DEFINE_EVENT_TYPE( wxEVT_STC_POSCHANGED
)
80 DEFINE_EVENT_TYPE( wxEVT_STC_PAINTED
)
81 DEFINE_EVENT_TYPE( wxEVT_STC_USERLISTSELECTION
)
82 DEFINE_EVENT_TYPE( wxEVT_STC_URIDROPPED
)
83 DEFINE_EVENT_TYPE( wxEVT_STC_DWELLSTART
)
84 DEFINE_EVENT_TYPE( wxEVT_STC_DWELLEND
)
85 DEFINE_EVENT_TYPE( wxEVT_STC_START_DRAG
)
86 DEFINE_EVENT_TYPE( wxEVT_STC_DRAG_OVER
)
87 DEFINE_EVENT_TYPE( wxEVT_STC_DO_DROP
)
88 DEFINE_EVENT_TYPE( wxEVT_STC_ZOOM
)
89 DEFINE_EVENT_TYPE( wxEVT_STC_HOTSPOT_CLICK
)
90 DEFINE_EVENT_TYPE( wxEVT_STC_HOTSPOT_DCLICK
)
91 DEFINE_EVENT_TYPE( wxEVT_STC_CALLTIP_CLICK
)
95 BEGIN_EVENT_TABLE(wxStyledTextCtrl
, wxControl
)
96 EVT_PAINT (wxStyledTextCtrl::OnPaint
)
97 EVT_SCROLLWIN (wxStyledTextCtrl::OnScrollWin
)
98 EVT_SCROLL (wxStyledTextCtrl::OnScroll
)
99 EVT_SIZE (wxStyledTextCtrl::OnSize
)
100 EVT_LEFT_DOWN (wxStyledTextCtrl::OnMouseLeftDown
)
101 // Let Scintilla see the double click as a second click
102 EVT_LEFT_DCLICK (wxStyledTextCtrl::OnMouseLeftDown
)
103 EVT_MOTION (wxStyledTextCtrl::OnMouseMove
)
104 EVT_LEFT_UP (wxStyledTextCtrl::OnMouseLeftUp
)
105 #if defined(__WXGTK__) || defined(__WXMAC__)
106 EVT_RIGHT_UP (wxStyledTextCtrl::OnMouseRightUp
)
108 EVT_CONTEXT_MENU (wxStyledTextCtrl::OnContextMenu
)
110 EVT_MOUSEWHEEL (wxStyledTextCtrl::OnMouseWheel
)
111 EVT_MIDDLE_UP (wxStyledTextCtrl::OnMouseMiddleUp
)
112 EVT_CHAR (wxStyledTextCtrl::OnChar
)
113 EVT_KEY_DOWN (wxStyledTextCtrl::OnKeyDown
)
114 EVT_KILL_FOCUS (wxStyledTextCtrl::OnLoseFocus
)
115 EVT_SET_FOCUS (wxStyledTextCtrl::OnGainFocus
)
116 EVT_SYS_COLOUR_CHANGED (wxStyledTextCtrl::OnSysColourChanged
)
117 EVT_ERASE_BACKGROUND (wxStyledTextCtrl::OnEraseBackground
)
118 EVT_MENU_RANGE (10, 16, wxStyledTextCtrl::OnMenu
)
119 EVT_LISTBOX_DCLICK (-1, wxStyledTextCtrl::OnListBox
)
123 IMPLEMENT_CLASS(wxStyledTextCtrl
, wxControl
)
124 IMPLEMENT_DYNAMIC_CLASS(wxStyledTextEvent
, wxCommandEvent
)
127 // forces the linking of the lexer modules
128 int Scintilla_LinkLexers();
131 //----------------------------------------------------------------------
132 // Constructor and Destructor
134 wxStyledTextCtrl::wxStyledTextCtrl(wxWindow
*parent
,
139 const wxString
& name
) :
140 wxControl(parent
, id
, pos
, size
,
141 style
| wxVSCROLL
| wxHSCROLL
| wxWANTS_CHARS
| wxCLIP_CHILDREN
,
142 wxDefaultValidator
, name
)
145 Scintilla_LinkLexers();
147 m_swx
= new ScintillaWX(this);
149 m_lastKeyDownConsumed
= FALSE
;
153 // Put Scintilla into unicode (UTF-8) mode
154 SetCodePage(wxSTC_CP_UTF8
);
159 wxStyledTextCtrl::~wxStyledTextCtrl() {
164 //----------------------------------------------------------------------
166 long wxStyledTextCtrl::SendMsg(int msg
, long wp
, long lp
) {
168 return m_swx
->WndProc(msg
, wp
, lp
);
173 //----------------------------------------------------------------------
174 // BEGIN generated section. The following code is automatically generated
175 // by gen_iface.py from the contents of Scintilla.iface. Do not edit
176 // this file. Edit stc.cpp.in or gen_iface.py instead and regenerate.
180 // END of generated section
181 //----------------------------------------------------------------------
184 // Returns the line number of the line with the caret.
185 int wxStyledTextCtrl::GetCurrentLine() {
186 int line
= LineFromPosition(GetCurrentPos());
191 // Extract style settings from a spec-string which is composed of one or
192 // more of the following comma separated elements:
194 // bold turns on bold
195 // italic turns on italics
196 // fore:#RRGGBB sets the foreground colour
197 // back:#RRGGBB sets the background colour
198 // face:[facename] sets the font face name to use
199 // size:[num] sets the font size in points
200 // eol turns on eol filling
201 // underline turns on underlining
203 void wxStyledTextCtrl::StyleSetSpec(int styleNum
, const wxString
& spec
) {
205 wxStringTokenizer
tkz(spec
, wxT(","));
206 while (tkz
.HasMoreTokens()) {
207 wxString token
= tkz
.GetNextToken();
209 wxString option
= token
.BeforeFirst(':');
210 wxString val
= token
.AfterFirst(':');
212 if (option
== wxT("bold"))
213 StyleSetBold(styleNum
, true);
215 else if (option
== wxT("italic"))
216 StyleSetItalic(styleNum
, true);
218 else if (option
== wxT("underline"))
219 StyleSetUnderline(styleNum
, true);
221 else if (option
== wxT("eol"))
222 StyleSetEOLFilled(styleNum
, true);
224 else if (option
== wxT("size")) {
226 if (val
.ToLong(&points
))
227 StyleSetSize(styleNum
, points
);
230 else if (option
== wxT("face"))
231 StyleSetFaceName(styleNum
, val
);
233 else if (option
== wxT("fore"))
234 StyleSetForeground(styleNum
, wxColourFromSpec(val
));
236 else if (option
== wxT("back"))
237 StyleSetBackground(styleNum
, wxColourFromSpec(val
));
242 // Set style size, face, bold, italic, and underline attributes from
243 // a wxFont's attributes.
244 void wxStyledTextCtrl::StyleSetFont(int styleNum
, wxFont
& font
) {
246 // Ensure that the native font is initialized
248 GetTextExtent(wxT("X"), &x
, &y
, NULL
, NULL
, &font
);
250 int size
= font
.GetPointSize();
251 wxString faceName
= font
.GetFaceName();
252 bool bold
= font
.GetWeight() == wxBOLD
;
253 bool italic
= font
.GetStyle() != wxNORMAL
;
254 bool under
= font
.GetUnderlined();
256 // TODO: add encoding/charset mapping
257 StyleSetFontAttr(styleNum
, size
, faceName
, bold
, italic
, under
);
260 // Set all font style attributes at once.
261 void wxStyledTextCtrl::StyleSetFontAttr(int styleNum
, int size
,
262 const wxString
& faceName
,
263 bool bold
, bool italic
,
265 StyleSetSize(styleNum
, size
);
266 StyleSetFaceName(styleNum
, faceName
);
267 StyleSetBold(styleNum
, bold
);
268 StyleSetItalic(styleNum
, italic
);
269 StyleSetUnderline(styleNum
, underline
);
271 // TODO: add encoding/charset mapping
275 // Perform one of the operations defined by the wxSTC_CMD_* constants.
276 void wxStyledTextCtrl::CmdKeyExecute(int cmd
) {
281 // Set the left and right margin in the edit area, measured in pixels.
282 void wxStyledTextCtrl::SetMargins(int left
, int right
) {
284 SetMarginRight(right
);
288 // Retrieve the start and end positions of the current selection.
289 void wxStyledTextCtrl::GetSelection(int* startPos
, int* endPos
) {
290 if (startPos
!= NULL
)
291 *startPos
= SendMsg(SCI_GETSELECTIONSTART
);
293 *endPos
= SendMsg(SCI_GETSELECTIONEND
);
297 // Retrieve the point in the window where a position is displayed.
298 wxPoint
wxStyledTextCtrl::PointFromPosition(int pos
) {
299 int x
= SendMsg(SCI_POINTXFROMPOSITION
, 0, pos
);
300 int y
= SendMsg(SCI_POINTYFROMPOSITION
, 0, pos
);
301 return wxPoint(x
, y
);
304 // Scroll enough to make the given line visible
305 void wxStyledTextCtrl::ScrollToLine(int line
) {
306 m_swx
->DoScrollToLine(line
);
310 // Scroll enough to make the given column visible
311 void wxStyledTextCtrl::ScrollToColumn(int column
) {
312 m_swx
->DoScrollToColumn(column
);
316 bool wxStyledTextCtrl::SaveFile(const wxString
& filename
)
318 wxFile
file(filename
, wxFile::write
);
320 if (!file
.IsOpened())
323 bool success
= file
.Write(GetText());
331 bool wxStyledTextCtrl::LoadFile(const wxString
& filename
)
333 bool success
= false;
334 wxFile
file(filename
, wxFile::read
);
339 off_t len
= file
.Length();
343 wxChar
*buf
= contents
.GetWriteBuf(len
);
344 success
= (file
.Read(buf
, len
) == len
);
345 contents
.UngetWriteBuf();
348 success
= true; // empty file is ok
362 //----------------------------------------------------------------------
365 void wxStyledTextCtrl::OnPaint(wxPaintEvent
& WXUNUSED(evt
)) {
367 m_swx
->DoPaint(&dc
, GetUpdateRegion().GetBox());
370 void wxStyledTextCtrl::OnScrollWin(wxScrollWinEvent
& evt
) {
371 if (evt
.GetOrientation() == wxHORIZONTAL
)
372 m_swx
->DoHScroll(evt
.GetEventType(), evt
.GetPosition());
374 m_swx
->DoVScroll(evt
.GetEventType(), evt
.GetPosition());
377 void wxStyledTextCtrl::OnScroll(wxScrollEvent
& evt
) {
378 wxScrollBar
* sb
= wxDynamicCast(evt
.GetEventObject(), wxScrollBar
);
380 if (sb
->IsVertical())
381 m_swx
->DoVScroll(evt
.GetEventType(), evt
.GetPosition());
383 m_swx
->DoHScroll(evt
.GetEventType(), evt
.GetPosition());
387 void wxStyledTextCtrl::OnSize(wxSizeEvent
& WXUNUSED(evt
)) {
388 wxSize sz
= GetClientSize();
389 m_swx
->DoSize(sz
.x
, sz
.y
);
392 void wxStyledTextCtrl::OnMouseLeftDown(wxMouseEvent
& evt
) {
394 wxPoint pt
= evt
.GetPosition();
395 m_swx
->DoLeftButtonDown(Point(pt
.x
, pt
.y
), m_stopWatch
.Time(),
396 evt
.ShiftDown(), evt
.ControlDown(), evt
.AltDown());
399 void wxStyledTextCtrl::OnMouseMove(wxMouseEvent
& evt
) {
400 wxPoint pt
= evt
.GetPosition();
401 m_swx
->DoLeftButtonMove(Point(pt
.x
, pt
.y
));
404 void wxStyledTextCtrl::OnMouseLeftUp(wxMouseEvent
& evt
) {
405 wxPoint pt
= evt
.GetPosition();
406 m_swx
->DoLeftButtonUp(Point(pt
.x
, pt
.y
), m_stopWatch
.Time(),
411 void wxStyledTextCtrl::OnMouseRightUp(wxMouseEvent
& evt
) {
412 wxPoint pt
= evt
.GetPosition();
413 m_swx
->DoContextMenu(Point(pt
.x
, pt
.y
));
417 void wxStyledTextCtrl::OnMouseMiddleUp(wxMouseEvent
& evt
) {
418 wxPoint pt
= evt
.GetPosition();
419 m_swx
->DoMiddleButtonUp(Point(pt
.x
, pt
.y
));
422 void wxStyledTextCtrl::OnContextMenu(wxContextMenuEvent
& evt
) {
423 wxPoint pt
= evt
.GetPosition();
424 ScreenToClient(&pt
.x
, &pt
.y
);
425 m_swx
->DoContextMenu(Point(pt
.x
, pt
.y
));
429 void wxStyledTextCtrl::OnMouseWheel(wxMouseEvent
& evt
) {
430 m_swx
->DoMouseWheel(evt
.GetWheelRotation(),
432 evt
.GetLinesPerAction(),
438 void wxStyledTextCtrl::OnChar(wxKeyEvent
& evt
) {
439 // On (some?) non-US keyboards the AltGr key is required to enter some
440 // common characters. It comes to us as both Alt and Ctrl down so we need
441 // to let the char through in that case, otherwise if only ctrl or only
442 // alt let's skip it.
443 bool ctrl
= evt
.ControlDown();
444 bool alt
= evt
.AltDown();
445 bool skip
= ((ctrl
|| alt
) && ! (ctrl
&& alt
));
447 int key
= evt
.GetKeyCode();
449 // printf("OnChar key:%%d consumed:%%d ctrl:%%d alt:%%d skip:%%d\n",
450 // key, m_lastKeyDownConsumed, ctrl, alt, skip);
452 if ( (key
<= WXK_START
|| key
> WXK_NUMPAD_DIVIDE
) &&
453 !m_lastKeyDownConsumed
&& !skip
) {
454 m_swx
->DoAddChar(key
);
461 void wxStyledTextCtrl::OnKeyDown(wxKeyEvent
& evt
) {
462 int key
= evt
.GetKeyCode();
463 bool shift
= evt
.ShiftDown(),
464 ctrl
= evt
.ControlDown(),
466 meta
= evt
.MetaDown();
468 int processed
= m_swx
->DoKeyDown(key
, shift
, ctrl
, alt
, meta
, &m_lastKeyDownConsumed
);
470 // printf("KeyDn key:%%d shift:%%d ctrl:%%d alt:%%d processed:%%d consumed:%%d\n",
471 // key, shift, ctrl, alt, processed, m_lastKeyDownConsumed);
473 if (!processed
&& !m_lastKeyDownConsumed
)
478 void wxStyledTextCtrl::OnLoseFocus(wxFocusEvent
& WXUNUSED(evt
)) {
479 m_swx
->DoLoseFocus();
483 void wxStyledTextCtrl::OnGainFocus(wxFocusEvent
& WXUNUSED(evt
)) {
484 m_swx
->DoGainFocus();
488 void wxStyledTextCtrl::OnSysColourChanged(wxSysColourChangedEvent
& WXUNUSED(evt
)) {
489 m_swx
->DoSysColourChange();
493 void wxStyledTextCtrl::OnEraseBackground(wxEraseEvent
& WXUNUSED(evt
)) {
494 // do nothing to help avoid flashing
499 void wxStyledTextCtrl::OnMenu(wxCommandEvent
& evt
) {
500 m_swx
->DoCommand(evt
.GetId());
504 void wxStyledTextCtrl::OnListBox(wxCommandEvent
& WXUNUSED(evt
)) {
505 m_swx
->DoOnListBox();
509 //----------------------------------------------------------------------
510 // Turn notifications from Scintilla into events
513 void wxStyledTextCtrl::NotifyChange() {
514 wxStyledTextEvent
evt(wxEVT_STC_CHANGE
, GetId());
515 evt
.SetEventObject(this);
516 GetEventHandler()->ProcessEvent(evt
);
520 static void SetEventText(wxStyledTextEvent
& evt
, const char* text
,
524 // The unicode conversion MUST have a null byte to terminate the
525 // string so move it into a buffer first and give it one.
526 wxMemoryBuffer
buf(length
+1);
527 buf
.AppendData((void*)text
, length
);
529 evt
.SetText(stc2wx(buf
));
533 void wxStyledTextCtrl::NotifyParent(SCNotification
* _scn
) {
534 SCNotification
& scn
= *_scn
;
535 wxStyledTextEvent
evt(0, GetId());
537 evt
.SetEventObject(this);
538 evt
.SetPosition(scn
.position
);
540 evt
.SetModifiers(scn
.modifiers
);
542 switch (scn
.nmhdr
.code
) {
543 case SCN_STYLENEEDED
:
544 evt
.SetEventType(wxEVT_STC_STYLENEEDED
);
548 evt
.SetEventType(wxEVT_STC_CHARADDED
);
551 case SCN_SAVEPOINTREACHED
:
552 evt
.SetEventType(wxEVT_STC_SAVEPOINTREACHED
);
555 case SCN_SAVEPOINTLEFT
:
556 evt
.SetEventType(wxEVT_STC_SAVEPOINTLEFT
);
559 case SCN_MODIFYATTEMPTRO
:
560 evt
.SetEventType(wxEVT_STC_ROMODIFYATTEMPT
);
564 evt
.SetEventType(wxEVT_STC_KEY
);
567 case SCN_DOUBLECLICK
:
568 evt
.SetEventType(wxEVT_STC_DOUBLECLICK
);
572 evt
.SetEventType(wxEVT_STC_UPDATEUI
);
576 evt
.SetEventType(wxEVT_STC_MODIFIED
);
577 evt
.SetModificationType(scn
.modificationType
);
578 SetEventText(evt
, scn
.text
, scn
.length
);
579 evt
.SetLength(scn
.length
);
580 evt
.SetLinesAdded(scn
.linesAdded
);
581 evt
.SetLine(scn
.line
);
582 evt
.SetFoldLevelNow(scn
.foldLevelNow
);
583 evt
.SetFoldLevelPrev(scn
.foldLevelPrev
);
586 case SCN_MACRORECORD
:
587 evt
.SetEventType(wxEVT_STC_MACRORECORD
);
588 evt
.SetMessage(scn
.message
);
589 evt
.SetWParam(scn
.wParam
);
590 evt
.SetLParam(scn
.lParam
);
593 case SCN_MARGINCLICK
:
594 evt
.SetEventType(wxEVT_STC_MARGINCLICK
);
595 evt
.SetMargin(scn
.margin
);
599 evt
.SetEventType(wxEVT_STC_NEEDSHOWN
);
600 evt
.SetLength(scn
.length
);
604 evt
.SetEventType(wxEVT_STC_PAINTED
);
607 case SCN_USERLISTSELECTION
:
608 evt
.SetEventType(wxEVT_STC_USERLISTSELECTION
);
609 evt
.SetListType(scn
.listType
);
610 SetEventText(evt
, scn
.text
, strlen(scn
.text
));
614 evt
.SetEventType(wxEVT_STC_URIDROPPED
);
615 SetEventText(evt
, scn
.text
, strlen(scn
.text
));
619 evt
.SetEventType(wxEVT_STC_DWELLSTART
);
625 evt
.SetEventType(wxEVT_STC_DWELLEND
);
631 evt
.SetEventType(wxEVT_STC_ZOOM
);
634 case SCN_HOTSPOTCLICK
:
635 evt
.SetEventType(wxEVT_STC_HOTSPOT_CLICK
);
638 case SCN_HOTSPOTDOUBLECLICK
:
639 evt
.SetEventType(wxEVT_STC_HOTSPOT_DCLICK
);
642 case SCN_CALLTIPCLICK
:
643 evt
.SetEventType(wxEVT_STC_CALLTIP_CLICK
);
650 GetEventHandler()->ProcessEvent(evt
);
654 //----------------------------------------------------------------------
655 //----------------------------------------------------------------------
656 //----------------------------------------------------------------------
658 wxStyledTextEvent::wxStyledTextEvent(wxEventType commandType
, int id
)
659 : wxCommandEvent(commandType
, id
)
664 m_modificationType
= 0;
677 m_dragAllowMove
= FALSE
;
678 #if wxUSE_DRAG_AND_DROP
679 m_dragResult
= wxDragNone
;
683 bool wxStyledTextEvent::GetShift() const { return (m_modifiers
& SCI_SHIFT
) != 0; }
684 bool wxStyledTextEvent::GetControl() const { return (m_modifiers
& SCI_CTRL
) != 0; }
685 bool wxStyledTextEvent::GetAlt() const { return (m_modifiers
& SCI_ALT
) != 0; }
688 wxStyledTextEvent::wxStyledTextEvent(const wxStyledTextEvent
& event
):
689 wxCommandEvent(event
)
691 m_position
= event
.m_position
;
693 m_modifiers
= event
.m_modifiers
;
694 m_modificationType
= event
.m_modificationType
;
695 m_text
= event
.m_text
;
696 m_length
= event
.m_length
;
697 m_linesAdded
= event
.m_linesAdded
;
698 m_line
= event
.m_line
;
699 m_foldLevelNow
= event
.m_foldLevelNow
;
700 m_foldLevelPrev
= event
.m_foldLevelPrev
;
702 m_margin
= event
.m_margin
;
704 m_message
= event
.m_message
;
705 m_wParam
= event
.m_wParam
;
706 m_lParam
= event
.m_lParam
;
708 m_listType
= event
.m_listType
;
712 m_dragText
= event
.m_dragText
;
713 m_dragAllowMove
=event
.m_dragAllowMove
;
714 #if wxUSE_DRAG_AND_DROP
715 m_dragResult
= event
.m_dragResult
;
719 //----------------------------------------------------------------------
720 //----------------------------------------------------------------------