java/sql-dk/src/info/globalcode/sql/dk/ColorfulPrintWriter.java
author František Kučera <franta-hg@frantovo.cz>
Sat, 04 Jan 2014 19:38:20 +0100
branchv_0
changeset 126 2357a9d08660
parent 59 5f745ae795a8
child 155 eb3676c6929b
permissions -rw-r--r--
Colors can be definitively turned off in constructor
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@126
    80
	private final boolean COLOR_ENABLED;
franta-hg@31
    81
	private boolean colorful = true;
franta-hg@31
    82
franta-hg@59
    83
	public void setStyle(TerminalStyle style) {
franta-hg@59
    84
		setStyle(EnumSet.of(style));
franta-hg@59
    85
	}
franta-hg@59
    86
franta-hg@31
    87
	public void setStyle(EnumSet<TerminalStyle> styles) {
franta-hg@31
    88
		printCodes(getStyleCodes(styles));
franta-hg@31
    89
	}
franta-hg@31
    90
franta-hg@31
    91
	private static int[] getStyleCodes(EnumSet<TerminalStyle> styles) {
franta-hg@31
    92
		int[] array = new int[styles.size()];
franta-hg@31
    93
		int i = 0;
franta-hg@31
    94
		for (TerminalStyle s : styles) {
franta-hg@31
    95
			array[i++] = s.getCode();
franta-hg@31
    96
		}
franta-hg@31
    97
		return array;
franta-hg@31
    98
	}
franta-hg@31
    99
franta-hg@40
   100
	/**
franta-hg@40
   101
	 * Print (usually audible) bell code (\007, \a, ^G)
franta-hg@40
   102
	 */
franta-hg@40
   103
	public void bell() {
franta-hg@40
   104
		print("\007");
franta-hg@40
   105
	}
franta-hg@40
   106
franta-hg@40
   107
	/**
franta-hg@40
   108
	 * Eat the last character
franta-hg@40
   109
	 */
franta-hg@40
   110
	public void backspace() {
franta-hg@40
   111
		print("\b");
franta-hg@40
   112
	}
franta-hg@40
   113
franta-hg@40
   114
	/**
franta-hg@40
   115
	 * Eat n last characters
franta-hg@40
   116
	 *
franta-hg@40
   117
	 * @param count n
franta-hg@40
   118
	 */
franta-hg@40
   119
	public void backspace(int count) {
franta-hg@40
   120
		for (int i = 0; i < count; i++) {
franta-hg@40
   121
			backspace();
franta-hg@40
   122
		}
franta-hg@40
   123
	}
franta-hg@40
   124
franta-hg@40
   125
	/**
franta-hg@40
   126
	 * With 100 ms delay and all colors.
franta-hg@40
   127
	 *
franta-hg@40
   128
	 * @see #printRainbow(java.lang.String, int,
franta-hg@40
   129
	 * info.globalcode.sql.dk.ColorfulPrintWriter.TerminalColor[])
franta-hg@40
   130
	 */
franta-hg@40
   131
	public void printRainbow(String string) {
franta-hg@40
   132
		printRainbow(string, 100);
franta-hg@40
   133
	}
franta-hg@40
   134
franta-hg@40
   135
	/**
franta-hg@40
   136
	 * With all colors.
franta-hg@40
   137
	 *
franta-hg@40
   138
	 * @see #printRainbow(java.lang.String, int,
franta-hg@40
   139
	 * info.globalcode.sql.dk.ColorfulPrintWriter.TerminalColor[])
franta-hg@40
   140
	 */
franta-hg@40
   141
	public void printRainbow(String string, int delay) {
franta-hg@40
   142
		printRainbow(string, delay, TerminalColor.values());
franta-hg@40
   143
	}
franta-hg@40
   144
franta-hg@40
   145
	/**
franta-hg@40
   146
	 * Prints rainbow text – (re)writes same text subsequently in given colors and then in default
franta-hg@40
   147
	 * color.
franta-hg@40
   148
	 *
franta-hg@40
   149
	 * @param string text to be printed, should not contain \n new line (then rainbow does not work
franta-hg@40
   150
	 * – use println() after printRainbow() instead)
franta-hg@40
   151
	 * @param delay delay between rewrites
franta-hg@40
   152
	 * @param colors list of colors to be used
franta-hg@40
   153
	 */
franta-hg@40
   154
	public void printRainbow(String string, int delay, TerminalColor... colors) {
franta-hg@40
   155
		for (TerminalColor c : colors) {
franta-hg@40
   156
			print(c, string);
franta-hg@40
   157
			try {
franta-hg@40
   158
				Thread.sleep(delay);
franta-hg@40
   159
			} catch (InterruptedException e) {
franta-hg@40
   160
				// no time to sleep
franta-hg@40
   161
				break;
franta-hg@40
   162
			}
franta-hg@40
   163
			backspace(string.length());
franta-hg@40
   164
			flush();
franta-hg@40
   165
		}
franta-hg@40
   166
		print(string);
franta-hg@40
   167
	}
franta-hg@40
   168
franta-hg@31
   169
	public void setForegroundColor(TerminalColor color) {
franta-hg@31
   170
		printCodes(color.getForegroundCode());
franta-hg@31
   171
	}
franta-hg@31
   172
franta-hg@31
   173
	public void setBackgroundColor(TerminalColor color) {
franta-hg@31
   174
		printCodes(color.getBackgroundCode());
franta-hg@31
   175
	}
franta-hg@31
   176
franta-hg@31
   177
	public void print(TerminalColor foregroundColor, String string) {
franta-hg@31
   178
		setForegroundColor(foregroundColor);
franta-hg@31
   179
		print(string);
franta-hg@31
   180
		resetAll();
franta-hg@31
   181
	}
franta-hg@31
   182
franta-hg@31
   183
	public void println(TerminalColor foregroundColor, String string) {
franta-hg@31
   184
		print(foregroundColor, string);
franta-hg@31
   185
		println();
franta-hg@31
   186
	}
franta-hg@31
   187
franta-hg@31
   188
	public void print(TerminalColor foregroundColor, TerminalColor backgroundColor, String string) {
franta-hg@31
   189
		setForegroundColor(foregroundColor);
franta-hg@31
   190
		setBackgroundColor(backgroundColor);
franta-hg@31
   191
		print(string);
franta-hg@31
   192
		resetAll();
franta-hg@31
   193
	}
franta-hg@31
   194
franta-hg@31
   195
	public void println(TerminalColor foregroundColor, TerminalColor backgroundColor, String string) {
franta-hg@31
   196
		print(foregroundColor, backgroundColor, string);
franta-hg@31
   197
		println();
franta-hg@31
   198
	}
franta-hg@31
   199
franta-hg@31
   200
	public void print(TerminalColor foregroundColor, TerminalColor backgroundColor, EnumSet<TerminalStyle> styles, String string) {
franta-hg@31
   201
		setForegroundColor(foregroundColor);
franta-hg@31
   202
		setBackgroundColor(backgroundColor);
franta-hg@31
   203
		setStyle(styles);
franta-hg@31
   204
		print(string);
franta-hg@31
   205
		resetAll();
franta-hg@31
   206
	}
franta-hg@31
   207
franta-hg@31
   208
	public void println(TerminalColor foregroundColor, TerminalColor backgroundColor, EnumSet<TerminalStyle> styles, String string) {
franta-hg@31
   209
		print(foregroundColor, backgroundColor, styles, string);
franta-hg@31
   210
		println();
franta-hg@31
   211
	}
franta-hg@31
   212
franta-hg@31
   213
	public void print(TerminalColor foregroundColor, TerminalColor backgroundColor, TerminalStyle style, String string) {
franta-hg@31
   214
		print(foregroundColor, backgroundColor, EnumSet.of(style), string);
franta-hg@31
   215
	}
franta-hg@31
   216
franta-hg@31
   217
	public void println(TerminalColor foregroundColor, TerminalColor backgroundColor, TerminalStyle style, String string) {
franta-hg@31
   218
		print(foregroundColor, backgroundColor, style, string);
franta-hg@31
   219
		println();
franta-hg@31
   220
	}
franta-hg@31
   221
franta-hg@31
   222
	public void print(TerminalColor foregroundColor, EnumSet<TerminalStyle> styles, String string) {
franta-hg@31
   223
		setForegroundColor(foregroundColor);
franta-hg@31
   224
		setStyle(styles);
franta-hg@31
   225
		print(string);
franta-hg@31
   226
		resetAll();
franta-hg@31
   227
	}
franta-hg@31
   228
franta-hg@31
   229
	public void println(TerminalColor foregroundColor, EnumSet<TerminalStyle> styles, String string) {
franta-hg@31
   230
		print(foregroundColor, styles, string);
franta-hg@31
   231
		println();
franta-hg@31
   232
	}
franta-hg@31
   233
franta-hg@31
   234
	public void print(TerminalColor foregroundColor, TerminalStyle style, String string) {
franta-hg@31
   235
		print(foregroundColor, EnumSet.of(style), string);
franta-hg@31
   236
	}
franta-hg@31
   237
franta-hg@31
   238
	public void println(TerminalColor foregroundColor, TerminalStyle style, String string) {
franta-hg@31
   239
		print(foregroundColor, style, string);
franta-hg@31
   240
		println();
franta-hg@31
   241
	}
franta-hg@31
   242
franta-hg@37
   243
	public void print(EnumSet<TerminalStyle> styles, String string) {
franta-hg@37
   244
		setStyle(styles);
franta-hg@37
   245
		print(string);
franta-hg@37
   246
		resetAll();
franta-hg@37
   247
	}
franta-hg@37
   248
franta-hg@37
   249
	public void println(EnumSet<TerminalStyle> styles, String string) {
franta-hg@37
   250
		print(styles, string);
franta-hg@37
   251
		println();
franta-hg@37
   252
	}
franta-hg@37
   253
franta-hg@37
   254
	public void print(TerminalStyle style, String string) {
franta-hg@37
   255
		print(EnumSet.of(style), string);
franta-hg@37
   256
	}
franta-hg@37
   257
franta-hg@37
   258
	public void println(TerminalStyle style, String string) {
franta-hg@37
   259
		print(style, string);
franta-hg@37
   260
		println();
franta-hg@37
   261
	}
franta-hg@37
   262
franta-hg@31
   263
	public void resetAll() {
franta-hg@55
   264
		printCodes(TerminalStyle.Reset.code);
franta-hg@31
   265
	}
franta-hg@31
   266
franta-hg@31
   267
	private void printCodes(int... codes) {
franta-hg@126
   268
		if (COLOR_ENABLED && colorful) {
franta-hg@31
   269
			print("\033[");
franta-hg@31
   270
			for (int i = 0; i < codes.length; i++) {
franta-hg@31
   271
				print(codes[i]);
franta-hg@31
   272
				if (i < codes.length - 1 && codes.length > 1) {
franta-hg@31
   273
					print(";");
franta-hg@31
   274
				}
franta-hg@31
   275
			}
franta-hg@31
   276
			print("m");
franta-hg@31
   277
		}
franta-hg@31
   278
	}
franta-hg@31
   279
franta-hg@126
   280
	/**
franta-hg@126
   281
	 * Colors can be switched on/off during usage of this writer.
franta-hg@126
   282
	 *
franta-hg@126
   283
	 * @return whether colors are currently turned on
franta-hg@126
   284
	 * @see #isColorEnabled()
franta-hg@126
   285
	 */
franta-hg@31
   286
	public boolean isColorful() {
franta-hg@31
   287
		return colorful;
franta-hg@31
   288
	}
franta-hg@31
   289
franta-hg@126
   290
	/**
franta-hg@126
   291
	 * Collors might be definitively disabled in constructor. If not, they can be turned on/off
franta-hg@126
   292
	 * during usage of this writer by {@linkplain #setColorful(boolean)}
franta-hg@126
   293
	 *
franta-hg@126
   294
	 * @return whether colors are allowed for this instance of this class
franta-hg@126
   295
	 * @see #isColorful()
franta-hg@126
   296
	 */
franta-hg@126
   297
	public boolean isColorEnabled() {
franta-hg@126
   298
		return COLOR_ENABLED;
franta-hg@126
   299
	}
franta-hg@126
   300
franta-hg@126
   301
	/**
franta-hg@126
   302
	 * @see #isColorful()
franta-hg@126
   303
	 * @see #isColorEnabled()
franta-hg@126
   304
	 */
franta-hg@31
   305
	public void setColorful(boolean colorful) {
franta-hg@31
   306
		this.colorful = colorful;
franta-hg@31
   307
	}
franta-hg@31
   308
franta-hg@31
   309
	public ColorfulPrintWriter(File file) throws FileNotFoundException {
franta-hg@31
   310
		super(file);
franta-hg@126
   311
		COLOR_ENABLED = true;
franta-hg@31
   312
	}
franta-hg@31
   313
franta-hg@31
   314
	public ColorfulPrintWriter(OutputStream out) {
franta-hg@31
   315
		super(out);
franta-hg@126
   316
		COLOR_ENABLED = true;
franta-hg@31
   317
	}
franta-hg@31
   318
franta-hg@31
   319
	public ColorfulPrintWriter(String fileName) throws FileNotFoundException {
franta-hg@31
   320
		super(fileName);
franta-hg@126
   321
		COLOR_ENABLED = true;
franta-hg@31
   322
	}
franta-hg@31
   323
franta-hg@31
   324
	public ColorfulPrintWriter(Writer out) {
franta-hg@31
   325
		super(out);
franta-hg@126
   326
		COLOR_ENABLED = true;
franta-hg@31
   327
	}
franta-hg@31
   328
franta-hg@31
   329
	public ColorfulPrintWriter(File file, String csn) throws FileNotFoundException, UnsupportedEncodingException {
franta-hg@31
   330
		super(file, csn);
franta-hg@126
   331
		COLOR_ENABLED = true;
franta-hg@31
   332
	}
franta-hg@31
   333
franta-hg@126
   334
	/**
franta-hg@126
   335
	 * @param colorEnabled colors might be definitively disabled by this option – this might be more
franta-hg@126
   336
	 * optimalizable than dynamic turning off colors by {@linkplain #setColorful(boolean)} which is
franta-hg@126
   337
	 * not definitive (colors can be turned on during live of this instance). This might be useful
franta-hg@126
   338
	 * if you need an instance of this class but don't need colors at all.
franta-hg@126
   339
	 */
franta-hg@126
   340
	public ColorfulPrintWriter(OutputStream out, boolean autoFlush, boolean colorEnabled) {
franta-hg@31
   341
		super(out, autoFlush);
franta-hg@126
   342
		COLOR_ENABLED = colorEnabled;
franta-hg@31
   343
	}
franta-hg@31
   344
franta-hg@31
   345
	public ColorfulPrintWriter(String fileName, String csn) throws FileNotFoundException, UnsupportedEncodingException {
franta-hg@31
   346
		super(fileName, csn);
franta-hg@126
   347
		COLOR_ENABLED = true;
franta-hg@31
   348
	}
franta-hg@31
   349
franta-hg@31
   350
	public ColorfulPrintWriter(Writer out, boolean autoFlush) {
franta-hg@31
   351
		super(out, autoFlush);
franta-hg@126
   352
		COLOR_ENABLED = true;
franta-hg@31
   353
	}
franta-hg@31
   354
}