org.fusesource.jansi.Ansi Maven / Gradle / Ivy
/**
* Copyright (C) 2009, Progress Software Corporation and/or its
* subsidiaries or affiliates. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.fusesource.jansi;
import java.util.ArrayList;
import java.util.concurrent.Callable;
/**
* Provides a fluent API for generating ANSI escape sequences.
*
* @author Hiram Chirino
* @since 1.0
*/
public class Ansi {
private static final char FIRST_ESC_CHAR = 27;
private static final char SECOND_ESC_CHAR = '[';
public static enum Color {
BLACK(0, "BLACK"),
RED(1, "RED"),
GREEN(2, "GREEN"),
YELLOW(3, "YELLOW"),
BLUE(4, "BLUE"),
MAGENTA(5, "MAGENTA"),
CYAN(6, "CYAN"),
WHITE(7,"WHITE"),
DEFAULT(9,"DEFAULT");
private final int value;
private final String name;
Color(int index, String name) {
this.value = index;
this.name = name;
}
@Override
public String toString() {
return name;
}
public int value() {
return value;
}
public int fg() {
return value + 30;
}
public int bg() {
return value + 40;
}
public int fgBright() {
return value + 90;
}
public int bgBright() {
return value + 100;
}
};
public static enum Attribute {
RESET ( 0, "RESET"),
INTENSITY_BOLD ( 1, "INTENSITY_BOLD"),
INTENSITY_FAINT ( 2, "INTENSITY_FAINT"),
ITALIC ( 3, "ITALIC_ON"),
UNDERLINE ( 4, "UNDERLINE_ON"),
BLINK_SLOW ( 5, "BLINK_SLOW"),
BLINK_FAST ( 6, "BLINK_FAST"),
NEGATIVE_ON ( 7, "NEGATIVE_ON"),
CONCEAL_ON ( 8, "CONCEAL_ON"),
STRIKETHROUGH_ON ( 9, "STRIKETHROUGH_ON"),
UNDERLINE_DOUBLE ( 21, "UNDERLINE_DOUBLE"),
INTENSITY_BOLD_OFF ( 22, "INTENSITY_BOLD_OFF"),
ITALIC_OFF ( 23, "ITALIC_OFF"),
UNDERLINE_OFF ( 24, "UNDERLINE_OFF"),
BLINK_OFF ( 25, "BLINK_OFF"),
NEGATIVE_OFF ( 27, "NEGATIVE_OFF"),
CONCEAL_OFF ( 28, "CONCEAL_OFF"),
STRIKETHROUGH_OFF ( 29, "STRIKETHROUGH_OFF");
private final int value;
private final String name;
Attribute(int index, String name) {
this.value = index;
this.name = name;
}
@Override
public String toString() {
return name;
}
public int value() {
return value;
}
};
public static enum Erase {
FORWARD(0, "FORWARD"),
BACKWARD(1, "BACKWARD"),
ALL(2, "ALL");
private final int value;
private final String name;
Erase(int index, String name) {
this.value = index;
this.name = name;
}
@Override
public String toString() {
return name;
}
public int value() {
return value;
}
};
public static final String DISABLE = Ansi.class.getName() + ".disable";
private static Callable detector = new Callable() {
public Boolean call() throws Exception {
return !Boolean.getBoolean(DISABLE);
}
};
public static void setDetector(final Callable detector) {
if (detector == null) throw new IllegalArgumentException();
Ansi.detector = detector;
}
public static boolean isDetected() {
try {
return detector.call();
}
catch (Exception e) {
return true;
}
}
private static final InheritableThreadLocal holder = new InheritableThreadLocal()
{
@Override
protected Boolean initialValue() {
return isDetected();
}
};
public static void setEnabled(final boolean flag) {
holder.set(flag);
}
public static boolean isEnabled() {
return holder.get();
}
public static Ansi ansi() {
if (isEnabled()) {
return new Ansi();
}
else {
return new NoAnsi();
}
}
private static class NoAnsi
extends Ansi
{
@Override
public Ansi fg(Color color) {
return this;
}
@Override
public Ansi bg(Color color) {
return this;
}
@Override
public Ansi a(Attribute attribute) {
return this;
}
@Override
public Ansi cursor(int x, int y) {
return this;
}
@Override
public Ansi cursorUp(int y) {
return this;
}
@Override
public Ansi cursorRight(int x) {
return this;
}
@Override
public Ansi cursorDown(int y) {
return this;
}
@Override
public Ansi cursorLeft(int x) {
return this;
}
@Override
public Ansi eraseScreen() {
return this;
}
@Override
public Ansi eraseScreen(Erase kind) {
return this;
}
@Override
public Ansi eraseLine() {
return this;
}
@Override
public Ansi eraseLine(Erase kind) {
return this;
}
@Override
public Ansi scrollUp(int rows) {
return this;
}
@Override
public Ansi scrollDown(int rows) {
return this;
}
@Override
public Ansi saveCursorPosition() {
return this;
}
@Override
public Ansi restorCursorPosition() {
return this;
}
@Override
public Ansi reset() {
return this;
}
}
private final StringBuilder builder;
private final ArrayList attributeOptions = new ArrayList(5);
public Ansi() {
this(new StringBuilder());
}
public Ansi(Ansi parent) {
this(new StringBuilder(parent.builder));
attributeOptions.addAll(parent.attributeOptions);
}
public Ansi(int size) {
this(new StringBuilder(size));
}
public Ansi(StringBuilder builder) {
this.builder = builder;
}
public static Ansi ansi(StringBuilder builder) {
return new Ansi(builder);
}
public static Ansi ansi(int size) {
return new Ansi(size);
}
public Ansi fg(Color color) {
attributeOptions.add(color.fg());
return this;
}
public Ansi bg(Color color) {
attributeOptions.add(color.bg());
return this;
}
public Ansi a(Attribute attribute) {
attributeOptions.add(attribute.value());
return this;
}
public Ansi cursor(final int x, final int y) {
return appendEscapeSequence('H', x, y);
}
public Ansi cursorUp(final int y) {
return appendEscapeSequence('A', y);
}
public Ansi cursorDown(final int y) {
return appendEscapeSequence('B', y);
}
public Ansi cursorRight(final int x) {
return appendEscapeSequence('C', x);
}
public Ansi cursorLeft(final int x) {
return appendEscapeSequence('D', x);
}
public Ansi eraseScreen() {
return appendEscapeSequence('J',Erase.ALL.value());
}
public Ansi eraseScreen(final Erase kind) {
return appendEscapeSequence('J', kind.value());
}
public Ansi eraseLine() {
return appendEscapeSequence('K');
}
public Ansi eraseLine(final Erase kind) {
return appendEscapeSequence('K', kind.value());
}
public Ansi scrollUp(final int rows) {
return appendEscapeSequence('S', rows);
}
public Ansi scrollDown(final int rows) {
return appendEscapeSequence('T', rows);
}
public Ansi saveCursorPosition() {
return appendEscapeSequence('s');
}
public Ansi restorCursorPosition() {
return appendEscapeSequence('u');
}
public Ansi reset() {
return a(Attribute.RESET);
}
public Ansi bold() {
return a(Attribute.INTENSITY_BOLD);
}
public Ansi boldOff() {
return a(Attribute.INTENSITY_BOLD_OFF);
}
public Ansi a(String value) {
flushAtttributes();
builder.append(value);
return this;
}
public Ansi a(boolean value) {
flushAtttributes();
builder.append(value);
return this;
}
public Ansi a(char value) {
flushAtttributes();
builder.append(value);
return this;
}
public Ansi a(char[] value, int offset, int len) {
flushAtttributes();
builder.append(value, offset, len);
return this;
}
public Ansi a(char[] value) {
flushAtttributes();
builder.append(value);
return this;
}
public Ansi a(CharSequence value, int start, int end) {
flushAtttributes();
builder.append(value, start, end);
return this;
}
public Ansi a(CharSequence value) {
flushAtttributes();
builder.append(value);
return this;
}
public Ansi a(double value) {
flushAtttributes();
builder.append(value);
return this;
}
public Ansi a(float value) {
flushAtttributes();
builder.append(value);
return this;
}
public Ansi a(int value) {
flushAtttributes();
builder.append(value);
return this;
}
public Ansi a(long value) {
flushAtttributes();
builder.append(value);
return this;
}
public Ansi a(Object value) {
flushAtttributes();
builder.append(value);
return this;
}
public Ansi a(StringBuffer value) {
flushAtttributes();
builder.append(value);
return this;
}
public Ansi newline() {
flushAtttributes();
builder.append(System.getProperty("line.separator"));
return this;
}
public Ansi format(String pattern, Object... args) {
flushAtttributes();
builder.append(String.format(pattern, args));
return this;
}
/**
* Uses the {@link AnsiRenderer}
* to generate the ANSI escape sequences for the supplied text.
*
* @since 1.1
* @param text
*/
public Ansi render(final String text) {
a(AnsiRenderer.render(text));
return this;
}
/**
* String formats and renders the supplied arguments. Uses the {@link AnsiRenderer}
* to generate the ANSI escape sequences.
*
* @since 1.1
* @param text
* @param args
*/
public Ansi render(final String text, Object... args) {
a(String.format(AnsiRenderer.render(text), args));
return this;
}
@Override
public String toString() {
flushAtttributes();
return builder.toString();
}
///////////////////////////////////////////////////////////////////
// Private Helper Methods
///////////////////////////////////////////////////////////////////
private Ansi appendEscapeSequence(char command) {
flushAtttributes();
builder.append(FIRST_ESC_CHAR);
builder.append(SECOND_ESC_CHAR);
builder.append(command);
return this;
}
private Ansi appendEscapeSequence(char command, int option) {
flushAtttributes();
builder.append(FIRST_ESC_CHAR);
builder.append(SECOND_ESC_CHAR);
builder.append(option);
builder.append(command);
return this;
}
private Ansi appendEscapeSequence(char command, Object... options) {
flushAtttributes();
return _appendEscapeSequence(command, options);
}
private void flushAtttributes() {
if( attributeOptions.isEmpty() )
return;
if (attributeOptions.size() == 1 && attributeOptions.get(0) == 0) {
builder.append(FIRST_ESC_CHAR);
builder.append(SECOND_ESC_CHAR);
builder.append('m');
} else {
_appendEscapeSequence('m', attributeOptions.toArray());
}
attributeOptions.clear();
}
private Ansi _appendEscapeSequence(char command, Object... options) {
builder.append(FIRST_ESC_CHAR);
builder.append(SECOND_ESC_CHAR);
int size = options.length;
for (int i = 0; i < size; i++) {
if (i != 0) {
builder.append(';');
}
if (options[i] != null) {
builder.append(options[i]);
}
}
builder.append(command);
return this;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy