rtlist.h

Go to the documentation of this file.

/******************************************************************************
 Copyright (c) 2012-2016 Institut für Nachrichtentechnik, Universität Rostock
 Copyright (c) 2006-2012 Quality & Usability Lab
                         Deutsche Telekom Laboratories, TU Berlin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
*******************************************************************************/
 
// https://AudioProcessingFramework.github.io/
 
 
#ifndef APF_RTLIST_H
#define APF_RTLIST_H
 
#include <list>
#include <algorithm>  // for std::find()
 
#include "apf/commandqueue.h"
 
namespace apf
{
 
template<typename T> class RtList; // no implementation, use <T*>!
 
template<typename T>
class RtList<T*> : NonCopyable
{
  public:
    using list_t = typename std::list<T*>;
    using value_type = typename list_t::value_type;
    using size_type = typename list_t::size_type;
    using iterator = typename list_t::iterator;
    using const_iterator = typename list_t::const_iterator;
 
    class AddCommand;  // no implementation, use <T*>!
    class RemCommand;  // no implementation, use <T*>!
    class ClearCommand;  // no implementation, use <T*>!
 
    // Default constructor is not allowed!
 
    explicit RtList(CommandQueue& fifo)
      : _fifo(fifo)
    {}
 
    ~RtList()
    {
      for (auto& delinquent: _the_actual_list) delete delinquent;
      _the_actual_list.clear();
    }
 
    template<typename X>
    X* add(X* item)
    {
      _fifo.push(new AddCommand(_the_actual_list, item));
      return item;
    }
 
    template<typename ForwardIterator>
    void add(ForwardIterator first, ForwardIterator last)
    {
      _fifo.push(new AddCommand(_the_actual_list, first, last));
    }
 
    void rem(T* to_rem)
    {
      _fifo.push(new RemCommand(_the_actual_list, to_rem));
    }
 
    template<typename ForwardIterator>
    void rem(ForwardIterator first, ForwardIterator last)
    {
      _fifo.push(new RemCommand(_the_actual_list, first, last));
    }
 
    void clear()
    {
      _fifo.push(new ClearCommand(_the_actual_list));
    }
 
    void splice(iterator position, RtList& x)
    {
      assert(&_fifo == &x._fifo);
      _the_actual_list.splice(position, x._the_actual_list);
    }
 
    void splice(iterator position, RtList& x, iterator first, iterator last)
    {
      assert(&_fifo == &x._fifo);
      _the_actual_list.splice(position, x._the_actual_list, first, last);
    }
 
    iterator       begin()       { return _the_actual_list.begin(); }
    const_iterator begin() const { return _the_actual_list.begin(); }
    iterator       end()         { return _the_actual_list.end(); }
    const_iterator end()   const { return _the_actual_list.end(); }
    bool           empty() const { return _the_actual_list.empty(); }
    size_type      size()  const { return _the_actual_list.size(); }
 
  private:
    CommandQueue& _fifo;
    list_t _the_actual_list;
};
 
template<typename T>
class RtList<T*>::AddCommand : public CommandQueue::Command
{
  public:
    AddCommand(list_t& dst_list, T* element)
      : _splice_list(1, element) // make list with one element
      , _dst_list(dst_list)
    {
      assert(element != nullptr);
    }
 
    template<typename InputIterator>
    AddCommand(list_t& dst_list, InputIterator first, InputIterator last)
      : _splice_list(first, last)
      , _dst_list(dst_list)
    {}
 
    virtual void execute()
    {
      _dst_list.splice(_dst_list.end(), _splice_list);
    }
 
    // Empty function, because no cleanup is necessary
    virtual void cleanup() {}
 
  private:
    list_t _splice_list;  // List of elements to be added
    list_t& _dst_list;  // Destination list
};
 
template<typename T>
class RtList<T*>::RemCommand : public CommandQueue::Command
{
  public:
    RemCommand(list_t& dst_list, T* delinquent)
      : _dst_list(dst_list)
      , _delinquents(1, delinquent)
    {}
 
    template<typename InputIterator>
    RemCommand(list_t& dst_list, InputIterator first, InputIterator last)
      : _dst_list(dst_list)
      , _delinquents(first, last)
    {}
 
    virtual void execute()
    {
      for (auto& i: _delinquents)
      {
        auto delinquent = std::find(_dst_list.begin(), _dst_list.end(), i);
        if (delinquent != _dst_list.end())
        {
          // Note: destruction order is reverse
          _splice_list.splice(_splice_list.begin(), _dst_list, delinquent);
        }
        else
        {
          throw std::logic_error("RemCommand: Item not found!");
        }
      }
    }
 
    // this might be dangerous/unexpected.
    // but i would need a synchronized Command, which waited
    // for the operation to complete, otherwise.
    virtual void cleanup()
    {
      for (auto& delinquent: _splice_list) delete delinquent;
      _splice_list.clear();
    }
 
  private:
    list_t _splice_list;  // List of elements to be removed
    list_t& _dst_list;  // Destination list
    list_t _delinquents;  // Temporary list of elements to be removed
};
 
template<typename T>
class RtList<T*>::ClearCommand : public CommandQueue::Command
{
  public:
    ClearCommand(list_t& dst_list)
      : _dst_list(dst_list)
    {}
 
    virtual void execute()
    {
      _delinquents.swap(_dst_list);
    }
 
    virtual void cleanup()
    {
      for (auto& delinquent: _delinquents) delete delinquent;
      _delinquents.clear();
    }
 
  private:
    list_t _delinquents;  
    list_t& _dst_list;  
};
 
}  // namespace apf
 
#endif