forked from dail8859/LuaScript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMatch.html
More file actions
253 lines (185 loc) · 6.19 KB
/
Copy pathMatch.html
File metadata and controls
253 lines (185 loc) · 6.19 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>LuaScript Reference</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>LuaScript <sub>v0.12</sub></h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Fields">Fields</a></li>
<li><a href="#Methods">Methods</a></li>
<li><a href="#Metamethods">Metamethods</a></li>
</ul>
<h2>Classes</h2>
<ul class="nowrap">
<li><a href="../classes/Editor.html">Editor</a></li>
<li><strong>Match</strong></li>
<li><a href="../classes/Styler.html">Styler</a></li>
<li><a href="../classes/Notepad.html">Notepad</a></li>
</ul>
<h2>Topics</h2>
<ul class="">
<li><a href="../topics/callbacks.md.html">Callbacks</a></li>
<li><a href="../topics/externalpluginsupport.md.html">External Plugin Support</a></li>
</ul>
<h2>Examples</h2>
<ul class="nowrap">
<li><a href="../examples/bookmark.lua.html">bookmark.lua</a></li>
<li><a href="../examples/highlightoccurrences.lua.html">highlightoccurrences.lua</a></li>
<li><a href="../examples/luaautoindent.lua.html">luaautoindent.lua</a></li>
<li><a href="../examples/luasyntaxchecker.lua.html">luasyntaxchecker.lua</a></li>
<li><a href="../examples/randomizelines.lua.html">randomizelines.lua</a></li>
<li><a href="../examples/selectionaddnext.lua.html">selectionaddnext.lua</a></li>
<li><a href="../examples/sessionmanager.lua.html">sessionmanager.lua</a></li>
<li><a href="../examples/stylecsv.lua.html">stylecsv.lua</a></li>
<li><a href="../examples/stylecustom.lua.html">stylecustom.lua</a></li>
<li><a href="../examples/visualstudiolinecopy.lua.html">visualstudiolinecopy.lua</a></li>
</ul>
</div>
<div id="content">
<h1>Class <code>Match</code></h1>
<p>Used for searching and replacing text.</p>
<p> A match generator is returned from <a href="../classes/Editor.html#Editor:match">Editor:match</a> which can
be used to iterate search results. While looping through matches, if the document is modified by any
method other than the match object's replace method, this may cause the match generator to lose its
place. Also, do not attempt to store the match object for later access outside the loop; it will not
be usable.
</p>
<h3>See also:</h3>
<ul>
<a href="../classes/Editor.html#Editor:match">Editor:match</a>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">for m in editor:match("teh") do
m:replace("the")
end
</pre>
</ul>
<h2><a href="#Fields">Fields</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Match.pos">Match.pos</a></td>
<td class="summary">Beginning position of the located match.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Match.len">Match.len</a></td>
<td class="summary">Length of text matched.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Match.text">Match.text</a></td>
<td class="summary">The actual text matched.</td>
</tr>
</table>
<h2><a href="#Methods">Methods</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Match:replace">Match:replace(text)</a></td>
<td class="summary">Replaces the matched text.</td>
</tr>
</table>
<h2><a href="#Metamethods">Metamethods</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#Match:__tostring">Match:__tostring()</a></td>
<td class="summary">String representation of the match.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Fields"></a>Fields</h2>
<dl class="function">
<dt>
<a name = "Match.pos"></a>
<strong>Match.pos</strong>
</dt>
<dd>
Beginning position of the located match.
<ul>
<li><span class="parameter">pos</span>
<span class="types"><span class="type">int</span></span>
(<em>readonly</em>)
</li>
</ul>
</dd>
<dt>
<a name = "Match.len"></a>
<strong>Match.len</strong>
</dt>
<dd>
Length of text matched.
<ul>
<li><span class="parameter">len</span>
<span class="types"><span class="type">int</span></span>
(<em>readonly</em>)
</li>
</ul>
</dd>
<dt>
<a name = "Match.text"></a>
<strong>Match.text</strong>
</dt>
<dd>
The actual text matched.
<ul>
<li><span class="parameter">text</span>
<span class="types"><span class="type">string</span></span>
(<em>readonly</em>)
</li>
</ul>
</dd>
</dl>
<h2 class="section-header "><a name="Methods"></a>Methods</h2>
<dl class="function">
<dt>
<a name = "Match:replace"></a>
<strong>Match:replace(text)</strong>
</dt>
<dd>
Replaces the matched text.
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">text</span>
<span class="types"><span class="type">string</span></span>
replacement text
</li>
</ul>
</dd>
</dl>
<h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
<dl class="function">
<dt>
<a name = "Match:__tostring"></a>
<strong>Match:__tostring()</strong>
</dt>
<dd>
String representation of the match.
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
<footer>
<a href="https://github.com/dail8859/LuaScript"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/a6677b08c955af8400f44c6298f40e7d19cc5b2d/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f677261795f3664366436642e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png"></a>
</footer>
</body>
</html>