#ANSI

The rsp/output modules comes with support for ANSI, which will allow you to format and style your console output.

#How to enable / disable

To enable ANSI output, set the RSP_ENABLE_ANSI option to true, when importing this project. By default, the option is set to false.

CPMAddPackage(
    NAME                rsp-cmake-scripts
    GITHUB_REPOSITORY   "https://github.com/rsps/cmake-scripts.git"
    VERSION             x.y.z
    OPTIONS
        "RSP_ENABLE_ANSI true"
    # ...remaining not shown ...
)

#Example

Once you have enabled ANSI for your project, then you can use a series of predefined properties (ANSI escape sequences) are available throughout your cmake scripts. These can be used to format your console output messages.

message("${COLOR_GREEN}${TEXT_ITALIC}Build success${RESTORE}, for ${PROJECT_NAME}")

The above shown example should output a message, where the first part is in green coloured, and italic styled text. The second part should be in normal styled text.

Build success, for < your-cmake-project-name >

#Restore

Use the RESTORE (ESC[0m) property if you wish to reset any previous set colour or style.

message("${TEXT_BOLD}Component:${RESTORE} ready")

Component: ready

#Text Styles

The following shows the default preset text styles:

#Colours

The following default foreground and background colours are supported:

#Your own styles

To customise the default preset, set the RSP_ANSI_PRESET list property, before including the rsp/output module, and before enabling ANSI. Use the following format for declaring your own styles and colours:

"<variable> <code>[|<code>]..." 

• <variable>: name of your style or colour.
• <code>: control sequence code.
• |: separator (when you define a style that uses multiple codes)

if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
    # Define your own ANSI preset...
    set(RSP_ANSI_PRESET
        "RESTORE 0"

        "MY_STYLE 1|31|23" # Set style to bold, italic, and red foreground.

        "TEXT_BOLD 1"
        "TEXT_DIM 2"

        # ... remaining not shown ...

        # RECOMMENDED: you should cache your preset!
        CACHE STRING "My custom ANSI preset"
    )
    
    include("rsp/output")
    
    enable_ansi()
endif()