Add a Logger class

[alkino]

No description provided.

[bbpbuildbot]

Logfiles from GitLab pipeline #230747 (:no_entry:) have been uploaded here!

Status and direct links:

• ⛔ mac_m1_cmake_build: [cmake, ON, OFF, OFF, address]
• ✅ spack_setup
• ✅ build:nmodl
• ⛔ build:neuron:nmodl:intel:legacy
• ⛔ build:neuron:nmodl:intel:shared
• ⛔ build:neuron:nmodl:nvhpc:acc:legacy
• ⛔ build:neuron:nmodl:nvhpc:acc:shared
• ⛔ build:neuron:nmodl:nvhpc:omp:legacy
• ⛔ build:neuron:nmodl:nvhpc:omp
• ⏩ test:neuron:nmodl:intel:legacy
• ⏩ test:neuron:nmodl:intel:shared
• ⏩ test:neuron:nmodl:nvhpc:acc:legacy
• ⏩ test:neuron:nmodl:nvhpc:acc:shared
• ⏩ test:neuron:nmodl:nvhpc:omp:legacy
• ⏩ test:neuron:nmodl:nvhpc:omp

[alkino]

@1uc About your general comment, I want to keep this class simple and my future plan is to have more kind of output. error, warning, fatal, ...

How should we handle this debug going to stderr? I want to keep it simple.

[azure-pipelines]

✔️ be9c98d -> Azure artifacts URL

[azure-pipelines]

✔️ f8182ca -> Azure artifacts URL

[1uc]

I think there's two (or three) abstractions:

1. An interface for writing to files/streams. This interface needs to supports injecting a callback that intercepts stderr and stdout and sends them to whatever matlab or jupyter want.
2. If the prior can't/wont also do formatting, then the previous becomes a lot more low-level; and there's a need for an API that accepts a formattable string (along with the arguments). It formats and calls the first API.
3. The second big concept is the Logger. The logger requires the user to pick a severity level (that ideally can be silenced, etc); and takes away their choices using stderr vs stdcout. Since we already have strict requirements about redirecting, I'd say, we don't want the logger to have a callback (even though this is otherwise common), i.e. it uses API from Point 1 (or 2). Something else loggers do is they often modify the message, i.e. by adding severity markers, e.g. ERROR: {}, or filename/linenumber/timestamp information: ERROR: foo.cpp:11 {}.

The current implementation requires us to use the logger to write to std::cout. This includes things like pretty printing datastructures or other things that are not logging, but just regular program output. This type of output we also want to intercept and redirect. To do this we need Abstraction 1; otherwise we either have multiple implementations of the callback; or abuse the logger.

[azure-pipelines]

✔️ 434ade7 -> Azure artifacts URL

[azure-pipelines]

✔️ bfe9e18 -> Azure artifacts URL

[azure-pipelines]

✔️ 3163fdb -> Azure artifacts URL

[sonarcloud]

Quality Gate passed

Issues
15 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[azure-pipelines]

✔️ e4b2f91 -> Azure artifacts URL