/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */

#ifndef INCLUDED_SC_INC_REFUPDATECONTEXT_HXX
#define INCLUDED_SC_INC_REFUPDATECONTEXT_HXX

#include "global.hxx"
#include "address.hxx"
#include "columnset.hxx"

#include <unordered_map>
#include <unordered_set>

class ScDocument;

namespace sc {

/**
 * Keep track of all named expressions that have been updated during
 * reference update.
 *
 * Can also be used to collect any set of named expressions / ranges.
 */
class UpdatedRangeNames
{
public:
    typedef std::unordered_set<sal_uInt16> NameIndicesType;

    void setUpdatedName(SCTAB nTab, sal_uInt16 nIndex);
    bool isNameUpdated(SCTAB nTab, sal_uInt16 nIndex) const;
    NameIndicesType getUpdatedNames(SCTAB nTab) const;
    bool isEmpty(SCTAB nTab) const;

private:
    typedef std::unordered_map<SCTAB, NameIndicesType> UpdatedNamesType;

    UpdatedNamesType maUpdatedNames;
};

/**
 * Context for reference update during shifting, moving or copying of cell
 * ranges.
 */
struct RefUpdateContext
{
    ScDocument& mrDoc;

    /**
     * update mode - insert/delete, copy, or move. The reorder mode (which
     * corresponds with the reordering of sheets) is not used with this
     * context.
     */
    UpdateRefMode meMode;

    /**
     * Range of cells that are about to be moved for insert/delete/move modes.
     * For copy mode, it's the destination range of cells that are about to be
     * pasted.  When moving a range of cells, it's the destination range, not
     * the source range.
     */
    ScRange maRange;

    /** Amount and direction of movement in the column direction. */
    SCCOL mnColDelta;
    /** Amount and direction of movement in the row direction. */
    SCROW mnRowDelta;
    /** Amount and direction of movement in the sheet direction. */
    SCTAB mnTabDelta;

    UpdatedRangeNames maUpdatedNames;
    ColumnSet maRegroupCols;

    RefUpdateContext(ScDocument& rDoc);

    bool isInserted() const;
    bool isDeleted() const;
};

struct RefUpdateResult
{
    /**
     * When this flag is true, the result of the formula needs to be
     * re-calculated either because it contains a reference that's been
     * deleted, or the size of a range reference has changed.
     */
    bool mbValueChanged;

    /**
     * This flag indicates whether any reference in the token array has been
     * modified.
     */
    bool mbReferenceModified;

    /**
     * When this flag is true, it indicates that the token array contains a
     * range name that's been updated.
     */
    bool mbNameModified;

    RefUpdateResult();
};

struct SC_DLLPUBLIC RefUpdateInsertTabContext
{
    ScDocument& mrDoc;
    SCTAB const mnInsertPos;
    SCTAB const mnSheets;
    UpdatedRangeNames maUpdatedNames;

    RefUpdateInsertTabContext(ScDocument& rDoc, SCTAB nInsertPos, SCTAB nSheets);
};

struct SC_DLLPUBLIC RefUpdateDeleteTabContext
{
    ScDocument& mrDoc;
    SCTAB const mnDeletePos;
    SCTAB const mnSheets;
    UpdatedRangeNames maUpdatedNames;

    RefUpdateDeleteTabContext(ScDocument& rDoc, SCTAB nInsertPos, SCTAB nSheets);
};

struct RefUpdateMoveTabContext
{
    ScDocument& mrDoc;
    SCTAB const mnOldPos;
    SCTAB const mnNewPos;
    UpdatedRangeNames maUpdatedNames;

    RefUpdateMoveTabContext(ScDocument& rDoc, SCTAB nOldPos, SCTAB nNewPos);

    SCTAB getNewTab(SCTAB nOldTab) const;
};

struct SetFormulaDirtyContext
{
    SCTAB mnTabDeletedStart;
    SCTAB mnTabDeletedEnd;

    /**
     * When true, go through all reference tokens and clears "sheet deleted"
     * flag if its corresponding index falls within specified sheet range.
     */
    bool mbClearTabDeletedFlag;

    SetFormulaDirtyContext();
};

}

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
