java/sql-dk/src/info/globalcode/sql/dk/ColorfulPrintWriter.java
author František Kučera <franta-hg@frantovo.cz>
Wed, 25 Dec 2013 00:43:06 +0100
branchv_0
changeset 55 f5ed7c4efacc
parent 40 a9db7fb3ce65
child 59 5f745ae795a8
permissions -rw-r--r--
colorful logging
franta-hg@31
     1
/**
franta-hg@31
     2
 * SQL-DK
franta-hg@31
     3
 * Copyright © 2013 František Kučera (frantovo.cz)
franta-hg@31
     4
 *
franta-hg@31
     5
 * This program is free software: you can redistribute it and/or modify
franta-hg@31
     6
 * it under the terms of the GNU General Public License as published by
franta-hg@31
     7
 * the Free Software Foundation, either version 3 of the License, or
franta-hg@31
     8
 * (at your option) any later version.
franta-hg@31
     9
 *
franta-hg@31
    10
 * This program is distributed in the hope that it will be useful,
franta-hg@31
    11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
franta-hg@31
    12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
franta-hg@31
    13
 * GNU General Public License for more details.
franta-hg@31
    14
 *
franta-hg@31
    15
 * You should have received a copy of the GNU General Public License
franta-hg@31
    16
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
franta-hg@31
    17
 */
franta-hg@31
    18
package info.globalcode.sql.dk;
franta-hg@31
    19
franta-hg@31
    20
import java.io.File;
franta-hg@31
    21
import java.io.FileNotFoundException;
franta-hg@31
    22
import java.io.OutputStream;
franta-hg@31
    23
import java.io.PrintWriter;
franta-hg@31
    24
import java.io.UnsupportedEncodingException;
franta-hg@31
    25
import java.io.Writer;
franta-hg@31
    26
import java.util.EnumSet;
franta-hg@31
    27
franta-hg@31
    28
/**
franta-hg@31
    29
 *
franta-hg@31
    30
 * @author Ing. František Kučera (frantovo.cz)
franta-hg@31
    31
 */
franta-hg@31
    32
public class ColorfulPrintWriter extends PrintWriter {
franta-hg@31
    33
franta-hg@31
    34
	public enum TerminalColor {
franta-hg@31
    35
franta-hg@31
    36
		Black(30, 40),
franta-hg@31
    37
		Red(31, 41),
franta-hg@31
    38
		Green(32, 42),
franta-hg@31
    39
		Yellow(33, 43),
franta-hg@31
    40
		Blue(34, 44),
franta-hg@31
    41
		Magenta(35, 45),
franta-hg@31
    42
		Cyan(36, 46),
franta-hg@31
    43
		White(37, 47);
franta-hg@31
    44
		private final int foregroundCode;
franta-hg@31
    45
		private final int backgroundCode;
franta-hg@31
    46
franta-hg@31
    47
		private TerminalColor(int foregroundCode, int backgroundCode) {
franta-hg@31
    48
			this.foregroundCode = foregroundCode;
franta-hg@31
    49
			this.backgroundCode = backgroundCode;
franta-hg@31
    50
		}
franta-hg@31
    51
franta-hg@31
    52
		public int getForegroundCode() {
franta-hg@31
    53
			return foregroundCode;
franta-hg@31
    54
		}
franta-hg@31
    55
franta-hg@31
    56
		public int getBackgroundCode() {
franta-hg@31
    57
			return backgroundCode;
franta-hg@31
    58
		}
franta-hg@31
    59
	}
franta-hg@31
    60
franta-hg@31
    61
	public enum TerminalStyle {
franta-hg@31
    62
franta-hg@31
    63
		Reset(0),
franta-hg@31
    64
		Bright(1),
franta-hg@31
    65
		Dim(2),
franta-hg@31
    66
		Underscore(4),
franta-hg@31
    67
		Blink(5),
franta-hg@31
    68
		Reverse(7),
franta-hg@31
    69
		Hidden(8);
franta-hg@31
    70
		private int code;
franta-hg@31
    71
franta-hg@31
    72
		private TerminalStyle(int code) {
franta-hg@31
    73
			this.code = code;
franta-hg@31
    74
		}
franta-hg@31
    75
franta-hg@31
    76
		public int getCode() {
franta-hg@31
    77
			return code;
franta-hg@31
    78
		}
franta-hg@31
    79
	}
franta-hg@31
    80
	private boolean colorful = true;
franta-hg@31
    81
franta-hg@31
    82
	public void setStyle(EnumSet<TerminalStyle> styles) {
franta-hg@31
    83
		printCodes(getStyleCodes(styles));
franta-hg@31
    84
	}
franta-hg@31
    85
franta-hg@31
    86
	private static int[] getStyleCodes(EnumSet<TerminalStyle> styles) {
franta-hg@31
    87
		int[] array = new int[styles.size()];
franta-hg@31
    88
		int i = 0;
franta-hg@31
    89
		for (TerminalStyle s : styles) {
franta-hg@31
    90
			array[i++] = s.getCode();
franta-hg@31
    91
		}
franta-hg@31
    92
		return array;
franta-hg@31
    93
	}
franta-hg@31
    94
franta-hg@40
    95
	/**
franta-hg@40
    96
	 * Print (usually audible) bell code (\007, \a, ^G)
franta-hg@40
    97
	 */
franta-hg@40
    98
	public void bell() {
franta-hg@40
    99
		print("\007");
franta-hg@40
   100
	}
franta-hg@40
   101
franta-hg@40
   102
	/**
franta-hg@40
   103
	 * Eat the last character
franta-hg@40
   104
	 */
franta-hg@40
   105
	public void backspace() {
franta-hg@40
   106
		print("\b");
franta-hg@40
   107
	}
franta-hg@40
   108
franta-hg@40
   109
	/**
franta-hg@40
   110
	 * Eat n last characters
franta-hg@40
   111
	 *
franta-hg@40
   112
	 * @param count n
franta-hg@40
   113
	 */
franta-hg@40
   114
	public void backspace(int count) {
franta-hg@40
   115
		for (int i = 0; i < count; i++) {
franta-hg@40
   116
			backspace();
franta-hg@40
   117
		}
franta-hg@40
   118
	}
franta-hg@40
   119
franta-hg@40
   120
	/**
franta-hg@40
   121
	 * With 100 ms delay and all colors.
franta-hg@40
   122
	 *
franta-hg@40
   123
	 * @see #printRainbow(java.lang.String, int,
franta-hg@40
   124
	 * info.globalcode.sql.dk.ColorfulPrintWriter.TerminalColor[])
franta-hg@40
   125
	 */
franta-hg@40
   126
	public void printRainbow(String string) {
franta-hg@40
   127
		printRainbow(string, 100);
franta-hg@40
   128
	}
franta-hg@40
   129
franta-hg@40
   130
	/**
franta-hg@40
   131
	 * With all colors.
franta-hg@40
   132
	 *
franta-hg@40
   133
	 * @see #printRainbow(java.lang.String, int,
franta-hg@40
   134
	 * info.globalcode.sql.dk.ColorfulPrintWriter.TerminalColor[])
franta-hg@40
   135
	 */
franta-hg@40
   136
	public void printRainbow(String string, int delay) {
franta-hg@40
   137
		printRainbow(string, delay, TerminalColor.values());
franta-hg@40
   138
	}
franta-hg@40
   139
franta-hg@40
   140
	/**
franta-hg@40
   141
	 * Prints rainbow text – (re)writes same text subsequently in given colors and then in default
franta-hg@40
   142
	 * color.
franta-hg@40
   143
	 *
franta-hg@40
   144
	 * @param string text to be printed, should not contain \n new line (then rainbow does not work
franta-hg@40
   145
	 * – use println() after printRainbow() instead)
franta-hg@40
   146
	 * @param delay delay between rewrites
franta-hg@40
   147
	 * @param colors list of colors to be used
franta-hg@40
   148
	 */
franta-hg@40
   149
	public void printRainbow(String string, int delay, TerminalColor... colors) {
franta-hg@40
   150
		for (TerminalColor c : colors) {
franta-hg@40
   151
			print(c, string);
franta-hg@40
   152
			try {
franta-hg@40
   153
				Thread.sleep(delay);
franta-hg@40
   154
			} catch (InterruptedException e) {
franta-hg@40
   155
				// no time to sleep
franta-hg@40
   156
				break;
franta-hg@40
   157
			}
franta-hg@40
   158
			backspace(string.length());
franta-hg@40
   159
			flush();
franta-hg@40
   160
		}
franta-hg@40
   161
		print(string);
franta-hg@40
   162
	}
franta-hg@40
   163
franta-hg@31
   164
	public void setForegroundColor(TerminalColor color) {
franta-hg@31
   165
		printCodes(color.getForegroundCode());
franta-hg@31
   166
	}
franta-hg@31
   167
franta-hg@31
   168
	public void setBackgroundColor(TerminalColor color) {
franta-hg@31
   169
		printCodes(color.getBackgroundCode());
franta-hg@31
   170
	}
franta-hg@31
   171
franta-hg@31
   172
	public void print(TerminalColor foregroundColor, String string) {
franta-hg@31
   173
		setForegroundColor(foregroundColor);
franta-hg@31
   174
		print(string);
franta-hg@31
   175
		resetAll();
franta-hg@31
   176
	}
franta-hg@31
   177
franta-hg@31
   178
	public void println(TerminalColor foregroundColor, String string) {
franta-hg@31
   179
		print(foregroundColor, string);
franta-hg@31
   180
		println();
franta-hg@31
   181
	}
franta-hg@31
   182
franta-hg@31
   183
	public void print(TerminalColor foregroundColor, TerminalColor backgroundColor, String string) {
franta-hg@31
   184
		setForegroundColor(foregroundColor);
franta-hg@31
   185
		setBackgroundColor(backgroundColor);
franta-hg@31
   186
		print(string);
franta-hg@31
   187
		resetAll();
franta-hg@31
   188
	}
franta-hg@31
   189
franta-hg@31
   190
	public void println(TerminalColor foregroundColor, TerminalColor backgroundColor, String string) {
franta-hg@31
   191
		print(foregroundColor, backgroundColor, string);
franta-hg@31
   192
		println();
franta-hg@31
   193
	}
franta-hg@31
   194
franta-hg@31
   195
	public void print(TerminalColor foregroundColor, TerminalColor backgroundColor, EnumSet<TerminalStyle> styles, String string) {
franta-hg@31
   196
		setForegroundColor(foregroundColor);
franta-hg@31
   197
		setBackgroundColor(backgroundColor);
franta-hg@31
   198
		setStyle(styles);
franta-hg@31
   199
		print(string);
franta-hg@31
   200
		resetAll();
franta-hg@31
   201
	}
franta-hg@31
   202
franta-hg@31
   203
	public void println(TerminalColor foregroundColor, TerminalColor backgroundColor, EnumSet<TerminalStyle> styles, String string) {
franta-hg@31
   204
		print(foregroundColor, backgroundColor, styles, string);
franta-hg@31
   205
		println();
franta-hg@31
   206
	}
franta-hg@31
   207
franta-hg@31
   208
	public void print(TerminalColor foregroundColor, TerminalColor backgroundColor, TerminalStyle style, String string) {
franta-hg@31
   209
		print(foregroundColor, backgroundColor, EnumSet.of(style), string);
franta-hg@31
   210
	}
franta-hg@31
   211
franta-hg@31
   212
	public void println(TerminalColor foregroundColor, TerminalColor backgroundColor, TerminalStyle style, String string) {
franta-hg@31
   213
		print(foregroundColor, backgroundColor, style, string);
franta-hg@31
   214
		println();
franta-hg@31
   215
	}
franta-hg@31
   216
franta-hg@31
   217
	public void print(TerminalColor foregroundColor, EnumSet<TerminalStyle> styles, String string) {
franta-hg@31
   218
		setForegroundColor(foregroundColor);
franta-hg@31
   219
		setStyle(styles);
franta-hg@31
   220
		print(string);
franta-hg@31
   221
		resetAll();
franta-hg@31
   222
	}
franta-hg@31
   223
franta-hg@31
   224
	public void println(TerminalColor foregroundColor, EnumSet<TerminalStyle> styles, String string) {
franta-hg@31
   225
		print(foregroundColor, styles, string);
franta-hg@31
   226
		println();
franta-hg@31
   227
	}
franta-hg@31
   228
franta-hg@31
   229
	public void print(TerminalColor foregroundColor, TerminalStyle style, String string) {
franta-hg@31
   230
		print(foregroundColor, EnumSet.of(style), string);
franta-hg@31
   231
	}
franta-hg@31
   232
franta-hg@31
   233
	public void println(TerminalColor foregroundColor, TerminalStyle style, String string) {
franta-hg@31
   234
		print(foregroundColor, style, string);
franta-hg@31
   235
		println();
franta-hg@31
   236
	}
franta-hg@31
   237
franta-hg@37
   238
	public void print(EnumSet<TerminalStyle> styles, String string) {
franta-hg@37
   239
		setStyle(styles);
franta-hg@37
   240
		print(string);
franta-hg@37
   241
		resetAll();
franta-hg@37
   242
	}
franta-hg@37
   243
franta-hg@37
   244
	public void println(EnumSet<TerminalStyle> styles, String string) {
franta-hg@37
   245
		print(styles, string);
franta-hg@37
   246
		println();
franta-hg@37
   247
	}
franta-hg@37
   248
franta-hg@37
   249
	public void print(TerminalStyle style, String string) {
franta-hg@37
   250
		print(EnumSet.of(style), string);
franta-hg@37
   251
	}
franta-hg@37
   252
franta-hg@37
   253
	public void println(TerminalStyle style, String string) {
franta-hg@37
   254
		print(style, string);
franta-hg@37
   255
		println();
franta-hg@37
   256
	}
franta-hg@37
   257
franta-hg@31
   258
	public void resetAll() {
franta-hg@55
   259
		printCodes(TerminalStyle.Reset.code);
franta-hg@31
   260
	}
franta-hg@31
   261
franta-hg@31
   262
	private void printCodes(int... codes) {
franta-hg@31
   263
		if (colorful) {
franta-hg@31
   264
			print("\033[");
franta-hg@31
   265
			for (int i = 0; i < codes.length; i++) {
franta-hg@31
   266
				print(codes[i]);
franta-hg@31
   267
				if (i < codes.length - 1 && codes.length > 1) {
franta-hg@31
   268
					print(";");
franta-hg@31
   269
				}
franta-hg@31
   270
			}
franta-hg@31
   271
			print("m");
franta-hg@31
   272
		}
franta-hg@31
   273
	}
franta-hg@31
   274
franta-hg@31
   275
	public boolean isColorful() {
franta-hg@31
   276
		return colorful;
franta-hg@31
   277
	}
franta-hg@31
   278
franta-hg@31
   279
	public void setColorful(boolean colorful) {
franta-hg@31
   280
		this.colorful = colorful;
franta-hg@31
   281
	}
franta-hg@31
   282
franta-hg@31
   283
	public ColorfulPrintWriter(File file) throws FileNotFoundException {
franta-hg@31
   284
		super(file);
franta-hg@31
   285
	}
franta-hg@31
   286
franta-hg@31
   287
	public ColorfulPrintWriter(OutputStream out) {
franta-hg@31
   288
		super(out);
franta-hg@31
   289
	}
franta-hg@31
   290
franta-hg@31
   291
	public ColorfulPrintWriter(String fileName) throws FileNotFoundException {
franta-hg@31
   292
		super(fileName);
franta-hg@31
   293
	}
franta-hg@31
   294
franta-hg@31
   295
	public ColorfulPrintWriter(Writer out) {
franta-hg@31
   296
		super(out);
franta-hg@31
   297
	}
franta-hg@31
   298
franta-hg@31
   299
	public ColorfulPrintWriter(File file, String csn) throws FileNotFoundException, UnsupportedEncodingException {
franta-hg@31
   300
		super(file, csn);
franta-hg@31
   301
	}
franta-hg@31
   302
franta-hg@31
   303
	public ColorfulPrintWriter(OutputStream out, boolean autoFlush) {
franta-hg@31
   304
		super(out, autoFlush);
franta-hg@31
   305
	}
franta-hg@31
   306
franta-hg@31
   307
	public ColorfulPrintWriter(String fileName, String csn) throws FileNotFoundException, UnsupportedEncodingException {
franta-hg@31
   308
		super(fileName, csn);
franta-hg@31
   309
	}
franta-hg@31
   310
franta-hg@31
   311
	public ColorfulPrintWriter(Writer out, boolean autoFlush) {
franta-hg@31
   312
		super(out, autoFlush);
franta-hg@31
   313
	}
franta-hg@31
   314
}