kameloso.terminal.colours

Modules

defs

module kameloso.terminal.colours.defs

Enum definitions of ANSI codes.

tags

module kameloso.terminal.colours.tags

A collection of functions used to translate tags in messages into terminal colours.

Members

Functions

applyANSI

void applyANSI(Sink sink, uint code, ANSICodeType overrideType)

Applies an ANSI code to a passed output range.

applyTruecolour

void applyTruecolour(Sink sink, uint r, uint g, uint b, Flag!"brightTerminal" bright, Flag!"normalise" normalise)

Produces a terminal colour token for the colour passed, expressed in terms of red, green and blue, then writes it to the passed output range.

asANSI

string asANSI(uint code)

Returns an ANSI format sequence containing the passed code.

asTruecolour

string asTruecolour(string word, uint r, uint g, uint b, Flag!"brightTerminal" bright, Flag!"normalise" normalise)

Produces a terminal colour token for the colour passed, expressed in terms of red, green and blue. Convenience function to colour a piece of text without being passed an output sink to fill into.

colourByHash

auto colourByHash(string word, CoreSettings settings)

Shorthand function to colour a passed word by the hash of it.

getColourByHash

auto getColourByHash(string word, CoreSettings settings)

Hashes the passed string and picks an ANSI colour for it by modulo.

invert

string invert(string line, string toInvert, Flag!"caseSensitive" caseSensitive)

Terminal-inverts the colours of a piece of text in a string.

withANSI

string withANSI(string text, uint code, ANSICodeType overrideType)

Applies an ANSI code to a passed string and returns it as a new one. Convenience function to colour a piece of text without being passed an output sink to fill into.

Appender!(char[]) sink;

// Output range version
sink.put("Hello ");
sink.applyANSI(TerminalForeground.red, ANSICodeType.foreground);
sink.put("world!");
sink.applyANSI(TerminalForeground.default_, ANSICodeType.foreground);

with (TerminalForeground)
{
    // Normal string-returning versions
    writeln("Hello ", red.asANSI, "world!", default_.asANSI);
    writeln("H3LL0".withANSI(red), ' ', "W0RLD!".withANSI(default_));
}

// Also accepts RGB form
sink.put(" Also");
sink.applyTruecolour(128, 128, 255);
sink.put("magic");
sink.applyANSI(TerminalForeground.default_);

with (TerminalForeground)
{
    writeln("Also ", asTruecolour(128, 128, 255), "magic", default_.asANSI);
}

immutable line = "Surrounding text kameloso surrounding text";
immutable kamelosoInverted = line.invert("kameloso");
assert(line != kamelosoInverted);

immutable nicknameTint = "nickname".getColourByHash(*kameloso.common.settings);
immutable substringTint = "substring".getColourByHash(*kameloso.common.settings);

• colours

• TerminalToken

• applyMonochromeAndFlushOverrides
• ensureAppropriateBuffering
• isTTY
• isTerminal
• setConsoleModeAndCodepage
• setTitle