Bug 1665125 - Make print background settings infallible. r=bobowen

This makes callers simpler. Differential Revision: https://phabricator.services.mozilla.com/D90285
iaxat · Sep 16, 2020 · 94f2b90 · 94f2b90
1 parent eb1718e
commit 94f2b90
Show file tree

Hide file tree

Showing 8 changed files with 45 additions and 55 deletions.
diff --git a/layout/base/nsPresContext.cpp b/layout/base/nsPresContext.cpp
@@ -1651,6 +1651,10 @@ void nsPresContext::SetPrintSettings(nsIPrintSettings* aPrintSettings) {
     return;
   }
 
+  // set the presentation context to the value in the print settings
+  mDrawColorBackground = mPrintSettings->GetPrintBGColors();
+  mDrawImageBackground = mPrintSettings->GetPrintBGImages();
+
   nsIntMargin unwriteableTwips = mPrintSettings->GetUnwriteableMarginInTwips();
   NS_ASSERTION(unwriteableTwips.top >= 0 && unwriteableTwips.right >= 0 &&
                    unwriteableTwips.bottom >= 0 && unwriteableTwips.left >= 0,

diff --git a/layout/base/nsPresContext.h b/layout/base/nsPresContext.h
@@ -704,17 +704,10 @@ class nsPresContext : public nsISupports, public mozilla::SupportsWeakPtr {
   bool ElementWouldPropagateScrollStyles(const mozilla::dom::Element&);
 
   /**
-   * Set and get methods for controlling the background drawing
+   * Methods for controlling the background drawing.
    */
   bool GetBackgroundImageDraw() const { return mDrawImageBackground; }
-  void SetBackgroundImageDraw(bool aCanDraw) {
-    mDrawImageBackground = aCanDraw;
-  }
-
   bool GetBackgroundColorDraw() const { return mDrawColorBackground; }
-  void SetBackgroundColorDraw(bool aCanDraw) {
-    mDrawColorBackground = aCanDraw;
-  }
 
   /**
    *  Check if bidi enabled (set depending on the presence of RTL

diff --git a/layout/printing/nsPrintJob.cpp b/layout/printing/nsPrintJob.cpp
@@ -1807,13 +1807,6 @@ nsresult nsPrintJob::ReflowPrintObject(const UniquePtr<nsPrintObject>& aPO) {
                                    : new nsPresContext(aPO->mDocument, type);
   aPO->mPresContext->SetPrintSettings(printData->mPrintSettings);
 
-  // set the presentation context to the value in the print settings
-  bool printBGColors;
-  printData->mPrintSettings->GetPrintBGColors(&printBGColors);
-  aPO->mPresContext->SetBackgroundColorDraw(printBGColors);
-  printData->mPrintSettings->GetPrintBGImages(&printBGColors);
-  aPO->mPresContext->SetBackgroundImageDraw(printBGColors);
-
   // init it with the DC
   MOZ_TRY(aPO->mPresContext->Init(printData->mPrintDC));
 

diff --git a/layout/tools/reftest/reftest-content.js b/layout/tools/reftest/reftest-content.js
@@ -235,25 +235,29 @@ function doPrintMode(contentRootElement) {
 }
 
 function setupPrintMode() {
-   var PSSVC =
-       Cc[PRINTSETTINGS_CONTRACTID].getService(Ci.nsIPrintSettingsService);
-   var ps = PSSVC.newPrintSettings;
-   ps.paperWidth = 5;
-   ps.paperHeight = 3;
-
-   // Override any os-specific unwriteable margins
-   ps.unwriteableMarginTop = 0;
-   ps.unwriteableMarginLeft = 0;
-   ps.unwriteableMarginBottom = 0;
-   ps.unwriteableMarginRight = 0;
-
-   ps.headerStrLeft = "";
-   ps.headerStrCenter = "";
-   ps.headerStrRight = "";
-   ps.footerStrLeft = "";
-   ps.footerStrCenter = "";
-   ps.footerStrRight = "";
-   docShell.contentViewer.setPageModeForTesting(/* aPageMode */ true, ps);
+    var PSSVC =
+        Cc[PRINTSETTINGS_CONTRACTID].getService(Ci.nsIPrintSettingsService);
+    var ps = PSSVC.newPrintSettings;
+    ps.paperWidth = 5;
+    ps.paperHeight = 3;
+
+    // Override any os-specific unwriteable margins
+    ps.unwriteableMarginTop = 0;
+    ps.unwriteableMarginLeft = 0;
+    ps.unwriteableMarginBottom = 0;
+    ps.unwriteableMarginRight = 0;
+
+    ps.headerStrLeft = "";
+    ps.headerStrCenter = "";
+    ps.headerStrRight = "";
+    ps.footerStrLeft = "";
+    ps.footerStrCenter = "";
+    ps.footerStrRight = "";
+
+    ps.printBGColors = true;
+    ps.printBGImages = true;
+
+    docShell.contentViewer.setPageModeForTesting(/* aPageMode */ true, ps);
 }
 
 // Message the parent process to ask it to print the current page to a PDF file.

diff --git a/widget/cocoa/nsPrintDialogX.mm b/widget/cocoa/nsPrintDialogX.mm
@@ -399,8 +399,7 @@ - (void)addAppearanceSection {
   mPrintBGColorsCheckbox = [self checkboxWithLabel:"printBGColors"
                                           andFrame:NSMakeRect(156, 103, 0, 0)];
 
-  bool geckoBool;
-  mSettings->GetPrintBGColors(&geckoBool);
+  bool geckoBool = mSettings->GetPrintBGColors();
   [mPrintBGColorsCheckbox setState:(geckoBool ? NSOnState : NSOffState)];
 
   [self addSubview:mPrintBGColorsCheckbox];
@@ -409,7 +408,7 @@ - (void)addAppearanceSection {
   mPrintBGImagesCheckbox = [self checkboxWithLabel:"printBGImages"
                                           andFrame:NSMakeRect(156, 81, 0, 0)];
 
-  mSettings->GetPrintBGImages(&geckoBool);
+  geckoBool = mSettings->GetPrintBGImages();
   [mPrintBGImagesCheckbox setState:(geckoBool ? NSOnState : NSOffState)];
 
   [self addSubview:mPrintBGImagesCheckbox];

diff --git a/widget/gtk/nsPrintDialogGTK.cpp b/widget/gtk/nsPrintDialogGTK.cpp
@@ -379,13 +379,11 @@ nsresult nsPrintDialogWidgetGTK::ImportSettings(nsIPrintSettings* aNSSettings) {
   gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(shrink_to_fit_toggle),
                                geckoBool);
 
-  aNSSettings->GetPrintBGColors(&geckoBool);
   gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(print_bg_colors_toggle),
-                               geckoBool);
+                               aNSSettings->GetPrintBGColors());
 
-  aNSSettings->GetPrintBGImages(&geckoBool);
   gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(print_bg_images_toggle),
-                               geckoBool);
+                               aNSSettings->GetPrintBGImages());
 
   gtk_print_unix_dialog_set_settings(GTK_PRINT_UNIX_DIALOG(dialog), settings);
   gtk_print_unix_dialog_set_page_setup(GTK_PRINT_UNIX_DIALOG(dialog), setup);

diff --git a/widget/nsIPrintSettings.idl b/widget/nsIPrintSettings.idl
@@ -132,12 +132,12 @@ interface nsIPrintSettings : nsISupports
   /**
    * Makes a new copy
    */
-    nsIPrintSettings clone();
+  nsIPrintSettings clone();
 
   /**
    * Assigns the internal values from the "in" arg to the current object
    */
-    void assign(in nsIPrintSettings aPS);
+  void assign(in nsIPrintSettings aPS);
 
   /**
    * Data Members
@@ -177,8 +177,8 @@ interface nsIPrintSettings : nsISupports
   attribute double  unwriteableMarginRight;
 
   attribute double  scaling;      /* values 0.0 - 1.0 */
-  attribute boolean printBGColors; /* Print Background Colors */
-  attribute boolean printBGImages; /* Print Background Images */
+  [infallible] attribute boolean printBGColors; /* Print Background Colors */
+  [infallible] attribute boolean printBGImages; /* Print Background Images */
 
   attribute short   printRange;
 

diff --git a/widget/nsPrintSettingsService.cpp b/widget/nsPrintSettingsService.cpp
@@ -111,8 +111,9 @@ nsPrintSettingsService::SerializeToPrintData(nsIPrintSettings* aSettings,
 
   aSettings->GetScaling(&data->scaling());
 
-  aSettings->GetPrintBGColors(&data->printBGColors());
-  aSettings->GetPrintBGImages(&data->printBGImages());
+  data->printBGColors() = aSettings->GetPrintBGColors();
+  data->printBGImages() = aSettings->GetPrintBGImages();
+
   aSettings->GetPrintRange(&data->printRange());
 
   aSettings->GetTitle(data->title());
@@ -733,17 +734,15 @@ nsresult nsPrintSettingsService::WritePrefs(nsIPrintSettings* aPS,
   }
 
   if (aFlags & nsIPrintSettings::kInitSaveBGColors) {
-    if (NS_SUCCEEDED(aPS->GetPrintBGColors(&b))) {
-      DUMP_BOOL(kWriteStr, kPrintBGColors, b);
-      Preferences::SetBool(GetPrefName(kPrintBGColors, aPrinterName), b);
-    }
+    b = aPS->GetPrintBGColors();
+    DUMP_BOOL(kWriteStr, kPrintBGColors, b);
+    Preferences::SetBool(GetPrefName(kPrintBGColors, aPrinterName), b);
   }
 
   if (aFlags & nsIPrintSettings::kInitSaveBGImages) {
-    if (NS_SUCCEEDED(aPS->GetPrintBGImages(&b))) {
-      DUMP_BOOL(kWriteStr, kPrintBGImages, b);
-      Preferences::SetBool(GetPrefName(kPrintBGImages, aPrinterName), b);
-    }
+    b = aPS->GetPrintBGImages();
+    DUMP_BOOL(kWriteStr, kPrintBGImages, b);
+    Preferences::SetBool(GetPrefName(kPrintBGImages, aPrinterName), b);
   }
 
   if (aFlags & nsIPrintSettings::kInitSaveReversed) {