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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>incron: IncronTabEntry Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>IncronTabEntry Class Reference</h1><!-- doxytag: class="IncronTabEntry" -->Incron table entry class.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="incrontab_8h-source.html">incrontab.h</a>></code>
<p>
<p>
<a href="classIncronTabEntry-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTabEntry.html#3b82e45096543af49e3284fd2e3ebb21">IncronTabEntry</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#3b82e45096543af49e3284fd2e3ebb21"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTabEntry.html#f75a28395d0e8aa1c44107a6785d4019">IncronTabEntry</a> (const std::string &rPath, uint32_t uMask, const std::string &rCmd)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#f75a28395d0e8aa1c44107a6785d4019"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTabEntry.html#e02308fb7784faf554d42fa51063edd3">~IncronTabEntry</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#e02308fb7784faf554d42fa51063edd3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTabEntry.html#62ec7f62ad28b984420dc4c78b204600">ToString</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Converts the entry to string representation. <a href="#62ec7f62ad28b984420dc4c78b204600"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTabEntry.html#f2abda30bace975f720479dc97959d68">GetPath</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the watch filesystem path. <a href="#f2abda30bace975f720479dc97959d68"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTabEntry.html#08dece0f96a74a72233b4287bd131d6d">GetMask</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the event mask. <a href="#08dece0f96a74a72233b4287bd131d6d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTabEntry.html#0ace542d7f8f49a38b2d51e43f27e78e">GetCmd</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the command string. <a href="#0ace542d7f8f49a38b2d51e43f27e78e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTabEntry.html#d4b1ff4fbf637ef58046bad6955dc3ac">IsNoLoop</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks whether this entry has set loop-avoidance. <a href="#d4b1ff4fbf637ef58046bad6955dc3ac"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTabEntry.html#fc6647d1ec6aec2c52ad7488264b961b">Parse</a> (const std::string &rStr, <a class="el" href="classIncronTabEntry.html">IncronTabEntry</a> &rEntry)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses a string and attempts to extract entry parameters. <a href="#fc6647d1ec6aec2c52ad7488264b961b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTabEntry.html#4812bc8f0d5291eacc8e66fda8fe1d13">GetSafePath</a> (const std::string &rPath)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add backslashes before spaces in the source path. <a href="#4812bc8f0d5291eacc8e66fda8fe1d13"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTabEntry.html#836fec204ac70c855f229d011c1e1629">m_path</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">watch path <a href="#836fec204ac70c855f229d011c1e1629"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTabEntry.html#d317024cf370d856765e7a210904d87e">m_uMask</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">event mask <a href="#d317024cf370d856765e7a210904d87e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTabEntry.html#4aeaa40804ebaa78dd84edbce86fdae4">m_cmd</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">command string <a href="#4aeaa40804ebaa78dd84edbce86fdae4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIncronTabEntry.html#91049dc7f267a5613cfcd8c6247c9e4f">m_fNoLoop</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">no loop yes/no <a href="#91049dc7f267a5613cfcd8c6247c9e4f"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Incron table entry class. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="3b82e45096543af49e3284fd2e3ebb21"></a><!-- doxytag: member="IncronTabEntry::IncronTabEntry" ref="3b82e45096543af49e3284fd2e3ebb21" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IncronTabEntry::IncronTabEntry </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
Creates an empty entry for later use with <a class="el" href="classIncronTabEntry.html#fc6647d1ec6aec2c52ad7488264b961b" title="Parses a string and attempts to extract entry parameters.">Parse()</a>.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classIncronTabEntry.html#fc6647d1ec6aec2c52ad7488264b961b" title="Parses a string and attempts to extract entry parameters.">Parse()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="f75a28395d0e8aa1c44107a6785d4019"></a><!-- doxytag: member="IncronTabEntry::IncronTabEntry" ref="f75a28395d0e8aa1c44107a6785d4019" args="(const std::string &rPath, uint32_t uMask, const std::string &rCmd)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IncronTabEntry::IncronTabEntry </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rPath</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"> <em>uMask</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rCmd</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
Creates an entry based on defined parameters.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rPath</em> </td><td>watched filesystem path </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>uMask</em> </td><td>event mask </td></tr>
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rCmd</em> </td><td>command string </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e02308fb7784faf554d42fa51063edd3"></a><!-- doxytag: member="IncronTabEntry::~IncronTabEntry" ref="e02308fb7784faf554d42fa51063edd3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IncronTabEntry::~IncronTabEntry </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="62ec7f62ad28b984420dc4c78b204600"></a><!-- doxytag: member="IncronTabEntry::ToString" ref="62ec7f62ad28b984420dc4c78b204600" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string IncronTabEntry::ToString </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Converts the entry to string representation.
<p>
This method creates a string for use in a table file.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>string representation </dd></dl>
</div>
</div><p>
<a class="anchor" name="fc6647d1ec6aec2c52ad7488264b961b"></a><!-- doxytag: member="IncronTabEntry::Parse" ref="fc6647d1ec6aec2c52ad7488264b961b" args="(const std::string &rStr, IncronTabEntry &rEntry)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool IncronTabEntry::Parse </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rStr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classIncronTabEntry.html">IncronTabEntry</a> & </td>
<td class="paramname"> <em>rEntry</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parses a string and attempts to extract entry parameters.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rStr</em> </td><td>parsed string </td></tr>
<tr><td valign="top"><tt>[out]</tt> </td><td valign="top"><em>rEntry</em> </td><td>parametrized entry </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = success, false = failure </dd></dl>
</div>
</div><p>
<a class="anchor" name="f2abda30bace975f720479dc97959d68"></a><!-- doxytag: member="IncronTabEntry::GetPath" ref="f2abda30bace975f720479dc97959d68" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& IncronTabEntry::GetPath </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the watch filesystem path.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>watch path </dd></dl>
</div>
</div><p>
<a class="anchor" name="08dece0f96a74a72233b4287bd131d6d"></a><!-- doxytag: member="IncronTabEntry::GetMask" ref="08dece0f96a74a72233b4287bd131d6d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t IncronTabEntry::GetMask </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the event mask.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>event mask </dd></dl>
</div>
</div><p>
<a class="anchor" name="0ace542d7f8f49a38b2d51e43f27e78e"></a><!-- doxytag: member="IncronTabEntry::GetCmd" ref="0ace542d7f8f49a38b2d51e43f27e78e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::string& IncronTabEntry::GetCmd </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the command string.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>command string </dd></dl>
</div>
</div><p>
<a class="anchor" name="d4b1ff4fbf637ef58046bad6955dc3ac"></a><!-- doxytag: member="IncronTabEntry::IsNoLoop" ref="d4b1ff4fbf637ef58046bad6955dc3ac" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool IncronTabEntry::IsNoLoop </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks whether this entry has set loop-avoidance.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true = no loop, false = loop allowed </dd></dl>
</div>
</div><p>
<a class="anchor" name="4812bc8f0d5291eacc8e66fda8fe1d13"></a><!-- doxytag: member="IncronTabEntry::GetSafePath" ref="4812bc8f0d5291eacc8e66fda8fe1d13" args="(const std::string &rPath)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string IncronTabEntry::GetSafePath </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>rPath</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add backslashes before spaces in the source path.
<p>
It also adds backslashes before all original backslashes of course.<p>
The source string is not modified and a copy is returned instead.<p>
This method is intended to be used for paths in user tables.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><tt>[in]</tt> </td><td valign="top"><em>rPath</em> </td><td>path to be modified </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>modified path </dd></dl>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="836fec204ac70c855f229d011c1e1629"></a><!-- doxytag: member="IncronTabEntry::m_path" ref="836fec204ac70c855f229d011c1e1629" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="classIncronTabEntry.html#836fec204ac70c855f229d011c1e1629">IncronTabEntry::m_path</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
watch path
<p>
</div>
</div><p>
<a class="anchor" name="d317024cf370d856765e7a210904d87e"></a><!-- doxytag: member="IncronTabEntry::m_uMask" ref="d317024cf370d856765e7a210904d87e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="classIncronTabEntry.html#d317024cf370d856765e7a210904d87e">IncronTabEntry::m_uMask</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
event mask
<p>
</div>
</div><p>
<a class="anchor" name="4aeaa40804ebaa78dd84edbce86fdae4"></a><!-- doxytag: member="IncronTabEntry::m_cmd" ref="4aeaa40804ebaa78dd84edbce86fdae4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="classIncronTabEntry.html#4aeaa40804ebaa78dd84edbce86fdae4">IncronTabEntry::m_cmd</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
command string
<p>
</div>
</div><p>
<a class="anchor" name="91049dc7f267a5613cfcd8c6247c9e4f"></a><!-- doxytag: member="IncronTabEntry::m_fNoLoop" ref="91049dc7f267a5613cfcd8c6247c9e4f" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classIncronTabEntry.html#91049dc7f267a5613cfcd8c6247c9e4f">IncronTabEntry::m_fNoLoop</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
no loop yes/no
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="incrontab_8h-source.html">incrontab.h</a><li><a class="el" href="incrontab_8cpp.html">incrontab.cpp</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Jun 21 22:27:24 2009 for incron by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
|
