The FoxRing functions documentation describes a collection of functions written to emulate commonly used functions from the FoxPro programming language, with each function defined including its syntax, description, arguments, and return values. Some of the key functions covered include frAbs() for getting the absolute value, frAt() and frAtC() for searching strings, frChr() for getting the character of an ASCII code, and frEmpty() to check if a value is empty.

1. Ring Documentation, Release 1.8
82.207 QXmlStreamEntityResolver Class
C++ Reference : http://doc.qt.io/qt-5/QXmlStreamEntityResolver.html
Parameters : void
82.208 QXmlStreamNamespaceDeclaration Class
C++ Reference : http://doc.qt.io/qt-5/QXmlStreamNamespaceDeclaration.html
Parameters : void
• QStringRef namespaceUri(void)
• QStringRef prefix(void)
82.209 QXmlStreamNotationDeclaration Class
C++ Reference : http://doc.qt.io/qt-5/QXmlStreamNotationDeclaration.html
Parameters : void
• QStringRef name(void)
• QStringRef publicId(void)
• QStringRef systemId(void)
82.210 QXmlStreamReader Class
C++ Reference : http://doc.qt.io/qt-5/QXmlStreamReader.html
Parameters : void
• void addData(QByteArray)
• void addData_2(QString)
• void addData_3(const char * data)
• void addExtraNamespaceDeclaration(QXmlStreamNamespaceDeclaration)
• void addExtraNamespaceDeclarations(QXmlStreamNamespaceDeclarations)
• bool atEnd(void)
• QXmlStreamAttributes attributes(void)
• qint64 characterOffset(void)
• void clear(void)
• qint64 columnNumber(void)
• QIODevice *device(void)
• QStringRef documentEncoding(void)
• QStringRef documentVersion(void)
82.207. QXmlStreamEntityResolver Class 1121

2. Ring Documentation, Release 1.8
• QStringRef dtdName(void)
• QStringRef dtdPublicId(void)
• QStringRef dtdSystemId(void)
• QXmlStreamEntityDeclarations entityDeclarations(void)
• QXmlStreamEntityResolver *entityResolver(void)
• Error error(void)
• QString errorString(void)
• bool hasError(void)
• bool isCDATA(void)
• bool isCharacters(void)
• bool isComment(void)
• bool isDTD(void)
• bool isEndDocument(void)
• bool isEndElement(void)
• bool isEntityReference(void)
• bool isProcessingInstruction(void)
• bool isStandaloneDocument(void)
• bool isStartDocument(void)
• bool isStartElement(void)
• bool isWhitespace(void)
• qint64 lineNumber(void)
• QStringRef name(void)
• QXmlStreamNamespaceDeclarations namespaceDeclarations(void)
• bool namespaceProcessing(void)
• QStringRef namespaceUri(void)
• QXmlStreamNotationDeclarations notationDeclarations(void)
• QStringRef prefix(void)
• QStringRef processingInstructionData(void)
• QStringRef processingInstructionTarget(void)
• QStringRef qualifiedName(void)
• void raiseError(QString)
• QString readElementText(QXmlStreamReader::ReadElementTextBehaviour)
• TokenType readNext(void)
• bool readNextStartElement(void)
• void setDevice(QIODevice *device)
• void setEntityResolver(QXmlStreamEntityResolver *resolver)
82.210. QXmlStreamReader Class 1122

3. Ring Documentation, Release 1.8
• void setNamespaceProcessing(bool)
• void skipCurrentElement(void)
• QStringRef text(void)
• QString tokenString(void)
• TokenType tokenType(void)
82.211 QXmlStreamWriter Class
C++ Reference : http://doc.qt.io/qt-5/QXmlStreamWriter.html
Parameters : void
• bool autoFormatting(void)
• int autoFormattingIndent(void)
• QTextCodec *codec(void)
• QIODevice *device(void)
• bool hasError(void)
• void setAutoFormatting(bool enable)
• void setAutoFormattingIndent(int spacesOrTabs)
• void setCodec(QTextCodec *codec)
• void setCodec_2(const char *codecName)
• void setDevice(QIODevice *device)
• void writeAttribute(QString, QString,QString)
• void writeAttribute_2(QString, QString)
• void writeAttribute_3(QXmlStreamAttribute)
• void writeAttributes(QXmlStreamAttributes)
• void writeCDATA(QString text)
• void writeCharacters(QString text)
• void writeComment(QString text)
• void writeCurrentToken(QXmlStreamReader reader)
• void writeDTD(QString dtd)
• void writeDefaultNamespace(QString namespaceUri)
• void writeEmptyElement(QString namespaceUri, QString name)
• void writeEmptyElement_2(QString qualifiedName)
• void writeEndDocument(void)
• void writeEndElement(void)
• void writeEntityReference(QString name)
• void writeNamespace(QString namespaceUri, QString prefix)
82.211. QXmlStreamWriter Class 1123

4. Ring Documentation, Release 1.8
• void writeProcessingInstruction(QString target, QString data)
• void writeStartDocument(QString version)
• void writeStartDocument_2(QString version, bool standalone)
• void writeStartDocument_3(void)
• void writeStartElement(QString namespaceUri, QString name)
• void writeStartElement_2(QString qualifiedName)
• void writeTextElement(QString namespaceUri, QString name, QString text)
• void writeTextElement_2(QString qualifiedName, QString text)
82.212 RingCodeHighlighter Class
Parameters : QTextDocument *parent
• void setColors(QColor c1,QColor c2,QColor c3,QColor c4,QColor c5)
• void setKeywordsBold(int nStatus)
82.212. RingCodeHighlighter Class 1124

5. CHAPTER
EIGHTYTHREE
RINGMURMURHASH FUNCTIONS REFERENCE
” MurmurHash is a non-cryptographic hash function suitable for general hash-based lookup. It was created by
Austin Appleby in 2008 and is currently hosted on Github along with its test suite named ‘SMHasher’. It also
exists in a number of variants,[5] all of which have been released into the public domain. The name comes from
two basic operations, multiply (MU) and rotate (R), used in its inner loop. “
Murmurhash extension is an extension written to implement a full implementation for the MurmurHash library.
Developer: Hassan Ahmed
83.1 MurmurHash1 functions
uint32_t murmurhash1(string key, int seed, [bool return_type]);
uint32_t murmurhash1_aligned(string key, int seed, [bool return_type]);
83.2 MurmurHash2 functions
uint32_t murmurhash2(string key, int seed, [bool return_type]);
uint32_t murmurhash2a(string key, int seed, [bool return_type]);
uint64_t murmurhash64a(string key, int seed, [bool return_type]);
uint64_t murmurhash64b(string key, int seed, [bool return_type]);
uint32_t murmurhash_neutral2(string key, int seed, [bool return_type]);
uint32_t murmurhash_aligned2(string key, int seed, [bool return_type]);
83.3 MurmurHash3 functions
uint32_t murmurhash3_x86_32(string key, int seed, [bool return_type]);
list murmurhash3_x86_128(string key, int seed, [bool return_type]);
list murmurhash3_x64_128(string key, int seed, [bool return_type]);
The third optional parameter is to set the type of the returned value, this parameter accepts a bool value [ true, false ],
true will return a Hex value, while false will return a integer value.
1125

6. Ring Documentation, Release 1.8
83.4 Example
load "murmurhashlib.ring"
key = "Ring Language"
see murmurhash3_x86_32(key, 0, 0) + nl // Output: 1894444853
see murmurhash3_x86_32(key, 0, 1) + nl // Output: 70eaef35
83.4. Example 1126

7. CHAPTER
EIGHTYFOUR
FOXRING FUNCTIONS REFERENCE
As a FoxPro developer, I started writing a class with some of the functions I used in FoxPro.
The goal is to create as many functions as possible with the behavior similar to FoxPro functions.
Developer: Jose Rosado
84.1 FoxRing functions
Function Name Description
frAbs() Returns the absolute value of the specified numeric expression.
frAddBs() Adds a backslash (if needed) to a path expression.
frALines() Creates an Array with the content of the specified string.
frAllTrim() Removes all leading and trailing spaces of the specified string.
frAsc() Returns the ANSI value for the leftmost character in a character expression.
frAt() Searches a character expression for the occurrence
of another character expression.
frAtC() Searches a character expression for the ocurrence of another character expression without
regard for the case of these two expressions.
frBetween() Determines whether the value of an expression is inclusively between the values of two
expressions of the same type.
frChr() Returns the character associated with the specified numeric ANSI code.
frEmpty() Determines whether an expression evaluates to empty.
frFile() Checks if a file exists on disk.
frFileToStr() Returns the contents of a file as a character string.
frForceExt() Returns a string with the old file name extension replaced by a new extension.
frForcePath() Returns a file name with a new path name substituted for the old one.
frIif() Returns one of two values depending on the value of a logical expression.
frInList() Determines whether an expression matches another expression in a list.
frInt() Evaluates a numeric expression and returns the integer portion of the expression.
frJustDrive() Returns the drive letter from a complete path.
frJustExt() Returns the characters of a file extension from a complete path.
frJustFName() Returns the file name portion of a complete path and file name.
frJustPath() Returns the path portion of a complete path and file name.
frJustStem() Returns the stem name (the file name before the extension)
from a complete path and file name.
frLen() Determines the number of characters in a character expression,
indicating the length of the expression.
Continued on next page
1127

8. Ring Documentation, Release 1.8
Table 84.1 – continued from previous page
Function Name Description
frListToString() Creates a string with the string elements of an Array.
frLTrim() Removes all leading spaces or parsing characters from the
specified character expression.
frPadL() Returns a string from an expression, padded with spaces or characters to a
specified length on the left side.
frPadR() Returns a string from an expression, padded with spaces or characters to a
specified length on the right side.
frProper() Returns from a character expression a string capitalized as
appropriate for proper names.
frReplicate() Returns a character string that contains a specified character
expression repeated a specified number of times.
frRTrim() Removes all trailing spaces or parsing characters from
the specified character expression.
frSetIfEmpty() Set a Value into a variable if the variable value is empty, null or zero.
frSetSeparatorTo() Specifies the character for the numeric place separator.
frSpace() Returns a character string composed of a specified number of spaces.
frStr() Returns the character equivalent of a numeric expression.
frStringToList() Creates a List with the content of the specified string.
frStrTran() Searches a character expression for a second character expression and
replaces each occurrence with a third character expression.
frStuff() Returns a new character string replaced by a specified number of
characteres in a character expression with another character expression.
frSubStr() Returns a character string from the given character expression,
starting at a specified position in the character
expression and continuing for a specified number of characters.
frTransform() Returns a character string from an expression in a
format determined by a format code.
frVal() Returns a numeric value from a character expression composed of numbers.
frVarType() Returns the data type of an expression.
84.2 frAbs() function
* Syntax : lnReturnValue = frAbs(tnExpression)
* Description : Returns the absolute value of the specified numeric expression.
* :
* Arguments : <tnExpression>
* : Specifies the numeric expression whose absolute value frAbs()
* : returns.
* Returns : <lnReturnValue>
* : Returns the absolute value of the specified numeric expression.
84.3 frAsc() function
* Syntax : lnReturnValue = frAsc(tcExpression)
* Description : Returns the ANSI value for the leftmost character in
* : a character expression.
* Arguments : <tcExpression>
* : Specifies the character expression containing the character
84.2. frAbs() function 1128

9. Ring Documentation, Release 1.8
* : whose ANSI value frAsc()
* : returns. Any characters after the first character in
* : tcExpression are ignored by frAsc().
* Returns : <lnReturnValue>
* : returns the position of the character in the character
* : table of the current code page.
* : Every character has a unique ANSI value in the
* : range from 0 to 255.
84.4 frAddBs() function
* Syntax : lcReturnValue = frAddBs(tcPath)
* Description : Adds a backslash (if needed) to a path expression.
* :
* Arguments : <tcPath>
* : Specifies the path name to which to add the backslash.
* :
* Returns : <lcReturnValue> The path with the backslash.
84.5 frAt() function
* Syntax : lnPos = frAt(tcToSearch, tcString, tnOccurrence)
* Description : Searches a character expression for the occurrence of
* : another character expression.
* : The search performed by frAt() is case-sensitive.
* :
* Arguments : <tcToSearch>
* : Specifies the character expression to search
* : for in <tcString>.
* : <tcString>
* : Specifies the character expression to search
* : for <tcToSearch>.
* : <tnOccurrence>
* : Specifies which occurrence, first, second, third,
* : and so on, of <tcToSearch> to search for
* : in <tcString>.
* : By default, frAt() searches for the first occurrence
* : of <tcToSearch> (tnOccurrence = 1).
* Returns : Numeric. frAt() returns an integer indicating the
* : position of the first character for a
* : character expression or memo field within another
* : character expression or memo field,
* : beginning from the leftmost character. If the
* : expression or field is not found, or if
* : <tnOccurrence> is greater than the number of
* : times <tcToSearch> occurs in <tcString>, frAt()
* : returns 0.
84.4. frAddBs() function 1129

10. Ring Documentation, Release 1.8
84.6 frAtC() function
* Syntax : lnPos = frAtC(tcToSearch, tcString, tnOccurrence)
* Description : Searches a character expression for the occurrence
* : of another character expression
* : without regard for the case of these two expressions.
* :
* Arguments : <tcToSearch>
* : Specifies the character expression to search
* : for in <tcString>.
* : <tcString>
* : Specifies the character expression to search
* : for <tcToSearch>.
* : <tnOccurrence>
* : Specifies which occurrence, first, second, third,
* : and so on, of <tcToSearch> to search for
* : in tcString.
* : By default, frAtC() searches for the first occurrence
* : of <tcToSearch> (tnOccurrence = 1).
* Returns : Numeric. frAtC() returns an integer indicating the
* : position of the first character for a
* : character expression or memo field within
* : another character expression or memo field,
* : beginning from the leftmost character. If the
* : expression or field is not found, or if
* : <tnOccurrence> is greater than the number of
* : times <tcToSearch> occurs in <tcString>, frAtC()
* : returns 0.
84.7 frChr() function
* Syntax : lcReturnValue = frChr(tnExpression)
* Description : Returns the character associated with the specified numeric
* : ANSI code.
* Arguments : <tnExpression>
* : Specifies a number between 0 and 255 whose equivalent ANSI
* : character frChr() returns.
* Returns : <lcReturnValue>
* : Returns a single character corresponding to the numeric
* : position of the character in the
* : character table of the current code page.
* :
* Remarks : tnExpression must be between 0 and 255
84.8 frEmpty() function
* Syntax : llReturnValue = frEmpty(tuExpression)
* Description : Determines whether an expression evaluates to empty.
* :
* Arguments : <tuExpression>
* : Specifies the expression that EMPTY() evaluates.
* : You can specify an expression with Character,
* : Numeric, or logical type.
84.6. frAtC() function 1130