// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "printing/emf_win.h"
// For quick access.
#include <stdint.h>
#include <wingdi.h>
#include <winspool.h>
#include <memory>
#include <string>
#include <utility>
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/files/scoped_temp_dir.h"
#include "base/path_service.h"
#include "base/win/scoped_hdc.h"
#include "printing/mojom/print.mojom.h"
#include "printing/printing_context.h"
#include "printing/printing_context_win.h"
#include "testing/gtest/include/gtest/gtest.h"
#include "ui/gfx/geometry/point.h"
#include "ui/gfx/geometry/size.h"
namespace printing {
namespace {
// This test is automatically disabled if no printer named "UnitTest Printer" is
// available.
class EmfPrintingTest : public testing::Test, public PrintingContext::Delegate {
public:
typedef testing::Test Parent;
static bool IsTestCaseDisabled() {
// It is assumed this printer is a HP Color LaserJet 4550 PCL or 4700.
HDC hdc = CreateDC(L"WINSPOOL", L"UnitTest Printer", nullptr, nullptr);
if (!hdc)
return true;
DeleteDC(hdc);
return false;
}
// PrintingContext::Delegate methods.
gfx::NativeView GetParentView() override { return gfx::NativeView(); }
std::string GetAppLocale() override { return std::string(); }
};
const uint32_t EMF_HEADER_SIZE = 128;
} // namespace
TEST(EmfTest, DC) {
// Simplest use case.
std::vector<char> data;
{
Emf emf;
EXPECT_TRUE(emf.Init());
EXPECT_TRUE(emf.context());
// An empty EMF is invalid, so we put at least a rectangle in it.
::Rectangle(emf.context(), 10, 10, 190, 190);
EXPECT_TRUE(emf.FinishDocument());
uint32_t size = emf.GetDataSize();
EXPECT_GT(size, EMF_HEADER_SIZE);
EXPECT_TRUE(emf.GetDataAsVector(&data));
ASSERT_EQ(data.size(), size);
}
// Playback the data.
Emf emf;
// TODO(thestig): Make `data` uint8_t and avoid the base::as_bytes() call.
EXPECT_TRUE(emf.InitFromData(base::as_bytes(base::make_span(data))));
HDC hdc = CreateCompatibleDC(nullptr);
EXPECT_TRUE(hdc);
RECT output_rect = {0, 0, 10, 10};
EXPECT_TRUE(emf.Playback(hdc, &output_rect));
EXPECT_TRUE(DeleteDC(hdc));
}
// Disabled if no "UnitTest printer" exist. Useful to reproduce bug 1186598.
TEST_F(EmfPrintingTest, Enumerate) {
if (IsTestCaseDisabled())
return;
auto settings = std::make_unique<PrintSettings>();
// My test case is a HP Color LaserJet 4550 PCL.
settings->set_device_name(u"UnitTest Printer");
// Initialize it.
PrintingContextWin context(this,
PrintingContext::ProcessBehavior::kOopDisabled);
EXPECT_EQ(mojom::ResultCode::kSuccess,
context.InitWithSettingsForTest(std::move(settings)));
base::FilePath emf_file;
EXPECT_TRUE(base::PathService::Get(base::DIR_SRC_TEST_DATA_ROOT, &emf_file));
emf_file = emf_file.Append(FILE_PATH_LITERAL("printing"))
.Append(FILE_PATH_LITERAL("test"))
.Append(FILE_PATH_LITERAL("data"))
.Append(FILE_PATH_LITERAL("emf"))
.Append(FILE_PATH_LITERAL("test4.emf"));
// Load any EMF with an image.
std::string emf_data;
base::ReadFileToString(emf_file, &emf_data);
ASSERT_TRUE(emf_data.size());
Emf emf;
EXPECT_TRUE(emf.InitFromData(base::as_bytes(base::make_span(emf_data))));
// This will print to file. The reason is that when running inside a
// unit_test, PrintingContext automatically dumps its files to the
// current directory.
// TODO(maruel): Clean the .PRN file generated in current directory.
context.NewDocument(u"EmfTest.Enumerate");
// Process one at a time.
RECT page_bounds = emf.GetPageBounds(1).ToRECT();
Emf::Enumerator emf_enum(emf, context.context(), &page_bounds);
for (Emf::Enumerator::const_iterator itr = emf_enum.begin();
itr != emf_enum.end(); ++itr) {
// To help debugging.
ptrdiff_t index = itr - emf_enum.begin();
// If you get this assert, you need to lookup iType in wingdi.h. It starts
// with EMR_HEADER.
EMR_HEADER;
EXPECT_TRUE(itr->SafePlayback(&emf_enum.context_))
<< " index: " << index << " type: " << itr->record()->iType;
}
context.DocumentDone();
}
// Disabled if no "UnitTest printer" exists.
TEST_F(EmfPrintingTest, PageBreak) {
base::win::ScopedCreateDC dc(
CreateDC(L"WINSPOOL", L"UnitTest Printer", nullptr, nullptr));
if (!dc.Get())
return;
std::vector<char> data;
{
Emf emf;
EXPECT_TRUE(emf.Init());
EXPECT_TRUE(emf.context());
int pages = 3;
while (pages) {
emf.StartPage(gfx::Size(), gfx::Rect(), 1,
mojom::PageOrientation::kUpright);
::Rectangle(emf.context(), 10, 10, 190, 190);
EXPECT_TRUE(emf.FinishPage());
--pages;
}
EXPECT_EQ(3U, emf.GetPageCount());
EXPECT_TRUE(emf.FinishDocument());
uint32_t size = emf.GetDataSize();
EXPECT_TRUE(emf.GetDataAsVector(&data));
ASSERT_EQ(data.size(), size);
}
// Playback the data.
DOCINFO di = {0};
di.cbSize = sizeof(DOCINFO);
di.lpszDocName = L"Test Job";
int job_id = ::StartDoc(dc.Get(), &di);
Emf emf;
// TODO(thestig): Make `data` uint8_t and avoid the base::as_bytes() call.
EXPECT_TRUE(emf.InitFromData(base::as_bytes(base::make_span(data))));
EXPECT_TRUE(emf.SafePlayback(dc.Get()));
::EndDoc(dc.Get());
// Since presumably the printer is not real, let us just delete the job from
// the queue.
HANDLE printer = nullptr;
if (::OpenPrinter(const_cast<LPTSTR>(L"UnitTest Printer"), &printer,
nullptr)) {
::SetJob(printer, job_id, 0, nullptr, JOB_CONTROL_DELETE);
ClosePrinter(printer);
}
}
TEST(EmfTest, FileBackedEmf) {
// Simplest use case.
base::ScopedTempDir scratch_metafile_dir;
ASSERT_TRUE(scratch_metafile_dir.CreateUniqueTempDir());
base::FilePath metafile_path;
EXPECT_TRUE(base::CreateTemporaryFileInDir(scratch_metafile_dir.GetPath(),
&metafile_path));
uint32_t size;
std::vector<char> data;
{
Emf emf;
EXPECT_TRUE(emf.InitToFile(metafile_path));
EXPECT_TRUE(emf.context());
// An empty EMF is invalid, so we put at least a rectangle in it.
::Rectangle(emf.context(), 10, 10, 190, 190);
EXPECT_TRUE(emf.FinishDocument());
size = emf.GetDataSize();
EXPECT_GT(size, EMF_HEADER_SIZE);
EXPECT_TRUE(emf.GetDataAsVector(&data));
EXPECT_EQ(data.size(), size);
}
int64_t file_size = 0;
base::GetFileSize(metafile_path, &file_size);
EXPECT_EQ(size, file_size);
// Playback the data.
HDC hdc = CreateCompatibleDC(nullptr);
EXPECT_TRUE(hdc);
Emf emf;
EXPECT_TRUE(emf.InitFromFile(metafile_path));
RECT output_rect = {0, 0, 10, 10};
EXPECT_TRUE(emf.Playback(hdc, &output_rect));
EXPECT_TRUE(DeleteDC(hdc));
}
} // namespace printing
Codebase Browser
chromium