Programmer 7500

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

/ Programmer 7500 / MAX_PROGRAMMERS.iso / PASCAL / FASTSC.ZIP / FAST.DOC < prev next >

Wrap

Text File | 1989-06-30 | 32.2 KB | 692 lines

FASTSCRN version 1.0 The FASTSCRN unit (and the related FASTDEF unit) is designed to provide simple and fast video control through the use of objects. Some features include: memory screens, option of selecting a color or using previous color, snow avoidance, copying between screens, changing attributes, cursor control, multiple video page support, and multiple video mode support. Section One: FASTSCRN Interface. . . . . . . . . . . . . . . . . . . . . 2 Section Two: FASTDEF Interface . . . . . . . . . . . . . . . . . . . . . 4 Section Three: ScreenObj Description . . . . . . . . . . . . . . . . . . 6 Rows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Cols. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 LastRow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 LastCol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 ScrPtr. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Init. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Done. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Snow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 ScreenPtr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 WriteV. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 WriteA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 WriteAv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 WriteC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 WriteAC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 WriteCv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 WriteACv. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Fill. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Attr. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 CharAt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 ColorAt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Copy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 SetLasts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Section Four: DisplayObj . . . . . . . . . . . . . . . . . . . . . . . . 10 ScreenType. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 ScreenSnow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Init. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Snow. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 CurrentRows . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 CurrentCols . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 CurrentVideoMode. . . . . . . . . . . . . . . . . . . . . . . . . . 11 SetVideoMode. . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 SetCursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 GetCursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 CursorOff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 CursorOn. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 WhereR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 WhereC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 GotoRC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 UsePage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 DisplayPage . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Section Five: Examples . . . . . . . . . . . . . . . . . . . . . . . . . 13 Writing to the screen . . . . . . . . . . . . . . . . . . . . . . . 13 Centering. . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Specifying colors. . . . . . . . . . . . . . . . . . . . . . . 13 Using LastRow and LastCol. . . . . . . . . . . . . . . . . . . 13 Copying to and from screens . . . . . . . . . . . . . . . . . . . . 14 Section Six: Public Domain . . . . . . . . . . . . . . . . . . . . . . . 15 FASTSCRN documentation Page 2 Section One: FASTSCRN Interface ------------ ------------------ ScreenObj = Object Rows,Cols : Byte; LastRow, LastCol : Byte; ScrPtr : Pointer; Constructor Init; Destructor Done; Function Snow:Boolean; Function ScreenPtr(Row, Col:Byte):Pointer; Procedure Write(Row, Col:Byte; Color:Integer; St:String); Procedure WriteV(Row, Col:Byte; Color:Integer; St:String); Procedure WriteA(Row, Col:Byte; Color:Integer; Var St; Len:Byte); Procedure WriteAv(Row, Col:Byte; Color:Integer; Var St; Len:Byte); Procedure WriteC(Row, Col1, Col2:Byte; Color:Integer; St:String); Procedure WriteAC(Row, Col1, Col2:Byte; Color:Integer; Var St; Len:Byte); Procedure WriteCv(Row1, Row2, Col:Byte; Color:Integer; St:String); Procedure WriteACv(Row1, Row2, Col:Byte; Color:Integer; Var St; Len:Byte); Procedure Fill(Row, Col, Rows, Cols:Byte; Color:Integer; Ch:Char); Procedure Color(Row, Col, Rows, Cols:Byte; Color:Integer; Ch:Char); Function CharAt(Row, Col:Byte):Char; Function ColorAt(Row, Col:Byte):Byte; Procedure Copy(SourceScreen:ScreenObj; SourceRow, SourceCol, SourceRows, SourceCols, DestRow, DestCol:Byte); Procedure SetLasts(Rows, Cols:Byte); End; DisplayObj= Object (ScreenObj) ScreenType : Byte; ScreenSnow : Boolean; Page : Byte; Constructor Init; Function Snow:Boolean; Function CurrentRows:Byte; Function CurrentCols:Byte; Function CurrentVideoMode:Byte; Procedure SetVideoMode(Mode:Byte); FASTSCRN documentation Page 3 Procedure SetCursor(Top,Bottom:Byte); Function GetCursor:Word; Procedure CursorOn; Procedure CursorOff; Function WhereR:Byte; Function WhereC:Byte; Function GotoRC(Row, Col:Byte); Procedure UsePage(PageNum:Byte); Procedure DisplayPage(PageNum:Byte); Function CurrentPage:Byte; End; Var DisplayScreen : DisplayObj; NOTE:The DisplayScreen variable is automatically set to the current video display when your program is first run, therefore ALL writes to the screen should go through DisplayScreen. Although not shown, ALL methods (except Constructors, of course) are declared as VIRTUAL for easy extensibility. FASTSCRN documentation Page 4 Section Two: FASTDEF interface ------------ ----------------- Type BorderTypes = (NoBrdr, SpaceBrdr, SingleBrdr, DoubleBrdr, HorizDoubleVertSingleBrdr, HorizSingleVertDoubleBrdr, BlockBrdr, Hatch1Brdr, Hatch2Brdr, Hatch3Brdr, SmallDotBrdr, MedDotBrdr, BigDotBrdr, User1Brdr, User2Brdr, User3Brdr ); Borders = (HorizTop, HorizBottom, VertLeft, VertRight, HorizBorders, VertBorders, AllBorders); BorderParts = (TL,TR,BL,BR,HT,HB,VR,VL,LC,RC,TC,BC,CC); The positions for these are as follows: TL HT TC HT TR VL VR LC HT CC HT RC VL VR BL HB BC HB BR The mnemonics corrspond to the following: TL : Top left corner TR : Top right corner BL : Bottom left corner BR : Bottom right corner HT : Horizontal top line HB : Horizontal bottom line VR : Vertical right line VL : Vertical left line LC : Left connecting piece RC : Right connecting piece TC : Top connecting piece BC : Bottom connecting piece CC : Center connecting piece BorderArray = Array[TL..CC] of Char; Const Black = $0; Blue = $1; Green = $2; Cyan = $3; Red = $4; Magenta = $5; Brown = $6; LightGray = $7; DarkGray = $8; LightBlue = $9; LightGreen = $A; LightCyan = $B; LightRed = $C; LightMagenta = $D; Yellow = $E; White = $F; Blink = $80; BlackBG = $0; FASTSCRN documentation Page 5 BlueBG = $10; GreenBG = $20; CyanBG = $30; RedBG = $40; MagentaBG = $50; BrownBG = $60; LightGrayBG = $70; SameAttr = -1; SameColor = SameAttr; NoDisplay = $0; MDAmono = $1; CGAcolor = $2; DCC3 = $3; EGAcolor = $4; EGAmono = $5; PGCcolor = $6; VGAmono = $7; VGAcolor = $8; DCC9 = $9; DCC10 = $A; MCGAmono = $B; MCGAcolor = $C; Unknown = $FF; BorderSt : Array [SpaceBrdr..User3Brdr] of BorderArray= ('█████████████', SpaceBrdr '┌┐└┘──││├┤┬┴┼', SingleBrdr '╔╗╚╝══║║╠╣╦╩╬', DoubleBrdr '╒╕╘╛══││╞╡╤╧╪', HorizDoubleVertSingleBrdr '╓╖╙╜──║║╟╢╥╙╫', HorizSingleVertDoubleBrdr '▄▄▀▀▄▀▐▌▀▀▄▀■', BlockBrdr '░░░░░░░░░░░░░', Hatch1Brdr '▒▒▒▒▒▒▒▒▒▒▒▒▒', Hatch2Brdr '▓▓▓▓▓▓▓▓▓▓▓▓▓', Hatch3Brdr '·············', SmallDotBrdr '∙∙∙∙∙∙∙∙∙∙∙∙∙', MedDotBrdr #7#7#7#7#7#7#7#7#7#7#7#7#7, LargeDotBrdr ' ', User1Brdr ' ', User2Brdr ' '); User3Brdr FASTSCRN documentation Page 6 Section Three: ScreenObj description -------------- --------------------- The ScreenObj object type is used for in-memory screens. Normally, an in- memory screen is used to store information from the main-screen, modify it in some way, and then re-display back onto the screen. Because ScreenObj assumes it is in-memory, no snow checks are made. ---------------------------------------------------------------------- Rows:Byte ---------------------------------------------------------------------- The Rows variable contains the number of rows the ScreenObj contains. ---------------------------------------------------------------------- Cols:Byte ---------------------------------------------------------------------- The Cols variable contains the number of columns per row that the ScreenObj contains. ---------------------------------------------------------------------- LastRow:Byte ---------------------------------------------------------------------- The LastRow variable is set to the row last written on. LastRow is updated by all ScreenObj.Write procedures (including array writes, vertical writes, and centered writes), ScreenObj.Fill procedure and ScreenObj.Attr procedure. ---------------------------------------------------------------------- LastCol:Byte ---------------------------------------------------------------------- The LastCol variable is set to the column last written on. LastCol is updated by all ScreenObj.Write procedures (including array writes, vertical writes, and centered writes), ScreenObj.Fill procedure and ScreenObj.Attr procedure. ---------------------------------------------------------------------- ScrPtr:Pointer ---------------------------------------------------------------------- ScrPtr points to the location in memory where the screen (either memory screen or actual video display) begins. ---------------------------------------------------------------------- Constructor Init ---------------------------------------------------------------------- The Init constructor must be called prior to any activity on that screen. Init sets up the Virtual Method Table (VMT) as well as initialized LastRow and LastCol to 1. FASTSCRN documentation Page 7 ---------------------------------------------------------------------- Destructor Done ---------------------------------------------------------------------- The Done destructor simply reclaims the memory used by the Virtual Method Table (VMT). ---------------------------------------------------------------------- Function Snow:Boolean ---------------------------------------------------------------------- The ScreenObj.Snow function always returns False. This function will probably be eliminated in future releases of FASTSCRN ---------------------------------------------------------------------- Procedure Write(Row, Col, Color, StringToWrite) ---------------------------------------------------------------------- Write will put StringToWrite at Row and Col on the ScreenObj. Write automatically takes care of the video page and snowing. If Color is -1 (SameColor/SameAttr), the previous color will be used. ---------------------------------------------------------------------- Procedure WriteV(Row, Col, Color, StringToWrite) ---------------------------------------------------------------------- WriteV will put StringToWrite VERTICALLY at Row and Col on the ScreenObj. WriteV automatically takes care of the video page and snowing. If Color is -1 (SameColor/SameAttr), the previous color will be used. ---------------------------------------------------------------------- Procedure WriteA(Row, Col, Color, ArrayToWrite, Len) ---------------------------------------------------------------------- WriteA will put ArrayToWrite of length Len at Row and Col on the ScreenObj. WriteA automatically takes care of the video page and snowing. If Color is -1 (SameColor/SameAttr), the previous color will be used. ---------------------------------------------------------------------- Procedure WriteAv(Row, Col, Color, ArrayToWrite, Len) ---------------------------------------------------------------------- WriteAv will put ArrayToWrite of length Len VERTICALLY at Row and Col on the ScreenObj. WriteA automatically takes care of the video page and snowing. If Color is -1 (SameColor/SameAttr), the previous color will be used. FASTSCRN documentation Page 8 ---------------------------------------------------------------------- Procedure WriteC(Row, Col1, Col2, Color, StringToWrite) ---------------------------------------------------------------------- WriteC will put StringToWrite on the ScreenObj centered between Col1 and Col2. WriteC automatically takes care of the video page and snowing. If Color is -1 (SameColor/SameAttr), the previous color will be used. ---------------------------------------------------------------------- Procedure WriteAC(Row, Col1, Col2, Color, ArrayToWrite, Len) ---------------------------------------------------------------------- WriteAC will put ArrayToWrite of length Len on the ScreenObj centered between Col1 and Col2. WriteAC automatically takes care of the video page and snowing. If Color is -1 (SameColor/SameAttr), the previous color will be used. ---------------------------------------------------------------------- Procedure WriteCv(Row1, Row2, Col, Color, StringToWrite) ---------------------------------------------------------------------- WriteCv will put StringToWrite on the ScreenObj centered VERTICALLY between Row1 and Row2. WriteCv automatically takes care of the video page and snowing. If Color is -1 (SameColor/SameAttr), the previous color will be used. ---------------------------------------------------------------------- Procedure WriteACv(Row1, Row2, Col, Color, ArrayToWrite, Len) ---------------------------------------------------------------------- WriteACv (yes, you guessed it!) will put ArrayToWrite on the ScreenObj centered VERTICALLY between Row1 and Row2. WriteACv (maybe you can guess this part also) automatically takes care of the video page and snowing. If Color is -1 (SameColor/SameAttr), the previous color will be used. ---------------------------------------------------------------------- Procedure Fill(Row, Col, Rows, Cols, Color, FillChar) ---------------------------------------------------------------------- Fill fills the ScreenObj from Row and Col for Rows number of rows and Cols number of columns with the FillChar using the color of Color. Fill automatically takes care of the video page and snowing. If Color is -1 (SameColor/SameAttr), the previous color will be used. ---------------------------------------------------------------------- Procedure Color(Row, Col, Rows, Cols, Color) ---------------------------------------------------------------------- Color will color from Row, Col for Rows number of Rows and Cols number of columns the color of Color. Color automatically takes care of the video page and snowing. FASTSCRN documentation Page 9 ---------------------------------------------------------------------- Function CharAt(Row, Col):Char ---------------------------------------------------------------------- CharAt returns the character at position Row, Col. ---------------------------------------------------------------------- Function ColorAt(Row, Col):Byte ---------------------------------------------------------------------- ColorAt returns the color at position Row, Col. ---------------------------------------------------------------------- Procedure SetLasts(Rows, Cols) ---------------------------------------------------------------------- SetLasts sets the variables LastRow and LastCol. Should not normally be called by the program. FASTSCRN documentation Page 10 Section Four: DisplayObj ------------- ---------- The DisplayObj object type is used for displaying information on the screen. Full snow checking and prevention is done with this object. Normally there is only one DisplayObj and that is DisplayScreen (which is initialized in the start-up code for the FASTSCRN unit), although multiple screens can be handled by declaring more DisplayObjs and some virtual methods. ---------------------------------------------------------------------- ScreenType:Byte ---------------------------------------------------------------------- The variable ScreenType is initialized when DisplayObj.Init is called. The detected video screen is stored in this variable. Currently, ScreenType can only be one of the following values: VGAcolor, VGAmono, EGAcolor, EGAmono, CGAcolor, CGAmono Although only the above screen types are detected, FASTSCRN defines the following screen types also: MDAmono, DCC3, PGCcolor, DCC9, DCC10, MCGAmono, MCGAcolor ---------------------------------------------------------------------- ScreenSnow:Boolean ---------------------------------------------------------------------- This variable stores TRUE if the DisplayObj snows during memory writes, or FALSE if it does not. It is set during the DisplayObj.Init process. ---------------------------------------------------------------------- Page:Byte ---------------------------------------------------------------------- This variable stores the current video page. This value should never be accessed by a program, use DisplayPage and UsePage instead. ---------------------------------------------------------------------- Constructor Init ---------------------------------------------------------------------- Call DisplayObj.Init prior to any access to the screen. This routine detects the following video cards: CGA, VGA, and EGA It also determines whether or not the screen is color or monochrome and if it snows. Note: The DisplayScreen variable is automatically Init at the beginning of the program. ---------------------------------------------------------------------- Function CurrentRows:Byte ---------------------------------------------------------------------- This routine returns the number of rows on the screen. It is completely independant of ScreenObj.Rows. FASTSCRN documentation Page 11 ---------------------------------------------------------------------- Function CurrentCols:Byte ---------------------------------------------------------------------- This routine returns the number of columns on the screen. It is compoletely independant of ScreenObj.Cols. ---------------------------------------------------------------------- Function CurrentVideoMode:Byte ---------------------------------------------------------------------- This routine returns the current video mode. ---------------------------------------------------------------------- Procedure SetVideoMode(Mode:Byte) ---------------------------------------------------------------------- This routine sets the video mode to Mode. ---------------------------------------------------------------------- Procedure SetCursor(Top, Bottom:Byte) ---------------------------------------------------------------------- Sets the top scan line of the cursor to Top and the bottom scan line to Bottom. ---------------------------------------------------------------------- Function GetCursor:Word ---------------------------------------------------------------------- Returns the top and bottom scan line of the cursor. Hi(GetCursor) is the Top and Lo(GetCursor) is the bottom. ---------------------------------------------------------------------- Function WhereR:Byte ---------------------------------------------------------------------- Returns the current row of the cursor. ---------------------------------------------------------------------- Function WhereC:Byte ---------------------------------------------------------------------- Returns of the current column of the cursor. FASTSCRN documentation Page 12 ---------------------------------------------------------------------- Procedure UsePage(Page:Byte) ---------------------------------------------------------------------- Directs all reads, writes, and cursor locating routines to the video page, Page. ---------------------------------------------------------------------- Procedure DisplayPage(Page:Byte) ---------------------------------------------------------------------- Displays the video page, Page. FASTSCRN documentation Page 13 Section Five: Examples ------------- -------- Writing to the screen --------------------- Uses FastScrn, FastDef; Begin With DisplayScreen Do Begin Fill(1,1,Rows,Cols,BlackBG+White,' '); (* Clears the screen and sets the using a black background and white foreground *) Write(1,1,BlackBG+White,'Hello'); (* Places 'Hello' at row 1, column 1 in white letters on a black background *) Write(10,1,Red+DarkGrayBG,'world!'); (* Places 'world!' at row 10, column 1 in red letters on a dark gray background *) End; End. Centering --------- Uses FastDef, FastScrn; Begin With DisplayScreen Do WriteC(1, 1,Cols, BlackBG+White, 'Hello world!'); (* Places 'Hello world!' centered between the first column and the last column on the screen *) End. SameColor/SameAttr ------------------ Uses FastScrn, FastDef; Begin With DisplayScreen Do Begin Color(1,1,Rows div 2,Cols,White+RedBG); (* Colors the top half of the screen with a white foreground and a red background *) Color((Rows div 2)+1,1,Rows div 2, Cols, BlackBG+Green); (* Colors the bottom half of the screen with a green forground and a black background *) WriteVC(1,Rows,Cols div 2,SameColor,'Hello world!'); (* Centered vertically, 'Hello world!' appears, half in white on red and half in green on black *) End; End. LastRow and LastCol ------------------- Uses FastDef, FastScrn; Begin With DisplayScreen Do Begin Write(1,1,SameColor,'Hello '); Write(LastRow, LastCol, SameColor, 'world!'); FASTSCRN documentation Page 14 (* Places 'world!' next to 'Hello ' using the previous screen color *) End; End. Copying to and from screens --------------------------- Uses FastScrn, FastDef; Var MemoryScreen : ScreenObj; Begin With MemoryScreen Do Begin Init; Rows:=10; Cols:=10; GetMem(ScrPtr, Rows*Cols*2); (* Get enough memory for the screen. Multiply by 2 because each character on the screen consists of two bytes *) Fill(1,1,Rows,Cols,White+BlueBG,'*'); (* Fill MemoryScreen with astericks *) Write(1,1,SameColor,'This is the memory screen'); (* Put 'This is the memory screen' into MemoryScreen in white on a blue background. FastScrn automatically takes care of wrapping the text *) End; With DisplayScreen Do Begin Fill(1,1,Rows,Cols,BlackBG+White,' '); (* Clear the screen *) Copy(MemoryScreen,1,1, MemoryScreen.Rows,MemoryScreen.Cols, 1,15); (* Copies the memory screen to row 1, column 15 of the display screen *) End; End. FASTSCRN documentation Page 15 Section Six: Public Domain ------------ ------------- This software is hereby released into the public domain to do with it as it will. If you have any ideas for extending FASTSCRN or modifying it in some way, I want to hear from you. Also, if you have any questions or comments about FASTSCRN, please let me know. Mark Addleman [72777, 740]