diff options
| -rw-r--r-- | dragon/console.rb | 376 | ||||
| -rw-r--r-- | dragon/index.rb | 1 | ||||
| -rw-r--r-- | readme.md | 30 |
3 files changed, 407 insertions, 0 deletions
diff --git a/dragon/console.rb b/dragon/console.rb new file mode 100644 index 0000000..fb74da1 --- /dev/null +++ b/dragon/console.rb @@ -0,0 +1,376 @@ +# Copyright 2019 DragonRuby LLC + +# console.rb has been released under MIT (*only this file*). + +module GTK + class Console + attr_accessor :show_reason, :log, :prompt, :logo, :background_color, + :text_color, :cursor_color, :font, :animation_duration, + :max_log_lines, :max_history, :current_input_str, :log, + :last_command_errored, :last_command, :error_color, :shown_at, + :header_color + + def initialize + @disabled = false + @current_input_str = '' + @log_offset = 0 + @visible = false + @toast_ids = [] + @log = [ 'Console ready.' ] + @max_log_lines = 100 # I guess...? + @max_history = 100 # I guess...? + @command_history = [] + @command_history_index = -1 + @nonhistory_input = '' + @prompt = '-> ' + @logo = 'console-logo.png' + @history_fname = 'console_history.txt' + @background_color = [ 0, 0, 0, 224 ] + @text_color = [ 255, 255, 255, 255 ] + @error_color = [ 200, 50, 50, 255] + @header_color = [ 100, 200, 220, 255] + @cursor_color = [ 187, 21, 6, 255 ] + @font = 'font.ttf' + @animation_duration = 1.seconds + @current_input_str = '' + @shown_at = -1 + load_history + end + + def save_history + str = '' + @command_history.reverse_each { |s| str << s ; str << "\n" } + $gtk.ffi_file.storefile(@history_fname, str) + end + + def load_history + @command_history.clear + str = $gtk.ffi_file.loadfile(@history_fname) + return if str.nil? # no history to load. + + str.chomp!("\n") # Don't let endlines at the end cause extra blank line. + str.chomp!("\r") + str.each_line { |s| + s.chomp!("\n") + s.chomp!("\r") + if s.length > 0 + @command_history.unshift s + break if @command_history.length >= @max_history + end + } + end + + def disable + @disabled = true + end + + def enable + @disabled = false + end + + def console_text_width + 117 + end + + def addtext obj + str = obj.to_s + str.each_line { |s| + @log.shift if @log.length > 1000 + s.wrapped_lines(console_text_width).each do |l| + @log << l + end + } + end + + def ready? + visible? && @toggled_at.elapsed?(@animation_duration, Kernel.global_tick_count) + end + + def hidden? + !@visible + end + + def visible? + @visible + end + + def show reason = nil + @shown_at = Kernel.global_tick_count + @show_reason = reason + toggle if hidden? + end + + def hide + if visible? + toggle + @show_reason = nil + clear_toast + end + end + + def close + hide + end + + def clear + @log.clear + end + + def clear_toast + @toasted_at = nil + @toast_duration = 0 + end + + def toggle + @visible = !@visible + @toggled_at = Kernel.global_tick_count + end + + def currently_toasting? + return false if hidden? + return false unless @show_reason == :toast + return false unless @toasted_at + return false if @toasted_at.elapsed?(5.seconds, Kernel.global_tick_count) + return true + end + + def toast_extended id = nil, duration = nil, *messages + if !id.is_a?(Symbol) + raise <<-S +ERROR: +args.gtk.console.toast has the following signature: + + def toast id, *messages + end + +The id property uniquely defines the message and must be +a symbol. + +After that, you can provide all the objects you want to +look at. + +Example: + + args.gtk.console.toast :say_hello, + \"Hello world.\", + args.state.tick_count + +Toast messages autohide after 5 seconds. + +If you need to look at something for longer, use +args.gtk.console.perma_toast instead (which you can manually dismiss). + +S + end + + return if currently_toasting? + return if @toast_ids.include? id + @toasted_at = Kernel.global_tick_count + log_once_info :perma_toast_tip, "Use console.perma_toast to show the toast for longer." + dwim_duration = 5.seconds + messages.each do |message| + lines = message.to_s.wrapped_lines(console_text_width) + dwim_duration += lines.length.seconds + log message.to_s.wrap(console_text_width) + end + show :toast + @toast_duration += duration || dwim_duration + @toast_ids << id + end + + def perma_toast id = nil, messages + toast_extended id, 600.seconds, *messages + end + + def toast id = nil, *messages + toast_extended id, nil, *messages + end + + def console_toggle_key_down? args + return args.inputs.keyboard.key_down.backtick! || + args.inputs.keyboard.key_down.superscript_two! || + args.inputs.keyboard.key_down.section_sign! || + args.inputs.keyboard.key_down.ordinal_indicator! + end + + def process_inputs args + if console_toggle_key_down? args + args.inputs.text.clear + toggle + end + + return unless visible? + + args.inputs.text.each { |str| @current_input_str << str } + args.inputs.text.clear + + if args.inputs.keyboard.key_down.enter + cmd = @current_input_str.strip + if cmd.length != 0 + @log_offset = 0 + @current_input_str = '' + + @command_history.pop while @command_history.length >= @max_history + @command_history.unshift cmd + @command_history_index = -1 + @nonhistory_input = '' + + if cmd == 'quit' || cmd == ':wq' || cmd == ':q!' || cmd == ':q' || cmd == ':wqa' + $gtk.request_quit + else + puts "-> #{cmd}" + begin + @last_command = cmd + $gtk.ffi_mrb.eval("$results = (#{cmd})") + if $results.nil? + puts "=> nil" + else + puts "=> #{$results}" + end + @last_command_errored = false + rescue Exception => e + @last_command_errored = true + puts "#{e}" + log "#{e}" + end + end + end + elsif args.inputs.keyboard.key_down.v + if args.inputs.keyboard.key_down.control || args.inputs.keyboard.key_down.meta + @current_input_str << $gtk.ffi_misc.getclipboard + end + elsif args.inputs.keyboard.key_down.up + if @command_history_index == -1 + @nonhistory_input = @current_input_str + end + if @command_history_index < (@command_history.length - 1) + @command_history_index += 1 + @current_input_str = @command_history[@command_history_index].clone + end + elsif args.inputs.keyboard.key_down.down + if @command_history_index == 0 + @command_history_index = -1 + @current_input_str = @nonhistory_input + @nonhistory_input = '' + elsif @command_history_index > 0 + @command_history_index -= 1 + @current_input_str = @command_history[@command_history_index].clone + end + elsif args.inputs.keyboard.key_down.pageup + fontwidth, fontheight = $gtk.calcstringbox 'W', 1, @font # we only need the height of a line of text here. + lines_on_one_page = (720.0 / fontheight).to_i - 4 + @log_offset += lines_on_one_page + @log_offset = @log.size if @log_offset > @log.size + elsif args.inputs.keyboard.key_down.pagedown + fontwidth, fontheight = $gtk.calcstringbox 'W', 1, @font # we only need the height of a line of text here. + lines_on_one_page = (720.0 / fontheight).to_i - 4 + @log_offset -= lines_on_one_page + @log_offset = 0 if @log_offset < 0 + elsif args.inputs.keyboard.key_down.escape + @current_input_str.clear + @command_history_index = -1 + @nonhistory_input = '' + elsif args.inputs.keyboard.key_down.backspace || args.inputs.keyboard.key_down.delete + @current_input_str.chop! + end + + args.inputs.keyboard.key_down.clear + args.inputs.keyboard.key_up.clear + args.inputs.keyboard.key_held.clear + end + + def render args + return if !@toggled_at + + if visible? + percent = @toggled_at.ease_using_global_tick_count(@animation_duration, :flip, :quint, :flip) + else + percent = @toggled_at.ease_using_global_tick_count(@animation_duration, :flip, :quint) + end + + return if percent == 0 + + w, h = $gtk.calcstringbox 'W', 1, @font # we only need the height of a line of text here. + + top = $gtk.args.grid.top + left = $gtk.args.grid.left + y = top - (720.0 * percent) + args.outputs.reserved << [left, y, 1280, 720, @background_color[0], @background_color[1], @background_color[2], (@background_color[3].to_f * percent).to_i].solid + + logo_y = y + + txtinfo = [ @text_color[0], @text_color[1], @text_color[2], (@text_color[3].to_f * percent).to_i, @font ] + errorinfo = [ @error_color[0], @error_color[1], @error_color[2], (@error_color[3].to_f * percent).to_i, @font ] + cursorinfo = [ @cursor_color[0], @cursor_color[1], @cursor_color[2], (@cursor_color[3].to_f * percent).to_i, @font ] + headerinfo = [ @header_color[0], @header_color[1], @header_color[2], (@header_color[3].to_f * percent).to_i, @font ] + + y += 2 # just give us a little padding at the bottom. + y += h # !!! FIXME: remove this when we fix coordinate origin on labels. + args.outputs.reserved << [left + 1280 - 210, logo_y + 540, 200, 200, @logo, 0, (80.0 * percent).to_i].sprite + args.outputs.reserved << [left + 10, y, "#{@prompt}#{@current_input_str}", 1, 0, *txtinfo].label + args.outputs.reserved << [left + 8, y + 3, (" " * (prompt.length + @current_input_str.length)) + "|", 1, 0, *cursorinfo ].label + y += h.to_f / 2.0 + args.outputs.reserved << [left + 0, y, 1280, y, *txtinfo].line + y += h.to_f / 2.0 + y += h # !!! FIXME: remove this when we fix coordinate origin on labels. + + ((@log.size - @log_offset) - 1).downto(0) do |idx| + str = @log[idx] || "" + if include_error_marker? str + args.outputs.reserved << [left + 10, y, str, 1, 0, *errorinfo].label + elsif str.start_with? "====" + args.outputs.reserved << [left + 10, y, str, 1, 0, *headerinfo].label + else + args.outputs.reserved << [left + 10, y, str, 1, 0, *txtinfo].label + end + y += h + break if y > top + end + end + + def include_error_marker? text + error_markers.any? { |e| text.downcase.include? e } + end + + def error_markers + ["exception:", "error:", "undefined method", "failed", "syntax"] + end + + def calc args + if visible? && + @show_reason == :toast && + @toasted_at && + @toasted_at.elapsed?(@toast_duration, Kernel.global_tick_count) + hide + end + + if !$gtk.paused? && visible? && show_reason == :exception + hide + end + + if $gtk.files_reloaded.length > 0 + clear_toast + @toast_ids.clear + end + end + + def tick args + begin + return if @disabled + render args + calc args + process_inputs args + rescue Exception => e + @disabled = true + $stdout.puts e + $stdout.puts "The GTK::Console console threw an unhandled exception and has been reset. You should report this exception (along with reproduction steps) to DragonRuby." + end + end + + def set_command command, show_reason = nil + @command_history << command + @current_input_str = command + show show_reason + end + end +end diff --git a/dragon/index.rb b/dragon/index.rb new file mode 100644 index 0000000..8a1460c --- /dev/null +++ b/dragon/index.rb @@ -0,0 +1 @@ +require 'app/dragon/console.rb' diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..9ecdcc9 --- /dev/null +++ b/readme.md @@ -0,0 +1,30 @@ +# How to Use + +This repository requires DragonRuby Game Toolkit. You can purchase a license from http://dragonruby.org. + +If your income is below $1000 per month, are a "student", or are a "big time Raspberry PI enthusiast", contact Amir at [email protected] with a short explanation of your current situation, and he'll set you up with a free license, no questions asked. + +1. Download DragonRuby Game Toolkit. +2. Unzip. +3. Navigate to your game folder using terminal (the default game folder is `./mygame/app`) +4. `git clone https://github.com/DragonRuby/dragonruby-game-toolkit-contrib` or download and unzip into the `./mygame/app` directory. +5. Your directory structures should look like the following: + +``` +DragonRuby +| ++- mygame/ + | + +- app/ + | + +- main.rb + +- repl.rb + +- documentation/ + | + +- dragon/ (this repository) + | + +- index.rb + +- other source files +``` + +5. Open `main.rb` and add the following to the top of the file: `require "app/dragon/index.rb"` |