225 lines
37 KiB
HTML
225 lines
37 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.9.1"/>
|
|
<title>discoverpixy: common/filesystem/filesystem.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" />
|
|
</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 style="padding-left: 0.5em;">
|
|
<div id="projectname">discoverpixy
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.9.1 -->
|
|
<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 Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</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 List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</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_bdd9a5d540de89e9fe90efdfc6973a4f.html">common</a></li><li class="navelem"><a class="el" href="dir_0a50ab14f1d261d61cd33403a26c32cc.html">filesystem</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">filesystem.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="filesystem_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**************************************************************************************************************************************</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">* Project: discoverpixy</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">* Website: https://github.com/t-moe/discoverpixy</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">* Authors: Aaron Schmocker, Timo Lang</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">* Institution: BFH Bern University of Applied Sciences</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">* File: common/filesystem/filesystem.h</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">*</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">* Version History:</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">* Date Autor Email SHA Changes</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">* 2015-04-03 timolang@gmail.com 51089aa Refactored Project Structure for use with emulator</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">* 2015-05-10 timolang@gmail.com e2bce8f Added filesystem module, tests and implementation for it in emulator.</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">* 2015-05-15 timolang@gmail.com 9a16865 Added doxgen comments to filesyste, checkbox, numupdown and screen module. And some minor changes to the other modules.</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">*</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">**************************************************************************************************************************************/</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#ifndef FILESYSTEM_H</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#define FILESYSTEM_H</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <stdbool.h></span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <stdint.h></span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="group__filesystem.html#ga07e357318d9528f9d2df7e5c86c81a3b"> 32</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3ba56340dd998fe228468cb60406dc3f5df"> 33</a></span>  <a class="code" href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3ba56340dd998fe228468cb60406dc3f5df">F_RDO</a> = 0x01, </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3baa87f9e9b73e66d81563fe63aba76cc7d"> 34</a></span>  <a class="code" href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3baa87f9e9b73e66d81563fe63aba76cc7d">F_HID</a> = 0x02, </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3ba4a52b8103f1c46e28720230e62cc18f0"> 35</a></span>  <a class="code" href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3ba4a52b8103f1c46e28720230e62cc18f0">F_SYS</a> = 0x04, </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3ba9d0e592d6c03a8ea881767c87935c790"> 36</a></span>  <a class="code" href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3ba9d0e592d6c03a8ea881767c87935c790">F_DIR</a> = 0x10, </div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3ba68f4a0b4d65d116a6fe51978a608b79a"> 37</a></span>  <a class="code" href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3ba68f4a0b4d65d116a6fe51978a608b79a">F_ARC</a> = 0x20 </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> } <a class="code" href="group__filesystem.html#ga07e357318d9528f9d2df7e5c86c81a3b">FILE_ATTRIBUTES</a>;</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="struct_f_i_l_e___d_a_t_e___s_t_r_u_c_t.html"> 43</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="struct_f_i_l_e___d_a_t_e___s_t_r_u_c_t.html#a2a7fd6ec9f3bf84d7c564990dcf0bfb8"> 44</a></span>  <span class="keywordtype">unsigned</span> year : 7; </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="struct_f_i_l_e___d_a_t_e___s_t_r_u_c_t.html#a1f902d56334cc3e0a86d4b08f34bfff6"> 45</a></span>  <span class="keywordtype">unsigned</span> month: 4; </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="struct_f_i_l_e___d_a_t_e___s_t_r_u_c_t.html#a2ce67e633b6747257e9cfc74288fcc31"> 46</a></span>  <span class="keywordtype">unsigned</span> day: 5; </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> } <a class="code" href="struct_f_i_l_e___d_a_t_e___s_t_r_u_c_t.html">FILE_DATE_STRUCT</a>;</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="struct_f_i_l_e___t_i_m_e___s_t_r_u_c_t.html"> 52</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="struct_f_i_l_e___t_i_m_e___s_t_r_u_c_t.html#a7f39b6fc12f0b04a38625ff3040dd30c"> 53</a></span>  <span class="keywordtype">unsigned</span> hour : 5; </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="struct_f_i_l_e___t_i_m_e___s_t_r_u_c_t.html#a3e054086f983d0603a8919338354951b"> 54</a></span>  <span class="keywordtype">unsigned</span> min: 6; </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="struct_f_i_l_e___t_i_m_e___s_t_r_u_c_t.html#a1bcccadb3a5a1a832dfe835818015058"> 55</a></span>  <span class="keywordtype">unsigned</span> sec: 5; </div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> } <a class="code" href="struct_f_i_l_e___t_i_m_e___s_t_r_u_c_t.html">FILE_TIME_STRUCT</a>;</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="struct_f_i_l_e___s_t_r_u_c_t.html"> 61</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="struct_f_i_l_e___s_t_r_u_c_t.html#aa5092484dbc5fc29a229feee0eae1246"> 62</a></span>  uint32_t <a class="code" href="struct_f_i_l_e___s_t_r_u_c_t.html#aa5092484dbc5fc29a229feee0eae1246">fsize</a>; </div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="struct_f_i_l_e___s_t_r_u_c_t.html#a87b927c3a2b9093be39307d2f1d47b61"> 63</a></span>  <a class="code" href="struct_f_i_l_e___d_a_t_e___s_t_r_u_c_t.html">FILE_DATE_STRUCT</a> <a class="code" href="struct_f_i_l_e___s_t_r_u_c_t.html#a87b927c3a2b9093be39307d2f1d47b61">fdate</a>; </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="struct_f_i_l_e___s_t_r_u_c_t.html#a708226ca737e39bed0dc978eb31e3730"> 64</a></span>  <a class="code" href="struct_f_i_l_e___t_i_m_e___s_t_r_u_c_t.html">FILE_TIME_STRUCT</a> <a class="code" href="struct_f_i_l_e___s_t_r_u_c_t.html#a708226ca737e39bed0dc978eb31e3730">ftime</a>; </div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="struct_f_i_l_e___s_t_r_u_c_t.html#a3eb7d979a8d987e842e3c06d08b345c0"> 65</a></span>  uint8_t <a class="code" href="struct_f_i_l_e___s_t_r_u_c_t.html#a3eb7d979a8d987e842e3c06d08b345c0">fattrib</a>; </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="struct_f_i_l_e___s_t_r_u_c_t.html#ae96bbe3347b319ee7bdbd1f2e2ba9f5b"> 66</a></span>  <span class="keywordtype">char</span>* <a class="code" href="struct_f_i_l_e___s_t_r_u_c_t.html#ae96bbe3347b319ee7bdbd1f2e2ba9f5b">fname</a>; </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> } <a class="code" href="struct_f_i_l_e___s_t_r_u_c_t.html">FILE_STRUCT</a>;</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html"> 72</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html#a3b02c6de5c049804444a246f7fdf46b4"> 73</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html#a3b02c6de5c049804444a246f7fdf46b4">path</a>; </div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html#a256a3eb1c4d0a61a23ff722736ed18df"> 74</a></span>  uint16_t <a class="code" href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html#a256a3eb1c4d0a61a23ff722736ed18df">num_files</a>; </div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html#a87f6b6d5b8df736e7d52923a19131f86"> 75</a></span>  <a class="code" href="struct_f_i_l_e___s_t_r_u_c_t.html">FILE_STRUCT</a>* <a class="code" href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html#a87f6b6d5b8df736e7d52923a19131f86">files</a>; </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> } <a class="code" href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html">DIRECTORY_STRUCT</a>;</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"><a class="line" href="struct_f_i_l_e___h_a_n_d_l_e.html"> 81</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"><a class="line" href="struct_f_i_l_e___h_a_n_d_l_e.html#a6a2fc0c236288b07ce5bd1335ca89fa2"> 82</a></span>  <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="struct_f_i_l_e___h_a_n_d_l_e.html#a6a2fc0c236288b07ce5bd1335ca89fa2">fname</a>; </div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="struct_f_i_l_e___h_a_n_d_l_e.html#ae776c66ed7fc6d25948f2bb573ca2198"> 83</a></span>  uint32_t <a class="code" href="struct_f_i_l_e___h_a_n_d_l_e.html#ae776c66ed7fc6d25948f2bb573ca2198">fpos</a>; </div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"><a class="line" href="struct_f_i_l_e___h_a_n_d_l_e.html#aa5092484dbc5fc29a229feee0eae1246"> 84</a></span>  uint32_t <a class="code" href="struct_f_i_l_e___h_a_n_d_l_e.html#aa5092484dbc5fc29a229feee0eae1246">fsize</a>; </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> } <a class="code" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a>;</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="group__filesystem.html#gab08f51089a5ddbb470a1a36a9478dda4"> 90</a></span> <span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4ab16a72615f8613168ea14797c243fdfd"> 91</a></span>  <a class="code" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4ab16a72615f8613168ea14797c243fdfd">F_OK</a>, </div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4a176dd2a26df528eae59eaacc6c5c6cdd"> 92</a></span>  <a class="code" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4a176dd2a26df528eae59eaacc6c5c6cdd">F_EOF</a>, </div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4a9400b97001c749e444d41e25dc8ed3f1"> 93</a></span>  <a class="code" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4a9400b97001c749e444d41e25dc8ed3f1">F_EACCESS</a>, </div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4ac13e1c44708fd21c9c5a4cdb8b53b472"> 94</a></span>  <a class="code" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4ac13e1c44708fd21c9c5a4cdb8b53b472">F_INVALIDPARAM</a>,</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4a2c5f1702bc6bd15c92158e47061d945a"> 95</a></span>  <a class="code" href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4a2c5f1702bc6bd15c92158e47061d945a">F_DISKERROR</a> </div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> } <a class="code" href="group__filesystem.html#gab08f51089a5ddbb470a1a36a9478dda4">FILE_STATUS</a>;</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="keywordtype">bool</span> <a class="code" href="group__filesystem.html#ga367ec5e73c77ddf5047d05021cf97a8f">filesystem_init</a>();</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <a class="code" href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html">DIRECTORY_STRUCT</a>* <a class="code" href="group__filesystem.html#ga8b1099cbd3464fbe64f2010f16d87101">filesystem_dir_open</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* path);</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="keywordtype">void</span> <a class="code" href="group__filesystem.html#gab8001e040f37dc57b18e4155532b59ce">filesystem_dir_close</a>(<a class="code" href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html">DIRECTORY_STRUCT</a>* dir);</div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <a class="code" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a>* <a class="code" href="group__filesystem.html#gabd043128e80a4f0573b1360d921b046c">filesystem_file_open</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* filename);</div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="keywordtype">void</span> <a class="code" href="group__filesystem.html#ga0e6cc31bf4c889249e13254306994c2f">filesystem_file_close</a>(<a class="code" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a>* handle);</div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <a class="code" href="group__filesystem.html#gab08f51089a5ddbb470a1a36a9478dda4">FILE_STATUS</a> <a class="code" href="group__filesystem.html#gac447af479c334caa207d6c279571d8a2">filesystem_file_seek</a>(<a class="code" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a>* handle, uint32_t offset);</div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <a class="code" href="group__filesystem.html#gab08f51089a5ddbb470a1a36a9478dda4">FILE_STATUS</a> <a class="code" href="group__filesystem.html#ga9e7f715d0000e7b99e2b4732416a0221">filesystem_file_read</a>(<a class="code" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a>* handle, uint8_t* buf, uint32_t size);</div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <a class="code" href="group__filesystem.html#gab08f51089a5ddbb470a1a36a9478dda4">FILE_STATUS</a> <a class="code" href="group__filesystem.html#gae7124857f3ab32f6032ef129f2a80000">filesystem_file_write</a>(<a class="code" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a>* handle, uint8_t* buf, uint32_t size);</div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> </div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="preprocessor">#endif </span><span class="comment">/* FILESYSTEM_H */</span><span class="preprocessor"></span></div>
|
|
<div class="ttc" id="group__filesystem_html_gac447af479c334caa207d6c279571d8a2"><div class="ttname"><a href="group__filesystem.html#gac447af479c334caa207d6c279571d8a2">filesystem_file_seek</a></div><div class="ttdeci">FILE_STATUS filesystem_file_seek(FILE_HANDLE *handle, uint32_t offset)</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8c_source.html#l00043">filesystem.c:43</a></div></div>
|
|
<div class="ttc" id="struct_f_i_l_e___h_a_n_d_l_e_html_aa5092484dbc5fc29a229feee0eae1246"><div class="ttname"><a href="struct_f_i_l_e___h_a_n_d_l_e.html#aa5092484dbc5fc29a229feee0eae1246">FILE_HANDLE::fsize</a></div><div class="ttdeci">uint32_t fsize</div><div class="ttdoc">The total file size in bytes. </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00084">filesystem.h:84</a></div></div>
|
|
<div class="ttc" id="struct_f_i_l_e___t_i_m_e___s_t_r_u_c_t_html"><div class="ttname"><a href="struct_f_i_l_e___t_i_m_e___s_t_r_u_c_t.html">FILE_TIME_STRUCT</a></div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00052">filesystem.h:52</a></div></div>
|
|
<div class="ttc" id="struct_f_i_l_e___s_t_r_u_c_t_html_a87b927c3a2b9093be39307d2f1d47b61"><div class="ttname"><a href="struct_f_i_l_e___s_t_r_u_c_t.html#a87b927c3a2b9093be39307d2f1d47b61">FILE_STRUCT::fdate</a></div><div class="ttdeci">FILE_DATE_STRUCT fdate</div><div class="ttdoc">Last modified date. </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00063">filesystem.h:63</a></div></div>
|
|
<div class="ttc" id="group__filesystem_html_ggab08f51089a5ddbb470a1a36a9478dda4a176dd2a26df528eae59eaacc6c5c6cdd"><div class="ttname"><a href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4a176dd2a26df528eae59eaacc6c5c6cdd">F_EOF</a></div><div class="ttdoc">The write/read operation tried to write/read past the end of the file. This is not a fatal error...</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00092">filesystem.h:92</a></div></div>
|
|
<div class="ttc" id="struct_f_i_l_e___s_t_r_u_c_t_html_a3eb7d979a8d987e842e3c06d08b345c0"><div class="ttname"><a href="struct_f_i_l_e___s_t_r_u_c_t.html#a3eb7d979a8d987e842e3c06d08b345c0">FILE_STRUCT::fattrib</a></div><div class="ttdeci">uint8_t fattrib</div><div class="ttdoc">File/Directory Attributes. </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00065">filesystem.h:65</a></div></div>
|
|
<div class="ttc" id="group__filesystem_html_ggab08f51089a5ddbb470a1a36a9478dda4ac13e1c44708fd21c9c5a4cdb8b53b472"><div class="ttname"><a href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4ac13e1c44708fd21c9c5a4cdb8b53b472">F_INVALIDPARAM</a></div><div class="ttdoc">You passed invalid parameters to the function. </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00094">filesystem.h:94</a></div></div>
|
|
<div class="ttc" id="struct_f_i_l_e___h_a_n_d_l_e_html"><div class="ttname"><a href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a></div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00081">filesystem.h:81</a></div></div>
|
|
<div class="ttc" id="group__filesystem_html_gabd043128e80a4f0573b1360d921b046c"><div class="ttname"><a href="group__filesystem.html#gabd043128e80a4f0573b1360d921b046c">filesystem_file_open</a></div><div class="ttdeci">FILE_HANDLE * filesystem_file_open(const char *filename)</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8c_source.html#l00033">filesystem.c:33</a></div></div>
|
|
<div class="ttc" id="group__filesystem_html_ga0e6cc31bf4c889249e13254306994c2f"><div class="ttname"><a href="group__filesystem.html#ga0e6cc31bf4c889249e13254306994c2f">filesystem_file_close</a></div><div class="ttdeci">void filesystem_file_close(FILE_HANDLE *handle)</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8c_source.html#l00038">filesystem.c:38</a></div></div>
|
|
<div class="ttc" id="group__filesystem_html_gga07e357318d9528f9d2df7e5c86c81a3ba68f4a0b4d65d116a6fe51978a608b79a"><div class="ttname"><a href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3ba68f4a0b4d65d116a6fe51978a608b79a">F_ARC</a></div><div class="ttdoc">File has the archive flag set (probably unused) </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00037">filesystem.h:37</a></div></div>
|
|
<div class="ttc" id="struct_f_i_l_e___s_t_r_u_c_t_html_ae96bbe3347b319ee7bdbd1f2e2ba9f5b"><div class="ttname"><a href="struct_f_i_l_e___s_t_r_u_c_t.html#ae96bbe3347b319ee7bdbd1f2e2ba9f5b">FILE_STRUCT::fname</a></div><div class="ttdeci">char * fname</div><div class="ttdoc">File/Directory name. </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00066">filesystem.h:66</a></div></div>
|
|
<div class="ttc" id="group__filesystem_html_ggab08f51089a5ddbb470a1a36a9478dda4a2c5f1702bc6bd15c92158e47061d945a"><div class="ttname"><a href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4a2c5f1702bc6bd15c92158e47061d945a">F_DISKERROR</a></div><div class="ttdoc">A lowlevel disk-error occoured. This is a fatal error. </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00095">filesystem.h:95</a></div></div>
|
|
<div class="ttc" id="group__filesystem_html_gga07e357318d9528f9d2df7e5c86c81a3ba4a52b8103f1c46e28720230e62cc18f0"><div class="ttname"><a href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3ba4a52b8103f1c46e28720230e62cc18f0">F_SYS</a></div><div class="ttdoc">File is a system file. </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00035">filesystem.h:35</a></div></div>
|
|
<div class="ttc" id="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t_html_a256a3eb1c4d0a61a23ff722736ed18df"><div class="ttname"><a href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html#a256a3eb1c4d0a61a23ff722736ed18df">DIRECTORY_STRUCT::num_files</a></div><div class="ttdeci">uint16_t num_files</div><div class="ttdoc">Number of files/directories in this directory. </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00074">filesystem.h:74</a></div></div>
|
|
<div class="ttc" id="group__filesystem_html_gae7124857f3ab32f6032ef129f2a80000"><div class="ttname"><a href="group__filesystem.html#gae7124857f3ab32f6032ef129f2a80000">filesystem_file_write</a></div><div class="ttdeci">FILE_STATUS filesystem_file_write(FILE_HANDLE *handle, uint8_t *buf, uint32_t size)</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8c_source.html#l00053">filesystem.c:53</a></div></div>
|
|
<div class="ttc" id="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t_html"><div class="ttname"><a href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html">DIRECTORY_STRUCT</a></div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00072">filesystem.h:72</a></div></div>
|
|
<div class="ttc" id="struct_f_i_l_e___h_a_n_d_l_e_html_ae776c66ed7fc6d25948f2bb573ca2198"><div class="ttname"><a href="struct_f_i_l_e___h_a_n_d_l_e.html#ae776c66ed7fc6d25948f2bb573ca2198">FILE_HANDLE::fpos</a></div><div class="ttdeci">uint32_t fpos</div><div class="ttdoc">The current byte-position in the file. </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00083">filesystem.h:83</a></div></div>
|
|
<div class="ttc" id="group__filesystem_html_gga07e357318d9528f9d2df7e5c86c81a3baa87f9e9b73e66d81563fe63aba76cc7d"><div class="ttname"><a href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3baa87f9e9b73e66d81563fe63aba76cc7d">F_HID</a></div><div class="ttdoc">File is hidden. </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00034">filesystem.h:34</a></div></div>
|
|
<div class="ttc" id="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t_html_a3b02c6de5c049804444a246f7fdf46b4"><div class="ttname"><a href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html#a3b02c6de5c049804444a246f7fdf46b4">DIRECTORY_STRUCT::path</a></div><div class="ttdeci">const char * path</div><div class="ttdoc">Directory path (absolute) </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00073">filesystem.h:73</a></div></div>
|
|
<div class="ttc" id="group__filesystem_html_ggab08f51089a5ddbb470a1a36a9478dda4ab16a72615f8613168ea14797c243fdfd"><div class="ttname"><a href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4ab16a72615f8613168ea14797c243fdfd">F_OK</a></div><div class="ttdoc">Everything ok. </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00091">filesystem.h:91</a></div></div>
|
|
<div class="ttc" id="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t_html_a87f6b6d5b8df736e7d52923a19131f86"><div class="ttname"><a href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html#a87f6b6d5b8df736e7d52923a19131f86">DIRECTORY_STRUCT::files</a></div><div class="ttdeci">FILE_STRUCT * files</div><div class="ttdoc">An array with num_files FILE_STRUCT entries. </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00075">filesystem.h:75</a></div></div>
|
|
<div class="ttc" id="struct_f_i_l_e___s_t_r_u_c_t_html"><div class="ttname"><a href="struct_f_i_l_e___s_t_r_u_c_t.html">FILE_STRUCT</a></div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00061">filesystem.h:61</a></div></div>
|
|
<div class="ttc" id="group__filesystem_html_ga8b1099cbd3464fbe64f2010f16d87101"><div class="ttname"><a href="group__filesystem.html#ga8b1099cbd3464fbe64f2010f16d87101">filesystem_dir_open</a></div><div class="ttdeci">DIRECTORY_STRUCT * filesystem_dir_open(const char *path)</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8c_source.html#l00023">filesystem.c:23</a></div></div>
|
|
<div class="ttc" id="group__filesystem_html_gga07e357318d9528f9d2df7e5c86c81a3ba9d0e592d6c03a8ea881767c87935c790"><div class="ttname"><a href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3ba9d0e592d6c03a8ea881767c87935c790">F_DIR</a></div><div class="ttdoc">It's a directory and not a file. </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00036">filesystem.h:36</a></div></div>
|
|
<div class="ttc" id="group__filesystem_html_ggab08f51089a5ddbb470a1a36a9478dda4a9400b97001c749e444d41e25dc8ed3f1"><div class="ttname"><a href="group__filesystem.html#ggab08f51089a5ddbb470a1a36a9478dda4a9400b97001c749e444d41e25dc8ed3f1">F_EACCESS</a></div><div class="ttdoc">The file can not be read/written due to access problems. This is a fatal error. </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00093">filesystem.h:93</a></div></div>
|
|
<div class="ttc" id="group__filesystem_html_ga367ec5e73c77ddf5047d05021cf97a8f"><div class="ttname"><a href="group__filesystem.html#ga367ec5e73c77ddf5047d05021cf97a8f">filesystem_init</a></div><div class="ttdeci">bool filesystem_init()</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8c_source.html#l00018">filesystem.c:18</a></div></div>
|
|
<div class="ttc" id="group__filesystem_html_ga07e357318d9528f9d2df7e5c86c81a3b"><div class="ttname"><a href="group__filesystem.html#ga07e357318d9528f9d2df7e5c86c81a3b">FILE_ATTRIBUTES</a></div><div class="ttdeci">FILE_ATTRIBUTES</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00032">filesystem.h:32</a></div></div>
|
|
<div class="ttc" id="group__filesystem_html_gga07e357318d9528f9d2df7e5c86c81a3ba56340dd998fe228468cb60406dc3f5df"><div class="ttname"><a href="group__filesystem.html#gga07e357318d9528f9d2df7e5c86c81a3ba56340dd998fe228468cb60406dc3f5df">F_RDO</a></div><div class="ttdoc">File is readonly. You cannot write to it. </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00033">filesystem.h:33</a></div></div>
|
|
<div class="ttc" id="struct_f_i_l_e___d_a_t_e___s_t_r_u_c_t_html"><div class="ttname"><a href="struct_f_i_l_e___d_a_t_e___s_t_r_u_c_t.html">FILE_DATE_STRUCT</a></div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00043">filesystem.h:43</a></div></div>
|
|
<div class="ttc" id="struct_f_i_l_e___h_a_n_d_l_e_html_a6a2fc0c236288b07ce5bd1335ca89fa2"><div class="ttname"><a href="struct_f_i_l_e___h_a_n_d_l_e.html#a6a2fc0c236288b07ce5bd1335ca89fa2">FILE_HANDLE::fname</a></div><div class="ttdeci">const char * fname</div><div class="ttdoc">The absolute file name. </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00082">filesystem.h:82</a></div></div>
|
|
<div class="ttc" id="group__filesystem_html_gab08f51089a5ddbb470a1a36a9478dda4"><div class="ttname"><a href="group__filesystem.html#gab08f51089a5ddbb470a1a36a9478dda4">FILE_STATUS</a></div><div class="ttdeci">FILE_STATUS</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00090">filesystem.h:90</a></div></div>
|
|
<div class="ttc" id="group__filesystem_html_gab8001e040f37dc57b18e4155532b59ce"><div class="ttname"><a href="group__filesystem.html#gab8001e040f37dc57b18e4155532b59ce">filesystem_dir_close</a></div><div class="ttdeci">void filesystem_dir_close(DIRECTORY_STRUCT *dir)</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8c_source.html#l00028">filesystem.c:28</a></div></div>
|
|
<div class="ttc" id="struct_f_i_l_e___s_t_r_u_c_t_html_a708226ca737e39bed0dc978eb31e3730"><div class="ttname"><a href="struct_f_i_l_e___s_t_r_u_c_t.html#a708226ca737e39bed0dc978eb31e3730">FILE_STRUCT::ftime</a></div><div class="ttdeci">FILE_TIME_STRUCT ftime</div><div class="ttdoc">Last modified time. </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00064">filesystem.h:64</a></div></div>
|
|
<div class="ttc" id="group__filesystem_html_ga9e7f715d0000e7b99e2b4732416a0221"><div class="ttname"><a href="group__filesystem.html#ga9e7f715d0000e7b99e2b4732416a0221">filesystem_file_read</a></div><div class="ttdeci">FILE_STATUS filesystem_file_read(FILE_HANDLE *handle, uint8_t *buf, uint32_t size)</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8c_source.html#l00048">filesystem.c:48</a></div></div>
|
|
<div class="ttc" id="struct_f_i_l_e___s_t_r_u_c_t_html_aa5092484dbc5fc29a229feee0eae1246"><div class="ttname"><a href="struct_f_i_l_e___s_t_r_u_c_t.html#aa5092484dbc5fc29a229feee0eae1246">FILE_STRUCT::fsize</a></div><div class="ttdeci">uint32_t fsize</div><div class="ttdoc">File size in bytes. 0 for directories. </div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00062">filesystem.h:62</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Mon Jun 8 2015 11:01:18 for discoverpixy by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.9.1
|
|
</small></address>
|
|
</body>
|
|
</html>
|