classes.r: Function and Context Index

Documentation for Module: classes.r || Module Index

syntax: !Overview Classes:
author: Tim Johnson tim@akwebsoft.com
Class: Wrapper - Initializer = WRAPPER!
Class: al-class - Initializer = AL!
Class: str-class - Initializer = STR!
Class: blk-class - Initializer = BLK!

Global Index
BLK!	PRN!	STR!	WRAPPER!	WRITER!
HASH!

Context Index
wrapper-class Functions: ==>
OVERVIEW	--	back	last	skip
++	==	first	next	usage
str-class Functions: ==>
OVERVIEW	data?	lop	pos?	que
add	end?	merge	pull	split
cut	find	pop	push	usage
data	ins
blk-class Functions: ==>
OVERVIEW	cut	ins	pop	que
add	data	lop	pull	usage
cat	fuse	merge	push
al-class Functions: ==>
OVERVIEW	del	push	usage	valid?
add	pull	push
hash-class Functions: ==>
OVERVIEW	del	items	put	setup
add	fix	keys	reset	usage
chop	get	pop	set	vals
clear	is	pos
writer-class Functions: ==>
OVERVIEW	fix	prn

Global function documentation

Function: BLK!

Top

Globals Index

Context Index

syntax: BLK! <block> Initialize a blk-class object

Function: HASH!

syntax: HASH! <block> Initialize a has-class object

Function: PRN!

syntax: PRN! <block-of-args> Initialize a writer object

Function: STR!

syntax: STR! <str-int> Initialize a str-class object

Function: WRAPPER!

syntax: WRAPPER! <series> Initialize a wrapper-class object

Function: WRITER!

syntax: WRITER! <block-of-args> Initialize a writer object

Global function documentation

Context: al-class

Overview Of: al-class

syntax: Treats a block or hash as an associative list.
Initialize: as AL! <block>

Function: al-class/add

    syntax: obj/add <any-key> <any-val>
    description: Increment, join or append, based on datatypes
    note: If key is not found, append key/value

Function: al-class/del

syntax: obj/del <key> Remove key/value pair located by key.

Function: al-class/pull

syntax: obj/pull <key> Return and remove key/value pair located by key.

Function: al-class/push

    syntax: push <any-key> <any-val>
    description: add key/value pair to head of self/_data_.
    Note: pre-existing pair removed
    syntax: push <any-key> <any-val>
    description: add key/value pair to end of self/_data_.
    Note: pre-existing pair removed

Function: al-class/push

Function: al-class/usage

syntax: obj/usage Built-in help
syntax: [AL! <block>-] Initialize an al-class object.

Function: al-class/valid?

syntax: obj/valid? Test for non-repeating keys and even length

Context: blk-class

Overview Of: blk-class

syntax: Block handling (Initialize as BLK! <integer or string>

Function: blk-class/add

syntax: obj/add <any-val> Add (QUE) value at end. /B (/only)

Function: blk-class/cat

syntax: obj/cat Return the _data_ member rejoin

Function: blk-class/cut

syntax: obj/cut <int-pos> Remove value from pos. /part block of values.

Function: blk-class/data

syntax: obj/data Return the _data_ member

Function: blk-class/fuse

    syntax: obj/fuse <any-type-sep>
    description: If sep is single value, place sep between each element
     If sep is block of two values, alternate them.

Function: blk-class/ins

syntax: obj/ins <any-val> <int-pos> Add value at <pos> /B = /only

Function: blk-class/lop

syntax: obj/lop Remove and return last value. /part = <block of values>.

Function: blk-class/merge

    syntax: obj/merge <block> Combine with another block. Alternating values.
    Note: All options but /B are exclusive.
    refinement: /even: blocks must be of equal length.
    refinement: /short: use up to shortest length.
    refinement: /rot: rotate back to head of shortest.
    refinement: /B = /only. Can be used with any of above.

Function: blk-class/pop

syntax: obj/pop Remove and return first value.

Function: blk-class/pull

syntax: obj/pull Remove any found of val(s).

Function: blk-class/push

syntax: obj/push <any-val> Add <val> as first value.

Function: blk-class/que

syntax: obj/que <any-val> Add value at end. /B (/only)

Function: blk-class/usage

syntax: obj/usage Built-in help

Context: hash-class

Overview Of: hash-class

syntax: Associated values - hash - object

Function: hash-class/add

syntax: obj/add Add new pair, throw exception if key already present.

Function: hash-class/chop

syntax: obj/chop Remove and return last pair.

Function: hash-class/clear

syntax: obj/clear Remove all keys and values.

Function: hash-class/del

syntax: obj/del <key> Remove and return pair by key.

Function: hash-class/fix

    syntax: obj/fix <arg-none-int> set/unset permissions.
    1: Default is unset (full permissions to read, write, add, delete)
    2: If arg is none - unset all permissions
    3: If arg is 0, block any method that adds or deletes data (fixed mode)
        disable reset, pop, chop, put, puts, del, setup, reset, clear
    4: If arg is non-zero integer, block changing of key values (fixed AND read-only)
        Disable (in addition to methods above) set, sets

Function: hash-class/get

syntax: obj/get <block-of-keys> Return block of values by key.

Function: hash-class/is

syntax: obj/is True if object is not empty.

Function: hash-class/items

syntax: obj/items Return key/value pairs in order of initialization.

Function: hash-class/keys

syntax: obj/keys Return block of keys in order of initialization.

Function: hash-class/pop

syntax: obj/pop Remove and return first pair.

Function: hash-class/pos

syntax: obj/pos <any-key> return position of pair in order of initialization.

Function: hash-class/put

syntax: obj/put <block-of-pairs>
description: Change (if exists) value(s) for key(s), or add key/value.

Function: hash-class/reset

    syntax: obj/reset
    description: Reset keys and vals to that of previous call to setup method
      or previous call to HASH!, whichever was latest.

Function: hash-class/set

syntax: obj/set <block-of-pairs>
description: Change value for keys, throws exception if no match for a key.

Function: hash-class/setup

    syntax: obj/setup <block>
    description: Initialize keys and vals attributes from argument block of
    alternating keys and values. Saves original copy of argument block.

Function: hash-class/usage

syntax: obj/usage Builtin help

Function: hash-class/vals

syntax: obj/vals Return block of values in order of initialization.

Context: str-class

Overview Of: str-class

syntax: String handling. Intialized by STR! function

Function: str-class/add

syntax: obj/add Add value at end. /B (/only) Alias of que

Function: str-class/cut

syntax: obj/cut <int-pos> Remove value from <pos>. /part block of values.

Function: str-class/data

syntax: obj/data Returns data string

Function: str-class/data?

syntax: obj/data? Does object hold valid data?

Function: str-class/end?

syntax: obj/end? <str-sub> Is sub at end of data?

Function: str-class/find

    syntax: obj/find <str-val> Search function
    refinement: /any -- Enables the * and ? wildcards.
    refinement: /case -- search is case-sensitive.
    refinement: /COMPILE -- loads a find command. HIGHLY RECOMMENDED IN LOOPS
    refinement: /last -- Backwards from end of string.
    refinement: /match -- Performs comparison and returns the tail of the match.
    refinement: /only -- Treats a series value as a single value.
    refinement: /part -- Limits the search to a given length or position.
                  range -- (Type: number series port)
    refinement: /reverse -- Backwards from the end
    refinement: /skip -- Treat the series as records of fixed size
                   size -- (Type: integer)
    refinement: /with -- Allows custom wildcards.
                   wild -- Specifies alternates for * and ? (Type: string)
    refinement: /tail -- Returns the end of the string. (clarification needed)

Function: str-class/ins

syntax: obj/ins <any-val> <int-pos> Add value at pos /B (/only)

Function: str-class/lop

syntax: obj/lop Remove and return last value. /part: block of values.

Function: str-class/merge

    syntax: obj/merge Combine with another string. Alternating values.

    Note: All options but /B are exclusive
    refinement: /even: blocks must be of equal length.
    refinement: /short: use up to shortest length.
    refinement: /rot: rotate back to head of shortest.
    refinement: /B (/only). Can be used with any of above.

Function: str-class/pop

syntax: obj/pop Remove and return first value.

Function: str-class/pos?

syntax: obj/pos? <str-substr> Index of substring or none

Function: str-class/pull

syntax: obj/pull <any-val(s)> Remove any found of val(s).

Function: str-class/push

syntax: obj/push <any-val> Add first value.

Function: str-class/que

syntax: obj/que Add value at end. /B (/only)

Function: str-class/split

syntax: obj/split <str-sep>
description: Seperate to block by <sep>. If <sep> is at end, add an empty string.

Function: str-class/usage

syntax: obj/usage console/web help

Context: wrapper-class

Overview Of: wrapper-class

    syntax:
    description: Navigates a series, wrapping around when bounds are overrun
    Initialized: by WRAPPER! function

Function: wrapper-class/++

syntax: obj/++ set index to next item, or 1 if bounds exceeded
Note: returns previous item, unlike next which return current item

Function: wrapper-class/--

syntax: obj/-- set index to previous item, or length? data if bounds exceeded
Note: returns previous addressed item, unlike back which return current item

Function: wrapper-class/==

syntax: obj/== Return currently referenced item

Function: wrapper-class/back

syntax: obj/back set index to previous item, or length? data if bounds exceeded

Function: wrapper-class/first

syntax: obj/first set index to 1

Function: wrapper-class/last

syntax: obj/last set index to length? data

Function: wrapper-class/next

syntax: obj/next set index to next item, or 1 if bounds exceeded

Function: wrapper-class/skip

syntax: obj/skip <int-inc> Advance by inc, wrapping if needed

Function: wrapper-class/usage

syntax: obj/usage Builtin help

Context: writer-class

Overview Of: writer-class

    syntax: Used for HTML rendering.
    Initialized: by WRITER! or PRN!
    description: Stores and renders a string with font and bold tags
    Note: bold and font tags are optional. Default is empty string

Function: writer-class/fix

syntax: obj/fix <block-of-args> Args are alternating keys and values.
Note: keys must be equivalent to object members. Exception thrown if not.

Function: writer-class/prn

syntax: obj/prn Renders stored text