Skip to content
This repository was archived by the owner on Aug 31, 2021. It is now read-only.

Commit 86be8e0

Browse files
livecodepanoslivecodepanos
committed
Merge remote-tracking branch 'upstream/develop-9.0' into merge-develop-9.0_17.12.2018
2 parents 0e94e5f + c19f1d1 commit 86be8e0

File tree

104 files changed

+743
-549
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

104 files changed

+743
-549
lines changed

‎docs/dictionary/command/filter.lcdoc‎

Lines changed: 44 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@ Name: filter
22

33
Type: command
44

5-
Syntax: filter [{lines | items | keys | elements} of] <filterSource> {with | without | [not] matching} [{wildcard pattern | regex pattern}] <filterPattern> [into <targetContainer>]
5+
Syntax: filter [{lines | items | keys | elements} of] <filterSource> {with| without | [not] matching} [wildcard pattern] <wildcardPattern> [into <targetContainer>]
6+
7+
Syntax: filter [{lines | items | keys | elements} of] <filterSource> {with| without | [not] matching} regex pattern <regexPattern> [into <targetContainer>]
68

79
Summary:
8-
Filters each line, item, key or element in a source container or
9-
expression, removing the lines, items, keys or elements that do or don't
10-
match a pattern.
10+
Filters each line, item, key or element in a source container or expression,
11+
removing the lines, items, keys or elements that do or don't match a pattern.
1112

1213
Introduced: 1.0
1314

@@ -56,49 +57,60 @@ Parameters:
5657
filterSource:
5758
An expression that evaluates to a string, array, or a container.
5859

59-
filterPattern:
60+
wildcardPattern:
6061
An expression used to match certain lines, items, keys or elements.
62+
See description.
63+
64+
regexPattern:
65+
An regular expression used to match certain lines, items, keys or elements.
66+
See [Microsoft's RegEx Quick Reference](https://docs.microsoft.com/en-us/dotnet/standard/base-types/regular-expression-language-quick-reference)
67+
guide for more info on regex usage.
6168

6269
targetContainer:
63-
An expression that evaluates to a container
70+
An expression that evaluates to a container.
6471

6572
It:
66-
If the filter command is used on a <filterSource> which is not a
67-
container, and no <targetContainer> is specified, the filtered string
73+
If the filter command is used on a <filterSource> which is not
74+
a <container>, and no <targetContainer> is specified, the filtered string
6875
or array will be placed in the <it> variable.
6976

7077
Description:
7178
Use the <filter> command to pick specific lines, items, keys or elements
72-
in a container or expression.
79+
in a <container> or <expression>.
7380

74-
The <filter>...with form and the <filter>...matching form retain the
81+
The `filter...with` form and the `filter...matching` form retain the
7582
lines, items, keys or elements that contain a match for the specified
76-
<filterPattern>.
83+
<wildcardPattern> or <regexPattern>.
7784

78-
The <filter>...without form and the <filter>...not matching form discard
85+
The `filter...without` form and the `filter...not matching` form discard
7986
the lines, items, keys or elements that do not contain a match for the
80-
specified <filterPattern>.
87+
specified <wildcardPattern> or <regexPattern>.
8188

8289
If you don't specify lines, items, keys or elements then lines are
8390
filtered by default.
8491

85-
If a regex pattern is specified, the <filterPattern> evaluates to a
86-
regular expression.
92+
>**Note:** If neither `wildcard pattern` or `regex pattern` forms are explicitly
93+
specified then the wildcard pattern form is assumed.
8794

88-
If a wildcard <filterPattern> is specified, the <filterPattern> consists
89-
of a string of characters to match, which may be combined with any
95+
If the `regex pattern` form is specified, the <regexPattern> should
96+
be formatted as a <regular expression>. There are [many websites](https://www.google.com/search?regex)
97+
that provide examples and tutorials of RegEx expressions.
98+
99+
If the 'wildcard pattern' form is to be used, the <wildcardPattern> should
100+
consists of a string of characters to match, which may be combined with any
90101
number of the following special characters:
91102

92-
- * : Matches zero or more of any character. The <filterPattern> A*C
103+
- `*` : Matches zero or more of any character. The filterPattern `A*C`
93104
matches "AC", "ABC", or "ADZXC".
94-
- ? : Matches exactly one character. The <filterPattern> A?C matches
105+
- `?` : Matches exactly one character. The filterPattern `A?C` matches
95106
"ABC", but not "AC" or "ADZXC".
96-
- [chars] : Matches any one of the characters inside the brackets. The
97-
<filterPattern> A[BC]D matches "ABD" or "ACD", but not "AD" or "ABCD".
98-
- [char-char] : Matches any character whose unicode codepoint is between
99-
the first character and the second character.
100-
- [!chars] : Matches any character which is not one of the characters
107+
- `[chars]` : Matches any one of the characters inside the brackets. The
108+
filterPattern `A[BC]D` matches "ABD" or "ACD", but not "AD" or "ABCD".
109+
- `[!chars]` : Matches any character which is not one of the characters
101110
inside the brackets.
111+
- `[char-char]` : Matches any character whose unicode codepoint is between
112+
the first character and the second character, such as `[a-y]` any character
113+
between "a" and "y" but not "z"
102114

103115

104116
You can match instances of special chars as follows:
@@ -110,18 +122,17 @@ You can match instances of special chars as follows:
110122
- `!` with `!`
111123

112124

113-
For example, the wildcard <filterPattern> `[[]A]*` will match any
114-
string beginning with `[A]`.
125+
For example, the <wildcardPattern> `[[]A]*` will match any
126+
string beginning with `[A]`. Broken down, there is `[[]` which equates
127+
to an open square bracket `[` followed by `A]*` as the closing square
128+
bracket is not a special character.
115129

116130
The three bracketed forms can be combined to create more complex
117131
character classes, for example the pattern [!abcA-C] matches any
118132
character which is not a, b or c (upper or lower case)
119133

120-
If no <filterPattern> type is specified, the <filterPattern> is handled
121-
as a wildcard.
122-
123-
If no <targetContainer> is specified, and you filter a container, the
124-
container contents will be replaced by the filtered result.
134+
If no <targetContainer> is specified, and you filter a <container>,
135+
the <container> contents will be replaced by the filtered result.
125136

126137
Changes:
127138
The <filter>...without form was added in version 2.1.1. In previous
@@ -140,6 +151,7 @@ Filtering of array keys and elements was added in version 8.1.
140151

141152
References: replace (command), sort (command), matchChunk (function),
142153
matchText (function), replaceText (function), it (keyword),
143-
caseSensitive (property)
154+
caseSensitive (property), container (glossary), expression (glossary),
155+
regular expression (glossary)
144156

145157
Tags: text processing

‎docs/dictionary/command/revDeleteFolder.lcdoc‎

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -46,27 +46,28 @@ On Mac OS and OS X systems, the <revDeleteFolder> <command> places the
4646
> should not rename or move <file|files> and <folder|folders> it didn't
4747
> create without obtaining explicit confirmation from the user.
4848

49-
>*Note:* When included in a <standalone application>, the <Common
50-
> library> is implemented as a hidden <group> and made available when
51-
> the <group> receives its first <openBackground> message. During the
52-
> first part of the <application|application's> startup process, before
53-
> this <message> is sent, the <revDeleteFolder> <command> is not yet
54-
> available. This may affect attempts to use this <command> in
55-
> <startup>, <preOpenStack>, <openStack>, or <preOpenCard>
56-
> <handler|handlers> in the <main stack>. Once the <application> has
57-
> finished starting up, the <library> is available and the
58-
> <revDeleteFolder> <command> can be used in any <handler>.
49+
>*Note:* When included in a <standalone application>, the
50+
> <Common library> is implemented as a hidden <group> and made
51+
> available when the <group> receives its first <openBackground>
52+
> message. During the first part of the <application|application's>
53+
> startup process, before this <message> is sent, the
54+
> <revDeleteFolder> <command> is not yet available. This may affect
55+
> attempts to use this <command> in <startup>, <preOpenStack>,
56+
> <openStack>, or <preOpenCard> <handler|handlers> in the
57+
> <main stack>. Once the <application> has finished starting up,
58+
> the <library> is available and the <revDeleteFolder> <command>
59+
> can be used in any <handler>.
5960

6061
References: revCopyFolder (command), create folder (command),
6162
answer folder (command), delete file (command), revMoveFolder (command),
62-
function (control structure), folders (function), application (glossary),
63-
return (glossary), standalone application (glossary), file (glossary),
64-
shell (glossary), subfolder (glossary), platform (glossary),
65-
command (glossary), Windows (glossary), main stack (glossary),
66-
OS X (glossary), AppleScript (glossary), group (glossary),
67-
result (glossary), Unix (glossary), Mac OS (glossary), folder (glossary),
68-
message (glossary), handler (glossary), Common library (library),
69-
library (library), startup (message), openBackground (message),
70-
preOpenStack (message), openStack (message), preOpenCard (message),
71-
stack (object)
63+
function (control structure), folders (function), result (function),
64+
application (glossary), return (glossary),
65+
standalone application (glossary), file (glossary), shell (glossary),
66+
subfolder (glossary), platform (glossary), command (glossary),
67+
Windows (glossary), main stack (glossary), OS X (glossary),
68+
AppleScript (glossary), group (glossary), Unix (glossary),
69+
Mac OS (glossary), folder (glossary), message (glossary),
70+
handler (glossary), Common library (library), library (library),
71+
startup (message), openBackground (message), preOpenStack (message),
72+
openStack (message), preOpenCard (message), stack (object)
7273

‎docs/dictionary/command/revGoToFramePaused.lcdoc‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,8 @@ revGoToFramePause <command> repeatedly for each frame, using the <send>
5252
<command> :
5353

5454
on goNextFrame theFrame -- 1 frame every 20th of a second
55-
revGoToFramePaused "My Animation",theFrame
56-
send ("goNextFrame" && (theFrame + 1)) to me in 3 ticks
57-
55+
revGoToFramePaused "My Animation",theFrame
56+
send ("goNextFrame" && (theFrame + 1)) to me in 3 ticks
5857
end goNextFrame
5958

6059

@@ -67,14 +66,14 @@ revGoToFramePause <command> repeatedly for each frame, using the <send>
6766
> library checkbox is checked.
6867

6968
References: revStopAnimation (command), group (command),
70-
current card (glossary), main stack (glossary), handler (glossary),
71-
frame (glossary), message (glossary),
69+
send (command), current card (glossary), main stack (glossary),
70+
handler (glossary), frame (glossary), message (glossary),
7271
Standalone Application Settings (glossary),
7372
standalone application (glossary), command (glossary),
7473
application (glossary), LiveCode custom library (glossary),
75-
Animation library (library), send (library), library (library),
76-
startup (message), openBackground (message), preOpenStack (message),
77-
openStack (message), preOpenCard (message), defaultStack (property)
74+
Animation library (library), library (library), startup (message),
75+
openBackground (message), preOpenStack (message), openStack (message),
76+
preOpenCard (message), defaultStack (property)
7877

7978
Tags: multimedia
8079

‎docs/dictionary/command/revGoURL.lcdoc‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,9 @@ browser, and so on.
5454
> folder inside the Extensions folder. (This <file> is installed by the
5555
> Internet Access installer on the 8.0 installation CD.) The <revGoURL>
5656
> <command> is not supported for <Mac OS> versions before 8.0.
57-
Important:If the <URL> contains quotes, it is necessary either to
57+
58+
59+
>*Important:* If the <URL> contains quotes, it is necessary either to
5860
<URLEncode> it or to replace the quotes with "%22", or unexpected
5961
behavior may be experienced.
6062

@@ -80,9 +82,8 @@ handler (glossary), message (glossary), group (glossary),
8082
Mac OS (glossary), standalone application (glossary),
8183
Apple Event (glossary), command (glossary), browser (glossary),
8284
URL (keyword), file (keyword), Common library (library),
83-
launch url command (library), library (library), startup (message),
84-
openBackground (message), preOpenStack (message), openStack (message),
85-
stack (object)
85+
library (library), startup (message), openBackground (message),
86+
preOpenStack (message), openStack (message), stack (object)
8687

8788
Tags: networking
8889

‎docs/dictionary/command/revInitializeVideoGrabber.lcdoc‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,20 +34,20 @@ separated by commas: the left, top, right, and bottom edges of the video
3434
grabber, in absolute (screen) coordinates.
3535

3636
Description:
37-
Use the <revInitializeVideoGrabber> <command> to start up <video
38-
capture> capability.
37+
Use the <revInitializeVideoGrabber> <command> to start up
38+
<video capture> capability.
3939

4040
You must use the <revInitializeVideoGrabber> <command> before using any
41-
of the other <command|commands> and <function|functions> in the <Video
42-
library>. The <command> does two things:
41+
of the other <command|commands> and <function|functions> in the
42+
<Video library>. The <command> does two things:
4343

4444
* Loads the code necessary for video capture into memory.
4545
* Opens the video grabber window.
4646

4747

4848
>*Note:* The <video grabber> is not a <stack window>, so you can't set
49-
> its <properties>. To change the size and location of the <video
50-
> grabber>, use the <revSetVideoGrabberRect> <command>.
49+
> its <properties>. To change the size and location of the
50+
> <video grabber>, use the <revSetVideoGrabberRect> <command>.
5151

5252
Once the video grabber is open, you can use the revVideoGrabDialog
5353
<command> to specify where the video camera (or other video source) is
@@ -68,8 +68,7 @@ capture>.
6868
> <LiveCode custom library|custom library> when you create your
6969
> <standalone application|standalone>. In the Inclusions pane of the
7070
> <Standalone Application Settings> window, make sure the
71-
> "Video Grabber"
72-
> library checkbox is checked.
71+
> "Video Grabber" library checkbox is checked.
7372

7473
Changes:
7574
The use of <QuickTime> was deprecated in version 8.1 of LiveCode with
@@ -89,7 +88,8 @@ video capture (glossary), Windows (glossary), VFW (glossary),
8988
Standalone Application Settings (glossary), video grabber (glossary),
9089
standalone application (glossary), function (glossary),
9190
command (glossary), LiveCode custom library (glossary), file (keyword),
92-
Video library (library), properties (property)
91+
Video library (library), properties (property), dontUseQT (property),
92+
dontUseQTEffects (property)
9393

9494
Tags: multimedia
9595

‎docs/dictionary/command/revMailUnicode.lcdoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ For some older email programs, it may not be possible to specify a
5252
<revMailUnicode> command will still work with such programs, but only
5353
the To: header will be set.
5454

55-
>*Note:* When included in a <standalone application>, the <Common
56-
> library> is implemented as a hidden <group> and made available when
57-
> the <group> receives its first <openBackground> message. During the
55+
>*Note:* When included in a <standalone application>, the
56+
> <Common library> is implemented as a hidden <group> and made available
57+
> when the <group> receives its first <openBackground> message. During the
5858
> first part of the <application|application's> startup process, before
5959
> this <message> is sent, the <revMailUnicode> <command> is not yet
6060
> available. This may affect attempts to use this <command> in

‎docs/dictionary/command/revMoveFolder.lcdoc‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ The <revMoveFolder> <command> moves the entire <folder>, including all
4747
is removed from its original location and apppears only in the new
4848
location.
4949

50-
>*Note:* When included in a <standalone application>, the <Common
51-
> library> is implemented as a hidden <group> and made available when
52-
> the <group> receives its first <openBackground> message. During the
50+
>*Note:* When included in a <standalone application>, the
51+
> <Common library> is implemented as a hidden <group> and made available
52+
> when the <group> receives its first <openBackground> message. During the
5353
> first part of the <application|application's> startup process, before
5454
> this <message> is sent, the <revMoveFolder> <command> is not yet
5555
> available. This may affect attempts to use this <command> in
@@ -60,11 +60,11 @@ location.
6060

6161
References: create alias (command), delete folder (command),
6262
revDeleteFolder (command), function (control structure),
63-
application (glossary), return (glossary),
64-
standalone application (glossary), file (glossary), shell (glossary),
65-
subfolder (glossary), platform (glossary), command (glossary),
66-
Windows (glossary), main stack (glossary), OS X (glossary),
67-
AppleScript (glossary), group (glossary), result (glossary),
63+
result (function), application (glossary),
64+
standalone application (glossary), file (glossary),
65+
shell (glossary), subfolder (glossary), platform (glossary),
66+
command (glossary), Windows (glossary), main stack (glossary),
67+
OS X (glossary), AppleScript (glossary), group (glossary),
6868
Unix (glossary), message (glossary), folder (glossary), Mac OS (glossary),
6969
handler (glossary), Common library (library), library (library),
7070
startup (message), openBackground (message), preOpenStack (message),

‎docs/dictionary/command/revMoveToFirstRecord.lcdoc‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ Type: command
55
Syntax: revMoveToFirstRecord <recordSetID>
66

77
Summary:
8-
Moves to the first <record> of a <record set (database
9-
cursor)(glossary)>.
8+
Moves to the first <record> of a <record set (glossary)>.
109

1110
Associations: database library
1211

@@ -53,8 +52,7 @@ References: revMoveToNextRecord (command), function (control structure),
5352
revdb_movefirst (function), revdb_moveprev (function),
5453
revdb_movelast (function), revDatabaseColumnNumbered (function),
5554
revdb_movenext (function), Standalone Application Settings (glossary),
56-
record (glossary), command (glossary),
57-
record set (database cursor) (glossary),
55+
record (glossary), command (glossary), record set (glossary),
5856
standalone application (glossary), database (glossary),
5957
LiveCode custom library (glossary), Database library (library)
6058

‎docs/dictionary/command/revMoveToLastRecord.lcdoc‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ Type: command
55
Syntax: revMoveToLastRecord <recordSetID>
66

77
Summary:
8-
Moves to the last <record> of a <record set (database
9-
cursor)(glossary)>.
8+
Moves to the last <record> of a <record set (glossary)>.
109

1110
Associations: database library
1211

@@ -53,7 +52,7 @@ revdb_movefirst (function), revdb_moveprev (function),
5352
revdb_movelast (function), revDatabaseColumnNumbered (function),
5453
revdb_movenext (function), LiveCode custom library (glossary),
5554
Standalone Application Settings (glossary), record (glossary),
56-
command (glossary), record set (database cursor) (glossary),
55+
command (glossary), record set (glossary),
5756
standalone application (glossary), database (glossary), string (keyword),
5857
Database library (library)
5958

‎docs/dictionary/command/revMoveToNextRecord.lcdoc‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ Type: command
55
Syntax: revMoveToNextRecord <recordSetID>
66

77
Summary:
8-
Moves to the next <record> in a <record set (database
9-
cursor)(glossary)>.
8+
Moves to the next <record> in a <record set (glossary)>.
109

1110
Associations: database library
1211

@@ -60,8 +59,7 @@ revQueryIsAtEnd (function), revdb_moveprev (function),
6059
revCurrentRecord (function), revCurrentRecordIsLast (function),
6160
revNumberOfRecords (function), revDatabaseColumnNumbered (function),
6261
revdb_movenext (function), Standalone Application Settings (glossary),
63-
record (glossary), command (glossary),
64-
record set (database cursor) (glossary),
62+
record (glossary), command (glossary), record set (glossary),
6563
standalone application (glossary), database (glossary),
6664
LiveCode custom library (glossary), Database library (library)
6765

0 commit comments

Comments
 (0)