colorize 1.0.5

A port of Ruby's colorize library to D.


To use this package, put the following dependency into your project's dependencies section:

dub.json
dub.sdl

d-colorize

Build Status Gitter chat


A partial port of Ruby's colorize library to D.

To put it simply, this is a simple helper for printing colored output to a terminal.

Installing

This package is registered in the dub registry as colorize.

Usage

import colorize : fg, color, cwriteln, cwritefln;

void main()
{
  cwriteln("This is blue".color(fg.blue));

  auto c = "red";
  cwritefln("This is %s".color(c), c);
}

Supporting cross-platform color printing

Colorize exports functions for wrapping strings around ANSI color escape sequences. Simply printing these strings should work fine for any UNIX system. However, for "colorized" printing to work on Windows, it's necessary to use one of the exported helper printing functions, provided by p0nce, also in this module.

Colorizing output works by using the color API described below and for Windows compatibility, we provide functions which parse the escape sequences and call appropriate system-level. On all platforms other than Windows, these functions should work just as their std.stdio counterparts.

These are:

cwrite

void cwrite(T...)(T args) if (!is(T[0] : File))
With an overloaded version for File output:
void cwrite(S...)(File f, S args)

cwritef

void cwritef(Char, T...)(in Char[] fmt, T args) if (!is(T[0] : File))
With an overloaded version for File output:
void cwritef(Char, A...)(File f, in Char[] fmt, A args)

cwriteln

void cwriteln(T...)(T args)

cwritefln

void cwritefln(Char, T...)(in Char[] fmt, T args)

Setting background, foreground and text modes:

string color(
  const string str,
  const fg c,
  const bg b=bg.init,
  const mode m=mode.init
) pure;

Wraps a string around color escape sequences.

Params

  • str = The string to wrap with colors and modes
  • c = The foreground color (see the fg enum type)
  • b = The background color (see the bg enum type)
  • m = The text mode (see the mode enum type)

Example

color("This is red over green blinking", fg.blue, bg.green, mode.blink)

Setting background colors:

string color(const string str, const bg b) pure; // alias to background

Wraps a string around a background color escape sequence.

Params

  • str = The string to wrap with background color b
  • b = The background color (see the bg enum type)

Example

color("This has a blue background", bg.blue);
background("This has a red background", bg.red);

Setting text modes:

string color(const string str, const mode m) pure; // alias to `style`

Wraps a string around a text mode.

Params

  • str = The string to wrap with style m
  • m = The text mode (see the mode enum type)

Example

color("This text is bold", mode.bold);
style("This text is blinking", mode.blink);

Coloring with strings:

string color(const string str, const string name) pure;

Wraps a string around the foreground color, background color or text style represented by the color name. Foreground colors are represented by their enum key ("blue" will be 34, "red" 31, and so on) and backgrounds/modes are prefixed with either "bg_" or "mode_" (thus, "bg_black" will be 40, "mode_bold" 1 and so on).

Example

color("This text is blue", "blue");
"This is red over blue, blinking"
  .color("red")
  .color("bg_blue")
  .color("mode_blue");

Params

Available colors and modes

fg enum type (Foreground colors)

Foreground text colors are available through the fg enum. Currently available colors are:

  • fg.init (39)
  • fg.black (30)
  • fg.red (31)
  • fg.green (32)
  • fg.yellow (33)
  • fg.blue (34)
  • fg.magenta (35)
  • fg.cyan (36)
  • fg.white (37)
  • fg.light_black (90)
  • fg.light_red (91)
  • fg.light_green (92)
  • fg.light_yellow (93)
  • fg.light_blue (94)
  • fg.light_magenta (95)
  • fg.light_cyan (96)
  • fg.light_white (97)

bg enum type (Background colors)

Background colors are available with the same names through the bg enum. This is because background colors come with an offset of 10 to their foreground counterparts and we wanted to avoid calculating the offset at runtime.

mode enum type (Text modes)

Text modes are available through the mode enum. Currently available text modes are:

  • mode.init (0)
  • mode.bold (1)
  • mode.underline (4)
  • mode.blink (5)
  • mode.swap (7)
  • mode.hide (8)

License

Copyright (c) 2014 Pedro Tacla Yamada. Licensed under the MIT license. Please refer to the LICENSE file for more info.

Authors:Pedro Tacla Yamada, ponce

Dependencies: none

Versions:
1.0.5 2014-Aug-05
1.0.4 2014-Aug-05
1.0.3 2014-Aug-05
1.0.2 2014-Aug-01
1.0.1 2014-Jul-31
Show all 12 versions
Stats:

statistics are temporarily disabled.