Class: Rex::Ui::Text::Output

Inherits:
Output
  • Object
show all
Includes:
Color
Defined in:
lib/rex/ui/text/output.rb,
lib/rex/ui/text/output/buffer/stdout.rb

Overview

This class implements text-based output but is not tied to an output medium.

Direct Known Subclasses

Buffer, File, Socket, Stdio, Tee

Defined Under Namespace

Classes: Buffer, File, Socket, Stdio, Tee

Constant Summary

Constants included from Color

Color::AnsiAttributes

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Color

#ansi, #colorize, #do_colorize, #reset_color, #substitute_colors

Methods inherited from Output

#flush, #prompting, #prompting?

Constructor Details

#initialize ⇒ Output

Returns a new instance of Output.



25
26
27
28
29
30
 
# File 'lib/rex/ui/text/output.rb', line 25

def initialize
  @config = {
    :color => :auto, # true, false, :auto
  }
  super
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



31
32
33
 
# File 'lib/rex/ui/text/output.rb', line 31

def config
  @config
end

Instance Method Details

#auto_color ⇒ Object 



41
42
43
 
# File 'lib/rex/ui/text/output.rb', line 41

def auto_color
  @config[:color] = :auto
end

#disable_color ⇒ Object 



33
34
35
 
# File 'lib/rex/ui/text/output.rb', line 33

def disable_color
  @config[:color] = false
end

#enable_color ⇒ Object 



37
38
39
 
# File 'lib/rex/ui/text/output.rb', line 37

def enable_color
  @config[:color] = true
end

#print(msg = '') ⇒ Object 



70
71
72
 
# File 'lib/rex/ui/text/output.rb', line 70

def print(msg = '')
  print_raw(substitute_colors(msg))
end

#print_error(msg = '') ⇒ Object 



50
51
52
 
# File 'lib/rex/ui/text/output.rb', line 50

def print_error(msg = '')
  print_line("%bld%red[-]%clr #{msg}")
end

#print_good(msg = '') ⇒ Object 



54
55
56
 
# File 'lib/rex/ui/text/output.rb', line 54

def print_good(msg = '')
  print_line("%bld%grn[+]%clr #{msg}")
end

#print_line(msg = '') ⇒ Object 



62
63
64
 
# File 'lib/rex/ui/text/output.rb', line 62

def print_line(msg = '')
  print(msg + "\n")
end

#print_status(msg = '') ⇒ Object 



58
59
60
 
# File 'lib/rex/ui/text/output.rb', line 58

def print_status(msg = '')
  print_line("%bld%blu[*]%clr #{msg}")
end

#print_warning(msg = '') ⇒ Object 



66
67
68
 
# File 'lib/rex/ui/text/output.rb', line 66

def print_warning(msg = '')
  print_line("%bld%yel[!]%clr #{msg}")
end

#puts(*args) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/rex/ui/text/output.rb', line 77

def puts(*args)
  args.each do |argument|
    line = argument.to_s
    print_raw(line)

    unless line.ends_with? "\n"
      # yes, this is output, but `IO#puts` uses `rb_default_rs`, which is
      # [`$/`](https://github.com/ruby/ruby/blob/3af8e150aded9d162bfd41426aaaae0279e5a653/io.c#L12168-L12172),
      # which is [`$INPUT_RECORD_SEPARATOR`](https://github.com/ruby/ruby/blob/3af8e150aded9d162bfd41426aaaae0279e5a653/lib/English.rb#L83)
      print_raw($INPUT_RECORD_SEPARATOR)
    end
  end

  nil
end

#reset ⇒ Object 



74
75
 
# File 'lib/rex/ui/text/output.rb', line 74

def reset
end

#update_prompt(prompt = nil) ⇒ Object 



45
46
47
48
 
# File 'lib/rex/ui/text/output.rb', line 45

def update_prompt(prompt = nil)
  return if prompt.nil?
  substitute_colors(prompt, true)
end