diff options
Added documentation
1 files changed, 133 insertions, 0 deletions
| -rw-r--r-- | docs/html/String_8h_source.html | 133 |
diff --git a/docs/html/String_8h_source.html b/docs/html/String_8h_source.html new file mode 100644 index 0000000..3173b5c --- /dev/null +++ b/docs/html/String_8h_source.html @@ -0,0 +1,133 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/> +<meta name="generator" content="Doxygen 1.9.3"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>FMI Table: src/Generic/String/String.h Source File</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="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 id="projectrow"> + <td id="projectalign"> + <div id="projectname">FMI Table + </div> + <div id="projectbrief">| Kamen Mladenov | FMI Computer Science Year 1 Group 6 | Project 2 | Project Topic 7 |</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.3 --> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +var searchBox = new SearchBox("searchBox", "search",'Search','.html'); +/* @license-end */ +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */ +</script> +<div id="main-nav"></div> +<!-- 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 id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b37d33ceb7f5c107fb027d4db224bc89.html">Generic</a></li><li class="navelem"><a class="el" href="dir_0b7ce500285c8e4ab35041e3e5c42da4.html">String</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"><div class="title">String.h</div></div> +</div><!--header--> +<div class="contents"> +<a href="String_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef HEADER_STRING</span></div> +<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define HEADER_STRING</span></div> +<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div> +<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include <istream></span></div> +<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include <ostream></span></div> +<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div> +<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#define DOUBLE_PRECISION 100</span></div> +<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div> +<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classString.html"> 17</a></span><span class="keyword">class </span><a class="code hl_class" href="classString.html">String</a> {</div> +<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keywordtype">char</span>* str;</div> +<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keywordtype">unsigned</span> length;</div> +<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div> +<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keywordtype">void</span> free();</div> +<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keywordtype">void</span> copyFrom(<span class="keyword">const</span> <a class="code hl_class" href="classString.html">String</a>& other);</div> +<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div> +<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">public</span>:</div> +<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <a class="code hl_class" href="classString.html">String</a>(<span class="keywordtype">unsigned</span> length);</div> +<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_class" href="classString.html">String</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* str);</div> +<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code hl_function" href="classString.html#a3d7f953737f3d4dca72d1cc4836f7dcc">get_cstr</a>() <span class="keyword">const</span>;</div> +<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordtype">unsigned</span> <a class="code hl_function" href="classString.html#a7793a7e9a7601d4c724dcc85566259bf">get_length</a>() <span class="keyword">const</span>;</div> +<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordtype">char</span>& <a class="code hl_function" href="classString.html#a5d3b77a51619a8580a373d2cd1092a54">operator[]</a>(<span class="keywordtype">unsigned</span> index);</div> +<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div> +<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <a class="code hl_class" href="classString.html">String</a>& <a class="code hl_function" href="classString.html#a64de9ab1af5df9397f8fbd8c79d5f4b6">operator+=</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* str);</div> +<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <a class="code hl_class" href="classString.html">String</a>& <a class="code hl_function" href="classString.html#a64de9ab1af5df9397f8fbd8c79d5f4b6">operator+=</a>(<span class="keywordtype">int</span> number);</div> +<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_class" href="classString.html">String</a>& <a class="code hl_function" href="classString.html#a64de9ab1af5df9397f8fbd8c79d5f4b6">operator+=</a>(<span class="keywordtype">unsigned</span> number);</div> +<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <a class="code hl_class" href="classString.html">String</a>& <a class="code hl_function" href="classString.html#a64de9ab1af5df9397f8fbd8c79d5f4b6">operator+=</a>(<span class="keywordtype">double</span> number);</div> +<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div> +<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_class" href="classString.html">String</a>();</div> +<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <a class="code hl_class" href="classString.html">String</a>(<span class="keyword">const</span> <a class="code hl_class" href="classString.html">String</a>& other);</div> +<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <a class="code hl_class" href="classString.html">String</a>& operator=(<span class="keyword">const</span> <a class="code hl_class" href="classString.html">String</a>& other);</div> +<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <a class="code hl_class" href="classString.html">~String</a>();</div> +<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div> +<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <a class="code hl_class" href="classString.html">String</a>(<a class="code hl_class" href="classString.html">String</a>&& other);</div> +<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <a class="code hl_class" href="classString.html">String</a>& operator=(<a class="code hl_class" href="classString.html">String</a>&& other);</div> +<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div> +<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classString.html#ad76bb9eca15651c67332808cdaad6344">read</a>(std::istream& istr);</div> +<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classString.html#a7b0ea809587c21bc1d2b87bfee53e628">write</a>(std::ostream& ostr) <span class="keyword">const</span>;</div> +<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keywordtype">int</span> <a class="code hl_function" href="classString.html#a3f420d69fbe3de91711dc69148d23cc7">compare</a>(<span class="keyword">const</span> <a class="code hl_class" href="classString.html">String</a>& other) <span class="keyword">const</span>;</div> +<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div> +<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">friend</span> std::istream& <a class="code hl_friend" href="classString.html#a145347940875a9da605f74c2138be157">operator>></a>(std::istream& istr, <a class="code hl_class" href="classString.html">String</a>& str);</div> +<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">friend</span> std::ostream& <a class="code hl_friend" href="classString.html#aaf68eeb5ffc0983ecc68d49085e33102">operator<<</a>(std::ostream& ostr, <span class="keyword">const</span> <a class="code hl_class" href="classString.html">String</a>& str);</div> +<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span>};</div> +<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div> +<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="preprocessor">#endif</span></div> +<div class="ttc" id="aclassString_html"><div class="ttname"><a href="classString.html">String</a></div><div class="ttdoc">A dynamically-allocated C-style string with extra features.</div><div class="ttdef"><b>Definition:</b> String.h:17</div></div> +<div class="ttc" id="aclassString_html_a145347940875a9da605f74c2138be157"><div class="ttname"><a href="classString.html#a145347940875a9da605f74c2138be157">String::operator>></a></div><div class="ttdeci">friend std::istream & operator>>(std::istream &istr, String &str)</div><div class="ttdoc">Reads String from stream with >> operator.</div><div class="ttdef"><b>Definition:</b> String.cpp:177</div></div> +<div class="ttc" id="aclassString_html_a3d7f953737f3d4dca72d1cc4836f7dcc"><div class="ttname"><a href="classString.html#a3d7f953737f3d4dca72d1cc4836f7dcc">String::get_cstr</a></div><div class="ttdeci">const char * get_cstr() const</div><div class="ttdoc">Returns internal C-style string.</div><div class="ttdef"><b>Definition:</b> String.cpp:35</div></div> +<div class="ttc" id="aclassString_html_a3f420d69fbe3de91711dc69148d23cc7"><div class="ttname"><a href="classString.html#a3f420d69fbe3de91711dc69148d23cc7">String::compare</a></div><div class="ttdeci">int compare(const String &other) const</div><div class="ttdoc">Compares two strings.</div><div class="ttdef"><b>Definition:</b> String.cpp:167</div></div> +<div class="ttc" id="aclassString_html_a5d3b77a51619a8580a373d2cd1092a54"><div class="ttname"><a href="classString.html#a5d3b77a51619a8580a373d2cd1092a54">String::operator[]</a></div><div class="ttdeci">char & operator[](unsigned index)</div><div class="ttdoc">Returns a character reference (from the underlying C-style string) at the given index.</div><div class="ttdef"><b>Definition:</b> String.cpp:43</div></div> +<div class="ttc" id="aclassString_html_a64de9ab1af5df9397f8fbd8c79d5f4b6"><div class="ttname"><a href="classString.html#a64de9ab1af5df9397f8fbd8c79d5f4b6">String::operator+=</a></div><div class="ttdeci">String & operator+=(const char *str)</div><div class="ttdoc">Appends a C-style string.</div><div class="ttdef"><b>Definition:</b> String.cpp:49</div></div> +<div class="ttc" id="aclassString_html_a7793a7e9a7601d4c724dcc85566259bf"><div class="ttname"><a href="classString.html#a7793a7e9a7601d4c724dcc85566259bf">String::get_length</a></div><div class="ttdeci">unsigned get_length() const</div><div class="ttdoc">Returns number of characters in string.</div><div class="ttdef"><b>Definition:</b> String.cpp:39</div></div> +<div class="ttc" id="aclassString_html_a7b0ea809587c21bc1d2b87bfee53e628"><div class="ttname"><a href="classString.html#a7b0ea809587c21bc1d2b87bfee53e628">String::write</a></div><div class="ttdeci">void write(std::ostream &ostr) const</div><div class="ttdoc">Writes String to stream.</div><div class="ttdef"><b>Definition:</b> String.cpp:159</div></div> +<div class="ttc" id="aclassString_html_aaf68eeb5ffc0983ecc68d49085e33102"><div class="ttname"><a href="classString.html#aaf68eeb5ffc0983ecc68d49085e33102">String::operator<<</a></div><div class="ttdeci">friend std::ostream & operator<<(std::ostream &ostr, const String &str)</div><div class="ttdoc">Writes String to stream with << operator.</div><div class="ttdef"><b>Definition:</b> String.cpp:189</div></div> +<div class="ttc" id="aclassString_html_ad76bb9eca15651c67332808cdaad6344"><div class="ttname"><a href="classString.html#ad76bb9eca15651c67332808cdaad6344">String::read</a></div><div class="ttdeci">void read(std::istream &istr)</div><div class="ttdoc">Reads String from stream.</div><div class="ttdef"><b>Definition:</b> String.cpp:146</div></div> +</div><!-- fragment --></div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 +</small></address> +</body> +</html> |