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