BufferLine rewrite [WIP] #4928
Open
BufferLine rewrite [WIP] #4928
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The new data structure is more flexible and more compact. However, mapping column number to cell information is no longer O(1). So we use a cursor as much as possible to reduce the need for that. This is an early check-in to have a backup and baseline. A few basic things work but it is NOT READY FOR USE.
Fix some bugs. Add simple grapheme support.
- Store character values in _data array. Get rid of _text string. (In progress.) This is likely to be faster. - Add a cache in BufferLine for the current position. (In progress.) - Re-implement loadCell to use above cache. - Revert DOM renderer to use laodCell. (webgl and canvas renderer s still to do.)
Replace fg, bg, and eAttrs parameters by single IAttributeData parameter. In addition to making for a simpler/cleaner API, it also increases flexibility for future CellData or BufferLine changes. (Rename function to reduce risk of using accidentally using old function.) Also removed redundant eraseAttr parameter in deleteCells, insertCells, and replaceCells.
Also add some optimizations.
Using the per-BufferLine cache in loadCell should make this reasonably performant.
InputHandler.print just calls insertText, without a loop. (WIP)
Use it in insertText and deleteCells.
Get rid of some old cursor stuff in favor of buffer-local cache.
Controlled by USE_NewBufferLine variable
(Still a bug with extra lines sometimes being added.)
New classes LogicalBufferLine and WrappedBufferLine.
This reflows the lines and calculates WrapperBufferLine offsets. It does *not* yet handle updating y, ybase, ydist, calling onDeleteEmitter handler, and similar tasks.
Add RowColumn and LineColumn type aliases for documentation.
This constrols USE_NewBufferLine.
Also fix some lint failures.
New CellData.fromChar method intended to replace CellData.fromCharData. Fix logic errors in erasecells and deletecellsOnly. Fixes to InputHandler.print when wrapping - still needs work. Change _cachedStyleFlagsIndex so -1 (not 0) is "none".
Also extended-underline testcase.
Handle soft line breaks in the middle of SKIP_COLUMNS. Change showData to take columns bounds rather than data index bounds.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR implements #4800. It also sort-of implements #4232 - it does reflow lazily, though it doesn't specifically use the "idle callbacks". Motivation is described in #4800; however, the implementation is different (though the same basic idea).
The
NewBufferLineimplementation is enabled if thenewBufferLineoption is true; otherwise the old implementation (renamed toOldBufferLine) is used. The goal is to merge the PR withnewBufferLinedefaulting to false to avoid breaking things, but allowing adventurous users and developers to trynewBufferLineset to true. (Some more testing will be needed even for thenewBufferLinefalse case; I believe there are regressions.)Note that
NewBufferLineis abstract and has two implementation classes:LogicalBufferLinerepresents an unwrapped line, but it also contains the data for following wrapped lines.WrappedBufferLinerepresents a wrapped line (duh) and basically just indirects to the previousLogicalBufferLine.Operations that are O(1) in
OldBufferLinemay require linear scanning inNewBufferLine. However,LogicalBufferLinehas a cache (mapping column index to_dataarray index) to avoid linear scanning for common operations. There is some needless overhead in the interest of minimizing API changes.Later, the
newBufferLinedefault will change to true. Later still, we will remove the support forOldBufferLineandNewBufferLinewill be renamed to plainBufferLine.The
AbstractBufferLineclass is intended as a parent for both[New]BufferLineand future classes for "other" content. Specifically, general HTML "paragraphs" (<div>elements) are planned.Tasks that must be done before merger:
oldBufferLineregressions. (Minor barely-measurable performance regressions may be OK.)Tasks that must be done before defaulting to
newBufferLinetrue:IExtendedAttrshandling is incomplete (though basic data structure support is there).imageaddon doesn't work. It uses custom classes that textually copy the old classes.