Module Rex::Ui::Text::Shell
In: lib/rex/ui/text/shell.rb

The shell class provides a command-prompt style interface in a generic fashion.

Methods

_print_prompt   colorize   do_colorize   init_ui   log_input   log_output   new   parse_line   print   print_error   print_line   print_status   reset_color   reset_ui   run   set_log_source   stop   stopped?   supports_color?   tab_complete   unset_log_source   update_prompt  

Classes and Modules

Module Rex::Ui::Text::Shell::InputShell

Attributes

disable_output  [RW]  Whether or not output has been disabled.
input  [R]  The input handle to read user input from.
output  [R]  The output handle to write output to.

Public Class methods

new(prompt, prompt_char = '>')

Initializes a shell that has a prompt and can be interacted with.

Public Instance methods

colorize(*color)

Returns colorized text if it‘s supported, otherwise an empty string.

do_colorize(*color)

Colorize if this shell supports it

init_ui(in_input = nil, in_output = nil)

Initializes the user interface input/output classes.

print(msg='')

Prints a raw message to the output handle.

print_error(msg='')

Prints an error message to the output handle.

print_line(msg='')

Prints a line of text to the output handle.

print_status(msg='')

Prints a status message to the output handle.

reset_color()

Resets coloring so that it‘s back to normal.

reset_ui()

Resets the user interface handles.

run(&block)

Run the command processing loop.

set_log_source(log_source)

Sets the log source that should be used for logging input and output.

stop()

Stop processing user input.

stopped?()

Checks to see if the shell has stopped.

supports_color?()

Checks to see whether or not colors are supported on this shell console.

tab_complete(str)

Performs tab completion on the supplied string.

unset_log_source()

Unsets the log source so that logging becomes disabled.

Protected Instance methods

_print_prompt(prompt)

Print the prompt, but do not log it.

log_input(buf)

Writes the supplied input to the log source if one has been registered.

log_output(buf)

Writes the supplied output to the log source if one has been registered.

parse_line(line)

Parse a line into an array of arguments.

[Validate]