Author: pekka.klarck Date: Mon Apr 13 11:21:53 2009 New Revision: 1795
Modified: trunk/doc/libraries/BuiltIn.html trunk/doc/libraries/String.html Log: regen Modified: trunk/doc/libraries/BuiltIn.html ============================================================================== --- trunk/doc/libraries/BuiltIn.html (original) +++ trunk/doc/libraries/BuiltIn.html Mon Apr 13 11:21:53 2009 @@ -102,7 +102,7 @@<a href="#Get Count" title="Returns and logs how many times `item2` is found from `item1`.">Get Count</a> <a href="#Get Length" title="Returns and logs the length of the given item.">Get Length</a> <a href="#Get Time" title="Returns the current time in the requested format.">Get Time</a> -<a href="#Grep" title="Returns the text grepped using `pattern`.">Grep</a> +<a href="#Grep" title="*DEPRECATED* Use `Get Lines Matching XXX` keywords from `String` library instead. This keyword will be removed in Robot Framework 2.2.">Grep</a> <a href="#Import Library" title="Imports a library with the given name and optional arguments.">Import Library</a> <a href="#Import Variables" title="Imports a variable file with the given path and optional arguments.">Import Variables</a> <a href="#Length Should Be" title="Verifies that the length of the given item is correct.">Length Should Be</a>
@@ -465,37 +465,7 @@ <tr> <td class="kw"><a name="Grep"></a>Grep</td> <td class="arg">text, pattern, pattern_type=literal string</td>- <td class="doc">Returns the text grepped using <span class="name">pattern</span>.<br />
-<br />-<span class="name">pattern_type</span> defines how the given pattern is interpreted as explained below. <span class="name">pattern_type</span> argument is case-insensitive and may contain other text. For example, 'regexp', 'REGEXP' and 'Pattern is a regexp' are all considered equal.<br />
-<br />-1) If <span class="name">pattern_type</span> contains either the strings 'simple' or 'glob', the <span class="name">pattern</span> is considered a simple glob pattern where:<br />
-<table border="1" class="doc"> -<tr> -<td>*</td> -<td>matches everything</td> -</tr> -<tr> -<td>?</td> -<td>matches any single character</td> -</tr> -<tr> -<td>[chars]</td>-<td>matches any character inside square brackets (e.g. '[abc]' matches either 'a', 'b' or 'c')</td>
-</tr> -<tr> -<td>[!chars]</td> -<td>matches any character not inside square brackets</td> -</tr> -</table> -<br />-2) If <span class="name">pattern_type</span> contains either 'simple' or 'glob', and additionally contains 'case-insensitive' or 'case insensitive', the glob pattern is considered case-insensitive. This functionality is available in 2.0.2 version and newer.<br />
-<br />-3) If <span class="name">pattern_type</span> contains either the string 'regular expression' or 'regexp', the <span class="name">pattern</span> is considered a regular expression. See <a href="#Should Match Regexp" class="name">Should Match Regexp</a> for more information about using regular expressions.<br />
-<br />-4) If <span class="name">pattern_type</span> contains either 'case-insensitive' or 'case insensitive' (but does not contain 'simple' or 'glob'), <span class="name">pattern</span> is considered a literal string and lines returned, if they contain the string, regardless of the case.<br />
-<br />-5) Otherwise the pattern is considered a literal string and lines returned, if they contain the string.</td> + <td class="doc"><b>DEPRECATED</b> Use <span class="name">Get Lines Matching XXX</span> keywords from <span class="name">String</span> library instead. This keyword will be removed in Robot Framework 2.2.</td>
</tr> <tr> <td class="kw"><a name="Import Library"></a>Import Library</td> @@ -1471,7 +1441,7 @@ <p class="footer"> Altogether 72 keywords.<br />Generated by <a href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool";>libdoc.py</a>
-on 2009-04-13 00:38:35. +on 2009-04-13 21:17:58. </p> </body> </html> Modified: trunk/doc/libraries/String.html ============================================================================== --- trunk/doc/libraries/String.html (original) +++ trunk/doc/libraries/String.html Mon Apr 13 11:21:53 2009 @@ -106,6 +106,9 @@<a href="#Get Columns" title="Takes `string`, splits into columns using delimiter.">Get Columns</a> <a href="#Get Line" title="From given `string`, extracts line with given `number`.">Get Line</a> <a href="#Get Line Count" title="Returns the number of lines.">Get Line Count</a> +<a href="#Get Lines Containing String" title="Returns lines of the given `string` that contain the `pattern`.">Get Lines Containing String</a> +<a href="#Get Lines Matching Pattern" title="Returns lines of the given `string` that match the `pattern`.">Get Lines Matching Pattern</a> +<a href="#Get Lines Matching Regexp" title="Returns lines of the given `string` that match the regexp `pattern`.">Get Lines Matching Regexp</a> <a href="#Get Substring" title="Returns a substring from `start` index to `end` index.">Get Substring</a> <a href="#Replace String" title="Replaces `search_for` in `string` with `replace_with`.">Replace String</a> <a href="#Replace String With Regexp" title="Replaces matches with `pattern` in `string` with `replace_with`.">Replace String With Regexp</a>
@@ -175,6 +178,91 @@ <td class="doc">Returns the number of lines.</td> </tr> <tr>+ <td class="kw"><a name="Get Lines Containing String"></a>Get Lines Containing String</td>
+ <td class="arg">string, pattern, case_insensitive=False</td>+ <td class="doc">Returns lines of the given <span class="name">string</span> that contain the <span class="name">pattern</span>.<br />
+<br />+The <span class="name">pattern</span> is always considered to be a normal string and a line matches if the <span class="name">pattern</span> is found anywhere in it. By default the match is case-sensitive, but setting <span class="name">case_insensitive</span> to any value makes it case-insensitive.<br />
+<br />+Lines are returned as one string catenated back together with newlines. Possible trailing newline is never returned. The number of matching lines is automatically logged.<br />
+<br />
+Examples:<br />
+<table border="1" class="doc">
+<tr>
+<td>${lines} =</td>
+<td>Get Lines Containing String</td>
+<td>${result}</td>
+<td>An example</td>
+<td></td>
+</tr>
+<tr>
+<td>${ret} =</td>
+<td>Get Lines Containing String</td>
+<td>${ret}</td>
+<td>FAIL</td>
+<td>case-insensitive</td>
+</tr>
+</table>
+<br />
+See <a href="#Get Lines Matching Pattern" class="name">Get Lines Matching
Pattern</a> and <a href="#Get Lines Matching Regexp" class="name">Get Lines
Matching Regexp</a> if you need more complex pattern matching.</td>
+</tr> +<tr>+ <td class="kw"><a name="Get Lines Matching Pattern"></a>Get Lines Matching Pattern</td>
+ <td class="arg">string, pattern, case_insensitive=False</td>+ <td class="doc">Returns lines of the given <span class="name">string</span> that match the <span class="name">pattern</span>.<br />
+<br />+The <span class="name">pattern</span> is a <i>glob pattern</i> where <i>*</i> and <i>?</i> can be used as wildcards so that the former matches anything and the latter any single character. A line matches only if it matches the <span class="name">pattern</span> fully. By default the match is case-sensitive, but setting <span class="name">case_insensitive</span> to any value makes it case-insensitive.<br />
+<br />+Lines are returned as one string catenated back together with newlines. Possible trailing newline is never returned.The number of matching lines is automatically logged.<br />
+<br />
+Examples:<br />
+<table border="1" class="doc">
+<tr>
+<td>${lines} =</td>
+<td>Get Lines Matching Pattern</td>
+<td>${result}</td>
+<td>Wild???? example</td>
+<td></td>
+</tr>
+<tr>
+<td>${ret} =</td>
+<td>Get Lines Matching Pattern</td>
+<td>${ret}</td>
+<td>FAIL: *</td>
+<td>case-insensitive</td>
+</tr>
+</table>
+<br />
+See <a href="#Get Lines Matching Regexp" class="name">Get Lines Matching
Regexp</a> if you need more complex patterns and <a href="#Get Lines
Containing String" class="name">Get Lines Containing String</a> if
searching literal strings is enough.</td>
+</tr> +<tr>+ <td class="kw"><a name="Get Lines Matching Regexp"></a>Get Lines Matching Regexp</td>
+ <td class="arg">string, pattern</td>+ <td class="doc">Returns lines of the given <span class="name">string</span> that match the regexp <span class="name">pattern</span>.<br />
+<br />+See <span class="name">BuiltIn.Should Match Regexp</span> for more information about Python regular expression syntax in general and how to use it in Robot Framework test data in particular. A line matches only if it matches the <span class="name">pattern</span> fully. Notice that to make the match case-insensitive, you need to embed case-insensitive flag into the pattern.<br />
+<br />+Lines are returned as one string catenated back together with newlines. Possible trailing newline is never returned. The number of matching lines is automatically logged.<br />
+<br />
+Examples:<br />
+<table border="1" class="doc">
+<tr>
+<td>${lines} =</td>
+<td>Get Lines Matching Regexp</td>
+<td>${result}</td>
+<td>Reg\\w{3} example</td>
+</tr>
+<tr>
+<td>${ret} =</td>
+<td>Get Lines Matching Pattern</td>
+<td>${ret}</td>
+<td>(?i)FAIL: .*</td>
+</tr>
+</table>
+<br />
+See <a href="#Get Lines Matching Pattern" class="name">Get Lines Matching
Pattern</a> and <a href="#Get Lines Containing String" class="name">Get
Lines Containing String</a> if you do not need full regular expression
powers.</td>
+</tr> +<tr> <td class="kw"><a name="Get Substring"></a>Get Substring</td> <td class="arg">string, start, end=None</td><td class="doc">Returns a substring from <span class="name">start</span> index to <span class="name">end</span> index.<br />
@@ -284,9 +372,9 @@ </tr> </table> <p class="footer"> -Altogether 14 keywords.<br /> +Altogether 17 keywords.<br />Generated by <a href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool";>libdoc.py</a>
-on 2009-04-13 00:38:36. +on 2009-04-13 21:20:58. </p> </body> </html>
