home *** CD-ROM | disk | FTP | other *** search
/ Amiga MA Magazine 1998 #7 / amigamamagazinepolishissue1998.iso / www / rwe / developer / ted.doc < prev    next >
Text File  |  1997-07-03  |  8KB  |  282 lines
  1. TABLE OF CONTENTS
  2.  
  3. ted.library/TEDSetLabelList
  4. ted.library/TEDSetLabelCount
  5. ted.library/TEDGetLabelList
  6. ted.library/TEDGetLabelCount
  7. ted.library/TEDSetJumpTable
  8. ted.library/TEDGetJumpTable
  9. ted.library/TEDError
  10. ted.library/TEDSetFirstLine
  11. ted.library/TEDSetCurrentLine
  12. ted.library/TEDGetFirstLine
  13. ted.library/TEDGetCurrentLine
  14. ted.library/TEDDetoke
  15. ted.library/TEDGetFilename
  16. ted.library/TEDSetLabelList
  17.                                                     ted.library/TEDSetLabelList
  18.    NAME
  19.        TEDSetLabelList -- tell the library where the address of label-list pointer
  20.                       is
  21.  
  22.    SYNOPSIS
  23.        TEDSetLabelList(&mice)
  24.                         A0
  25.  
  26.    FUNCTION
  27.        TEDSetLabelList attempts to tell ted.library where the pointer to the
  28.        list of 'mouseabel' labels is.
  29.  
  30.    INPUTS
  31.        &mice -- address of the pointer to the label list
  32.  
  33. ted.library/TEDSetLabelCount
  34.                                                    ted.library/TEDSetLabelCount
  35.    NAME
  36.        TEDSetLabelCount -- tell the library where the address of the label
  37.                            counter is
  38.  
  39.    SYNOPSIS
  40.        TEDSetLabelCount(&micecount)
  41.                             A0
  42.  
  43.    FUNCTION
  44.        Attempt to tell ted.library where the label counter is held.
  45.  
  46.    INPUTS
  47.        &micecount -- address of label counter
  48.  
  49. ted.library/TEDGetLabelList
  50.                                                     ted.library/TEDGetLabelList
  51.    NAME
  52.        TEDGetLabelList -- obtain the address of the label-list
  53.  
  54.    SYNOPSIS
  55.        address = TEDGetLabelList()
  56.        D0
  57.  
  58.    FUNCTION
  59.        Returns the address of the label-list
  60.  
  61.    RESULT
  62.        address -- address of the label-list (0 for failure)
  63.  
  64.    NOTES
  65.        The label-list is constructed as follows :
  66.  
  67.             *NextLabel
  68.             *LabelText
  69.  
  70.        where LabelText :
  71.             *PrevLine
  72.             *NextLine
  73.             linelength.b
  74.             <actual tokenised text>
  75. ted.library/TEDGetLabelCount
  76.                                                    ted.library/TEDGetLabelCount
  77.    NAME
  78.        TEDGetLabelCount -- find out how many mouseable labels there are
  79.  
  80.    SYNOPSIS
  81.        count = TEDGetLabelCount()
  82.        D0
  83.  
  84.    FUNCTION
  85.        Find out the number of 'mouseable' labels there are.
  86.  
  87.    RESULT
  88.        count -- the number of 'mouseable' labels (0=failure or no labels)
  89. ted.library/TEDSetJumpTable
  90.                                                    ted.library/TEDSetJumpTable
  91.    NAME
  92.        TEDSetJumpTable -- tell the library where SuperTED's pointer to the
  93.                          function jumptable is.
  94.  
  95.    SYNOPSIS
  96.        TEDSetJumpTable(&jumptable)
  97.                            A0
  98.  
  99.    FUNCTION
  100.        Tell the ted library where SuperTED's function jump table pointer is
  101.  
  102.    INPUTS
  103.        &jumptable -- the address of the pointer to SuperTED's jump table
  104. ted.library/TEDGetJumpTable
  105.                                                    ted.library/TEDGetJumpTable
  106.    NAME
  107.        TEDGetJumpTable -- obtain the locaton of SuperTED's function jump table
  108.  
  109.    SYNOPSIS
  110.        jumptable = TEDGetJumpTable()
  111.        D0
  112.  
  113.    FUNCTION
  114.        Get the locaton of SuperTED's internal function jump table
  115.  
  116.    RESULT
  117.        jumptable -- the address of SuperTED's internal function jump table
  118.  
  119.    NOTES
  120.        At present SuperTED's function jump table is structured thus :
  121.  
  122.          A series of longword pointers to subroutines inside SuperTED :
  123.  
  124.         00    ->    Open Requester
  125.         04    ->    Close Requester
  126.         08    ->    Get Input
  127.         12    ->    Error Requester
  128.         16    ->    Detoke Entire File
  129.         20    ->    Tokenise Entire File
  130.         24    ->    File Requester
  131.         28    ->    Refresh Gadgets
  132.         32    ->    Get Input(2)
  133.         36    ->    RESERVED
  134.         40    ->    Screen Ptr
  135.         44    ->    RESERVED
  136.         48    ->    Change Colours
  137.         52    ->    RESERVED
  138.         
  139.         56    ->    Tokenise One Line
  140.         60    ->    Open IO
  141.         64    ->    Close IO
  142.         68    ->    Activate Gadget
  143.         72    ->    Normal Mouse Pointer
  144.         76    ->    Busy Mouse Pointer
  145.         80    ->    RESERVED
  146.         84    ->    RESERVED
  147.         88    ->    Allocate Memory
  148.         92.w    ->    Bitmap Modulo
  149.         94    ->    Current Requester's Window
  150.         98.w    ->    Button Status
  151.         100    ->    Detoknise One Line
  152.         104    ->    RESERVED
  153.         108    ->    RESERVED
  154.         112    ->    RESERVED
  155.         116    ->    RESERVED
  156.         120    ->    RESERVED
  157.         128    ->    RESERVED
  158.    SEE ALSO
  159.        libraries/ted.i libraries/ted.h
  160. ted.library/TEDError
  161.                                                   ted.library/TEDError
  162.    NAME
  163.        TEDError -- bring up an error requester on SuperTED's screen
  164.  
  165.    SYNOPSIS
  166.        TEDError(bodytext)
  167.                    A0
  168.  
  169.    FUNCTION
  170.        Tell SuperTED to open its standard Error Requester containing
  171.        the specified 'bodytext'. The requester has only one button - 'Okay'
  172.  
  173.    INPUTS
  174.        bodytext -- a pointer to the requester's body text
  175. ted.library/TEDSetFirstLine
  176.                                                   ted.library/TEDSetFirstLine
  177.    NAME
  178.        TEDSetFirstLine -- tell the library where the first line pointer is
  179.  
  180.    SYNOPSIS
  181.        TEDSetFirstLine(&firstlineptr)
  182.                              A0
  183.  
  184.    FUNCTION
  185.        Tell ted.library where SuperTED holds the pointer to the first line
  186.        in the document
  187.  
  188.    INPUTS
  189.        &firstlineptr -- address of the first line pointer (!)
  190. ted.library/TEDSetCurrentLine
  191.                                                   ted.library/TEDSetCurrentLine
  192.    NAME
  193.        TEDSetCurrentLine -- tell the library where the current line pointer is
  194.  
  195.    SYNOPSIS
  196.        TEDSetCurrentLine(¤tlineptr)
  197.                              A0
  198.  
  199.    FUNCTION
  200.        Tell ted.library where SuperTED holds the pointer to the current line
  201.        in the document
  202.  
  203.    INPUTS
  204.        ¤tlineptr -- address of the current line pointer (!)
  205. ted.library/TEDGetFirstLine
  206.                                                   ted.library/TEDGetFirstLine
  207.    NAME
  208.        TEDGetFirstLine -- get the pointer to the first line of text
  209.  
  210.    SYNOPSIS
  211.        lineptr = TEDGetFirstLine()
  212.        D0
  213.  
  214.    FUNCTION
  215.        Retrieve a pointer to the first line of text
  216.  
  217.    RESULTS
  218.        lineptr -- address of the first line of text
  219. ted.library/TEDGetCurrentLine
  220.                                                   ted.library/TEDGetCurrentLine
  221.    NAME
  222.        TEDGetCurrentLine -- get the pointer to the current line of text
  223.  
  224.    SYNOPSIS
  225.        lineptr = TEDGetCurrentLine()
  226.        D0
  227.  
  228.    FUNCTION
  229.        Retrieve a pointer to the current line of text
  230.  
  231.    RESULTS
  232.        lineptr -- address of the current line of text
  233. ted.library/TEDDetoke
  234.                                                   ted.library/TEDDetoke
  235.    NAME
  236.        TEDDetoke -- detokenise a line of source code
  237.  
  238.    SYNOPSIS
  239.        detokenised_line = TEDDetoke(sourceline)
  240.        D0                               A0
  241.  
  242.    FUNCTION
  243.        Get SuperTED to detokenise a line of source code
  244.  
  245.    INPUTS
  246.        sourceline -- the actual tokenised text (NOT the line structure!)
  247.  
  248.    RESULTS
  249.        detokenised_line -- a pointer to detokenised null-terminated text.
  250.  
  251.    NOTES
  252.        ** THIS FUNCTION IS NOW OBSOLETE **
  253.  
  254.        Remember to pass the actual tokenised text, not the line structure!
  255.        SuperTED's line structure is as follows:
  256.  
  257.             *PrevLine
  258.             *NextLine
  259.             linelength.b
  260.             <actual tokenised text>
  261.    SEE ALSO
  262.        blitz.library/DetokeLine
  263. ted.library/TEDGetFilename
  264.                                                   ted.library/TEDGetFilename
  265.    NAME
  266.        TEDGetFilename -- return the name of file currently loaded
  267.  
  268.    SYNOPSIS
  269.        filename = TEDGetFilename()
  270.        D0
  271.  
  272.    FUNCTION
  273.        Get SuperTED to return a string holding the name of the current file
  274.  
  275.    RESULTS
  276.        filename  -- a pointer to a null terminated string holding the
  277.                     full path to the currnt file
  278.  
  279.    NOTES
  280.        The pathname is taken from the 'directory' string in the Load
  281.        requester - so it may well be blank.
  282.