e5e068c28d
The HeightTree is the data structure that maps between document line numbers and visual Y positions. It handles both the varying heights of lines (e.g. due to word-wrapping) and the collapsing of lines (e.g. due to folding). Where the old implementation was based on a red-black tree, the new implementation is inspired by B+ trees. We no longer need a separate memory allocation for every line in the document. This should dramatically reduce the memory consumption: a comment in the old code indicated that each line took 56 bytes of memory. But that was in 32-bit days; in a 64-bit process the old implementation actually needed 88 bytes per line. The new implementation should need 168 bytes per leaf node which holds 8-16 lines, i.e. we need 10.5-21 bytes per line for the leaf nodes. It additionally needs 456 bytes per inner node (for the inner node and its children array). The level just above the leafs holds 64-256 lines per inner node, i.e. we need 1.8-7.2 bytes per line for the second level. Thus the total memory consumption of the new tree should in the worst case still be below 29.2 bytes per line (`168/8 + sum(456/(8**lvl) for lvl in range(2,100))`). However after freshly loading a large document from disk we should be close to the best case which in total is just 12.4 bytes per line (`168/16 + sum(456/(16**lvl) for lvl in range(2,100))`). Apart from the reduced memory usage, the behavior of the new tree should be identical to the old behavior. In particular, all operations (line insertion, line deletion, collapsing, uncollapsing, line<->Y queries) maintain their externally-visible behavior and their O(lg N) run-time. set_DefaultLineHeight runs in O(N) now (previously could take O(N lg N)). |
||
---|---|---|
.github/workflows | ||
BuildTools | ||
Documentation | ||
ICSharpCode.AvalonEdit | ||
ICSharpCode.AvalonEdit.Sample | ||
ICSharpCode.AvalonEdit.Tests | ||
ThirdParty-Highlightings | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
ChangeLog.md | ||
ICSharpCode.AvalonEdit.Documentation.sln | ||
ICSharpCode.AvalonEdit.sln | ||
LICENSE | ||
README.md | ||
global.json |
README.md
AvalonEdit
AvalonEdit is the name of the WPF-based text editor in SharpDevelop 4.x "Mirador" and beyond. It is also being used in ILSpy and many other projects.
Downloads
AvalonEdit is available as NuGet package. Usage details, documentation and more can be found on the AvalonEdit homepage
How to build
AvalonEdit is targeting net6.0-windows, net5.0-windows, netcoreapp3.1, net40 and net45 TFMs. Because of net6.0-windows you must have the .NET 6.0 SDK installed on your machine. Visual Studio 2022 Community and up is required for working with the solution (global.json will select the proper SDK to use for building for you).
Documentation
Check out the official documentation and the samples and articles wiki page
To build the Documentation you need to install Sandcastle from https://github.com/EWSoftware/SHFB/releases (currently validated tooling is v2021.4.9.0)
The build of the Documentation can take very long, please be patient.
License
AvalonEdit is distributed under the MIT License.
Projects using AvalonEdit
A good place to start are the "top 10" listed under GitHub Usage for the AvalonEdit package on NuGet.
- https://github.com/icsharpcode/ILSpy/ ILSpy .NET decompiler
- https://github.com/KirillOsenkov/MSBuildStructuredLog A logger for MSBuild
- https://github.com/aelij/RoslynPad RoslynPad
- https://github.com/huangjia2107/XamlViewer LightWeight Xaml Editor
Note: if your project is not listed here, let us know! :)