diff --git a/harbour/ChangeLog b/harbour/ChangeLog index 4295f7c2ff..d8c8bd3693 100644 --- a/harbour/ChangeLog +++ b/harbour/ChangeLog @@ -1,3 +1,13 @@ +19991230-08:22 GMT+2 Chen Kedem + * source/rtl/text.prg + + doc for __TextSave() + + doc for __TextRestore() + * source/rtl/xsavescr.prg + + doc for __XSaveScreen() + + doc for __XRestScreen() + * doc/funclist.txt + * BROWSE() marked as S (not yet ready, missing EDIT mode) + 1999-12-29 19:00 EDT David G. Holm * doc/gmake.txt diff --git a/harbour/doc/funclist.txt b/harbour/doc/funclist.txt index 7a09a4f53b..e2d94ea32c 100644 --- a/harbour/doc/funclist.txt +++ b/harbour/doc/funclist.txt @@ -1,4 +1,4 @@ -; +; ; $Id$ ; ; The Harbour Project @@ -55,7 +55,7 @@ BIN2L ;R; BIN2W ;R; BOF ;R; BREAK ;R; -BROWSE ;N; +BROWSE ;S; CDOW ;R; CHR ;R; CMONTH ;R; diff --git a/harbour/source/rtl/text.prg b/harbour/source/rtl/text.prg index 6ea7270a22..d7fe909e6c 100644 --- a/harbour/source/rtl/text.prg +++ b/harbour/source/rtl/text.prg @@ -33,6 +33,18 @@ * */ +/* + * The following parts are Copyright of the individual authors. + * www - http://www.harbour-project.org + * + * Copyright 1999 Chen Kedem + * __TextSave() documentation + * __TextRestore() documentation + * + * See doc/license.txt for licensing terms. + * + */ + #include "set.ch" STATIC s_cFile @@ -40,6 +52,37 @@ STATIC s_lOldPrinter STATIC s_lOldExtra STATIC s_cOldExtraFile +/* $DOC$ + * $FUNCNAME$ + * __TextSave() + * $CATEGORY$ + * Internal + * $ONELINER$ + * Redirect console output to printer or a file and save old settings + * $SYNTAX$ + * __TextSave( ) --> NIL + * $ARGUMENTS$ + * is either "PRINTER" (note the uppercase) in which console + * output is SET to PRINTER, or a name of a text file with a default + * ".txt" extension, that is used to redirect console output. + * $RETURNS$ + * __TextSave() always return NIL. + * $DESCRIPTION$ + * __TextSave() is used in the preprocessing of the TEXT TO command to + * redirect the console output while saving old settings that can be + * restored later by __TextRestore(). + * $EXAMPLES$ + * $TESTS$ + * $STATUS$ + * $COMPLIANCE$ + * __TextSave() is an Undocumented CA-Clipper function + * $PLATFORMS$ + * $FILES$ + * $SEEALSO$ + * SET(), SET ALTERNATE, SET PRINTER, TEXT, __TextRestore() + * $END$ + */ + PROCEDURE __TextSave( cFile ) s_cFile := cFile @@ -53,6 +96,35 @@ PROCEDURE __TextSave( cFile ) RETURN +/* $DOC$ + * $FUNCNAME$ + * __TextRestore() + * $CATEGORY$ + * Internal + * $ONELINER$ + * Restore console output settings as saved by __TextSave() + * $SYNTAX$ + * __TextRestore() --> NIL + * $ARGUMENTS$ + * none. + * $RETURNS$ + * __TextRestore() always return NIL. + * $DESCRIPTION$ + * __TextRestore() is used in the preprocessing of the TEXT TO command + * to restore console output settings that were previously saved by + * __TextSave(). + * $EXAMPLES$ + * $TESTS$ + * $STATUS$ + * $COMPLIANCE$ + * __TextRestore() is an Undocumented CA-Clipper function + * $PLATFORMS$ + * $FILES$ + * $SEEALSO$ + * SET(), SET ALTERNATE, SET PRINTER, TEXT, __TextSave() + * $END$ + */ + PROCEDURE __TextRestore() IF s_cFile == "PRINTER" @@ -63,4 +135,3 @@ PROCEDURE __TextRestore() ENDIF RETURN - diff --git a/harbour/source/rtl/xsavescr.prg b/harbour/source/rtl/xsavescr.prg index 81ab434980..1d15f63007 100644 --- a/harbour/source/rtl/xsavescr.prg +++ b/harbour/source/rtl/xsavescr.prg @@ -1,4 +1,4 @@ -/* +/* * $Id$ */ @@ -33,14 +33,123 @@ * */ +/* + * The following parts are Copyright of the individual authors. + * www - http://www.harbour-project.org + * + * Copyright 1999 Chen Kedem + * __XSaveScreen() documentation + * __XRestScreen() documentation + * + * See doc/license.txt for licensing terms. + * + */ + STATIC s_cScrn +/* $DOC$ + * $FUNCNAME$ + * __XSaveScreen() (SAVE SCREEN command) + * $CATEGORY$ + * Data input and output + * $ONELINER$ + * Save whole screen image and coordinate to an internal buffer + * $SYNTAX$ + * __XSaveScreen() --> NIL + * + * or + * + * SAVE SCREEN + * $ARGUMENTS$ + * none. + * $RETURNS$ + * __XSaveScreen() always return NIL. + * $DESCRIPTION$ + * __XSaveScreen() save the image of the whole screen into an internal + * buffer, it also save current cursor position. The information could + * later be restored by __XRestScreen(). Each call to __XSaveScreen() + * overwrite the internal buffer. + * + * SAVE SCREEN command is preprocessed into __XSaveScreen() function + * during compile time. Note that SAVE SCREEN TO is preprocessed into + * SAVESCREEN() function. + * + * __XSaveScreen() is a compatibility function, it is superseded by + * SAVESCREEN() which allow you to save part or all the screen into a + * variable. + * $EXAMPLES$ + * // save the screen, display list of files than restore the screen + * SAVE SCREEN + * DIR *.* + * WAIT + * RESTORE SCREEN + * $TESTS$ + * $STATUS$ + * $COMPLIANCE$ + * __XSaveScreen() works exactly like CA-Clipper's __XSaveScreen() + * $PLATFORMS$ + * __XSaveScreen() is part of the GT API, and supported only by some + * platforms. + * $FILES$ + * $SEEALSO$ + * RESTORE SCREEN, RESTSCREEN(), SAVESCREEN() + * $END$ + */ + PROCEDURE __XSAVESCREEN() s_cScrn := { Row(), Col(), SaveScreen() } RETURN +/* $DOC$ + * $FUNCNAME$ + * __XRestScreen() (RESTORE SCREEN command) + * $CATEGORY$ + * Data input and output + * $ONELINER$ + * Restore screen image and coordinate from an internal buffer + * $SYNTAX$ + * __XRestScreen() --> NIL + * + * or + * + * RESTORE SCREEN + * $ARGUMENTS$ + * none. + * $RETURNS$ + * __XRestScreen() always return NIL. + * $DESCRIPTION$ + * __XRestScreen() restore saved image of the whole screen from an + * internal buffer that was saved by __XSaveScreen(), it also restore + * cursor position. After a call to __XRestScreen() the internal buffer + * is cleared. + * + * RESTORE SCREEN command is preprocessed into __XRestScreen() function + * during compile time. Note that RESTORE SCREEN FROM is preprocessed + * into RESTSCREEN() function. + * + * __XRestScreen() is a compatibility function, it is superseded by + * RESTSCREEN() which allow you to restore the screen from a variable. + * $EXAMPLES$ + * // save the screen, display list of files than restore the screen + * SAVE SCREEN + * DIR *.* + * WAIT + * RESTORE SCREEN + * $TESTS$ + * $STATUS$ + * $COMPLIANCE$ + * __XRestScreen() works exactly like CA-Clipper's __XRestScreen() + * $PLATFORMS$ + * __XRestScreen() is part of the GT API, and supported only by some + * platforms. + * $FILES$ + * $SEEALSO$ + * RESTSCREEN(), SAVE SCREEN, SAVESCREEN() + * $END$ + */ + PROCEDURE __XRESTSCREEN() IF s_cScrn != NIL