A DolDoc in memory is a Circular Queue of cmds and graphics. See CDocEntry for the entry structure. See TipOfDay() for a nice example. DolDoc's are used for the editor, viewer, browser, and cmd line. CDoc Class Linked Text File header CDocBin Class class CDocBin CDocEntry Class class CDocEntry:CDocEntryBase CDocEntryBase Class class CDocEntryBase CDocSettings Class class CDocSettings CDolDocGlbls Class class CDolDocGlbls DocBottom Funct Move cursor, cur_entry, to bottom. DocCenter Funct Center win on doc cursor, cur_entry. DocClear Funct Clear all doc entries, except +H, hold entries. DocCollapse Funct Collapse or uncollapse all tree widgets. DocCursor Funct Show or hide cursor. DocDel Funct Free entire doc and entries. DocEd Funct Live for user interaction. End on <ESC> or <SHIFT-ESC>. DocEntryCopy Funct Make copy of entry and all parts of entry. DocEntryDel Funct Free entry and all parts of entry. DocEntryRun Funct Do action on final entry sel by user. DocEntrySize Funct Mem size of entry and all parts. DocGetKey Funct Called by View. You probably don't need this. DocHighlightCursor Funct Highlight or Don't highlight cursor. DocInsDoc Funct Insert copy of doc2 into doc at insert pt, cur_entry. DocInsEntry Funct Insert entry into doc, updating its vals. DocLock Funct Make this task have exclusive access to this doc. DocNew Funct MAlloc new DolDoc. (Begin a new doc.) DocRecalc Funct Recalc and fmt. Also used by WinMgr to draw on scrn. DocRst Funct Del all entries and set doc to dfts. DocScroll Funct Turn scroll bars OFF/ON. DocSize Funct Mem size of doc and all its entries. DocTop Funct Move cursor, cur_entry, to top. DocUnlock Funct Release exclusive lock on access to doc. PopUpEd Funct Create PopUp win task and edit a doc. doldoc GlbVar } doldoc;
DolDoc ClipCopy Funct Copy DOCET_SEL flagged entries to clip. ClipCut Funct Remove sel entries and place on clip. ClipDel Funct Delete everything on clip. ClipPaste Funct Insert copy of clip at insert pt, cur_entry. DocCopy Funct Copies start to end entry, including end points. DocCut Funct Del start to end entry, including end points. sys_clip_doc GlbVar CDoc *sys_clip_doc;
DolDoc/Clip Collapse Funct Collapse DolDoc trees. CursorRem Funct Rem ASCII 5 cursor. DocD Funct Dump live chunk of mem showing offsets. Can be edited. DocDm Funct Dump live chunk of mem showing addresses. Can be edited. DocHasBin Funct Returns true if DolDoc has binary content DocMax Funct Set max document entries. (Cmd line buffer size.) DocOpt Funct Optimize DolDoc files, eliminating aux_str's and .Z's. Ed Funct Invoke document editor. Man Funct Owner's manual for symbol. Edit src code for symbol. Plain Funct Edit document in plain text mode, so dollar signs are not special. TOSToFuncRep Funct Convert DolDocfile to HTML. TOSToHtml Funct Convert DolDocfile to HTML. ToDolDoc Funct Convert text file to DolDoc by making double $'s. ToTXT Funct Convert DolDocfile to plain text. Type Funct Output txt or graphic file to command line.
DolDoc/Cmd Line (Typically) DocTreeExe Funct Execute doc tree branch. DocTreeFExe Funct Execute doc tree branch in file. ExeDoc Funct JIT Compile and execute a document. StreamDoc Funct Inject doc into compile stream. Use inside #exe{}.
DolDoc/Compiler Doc2FuncRep Funct Cvt DolDocdoc to HTML file. Doc2Html Funct Cvt DolDocdoc to HTML file. Doc2TXT Funct Cvt DolDoc doc to plain text. TOSToFuncRep Funct Convert DolDocfile to HTML. TOSToHtml Funct Convert DolDocfile to HTML. ToDolDoc Funct Convert text file to DolDoc by making double $'s. ToTXT Funct Convert DolDocfile to plain text.
DolDoc/Conversion DocAnchorFind Funct Find named anchor. Move cur_entry & center. DocFind Funct Find str by searching tags. Move cur_entry & center. DocGoToLine Funct Nearest to specified line num. Move cur_entry & center. EdCurU8 Funct Return cur U8. See EdRenumAsm for an example. EdCursorLeft Funct Move cursor left. Might need a call to DocRecalc(). EdCursorRight Funct Move cursor right. Might need a call to DocRecalc(). EdFindNext Funct Editor F3 find next, possibly doing replaces. EdFindPaired Funct Find { } or ( ) pair. Move cur_entry & center. EdGoToFun Funct Move cur_entry to start of cur fun and center.(Shoddy) EdLineDown Funct Move cursor down. Might need a call to DocRecalc(). EdLineUp Funct Move cursor up. Might need a call to DocRecalc(). EdReplace Funct Find & replace using editor's cmd. EdSelAll Funct Set state of DOCET_SEL on all entries. EdSelFun Funct Set DOCET_SEL on all entries in cur fun.
DolDoc/Editor ClipCopyCB Funct { ClipCutCB Funct { ClipPasteCB Funct { DocAppendLine Funct Append a line to a doc file. DocLineRead Funct Extract line from stored doc file. (Slow.) DocLineWrite Funct Write line to stored doc file. (Slow.) DocLoad Funct Fetch doc from raw mem buf. DocPrependLine Funct Append a line to a doc file. DocRead Funct Fetch doc from disk. See flags. DocSave Funct Store doc to raw mem buf. DocWrite Funct Store doc to disk.
DolDoc/File DocForm Funct User input. Supply a class name that has format definitions. DocMenu Funct Run menu chooser doc. Returns menu doc unlocked. DocScanLine Funct Start at entry in doc,make and return one line as str. FileNameForm Funct Text filename form in cur win, not PopUp. PopUp1 Funct Make PopUp win task with one bttn. PopUp2 Funct Make PopUp win task with two bttns. PopUpCancelOk Funct Make PopUp win task CANCEL/OKAY bttns. PopUpFileName Funct Filename chooser. Uses form, not FileMgr(). PopUpForm Funct See ::/Demo/DolDoc/Form.HC and ::/Demo/LastClass.HC. PopUpGetF64 Funct Prompt for F64 text expression in PopUp win task. PopUpGetI64 Funct Prompt for I64 text expression in PopUp win task. PopUpGetStr Funct Prompt for text str in PopUp win task. PopUpMenu Funct Run menu chooser doc in PopUp win task. PopUpNoYes Funct Make PopUp win task with NO/YES bttns. PopUpOk Funct Make PopUp win task with OKAY bttn. PopUpPickDefineSub Funct Prompt for Define lst entry in PopUp win task. PopUpPickDir Funct File dir name chooser. Uses FileMgr(). PopUpPickFile Funct Filename chooser. Uses FileMgr(). PopUpPickLst Funct Prompt for lst entry in PopUp win task. PopUpRangeF64 Funct Evenly-spaced F64 range chooser in PopUp win task. PopUpRangeF64Exp Funct Exp-spaced F64 range chooser in PopUp win task. PopUpRangeF64Log Funct Log-spaced F64 range chooser in PopUp win task. PopUpRangeI64 Funct Evenly-spaced I64 range chooser in PopUp win task.
DolDoc/Input DocEntryLink Funct MAlloc new str, either tag or aux_str if link. DocLinkChk Funct Check for bad Editor Link. DocLinkFile Funct Return the file for an Editor Link Types. EdLinkCvt Funct Editor Link--> filename, needle_str and line number.
DolDoc/Link DocBMP Funct Put a BMP file into a document as a sprite. DocD Funct Dump live chunk of mem showing offsets. Can be edited. DocDm Funct Dump live chunk of mem showing addresses. Can be edited. DocGR Funct Put a GR file into a document as asprite. DocPrint Funct You must not print partial doc cmds. DocPrintAtomic Funct Prints multiple whole cmds all-at-once. Might need this when printing trees. DocPrintPartial Funct Lets you print half a doc cmd, if you like. DocPutKey Funct PutKey(ch,sc) at doc insert pt, cur_entry. DocPutLine Funct Send line from other doc to StdOut DocPut. DocSprite Funct Put a sprite into a document. You can, optionally, supply a fmt string DocType Funct Output txt or graphic file to document. PopUpViewDoc Funct Pass doc to PopUp win task for viewing. PopUpViewPrint Funct View Print stmt in PopUp win task. Sprite Funct Put sprite to the command-line, DocPut. View Funct Go live for user interaction until <ESC> or <SHIFT-ESC>.
DolDoc/Output There is one CDoc for the task's border: Fs->border_doc. There is a pair for the task's client area: Fs->put_doc and Fs->display_doc. You can, optionally, do double buffering, otherwise Fs->put_doc is the same as Fs->display_doc. See ::/Demo/Spy.HC. DocBorder Funct Doc holding border of window text. DocBorderNew Funct Make new std border doc. DocDblBufEnd Funct See ::/Demo/Spy.HC DocDblBufStart Funct See ::/Demo/Spy.HC DocDblBufSwap Funct See ::/Demo/Spy.HC DocDisplay Funct StdOut displayed unless double buffering. DocPut Funct Current document that StdOut Put() goes to. DocTermNew Funct Make into term win task with Put/Display/Border docs.
DolDoc/Task DocTreeAppend Funct Append to doc tree branch. DocTreeExe Funct Execute doc tree branch. DocTreeFAppend Funct Append to doc tree branch in file. DocTreeFExe Funct Execute doc tree branch in file. DocTreeFFind Funct Find tree widget in file. DocTreeFWrite Funct Rewrite doc tree branch in file. DocTreeFind Funct Find tree widget start and end. DocTreeMake Funct Make tree widget. DocTreeWrite Funct Rewrite doc tree branch.
DolDoc/Tree