diff --git a/harbour/ChangeLog b/harbour/ChangeLog index 5ebf5b23dd..0494c7a99e 100644 --- a/harbour/ChangeLog +++ b/harbour/ChangeLog @@ -8,6 +8,11 @@ 2002-12-01 23:12 UTC+0100 Foo Bar */ +2003-07-30 08:28 UTC+0300 Chen Kedem + * doc/en/set.txt + + Added _SET_EOF text from the changelog entry written by + David G. Holm and mark it Harbour extension. + 2003-07-28 22:00 UTC-0400 David G. Holm * include/hbset.h * include/set.ch diff --git a/harbour/doc/en/set.txt b/harbour/doc/en/set.txt index fce668693b..18fd5927af 100644 --- a/harbour/doc/en/set.txt +++ b/harbour/doc/en/set.txt @@ -40,9 +40,9 @@ * $SYNTAX$ * __SETCENTURY([ | ] ) --> lPreviousValue * $ARGUMENTS$ - * optional or (not case sensitive) - * .T. or "ON" to enable the century setting (4-digit years) - * .F. or "OFF" to disable the century setting (2-digit years) + * optional or (not case sensitive) + * .T. or "ON" to enable the century setting (4-digit years) + * .F. or "OFF" to disable the century setting (2-digit years) * $RETURNS$ * Either the current or previous century setting as a logical value * $FILES$ @@ -60,13 +60,13 @@ * $SYNTAX$ * Set( [, [, ] ] ) --> xPreviousSetting * $ARGUMENTS$ - * Set Number + * Set Number * - * Any expression to assing a value to the seting + * Any expression to assing a value to the seting * - * Logical expression + * Logical expression * - * + * * * _SET_ALTERNATE | * @@ -161,7 +161,7 @@ * When set to .t., pressing Alt+D activates the debugger. * When set to .f., which is the default, Alt+D can be read * by INKEY(). (Also affected by AltD(1) and AltD(0)) - + * * _SET_DECIMALS * * Sets the number of decimal digits to use when displaying @@ -200,6 +200,15 @@ * file set by _SET_PRINTFILE. When set to anything else, * all output is sent to the screen. Defaults to "SCREEN". * + * _SET_EOF | + * + * Defaults to FALSE on UN*X, but defaults to TRUE on + * everything else. If set to FALSE, then CHR(26) does not + * get written when using COPY TO DELIMITED, COPY TO SDF, + * or when closing any of the various text files that are + * created using various SET values. + * [This is a Harbour extension] + * * _SET_EPOCH * * Determines how to handle the conversion of 2-digit years @@ -214,8 +223,8 @@ * and 2-digit years in the range 00 to 49 get converted * to 20xx. * - * _SET_ESCAPE | * - + * _SET_ESCAPE | + * * When enabled, which is the default, pressing Esc will * exit a READ. When disabled, pressing Esc during a READ * is ignored, unless the Esc key has been assigned to a @@ -264,7 +273,7 @@ * * _SET_EXTRA | * - * QUESTION: What is this for? + * QUESTION: What is this for? * It does not affect _SET_EXTRAFILE in Clipper! * * _SET_EXTRAFILE @@ -305,6 +314,7 @@ * _SET_LANGUAGE * * Specifies the language to be used for Harbour messages. + * [This is a Harbour extension] * * _SET_MARGIN * @@ -407,7 +417,7 @@ * When enabled, lightbar menus can be navigated from the * last position to the first and from the first position * to the last. When disabled, which is the default, there - * is a hard stop at the first and last positions. + * is a hard stop at the first and last positions. * $RETURNS$ * SET() The current or previous setting * $FILES$ @@ -426,29 +436,29 @@ * __SetFunction( , [] ) --> NIL * $ARGUMENTS$ * is a number in the range 1..40 that represent the - * function key to be assigned. + * function key to be assigned. * * is a character string to set. If is not * specified, the function key is going to be set to NIL releasing by - * that any previous __SetFunction() or SETKEY() for that function. + * that any previous __SetFunction() or SETKEY() for that function. * $RETURNS$ - * __SetFunction() always return NIL. + * __SetFunction() always return NIL. * $DESCRIPTION$ * __SetFunction() assign a character string with a function key, when * this function key is pressed, the keyboard is stuffed with this * character string. __SetFunction() has the effect of clearing any - * SETKEY() previously set to the same function number and vice versa. + * SETKEY() previously set to the same function number and vice versa. * - * - * nFunctionKey Key to be set + *
+ * nFunctionKey Key to be set * - * 1 .. 12 F1 .. F12 - * 13 .. 20 Shift-F3 .. Shift-F10 - * 21 .. 30 Ctrl-F1 .. Ctrl-F10 - * 31 .. 40 Alt-F1 .. Alt-F10 + * 1 .. 12 F1 .. F12 + * 13 .. 20 Shift-F3 .. Shift-F10 + * 21 .. 30 Ctrl-F1 .. Ctrl-F10 + * 31 .. 40 Alt-F1 .. Alt-F10 *
* SET FUNCTION command is preprocessed into __SetFunction() function - * during compile time. + * during compile time. * $EXAMPLES$ * // Set F1 with a string * CLS @@ -462,9 +472,9 @@ * R * $COMPLIANCE$ * Harbour use 11 and 12 to represent F11 and F12, while CA-Clipper use - * 11 and 12 to represent Shift-F1 and Shift-F2. + * 11 and 12 to represent Shift-F1 and Shift-F2. * $PLATFORMS$ - * All + * All * $FILES$ * Library is rtl * $SEEALSO$ @@ -483,27 +493,27 @@ * SET FUNCTION TO [] * $ARGUMENTS$ * is a number in the range 1..40 that represent the - * function key to be assigned. + * function key to be assigned. * * is a character string to set. If is not * specified, the function key is going to be set to NIL releasing by - * that any previous Set Function or SETKEY() for that function. + * that any previous Set Function or SETKEY() for that function. * $DESCRIPTION$ * Set Function assign a character string with a function key, when * this function key is pressed, the keyboard is stuffed with this * character string. Set Function has the effect of clearing any - * SETKEY() previously set to the same function number and vice versa. + * SETKEY() previously set to the same function number and vice versa. * * - * nFunctionKey Key to be set + * nFunctionKey Key to be set * - * 1 .. 12 F1 .. F12 - * 13 .. 20 Shift-F3 .. Shift-F10 - * 21 .. 30 Ctrl-F1 .. Ctrl-F10 - * 31 .. 40 Alt-F1 .. Alt-F10 + * 1 .. 12 F1 .. F12 + * 13 .. 20 Shift-F3 .. Shift-F10 + * 21 .. 30 Ctrl-F1 .. Ctrl-F10 + * 31 .. 40 Alt-F1 .. Alt-F10 *
* SET FUNCTION command is preprocessed into __SetFunction() function - * during compile time. + * during compile time. * $EXAMPLES$ * // Set F1 with a string * CLS @@ -517,9 +527,9 @@ * R * $COMPLIANCE$ * Harbour use 11 and 12 to represent F11 and F12, while CA-Clipper use - * 11 and 12 to represent Shift-F1 and Shift-F2. + * 11 and 12 to represent Shift-F1 and Shift-F2. * $PLATFORMS$ - * All + * All * $SEEALSO$ * INKEY(),SETKEY(),__Keyboard() * $END$ @@ -535,20 +545,20 @@ * $SYNTAX$ * SETKEY( [, [, ] ] ) * $ARGUMENTS$ - * is either a numeric key value, or an array of such values + * is either a numeric key value, or an array of such values - * is an optional code-block to be assigned + * is an optional code-block to be assigned - * is an optional condition code-block + * is an optional condition code-block * $RETURNS$ - * Current assigned action-block + * Current assigned action-block * $DESCRIPTION$ * The SetKey() function returns the current code-block assigned to a * key when called with only the key value. If the action block (and * optionally the condition block) are passed, the current block is * returned, and the new code block and condition block are stored. * A group of keys may be assigned the same code block/condition block - * by using an array of key values in place on the first parameter. + * by using an array of key values in place on the first parameter. * $EXAMPLES$ * local bOldF10 := setKey( K_F10, {|| Yahoo() } ) * ... // some other processing @@ -571,7 +581,7 @@ * SETKEY() is mostly CA-Clipper compliant. The only difference is the * addition of the condition code-block parameter, allowing set-keys to * be conditionally turned off or on. This condition-block cannot be - * returned once set - see SetKeyGet() + * returned once set - see SetKeyGet() * $FILES$ * Library is rtl * $SEEALSO$ @@ -589,15 +599,15 @@ * $SYNTAX$ * HB_SETKEYGET( [, ] ) * $ARGUMENTS$ - * is an numeric key value + * is an numeric key value - * is an optional return-parameter + * is an optional return-parameter * $RETURNS$ - * Current assigned action-block + * Current assigned action-block * $DESCRIPTION$ * The HB_SetKeyGet() function returns the current code-block assigned to * a key, and optionally assignes the condition-block to the - * return-parameter + * return-parameter * $EXAMPLES$ * local bOldF10, bOldF10Cond * bOldF10 := HB_SetKeyGet( K_F10, @bOldF10Cond ) @@ -610,7 +620,7 @@ * $STATUS$ * R * $COMPLIANCE$ - * HB_SETKEYGET() is a new function and hence not CA-Clipper compliant. + * HB_SETKEYGET() is a new function and hence not CA-Clipper compliant. * $FILES$ * Library is rtl * $SEEALSO$ @@ -629,16 +639,16 @@ * HB_SETKEYSAVE( [ ] ) * $ARGUMENTS$ * is an optional set-key list from a previous call to - * HB_SetKeySave(), or NIL to clear current set-key list + * HB_SetKeySave(), or NIL to clear current set-key list * $RETURNS$ - * Current set-key list + * Current set-key list * $DESCRIPTION$ * HB_SetKeySave() is designed to act like the set() function which * returns the current state of an environment setting, and optionally * assigning a new value. In this case, the "environment setting" is the * internal set-key list, and the optional new value is either a value * returned from a previous call to SetKeySave() - to restore that list, - * or the value of NIL to clear the current list. + * or the value of NIL to clear the current list. * $EXAMPLES$ * local aKeys := HB_SetKeySave( NIL ) // removes all current set=keys * ... // some other processing @@ -650,7 +660,7 @@ * $STATUS$ * R * $COMPLIANCE$ - * HB_SETKEYSAVE() is new. + * HB_SETKEYSAVE() is new. * $FILES$ * Library is rtl * $SEEALSO$ @@ -668,22 +678,22 @@ * $SYNTAX$ * HB_SetKeyCheck( [, ][, ][, ] ) * $ARGUMENTS$ - * is a numeric key value to be tested code-block, if executed + * is a numeric key value to be tested code-block, if executed - * .. are optional parameters that will be passed to the code-block + * .. are optional parameters that will be passed to the code-block * $RETURNS$ * True if there is a hot-key associated with and it was executed; - * otherwise False - * If there is a hot-key association (before checking any condition): - * - if there is a condition-block, it is passed one parameter - + * otherwise False + * If there is a hot-key association (before checking any condition): + * - if there is a condition-block, it is passed one parameter - * - when the hot-key code-block is called, it is passed 1 to 4 parameters, * depending on the parameters passed to HB_SetKeyCheck(). Any * parameters so passed are directly passed to the code-block, with an - * additional parameter being + * additional parameter being * $DESCRIPTION$ * HB_SetKeyCheck() is intended as a common interface to the SetKey() * functionality for such functions as ACHOICE(), DBEDIT(), MEMOEDIT(), - * ACCEPT, INPUT, READ, and WAIT + * ACCEPT, INPUT, READ, and WAIT * $EXAMPLES$ * // within ReadModal() * if HB_SetKeyCheck( K_ALT_X, GetActive() ) @@ -701,7 +711,7 @@ * $STATUS$ * R * $COMPLIANCE$ - * HB_SETKEYCHECK() is new. + * HB_SETKEYCHECK() is new. * $FILES$ * Library is rtl * $SEEALSO$ @@ -719,11 +729,11 @@ * $SYNTAX$ * SET KEY to p] [when ] ) * $ARGUMENTS$ - * is either a numeric key value, or an array of such values + * is either a numeric key value, or an array of such values - * is an optional code-block to be assigned + * is an optional code-block to be assigned - * is an optional condition code-block + * is an optional condition code-block * $DESCRIPTION$ * The Set Key Command function is translated to the SetKey() function * witch returns the current code-block assigned to a @@ -731,7 +741,7 @@ * optionally the condition block) are passed, the current block is * returned, and the new code block and condition block are stored. * A group of keys may be assigned the same code block/condition block - * by using an array of key values in place on the first parameter. + * by using an array of key values in place on the first parameter. * $EXAMPLES$ * local bOldF10 := setKey( K_F10, {|| Yahoo() } ) * ... // some other processing @@ -754,7 +764,7 @@ * SET KEY is mostly CA-Clipper compliant. The only difference is the * addition of the condition code-block parameter, allowing set-keys to * be conditionally turned off or on. This condition-block cannot be - * returned once set - see SetKeyGet() + * returned once set - see SetKeyGet() * $SEEALSO$ * HB_SETKEYSAVE() * $END$ @@ -770,12 +780,12 @@ * $SYNTAX$ * SETTYPEAHEAD( ) --> * $ARGUMENTS$ - * is a valid typeahead size. + * is a valid typeahead size. * $RETURNS$ - * The previous state of _SET_TYPEAHEAD + * The previous state of _SET_TYPEAHEAD * $DESCRIPTION$ * This function sets the typeahead buffer to a valid given size as is - * Set( _SET_TYPEAHEAD ) where used. + * Set( _SET_TYPEAHEAD ) where used. * $EXAMPLES$ * // Sets typeahead to 12 * SetTypeahead( 12 ) @@ -783,7 +793,7 @@ * $STATUS$ * R * $COMPLIANCE$ - * SETTYPEAHEAD() is fully CA-Clipper compliant. + * SETTYPEAHEAD() is fully CA-Clipper compliant. * $FILES$ * Library is rtl * $SEEALSO$ @@ -801,15 +811,15 @@ * $SYNTAX$ * __XHELP() --> * $ARGUMENTS$ - * None + * None * $RETURNS$ - * This function returns aleatory values. + * This function returns aleatory values. * $DESCRIPTION$ * This is an internal undocumented Clipper function, which will * try to call the user defined function HELP() if it's defined * in the current application. This is the default SetKey() handler - * for the F1 key. - * $STATUS$ + * for the F1 key. + * $STATUS$ * R * $COMPLIANCE$ * __XHELP() is fully CA-Clipper compliant. @@ -828,19 +838,19 @@ * $SYNTAX$ * SET DEFAULT TO [] * $ARGUMENTS$ - * Drive and/or path. + * Drive and/or path. * $DESCRIPTION$ * This command changes the drive and directory used for reading and * writting database,index,memory, and alternate files.Specifying no * parameters with this command will default the operation to the - * current logged drive and directory. + * current logged drive and directory. * $EXAMPLES$ * SET DEFAULT to c:\TEMP * * $STATUS$ * R * $COMPLIANCE$ - * This command is Ca-Clipper Compliant. + * This command is Ca-Clipper Compliant. * $SEEALSO$ * SET PATH,CURDIR(),SET() * $END$ @@ -856,19 +866,19 @@ * $SYNTAX$ * SET WRAP on | OFF | ( * $ARGUMENTS$ - * Logical expression for toggle + * Logical expression for toggle * $DESCRIPTION$ * This command toggles the highlighted bars in a @...PROMPT command * to wrap around in a bottom-to-top and top-to-bottom manner.If the * value of the logical expression is a logical false (.F.), - * the wrapping mode is set OFF;otherwise,it is set ON. + * the wrapping mode is set OFF;otherwise,it is set ON. * $EXAMPLES$ * See Tests/menutest.prg * * $STATUS$ - * R + * R * $COMPLIANCE$ - * This command is Ca-Clipper Compliant. + * This command is Ca-Clipper Compliant. * $SEEALSO$ * @...PROMPT,MENU TO * $END$ @@ -882,14 +892,14 @@ * $ONELINER$ * Extablishes a message row for @...PROMPT command * $SYNTAX$ - * SET MESSAGE TO [ [CENTER]] + * SET MESSAGE TO [ [CENTER]] * $ARGUMENTS$ - * Row number to display the message + * Row number to display the message * $DESCRIPTION$ * This command is designed to work in conjuntion with the MENU TO and * @...PROMPT commands.With this command, a row number between 0 and * MAXROW() may be specified in .This establishes the row on - * witch any message associated with an @...PROMPT command will apear. + * witch any message associated with an @...PROMPT command will apear. * If the value of is 0,all messages will be supressed. * All messaged will be left-justifies unless the CENTER clause is @@ -897,18 +907,18 @@ * will be centered at the designated row (unless is 0).All * messages are independent;therefor,the screen area is cleared out * by the centered message will vary based on the length of each - * individual message. + * individual message. * Specifying no parameters with this command set the row value to 0, - * witch suppresses all messages output. - * The British spelling of CENTRE is also supported. + * witch suppresses all messages output. + * The British spelling of CENTRE is also supported. * $EXAMPLES$ * See Tests/menutest.prg * * $STATUS$ - * R + * R * $COMPLIANCE$ - * This command is Ca-Clipper Compliant. + * This command is Ca-Clipper Compliant. * $SEEALSO$ * SET(),SET WRAP,@...PROMPT,MENU TO * $END$ @@ -922,23 +932,23 @@ * $ONELINER$ * Specifies a search path for opening files * $SYNTAX$ - * SET PATH TO [] + * SET PATH TO [] * $ARGUMENTS$ - * Search path for files + * Search path for files * $DESCRIPTION$ * This command specifies the search path for files required by most * commands and functions not found in the current drive and directory. * This pertains primarily,but not exclusively, to databases,indexes, * and memo files,as well as to memory,labels,and reports files. The * search hirarchy is: 1 Current drive and directory,2 The SET DEFAULT - * path;3 The SET PATH path. + * path;3 The SET PATH path. * $EXAMPLES$ * SET PATH TO c:\Harbour\Test - * + * * $STATUS$ - * R + * R * $COMPLIANCE$ - * This command is Ca-Clipper Compliant. + * This command is Ca-Clipper Compliant. * $SEEALSO$ * SET DEFAULT,CURDIR(),SET() * $END$ @@ -952,7 +962,7 @@ * $ONELINER$ * Toggles the enhaced display of PROMPT's and GETs. * $SYNTAX$ - * SET INTENSITY ON | off | () + * SET INTENSITY ON | off | () * $ARGUMENTS$ * Logical expression for toggle command * $DESCRIPTION$ @@ -962,9 +972,9 @@ * $EXAMPLES$ * SET INTENSITY ON * $STATUS$ - * R + * R * $COMPLIANCE$ - * This command is Ca-Clipper Compliant. + * This command is Ca-Clipper Compliant. * $SEEALSO$ * @...GET,@...PROMPT,@...SAY,SET() * $END$ @@ -983,7 +993,7 @@ * $ARGUMENTS$ * Name of alternate file. * - * Logical expression for toggle + * Logical expression for toggle * $DESCRIPTION$ * This command toggles and output console information to the alternate * file ,provided that the command is toggled on or the condition @@ -1008,9 +1018,9 @@ * SET ALTERNATE TO * SET ALTERNATE OFF * $STATUS$ - * R + * R * $COMPLIANCE$ - * This command is Ca-Clipper Compliant. + * This command is Ca-Clipper Compliant. * $SEEALSO$ * CLOSE,SET PRINTER,SET CONSOLE,SET() * $END$ @@ -1024,9 +1034,9 @@ * $ONELINER$ * Toggle the century digits in all dates display * $SYNTAX$ - * SET CENTURY on | OFF | () + * SET CENTURY on | OFF | () * $ARGUMENTS$ - * Logical expression for toggle + * Logical expression for toggle * $DESCRIPTION$ * This command allows the input and display of dates with the century * prefix.It will be in the standart MM/DD/YYYY format unless specified @@ -1055,8 +1065,8 @@ * Assings a date format or chooses a predefined date data set. * $SYNTAX$ * SET DATE FORMAT [TO] - * SET DATE [TO] [ ANSI / BRITISH / FRENCH / GERMAN / ITALIAN / JAPAN - * / USA / AMERICAN] + * SET DATE [TO] [ ANSI / BRITISH / FRENCH / GERMAN / ITALIAN / JAPAN + * / USA / AMERICAN] * $ARGUMENTS$ * Keyword for date format * $DESCRIPTION$ @@ -1066,7 +1076,7 @@ * is an AMERICAN date format;specifying no parameters will set the * date format to AMERICAN.Below is a table of the varius predefined * dates formats. - * + * * * Syntax Date Format * ANSI yy.mm.dd @@ -1129,7 +1139,7 @@ * $SYNTAX$ * SET FIXED on | OFF | () * $ARGUMENTS$ - * Logical expression for toggle + * Logical expression for toggle * $DESCRIPTION$ * This command activates a system wide fixed placement of decimals * places shown for all numeric outputs.If the value of is @@ -1140,8 +1150,8 @@ * of decimal placed displayed. * *
- * Addition Same as operand with the greatest number of decimal digits - * Subraction Same as operand with the greatest number of decimal digits + * Addition Same as operand with the greatest number of decimal digits + * Subraction Same as operand with the greatest number of decimal digits * Multiplication Sum of operand decimal digits * Division Determined by SET DECIMAL TO * Exponential Determined by SET DECIMAL TO