Refactor: New Logging framework

[sillydan1]

New Logging Framework

This PR adds a revamp of the log-tab panel(s). Providing a much more extendable and unified way for notifying the user with information, warnings and errors.

Screen.Recording.2022-11-12.at.14.33.04.mov

How to use

Using the logging framework is easy, thread-safe and reactive!

Anatomy of a log entry

UUID id,                // autogenerated uuid
String service,         // service that produced the service
String message,         // information about what happened
LogLevel level          // Info/Warn/Error level

Add Entries

The basic usage - simply add new logs:

Log.addInfo("Some information")
Log.addWarning("Some warning");
Log.addError("Some error");

Origin Service

If the log originates from somewhere that is not an internal place (i.e. jecdar, uppaal, codeanalysis or some custom program), you can specify what service generated the log:

var myService = "NotHuppaal";
Log.addInfo(myService, "Some information")
Log.addWarning(myService, "Some warning");
Log.addError(myService, "Some error");

Links

You can add inline links to your log message, markdown style:

Log.addWarning("Something is wrong at location [L23](component:MyComponent/L23). Please check it out");

A link can link to many types of things:

// location regex:      [text](location:ComponentName/LocationId)
// edge regex:          [text](edge:ComponentName/EdgeId)
// subcomponent regex:  [text](subcomponent:ComponentName/SubcomponentId)
// jork regex:          [text](jork:ComponentName/JorkId)
// tag regex:           [text](tag:ComponentName/TagId)
// query regex:         [text](query:QueryId)
// component regex:     [text](component:ComponentName)
// file:                [text](generic:filename) (open OS default app)

On Log Entry Events

You can also add event listeners for when new logs are added:

private void subscribeOnLogAdded() {
    Log.addOnLogAddedListener(this::onLogAdded);
}

private void onLogAdded(Log log) {
    // Your code here...
}

Note that the events are being called on the main javafx thread - so you don't need to perform any Platform.runLater operations in your handlers.

Backwards Compatibility

You may notice that this PR doesn't remove the old tabs. This is on purpose. Links to locations doesn't actually work at the moment, since classes in the dk.cs.aau.huppaal.abstractions.* (everything that is a Nearable implementation) doesn't know who their parent component is, so they can't actually create any (working) clickable links. Because of this, I haven't implemented all syntactic elements in the LogLinkQuantifier enumeration.

I have integrated all static functions from CodeAnalysis to also use the new logging framework. I haven't deleted the old code though.

[sillydan1]

Update: current implementations of Nearable will be linked correctly (the old tabs are still present, but I am fairly sure they could be removed pretty soon):

Screen.Recording.2022-11-15.at.22.16.53.mov

[Nielswps]

Really cool feature and a very nice graphical representation. Good job 👍

The comments are primarily about improvements to the readability of the code.

[Nielswps]

Thanks for implementing the suggestions and explaining some of the features. The PR looks ready to merch 😁 👍