termcolor

Termes

TermColor est une bibliothèque C ++ d'en-tête uniquement pour imprimer des messages colorés au terminal. Écrit juste pour le plaisir avec l'aide de la force. TermColor utilise la mise en forme des couleurs ANSI, vous pouvez donc l'utiliser sur chaque système utilisé de tels terminaux (la plupart des * systèmes Nix, y compris Linux et Mac OS).

Note

Sur Windows, l'API Windows est utilisée à la place des codes d'échappement, mais certaines limitations sont appliquées (tout n'est pas pris en charge). C'est pourquoi il est recommandé d'entrer le mode de traitement des terminaux virtuels et de définir la macro TERMCOLOR_USE_ANSI_ESCAPE_SEQUENCES pour tromper TermColor pour utiliser les codes couleur ANSI.

Il est licencié en vertu de la licence BSD (3 clause). Cela signifie essentiellement: faites ce que vous voulez tant que le droit d'auteur colle.

Installation

• Ajoutez termcolor.hpp (saisissez-le de include/termcolor/termcolor.hpp ) au projet et utilisez des manipulateurs de flux de l'espace de noms termcolor .

• Vous pouvez également utiliser VCPKG pour installer la bibliothèque:

  $ vcpkg install termcolor

• Ou si vous êtes sur macOS, vous pouvez utiliser Homebrew à cette fin:

  $ brew install termcolor

• Pour des informations à jour sur les packages existants, reportez-vous à l'image suivante:

Comment utiliser?

C'est très facile à utiliser. L'idée est construite sur des manipulateurs de flux C ++. L'application «Hello World» typique ressemble à ceci:

# include < iostream >
# include < termcolor/termcolor.hpp >

int main ( int /* argc */ , char ** /* argv */ )
{
    std::cout << termcolor::red << " Hello, " ;                   // 16 colors
    std::cout << termcolor::color< 100 > << " Colorful " ;          // 256 colors
    std::cout << termcolor::color< 211 , 54 , 130 > << " World! " ;    // true colors
    std::cout << std::endl;
    return 0 ;
}

L'application ci-dessus imprime une chaîne en utilisant différentes couleurs. Il y a cependant une mise en garde. Vous ne devez pas oublier de réinitialiser les couleurs, sinon ils seront également appliqués à d'autres impressions.

std::cout << termcolor::red << " Hello, Colorful World! " << std::endl;
std::cout << " I'm RED too! " << std::endl;

La version correcte du code ci-dessus devrait ressembler à ceci:

std::cout << termcolor::red << " Hello, Colorful World! " << termcolor::reset << std::endl;
std::cout << termcolor::reset << " Here I'm! " << std::endl;

Par défaut, TermColor ignore toutes les couleurs pour les flux non-tty (par exemple std::stringstream ), donc l'extrait suivant

std::stringstream ss;
ss << termcolor::red << " unicorn " ;
std::cout << ss.str();

Imprimera «Unicorn» en utilisant la couleur par défaut, pas le rouge. Afin de modifier ce comportement, on peut utiliser termcolor::colorize manipulateur qui applique les couleurs quoi qu'il arrive.

Quels manipulateurs sont soutenus?

Les manipulateurs sont divisés en quatre groupes:

• premier plan , qui modifie la couleur du texte;
• arrière-plan , qui modifie la couleur du fond du texte;
• attributs , qui modifient un style de texte (gras, souligne, etc.);
• contrôle , qui modifie le comportement de TermColor.

De plus, il existe des manipulateurs de couleurs pour 16 couleurs, 256 couleurs et des palettes de vraies couleurs.

Note

Bien que termcolor prenne en charge la vraie couleur, il est nécessaire pour l'émulateur de terminal que vous utilisez pour exécuter votre logiciel pour prendre en charge la vraie couleur. Assurez-vous donc qu'il est pris en charge avant de déposer un problème.

Manipulateurs de premier plan

16 couleurs

1. termcolor::grey
2. termcolor::red
3. termcolor::green
4. termcolor::yellow
5. termcolor::blue
6. termcolor::magenta
7. termcolor::cyan
8. termcolor::white
9. termcolor::bright_grey
10. termcolor::bright_red
11. termcolor::bright_green
12. termcolor::bright_yellow
13. termcolor::bright_blue
14. termcolor::bright_magenta
15. termcolor::bright_cyan
16. termcolor::bright_white

256 couleurs

1. termcolor::color<256_COLOR_CODE>

vraies couleurs

1. termcolor::color<RED, GREEN, BLUE>

Manipulateurs de fond

16 couleurs

1. termcolor::on_grey
2. termcolor::on_red
3. termcolor::on_green
4. termcolor::on_yellow
5. termcolor::on_blue
6. termcolor::on_magenta
7. termcolor::on_cyan
8. termcolor::on_white
9. termcolor::on_bright_grey
10. termcolor::on_bright_red
11. termcolor::on_bright_green
12. termcolor::on_bright_yellow
13. termcolor::on_bright_blue
14. termcolor::on_bright_magenta
15. termcolor::on_bright_cyan
16. termcolor::on_bright_white

256 couleurs

1. termcolor::on_color<256_COLOR_CODE>

vraies couleurs

1. termcolor::on_color<RED, GREEN, BLUE>

Manipulateurs d'attribut

(L'API Windows ne prend pas en charge ces manipulateurs sauf pour underline )

1. termcolor::bold
2. termcolor::dark
3. termcolor::italic
4. termcolor::underline
5. termcolor::blink
6. termcolor::reverse
7. termcolor::concealed
8. termcolor::crossed

Manipulateurs de contrôle

(L'API Windows ne prend pas en charge ces manipulateurs)

1. termcolor::colorize
2. termcolor::nocolorize

Mises en garde

1. Sur Windows, en raison de l'utilisation interne de <windows.h> , l'espace de noms global pourrait être pollué avec des macros min / max. Si un tel effet est souhaitable, veuillez envisager d'utiliser #define NOMINMAX avant #include <termcolor.hpp> .