librex 0.0.68 → 0.0.70

data/lib/rex/ui/output.rb

@@ -12,66 +12,72 @@ module Ui
 ###
 class Output
 
-	# General output
-	require 'rex/ui/output/none'
-
-	# Text-based output
-	require 'rex/ui/text/output'
-
-	#
-	# Prints an error message.
-	#
-	def print_error(msg='')
-	end
-
-	#
-	# Prints a 'good' message.
-	#
-	def print_good(msg='')
-	end
-
-	def print_debug(msg='')
-	end
-
-	#
-	# Prints a status line.
-	#
-	def print_status(msg='')
-	end
-
-	#
-	# Prints an undecorated line of information.
-	#
-	def print_line(msg='')
-	end
-
-	#
-	# Prints a message with no decoration.
-	#
-	def print(msg='')
-	end
-
-	#
-	# Flushes any buffered output.
-	#
-	def flush
-	end
-
-	#
-	# Called to tell the output medium that we're at a prompt.
-	# This is used to allow the output medium to display an extra
-	# carriage return
-	#
-	def prompting(v = true)
-		@at_prompt = v
-	end
-
-	#
-	# Returns whether or not we're at a prompt currently
-	#
-	def prompting?
-		@at_prompt
-	end
+  # General output
+  require 'rex/ui/output/none'
+
+  # Text-based output
+  require 'rex/ui/text/output'
+
+  #
+  # Prints an error message.
+  #
+  def print_error(msg='')
+  end
+
+  #
+  # Prints a 'good' message.
+  #
+  def print_good(msg='')
+  end
+
+  def print_debug(msg='')
+  end
+
+  #
+  # Prints a status line.
+  #
+  def print_status(msg='')
+  end
+
+  #
+  # Prints an undecorated line of information.
+  #
+  def print_line(msg='')
+  end
+
+  #
+  # Prints a warning
+  #
+  def print_warning(msg='')
+  end
+
+  #
+  # Prints a message with no decoration.
+  #
+  def print(msg='')
+  end
+
+  #
+  # Flushes any buffered output.
+  #
+  def flush
+  end
+
+  #
+  # Called to tell the output medium that we're at a prompt.
+  # This is used to allow the output medium to display an extra
+  # carriage return
+  #
+  def prompting(v = true)
+    @at_prompt = v
+  end
+
+  #
+  # Returns whether or not we're at a prompt currently
+  #
+  def prompting?
+    @at_prompt
+  end
 
 end
 

data/lib/rex/ui/progress_tracker.rb

@@ -11,85 +11,85 @@ module Ui
 ###
 class ProgressTracker
 
-	require 'rex/ui/text/progress_tracker'
-
-	def initialize
-		self.start = 0
-		self.stop  = 0
-		self.pos   = 0
-	end
-
-	#
-	# Sets start and step using a range.
-	#
-	def range=(rng)
-		self.start = rng.begin
-		self.stop  = rng.end
-	end
-
-	#
-	# Sets the start and resets the position.
-	#
-	def start=(start)
-		@start   = start
-		self.pos = start
-	end
-
-	#
-	# Steps with a given message and step size.
-	#
-	def step(status = nil, n = 1)
-		self.pos += n if (self.pos + n <= self.stop)
-
-		step_status(status)
-
-		self.pos
-	end
-
-	#
-	# Resets the current step location.
-	#
-	def reset(n = self.start)
-		self.pos = n
-	end
-
-	#
-	# Passes a generic status message that isn't necessarily associated
-	# with a step event.
-	#
-	def status(msg = nil)
-	end
-
-	#
-	# Updates the status associated with the current step.
-	#
-	def step_status(msg = nil)
-	end
-
-	#
-	# An error occurred that may result in aborting the progress.
-	#
-	def error(msg = nil)
-	end
-
-	#
-	# Progress has been aborted, the reason is supplied in msg.
-	#
-	def abort(msg = nil)
-	end
-
-	#
-	# The start of the progress.
-	#
-	attr_reader   :start
-	#
-	# The last position in the progress.
-	#
-	attr_accessor :stop
-	#
-	# The current position in the progress.
-	#
-	attr_accessor :pos
+  require 'rex/ui/text/progress_tracker'
+
+  def initialize
+    self.start = 0
+    self.stop  = 0
+    self.pos   = 0
+  end
+
+  #
+  # Sets start and step using a range.
+  #
+  def range=(rng)
+    self.start = rng.begin
+    self.stop  = rng.end
+  end
+
+  #
+  # Sets the start and resets the position.
+  #
+  def start=(start)
+    @start   = start
+    self.pos = start
+  end
+
+  #
+  # Steps with a given message and step size.
+  #
+  def step(status = nil, n = 1)
+    self.pos += n if (self.pos + n <= self.stop)
+
+    step_status(status)
+
+    self.pos
+  end
+
+  #
+  # Resets the current step location.
+  #
+  def reset(n = self.start)
+    self.pos = n
+  end
+
+  #
+  # Passes a generic status message that isn't necessarily associated
+  # with a step event.
+  #
+  def status(msg = nil)
+  end
+
+  #
+  # Updates the status associated with the current step.
+  #
+  def step_status(msg = nil)
+  end
+
+  #
+  # An error occurred that may result in aborting the progress.
+  #
+  def error(msg = nil)
+  end
+
+  #
+  # Progress has been aborted, the reason is supplied in msg.
+  #
+  def abort(msg = nil)
+  end
+
+  #
+  # The start of the progress.
+  #
+  attr_reader   :start
+  #
+  # The last position in the progress.
+  #
+  attr_accessor :stop
+  #
+  # The current position in the progress.
+  #
+  attr_accessor :pos
 
 end
 

data/lib/rex/ui/subscriber.rb

@@ -9,140 +9,150 @@ module Ui
 ###
 module Subscriber
 
-	##
-	#
-	# Subscribes to the output half of the user interface.
-	#
-	##
-	module Output
-
-		#
-		# Wraps user_output.print_line
-		#
-		def print_line(msg='')
-			if (user_output)
-				print_blank_line if user_output.prompting?
-				user_output.print_line(msg)
-			end
-		end
-
-		#
-		# Wraps user_output.print_status
-		#
-		def print_status(msg='')
-			if (user_output)
-				print_blank_line if user_output.prompting?
-				user_output.print_status(msg)
-			end
-		end
-
-		#
-		# Wraps user_output.print_error
-		#
-		def print_error(msg='')
-			if (user_output)
-				print_blank_line if user_output.prompting?
-				user_output.print_error(msg)
-			end
-		end
-
-		#
-		# Wraps user_output.print_good
-		#
-		def print_good(msg='')
-			if (user_output)
-				print_blank_line if user_output.prompting?
-				user_output.print_good(msg)
-			end
-		end
-
-		#
-		# Wraps user_output.print_debug
-		#
-		def print_debug(msg='')
-			if (user_output)
-				print_blank_line if user_output.prompting?
-				user_output.print_debug(msg)
-			end
-		end
-
-		#
-		# Wraps user_output.print
-		#
-		def print(msg='')
-			user_output.print(msg) if (user_output)
-		end
-
-		#
-		# Wraps user_output.flush
-		#
-		def flush
-			user_output.flush if (user_output)
-		end
-
-		#
-		# The user output handle.
-		#
-		attr_accessor :user_output
-
-	protected
-
-		#
-		# Prints a blank line.  Used when the input is prompting.
-		#
-		def print_blank_line
-			user_output.prompting(false)
-			user_output.print_line
-		end
-
-	end
-
-	##
-	#
-	# Subscribes to the input half of the user interface.
-	#
-	##
-	module Input
-
-		#
-		# Gets a line of input from the user_input handle by calling gets.
-		#
-		def gets
-			user_input.gets if (user_input)
-		end
-
-		#
-		# The user intput handle.
-		#
-		attr_accessor :user_input
-
-	end
-
-	include Output
-	include Input
-
-	#
-	# Sets the input and output handles.
-	#
-	def init_ui(input = nil, output = nil)
-		self.user_input  = input
-		self.user_output = output
-	end
-
-	#
-	# Disables input/output
-	#
-	def reset_ui
-		self.user_input  = nil
-		self.user_output = nil
-	end
-
-	#
-	# Copy the user input and output handles from the supplied subscriber.
-	#
-	def copy_ui(subscriber)
-		init_ui(subscriber.user_input, subscriber.user_output)
-	end
+  ##
+  #
+  # Subscribes to the output half of the user interface.
+  #
+  ##
+  module Output
+
+    #
+    # Wraps user_output.print_line
+    #
+    def print_line(msg='')
+      if (user_output)
+        print_blank_line if user_output.prompting?
+        user_output.print_line(msg)
+      end
+    end
+
+    #
+    # Wraps user_output.print_status
+    #
+    def print_status(msg='')
+      if (user_output)
+        print_blank_line if user_output.prompting?
+        user_output.print_status(msg)
+      end
+    end
+
+    #
+    # Wraps user_output.print_error
+    #
+    def print_error(msg='')
+      if (user_output)
+        print_blank_line if user_output.prompting?
+        user_output.print_error(msg)
+      end
+    end
+
+    #
+    # Wraps user_output.print_good
+    #
+    def print_good(msg='')
+      if (user_output)
+        print_blank_line if user_output.prompting?
+        user_output.print_good(msg)
+      end
+    end
+
+    #
+    # Wraps user_output.print_debug
+    #
+    def print_debug(msg='')
+      if (user_output)
+        print_blank_line if user_output.prompting?
+        user_output.print_debug(msg)
+      end
+    end
+
+    #
+    # Wraps user_output.print_warning
+    #
+    def print_warning(msg='')
+      if (user_output)
+        print_blank_line if user_output.prompting?
+        user_output.print_warning(msg)
+      end
+    end
+
+    #
+    # Wraps user_output.print
+    #
+    def print(msg='')
+      user_output.print(msg) if (user_output)
+    end
+
+    #
+    # Wraps user_output.flush
+    #
+    def flush
+      user_output.flush if (user_output)
+    end
+
+    #
+    # The user output handle.
+    #
+    attr_accessor :user_output
+
+  protected
+
+    #
+    # Prints a blank line.  Used when the input is prompting.
+    #
+    def print_blank_line
+      user_output.prompting(false)
+      user_output.print_line
+    end
+
+  end
+
+  ##
+  #
+  # Subscribes to the input half of the user interface.
+  #
+  ##
+  module Input
+
+    #
+    # Gets a line of input from the user_input handle by calling gets.
+    #
+    def gets
+      user_input.gets if (user_input)
+    end
+
+    #
+    # The user intput handle.
+    #
+    attr_accessor :user_input
+
+  end
+
+  include Output
+  include Input
+
+  #
+  # Sets the input and output handles.
+  #
+  def init_ui(input = nil, output = nil)
+    self.user_input  = input
+    self.user_output = output
+  end
+
+  #
+  # Disables input/output
+  #
+  def reset_ui
+    self.user_input  = nil
+    self.user_output = nil
+  end
+
+  #
+  # Copy the user input and output handles from the supplied subscriber.
+  #
+  def copy_ui(subscriber)
+    init_ui(subscriber.user_input, subscriber.user_output)
+  end
 
 end