--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Documentation/Source/Tools.html Tue Oct 15 22:03:54 2013 +0200 @@ -0,0 +1,150 @@ +<!DOCTYPE html> +<html><head> +<title>Tools</title> +<meta charset="UTF-8"> +<style> +body { + background: #EDECE6; + margin: 0em 1em 10em 1em; + color: black; +} + +h1 { color: white; background: #85774A; } +h2 { color: white; background: #85774A; } +h3 { color: white; background: #9D936E; } +h4 { color: white; background: #9D936E; } + +a { color: #BA6D36; } + +</style> +</head> +<body><a NAME="top" ID="top"></a> +<h1>Tools</h1> +<p> +Module implementing tool functions. +</p> +<h3>Global Attributes</h3> +<table> +<tr><td>coding_regexps</td></tr> +</table> +<h3>Classes</h3> +<table> +<tr><td>None</td></tr> +</table> +<h3>Functions</h3> +<table> +<tr> +<td><a href="#decode">decode</a></td> +<td>Function to decode a text.</td> +</tr><tr> +<td><a href="#extractLineFlags">extractLineFlags</a></td> +<td>Function to extract flags starting and ending with '__' from a line comment.</td> +</tr><tr> +<td><a href="#get_coding">get_coding</a></td> +<td>Function to get the coding of a text.</td> +</tr><tr> +<td><a href="#normalizeCode">normalizeCode</a></td> +<td>Function to normalize the given code.</td> +</tr><tr> +<td><a href="#readEncodedFile">readEncodedFile</a></td> +<td>Function to read a file and decode its contents into proper text.</td> +</tr> +</table> +<hr /><hr /> +<a NAME="decode" ID="decode"></a> +<h2>decode</h2> +<b>decode</b>(<i>text</i>) +<p> + Function to decode a text. +</p><dl> +<dt><i>text</i></dt> +<dd> +text to decode (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +decoded text and encoding +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="extractLineFlags" ID="extractLineFlags"></a> +<h2>extractLineFlags</h2> +<b>extractLineFlags</b>(<i>line, startComment="</i>) +<p> + Function to extract flags starting and ending with '__' from a line comment. +</p><dl> +<dt><i>line</i></dt> +<dd> +line to extract flags from (string) +</dd><dt><i>startComment=</i></dt> +<dd> +string identifying the start of the comment (string) +</dd><dt><i>endComment=</i></dt> +<dd> +string identifying the end of a comment (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +list containing the extracted flags (list of strings) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="get_coding" ID="get_coding"></a> +<h2>get_coding</h2> +<b>get_coding</b>(<i>text</i>) +<p> + Function to get the coding of a text. +</p><dl> +<dt><i>text</i></dt> +<dd> +text to inspect (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +coding string +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="normalizeCode" ID="normalizeCode"></a> +<h2>normalizeCode</h2> +<b>normalizeCode</b>(<i>codestring</i>) +<p> + Function to normalize the given code. +</p><dl> +<dt><i>codestring</i></dt> +<dd> +code to be normalized (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +normalized code (string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /><hr /> +<a NAME="readEncodedFile" ID="readEncodedFile"></a> +<h2>readEncodedFile</h2> +<b>readEncodedFile</b>(<i>filename</i>) +<p> + Function to read a file and decode its contents into proper text. +</p><dl> +<dt><i>filename</i></dt> +<dd> +name of the file to read (string) +</dd> +</dl><dl> +<dt>Returns:</dt> +<dd> +tuple of decoded text and encoding (string, string) +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file