Show colored messages in CMake output

[med-ayssar]

Changes:

• Replace each occurrence of message([<mode>]) with the corresponding print function, depending on the mode keyword.
• FATAL_ERROR is mapped to printError function, outputting a red colored message.
• WARNING is mapped to printWarning function, outputting a yellow colored message.
• STATUS is mapped to printInfo function, outputting a green colored message.
• A message function without a mode is replaced by the printInfo function.
• The summary phase of CMake is assigned a BoldCyan color.
• The print function in ColorMessges can be used to extend new print functions with different colors.
• Important: If the output will be written to a file, it will have escape sequences in it because they are being forced to be emitted always.

Before:

• First output lines:
  
• Summary:
  

After:

• First output lines:
  

• Summary:
  

• On Error: Setting CMAKE_INSTALL_PREFIX to an empty string!
  

[terhorstd]

@med-ayssar , could you provide a bit more description? E.g. is it sensitive to non-terminal output?

[med-ayssar]

@med-ayssar , could you provide a bit more description? E.g. is it sensitive to non-terminal output?

Can you elaborate more, what do you mean by non-terminal output.
Basically, we are assigning "FATAL_ERROR" a red color, "WARNING" a yellow color and "STATUS" or default message a green color. For The summary, I have assigned different color to distinguish it from the above mentioned colors

The functions calls responsible for outputing suchs messages are now called:

• printInfo -> green
• printWarning -> yellow
• printError -> red

All function calls to message are then replaced by the corresponding message type.

[jougs]

@med-ayssar: The description should always contain a summary of what this PR is about and why we would want it in NEST (similar to what your comment does).

Both the description and the PR name should definitely mention that this relates to the cmake stage (in contrast to the runtime phase, PyNEST, NEST, SLI, or any such thing).

The description might also benefit from an example screenshot contrasting the situation before/after the change. Also please use GitHub Flavored Markdown to highlight code like things as typewriter and make things easier to read.

[jougs]

@med-ayssar: ping!

[jougs]

Thanks for the update. I have some minor suggestions and a less minor comment.

[github-actions]

Pull request automatically marked stale!

[jougs]

@med-ayssar: could you please have a look at my comments and finalize this? I really think it is a big improvement and should go in instead of sitting here stale and half-ready :-)

[jougs]

I think I have replied to all your questions. Please have another look.
And please also merge master, so the conflicts go away. Thanks!

[jougs]

@med-ayssar: I just took the liberty to merge my suggestions into your branch 😁

@terhorstd: could you please especially look at differentiating between output to the shell and when redirected to files?

[terhorstd]

All common tools strip color codes when the output is not going to a terminal. I'm not sure how the CI handles the output, but all common highlighting seems to be still there so there is either additional highlighting, or trickery with pseudo-ttys. So I'd guess that the isatty() / test -t type of calls can be used to split to non-highlighting versions when used in a pipe or redirected to a file (see for example this StackExchange answer).

[heplesser]

@med-ayssar Could you fix the conflicts that have come up?

[jougs]

@terhorstd!

[jougs]

Due to the vacation of @terhorstd and that a) this is lying around for quite some time now, b) #2379 depends on it, and c) this is minor change that only affects the CMake output, I'm merging without the second review. Any (possible) problems with the rendering of output on the CI can be fixed in follow-up PRs.