-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathSdFile_8h_source.html
146 lines (144 loc) · 14.8 KB
/
SdFile_8h_source.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
<!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=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Prusa3d Marlin fork: SdFile.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Prusa3d Marlin fork
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- 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="headertitle">
<div class="title">SdFile.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="SdFile_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">/* Arduino SdFat Library</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (C) 2009 by William Greiman</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * This file is part of the Arduino SdFat Library</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * This Library is free software: you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * it under the terms of the GNU General Public License as published by</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * the Free Software Foundation, either version 3 of the License, or</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * (at your option) any later version.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * This Library is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * GNU General Public License for more details.</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * You should have received a copy of the GNU General Public License</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * along with the Arduino SdFat Library. If not, see</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * <http://www.gnu.org/licenses/>.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "Marlin.h"</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#ifdef SDSUPPORT</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include "<a class="code" href="SdBaseFile_8h.html">SdBaseFile.h</a>"</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">//#include <Print.h></span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#ifndef SdFile_h</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#define SdFile_h</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classSdFile.html"> 36</a></span> <span class="comment"></span><span class="keyword">class </span><a class="code" href="classSdFile.html">SdFile</a> : <span class="keyword">public</span> <a class="code" href="classSdBaseFile.html">SdBaseFile</a><span class="comment">/*, public Print*/</span> {</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// GCode filtering vars and methods - due to optimization reasons not wrapped in a separate class</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="comment">// beware - this read ptr is manipulated inside just 2 methods - readFilteredGcode and gfReset</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment">// If you even want to call gfReset from readFilteredGcode, you must make sure</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// to update gfReadPtr inside readFilteredGcode from a local copy (see explanation of this trick in readFilteredGcode)</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">const</span> uint8_t *gfReadPtr;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  uint32_t gfBlock; <span class="comment">// remember the current file block to be kept in cache - due to reuse of the memory, the block may fall out a must be read back</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  uint16_t gfOffset;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">const</span> uint8_t *gfBlockBuffBegin()<span class="keyword">const</span>;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keywordtype">void</span> gfReset();</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="keywordtype">bool</span> gfEnsureBlock();</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">bool</span> gfComputeNextFileBlock();</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">void</span> gfUpdateCurrentPosition(uint16_t inc);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="classSdFile.html">SdFile</a>() {}</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <a class="code" href="classSdFile.html">SdFile</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* name, uint8_t oflag);</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor"> #if ARDUINO >= 100</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">size_t</span> <a class="code" href="classSdFile.html#aeb1a0b961c1d1e2f5604c9b3f5aa2fbd">write</a>(uint8_t b);</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor"> #else</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">void</span> <a class="code" href="classSdFile.html#aeb1a0b961c1d1e2f5604c9b3f5aa2fbd">write</a>(uint8_t b);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor"> #endif</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordtype">bool</span> openFilteredGcode(<a class="code" href="classSdBaseFile.html">SdBaseFile</a>* dirFile, <span class="keyword">const</span> <span class="keywordtype">char</span>* path);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  int16_t readFilteredGcode();</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keywordtype">bool</span> seekSetFilteredGcode(uint32_t pos);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  int16_t <a class="code" href="classSdFile.html#aeb1a0b961c1d1e2f5604c9b3f5aa2fbd">write</a>(<span class="keyword">const</span> <span class="keywordtype">void</span>* buf, uint16_t nbyte);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">void</span> <a class="code" href="classSdFile.html#aeb1a0b961c1d1e2f5604c9b3f5aa2fbd">write</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* str);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordtype">void</span> <a class="code" href="classSdFile.html#adaa153fed109a0a03cfd545a259de4fe">write_P</a>(PGM_P str);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordtype">void</span> <a class="code" href="classSdFile.html#ad760d51410f36fd1e1b005a754624954">writeln_P</a>(PGM_P str);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> };</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#endif </span><span class="comment">// SdFile_h</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">#endif</span></div>
<div class="ttc" id="aSdBaseFile_8h_html"><div class="ttname"><a href="SdBaseFile_8h.html">SdBaseFile.h</a></div><div class="ttdoc">SdBaseFile class.</div></div>
<div class="ttc" id="aclassSdBaseFile_html"><div class="ttname"><a href="classSdBaseFile.html">SdBaseFile</a></div><div class="ttdoc">Base class for SdFile with Print and C++ streams.</div><div class="ttdef"><b>Definition:</b> SdBaseFile.h:182</div></div>
<div class="ttc" id="aclassSdFile_html"><div class="ttname"><a href="classSdFile.html">SdFile</a></div><div class="ttdoc">SdBaseFile with Print.</div><div class="ttdef"><b>Definition:</b> SdFile.h:36</div></div>
<div class="ttc" id="aclassSdFile_html_ad760d51410f36fd1e1b005a754624954"><div class="ttname"><a href="classSdFile.html#ad760d51410f36fd1e1b005a754624954">SdFile::writeln_P</a></div><div class="ttdeci">void writeln_P(PGM_P str)</div><div class="ttdef"><b>Definition:</b> SdFile.cpp:277</div></div>
<div class="ttc" id="aclassSdFile_html_adaa153fed109a0a03cfd545a259de4fe"><div class="ttname"><a href="classSdFile.html#adaa153fed109a0a03cfd545a259de4fe">SdFile::write_P</a></div><div class="ttdeci">void write_P(PGM_P str)</div><div class="ttdef"><b>Definition:</b> SdFile.cpp:269</div></div>
<div class="ttc" id="aclassSdFile_html_aeb1a0b961c1d1e2f5604c9b3f5aa2fbd"><div class="ttname"><a href="classSdFile.html#aeb1a0b961c1d1e2f5604c9b3f5aa2fbd">SdFile::write</a></div><div class="ttdeci">size_t write(uint8_t b)</div><div class="ttdef"><b>Definition:</b> SdFile.cpp:246</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.1
</small></address>
</body>
</html>