home *** CD-ROM | disk | FTP | other *** search
/ Phoenix CD 2.0 / Phoenix_CD.cdr / 01e / max130.zip / SUMMARY.DOC < prev    next >
Text File  |  1988-10-30  |  8KB  |  304 lines

  1.  
  2. 13.0    Builtin Function Summary
  3.  
  4. The following list summarizes the built in functions that are
  5. available. It is organized alphabetically by category. 
  6.  
  7. 13.1    Allocation
  8.  
  9.    auto        allocate automatic storage
  10.    static    allocate static storage
  11.    tclear    clear transient area (use with tset)
  12.    tlevel    return current transient level
  13.    tpop        restore previous transient area
  14.    tpush    allocate new transient area
  15.    tset        save transient area (use with tclear)
  16.  
  17. 13.2    Arithmetic
  18.  
  19.    add        add or increment
  20.    div        divide
  21.    mod        modulo
  22.    mul        multiply
  23.    sub        subtract or decrement
  24.  
  25. 13.3    Array Handling
  26.  
  27.    arycre    create and initialize array
  28.    aryfre    free array
  29.    aryget    get element from array by index
  30.    arykget    get element from array by key
  31.    arykput    put element into array by key
  32.    arylcur    set current location in mapped list to index
  33.    arylmap    map array to list
  34.    aryput    put element into array by index
  35.    arysize    return size of array
  36.  
  37. 13.4    Bitwise Operators
  38.  
  39.    bitand    bitwise AND
  40.    bitnot    bitwise NOT
  41.    bitor    bitwise OR
  42.    bitls    left shift
  43.    bitrs    right shift
  44.    bitxor    bitwise exclusive OR
  45.  
  46. 13.5    Debug
  47.  
  48.    dbgbs    set breakpoint(s)
  49.    dbgbl    list breakpoint(s)
  50.    dbgbc    clear breakpoint(s)
  51.    dbgcont    continue, disable single step
  52.    dbgoff    disable debugger
  53.    dbgon    enable debugger
  54.    dbgsd    display stack
  55.    dbgstep    enter single step mode
  56.    dbgtroff    disable tracing
  57.    dbgtron    enable tracing
  58.    dbgvd    display variable
  59.  
  60. 13.6    Definition
  61.  
  62.    define    create user defined function
  63.    defint    create internal user defined function
  64.  
  65. 13.7    Directory
  66.  
  67.    chdir    change directory
  68.    copy        copy file
  69.    dirlst    copy directory to list
  70.    delete    delete file
  71.    getcwd    get current working directory
  72.    mkdir    make directory
  73.    rmdir    remove directory
  74.    rename    rename file
  75.  
  76. 13.8    Error Handling
  77.  
  78.    errcode    get/set error code
  79.    errfn    specify error handler
  80.    errinfo    get error information
  81.    errlevel    get/set error message level
  82.    errmsg    get error message
  83.    errsig    signal error
  84.  
  85. 13.9    File Access
  86.  
  87.    close    close file
  88.    eof        check for end of file
  89.    open        open file
  90.    read        read record or block from file
  91.    seek        set read/write position in file
  92.    tell        get read/write position
  93.    write    write record or block to file
  94.  
  95. 13.10    Flow of Control
  96.  
  97.    case        if...then...else with comparand
  98.    do        execute block of functions
  99.    exit        return to command level
  100.    for        iterative loop with initialization, iteration and check
  101.    goto        transfer control to label
  102.    if        conditional execution
  103.    label    provide target for goto
  104.    leave    leave containing case/do/for/if/select/until/while
  105.    loop        infinite loop
  106.    quit        terminate interpreter
  107.    return    return to calling function
  108.    select    if...then...else with no comparand
  109.    until    execute loop until condition is true
  110.    while    execute loop while condition is true
  111.  
  112. 13.11    Functions
  113.  
  114.    bifdir    display builtin function names and information
  115.    udfdir    display user defined function names and information
  116.    udfid    identify user defined function given step number
  117.    udflist    list user defined function
  118.  
  119. 13.12    Input/Output
  120.  
  121.    get        get record from keyboard
  122.    inkey    get character from keyboard
  123.    inp        receive data from port
  124.    outp        send data to port
  125.    put        send record to console
  126.    putx        put without carriage return/line feed
  127.    window    access window
  128.  
  129. 13.13    Linkage
  130.  
  131.    bind        bind function to internal address (bif or udf)
  132.    bifbind    bind to builtin function address
  133.    export    export variable to other functions
  134.    import    import variable from other functions
  135.    udfbind    bind to user defined function address
  136.    unbind    unbind function from internal address
  137.  
  138. 13.14    List Handling
  139.  
  140. 13.14.1    Functions that create and destroy lists
  141.  
  142.    lstcre    create and initialize list
  143.    lstfre    free list
  144.  
  145. 13.14.2    Functions that add nodes to lists
  146.  
  147.    lsthpsh    push node on head
  148.    lsttpsh    push node on tail
  149.    lstcpsh    push next node on current node
  150.    lstspsh    push sub node on current node
  151.  
  152. 13.14.3    Functions that remove nodes from lists
  153.  
  154.    lsthpop    pop node from head
  155.    lsttpop    pop node from tail
  156.    lstcpop    pop current node from list
  157.    lstspop    pop sub node from current node
  158.  
  159. 13.14.4    Functions that return the value of nodes
  160.  
  161.    lsthget    get value of head node
  162.    lsttget    get value of tail node
  163.    lstcget    get value of current node
  164.    lstsget    get value of sub node of current node
  165.  
  166. 13.14.5    Functions that update the value of nodes
  167.  
  168.    lsthput    update value of head node
  169.    lsttput    update value of tail node
  170.    lstcput    update value of current node
  171.    lstsput    update value of sub node of current node
  172.  
  173. 13.14.6    Functions that specify or move the current location
  174.  
  175.    lsthead    set current node to head node
  176.    lsttail    set current node to tail node
  177.    lstprev    set current node to previous node of current node
  178.    lstnext    set current node to next node of current node
  179.    lstsub    set current node to sub node of current node
  180.  
  181. 13.14.7    Functions that return validity (existence) of specified nodes
  182.  
  183.    lstcval    true if a current node has been specified
  184.    lstnval    true if next node to current node exists
  185.    lstpval    true if previous node to current node exists
  186.    lstsval    true if sub node to current node exists
  187.  
  188. 13.14.8    Functions that map lists to arrays
  189.  
  190.    lstamap    map a list to an array
  191.    lstacur    map current list node to an array index
  192.  
  193. 13.14.9    Functions that manipulate entire lists
  194.  
  195.    lstjoin    combine two lists into one list
  196.    lstsplit    separate a list into two lists
  197.    lstread    read a list from a file
  198.    lstwrite    write a list to a file
  199.    lstsize    return the size of a list
  200.    lstsort    sort a list
  201.    lstswap    interchange next and sub lists
  202.  
  203. 13.15    Logical and Relational
  204.  
  205.    and        logical AND
  206.    any        return true if leftmost argument matches any other
  207.    eq        equal
  208.    ge        greater than or equal to
  209.    gt        greater than
  210.    le        less than or equal to
  211.    lt        less than
  212.    ne        not equal
  213.    not        logical negate
  214.    or        logical OR
  215.  
  216. 13.16    Math
  217.  
  218.    acos        arc cosine
  219.    asin        arc sine
  220.    atan        arc tangent
  221.    cos        cosine
  222.    exp        exponential
  223.    ln        logarithm natural
  224.    log        logarithm base 10
  225.    pow        power
  226.    sin        sine
  227.    sqrt        square root
  228.    tan        tangent
  229.  
  230. 13.17    Memory
  231.  
  232.    memcre    allocate memory
  233.    memfre    free memory
  234.    memget    get memory
  235.    memput    set memory
  236.  
  237. 13.18    Miscellaneous
  238.  
  239.    eval        translate and interpret character string
  240.    feval    translate and interpret file
  241.    fmhex    convert from hexadecimal to decimal
  242.    format    format string with substitutions
  243.    genfre    free any structure descriptor
  244.    rand        generate pseudo-random number
  245.  
  246. 13.19    Patterns
  247.  
  248.    patalt    check alternates
  249.    patarb    match arbitrary characters
  250.    patcre    create pattern
  251.    pateol    match end of line
  252.    patfre    free pattern
  253.    patgrp    match character from group
  254.    patlit    match literal
  255.    patmatch     execute match
  256.    patneg    negate match
  257.    patpat    group primitives
  258.    patrem    match remainder of string
  259.    patrng    match character from range
  260.    patset    assign match to variable
  261.    patuse    use pattern descriptor
  262.  
  263. 13.20    Reference
  264.  
  265.    argc        get number of arguments
  266.    argn        get argument name
  267.    argt        get argument type
  268.    argv        evaluate argument
  269.    get_arg    get argument step given program step
  270.    get_nxt    get next program step given program step
  271.    get_sym    get user defined function name given program step
  272.    get_node    get first program step given user defined function name
  273.    set        assign value to variable(s)
  274.    sys        get/set internal values
  275.  
  276. 13.21    Strings
  277.  
  278.    strasc    convert decimal ascii code to character
  279.    strcat    concatenate strings
  280.    strchr    convert character to decimal ascii code
  281.    strcpy    copy string n times
  282.    strfnd    find character from set in string
  283.    strind    find sub string in string
  284.    strlc    convert to lowercase
  285.    strlen    return string length
  286.    strsub    get substring
  287.    strtrn    translate string
  288.    struc    convert to uppercase
  289.    strver    find character from string not in set
  290.  
  291. 13.22    System Functions
  292.  
  293.    break    specify control-c handler
  294.    getenv    get field value from environment
  295.    system    pass command to operating system shell
  296.  
  297. 13.23    Time and Date Functions
  298.  
  299.    day        return formatted date and time
  300.    date        return date string
  301.    seconds    return seconds since some point in past
  302.    time        return time string
  303.  
  304.