Skip to content

Latest commit

 

History

History
111 lines (77 loc) · 3.98 KB

README.md

File metadata and controls

111 lines (77 loc) · 3.98 KB
Raw

This small package is intended to allow printing colored text into C++ console applications.

Before doing anything else, leave a star to this project ;).

What you would see from the console using this package:

temp

It is cross-platform and all the functionalities are contained in ColoredStream.h.

The ability to show a colored text is made possible by building and printing a ColoredText object. ColoredText extends std::stringstream adding the possibility to show colored text. Such ability is enabled when passing a ColoredText instance to a std::cout or a std::cerr for printing something into the console. On the opposite, when passing a ColoredText instance to another kind of output stream, like for instance a std::ofstream, the object behaves like a normal std::stringstream, printing normal text.

Three possible color prescriptions can be specified:

  • specify classical colors like red or yellow
  • specify a 8-bit color code
  • specify a R,G,B triplet

It is also possible to apply a specific background color: temp

The kind of color used for specifying the text (R,G,B triplet, 8-bit code, etc...) can be different from the one used for the background.

EXAMPLES

Still haven't left a star? Do it now!! ;).

Using this package is straightforward: you just need to create a ColoredText object and then pass it to std::cout (or std::cerr) for printing it. Suppose for example you want to display a red colored 'hello world', all you need to do would be this:

#include <ColoredStream/ColoredStream.h>
using namespace colored_stream;

std::cout << ColoredText{ClassicColor::RED, "Hello world"} << std::endl;

temp

and that's it!

You may also want to create an empty ColoredText instance, whose content is created step by step, before printing it:

ColoredText colored_content(ClassicColor::RED);
colored_content << "Hello ";
colored_content << "World ";
colored_content << " :-)";

std::cout << colored_content << std::endl;

temp

... or, you can pass a variadic number of inputs in order to build the object in place:

std::cout << ColoredText{ClassicColor::BLUE, "Hello ", "World ", " :-)"}
            << std::endl;

temp

You can also prescribe the background color and not only the text one:

ColoredText stream{
    Settings{}.text(ClassicColor::RED).background(Uint8Color{11}),
    "Hello World"};
std::cout << stream << std::endl;

temp

You can also decide to bind a certain color to a certain concrete std::ostream so that everything that will be passed to that stream will be rendered with a certain color. Indeed, you can use ColoredStream for this:

ColoredStream stream{ClassicColor::MAGENTA, std::cerr};
stream << "All this line was "
        << "passed to the same "
        << " ColoredStream";

stream << " ... also this from another line of code" << std::endl;

temp

The created stream will be a wrapper of the concrete passed one. Every time something is passed to the wrapper, the prescription about the text and the background color is added and then the content is actually propagated to the concrete stream.

Check the samples folder for other examples.

CMAKE SUPPORT

You can fetch this package and link to the ColoredStream library, which will expose the position of ColoredStream.h:

include(FetchContent)
FetchContent_Declare(
colored_stream
GIT_REPOSITORY https://github.com/andreacasalino/ColoredStream.git
GIT_TAG        main
)
FetchContent_MakeAvailable(colored_stream)

and then link to the ColoredStream library:

target_link_libraries(${TARGET_NAME}
    ColoredStream
)