Module | ANSICode |
In: |
lib/more/facets/ansicode.rb
|
Module which makes it very easy to use ANSI codes. These are esspecially nice for beautifying shell output.
include ANSICode p red, "Hello", blue, "World" => "\e[31mHello\e[34mWorld" p red { "Hello" } + blue { "World" } => "\e[31mHello\e[0m\e[34mWorld\e[0m"
The following is a list of supported codes.
save restore clear_screen cls # synonym for :clear_screen clear_line clr # synonym for :clear_line move up down left right display clear reset # synonym for :clear bold dark italic # not widely implemented underline underscore # synonym for :underline blink rapid_blink # not widely implemented negative # no reverse because of String#reverse concealed strikethrough # not widely implemented black red green yellow blue magenta cyan white on_black on_red on_green on_yellow on_blue on_magenta on_cyan on_white
ColoredRegexp | = | /\e\[([34][0-7]|[0-9])m/ |
Define color codes.
# File lib/more/facets/ansicode.rb, line 231 231: def self.define_ansicolor_method(name,code) 232: class_eval "def \#{name.to_s}(string = nil)\nresult = \"\\e[\#{code}m\"\nif block_given?\nresult << yield\nresult << \"\\e[0m\"\nelsif string\nresult << string\nresult << \"\\e[0m\"\nelsif respond_to?(:to_str)\nresult << self\nresult << \"\\e[0m\"\nend\nreturn result\nend\n" 233: end
Clear to the end of the current line.
# File lib/more/facets/ansicode.rb, line 169 169: def clear_line 170: "\e[K" 171: end
# File lib/more/facets/ansicode.rb, line 302 302: def colors 303: @@colors.map { |c| c[0] } 304: end
Like move but returns to original positon after yielding block or adding string argument.
# File lib/more/facets/ansicode.rb, line 213 213: def display( line, column=0, string=nil ) #:yield: 214: result = "\e[s" 215: result << "\e[#{line.to_i};#{column.to_i}H" 216: if block_given? 217: result << yield 218: result << "\e[u" 219: elsif string 220: result << string 221: result << "\e[u" 222: elsif respond_to?(:to_str) 223: result << self 224: result << "\e[u" 225: end 226: return result 227: end
Move curose to line and column.
# File lib/more/facets/ansicode.rb, line 182 182: def move( line, column=0 ) 183: "\e[#{line.to_i};#{column.to_i}H" 184: end
Restore saved cursor positon.
# File lib/more/facets/ansicode.rb, line 156 156: def restore 157: "\e[u" 158: end
Save current cursor positon.
# File lib/more/facets/ansicode.rb, line 150 150: def save 151: "\e[s" 152: end
# File lib/more/facets/ansicode.rb, line 288 288: def uncolored(string = nil) 289: if block_given? 290: yield.gsub(ColoredRegexp, '') 291: elsif string 292: string.gsub(ColoredRegexp, '') 293: elsif respond_to?(:to_str) 294: gsub(ColoredRegexp, '') 295: else 296: '' 297: end 298: end