home *** CD-ROM | disk | FTP | other *** search
-
- 13.0 Builtin Function Summary
-
- The following list summarizes the built in functions that are
- available. It is organized alphabetically by category.
-
- 13.1 Allocation
-
- auto allocate automatic storage
- static allocate static storage
- tclear clear transient area (use with tset)
- tlevel return current transient level
- tpop restore previous transient area
- tpush allocate new transient area
- tset save transient area (use with tclear)
-
- 13.2 Arithmetic
-
- add add or increment
- div divide
- mod modulo
- mul multiply
- sub subtract or decrement
-
- 13.3 Array Handling
-
- arycre create and initialize array
- aryfre free array
- aryget get element from array by index
- arykget get element from array by key
- arykput put element into array by key
- arylcur set current location in mapped list to index
- arylmap map array to list
- aryput put element into array by index
- arysize return size of array
-
- 13.4 Bitwise Operators
-
- bitand bitwise AND
- bitnot bitwise NOT
- bitor bitwise OR
- bitls left shift
- bitrs right shift
- bitxor bitwise exclusive OR
-
- 13.5 Debug
-
- dbgbs set breakpoint(s)
- dbgbl list breakpoint(s)
- dbgbc clear breakpoint(s)
- dbgcont continue, disable single step
- dbgoff disable debugger
- dbgon enable debugger
- dbgsd display stack
- dbgstep enter single step mode
- dbgtroff disable tracing
- dbgtron enable tracing
- dbgvd display variable
-
- 13.6 Definition
-
- define create user defined function
- defint create internal user defined function
-
- 13.7 Directory
-
- chdir change directory
- copy copy file
- dirlst copy directory to list
- delete delete file
- getcwd get current working directory
- mkdir make directory
- rmdir remove directory
- rename rename file
-
- 13.8 Error Handling
-
- errcode get/set error code
- errfn specify error handler
- errinfo get error information
- errlevel get/set error message level
- errmsg get error message
- errsig signal error
-
- 13.9 File Access
-
- close close file
- eof check for end of file
- open open file
- read read record or block from file
- seek set read/write position in file
- tell get read/write position
- write write record or block to file
-
- 13.10 Flow of Control
-
- case if...then...else with comparand
- do execute block of functions
- exit return to command level
- for iterative loop with initialization, iteration and check
- goto transfer control to label
- if conditional execution
- label provide target for goto
- leave leave containing case/do/for/if/select/until/while
- loop infinite loop
- quit terminate interpreter
- return return to calling function
- select if...then...else with no comparand
- until execute loop until condition is true
- while execute loop while condition is true
-
- 13.11 Functions
-
- bifdir display builtin function names and information
- udfdir display user defined function names and information
- udfid identify user defined function given step number
- udflist list user defined function
-
- 13.12 Input/Output
-
- get get record from keyboard
- inkey get character from keyboard
- inp receive data from port
- outp send data to port
- put send record to console
- putx put without carriage return/line feed
- window access window
-
- 13.13 Linkage
-
- bind bind function to internal address (bif or udf)
- bifbind bind to builtin function address
- export export variable to other functions
- import import variable from other functions
- udfbind bind to user defined function address
- unbind unbind function from internal address
-
- 13.14 List Handling
-
- 13.14.1 Functions that create and destroy lists
-
- lstcre create and initialize list
- lstfre free list
-
- 13.14.2 Functions that add nodes to lists
-
- lsthpsh push node on head
- lsttpsh push node on tail
- lstcpsh push next node on current node
- lstspsh push sub node on current node
-
- 13.14.3 Functions that remove nodes from lists
-
- lsthpop pop node from head
- lsttpop pop node from tail
- lstcpop pop current node from list
- lstspop pop sub node from current node
-
- 13.14.4 Functions that return the value of nodes
-
- lsthget get value of head node
- lsttget get value of tail node
- lstcget get value of current node
- lstsget get value of sub node of current node
-
- 13.14.5 Functions that update the value of nodes
-
- lsthput update value of head node
- lsttput update value of tail node
- lstcput update value of current node
- lstsput update value of sub node of current node
-
- 13.14.6 Functions that specify or move the current location
-
- lsthead set current node to head node
- lsttail set current node to tail node
- lstprev set current node to previous node of current node
- lstnext set current node to next node of current node
- lstsub set current node to sub node of current node
-
- 13.14.7 Functions that return validity (existence) of specified nodes
-
- lstcval true if a current node has been specified
- lstnval true if next node to current node exists
- lstpval true if previous node to current node exists
- lstsval true if sub node to current node exists
-
- 13.14.8 Functions that map lists to arrays
-
- lstamap map a list to an array
- lstacur map current list node to an array index
-
- 13.14.9 Functions that manipulate entire lists
-
- lstjoin combine two lists into one list
- lstsplit separate a list into two lists
- lstread read a list from a file
- lstwrite write a list to a file
- lstsize return the size of a list
- lstsort sort a list
- lstswap interchange next and sub lists
-
- 13.15 Logical and Relational
-
- and logical AND
- any return true if leftmost argument matches any other
- eq equal
- ge greater than or equal to
- gt greater than
- le less than or equal to
- lt less than
- ne not equal
- not logical negate
- or logical OR
-
- 13.16 Math
-
- acos arc cosine
- asin arc sine
- atan arc tangent
- cos cosine
- exp exponential
- ln logarithm natural
- log logarithm base 10
- pow power
- sin sine
- sqrt square root
- tan tangent
-
- 13.17 Memory
-
- memcre allocate memory
- memfre free memory
- memget get memory
- memput set memory
-
- 13.18 Miscellaneous
-
- eval translate and interpret character string
- feval translate and interpret file
- fmhex convert from hexadecimal to decimal
- format format string with substitutions
- genfre free any structure descriptor
- rand generate pseudo-random number
-
- 13.19 Patterns
-
- patalt check alternates
- patarb match arbitrary characters
- patcre create pattern
- pateol match end of line
- patfre free pattern
- patgrp match character from group
- patlit match literal
- patmatch execute match
- patneg negate match
- patpat group primitives
- patrem match remainder of string
- patrng match character from range
- patset assign match to variable
- patuse use pattern descriptor
-
- 13.20 Reference
-
- argc get number of arguments
- argn get argument name
- argt get argument type
- argv evaluate argument
- get_arg get argument step given program step
- get_nxt get next program step given program step
- get_sym get user defined function name given program step
- get_node get first program step given user defined function name
- set assign value to variable(s)
- sys get/set internal values
-
- 13.21 Strings
-
- strasc convert decimal ascii code to character
- strcat concatenate strings
- strchr convert character to decimal ascii code
- strcpy copy string n times
- strfnd find character from set in string
- strind find sub string in string
- strlc convert to lowercase
- strlen return string length
- strsub get substring
- strtrn translate string
- struc convert to uppercase
- strver find character from string not in set
-
- 13.22 System Functions
-
- break specify control-c handler
- getenv get field value from environment
- system pass command to operating system shell
-
- 13.23 Time and Date Functions
-
- day return formatted date and time
- date return date string
- seconds return seconds since some point in past
- time return time string
-