cell_iterator.hpp

// Copyright (c) 2014-2022 Thomas Fussell
// Copyright (c) 2010-2015 openpyxl
// Copyright (c) 2024-2025 xlnt-community
//
// 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
//
// @license: http://www.opensource.org/licenses/mit-license.php
// @author: see AUTHORS file

#pragma once

#include <cstddef> // std::ptrdiff_t
#include <iterator>

#include <xlnt/xlnt_config.hpp>
#include <xlnt/cell/cell_reference.hpp>
#include <xlnt/worksheet/major_order.hpp>
#include <xlnt/worksheet/range_reference.hpp>
#include <xlnt/worksheet/worksheet.hpp>

namespace xlnt {

enum class major_order;

class cell;
class cell_reference;
class range_reference;

class XLNT_API cell_iterator
{
public:
    using iterator_category = std::bidirectional_iterator_tag;
    using value_type = cell;
    using difference_type = std::ptrdiff_t;
    using pointer = cell *;
    using reference = cell; // intentionally value

    cell_iterator() = default;

    cell_iterator(worksheet ws, const cell_reference &start_cell,
        const range_reference &limits, major_order order, bool skip_null, bool wrap);

    cell_iterator(const cell_iterator &) = default;

    cell_iterator &operator=(const cell_iterator &) = default;

    cell_iterator(cell_iterator &&) = default;

    cell_iterator &operator=(cell_iterator &&) = default;

    ~cell_iterator() = default;

    reference operator*();

    const reference operator*() const;

    bool operator==(const cell_iterator &other) const;

    bool operator!=(const cell_iterator &other) const;

    cell_iterator &operator--();

    cell_iterator operator--(int);

    cell_iterator &operator++();

    cell_iterator operator++(int);

    bool has_value() const;

private:
    bool skip_null_ = false;

    bool wrap_ = false;

    major_order order_ = major_order::column;

    worksheet ws_;

    cell_reference cursor_;

    range_reference bounds_;
};

class XLNT_API const_cell_iterator
{
public:
    using iterator_category = std::bidirectional_iterator_tag;
    using value_type = const cell;
    using difference_type = std::ptrdiff_t;
    using pointer = const cell *;
    using reference = const cell; // intentionally value

    const_cell_iterator() = default;

    const_cell_iterator(worksheet ws, const cell_reference &start_cell,
        const range_reference &limits, major_order order, bool skip_null, bool wrap);

    const_cell_iterator(const const_cell_iterator &) = default;

    const_cell_iterator &operator=(const const_cell_iterator &) = default;

    const_cell_iterator(const_cell_iterator &&) = default;

    const_cell_iterator &operator=(const_cell_iterator &&) = default;

    ~const_cell_iterator() = default;

    const reference operator*() const;

    bool operator==(const const_cell_iterator &other) const;

    bool operator!=(const const_cell_iterator &other) const;

    const_cell_iterator &operator--();

    const_cell_iterator operator--(int);

    const_cell_iterator &operator++();

    const_cell_iterator operator++(int);

    bool has_value() const;

private:
    bool skip_null_ = false;

    bool wrap_ = false;

    major_order order_ = major_order::column;

    worksheet ws_;

    cell_reference cursor_;

    range_reference bounds_;
};

} // namespace xlnt