ListLocked.hpp

/***************************************************************************
  tag: Peter Soetens  Thu Oct 22 11:59:08 CEST 2009  ListLocked.hpp

                        ListLocked.hpp -  description
                           -------------------
    begin                : Thu October 22 2009
    copyright            : (C) 2009 Peter Soetens
    email                : peter@thesourcworks.com

 ***************************************************************************
 *   This library 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.                                             *
 *                                                                         *
 *   As a special exception, you may use this file as part of a free       *
 *   software library without restriction.  Specifically, if other files   *
 *   instantiate templates or use macros or inline functions from this     *
 *   file, or you compile this file and link it with other files to        *
 *   produce an executable, this file does not by itself cause the         *
 *   resulting executable to be covered by the GNU General Public          *
 *   License.  This exception does not however invalidate any other        *
 *   reasons why the executable file might be covered by the GNU General   *
 *   Public License.                                                       *
 *                                                                         *
 *   This library 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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU General Public             *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 59 Temple Place,                                    *
 *   Suite 330, Boston, MA  02111-1307  USA                                *
 *                                                                         *
 ***************************************************************************/



#ifndef ORO_LIST_LOCKED_HPP
#define ORO_LIST_LOCKED_HPP

#include <boost/intrusive/list.hpp>
#include <boost/bind.hpp>
#include <boost/bind/protect.hpp>
#include <stack>
#include <vector>
#include <algorithm>
#include "../os/Mutex.hpp"
#include "../os/MutexLock.hpp"

#ifdef ORO_PRAGMA_INTERFACE
#pragma interface
#endif

namespace RTT
{ namespace internal {

    template< class T>
    class ListLocked
    {
    public:

        typedef T value_t;
    private:
        struct Cont :  public boost::intrusive::list_base_hook<> {
            T data;
        };
        typedef boost::intrusive::list<Cont> BufferType;
        typedef std::stack<Cont*> StackType;
        typedef typename BufferType::iterator Iterator;
        typedef typename BufferType::const_iterator CIterator;

        BufferType mlist;
        StackType  mreserved;
        unsigned int required;

        mutable os::MutexRecursive m;
    public:
        ListLocked(unsigned int lsize, unsigned int unused = 0 )
            :required(lsize)
        {
            for(unsigned int i=0; i <lsize; ++i)
                mreserved.push(new Cont());
        }

        ~ListLocked() {
            this->clear();
            while( !mreserved.empty() ) {
                delete mreserved.top();
                mreserved.pop();
            }
        }

        size_t capacity() const
        {
            os::MutexLock lock(m);
            return mreserved.size() + mlist.size();
        }

        size_t size() const
        {
            os::MutexLock lock(m);
            return mlist.size();
        }

        bool empty() const
        {
            os::MutexLock lock(m);
            return mlist.empty();
        }

        void grow(size_t items = 1) {
            os::MutexLock lock(m);
            required += items;
            if (required > mreserved.size() + mlist.size() ) {
                while ( mreserved.size() + mlist.size() < required * 2) {
                    mreserved.push( new Cont() );
                }
            }
        }
        void shrink(size_t items = 1) {
            os::MutexLock lock(m);
            required -= items;
        }

        void reserve(size_t lsize)
        {
            os::MutexLock lock(m);
            while ( mreserved.size() + mlist.size() < lsize) {
                mreserved.push( new Cont() );
            }
        }

        void clear()
        {
            os::MutexLock lock(m);
            mlist.clear_and_dispose( boost::bind(&ListLocked::give_back, this, _1) );
        }

        bool append( value_t item )
        {
            os::MutexLock lock(m);
            if ( mreserved.empty() )
                return false;
            mlist.push_back( this->get_item(item) );
            return true;
        }

        value_t front() const
        {
            os::MutexLock lock(m);
            return mlist.front().data;
        }

        value_t back() const
        {
            os::MutexLock lock(m);
            return mlist.back().data;
        }

        size_t append(const std::vector<T>& items)
        {
            os::MutexLock lock(m);
            unsigned int max = mreserved.size();
            typename std::vector<T>::const_iterator it = items.begin();
            for(; it != items.end() && max != 0; ++it, --max )
                mlist.push_back( this->get_item(*it) );
            return it - items.begin();
        }


        bool erase( value_t item )
        {
            os::MutexLock lock(m);
            mlist.remove_and_dispose_if( boost::bind(&ListLocked::is_item, this, item, _1), boost::bind(&ListLocked::give_back, this, _1) );
            return true;
        }

        template<typename Pred>
        bool delete_if(Pred pred)
        {
            os::MutexLock lock(m);
            bool deleted = false;

            typename BufferType::iterator cur(mlist.begin());
            typename BufferType::iterator last(mlist.end());

            while(cur != last) 
            {
            if(pred(cur->data))
            {
                cur = mlist.erase_and_dispose(cur, boost::bind(&ListLocked::give_back, this, ::_1) );
                deleted = true;
            }
            else
                ++cur;
            }

            return deleted;
        }

        template<class Function>
        void apply(Function func )
        {
            os::MutexLock lock(m);
            // A free beer for the one that can express this with a for_each construct.
            for (Iterator it = mlist.begin(); it != mlist.end(); ++it)
                func( it->data );
        }

        template<class Function>
        value_t find_if( Function func, value_t blank = value_t() )
        {
            os::MutexLock lock(m);
            Iterator it = std::find_if(mlist.begin(), mlist.end(), boost::bind(func, boost::bind(&ListLocked::get_data, this,_1)));
            if (it != mlist.end() )
                return it->data;
            return blank;
        }
    private:
        void give_back(Cont* cont)
        {
            mreserved.push( cont );
        }

        Cont& get_item(value_t item)
        {
            Cont* c = mreserved.top();
            mreserved.pop();
            c->data = item;
            return *c;
        }

        value_t& get_data(Cont& c)
        {
            return c.data;
        }

        bool is_item(value_t item, const Cont& cont)
        {
            return item == cont.data;
        }
    };

}}

#endif