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
|
// 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.
#ifndef PRINTING_EMF_WIN_H_
#define PRINTING_EMF_WIN_H_
#include <windows.h>
#include <stddef.h>
#include <stdint.h>
#include <memory>
#include <vector>
#include "base/compiler_specific.h"
#include "base/component_export.h"
#include "base/gtest_prod_util.h"
#include "base/memory/raw_ptr.h"
#include "printing/metafile.h"
namespace base {
class FilePath;
}
namespace gfx {
class Rect;
class Size;
} // namespace gfx
namespace printing {
// Simple wrapper class that manage an EMF data stream and its virtual HDC.
class COMPONENT_EXPORT(PRINTING_METAFILE) Emf : public Metafile {
public:
class Record;
class Enumerator;
struct EnumerationContext;
// Generates a virtual HDC that will record every GDI commands and compile
// it in a EMF data stream.
Emf();
Emf(const Emf&) = delete;
Emf& operator=(const Emf&) = delete;
~Emf() override;
// Closes metafile.
void Close();
// Generates a new metafile that will record every GDI command, and will
// be saved to `metafile_path`.
bool InitToFile(const base::FilePath& metafile_path);
// Initializes the Emf with the data in `metafile_path`.
bool InitFromFile(const base::FilePath& metafile_path);
// Metafile methods.
bool Init() override;
bool InitFromData(base::span<const uint8_t> data) override;
// Inserts a custom GDICOMMENT records indicating StartPage/EndPage calls
// (since StartPage and EndPage do not work in a metafile DC). Only valid
// when hdc_ is non-NULL. `page_size`, `content_area`, and `scale_factor` are
// ignored.
void StartPage(const gfx::Size& page_size,
const gfx::Rect& content_area,
float scale_factor,
mojom::PageOrientation page_orientation) override;
bool FinishPage() override;
bool FinishDocument() override;
uint32_t GetDataSize() const override;
bool GetData(void* buffer, uint32_t size) const override;
bool ShouldCopySharedMemoryRegionData() const override;
mojom::MetafileDataType GetDataType() const override;
// Should be passed to Playback to keep the exact same size.
gfx::Rect GetPageBounds(unsigned int page_number) const override;
unsigned int GetPageCount() const override;
HDC context() const override;
bool Playback(HDC hdc, const RECT* rect) const override;
bool SafePlayback(HDC hdc) const override;
HENHMETAFILE emf() const { return emf_; }
private:
FRIEND_TEST_ALL_PREFIXES(EmfTest, DC);
FRIEND_TEST_ALL_PREFIXES(EmfPrintingTest, PageBreak);
FRIEND_TEST_ALL_PREFIXES(EmfTest, FileBackedEmf);
// Playbacks safely one EMF record.
static int CALLBACK SafePlaybackProc(HDC hdc,
HANDLETABLE* handle_table,
const ENHMETARECORD* record,
int objects_count,
LPARAM param);
// Compiled EMF data handle.
HENHMETAFILE emf_;
// Valid when generating EMF data through a virtual HDC.
HDC hdc_;
};
// Emf subclass that knows how to play back PostScript data embedded as EMF
// comment records.
class COMPONENT_EXPORT(PRINTING_METAFILE) PostScriptMetaFile : public Emf {
public:
PostScriptMetaFile();
PostScriptMetaFile(const PostScriptMetaFile&) = delete;
PostScriptMetaFile& operator=(const PostScriptMetaFile&) = delete;
~PostScriptMetaFile() override;
// `Emf` overrides:
mojom::MetafileDataType GetDataType() const override;
bool SafePlayback(HDC hdc) const override;
};
struct Emf::EnumerationContext {
EnumerationContext();
raw_ptr<HANDLETABLE> handle_table;
int objects_count;
HDC hdc;
raw_ptr<const XFORM> base_matrix;
int dc_on_page_start;
};
// One EMF record. It keeps pointers to the EMF buffer held by Emf::emf_.
// The entries become invalid once Emf::CloseEmf() is called.
class COMPONENT_EXPORT(PRINTING_METAFILE) Emf::Record {
public:
// Plays the record.
bool Play(EnumerationContext* context) const;
// Plays the record working around quirks with SetLayout,
// SetWorldTransform and ModifyWorldTransform. See implementation for details.
bool SafePlayback(EnumerationContext* context) const;
// Access the underlying EMF record.
const ENHMETARECORD* record() const { return record_; }
protected:
explicit Record(const ENHMETARECORD* record);
private:
friend class Emf;
friend class Enumerator;
raw_ptr<const ENHMETARECORD> record_;
};
// Retrieves individual records out of a Emf buffer. The main use is to skip
// over records that are unsupported on a specific printer or to play back
// only a part of an EMF buffer.
class COMPONENT_EXPORT(PRINTING_METAFILE) Emf::Enumerator {
public:
// Iterator type used for iterating the records.
typedef std::vector<Record>::const_iterator const_iterator;
// Enumerates the records at construction time. `hdc` and `rect` are
// both optional at the same time or must both be valid.
// Warning: `emf` must be kept valid for the time this object is alive.
Enumerator(const Emf& emf, HDC hdc, const RECT* rect);
Enumerator(const Enumerator&) = delete;
Enumerator& operator=(const Enumerator&) = delete;
~Enumerator();
// Retrieves the first Record.
const_iterator begin() const;
// Retrieves the end of the array.
const_iterator end() const;
private:
FRIEND_TEST_ALL_PREFIXES(EmfPrintingTest, Enumerate);
// Processes one EMF record and saves it in the items_ array.
static int CALLBACK EnhMetaFileProc(HDC hdc,
HANDLETABLE* handle_table,
const ENHMETARECORD* record,
int objects_count,
LPARAM param);
// The collection of every EMF records in the currently loaded EMF buffer.
// Initialized by Enumerate(). It keeps pointers to the EMF buffer held by
// Emf::emf_. The entries become invalid once Emf::CloseEmf() is called.
std::vector<Record> items_;
EnumerationContext context_;
};
} // namespace printing
#endif // PRINTING_EMF_WIN_H_
|