From e975d02e595113cf360c98c36ad0d33d4a4580d8 Mon Sep 17 00:00:00 2001 From: Luiz Rafael Culik Date: Thu, 1 Jun 2000 02:31:26 +0000 Subject: [PATCH] See changelog 20000531-23:20 GMT -3 --- harbour/doc/en/compiler.txt | 16 +- harbour/doc/en/lang.txt | 2 +- harbour/doc/en/set.txt | 34 +++- harbour/doc/en/setmode.txt | 32 +-- harbour/doc/en/string.txt | 379 +++++++++++++++++++++++++++++++++++- 5 files changed, 436 insertions(+), 27 deletions(-) diff --git a/harbour/doc/en/compiler.txt b/harbour/doc/en/compiler.txt index 2ab658e355..5d1a5c5a79 100644 --- a/harbour/doc/en/compiler.txt +++ b/harbour/doc/en/compiler.txt @@ -128,14 +128,14 @@ * /w0 - no warnings * /w or /w1 - Clipper compatible warnings * /w2 - some useful warnings missed in Clipper - * /w3 - warnings generated for Harbour language extensions and - * also Enables strong type checking but only warns against - * declared types, or types which may be calculated at compile - * time - * /w4 -Enables warning about suspicious operations, which means if you - * mix undeclared types, or types which can not be calculated at - * compile time,together with declared types, a warning will be - * generated. + * /w3 - warnings generated for Harbour language extensions + * and also enables strong type checking but only + * warns against declared types, or types which may be + * calculated at compile time + * /w4 - Enables warning about suspicious operations, which + * means if you mix undeclared types, or types which + * can not be calculated at compile time,together with + * declared types, a warning will be generated. * * /x[] set symbol init function name prefix (for .c only) * ----------------- diff --git a/harbour/doc/en/lang.txt b/harbour/doc/en/lang.txt index e58c869372..114517f386 100644 --- a/harbour/doc/en/lang.txt +++ b/harbour/doc/en/lang.txt @@ -103,7 +103,7 @@ * $DESCRIPTION$ * This function return the current name of the language module in use. * $EXAMPLES$ - * REQUEST HB_LANG_PT + * REQUEST HB_LANG_PT * REQUEST HB_LANG_RO * REQUEST HB_LANG_ES * FUNCTION MAIN() diff --git a/harbour/doc/en/set.txt b/harbour/doc/en/set.txt index d892ed4b2e..de06e97524 100644 --- a/harbour/doc/en/set.txt +++ b/harbour/doc/en/set.txt @@ -25,7 +25,7 @@ * Documentation for: SET PATH,SET INTENSITY,SET ALTERNATE * Documentation for: SET CENTURY,SET DATE,SET CONSOLE * Documentation for: SET EPOCH,SET PRINTER,SET FIXED - * + * Documentation for: SET BELL * See doc/license.txt for licensing terms. * */ @@ -1316,3 +1316,35 @@ * $END$ */ +/* $DOC$ + * $COMMANDNAME$ + * SET BELL + * $CATEGORY$ + * Command + * $ONELINER$ + * Toggle the bell to sound once a GET has been completed. + * $SYNTAX$ + * SET BELL on | OFF | () + * $ARGUMENTS$ + * Logical expression for toggle command + * $DESCRIPTION$ + * This command toggles the bell to sound whenever a character is + * entered into the last character positionof a GET,of if an invalid + * data type is entered into a GET. + * + * If is a logical true (.T.),the bell will be turned + * ON;otherwise, the belle will be turned off. + * $EXAMPLES$ + * SET BEEL ON + * cDummy:=space(20) + * ? 3,2 get cDummy + * Read + * SET bell off + * $STATUS$ + * R + * $COMPLIANCE$ + * This command is Ca-Clipper compliant + * $SEEALSO$ + * SET() + * $END$ + */ diff --git a/harbour/doc/en/setmode.txt b/harbour/doc/en/setmode.txt index c835d6d0f5..7b168b5983 100644 --- a/harbour/doc/en/setmode.txt +++ b/harbour/doc/en/setmode.txt @@ -21,11 +21,9 @@ * is the number of rows for the video mode to set. * * is the number of columns for the video mode to set. - * * $RETURNS$ * SETMODE() returns true if the video mode change was successful; * otherwise, it returns false. - * * $DESCRIPTION$ * SETMODE() is a function that change the video mode depend on the * video card and monitor combination, to match the number of rows and @@ -34,17 +32,23 @@ * that produce the video mode change. * The followings are availables for D.O.S: * - * - * 12 rows x 40 columns 12 rows x 80 columns - * 25 rows x 40 columns 25 rows x 80 columns - * 28 rows x 40 columns 28 rows x 80 columns - * 50 rows x 40 columns 43 rows x 80 columns - * Not avaliable 43 rows x 40 col 50 rows x 80 columns - *
+ * + * 12 rows x 40 columns 12 rows x 80 columns + * 25 rows x 40 columns 25 rows x 80 columns + * 28 rows x 40 columns 28 rows x 80 columns + * 50 rows x 40 columns 43 rows x 80 columns + * 50 rows x 80 columns + *
+ * The follow modes are avaliable to Windows + * + * + * 25 rows x 40 columns 25 rows x 80 columns + * 50 rows x 40 columns 43 rows x 80 columns + * 50 rows x 80 columns + *
* Some modes only are availables for color and/or VGA monitors. * Any change produced on the screen size is updated in the values * returned by MAXROW() and MAXCOL(). - * * $EXAMPLES$ * þ The first example change to a 12 lines of display mode: * IF SETMODE( 12, 40) @@ -65,10 +69,10 @@ * $COMPLIANCE$ * Some of these modes are not availables on Clipper * $PLATFORMS$ - * DOS - * $FILES$ - * Source is gtdos.c + * DOS,WIN32 + * $FILES$ + * Source is gtdos.c,gtwin.c * $SEEALSO$ - * MAXCOL(), MAXROW() + * MAXCOL(),MAXROW() * $END$ */ diff --git a/harbour/doc/en/string.txt b/harbour/doc/en/string.txt index 40a80c7e3d..006c853558 100644 --- a/harbour/doc/en/string.txt +++ b/harbour/doc/en/string.txt @@ -26,6 +26,14 @@ * LOWER() Documentation * ASC() Documentation * CHR() Documentation + * PADC() Documentation + * PADL() Documentation + * PADR() Documentation + * ALLTRIM() Documentation + * TRIM() Documentation + * RTRIM() Documentation + * SPACE() Documentation + * REPLICATE() Documentation * See doc/license.txt for licensing terms. * */ @@ -464,7 +472,7 @@ * $FILES$ * Library is rtl * $SEEALSO$ - * STRZERO(),VAL() + * STRZERO() * $END$ */ @@ -538,7 +546,7 @@ * $FILES$ * Library is rtl * $SEEALSO$ - * STR(),VAL() + * STR() * $END$ */ @@ -577,7 +585,7 @@ * $FILES$ * Library is rtl * $SEEALSO$ - * STR(),VAL() + * STR() * $END$ */ @@ -901,3 +909,368 @@ * $END$ */ +/* $DOC$ + * $FUNCNAME$ + * PADC() + * $CATEGORY$ + * Strings + * $ONELINER$ + * Centers an expression for a given width + * $SYNTAX$ + * PADC(,,) --> cString + * $ARGUMENTS$ + * An number,Character or date to pad + * + * Width of output string + * + * Character to fill in the string + * $RETURNS$ + * The Center string of + * $DESCRIPTION$ + * This function takes an date,number,or character expression + * and attempt to center the expression within a string of a given width + * expressed as .The default character used to pad either side + * of will be an blank space;however,this character may be + * explicitly specified the value of . + * + * If the lenght of is longer then ,this function will + * truncate the string from the leftmost side to the lenght of + * . + * $EXAMPLES$ + * ? PADC('Harbour',20) + * ? PADC(34.5142,20) + * ? PADC(Date(),35) + * $TESTS$ + * See Examples + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compilant + * $PLATFORMS$ + * All + * $FILES$ + * Library is rtl + * $SEEALSO$ + * ALLTRIM(),PADL(),PADR() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * PADL() + * $CATEGORY$ + * Strings + * $ONELINER$ + * Left-justifies an expression for a given width + * $SYNTAX$ + * PADL(,,) --> cString + * $ARGUMENTS$ + * An number,Character or date to pad + * + * Width of output string + * + * Character to fill in the string + * $RETURNS$ + * The left-justifies string of + * $DESCRIPTION$ + * This function takes an date,number,or character expression + * and attempt to left-justify it within a string of a given width + * expressed as .The default character used to pad left side + * of will be an blank space;however,this character may be + * explicitly specified the value of . + * + * If the lenght of is longer then ,this function will + * truncate the string from the leftmost side to the lenght of + * . + * $EXAMPLES$ + * ? PADC('Harbour',20) + * ? PADC(34.5142,20) + * ? PADC(Date(),35) + * $TESTS$ + * See examples + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compilant + * $PLATFORMS$ + * All + * $FILES$ + * Library is rtl + * $SEEALSO$ + * ALLTRIM(),PADC(),PADR() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * PADR() + * $CATEGORY$ + * Strings + * $ONELINER$ + * Right-justifies an expression for a given width + * $SYNTAX$ + * PADR(,,) --> cString + * $ARGUMENTS$ + * An number,Character or date to pad + * + * Width of output string + * + * Character to fill in the string + * $RETURNS$ + * The right-justifies string of + * $DESCRIPTION$ + * This function takes an date,number,or character expression + * and attempt to right-justify it within a string of a given width + * expressed as .The default character used to pad right side + * of will be an blank space;however,this character may be + * explicitly specified the value of . + * + * If the lenght of is longer then ,this function will + * truncate the string from the leftmost side to the lenght of + * . + * $EXAMPLES$ + * ? PADC('Harbour',20) + * ? PADC(34.5142,20) + * ? PADC(Date(),35) + * $TESTS$ + * See examples + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compilant + * $PLATFORMS$ + * All + * $FILES$ + * Library is rtl + * $SEEALSO$ + * ALLTRIM(),PADC(),PADL() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * ALLTRIM() + * $CATEGORY$ + * Strings + * $ONELINER$ + * Removes leading and trailing blank spaces from a string + * $SYNTAX$ + * ALLTRIM( ) --> cExpression + * $ARGUMENTS$ + * Any character string + * $RETURNS$ + * An string will all blank spaces removed from + * $DESCRIPTION$ + * This function returns the string will all leading and + * trailing blank spaces removed. + * $EXAMPLES$ + * ? ALLTRIM("HELLO HARBOUR") + * ? ALLTRIM(" HELLO HARBOUR") + * ? ALLTRIM("HELLO HARBOUR ") + * ? ALLTRIM(" HELLO HARBOUR ") + * $TESTS$ + * See Examples + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compilant + * $PLATFORMS$ + * All + * $FILES$ + * Library is rtl + * $SEEALSO$ + * LTRIM(),RTRIM(),TRIM() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * RTRIM() + * $CATEGORY$ + * Strings + * $ONELINER$ + * Remove trailing spaces from a string. + * $SYNTAX$ + * RTRIM() --> cString + * $ARGUMENTS$ + * Any character expression + * $RETURNS$ + * A formated string with out any blank spaced. + * $DESCRIPTION$ + * This function returns the value of with any trailing blank + * removed. + * + * This function is indentical to RTRIM() and the opposite of LTRIM(). + * Together with LTRIM(),this function equated to the ALLTRIM() + * function. + * $EXAMPLES$ + * ? RTrim("HELLO") // "HELLO" + * ? RTrim( "" ) // "" + * ? RTrim( "UA " ) // "UA" + * ? RTrim( " UA" ) // " UA" + * $TESTS$ + * See Examples + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compilant + * $PLATFORMS$ + * All + * $FILES$ + * Library is rtl + * $SEEALSO$ + * ALLTRIM(),LTRIM(),TRIM() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * TRIM() + * $CATEGORY$ + * Strings + * $ONELINER$ + * Remove trailing spaces from a string. + * $SYNTAX$ + * TRIM() --> cString + * $ARGUMENTS$ + * Any character expression + * $RETURNS$ + * A formated string with out any blank spaced. + * $DESCRIPTION$ + * This function returns the value of with any trailing blank + * removed. + * + * This function is indentical to RTRIM() and the opposite of LTRIM(). + * Together with LTRIM(),this function equated to the ALLTRIM() + * function. + * $EXAMPLES$ + * ? Trim("HELLO") // "HELLO" + * ? Trim( "" ) // "" + * ? Trim( "UA " ) // "UA" + * ? Trim( " UA" ) // " UA" + * $TESTS$ + * See Examples + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compilant + * $PLATFORMS$ + * All + * $FILES$ + * Library is rtl + * $SEEALSO$ + * RTRIM(),LTRIM(),ALLTRIM() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * REPLICATE() + * $CATEGORY$ + * Strings + * $ONELINER$ + * Repeats a single character expression + * $SYNTAX$ + * REPLICATE(,) --> cReplicateString + * $ARGUMENTS$ + * Character string to be replicated + * + * Number of times to replicate + * $RETURNS$ + * A character expression containg the + * fill character. + * $DESCRIPTION$ + * This function returns a string composed of repetitions of + * .The lenght of the character string returned by this + * function is limited to the memory avaliable. + * + * A value of 0 for will return a NULL string. + * $EXAMPLES$ + * ? Replicate('a',10) // aaaaaaaaaa + * ? Replicate('b',100000) + * $TESTS$ + * See Examples + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant in all aspects, with the + * exception don't have the Clipper 64Kb string length. + * $PLATFORMS$ + * All + * $FILES$ + * Library is rtl + * $SEEALSO$ + * SPACE(),PADC(),PADL(),PADR() + * $END$ + */ + +/* $DOC$ + * $FUNCNAME$ + * SPACE() + * $CATEGORY$ + * Strings + * $ONELINER$ + * Returns a string of blank spaces + * $SYNTAX$ + * SPACE( ) --> cString + * $ARGUMENTS$ + * The lenght of the string + * $RETURNS$ + * An string containing blank spaces + * $DESCRIPTION$ + * This function returns a string consisting of blank spaces. If + * the value of is 0,a NULL string will be returned. + * + * This function is useful to declare the lenght of a character memory + * variable. + * $EXAMPLES$ + * FUNC MAIN + * LOCAL cBigString + * LOCAL cFirst + * LOCAL cString := Space(20) //Create an characte memory variable + * // with lenght 20 + * ? len(cString) // 20 + * cBigString:=space(100000) // create a memory variable with 100000 + * // blank spaces + * ? len(cBigString) + * Use Tests New + * cFirst:= makeempty(1) + * ? len(cFirst) + * Return Nil + * + * Function MakeEmpty(xField) + * LOCAL nRecord + * LOCAL xRetValue + * + * If !empty(alias()) + * nRecord:=recno() + * dbgoto(0) + * if valtype(xField)=="C" + * xField:= ascan(dbstruct(),{|aFields| aFields[1]==upper(xfield)}) + * else + * default xField to 0 + * if xField < 1 .or. xField>fcount() + * xfield:=0 + * endif + * endif + * if !(xfield ==0) + * xRetvalue:=fieldget(xfield) + * endif + * dbgoto(nrecord) + * endif + * return( xRetvalue) + * $TESTS$ + * See examples + * $STATUS$ + * R + * $COMPLIANCE$ + * This function is Ca-Clipper compliant in all aspects, with the + * exception don't have the Clipper 64Kb string length. + * $PLATFORMS$ + * All + * $FILES$ + * Library is Rtl + * $SEEALSO$ + * PADC(),PADL(),PADR(),REPLICATE() + * $END$ + */