1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
/* -*- 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/.
*/
#include <sal/config.h>
#include <iostream>
#include <test/screenshot_test.hxx>
#include <com/sun/star/frame/Desktop.hpp>
#include <comphelper/processfactory.hxx>
#include <vcl/abstdlg.hxx>
#include <vcl/pngwrite.hxx>
#include <vcl/svapp.hxx>
#include <vcl/virdev.hxx>
#include <vcl/weld.hxx>
#include <tools/stream.hxx>
namespace {
void splitHelpId( const OString& rHelpId, OUString& rDirname, OUString &rBasename )
{
sal_Int32 nIndex = rHelpId.lastIndexOf( '/' );
if( nIndex > 0 )
rDirname = OStringToOUString( rHelpId.subView( 0, nIndex ), RTL_TEXTENCODING_UTF8 );
if( rHelpId.getLength() > nIndex+1 )
rBasename= OStringToOUString( rHelpId.subView( nIndex+1 ), RTL_TEXTENCODING_UTF8 );
}
}
using namespace css;
using namespace css::uno;
/// the target directory for screenshots
constexpr OUStringLiteral g_aScreenshotDirectory(u"screenshots");
ScreenshotTest::ScreenshotTest()
: maParent(nullptr, "vcl/ui/screenshotparent.ui", "ScreenShot")
, mxParentWidget(maParent.getDialog()->weld_content_area())
{
if (auto const env = getenv("LO_TEST_LOCALE")) {
maCurrentLanguage = OUString::fromUtf8(env);
}
}
ScreenshotTest::~ScreenshotTest()
{
}
void ScreenshotTest::setUp()
{
test::BootstrapFixture::setUp();
mxDesktop = css::frame::Desktop::create( comphelper::getComponentContext(getMultiServiceFactory()) );
CPPUNIT_ASSERT_MESSAGE("no desktop!", mxDesktop.is());
osl::Directory::create( m_directories.getURLFromWorkdir( g_aScreenshotDirectory)) ;
// initialize maKnownDialogs
if (maKnownDialogs.empty())
{
registerKnownDialogsByID(maKnownDialogs);
}
}
void ScreenshotTest::implSaveScreenshot(const BitmapEx& rScreenshot, const OString& rScreenshotId)
{
OUString aDirname, aBasename;
splitHelpId(rScreenshotId, aDirname, aBasename);
aDirname = g_aScreenshotDirectory + "/" + aDirname +
( (maCurrentLanguage == "en-US") ? OUString() : "/" + maCurrentLanguage );
auto const dirUrl = m_directories.getURLFromWorkdir(aDirname);
auto const e = osl::Directory::createPath(dirUrl);
if (e != osl::FileBase::E_EXIST) {
CPPUNIT_ASSERT_EQUAL_MESSAGE(
OString("Failed to create " + OUStringToOString(dirUrl, RTL_TEXTENCODING_UTF8))
.getStr(),
osl::FileBase::E_None, e);
}
auto const pngUrl = OUString(dirUrl + "/" + aBasename + ".png");
SvFileStream aNew(pngUrl, StreamMode::WRITE | StreamMode::TRUNC);
CPPUNIT_ASSERT_MESSAGE(OString("Failed to open <" + OUStringToOString(pngUrl, RTL_TEXTENCODING_UTF8) + ">: " + OString::number(sal_uInt32(aNew.GetErrorCode()))).getStr(), aNew.IsOpen());
std::cout << "saving " << pngUrl << ":\n";
vcl::PNGWriter aPNGWriter(rScreenshot);
aPNGWriter.Write(aNew);
}
void ScreenshotTest::saveScreenshot(VclAbstractDialog const & rDialog)
{
const BitmapEx aScreenshot(rDialog.createScreenshot());
if (!aScreenshot.IsEmpty())
{
const OString aScreenshotId = rDialog.GetScreenshotId();
if (!aScreenshotId.isEmpty())
{
implSaveScreenshot(aScreenshot, aScreenshotId);
}
}
}
void ScreenshotTest::saveScreenshot(weld::Window& rDialog)
{
VclPtr<VirtualDevice> xDialogSurface(rDialog.screenshot());
const BitmapEx aScreenshot(xDialogSurface->GetBitmapEx(Point(), xDialogSurface->GetOutputSizePixel()));
if (!aScreenshot.IsEmpty())
{
const OString aScreenshotId = rDialog.get_help_id();
assert(!aScreenshotId.isEmpty());
implSaveScreenshot(aScreenshot, aScreenshotId);
}
}
VclPtr<VclAbstractDialog> ScreenshotTest::createDialogByName(const OString& rName)
{
const mapType::const_iterator aHit = maKnownDialogs.find(rName);
if (aHit != maKnownDialogs.end())
{
return createDialogByID((*aHit).second);
}
return VclPtr<VclAbstractDialog>();
}
void ScreenshotTest::dumpDialogToPath(VclAbstractDialog& rDialog)
{
const std::vector<OString> aPageDescriptions(rDialog.getAllPageUIXMLDescriptions());
if (!aPageDescriptions.empty())
{
for (size_t a(0); a < aPageDescriptions.size(); a++)
{
if (rDialog.selectPageByUIXMLDescription(aPageDescriptions[a]))
{
saveScreenshot(rDialog);
}
else
{
CPPUNIT_ASSERT(false);
}
}
}
else
{
saveScreenshot(rDialog);
}
}
void ScreenshotTest::dumpDialogToPath(weld::Builder& rBuilder)
{
std::unique_ptr<weld::Window> xDialog(rBuilder.create_screenshot_window());
auto xTabCtrl = rBuilder.weld_notebook("tabcontrol");
int nPages = xTabCtrl ? xTabCtrl->get_n_pages() : 0;
if (nPages)
{
for (int i = 0; i < nPages; ++i)
{
OString sIdent(xTabCtrl->get_page_ident(i));
xTabCtrl->set_current_page(sIdent);
if (xTabCtrl->get_current_page_ident() == sIdent)
{
OString sOrigHelpId(xDialog->get_help_id());
// skip empty pages
weld::Container* pPage = xTabCtrl->get_page(sIdent);
OString sBuildableName(pPage->get_buildable_name());
if (!sBuildableName.isEmpty() && !sBuildableName.startsWith("__"))
xDialog->set_help_id(pPage->get_help_id());
saveScreenshot(*xDialog);
xDialog->set_help_id(sOrigHelpId);
}
else
{
CPPUNIT_ASSERT(false);
}
}
}
else
{
saveScreenshot(*xDialog);
}
}
void ScreenshotTest::dumpDialogToPath(std::string_view rUIXMLDescription)
{
if (rUIXMLDescription.empty())
return;
bool bNonConforming = rUIXMLDescription == "modules/swriter/ui/sidebarstylepresets.ui" ||
rUIXMLDescription == "modules/swriter/ui/sidebartheme.ui" ||
rUIXMLDescription == "modules/swriter/ui/notebookbar.ui" ||
rUIXMLDescription == "modules/scalc/ui/sidebaralignment.ui" ||
rUIXMLDescription == "modules/scalc/ui/sidebarcellappearance.ui" ||
rUIXMLDescription == "modules/scalc/ui/sidebarnumberformat.ui" ||
rUIXMLDescription == "sfx/ui/helpbookmarkpage.ui" ||
rUIXMLDescription == "sfx/ui/helpcontentpage.ui" ||
rUIXMLDescription == "sfx/ui/helpindexpage.ui" ||
rUIXMLDescription == "sfx/ui/helpsearchpage.ui" ||
rUIXMLDescription == "sfx/ui/startcenter.ui" ||
rUIXMLDescription == "svx/ui/datanavigator.ui" ||
rUIXMLDescription == "svx/ui/xformspage.ui" ||
rUIXMLDescription == "modules/dbreport/ui/conditionwin.ui";
if (bNonConforming) // skip these broken ones
return;
std::unique_ptr<weld::Builder> xBuilder(Application::CreateBuilder(mxParentWidget.get(), OStringToOUString(rUIXMLDescription, RTL_TEXTENCODING_UTF8)));
dumpDialogToPath(*xBuilder);
}
void ScreenshotTest::processAllKnownDialogs()
{
for (const auto& rDialog : getKnownDialogs())
{
ScopedVclPtr<VclAbstractDialog> pDlg(createDialogByID(rDialog.second));
if (pDlg)
{
// known dialog, dump screenshot to path
dumpDialogToPath(*pDlg);
}
else
{
// unknown dialog, should not happen in this basic loop.
// You have probably forgotten to add a case and
// implementation to createDialogByID, please do this
}
}
}
void ScreenshotTest::processDialogBatchFile(std::u16string_view rFile)
{
test::Directories aDirectories;
const OUString aURL(aDirectories.getURLFromSrc(rFile));
SvFileStream aStream(aURL, StreamMode::READ);
OString aNextUIFile;
const OString aComment("#");
while (aStream.ReadLine(aNextUIFile))
{
if (!aNextUIFile.isEmpty() && !aNextUIFile.startsWith(aComment))
{
std::cout << "processing " << aNextUIFile << ":\n";
// first check if it's a known dialog
ScopedVclPtr<VclAbstractDialog> pDlg(createDialogByName(aNextUIFile));
if (pDlg)
{
// known dialog, dump screenshot to path
dumpDialogToPath(*pDlg);
}
else
{
// unknown dialog, try fallback to generic created
// Builder-generated instance. Keep in mind that Dialogs
// using this mechanism will probably not be layouted well
// since the setup/initialization part is missing. Thus,
// only use for fallback when only the UI file is available.
dumpDialogToPath(aNextUIFile);
}
}
}
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
