Module: Main::Program::InstanceMethods

Included in:
Main::Program
Defined in:
lib/main/program/instance_methods.rb

Instance Method Summary collapse

Instance Method Details

#abort(message = 'exit') ⇒ Object

Raises:

  • (SystemExit) 


184
185
186
 
# File 'lib/main/program/instance_methods.rb', line 184

def abort(message = 'exit')
  raise SystemExit.new(message)
end

#after_initialize ⇒ Object 



49
 
# File 'lib/main/program/instance_methods.rb', line 49

def after_initialize() :hook end

#after_parse_parameters ⇒ Object 



159
 
# File 'lib/main/program/instance_methods.rb', line 159

def after_parse_parameters() :hook end

#after_run ⇒ Object 



167
 
# File 'lib/main/program/instance_methods.rb', line 167

def after_run() :hook end

#before_initialize ⇒ Object 



41
 
# File 'lib/main/program/instance_methods.rb', line 41

def before_initialize() :hook end

#before_parse_parameters ⇒ Object 



147
 
# File 'lib/main/program/instance_methods.rb', line 147

def before_parse_parameters() :hook end

#before_run ⇒ Object 



163
 
# File 'lib/main/program/instance_methods.rb', line 163

def before_run() :hook end

#fcall(object, method, *argv, &block) ⇒ Object 



221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/main/program/instance_methods.rb', line 221

def fcall(object, method, *argv, &block)
  method = object.method(method)
  arity = m.arity
  if arity >= 0
    argv = argv[0, arity]
  else
    arity = arity.abs - 1
    argv = argv[0, arity] + argv[arity .. -1]
  end
  method.call(*argv, &block)
end

#finalize ⇒ Object 



59
60
61
 
# File 'lib/main/program/instance_methods.rb', line 59

def finalize
  while((f = @finalizers.pop)); f.call; end
end

#handle_exception(e) ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/main/program/instance_methods.rb', line 188

def handle_exception(e)
  if e.respond_to?(:error_handler_before)
    fcall(e, :error_handler_before, self)
  end

  if e.respond_to?(:error_handler_instead)
    fcall(e, :error_handler_instead, self)
  else
    if e.respond_to?(:status)
      exit_status(( e.status ))
    end

    if Softspoken === e or SystemExit === e
      quiet = ((SystemExit === e and e.message.respond_to?('abort')) or # see main/stdext.rb
              (SystemExit === e and e.message == 'exit'))
      stderr.puts e.message unless quiet
    else
      fatal{ e }
    end
  end

  if e.respond_to?(:error_handler_after)
    fcall(e, :error_handler_after, self)
  end

  exit_status(( exit_failure )) if exit_status == exit_success
  exit_status(( Integer(exit_status) rescue(exit_status ? 0 : 1) ))
end

#handle_exit(status) ⇒ Object 



217
218
219
 
# File 'lib/main/program/instance_methods.rb', line 217

def handle_exit(status)
  exit(( Integer(status) rescue 1 ))
end

#help!(status = 0) ⇒ Object 



175
176
177
178
 
# File 'lib/main/program/instance_methods.rb', line 175

def help!(status = 0)
  print usage.to_s
  exit(status)
end

#help? ⇒ Boolean

Returns:

  • (Boolean) 


180
181
182
 
# File 'lib/main/program/instance_methods.rb', line 180

def help?
  (params['help'] and params['help'].given?) or argv.first == 'help'
end

#initialize ⇒ Object 



48
 
# File 'lib/main/program/instance_methods.rb', line 48

def initialize() :hook end

#instance_eval_block(*argv, &block) ⇒ Object 



241
242
243
244
245
246
247
248
 
# File 'lib/main/program/instance_methods.rb', line 241

def instance_eval_block(*argv, &block)
  singleton_class =
    class << self
      self
    end
  singleton_class.module_eval{ define_method('__instance_eval_block', &block) }
  fcall(self, '__instance_eval_block', *argv, &block)
end

#logger=(log) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/main/program/instance_methods.rb', line 74

def logger= log
  unless(defined?(@logger) and @logger == log)
    case log 
      when ::Logger, Logger
        @logger = log
      when IO, StringIO
        @logger = Logger.new log 
        @logger.level = logger_level 
      else
        @logger = Logger.new(*log)
        @logger.level = logger_level 
    end
  end
  @logger
end

#main_initialize ⇒ Object 



42
43
44
45
46
47
 
# File 'lib/main/program/instance_methods.rb', line 42

def main_initialize()
  setup_finalizers
  setup_io_restoration
  setup_io_redirection
  setup_logging
end

#modes ⇒ Object 



171
172
173
 
# File 'lib/main/program/instance_methods.rb', line 171

def modes
  self.class.modes
end

#parse_parameters ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/main/program/instance_methods.rb', line 148

def parse_parameters
  pre_parse_parameters
  before_parse_parameters

  self.class.parameters.parse(self)
  @params = Parameter::Table.new
  self.class.parameters.each{|p| @params[p.name.to_s] = p}

  after_parse_parameters
  post_parse_parameters
end

#post_initialize ⇒ Object 



50
 
# File 'lib/main/program/instance_methods.rb', line 50

def post_initialize() :hook end

#post_parse_parameters ⇒ Object 



160
 
# File 'lib/main/program/instance_methods.rb', line 160

def post_parse_parameters() :hook end

#post_run ⇒ Object 



168
 
# File 'lib/main/program/instance_methods.rb', line 168

def post_run() :hook end

#pre_initialize ⇒ Object 



40
 
# File 'lib/main/program/instance_methods.rb', line 40

def pre_initialize() :hook end

#pre_parse_parameters ⇒ Object 



146
 
# File 'lib/main/program/instance_methods.rb', line 146

def pre_parse_parameters() :hook end

#pre_run ⇒ Object 



162
 
# File 'lib/main/program/instance_methods.rb', line 162

def pre_run() :hook end

#run ⇒ Object

Raises:

  • (NotImplementedError) 


164
165
166
 
# File 'lib/main/program/instance_methods.rb', line 164

def run
  raise NotImplementedError, 'run not defined'
end

#setup_finalizers ⇒ Object 



52
53
54
55
56
57
 
# File 'lib/main/program/instance_methods.rb', line 52

def setup_finalizers
  @finalizers = finalizers = []
  ObjectSpace.define_finalizer(self) do
    while((f = finalizers.pop)); f.call; end
  end
end

#setup_io_redirection ⇒ Object 



63
64
65
66
67
 
# File 'lib/main/program/instance_methods.rb', line 63

def setup_io_redirection
  self.stdin = opts['stdin'] || opts[:stdin] || stdin
  self.stdout = opts['stdout'] || opts[:stdout] || stdout
  self.stderr = opts['stderr'] || opts[:stderr] || stderr
end

#setup_io_restoration ⇒ Object 



90
91
92
93
94
 
# File 'lib/main/program/instance_methods.rb', line 90

def setup_io_restoration
  [STDIN, STDOUT, STDERR].each do |io|
    dup = io.dup and @finalizers.push lambda{ io.reopen dup rescue nil }
  end
end

#setup_logging ⇒ Object 



69
70
71
72
 
# File 'lib/main/program/instance_methods.rb', line 69

def setup_logging
  log = self.class.logger || stderr
  self.logger = log
end

#stderr=(io) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/main/program/instance_methods.rb', line 132

def stderr= io
  unless(defined?(@stderr) and (@stderr == io))
    @stderr =
      if io.respond_to? 'write'
        io
      else
        fd = open io.to_s, 'w+'
        @finalizers.push lambda{ fd.close }
        fd
      end
    STDERR.reopen @stderr rescue($stderr = @stderr)
  end
end

#stdin=(io) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/main/program/instance_methods.rb', line 97

def stdin= io
  unless(defined?(@stdin) and (@stdin == io))
    @stdin =
      if io.respond_to? 'read'
        io
      else
        fd = open io.to_s, 'r+'
        @finalizers.push lambda{ fd.close }
        fd
      end
    begin
      STDIN.reopen @stdin
    rescue
      $stdin = @stdin
      ::Object.const_set 'STDIN', @stdin
    end
  end
end

#stdout=(io) ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/main/program/instance_methods.rb', line 117

def stdout= io
  unless(defined?(@stdout) and (@stdout == io))
    @stdout =
      if io.respond_to? 'write'
        io
      else
        fd = open io.to_s, 'w+'
        @finalizers.push lambda{ fd.close }
        fd
      end
    STDOUT.reopen @stdout rescue($stdout = @stdout)
  end
end