Class Shell::CommandProcessor
In: shell/command-processor.rb
Parent: Object

Methods

Constants

NoDelegateMethods = ["initialize", "expand_path"]   initialize of Shell and related classes.

Public Class methods

[Source]

# File shell/command-processor.rb, line 500
    def self.add_delegate_command_to_shell(id)
      id = id.intern if id.kind_of?(String)
      name = id.id2name
      if Shell.method_defined?(id)
        Shell.notify "warn: override definnition of Shell##{name}."
        Shell.notify "warn: alias Shell##{name} to Shell##{name}_org.\n"
        Shell.module_eval "alias #{name}_org #{name}"
      end
      Shell.notify "method added: Shell##{name}.", Shell.debug?
      Shell.module_eval(%Q[def #{name}(*args, &block)
                            begin
                              @command_processor.__send__(:#{name}, *args, &block)
                            rescue Exception
                              $@.delete_if{|s| /:in `__getobj__'$/ =~ s} #`
                              $@.delete_if{|s| /^\\(eval\\):/ =~ s}
                            raise
                            end
                          end], __FILE__, __LINE__)

      if Shell::Filter.method_defined?(id)
        Shell.notify "warn: override definnition of Shell::Filter##{name}."
        Shell.notify "warn: alias Shell##{name} to Shell::Filter##{name}_org."
        Filter.module_eval "alias #{name}_org #{name}"
      end
      Shell.notify "method added: Shell::Filter##{name}.", Shell.debug?
      Filter.module_eval(%Q[def #{name}(*args, &block)
                            begin
                              self | @shell.__send__(:#{name}, *args, &block)
                            rescue Exception
                              $@.delete_if{|s| /:in `__getobj__'$/ =~ s} #`
                              $@.delete_if{|s| /^\\(eval\\):/ =~ s}
                            raise
                            end
                          end], __FILE__, __LINE__)
    end

[Source]

# File shell/command-processor.rb, line 391
    def self.alias_command(ali, command, *opts, &block)
      ali = ali.id2name if ali.kind_of?(Symbol)
      command = command.id2name if command.kind_of?(Symbol)
      begin
        if iterator?
          @alias_map[ali.intern] = proc

          eval((d = %Q[def #{ali}(*opts)
                          @shell.__send__(:#{command},
                                          *(CommandProcessor.alias_map[:#{ali}].call *opts))
                        end]), nil, __FILE__, __LINE__ - 1)
    
        else
           args = opts.collect{|opt| '"' + opt + '"'}.join(",")
           eval((d = %Q[def #{ali}(*opts)
                          @shell.__send__(:#{command}, #{args}, *opts)
                        end]), nil, __FILE__, __LINE__ - 1)
        end
      rescue SyntaxError
        Shell.notify "warn: Can't alias #{ali} command: #{command}." 
        Shell.notify("Definition of #{ali}: ", d)
        raise
      end
      Shell.notify "Define #{ali} command: #{command}.", Shell.debug?
      Shell.notify("Definition of #{ali}: ", d, 
             Shell.debug.kind_of?(Integer) && Shell.debug > 1)
      self
    end

[Source]

# File shell/command-processor.rb, line 388
    def self.alias_map
      @alias_map
    end

CommandProcessor.def_builtin_commands(delegation_class, command_specs)

    delegation_class: Class or Module
    command_specs: [[command_name, [argument,...]],...]
       command_name: String
       arguments:      String
          FILENAME?? -> expand_path(filename??)
          *FILENAME?? -> filename??.collect{|f|expand_path(f)}.join(", ")
  define command_name(argument,...) as
      delegation_class.command_name(argument,...)

[Source]

# File shell/command-processor.rb, line 437
    def self.def_builtin_commands(delegation_class, command_specs)
      for meth, args in command_specs
        arg_str = args.collect{|arg| arg.downcase}.join(", ")
        call_arg_str = args.collect{
          |arg|
          case arg
          when /^(FILENAME.*)$/
            format("expand_path(%s)", $1.downcase)
          when /^(\*FILENAME.*)$/
            # \*FILENAME* -> filenames.collect{|fn| expand_path(fn)}.join(", ")
            $1.downcase + '.collect{|fn| expand_path(fn)}'
          else
            arg
          end
        }.join(", ")
        d = %Q[def #{meth}(#{arg_str})
                    #{delegation_class}.#{meth}(#{call_arg_str})
                 end]
        Shell.notify "Define #{meth}(#{arg_str})", Shell.debug?
        Shell.notify("Definition of #{meth}: ", d, 
             Shell.debug.kind_of?(Integer) && Shell.debug > 1)
        eval d
      end
    end

CommandProcessor.def_system_command(command, path)

    command:  String
    path:       String
  define 'command()' method as method.

[Source]

# File shell/command-processor.rb, line 361
    def self.def_system_command(command, path = command)
      begin
        eval((d = %Q[def #{command}(*opts)
                  SystemCommand.new(@shell, '#{path}', *opts)
               end]), nil, __FILE__, __LINE__ - 1)
      rescue SyntaxError
        Shell.notify "warn: Can't define #{command} path: #{path}." 
      end
      Shell.notify "Define #{command} path: #{path}.", Shell.debug?
      Shell.notify("Definition of #{command}: ", d, 
             Shell.debug.kind_of?(Integer) && Shell.debug > 1)
    end

[Source]

# File shell/command-processor.rb, line 30
    def self.initialize

      install_builtin_commands

      # define CommandProccessor#methods to Shell#methods and Filter#methods
      for m in CommandProcessor.instance_methods(false) - NoDelegateMethods
        add_delegate_command_to_shell(m)
      end
      
      def self.method_added(id)
        add_delegate_command_to_shell(id)
      end
    end

define default builtin commands

[Source]

# File shell/command-processor.rb, line 539
    def self.install_builtin_commands
      # method related File.
      # (exclude open/foreach/unlink)
      normal_delegation_file_methods = [
        ["atime", ["FILENAME"]],
        ["basename", ["fn", "*opts"]],
        ["chmod", ["mode", "*FILENAMES"]], 
        ["chown", ["owner", "group", "*FILENAME"]],
        ["ctime", ["FILENAMES"]],
        ["delete", ["*FILENAMES"]],
        ["dirname", ["FILENAME"]],
        ["ftype", ["FILENAME"]],
        ["join", ["*items"]],
        ["link", ["FILENAME_O", "FILENAME_N"]],
        ["lstat", ["FILENAME"]],
        ["mtime", ["FILENAME"]],
        ["readlink", ["FILENAME"]],
        ["rename", ["FILENAME_FROM", "FILENAME_TO"]],
        #      ["size", ["FILENAME"]],
        ["split", ["pathname"]],
        ["stat", ["FILENAME"]],
        ["symlink", ["FILENAME_O", "FILENAME_N"]],
        ["truncate", ["FILENAME", "length"]],
        ["utime", ["atime", "mtime", "*FILENAMES"]]]

      def_builtin_commands(File, normal_delegation_file_methods)
      alias_method :rm, :delete

      # method related FileTest
      def_builtin_commands(FileTest, 
                   FileTest.singleton_methods(false).collect{|m| [m, ["FILENAME"]]})

      # method related ftools
      normal_delegation_ftools_methods = [
        ["syscopy", ["FILENAME_FROM", "FILENAME_TO"]],
        ["copy", ["FILENAME_FROM", "FILENAME_TO"]],
        ["move", ["FILENAME_FROM", "FILENAME_TO"]],
        ["compare", ["FILENAME_FROM", "FILENAME_TO"]],
        ["safe_unlink", ["*FILENAMES"]],
        ["makedirs", ["*FILENAMES"]],
        #    ["chmod", ["mode", "*FILENAMES"]],
        ["install", ["FILENAME_FROM", "FILENAME_TO", "mode"]],
      ]
      def_builtin_commands(File,
                   normal_delegation_ftools_methods)
      alias_method :cmp, :compare
      alias_method :mv, :move
      alias_method :cp, :copy
      alias_method :rm_f, :safe_unlink
      alias_method :mkpath, :makedirs
    end

CommandProcessor.install_system_commands(pre)

      pre: String - command name prefix

defines every command which belongs in default_system_path via CommandProcessor.command(). It doesn‘t define already defined methods twice. By default, "pre_" is prefixes to each method name. Characters that may not be used in a method name are all converted to ‘_’. Definition errors are just ignored.

[Source]

# File shell/command-processor.rb, line 471
    def self.install_system_commands(pre = "sys_")
      defined_meth = {}
      for m in Shell.methods
        defined_meth[m] = true
      end
      sh = Shell.new
      for path in Shell.default_system_path
        next unless sh.directory? path
        sh.cd path
        sh.foreach do
          |cn|
          if !defined_meth[pre + cn] && sh.file?(cn) && sh.executable?(cn)
            command = (pre + cn).gsub(/\W/, "_").sub(/^([0-9])/, '_\1')
            begin
              def_system_command(command, sh.expand_path(cn))
            rescue
              Shell.notify "warn: Can't define #{command} path: #{cn}"
            end
            defined_meth[command] = command
          end
        end
      end
    end

[Source]

# File shell/command-processor.rb, line 39
      def self.method_added(id)
        add_delegate_command_to_shell(id)
      end

[Source]

# File shell/command-processor.rb, line 60
    def initialize(shell)
      @shell = shell
      @system_commands = {}
    end

include run file.

[Source]

# File shell/command-processor.rb, line 47
    def self.run_config
      begin
        load File.expand_path("~/.rb_shell") if ENV.key?("HOME")
      rescue LoadError, Errno::ENOENT
      rescue
        print "load error: #{rc}\n"
        print $!.class, ": ", $!, "\n"
        for err in $@[0, $@.size - 2]
          print "\t", err, "\n"
        end
      end
    end

[Source]

# File shell/command-processor.rb, line 420
    def self.unalias_command(ali)
      ali = ali.id2name if ali.kind_of?(Symbol)
      @alias_map.delete ali.intern
      undef_system_command(ali)
    end

[Source]

# File shell/command-processor.rb, line 374
    def self.undef_system_command(command)
      command = command.id2name if command.kind_of?(Symbol)
      remove_method(command)
      Shell.module_eval{remove_method(command)}
      Filter.module_eval{remove_method(command)}
      self
    end

Public Instance methods

[](command, file1, file2=nil)

Alias for test

[Source]

# File shell/command-processor.rb, line 281
    def append(to, filter)
      case to
      when String
        AppendFile.new(@shell, to, filter)
      when IO
        AppendIO.new(@shell, to, filter)
      else
        Shell.Fail Error::CantApplyMethod, "append", to.class
      end
    end

[Source]

# File shell/command-processor.rb, line 269
    def cat(*filenames)
      Cat.new(@shell, *filenames)
    end

ProcessCommand#transact

[Source]

# File shell/command-processor.rb, line 245
    def check_point
      @shell.process_controller.wait_all_jobs_execution
    end

[Source]

# File shell/command-processor.rb, line 296
    def concat(*jobs)
      Concat.new(@shell, *jobs)
    end

[Source]

# File shell/command-processor.rb, line 265
    def echo(*strings)
      Echo.new(@shell, *strings)
    end

CommandProcessor#expand_path(path)

    path:     String
    return: String
  returns the absolute path for <path>

[Source]

# File shell/command-processor.rb, line 71
    def expand_path(path)
      @shell.expand_path(path)
    end

[Source]

# File shell/command-processor.rb, line 331
    def find_system_command(command)
      return command if /^\// =~ command
      case path = @system_commands[command]
      when String
        if exists?(path)
          return path
        else
          Shell.Fail Error::CommandNotFound, command
        end
      when false
        Shell.Fail Error::CommandNotFound, command
      end

      for p in @shell.system_path
        path = join(p, command)
        if FileTest.exists?(path)
          @system_commands[command] = path
          return path
        end
      end
      @system_commands[command] = false
      Shell.Fail Error::CommandNotFound, command
    end
finish_all_jobs()

Alias for check_point

File related commands Shell#foreach Shell#open Shell#unlink Shell#test

-

CommandProcessor#foreach(path, rs)

    path: String
    rs:     String - record separator
    iterator
  Same as:
    File#foreach (when path is file)
    Dir#foreach (when path is directory)
  path is relative to pwd

[Source]

# File shell/command-processor.rb, line 93
    def foreach(path = nil, *rs)
      path = "." unless path
      path = expand_path(path)

      if File.directory?(path)
        Dir.foreach(path){|fn| yield fn}
      else
        IO.foreach(path, *rs){|l| yield l}
      end
    end

def sort(*filenames)

  Sort.new(self, *filenames)

end

[Source]

# File shell/command-processor.rb, line 277
    def glob(pattern)
      Glob.new(@shell, pattern)
    end

Dir related methods

Shell#mkdir Shell#rmdir

[Source]

# File shell/command-processor.rb, line 196
    def mkdir(*path)
      for dir in path
        Dir.mkdir(expand_path(dir))
      end
    end

%pwd, %cwd -> @pwd

[Source]

# File shell/command-processor.rb, line 301
    def notify(*opts, &block)
      Thread.exclusive do
        Shell.notify(*opts) {|mes|
          yield mes if iterator?
        
          mes.gsub!("%pwd", "#{@cwd}")
          mes.gsub!("%cwd", "#{@cwd}")
        }
      end
    end

CommandProcessor#open(path, mode)

    path:     String
    mode:     String
    return: File or Dir
  Same as:
    File#open (when path is file)
    Dir#open  (when path is directory)
  mode has an effect only when path is a file

[Source]

# File shell/command-processor.rb, line 114
    def open(path, mode)
      path = expand_path(path)
      if File.directory?(path)
        Dir.open(path)
      else
        effect_umask do
          File.open(path, mode)
        end
      end
    end

internal commands

[Source]

# File shell/command-processor.rb, line 261
    def out(dev = STDOUT, &block)
      dev.print transact(&block)
    end

ProcessCommand#rehash

  clear command hash table.

[Source]

# File shell/command-processor.rb, line 238
    def rehash
      @system_commands = {}
    end

CommandProcessor#rmdir(*path)

    path: String
  same as Dir.rmdir()

[Source]

# File shell/command-processor.rb, line 207
    def rmdir(*path)
      for dir in path
        Dir.rmdir(expand_path(dir))
      end
    end

CommandProcessor#system(command, *opts)

    command: String
    opts:      String
    return:  SystemCommand
  Same as system() function
  example:
    print sh.system("ls", "-l")
    sh.system("ls", "-l") | sh.head > STDOUT

[Source]

# File shell/command-processor.rb, line 223
    def system(command, *opts)
      if opts.empty?
        if command =~ /\*|\?|\{|\}|\[|\]|<|>|\(|\)|~|&|\||\\|\$|;|'|`|"|\n/
          return SystemCommand.new(@shell, find_system_command("sh"), "-c", command)
        else
          command, *opts = command.split(/\s+/)
        end
      end
      SystemCommand.new(@shell, find_system_command(command), *opts)
    end

[Source]

# File shell/command-processor.rb, line 292
    def tee(file)
      Tee.new(@shell, file)
    end

CommandProcessor#test(command, file1, file2) CommandProcessor#[command, file1, file2]

    command: char or String or Symbol
    file1:   String
    file2:   String(optional)
    return: Boolean
  same as:
    test()     (when command is char or length 1 string or symbol)
    FileTest.command (others)
  example:
    sh[?e, "foo"]
    sh[:e, "foo"]
    sh["e", "foo"]
    sh[:exists?, "foo"]
    sh["exists?", "foo"]

[Source]

# File shell/command-processor.rb, line 158
    def test(command, file1, file2=nil)
      file1 = expand_path(file1)
      file2 = expand_path(file2) if file2
      command = command.id2name if command.kind_of?(Symbol)

      case command
      when Integer
        top_level_test(command, file1, file2)
      when String
        if command.size == 1
          if file2
            top_level_test(command, file1, file2)
          else
            top_level_test(command, file1)
          end
        else
          if file2
            FileTest.send(command, file1, file2)
          else
            FileTest.send(command, file1)
          end
        end
      end
    end

[Source]

# File shell/command-processor.rb, line 250
    def transact(&block)
      begin
        @shell.instance_eval(&block)
      ensure
        check_point
      end
    end

CommandProcessor#unlink(path)

  same as:
    Dir#unlink  (when path is directory)
    File#unlink (when path is file)

[Source]

# File shell/command-processor.rb, line 132
    def unlink(path)
      path = expand_path(path)
      if File.directory?(path)
        Dir.unlink(path)
      else
        IO.unlink(path)
      end
    end

[Validate]

ruby-doc.org is a community service provided by James Britt and Happy Camper Studios, a Phoenix, Arizona, Ruby application development company.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.