summaryrefslogtreecommitdiffstats
path: root/gfx/thebes/PrintTargetCG.mm
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /gfx/thebes/PrintTargetCG.mm
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esr
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'gfx/thebes/PrintTargetCG.mm')
-rw-r--r--gfx/thebes/PrintTargetCG.mm277
1 files changed, 277 insertions, 0 deletions
diff --git a/gfx/thebes/PrintTargetCG.mm b/gfx/thebes/PrintTargetCG.mm
new file mode 100644
index 0000000000..a5c7caea55
--- /dev/null
+++ b/gfx/thebes/PrintTargetCG.mm
@@ -0,0 +1,277 @@
+/* -*- Mode: C++; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ * 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 "PrintTargetCG.h"
+
+#include "cairo.h"
+#include "cairo-quartz.h"
+#include "mozilla/gfx/HelpersCairo.h"
+#include "nsObjCExceptions.h"
+#include "nsString.h"
+#include "nsIOutputStream.h"
+
+namespace mozilla::gfx {
+
+static size_t PutBytesNull(void* info, const void* buffer, size_t count) { return count; }
+
+PrintTargetCG::PrintTargetCG(CGContextRef aPrintToStreamContext, PMPrintSession aPrintSession,
+ PMPageFormat aPageFormat, PMPrintSettings aPrintSettings,
+ const IntSize& aSize)
+ : PrintTarget(/* aCairoSurface */ nullptr, aSize),
+ mPrintToStreamContext(aPrintToStreamContext),
+ mPrintSession(aPrintSession),
+ mPageFormat(aPageFormat),
+ mPrintSettings(aPrintSettings) {
+ NS_OBJC_BEGIN_TRY_IGNORE_BLOCK;
+
+ MOZ_ASSERT(mPrintSession && mPageFormat && mPrintSettings);
+
+ ::PMRetain(mPrintSession);
+ ::PMRetain(mPageFormat);
+ ::PMRetain(mPrintSettings);
+
+ // TODO: Add memory reporting like gfxQuartzSurface.
+ // RecordMemoryUsed(mSize.height * 4 + sizeof(gfxQuartzSurface));
+
+ NS_OBJC_END_TRY_IGNORE_BLOCK;
+}
+
+PrintTargetCG::~PrintTargetCG() {
+ NS_OBJC_BEGIN_TRY_IGNORE_BLOCK;
+
+ ::PMRelease(mPrintSession);
+ ::PMRelease(mPageFormat);
+ ::PMRelease(mPrintSettings);
+
+ if (mPrintToStreamContext) {
+ CGContextRelease(mPrintToStreamContext);
+ }
+
+ NS_OBJC_END_TRY_IGNORE_BLOCK;
+}
+
+static size_t WriteStreamBytes(void* aInfo, const void* aBuffer, size_t aCount) {
+ auto* stream = static_cast<nsIOutputStream*>(aInfo);
+ auto* data = static_cast<const char*>(aBuffer);
+ size_t remaining = aCount;
+ do {
+ uint32_t wrote = 0;
+ // Handle potential narrowing from size_t to uint32_t.
+ uint32_t toWrite = uint32_t(std::min(remaining, size_t(std::numeric_limits<uint32_t>::max())));
+ if (NS_WARN_IF(NS_FAILED(stream->Write(data, toWrite, &wrote)))) {
+ break;
+ }
+ data += wrote;
+ remaining -= size_t(wrote);
+ } while (remaining);
+ return aCount;
+}
+
+static void ReleaseStream(void* aInfo) {
+ auto* stream = static_cast<nsIOutputStream*>(aInfo);
+ stream->Close();
+ NS_RELEASE(stream);
+}
+
+static CGContextRef CreatePrintToStreamContext(nsIOutputStream* aOutputStream,
+ const IntSize& aSize) {
+ MOZ_ASSERT(aOutputStream);
+
+ NS_ADDREF(aOutputStream); // Matched by the NS_RELEASE in ReleaseStream.
+
+ CGRect pageBox{{0.0, 0.0}, {CGFloat(aSize.width), CGFloat(aSize.height)}};
+ CGDataConsumerCallbacks callbacks = {WriteStreamBytes, ReleaseStream};
+ CGDataConsumerRef consumer = CGDataConsumerCreate(aOutputStream, &callbacks);
+
+ // This metadata is added by the CorePrinting APIs in the non-stream case.
+ NSString* bundleName =
+ [NSBundle.mainBundle.localizedInfoDictionary objectForKey:(NSString*)kCFBundleNameKey];
+ CFMutableDictionaryRef auxiliaryInfo = CFDictionaryCreateMutable(
+ kCFAllocatorDefault, 1, &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
+ CFDictionaryAddValue(auxiliaryInfo, kCGPDFContextCreator, (__bridge CFStringRef)bundleName);
+
+ CGContextRef pdfContext = CGPDFContextCreate(consumer, &pageBox, auxiliaryInfo);
+ CGDataConsumerRelease(consumer);
+ CFRelease(auxiliaryInfo);
+ return pdfContext;
+}
+
+/* static */ already_AddRefed<PrintTargetCG> PrintTargetCG::CreateOrNull(
+ nsIOutputStream* aOutputStream, PMPrintSession aPrintSession, PMPageFormat aPageFormat,
+ PMPrintSettings aPrintSettings, const IntSize& aSize) {
+ if (!Factory::CheckSurfaceSize(aSize)) {
+ return nullptr;
+ }
+
+ CGContextRef printToStreamContext = nullptr;
+ if (aOutputStream) {
+ printToStreamContext = CreatePrintToStreamContext(aOutputStream, aSize);
+ if (!printToStreamContext) {
+ return nullptr;
+ }
+ }
+
+ RefPtr<PrintTargetCG> target =
+ new PrintTargetCG(printToStreamContext, aPrintSession, aPageFormat, aPrintSettings, aSize);
+
+ return target.forget();
+}
+
+already_AddRefed<DrawTarget> PrintTargetCG::GetReferenceDrawTarget() {
+ if (!mRefDT) {
+ const IntSize size(1, 1);
+
+ CGDataConsumerCallbacks callbacks = {PutBytesNull, nullptr};
+ CGDataConsumerRef consumer = CGDataConsumerCreate(nullptr, &callbacks);
+ CGContextRef pdfContext = CGPDFContextCreate(consumer, nullptr, nullptr);
+ CGDataConsumerRelease(consumer);
+
+ cairo_surface_t* similar =
+ cairo_quartz_surface_create_for_cg_context(pdfContext, size.width, size.height);
+
+ CGContextRelease(pdfContext);
+
+ if (cairo_surface_status(similar)) {
+ return nullptr;
+ }
+
+ RefPtr<DrawTarget> dt = Factory::CreateDrawTargetForCairoSurface(similar, size);
+
+ // The DT addrefs the surface, so we need drop our own reference to it:
+ cairo_surface_destroy(similar);
+
+ if (!dt || !dt->IsValid()) {
+ return nullptr;
+ }
+ mRefDT = dt.forget();
+ }
+
+ return do_AddRef(mRefDT);
+}
+
+nsresult PrintTargetCG::BeginPrinting(const nsAString& aTitle, const nsAString& aPrintToFileName,
+ int32_t aStartPage, int32_t aEndPage) {
+ NS_OBJC_BEGIN_TRY_BLOCK_RETURN;
+
+ if (mPrintToStreamContext) {
+ return NS_OK;
+ }
+
+ // Print Core of Application Service sent print job with names exceeding
+ // 255 bytes. This is a workaround until fix it.
+ // (https://openradar.appspot.com/34428043)
+ nsAutoString adjustedTitle;
+ PrintTarget::AdjustPrintJobNameForIPP(aTitle, adjustedTitle);
+
+ if (!adjustedTitle.IsEmpty()) {
+ CFStringRef cfString = ::CFStringCreateWithCharacters(
+ NULL, reinterpret_cast<const UniChar*>(adjustedTitle.BeginReading()),
+ adjustedTitle.Length());
+ if (cfString) {
+ ::PMPrintSettingsSetJobName(mPrintSettings, cfString);
+ ::CFRelease(cfString);
+ }
+ }
+
+ OSStatus status;
+ status = ::PMSetFirstPage(mPrintSettings, aStartPage, false);
+ NS_ASSERTION(status == noErr, "PMSetFirstPage failed");
+ status = ::PMSetLastPage(mPrintSettings, aEndPage, false);
+ NS_ASSERTION(status == noErr, "PMSetLastPage failed");
+
+ status = ::PMSessionBeginCGDocumentNoDialog(mPrintSession, mPrintSettings, mPageFormat);
+
+ return status == noErr ? NS_OK : NS_ERROR_ABORT;
+
+ NS_OBJC_END_TRY_BLOCK_RETURN(NS_ERROR_FAILURE);
+}
+
+nsresult PrintTargetCG::EndPrinting() {
+ NS_OBJC_BEGIN_TRY_BLOCK_RETURN;
+
+ if (mPrintToStreamContext) {
+ CGContextFlush(mPrintToStreamContext);
+ CGPDFContextClose(mPrintToStreamContext);
+ return NS_OK;
+ }
+
+ ::PMSessionEndDocumentNoDialog(mPrintSession);
+ return NS_OK;
+
+ NS_OBJC_END_TRY_BLOCK_RETURN(NS_ERROR_FAILURE);
+}
+
+nsresult PrintTargetCG::AbortPrinting() {
+#ifdef DEBUG
+ mHasActivePage = false;
+#endif
+ return EndPrinting();
+}
+
+nsresult PrintTargetCG::BeginPage() {
+ NS_OBJC_BEGIN_TRY_BLOCK_RETURN;
+
+ CGContextRef context;
+ if (mPrintToStreamContext) {
+ CGContextBeginPage(mPrintToStreamContext, nullptr);
+ context = mPrintToStreamContext;
+ } else {
+ PMSessionError(mPrintSession);
+ OSStatus status = ::PMSessionBeginPageNoDialog(mPrintSession, mPageFormat, nullptr);
+ if (status != noErr) {
+ return NS_ERROR_ABORT;
+ }
+
+ // This call will fail if it wasn't called between the PMSessionBeginPage/
+ // PMSessionEndPage calls:
+ ::PMSessionGetCGGraphicsContext(mPrintSession, &context);
+
+ if (!context) {
+ return NS_ERROR_FAILURE;
+ }
+ }
+
+ unsigned int width = static_cast<unsigned int>(mSize.width);
+ unsigned int height = static_cast<unsigned int>(mSize.height);
+
+ // Initially, origin is at bottom-left corner of the paper.
+ // Here, we translate it to top-left corner of the paper.
+ CGContextTranslateCTM(context, 0, height);
+ CGContextScaleCTM(context, 1.0, -1.0);
+
+ cairo_surface_t* surface = cairo_quartz_surface_create_for_cg_context(context, width, height);
+
+ if (cairo_surface_status(surface)) {
+ return NS_ERROR_FAILURE;
+ }
+
+ mCairoSurface = surface;
+
+ return PrintTarget::BeginPage();
+
+ NS_OBJC_END_TRY_BLOCK_RETURN(NS_ERROR_FAILURE);
+}
+
+nsresult PrintTargetCG::EndPage() {
+ NS_OBJC_BEGIN_TRY_BLOCK_RETURN;
+
+ cairo_surface_finish(mCairoSurface);
+ mCairoSurface = nullptr;
+
+ if (mPrintToStreamContext) {
+ CGContextEndPage(mPrintToStreamContext);
+ } else {
+ OSStatus status = ::PMSessionEndPageNoDialog(mPrintSession);
+ if (status != noErr) {
+ return NS_ERROR_ABORT;
+ }
+ }
+
+ return PrintTarget::EndPage();
+
+ NS_OBJC_END_TRY_BLOCK_RETURN(NS_ERROR_FAILURE);
+}
+
+} // namespace mozilla::gfx