Saf/Collection/Queue.h

Go to the documentation of this file.

/*
    This file is part of Simple Application Framework (Saf) library.
    Copyright (C) 2010 - 2012 Ondrej Danek <ondrej.danek@gmail.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, either version 3 of the License, or
    (at your option) any later version.

    Saf 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Simple Application Framework library. If not, 
    see <http://www.gnu.org/licenses/>.
*/

#ifndef SAF_COLLECTION_QUEUE_H
#define SAF_COLLECTION_QUEUE_H

#include "../Type.h"
#include "../Algo/Swap.h"
#include "Deque.h"

namespace Saf
{
    namespace Collection
    {
        template <class ValType, class ContainerType = Deque<ValType> > 
        class Queue
        {
        protected:
            typedef Queue<ValType,ContainerType> MyType;

        private:
            ContainerType m_storage;
            Size m_elems;

        public:
            Queue()
                : m_elems(0)
            {}

            Queue(const MyType& queue)
                : m_storage(queue.m_storage), m_elems(queue.m_elems)
            {}

            explicit Queue(const ContainerType& cont)
                : m_storage(cont)
            {
                m_elems = Algo::Range::Distance(cont.Begin(), cont.End());
            }

            MyType& operator=(MyType& queue)
            {
                m_storage = queue.m_storage;
                m_elems = queue.m_elems;
                return *this;
            }

            MyType& Swap(MyType& queue)
            {
                Algo::Swap(m_storage, queue.m_storage);
                Algo::Swap(m_elems, queue.m_elems);
                return *this;
            }

            bool IsEmpty() const
            {
                return m_storage.IsEmpty();
            }

            Size Elements() const
            {
                return m_elems;
            }

            ValType& Front()
            {
                return *m_storage.Front();
            }

            const ValType& Front() const
            {
                return *m_storage.Front();
            }

            ValType& Back()
            {
                return *m_storage.Back();
            }

            const ValType& Back() const
            {
                return *m_storage.Back();
            }

            MyType& Push(const ValType& val)
            {
                m_storage.PushBack(val);
                ++m_elems;
                return *this;
            }

            MyType& Pop()
            {
                --m_elems;
                m_storage.PopFront();
                return *this;
            }

            const ContainerType& Container() const
            {
                return m_storage;
            }
        };
    }

    namespace Algo
    {
        // Swap specialization for a queue container.
        template <class ValType, class ContainerType>
        struct SwapFunc< Collection::Queue<ValType,ContainerType> >
        {
            void operator()(Collection::Queue<ValType,ContainerType>& x, 
                Collection::Queue<ValType,ContainerType>& y)
            {
                x.Swap(y);
            }
        };
    }
}

#endif