diff options
Diffstat (limited to 'docs/namespace_string_tools.html')
| -rw-r--r-- | docs/namespace_string_tools.html | 362 |
1 files changed, 362 insertions, 0 deletions
diff --git a/docs/namespace_string_tools.html b/docs/namespace_string_tools.html new file mode 100644 index 0000000..2a9fdcd --- /dev/null +++ b/docs/namespace_string_tools.html @@ -0,0 +1,362 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>tgbot-cpp: StringTools Namespace Reference</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">tgbot-cpp + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('namespace_string_tools.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">StringTools Namespace Reference<div class="ingroups"><a class="el" href="group__tools.html">Tools</a></div></div> </div> +</div><!--header--> +<div class="contents"> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:a4e79ae0938faa2be79b4004f8d38cc36"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_string_tools.html#a4e79ae0938faa2be79b4004f8d38cc36">startsWith</a> (const std::string &str1, const std::string &str2)</td></tr> +<tr class="separator:a4e79ae0938faa2be79b4004f8d38cc36"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a56ad2f85f783a58212b6d049c2df7c13"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_string_tools.html#a56ad2f85f783a58212b6d049c2df7c13">endsWith</a> (const std::string &str1, const std::string &str2)</td></tr> +<tr class="separator:a56ad2f85f783a58212b6d049c2df7c13"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0136fb0794d49068fd59ee54863feaf0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_string_tools.html#a0136fb0794d49068fd59ee54863feaf0">split</a> (const std::string &str, char delimiter, std::vector< std::string > &dest)</td></tr> +<tr class="separator:a0136fb0794d49068fd59ee54863feaf0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a78a624fa5a1ee47cca1e025c799a26d9"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_string_tools.html#a78a624fa5a1ee47cca1e025c799a26d9">generateRandomString</a> (size_t length)</td></tr> +<tr class="separator:a78a624fa5a1ee47cca1e025c799a26d9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6c54e792856444bd52f5a3f40df376b7"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_string_tools.html#a6c54e792856444bd52f5a3f40df376b7">urlEncode</a> (const std::string &value, const std::string &additionalLegitChars="")</td></tr> +<tr class="separator:a6c54e792856444bd52f5a3f40df376b7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae7831577f52841166e96c93357956369"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_string_tools.html#ae7831577f52841166e96c93357956369">urlDecode</a> (const std::string &value)</td></tr> +<tr class="separator:ae7831577f52841166e96c93357956369"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abca17ac29bcc3e047459f3250497bd26"><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_string_tools.html#abca17ac29bcc3e047459f3250497bd26">split</a> (const std::string &str, char delimiter)</td></tr> +<tr class="separator:abca17ac29bcc3e047459f3250497bd26"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<h2 class="groupheader">Function Documentation</h2> +<a id="a56ad2f85f783a58212b6d049c2df7c13"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a56ad2f85f783a58212b6d049c2df7c13">◆ </a></span>endsWith()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool StringTools::endsWith </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>str1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>str2</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Checks if first string is ending with second string </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">str1</td><td>First string </td></tr> + <tr><td class="paramname">str2</td><td>Second string </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="a78a624fa5a1ee47cca1e025c799a26d9"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a78a624fa5a1ee47cca1e025c799a26d9">◆ </a></span>generateRandomString()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string StringTools::generateRandomString </td> + <td>(</td> + <td class="paramtype">size_t </td> + <td class="paramname"><em>length</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Generates pseudo random string. It's recommended to call srand before this method. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">length</td><td>Length of resulting string. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="a0136fb0794d49068fd59ee54863feaf0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0136fb0794d49068fd59ee54863feaf0">◆ </a></span>split() <span class="overload">[1/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void StringTools::split </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>str</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char </td> + <td class="paramname"><em>delimiter</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::vector< std::string > & </td> + <td class="paramname"><em>dest</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Splits string to smaller substrings which have between them a delimiter. Resulting substrings won't have delimiter. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">str</td><td>Source string </td></tr> + <tr><td class="paramname">delimiter</td><td>Delimiter </td></tr> + <tr><td class="paramname">dest</td><td>Array to which substrings will be saved. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="abca17ac29bcc3e047459f3250497bd26"></a> +<h2 class="memtitle"><span class="permalink"><a href="#abca17ac29bcc3e047459f3250497bd26">◆ </a></span>split() <span class="overload">[2/2]</span></h2> + +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">std::vector<std::string> StringTools::split </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>str</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">char </td> + <td class="paramname"><em>delimiter</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<p>Splits string to smaller substrings which have between them a delimiter. Resulting substrings won't have delimiter. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">str</td><td>Source string </td></tr> + <tr><td class="paramname">delimiter</td><td>Delimiter </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Array of substrings </dd></dl> + +<p class="definition">Definition at line <a class="el" href="_string_tools_8h_source.html#l00084">84</a> of file <a class="el" href="_string_tools_8h_source.html">StringTools.h</a>.</p> + +</div> +</div> +<a id="a4e79ae0938faa2be79b4004f8d38cc36"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4e79ae0938faa2be79b4004f8d38cc36">◆ </a></span>startsWith()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool StringTools::startsWith </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>str1</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>str2</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Checks if first string is starting with second string </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">str1</td><td>First string </td></tr> + <tr><td class="paramname">str2</td><td>Second string </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="ae7831577f52841166e96c93357956369"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae7831577f52841166e96c93357956369">◆ </a></span>urlDecode()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string StringTools::urlDecode </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>value</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Performs url decode. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">value</td><td>Encoded url string </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Decoded url string </dd></dl> + +</div> +</div> +<a id="a6c54e792856444bd52f5a3f40df376b7"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6c54e792856444bd52f5a3f40df376b7">◆ </a></span>urlEncode()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">std::string StringTools::urlEncode </td> + <td>(</td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>value</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const std::string & </td> + <td class="paramname"><em>additionalLegitChars</em> = <code>""</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<p>Performs url encode. </p><dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">value</td><td>Source url string </td></tr> + <tr><td class="paramname">additionalLegitChars</td><td>Optional. String of chars which will be not encoded in source url string. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Encoded url string </dd></dl> + +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="navelem"><a class="el" href="namespace_string_tools.html">StringTools</a></li> + <li class="footer">Generated on Sun Jan 15 2017 02:46:16 for tgbot-cpp by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |