From 3b940b4d6a49c6ecffeee0bc67e926f56ac4963e Mon Sep 17 00:00:00 2001 From: dsiders Date: Sun, 12 Jun 2022 23:57:59 +0100 Subject: [PATCH] Docs: LazUtils/masks. Removes extra spaces in topics. Uses consistent tagging for True and False values. --- docs/xml/lazutils/masks.xml | 81 ++++++++++++++++++++----------------- 1 file changed, 45 insertions(+), 36 deletions(-) diff --git a/docs/xml/lazutils/masks.xml b/docs/xml/lazutils/masks.xml index 56132a6e81..678be9c684 100644 --- a/docs/xml/lazutils/masks.xml +++ b/docs/xml/lazutils/masks.xml @@ -257,7 +257,7 @@ Represents types of Windows-specific quirks for file and directory masks.

- TWindowsQuirk is an enumerated type used to represent ways in which a Windows/DOS mask works differently than a regular mask. Windows/DOS masks have many quirks and corner cases inherited from CP/M, then adapted to DOS (8.3) file names, and adapted again for long file names. + TWindowsQuirk is an enumerated type used to represent ways in which a Windows/DOS mask works differently than a regular mask. Windows/DOS masks have many quirks and corner cases inherited from CP/M, then adapted to DOS (8.3) file names, and adapted again for long file names.

@@ -274,7 +274,7 @@ - Anything.abc matches "Anything.abc" but also "Anything.abc*" (3 char extension). Anything.ab matches "Anything.ab" and never "anything.abcd". + Anything.abc matches "Anything.abc" but also "Anything.abc*" (3 char extension). Anything.ab matches "Anything.ab" and never "anything.abcd". @@ -635,7 +635,7 @@

- Exception_MissingCloseChar is a class procedure used to raise an EMaskError exception when the closing ']' character is omitted from a set or range expression. The exception message is determined by the value in the aOffset argument. When aOffset is a positive value (or zero), the value in rsMissingCloseCharMaskAt is used as the exception message. Otherwise, the value in rsMissingCloseCharMask is used. + Exception_MissingCloseChar is a class procedure used to raise an EMaskError exception when the closing ']' character is omitted from a set or range expression. The exception message is determined by the value in the aOffset argument. When aOffset is a positive value (or zero), the value in rsMissingCloseCharMaskAt is used as the exception message. Otherwise, the value in rsMissingCloseCharMask is used.

Exception_MissingCloseChar is called from the private CompileRange method in TMaskUTF8 when the range or set expression is not closed. @@ -696,7 +696,7 @@ Constructor for the class instance.

- Create is the overloaded constructor for the class instance. One variant allows case sensitivity for mask expressions and the allowed op codes to be specified as arguments. The other variant accepts an argument with the set of mask options for the class instance. + Create is the overloaded constructor for the class instance. One variant allows case sensitivity for mask expressions and the allowed op codes to be specified as arguments. The other variant accepts an argument with the set of mask options for the class instance.

Create the sets the initial values for the CaseSensitive, AutoReverseRange, and EscapeChar properties. @@ -708,7 +708,7 @@ - True if the mask expression is case sensitive. + True if the mask expression is case sensitive. Op codes allowed for the compiled mask expression. @@ -721,7 +721,7 @@ Indicates if the mask expression is case sensitive.

- CaseSensitive is a Boolean property which indicates if character in a mask expression are handle with case sensitivity. Its value is determined by an explicit argument passed to the Create method, or the presence of moCaseSensitive in the TMaskOptions passed to the constructor. + CaseSensitive is a Boolean property which indicates if character in a mask expression are handle with case sensitivity. Its value is determined by an explicit argument passed to the Create method, or the presence of moCaseSensitive in the TMaskOptions passed to the constructor.

Changing the value for the property causes Compile to be called when the Matches method in descendent classes is executed. When set to False, both the mask expression and the compared values are converted to lowercase for the comparison performed in Matches. @@ -784,7 +784,7 @@ Contains the set of mask op codes enabled for the class instance.

- MaskOpCodes is a TMaskOpCodes property with the set of op codes enabled for the Mask expression in the class instance. MaskOpCodes is populated with enumeration values from TMaskOpCode when characters in the mask expression are examined in the Compile method. The allowed values in the set can be specified as an argument to the Create constructor. + MaskOpCodes is a TMaskOpCodes property with the set of op codes enabled for the Mask expression in the class instance. MaskOpCodes is populated with enumeration values from TMaskOpCode when characters in the mask expression are examined in the Compile method. The allowed values in the set can be specified as an argument to the Create constructor.

Values in MaskOpCodes are used when the Matches method is called to compare a string value to the Mask expression. @@ -806,7 +806,7 @@ - Implements a class used to define, evaluate, and compare a mask expression using UNIX file system mask conventions. + Implements a class used to define, evaluate, and compare a mask expression using UNIX file system mask conventions.

@@ -873,7 +873,7 @@ - Always returns False in TMaskUTF8. + Always returns False in TMaskUTF8. Character value examined in the method. @@ -938,7 +938,7 @@ Constructor for the class instance.

- Create is the overloaded constructor for the class instance. It includes an AMask argument which contains the expression stored in the Mask property. Variants of the method also allow the value in CaseSensitive to be set. Set arguments can be provided which contain the TMaskOpCode values or the TMaskOption values used in the class instance. + Create is the overloaded constructor for the class instance. It includes an AMask argument which contains the expression stored in the Mask property. Variants of the method also allow the value in CaseSensitive to be set. Set arguments can be provided which contain the TMaskOpCode values or the TMaskOption values used in the class instance.

The variant which includes a TMaskOptions parameter has been deprecated in version 2.3, and will be removed in version 2.5. Use the variant which includes a TMaskOpCodes parameter. @@ -950,7 +950,7 @@ Mask expression for the class instance. - True if comparisons are performed with case sensitivity. + True if comparisons are performed with case sensitivity. Set of op codes allowed for the compiled mask expression. @@ -1004,7 +1004,7 @@ - True when the specified value matches the Mask expression. + True when the specified value matches the Mask expression. Value to compare to the Mask expression. @@ -1028,7 +1028,7 @@ - True if the specified file name matches the Windows-specific Mask expression. + True if the specified file name matches the Windows-specific Mask expression. @@ -1152,12 +1152,16 @@ - Returns True if the specified character contains a Null character (#0) (ASCII NUL). + + Returns True if the specified character contains a Null character (#0) (ASCII NUL). + - True if the specified character contains a Null character (#0) (ASCII NUL). + + True if the specified character contains a Null character (#0) (ASCII NUL). + Character value examined in the method. @@ -1189,7 +1193,7 @@ - True if the source file name is treated as a mask specification for a file name and not a file extension; such as '.foo'. + True if the source file name is treated as a mask specification for a file name and not a file extension; such as '.foo'. @@ -1206,7 +1210,7 @@ Mask expression for the class instance. - True if masks are compared with case sensitivity. + True if masks are compared with case sensitivity. Set of TMaskOpCode values allowed in the class instance. @@ -1269,7 +1273,7 @@ - True when the specified value matches the Mask expression. + True when the specified value matches the Mask expression. Value examined and compared to the Mask expression. @@ -1526,7 +1530,7 @@ - True when the file name matches one of the mask items. + True when the file name matches one of the mask items. File name examined in the method. @@ -1545,7 +1549,7 @@ - True if the file name matches one the masks in the list. + True if the file name matches one the masks in the list. File name examined in the method. @@ -1745,7 +1749,7 @@ Delimiter used between mask expressions in AValue. - True if the mask expression(s) are case sensitive. + True if the mask expression(s) are case sensitive. Set of TMaskOpCode values enabled for the class instance. @@ -1767,7 +1771,7 @@ - True if the specified file name matches one of the mask in the list. + True if the specified file name matches one of the mask in the list. File name compared to the mask instances in the list. @@ -1814,7 +1818,9 @@ - True when the file name matches the mask value using the specified options. + + True when the file name matches the mask value using the specified options. + File name compared to the mask value. @@ -1823,7 +1829,7 @@ Mask used to perform the comparison. - True when case sensitivity should be used in the comparison. + True when case sensitivity should be used in the comparison. Set of options enabled for the comparison. @@ -1843,7 +1849,7 @@
foo*.*
- Matches all files starting with 'foo' regardless of the file extension. Same as foo* using the Matches method. + Matches all files starting with 'foo' regardless of the file extension. Same as foo* using the Matches method.
foo*.
Matches foo* but must not include a file extension.
@@ -1878,7 +1884,9 @@ - True when the file name matches the mask value using the specified options. + + True when the file name matches the mask value using the specified options. + File name compared to the mask value. @@ -1887,7 +1895,7 @@ Mask used to perform the comparison. - True when case sensitivity should be used in the comparison. + True when case sensitivity should be used in the comparison. Set of options enabled for the comparison. @@ -1954,7 +1962,7 @@ - True when Filename matches at least one of the masks in the list. + True when Filename matches at least one of the masks in the list. File name compared to the file masks in Mask. @@ -1966,7 +1974,7 @@ Character(s) used as a separator between mask expressions in Mask. - True if the file name to mask comparison is case sensitive. + True if the file name to mask comparison is case sensitive. TMaskOption values which enable or disable features in the comparison. @@ -1986,7 +1994,7 @@
foo*.*
- Matches all files starting with 'foo' regardless of the file extension. Same as foo* using MatchesMaskList. + Matches all files starting with 'foo' regardless of the file extension. Same as foo* using MatchesMaskList.
foo*.
Matches foo* but must not include a file extension.
@@ -2037,7 +2045,8 @@ - True when Filename matches at least one of the masks in the list. + True when Filename matches at least one of the masks in the list. + File name compared to the file masks in Mask. @@ -2049,7 +2058,7 @@ Character(s) used as a separator between mask expressions in Mask. - True if the file name to mask comparison is case sensitive. + True if the file name to mask comparison is case sensitive. TMaskOption values which enable or disable features in the comparison. @@ -2118,7 +2127,7 @@ Sets of Characters

- A set begins with an opening Square Bracket character ([) and ends with a closing Square Bracket character (]). Values between the brackets represent the characters which are considered a match in that position. For example: 'a[bcd]e.txt' would match 'abe.txt', 'ace.txt', or 'ade.txt'. It would not match 'afe.txt'. + A set begins with an opening Square Bracket character ([) and ends with a closing Square Bracket character (]). Values between the brackets represent the characters which are considered a match in that position. For example: 'a[bcd]e.txt' would match 'abe.txt', 'ace.txt', or 'ade.txt'. It would not match 'afe.txt'.

Ranges of Characters @@ -2130,7 +2139,7 @@ Negated Sets and Ranges

- When using set or range notation, character values can be excluded using negation. This is expressed using an Exclamation Point character (!) in front of the set or range specification. For example: '[!0-9]' or '[!0123456789]'. In both examples, any character at the given position except the values in the set or range would be considered a match. + When using set or range notation, character values can be excluded using negation. This is expressed using an Exclamation Point character (!) in front of the set or range specification. For example: '[!0-9]' or '[!0123456789]'. In both examples, any character at the given position except the values in the set or range would be considered a match.

Wildcards @@ -2154,13 +2163,13 @@ They are other Windows-specific behaviors originating from its CP/M and MS DOS heritage. These are implemented in TWindowsMask as Quirks, and can be enabled or disabled in the class instance.

- Please refer to the documentation for the TMask and TWindowsMask for more information about mask expressions and their usage in the respective classes. + Please refer to the documentation for the TMask and TWindowsMask for more information about mask expressions and their usage in the respective classes.

Configurable Settings

- The Mask classes also contain configurable settings which can affect their behavior in their Matches method. For example: CaseSensitive, AutoReverseRange, EscapeChar, and MaskOpCodes. The initial value for these settings can be passed as arguments to the class constructors, or they can be specified using properties in the class instances. MaskOpCodes is particularly important; it determines the behavior of wildcards and escape characters in the mask expression. + The Mask classes also contain configurable settings which can affect their behavior in their Matches method. For example: CaseSensitive, AutoReverseRange, EscapeChar, and MaskOpCodes. The initial value for these settings can be passed as arguments to the class constructors, or they can be specified using properties in the class instances. MaskOpCodes is particularly important; it determines the behavior of wildcards and escape characters in the mask expression.

Mask Expression Examples