Class: Gloo::App::Engine

Inherits:
Object
  • Object
show all
Defined in:
lib/gloo/app/engine.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(context) ⇒ Engine

Set up the engine with basic elements.



23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/gloo/app/engine.rb', line 23

def initialize( context )
  @args = Args.new( self, context.params )
  @settings = Settings.new( self, context.user_root )

  @log = context.log.new( self, @args.quiet? )
  @log.debug "log (class: #{@log.class.name}) in use ..."

  @platform = context.platform
  @log.debug "platform (class: #{@platform.class.name}) in use ..."

  @log.debug 'engine intialized...'
end

Instance Attribute Details

#args ⇒ Object (readonly)

Returns the value of attribute args.



15
16
17
 
# File 'lib/gloo/app/engine.rb', line 15

def args
  @args
end

#converter ⇒ Object

Returns the value of attribute converter.



17
18
19
 
# File 'lib/gloo/app/engine.rb', line 17

def converter
  @converter
end

#dictionary ⇒ Object (readonly)

Returns the value of attribute dictionary.



15
16
17
 
# File 'lib/gloo/app/engine.rb', line 15

def dictionary
  @dictionary
end

#event_manager ⇒ Object

Returns the value of attribute event_manager.



17
18
19
 
# File 'lib/gloo/app/engine.rb', line 17

def event_manager
  @event_manager
end

#exec_env ⇒ Object

Returns the value of attribute exec_env.



17
18
19
 
# File 'lib/gloo/app/engine.rb', line 17

def exec_env
  @exec_env
end

#factory ⇒ Object (readonly)

Returns the value of attribute factory.



15
16
17
 
# File 'lib/gloo/app/engine.rb', line 15

def factory
  @factory
end

#heap ⇒ Object (readonly)

Returns the value of attribute heap.



15
16
17
 
# File 'lib/gloo/app/engine.rb', line 15

def heap
  @heap
end

#last_cmd ⇒ Object

Returns the value of attribute last_cmd.



17
18
19
 
# File 'lib/gloo/app/engine.rb', line 17

def last_cmd
  @last_cmd
end

#log ⇒ Object (readonly)

Returns the value of attribute log.



14
15
16
 
# File 'lib/gloo/app/engine.rb', line 14

def log
  @log
end

#mode ⇒ Object (readonly)

Returns the value of attribute mode.



15
16
17
 
# File 'lib/gloo/app/engine.rb', line 15

def mode
  @mode
end

#parser ⇒ Object (readonly)

Returns the value of attribute parser.



15
16
17
 
# File 'lib/gloo/app/engine.rb', line 15

def parser
  @parser
end

#persist_man ⇒ Object

Returns the value of attribute persist_man.



17
18
19
 
# File 'lib/gloo/app/engine.rb', line 17

def persist_man
  @persist_man
end

#platform ⇒ Object (readonly)

Returns the value of attribute platform.



15
16
17
 
# File 'lib/gloo/app/engine.rb', line 15

def platform
  @platform
end

#running ⇒ Object (readonly)

Returns the value of attribute running.



15
16
17
 
# File 'lib/gloo/app/engine.rb', line 15

def running
  @running
end

#running_app ⇒ Object (readonly)

Returns the value of attribute running_app.



14
15
16
 
# File 'lib/gloo/app/engine.rb', line 14

def running_app
  @running_app
end

#settings ⇒ Object (readonly)

Returns the value of attribute settings.



14
15
16
 
# File 'lib/gloo/app/engine.rb', line 14

def settings
  @settings
end

Class Method Details

.deserialize(data) ⇒ Object

Deserialize the Engine data.



84
85
86
87
88
 
# File 'lib/gloo/app/engine.rb', line 84

def self.deserialize data
  e = Marshal::load( data )
  e.restore_after_deserialization
  return e
end

Instance Method Details

#app_running? ⇒ Boolean

Is there a running app?

Returns:

  • (Boolean) 


253
254
255
 
# File 'lib/gloo/app/engine.rb', line 253

def app_running?
  return @running_app ? true : false
end

#err(msg, backtrace = nil) ⇒ Object

Report an error. Write it to the log and set the heap error value.



285
286
287
288
289
290
 
# File 'lib/gloo/app/engine.rb', line 285

def err( msg, backtrace=nil )
  @log.error msg
  @heap.error.set_to msg

  @event_manager.on_error( msg, backtrace)
end

#error? ⇒ Boolean

Did the last command result in an error?

Returns:

  • (Boolean) 


277
278
279
 
# File 'lib/gloo/app/engine.rb', line 277

def error?
  return !@heap.error.value.nil?
end

#last_cmd_blank? ⇒ Boolean

Is the last command entered blank?

Returns:

  • (Boolean) 


173
174
175
176
177
178
 
# File 'lib/gloo/app/engine.rb', line 173

def last_cmd_blank?
  return true if @last_cmd.nil?
  return true if @last_cmd.strip.empty?

  return false
end

#load_files ⇒ Object

Load all file specified in the CLI.



133
134
135
 
# File 'lib/gloo/app/engine.rb', line 133

def load_files
  @args.files.each { |f| @persist_man.load( f ) }
end

#log_exception(ex) ⇒ Object

Log an exception. This function does not log the full backtrace, but does write part of it to the log.



297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/gloo/app/engine.rb', line 297

def log_exception ex
  # Get the stack trace, and if needed truncate to fit.
  msg_lines = ex.backtrace
  if msg_lines.count > 27
    msg_lines = msg_lines[0..13] + [ '... truncated ...' ] + msg_lines[-13..-1]
  end
  backtrace = msg_lines.join( "\n" )
  @log.error backtrace

  err( ex.message, backtrace)
end

#loop ⇒ Object

Prompt, Get input, process.



183
184
185
186
187
188
 
# File 'lib/gloo/app/engine.rb', line 183

def loop
  while @running
    @last_cmd = @platform.prompt.ask
    process_cmd
  end
end

#open_start_file ⇒ Object

Get the setting for the start_with file and open it.



165
166
167
168
 
# File 'lib/gloo/app/engine.rb', line 165

def open_start_file
  name = @settings.start_with
  @persist_man.load( name ) if name
end

#prep_serialize ⇒ Object

Prepare for serialization by removing any file references. Without this, the engine cannot be serialized.



69
70
71
 
# File 'lib/gloo/app/engine.rb', line 69

def prep_serialize
  @log.prep_serialize
end

#process_cmd(cmd = nil) ⇒ Object

Process the command.



193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/gloo/app/engine.rb', line 193

def process_cmd cmd=nil
  @last_cmd = cmd if cmd
  
  if last_cmd_blank?
    @platform.clear_screen
    return
  end

  begin
    @parser.run @last_cmd
  rescue => e
    log_exception e
  end
end

#quit ⇒ Object

Do any clean up and quit.



218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/gloo/app/engine.rb', line 218

def quit
  if app_running?
    @log.debug 'stopping running app...'
    stop_running_app
  end

  @log.debug 'triggering on_quit events...'
  @event_manager.on_quit

  @log.info 'Gloo engine is quitting...'
end

#restore_after_deserialization ⇒ Object

Restore the engine after deserialization.



93
94
95
 
# File 'lib/gloo/app/engine.rb', line 93

def restore_after_deserialization
  @log.restore_after_deserialization
end

#run ⇒ Object

Run in interactive mode.



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/gloo/app/engine.rb', line 140

def run
  # Open default file(s)
  self.open_start_file

  # Open any files specifed in args
  load_files

  unless @mode == Mode::SCRIPT || @args.quiet?
    self.loop
  end

  quit
end

#run_files ⇒ Object

Run files specified on the CLI. Then quit.



125
126
127
128
 
# File 'lib/gloo/app/engine.rb', line 125

def run_files
  load_files
  quit
end

#run_keep_alive ⇒ Object

Run in Embedded mode, which means we’ll start the engine, but wait for external inputs.



158
159
160
 
# File 'lib/gloo/app/engine.rb', line 158

def run_keep_alive
  @log.debug 'Running in Embedded mode...'
end

#run_mode ⇒ Object

Run gloo in the selected mode.



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/gloo/app/engine.rb', line 104

def run_mode
  @log.info "Running gloo in #{@mode} mode"

  if @mode == Mode::VERSION
    run_version
  elsif @mode == Mode::SCRIPT
    run_files
  elsif @mode == Mode::EMBED
    run_keep_alive
  elsif @mode == Mode::APP
    @settings.override_project_path @args.app_path
    run
  else
    run
  end
end

#run_version ⇒ Object

Show the version information and then quit.



265
266
267
268
 
# File 'lib/gloo/app/engine.rb', line 265

def run_version
  @platform.show Info.full_version unless @args.quiet?
  quit
end

#serialize ⇒ Object

Get the serialized version of this Engine.



76
77
78
79
 
# File 'lib/gloo/app/engine.rb', line 76

def serialize
  prep_serialize
  Marshal::dump( self )
end

#start ⇒ Object

Start the engine. Load object and verb definitions and setup engine elements.



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/gloo/app/engine.rb', line 40

def start
  @log.debug 'starting the engine...'
  @log.debug Gloo::App::Info.display_title
  @mode = @args.detect_mode
  @running = true

  @dictionary = Gloo::Core::Dictionary.get

  @parser = Gloo::Core::Parser.new( self )
  @heap = Gloo::Core::Heap.new( self )
  @factory = Gloo::Core::Factory.new( self )
  @persist_man = Gloo::Persist::PersistMan.new( self )
  @event_manager = Gloo::Core::EventManager.new( self )

  @exec_env = Gloo::Exec::ExecEnv.new( self )
  @converter = Gloo::Convert::Converter.new( self )

  @log.info 'The gloo engine has started'
  run_mode
end

#start_running_app(obj) ⇒ Object

Set the running app object within gloo.



237
238
239
240
 
# File 'lib/gloo/app/engine.rb', line 237

def start_running_app( obj )
  @running_app = Gloo::App::RunningApp.new( obj, self )
  @running_app.start
end

#stop_running ⇒ Object

Request the engine to stop running.



211
212
213
 
# File 'lib/gloo/app/engine.rb', line 211

def stop_running
  @running = false
end

#stop_running_app ⇒ Object

Stop the running app object within gloo.



245
246
247
248
 
# File 'lib/gloo/app/engine.rb', line 245

def stop_running_app
  @running_app.stop if @running_app
  @running_app = nil
end