@DATABASE "ted" @MASTER "ted.doc" @REMARK This file was created by ADtoHT 2.1 on 11-Jun-97 20:11:49 @REMARK Do not edit @REMARK ADtoHT is © 1993-1995 Christian Stieber @NODE MAIN "ted.doc" @{b}ted.library@{ub} @{"TEDDetoke()" LINK "TEDDetoke"} @{"TEDError()" LINK "TEDError"} @{"TEDGetCurrentLine()" LINK "TEDGetCurrentLine"} @{"TEDGetFilename()" LINK "TEDGetFilename"} @{"TEDGetFirstLine()" LINK "TEDGetFirstLine"} @{"TEDGetJumpTable()" LINK "TEDGetJumpTable"} @{"TEDGetLabelCount()" LINK "TEDGetLabelCount"} @{"TEDGetLabelList()" LINK "TEDGetLabelList"} @{"TEDSetCurrentLine()" LINK "TEDSetCurrentLine"} @{"TEDSetFirstLine()" LINK "TEDSetFirstLine"} @{"TEDSetJumpTable()" LINK "TEDSetJumpTable"} @{"TEDSetLabelCount()" LINK "TEDSetLabelCount"} @{"TEDSetLabelList()" LINK "TEDSetLabelList"} @ENDNODE @NODE "TEDSetLabelList" "ted.library/TEDSetLabelList()" ted.library/TEDSetLabelList@{b} NAME@{ub} TEDSetLabelList -- tell the library where the address of label-list pointer is@{b} SYNOPSIS@{ub} TEDSetLabelList(&mice) A0@{b} FUNCTION@{ub} TEDSetLabelList attempts to tell ted.library where the pointer to the list of 'mouseabel' labels is.@{b} INPUTS@{ub} &mice -- address of the pointer to the label list @ENDNODE @NODE "TEDSetLabelCount" "ted.library/TEDSetLabelCount()" ted.library/TEDSetLabelCount@{b} NAME@{ub} TEDSetLabelCount -- tell the library where the address of the label counter is@{b} SYNOPSIS@{ub} TEDSetLabelCount(&micecount) A0@{b} FUNCTION@{ub} Attempt to tell ted.library where the label counter is held.@{b} INPUTS@{ub} &micecount -- address of label counter @ENDNODE @NODE "TEDGetLabelList" "ted.library/TEDGetLabelList()" ted.library/TEDGetLabelList@{b} NAME@{ub} TEDGetLabelList -- obtain the address of the label-list@{b} SYNOPSIS@{ub} address = TEDGetLabelList() D0@{b} FUNCTION@{ub} Returns the address of the label-list@{b} RESULT@{ub} address -- address of the label-list (0 for failure)@{b} NOTES@{ub} The label-list is constructed as follows : *NextLabel *LabelText where LabelText : *PrevLine *NextLine linelength.b @ENDNODE @NODE "TEDGetLabelCount" "ted.library/TEDGetLabelCount()" ted.library/TEDGetLabelCount@{b} NAME@{ub} TEDGetLabelCount -- find out how many mouseable labels there are@{b} SYNOPSIS@{ub} count = TEDGetLabelCount() D0@{b} FUNCTION@{ub} Find out the number of 'mouseable' labels there are.@{b} RESULT@{ub} count -- the number of 'mouseable' labels (0=failure or no labels) @ENDNODE @NODE "TEDSetJumpTable" "ted.library/TEDSetJumpTable()" ted.library/TEDSetJumpTable@{b} NAME@{ub} TEDSetJumpTable -- tell the library where SuperTED's pointer to the function jumptable is.@{b} SYNOPSIS@{ub} TEDSetJumpTable(&jumptable) A0@{b} FUNCTION@{ub} Tell the ted library where SuperTED's function jump table pointer is@{b} INPUTS@{ub} &jumptable -- the address of the pointer to SuperTED's jump table @ENDNODE @NODE "TEDGetJumpTable" "ted.library/TEDGetJumpTable()" ted.library/TEDGetJumpTable@{b} NAME@{ub} TEDGetJumpTable -- obtain the locaton of SuperTED's function jump table@{b} SYNOPSIS@{ub} jumptable = TEDGetJumpTable() D0@{b} FUNCTION@{ub} Get the locaton of SuperTED's internal function jump table@{b} RESULT@{ub} jumptable -- the address of SuperTED's internal function jump table@{b} NOTES@{ub} At present SuperTED's function jump table is structured thus : A series of longword pointers to subroutines inside SuperTED : 00 -> Open Requester 04 -> Close Requester 08 -> Get Input 12 -> Error Requester 16 -> Detoke Entire File 20 -> Tokenise Entire File 24 -> File Requester 28 -> Refresh Gadgets 32 -> Get Input(2) 36 -> RESERVED 40 -> Screen Ptr 44 -> RESERVED 48 -> Change Colours 52 -> RESERVED 56 -> Tokenise One Line 60 -> Open IO 64 -> Close IO 68 -> Activate Gadget 72 -> Normal Mouse Pointer 76 -> Busy Mouse Pointer 80 -> RESERVED 84 -> RESERVED 88 -> Allocate Memory 92.w -> Bitmap Modulo 94 -> Current Requester's Window 98.w -> Button Status 100 -> Detoknise One Line 104 -> RESERVED 108 -> RESERVED 112 -> RESERVED 116 -> RESERVED 120 -> RESERVED 128 -> RESERVED@{b} SEE ALSO@{ub} libraries/ted.i libraries/ted.h @ENDNODE @NODE "TEDError" "ted.library/TEDError()" ted.library/TEDError@{b} NAME@{ub} TEDError -- bring up an error requester on SuperTED's screen@{b} SYNOPSIS@{ub} TEDError(bodytext) A0@{b} FUNCTION@{ub} Tell SuperTED to open its standard Error Requester containing the specified 'bodytext'. The requester has only one button - 'Okay'@{b} INPUTS@{ub} bodytext -- a pointer to the requester's body text @ENDNODE @NODE "TEDSetFirstLine" "ted.library/TEDSetFirstLine()" ted.library/TEDSetFirstLine@{b} NAME@{ub} TEDSetFirstLine -- tell the library where the first line pointer is@{b} SYNOPSIS@{ub} TEDSetFirstLine(&firstlineptr) A0@{b} FUNCTION@{ub} Tell ted.library where SuperTED holds the pointer to the first line in the document@{b} INPUTS@{ub} &firstlineptr -- address of the first line pointer (!) @ENDNODE @NODE "TEDSetCurrentLine" "ted.library/TEDSetCurrentLine()" ted.library/TEDSetCurrentLine@{b} NAME@{ub} TEDSetCurrentLine -- tell the library where the current line pointer is@{b} SYNOPSIS@{ub} TEDSetCurrentLine(¤tlineptr) A0@{b} FUNCTION@{ub} Tell ted.library where SuperTED holds the pointer to the current line in the document@{b} INPUTS@{ub} ¤tlineptr -- address of the current line pointer (!) @ENDNODE @NODE "TEDGetFirstLine" "ted.library/TEDGetFirstLine()" ted.library/TEDGetFirstLine@{b} NAME@{ub} TEDGetFirstLine -- get the pointer to the first line of text@{b} SYNOPSIS@{ub} lineptr = TEDGetFirstLine() D0@{b} FUNCTION@{ub} Retrieve a pointer to the first line of text@{b} RESULTS@{ub} lineptr -- address of the first line of text @ENDNODE @NODE "TEDGetCurrentLine" "ted.library/TEDGetCurrentLine()" ted.library/TEDGetCurrentLine@{b} NAME@{ub} TEDGetCurrentLine -- get the pointer to the current line of text@{b} SYNOPSIS@{ub} lineptr = TEDGetCurrentLine() D0@{b} FUNCTION@{ub} Retrieve a pointer to the current line of text@{b} RESULTS@{ub} lineptr -- address of the current line of text @ENDNODE @NODE "TEDDetoke" "ted.library/TEDDetoke()" ted.library/TEDDetoke@{b} NAME@{ub} TEDDetoke -- detokenise a line of source code@{b} SYNOPSIS@{ub} detokenised_line = TEDDetoke(sourceline) D0 A0@{b} FUNCTION@{ub} Get SuperTED to detokenise a line of source code@{b} INPUTS@{ub} sourceline -- the actual tokenised text (NOT the line structure!)@{b} RESULTS@{ub} detokenised_line -- a pointer to detokenised null-terminated text.@{b} NOTES@{ub} ** THIS FUNCTION IS NOW OBSOLETE ** Remember to pass the actual tokenised text, not the line structure! SuperTED's line structure is as follows: *PrevLine *NextLine linelength.b @{b} SEE ALSO@{ub} @{"blitz.library/DetokeLine" LINK "blitz/DetokeLine"} @ENDNODE @NODE "TEDGetFilename" "ted.library/TEDGetFilename()" ted.library/TEDGetFilename@{b} NAME@{ub} TEDGetFilename -- return the name of file currently loaded@{b} SYNOPSIS@{ub} filename = TEDGetFilename() D0@{b} FUNCTION@{ub} Get SuperTED to return a string holding the name of the current file@{b} RESULTS@{ub} filename -- a pointer to a null terminated string holding the full path to the currnt file@{b} NOTES@{ub} The pathname is taken from the 'directory' string in the Load requester - so it may well be blank. @ENDNODE