odfstudio/sc/qa/unit/functions_dynamic_array.cxx

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
/*
 * 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/.
 */

#include "helper/qahelper.hxx"

#include <address.hxx>
#include <document.hxx>
#include <rtl/string.hxx>
#include <rtl/ustring.hxx>

class DynamicArrayTest : public ScModelTestBase
{
public:
    DynamicArrayTest()
        : ScModelTestBase(u"sc/qa/unit/data"_ustr)
    {
    }
};

namespace
{
// Walk column C from row 5 down to nLastRow on the given sheet. Every non-empty C cell is an
// equality comparison for that row and has to evaluate to 1. The whole column is read before
// anything is reported, so one run lists every row that disagreed instead of stopping at the
// first one, and the report says at which stage of the test they disagreed.
void assertRowChecks(ScDocument& rDocument, SCTAB nTab, SCROW nLastRow, const char* pStage = "")
{
    OString aRows;
    for (SCROW nRow = 4; nRow <= nLastRow; ++nRow)
    {
        ScAddress aPosition(2, nRow, nTab);
        if (rDocument.GetCellType(aPosition) == CELLTYPE_NONE)
            continue;
        if (rDocument.GetValue(aPosition) == 1.0)
            continue;
        if (!aRows.isEmpty())
            aRows += ", ";
        // Print the two values the comparison used, so a failing row already says what we
        // computed and what was expected.
        OString aOurs
            = OUStringToOString(rDocument.GetString(0, nRow, nTab), RTL_TEXTENCODING_UTF8);
        OString aExpected
            = OUStringToOString(rDocument.GetString(1, nRow, nTab), RTL_TEXTENCODING_UTF8);
        aRows += "C" + OString::number(nRow + 1) + " (A=" + aOurs + " B=" + aExpected;
        // The tested cell is in column F or G, depending on the layout of the row. Print
        // its value and the formula it reads back as.
        for (SCCOL nColumn = 5; nColumn <= 6; ++nColumn)
        {
            if (rDocument.GetCellType(ScAddress(nColumn, nRow, nTab)) == CELLTYPE_NONE)
                continue;
            aRows += OString::Concat(nColumn == 5 ? " F=" : " G=")
                     + OUStringToOString(rDocument.GetString(nColumn, nRow, nTab),
                                         RTL_TEXTENCODING_UTF8);
            OUString aFormula = rDocument.GetFormula(nColumn, nRow, nTab);
            if (!aFormula.isEmpty())
                aRows += " [" + OUStringToOString(aFormula, RTL_TEXTENCODING_UTF8) + "]";
        }
        aRows += ")";
    }
    if (aRows.isEmpty())
        return;

    OString aLabel = "Sheet" + OString::number(nTab + 1)
                     + " verdict cells that did not "
                       "evaluate to TRUE";
    if (*pStage)
        aLabel += OString::Concat(" ") + pStage;
    aLabel += ": " + aRows;
    CPPUNIT_FAIL(aLabel.getStr());
}
}

CPPUNIT_TEST_FIXTURE(DynamicArrayTest, testDynamicArrayXlsxRoundTrip)
{
    createScDoc("functions/dynamic_array/xlsx/DynamicArrayFixture.xlsx");

    auto checkVerdicts = [this]() {
        ScDocument* pDocument = getScDoc();
        // Sheet 1 "CSE Array Spill Cases", master cell A3 = AND(C5:C400).
        assertRowChecks(*pDocument, 0, 399);
        CPPUNIT_ASSERT_EQUAL(1.0, pDocument->GetValue(ScAddress(0, 2, 0)));
        // Sheet 2 "Implicit intersection Operator", master cell A3 = AND(C5:C200).
        assertRowChecks(*pDocument, 1, 199);
        CPPUNIT_ASSERT_EQUAL(1.0, pDocument->GetValue(ScAddress(0, 2, 1)));
        // Sheet 3 "Spill Operator", master cell A3 = AND(C5:C508).
        assertRowChecks(*pDocument, 2, 507);
        CPPUNIT_ASSERT_EQUAL(1.0, pDocument->GetValue(ScAddress(0, 2, 2)));
    };

    // The self-checking workbook holds after import, and again after an
    // XLSX save and reload.
    checkVerdicts();
    saveAndReload(TestFilter::XLSX);
    checkVerdicts();
}

CPPUNIT_TEST_FIXTURE(DynamicArrayTest, testDroppedImplicitIntersectionIsPutBack)
{
    // OOXML leaves the @ of a plain =@ref# cell out of the text, expressing it by keeping
    // the cell a non-array formula, so the import puts it back. An array formula does not
    // reduce its operand, so it keeps the spelling it was saved with.
    createScDoc("functions/dynamic_array/xlsx/DynamicArrayFixture.xlsx");
    ScDocument* pDocument = getScDoc();

    // "Implicit intersection Operator" F44 is a plain _xlfn.ANCHORARRAY($G$45).
    CPPUNIT_ASSERT_EQUAL(u"=@$G$45#"_ustr, pDocument->GetFormula(5, 43, 1));

    // "Spill Operator" A34 is the same call as an array formula.
    CPPUNIT_ASSERT_EQUAL(u"=$H$5#"_ustr, pDocument->GetFormula(0, 33, 2));
}

CPPUNIT_TEST_FIXTURE(DynamicArrayTest, testUnionSpillIntersectionOperatorXlsxRoundTrip)
{
    createScDoc("functions/dynamic_array/xlsx/UnionSpillIntersectionOperatorTest.xlsx");

    auto checkVerdicts = [this](const char* pStage) {
        ScDocument* pDocument = getScDoc();
        assertRowChecks(*pDocument, 0, 200, pStage);
    };

    // J112 is the shape OOXML saves without its @, so the import puts it back.
    CPPUNIT_ASSERT_EQUAL(u"=@$I$112#"_ustr, getScDoc()->GetFormula(9, 111, 0));

    // The workbook is another application's, so the first check is against its stored
    // results and each later one against ours, with the save and reload covering the export.
    checkVerdicts("on import");
    getScDoc()->CalcAll();
    checkVerdicts("after a recalculation");
    saveAndReload(TestFilter::XLSX);
    checkVerdicts("after a save and reload");
    getScDoc()->CalcAll();
    checkVerdicts("after a recalculation of the reloaded document");
}

CPPUNIT_PLUGIN_IMPLEMENT();

/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */