-
Notifications
You must be signed in to change notification settings - Fork 193
/
ScintillaWin.cxx
4252 lines (3751 loc) · 133 KB
/
ScintillaWin.cxx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Scintilla source code edit control
/** @file ScintillaWin.cxx
** Windows specific subclass of ScintillaBase.
**/
// Copyright 1998-2003 by Neil Hodgson <neilh@scintilla.org>
// The License.txt file describes the conditions under which this software may be distributed.
#include <cstddef>
#include <cstdlib>
#include <cstdint>
#include <cassert>
#include <cstring>
#include <cstdio>
#include <cmath>
#include <climits>
#include <stdexcept>
#include <new>
#include <string>
#include <string_view>
#include <vector>
#include <map>
#include <optional>
#include <algorithm>
#include <memory>
//#include <mutex>
// WIN32_LEAN_AND_MEAN is defined to avoid including commdlg.h
// (which defined FindText) to fix GCC LTO ODR violation warning.
struct IUnknown;
#include <windows.h>
#include <commctrl.h>
#include <richedit.h>
#include <windowsx.h>
#include <zmouse.h>
#include <ole2.h>
#include <shlwapi.h>
#include <shlobj.h>
#include <shellapi.h>
#define DebugCopyAsRichTextFormat 0
#define DebugDragAndDropDataFormat 0
#define MaxDragAndDropDataFormatCount 6
/*
CF_VSSTGPROJECTITEMS, CF_VSREFPROJECTITEMS
https://docs.microsoft.com/en-us/visualstudio/extensibility/ux-guidelines/application-patterns-for-visual-studio
*/
#define EnableDrop_VisualStudioProjectItem 1
/*
Chromium Web Custom MIME Data Format
Used by VSCode, Atom etc.
*/
#define Enable_ChromiumWebCustomMIMEDataFormat 0
#include "ParallelSupport.h"
#include "ScintillaTypes.h"
#include "ScintillaMessages.h"
#include "ScintillaStructures.h"
#include "ILoader.h"
#include "ILexer.h"
#include "Debugging.h"
#include "Geometry.h"
#include "Platform.h"
#include "VectorISA.h"
//#include "CharacterCategory.h"
#include "Position.h"
#include "UniqueString.h"
#include "SplitVector.h"
#include "Partitioning.h"
#include "RunStyles.h"
#include "ContractionState.h"
#include "CellBuffer.h"
#include "CallTip.h"
#include "KeyMap.h"
#include "Indicator.h"
#include "LineMarker.h"
#include "Style.h"
#include "ViewStyle.h"
#include "CharClassify.h"
#include "Decoration.h"
#include "CaseFolder.h"
#include "Document.h"
#include "CaseConvert.h"
#include "UniConversion.h"
#include "Selection.h"
#include "PositionCache.h"
#include "EditModel.h"
#include "MarginView.h"
#include "EditView.h"
#include "Editor.h"
//#include "ElapsedPeriod.h"
#include "AutoComplete.h"
#include "ScintillaBase.h"
#include "WinTypes.h"
#include "PlatWin.h"
#include "HanjaDic.h"
#include "LaTeXInput.h"
#define APPM_DROPFILES (WM_APP + 7)
#ifndef WM_DPICHANGED
#define WM_DPICHANGED 0x02E0
#endif
#ifndef WM_DPICHANGED_AFTERPARENT
#define WM_DPICHANGED_AFTERPARENT 0x02E3
#endif
#ifndef WM_MOUSEHWHEEL
#define WM_MOUSEHWHEEL 0x020E
#endif
#ifndef SPI_GETWHEELSCROLLCHARS
#define SPI_GETWHEELSCROLLCHARS 0x006C
#endif
using namespace Scintilla;
using namespace Scintilla::Internal;
namespace {
// Two idle messages SC_WIN_IDLE and SC_WORK_IDLE.
// SC_WIN_IDLE is low priority so should occur after the next WM_PAINT
// It is for lengthy actions like wrapping and background styling
constexpr UINT SC_WIN_IDLE = 5001;
// SC_WORK_IDLE is high priority and should occur before the next WM_PAINT
// It is for shorter actions like restyling the text just inserted
// and delivering SCN_UPDATEUI
constexpr UINT SC_WORK_IDLE = 5002;
constexpr int IndicatorInput = static_cast<int>(IndicatorNumbers::Ime);
constexpr int IndicatorTarget = IndicatorInput + 1;
constexpr int IndicatorConverted = IndicatorInput + 2;
constexpr int IndicatorUnknown = IndicatorInput + 3;
#if _WIN32_WINNT < _WIN32_WINNT_WIN8
using SetCoalescableTimerSig = UINT_PTR (WINAPI *)(HWND hwnd, UINT_PTR nIDEvent,
UINT uElapse, TIMERPROC lpTimerFunc, ULONG uToleranceDelay);
#endif
constexpr const WCHAR *callClassName = L"CallTip";
inline void SetWindowID(HWND hWnd, int identifier) noexcept {
::SetWindowLongPtr(hWnd, GWLP_ID, identifier);
}
constexpr POINT POINTFromLParam(sptr_t lParam) noexcept {
return { GET_X_LPARAM(lParam), GET_Y_LPARAM(lParam) };
};
constexpr Point PointFromLParam(LPARAM lParam) noexcept {
return Point::FromInts(GET_X_LPARAM(lParam), GET_Y_LPARAM(lParam));
}
inline bool KeyboardIsKeyDown(int key) noexcept {
return (::GetKeyState(key) & 0x8000) != 0;
}
// Bit 24 is the extended keyboard flag and the numeric keypad is non-extended
constexpr sptr_t extendedKeyboard = 1 << 24;
constexpr bool KeyboardIsNumericKeypadFunction(Scintilla::uptr_t wParam, Scintilla::sptr_t lParam) noexcept {
// Bit 24 is the extended keyboard flag and the numeric keypad is non-extended
if ((lParam & extendedKeyboard) != 0) {
// Not from the numeric keypad
return false;
}
switch (wParam) {
case VK_INSERT: // 0
case VK_END: // 1
case VK_DOWN: // 2
case VK_NEXT: // 3
case VK_LEFT: // 4
case VK_CLEAR: // 5
case VK_RIGHT: // 6
case VK_HOME: // 7
case VK_UP: // 8
case VK_PRIOR: // 9
return true;
default:
return false;
}
}
inline CLIPFORMAT RegisterClipboardType(LPCWSTR lpszFormat) noexcept {
// Registered clipboard format values are 0xC000 through 0xFFFF.
// RegisterClipboardFormat() returns 32-bit unsigned and CLIPFORMAT is 16-bit
// unsigned so choose the low 16-bits with &.
return static_cast<CLIPFORMAT>(::RegisterClipboardFormat(lpszFormat));
}
}
namespace Scintilla::Internal {
// Forward declaration for COM interface subobjects
class ScintillaWin;
}
namespace {
/**
*/
class FormatEnumerator final : public IEnumFORMATETC {
ULONG ref;
ULONG pos;
std::vector<CLIPFORMAT> formats;
public:
FormatEnumerator(ULONG pos_, const CLIPFORMAT formats_[], size_t formatsLen_);
// IUnknown
STDMETHODIMP QueryInterface(REFIID riid, PVOID *ppv) noexcept override;
STDMETHODIMP_(ULONG)AddRef() noexcept override;
STDMETHODIMP_(ULONG)Release() noexcept override;
// IEnumFORMATETC
STDMETHODIMP Next(ULONG celt, FORMATETC *rgelt, ULONG *pceltFetched) noexcept override;
STDMETHODIMP Skip(ULONG celt) noexcept override;
STDMETHODIMP Reset() noexcept override;
STDMETHODIMP Clone(IEnumFORMATETC **ppenum) override;
};
/**
*/
class DropSource final : public IDropSource {
public:
ScintillaWin *sci = nullptr;
// IUnknown
STDMETHODIMP QueryInterface(REFIID riid, PVOID *ppv) noexcept override;
STDMETHODIMP_(ULONG)AddRef() noexcept override;
STDMETHODIMP_(ULONG)Release() noexcept override;
// IDropSource
STDMETHODIMP QueryContinueDrag(BOOL fEsc, DWORD grfKeyState) noexcept override;
STDMETHODIMP GiveFeedback(DWORD) noexcept override;
};
/**
*/
class DataObject final : public IDataObject {
public:
ScintillaWin *sci = nullptr;
// IUnknown
STDMETHODIMP QueryInterface(REFIID riid, PVOID *ppv) noexcept override;
STDMETHODIMP_(ULONG)AddRef() noexcept override;
STDMETHODIMP_(ULONG)Release() noexcept override;
// IDataObject
STDMETHODIMP GetData(FORMATETC *pFEIn, STGMEDIUM *pSTM) override;
STDMETHODIMP GetDataHere(FORMATETC *, STGMEDIUM *) noexcept override;
STDMETHODIMP QueryGetData(FORMATETC *pFE) noexcept override;
STDMETHODIMP GetCanonicalFormatEtc(FORMATETC *, FORMATETC *pFEOut) noexcept override;
STDMETHODIMP SetData(FORMATETC *, STGMEDIUM *, BOOL) noexcept override;
STDMETHODIMP EnumFormatEtc(DWORD dwDirection, IEnumFORMATETC **ppEnum) override;
STDMETHODIMP DAdvise(FORMATETC *, DWORD, IAdviseSink *, PDWORD) noexcept override;
STDMETHODIMP DUnadvise(DWORD) noexcept override;
STDMETHODIMP EnumDAdvise(IEnumSTATDATA **) noexcept override;
};
/**
*/
class DropTarget final : public IDropTarget {
public:
ScintillaWin *sci = nullptr;
// IUnknown
STDMETHODIMP QueryInterface(REFIID riid, PVOID *ppv) noexcept override;
STDMETHODIMP_(ULONG)AddRef() noexcept override;
STDMETHODIMP_(ULONG)Release() noexcept override;
// IDropTarget
STDMETHODIMP DragEnter(LPDATAOBJECT pIDataSource, DWORD grfKeyState, POINTL pt, PDWORD pdwEffect) override;
STDMETHODIMP DragOver(DWORD grfKeyState, POINTL pt, PDWORD pdwEffect) override;
STDMETHODIMP DragLeave() override;
STDMETHODIMP Drop(LPDATAOBJECT pIDataSource, DWORD grfKeyState, POINTL pt, PDWORD pdwEffect) override;
};
// InputLanguage() and SetCandidateWindowPos() are based on Chromium's IMM32Manager and InputMethodWinImm32.
// https://github.com/chromium/chromium/blob/main/ui/base/ime/win/imm32_manager.cc
// See License.txt or https://github.com/chromium/chromium/blob/main/LICENSE for license details.
// See Chromium's IMM32Manager::SetInputLanguage()
LANGID InputLanguage() noexcept {
// Retrieve the current input language from the system's keyboard layout.
// Using GetKeyboardLayoutName instead of GetKeyboardLayout, because
// the language from GetKeyboardLayout is the language under where the
// keyboard layout is installed. And the language from GetKeyboardLayoutName
// indicates the language of the keyboard layout itself.
// See crbug.com/344834.
LANGID inputLang;
WCHAR keyboard_layout[KL_NAMELENGTH];
if (::GetKeyboardLayoutNameW(keyboard_layout)) {
inputLang = static_cast<LANGID>(wcstol(&keyboard_layout[KL_NAMELENGTH >> 1], nullptr, 16));
} else {
/// TODO: Fallback to en-US?
HKL inputLocale = ::GetKeyboardLayout(0);
inputLang = LOWORD(inputLocale);
}
//Platform::DebugPrintf("InputLanguage(): %04X\n", inputLang);
return inputLang;
}
class IMContext {
HWND hwnd;
public:
HIMC hIMC;
explicit IMContext(HWND hwnd_) noexcept :
hwnd(hwnd_), hIMC(::ImmGetContext(hwnd_)) {}
// Deleted so IMContext objects can not be copied.
IMContext(const IMContext &) = delete;
IMContext(IMContext &&) = delete;
IMContext &operator=(const IMContext &) = delete;
IMContext &operator=(IMContext &&) = delete;
~IMContext() {
if (hIMC)
::ImmReleaseContext(hwnd, hIMC);
}
operator bool() const noexcept {
return hIMC != nullptr;
}
LONG GetImeCaretPos() const noexcept {
return ImmGetCompositionStringW(hIMC, GCS_CURSORPOS, nullptr, 0);
}
std::vector<BYTE> GetImeAttributes() const {
const LONG attrLen = ::ImmGetCompositionStringW(hIMC, GCS_COMPATTR, nullptr, 0);
std::vector<BYTE> attr(attrLen, 0);
::ImmGetCompositionStringW(hIMC, GCS_COMPATTR, attr.data(), static_cast<DWORD>(attr.size()));
return attr;
}
bool HasCompositionString(DWORD dwIndex) const noexcept {
return ::ImmGetCompositionStringW(hIMC, dwIndex, nullptr, 0) > 0;
}
std::wstring GetCompositionString(DWORD dwIndex) const {
const LONG byteLen = ::ImmGetCompositionStringW(hIMC, dwIndex, nullptr, 0);
std::wstring wcs(byteLen / sizeof(wchar_t), 0);
::ImmGetCompositionStringW(hIMC, dwIndex, wcs.data(), byteLen);
return wcs;
}
};
class GlobalMemory;
class ReverseArrowCursor {
HCURSOR cursor {};
UINT dpi = USER_DEFAULT_SCREEN_DPI;
public:
ReverseArrowCursor() noexcept = default;
// Deleted so ReverseArrowCursor objects can not be copied.
ReverseArrowCursor(const ReverseArrowCursor &) = delete;
ReverseArrowCursor(ReverseArrowCursor &&) = delete;
ReverseArrowCursor &operator=(const ReverseArrowCursor &) = delete;
ReverseArrowCursor &operator=(ReverseArrowCursor &&) = delete;
~ReverseArrowCursor() {
if (cursor) {
::DestroyCursor(cursor);
}
}
HCURSOR Load(UINT dpi_) noexcept {
if (cursor) {
if (dpi == dpi_) {
return cursor;
}
::DestroyCursor(cursor);
}
dpi = dpi_;
cursor = LoadReverseArrowCursor(dpi_);
return cursor ? cursor : ::LoadCursor({}, IDC_ARROW);
}
};
struct HorizontalScrollRange {
int pageWidth;
int documentWidth;
};
}
namespace Scintilla::Internal {
/**
*/
class ScintillaWin final :
public ScintillaBase {
bool lastKeyDownConsumed = false;
bool styleIdleInQueue = false;
wchar_t lastHighSurrogateChar = 0;
bool capturedMouse = false;
bool trackedMouseLeave = false;
bool cursorIsHidden = false;
bool hasOKText = false;
#if _WIN32_WINNT < _WIN32_WINNT_WIN8
SetCoalescableTimerSig SetCoalescableTimerFn = nullptr;
#endif
BOOL typingWithoutCursor = FALSE;
UINT linesPerScroll = 0; ///< Intellimouse support
UINT charsPerScroll = 0; ///< Intellimouse support
MouseWheelDelta verticalWheelDelta;
MouseWheelDelta horizontalWheelDelta;
UINT dpi = USER_DEFAULT_SCREEN_DPI;
ReverseArrowCursor reverseArrowCursor;
PRectangle rectangleClient;
HRGN hRgnUpdate {};
CLIPFORMAT cfColumnSelect;
CLIPFORMAT cfBorlandIDEBlockType;
CLIPFORMAT cfLineSelect;
CLIPFORMAT cfVSLineTag;
#if EnableDrop_VisualStudioProjectItem
CLIPFORMAT cfVSStgProjectItem;
CLIPFORMAT cfVSRefProjectItem;
#endif
#if Enable_ChromiumWebCustomMIMEDataFormat
CLIPFORMAT cfChromiumCustomMIME;
#endif
#if DebugCopyAsRichTextFormat
CLIPFORMAT cfRTF;
#endif
// supported drag & drop format
CLIPFORMAT dropFormat[MaxDragAndDropDataFormatCount];
UINT dropFormatCount;
DropSource ds;
DataObject dob;
DropTarget dt;
static HINSTANCE hInstance;
static ATOM scintillaClassAtom;
static ATOM callClassAtom;
// The current input Language ID.
LANGID inputLang = LANG_USER_DEFAULT;
bool renderTargetValid = true;
ID2D1RenderTarget *pRenderTarget = nullptr;
// rendering parameters for current monitor
HMONITOR hCurrentMonitor {};
std::unique_ptr<IDWriteRenderingParams, UnknownReleaser> defaultRenderingParams;
std::unique_ptr<IDWriteRenderingParams, UnknownReleaser> customRenderingParams;
explicit ScintillaWin(HWND hwnd) noexcept;
// ~ScintillaWin() in public section
void Finalise() noexcept override;
void SetRenderingParams(Surface *surface) const noexcept {
surface->SetRenderingParams(defaultRenderingParams.get(), customRenderingParams.get());
}
bool UpdateRenderingParams(bool force) noexcept;
void EnsureRenderTarget(HDC hdc) noexcept;
void DropRenderTarget() noexcept {
ReleaseUnknown(pRenderTarget);
}
HWND MainHWND() const noexcept {
return HwndFromWindow(wMain);
}
#if DebugDragAndDropDataFormat
void EnumDataSourceFormat(const char *tag, LPDATAOBJECT pIDataSource);
void EnumAllClipboardFormat(const char *tag);
#else
#define EnumDataSourceFormat(tag, pIDataSource)
#define EnumAllClipboardFormat(tag)
#endif
//static sptr_t DirectFunction(sptr_t ptr, UINT iMessage, uptr_t wParam, sptr_t lParam);
//static sptr_t DirectStatusFunction(sptr_t ptr, UINT iMessage, uptr_t wParam, sptr_t lParam, int *pStatus);
static LRESULT CALLBACK SWndProc(HWND hWnd, UINT iMessage, WPARAM wParam, LPARAM lParam);
static LRESULT CALLBACK CTWndProc(HWND hWnd, UINT iMessage, WPARAM wParam, LPARAM lParam);
enum : UINT_PTR {
invalidTimerID, standardTimerID, idleTimerID, fineTimerStart
};
void DisplayCursor(Window::Cursor c) noexcept override;
bool SCICALL DragThreshold(Point ptStart, Point ptNow) noexcept override;
void StartDrag() override;
static KeyMod MouseModifiers(uptr_t wParam) noexcept;
Sci::Position TargetAsUTF8(char *text) const;
Sci::Position EncodedFromUTF8(const char *utf8, char *encoded) const;
bool PaintDC(HDC hdc);
sptr_t WndPaint();
// DBCS
void ImeStartComposition();
void ImeEndComposition();
LRESULT ImeOnReconvert(LPARAM lParam);
LRESULT ImeOnDocumentFeed(LPARAM lParam) const;
sptr_t HandleCompositionWindowed(uptr_t wParam, sptr_t lParam);
sptr_t HandleCompositionInline(uptr_t wParam, sptr_t lParam);
// Korean IME always use inline mode, and use block caret in inline mode.
bool KoreanIME() const noexcept {
return PRIMARYLANGID(inputLang) == LANG_KOREAN;
}
void MoveImeCarets(Sci::Position offset) noexcept;
void DrawImeIndicator(int indicator, Sci::Position len);
void SetCandidateWindowPos();
void SelectionToHangul();
void EscapeHanja();
void ToggleHanja();
void AddWString(std::wstring_view wsv, CharacterSource charSource);
bool HandleLaTeXTabCompletion();
UINT CodePageOfDocument() const noexcept;
bool ValidCodePage(int codePage) const noexcept override;
std::string UTF8FromEncoded(std::string_view encoded) const override;
std::string EncodedFromUTF8(std::string_view utf8) const override;
std::string EncodeWString(std::wstring_view wsv) const;
sptr_t DefWndProc(Message iMessage, uptr_t wParam, sptr_t lParam) noexcept override;
void IdleWork() override;
void QueueIdleWork(WorkItems items, Sci::Position upTo) noexcept override;
bool SetIdle(bool on) noexcept override;
UINT_PTR timers[static_cast<int>(TickReason::dwell) + 1]{};
bool FineTickerRunning(TickReason reason) const noexcept override;
void FineTickerStart(TickReason reason, int millis, int tolerance) noexcept override;
void FineTickerCancel(TickReason reason) noexcept override;
void SetMouseCapture(bool on) noexcept override;
bool HaveMouseCapture() const noexcept override;
void SetTrackMouseLeaveEvent(bool on) noexcept;
void HideCursorIfPreferred() noexcept;
void UpdateBaseElements() override;
bool SCICALL PaintContains(PRectangle rc) const noexcept override;
void ScrollText(Sci::Line linesToMove) override;
void NotifyCaretMove() noexcept override;
void UpdateSystemCaret() override;
void SetVerticalScrollPos() override;
void SetHorizontalScrollPos() override;
void HorizontalScrollToClamped(int xPos);
HorizontalScrollRange GetHorizontalScrollRange() const noexcept;
bool ModifyScrollBars(Sci::Line nMax, Sci::Line nPage) override;
void NotifyChange() noexcept override;
void NotifyFocus(bool focus) override;
void SetCtrlID(int identifier) noexcept override;
int GetCtrlID() const noexcept override;
void NotifyParent(NotificationData scn) noexcept override;
void NotifyDoubleClick(Point pt, KeyMod modifiers) override;
std::unique_ptr<CaseFolder> CaseFolderForEncoding() override;
std::string CaseMapString(const std::string &s, CaseMapping caseMapping) const override;
void Copy(bool asBinary) const override;
bool CanPaste() noexcept override;
void Paste(bool asBinary) override;
void SCICALL CreateCallTipWindow(PRectangle rc) noexcept override;
#if SCI_EnablePopupMenu
void AddToPopUp(const char *label, int cmd = 0, bool enabled = true) noexcept override;
#endif
void ClaimSelection() noexcept override;
enum class CopyEncoding {
Unicode, // used in Copy & Paste, Drag & Drop
Ansi, // used in Drag & Drop for CF_TEXT
Binary, // used in Copy & Paste for asBinary
};
void GetMouseParameters() noexcept;
void CopyToGlobal(GlobalMemory &gmUnicode, const SelectionText &selectedText, CopyEncoding encoding) const;
void CopyToClipboard(const SelectionText &selectedText) const override;
void ScrollMessage(WPARAM wParam);
void HorizontalScrollMessage(WPARAM wParam);
void FullPaint();
void FullPaintDC(HDC hdc);
bool IsCompatibleDC(HDC hOtherDC) const noexcept;
DWORD EffectFromState(DWORD grfKeyState) const noexcept;
BOOL IsVisible() const noexcept;
int SetScrollInfo(int nBar, LPCSCROLLINFO lpsi, BOOL bRedraw) const noexcept;
bool GetScrollInfo(int nBar, LPSCROLLINFO lpsi) const noexcept;
bool ChangeScrollRange(int nBar, int nMin, int nMax, UINT nPage) const noexcept;
void ChangeScrollPos(int barType, Sci::Position pos);
sptr_t GetTextLength() const noexcept;
sptr_t GetText(uptr_t wParam, sptr_t lParam) const;
Window::Cursor SCICALL ContextCursor(Point pt);
#if SCI_EnablePopupMenu
sptr_t ShowContextMenu(unsigned int iMessage, uptr_t wParam, sptr_t lParam);
#endif
PRectangle GetClientRectangle() const noexcept override {
return rectangleClient;
}
void SizeWindow();
sptr_t MouseMessage(unsigned int iMessage, uptr_t wParam, sptr_t lParam);
sptr_t KeyMessage(unsigned int iMessage, uptr_t wParam, sptr_t lParam);
sptr_t FocusMessage(unsigned int iMessage, uptr_t wParam, sptr_t lParam);
sptr_t IMEMessage(unsigned int iMessage, uptr_t wParam, sptr_t lParam);
sptr_t EditMessage(unsigned int iMessage, uptr_t wParam, sptr_t lParam);
sptr_t IdleMessage(unsigned int iMessage, uptr_t wParam, sptr_t lParam);
sptr_t SciMessage(Message iMessage, uptr_t wParam, sptr_t lParam);
public:
~ScintillaWin() override;
// Deleted so ScintillaWin objects can not be copied.
ScintillaWin(const ScintillaWin &) = delete;
ScintillaWin(ScintillaWin &&) = delete;
ScintillaWin &operator=(const ScintillaWin &) = delete;
ScintillaWin &operator=(ScintillaWin &&) = delete;
// Public for benefit of Scintilla_DirectFunction
sptr_t WndProc(Message iMessage, uptr_t wParam, sptr_t lParam) override;
/// Implement IUnknown
STDMETHODIMP QueryInterface(REFIID riid, PVOID *ppv) noexcept;
STDMETHODIMP_(ULONG)AddRef() noexcept;
STDMETHODIMP_(ULONG)Release() noexcept;
/// Implement IDropTarget
STDMETHODIMP DragEnter(LPDATAOBJECT pIDataSource, DWORD grfKeyState,
POINTL pt, PDWORD pdwEffect);
STDMETHODIMP DragOver(DWORD grfKeyState, POINTL pt, PDWORD pdwEffect);
STDMETHODIMP DragLeave();
STDMETHODIMP Drop(LPDATAOBJECT pIDataSource, DWORD grfKeyState,
POINTL pt, PDWORD pdwEffect);
/// Implement important part of IDataObject
STDMETHODIMP GetData(const FORMATETC *pFEIn, STGMEDIUM *pSTM);
#if USE_WIN32_INIT_ONCE
static BOOL CALLBACK PrepareOnce(PINIT_ONCE initOnce, PVOID parameter, PVOID *lpContext) noexcept;
#else
static void PrepareOnce() noexcept;
#endif
static bool Register(HINSTANCE hInstance_) noexcept;
static bool Unregister() noexcept;
bool DragIsRectangularOK(UINT fmt) const noexcept {
return drag.rectangular && (fmt == cfColumnSelect);
}
private:
// For use in creating a system caret
bool HasCaretSizeChanged() const noexcept;
BOOL CreateSystemCaret();
BOOL DestroySystemCaret() noexcept;
HBITMAP sysCaretBitmap {};
int sysCaretWidth = 0;
int sysCaretHeight = 0;
};
HINSTANCE ScintillaWin::hInstance {};
ATOM ScintillaWin::scintillaClassAtom = 0;
ATOM ScintillaWin::callClassAtom = 0;
ScintillaWin::ScintillaWin(HWND hwnd) noexcept {
wMain = hwnd;
dpi = GetWindowDPI(hwnd);
// There does not seem to be a real standard for indicating that the clipboard
// contains a rectangular selection, so copy Developer Studio and Borland Delphi.
cfColumnSelect = RegisterClipboardType(L"MSDEVColumnSelect");
cfBorlandIDEBlockType = RegisterClipboardType(L"Borland IDE Block Type");
// Likewise for line-copy (copies a full line when no text is selected)
cfLineSelect = RegisterClipboardType(L"MSDEVLineSelect");
cfVSLineTag = RegisterClipboardType(L"VisualStudioEditorOperationsLineCutCopyClipboardTag");
#if EnableDrop_VisualStudioProjectItem
cfVSStgProjectItem = RegisterClipboardType(L"CF_VSSTGPROJECTITEMS");
cfVSRefProjectItem = RegisterClipboardType(L"CF_VSREFPROJECTITEMS");
#endif
#if Enable_ChromiumWebCustomMIMEDataFormat
cfChromiumCustomMIME = RegisterClipboardType(L"Chromium Web Custom MIME Data Format");
#endif
#if DebugCopyAsRichTextFormat
cfRTF = RegisterClipboardType(L"Rich Text Format");
#endif
UINT index = 0;
#if defined(_WIN64) && (_WIN32_WINNT < _WIN32_WINNT_WIN10)
dropFormat[index++] = CF_HDROP;
#endif
#if EnableDrop_VisualStudioProjectItem
dropFormat[index++] = cfVSStgProjectItem;
dropFormat[index++] = cfVSRefProjectItem;
#endif
#if Enable_ChromiumWebCustomMIMEDataFormat
dropFormat[index++] = cfChromiumCustomMIME;
#endif
// text format comes last
dropFormat[index++] = CF_UNICODETEXT;
dropFormat[index++] = CF_TEXT;
dropFormatCount = index;
dob.sci = this;
ds.sci = this;
dt.sci = this;
caret.period = ::GetCaretBlinkTime();
if (caret.period < 0) {
caret.period = 0;
}
// Find SetCoalescableTimer which is only available from Windows 8+
#if _WIN32_WINNT < _WIN32_WINNT_WIN8
SetCoalescableTimerFn = DLLFunctionEx<SetCoalescableTimerSig>(L"user32.dll", "SetCoalescableTimer");
#endif
vs.indicators[IndicatorUnknown] = Indicator(IndicatorStyle::Hidden, colourIME);
vs.indicators[IndicatorInput] = Indicator(IndicatorStyle::Dots, colourIME);
vs.indicators[IndicatorConverted] = Indicator(IndicatorStyle::CompositionThick, colourIME);
vs.indicators[IndicatorTarget] = Indicator(IndicatorStyle::StraightBox, colourIME);
}
ScintillaWin::~ScintillaWin() {
if (sysCaretBitmap) {
::DeleteObject(sysCaretBitmap);
sysCaretBitmap = {};
}
}
void ScintillaWin::Finalise() noexcept {
ScintillaBase::Finalise();
for (TickReason tr = TickReason::caret; tr <= TickReason::dwell;
tr = static_cast<TickReason>(static_cast<int>(tr) + 1)) {
FineTickerCancel(tr);
}
SetIdle(false);
DropRenderTarget();
::RevokeDragDrop(MainHWND());
}
bool ScintillaWin::UpdateRenderingParams(bool force) noexcept {
// see https://sourceforge.net/p/scintilla/bugs/2344/?page=2
//HWND topLevel = ::GetAncestor(MainHWND(), GA_ROOT);
HWND topLevel = ::GetParent(MainHWND()); // our main window
HMONITOR monitor = ::MonitorFromWindow(topLevel, MONITOR_DEFAULTTONEAREST);
if (!force && monitor == hCurrentMonitor && (technology == Technology::Default || defaultRenderingParams)) {
return false;
}
IDWriteRenderingParams *monitorRenderingParams = nullptr;
IDWriteRenderingParams *customClearTypeRenderingParams = nullptr;
if (technology != Technology::Default) {
const HRESULT hr = pIDWriteFactory->CreateMonitorRenderingParams(monitor, &monitorRenderingParams);
UINT clearTypeContrast = 0;
if (SUCCEEDED(hr) && ::SystemParametersInfo(SPI_GETFONTSMOOTHINGCONTRAST, 0, &clearTypeContrast, 0) != 0) {
if (clearTypeContrast >= 1000 && clearTypeContrast <= 2200) {
const FLOAT gamma = static_cast<FLOAT>(clearTypeContrast) / 1000.0f;
pIDWriteFactory->CreateCustomRenderingParams(gamma,
monitorRenderingParams->GetEnhancedContrast(),
monitorRenderingParams->GetClearTypeLevel(),
monitorRenderingParams->GetPixelGeometry(),
monitorRenderingParams->GetRenderingMode(),
&customClearTypeRenderingParams);
}
}
}
hCurrentMonitor = monitor;
defaultRenderingParams.reset(monitorRenderingParams);
customRenderingParams.reset(customClearTypeRenderingParams);
return true;
}
void ScintillaWin::EnsureRenderTarget(HDC hdc) noexcept {
if (!renderTargetValid) {
DropRenderTarget();
renderTargetValid = true;
}
if (!pRenderTarget) {
// Create a Direct2D render target.
D2D1_RENDER_TARGET_PROPERTIES drtp {};
drtp.type = D2D1_RENDER_TARGET_TYPE_DEFAULT;
drtp.dpiX = 96.0;
drtp.dpiY = 96.0;
drtp.usage = D2D1_RENDER_TARGET_USAGE_NONE;
drtp.minLevel = D2D1_FEATURE_LEVEL_DEFAULT;
if (technology == Technology::DirectWriteDC) {
// Explicit pixel format needed.
drtp.pixelFormat = D2D1::PixelFormat(DXGI_FORMAT_B8G8R8A8_UNORM, D2D1_ALPHA_MODE_IGNORE);
ID2D1DCRenderTarget *pDCRT = nullptr;
const HRESULT hr = pD2DFactory->CreateDCRenderTarget(&drtp, &pDCRT);
if (SUCCEEDED(hr)) {
pRenderTarget = pDCRT;
//D2D1::Matrix3x2F invertX = D2D1::Matrix3x2F(-1, 0, 0, 1, 0, 0);
//D2D1::Matrix3x2F moveX = D2D1::Matrix3x2F::Translation(rc.right - rc.left, 0);
//pRenderTarget->SetTransform(invertX * moveX);
} else {
//Platform::DebugPrintf("Failed CreateDCRenderTarget 0x%lx\n", hr);
pRenderTarget = nullptr;
}
} else {
drtp.pixelFormat = D2D1::PixelFormat(DXGI_FORMAT_UNKNOWN, D2D1_ALPHA_MODE_UNKNOWN);
HWND hw = MainHWND();
RECT rc;
::GetClientRect(hw, &rc);
D2D1_HWND_RENDER_TARGET_PROPERTIES dhrtp {};
dhrtp.hwnd = hw;
dhrtp.pixelSize = D2D1::SizeU(rc.right - rc.left, rc.bottom - rc.top);
dhrtp.presentOptions = (technology == Technology::DirectWriteRetain) ?
D2D1_PRESENT_OPTIONS_RETAIN_CONTENTS : D2D1_PRESENT_OPTIONS_NONE;
ID2D1HwndRenderTarget *pHwndRenderTarget = nullptr;
const HRESULT hr = pD2DFactory->CreateHwndRenderTarget(drtp, dhrtp, &pHwndRenderTarget);
if (SUCCEEDED(hr)) {
pRenderTarget = pHwndRenderTarget;
} else {
//Platform::DebugPrintf("Failed CreateHwndRenderTarget 0x%lx\n", hr);
pRenderTarget = nullptr;
}
}
// Pixmaps were created to be compatible with previous render target so
// need to be recreated.
DropGraphics();
}
if ((technology == Technology::DirectWriteDC) && pRenderTarget) {
RECT rcWindow;
::GetClientRect(MainHWND(), &rcWindow);
const HRESULT hr = static_cast<ID2D1DCRenderTarget*>(pRenderTarget)->BindDC(hdc, &rcWindow);
if (FAILED(hr)) {
//Platform::DebugPrintf("BindDC failed 0x%lx\n", hr);
DropRenderTarget();
}
}
}
void ScintillaWin::DisplayCursor(Window::Cursor c) noexcept {
if (cursorMode != CursorShape::Normal) {
c = static_cast<Window::Cursor>(cursorMode);
}
if (c == Window::Cursor::reverseArrow) {
::SetCursor(reverseArrowCursor.Load(dpi));
} else {
wMain.SetCursor(c);
}
}
bool ScintillaWin::DragThreshold(Point ptStart, Point ptNow) noexcept {
const Point ptDifference = ptStart - ptNow;
const XYPOSITION xMove = std::trunc(std::abs(ptDifference.x));
const XYPOSITION yMove = std::trunc(std::abs(ptDifference.y));
return (xMove > SystemMetricsForDpi(SM_CXDRAG, dpi)) ||
(yMove > SystemMetricsForDpi(SM_CYDRAG, dpi));
}
void ScintillaWin::StartDrag() {
inDragDrop = DragDrop::dragging;
DWORD dwEffect = 0;
dropWentOutside = true;
IDataObject *pDataObject = &dob;
IDropSource *pDropSource = &ds;
//Platform::DebugPrintf("About to DoDragDrop %p %p\n", pDataObject, pDropSource);
const HRESULT hr = ::DoDragDrop(
pDataObject,
pDropSource,
DROPEFFECT_COPY | DROPEFFECT_MOVE, &dwEffect);
//Platform::DebugPrintf("DoDragDrop = %lx\n", hr);
if (SUCCEEDED(hr)) {
if ((hr == DRAGDROP_S_DROP) && (dwEffect == DROPEFFECT_MOVE) && dropWentOutside) {
// Remove dragged out text
ClearSelection();
}
}
inDragDrop = DragDrop::none;
SetDragPosition(SelectionPosition(Sci::invalidPosition));
}
KeyMod ScintillaWin::MouseModifiers(uptr_t wParam) noexcept {
return ModifierFlags((wParam & MK_SHIFT) != 0,
(wParam & MK_CONTROL) != 0,
KeyboardIsKeyDown(VK_MENU));
}
}
namespace {
/** Map the key codes to their equivalent Keys:: form. */
constexpr Keys KeyTranslate(uptr_t keyIn) noexcept {
switch (keyIn) {
case VK_DOWN: return Keys::Down;
case VK_UP: return Keys::Up;
case VK_LEFT: return Keys::Left;
case VK_RIGHT: return Keys::Right;
case VK_HOME: return Keys::Home;
case VK_END: return Keys::End;
case VK_PRIOR: return Keys::Prior;
case VK_NEXT: return Keys::Next;
case VK_DELETE: return Keys::Delete;
case VK_INSERT: return Keys::Insert;
case VK_ESCAPE: return Keys::Escape;
case VK_BACK: return Keys::Back;
case VK_TAB: return Keys::Tab;
case VK_RETURN: return Keys::Return;
case VK_ADD: return Keys::Add;
case VK_SUBTRACT: return Keys::Subtract;
case VK_DIVIDE: return Keys::Divide;
case VK_LWIN: return Keys::Win;
case VK_RWIN: return Keys::RWin;
case VK_APPS: return Keys::Menu;
case VK_OEM_2: return static_cast<Keys>('/');
case VK_OEM_3: return static_cast<Keys>('`');
case VK_OEM_4: return static_cast<Keys>('[');
case VK_OEM_5: return static_cast<Keys>('\\');
case VK_OEM_6: return static_cast<Keys>(']');
default: return static_cast<Keys>(keyIn);
}
}
bool BoundsContains(PRectangle rcBounds, HRGN hRgnBounds, PRectangle rcCheck) noexcept {
bool contains = true;
if (!rcCheck.Empty()) {
if (!rcBounds.Contains(rcCheck)) {
contains = false;
} else if (hRgnBounds) {
// In bounding rectangle so check more accurately using region
const RECT rcw = RectFromPRectangleEx(rcCheck);
HRGN hRgnCheck = ::CreateRectRgnIndirect(&rcw);
if (hRgnCheck) {
HRGN hRgnDifference = ::CreateRectRgn(0, 0, 0, 0);
if (hRgnDifference) {
const int combination = ::CombineRgn(hRgnDifference, hRgnCheck, hRgnBounds, RGN_DIFF);
if (combination != NULLREGION) {
contains = false;
}
::DeleteRgn(hRgnDifference);
}
::DeleteRgn(hRgnCheck);
}
}
}
return contains;
}
// Simplify calling WideCharToMultiByte and MultiByteToWideChar by providing default parameters and using string view.
inline int MultiByteFromWideChar(UINT codePage, std::wstring_view wsv, LPSTR lpMultiByteStr, ptrdiff_t cbMultiByte) noexcept {
return ::WideCharToMultiByte(codePage, 0, wsv.data(), static_cast<int>(wsv.length()), lpMultiByteStr, static_cast<int>(cbMultiByte), nullptr, nullptr);
}
inline int MultiByteLenFromWideChar(UINT codePage, std::wstring_view wsv) noexcept {
return MultiByteFromWideChar(codePage, wsv, nullptr, 0);
}
inline int WideCharFromMultiByte(UINT codePage, std::string_view sv, LPWSTR lpWideCharStr, ptrdiff_t cchWideChar) noexcept {
return ::MultiByteToWideChar(codePage, 0, sv.data(), static_cast<int>(sv.length()), lpWideCharStr, static_cast<int>(cchWideChar));
}
inline int WideCharLenFromMultiByte(UINT codePage, std::string_view sv) noexcept {
return WideCharFromMultiByte(codePage, sv, nullptr, 0);
}
std::string StringEncode(const std::wstring_view wsv, int codePage) {
const int cchMulti = wsv.empty() ? 0: MultiByteLenFromWideChar(codePage, wsv);
std::string sMulti(cchMulti, '\0');
if (cchMulti) {
MultiByteFromWideChar(codePage, wsv, sMulti.data(), cchMulti);
}
return sMulti;
}
std::wstring StringDecode(const std::string_view sv, int codePage) {
const int cchWide = sv.empty() ? 0: WideCharLenFromMultiByte(codePage, sv);
std::wstring sWide(cchWide, 0);
if (cchWide) {
WideCharFromMultiByte(codePage, sv, sWide.data(), cchWide);
}
return sWide;
}
std::wstring StringMapCase(const std::wstring_view wsv, DWORD mapFlags) {
#if _WIN32_WINNT >= _WIN32_WINNT_VISTA
const int charsConverted = ::LCMapStringEx(LOCALE_NAME_USER_DEFAULT, mapFlags,
wsv.data(), static_cast<int>(wsv.length()), nullptr, 0, nullptr, nullptr, 0);
std::wstring wsConverted(charsConverted, 0);
if (charsConverted) {
::LCMapStringEx(LOCALE_NAME_USER_DEFAULT, mapFlags,
wsv.data(), static_cast<int>(wsv.length()), wsConverted.data(), charsConverted, nullptr, nullptr, 0);
}
#else
const int charsConverted = ::LCMapStringW(LOCALE_USER_DEFAULT, mapFlags,
wsv.data(), static_cast<int>(wsv.length()), nullptr, 0);
std::wstring wsConverted(charsConverted, 0);
if (charsConverted) {
::LCMapStringW(LOCALE_USER_DEFAULT, mapFlags,
wsv.data(), static_cast<int>(wsv.length()), wsConverted.data(), charsConverted);
}
#endif