gloo-lang 0.9.0 → 0.9.3

data/lib/gloo_lang/verbs/help.rb

@@ -0,0 +1,264 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# Show the help information.
+#
+
+module GlooLang
+  module Verbs
+    class Help < GlooLang::Core::Verb
+
+      KEYWORD = 'help'.freeze
+      KEYWORD_SHORT = '?'.freeze
+      DEFAULT_HELP = 'default_help'.freeze
+      HELP_NOT_FOUND_ERR = 'Help command could not be found:'.freeze
+
+      DISPATCH = {
+        settings: 'show_settings',
+        keywords: 'show_keywords',
+        verb: 'show_verbs',
+        verbs: 'show_verbs',
+        v: 'show_verbs',
+        obj: 'show_objs',
+        object: 'show_objs',
+        objects: 'show_objs',
+        o: 'show_objs',
+        topics: 'show_topics'
+      }.freeze
+
+      #
+      # Run the verb.
+      #
+      def run
+        opts = @tokens.second if @tokens
+        opts = opts.strip.downcase if opts
+
+        if opts
+          dispatch opts
+        else
+          $engine.help.page_topic DEFAULT_HELP
+        end
+      end
+
+      #
+      # Get the text for the list of verbs.
+      #
+      def get_verb_list
+        out = "Verbs:\n"
+        str = ''
+        verbs = $engine.dictionary.get_verbs.sort_by( &:keyword )
+        verbs.each_with_index do |v, i|
+          cut = v.keyword_shortcut.ljust( 5, ' ' )
+          str << " #{cut} #{v.keyword.ljust( 20, ' ' )}"
+          if ( ( i + 1 ) % 3 ).zero?
+            out << "#{str}\n"
+            str = ''
+          end
+        end
+
+        return out
+      end
+
+      #
+      # Lookup the opts in the dispatch table.
+      #
+      def lookup_opts( opts )
+        return DISPATCH[ opts.to_sym ]
+      end
+
+      #
+      # Get the text for the list of verbs.
+      #
+      def get_obj_list
+        out = "Object Types:\n"
+        str = ''
+        objs = $engine.dictionary.get_obj_types.sort_by( &:typename )
+        objs.each_with_index do |o, i|
+          name = o.typename
+          if o.short_typename != o.typename
+            name = "#{name} (#{o.short_typename})"
+          end
+          str << " #{name.ljust( 30, ' ' )}"
+          if ( ( i + 1 ) % 4 ).zero?
+            out << "#{str}\n"
+            str = ''
+          end
+        end
+
+        return out
+      end
+
+      #
+      # Get the list of help topics.
+      #
+      def get_topics
+        out = "Help Topics:\n"
+        str = ''
+        objs = $engine.help.topics.keys.sort
+        objs.each_with_index do |o, i|
+          str << " #{o.ljust( 30, ' ' )}"
+          if ( ( i + 1 ) % 4 ).zero?
+            out << "#{str}\n"
+            str = ''
+          end
+        end
+
+        return out
+      end
+
+      #
+      # Get the Verb's keyword.
+      #
+      def self.keyword
+        return KEYWORD
+      end
+
+      #
+      # Get the Verb's keyword shortcut.
+      #
+      def self.keyword_shortcut
+        return KEYWORD_SHORT
+      end
+
+      # ---------------------------------------------------------------------
+      #    Private functions
+      # ---------------------------------------------------------------------
+
+      private
+
+      #
+      # Report an error with the inline help.
+      #
+      def report_help_error( opts )
+        $engine.err "#{HELP_NOT_FOUND_ERR} '#{opts}'"
+      end
+
+      #
+      # Dispatch the help to the right place.
+      #
+      def dispatch( opts )
+        return if dispatch_help_page( opts )
+
+        $log.debug 'looking for built in help topic'
+        cmd = DISPATCH[ opts.to_sym ]
+        if cmd
+          $log.debug 'found help index'
+          send cmd
+        else
+          $log.debug 'looking for entity help'
+          entity_help opts
+        end
+      rescue
+        report_help_error opts
+      end
+
+      #
+      # Dispatch to a help page if we can find one.
+      #
+      def dispatch_help_page( opts )
+        if $engine.help.topic? opts
+          $log.debug 'found expanded help topic'
+          $engine.help.page_topic opts
+          return true
+        end
+
+        key = $engine.dictionary.lookup_keyword opts
+        if $engine.help.topic? key
+          $log.debug 'found expanded help topic'
+          $engine.help.page_topic key
+          return true
+        end
+
+        return false
+      end
+
+      #
+      # Write output to it and show it unless we are in
+      # silent mode.
+      #
+      def show_output( out )
+        $engine.heap.it.set_to out
+        puts out unless $engine.args.quiet?
+      end
+
+      #
+      # List all help topics (articles)
+      #
+      def show_topics
+        out = self.get_topics
+        show_output out
+      end
+
+      #
+      # Dispatch the help command to a verb or object
+      # if we can find one matching the request.
+      #
+      def entity_help( opts )
+        return if try_verb_help opts
+        return if try_object_help opts
+
+        report_help_error opts
+      end
+
+      #
+      # See if there is a verb we can show help
+      # information about.
+      #
+      def try_verb_help( opts )
+        if $engine.dictionary.verb?( opts )
+          t = $engine.dictionary.find_verb( opts )
+          out = t.send 'help'
+          show_output out
+          return true
+        end
+
+        return false
+      end
+
+      #
+      # See if there is a verb we can show help
+      # information about.
+      #
+      def try_object_help( opts )
+        if $engine.dictionary.obj?( opts )
+          t = $engine.dictionary.find_obj( opts )
+          out = t.send 'help'
+          show_output out
+          return true
+        end
+
+        return false
+      end
+
+      #
+      # Show application settings.
+      #
+      def show_settings
+        $settings.show
+      end
+
+      #
+      # Show all keywords: verbs and objects.
+      #
+      def show_keywords
+        $engine.dictionary.show_keywords
+      end
+
+      #
+      # List the verbs
+      #
+      def show_verbs
+        show_output get_verb_list
+      end
+
+      #
+      # List the object types
+      #
+      def show_objs
+        out = self.get_obj_list
+        show_output out
+      end
+
+    end
+  end
+end

data/lib/gloo_lang/verbs/if.rb

@@ -0,0 +1,92 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# If something is true, do something.
+#
+
+module GlooLang
+  module Verbs
+    class If < GlooLang::Core::Verb
+
+      KEYWORD = 'if'.freeze
+      KEYWORD_SHORT = 'if'.freeze
+      THEN = 'then'.freeze
+      MISSING_EXPR_ERR = 'Missing Expression!'.freeze
+
+      #
+      # Run the verb.
+      #
+      def run
+        value = value_tokens
+        return if value.nil?
+
+        return unless evals_true( value )
+
+        run_then
+      end
+
+      #
+      # Get the Verb's keyword.
+      #
+      def self.keyword
+        return KEYWORD
+      end
+
+      #
+      # Get the Verb's keyword shortcut.
+      #
+      def self.keyword_shortcut
+        return KEYWORD_SHORT
+      end
+
+      # ---------------------------------------------------------------------
+      #    Private functions
+      # ---------------------------------------------------------------------
+
+      private
+
+      #
+      # Get the list of tokens that represent the parameters
+      # of the if command.
+      #
+      def value_tokens
+        value = @tokens.before_token( THEN )
+        if value && value.count > 1
+          # The first token is the verb, so we drop it.
+          value = value[ 1..-1 ]
+        else
+          $engine.err MISSING_EXPR_ERR
+        end
+
+        return value
+      end
+
+      #
+      # Does the given value evalute to true?
+      #
+      def evals_true( value )
+        eval_result = false
+        if value.count.positive?
+          expr = GlooLang::Expr::Expression.new( value )
+          result = expr.evaluate
+          eval_result = true if result == true
+          eval_result = true if result.is_a?( Numeric ) && result != 0
+        end
+
+        return eval_result
+      end
+
+      #
+      # Run the 'then' command.
+      #
+      def run_then
+        cmd = @tokens.expr_after( THEN )
+        i = $engine.parser.parse_immediate cmd
+        return unless i
+
+        i.run
+      end
+
+    end
+  end
+end

data/lib/gloo_lang/verbs/list.rb

@@ -0,0 +1,98 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# List out an object and it's children.
+#
+
+module GlooLang
+  module Verbs
+    class List < GlooLang::Core::Verb
+
+      KEYWORD = 'list'.freeze
+      KEYWORD_SHORT = '.'.freeze
+      TARGET_MISSING_ERR = 'Object does not exist: '.freeze
+
+      #
+      # Run the verb.
+      #
+      def run
+        levels = determine_levels
+        target = self.determine_target
+        obj = target.resolve
+        if obj
+          show_target( obj, levels )
+        else
+          $engine.err "#{TARGET_MISSING_ERR} #{target}"
+        end
+      end
+
+      #
+      # Determine the target object for the show command.
+      #
+      def determine_target
+        return $engine.heap.context if @tokens.token_count == 1
+
+        return GlooLang::Core::Pn.new( @tokens.second )
+      end
+
+      #
+      # Get the Verb's keyword.
+      #
+      def self.keyword
+        return KEYWORD
+      end
+
+      #
+      # Get the Verb's keyword shortcut.
+      #
+      def self.keyword_shortcut
+        return KEYWORD_SHORT
+      end
+
+      # ---------------------------------------------------------------------
+      #    Private functions
+      # ---------------------------------------------------------------------
+
+      private
+
+      #
+      # Show the target object.
+      #
+      def show_target( obj, levels, indent = '' )
+        show_obj( obj, indent )
+        return if levels.zero?
+
+        obj.children.each do |o|
+          show_target( o, levels - 1, "#{indent}  " )
+        end
+      end
+
+      #
+      # Show object in standard format.
+      #
+      def show_obj( obj, indent = '  ' )
+        if obj.multiline_value? && obj.value_is_array?
+          $log.show "#{indent}#{obj.name} [#{obj.type_display}] :"
+          obj.value.each do |line|
+            $log.show "#{indent}  #{line}"
+          end
+        else
+          $log.show "#{indent}#{obj.name} [#{obj.type_display}] : #{obj.value}"
+        end
+      end
+
+      #
+      # Determine how many levels to show.
+      #
+      def determine_levels
+        # Check settings for the default value.
+        levels = $settings.list_indent
+        return levels if levels
+
+        # Last chance: use the default
+        return 1
+      end
+
+    end
+  end
+end

data/lib/gloo_lang/verbs/load.rb

@@ -0,0 +1,45 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# Save an object to a file or other persistance mechcanism.
+#
+
+module GlooLang
+  module Verbs
+    class Load < GlooLang::Core::Verb
+
+      KEYWORD = 'load'.freeze
+      KEYWORD_SHORT = '<'.freeze
+      MISSING_EXPR_ERR = 'Missing Expression!'.freeze
+
+      #
+      # Run the verb.
+      #
+      def run
+        fn = @tokens.second
+
+        if fn
+          $log.debug "Getting ready to load file: #{fn}"
+          $engine.persist_man.load fn
+        else
+          $engine.err MISSING_EXPR_ERR
+        end
+      end
+
+      #
+      # Get the Verb's keyword.
+      #
+      def self.keyword
+        return KEYWORD
+      end
+
+      #
+      # Get the Verb's keyword shortcut.
+      #
+      def self.keyword_shortcut
+        return KEYWORD_SHORT
+      end
+
+    end
+  end
+end

data/lib/gloo_lang/verbs/move.rb

@@ -0,0 +1,89 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Move an object to a new parent.
+#
+
+module GlooLang
+  module Verbs
+    class Move < GlooLang::Core::Verb
+
+      KEYWORD = 'move'.freeze
+      KEYWORD_SHORT = 'mv'.freeze
+      TO = 'to'.freeze
+      MISSING_SRC_ERR = 'Object to move was not specified!'.freeze
+      MISSING_SRC_OBJ_ERR = 'Could not find object to move: '.freeze
+      MISSING_DST_ERR = "Move' must include 'to' parent object!".freeze
+      MISSING_DST_OBJ_ERR = 'Could not resolve target: '.freeze
+
+      #
+      # Run the verb.
+      #
+      def run
+        dst = lookup_dst
+        return if dst.nil?
+
+        o = lookup_obj
+        return unless o
+
+        o.parent.remove_child o
+        dst.add_child o
+      end
+
+      #
+      # Get the Verb's keyword.
+      #
+      def self.keyword
+        return KEYWORD
+      end
+
+      #
+      # Get the Verb's keyword shortcut.
+      #
+      def self.keyword_shortcut
+        return KEYWORD_SHORT
+      end
+
+      # ---------------------------------------------------------------------
+      #    Private functions
+      # ---------------------------------------------------------------------
+
+      private
+
+      #
+      # Lookup the object that we're moving.
+      #
+      def lookup_obj
+        arr = @tokens.before_token( TO )
+        if arr.count == 1
+          $engine.err MISSING_SRC_ERR
+          return
+        end
+
+        name = arr[ 1 ]
+        pn = GlooLang::Core::Pn.new name
+        o = pn.resolve
+
+        $engine.err( "#{MISSING_SRC_OBJ_ERR} #{name}" ) unless o
+        return o
+      end
+
+      #
+      # Lookup destination, the new parent object.
+      #
+      def lookup_dst
+        dst = @tokens.after_token( TO )
+        unless dst
+          $engine.err MISSING_DST_ERR
+          return nil
+        end
+
+        pn = GlooLang::Core::Pn.new dst
+        o = pn.resolve
+        $engine.err( "#{MISSING_DST_OBJ_ERR} '#{dst}'" ) unless o
+        return o
+      end
+
+    end
+  end
+end

data/lib/gloo_lang/verbs/put.rb

@@ -0,0 +1,94 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# Create an object, optionally of a type.
+#
+
+module GlooLang
+  module Verbs
+    class Put < GlooLang::Core::Verb
+
+      KEYWORD = 'put'.freeze
+      KEYWORD_SHORT = 'p'.freeze
+      INTO = 'into'.freeze
+      MISSING_EXPR_ERR = 'Missing Expression!'.freeze
+      INTO_MISSING_ERR = 'Target (into) missing!'.freeze
+      TARGET_ERR = 'Target could not be resolved: '.freeze
+
+      #
+      # Run the verb.
+      #
+      def run
+        value = fetch_value_tokens
+        return if value.nil?
+
+        target = lookup_target
+        return if target.nil?
+
+        update_target target, value
+      end
+
+      #
+      # Get the Verb's keyword.
+      #
+      def self.keyword
+        return KEYWORD
+      end
+
+      #
+      # Get the Verb's keyword shortcut.
+      #
+      def self.keyword_shortcut
+        return KEYWORD_SHORT
+      end
+
+      # ---------------------------------------------------------------------
+      #    Private functions
+      # ---------------------------------------------------------------------
+
+      private
+
+      #
+      # Get the value that is being put.
+      #
+      def fetch_value_tokens
+        value = @tokens.before_token( INTO )
+        if value.nil? || ( value.count <= 1 )
+          $engine.err MISSING_EXPR_ERR
+          return nil
+        end
+
+        # The first token is the verb, so we drop it.
+        return value[ 1..-1 ]
+      end
+
+      #
+      # Lookup the target of the put command.
+      #
+      def lookup_target
+        target = @tokens.after_token( INTO )
+        return target if target
+
+        $engine.err INTO_MISSING_ERR
+        return nil
+      end
+
+      #
+      # Update the target with the new value.
+      #
+      def update_target( target, value )
+        pn = GlooLang::Core::Pn.new target
+        o = pn.resolve
+        if o.nil?
+          $engine.err "#{TARGET_ERR} #{target}"
+        elsif value.count.positive?
+          expr = GlooLang::Expr::Expression.new( value )
+          result = expr.evaluate
+          o.set_value result
+          $engine.heap.it.set_to result
+        end
+      end
+
+    end
+  end
+end

data/lib/gloo_lang/verbs/quit.rb

@@ -0,0 +1,40 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# Quit the running gloo engine.
+#
+
+module GlooLang
+  module Verbs
+    class Quit < GlooLang::Core::Verb
+
+      KEYWORD = 'quit'.freeze
+      KEYWORD_SHORT = 'q'.freeze
+
+      #
+      # Run the verb.
+      #
+      # We'll mark the application as not running and let the
+      # engine stop gracefully next time through the loop.
+      #
+      def run
+        $engine.stop_running
+      end
+
+      #
+      # Get the Verb's keyword.
+      #
+      def self.keyword
+        return KEYWORD
+      end
+
+      #
+      # Get the Verb's keyword shortcut.
+      #
+      def self.keyword_shortcut
+        return KEYWORD_SHORT
+      end
+
+    end
+  end
+end