gloo 0.5.4 → 0.7.2

data/lib/gloo/expr/expression.rb

@@ -8,7 +8,13 @@ module Gloo
   module Expr
     class Expression
 
+      # ---------------------------------------------------------------------
+      #    Constructor
+      # ---------------------------------------------------------------------
+
+      #
       # Create the expression from a list of tokens.
+      #
       def initialize( tokens )
         @tokens = tokens
         @symbols = []
@@ -17,7 +23,13 @@ module Gloo
         @op = nil
       end
 
+      # ---------------------------------------------------------------------
+      #    Evaluate Expression
+      # ---------------------------------------------------------------------
+
+      #
       # Evaluate the expression and return the value.
+      #
       def evaluate
         identify_tokens
 
@@ -39,7 +51,15 @@ module Gloo
         return @left
       end
 
+      # ---------------------------------------------------------------------
+      #    Private functions
+      # ---------------------------------------------------------------------
+
+      private
+
+      #
       # Perform the operation.
+      #
       def perform_op
         @op ||= Gloo::Core::Op.default_op
         l = evaluate_sym @left
@@ -49,7 +69,9 @@ module Gloo
         @op = nil
       end
 
+      #
       # Evaluate the symbol and get a simple value.
+      #
       def evaluate_sym( sym )
         return sym.value if sym.is_a? Gloo::Core::Literal
         return resolve_ref sym if sym.is_a? Gloo::Core::Pn
@@ -57,7 +79,9 @@ module Gloo
         return sym
       end
 
+      #
       # resolve an object reference and get the value.
+      #
       def resolve_ref( ref )
         return ref.src if ref.named_color?
 
@@ -65,15 +89,13 @@ module Gloo
         return ob.value if ob
       end
 
+      #
       # Identify each token in the list.
+      #
       def identify_tokens
         @tokens.each do |o|
           @symbols << identify_token( o )
         end
-
-        # @symbols.each do |o|
-        #   puts o.class.name
-        # end
       end
 
       #

data/lib/gloo/expr/l_boolean.rb

@@ -8,17 +8,23 @@ module Gloo
   module Expr
     class LBoolean < Gloo::Core::Literal
 
+      #
       # Is the given token a boolean?
+      #
       def self.boolean?( token )
         return Gloo::Objs::Boolean.boolean? token
       end
 
+      #
       # Set the value, converting to an boolean.
+      #
       def set_value( value )
         @value = Gloo::Objs::Boolean.coerse_to_bool value
       end
 
+      #
       # Get string representation
+      #
       def to_s
         return 'false' unless @value
 

data/lib/gloo/expr/l_decimal.rb

@@ -18,13 +18,18 @@ module Gloo
         return s.to_f.to_s == s
       end
 
+      #
       # Set the value, converting to an integer.
+      #
       def set_value( value )
         value = value.to_s if value.is_a? Numeric
 
         @value = value.to_f
       end
 
+      #
+      # Get string representation
+      #
       def to_s
         return self.value.to_s
       end

data/lib/gloo/expr/l_integer.rb

@@ -8,7 +8,9 @@ module Gloo
   module Expr
     class LInteger < Gloo::Core::Literal
 
+      #
       # Is the given token an integer?
+      #
       def self.integer?( token )
         return true if token.is_a? Integer
 
@@ -16,11 +18,16 @@ module Gloo
         return s.to_i.to_s == s
       end
 
+      #
       # Set the value, converting to an integer.
+      #
       def set_value( value )
         @value = value.to_i
       end
 
+      #
+      # Get string representation
+      #
       def to_s
         return self.value.to_s
       end

data/lib/gloo/expr/l_string.rb

@@ -8,8 +8,10 @@ module Gloo
   module Expr
     class LString < Gloo::Core::Literal
 
+      #
       # Set the value, triming opening and closing
       # quotations if necessary.
+      #
       def set_value( value )
         @value = value
         return unless value
@@ -17,7 +19,9 @@ module Gloo
         @value = LString.strip_quotes( @value )
       end
 
+      #
       # Is the given token a string?
+      #
       def self.string?( token )
         return false unless token.is_a? String
         return true if token.start_with?( '"' )
@@ -42,6 +46,9 @@ module Gloo
         end
       end
 
+      #
+      # Get string representation
+      #
       def to_s
         return self.value
       end

data/lib/gloo/expr/op_div.rb

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

data/lib/gloo/expr/op_minus.rb

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

data/lib/gloo/expr/op_mult.rb

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

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.