fune/layout/printing/nsPrintObject.cpp
Daniel Holbert 49e37dc76e Bug 1776074 part 7: Remove mFrameType member (and PrintObjectType in general) from nsPrintObject.h. r=emilio
This patch does not change behavior (other than a minor correctness fix in some
off-by-default logging; see below).

As shown in the removed line of the init list, this mFrameType member-var's
semantics are equivalent to a null-check of the mParent member-var.  So: rather
than encoding that same information twice, this patch simplifies to just
directly null-check the mParent pointer at all the usage sites.

Before this patch, nsPrintJob.cpp had two different patterns for logging
mFrameType; sometimes with a global `gFrameTypesStr` array, and other times
with a local `types` array (with shorter 2-character strings).  I've converted
both of these to helper-functions.

In the case of the `types` array, the old code used a 4-value array, which was
interesting since the enum type only had 2 possible values. This discrepancy is
just due to an oversight in bug 1769508, where we recently condensed the enum
from 4 values to 2; that bug technically should've condensed these arrays as
well (but didn't do so).  This left these arrays' enum-to-string mapping being
wrong (since eIFrame changed its numeric value from 2 to 1 in bug 1769508), but
probably nobody has used this logging code in a while, so nobody
noticed. Anyway: in this patch, I'm restoring the mappings that we had before
that change (so we'll log "DC" for root print objects and "IF" for non-root
i.e. iframe-flavored print objects).

Differential Revision: https://phabricator.services.mozilla.com/D150177
2022-06-23 22:57:00 +00:00

93 lines
2.8 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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 "nsPrintObject.h"
#include "nsIContentViewer.h"
#include "nsContentUtils.h" // for nsAutoScriptBlocker
#include "nsIInterfaceRequestorUtils.h"
#include "nsPIDOMWindow.h"
#include "nsPresContext.h"
#include "nsGkAtoms.h"
#include "nsComponentManagerUtils.h"
#include "nsIBaseWindow.h"
#include "nsDocShell.h"
#include "mozilla/PresShell.h"
#include "mozilla/dom/BrowsingContext.h"
#include "mozilla/dom/Document.h"
#include "mozilla/dom/Element.h"
using namespace mozilla;
using mozilla::dom::BrowsingContext;
using mozilla::dom::Document;
using mozilla::dom::Element;
using mozilla::dom::Selection;
//---------------------------------------------------
//-- nsPrintObject Class Impl
//---------------------------------------------------
nsPrintObject::nsPrintObject(nsIDocShell& aDocShell, Document& aDoc,
nsPrintObject* aParent)
: mDocShell(&aDocShell), mDocument(&aDoc), mParent(aParent) {
MOZ_COUNT_CTOR(nsPrintObject);
MOZ_ASSERT(aDoc.IsStaticDocument());
if (!aParent) {
// We are a root nsPrintObject.
// Ensure the document has no presentation.
DestroyPresentation();
} else {
// We are a nested nsPrintObject.
nsCOMPtr<nsPIDOMWindowOuter> window = aDoc.GetWindow();
mContent = window->GetFrameElementInternal();
}
}
nsPrintObject::~nsPrintObject() {
MOZ_COUNT_DTOR(nsPrintObject);
DestroyPresentation();
mDocShell = nullptr;
mTreeOwner = nullptr; // mTreeOwner must be released after mDocShell;
}
//------------------------------------------------------------------
// Resets PO by destroying the presentation
void nsPrintObject::DestroyPresentation() {
if (mDocument) {
if (RefPtr<PresShell> ps = mDocument->GetPresShell()) {
MOZ_DIAGNOSTIC_ASSERT(!mPresShell || ps == mPresShell);
mPresShell = nullptr;
nsAutoScriptBlocker scriptBlocker;
ps->EndObservingDocument();
ps->Destroy();
}
}
mPresShell = nullptr;
mPresContext = nullptr;
mViewManager = nullptr;
}
void nsPrintObject::EnablePrinting(bool aEnable) {
mPrintingIsEnabled = aEnable;
for (const UniquePtr<nsPrintObject>& kid : mKids) {
kid->EnablePrinting(aEnable);
}
}
bool nsPrintObject::HasSelection() const {
return mDocument && mDocument->GetProperty(nsGkAtoms::printselectionranges);
}
void nsPrintObject::EnablePrintingSelectionOnly() {
mPrintingIsEnabled = HasSelection();
for (const UniquePtr<nsPrintObject>& kid : mKids) {
kid->EnablePrintingSelectionOnly();
}
}