Class: Debugger::HelpCommand

Inherits:
Command
  • Object
show all
Defined in:
lib/ruby-debug/commands/help.rb

Overview

Implements debugger “help” command.

Constant Summary

Constants inherited from Command

Command::DEF_OPTIONS

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Command

commands, #find, inherited, #initialize, load_commands, #match, method_missing, options, register_setting_get, register_setting_set, register_setting_var, settings, settings_map

Constructor Details

This class inherits a constructor from Debugger::Command

Class Method Details

.help(cmd) ⇒ Object 



48
49
50
51
52
53
 
# File 'lib/ruby-debug/commands/help.rb', line 48

def help(cmd)
  %{
    h[elp]\t\tprint this help
    h[elp] command\tprint help on command
  }
end

.help_command ⇒ Object 



44
45
46
 
# File 'lib/ruby-debug/commands/help.rb', line 44

def help_command
  'help'
end

Instance Method Details

#execute ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/ruby-debug/commands/help.rb', line 11

def execute
  if @match[1]
    args = @match[1].split
    cmds = @state.commands.select do |cmd| 
      [cmd.help_command].flatten.include?(args[0])
    end
  else
    args = @match[1]
    cmds = []
  end
  unless cmds.empty?
    help = cmds.map{ |cmd| cmd.help(args) }.join
    help = help.split("\n").map{|l| l.gsub(/^ +/, '')}
    help.shift if help.first && help.first.empty?
    help.pop if help.last && help.last.empty?
    print help.join("\n")
  else
    if args and args[0]
      errmsg "Undefined command: \"#{args[0]}\".  Try \"help\"."
    else
      print "ruby-debug help v#{Debugger::VERSION}\n" unless
        self.class.settings[:debuggertesting]
      print "Type 'help <command-name>' for help on a specific command\n\n"
      print "Available commands:\n"
      cmds = @state.commands.map{ |cmd| cmd.help_command }
      cmds = cmds.flatten.uniq.sort
      print columnize(cmds, self.class.settings[:width])
    end
  end
  print "\n"
end

#regexp ⇒ Object 



7
8
9
 
# File 'lib/ruby-debug/commands/help.rb', line 7

def regexp
  /^\s* h(?:elp)? (?:\s+(.+))? $/x
end