gloo-lang 1.0.2 → 1.1.0

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

@@ -1,29 +0,0 @@
-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_lang/help/objs/basic/alias.txt

@@ -1,36 +0,0 @@
-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_lang/help/objs/basic/boolean.txt

@@ -1,28 +0,0 @@
-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_lang/help/objs/basic/container.txt

@@ -1,33 +0,0 @@
-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_lang/help/objs/basic/decimal.txt

@@ -1,28 +0,0 @@
-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

data/lib/gloo_lang/help/objs/basic/integer.txt

@@ -1,27 +0,0 @@
-INTEGER OBJECT TYPE
-  NAME: integer
-  SHORTCUT: int
-
-  DESCRIPTION
-    An integer (numeric) value.
-
-  CHILDREN
-    None
-
-  MESSAGES
-    inc - Increment the integer value by 1.
-    dec - Decrement the integer value by 1.
-
-  EXAMPLE
-
-    i [can] :
-      x [integer] : 0
-      on_load [script] :
-        show i.x
-        tell i.x to inc
-        show i.x
-        put i.x * 10 into i.x
-        show i.x
-
-  SEE ALSO
-    decimal

data/lib/gloo_lang/help/objs/basic/script.txt

@@ -1,29 +0,0 @@
-SCRIPT OBJECT TYPE
-  NAME: script
-  SHORTCUT: cmd
-
-  DESCRIPTION
-    An exectutable script.
-
-  CHILDREN
-    None
-
-  MESSAGES
-    run - Run the script.
-          The script can be run by telling the object or run.
-          It can all be executed with the run verb.
-
-  EXAMPLE
-
-    script [can] :
-    	on_load [script] :
-    		show "Showing multiple lines..."
-    		show script.msg1
-    		show script.msg2
-    		show script.msg3
-    		show "Done."
-    	msg1 [string] : one
-    	msg2 [string] : two
-    	msg3 [string] : three
-
-  SEE ALSO

data/lib/gloo_lang/help/objs/basic/string.txt

@@ -1,28 +0,0 @@
-STRING OBJECT TYPE
-  NAME: string
-  SHORTCUT: str
-
-  DESCRIPTION
-    A string value.
-
-  CHILDREN
-    None
-
-  MESSAGES
-    up - Convert the string to uppercase.
-    down - Convert the string to lowercase.
-    size - Get the size of the string.
-
-  EXAMPLE
-
-    s [can] :
-      msg [string] : Hello World!
-      on_load [script] :
-        show s.msg
-        tell s.msg to up
-        show s.msg
-        tell s.msg to size
-        show it
-
-  SEE ALSO
-    text

data/lib/gloo_lang/help/objs/basic/text.txt

@@ -1,27 +0,0 @@
-TEXT OBJECT TYPE
-  NAME: text
-  SHORTCUT: txt
-
-  DESCRIPTION
-    A longer, multi-line text string.
-    Use BEGIN and END to mark the text range.
-
-  CHILDREN
-    None
-
-  MESSAGES
-    edit - Edit the text field in the default editor.
-    page - Show the text, paginated.
-
-  EXAMPLE
-
-    t [container] :
-    	msg [txt] : BEGIN
-    		I will now write a poem
-    		of two lines or less
-    		END
-    	on_load [script] :
-    		show t.msg
-
-  SEE ALSO
-    string

data/lib/gloo_lang/help/objs/basic/untyped.txt

@@ -1,22 +0,0 @@
-UNTYPED OBJECT TYPE
-  NAME: untyped
-  SHORTCUT: un
-
-  DESCRIPTION
-    An untyped object.
-    If no type is specified when an object is created it
-    will be of this type.
-
-  CHILDREN
-    None
-
-  MESSAGES
-    None
-
-  EXAMPLE
-
-    > create x
-    > put 1 into x
-    > put 'string' into x
-
-  SEE ALSO

data/lib/gloo_lang/help/objs/cli/banner.txt

@@ -1,49 +0,0 @@
-BANNER OBJECT TYPE
-  NAME: banner
-  SHORTCUT: ban
-
-  DESCRIPTION
-    Banner text in large, colored font.
-
-  CHILDREN
-    text - string
-      The text for the banner.
-    style - string
-      The banner style.  See tty-font for options.
-    color - string
-      The color for the banner.  See pastel for options.
-
-  MESSAGES
-    show - Show the text banner.
-
-  EXAMPLE
-
-    ban [can] :
-      on_load [script] :
-        tell ban.one to show
-        tell ban.two to show
-        tell ban.three to show
-        tell ban.four to show
-        tell ban.five to show
-      one [banner] :
-        text [string] : Something New
-        style [string] : standard
-        color [string] : white on_green
-      two [banner] :
-        text [string] : Star Wars
-        style [string] : starwars
-        color [string] : red
-      three [banner] :
-        text [string] : Many_Dimensions
-        style [string] : 3d
-        color [string] : blue
-      four [banner] :
-        text [string] : As An Arrow
-        style [string] : straight
-        color [string] : yellow
-      five [banner] :
-        text [string] : Cranium
-        style [string] : block
-        color [string] : white on_yellow
-
-  SEE ALSO

data/lib/gloo_lang/help/objs/cli/bar.txt

@@ -1,37 +0,0 @@
-BAR OBJECT TYPE
-  NAME: bar
-  SHORTCUT: bar
-
-  DESCRIPTION
-    CLI progress bar
-
-  CHILDREN
-    name - string
-      The name of the progress bar.
-    total - integer - 100
-      The total for the bar.
-
-  MESSAGES
-    start - Start the bar.
-    advance <amount> - Advance by the given amount.
-    stop - Complete the bar.
-    run <seconds> - Run for the given number of seconds
-      and advance the bar so that it completes at the end
-      of the time specified.
-
-  EXAMPLE
-
-    bar [can] :
-      on_load [script] :
-        tell bar.progress to start
-        tell bar.progress to advance
-        wait
-        tell bar.progress to advance (30)
-        wait
-        tell bar.progress to advance (40)
-        wait
-        tell bar.progress to stop
-      progress [bar] :
-        name [string] : going
-
-  SEE ALSO

data/lib/gloo_lang/help/objs/cli/colorize.txt

@@ -1,33 +0,0 @@
-COLORIZE OBJECT TYPE
-  NAME: colorize
-  SHORTCUT: color
-
-  DESCRIPTION
-    The Colorize object can be used to write output in color.
-    The Colorize container can contain multiple strings, each
-    one can have a different color as specified by the names
-    of the children.
-
-  CHILDREN
-    <color> - string - no default value
-      The name of the child or children is the color.
-      The string's value is what will be written out.
-
-  MESSAGES
-    run - Output the string in the color specified.
-
-  EXAMPLE
-
-    color [can] :
-    	w [colorize] :
-    		white [string] : This is white!
-    	m [colorize] :
-    		red [string] : red -
-    		green [string] : green -
-    		blue [string] : blue
-    	on_load [script] :
-    		run color.w
-    		run color.m
-
-  SEE ALSO
-    pastel

data/lib/gloo_lang/help/objs/cli/confirm.txt

@@ -1,26 +0,0 @@
-CONFIRM OBJECT TYPE
-  NAME: confirm
-  SHORTCUT: confirm
-
-  DESCRIPTION
-    CLI confirmation prompt.
-
-  CHILDREN
-    prompt - string - '> '
-      The confirmation prompt.
-    result - boolean - none
-      The result of the prompt.
-
-  MESSAGES
-    run - Prompt the user and then set the result.
-
-  EXAMPLE
-
-    confirm [confirm] :
-    	prompt [string] : Are you sure?
-    	result [boolean] :
-    	on_load [script] :
-    		run confirm
-    		show 'Confirmed: ' + confirm.result
-
-  SEE ALSO

data/lib/gloo_lang/help/objs/cli/menu.txt

@@ -1,44 +0,0 @@
-MENU OBJECT TYPE
-  NAME: menu
-  SHORTCUT: menu
-
-  DESCRIPTION
-    A CLI menu.
-    This can be used for the main loop of a CLI application.
-
-  CHILDREN
-    prompt - string - '> '
-      The shortcut may be used to select the  menu item.
-    items - container
-      A textual description of the menu item action.
-    loop - boolean
-      The script that will be run if the menu item is selected.
-    default - script
-      Optional script element. Run this if no other option selected.
-
-  MESSAGES
-    run - Show the options and the the prompt.
-      Then run the script for the user's selection.
-      Optionally repeat as long as the loop child is true.
-
-  EXAMPLE
-
-    menu [menu] :
-    	on_load [script] :
-    		run menu
-    	prompt [string] : >
-    	loop [bool] : true
-    	items [can] :
-    		hw [mitem] :
-    			shortcut [str] : hw
-    			description [str] : Run Hello World
-    			do [script] :
-            show 'Hello World!'
-    		q [mitem] :
-    			shortcut [str] : q
-    			description [str] : Quit this menu
-    			do [script] :
-            put false into menu.loop
-
-  SEE ALSO
-    menu_item

data/lib/gloo_lang/help/objs/cli/menu_item.txt

@@ -1,26 +0,0 @@
-MENU_ITEM OBJECT TYPE
-  NAME: menu_item
-  SHORTCUT: mitem
-
-  DESCRIPTION
-    A CLI menu item.  One element in a CLI menu.
-
-  CHILDREN
-    shortcut - string
-      The shortcut may be used to select the  menu item.
-      The shortcut child is optional.  If it is not provided,
-      the name of the menu item will be used instead.
-    description - string
-      A textual description of the menu item action.
-      The description child is optional.  If it is not provided,
-      the value of the menu item will be used instead.
-    do - script
-      The script that will be run if the menu item is selected.
-
-  MESSAGES
-    None
-
-  EXAMPLE
-
-  SEE ALSO
-    menu

data/lib/gloo_lang/help/objs/cli/pastel.txt

@@ -1,43 +0,0 @@
-PASTEL OBJECT TYPE
-  NAME: pastel
-  SHORTCUT: pastel
-
-  DESCRIPTION
-    Show colorized text with the pastel gem.
-
-  CHILDREN
-    text - string
-      The text that will be colorized.
-    color - string
-      The colors.  See pastel for options.
-
-  MESSAGES
-    show - Show the colorized text.
-
-  EXAMPLE
-
-    pastel [can] :
-      on_load [script] :
-        tell pastel.one to show
-        tell pastel.two to show
-        tell pastel.three to show
-        tell pastel.four to show
-        tell pastel.five to show
-      one [pastel] :
-        text [string] : Something New
-        color [string] : white on_green
-      two [pastel] :
-        text [string] : Star Wars
-        color [string] : red
-      three [pastel] :
-        text [string] : Many_Dimensions
-        color [string] : blue
-      four [pastel] :
-        text [string] : As An Arrow
-        color [string] : yellow on_blue
-      five [pastel] :
-        text [string] : Cranium
-        color [string] : white on_yellow
-
-  SEE ALSO
-    colorize

data/lib/gloo_lang/help/objs/cli/prompt.txt

@@ -1,27 +0,0 @@
-PROMPT OBJECT TYPE
-  NAME: prompt
-  SHORTCUT: ask
-
-  DESCRIPTION
-    CLI prompt for user input.
-
-  CHILDREN
-    prompt - string - '> '
-      The prompt displayed to the user.
-    result - string - none
-      The result with the user's input.
-
-  MESSAGES
-    run - Prompt the user and then set the result.
-    multiline - Show a multiline prompt.
-
-  EXAMPLE
-
-    ask [ask] :
-    	prompt [string] : What is your name?
-    	result [string] :
-    	on_load [script] :
-    		run ask
-    		show 'Hello, ' + ask.result + '!  Thanks for playing'
-
-  SEE ALSO

data/lib/gloo_lang/help/objs/cli/select.txt

@@ -1,34 +0,0 @@
-SELECT OBJECT TYPE
-  NAME: select
-  SHORTCUT: sel
-
-  DESCRIPTION
-    Prompt for user to select from a list of options.
-
-  CHILDREN
-    prompt - string - '> '
-      The prompt displayed to the user.
-    options - container
-      The list of options for the selection list.
-      The name of each option will be presented to the user, but
-      the value will be put in the result.
-    result - string - none
-      The result with the user's selection.
-
-  MESSAGES
-    run - Prompt the user for a selection and then set the result.
-
-  EXAMPLE
-
-    select [select] :
-    	prompt [string] : What is your favorite color?
-      options [can] :
-        red : r
-        green : g
-        blue : b
-    	result [string] :
-    	on_load [script] :
-    		run select
-    		show select.result
-
-  SEE ALSO

data/lib/gloo_lang/help/objs/ctrl/each.txt

@@ -1,48 +0,0 @@
-EACH OBJECT TYPE
-  NAME: each
-  SHORTCUT: each
-
-  DESCRIPTION
-    Perform an action for each item in a collection.
-
-  CHILDREN
-    child | word | line | repo - string - none
-      The entity we want to loop for.
-      It will hold the current value while the script is running.
-    in - string - none
-      The collection we will iterate in.
-      In the case of <word> or <line> this will be a string or text.
-      In the case of <repo> this will be the root path.
-    do - script - none
-      The action we want to perform for each found item.
-
-  MESSAGES
-    run - Look through the collecion and perform this for each
-      found item.
-
-  EXAMPLE
-
-    #
-    # Show each child in a container.
-    #
-
-    for [each] :
-    	child [alias] :
-    	in [alias] : objs
-    	do [script] : show for.child
-    objs [can] :
-      1 [string] : one
-      2 [string] : two
-      3 [string] : three
-
-    #
-    # Show each word in a string.
-    #
-
-    for [each] :
-    	word [string] :
-    	in [string] : one word at a time
-    	do [script] : show for.word
-
-
-  SEE ALSO