Power-Programmierung

home *** CD-ROM | disk | FTP | other *** search

/ Power-Programmierung / CD1.mdf / pascal / library / dos / nicol / sti_edit / sti_edit.txt < prev next >

Wrap

Text File | 1980-01-01 | 14.9 KB | 551 lines

EDITOR SUB-SYSTEM 1.0 For Turbo Pascal Version 5.0 Copyright 1990, 1991 By Software Technology International All Rights Reserved -1- NOTICE ------ All parts of this manual and the accompanying soft- ware are copyrighted material. You, as a registered user, are granted permission to make as many copies of the software, or manual, as you wish, as long as they are for your personal use. You may not copy this soft- ware, or manual, in any form whatsoever for usage outside of your personal use. This includes, but is not limited to, duplication of the disk, the files on the disk or the manual, by manual or electronic means. -2- TABLE OF CONTENTS ----------------- Subject Page ----------------------------------------------------- GENERAL DESCRIPTION ...................... 4 Introduction ........................... 4 The software ........................... 4 THE SOFTWARE IN DETAIL ................... 5 The Main Procedures .................... 5 Usage Pointers ......................... 8 INDEX .................................... 9 -3- GENERAL DESCRIPTION ------------------- Introduction ------------ Welcome to Version 1.0 of Software Technology Inter- nationals' Editor Sub-System. This unit provides an editor that you can build into any application. This editor, while not aimed at being a professional editor, provides more than ample power to the end user, and a lot of flexibility to the programmer that includes it into his/her program. The editor was written to be flexible, as fast as possible, and as easy to use as possible. We hope they live up to your expectations. Please feel free to write to us anytime with bug reports or suggestions for future versions. If you are a registered user, this will entitle you to a free upgrade. Remember that this software is copyrighted, so please don't copy and distribute it, this is a federal offense. The Software ------------ The software consists of various units, that, when combined make-up the editor sub-system. The editor sub-system is accessed through only a single procedure, and provides a lot of flexibility. The editor can be various sizes, can have a border, provides all common editing features, and a few that are not so common. It also allows you to tie in help and directory routines. The editor takes up around 80k in memory alone, and about 100k with the help unit and directory units added. The files are edited in memory, so files are only limited in size to the size of the memory. The editor requires the use of a few other STI units to be fully functional, but an ambitious programmer can probably get around this dependency. -4- THE SOFTWARE IN DETAIL ---------------------- The Procedure ------------- The editor subsystem is accessed through the follow- ing procedure. procedure STI_ED(X1,Y1, X2,Y2, TextCol, BorderCol, PromptCol : byte; Border : boolean; Name : string; HelpP, DirP, PassP : pointer); The X1,Y1,X2,Y2 parameters are the screen co- ordinates for the editor. The area below this is auto- matically saved, and restored when the editor is exit- ed. The TextCol, BorderCol and PromptCol parameters specify the colors for the text, border and prompts respectively. The Border parameter is a flag telling the sub- system whether a border is required or not. The Name paramater is a string specifying the name of the file to be edited. The HelpP, DirP and PassP parameters are pointers to functions that supply additional abilities. The HelpP pointer points to a help routine. The DirP is a pointer to a procedure that supplies a directory/file selection routine, and the PassP pointer points to a procedure that can accept an array containing keystrokes that have no meaning to the editor. The prototypes for the three procedures are as follows. procedure Help_Me_Please; function Select_A_File : string; procedure Passed_On_Characters(Chars : ChrSet); To see how these are used, have a look at the file STI_EDEM.PAS. -5- COMMANDS -------- The editor supports the following commands. BS : deletes character to the left TAB : works as one would expect RET : works as normal ESC : read, but ignored HELP : calls help routine is specified F1 : same as help F2 : save the current file F3 : load a file F4 : Search F5 : Search and Replace F6 : Mark block start F7 : Mark block end F8 : Copy a block F9 : Erase a block F10 : Quit Arrow : They work as is normal ^PP : Print editor file ^PB : Print a block ^S : Left one character ^D : Right one character ^E : Up one line ^X : Down one line ^A : One word left ^F : One word right ^R : One screen up ^C : One screen down ^G : Delete character at cursor ^I : Insert mode toggle ^Y : Erase one line ^T : Erase next word ^KD : Quit and Save ^KQ : Quit ^KS : Save ^KB : Mark Block Start ^KC : Copy a block ^KK : Mark Block End ^KY : Delete a Block ^KV : Move a Block ^KW : Write a block ^KR : Read a block ^QQ : Search and Replace ^QH : Erase line contents ^QF : Search ^QC : Jump to end of file ^QR : Jump to start of file ^LU : Uppercase Line ^LD : Lowercase Line ^LC : Centre Line (to 128 char width) -6- ^LR : Trim right side of line ^LL : Trim left side of line ^WU : Uppercase word ^WD : Lowercase word ^DELETE : Delete word(^T) ^LEFT ARROW : Start of line ^RIGHT ARROW : End of line ^UP ARROW : One screen up ^DOWN ARROW : One screen down SHIFT+TAB : Reset tab width SHIFT+ROLL UP : End of file SHIFT+ROLL DOWN : Start of file SHIFT+INSERT : Insert a lne SHIFT+DELETE : Delete a line SHIFT+HOME CLR : End of line SHIFT+LEFT : One word left SHIFT+RIGHT : One word right SHIFT+UP : Top of screen SHIFT+DOWN : Bottom of screen All other combinations are passed on to the calling program. -7- USAGE POINTERS -------------- The main points that the programmer should be aware of are that: a) The program requires a lot of memory (70k). Most of this is code (63k). b) The cursor speed is sometimes too fast. This is due to a bug in the Delay routine in TP. c) The program edits a file in memory, so the file size is limited to available memory. Sometimes this is a serious limitation. d) Without the Help and especially the Directory code the program is not as useful as it is with them. e) The editor allows special key combinations to be passed back to the calling routine. This makes it ideal for a situation where you need multiple files or an integrated environment like. -8- INDEX ----- Topic Page Number ------------------------------------------------------- Commands.................................. 6 Contents.................................. 3 Copying................................... 2 Copyright................................. 2 Descriptions.............................. 5 General Description....................... 4 Introduction.............................. 4 Procedures................................ 5 Usage..................................... 8 Users..................................... 2 -9-