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