1
0
Fork 0
mirror of https://github.com/deltachat/deltachat-core.git synced 2025-10-04 18:29:19 +02:00
deltachat-core/docs/html/mrarray_8h_source.html
B. Petersen 2dd616d1e7 doxygen
2018-01-08 21:48:17 +01:00

107 lines
16 KiB
HTML

<!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.11"/>
<title>Delta Chat Core C-API: /home/bpetersen/projects/deltachat-core/src/mrarray.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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="user.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">Delta Chat Core C-API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">mrarray.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*******************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Delta Chat Core</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Copyright (C) 2017 Björn Petersen</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Contact: r10s@b44t.com, http://b44t.com</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * This program is free software: you can redistribute it and/or modify it under</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * the terms of the GNU General Public License as published by the Free Software</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * Foundation, either version 3 of the License, or (at your option) any later</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * version.</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * This program is distributed in the hope that it will be useful, but WITHOUT</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * details.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * You should have received a copy of the GNU General Public License along with</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> * this program. If not, see http://www.gnu.org/licenses/ .</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"> ******************************************************************************/</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#ifndef __MRARRAY_H__</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#define __MRARRAY_H__</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>_mrmailbox <a class="code" href="classmrmailbox__t.html">mrmailbox_t</a>;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>_mrarray <a class="code" href="classmrarray__t.html">mrarray_t</a>;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;<a class="code" href="classmrarray__t.html">mrarray_t</a>* mrarray_new (<a class="code" href="classmrmailbox__t.html">mrmailbox_t</a>*, <span class="keywordtype">size_t</span> initsize);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="keywordtype">void</span> mrarray_empty (<a class="code" href="classmrarray__t.html">mrarray_t</a>*);</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="keywordtype">void</span> <a class="code" href="classmrarray__t.html#a1400b5e42c682326e809723f02739a8e">mrarray_unref</a> (<a class="code" href="classmrarray__t.html">mrarray_t</a>*);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;<span class="keywordtype">void</span> mrarray_add_uint (<a class="code" href="classmrarray__t.html">mrarray_t</a>*, uintptr_t);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;<span class="keywordtype">void</span> mrarray_add_id (<a class="code" href="classmrarray__t.html">mrarray_t</a>*, uint32_t);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;<span class="keywordtype">void</span> mrarray_add_ptr (<a class="code" href="classmrarray__t.html">mrarray_t</a>*, <span class="keywordtype">void</span>*);</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;<span class="keywordtype">size_t</span> <a class="code" href="classmrarray__t.html#a73f6d954ed1b97bbceb3cf7d8e1aeec8">mrarray_get_cnt</a> (<a class="code" href="classmrarray__t.html">mrarray_t</a>*);</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;uintptr_t <a class="code" href="classmrarray__t.html#a32e441acbb4de2f4afba7bc2712293e0">mrarray_get_uint</a> (<a class="code" href="classmrarray__t.html">mrarray_t</a>*, <span class="keywordtype">size_t</span> index);</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;uint32_t <a class="code" href="classmrarray__t.html#a40b1e875ba256b6ccbbe65f58bbc01ec">mrarray_get_id</a> (<a class="code" href="classmrarray__t.html">mrarray_t</a>*, <span class="keywordtype">size_t</span> index);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;<span class="keywordtype">void</span>* <a class="code" href="classmrarray__t.html#a24637c94b99b8aaa0b7608dca9e4996b">mrarray_get_ptr</a> (<a class="code" href="classmrarray__t.html">mrarray_t</a>*, <span class="keywordtype">size_t</span> index);</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;<span class="keywordtype">int</span> mrarray_search_id (<a class="code" href="classmrarray__t.html">mrarray_t</a>*, uint32_t needle, <span class="keywordtype">size_t</span>* indx);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;<span class="keyword">const</span> uintptr_t* mrarray_get_raw (<a class="code" href="classmrarray__t.html">mrarray_t</a>*);</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;} <span class="comment">/* /extern &quot;C&quot; */</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* __MRARRAY_H__ */</span><span class="preprocessor"></span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;</div><div class="ttc" id="classmrarray__t_html"><div class="ttname"><a href="classmrarray__t.html">mrarray_t</a></div><div class="ttdoc">An object containing a simple array. </div></div>
<div class="ttc" id="classmrarray__t_html_a32e441acbb4de2f4afba7bc2712293e0"><div class="ttname"><a href="classmrarray__t.html#a32e441acbb4de2f4afba7bc2712293e0">mrarray_t::mrarray_get_uint</a></div><div class="ttdeci">uintptr_t mrarray_get_uint(mrarray_t *array, size_t index)</div><div class="ttdoc">Get the item at the given index as an unsigned integer. </div><div class="ttdef"><b>Definition:</b> mrarray.c:195</div></div>
<div class="ttc" id="classmrmailbox__t_html"><div class="ttname"><a href="classmrmailbox__t.html">mrmailbox_t</a></div><div class="ttdoc">An object representing a single mailbox. </div></div>
<div class="ttc" id="classmrarray__t_html_a24637c94b99b8aaa0b7608dca9e4996b"><div class="ttname"><a href="classmrarray__t.html#a24637c94b99b8aaa0b7608dca9e4996b">mrarray_t::mrarray_get_ptr</a></div><div class="ttdeci">void * mrarray_get_ptr(mrarray_t *array, size_t index)</div><div class="ttdoc">Get the item at the given index as an ID. </div><div class="ttdef"><b>Definition:</b> mrarray.c:235</div></div>
<div class="ttc" id="classmrarray__t_html_a73f6d954ed1b97bbceb3cf7d8e1aeec8"><div class="ttname"><a href="classmrarray__t.html#a73f6d954ed1b97bbceb3cf7d8e1aeec8">mrarray_t::mrarray_get_cnt</a></div><div class="ttdeci">size_t mrarray_get_cnt(mrarray_t *array)</div><div class="ttdoc">Find out the number of items in an array. </div><div class="ttdef"><b>Definition:</b> mrarray.c:174</div></div>
<div class="ttc" id="classmrarray__t_html_a40b1e875ba256b6ccbbe65f58bbc01ec"><div class="ttname"><a href="classmrarray__t.html#a40b1e875ba256b6ccbbe65f58bbc01ec">mrarray_t::mrarray_get_id</a></div><div class="ttdeci">uint32_t mrarray_get_id(mrarray_t *array, size_t index)</div><div class="ttdoc">Get the item at the given index as an ID. </div><div class="ttdef"><b>Definition:</b> mrarray.c:215</div></div>
<div class="ttc" id="classmrarray__t_html_a1400b5e42c682326e809723f02739a8e"><div class="ttname"><a href="classmrarray__t.html#a1400b5e42c682326e809723f02739a8e">mrarray_t::mrarray_unref</a></div><div class="ttdeci">void mrarray_unref(mrarray_t *array)</div><div class="ttdoc">Free an array object. </div><div class="ttdef"><b>Definition:</b> mrarray.c:71</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>