annotate .cms/lib/codemirror/src/display/scrolling.js @ 0:78edf6b517a0 draft

24.10
author Coffee CMS <info@coffee-cms.ru>
date Fri, 11 Oct 2024 22:40:23 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
1 import { Pos } from "../line/pos.js"
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
2 import { cursorCoords, displayHeight, displayWidth, estimateCoords, paddingTop, paddingVert, scrollGap, textHeight } from "../measurement/position_measurement.js"
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
3 import { gecko, phantom } from "../util/browser.js"
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
4 import { elt } from "../util/dom.js"
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
5 import { signalDOMEvent } from "../util/event.js"
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
6
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
7 import { startWorker } from "./highlight_worker.js"
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
8 import { alignHorizontally } from "./line_numbers.js"
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
9 import { updateDisplaySimple } from "./update_display.js"
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
10
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
11 // SCROLLING THINGS INTO VIEW
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
12
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
13 // If an editor sits on the top or bottom of the window, partially
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
14 // scrolled out of view, this ensures that the cursor is visible.
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
15 export function maybeScrollWindow(cm, rect) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
16 if (signalDOMEvent(cm, "scrollCursorIntoView")) return
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
17
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
18 let display = cm.display, box = display.sizer.getBoundingClientRect(), doScroll = null
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
19 let doc = display.wrapper.ownerDocument
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
20 if (rect.top + box.top < 0) doScroll = true
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
21 else if (rect.bottom + box.top > (doc.defaultView.innerHeight || doc.documentElement.clientHeight)) doScroll = false
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
22 if (doScroll != null && !phantom) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
23 let scrollNode = elt("div", "\u200b", null, `position: absolute;
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
24 top: ${rect.top - display.viewOffset - paddingTop(cm.display)}px;
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
25 height: ${rect.bottom - rect.top + scrollGap(cm) + display.barHeight}px;
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
26 left: ${rect.left}px; width: ${Math.max(2, rect.right - rect.left)}px;`)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
27 cm.display.lineSpace.appendChild(scrollNode)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
28 scrollNode.scrollIntoView(doScroll)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
29 cm.display.lineSpace.removeChild(scrollNode)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
30 }
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
31 }
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
32
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
33 // Scroll a given position into view (immediately), verifying that
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
34 // it actually became visible (as line heights are accurately
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
35 // measured, the position of something may 'drift' during drawing).
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
36 export function scrollPosIntoView(cm, pos, end, margin) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
37 if (margin == null) margin = 0
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
38 let rect
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
39 if (!cm.options.lineWrapping && pos == end) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
40 // Set pos and end to the cursor positions around the character pos sticks to
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
41 // If pos.sticky == "before", that is around pos.ch - 1, otherwise around pos.ch
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
42 // If pos == Pos(_, 0, "before"), pos and end are unchanged
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
43 end = pos.sticky == "before" ? Pos(pos.line, pos.ch + 1, "before") : pos
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
44 pos = pos.ch ? Pos(pos.line, pos.sticky == "before" ? pos.ch - 1 : pos.ch, "after") : pos
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
45 }
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
46 for (let limit = 0; limit < 5; limit++) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
47 let changed = false
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
48 let coords = cursorCoords(cm, pos)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
49 let endCoords = !end || end == pos ? coords : cursorCoords(cm, end)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
50 rect = {left: Math.min(coords.left, endCoords.left),
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
51 top: Math.min(coords.top, endCoords.top) - margin,
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
52 right: Math.max(coords.left, endCoords.left),
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
53 bottom: Math.max(coords.bottom, endCoords.bottom) + margin}
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
54 let scrollPos = calculateScrollPos(cm, rect)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
55 let startTop = cm.doc.scrollTop, startLeft = cm.doc.scrollLeft
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
56 if (scrollPos.scrollTop != null) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
57 updateScrollTop(cm, scrollPos.scrollTop)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
58 if (Math.abs(cm.doc.scrollTop - startTop) > 1) changed = true
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
59 }
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
60 if (scrollPos.scrollLeft != null) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
61 setScrollLeft(cm, scrollPos.scrollLeft)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
62 if (Math.abs(cm.doc.scrollLeft - startLeft) > 1) changed = true
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
63 }
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
64 if (!changed) break
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
65 }
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
66 return rect
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
67 }
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
68
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
69 // Scroll a given set of coordinates into view (immediately).
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
70 export function scrollIntoView(cm, rect) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
71 let scrollPos = calculateScrollPos(cm, rect)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
72 if (scrollPos.scrollTop != null) updateScrollTop(cm, scrollPos.scrollTop)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
73 if (scrollPos.scrollLeft != null) setScrollLeft(cm, scrollPos.scrollLeft)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
74 }
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
75
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
76 // Calculate a new scroll position needed to scroll the given
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
77 // rectangle into view. Returns an object with scrollTop and
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
78 // scrollLeft properties. When these are undefined, the
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
79 // vertical/horizontal position does not need to be adjusted.
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
80 function calculateScrollPos(cm, rect) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
81 let display = cm.display, snapMargin = textHeight(cm.display)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
82 if (rect.top < 0) rect.top = 0
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
83 let screentop = cm.curOp && cm.curOp.scrollTop != null ? cm.curOp.scrollTop : display.scroller.scrollTop
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
84 let screen = displayHeight(cm), result = {}
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
85 if (rect.bottom - rect.top > screen) rect.bottom = rect.top + screen
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
86 let docBottom = cm.doc.height + paddingVert(display)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
87 let atTop = rect.top < snapMargin, atBottom = rect.bottom > docBottom - snapMargin
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
88 if (rect.top < screentop) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
89 result.scrollTop = atTop ? 0 : rect.top
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
90 } else if (rect.bottom > screentop + screen) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
91 let newTop = Math.min(rect.top, (atBottom ? docBottom : rect.bottom) - screen)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
92 if (newTop != screentop) result.scrollTop = newTop
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
93 }
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
94
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
95 let gutterSpace = cm.options.fixedGutter ? 0 : display.gutters.offsetWidth
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
96 let screenleft = cm.curOp && cm.curOp.scrollLeft != null ? cm.curOp.scrollLeft : display.scroller.scrollLeft - gutterSpace
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
97 let screenw = displayWidth(cm) - display.gutters.offsetWidth
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
98 let tooWide = rect.right - rect.left > screenw
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
99 if (tooWide) rect.right = rect.left + screenw
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
100 if (rect.left < 10)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
101 result.scrollLeft = 0
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
102 else if (rect.left < screenleft)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
103 result.scrollLeft = Math.max(0, rect.left + gutterSpace - (tooWide ? 0 : 10))
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
104 else if (rect.right > screenw + screenleft - 3)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
105 result.scrollLeft = rect.right + (tooWide ? 0 : 10) - screenw
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
106 return result
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
107 }
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
108
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
109 // Store a relative adjustment to the scroll position in the current
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
110 // operation (to be applied when the operation finishes).
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
111 export function addToScrollTop(cm, top) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
112 if (top == null) return
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
113 resolveScrollToPos(cm)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
114 cm.curOp.scrollTop = (cm.curOp.scrollTop == null ? cm.doc.scrollTop : cm.curOp.scrollTop) + top
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
115 }
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
116
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
117 // Make sure that at the end of the operation the current cursor is
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
118 // shown.
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
119 export function ensureCursorVisible(cm) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
120 resolveScrollToPos(cm)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
121 let cur = cm.getCursor()
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
122 cm.curOp.scrollToPos = {from: cur, to: cur, margin: cm.options.cursorScrollMargin}
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
123 }
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
124
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
125 export function scrollToCoords(cm, x, y) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
126 if (x != null || y != null) resolveScrollToPos(cm)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
127 if (x != null) cm.curOp.scrollLeft = x
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
128 if (y != null) cm.curOp.scrollTop = y
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
129 }
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
130
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
131 export function scrollToRange(cm, range) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
132 resolveScrollToPos(cm)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
133 cm.curOp.scrollToPos = range
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
134 }
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
135
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
136 // When an operation has its scrollToPos property set, and another
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
137 // scroll action is applied before the end of the operation, this
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
138 // 'simulates' scrolling that position into view in a cheap way, so
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
139 // that the effect of intermediate scroll commands is not ignored.
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
140 function resolveScrollToPos(cm) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
141 let range = cm.curOp.scrollToPos
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
142 if (range) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
143 cm.curOp.scrollToPos = null
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
144 let from = estimateCoords(cm, range.from), to = estimateCoords(cm, range.to)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
145 scrollToCoordsRange(cm, from, to, range.margin)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
146 }
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
147 }
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
148
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
149 export function scrollToCoordsRange(cm, from, to, margin) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
150 let sPos = calculateScrollPos(cm, {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
151 left: Math.min(from.left, to.left),
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
152 top: Math.min(from.top, to.top) - margin,
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
153 right: Math.max(from.right, to.right),
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
154 bottom: Math.max(from.bottom, to.bottom) + margin
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
155 })
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
156 scrollToCoords(cm, sPos.scrollLeft, sPos.scrollTop)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
157 }
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
158
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
159 // Sync the scrollable area and scrollbars, ensure the viewport
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
160 // covers the visible area.
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
161 export function updateScrollTop(cm, val) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
162 if (Math.abs(cm.doc.scrollTop - val) < 2) return
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
163 if (!gecko) updateDisplaySimple(cm, {top: val})
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
164 setScrollTop(cm, val, true)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
165 if (gecko) updateDisplaySimple(cm)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
166 startWorker(cm, 100)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
167 }
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
168
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
169 export function setScrollTop(cm, val, forceScroll) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
170 val = Math.max(0, Math.min(cm.display.scroller.scrollHeight - cm.display.scroller.clientHeight, val))
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
171 if (cm.display.scroller.scrollTop == val && !forceScroll) return
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
172 cm.doc.scrollTop = val
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
173 cm.display.scrollbars.setScrollTop(val)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
174 if (cm.display.scroller.scrollTop != val) cm.display.scroller.scrollTop = val
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
175 }
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
176
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
177 // Sync scroller and scrollbar, ensure the gutter elements are
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
178 // aligned.
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
179 export function setScrollLeft(cm, val, isScroller, forceScroll) {
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
180 val = Math.max(0, Math.min(val, cm.display.scroller.scrollWidth - cm.display.scroller.clientWidth))
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
181 if ((isScroller ? val == cm.doc.scrollLeft : Math.abs(cm.doc.scrollLeft - val) < 2) && !forceScroll) return
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
182 cm.doc.scrollLeft = val
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
183 alignHorizontally(cm)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
184 if (cm.display.scroller.scrollLeft != val) cm.display.scroller.scrollLeft = val
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
185 cm.display.scrollbars.setScrollLeft(val)
Coffee CMS <info@coffee-cms.ru>
parents:
diff changeset
186 }