Project

General

Profile

Statistics
| Revision:

root / trunk / docs / libdragonfly / ring__buffer_8h-source.html @ 862

History | View | Annotate | Download (6.34 KB)

1 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 
<title>libdragonfly: ring_buffer.h Source File</title>
4 
<link href="doxygen.css" rel="stylesheet" type="text/css">
5 
<link href="tabs.css" rel="stylesheet" type="text/css">
6 
</head><body>
7 
<!-- Generated by Doxygen 1.5.5 -->
8 
<div class="navigation" id="top">
9 
  <div class="tabs">
10 
    <ul>
11 
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12 
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
13 
      <li><a href="modules.html"><span>Modules</span></a></li>
14 
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
15 
      <li class="current"><a href="files.html"><span>Files</span></a></li>
16 
    </ul>
17 
  </div>
18 
<h1>ring_buffer.h</h1><a href="ring__buffer_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
19 
<a name="l00038"></a>00038 <span class="preprocessor">#ifndef _RING_BUFFER_H</span>
20 
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#define _RING_BUFFER_H</span>
21 
<a name="l00040"></a>00040 <span class="preprocessor"></span>
22 
<a name="l00053"></a><a class="code" href="ring__buffer_8h.html#883368e450d3596622905053d3b3ab83">00053</a> <span class="preprocessor">#define RING_BUFFER_NEW(struct_name, size, type, ...)   \</span>
23 
<a name="l00054"></a>00054 <span class="preprocessor">        struct struct_name {    \</span>
24 
<a name="l00055"></a>00055 <span class="preprocessor">                type queue[size];       \</span>
25 
<a name="l00056"></a>00056 <span class="preprocessor">                uint8_t start;                  \</span>
26 
<a name="l00057"></a>00057 <span class="preprocessor">                uint8_t end;                    \</span>
27 
<a name="l00058"></a>00058 <span class="preprocessor">                uint8_t buffer_size;                    \</span>
28 
<a name="l00059"></a>00059 <span class="preprocessor">        } __VA_ARGS__</span>
29 
<a name="l00060"></a>00060 <span class="preprocessor"></span>
30 
<a name="l00061"></a>00061
31 
<a name="l00068"></a><a class="code" href="ring__buffer_8h.html#3c186ab6ff12fa96c18f6d064720cc2c">00068</a> <span class="preprocessor">#define RING_BUFFER_INIT(buf, size)                     \</span>
32 
<a name="l00069"></a>00069 <span class="preprocessor">        do {                                                                            \</span>
33 
<a name="l00070"></a>00070 <span class="preprocessor">                (buf).buffer_size = size;                               \</span>
34 
<a name="l00071"></a>00071 <span class="preprocessor">        } while(0)</span>
35 
<a name="l00072"></a>00072 <span class="preprocessor"></span>
36 
<a name="l00073"></a>00073
37 
<a name="l00078"></a><a class="code" href="ring__buffer_8h.html#0ae5ca959a3b05583623551cc287a534">00078</a> <span class="preprocessor">#define RING_BUFFER_CLEAR(buf)  \</span>
38 
<a name="l00079"></a>00079 <span class="preprocessor">        do {                                            \</span>
39 
<a name="l00080"></a>00080 <span class="preprocessor">                (buf).start = 0;                \</span>
40 
<a name="l00081"></a>00081 <span class="preprocessor">                (buf).end = 0;                  \</span>
41 
<a name="l00082"></a>00082 <span class="preprocessor">        } while (0)</span>
42 
<a name="l00083"></a>00083 <span class="preprocessor"></span>
43 
<a name="l00088"></a><a class="code" href="ring__buffer_8h.html#19daf3026b69a26bb3d383b14ae90e23">00088</a> <span class="preprocessor">#define RING_BUFFER_EMPTY(buf) ((buf).start == (buf).end)</span>
44 
<a name="l00089"></a>00089 <span class="preprocessor"></span>
45 
<a name="l00090"></a>00090
46 
<a name="l00095"></a><a class="code" href="ring__buffer_8h.html#2ed153688dc60c5503f2f7fdd2b73a4a">00095</a> <span class="preprocessor">#define RING_BUFFER_FULL(buf)   \</span>
47 
<a name="l00096"></a>00096 <span class="preprocessor">                (((buf).end + 1) % (buf).buffer_size == (buf).start)</span>
48 
<a name="l00097"></a>00097 <span class="preprocessor"></span>
49 
<a name="l00098"></a>00098
50 
<a name="l00106"></a><a class="code" href="ring__buffer_8h.html#7708daab49219e2fd35534bc9cd15245">00106</a> <span class="preprocessor">#define RING_BUFFER_ADD(buf, val)               \</span>
51 
<a name="l00107"></a>00107 <span class="preprocessor">        do {                                                            \</span>
52 
<a name="l00108"></a>00108 <span class="preprocessor">                (buf).queue[(buf).end] = val;   \</span>
53 
<a name="l00109"></a>00109 <span class="preprocessor">                (buf).end = ((buf).end + 1) % (buf).buffer_size;        \</span>
54 
<a name="l00110"></a>00110 <span class="preprocessor">        } while (0)</span>
55 
<a name="l00111"></a>00111 <span class="preprocessor"></span>
56 
<a name="l00112"></a>00112
57 
<a name="l00122"></a><a class="code" href="ring__buffer_8h.html#4a0f9de5ac14f60d678cda392921a629">00122</a> <span class="preprocessor">#define RING_BUFFER_REMOVE(buf, val_ret)        \</span>
58 
<a name="l00123"></a>00123 <span class="preprocessor">        do {    \</span>
59 
<a name="l00124"></a>00124 <span class="preprocessor">                (val_ret) = (buf).queue[(buf).start];   \</span>
60 
<a name="l00125"></a>00125 <span class="preprocessor">                (buf).start = ((buf).start + 1) % (buf).buffer_size;    \</span>
61 
<a name="l00126"></a>00126 <span class="preprocessor">        } while (0)</span>
62 
<a name="l00127"></a>00127 <span class="preprocessor"></span>
63 
<a name="l00136"></a><a class="code" href="ring__buffer_8h.html#6cb5596d0d7edccd628aca097f088f91">00136</a> <span class="preprocessor"> #define RING_BUFFER_PEEK(buf, val_ret)  \</span>
64 
<a name="l00137"></a>00137 <span class="preprocessor">  do { \</span>
65 
<a name="l00138"></a>00138 <span class="preprocessor">    (val_ret) = (buf).queue[(buf).start]; \</span>
66 
<a name="l00139"></a>00139 <span class="preprocessor">  } while(0)</span>
67 
<a name="l00140"></a>00140 <span class="preprocessor"></span>
68 
<a name="l00141"></a>00141 <span class="preprocessor">#endif </span><span class="comment">/* _RING_BUFFER_H */</span>
69 
<a name="l00142"></a>00142
70 
</pre></div></div>
71 
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 26 13:39:28 2008 for libdragonfly by&nbsp;
72 
<a href="http://www.doxygen.org/index.html">
73 
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
74 
</body>
75 
</html>