layout/printing/nsPagePrintTimer.h
author Brian Hackett <bhackett1024@gmail.com>
Wed, 14 Nov 2018 16:09:58 -1000
changeset 446931 1c7fc8389e012c987347efefca6b35f3948b742a
parent 399584 76ce0d94b9b75081a9f8842f4f157e3778b06f6b
child 448947 6f3709b3878117466168c40affa7bca0b60cf75b
permissions -rw-r--r--
Bug 1507359 Part 2 - Bindings and internal changes to allow ReplayDebugger to control child pausing/resuming, r=mccr8.

/* -*- 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;
class nsIDocument;

//---------------------------------------------------
//-- Page Timer Class
//---------------------------------------------------
class nsPagePrintTimer final : public mozilla::Runnable,
                               public nsITimerCallback
{
public:

  NS_DECL_ISUPPORTS_INHERITED

  nsPagePrintTimer(nsPrintJob* aPrintJob,
                   nsIDocumentViewerPrint* aDocViewerPrint,
                   nsIDocument* 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()
  {
    mPrintJob = nullptr;
    mPrintObj = nullptr;
  }

private:
  ~nsPagePrintTimer();

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

  nsPrintJob*                mPrintJob;
  const mozilla::OwningNonNull<nsIDocumentViewerPrint> mDocViewerPrint;
  nsCOMPtr<nsIDocument>      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___ */