/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the Collabora Office 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/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#include <editable.hxx>
#include <document.hxx>
#include <viewfunc.hxx>
#include <formulacell.hxx>
#include <globstr.hrc>

ScEditableTester::ScEditableTester() = default;

ScEditableTester ScEditableTester::CreateAndTestBlock(const ScDocument& rDoc, SCTAB nTab, SCCOL nStartCol, SCROW nStartRow, SCCOL nEndCol, SCROW nEndRow, bool bNoMatrixAtAll)
{
    ScEditableTester aTester;
    aTester.TestBlock(rDoc, nTab, nStartCol, nStartRow, nEndCol, nEndRow, bNoMatrixAtAll);
    return aTester;
}

ScEditableTester ScEditableTester::CreateAndTestSelectedBlock(const ScDocument& rDoc,
                        SCCOL nStartCol, SCROW nStartRow, SCCOL nEndCol, SCROW nEndRow,
                        const ScMarkData& rMark)
{
    ScEditableTester aTester;
    aTester.TestSelectedBlock(rDoc, nStartCol, nStartRow, nEndCol, nEndRow, rMark);
    return aTester;
}

ScEditableTester ScEditableTester::CreateAndTestRange(const ScDocument& rDoc, const ScRange& rRange, sc::EditAction eAction)
{
    ScEditableTester aTester;
    if (eAction == sc::EditAction::Unknown)
        aTester.TestRange(rDoc, rRange);
    else
        aTester.TestRangeForAction( rDoc, rRange, eAction );
    return aTester;
}

ScEditableTester ScEditableTester::CreateAndTestSelection(const ScDocument& rDoc, const ScMarkData& rMark)
{
    ScEditableTester aTester;
    aTester.TestSelection(rDoc, rMark);
    return aTester;
}

ScEditableTester ScEditableTester::CreateAndTestView(ScViewFunc* pView)
{
    ScEditableTester aTester;
    bool bThisMatrix;
    if ( !pView->SelectionEditable( &bThisMatrix ) )
    {
        aTester.mbIsEditable = false;
        if ( !bThisMatrix )
            aTester.mbOnlyMatrix = false;
    }
    return aTester;
}

ScEditableTester ScEditableTester::CreateAndTestBlockForAction(
    const ScDocument& rDoc, sc::EditAction eAction, SCCOL nStartCol, SCROW nStartRow,
    SCCOL nEndCol, SCROW nEndRow, const ScMarkData& rMark )
{
    ScEditableTester aTester;
    aTester.TestBlockForAction(rDoc, eAction, nStartCol, nStartRow, nEndCol, nEndRow, rMark);
    return aTester;
}

void ScEditableTester::TestBlock( const ScDocument& rDoc, SCTAB nTab,
        SCCOL nStartCol, SCROW nStartRow, SCCOL nEndCol, SCROW nEndRow, bool bNoMatrixAtAll )
{
    if (mbIsEditable || mbOnlyMatrix)
    {
        bool bThisMatrix;
        if (!rDoc.IsBlockEditable( nTab, nStartCol, nStartRow, nEndCol, nEndRow, &bThisMatrix, bNoMatrixAtAll ))
        {
            mbIsEditable = false;
            if ( !bThisMatrix )
                mbOnlyMatrix = false;
        }
    }
}

void ScEditableTester::TestBlockForAction( const ScDocument& rDoc, SCTAB nTab,
        SCCOL nStartCol, SCROW nStartRow, SCCOL nEndCol, SCROW nEndRow, sc::EditAction eAction )
{
    if (mbIsEditable || mbOnlyMatrix)
    {
        mbIsEditable = rDoc.IsEditActionAllowed(eAction, nTab, nStartCol, nStartRow, nEndCol, nEndRow);
    }
}

void ScEditableTester::TestSelectedBlock( const ScDocument& rDoc,
                        SCCOL nStartCol, SCROW nStartRow, SCCOL nEndCol, SCROW nEndRow,
                        const ScMarkData& rMark )
{
    SCTAB nTabCount = rDoc.GetTableCount();
    for (const auto& rTab : rMark)
    {
        if (rTab >= nTabCount)
            break;

        TestBlock( rDoc, rTab, nStartCol, nStartRow, nEndCol, nEndRow, false );
    }
}

void ScEditableTester::TestRange( const ScDocument& rDoc, const ScRange& rRange )
{
    SCCOL nStartCol = rRange.aStart.Col();
    SCROW nStartRow = rRange.aStart.Row();
    SCTAB nStartTab = rRange.aStart.Tab();
    SCCOL nEndCol = rRange.aEnd.Col();
    SCROW nEndRow = rRange.aEnd.Row();
    SCTAB nEndTab = rRange.aEnd.Tab();
    for (SCTAB nTab=nStartTab; nTab<=nEndTab; nTab++)
        TestBlock( rDoc, nTab, nStartCol, nStartRow, nEndCol, nEndRow, false );
}

void ScEditableTester::TestRangeForAction(const ScDocument& rDoc, const ScRange& rRange, sc::EditAction eAction)
{
    SCCOL nStartCol = rRange.aStart.Col();
    SCROW nStartRow = rRange.aStart.Row();
    SCTAB nStartTab = rRange.aStart.Tab();
    SCCOL nEndCol = rRange.aEnd.Col();
    SCROW nEndRow = rRange.aEnd.Row();
    SCTAB nEndTab = rRange.aEnd.Tab();
    for (SCTAB nTab = nStartTab; nTab <= nEndTab; nTab++)
        TestBlockForAction(rDoc, nTab, nStartCol, nStartRow, nEndCol, nEndRow, eAction);
}

void ScEditableTester::TestSelection( const ScDocument& rDoc, const ScMarkData& rMark )
{
    if (mbIsEditable || mbOnlyMatrix)
    {
        bool bThisMatrix;
        if ( !rDoc.IsSelectionEditable( rMark, &bThisMatrix ) )
        {
            mbIsEditable = false;
            if ( !bThisMatrix )
                mbOnlyMatrix = false;
        }
    }
}

void ScEditableTester::TestBlockForAction(
    const ScDocument& rDoc, sc::EditAction eAction, SCCOL nStartCol, SCROW nStartRow,
    SCCOL nEndCol, SCROW nEndRow, const ScMarkData& rMark )
{
    mbOnlyMatrix = false;

    for (const auto& rTab : rMark)
    {
        if (!mbIsEditable)
            return;

        mbIsEditable = rDoc.IsEditActionAllowed(eAction, rTab, nStartCol, nStartRow, nEndCol, nEndRow);
    }
}

TranslateId ScEditableTester::GetMessageId() const
{
    if (mbIsEditable)
        return {};
    else if (mbOnlyMatrix)
        return STR_MATRIXFRAGMENTERR;
    else
        return STR_PROTECTIONERR;
}

bool ScEditableTester::IsEditableOrMatrixCell(const ScDocument& rDoc,
                                              const ScAddress& rPos) const
{
    if (mbIsEditable)
        return true;
    if (!mbOnlyMatrix)
        return false;
    const ScFormulaCell* pCell = rDoc.GetFormulaCell(rPos);
    if (!pCell)
        return false;
    const ScMatrixMode eFlag = pCell->GetMatrixFlag();
    return eFlag == ScMatrixMode::Reference || eFlag == ScMatrixMode::Formula;
}

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