https://github.com/lostincompilation/cmake-message-with-color
A small CMake helper file to add color formatting functionality to CMake's message()
https://github.com/lostincompilation/cmake-message-with-color
cmake cmake-color cmake-scripts color colorization formatted-output formatted-text message
Last synced: 4 months ago
JSON representation
A small CMake helper file to add color formatting functionality to CMake's message()
- Host: GitHub
- URL: https://github.com/lostincompilation/cmake-message-with-color
- Owner: LostInCompilation
- License: zlib
- Created: 2024-07-07T17:52:06.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-06T05:39:33.000Z (about 1 year ago)
- Last Synced: 2025-04-12T22:56:46.774Z (about 1 year ago)
- Topics: cmake, cmake-color, cmake-scripts, color, colorization, formatted-output, formatted-text, message
- Language: CMake
- Homepage:
- Size: 99.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# CMake Print Colored Text
A small and easy to use helper to include in your CMake build system to have colored text output, independent of the used Terminal or operating system.
## Contents
- [Description](#description)
- [Usage](#usage)
- [Printing a message with one color](#printing-a-message-with-one-color)
- [Printing only parts of the message with color and/or styles](#printing-only-parts-of-the-message-with-color-andor-styles)
- [Using multiple colors in one message](#using-multiple-colors-in-one-message)
- [Supported colors and styles](#supported-colors-and-styles)
*See also: [License (zlib)](LICENSE.md)*
## Description
The normal `message(...)` command in CMake sadly doesn't support custom colors or styles for messages. With this helper file you can print messages with colors, have multiple colors in one message, or only have parts of the message printed with color, while the rest of the text in the same line is printed normally.
This helper **does not** use ANSI escape codes directly to print the colors and styles. It is fully compatible with every Terminal and every operating system.
## Usage
Just copy the file `colorFormatting.cmake` next to your ***CMakeLists.txt*** and include it in your ***CMakeLists.txt***:
```cmake
include("colorFormatting.cmake")
```
### Printing a message with one color
To print the whole message with one color and/or style you can use the `messageWithColor(...)` function:
```cmake
messageWithColor(COLOR BLUE "My message with blue color")
```
#### Only bold
To print a message using bold text style and no color change use this argument:
```cmake
messageWithColor(BOLD "My message in bold text")
```
#### Color and bold
The bold style can be combined with colors:
```cmake
messageWithColor(BOLD COLOR GREEN "My message in bold text and green color")
```
### Printing only parts of the message with color and/or styles
To print a part of the message with colors and/or styles, there is another function called `colorFormatText(...)`. It takes the same arguments as `messageWithColor(...)`, but doesn't print anything directly.
Instead `colorFormatText(...)` sets the variable `COLOR_FORMATTED_TEXT` that you can print yourself. This way you can append unformatted text to formatted text:
```cmake
# Formatted text is saved in COLOR_FORMATTED_TEXT
colorFormatText(COLOR GREEN "This is green:")
# Print the formatted text and append unformatted text
message("${COLOR_FORMATTED_TEXT} This is without color")
```
Result
### Using multiple colors in one message
To print a message with multiple colors and/or styles, you can use the `colorFormatTextAppend(...)` function. It takes the same arguments as `colorFormatText(...)`, but doesn't print anything on it's own.
Instead it *appends* the given string to the `COLOR_FORMATTED_TEXT_COMBINED` variable, that you can print yourself:
```cmake
# Append multiple strings with different colors and styles
colorFormatTextAppend(COLOR RED "This is ")
colorFormatTextAppend(COLOR GREEN "a multicolor ")
colorFormatTextAppend(BOLD COLOR BLUE "message ")
colorFormatTextAppend(COLOR MAGENTA "test")
# Print the combined string with multiple colors
message("${COLOR_FORMATTED_TEXT_COMBINED}")
```
Result
## Supported colors and styles
| Color | Style |
|:-------:|:-------:|
| NORMAL BLACK RED GREEN YELLOW BLUE MAGENTA CYAN WHITE | BOLD |
**NOTE:** If an invalid color argument is passed to any of the above functions, the text will be printed without any color change. *No error message is printed.*