<!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"/>
<title>RAUL: List.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div 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="namespaces.html"><span>Namespaces</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>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>List.hpp</h1> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* This file is part of Raul.</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2007-2009 David Robillard <http://drobilla.net></span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Raul is free software; you can redistribute it and/or modify it under the</span>
<a name="l00005"></a>00005 <span class="comment"> * terms of the GNU General Public License as published by the Free Software</span>
<a name="l00006"></a>00006 <span class="comment"> * Foundation; either version 2 of the License, or (at your option) any later</span>
<a name="l00007"></a>00007 <span class="comment"> * version.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * Raul is distributed in the hope that it will be useful, but WITHOUT ANY</span>
<a name="l00010"></a>00010 <span class="comment"> * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
<a name="l00011"></a>00011 <span class="comment"> * FOR A PARTICULAR PURPOSE. See the GNU General Public License for details.</span>
<a name="l00012"></a>00012 <span class="comment"> *</span>
<a name="l00013"></a>00013 <span class="comment"> * You should have received a copy of the GNU General Public License along</span>
<a name="l00014"></a>00014 <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span>
<a name="l00015"></a>00015 <span class="comment"> * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00016"></a>00016 <span class="comment"> */</span>
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="preprocessor">#ifndef RAUL_LIST_HPP</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define RAUL_LIST_HPP</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include <cstddef></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <cassert></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include <boost/utility.hpp></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include "raul/Deletable.hpp"</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "raul/AtomicPtr.hpp"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "raul/AtomicInt.hpp"</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="keyword">namespace </span>Raul {
<a name="l00029"></a>00029
<a name="l00030"></a>00030
<a name="l00037"></a>00037 <span class="keyword">template</span> <<span class="keyword">typename</span> T>
<a name="l00038"></a><a class="code" href="classRaul_1_1List.html">00038</a> <span class="keyword">class </span><a class="code" href="classRaul_1_1List.html" title="A realtime safe, (partially) thread safe doubly-linked list.">List</a> : <span class="keyword">public</span> Raul::<a class="code" href="classRaul_1_1Deletable.html" title="Something with a virtual destructor.">Deletable</a>, <span class="keyword">public</span> boost::noncopyable
<a name="l00039"></a>00039 {
<a name="l00040"></a>00040 <span class="keyword">public</span>:
<a name="l00041"></a>00041
<a name="l00048"></a><a class="code" href="classRaul_1_1List_1_1Node.html">00048</a> <span class="keyword">class </span><a class="code" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">Node</a> : <span class="keyword">public</span> Raul::<a class="code" href="classRaul_1_1Deletable.html" title="Something with a virtual destructor.">Deletable</a> {
<a name="l00049"></a>00049 <span class="keyword">public</span>:
<a name="l00050"></a>00050 <a class="code" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">Node</a>(T elem) : _elem(elem) {}
<a name="l00051"></a>00051 <span class="keyword">virtual</span> ~<a class="code" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">Node</a>() {}
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="keyword">template</span> <<span class="keyword">typename</span> Y>
<a name="l00054"></a>00054 <a class="code" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">Node</a>(<span class="keyword">const</span> <span class="keyword">typename</span> <a class="code" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">List<Y>::Node</a>& copy)
<a name="l00055"></a>00055 : _elem(copy._elem), _prev(copy._prev), _next(copy._next)
<a name="l00056"></a>00056 {}
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <a class="code" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">Node</a>* prev()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _prev.get(); }
<a name="l00059"></a>00059 <span class="keywordtype">void</span> prev(<a class="code" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">Node</a>* ln) { _prev = ln; }
<a name="l00060"></a>00060 <a class="code" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">Node</a>* next()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _next.get(); }
<a name="l00061"></a>00061 <span class="keywordtype">void</span> next(<a class="code" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">Node</a>* ln) { _next = ln; }
<a name="l00062"></a>00062 T& elem() { <span class="keywordflow">return</span> _elem;}
<a name="l00063"></a>00063 <span class="keyword">const</span> T& elem()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _elem; }
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="keyword">private</span>:
<a name="l00066"></a>00066 T _elem;
<a name="l00067"></a>00067 AtomicPtr<Node> _prev;
<a name="l00068"></a>00068 AtomicPtr<Node> _next;
<a name="l00069"></a>00069 };
<a name="l00070"></a>00070
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <a class="code" href="classRaul_1_1List.html" title="A realtime safe, (partially) thread safe doubly-linked list.">List</a>(<span class="keywordtype">size_t</span> <a class="code" href="classRaul_1_1List.html#a8e77fcf7bff6532771334c067acc5977" title="Valid only in the write thread.">size</a>=0, <a class="code" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">Node</a>* head=NULL, <a class="code" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">Node</a>* tail=NULL)
<a name="l00073"></a>00073 : _size(<a class="code" href="classRaul_1_1List.html#a8e77fcf7bff6532771334c067acc5977" title="Valid only in the write thread.">size</a>)
<a name="l00074"></a>00074 , _end_iter(this)
<a name="l00075"></a>00075 , _const_end_iter(this)
<a name="l00076"></a>00076 {
<a name="l00077"></a>00077 _head = head;
<a name="l00078"></a>00078 _tail = tail;
<a name="l00079"></a>00079 _end_iter._listnode = NULL;
<a name="l00080"></a>00080 _const_end_iter._listnode = NULL;
<a name="l00081"></a>00081 }
<a name="l00082"></a>00082
<a name="l00083"></a>00083 ~<a class="code" href="classRaul_1_1List.html" title="A realtime safe, (partially) thread safe doubly-linked list.">List</a>();
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="keywordtype">void</span> <a class="code" href="classRaul_1_1List.html#a20d904c950f9eb4208b19e6ebb690371" title="Realtime Safe.">push_back</a>(Node* elem);
<a name="l00086"></a>00086 <span class="keywordtype">void</span> <a class="code" href="classRaul_1_1List.html#a20d904c950f9eb4208b19e6ebb690371" title="Realtime Safe.">push_back</a>(T& elem);
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <span class="keywordtype">void</span> <a class="code" href="classRaul_1_1List.html#ae37d799cafbab461d145bbf0f5aa8401" title="Append a list to this list.">append</a>(<a class="code" href="classRaul_1_1List.html" title="A realtime safe, (partially) thread safe doubly-linked list.">List<T></a>& list);
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="keywordtype">void</span> <a class="code" href="classRaul_1_1List.html#a96cb220e9d0bc81a5a40669f9f0a793b" title="Clear the list, deleting all Nodes contained (but NOT their contents!).">clear</a>();
<a name="l00091"></a>00091
<a name="l00093"></a><a class="code" href="classRaul_1_1List.html#a8e77fcf7bff6532771334c067acc5977">00093</a> <span class="keywordtype">unsigned</span> <a class="code" href="classRaul_1_1List.html#a8e77fcf7bff6532771334c067acc5977" title="Valid only in the write thread.">size</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">static_cast<</span><span class="keywordtype">unsigned</span><span class="keyword">></span>(_size.get()); }
<a name="l00094"></a>00094
<a name="l00096"></a><a class="code" href="classRaul_1_1List.html#a92a6732e5efee58a8c420189636f7d62">00096</a> <span class="keywordtype">bool</span> <a class="code" href="classRaul_1_1List.html#a92a6732e5efee58a8c420189636f7d62" title="Valid for any thread.">empty</a>() { <span class="keywordflow">return</span> (_head.get() == NULL); }
<a name="l00097"></a>00097
<a name="l00098"></a>00098 <span class="keyword">class </span>iterator;
<a name="l00099"></a>00099
<a name="l00101"></a><a class="code" href="classRaul_1_1List_1_1const__iterator.html">00101</a> <span class="keyword">class </span><a class="code" href="classRaul_1_1List_1_1const__iterator.html" title="Realtime safe const iterator for a List.">const_iterator</a> {
<a name="l00102"></a>00102 <span class="keyword">public</span>:
<a name="l00103"></a>00103 <a class="code" href="classRaul_1_1List_1_1const__iterator.html#a371181e310dc14d0e6e6d432c9f2a79b" title="const_iterator stuff ///">const_iterator</a>(<span class="keyword">const</span> <a class="code" href="classRaul_1_1List.html" title="A realtime safe, (partially) thread safe doubly-linked list.">List<T></a>* <span class="keyword">const</span> list);
<a name="l00104"></a>00104 <a class="code" href="classRaul_1_1List_1_1const__iterator.html#a371181e310dc14d0e6e6d432c9f2a79b" title="const_iterator stuff ///">const_iterator</a>(<span class="keyword">const</span> <a class="code" href="classRaul_1_1List_1_1iterator.html" title="Realtime safe iterator for a List.">iterator</a>& i)
<a name="l00105"></a>00105 : _list(i._list), _listnode(i._listnode) {}
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="keyword">inline</span> <span class="keyword">const</span> T& operator*();
<a name="l00108"></a>00108 <span class="keyword">inline</span> <span class="keyword">const</span> T* operator->();
<a name="l00109"></a>00109 <span class="keyword">inline</span> <a class="code" href="classRaul_1_1List_1_1const__iterator.html" title="Realtime safe const iterator for a List.">const_iterator</a>& operator++();
<a name="l00110"></a>00110 <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator!=(<span class="keyword">const</span> <a class="code" href="classRaul_1_1List_1_1const__iterator.html" title="Realtime safe const iterator for a List.">const_iterator</a>& iter) <span class="keyword">const</span>;
<a name="l00111"></a>00111 <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator!=(<span class="keyword">const</span> <a class="code" href="classRaul_1_1List_1_1iterator.html" title="Realtime safe iterator for a List.">iterator</a>& iter) <span class="keyword">const</span>;
<a name="l00112"></a>00112 <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code" href="classRaul_1_1List_1_1const__iterator.html" title="Realtime safe const iterator for a List.">const_iterator</a>& iter) <span class="keyword">const</span>;
<a name="l00113"></a>00113 <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code" href="classRaul_1_1List_1_1iterator.html" title="Realtime safe iterator for a List.">iterator</a>& iter) <span class="keyword">const</span>;
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="keyword">inline</span> <span class="keyword">typename</span> <a class="code" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">List<T>::Node</a>* node() { <span class="keywordflow">return</span> _listnode; }
<a name="l00116"></a>00116 <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keyword">typename</span> <a class="code" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">List<T>::Node</a>* node()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _listnode; }
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classRaul_1_1List.html" title="A realtime safe, (partially) thread safe doubly-linked list.">List</a><T>;
<a name="l00119"></a>00119
<a name="l00120"></a>00120 <span class="keyword">private</span>:
<a name="l00121"></a>00121 <span class="keyword">const</span> <a class="code" href="classRaul_1_1List.html" title="A realtime safe, (partially) thread safe doubly-linked list.">List<T></a>* _list;
<a name="l00122"></a>00122 <span class="keyword">const</span> <span class="keyword">typename</span> <a class="code" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">List<T>::Node</a>* _listnode;
<a name="l00123"></a>00123 };
<a name="l00124"></a>00124
<a name="l00125"></a>00125
<a name="l00127"></a><a class="code" href="classRaul_1_1List_1_1iterator.html">00127</a> <span class="keyword">class </span><a class="code" href="classRaul_1_1List_1_1iterator.html" title="Realtime safe iterator for a List.">iterator</a> {
<a name="l00128"></a>00128 <span class="keyword">public</span>:
<a name="l00129"></a>00129 <a class="code" href="classRaul_1_1List_1_1iterator.html" title="Realtime safe iterator for a List.">iterator</a>(<a class="code" href="classRaul_1_1List.html" title="A realtime safe, (partially) thread safe doubly-linked list.">List<T></a>* <span class="keyword">const</span> list);
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="keyword">inline</span> T& operator*();
<a name="l00132"></a>00132 <span class="keyword">inline</span> T* operator->();
<a name="l00133"></a>00133 <span class="keyword">inline</span> <a class="code" href="classRaul_1_1List_1_1iterator.html" title="Realtime safe iterator for a List.">iterator</a>& operator++();
<a name="l00134"></a>00134 <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator!=(<span class="keyword">const</span> <a class="code" href="classRaul_1_1List_1_1iterator.html" title="Realtime safe iterator for a List.">iterator</a>& iter) <span class="keyword">const</span>;
<a name="l00135"></a>00135 <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator!=(<span class="keyword">const</span> <a class="code" href="classRaul_1_1List_1_1const__iterator.html" title="Realtime safe const iterator for a List.">const_iterator</a>& iter) <span class="keyword">const</span>;
<a name="l00136"></a>00136 <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code" href="classRaul_1_1List_1_1iterator.html" title="Realtime safe iterator for a List.">iterator</a>& iter) <span class="keyword">const</span>;
<a name="l00137"></a>00137 <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> <a class="code" href="classRaul_1_1List_1_1const__iterator.html" title="Realtime safe const iterator for a List.">const_iterator</a>& iter) <span class="keyword">const</span>;
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classRaul_1_1List.html" title="A realtime safe, (partially) thread safe doubly-linked list.">List</a><T>;
<a name="l00140"></a>00140 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classRaul_1_1List.html" title="A realtime safe, (partially) thread safe doubly-linked list.">List</a><T>::<a class="code" href="classRaul_1_1List_1_1const__iterator.html" title="Realtime safe const iterator for a List.">const_iterator</a>;
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="keyword">private</span>:
<a name="l00143"></a>00143 const <a class="code" href="classRaul_1_1List.html" title="A realtime safe, (partially) thread safe doubly-linked list.">List</a><T>* _list;
<a name="l00144"></a>00144 typename <a class="code" href="classRaul_1_1List.html" title="A realtime safe, (partially) thread safe doubly-linked list.">List</a><T>::<a class="code" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">Node</a>* _listnode;
<a name="l00145"></a>00145 };
<a name="l00146"></a>00146
<a name="l00147"></a>00147 void chop_front(List<T>& front, size_t front_size, Node* new_head);
<a name="l00148"></a>00148
<a name="l00149"></a>00149 <a class="code" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">Node</a>* <a class="code" href="classRaul_1_1List.html#adeb74758cc7641b414907f792e276155" title="Remove an element from the list using an iterator.">erase</a>(const iterator iter);
<a name="l00150"></a>00150
<a name="l00151"></a>00151 <a class="code" href="classRaul_1_1List_1_1iterator.html" title="Realtime safe iterator for a List.">iterator</a> <a class="code" href="classRaul_1_1List.html#a534f9df684480b3bb74173e36f0cd2e9" title="Find an element in the list.">find</a>(const T& val);
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <a class="code" href="classRaul_1_1List_1_1iterator.html" title="Realtime safe iterator for a List.">iterator</a> begin();
<a name="l00154"></a>00154 <a class="code" href="classRaul_1_1List_1_1const__iterator.html" title="Realtime safe const iterator for a List.">const_iterator</a> begin() const;
<a name="l00155"></a>00155 const <a class="code" href="classRaul_1_1List_1_1iterator.html" title="Realtime safe iterator for a List.">iterator</a> end() const;
<a name="l00156"></a>00156
<a name="l00157"></a>00157 T& front() { <span class="keywordflow">return</span> *begin(); }
<a name="l00158"></a>00158 <span class="keyword">const</span> T& front()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> *begin(); }
<a name="l00159"></a>00159
<a name="l00160"></a>00160 <a class="code" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">Node</a>* head() { <span class="keywordflow">return</span> _head.get(); }
<a name="l00161"></a>00161 <span class="keyword">const</span> <a class="code" href="classRaul_1_1List_1_1Node.html" title="A node in a List.">Node</a>* head()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _head.get(); }
<a name="l00162"></a>00162
<a name="l00163"></a>00163 <span class="keyword">private</span>:
<a name="l00164"></a>00164 AtomicPtr<Node> _head;
<a name="l00165"></a>00165 AtomicPtr<Node> _tail;
<a name="l00166"></a>00166 AtomicInt _size;
<a name="l00167"></a>00167 <a class="code" href="classRaul_1_1List_1_1iterator.html" title="Realtime safe iterator for a List.">iterator</a> _end_iter;
<a name="l00168"></a>00168 <a class="code" href="classRaul_1_1List_1_1const__iterator.html" title="Realtime safe const iterator for a List.">const_iterator</a> _const_end_iter;
<a name="l00169"></a>00169 };
<a name="l00170"></a>00170
<a name="l00171"></a>00171
<a name="l00172"></a>00172 } <span class="comment">// namespace Raul</span>
<a name="l00173"></a>00173
<a name="l00174"></a>00174 <span class="preprocessor">#endif // RAUL_LIST_HPP</span>
<a name="l00175"></a>00175 <span class="preprocessor"></span>
<a name="l00176"></a>00176 <span class="preprocessor">#include "ListImpl.hpp"</span>
<a name="l00177"></a>00177
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Oct 6 2010 for RAUL by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
88959ca903fe50462ea99715ead18944
>
files
>
58
