queue_base.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_IN_IQUEUE_H__
#error This header is a private element of etl::queue & etl::iqueue
#endif

#ifndef __ETL_QUEUE_BASE__
#define __ETL_QUEUE_BASE__

#include <stddef.h>

#include "exception.h"

namespace etl
{
  //***************************************************************************
  //***************************************************************************
  class queue_exception : public exception
  {
  public:

    queue_exception(const char* what)
      : exception(what)
    {
    }
  };

  //***************************************************************************
  //***************************************************************************
  class queue_full : public queue_exception
  {
  public:

    queue_full()
      : queue_exception("queue: full")
    {
    }
  };

  //***************************************************************************
  //***************************************************************************
  class queue_base
  {
  public:

    typedef size_t size_type; 

    //*************************************************************************
    //*************************************************************************
    size_type size() const
    {
      return current_size;
    }

    //*************************************************************************
    //*************************************************************************
    size_type capacity() const
    {
      return MAX_SIZE;
    }

    //*************************************************************************
    //*************************************************************************
    size_type max_size() const
    {
      return MAX_SIZE;
    }

    //*************************************************************************
    //*************************************************************************
    bool empty() const
    {
      return current_size == 0;
    }

    //*************************************************************************
    //*************************************************************************
    bool full() const
    {
      return current_size == MAX_SIZE;
    }

    //*************************************************************************
    //*************************************************************************
    size_t available() const
    {
      return max_size() - size();
    }

    //*************************************************************************
    //*************************************************************************
    void clear()
    {
      in  = 0;
      out = 0;
      current_size = 0;
    }

    //*************************************************************************
    //*************************************************************************
    void pop()
    {
      if (!empty())
      {
        out = (out == (MAX_SIZE - 1)) ? 0 : out + 1;
        --current_size;
      }
    }

  protected:

    //*************************************************************************
    //*************************************************************************
    queue_base(size_type max_size)
      : MAX_SIZE(max_size)
    {
      clear();
    }

    size_type in;             
    size_type out;            
    size_type current_size;   
    const size_type MAX_SIZE; 
  };
}

#endif