gloo 0.6.1 → 0.7.4

data/lib/gloo/expr/op_plus.rb

@@ -8,7 +8,9 @@ module Gloo
   module Expr
     class OpPlus < Gloo::Core::Op
 
+      #
       # Perform the operation and return the result.
+      #
       def perform( left, right )
         return left + right.to_s if left.is_a? String
 

data/lib/gloo/help/app/application.txt

@@ -0,0 +1,22 @@
+GLOO APPLICATION
+
+  DESCRIPTION
+    Gloo scripting language.  A scripting language built on ruby.
+    More information coming soon.
+
+  SYNOPSIS
+    gloo [global option] [file]
+
+  GLOBAL OPTIONS
+    --cli        - Run in CLI mode
+                 - If no options are specified, this is the default.
+    --version    - Show application version
+    --help       - Show this help page
+
+  FILE
+    TODO: document running a gloo script
+      how to reference files by relative path in gloo folder
+      and also by absolute path
+
+  SEE ALSO
+    application, configuration

data/lib/gloo/help/app/configuration.txt

@@ -0,0 +1,7 @@
+CONFIGURATION
+
+  DESCRIPTION
+    TODO: document the application configuration and settings
+
+  SEE ALSO
+    application, help

data/lib/gloo/help/app/default_help.txt

@@ -0,0 +1,14 @@
+GLOO HELP
+
+  TODO:  write this article
+
+  LISTS
+    Show options for object and verb lists
+
+  DETAIL
+    How to get help detail for verbs and objects
+    How to see a help pages
+    How to see a list of help pages (topics)
+
+  SEE ALSO
+    application, configuration

data/lib/gloo/help/app/logging.txt

@@ -0,0 +1,16 @@
+GLOO APPLICATION LOGGING
+
+  DESCRIPTION
+    Gloo writes to the gloo.log as well as to the console.
+    Debug messages are written to the log only, but other messages
+    are also written to the console unless the application is
+    running in quiet mode.
+
+  CONFIGURATION
+    The application logs folder is in the gloo folder.
+    When gloo is run, the gloo.log file will be written to.
+
+  TAIL
+    Example tail command to watch the gloo log:
+
+      tail -f ~/gloo/logs/gloo.log

data/lib/gloo/help/core/color.txt

@@ -0,0 +1,31 @@
+COLOR
+
+  DESCRIPTION
+    The following colors can be used by the show verb to display
+    colored text:
+
+      red
+      blue
+      green
+      white
+      black
+      yellow
+
+    The color names are considered as virtual objects but may
+    also be referenced in variables.  See the example below.
+
+  EXAMPLE
+    Here are some examples of expression usage:
+
+      #
+      # Show multiple messages in color
+      #
+      colors [can] :
+        var [string] : red
+      	on_load [script] :
+      		show "red" (colors.var)
+      		show "blue" (blue)
+      		show "green" (green)
+
+  SEE ALSO
+    show

data/lib/gloo/help/core/error.txt

@@ -0,0 +1,33 @@
+ERROR
+
+  DESCRIPTION
+    Gloo has a special 'error' variable that's not part of the normal
+    object heap.  The error will be empty most of the time, but
+    if a command results in an error, this variable will hold the
+    error message until the next command is executed.  The error
+    is a string and can be accessed by simply referring to the
+    path-name 'error'.
+
+  EXAMPLE
+    To see the last error:
+
+      > show error
+
+    To run a command that generates an error:
+
+      > put 3 into
+      'put' must include 'into' target
+
+    Then, showing the error
+
+      > show error
+      'put' must include 'into' target
+
+    But, as mentioned, the next command will clear out the last error.
+    If you need to keep track of the result of a command, you should
+    put the error into another object.
+
+      > create err as string
+      > put 3 into
+      > put error into err
+      

data/lib/gloo/help/core/events.txt

@@ -0,0 +1,21 @@
+EVENTS
+
+  DESCRIPTION
+    Scripts can be written to be triggered by events.  The current list is as
+    follows, but it is expected that the list of events will grow.
+
+      on_load - run when a script loads
+      on_unload - run when an object receives an unload message
+
+      TODO:  add event types.
+
+  EXAMPLE
+    Show a message when a file is loaded:
+
+      start [container] :
+        on_load [script] : show "Welcome back!" (white)
+
+    Show a message when a file unloaded:
+
+      done [container] :
+        on_unload [script] : show "See ya soon!" (white)

data/lib/gloo/help/core/gloo_system.txt

@@ -0,0 +1,54 @@
+GLOO SYSTEM OBJECTS
+
+  DESCRIPTION
+    The gloo system objects are virtual objects.  That is that they
+    can be accessed like other objects.  But the values are set by
+    the system.  The values cannot be updated.  The other difference
+    is that the virtual objects do not show up in the object heap.
+
+  ACCESS
+    The gloo objects can be accessed through the 'gloo' root level
+    virtual object designation.  There is also a shortcut for the virtual
+    object path:  '$'.  For example, to see the current user:
+
+      > show gloo.user
+
+    Or:
+
+      > show $.user
+
+    Some objects include an '_' to separate words.  As an alternative,
+    a '.' can be used instead.  The following commands are treated as
+    identical:
+
+      > show gloo.working_dir
+      > show gloo.working.dir
+      > show $.working_dir
+      > show $.working.dir
+
+  OBJECTS
+
+    IDENTITY
+    gloo.hostname         # Get the system hostname.
+    gloo.user             # Get the logged in User.
+
+    FILE SYSTEM
+    gloo.user_home        # Get the user's home directory.
+    gloo.working_dir      # Get the working directory.
+    gloo.gloo_home        # Get the gloo home directory
+    gloo.gloo_config      # Get the gloo configuration directory
+    gloo.gloo_projects    # Get the gloo projects directory
+    gloo.gloo_log         # Get the gloo logging directory
+
+    SCREEN
+    gloo.screen_lines     # Get the number of lines on screen.
+    gloo.screen_cols      # Get the number of columns on screen.
+
+    PLATFORM
+    gloo.platform_cpu       # Get the platform CPU
+    gloo.platform_os        # Get the platform Operating System
+    gloo.platform_version   # Get the platform version
+    gloo.platform_windows?  # Is the platform Windows?
+    gloo.platform_unix?     # Is the platform Unix?
+    gloo.platform_linux?    # Is the platform Linux?
+    gloo.platform_mac?      # Is the platform Mac?

data/lib/gloo/help/core/here.txt

@@ -0,0 +1,30 @@
+HERE
+
+  DESCRIPTION
+    Gloo scripts can use relative referencing to access objects
+    without specifying the full path.  This relative referencing is
+    referred to with the 'here' operator: ^
+
+  EXAMPLE
+    In the following script, the here reference is used several times:
+
+      #
+      # Use here reference.
+      #
+      here [can] :
+        s [str] : local string
+      	on_load [script] : show ^.s
+        a [can] :
+          s [str] : A string
+          b [can] :
+            s [str] : B string
+            on_load [script] :
+              show ^.s
+              show ^^.s
+
+    A single use of '^' means: refer to an object at the same level
+    as the running script.  It tells the interpreter to 'look here'
+    for the object.
+
+    Use of two ^^ here references means to go up a level, and
+    so forth.

data/lib/gloo/help/core/it.txt

@@ -0,0 +1,23 @@
+IT
+
+  DESCRIPTION
+    'It' is a special virtual object.  'It' contains the value of
+    the last expression or command run.  Not all commands result in
+    a change to the value of it.
+
+  EXAMPLE
+    Get the value of an expression and store it somewhere for later use:
+
+      #
+      # Example of usage of 'it'.
+      #
+      it_example [can] :
+        result [int] :
+        on_load [script] :
+          show 3 + 4
+          put it into ^.result
+          show ^.result
+
+    Running this script will show 7 twice.  The first time will be the
+    result of the addition.  The second time will be showing the
+    result object.

data/lib/gloo/help/core/ops.txt

@@ -0,0 +1,16 @@
+OPERATORS
+
+  DESCRIPTION
+    These are the gloo operators:
+
+      +   addition
+      -   subtraction
+      *   multiplication
+      /   division
+
+  EXAMPLE
+    Here are some examples of expression usage:
+
+      > show 2 + 5
+      > put 12 / 3 into x
+      > show 23 * 3 - 6

data/lib/gloo/help/core/pathname.txt

@@ -0,0 +1,29 @@
+PATHNAME
+
+  DESCRIPTION
+    All gloo object data and scripts are stored in a heap of objects or
+    just "the heap".  The heap is hierarchical, with some objects having
+    children objects.  To reference an object, we use a "pathname".  The
+    pathname starts with the root level object then has a period, ".",
+    then the child object name, and so forth.  "a.b.c" refers to the "c"
+    object in the "b" container, which is in the "a" container.
+
+  ROOT
+    The word "root" is not needed when referring to objects.  In some
+    special cases, "root" can be used to point to the first level of
+    the object heap.  One such use would be with the "context" verb.
+
+  EXAMPLE
+    Here is an example of objects and a pathname reference to an
+    object within the hierarchy:
+
+      #
+      # Hierarchical containers.
+      #
+      a [can] :
+        b [can] :
+          c [string] : Hello World
+      on_load [script] : show a.b.c
+
+  SEE ALSO
+    context

data/lib/gloo/help/objs/basic/alias.txt

@@ -0,0 +1,36 @@
+ALIAS OBJECT TYPE
+  NAME: alias
+  SHORTCUT: ln
+
+  DESCRIPTION
+    A pointer to another object.
+    Normal path-name references will refere to the aliased object.
+    To refer to the alias itself, add an * at the end of the path-name.
+    This is neeed, for example, to set the value of the alias.
+    The value of the alias is merely the path-name of the
+    referenced object.
+
+  CHILDREN
+    None
+
+  MESSAGES
+    The alias will reflect the mesages of the object to which
+    it points.
+    The alias itself can receive the following message:
+    resolve - Check to see if the object referenced exists.
+          Sets it to true or false.
+
+  EXAMPLE
+
+    a [can] :
+      s [string] : a string
+      i [integer] : 13
+      ln [alias] : a.s
+      on_load [script] :
+        show a.ln
+        show a.ln*
+        put 'a.i' into a.ln*
+        put 7 into a.ln
+        show a.ln
+
+  SEE ALSO

data/lib/gloo/help/objs/basic/boolean.txt

@@ -0,0 +1,28 @@
+BOOLEAN OBJECT TYPE
+  NAME: boolean
+  SHORTCUT: bool
+
+  DESCRIPTION
+    A boolean value.
+    Value will be either true or false.
+
+  CHILDREN
+    None
+
+  MESSAGES
+    not - Set the boolean to the opposite of what it is now.
+    true - Set the boolean to true.
+    false - Set the boolean to false.
+
+  EXAMPLE
+
+    b [can] :
+      flag [boolean] : true
+      on_load [script] :
+        show b.flag
+        put false into b.flag
+        show b.flag
+        tell b.flag to not
+        show b.flag
+
+  SEE ALSO

data/lib/gloo/help/objs/basic/container.txt

@@ -0,0 +1,33 @@
+CONTAINER OBJECT TYPE
+  NAME: container
+  SHORTCUT: can
+
+  DESCRIPTION
+    A container of other objects.
+    A container is similar to a folder in a file system.
+    It can contain any number of objects including other containers.
+    The container structure provides direct access to any object
+    within it through the object.object.object path-name structure.
+
+  CHILDREN
+    None by default.  But any container can have any number of
+    objects added to it.
+
+  MESSAGES
+    count - Count the number of children objects in the container.
+            The result is put in <it>.
+    delete_children - Delete all children objects from the container.
+    show_key_value_tbl - Show a table with key (name) and values
+      for all children in the container.
+
+  EXAMPLE
+
+    can [can] :
+      data [can] :
+        1 : one
+        2 : two
+        3 : three
+    	on_load [script] :
+    		tell can.data to show_key_value_table
+
+  SEE ALSO

data/lib/gloo/help/objs/basic/decimal.txt

@@ -0,0 +1,28 @@
+DECIMAL OBJECT TYPE
+  NAME: decimal
+  SHORTCUT: num
+
+  DESCRIPTION
+    A decimal (numeric) value.
+
+  CHILDREN
+    None
+
+  MESSAGES
+    round - Round to the nearest whole value.
+      If an optional parameter is included, round to the
+      precision specified.
+
+  EXAMPLE
+
+    d [can] :
+      x [decimal] : 100
+      on_load [script] :
+        show d.x
+        put d.x / 3 into d.x
+        show d.x
+        tell d.x to round (1)
+        show d.x
+
+  SEE ALSO
+    integer