Module: DataMetaXtra::AnsiCtl

Includes:: Glyphs

Defined in:: lib/dataMetaXtra/ansi.rb

Overview

ANSI control sequences.

Constant Summary collapse

SKIP_ANSI_ESC = Skip ANSI Escape sequences unless this env var is defined and set to ‘yes’

ENV['DATAMETA_USE_ANSI_CTL'] != 'yes'

OP = ANSI escape operation start

SKIP_ANSI_ESC ? '' : 27.chr + '['

ATRB_DIV = ANSI atribute divider. When the ANSI seqs are disabled, this takes care of concatenating those.

SKIP_ANSI_ESC ? '' : ';'

PLAIN = Plain text

SKIP_ANSI_ESC ? '' : '0'

RESET = Reset sequence

SKIP_ANSI_ESC ? '' : "#{OP}m"

BOLD = Styles: Bold

SKIP_ANSI_ESC ? '' : '1'

DIM = Dimmed

SKIP_ANSI_ESC ? '' : '2'

ULINE = Underline

SKIP_ANSI_ESC ? '' : '4'

BLINK = Blinking

SKIP_ANSI_ESC ? '' : '5'

REVERSE = Reverse graphics

SKIP_ANSI_ESC ? '' : '7'

HIDDEN = Hidden text - to enter passwords

SKIP_ANSI_ESC ? '' : '8'

REBOLD = Reset Bold

SKIP_ANSI_ESC ? '' : "2#{BOLD}"

REDIM = Reset Dim

SKIP_ANSI_ESC ? '' : "2#{DIM}"

REULINE = Reset Underline

SKIP_ANSI_ESC ? '' : "2#{ULINE}"

REBLINK = Reset Blink

SKIP_ANSI_ESC ? '' : "2#{BLINK}"

REREVERSE = Reset reverse graphics

SKIP_ANSI_ESC ? '' : "2#{REVERSE}"

REHIDDEN = Reset hidden text

SKIP_ANSI_ESC ? '' : "2#{HIDDEN}"

F_DEF = Foregrounds: Default foreground

SKIP_ANSI_ESC ? '' : '39'

F_BLACK = Black foreground

SKIP_ANSI_ESC ? '' : '30'

F_RED = Red foreground

SKIP_ANSI_ESC ? '' : '31'

F_GREEN = Green foreground

SKIP_ANSI_ESC ? '' : '32'

F_BROWN = Brown foreground

SKIP_ANSI_ESC ? '' : '33'

F_YELLOW = Yellow, alias for BROWN foreground

SKIP_ANSI_ESC ? '' : F_BROWN

F_BLUE = blue foreground

SKIP_ANSI_ESC ? '' : '34'

F_PURPLE = Purple foreground

SKIP_ANSI_ESC ? '' : '35'

F_MAGENTA = Magenta, alias or PURPLE foreground

SKIP_ANSI_ESC ? '' : F_PURPLE

F_CYAN = Cyan foreground

SKIP_ANSI_ESC ? '' : '36'

F_LGREY = Light Grey foreground

SKIP_ANSI_ESC ? '' : '37'

F_LGRAY = Light Gray, alias for GREY foreground

SKIP_ANSI_ESC ? '' : F_LGREY

F_DGREY = Dark Grey foreground

SKIP_ANSI_ESC ? '' : '90'

F_DGRAY = Dark Gray, alias for GRAY foreground

SKIP_ANSI_ESC ? '' : F_DGREY

F_LRED = Light Red foreground

SKIP_ANSI_ESC ? '' : '91'

F_LGREEN = Light Green foreground

SKIP_ANSI_ESC ? '' : '92'

F_LBROWN = Light Brown foreground

SKIP_ANSI_ESC ? '' : '93'

F_LYELLOW = Light Yellow, alias for BROWN foreground

SKIP_ANSI_ESC ? '' : F_LBROWN

F_LBLUE = Light Blue foreground

SKIP_ANSI_ESC ? '' : '94'

F_LPURPLE = Light Purple foreground

SKIP_ANSI_ESC ? '' : '95'

F_LMAGENTA = Light Magenta, alias for PURPLE foreground

SKIP_ANSI_ESC ? '' : F_LPURPLE

F_LCYAN = Light Cyan foreground

SKIP_ANSI_ESC ? '' : '96'

F_WHITE = Light White foreground

SKIP_ANSI_ESC ? '' : '97'

CL = Close the ANSI Escape Sequence

SKIP_ANSI_ESC ? '' : 'm'

B_BLACK = Black background

SKIP_ANSI_ESC ? '' : '40'

B_RED = Red background

SKIP_ANSI_ESC ? '' : '41'

B_GREEN = Green background

SKIP_ANSI_ESC ? '' : '42'

B_BROWN = Brown background

SKIP_ANSI_ESC ? '' : '43'

B_YELLOW = Yellow, alias for BROWN background

SKIP_ANSI_ESC ? '' : B_BROWN

B_BLUE = Blue background

SKIP_ANSI_ESC ? '' : '44'

B_PURPLE = Purple background

SKIP_ANSI_ESC ? '' : '45'

B_MAGENTA = Magenta, alias for PURPLE background

SKIP_ANSI_ESC ? '' : B_PURPLE

B_CYAN = Cyan background

SKIP_ANSI_ESC ? '' : '46'

B_LGREY = Light Grey background

SKIP_ANSI_ESC ? '' : '47'

B_LGRAY = Light Gray, alias for GRAY background

SKIP_ANSI_ESC ? '' : B_LGREY

B_DGREY = Dark Grey background

SKIP_ANSI_ESC ? '' : '100'

B_DGRAY = Dark Gray, alias for GRAY background

SKIP_ANSI_ESC ? '' : B_DGREY

B_PLAIN = Plain background

SKIP_ANSI_ESC ? '' : '49'

B_DEFAULT = Default background

SKIP_ANSI_ESC ? '' : B_PLAIN

B_LRED = Light Red background

SKIP_ANSI_ESC ? '' : '101'

B_LGREEN = Light Green background

SKIP_ANSI_ESC ? '' : '102'

B_LBROWN = Light Brown background

SKIP_ANSI_ESC ? '' : '103'

B_LYELLOW = Light Yellow, alias for BROWN background

SKIP_ANSI_ESC ? '' : B_LBROWN

B_LBLUE = Light Blue background

SKIP_ANSI_ESC ? '' : '104'

B_LPURPLE = Light Purple background

SKIP_ANSI_ESC ? '' : '105'

B_LMAGENTA = Light Magenta, alias for PURPLE background

SKIP_ANSI_ESC ? '' : B_LPURPLE

B_LCYAN = Light Cyan background

SKIP_ANSI_ESC ? '' : '106'

B_WHITE = Light White background

SKIP_ANSI_ESC ? '' : '107'

STYLES = All Styles with names

{
    BOLD => 'BOLD',
    DIM => 'DIM',
    ULINE => 'ULINE',
    BLINK => 'BLINK',
    REVERSE => 'REVERSE',
    HIDDEN => 'HIDDEN',
    REBOLD => 'RE-BOLD',
    REDIM => 'RE-DIM',
    REULINE => 'RE-ULINE',
    REBLINK => 'RE-BLINK',
    REREVERSE => 'RE-REVERSE',
    REHIDDEN => 'RE-HIDDEN'
}

FORES = All Foregrounds with names

{
    F_DEF => 'F_DEF',
    F_BLACK => 'F_BLACK',
    F_RED => 'F_RED',
    F_GREEN => 'F_GREEN',
    F_BROWN => 'F_BROWN',
    F_BLUE => 'F_BLUE',
    F_PURPLE => 'F_PURPLE',
    F_CYAN => 'F_CYAN',
    F_LGREY => 'F_LGREY',
    F_DGREY => 'F_DGREY',
    F_LRED => 'F_LRED',
    F_LGREEN => 'F_LGREEN',
    F_LBROWN => 'F_LBROWN',
    F_LBLUE => 'F_LBLUE',
    F_LPURPLE => 'F_LPURPLE',
    F_LCYAN => 'F_LCYAN',
    F_WHITE => 'F_WHITE',
}

BACKS = All Backgrounds with names

{
    B_BLACK => 'B_BLACK',
    B_RED => 'B_RED',
    B_GREEN => 'B_GREEN',
    B_BROWN => 'B_BROWN',
    B_BLUE => 'B_BLUE',
    B_PURPLE => 'B_PURPLE',
    B_CYAN => 'B_CYAN',
    B_LGREY => 'B_LGREY',
    B_DGREY => 'B_DGREY',

    B_DEFAULT => 'B_DEFAULT',

    B_LRED => 'B_LRED',
    B_LGREEN => 'B_LGREEN',
    B_LBROWN => 'B_LBROWN',
    B_LBLUE => 'B_LBLUE',
    B_LPURPLE => 'B_LPURPLE',
    B_LCYAN => 'B_LCYAN',
    B_WHITE => 'B_WHITE',
}

Constants included from Glyphs

Glyphs::CHKF, Glyphs::CHKT, Glyphs::CIRBULLE, Glyphs::CIRBULLF, Glyphs::DARR, Glyphs::DIAM, Glyphs::DLARR, Glyphs::DRARR, Glyphs::LARR, Glyphs::LARRR, Glyphs::LLQ, Glyphs::LLQBIG, Glyphs::LLTRI, Glyphs::LRARR, Glyphs::LSQBR, Glyphs::LTRI, Glyphs::RARR, Glyphs::RARRR, Glyphs::RLARRR, Glyphs::RRQ, Glyphs::RRQBIG, Glyphs::RRTRI, Glyphs::RSQBR, Glyphs::RTRI, Glyphs::SESQ, Glyphs::SFSQ, Glyphs::SHADE1, Glyphs::SHADE2, Glyphs::SPEAR, Glyphs::SQRBULLE, Glyphs::SQRBULLF, Glyphs::STAR, Glyphs::TALLBLK1, Glyphs::TALLBLK2, Glyphs::TALLBLK3, Glyphs::TALLBLK4, Glyphs::UARR, Glyphs::UDARR, Glyphs::ULARR, Glyphs::URARR, Glyphs::XFAT, Glyphs::XTHIN

Class Method Summary collapse

.test ⇒ Object

convenient test for all styles.

Class Method Details

.test ⇒ `Object`

convenient test for all styles

# File 'lib/dataMetaXtra/ansi.rb', line 211

def test
  puts
  out = ''
  BACKS.keys.each { |b|
    FORES.keys.each { |f|
      STYLES.keys.each { |s|
        out << %<#{LLQBIG}#{OP}#{s};#{f};#{b}m#{FORES[f]}/#{BACKS[b]}:#{STYLES[s]}#{RESET}#{RRQBIG}>
        if out.length > 240
          puts out
          out = ''
        end
      }
    }
    print "\n"
  }
  puts
end