]> git.saurik.com Git - wxWidgets.git/blob - contrib/src/stc/scintilla/src/ScintillaBase.cxx
e42b5dc65ea0b0e065295df708d615e6a3e0729b
[wxWidgets.git] / contrib / src / stc / scintilla / src / ScintillaBase.cxx
1 // Scintilla source code edit control
2 /** @file ScintillaBase.cxx
3 ** An enhanced subclass of Editor with calltips, autocomplete and context menu.
4 **/
5 // Copyright 1998-2003 by Neil Hodgson <neilh@scintilla.org>
6 // The License.txt file describes the conditions under which this software may be distributed.
7
8 #include <stdlib.h>
9 #include <string.h>
10 #include <stdio.h>
11 #include <ctype.h>
12
13 #include "Platform.h"
14
15 #include "Scintilla.h"
16 #include "PropSet.h"
17 #ifdef SCI_LEXER
18 #include "SciLexer.h"
19 #include "Accessor.h"
20 #include "DocumentAccessor.h"
21 #include "KeyWords.h"
22 #endif
23 #include "ContractionState.h"
24 #include "SVector.h"
25 #include "CellBuffer.h"
26 #include "CallTip.h"
27 #include "KeyMap.h"
28 #include "Indicator.h"
29 #include "XPM.h"
30 #include "LineMarker.h"
31 #include "Style.h"
32 #include "ViewStyle.h"
33 #include "AutoComplete.h"
34 #include "Document.h"
35 #include "Editor.h"
36 #include "ScintillaBase.h"
37
38 ScintillaBase::ScintillaBase() {
39 displayPopupMenu = true;
40 listType = 0;
41 #ifdef SCI_LEXER
42 lexLanguage = SCLEX_CONTAINER;
43 lexCurrent = 0;
44 for (int wl = 0;wl < numWordLists;wl++)
45 keyWordLists[wl] = new WordList;
46 keyWordLists[numWordLists] = 0;
47 #endif
48 }
49
50 ScintillaBase::~ScintillaBase() {
51 #ifdef SCI_LEXER
52 for (int wl = 0;wl < numWordLists;wl++)
53 delete keyWordLists[wl];
54 #endif
55 }
56
57 void ScintillaBase::Finalise() {
58 Editor::Finalise();
59 popup.Destroy();
60 }
61
62 void ScintillaBase::RefreshColourPalette(Palette &pal, bool want) {
63 Editor::RefreshColourPalette(pal, want);
64 ct.RefreshColourPalette(pal, want);
65 }
66
67 void ScintillaBase::AddCharUTF(char *s, unsigned int len, bool treatAsDBCS) {
68 bool isFillUp = ac.Active() && ac.IsFillUpChar(*s);
69 if (!isFillUp) {
70 Editor::AddCharUTF(s, len, treatAsDBCS);
71 }
72 if (ac.Active()) {
73 AutoCompleteCharacterAdded(s[0]);
74 // For fill ups add the character after the autocompletion has
75 // triggered so containers see the key so can display a calltip.
76 if (isFillUp) {
77 Editor::AddCharUTF(s, len, treatAsDBCS);
78 }
79 }
80 }
81
82 void ScintillaBase::Command(int cmdId) {
83
84 switch (cmdId) {
85
86 case idAutoComplete: // Nothing to do
87
88 break;
89
90 case idCallTip: // Nothing to do
91
92 break;
93
94 case idcmdUndo:
95 WndProc(SCI_UNDO, 0, 0);
96 break;
97
98 case idcmdRedo:
99 WndProc(SCI_REDO, 0, 0);
100 break;
101
102 case idcmdCut:
103 WndProc(SCI_CUT, 0, 0);
104 break;
105
106 case idcmdCopy:
107 WndProc(SCI_COPY, 0, 0);
108 break;
109
110 case idcmdPaste:
111 WndProc(SCI_PASTE, 0, 0);
112 break;
113
114 case idcmdDelete:
115 WndProc(SCI_CLEAR, 0, 0);
116 break;
117
118 case idcmdSelectAll:
119 WndProc(SCI_SELECTALL, 0, 0);
120 break;
121 }
122 }
123
124 int ScintillaBase::KeyCommand(unsigned int iMessage) {
125 // Most key commands cancel autocompletion mode
126 if (ac.Active()) {
127 switch (iMessage) {
128 // Except for these
129 case SCI_LINEDOWN:
130 AutoCompleteMove(1);
131 return 0;
132 case SCI_LINEUP:
133 AutoCompleteMove( -1);
134 return 0;
135 case SCI_PAGEDOWN:
136 AutoCompleteMove(5);
137 return 0;
138 case SCI_PAGEUP:
139 AutoCompleteMove( -5);
140 return 0;
141 case SCI_VCHOME:
142 AutoCompleteMove( -5000);
143 return 0;
144 case SCI_LINEEND:
145 AutoCompleteMove(5000);
146 return 0;
147 case SCI_DELETEBACK:
148 DelCharBack(true);
149 AutoCompleteCharacterDeleted();
150 EnsureCaretVisible();
151 return 0;
152 case SCI_DELETEBACKNOTLINE:
153 DelCharBack(false);
154 AutoCompleteCharacterDeleted();
155 EnsureCaretVisible();
156 return 0;
157 case SCI_TAB:
158 AutoCompleteCompleted();
159 return 0;
160 case SCI_NEWLINE:
161 AutoCompleteCompleted();
162 return 0;
163
164 default:
165 ac.Cancel();
166 }
167 }
168
169 if (ct.inCallTipMode) {
170 if (
171 (iMessage != SCI_CHARLEFT) &&
172 (iMessage != SCI_CHARLEFTEXTEND) &&
173 (iMessage != SCI_CHARRIGHT) &&
174 (iMessage != SCI_CHARLEFTEXTEND) &&
175 (iMessage != SCI_EDITTOGGLEOVERTYPE) &&
176 (iMessage != SCI_DELETEBACK) &&
177 (iMessage != SCI_DELETEBACKNOTLINE)
178 ) {
179 ct.CallTipCancel();
180 }
181 if ((iMessage == SCI_DELETEBACK) || (iMessage == SCI_DELETEBACKNOTLINE)) {
182 if (currentPos <= ct.posStartCallTip) {
183 ct.CallTipCancel();
184 }
185 }
186 }
187 return Editor::KeyCommand(iMessage);
188 }
189
190 void ScintillaBase::AutoCompleteDoubleClick(void* p) {
191 ScintillaBase* sci = reinterpret_cast<ScintillaBase*>(p);
192 sci->AutoCompleteCompleted();
193 }
194
195 void ScintillaBase::AutoCompleteStart(int lenEntered, const char *list) {
196 //Platform::DebugPrintf("AutoComplete %s\n", list);
197 ct.CallTipCancel();
198
199 if (ac.chooseSingle && (listType == 0)) {
200 if (list && !strchr(list, ac.GetSeparator())) {
201 const char *typeSep = strchr(list, ac.GetTypesep());
202 size_t lenInsert = (typeSep) ? (typeSep-list) : strlen(list);
203 if (ac.ignoreCase) {
204 SetEmptySelection(currentPos - lenEntered);
205 pdoc->DeleteChars(currentPos, lenEntered);
206 SetEmptySelection(currentPos);
207 pdoc->InsertString(currentPos, list, lenInsert);
208 SetEmptySelection(currentPos + lenInsert);
209 } else {
210 SetEmptySelection(currentPos);
211 pdoc->InsertString(currentPos, list + lenEntered, lenInsert - lenEntered);
212 SetEmptySelection(currentPos + lenInsert - lenEntered);
213 }
214 return;
215 }
216 }
217 ac.Start(wMain, idAutoComplete, currentPos, lenEntered, vs.lineHeight, IsUnicodeMode());
218
219 PRectangle rcClient = GetClientRectangle();
220 Point pt = LocationFromPosition(currentPos - lenEntered);
221
222 int heightLB = 100;
223 int widthLB = 100;
224 if (pt.x >= rcClient.right - widthLB) {
225 HorizontalScrollTo(xOffset + pt.x - rcClient.right + widthLB);
226 Redraw();
227 pt = LocationFromPosition(currentPos);
228 }
229 PRectangle rcac;
230 rcac.left = pt.x - ac.lb->CaretFromEdge();
231 if (pt.y >= rcClient.bottom - heightLB && // Wont fit below.
232 pt.y >= (rcClient.bottom + rcClient.top) / 2) { // and there is more room above.
233 rcac.top = pt.y - heightLB;
234 if (rcac.top < 0) {
235 heightLB += rcac.top;
236 rcac.top = 0;
237 }
238 } else {
239 rcac.top = pt.y + vs.lineHeight;
240 }
241 rcac.right = rcac.left + widthLB;
242 rcac.bottom = Platform::Minimum(rcac.top + heightLB, rcClient.bottom);
243 ac.lb->SetPositionRelative(rcac, wMain);
244 ac.lb->SetFont(vs.styles[STYLE_DEFAULT].font);
245 ac.lb->SetAverageCharWidth(vs.styles[STYLE_DEFAULT].aveCharWidth);
246 ac.lb->SetDoubleClickAction(AutoCompleteDoubleClick, this);
247
248 ac.SetList(list);
249
250 // Fiddle the position of the list so it is right next to the target and wide enough for all its strings
251 PRectangle rcList = ac.lb->GetDesiredRect();
252 int heightAlloced = rcList.bottom - rcList.top;
253 widthLB = Platform::Maximum(widthLB, rcList.right - rcList.left);
254 // Make an allowance for large strings in list
255 rcList.left = pt.x - ac.lb->CaretFromEdge();
256 rcList.right = rcList.left + widthLB;
257 if (((pt.y + vs.lineHeight) >= (rcClient.bottom - heightAlloced)) && // Wont fit below.
258 ((pt.y + vs.lineHeight / 2) >= (rcClient.bottom + rcClient.top) / 2)) { // and there is more room above.
259 rcList.top = pt.y - heightAlloced;
260 } else {
261 rcList.top = pt.y + vs.lineHeight;
262 }
263 rcList.bottom = rcList.top + heightAlloced;
264 ac.lb->SetPositionRelative(rcList, wMain);
265 ac.Show();
266 if (lenEntered != 0) {
267 AutoCompleteMoveToCurrentWord();
268 }
269 }
270
271 void ScintillaBase::AutoCompleteCancel() {
272 ac.Cancel();
273 }
274
275 void ScintillaBase::AutoCompleteMove(int delta) {
276 ac.Move(delta);
277 }
278
279 void ScintillaBase::AutoCompleteMoveToCurrentWord() {
280 char wordCurrent[1000];
281 int i;
282 int startWord = ac.posStart - ac.startLen;
283 for (i = startWord; i < currentPos; i++)
284 wordCurrent[i - startWord] = pdoc->CharAt(i);
285 wordCurrent[i - startWord] = '\0';
286 ac.Select(wordCurrent);
287 }
288
289 void ScintillaBase::AutoCompleteCharacterAdded(char ch) {
290 if (ac.IsFillUpChar(ch)) {
291 AutoCompleteCompleted();
292 } else if (ac.IsStopChar(ch)) {
293 ac.Cancel();
294 } else {
295 AutoCompleteMoveToCurrentWord();
296 }
297 }
298
299 void ScintillaBase::AutoCompleteCharacterDeleted() {
300 if (currentPos <= ac.posStart - ac.startLen) {
301 ac.Cancel();
302 } else if (ac.cancelAtStartPos && (currentPos <= ac.posStart)) {
303 ac.Cancel();
304 } else {
305 AutoCompleteMoveToCurrentWord();
306 }
307 }
308
309 void ScintillaBase::AutoCompleteCompleted() {
310 int item = ac.lb->GetSelection();
311 char selected[1000];
312 selected[0] = '\0';
313 if (item != -1) {
314 ac.lb->GetValue(item, selected, sizeof(selected));
315 }
316 ac.Cancel();
317
318 if (listType > 0) {
319 userListSelected = selected;
320 SCNotification scn;
321 scn.nmhdr.code = SCN_USERLISTSELECTION;
322 scn.message = 0;
323 scn.wParam = listType;
324 scn.listType = listType;
325 scn.lParam = 0;
326 scn.text = userListSelected.c_str();
327 NotifyParent(scn);
328 return;
329 }
330
331 Position firstPos = ac.posStart - ac.startLen;
332 Position endPos = currentPos;
333 if (ac.dropRestOfWord)
334 endPos = pdoc->ExtendWordSelect(endPos, 1, true);
335 if (endPos < firstPos)
336 return;
337 pdoc->BeginUndoAction();
338 if (endPos != firstPos) {
339 pdoc->DeleteChars(firstPos, endPos - firstPos);
340 }
341 SetEmptySelection(ac.posStart);
342 if (item != -1) {
343 SString piece = selected;
344 pdoc->InsertString(firstPos, piece.c_str());
345 SetEmptySelection(firstPos + static_cast<int>(piece.length()));
346 }
347 pdoc->EndUndoAction();
348 }
349
350 int ScintillaBase::AutoCompleteGetCurrent() {
351 return ac.lb->GetSelection();
352 }
353
354 void ScintillaBase::CallTipShow(Point pt, const char *defn) {
355 AutoCompleteCancel();
356 pt.y += vs.lineHeight;
357 PRectangle rc = ct.CallTipStart(currentPos, pt,
358 defn,
359 vs.styles[STYLE_DEFAULT].fontName,
360 vs.styles[STYLE_DEFAULT].sizeZoomed,
361 IsUnicodeMode(),
362 wMain);
363 // If the call-tip window would be out of the client
364 // space, adjust so it displays above the text.
365 PRectangle rcClient = GetClientRectangle();
366 if (rc.bottom > rcClient.bottom) {
367 int offset = vs.lineHeight + rc.Height();
368 rc.top -= offset;
369 rc.bottom -= offset;
370 }
371 // Now display the window.
372 CreateCallTipWindow(rc);
373 ct.wCallTip.SetPositionRelative(rc, wMain);
374 ct.wCallTip.Show();
375 }
376
377 void ScintillaBase::CallTipClick() {
378 SCNotification scn;
379 scn.nmhdr.code = SCN_CALLTIPCLICK;
380 scn.position = ct.clickPlace;
381 NotifyParent(scn);
382 }
383
384 void ScintillaBase::ContextMenu(Point pt) {
385 if (displayPopupMenu) {
386 bool writable = !WndProc(SCI_GETREADONLY, 0, 0);
387 popup.CreatePopUp();
388 AddToPopUp("Undo", idcmdUndo, writable && pdoc->CanUndo());
389 AddToPopUp("Redo", idcmdRedo, writable && pdoc->CanRedo());
390 AddToPopUp("");
391 AddToPopUp("Cut", idcmdCut, writable && currentPos != anchor);
392 AddToPopUp("Copy", idcmdCopy, currentPos != anchor);
393 AddToPopUp("Paste", idcmdPaste, writable && WndProc(SCI_CANPASTE, 0, 0));
394 AddToPopUp("Delete", idcmdDelete, writable && currentPos != anchor);
395 AddToPopUp("");
396 AddToPopUp("Select All", idcmdSelectAll);
397 popup.Show(pt, wMain);
398 }
399 }
400
401 void ScintillaBase::CancelModes() {
402 AutoCompleteCancel();
403 ct.CallTipCancel();
404 Editor::CancelModes();
405 }
406
407 void ScintillaBase::ButtonDown(Point pt, unsigned int curTime, bool shift, bool ctrl, bool alt) {
408 CancelModes();
409 Editor::ButtonDown(pt, curTime, shift, ctrl, alt);
410 }
411
412 #ifdef SCI_LEXER
413 void ScintillaBase::SetLexer(uptr_t wParam) {
414 lexLanguage = wParam;
415 lexCurrent = LexerModule::Find(lexLanguage);
416 if (!lexCurrent)
417 lexCurrent = LexerModule::Find(SCLEX_NULL);
418 }
419
420 void ScintillaBase::SetLexerLanguage(const char *languageName) {
421 lexLanguage = SCLEX_CONTAINER;
422 lexCurrent = LexerModule::Find(languageName);
423 if (!lexCurrent)
424 lexCurrent = LexerModule::Find(SCLEX_NULL);
425 if (lexCurrent)
426 lexLanguage = lexCurrent->GetLanguage();
427 }
428
429 void ScintillaBase::Colourise(int start, int end) {
430 int lengthDoc = pdoc->Length();
431 if (end == -1)
432 end = lengthDoc;
433 int len = end - start;
434
435 PLATFORM_ASSERT(len >= 0);
436 PLATFORM_ASSERT(start + len <= lengthDoc);
437
438 //WindowAccessor styler(wMain.GetID(), props);
439 DocumentAccessor styler(pdoc, props, wMain.GetID());
440
441 int styleStart = 0;
442 if (start > 0)
443 styleStart = styler.StyleAt(start - 1);
444 styler.SetCodePage(pdoc->dbcsCodePage);
445
446 if (lexCurrent && (len > 0)) { // Should always succeed as null lexer should always be available
447 lexCurrent->Lex(start, len, styleStart, keyWordLists, styler);
448 styler.Flush();
449 if (styler.GetPropertyInt("fold")) {
450 lexCurrent->Fold(start, len, styleStart, keyWordLists, styler);
451 styler.Flush();
452 }
453 }
454 }
455 #endif
456
457 void ScintillaBase::NotifyStyleToNeeded(int endStyleNeeded) {
458 #ifdef SCI_LEXER
459 if (lexLanguage != SCLEX_CONTAINER) {
460 int endStyled = WndProc(SCI_GETENDSTYLED, 0, 0);
461 int lineEndStyled = WndProc(SCI_LINEFROMPOSITION, endStyled, 0);
462 endStyled = WndProc(SCI_POSITIONFROMLINE, lineEndStyled, 0);
463 Colourise(endStyled, endStyleNeeded);
464 return;
465 }
466 #endif
467 Editor::NotifyStyleToNeeded(endStyleNeeded);
468 }
469
470 sptr_t ScintillaBase::WndProc(unsigned int iMessage, uptr_t wParam, sptr_t lParam) {
471 switch (iMessage) {
472 case SCI_AUTOCSHOW:
473 listType = 0;
474 AutoCompleteStart(wParam, reinterpret_cast<const char *>(lParam));
475 break;
476
477 case SCI_AUTOCCANCEL:
478 AutoCompleteCancel();
479 break;
480
481 case SCI_AUTOCACTIVE:
482 return ac.Active();
483
484 case SCI_AUTOCPOSSTART:
485 return ac.posStart;
486
487 case SCI_AUTOCCOMPLETE:
488 AutoCompleteCompleted();
489 break;
490
491 case SCI_AUTOCSETSEPARATOR:
492 ac.SetSeparator(static_cast<char>(wParam));
493 break;
494
495 case SCI_AUTOCGETSEPARATOR:
496 return ac.GetSeparator();
497
498 case SCI_AUTOCSTOPS:
499 ac.SetStopChars(reinterpret_cast<char *>(lParam));
500 break;
501
502 case SCI_AUTOCSELECT:
503 ac.Select(reinterpret_cast<char *>(lParam));
504 break;
505
506 case SCI_AUTOCGETCURRENT:
507 return AutoCompleteGetCurrent();
508
509 case SCI_AUTOCSETCANCELATSTART:
510 ac.cancelAtStartPos = wParam != 0;
511 break;
512
513 case SCI_AUTOCGETCANCELATSTART:
514 return ac.cancelAtStartPos;
515
516 case SCI_AUTOCSETFILLUPS:
517 ac.SetFillUpChars(reinterpret_cast<char *>(lParam));
518 break;
519
520 case SCI_AUTOCSETCHOOSESINGLE:
521 ac.chooseSingle = wParam != 0;
522 break;
523
524 case SCI_AUTOCGETCHOOSESINGLE:
525 return ac.chooseSingle;
526
527 case SCI_AUTOCSETIGNORECASE:
528 ac.ignoreCase = wParam != 0;
529 break;
530
531 case SCI_AUTOCGETIGNORECASE:
532 return ac.ignoreCase;
533
534 case SCI_USERLISTSHOW:
535 listType = wParam;
536 AutoCompleteStart(0, reinterpret_cast<const char *>(lParam));
537 break;
538
539 case SCI_AUTOCSETAUTOHIDE:
540 ac.autoHide = wParam != 0;
541 break;
542
543 case SCI_AUTOCGETAUTOHIDE:
544 return ac.autoHide;
545
546 case SCI_AUTOCSETDROPRESTOFWORD:
547 ac.dropRestOfWord = wParam != 0;
548 break;
549
550 case SCI_AUTOCGETDROPRESTOFWORD:
551 return ac.dropRestOfWord;
552
553 case SCI_REGISTERIMAGE:
554 ac.lb->RegisterImage(wParam, reinterpret_cast<const char *>(lParam));
555 break;
556
557 case SCI_CLEARREGISTEREDIMAGES:
558 ac.lb->ClearRegisteredImages();
559 break;
560
561 case SCI_AUTOCSETTYPESEPARATOR:
562 ac.SetTypesep(static_cast<char>(wParam));
563 break;
564
565 case SCI_AUTOCGETTYPESEPARATOR:
566 return ac.GetTypesep();
567
568 case SCI_CALLTIPSHOW:
569 CallTipShow(LocationFromPosition(wParam),
570 reinterpret_cast<const char *>(lParam));
571 break;
572
573 case SCI_CALLTIPCANCEL:
574 ct.CallTipCancel();
575 break;
576
577 case SCI_CALLTIPACTIVE:
578 return ct.inCallTipMode;
579
580 case SCI_CALLTIPPOSSTART:
581 return ct.posStartCallTip;
582
583 case SCI_CALLTIPSETHLT:
584 ct.SetHighlight(wParam, lParam);
585 break;
586
587 case SCI_CALLTIPSETBACK:
588 ct.colourBG = ColourDesired(wParam);
589 InvalidateStyleRedraw();
590 break;
591
592 case SCI_CALLTIPSETFORE:
593 ct.colourUnSel = ColourDesired(wParam);
594 InvalidateStyleRedraw();
595 break;
596
597 case SCI_CALLTIPSETFOREHLT:
598 ct.colourSel = ColourDesired(wParam);
599 InvalidateStyleRedraw();
600 break;
601
602 case SCI_USEPOPUP:
603 displayPopupMenu = wParam != 0;
604 break;
605
606 #ifdef SCI_LEXER
607 case SCI_SETLEXER:
608 SetLexer(wParam);
609 lexLanguage = wParam;
610 break;
611
612 case SCI_GETLEXER:
613 return lexLanguage;
614
615 case SCI_COLOURISE:
616 Colourise(wParam, lParam);
617 Redraw();
618 break;
619
620 case SCI_SETPROPERTY:
621 props.Set(reinterpret_cast<const char *>(wParam),
622 reinterpret_cast<const char *>(lParam));
623 break;
624
625 case SCI_SETKEYWORDS:
626 if (wParam < numWordLists) {
627 keyWordLists[wParam]->Clear();
628 keyWordLists[wParam]->Set(reinterpret_cast<const char *>(lParam));
629 }
630 break;
631
632 case SCI_SETLEXERLANGUAGE:
633 SetLexerLanguage(reinterpret_cast<const char *>(lParam));
634 break;
635
636 #endif
637
638 default:
639 return Editor::WndProc(iMessage, wParam, lParam);
640 }
641 return 0l;
642 }