Class: Shell::CommandProcessor

Inherits:
Object
  • Object
show all
Defined in:
lib/shell/command-processor.rb

Constant Summary collapse

NoDelegateMethods =

initialize of Shell and related classes.

["initialize", "expand_path"]

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(shell) ⇒ CommandProcessor

Returns a new instance of CommandProcessor.



60
61
62
63
 
# File 'lib/shell/command-processor.rb', line 60

def initialize(shell)
  @shell = shell
  @system_commands = {}
end

Class Method Details

.add_delegate_command_to_shell(id) ⇒ Object 

class initializing methods  -



500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/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
     [email protected]_if{|s| /:in `__getobj__'$/ =~ s} #`
                   [email protected]_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
     [email protected]_if{|s| /:in `__getobj__'$/ =~ s} #`
                   [email protected]_if{|s| /^\\(eval\\):/ =~ s}
   raise
   end
                      end], __FILE__, __LINE__)
end

.alias_command(ali, command, *opts, &block) ⇒ Object 



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/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

.alias_map ⇒ Object 



388
389
390
 
# File 'lib/shell/command-processor.rb', line 388

def self.alias_map
  @alias_map
end

.def_builtin_commands(delegation_class, command_specs) ⇒ Object

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,...)



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/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

.def_system_command(command, path = command) ⇒ Object

CommandProcessor.def_system_command(command, path)

command:  String
path:	    String

define ‘command()’ method as method.



361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/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

.initialize ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/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

.install_builtin_commands ⇒ Object

define default builtin commands



539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/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

.install_system_commands(pre = "sys_") ⇒ Object

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.



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/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

.method_added(id) ⇒ Object 



39
40
41
 
# File 'lib/shell/command-processor.rb', line 39

def self.method_added(id)
	add_delegate_command_to_shell(id)
end

.run_config ⇒ Object

include run file.



47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/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

.unalias_command(ali) ⇒ Object 



420
421
422
423
424
 
# File 'lib/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

.undef_system_command(command) ⇒ Object 



374
375
376
377
378
379
380
 
# File 'lib/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

Instance Method Details

#append(to, filter) ⇒ Object 



281
282
283
284
285
286
287
288
289
290
 
# File 'lib/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

#cat(*filenames) ⇒ Object 



269
270
271
 
# File 'lib/shell/command-processor.rb', line 269

def cat(*filenames)
  Cat.new(@shell, *filenames)
end

#check_point ⇒ Object Also known as: finish_all_jobs

ProcessCommand#transact



245
246
247
 
# File 'lib/shell/command-processor.rb', line 245

def check_point
  @shell.process_controller.wait_all_jobs_execution
end

#concat(*jobs) ⇒ Object 



296
297
298
 
# File 'lib/shell/command-processor.rb', line 296

def concat(*jobs)
  Concat.new(@shell, *jobs)
end

#echo(*strings) ⇒ Object 



265
266
267
 
# File 'lib/shell/command-processor.rb', line 265

def echo(*strings)
  Echo.new(@shell, *strings)
end

#expand_path(path) ⇒ Object

CommandProcessor#expand_path(path)

path:	  String
return: String

returns the absolute path for <path>



71
72
73
 
# File 'lib/shell/command-processor.rb', line 71

def expand_path(path)
  @shell.expand_path(path)
end

#find_system_command(command) ⇒ Object 



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/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

#foreach(path = nil, *rs) ⇒ Object

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



93
94
95
96
97
98
99
100
101
102
 
# File 'lib/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

#glob(pattern) ⇒ Object

def sort(*filenames)

  Sort.new(self, *filenames)
end



277
278
279
 
# File 'lib/shell/command-processor.rb', line 277

def glob(pattern)
  Glob.new(@shell, pattern)
end

#mkdir(*path) ⇒ Object

Dir related methods

Shell#mkdir Shell#rmdir

–

CommandProcessor#mkdir(*path)

path: String

same as Dir.mkdir()



196
197
198
199
200
 
# File 'lib/shell/command-processor.rb', line 196

def mkdir(*path)
  for dir in path
	Dir.mkdir(expand_path(dir))
  end
end

#notify(*opts, &block) ⇒ Object

%pwd, %cwd -> @pwd



301
302
303
304
305
306
307
308
309
310
 
# File 'lib/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

#open(path, mode) ⇒ Object

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



114
115
116
117
118
119
120
121
122
123
 
# File 'lib/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

#out(dev = STDOUT, &block) ⇒ Object

internal commands



261
262
263
 
# File 'lib/shell/command-processor.rb', line 261

def out(dev = STDOUT, &block)
  dev.print transact(&block)
end

#rehash ⇒ Object

ProcessCommand#rehash clear command hash table.



238
239
240
 
# File 'lib/shell/command-processor.rb', line 238

def rehash
  @system_commands = {}
end

#rmdir(*path) ⇒ Object

CommandProcessor#rmdir(*path)

path: String

same as Dir.rmdir()



207
208
209
210
211
 
# File 'lib/shell/command-processor.rb', line 207

def rmdir(*path)
  for dir in path
	Dir.rmdir(expand_path(dir))
  end
end

#system(command, *opts) ⇒ Object

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



223
224
225
226
227
228
229
230
231
232
 
# File 'lib/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

#tee(file) ⇒ Object 



292
293
294
 
# File 'lib/shell/command-processor.rb', line 292

def tee(file)
  Tee.new(@shell, file)
end

#test(command, file1, file2 = nil) ⇒ Object Also known as: []

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"]



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/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

#transact(&block) ⇒ Object 



250
251
252
253
254
255
256
 
# File 'lib/shell/command-processor.rb', line 250

def transact(&block)
  begin
	@shell.instance_eval(&block)
  ensure
	check_point
  end
end

#unlink(path) ⇒ Object

CommandProcessor#unlink(path) same as:

Dir#unlink  (when path is directory)
File#unlink (when path is file)



132
133
134
135
136
137
138
139
 
# File 'lib/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