From 493e8ae1e898c666d1813d9bb2b5b28dd8786cd5 Mon Sep 17 00:00:00 2001 From: Chen Kedem Date: Thu, 13 Apr 2000 14:41:21 +0000 Subject: [PATCH] 20000413-16:40 GMT+2 Chen Kedem --- harbour/ChangeLog | 13 ++ harbour/doc/en/dbstrux.txt | 60 +++++----- harbour/doc/en/terminal.txt | 228 ++++++++++++++++++------------------ 3 files changed, 161 insertions(+), 140 deletions(-) diff --git a/harbour/ChangeLog b/harbour/ChangeLog index aa06c85593..1cd8eb3a33 100644 --- a/harbour/ChangeLog +++ b/harbour/ChangeLog @@ -1,3 +1,16 @@ +20000413-16:40 GMT+2 Chen Kedem + * doc/en/dbstrux.txt + * in __FLTEDIT() HARBOUR_STRICT_CLIPPER_COMPATIBILITY was changed into + HB_C52_UNDOC as used by the source + * insert explicit marks to make Commands $ARGUMENTS$ bold + + * doc/en/terminal.txt + * in ALERT() HARBOUR_STRICT_CLIPPER_COMPATIBILITY was changed into + HB_C52_STRICT as used by the source + * in ALERT() and __NONOALERT() the $COMPLIANCE$ section was extended + + $PLATFORMS$ section for HB_OSNEWLINE() + * a bit re-formating + 20000413-12:32 GMT+1 Victor Szakats * source/compiler/genc.c diff --git a/harbour/doc/en/dbstrux.txt b/harbour/doc/en/dbstrux.txt index 51434caf64..7db7621125 100644 --- a/harbour/doc/en/dbstrux.txt +++ b/harbour/doc/en/dbstrux.txt @@ -61,7 +61,7 @@ * $PLATFORMS$ * All * $FILES$ - * Library is Rdd.lib + * Library is rdd.lib * $SEEALSO$ * COPY STRUCTURE,COPY STRUCTURE EXTENDED,DBCREATE(),DBSTRUCT(),__dbCopyXStruct(),__dbCreate(),__dbStructFilter() * $END$ @@ -77,14 +77,14 @@ * $SYNTAX$ * COPY STRUCTURE TO [FIELDS ] * $ARGUMENTS$ - * TO is the name of the new database file to create. - * (.dbf) is the default extension if none is given. It can be + * TO is the name of the new database file to + * create. (.dbf) is the default extension if none is given. It can be * specified as literal file name or as a character expression * enclosed in parentheses. * - * FIELDS is an optional list of field names to copy from - * the currently open database in the specified order, the default is - * all fields. Names could be specified as uppercase or lowercase. + * FIELDS is an optional list of field names to copy + * from the currently open database in the specified order, the default + * is all fields. Names could be specified as uppercase or lowercase. * $DESCRIPTION$ * COPY STRUCTURE create a new empty database file with a structure * that is based on the currently open database in this work-area. @@ -183,7 +183,7 @@ * $PLATFORMS$ * All * $FILES$ - * Library is Rdd.lib + * Library is rdd.lib * $SEEALSO$ * COPY STRUCTURE,COPY STRUCTURE EXTENDED,CREATE,CREATE FROM,DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__dbCreate() * $END$ @@ -199,8 +199,8 @@ * $SYNTAX$ * COPY STRUCTURE EXTENDED TO * $ARGUMENTS$ - * TO is the name of target definition file to create. - * (.dbf) is the default extension if none is given. It can be + * TO is the name of target definition file to + * create. (.dbf) is the default extension if none is given. It can be * specified as literal file name or as a character expression * enclosed in parentheses. * $DESCRIPTION$ @@ -364,7 +364,7 @@ * $PLATFORMS$ * All * $FILES$ - * Library is Rdd.lib + * Library is rdd.lib * $SEEALSO$ * COPY STRUCTURE,COPY STRUCTURE EXTENDED,CREATE,CREATE FROM,DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__dbCopyXStruct() * $END$ @@ -385,12 +385,13 @@ * literal file name or as a character expression enclosed in * parentheses. * - * VIA is RDD name to create target with. If omitted, the - * default RDD is used. It can be specified as literal name or as a + * VIA is RDD name to create target with. If omitted, + * the default RDD is used. It can be specified as literal name or as a * character expression enclosed in parentheses. * - * ALIAS is an optional alias to USE the target file with. If - * not specified, alias is based on the root name of . + * ALIAS is an optional alias to USE the target file + * with. If not specified, alias is based on the root name of + * . * $DESCRIPTION$ * CREATE a new empty structure extended file with the name * and then open it in the current work-area. The new file has the @@ -456,21 +457,22 @@ * literal file name or as a character expression enclosed in * parentheses. * - * FROM is a structure extended file name from which the - * target file is going to be built. It can be specified - * as literal file name or as a character expression enclosed in - * parentheses. + * FROM is a structure extended file name from + * which the target file is going to be built. It can be + * specified as literal file name or as a character expression enclosed + * in parentheses. * - * VIA is RDD name to create target with. If omitted, the - * default RDD is used. It can be specified as literal name or as a + * VIA is RDD name to create target with. If omitted, + * the default RDD is used. It can be specified as literal name or as a * character expression enclosed in parentheses. * - * NEW open the target file name in the next available - * unused work-area and making it the current work-area. If omitted - * open the target file in current work-area. + * NEW open the target file name in the next + * available unused work-area and making it the current work-area. If + * omitted open the target file in current work-area. * - * ALIAS is an optional alias to USE the target file with. If - * not specified, alias is based on the root name of . + * ALIAS is an optional alias to USE the target file + * with. If not specified, alias is based on the root name of + * . * $DESCRIPTION$ * CREATE FROM open a structure extended file where each * record contain at least the following fields (in no particular @@ -583,12 +585,12 @@ * function to use. * * This function is only visible if source/rdd/dbstrux.prg was compiled - * with the HARBOUR_STRICT_CLIPPER_COMPATIBILITY flag. + * with the HB_C52_UNDOC flag. * $PLATFORMS$ - * All + * All * $FILES$ * Header file is dbstruct.ch - * Library is Rdd.lib + * Library is rdd.lib * $SEEALSO$ * DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__dbStructFilter() * $END$ @@ -670,7 +672,7 @@ * All * $FILES$ * Header file is dbstruct.ch - * Library is Rdd.lib + * Library is rdd.lib * $SEEALSO$ * DBCREATE(),DBSTRUCT(),__dbCopyStruct(),__FLEDIT()* * $END$ diff --git a/harbour/doc/en/terminal.txt b/harbour/doc/en/terminal.txt index ae84732363..917aa6a41b 100644 --- a/harbour/doc/en/terminal.txt +++ b/harbour/doc/en/terminal.txt @@ -34,22 +34,22 @@ * $SYNTAX$ * __XSaveScreen() --> NIL * $ARGUMENTS$ - * none. + * none. * $RETURNS$ - * __XSaveScreen() always return NIL. + * __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. + * 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. + * 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. + * variable. * $EXAMPLES$ * // save the screen, display list of files than restore the screen * SAVE SCREEN @@ -60,12 +60,12 @@ * $STATUS$ * R * $COMPLIANCE$ - * __XSaveScreen() works exactly like CA-Clipper's __XSaveScreen() + * __XSaveScreen() works exactly like CA-Clipper's __XSaveScreen() * $PLATFORMS$ * __XSaveScreen() is part of the GT API, and supported only by some - * platforms. + * platforms. * $FILES$ - * Library is Rtl.lib + * Library is rtl.lib * $SEEALSO$ * RESTORE SCREEN,RESTSCREEN(),SAVESCREEN() * $END$ @@ -81,33 +81,31 @@ * $SYNTAX$ * SAVE SCREEN * $ARGUMENTS$ - * none. + * none. * $RETURNS$ - * SAVE SCREEN always return NIL. + * SAVE SCREEN always return NIL. * $DESCRIPTION$ * SAVE SCREEN save the image of the whole screen into an internal * buffer, it also save current cursor position. The information could * later be restored by REST SCREEN. Each call to SAVE SCREEN - * overwrite the internal buffer. + * 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. - * + * SAVESCREEN() function. * $EXAMPLES$ * // save the screen, display list of files than restore the screen * SAVE SCREEN * DIR *.* * WAIT * RESTORE SCREEN - * * $STATUS$ * R * $COMPLIANCE$ - * __XSaveScreen() works exactly like CA-Clipper's __XSaveScreen() + * __XSaveScreen() works exactly like CA-Clipper's __XSaveScreen() * $PLATFORMS$ * __XSaveScreen() is part of the GT API, and supported only by some - * platforms. + * platforms. * $SEEALSO$ * RESTORE SCREEN,__XRESTSCREEN(),__XSAVESCREEN() * $END$ @@ -125,35 +123,34 @@ * $ARGUMENTS$ * none. * $RETURNS$ - * __XRestScreen() always return NIL. + * __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. + * is cleared. * * RESTORE SCREEN command is preprocessed into __XRestScreen() function * during compile time. Note that RESTORE SCREEN FROM is preprocessed - * into RESTSCREEN() function. + * into RESTSCREEN() function. * * __XRestScreen() is a compatibility function, it is superseded by - * RESTSCREEN() which allow you to restore the screen from a variable. + * 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 - * * $STATUS$ * R * $COMPLIANCE$ - * __XRestScreen() works exactly like CA-Clipper's __XRestScreen() + * __XRestScreen() works exactly like CA-Clipper's __XRestScreen() * $PLATFORMS$ * __XRestScreen() is part of the GT API, and supported only by some - * platforms. + * platforms. * $FILES$ - * Library is Rtl.lib + * Library is rtl.lib * $SEEALSO$ * __XRESTSCREEN(),SAVE SCREEN,__XSAVESCREEN() * $END$ @@ -169,33 +166,31 @@ * $SYNTAX$ * RESTORE SCREEN * $ARGUMENTS$ - * none. + * none. * $RETURNS$ - * REST SCREEN always return NIL. + * REST SCREEN always return NIL. * $DESCRIPTION$ * Rest Screen restore saved image of the whole screen from an * internal buffer that was saved by Save Screen, it also restore * cursor position. After a call to Rest Screen the internal buffer - * is cleared. + * is cleared. * * RESTORE SCREEN command is preprocessed into __XRestScreen() function * during compile time. Note that RESTORE SCREEN FROM is preprocessed - * into RESTSCREEN() function. - * + * into RESTSCREEN() function. * $EXAMPLES$ * // save the screen, display list of files than restore the screen * SAVE SCREEN * DIR *.* * WAIT * RESTORE SCREEN - * * $STATUS$ * R * $COMPLIANCE$ - * Rest Screen() works exactly like CA-Clipper's Rest Screen + * Rest Screen() works exactly like CA-Clipper's Rest Screen * $PLATFORMS$ * Rest Screen is part of the GT API, and supported only by some - * platforms. + * platforms. * $SEEALSO$ * __XRESTSCREEN(),SAVE SCREEN,__XSAVESCREEN() * $END$ @@ -212,40 +207,39 @@ * ALERT( , [], [], [] ) --> nChoice or NIL * $ARGUMENTS$ * Message to display in the dialog box. can be - * of any Harbour type. + * of any Harbour type. * If is an array of Character strings, each element would * be displayed in a new line. If is a Character * string, you could split the message to several lines by placing - * a semicolon (;) in the desired places. + * a semicolon (;) in the desired places. * * Array with available response. Each element should be - * Character string. If omitted, default is { "Ok" }. + * Character string. If omitted, default is { "Ok" }. * * Color string to paint the dialog box with. - * If omitted, default color is "W+/R". + * If omitted, default color is "W+/R". * * Number of seconds to wait to user response before abort. - * Default value is 0, that wait forever. + * Default value is 0, that wait forever. * $RETURNS$ * ALERT() return Numeric value representing option number chosen. * If ESC was pressed, return value is zero. The return value is NIL * if ALERT() is called with no parameters, or if type is - * not Character and HARBOUR_STRICT_CLIPPER_COMPATIBILITY option was - * used. If seconds had passed without user response, the - * return value is 1. + * not Character and HB_C52_STRICT option was used. If seconds + * had passed without user response, the return value is 1. * $DESCRIPTION$ * ALERT() display simple dialog box on screen and let the user select * one option. The user can move the highlight bar using arrow keys or * TAB key. To select an option the user can press ENTER, SPACE or the - * first letter of the option. + * first letter of the option. * * If the program is executed with the //NOALERT command line switch, * nothing is displayed and it simply returns NIL. This switch could - * be overridden with __NONOALERT(). + * be overridden with __NONOALERT(). * * If the GT system is linked in, ALERT() display the message using * the full screen I/O system, if not, the information is printed to - * the standard output using OUTSTD(). + * the standard output using OUTSTD(). * $EXAMPLES$ * LOCAL cMessage, aOptions, nChoice * @@ -269,28 +263,36 @@ * CASE nChoice == 3 * ? "Oops mode is not working in this version" * ENDCASE - * * $STATUS$ * R * $COMPLIANCE$ - * This function is sensitive to HARBOUR_STRICT_CLIPPER_COMPATIBILITY - * settings. + * This function is sensitive to HB_C52_STRICT settings during the + * compilation of source/rtl/alert.prg * - * ON: accept Character values only and return NIL if other - * types are passed, - * OFF: could be any type, and internally converted to - * Character string. If type is Array, multi-line message is - * displayed. + * defined: accept Character values only and return + * NIL if other types are passed. * - * ON: Only the first four valid are taken. - * OFF: could contain as many as needed options. + * undefined: could be any type, and internally + * converted to Character string. If type is Array, multi-line message + * is displayed. + * + * defined: Only the first four valid are taken. + * + * undefined: could contain as many as needed options. + * + * If HB_COMPAT_C53 was define during compilation of + * source/rtl/alert.prg the Left-Mouse button could be used to select + * an option. + * + * The interpretation of the //NOALERT command line switch is done only + * if HB_C52_UNDOC was define during compilation of source/rtl/alert.prg * * is a Harbour extension, or at least un-documented - * in Clipper 5.2 NG. + * in Clipper 5.2 NG. * - * is a Harbour extension. + * is a Harbour extension. * $FILES$ - * Library is Rtl.lib + * Library is rtl.lib * $SEEALSO$ * @...PROMPT,MENU TO,STDOUT(),__NONOALERT() * $END$ @@ -306,23 +308,24 @@ * $SYNTAX$ * __NONOALERT() --> NIL * $ARGUMENTS$ - * This function takes no arguments. + * This function takes no arguments. * $RETURNS$ - * __NONOALERT() always return NIL. + * __NONOALERT() always return NIL. * $DESCRIPTION$ * The //NOALERT command line switch cause Clipper to ignore calls to * the ALERT() function, this function override this behavior - * and always display ALERT() dialog box. + * and always display ALERT() dialog box. * $EXAMPLES$ * // make sure alert are been displayed * __NONOALERT() - * * $STATUS$ * R * $FILES$ - * Library is Rtl.lib + * Library is rtl.lib * $COMPLIANCE$ - * __NONOALERT() is an undocumented CA-Clipper function + * __NONOALERT() is an undocumented CA-Clipper function and exist only + * if HB_C52_UNDOC was defined during the compilation of + * source/rtl/alert.prg * $END$ */ @@ -336,14 +339,14 @@ * $SYNTAX$ * HB_OSNewLine() --> cString * $RETURNS$ - * A character string containing the character or characters required - * to move the screen cursor or print head to the start of a new line. - * The string will hold either CHR( 10 ) or CHR( 13 ) + CHR( 10 ). + * A character string containing the character or characters + * required to move the screen cursor or print head to the start of a + * new line. The string will hold either CHR(10) or CHR(13) + CHR(10). * $DESCRIPTION$ * Returns a character string containing the character or characters * required to move the screen cursor or print head to the start of a * new line for the operating system that the program is running on - * (or thinks it is running on, if an OS emulator is being used). + * (or thinks it is running on, if an OS emulator is being used). * $EXAMPLES$ * // Get the newline character(s) for the current OS using defaults. * STATIC s_cNewLine @@ -352,17 +355,22 @@ * ... * OutStd( "Hello World!" + s_cNewLine ) * ... - * * $TESTS$ + * * valtype( HB_OSNewLine() ) == "C" * LEN( HB_OSNewLine() ) == 1 * * $STATUS$ * R * $COMPLIANCE$ - * This is an add-on Operating System Tool function. + * This is an add-on Operating System Tool function. + * $PLATFORMS$ + * Under OS_UNIX_COMPATIBLE operating system the return value is the + * Line-Feed (0x0a) character CHR(10), with other operating systems + * (like DOS) the return value is the Carriage-Return plus Line-Feed + * (0x0d 0x0a) characters CHR(13)+CHR(10). * $FILES$ - * Library is Rtl.lib + * Library is rtl.lib * $SEEALSO$ * OS(),OUTSTD(),OUTERR() * $END$ @@ -376,32 +384,30 @@ * $ONELINER$ * Extract one color from a full Clipper colorspec string. * $SYNTAX$ - * hb_ColorIndex( , ) + * hb_ColorIndex( , ) * $ARGUMENTS$ * is a Clipper color list * - * is the position of the color item to be extracted, the first - * position is the zero. + * is the position of the color item to be extracted, the + * first position is the zero. * $RETURNS$ - * The selected color string, or if anything goes wrong, and empty - * string + * The selected color string, or if anything goes wrong, an empty + * string. * $DESCRIPTION$ * Clipper has a color spec string, which has more than one * color in it, separated with commas. This function is able to extract * a given item from this list. You may use the manifest constants - * defined in color.ch to extract common Clipper colors. + * defined in color.ch to extract common Clipper colors. * $EXAMPLES$ * ? hb_ColorIndex( "W/N, N/W", CLR_ENHANCED ) // "N/W" - * * $TESTS$ - * see the regression test suit for comprehensive tests. - * + * see the regression test suit for comprehensive tests. * $STATUS$ * R * $COMPLIANCE$ - * Was not part of CA-Clipper. + * Was not part of CA-Clipper. * $FILES$ - * Library is Rtl.lib + * Library is rtl.lib * $SEEALSO$ * ColorSelect() * $END$ @@ -422,17 +428,17 @@ * is any picture transformation that TRANSFORM() can use. * * is an optional string that specifies a screen color to - * use in place of the default color when the output goes to the screen. + * use in place of the default color when the output goes to the screen. * $RETURNS$ - * NIL + * NIL * $DESCRIPTION$ * Outputs any expression using a picture transformation instead of - * using the default transformation for the type of expression. + * using the default transformation for the type of expression. * $EXAMPLES$ * // Output a negative dollar amount using debit notation. * DEVOUTPICT( -1.25, "@D$ 99,999.99 ) - * * $TESTS$ + * * @ 3,1 SAY -1.25 PICTURE "@D$ 99,999.99" * will display "$( 1.25)" starting on row four, column two of the * current device (without the double quotation marks, of course). @@ -441,9 +447,9 @@ * R * $COMPLIANCE$ * DEVOUTPICT() is mostly CA-Clipper compliant. Any differences are due - * to enhancements in the Harbour TRANSFORM() over CA-Clipper. + * to enhancements in the Harbour TRANSFORM() over CA-Clipper. * $FILES$ - * Library is Rtl.lib + * Library is rtl.lib * $SEEALSO$ * DEVOUT(),TRANSFORM() * $END$ @@ -459,18 +465,18 @@ * $SYNTAX$ * __INPUT( ) --> * $ARGUMENTS$ - * is any valid expression. + * is any valid expression. * $RETURNS$ - * Macroed + * Macroed * $DESCRIPTION$ * This function waits for a console input and returns macroed - * expression entered. + * expression entered. * $STATUS$ * S * $COMPLIANCE$ - * __INPUT() is fully CA-Clipper compliant. + * __INPUT() is fully CA-Clipper compliant. * $FILES$ - * Library is Rtl.lib + * Library is rtl.lib * $SEEALSO$ * __WAIT(),__ACCEPT() * $END$ @@ -488,21 +494,21 @@ * $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. + * ".txt" extension, that is used to redirect console output. * $RETURNS$ - * __TextSave() always return NIL. + * __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(). + * restored later by __TextRestore(). * $STATUS$ - * R + * R * $COMPLIANCE$ - * __TextSave() is an Undocumented CA-Clipper function + * __TextSave() is an Undocumented CA-Clipper function * $PLATFORMS$ - * ALL + * ALL * $FILES$ - * Library is Rtl.lib + * Library is rtl.lib * $SEEALSO$ * SET(),SET ALTERNATE,SET PRINTER,TEXT,__TextRestore() * $END$ @@ -518,21 +524,21 @@ * $SYNTAX$ * __TextRestore() --> NIL * $ARGUMENTS$ - * none. + * none. * $RETURNS$ - * __TextRestore() always return NIL. + * __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(). + * __TextSave(). * $STATUS$ * R * $COMPLIANCE$ - * __TextRestore() is an Undocumented CA-Clipper function + * __TextRestore() is an Undocumented CA-Clipper function * $PLATFORMS$ - * All + * All * $FILES$ - * Library is Rtl.lib + * Library is rtl.lib * $SEEALSO$ * SET(),SET ALTERNATE,SET PRINTER,TEXT,__TextSave() * $END$ @@ -548,27 +554,27 @@ * $SYNTAX$ * __WAIT( ) --> * $ARGUMENTS$ - * is a string. + * is a string. * $RETURNS$ - * Pressed key. + * Pressed key. * $DESCRIPTION$ * This function stops the application until a key is pressed. The key - * must be in the range 32..255. Control keys are not processed. + * must be in the range 32..255. Control keys are not processed. * $EXAMPLES$ * // Wait for a key stroke * __Wait( "Press a key to continue" ) - * $TESTS$ + * * do while cKey != "Q" * cKey := __Wait( "Press 'Q' to continue" ) * end do - + * * $STATUS$ * R * $COMPLIANCE$ - * __WAIT() is fully CA-Clipper compliant. + * __WAIT() is fully CA-Clipper compliant. * $FILES$ - * Library is Rtl.lib + * Library is rtl.lib * $SEEALSO$ * __ACCEPT(),__INPUT() * $END$