image_symbol_iterator.hpp

Go to the documentation of this file.

// ===-- include/psystem/image_symbol_iterator.hpp -------- -*- C++ -*- --=== //
// Copyright (c) 2015 Matt Bisson.  All rights reserved.

#pragma once
#ifndef PSYSTEM_IMAGE_SYMBOL_ITERATOR_HPP
#define PSYSTEM_IMAGE_SYMBOL_ITERATOR_HPP

#include "psystem_ns.hpp"

#include <iterator>

namespace psystem {

class image_symbol_iterator
    : public std::iterator<std::random_access_iterator_tag, IMAGE_SYMBOL const>
{
public:
    explicit image_symbol_iterator(psystem::address_t const in_ptr) noexcept;

    image_symbol_iterator(image_symbol_iterator const& o) noexcept;

    ~image_symbol_iterator() noexcept;

    image_symbol_iterator& operator=(image_symbol_iterator const& o) noexcept;

public:
    // Basic equality:

    bool operator==(image_symbol_iterator const& other) const noexcept;

    bool operator!=(image_symbol_iterator const& other) const noexcept;

    // "Magnitude" Comparison:

    bool operator<(image_symbol_iterator const& o) const noexcept;

    bool operator<=(image_symbol_iterator const& o) const noexcept;

    bool operator>(image_symbol_iterator const& o) const noexcept;

    bool operator>=(image_symbol_iterator const& o) const noexcept;

    // Data Access

    reference operator*() const noexcept;

    pointer operator->() const noexcept;

    void swap(image_symbol_iterator& o) noexcept;

public:
    // Data Access

    reference operator[](size_t const count) const noexcept;

    // Increment

    image_symbol_iterator operator++(int) noexcept;

    image_symbol_iterator& operator++() noexcept;

    image_symbol_iterator& operator+=(size_t const count) noexcept;

    // Decrement

    image_symbol_iterator operator--(int) noexcept;

    image_symbol_iterator& operator--() noexcept;

    image_symbol_iterator& operator-=(size_t const count) noexcept;

    image_symbol_iterator operator-(size_t const count) const noexcept;

    difference_type operator-(image_symbol_iterator const& it) const noexcept;

private:
    IMAGE_SYMBOL const *m_current_symbol;
};


image_symbol_iterator operator+(
    image_symbol_iterator const& it, size_t const count) noexcept;

image_symbol_iterator operator+(
    size_t const count, image_symbol_iterator const& it) noexcept;

} // namespace psystem

namespace std {

inline void
swap(
    psystem::image_symbol_iterator& it1,
    psystem::image_symbol_iterator& it2) noexcept
{
    it1.swap(it2);
}

}

#endif // PSYSTEM_IMAGE_SYMBOL_ITERATOR_HPP