sc/qa/unit/screenshots/screenshots.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #include <memory>
  11 #include <test/screenshot_test.hxx>
  12
  13 #include <sfx2/sfxdlg.hxx>
  14 #include <svx/numinf.hxx>
  15 #include <svx/svxids.hrc>
  16 #include <tools/stream.hxx>
  17
  18 #include <tabvwsh.hxx>
  19 #include <docsh.hxx>
  20 #include <document.hxx>
  21 #include <scabstdlg.hxx>
  22 #include <scui_def.hxx>
  23 #include <patattr.hxx>
  24
  25 #include <strings.hrc>
  26 #include <scresid.hxx>
  27 #include <scitems.hxx>
  28
  29 using namespace css;
  30
  31 class ScScreenshotTest : public ScreenshotTest
  32 {
  33 private:
  34     /// members
  35     uno::Reference<lang::XComponent>        mxComponent;
  36     SfxObjectShell*                         mpFoundShell;
  37     ScDocShellRef                           mxDocSh;
  38     ScTabViewShell*                         mpViewShell;
  39     ScAbstractDialogFactory*                mpFact;
  40     OUString                                mCsv; // needs to outlive mpStream
  41     std::unique_ptr<SvMemoryStream>         mpStream;
  42     std::unique_ptr<SfxItemSet>             mpItemSet;
  43
  44     /// helper
  45     void initialize();
  46
  47     /// helper method to populate KnownDialogs, called in setUp(). Needs to be
  48     /// written and has to add entries to KnownDialogs
  49     virtual void registerKnownDialogsByID(mapType& rKnownDialogs) override;
  50
  51     /// dialog creation for known dialogs by ID. Has to be implemented for
  52     /// each registered known dialog
  53     virtual VclPtr<VclAbstractDialog> createDialogByID(sal_uInt32 nID) override;
  54
  55 public:
  56     ScScreenshotTest();
  57
  58     void testOpeningModalDialogs();
  59 #if 0
  60     void testMultiViewCopyPaste();
  61 #endif
  62
  63     CPPUNIT_TEST_SUITE(ScScreenshotTest);
  64     CPPUNIT_TEST(testOpeningModalDialogs);
  65 #if 0
  66     CPPUNIT_TEST(testMultiViewCopyPaste);
  67 #endif
  68     CPPUNIT_TEST_SUITE_END();
  69 };
  70
  71 ScScreenshotTest::ScScreenshotTest()
  72 :   mxComponent(),
  73     mpFoundShell(nullptr),
  74     mxDocSh(),
  75     mpViewShell(nullptr),
  76     mpFact(nullptr),
  77     mCsv("some, strings, here, separated, by, commas"),
  78     mpStream(),
  79     mpItemSet()
  80 {
  81 }
  82
  83 void ScScreenshotTest::initialize()
  84 {
  85     if (mxComponent.is())
  86         mxComponent->dispose();
  87     // use new, empty doc to avoid file locking
  88     mxComponent = loadFromDesktop("private:factory/scalc", "com.sun.star.sheet.SpreadsheetDocument");
  89
  90     mpFoundShell = SfxObjectShell::GetShellFromComponent(mxComponent);
  91     CPPUNIT_ASSERT_MESSAGE("Failed to access document shell", mpFoundShell);
  92
  93     mxDocSh = dynamic_cast<ScDocShell*>(mpFoundShell);
  94     CPPUNIT_ASSERT(mxDocSh != nullptr);
  95
  96     mpViewShell = mxDocSh->GetBestViewShell(false);
  97     CPPUNIT_ASSERT(mpViewShell != nullptr);
  98
  99     mpFact = ScAbstractDialogFactory::Create();
 100
 101     SvMemoryStream* pNewMemStream = new SvMemoryStream(const_cast<sal_Unicode *>(mCsv.getStr()), mCsv.getLength() * sizeof(sal_Unicode), StreamMode::READ);
 102     pNewMemStream->SetStreamCharSet( RTL_TEXTENCODING_UNICODE );
 103 #ifdef OSL_BIGENDIAN
 104     pNewMemStream->SetEndian(SvStreamEndian::BIG);
 105 #else
 106     pNewMemStream->SetEndian(SvStreamEndian::LITTLE);
 107 #endif
 108     mpStream.reset(pNewMemStream);
 109 }
 110
 111 void ScScreenshotTest::registerKnownDialogsByID(mapType& rKnownDialogs)
 112 {
 113     // fill map of known dialogs
 114     rKnownDialogs["modules/scalc/ui/insertsheet.ui"] = 0;
 115     rKnownDialogs["modules/scalc/ui/deletecells.ui"] = 1;
 116     rKnownDialogs["modules/scalc/ui/pastespecial.ui"] = 2;
 117     rKnownDialogs["modules/scalc/ui/changesourcedialog.ui"] = 3;
 118     rKnownDialogs["modules/scalc/ui/selectdatasource.ui"] = 4;
 119     rKnownDialogs["modules/scalc/ui/selectsource.ui"] = 5;
 120     rKnownDialogs["modules/scalc/ui/deletecontents.ui"] = 6;
 121     rKnownDialogs["modules/scalc/ui/createnamesdialog.ui"] = 7;
 122     rKnownDialogs["modules/scalc/ui/inputstringdialog.ui"] = 8;
 123     rKnownDialogs["modules/scalc/ui/tabcolordialog.ui"] = 9;
 124     rKnownDialogs["modules/scalc/ui/textimportoptions.ui"] = 10;
 125     rKnownDialogs["modules/scalc/ui/dataform.ui"] = 11;
 126     rKnownDialogs["modules/scalc/ui/movecopysheet.ui"] = 12;
 127     rKnownDialogs["modules/scalc/ui/textimportcsv.ui"] = 13;
 128     rKnownDialogs["modules/scalc/ui/formatcellsdialog.ui"] = 14;
 129 }
 130
 131 VclPtr<VclAbstractDialog> ScScreenshotTest::createDialogByID(sal_uInt32 nID)
 132 {
 133     VclPtr<VclAbstractDialog> pReturnDialog;
 134     ////FIXME: translatable string here
 135     const OUString aDefaultSheetName("Sheet1");
 136
 137     switch ( nID )
 138     {
 139         case 0: // "modules/scalc/ui/insertsheet.ui"
 140         {
 141             ScViewData& rViewData = mpViewShell->GetViewData();
 142             SCTAB nTabSelCount = rViewData.GetMarkData().GetSelectCount();
 143
 144             pReturnDialog = mpFact->CreateScInsertTableDlg(
 145                 mpViewShell->GetFrameWeld(), rViewData, nTabSelCount, false);
 146
 147             break;
 148         }
 149
 150         case 1: // "modules/scalc/ui/deletecells.ui"
 151         {
 152             pReturnDialog = mpFact->CreateScDeleteCellDlg(mpViewShell->GetFrameWeld(), false);
 153             break;
 154         }
 155
 156         case 2: // "modules/scalc/ui/pastespecial.ui"
 157         {
 158             pReturnDialog = mpFact->CreateScInsertContentsDlg(mpViewShell->GetFrameWeld());
 159             break;
 160         }
 161
 162         case 3: // "modules/scalc/ui/changesourcedialog.ui"
 163         {
 164             pReturnDialog = mpFact->CreateScColRowLabelDlg(mpViewShell->GetFrameWeld(), true, false);
 165             break;
 166         }
 167
 168         case 4: // "modules/scalc/ui/selectdatasource.ui"
 169         {
 170             pReturnDialog = mpFact->CreateScDataPilotDatabaseDlg(mpViewShell->GetFrameWeld());
 171             break;
 172         }
 173         case 5: // "modules/scalc/ui/selectsource.ui"
 174         {
 175             pReturnDialog = mpFact->CreateScDataPilotSourceTypeDlg(mpViewShell->GetFrameWeld(), true);
 176             break;
 177         }
 178
 179         case 6: // "modules/scalc/ui/deletecontents.ui"
 180         {
 181             pReturnDialog = mpFact->CreateScDeleteContentsDlg(mpViewShell->GetFrameWeld());
 182             break;
 183         }
 184
 185         case 7: // "modules/scalc/ui/createnamesdialog.ui"
 186         {
 187             pReturnDialog = mpFact->CreateScNameCreateDlg(
 188                 mpViewShell->GetFrameWeld(),
 189                 CreateNameFlags::Left | CreateNameFlags::Top);
 190                     // just fake some flags
 191             break;
 192         }
 193
 194         case 8: // "modules/scalc/ui/inputstringdialog.ui"
 195         {
 196             pReturnDialog = mpFact->CreateScStringInputDlg(mpViewShell->GetFrameWeld(),
 197                                 ScResId(SCSTR_APDTABLE), ScResId(SCSTR_NAME),
 198                                 aDefaultSheetName, "modules/scalc/ui/inputstringdialog/InputStringDialog", "" );
 199             break;
 200         }
 201
 202         case 9: // "modules/scalc/ui/tabcolordialog.ui"
 203         {
 204             pReturnDialog = mpFact->CreateScTabBgColorDlg(mpViewShell->GetFrameWeld(),
 205                                 ScResId(SCSTR_SET_TAB_BG_COLOR),
 206                                 ScResId(SCSTR_NO_TAB_BG_COLOR), Color(0xff00ff) );
 207             break;
 208         }
 209
 210         case 10: // "modules/scalc/ui/textimportoptions.ui"
 211         {
 212             pReturnDialog = mpFact->CreateScTextImportOptionsDlg(mpViewShell->GetFrameWeld());
 213             break;
 214         }
 215
 216         case 11: // "modules/scalc/ui/dataform.ui"
 217         {
 218             ////FIXME: looks butt-ugly w/ empty file, move it elsewhere, where
 219             ////we actually have some data
 220             pReturnDialog = mpFact->CreateScDataFormDlg(mpViewShell->GetFrameWeld(), mpViewShell);
 221             break;
 222         }
 223
 224         case 12: // "modules/scalc/ui/movecopysheet.ui"
 225         {
 226             pReturnDialog = mpFact->CreateScMoveTableDlg(mpViewShell->GetFrameWeld(), aDefaultSheetName);
 227             break;
 228         }
 229
 230         case 13: // "modules/scalc/ui/textimportcsv.ui"
 231         {
 232             pReturnDialog = mpFact->CreateScImportAsciiDlg(mpViewShell->GetFrameWeld(), OUString(), mpStream.get(), SC_PASTETEXT);
 233             break;
 234         }
 235         case 14: // "modules/scalc/ui/formatcellsdialog.ui"
 236         {
 237             ScViewData& rViewData = mpViewShell->GetViewData();
 238             ScDocument& rDoc = rViewData.GetDocument();
 239
 240             const ScPatternAttr *pAttr = mpViewShell->GetSelectionPattern();
 241             std::unique_ptr<SvxNumberInfoItem> pNumberInfoItem;
 242
 243             mpItemSet.reset(new SfxItemSet(pAttr->GetItemSet()));
 244             mpItemSet->Put(SfxUInt32Item(ATTR_VALUE_FORMAT,
 245                            pAttr->GetNumberFormat( rDoc.GetFormatTable() ) ) );
 246
 247             pNumberInfoItem = ScTabViewShell::MakeNumberInfoItem(rDoc, &rViewData);
 248
 249             mpItemSet->MergeRange(SID_ATTR_NUMBERFORMAT_INFO, SID_ATTR_NUMBERFORMAT_INFO);
 250             mpItemSet->Put(*pNumberInfoItem);
 251
 252             pReturnDialog = mpFact->CreateScAttrDlg(mpViewShell->GetFrameWeld(), mpItemSet.get());
 253             break;
 254         }
 255         default:
 256             break;
 257     }
 258
 259     //CPPUNIT_ASSERT_MESSAGE( "Failed to create dialog", pReturnDialog );
 260     return pReturnDialog;
 261 }
 262
 263 void ScScreenshotTest::testOpeningModalDialogs()
 264 {
 265     initialize();
 266
 267     /// process input file containing the UXMLDescriptions of the dialogs to dump
 268     processDialogBatchFile("sc/qa/unit/screenshots/data/screenshots.txt");
 269
 270     mxComponent->dispose();
 271     mxComponent.clear();
 272 }
 273
 274 #if 0
 275 void ScScreenshotTest::testMultiViewCopyPaste()
 276 {
 277     initialize();
 278
 279     ScDocument& rDoc = mxDocSh->GetDocument();
 280
 281     rDoc.SetString(ScAddress(0, 0, 0), "TestCopy1");
 282     rDoc.SetString(ScAddress(1, 0, 0), "TestCopy2");
 283
 284     // view #1
 285     ScTabViewShell* pView1 = dynamic_cast<ScTabViewShell*>(SfxViewShell::Current());
 286     CPPUNIT_ASSERT(pView1);
 287
 288     // view #2
 289     SfxLokHelper::createView();
 290     ScTabViewShell* pView2 = dynamic_cast<ScTabViewShell*>(SfxViewShell::Current());
 291     CPPUNIT_ASSERT(pView1 != pView2);
 292     {
 293         std::unique_ptr<SfxPoolItem> xItem1;
 294         std::unique_ptr<SfxPoolItem> xItem2;
 295         CPPUNIT_ASSERT(SfxItemState::DISABLED != pView1->GetViewFrame()->GetBindings().QueryState(SID_PASTE, xItem1));
 296         CPPUNIT_ASSERT(SfxItemState::DISABLED != pView2->GetViewFrame()->GetBindings().QueryState(SID_PASTE, xItem2));
 297     }
 298
 299     // copy text view 1
 300     pView1->SetCursor(0, 0);
 301     pView1->GetViewFrame()->GetBindings().Execute(SID_COPY);
 302
 303     // copy text view 2
 304     pView2->SetCursor(1, 0);
 305     pView2->GetViewFrame()->GetBindings().Execute(SID_COPY);
 306
 307      // paste text view 1
 308     pView1->SetCursor(0, 1);
 309     pView1->GetViewFrame()->GetBindings().Execute(SID_PASTE);
 310
 311     // paste text view 2
 312     pView2->SetCursor(1, 1);
 313     pView2->GetViewFrame()->GetBindings().Execute(SID_PASTE);
 314
 315     CPPUNIT_ASSERT_EQUAL(OUString("TestCopy2"), rDoc.GetString(ScAddress(0, 1, 0)));
 316     CPPUNIT_ASSERT_EQUAL(OUString("TestCopy2"), rDoc.GetString(ScAddress(1, 1, 0)));
 317
 318     mxComponent->dispose();
 319     mxComponent.clear();
 320 }
 321 #endif
 322
 323 CPPUNIT_TEST_SUITE_REGISTRATION(ScScreenshotTest);
 324
 325 CPPUNIT_PLUGIN_IMPLEMENT();
 326
 327 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */