iqueue.h

Go to the documentation of this file.

/******************************************************************************
The MIT License(MIT)

Embedded Template Library.

Copyright(c) 2014 jwellbelove

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_IQUEUE__
#define __ETL_IQUEUE__
#define __ETL_IN_IQUEUE_H__

#include <stddef.h>

#include "queue_base.h"
#include "type_traits.h"
#include "parameter_type.h"

#ifndef ETL_THROW_EXCEPTIONS
#include "error_handler.h"
#endif

namespace etl
{
  //***************************************************************************
  //***************************************************************************
  template <typename T>
  class iqueue : public queue_base
  {
  public:

    typedef T                     value_type;      
    typedef T&                    reference;       
    typedef const T&              const_reference; 
    typedef T*                    pointer;         
    typedef const T*              const_pointer;   
    typedef queue_base::size_type size_type;       

  private:

    typedef typename parameter_type<T>::type parameter_t;

  public:

    //*************************************************************************
    //*************************************************************************
    reference front()
    {
      return buffer[out];
    }

    //*************************************************************************
    //*************************************************************************
    const_reference front() const
    {
      return buffer[out];
    }

    //*************************************************************************
    //*************************************************************************
    reference back()
    {
      return buffer[in == 0 ? MAX_SIZE - 1 : in - 1];
    }

    //*************************************************************************
    //*************************************************************************
    const_reference back() const
    {
      return buffer[in == 0 ? MAX_SIZE - 1 : in - 1];
    }

    //*************************************************************************
    //*************************************************************************
    void push(parameter_t item)
    {
      if (!full())
      {
        buffer[in] = item;
        in = (in == (MAX_SIZE - 1)) ? 0 : in + 1;
        ++current_size;
      }
      else
#ifdef ETL_THROW_EXCEPTIONS
      {
        throw queue_full();
      }
#else
      {
        error_handler::error(queue_full());
      }
#endif
    }

    //*************************************************************************
    //*************************************************************************
    reference push()
    {
      const size_type next = in;

      if (!full())
      {
        in = (in == (MAX_SIZE - 1)) ? 0 : in + 1;
        ++current_size;
      }
      else
#ifdef ETL_THROW_EXCEPTIONS
      {
        throw queue_full();
      }
#else
      {
        error_handler::error(queue_full());
      }
#endif

      return buffer[next];
    }

  protected:

    //*************************************************************************
    //*************************************************************************
    iqueue(T* buffer, size_type max_size)
      : queue_base(max_size),
        buffer(buffer)
    {
    }

  private:

    T* buffer; 
  };
}

#undef __etl_in_iqueue_h__
#endif