queue.h

Go to the documentation of this file.

 
 
/******************************************************************************
The MIT License(MIT)
 
Embedded Template Library.
https://github.com/ETLCPP/etl
https://www.etlcpp.com
 
Copyright(c) 2014 John Wellbelove, Mark Kitson
 
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.
******************************************************************************/
 
#ifndef ETL_QUEUE_INCLUDED
#define ETL_QUEUE_INCLUDED
 
#include "platform.h"
#include "alignment.h"
#include "exception.h"
#include "error_handler.h"
#include "debug_count.h"
#include "type_traits.h"
#include "parameter_type.h"
#include "memory_model.h"
#include "integral_limits.h"
#include "utility.h"
#include "placement_new.h"
 
#include <stddef.h>
#include <stdint.h>
 
//*****************************************************************************
//*****************************************************************************
 
namespace etl
{
  //***************************************************************************
  //***************************************************************************
  class queue_exception : public exception
  {
  public:
 
    queue_exception(string_type reason_, string_type file_name_, numeric_type line_number_)
      : exception(reason_, file_name_, line_number_)
    {
    }
  };
 
  //***************************************************************************
  //***************************************************************************
  class queue_full : public queue_exception
  {
  public:
 
    queue_full(string_type file_name_, numeric_type line_number_)
      : queue_exception(ETL_ERROR_TEXT("queue:full", ETL_QUEUE_FILE_ID"A"), file_name_, line_number_)
    {
    }
  };
 
  //***************************************************************************
  //***************************************************************************
  class queue_empty : public queue_exception
  {
  public:
 
    queue_empty(string_type file_name_, numeric_type line_number_)
      : queue_exception(ETL_ERROR_TEXT("queue:empty", ETL_QUEUE_FILE_ID"B"), file_name_, line_number_)
    {
    }
  };
 
  //***************************************************************************
  //***************************************************************************
  template <size_t MEMORY_MODEL = etl::memory_model::MEMORY_MODEL_LARGE>
  class queue_base
  {
  public:
 
    typedef typename etl::size_type_lookup<MEMORY_MODEL>::type size_type;
 
    //*************************************************************************
    //*************************************************************************
    size_type size() const
    {
      return current_size;
    }
 
    //*************************************************************************
    //*************************************************************************
    size_type max_size() const
    {
      return CAPACITY;
    }
 
    //*************************************************************************
    //*************************************************************************
    size_type capacity() const
    {
      return CAPACITY;
    }
 
    //*************************************************************************
    //*************************************************************************
    bool empty() const
    {
      return current_size == 0;
    }
 
    //*************************************************************************
    //*************************************************************************
    bool full() const
    {
      return current_size == CAPACITY;
    }
 
    //*************************************************************************
    //*************************************************************************
    size_type available() const
    {
      return max_size() - size();
    }
 
  protected:
 
    //*************************************************************************
    //*************************************************************************
    queue_base(size_type max_size_)
      : in(0),
        out(0),
        current_size(0),
        CAPACITY(max_size_)
    {
    }
 
    //*************************************************************************
    //*************************************************************************
    ~queue_base()
    {
    }
 
    //*************************************************************************
    //*************************************************************************
    void add_in()
    {
      if (++in == CAPACITY) ETL_UNLIKELY
      {
        in = 0;
      }
 
      ++current_size;
      ETL_INCREMENT_DEBUG_COUNT;
    }
 
    //*************************************************************************
    //*************************************************************************
    void del_out()
    {
      if (++out == CAPACITY) ETL_UNLIKELY
      {
        out = 0;
      }
      --current_size;
      ETL_DECREMENT_DEBUG_COUNT;
    }
 
    //*************************************************************************
    //*************************************************************************
    void index_clear()
    {
      in = 0;
      out = 0;
      current_size = 0;
      ETL_RESET_DEBUG_COUNT;
    }
 
    size_type in;            
    size_type out;           
    size_type current_size;   
    const size_type CAPACITY; 
    ETL_DECLARE_DEBUG_COUNT;  
 
  };
 
  //***************************************************************************
  //***************************************************************************
  template <typename T, const size_t MEMORY_MODEL = etl::memory_model::MEMORY_MODEL_LARGE>
  class iqueue : public etl::queue_base<MEMORY_MODEL>
  {
  private:
 
    typedef typename etl::queue_base<MEMORY_MODEL> base_t;
 
  public:
 
    typedef T                          value_type;      
    typedef T&                         reference;       
    typedef const T&                   const_reference; 
#if ETL_USING_CPP11
    typedef T&&                        rvalue_reference;
#endif
    typedef T*                         pointer;         
    typedef const T*                   const_pointer;   
    typedef typename base_t::size_type size_type;       
 
    using base_t::in;
    using base_t::out;
    using base_t::CAPACITY;
    using base_t::current_size;
    using base_t::full;
    using base_t::empty;
    using base_t::add_in;
    using base_t::del_out;
 
    //*************************************************************************
    //*************************************************************************
    reference front()
    {
      return p_buffer[out];
    }
 
    //*************************************************************************
    //*************************************************************************
    const_reference front() const
    {
      return p_buffer[out];
    }
 
    //*************************************************************************
    //*************************************************************************
    reference back()
    {
      return p_buffer[in == 0 ? CAPACITY - 1 : in - 1];
    }
 
    //*************************************************************************
    //*************************************************************************
    const_reference back() const
    {
      return p_buffer[in == 0 ? CAPACITY - 1 : in - 1];
    }
 
    //*************************************************************************
    //*************************************************************************
    void push(const_reference value)
    {
#if defined(ETL_CHECK_PUSH_POP)
      ETL_ASSERT(!full(), ETL_ERROR(queue_full));
#endif
      ::new (&p_buffer[in]) T(value);
      add_in();
    }
 
#if ETL_USING_CPP11
    //*************************************************************************
    //*************************************************************************
    void push(rvalue_reference value)
    {
#if defined(ETL_CHECK_PUSH_POP)
      ETL_ASSERT(!full(), ETL_ERROR(queue_full));
#endif
      ::new (&p_buffer[in]) T(etl::move(value));
      add_in();
    }
#endif
 
#if ETL_USING_CPP11 && ETL_NOT_USING_STLPORT && !defined(ETL_QUEUE_FORCE_CPP03_IMPLEMENTATION)
    //*************************************************************************
    //*************************************************************************
    template <typename ... Args>
    reference emplace(Args && ... args)
    {
#if defined(ETL_CHECK_PUSH_POP)
      ETL_ASSERT(!full(), ETL_ERROR(queue_full));
#endif
      reference value = p_buffer[in];
      ::new (&value) T(etl::forward<Args>(args)...);
      add_in();
      return value;
    }
#else
    //*************************************************************************
    //*************************************************************************
    reference emplace()
    {
#if defined(ETL_CHECK_PUSH_POP)
      ETL_ASSERT(!full(), ETL_ERROR(queue_full));
#endif
      reference value = p_buffer[in];
      ::new (&value) T();
      add_in();
      return value;
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename T1>
    reference emplace(const T1& value1)
    {
#if defined(ETL_CHECK_PUSH_POP)
      ETL_ASSERT(!full(), ETL_ERROR(queue_full));
#endif
      reference value = p_buffer[in];
      ::new (&value) T(value1);
      add_in();
      return value;
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename T1, typename T2>
    reference emplace(const T1& value1, const T2& value2)
    {
#if defined(ETL_CHECK_PUSH_POP)
      ETL_ASSERT(!full(), ETL_ERROR(queue_full));
#endif
      reference value = p_buffer[in];
      ::new (&value) T(value1, value2);
      add_in();
      return value;
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename T1, typename T2, typename T3>
    reference emplace(const T1& value1, const T2& value2, const T3& value3)
    {
#if defined(ETL_CHECK_PUSH_POP)
      ETL_ASSERT(!full(), ETL_ERROR(queue_full));
#endif
      reference value = p_buffer[in];
      ::new (&value) T(value1, value2, value3);
      add_in();
      return value;
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename T1, typename T2, typename T3, typename T4>
    reference emplace(const T1& value1, const T2& value2, const T3& value3, const T4& value4)
    {
#if defined(ETL_CHECK_PUSH_POP)
      ETL_ASSERT(!full(), ETL_ERROR(queue_full));
#endif
      reference value = p_buffer[in];
      ::new (&value) T(value1, value2, value3, value4);
      add_in();
      return value;
    }
#endif
 
    //*************************************************************************
    //*************************************************************************
    void clear()
    {
      if ETL_IF_CONSTEXPR(etl::is_trivially_destructible<T>::value)
      {
        base_t::index_clear();
      }
      else
      {
        while (current_size > 0)
        {
          p_buffer[out].~T();
          del_out();
        }
 
        in = 0;
        out = 0;
      }
    }
 
    //*************************************************************************
    //*************************************************************************
    void pop()
    {
#if defined(ETL_CHECK_PUSH_POP)
      ETL_ASSERT_OR_RETURN(!empty(), ETL_ERROR(queue_empty));
#endif
      p_buffer[out].~T();
      del_out();
    }
 
    //*************************************************************************
    //*************************************************************************
    void pop_into(reference destination)
    {
      destination = ETL_MOVE(front());
      pop();
    }
 
    //*************************************************************************
    //*************************************************************************
    template <typename TContainer>
    void pop_into(TContainer& destination)
    {
      destination.push(ETL_MOVE(front()));
      pop();
    }
 
    //*************************************************************************
    //*************************************************************************
    iqueue& operator = (const iqueue& rhs)
    {
      if (&rhs != this)
      {
        clear();
        clone(rhs);
      }
 
      return *this;
    }
 
#if ETL_USING_CPP11
    //*************************************************************************
    //*************************************************************************
    iqueue& operator = (iqueue&& rhs)
    {
      if (&rhs != this)
      {
        clear();
        move_clone(rhs);
      }
 
      return *this;
    }
#endif
 
  protected:
 
    //*************************************************************************
    //*************************************************************************
    void clone(const iqueue& other)
    {
      clear();
 
      size_type index = other.out;
 
      for (size_type i = 0; i < other.size(); ++i)
      {
        push(other.p_buffer[index]);
        index = (index == (CAPACITY - 1)) ? 0 : index + 1;
      }
    }
 
#if ETL_USING_CPP11
    //*************************************************************************
    //*************************************************************************
    void move_clone(iqueue&& other)
    {
      clear();
 
      size_type index = other.out;
 
      for (size_type i = 0; i < other.size(); ++i)
      {
        push(etl::move(other.p_buffer[index]));
        index = (index == (CAPACITY - 1)) ? 0 : index + 1;
      }
    }
#endif
 
    //*************************************************************************
    //*************************************************************************
    iqueue(T* p_buffer_, size_type max_size_)
      : base_t(max_size_),
        p_buffer(p_buffer_)
    {
    }
 
  private:
 
    // Disable copy construction.
    iqueue(const iqueue&);
 
    T* p_buffer; 
 
    //*************************************************************************
    //*************************************************************************
#if defined(ETL_POLYMORPHIC_QUEUE) || defined(ETL_POLYMORPHIC_CONTAINERS)
  public:
    virtual ~iqueue()
    {
    }
#else
  protected:
    ~iqueue()
    {
    }
#endif
  };
 
  //***************************************************************************
  //***************************************************************************
  template <typename T, const size_t SIZE, const size_t MEMORY_MODEL = etl::memory_model::MEMORY_MODEL_LARGE>
  class queue : public etl::iqueue<T, MEMORY_MODEL>
  {
  private:
 
    typedef etl::iqueue<T, MEMORY_MODEL> base_t;
 
  public:
 
    typedef typename base_t::size_type                                                  size_type;
    typedef typename etl::aligned_storage<sizeof(T), etl::alignment_of<T>::value>::type container_type;
 
    ETL_STATIC_ASSERT((SIZE <= etl::integral_limits<size_type>::max), "Size too large for memory model");
 
    static ETL_CONSTANT size_type MAX_SIZE = size_type(SIZE);
 
    //*************************************************************************
    //*************************************************************************
    queue()
      : base_t(reinterpret_cast<T*>(&buffer[0]), SIZE)
    {
    }
 
    //*************************************************************************
    //*************************************************************************
    queue(const queue& rhs)
      : base_t(reinterpret_cast<T*>(&buffer[0]), SIZE)
    {
      base_t::clone(rhs);
    }
 
#if ETL_USING_CPP11
    //*************************************************************************
    //*************************************************************************
    queue(queue&& rhs)
      : base_t(reinterpret_cast<T*>(&buffer[0]), SIZE)
    {
      base_t::move_clone(etl::move(rhs));
    }
#endif
 
    //*************************************************************************
    //*************************************************************************
    ~queue()
    {
      base_t::clear();
    }
 
    //*************************************************************************
    //*************************************************************************
    queue& operator = (const queue& rhs)
    {
      if (&rhs != this)
      {
        base_t::clone(rhs);
      }
 
      return *this;
    }
 
#if ETL_USING_CPP11
    //*************************************************************************
    //*************************************************************************
    queue& operator = (queue&& rhs)
    {
      if (&rhs != this)
      {
        base_t::move_clone(etl::move(rhs));
      }
 
      return *this;
    }
#endif
 
  private:
 
    container_type buffer[SIZE];
  };
 
  template <typename T, const size_t SIZE, const size_t MEMORY_MODEL>
  ETL_CONSTANT typename queue<T, SIZE, MEMORY_MODEL>::size_type queue<T, SIZE, MEMORY_MODEL>::MAX_SIZE;
}
 
#endif