BitIterator.hpp

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
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.
 
Library: Base
File: BitIterator
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/BaseValues.h>
#include <NDEVR/BitFlag.h>
#include <NDEVR/BitReference.h>
#include <iterator>
namespace NDEVR
{
    class BitIterator
    {
    public:
        friend class ConstBitIterator;
        BitIterator(BitFlag* flag, const sint04 offset)
            : m_flag(flag)
        {
            checkBitLocationPositive(offset);
        }
        BitIterator(const BitIterator& iter) = default;
 
        bool operator!() const
        {
            return !(*m_flag)[m_bit_ref];
        }
        constexpr operator bool() const
        {
            return (*m_flag)[m_bit_ref];
        }
        BitReference operator*()
        {
            return BitReference(*m_flag, m_bit_ref);
        }
        const BitReference operator*() const
        {
            return BitReference(*m_flag, m_bit_ref);
        }
        bool byteAligned() const
        {
            return m_bit_ref == 0;
        }
        void jumpByte()
        {
            m_flag++;
        }
        const BitFlag& byteFlag() const
        {
            return *m_flag;
        }
        const BitFlag& byteFlag(uint04 offset) const
        {
            return *(m_flag + offset);
        }
        BitIterator& operator++()
        {
            if (m_bit_ref == 7)
            {
                m_flag++;
                m_bit_ref = 0;
            }
            else
            {
                m_bit_ref++;
            }
            return *this;
        }
        BitIterator& operator--()
        {
            if (m_bit_ref == 0)
            {
                m_bit_ref = 7;
                m_flag--;
            }
            else
            {
                m_bit_ref--;
            }
            return *this;
        }
        BitIterator operator++(int)
        {
            BitIterator old_value(*this);
            if (m_bit_ref == 7)
            {
                m_flag++;
                m_bit_ref = 0;
            }
            else
            {
                m_bit_ref++;
            }
            return old_value;
        }
        BitIterator operator--(int)
        {
            BitIterator old_value(*this);
            if (m_bit_ref == 0)
            {
                m_bit_ref = 7;
                m_flag--;
            }
            else
            {
                m_bit_ref--;
            }
            return old_value;
        }
        template<class t_type>
        BitIterator& operator+=(const t_type& movement)
        {
            checkBitLocationPositive(cast<sint04>(m_bit_ref) + cast<sint04>(movement));
            return (*this);
        }
        template<class t_type>
        BitIterator& operator-=(const t_type& movement)
        {
            checkBitLocationNegative(cast<sint04>(m_bit_ref) - cast<sint04>(movement));
            return (*this);
        }
#ifdef _DEBUG
        bool operator>=(const bool*) const { return false; };//needed for buffer compat
        bool operator<=(const bool*) const { return true; };//needed for buffer compat
        bool operator<(const bool*) const { return true; };//needed for buffer compat
        bool operator>(const bool*) const { return false; };//needed for buffer compat
#endif
        bool operator>(const BitIterator& other) const
        {
            if (m_flag == other.m_flag)
                return m_bit_ref > other.m_bit_ref;
            else
                return m_flag > other.m_flag;
        }
        bool operator<(const BitIterator& other) const
        {
            if (m_flag == other.m_flag)
                return m_bit_ref < other.m_bit_ref;
            else
                return m_flag < other.m_flag;
        }
        ptrdiff_t operator-(const BitIterator& rhs)
        {
            ptrdiff_t byte_diff = this->m_flag - rhs.m_flag;
            ptrdiff_t bit_diff = this->m_bit_ref - rhs.m_bit_ref;
            return byte_diff * 8 + bit_diff;
        }
        template<class t_type>
        BitIterator operator+(t_type distance) const
        {
            BitIterator sum = *this;
            sum.checkBitLocationPositive(cast<sint04>(sum.m_bit_ref) + cast<sint04>(distance));
            return sum;
        }
        template<class t_type>
        BitIterator operator-(t_type distance) const
        {
            BitIterator sum = *this;
            sum.checkBitLocationNegative(cast<sint04>(sum.m_bit_ref) - cast<sint04>(distance));
            return sum;
        }
    public:
        BitIterator& operator=(const BitIterator& rawIterator) = default;
 
        bool operator==(const BitIterator& rawIterator) const { return (m_bit_ref == rawIterator.m_bit_ref && m_flag == rawIterator.m_flag); }
        bool operator!=(const BitIterator& rawIterator) const { return (m_bit_ref != rawIterator.m_bit_ref || m_flag != rawIterator.m_flag); }
 
    private:
        void checkBitLocationPositive(sint04 bit) const
        {
            if (bit >= 8)
            {
                m_flag += (bit / 8);
                bit = bit % 8;
            }
            m_bit_ref = cast<uint01>(bit);
        }
        void checkBitLocationNegative(sint04 bit) const
        {
            if (bit <= 0)
            {
                bit = -bit + 8;
                m_flag -= (bit / 8);
                bit = bit % 8;
            }
            m_bit_ref = cast<uint01>(bit);
        }
        mutable BitFlag* m_flag;
        mutable uint01 m_bit_ref = Constant<uint01>::Invalid;
    };

    class ConstBitIterator
    {
    public:
        friend class BitIterator;
        ConstBitIterator(const BitIterator& iter)
            : m_flag(iter.m_flag)
            , m_bit_ref(iter.m_bit_ref)
        {}
        ConstBitIterator(const BitFlag* flag, sint04 offset)
            : m_flag(flag)
        {
            checkBitLocationPositive(offset);
        }
        ConstBitIterator(const BitFlag* flag, uint04 offset)
            : m_flag(flag)
        {
            checkBitLocationPositive(cast<sint04>(offset));
        }
        ConstBitIterator(const ConstBitIterator& iter) = default;
 
        bool operator*()
        {
            return (*m_flag)[m_bit_ref];
        }
        bool operator*() const
        {
            return (*m_flag)[m_bit_ref];
        }
        bool operator==(bool ref) const
        {
            return (*m_flag)[m_bit_ref] == ref;
        }
        bool operator!() const
        {
            return !(*m_flag)[m_bit_ref];
        }
        constexpr operator bool() const
        {
            return (*m_flag)[m_bit_ref];
        }
        bool operator>(const BitIterator& other) const
        {
            if (m_flag == other.m_flag)
                return m_bit_ref > other.m_bit_ref;
            else
                return m_flag > other.m_flag;
        }
        bool operator<(const BitIterator& other) const
        {
            if (m_flag == other.m_flag)
                return m_bit_ref < other.m_bit_ref;
            else
                return m_flag < other.m_flag;
        }
        bool operator>(const ConstBitIterator& other) const
        {
            if (m_flag == other.m_flag)
                return m_bit_ref > other.m_bit_ref;
            else
                return m_flag > other.m_flag;
        }
        bool operator<(const ConstBitIterator& other) const
        {
            if (m_flag == other.m_flag)
                return m_bit_ref < other.m_bit_ref;
            else
                return m_flag < other.m_flag;
        }
        bool byteAligned() const
        {
            return m_bit_ref == 0;
        }
        void jumpByte()
        {
            m_flag++;
        }
        const BitFlag& byteFlag() const
        {
            return *m_flag;
        }
        const BitFlag& byteFlag(uint04 offset) const
        {
            return *(m_flag + offset);
        }
        ConstBitIterator& operator++()
        {
            if (m_bit_ref == 7)
            {
                m_flag++;
                m_bit_ref = 0;
            }
            else
            {
                m_bit_ref++;
            }
            return *this;
        }
        ConstBitIterator& operator--()
        {
            if (m_bit_ref == 0)
            {
                m_bit_ref = 7;
                m_flag--;
            }
            else
            {
                m_bit_ref--;
            }
            return *this;
        }
        ConstBitIterator operator++(int)
        {
            ConstBitIterator old_value(*this);
            if (m_bit_ref == 7)
            {
                m_flag++;
                m_bit_ref = 0;
            }
            else
            {
                m_bit_ref++;
            }
            return old_value;
        }
        ConstBitIterator operator--(int)
        {
            ConstBitIterator old_value(*this);
            if (m_bit_ref == 0)
            {
                m_bit_ref = 7;
                m_flag--;
            }
            else
            {
                m_bit_ref--;
            }
            return old_value;
        }
        template<class t_type>
        ConstBitIterator& operator+=(const t_type& movement)
        {
            checkBitLocationPositive(cast<sint04>(m_bit_ref) + cast<sint04>(movement));
            return (*this);
        }
        template<class t_type>
        ConstBitIterator& operator-=(const t_type& movement)
        {
            checkBitLocationNegative(cast<sint04>(m_bit_ref) - cast<sint04>(movement));
            return (*this);
        }
 
        ptrdiff_t operator-(const ConstBitIterator& rhs)
        {
            ptrdiff_t byte_diff = this->m_flag - rhs.m_flag;
            ptrdiff_t bit_diff = this->m_bit_ref - rhs.m_bit_ref;
            return byte_diff * 8 + bit_diff;
        }
 
    public:
        ConstBitIterator& operator=(const ConstBitIterator& rawIterator) = default;
 
        bool operator==(const ConstBitIterator& rawIterator) const { return (m_bit_ref == rawIterator.m_bit_ref && m_flag == rawIterator.m_flag); }
        bool operator!=(const ConstBitIterator& rawIterator) const { return (m_bit_ref != rawIterator.m_bit_ref || m_flag != rawIterator.m_flag); }
        bool operator==(const BitIterator& rawIterator) const { return (m_bit_ref == rawIterator.m_bit_ref && m_flag == rawIterator.m_flag); }
        bool operator!=(const BitIterator& rawIterator) const { return (m_bit_ref != rawIterator.m_bit_ref || m_flag != rawIterator.m_flag); }
        template<class t_type>
        ConstBitIterator operator+(const t_type& movement)
        {
            ConstBitIterator sum(*this);
            sum += movement;
            return sum;
        }
        template<class t_type>
        ConstBitIterator operator-(const t_type& movement)
        {
            ConstBitIterator sum(*this);
            sum -= movement;
            return sum;
        }
    private:
        void checkBitLocationPositive(sint04 bit) const
        {
            if (bit >= 8)
            {
                m_flag += (bit / 8);
                bit = bit % 8;
            }
            m_bit_ref = cast<uint01>(bit);
        }
        void checkBitLocationNegative(sint04 bit) const
        {
            if (bit <= 0)
            {
                bit = -bit + 8;
                m_flag -= (bit / 8);
                bit = bit % 8;
            }
            m_bit_ref = cast<uint01>(bit);
        }
        mutable const BitFlag* m_flag;
        mutable uint01 m_bit_ref = Constant<uint01>::Invalid;
    };
}