Moved the check for page scrolling with the wheel into wxMouseEvent so
[wxWidgets.git] / src / stc / stc.cpp.in
1 ////////////////////////////////////////////////////////////////////////////
2 // Name: stc.cpp
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.
9 //
10 // Author: Robin Dunn
11 //
12 // Created: 13-Jan-2000
13 // RCS-ID: $Id$
14 // Copyright: (c) 2000 by Total Control Software
15 // Licence: wxWindows license
16 /////////////////////////////////////////////////////////////////////////////
17
18 #include <ctype.h>
19
20 #include "wx/stc/stc.h"
21 #include "ScintillaWX.h"
22
23 #include <wx/tokenzr.h>
24
25
26 //----------------------------------------------------------------------
27
28 const wxChar* wxSTCNameStr = wxT("stcwindow");
29
30 #ifdef MAKELONG
31 #undef MAKELONG
32 #endif
33
34 #define MAKELONG(a, b) ((a) | ((b) << 16))
35
36
37 static long wxColourAsLong(const wxColour& co) {
38 return (((long)co.Blue() << 16) |
39 ((long)co.Green() << 8) |
40 ((long)co.Red()));
41 }
42
43 static wxColour wxColourFromLong(long c) {
44 wxColour clr;
45 clr.Set(c & 0xff, (c >> 8) & 0xff, (c >> 16) & 0xff);
46 return clr;
47 }
48
49
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);
58 }
59
60 //----------------------------------------------------------------------
61
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 )
84
85
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)
95 #endif
96 EVT_MOTION (wxStyledTextCtrl::OnMouseMove)
97 EVT_LEFT_UP (wxStyledTextCtrl::OnMouseLeftUp)
98 #if defined(__WXGTK__) || defined(__WXMAC__)
99 EVT_RIGHT_UP (wxStyledTextCtrl::OnMouseRightUp)
100 #else
101 EVT_CONTEXT_MENU (wxStyledTextCtrl::OnContextMenu)
102 #endif
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)
112 END_EVENT_TABLE()
113
114
115 IMPLEMENT_CLASS(wxStyledTextCtrl, wxControl)
116 IMPLEMENT_DYNAMIC_CLASS(wxStyledTextEvent, wxCommandEvent)
117
118 // forces the linking of the lexer modules
119 int Scintilla_LinkLexers();
120
121 //----------------------------------------------------------------------
122 // Constructor and Destructor
123
124 wxStyledTextCtrl::wxStyledTextCtrl(wxWindow *parent,
125 wxWindowID id,
126 const wxPoint& pos,
127 const wxSize& size,
128 long style,
129 const wxString& name) :
130 wxControl(parent, id, pos, size,
131 style | wxVSCROLL | wxHSCROLL | wxWANTS_CHARS | wxCLIP_CHILDREN,
132 wxDefaultValidator, name)
133 {
134 Scintilla_LinkLexers();
135 m_swx = new ScintillaWX(this);
136 m_stopWatch.Start();
137 m_lastKeyDownConsumed = FALSE;
138 m_vScrollBar = NULL;
139 m_hScrollBar = NULL;
140 #if wxUSE_UNICODE
141 // Put Scintilla into unicode (UTF-8) mode
142 SetCodePage(wxSTC_CP_UTF8);
143 #endif
144 }
145
146
147 wxStyledTextCtrl::~wxStyledTextCtrl() {
148 delete m_swx;
149 }
150
151
152 //----------------------------------------------------------------------
153
154 long wxStyledTextCtrl::SendMsg(int msg, long wp, long lp) {
155
156 return m_swx->WndProc(msg, wp, lp);
157 }
158
159
160
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.
165
166 %(METHOD_IMPS)s
167
168 // END of generated section
169 //----------------------------------------------------------------------
170
171
172 // Returns the line number of the line with the caret.
173 int wxStyledTextCtrl::GetCurrentLine() {
174 int line = LineFromPosition(GetCurrentPos());
175 return line;
176 }
177
178
179 // Extract style settings from a spec-string which is composed of one or
180 // more of the following comma separated elements:
181 //
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
190 //
191 void wxStyledTextCtrl::StyleSetSpec(int styleNum, const wxString& spec) {
192
193 wxStringTokenizer tkz(spec, wxT(","));
194 while (tkz.HasMoreTokens()) {
195 wxString token = tkz.GetNextToken();
196
197 wxString option = token.BeforeFirst(':');
198 wxString val = token.AfterFirst(':');
199
200 if (option == wxT("bold"))
201 StyleSetBold(styleNum, true);
202
203 else if (option == wxT("italic"))
204 StyleSetItalic(styleNum, true);
205
206 else if (option == wxT("underline"))
207 StyleSetUnderline(styleNum, true);
208
209 else if (option == wxT("eol"))
210 StyleSetEOLFilled(styleNum, true);
211
212 else if (option == wxT("size")) {
213 long points;
214 if (val.ToLong(&points))
215 StyleSetSize(styleNum, points);
216 }
217
218 else if (option == wxT("face"))
219 StyleSetFaceName(styleNum, val);
220
221 else if (option == wxT("fore"))
222 StyleSetForeground(styleNum, wxColourFromSpec(val));
223
224 else if (option == wxT("back"))
225 StyleSetBackground(styleNum, wxColourFromSpec(val));
226 }
227 }
228
229
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();
238
239 // TODO: add encoding/charset mapping
240 StyleSetFontAttr(styleNum, size, faceName, bold, italic, under);
241 }
242
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,
247 bool underline) {
248 StyleSetSize(styleNum, size);
249 StyleSetFaceName(styleNum, faceName);
250 StyleSetBold(styleNum, bold);
251 StyleSetItalic(styleNum, italic);
252 StyleSetUnderline(styleNum, underline);
253
254 // TODO: add encoding/charset mapping
255 }
256
257
258 // Perform one of the operations defined by the wxSTC_CMD_* constants.
259 void wxStyledTextCtrl::CmdKeyExecute(int cmd) {
260 SendMsg(cmd);
261 }
262
263
264 // Set the left and right margin in the edit area, measured in pixels.
265 void wxStyledTextCtrl::SetMargins(int left, int right) {
266 SetMarginLeft(left);
267 SetMarginRight(right);
268 }
269
270
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);
275 if (endPos != NULL)
276 *endPos = SendMsg(SCI_GETSELECTIONEND);
277 }
278
279
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);
285 }
286
287 // Scroll enough to make the given line visible
288 void wxStyledTextCtrl::ScrollToLine(int line) {
289 m_swx->DoScrollToLine(line);
290 }
291
292
293 // Scroll enough to make the given column visible
294 void wxStyledTextCtrl::ScrollToColumn(int column) {
295 m_swx->DoScrollToColumn(column);
296 }
297
298
299
300 //----------------------------------------------------------------------
301 // Event handlers
302
303 void wxStyledTextCtrl::OnPaint(wxPaintEvent& evt) {
304 wxPaintDC dc(this);
305 wxRegion region = GetUpdateRegion();
306
307 m_swx->DoPaint(&dc, region.GetBox());
308 }
309
310 void wxStyledTextCtrl::OnScrollWin(wxScrollWinEvent& evt) {
311 if (evt.GetOrientation() == wxHORIZONTAL)
312 m_swx->DoHScroll(evt.GetEventType(), evt.GetPosition());
313 else
314 m_swx->DoVScroll(evt.GetEventType(), evt.GetPosition());
315 }
316
317 void wxStyledTextCtrl::OnScroll(wxScrollEvent& evt) {
318 wxScrollBar* sb = wxDynamicCast(evt.GetEventObject(), wxScrollBar);
319 if (sb) {
320 if (sb->IsVertical())
321 m_swx->DoVScroll(evt.GetEventType(), evt.GetPosition());
322 else
323 m_swx->DoHScroll(evt.GetEventType(), evt.GetPosition());
324 }
325 }
326
327 void wxStyledTextCtrl::OnSize(wxSizeEvent& evt) {
328 wxSize sz = GetClientSize();
329 m_swx->DoSize(sz.x, sz.y);
330 }
331
332 void wxStyledTextCtrl::OnMouseLeftDown(wxMouseEvent& evt) {
333 SetFocus();
334 wxPoint pt = evt.GetPosition();
335 m_swx->DoButtonDown(Point(pt.x, pt.y), m_stopWatch.Time(),
336 evt.ShiftDown(), evt.ControlDown(), evt.AltDown());
337 }
338
339 void wxStyledTextCtrl::OnMouseMove(wxMouseEvent& evt) {
340 wxPoint pt = evt.GetPosition();
341 m_swx->DoButtonMove(Point(pt.x, pt.y));
342 }
343
344 void wxStyledTextCtrl::OnMouseLeftUp(wxMouseEvent& evt) {
345 wxPoint pt = evt.GetPosition();
346 m_swx->DoButtonUp(Point(pt.x, pt.y), m_stopWatch.Time(),
347 evt.ControlDown());
348 }
349
350
351 void wxStyledTextCtrl::OnMouseRightUp(wxMouseEvent& evt) {
352 wxPoint pt = evt.GetPosition();
353 m_swx->DoContextMenu(Point(pt.x, pt.y));
354 }
355
356
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));
361 }
362
363
364 void wxStyledTextCtrl::OnMouseWheel(wxMouseEvent& evt) {
365 m_swx->DoMouseWheel(evt.GetWheelRotation(),
366 evt.GetWheelDelta(),
367 evt.GetLinesPerAction(),
368 evt.ControlDown(),
369 evt.IsPageScroll());
370 }
371
372
373 void wxStyledTextCtrl::OnChar(wxKeyEvent& evt) {
374 int key = evt.GetKeyCode();
375
376 // On (some?) non-US keyboards the AltGr key is required to enter some
377 // common characters. It comes to us as both Alt and Ctrl down so we need
378 // to let the char through in that case, otherwise if only ctrl or only
379 // alt let's skip it.
380 bool ctrl = evt.ControlDown();
381 bool alt = evt.AltDown();
382 bool skip = ((ctrl || alt) && ! (ctrl && alt));
383
384 // printf("OnChar key:%%d consumed:%%d ctrl:%%d alt:%%d skip:%%d\n",
385 // key, m_lastKeyDownConsumed, ctrl, alt, skip);
386
387 if (key <= WXK_START && /*key >= 32 &&*/ !m_lastKeyDownConsumed && !skip) {
388 m_swx->DoAddChar(key);
389 return;
390 }
391 evt.Skip();
392 }
393
394
395 void wxStyledTextCtrl::OnKeyDown(wxKeyEvent& evt) {
396 int key = evt.GetKeyCode();
397 bool shift = evt.ShiftDown(),
398 ctrl = evt.ControlDown(),
399 alt = evt.AltDown();
400
401 int processed = m_swx->DoKeyDown(key, shift, ctrl, alt, &m_lastKeyDownConsumed);
402
403 // printf("KeyDn key:%%d shift:%%d ctrl:%%d alt:%%d processed:%%d consumed:%%d\n",
404 // key, shift, ctrl, alt, processed, m_lastKeyDownConsumed);
405
406 if (!processed && !m_lastKeyDownConsumed)
407 evt.Skip();
408 }
409
410
411 void wxStyledTextCtrl::OnLoseFocus(wxFocusEvent& evt) {
412 m_swx->DoLoseFocus();
413 }
414
415
416 void wxStyledTextCtrl::OnGainFocus(wxFocusEvent& evt) {
417 m_swx->DoGainFocus();
418 }
419
420
421 void wxStyledTextCtrl::OnSysColourChanged(wxSysColourChangedEvent& evt) {
422 m_swx->DoSysColourChange();
423 }
424
425
426 void wxStyledTextCtrl::OnEraseBackground(wxEraseEvent& evt) {
427 // do nothing to help avoid flashing
428 }
429
430
431
432 void wxStyledTextCtrl::OnMenu(wxCommandEvent& evt) {
433 m_swx->DoCommand(evt.GetId());
434 }
435
436
437 void wxStyledTextCtrl::OnListBox(wxCommandEvent& evt) {
438 m_swx->DoOnListBox();
439 }
440
441
442 //----------------------------------------------------------------------
443 // Turn notifications from Scintilla into events
444
445
446 void wxStyledTextCtrl::NotifyChange() {
447 wxStyledTextEvent evt(wxEVT_STC_CHANGE, GetId());
448 evt.SetEventObject(this);
449 GetEventHandler()->ProcessEvent(evt);
450 }
451
452 void wxStyledTextCtrl::NotifyParent(SCNotification* _scn) {
453 SCNotification& scn = *_scn;
454 wxStyledTextEvent evt(0, GetId());
455
456 evt.SetEventObject(this);
457 evt.SetPosition(scn.position);
458 evt.SetKey(scn.ch);
459 evt.SetModifiers(scn.modifiers);
460
461 switch (scn.nmhdr.code) {
462 case SCN_STYLENEEDED:
463 evt.SetEventType(wxEVT_STC_STYLENEEDED);
464 break;
465
466 case SCN_CHARADDED:
467 evt.SetEventType(wxEVT_STC_CHARADDED);
468 break;
469
470 case SCN_SAVEPOINTREACHED:
471 evt.SetEventType(wxEVT_STC_SAVEPOINTREACHED);
472 break;
473
474 case SCN_SAVEPOINTLEFT:
475 evt.SetEventType(wxEVT_STC_SAVEPOINTLEFT);
476 break;
477
478 case SCN_MODIFYATTEMPTRO:
479 evt.SetEventType(wxEVT_STC_ROMODIFYATTEMPT);
480 break;
481
482 case SCN_KEY:
483 evt.SetEventType(wxEVT_STC_KEY);
484 break;
485
486 case SCN_DOUBLECLICK:
487 evt.SetEventType(wxEVT_STC_DOUBLECLICK);
488 break;
489
490 case SCN_UPDATEUI:
491 evt.SetEventType(wxEVT_STC_UPDATEUI);
492 break;
493
494 case SCN_MODIFIED:
495 evt.SetEventType(wxEVT_STC_MODIFIED);
496 evt.SetModificationType(scn.modificationType);
497 if (scn.text) {
498 // The unicode conversion MUST have a null byte to terminate the
499 // string so move it into a buffer first and give it one.
500 wxMemoryBuffer buf(scn.length+1);
501 buf.AppendData((void*)scn.text, scn.length);
502 buf.AppendByte(0);
503 evt.SetText(stc2wx(buf));
504 }
505 evt.SetLength(scn.length);
506 evt.SetLinesAdded(scn.linesAdded);
507 evt.SetLine(scn.line);
508 evt.SetFoldLevelNow(scn.foldLevelNow);
509 evt.SetFoldLevelPrev(scn.foldLevelPrev);
510 break;
511
512 case SCN_MACRORECORD:
513 evt.SetEventType(wxEVT_STC_MACRORECORD);
514 evt.SetMessage(scn.message);
515 evt.SetWParam(scn.wParam);
516 evt.SetLParam(scn.lParam);
517 break;
518
519 case SCN_MARGINCLICK:
520 evt.SetEventType(wxEVT_STC_MARGINCLICK);
521 evt.SetMargin(scn.margin);
522 break;
523
524 case SCN_NEEDSHOWN:
525 evt.SetEventType(wxEVT_STC_NEEDSHOWN);
526 evt.SetLength(scn.length);
527 break;
528
529 case SCN_PAINTED:
530 evt.SetEventType(wxEVT_STC_PAINTED);
531 break;
532
533 case SCN_USERLISTSELECTION:
534 evt.SetEventType(wxEVT_STC_USERLISTSELECTION);
535 evt.SetListType(scn.listType);
536 evt.SetText(scn.text);
537 break;
538
539 case SCN_URIDROPPED:
540 evt.SetEventType(wxEVT_STC_URIDROPPED);
541 evt.SetText(scn.text);
542 break;
543
544 case SCN_DWELLSTART:
545 evt.SetEventType(wxEVT_STC_DWELLSTART);
546 evt.SetX(scn.x);
547 evt.SetY(scn.y);
548 break;
549
550 case SCN_DWELLEND:
551 evt.SetEventType(wxEVT_STC_DWELLEND);
552 evt.SetX(scn.x);
553 evt.SetY(scn.y);
554 break;
555
556 default:
557 return;
558 }
559
560 GetEventHandler()->ProcessEvent(evt);
561 }
562
563
564 //----------------------------------------------------------------------
565 //----------------------------------------------------------------------
566 //----------------------------------------------------------------------
567
568 wxStyledTextEvent::wxStyledTextEvent(wxEventType commandType, int id)
569 : wxCommandEvent(commandType, id)
570 {
571 m_position = 0;
572 m_key = 0;
573 m_modifiers = 0;
574 m_modificationType = 0;
575 m_length = 0;
576 m_linesAdded = 0;
577 m_line = 0;
578 m_foldLevelNow = 0;
579 m_foldLevelPrev = 0;
580 m_margin = 0;
581 m_message = 0;
582 m_wParam = 0;
583 m_lParam = 0;
584 m_listType = 0;
585 m_x = 0;
586 m_y = 0;
587 m_dragAllowMove = FALSE;
588 #if wxUSE_DRAG_AND_DROP
589 m_dragResult = wxDragNone;
590 #endif
591 }
592
593 bool wxStyledTextEvent::GetShift() const { return (m_modifiers & SCI_SHIFT) != 0; }
594 bool wxStyledTextEvent::GetControl() const { return (m_modifiers & SCI_CTRL) != 0; }
595 bool wxStyledTextEvent::GetAlt() const { return (m_modifiers & SCI_ALT) != 0; }
596
597
598 wxStyledTextEvent::wxStyledTextEvent(const wxStyledTextEvent& event):
599 wxCommandEvent(event)
600 {
601 m_position = event.m_position;
602 m_key = event.m_key;
603 m_modifiers = event.m_modifiers;
604 m_modificationType = event.m_modificationType;
605 m_text = event.m_text;
606 m_length = event.m_length;
607 m_linesAdded = event.m_linesAdded;
608 m_line = event.m_line;
609 m_foldLevelNow = event.m_foldLevelNow;
610 m_foldLevelPrev = event.m_foldLevelPrev;
611
612 m_margin = event.m_margin;
613
614 m_message = event.m_message;
615 m_wParam = event.m_wParam;
616 m_lParam = event.m_lParam;
617
618 m_listType = event.m_listType;
619 m_x = event.m_x;
620 m_y = event.m_y;
621
622 m_dragText = event.m_dragText;
623 m_dragAllowMove =event.m_dragAllowMove;
624 #if wxUSE_DRAG_AND_DROP
625 m_dragResult = event.m_dragResult;
626 #endif
627 }
628
629 //----------------------------------------------------------------------
630 //----------------------------------------------------------------------
631
632
633
634
635
636
637
638
639