layout/printing/nsPagePrintTimer.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsPagePrintTimer.h"
  39 #include "nsIContentViewer.h"
  40 #include "nsIServiceManager.h"
  41 #include "nsPrintEngine.h"
  42
  43 NS_IMPL_ISUPPORTS1(nsPagePrintTimer, nsITimerCallback)
  44
  45 nsPagePrintTimer::nsPagePrintTimer() :
  46   mPrintEngine(nsnull),
  47   mDelay(0),
  48   mPrintObj(nsnull)
  49 {
  50 }
  51
  52 nsPagePrintTimer::~nsPagePrintTimer()
  53 {
  54   // "Destroy" the document viewer; this normally doesn't actually
  55   // destroy it because of the IncrementDestroyRefCount call below
  56   // XXX This is messy; the document viewer should use a single approach
  57   // to keep itself alive during printing
  58   nsCOMPtr<nsIContentViewer> cv(do_QueryInterface(mDocViewerPrint));
  59   if (cv) {
  60     cv->Destroy();
  61   }
  62 }
  63
  64 nsresult
  65 nsPagePrintTimer::StartTimer(PRBool aUseDelay)
  66 {
  67   nsresult result;
  68   mTimer = do_CreateInstance("@mozilla.org/timer;1", &result);
  69   if (NS_FAILED(result)) {
  70     NS_WARNING("unable to start the timer");
  71   } else {
  72     mTimer->InitWithCallback(this, aUseDelay?mDelay:0, nsITimer::TYPE_ONE_SHOT);
  73   }
  74   return result;
  75 }
  76
  77
  78
  79 // nsITimerCallback
  80 NS_IMETHODIMP
  81 nsPagePrintTimer::Notify(nsITimer *timer)
  82 {
  83   if (mDocViewerPrint) {
  84     PRPackedBool initNewTimer = PR_TRUE;
  85     // Check to see if we are done
  86     // inRange will be true if a page is actually printed
  87     PRBool inRange;
  88     // donePrinting will be true if it completed successfully or
  89     // if the printing was cancelled
  90     PRBool donePrinting = mPrintEngine->PrintPage(mPrintObj, inRange);
  91     if (donePrinting) {
  92       // now clean up print or print the next webshell
  93       if (mPrintEngine->DonePrintingPages(mPrintObj, NS_OK)) {
  94         initNewTimer = PR_FALSE;
  95       }
  96     }
  97
  98     // Note that the Stop() destroys this after the print job finishes
  99     // (The PrintEngine stops holding a reference when DonePrintingPages
 100     // returns true.)
 101     Stop();
 102     if (initNewTimer) {
 103       nsresult result = StartTimer(inRange);
 104       if (NS_FAILED(result)) {
 105         donePrinting = PR_TRUE;     // had a failure.. we are finished..
 106         mPrintEngine->SetIsPrinting(PR_FALSE);
 107       }
 108     }
 109   }
 110   return NS_OK;
 111 }
 112
 113 void
 114 nsPagePrintTimer::Init(nsPrintEngine*          aPrintEngine,
 115                        nsIDocumentViewerPrint* aDocViewerPrint,
 116                        PRUint32                aDelay)
 117 {
 118   mPrintEngine     = aPrintEngine;
 119   mDocViewerPrint  = aDocViewerPrint;
 120   mDelay           = aDelay;
 121
 122   mDocViewerPrint->IncrementDestroyRefCount();
 123 }
 124
 125 nsresult
 126 nsPagePrintTimer::Start(nsPrintObject* aPO)
 127 {
 128   mPrintObj = aPO;
 129   return StartTimer(PR_FALSE);
 130 }
 131
 132
 133 void
 134 nsPagePrintTimer::Stop()
 135 {
 136   if (mTimer) {
 137     mTimer->Cancel();
 138     mTimer = nsnull;
 139   }
 140 }
 141
 142 nsresult NS_NewPagePrintTimer(nsPagePrintTimer **aResult)
 143 {
 144
 145   NS_PRECONDITION(aResult, "null param");
 146
 147   nsPagePrintTimer* result = new nsPagePrintTimer;
 148
 149   if (!result) {
 150     *aResult = nsnull;
 151     return NS_ERROR_OUT_OF_MEMORY;
 152   }
 153
 154   NS_ADDREF(result);
 155   *aResult = result;
 156
 157   return NS_OK;
 158 }
 159