summaryrefslogtreecommitdiff
path: root/include/ilist.h
diff options
context:
space:
mode:
authorMarko Mäkelä <marko.makela@mariadb.com>2020-05-27 17:10:39 +0300
committerMarko Mäkelä <marko.makela@mariadb.com>2020-05-27 17:10:39 +0300
commitdad7a8ee7dab99c0ba3d98ac12d0235462f3029e (patch)
treebdfa61bfebb73cf1c5c06a1e3931dd7d2d4b0d77 /include/ilist.h
parent7476e8c7cdd73d60294126a2840baee97e7644b6 (diff)
parent5139cfabb3bfc62be38e651ff176580e0aba09b8 (diff)
downloadmariadb-git-dad7a8ee7dab99c0ba3d98ac12d0235462f3029e.tar.gz
Merge 10.2 into 10.3
Diffstat (limited to 'include/ilist.h')
-rw-r--r--include/ilist.h245
1 files changed, 245 insertions, 0 deletions
diff --git a/include/ilist.h b/include/ilist.h
new file mode 100644
index 00000000000..46e15e9998a
--- /dev/null
+++ b/include/ilist.h
@@ -0,0 +1,245 @@
+/*
+ Copyright (c) 2019, 2020, MariaDB
+
+ This program is free software; you can redistribute it and/or
+ modify it under the terms of the GNU General Public License
+ as published by the Free Software Foundation; version 2 of
+ the License.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1335 USA
+*/
+
+#pragma once
+
+#include <cstddef>
+#include <iterator>
+
+// Derive your class from this struct to insert to a linked list.
+template <class Tag= void> struct ilist_node
+{
+ ilist_node()
+#ifndef DBUG_OFF
+ :
+ next(NULL), prev(NULL)
+#endif
+ {
+ }
+
+ ilist_node(ilist_node *next, ilist_node *prev) : next(next), prev(prev) {}
+
+ ilist_node *next;
+ ilist_node *prev;
+};
+
+// Modelled after std::list<T>
+template <class T, class Tag= void> class ilist
+{
+public:
+ typedef ilist_node<Tag> ListNode;
+ class Iterator;
+
+ // All containers in C++ should define these types to implement generic
+ // container interface.
+ typedef T value_type;
+ typedef std::size_t size_type;
+ typedef std::ptrdiff_t difference_type;
+ typedef value_type &reference;
+ typedef const value_type &const_reference;
+ typedef T *pointer;
+ typedef const T *const_pointer;
+ typedef Iterator iterator;
+ typedef Iterator const_iterator; /* FIXME */
+ typedef std::reverse_iterator<iterator> reverse_iterator;
+ typedef std::reverse_iterator<const iterator> const_reverse_iterator;
+
+ class Iterator
+ {
+ public:
+ // All iterators in C++ should define these types to implement generic
+ // iterator interface.
+ typedef std::bidirectional_iterator_tag iterator_category;
+ typedef T value_type;
+ typedef std::ptrdiff_t difference_type;
+ typedef T *pointer;
+ typedef T &reference;
+
+ Iterator(ListNode *node) : node_(node) {}
+
+ Iterator &operator++()
+ {
+ node_= node_->next;
+ return *this;
+ }
+ Iterator operator++(int)
+ {
+ Iterator tmp(*this);
+ operator++();
+ return tmp;
+ }
+
+ Iterator &operator--()
+ {
+ node_= node_->prev;
+ return *this;
+ }
+ Iterator operator--(int)
+ {
+ Iterator tmp(*this);
+ operator--();
+ return tmp;
+ }
+
+ reference operator*() { return *static_cast<pointer>(node_); }
+ pointer operator->() { return static_cast<pointer>(node_); }
+
+ bool operator==(const Iterator &rhs) { return node_ == rhs.node_; }
+ bool operator!=(const Iterator &rhs) { return !(*this == rhs); }
+
+ private:
+ ListNode *node_;
+
+ friend class ilist;
+ };
+
+ ilist() : sentinel_(&sentinel_, &sentinel_) {}
+
+ reference front() { return *begin(); }
+ reference back() { return *--end(); }
+ const_reference front() const { return *begin(); }
+ const_reference back() const { return *--end(); }
+
+ iterator begin() { return iterator(sentinel_.next); }
+ const_iterator begin() const
+ {
+ return iterator(const_cast<ListNode *>(sentinel_.next));
+ }
+ iterator end() { return iterator(&sentinel_); }
+ const_iterator end() const
+ {
+ return iterator(const_cast<ListNode *>(&sentinel_));
+ }
+
+ reverse_iterator rbegin() { return reverse_iterator(end()); }
+ const_reverse_iterator rbegin() const { return reverse_iterator(end()); }
+ reverse_iterator rend() { return reverse_iterator(begin()); }
+ const_reverse_iterator rend() const { return reverse_iterator(begin()); }
+
+ bool empty() const { return sentinel_.next == &sentinel_; }
+
+ // Not implemented because it's O(N)
+ // size_type size() const
+ // {
+ // return static_cast<size_type>(std::distance(begin(), end()));
+ // }
+
+ void clear()
+ {
+ sentinel_.next= &sentinel_;
+ sentinel_.prev= &sentinel_;
+ }
+
+ iterator insert(iterator pos, reference value)
+ {
+ ListNode *curr= pos.node_;
+ ListNode *prev= pos.node_->prev;
+
+ prev->next= &value;
+ curr->prev= &value;
+
+ static_cast<ListNode &>(value).prev= prev;
+ static_cast<ListNode &>(value).next= curr;
+
+ return iterator(&value);
+ }
+
+ iterator erase(iterator pos)
+ {
+ ListNode *prev= pos.node_->prev;
+ ListNode *next= pos.node_->next;
+
+ prev->next= next;
+ next->prev= prev;
+
+#ifndef DBUG_OFF
+ ListNode *curr= pos.node_;
+ curr->prev= NULL;
+ curr->next= NULL;
+#endif
+
+ return next;
+ }
+
+ void push_back(reference value) { insert(end(), value); }
+ void pop_back() { erase(end()); }
+
+ void push_front(reference value) { insert(begin(), value); }
+ void pop_front() { erase(begin()); }
+
+ // STL version is O(n) but this is O(1) because an element can't be inserted
+ // several times in the same ilist.
+ void remove(reference value) { erase(iterator(&value)); }
+
+private:
+ ListNode sentinel_;
+};
+
+// Similar to ilist but also has O(1) size() method.
+template <class T, class Tag= void> class sized_ilist : public ilist<T, Tag>
+{
+ typedef ilist<T, Tag> BASE;
+
+public:
+ // All containers in C++ should define these types to implement generic
+ // container interface.
+ typedef T value_type;
+ typedef std::size_t size_type;
+ typedef std::ptrdiff_t difference_type;
+ typedef value_type &reference;
+ typedef const value_type &const_reference;
+ typedef T *pointer;
+ typedef const T *const_pointer;
+ typedef typename BASE::Iterator iterator;
+ typedef const typename BASE::Iterator const_iterator;
+ typedef std::reverse_iterator<iterator> reverse_iterator;
+ typedef std::reverse_iterator<const iterator> const_reverse_iterator;
+
+ sized_ilist() : size_(0) {}
+
+ size_type size() const { return size_; }
+
+ void clear()
+ {
+ BASE::clear();
+ size_= 0;
+ }
+
+ iterator insert(iterator pos, reference value)
+ {
+ ++size_;
+ return BASE::insert(pos, value);
+ }
+
+ iterator erase(iterator pos)
+ {
+ --size_;
+ return BASE::erase(pos);
+ }
+
+ void push_back(reference value) { insert(BASE::end(), value); }
+ void pop_back() { erase(BASE::end()); }
+
+ void push_front(reference value) { insert(BASE::begin(), value); }
+ void pop_front() { erase(BASE::begin()); }
+
+ void remove(reference value) { erase(iterator(&value)); }
+
+private:
+ size_type size_;
+};