blob: 730853d2cefcc08ac98722693a47bf505e6642dc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
/*
Ousía
Copyright (C) 2014 Benjamin Paaßen, Andreas Stöckel
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @file Terminal.hpp
*
* Classes for printing colored output to a terminal.
*
* @author Andreas Stöckel (astoecke@techfak.uni-bielefeld.de)
*/
#ifndef _OUSIA_TERMINAL_HPP_
#define _OUSIA_TERMINAL_HPP_
#include <string>
namespace ousia {
/**
* The Terminal class contains some helper functions used to interact with the
* terminal as used for colorful output when logging error messages.
*
* TODO: Disable on Windows or use corresponding API-functions for setting the
* color.
* TODO: Give output stream to terminal/use terminal as output stream
*/
class Terminal {
private:
/**
* If set to false, no control codes are generated.
*/
bool useColor;
public:
/**
* ANSI color code for black.
*/
static const int BLACK = 30;
/**
* ANSI color code for red.
*/
static const int RED = 31;
/**
* ANSI color code for green.
*/
static const int GREEN = 32;
/**
* ANSI color code for yellow.
*/
static const int YELLOW = 33;
/**
* ANSI color code for blue.
*/
static const int BLUE = 34;
/**
* ANSI color code for magenta.
*/
static const int MAGENTA = 35;
/**
* ANSI color code for cyan.
*/
static const int CYAN = 36;
/**
* ANSI color code for white.
*/
static const int WHITE = 37;
/**
* Creates a new instance of the Terminal class.
*
* @param useColor specifies whether color codes should be generated.
*/
Terminal(bool useColor) : useColor(useColor) {}
/**
* Returns a control string for switching to the given color.
*
* @param color is the color the terminal should switch to.
* @param bright specifies whether the terminal should switch to the bright
* mode.
* @return a control string to be included in the output stream.
*/
std::string color(int color, bool bright = true) const;
/**
* Returns a control string for switching to the bright mode.
*
* @return a control string to be included in the output stream.
*/
std::string bright() const;
/**
* Returns a control string for switching to the default mode.
*
* @return a control string to be included in the output stream.
*/
std::string reset() const;
};
}
#endif /* _OUSIA_TERMINAL_HPP_ */
|
