selection.hpp

// Copyright (c) 2014-2022 Thomas Fussell
// Copyright (c) 2024-2026 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 <vector>

#include <xlnt/xlnt_config.hpp>
#include <xlnt/cell/cell_reference.hpp>
#include <xlnt/worksheet/pane.hpp>
#include <xlnt/worksheet/range_reference.hpp>
#include <xlnt/utils/exceptions.hpp>
#include <xlnt/utils/optional.hpp>

namespace xlnt {

class XLNT_API selection
{
public:
    explicit selection() = default;

    explicit selection(pane_corner quadrant, cell_reference active_cell)
        : active_cell_(active_cell), sqref_({range_reference(active_cell, active_cell)}), pane_(quadrant)
    {
    }

    explicit selection(pane_corner quadrant, cell_reference active_cell, range_reference selected)
        : active_cell_(active_cell), sqref_({selected}), pane_(quadrant)
    {
    }

    bool has_active_cell() const
    {
        return active_cell_.is_set();
    }

    cell_reference active_cell() const
    {
        if (!active_cell_.is_set())
        {
            throw xlnt::invalid_attribute("selection has no active cell");
        }
        return active_cell_.get();
    }

    void active_cell(const cell_reference &ref)
    {
        active_cell_ = ref;
    }

    void clear_active_cell()
    {
        active_cell_.clear();
    }

    bool has_sqref() const
    {
        return !sqref_.empty();
    }

    XLNT_DEPRECATED range_reference sqref() const
    {
        if (!has_sqref())
            throw invalid_attribute("the selection has no sqref");

        return sqref_.front();
    }

    const std::vector<range_reference>& sqrefs() const
    {
        return sqref_;
    }

    void sqref(const range_reference &ref)
    {
        sqref_ = {ref};
    }

    void sqref(const std::vector<range_reference> &ref)
    {
        sqref_ = ref;
    }

    void sqref(const std::string &ref);

    pane_corner pane() const
    {
        return pane_;
    }

    void pane(pane_corner corner)
    {
        pane_ = corner;
    }

    bool operator==(const selection &rhs) const
    {
        return active_cell_ == rhs.active_cell_
            && sqref_ == rhs.sqref_
            && pane_ == rhs.pane_;
    }

    // <summary>
    bool operator!=(const selection &rhs) const
    {
        return !(*this == rhs);
    }

private:
    optional<cell_reference> active_cell_;

    std::vector<range_reference> sqref_;

    pane_corner pane_ = pane_corner::top_left;
};

} // namespace xlnt