layout/printing/nsPagePrintTimer.h
author Mozilla Releng Treescript <release+treescript@mozilla.org>
Fri, 22 Oct 2021 18:57:39 +0000
changeset 663381 b21b30118aff9e5e4d26578aeaed2c163be4ea66
parent 617775 f831fe50e3baa7ec892cb7112ccff5b4cb30ae53
permissions -rw-r--r--
no bug - Bumping Firefox l10n changesets r=release a=l10n-bump br -> ce92556a0a903955d3c937b59a7c14bd6e1f7ecf en-CA -> 5a0e35b08a489351418516c5c384b15bdef9cabd es-AR -> 6cf3c836995d40e92bb7380e49f0992b269f8f5f es-MX -> dd834a4af402c5c6706f622c4f3dcc0c95abb5b0 et -> 1f2150796079f0ddc0c5c4bba7c030fc98b39cd2 fr -> 64a3576df276ce45d0ff0d4ee133c92c1801bcc0 hr -> 6e4a3fdc01f315566fe44286e5e9e7421f463165 it -> 0c7d2a0e1304afbfc88ee865aef9f9274df09106 oc -> 9ac29828960ef1d2267773688598a106a3c4eb3a tr -> 51354c936bf6d0bff1684ef2f3fff47f300fddbc

/* -*- 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/. */
#ifndef nsPagePrintTimer_h___
#define nsPagePrintTimer_h___

// Timer Includes
#include "nsITimer.h"

#include "nsIDocumentViewerPrint.h"
#include "nsPrintObject.h"
#include "mozilla/Attributes.h"
#include "mozilla/OwningNonNull.h"
#include "nsThreadUtils.h"

class nsPrintJob;

//---------------------------------------------------
//-- Page Timer Class
//---------------------------------------------------
// Strictly speaking, this actually manages the timing of printing *sheets*
// (instances of "PrintedSheetFrame"), each of which may encompass multiple
// pages (nsPageFrames) of the document. The use of "Page" in the class name
// here is for historical / colloquial purposes.
class nsPagePrintTimer final : public mozilla::Runnable,
                               public nsITimerCallback {
 public:
  NS_DECL_ISUPPORTS_INHERITED

  nsPagePrintTimer(nsPrintJob* aPrintJob,
                   nsIDocumentViewerPrint* aDocViewerPrint,
                   mozilla::dom::Document* aDocument, uint32_t aDelay)
      : Runnable("nsPagePrintTimer"),
        mPrintJob(aPrintJob),
        mDocViewerPrint(aDocViewerPrint),
        mDocument(aDocument),
        mDelay(aDelay),
        mFiringCount(0),
        mPrintObj(nullptr),
        mWatchDogCount(0),
        mDone(false) {
    MOZ_ASSERT(aDocViewerPrint && aDocument);
    mDocViewerPrint->IncrementDestroyBlockedCount();
  }

  NS_DECL_NSITIMERCALLBACK

  nsresult Start(nsPrintObject* aPO);

  NS_IMETHOD Run() override;

  void Stop();

  void WaitForRemotePrint();
  void RemotePrintFinished();

  void Disconnect();

 private:
  ~nsPagePrintTimer();

  nsresult StartTimer(bool aUseDelay);
  nsresult StartWatchDogTimer();
  void StopWatchDogTimer();
  void Fail();

  nsPrintJob* mPrintJob;
  nsCOMPtr<nsIDocumentViewerPrint> mDocViewerPrint;
  RefPtr<mozilla::dom::Document> mDocument;
  nsCOMPtr<nsITimer> mTimer;
  nsCOMPtr<nsITimer> mWatchDogTimer;
  nsCOMPtr<nsITimer> mWaitingForRemotePrint;
  uint32_t mDelay;
  uint32_t mFiringCount;
  nsPrintObject* mPrintObj;
  uint32_t mWatchDogCount;
  bool mDone;

  static const uint32_t WATCH_DOG_INTERVAL = 1000;
  static const uint32_t WATCH_DOG_MAX_COUNT =
#ifdef DEBUG
      // Debug builds are very slow (on Mac at least) and can need extra time
      30
#else
      10
#endif
      ;
};

#endif /* nsPagePrintTimer_h___ */