Another attempt to handle key events correctly for wxSTC
[wxWidgets.git] / contrib / 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 // 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)
28
29 int wxForceScintillaLexers(void)
30 {
31 extern LexerModule lmAda;
32 extern LexerModule lmAVE;
33 extern LexerModule lmConf;
34 extern LexerModule lmCPP;
35 extern LexerModule lmEiffel;
36 extern LexerModule lmHTML;
37 extern LexerModule lmLISP;
38 extern LexerModule lmLua;
39 extern LexerModule lmBatch; // In LexOthers.cxx
40 extern LexerModule lmPascal;
41 extern LexerModule lmPerl;
42 extern LexerModule lmPython;
43 extern LexerModule lmRuby;
44 extern LexerModule lmSQL;
45 extern LexerModule lmVB;
46
47 if ( &lmAda
48 && &lmAVE
49 && &lmConf
50 && &lmCPP
51 && &lmEiffel
52 && &lmHTML
53 && &lmLISP
54 && &lmLua
55 && &lmBatch
56 && &lmPascal
57 && &lmPerl
58 && &lmPython
59 && &lmRuby
60 && &lmSQL
61 && &lmVB )
62 {
63 return 1;
64 }
65 else
66 {
67 return 0;
68 }
69 }
70
71 //----------------------------------------------------------------------
72
73 const wxChar* wxSTCNameStr = "stcwindow";
74
75 DEFINE_EVENT_TYPE( wxEVT_STC_CHANGE )
76 DEFINE_EVENT_TYPE( wxEVT_STC_STYLENEEDED )
77 DEFINE_EVENT_TYPE( wxEVT_STC_CHARADDED )
78 DEFINE_EVENT_TYPE( wxEVT_STC_SAVEPOINTREACHED )
79 DEFINE_EVENT_TYPE( wxEVT_STC_SAVEPOINTLEFT )
80 DEFINE_EVENT_TYPE( wxEVT_STC_ROMODIFYATTEMPT )
81 DEFINE_EVENT_TYPE( wxEVT_STC_KEY )
82 DEFINE_EVENT_TYPE( wxEVT_STC_DOUBLECLICK )
83 DEFINE_EVENT_TYPE( wxEVT_STC_UPDATEUI )
84 DEFINE_EVENT_TYPE( wxEVT_STC_MODIFIED )
85 DEFINE_EVENT_TYPE( wxEVT_STC_MACRORECORD )
86 DEFINE_EVENT_TYPE( wxEVT_STC_MARGINCLICK )
87 DEFINE_EVENT_TYPE( wxEVT_STC_NEEDSHOWN )
88 DEFINE_EVENT_TYPE( wxEVT_STC_POSCHANGED )
89 DEFINE_EVENT_TYPE( wxEVT_STC_PAINTED )
90 DEFINE_EVENT_TYPE( wxEVT_STC_USERLISTSELECTION )
91 DEFINE_EVENT_TYPE( wxEVT_STC_URIDROPPED )
92 DEFINE_EVENT_TYPE( wxEVT_STC_DWELLSTART )
93 DEFINE_EVENT_TYPE( wxEVT_STC_DWELLEND )
94
95
96
97
98 BEGIN_EVENT_TABLE(wxStyledTextCtrl, wxControl)
99 EVT_PAINT (wxStyledTextCtrl::OnPaint)
100 EVT_SCROLLWIN (wxStyledTextCtrl::OnScrollWin)
101 EVT_SIZE (wxStyledTextCtrl::OnSize)
102 EVT_LEFT_DOWN (wxStyledTextCtrl::OnMouseLeftDown)
103 #ifdef __WXMSW__
104 // Let Scintilla see the double click as a second click
105 EVT_LEFT_DCLICK (wxStyledTextCtrl::OnMouseLeftDown)
106 #endif
107 EVT_MOTION (wxStyledTextCtrl::OnMouseMove)
108 EVT_LEFT_UP (wxStyledTextCtrl::OnMouseLeftUp)
109 EVT_CONTEXT_MENU (wxStyledTextCtrl::OnContextMenu)
110 EVT_MOUSEWHEEL (wxStyledTextCtrl::OnMouseWheel)
111 EVT_CHAR (wxStyledTextCtrl::OnChar)
112 EVT_KEY_DOWN (wxStyledTextCtrl::OnKeyDown)
113 EVT_KILL_FOCUS (wxStyledTextCtrl::OnLoseFocus)
114 EVT_SET_FOCUS (wxStyledTextCtrl::OnGainFocus)
115 EVT_SYS_COLOUR_CHANGED (wxStyledTextCtrl::OnSysColourChanged)
116 EVT_ERASE_BACKGROUND (wxStyledTextCtrl::OnEraseBackground)
117 EVT_MENU_RANGE (-1, -1, wxStyledTextCtrl::OnMenu)
118 EVT_LISTBOX_DCLICK (-1, wxStyledTextCtrl::OnListBox)
119 END_EVENT_TABLE()
120
121
122 IMPLEMENT_CLASS(wxStyledTextCtrl, wxControl)
123 IMPLEMENT_DYNAMIC_CLASS(wxStyledTextEvent, wxCommandEvent)
124
125 //----------------------------------------------------------------------
126 // Constructor and Destructor
127
128 wxStyledTextCtrl::wxStyledTextCtrl(wxWindow *parent,
129 wxWindowID id,
130 const wxPoint& pos,
131 const wxSize& size,
132 long style,
133 const wxString& name) :
134 wxControl(parent, id, pos, size,
135 style | wxVSCROLL | wxHSCROLL | wxWANTS_CHARS | wxCLIP_CHILDREN,
136 wxDefaultValidator, name)
137 {
138 m_swx = new ScintillaWX(this);
139 m_stopWatch.Start();
140 m_lastKeyDownConsumed = FALSE;
141 }
142
143
144 wxStyledTextCtrl::~wxStyledTextCtrl() {
145 delete m_swx;
146 }
147
148
149 //----------------------------------------------------------------------
150
151 long wxStyledTextCtrl::SendMsg(int msg, long wp, long lp) {
152
153 return m_swx->WndProc(msg, wp, lp);
154 }
155
156
157 #ifdef MAKELONG
158 #undef MAKELONG
159 #endif
160
161 #define MAKELONG(a, b) ((a) | ((b) << 16))
162
163
164 static long wxColourAsLong(const wxColour& co) {
165 return (((long)co.Blue() << 16) |
166 ((long)co.Green() << 8) |
167 ((long)co.Red()));
168 }
169
170 static wxColour wxColourFromLong(long c) {
171 wxColour clr;
172 clr.Set(c & 0xff, (c >> 8) & 0xff, (c >> 16) & 0xff);
173 return clr;
174 }
175
176
177 static wxColour wxColourFromSpec(const wxString& spec) {
178 // spec should be #RRGGBB
179 char* junk;
180 int red = strtol(spec.Mid(1,2), &junk, 16);
181 int green = strtol(spec.Mid(3,2), &junk, 16);
182 int blue = strtol(spec.Mid(5,2), &junk, 16);
183 return wxColour(red, green, blue);
184 }
185
186
187 //----------------------------------------------------------------------
188 // BEGIN generated section. The following code is automatically generated
189 // by gen_iface.py from the contents of Scintilla.iface. Do not edit
190 // this file. Edit stc.cpp.in or gen_iface.py instead and regenerate.
191
192 %(METHOD_IMPS)s
193
194 // END of generated section
195 //----------------------------------------------------------------------
196
197
198 // Returns the line number of the line with the caret.
199 int wxStyledTextCtrl::GetCurrentLine() {
200 int line = LineFromPosition(GetCurrentPos());
201 return line;
202 }
203
204
205 // Extract style settings from a spec-string which is composed of one or
206 // more of the following comma separated elements:
207 //
208 // bold turns on bold
209 // italic turns on italics
210 // fore:#RRGGBB sets the foreground colour
211 // back:#RRGGBB sets the background colour
212 // face:[facename] sets the font face name to use
213 // size:[num] sets the font size in points
214 // eol turns on eol filling
215 // underline turns on underlining
216 //
217 void wxStyledTextCtrl::StyleSetSpec(int styleNum, const wxString& spec) {
218
219 wxStringTokenizer tkz(spec, ",");
220 while (tkz.HasMoreTokens()) {
221 wxString token = tkz.GetNextToken();
222
223 wxString option = token.BeforeFirst(':');
224 wxString val = token.AfterFirst(':');
225
226 if (option == "bold")
227 StyleSetBold(styleNum, true);
228
229 else if (option == "italic")
230 StyleSetItalic(styleNum, true);
231
232 else if (option == "underline")
233 StyleSetUnderline(styleNum, true);
234
235 else if (option == "eol")
236 StyleSetEOLFilled(styleNum, true);
237
238 else if (option == "size") {
239 long points;
240 if (val.ToLong(&points))
241 StyleSetSize(styleNum, points);
242 }
243
244 else if (option == "face")
245 StyleSetFaceName(styleNum, val);
246
247 else if (option == "fore")
248 StyleSetForeground(styleNum, wxColourFromSpec(val));
249
250 else if (option == "back")
251 StyleSetBackground(styleNum, wxColourFromSpec(val));
252 }
253 }
254
255
256 // Set style size, face, bold, italic, and underline attributes from
257 // a wxFont's attributes.
258 void wxStyledTextCtrl::StyleSetFont(int styleNum, wxFont& font) {
259 int size = font.GetPointSize();
260 wxString faceName = font.GetFaceName();
261 bool bold = font.GetWeight() == wxBOLD;
262 bool italic = font.GetStyle() != wxNORMAL;
263 bool under = font.GetUnderlined();
264
265 // TODO: add encoding/charset mapping
266 StyleSetFontAttr(styleNum, size, faceName, bold, italic, under);
267 }
268
269 // Set all font style attributes at once.
270 void wxStyledTextCtrl::StyleSetFontAttr(int styleNum, int size,
271 const wxString& faceName,
272 bool bold, bool italic,
273 bool underline) {
274 StyleSetSize(styleNum, size);
275 StyleSetFaceName(styleNum, faceName);
276 StyleSetBold(styleNum, bold);
277 StyleSetItalic(styleNum, italic);
278 StyleSetUnderline(styleNum, underline);
279
280 // TODO: add encoding/charset mapping
281 }
282
283
284 // Perform one of the operations defined by the wxSTC_CMD_* constants.
285 void wxStyledTextCtrl::CmdKeyExecute(int cmd) {
286 SendMsg(cmd);
287 }
288
289
290 // Set the left and right margin in the edit area, measured in pixels.
291 void wxStyledTextCtrl::SetMargins(int left, int right) {
292 SetMarginLeft(left);
293 SetMarginRight(right);
294 }
295
296
297 // Retrieve the start and end positions of the current selection.
298 void wxStyledTextCtrl::GetSelection(int* startPos, int* endPos) {
299 if (startPos != NULL)
300 *startPos = SendMsg(SCI_GETSELECTIONSTART);
301 if (endPos != NULL)
302 *endPos = SendMsg(SCI_GETSELECTIONEND);
303 }
304
305
306 // Retrieve the point in the window where a position is displayed.
307 wxPoint wxStyledTextCtrl::PointFromPosition(int pos) {
308 int x = SendMsg(SCI_POINTXFROMPOSITION, 0, pos);
309 int y = SendMsg(SCI_POINTYFROMPOSITION, 0, pos);
310 return wxPoint(x, y);
311 }
312
313 // Scroll enough to make the given line visible
314 void wxStyledTextCtrl::ScrollToLine(int line) {
315 m_swx->DoScrollToLine(line);
316 }
317
318
319 // Scroll enough to make the given column visible
320 void wxStyledTextCtrl::ScrollToColumn(int column) {
321 m_swx->DoScrollToColumn(column);
322 }
323
324
325
326 //----------------------------------------------------------------------
327 // Event handlers
328
329 void wxStyledTextCtrl::OnPaint(wxPaintEvent& evt) {
330 wxPaintDC dc(this);
331 wxRegion region = GetUpdateRegion();
332
333 m_swx->DoPaint(&dc, region.GetBox());
334 }
335
336 void wxStyledTextCtrl::OnScrollWin(wxScrollWinEvent& evt) {
337 if (evt.GetOrientation() == wxHORIZONTAL)
338 m_swx->DoHScroll(evt.GetEventType(), evt.GetPosition());
339 else
340 m_swx->DoVScroll(evt.GetEventType(), evt.GetPosition());
341 }
342
343 void wxStyledTextCtrl::OnSize(wxSizeEvent& evt) {
344 wxSize sz = GetClientSize();
345 m_swx->DoSize(sz.x, sz.y);
346 }
347
348 void wxStyledTextCtrl::OnMouseLeftDown(wxMouseEvent& evt) {
349 wxPoint pt = evt.GetPosition();
350 m_swx->DoButtonDown(Point(pt.x, pt.y), m_stopWatch.Time(),
351 evt.ShiftDown(), evt.ControlDown(), evt.AltDown());
352 }
353
354 void wxStyledTextCtrl::OnMouseMove(wxMouseEvent& evt) {
355 wxPoint pt = evt.GetPosition();
356 m_swx->DoButtonMove(Point(pt.x, pt.y));
357 }
358
359 void wxStyledTextCtrl::OnMouseLeftUp(wxMouseEvent& evt) {
360 wxPoint pt = evt.GetPosition();
361 m_swx->DoButtonUp(Point(pt.x, pt.y), m_stopWatch.Time(),
362 evt.ControlDown());
363 }
364
365
366 void wxStyledTextCtrl::OnContextMenu(wxContextMenuEvent& evt) {
367 wxPoint pt = evt.GetPosition();
368 ScreenToClient(&pt.x, &pt.y);
369 m_swx->DoContextMenu(Point(pt.x, pt.y));
370 }
371
372
373 void wxStyledTextCtrl::OnMouseWheel(wxMouseEvent& evt) {
374 m_swx->DoMouseWheel(evt.GetWheelRotation(),
375 evt.GetWheelDelta(),
376 evt.GetLinesPerAction(),
377 evt.ControlDown());
378 }
379
380
381 void wxStyledTextCtrl::OnChar(wxKeyEvent& evt) {
382 long key = evt.KeyCode();
383
384 // printf("OnChar key:%%d consumed:%%d ctrl:%%d alt:%%d\n",
385 // key, m_lastKeyDownConsumed, evt.ControlDown(), evt.AltDown());
386
387 // AltGr keys???
388 // \|@#¬[]{}?£$~ ã,õ,Ã,Õ, ñ, Ñ
389
390 // On (some?) non-US keyboards the AltGr key is required to enter some
391 // common characters. It comes to us as both Alt and Ctrl down so we need
392 // to let the char through in that case, otherwise if only ctrl or only
393 // alt let's skip it.
394 bool ctrl = evt.ControlDown();
395 bool alt = evt.AltDown();
396 bool skip = (ctrl || alt && ! (ctrl && alt));
397
398 if (key <= 0xff && !iscntrl(key) && !m_lastKeyDownConsumed && !skip) {
399 m_swx->DoAddChar(key);
400 return;
401 }
402 evt.Skip();
403 }
404
405
406 void wxStyledTextCtrl::OnKeyDown(wxKeyEvent& evt) {
407 long key = evt.KeyCode();
408 bool shift = evt.ShiftDown(),
409 ctrl = evt.ControlDown(),
410 alt = evt.AltDown();
411
412 int processed = m_swx->DoKeyDown(key, shift, ctrl, alt, &m_lastKeyDownConsumed);
413
414 // printf("key: %%d shift: %%d ctrl: %%d alt: %%d processed: %%d consumed: %%d\n",
415 // key, shift, ctrl, alt, processed, m_lastKeyDownConsumed);
416
417 if (!processed && !m_lastKeyDownConsumed)
418 evt.Skip();
419 }
420
421
422 void wxStyledTextCtrl::OnLoseFocus(wxFocusEvent& evt) {
423 m_swx->DoLoseFocus();
424 }
425
426
427 void wxStyledTextCtrl::OnGainFocus(wxFocusEvent& evt) {
428 m_swx->DoGainFocus();
429 }
430
431
432 void wxStyledTextCtrl::OnSysColourChanged(wxSysColourChangedEvent& evt) {
433 m_swx->DoSysColourChange();
434 }
435
436
437 void wxStyledTextCtrl::OnEraseBackground(wxEraseEvent& evt) {
438 // do nothing to help avoid flashing
439 }
440
441
442
443 void wxStyledTextCtrl::OnMenu(wxCommandEvent& evt) {
444 m_swx->DoCommand(evt.GetId());
445 }
446
447
448 void wxStyledTextCtrl::OnListBox(wxCommandEvent& evt) {
449 m_swx->DoOnListBox();
450 }
451
452
453 //----------------------------------------------------------------------
454 // Turn notifications from Scintilla into events
455
456
457 void wxStyledTextCtrl::NotifyChange() {
458 wxStyledTextEvent evt(wxEVT_STC_CHANGE, GetId());
459 GetEventHandler()->ProcessEvent(evt);
460 }
461
462 void wxStyledTextCtrl::NotifyParent(SCNotification* _scn) {
463 SCNotification& scn = *_scn;
464 wxStyledTextEvent evt(0, GetId());
465
466 evt.SetPosition(scn.position);
467 evt.SetKey(scn.ch);
468 evt.SetModifiers(scn.modifiers);
469
470 switch (scn.nmhdr.code) {
471 case SCN_STYLENEEDED:
472 evt.SetEventType(wxEVT_STC_STYLENEEDED);
473 break;
474
475 case SCN_CHARADDED:
476 evt.SetEventType(wxEVT_STC_CHARADDED);
477 break;
478
479 case SCN_SAVEPOINTREACHED:
480 evt.SetEventType(wxEVT_STC_SAVEPOINTREACHED);
481 break;
482
483 case SCN_SAVEPOINTLEFT:
484 evt.SetEventType(wxEVT_STC_SAVEPOINTLEFT);
485 break;
486
487 case SCN_MODIFYATTEMPTRO:
488 evt.SetEventType(wxEVT_STC_ROMODIFYATTEMPT);
489 break;
490
491 case SCN_KEY:
492 evt.SetEventType(wxEVT_STC_KEY);
493 break;
494
495 case SCN_DOUBLECLICK:
496 evt.SetEventType(wxEVT_STC_DOUBLECLICK);
497 break;
498
499 case SCN_UPDATEUI:
500 evt.SetEventType(wxEVT_STC_UPDATEUI);
501 break;
502
503 case SCN_MODIFIED:
504 evt.SetEventType(wxEVT_STC_MODIFIED);
505 evt.SetModificationType(scn.modificationType);
506 if (scn.text)
507 evt.SetText(wxString(scn.text, scn.length));
508 evt.SetLength(scn.length);
509 evt.SetLinesAdded(scn.linesAdded);
510 evt.SetLine(scn.line);
511 evt.SetFoldLevelNow(scn.foldLevelNow);
512 evt.SetFoldLevelPrev(scn.foldLevelPrev);
513 break;
514
515 case SCN_MACRORECORD:
516 evt.SetEventType(wxEVT_STC_MACRORECORD);
517 evt.SetMessage(scn.message);
518 evt.SetWParam(scn.wParam);
519 evt.SetLParam(scn.lParam);
520 break;
521
522 case SCN_MARGINCLICK:
523 evt.SetEventType(wxEVT_STC_MARGINCLICK);
524 evt.SetMargin(scn.margin);
525 break;
526
527 case SCN_NEEDSHOWN:
528 evt.SetEventType(wxEVT_STC_NEEDSHOWN);
529 evt.SetLength(scn.length);
530 break;
531
532 case SCN_POSCHANGED:
533 evt.SetEventType(wxEVT_STC_POSCHANGED);
534 break;
535
536 case SCN_PAINTED:
537 evt.SetEventType(wxEVT_STC_PAINTED);
538 break;
539
540 case SCN_USERLISTSELECTION:
541 evt.SetEventType(wxEVT_STC_USERLISTSELECTION);
542 evt.SetListType(scn.listType);
543 evt.SetText(scn.text);
544 break;
545
546 case SCN_URIDROPPED:
547 evt.SetEventType(wxEVT_STC_URIDROPPED);
548 evt.SetText(scn.text);
549 break;
550
551 case SCN_DWELLSTART:
552 evt.SetEventType(wxEVT_STC_DWELLSTART);
553 evt.SetX(scn.x);
554 evt.SetY(scn.y);
555 break;
556
557 case SCN_DWELLEND:
558 evt.SetEventType(wxEVT_STC_DWELLEND);
559 evt.SetX(scn.x);
560 evt.SetY(scn.y);
561 break;
562
563 default:
564 return;
565 }
566
567 GetEventHandler()->ProcessEvent(evt);
568 }
569
570
571
572 //----------------------------------------------------------------------
573 //----------------------------------------------------------------------
574 //----------------------------------------------------------------------
575
576 wxStyledTextEvent::wxStyledTextEvent(wxEventType commandType, int id)
577 : wxCommandEvent(commandType, id)
578 {
579 m_position = 0;
580 m_key = 0;
581 m_modifiers = 0;
582 m_modificationType = 0;
583 m_length = 0;
584 m_linesAdded = 0;
585 m_line = 0;
586 m_foldLevelNow = 0;
587 m_foldLevelPrev = 0;
588 m_margin = 0;
589 m_message = 0;
590 m_wParam = 0;
591 m_lParam = 0;
592 m_listType = 0;
593 m_x = 0;
594 m_y = 0;
595 }
596
597 bool wxStyledTextEvent::GetShift() const { return (m_modifiers & SCI_SHIFT) != 0; }
598 bool wxStyledTextEvent::GetControl() const { return (m_modifiers & SCI_CTRL) != 0; }
599 bool wxStyledTextEvent::GetAlt() const { return (m_modifiers & SCI_ALT) != 0; }
600
601 void wxStyledTextEvent::CopyObject(wxObject& obj) const {
602 wxCommandEvent::CopyObject(obj);
603
604 wxStyledTextEvent* o = (wxStyledTextEvent*)&obj;
605 o->m_position = m_position;
606 o->m_key = m_key;
607 o->m_modifiers = m_modifiers;
608 o->m_modificationType = m_modificationType;
609 o->m_text = m_text;
610 o->m_length = m_length;
611 o->m_linesAdded = m_linesAdded;
612 o->m_line = m_line;
613 o->m_foldLevelNow = m_foldLevelNow;
614 o->m_foldLevelPrev = m_foldLevelPrev;
615
616 o->m_margin = m_margin;
617
618 o->m_message = m_message;
619 o->m_wParam = m_wParam;
620 o->m_lParam = m_lParam;
621
622 o->m_listType = m_listType;
623 o->m_x = m_x;
624 o->m_y = m_y;
625
626 }
627
628 //----------------------------------------------------------------------
629 //----------------------------------------------------------------------
630