gloo-lang 1.0.2 → 1.2.1

data/lib/gloo_lang/help/verbs/list.txt

@@ -1,34 +0,0 @@
-LIST VERB
-  NAME: list
-  SHORTCUT: .
-
-  DESCRIPTION
-    List out objects (and children) at the current context.
-    When a path is provided, it will be listed instead of the
-    current context.
-
-    When using context, the current context will be shown, but
-    when context has not been set, the root will be shown.
-
-  SYNTAX
-    list <path.to.object>
-
-  PARAMETERS
-    path.to.object - Optional path to object that will be listed.
-                     When no path is provided, the current context is used.
-
-  RESULT
-    Object and children are listed out in the CLI.
-
-  ERRORS
-    Object does not exist
-      - The object specified that is to be listed could not be found.
-
-  EXAMPLE
-
-    > list
-    > list my.container
-    > list root
-
-  SEE ALSO
-    context

data/lib/gloo_lang/help/verbs/load.txt

@@ -1,38 +0,0 @@
-LOAD VERB
-  NAME: load
-  SHORTCUT: <
-
-  DESCRIPTION
-    Load an object file.
-    There are two ways to specify the file.  Give either the full path
-    and file name or use a relative path from the gloo project folder.
-    For the latter, the extension is not needed.  For the former, the
-    file extension is necessary.
-    
-    Using * instead of a file name will load all gloo files in the folder.
-
-  SYNTAX
-    load <file_name>
-
-  PARAMETERS
-    file_name - Name of the object file that is to be loaded.
-
-  RESULT
-    Objects are loaded into the heap.
-    on_load scripts are run within the loaded objects.
-
-  ERRORS
-    Missing Expression!
-      - No expression is provided as parameter to the verb.
-
-    If the file specified can't be found or can't be loaded,
-    an error condition will result.
-
-  EXAMPLE
-
-    > load my/project/file
-    > load my/app/*
-    > load ~/.my_app/settings.gloo
-
-  SEE ALSO
-    save

data/lib/gloo_lang/help/verbs/move.txt

@@ -1,42 +0,0 @@
-MOVE VERB
-  NAME: move
-  SHORTCUT: mv
-
-  DESCRIPTION
-    Move an object to a new parent.
-
-  SYNTAX
-    move <path.to.object> to <new.parent>
-
-  PARAMETERS
-    path.to.object - The object that we want to move.
-    new.parent - The new location for the object.
-
-  RESULT
-    The object will now be in the new location.
-
-  ERRORS
-    Object to move was not specified
-      - The <path.to.object> is not specified.
-
-    Could not find object to move
-      - The <path.to.object> cannot be resolved.
-
-    Move' must include 'to' parent object
-      - The 'to' keyword is missing.
-      - The <new.parent> is not specified.
-
-    Could not resolve target
-      - The <new.parent> cannot be resolved.
-
-  EXAMPLE
-
-    can [can] :
-      two [string] : def
-      data [can] :
-        one [string] : abc
-      on_load [script] :
-        move can.two to can.data
-
-  SEE ALSO
-    create

data/lib/gloo_lang/help/verbs/put.txt

@@ -1,38 +0,0 @@
-PUT VERB
-  NAME: put
-  SHORTCUT: p
-
-  DESCRIPTION
-    Put a value into an object.
-    The value is the result of an expression.
-
-  SYNTAX
-    put <expression> into <dst.path>
-
-  PARAMETERS
-    expression - The expression that is evaluated.
-    dst.path - The path to the destination object.
-
-  RESULT
-    <it> will contain the result of the evaluation.
-
-  ERRORS
-    Missing Expression
-      - The 'into' keyword is missing.
-      - No source expression is provided.
-
-    Target (into) missing
-      - The destination is not specified.
-
-    Target could not be resolved
-      - The destination of the put cannot be resolved.
-
-  EXAMPLE
-
-    > put 'one' into str
-    > put "two" into str
-    > put 123 into x
-    > put 3 + 5 into x
-    > put TRUE into flag
-
-  SEE ALSO

data/lib/gloo_lang/help/verbs/quit.txt

@@ -1,25 +0,0 @@
-QUIT VERB
-  NAME: quit
-  SHORTCUT: q
-
-  DESCRIPTION
-    Stop running the gloo application.
-    Cleanup and shutdown.
-
-  SYNTAX
-    quit
-
-  PARAMETERS
-    None
-
-  RESULT
-    None
-
-  ERRORS
-    None
-
-  EXAMPLE
-
-    > quit
-
-  SEE ALSO

data/lib/gloo_lang/help/verbs/run.txt

@@ -1,41 +0,0 @@
-RUN VERB
-  NAME: run
-  SHORTCUT: r
-
-  DESCRIPTION
-    Run a script or other object.
-    This is the same as sending a 'run' message to the object.
-
-  SYNTAX
-    run <path.to.object>
-    run ~> <expression>
-
-  PARAMETERS
-    path.to.object
-      - Reference to the object which will be run.
-      - The object must be a runnable object such as a script.
-
-    expression
-      - Evaluate the expression and run it.
-
-
-  RESULT
-    The result depends on the object that is run.
-
-  ERRORS
-    Missing Expression!
-      - No expression is provided as parameter to the verb.
-
-  EXAMPLE
-
-    > run my.script
-
-    > create s as script : "show 3 + 4"
-    > run s
-
-    Run a script in an evaluated expression:
-    > create s as string : "show 3 + 4"
-    > run ~> s
-
-  SEE ALSO
-    tell

data/lib/gloo_lang/help/verbs/save.txt

@@ -1,26 +0,0 @@
-SAVE VERB
-  NAME: save
-  SHORTCUT: >
-
-  DESCRIPTION
-    Save a previously loaded object to .gloo file.  The path will be for the
-    root level object that was loaded earlier.
-
-  SYNTAX
-    save <path.to.object>
-
-  PARAMETERS
-    path.to.object - Name of the object file that is to be saved.
-
-  RESULT
-    The file is updated with the latest object state.
-
-  ERRORS
-    None
-
-  EXAMPLE
-
-    > save my_obj
-
-  SEE ALSO
-    load

data/lib/gloo_lang/help/verbs/show.txt

@@ -1,30 +0,0 @@
-SHOW VERB
-  NAME: show
-  SHORTCUT: =
-
-  DESCRIPTION
-    Show an object's value.
-
-  SYNTAX
-    show <path.to.object>
-
-  PARAMETERS
-    path.to.object - The object that we want to see.
-
-  RESULT
-    The object's value is shown.
-    <it> will contain the object's value.
-
-  ERRORS
-    None
-
-  EXAMPLE
-
-    > show "me"
-    > show "hello " "world"
-    > show 132 * 23
-
-    > create x : "boo"
-    > show x
-
-  SEE ALSO

data/lib/gloo_lang/help/verbs/tell.txt

@@ -1,34 +0,0 @@
-TELL VERB
-  NAME: tell
-  SHORTCUT: ->
-
-  DESCRIPTION
-    Send a message to an object.
-    Ask the object to perform an action.
-
-  SYNTAX
-    tell <path.to.object> to <message>
-
-  PARAMETERS
-    path.to.object - The object that we want to see.
-    message - The message to send.
-
-  RESULT
-    The result depends on the message that is sent.
-
-  ERRORS
-    Missing message!
-      - No message was specified, or the 'to' keyword is missing.
-
-    Object was not found
-      - The target of the message was not found.
-
-  EXAMPLE
-
-    > tell an.obj to unload
-    > tell the.script to run
-    > tell my.str to up
-    > tell the.container to count
-    
-  SEE ALSO
-    run

data/lib/gloo_lang/help/verbs/unless.txt

@@ -1,38 +0,0 @@
-UNLESS VERB
-  NAME: unless
-  SHORTCUT: if!
-
-  DESCRIPTION
-    Unless an expression is true, do something.
-    This is the opposite of the if verb.
-
-  SYNTAX
-    unless <true> do <command>
-
-  PARAMETERS
-    true - Does the expression evaluate to true?
-    command - Execute command if the expression is not true.
-
-  RESULT
-    Unchanged if the expression is true.
-    If not true, then the result will be based on the command
-    specified after the 'do' keyword.
-
-  ERRORS
-    Missing Expression!
-      - No expression is provided as parameter to the verb.
-
-    Other errors depend on the command that is run.
-
-  EXAMPLE
-
-    unless [container] :
-      x [bool] : true
-      false_msg [string] : It is NOT true!
-      on_load [script] :
-        unless unless.x do show "first time: " + unless.false_msg
-        put false into unless.x
-        unless unless.x do show "second time: " +  unless.false_msg
-
-  SEE ALSO
-    if

data/lib/gloo_lang/help/verbs/version.txt

@@ -1,32 +0,0 @@
-VERSION VERB
-  NAME: version
-  SHORTCUT: v
-
-  DESCRIPTION
-    Show the application version information.
-
-    This is the same as showing the version by running gloo
-    with the --version command line parameter.
-
-  SYNTAX
-    version
-
-  PARAMETERS
-    None
-
-  RESULT
-    None
-
-  ERRORS
-    None
-
-  EXAMPLE
-
-    > version
-    > v
-
-    This is the same as running this from the command line:
-
-    > gloo --version
-
-  SEE ALSO

data/lib/gloo_lang/help/verbs/wait.txt

@@ -1,29 +0,0 @@
-WAIT VERB
-  NAME: wait
-  SHORTCUT: w
-
-  DESCRIPTION
-    Wait for the given number of seconds.
-
-  SYNTAX
-    wait <seconds>
-
-  PARAMETERS
-    seconds - The number of seconds.
-      If no value is given, we'll wait for 1 second.
-
-  RESULT
-    None
-
-  ERRORS
-    None
-
-  EXAMPLE
-
-    > wait
-    > wait 3
-
-    > create x as int : 10
-    > wait x
-
-  SEE ALSO

data/lib/gloo_lang/verbs/help.rb

@@ -1,264 +0,0 @@
-# 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 )
-
-        @engine.log.debug 'looking for built in help topic'
-        cmd = DISPATCH[ opts.to_sym ]
-        if cmd
-          @engine.log.debug 'found help index'
-          send cmd
-        else
-          @engine.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
-          @engine.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
-          @engine.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
-        @engine.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