Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/goswinr/avalonlog
A thread-safe and colorful text viewer based on AvalonEdit
https://github.com/goswinr/avalonlog
avalonedit console fsharp logging wpf
Last synced: about 2 months ago
JSON representation
A thread-safe and colorful text viewer based on AvalonEdit
- Host: GitHub
- URL: https://github.com/goswinr/avalonlog
- Owner: goswinr
- License: other
- Created: 2021-04-09T13:11:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-03T17:30:15.000Z (about 2 months ago)
- Last Synced: 2024-11-03T17:39:24.343Z (about 2 months ago)
- Topics: avalonedit, console, fsharp, logging, wpf
- Language: F#
- Homepage:
- Size: 373 KB
- Stars: 6
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# AvalonLog
[](https://www.nuget.org/packages/AvalonLog/)
[](./LICENSE)
AvalonLog is a fast and thread-safe WPF text log viewer for colored text. Including F# printf formatting. Based on [AvalonEditB](https://github.com/goswinr/AvalonEditB). Works on .NET Framework 4.7.2 and .NET 6.0
Thread-safe means that it can be called from any thread.
Fast means
- it buffers repeated print calls and updates the view maximum 10 times per second. see 
- Avalonedit is fast, the view is virtualized. It can easily handle thousands of lines.
### Usage
Here an short example for F# interactive in .NET Framework.
(for net7.0 you would have to use it in a project)
```fsharp
#r "PresentationCore"
#r "PresentationFramework"
#r "WindowsBase"
#r "nuget: AvalonLog"
open System.Windows
let log = new AvalonLog.AvalonLog() // The main class wrapping an Avalonedit TextEditor as append only log.
// create some printing functions by partial application:
let red = log.printfColor 255 0 0 // without newline
let blue = log.printfnColor 0 0 255 // with newline
let green = log.printfnColor 0 155 0 // with newline
// print to log using F# printf formatting
red "Hello, "
blue "World!"
red "The answer"
green " is %d." (40 + 2)
Application().Run(Window(Content=log)) // show WPF window
```
this will produce
For C# there is
```csharp
public void AppendWithBrush(SolidColorBrush br, string s)
```
and similar functions on the `AvalonLog` instance.
### Documentation
See extracted API at [fuget.org](https://www.fuget.org/packages/AvalonLog/0.14.0/lib/net472/AvalonLog.dll/AvalonLog)
### Download
AvalonLog is available as [NuGet package](https://www.nuget.org/packages/AvalonLog).
### How to build
Just run `dotnet build`
### License
MIT
Logo by [LovePik](https://lovepik.com/image-401268798/crystal-parrot-side-cartoon.html)
### Changelog
`0.16.0`
- add .IsAlive property to turn on/off the logging
`0.15.8`
- upgrade to FSharp.Core 8.0.400 to make it work for Fesh.Revit
`0.15.0`
- add Pen Utils, faster redraw, expose delay time
`0.14.0`
- AvalonEditB 2.4.0
`0.13.0`
- AvalonEditB 2.3.0
`0.12.0`
- AvalonEditB 2.2.0
`0.11.0`
- disable replace in Log
- AvalonEditB 2.1.0
`0.10.0`
- AvalonEditB 2.0.0
`0.9.1`
- AvalonEditB 1.8.0
`0.9.0`
- AvalonEditB 1.7.0
`0.8.3`
- AvalonEditB 1.6.0
`0.8.2`
- net7.0
- AvalonEditB 1.5.1
- update readme, fix typos
`0.7.2`
- fix typos in readme
`0.7.1`
- use AvalonEditB `1.4.1`
- fix typos in doc-strings
`0.7.0`
- fix crash when Log has more than 1000k characters
`0.6.0`
- fix ConditionalTextWriter
`0.5.0`
- Update to AvalonEditB `1.3.0`
- target net6.0 and net472
- fix typos in docstring
`0.4.0`
- Update to AvalonEditB `1.2.0`
- Rename `GetTextWriterIf` to `GetConditionalTextWriter`
`0.3.1`
- Update Xml doc-strings