layout/printing/nsPrintEngine.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5 #ifndef nsPrintEngine_h___
   6 #define nsPrintEngine_h___
   7
   8 #include "mozilla/Attributes.h"
   9
  10 #include "nsCOMPtr.h"
  11
  12 #include "nsPrintObject.h"
  13 #include "nsPrintData.h"
  14 #include "nsFrameList.h"
  15 #include "mozilla/Attributes.h"
  16 #include "nsIWebProgress.h"
  17 #include "mozilla/dom/HTMLCanvasElement.h"
  18 #include "nsIWebProgressListener.h"
  19 #include "nsWeakReference.h"
  20
  21 // Interfaces
  22 #include "nsIDOMWindow.h"
  23 #include "nsIObserver.h"
  24
  25 // Classes
  26 class nsPagePrintTimer;
  27 class nsIDocShell;
  28 class nsDeviceContext;
  29 class nsIDocument;
  30 class nsIDocumentViewerPrint;
  31 class nsPrintObject;
  32 class nsIDocShell;
  33 class nsIPageSequenceFrame;
  34 class nsIWeakReference;
  35
  36 //------------------------------------------------------------------------
  37 // nsPrintEngine Class
  38 //
  39 //------------------------------------------------------------------------
  40 class nsPrintEngine MOZ_FINAL : public nsIObserver,
  41                                 public nsIWebProgressListener,
  42                                 public nsSupportsWeakReference
  43 {
  44 public:
  45   // nsISupports interface...
  46   NS_DECL_ISUPPORTS
  47
  48   // nsIObserver
  49   NS_DECL_NSIOBSERVER
  50
  51   NS_DECL_NSIWEBPROGRESSLISTENER
  52
  53   // Old nsIWebBrowserPrint methods; not cleaned up yet
  54   NS_IMETHOD Print(nsIPrintSettings*       aPrintSettings,
  55                    nsIWebProgressListener* aWebProgressListener);
  56   NS_IMETHOD PrintPreview(nsIPrintSettings* aPrintSettings,
  57                           nsIDOMWindow *aChildDOMWin,
  58                           nsIWebProgressListener* aWebProgressListener);
  59   NS_IMETHOD GetIsFramesetDocument(bool *aIsFramesetDocument);
  60   NS_IMETHOD GetIsIFrameSelected(bool *aIsIFrameSelected);
  61   NS_IMETHOD GetIsRangeSelection(bool *aIsRangeSelection);
  62   NS_IMETHOD GetIsFramesetFrameSelected(bool *aIsFramesetFrameSelected);
  63   NS_IMETHOD GetPrintPreviewNumPages(int32_t *aPrintPreviewNumPages);
  64   NS_IMETHOD EnumerateDocumentNames(uint32_t* aCount, char16_t*** aResult);
  65   static nsresult GetGlobalPrintSettings(nsIPrintSettings** aPrintSettings);
  66   NS_IMETHOD GetDoingPrint(bool *aDoingPrint);
  67   NS_IMETHOD GetDoingPrintPreview(bool *aDoingPrintPreview);
  68   NS_IMETHOD GetCurrentPrintSettings(nsIPrintSettings **aCurrentPrintSettings);
  69
  70
  71   // This enum tells indicates what the default should be for the title
  72   // if the title from the document is null
  73   enum eDocTitleDefault {
  74     eDocTitleDefBlank,
  75     eDocTitleDefURLDoc
  76   };
  77
  78   nsPrintEngine();
  79
  80   void Destroy();
  81   void DestroyPrintingData();
  82
  83   nsresult Initialize(nsIDocumentViewerPrint* aDocViewerPrint,
  84                       nsIDocShell*            aContainer,
  85                       nsIDocument*            aDocument,
  86                       float                   aScreenDPI,
  87                       FILE*                   aDebugFile);
  88
  89   nsresult GetSeqFrameAndCountPages(nsIFrame*& aSeqFrame, int32_t& aCount);
  90
  91   //
  92   // The following three methods are used for printing...
  93   //
  94   nsresult DocumentReadyForPrinting();
  95   nsresult GetSelectionDocument(nsIDeviceContextSpec * aDevSpec,
  96                                 nsIDocument ** aNewDoc);
  97
  98   nsresult SetupToPrintContent();
  99   nsresult EnablePOsForPrinting();
 100   nsPrintObject* FindSmallestSTF();
 101
 102   bool     PrintDocContent(nsPrintObject* aPO, nsresult& aStatus);
 103   nsresult DoPrint(nsPrintObject * aPO);
 104
 105   void SetPrintPO(nsPrintObject* aPO, bool aPrint);
 106
 107   void TurnScriptingOn(bool aDoTurnOn);
 108   bool CheckDocumentForPPCaching();
 109   void InstallPrintPreviewListener();
 110
 111   // nsIDocumentViewerPrint Printing Methods
 112   bool     HasPrintCallbackCanvas();
 113   bool     PrePrintPage();
 114   bool     PrintPage(nsPrintObject* aPOect, bool& aInRange);
 115   bool     DonePrintingPages(nsPrintObject* aPO, nsresult aResult);
 116
 117   //---------------------------------------------------------------------
 118   void BuildDocTree(nsIDocShell *      aParentNode,
 119                     nsTArray<nsPrintObject*> * aDocList,
 120                     nsPrintObject *            aPO);
 121   nsresult ReflowDocList(nsPrintObject * aPO, bool aSetPixelScale);
 122
 123   nsresult ReflowPrintObject(nsPrintObject * aPO);
 124
 125   void CheckForChildFrameSets(nsPrintObject* aPO);
 126
 127   void CalcNumPrintablePages(int32_t& aNumPages);
 128   void ShowPrintProgress(bool aIsForPrinting, bool& aDoNotify);
 129   nsresult CleanupOnFailure(nsresult aResult, bool aIsPrinting);
 130   // If FinishPrintPreview() fails, caller may need to reset the state of the
 131   // object, for example by calling CleanupOnFailure().
 132   nsresult FinishPrintPreview();
 133   static void CloseProgressDialog(nsIWebProgressListener* aWebProgressListener);
 134   void SetDocAndURLIntoProgress(nsPrintObject* aPO,
 135                                 nsIPrintProgressParams* aParams);
 136   void EllipseLongString(nsAString& aStr, const uint32_t aLen, bool aDoFront);
 137   nsresult CheckForPrinters(nsIPrintSettings* aPrintSettings);
 138   void CleanupDocTitleArray(char16_t**& aArray, int32_t& aCount);
 139
 140   bool IsThereARangeSelection(nsIDOMWindow * aDOMWin);
 141
 142   //---------------------------------------------------------------------
 143
 144
 145   // Timer Methods
 146   nsresult StartPagePrintTimer(nsPrintObject* aPO);
 147
 148   bool IsWindowsInOurSubTree(nsPIDOMWindow * aDOMWindow);
 149   static bool IsParentAFrameSet(nsIDocShell * aParent);
 150   bool IsThereAnIFrameSelected(nsIDocShell* aDocShell,
 151                                  nsIDOMWindow* aDOMWin,
 152                                  bool& aIsParentFrameSet);
 153
 154   static nsPrintObject* FindPrintObjectByDOMWin(nsPrintObject* aParentObject,
 155                                                 nsIDOMWindow* aDOMWin);
 156
 157   // get the currently infocus frame for the document viewer
 158   already_AddRefed<nsIDOMWindow> FindFocusedDOMWindow();
 159
 160   //---------------------------------------------------------------------
 161   // Static Methods
 162   //---------------------------------------------------------------------
 163   static void GetDocumentTitleAndURL(nsIDocument* aDoc,
 164                                      nsAString&   aTitle,
 165                                      nsAString&   aURLStr);
 166   void GetDisplayTitleAndURL(nsPrintObject*   aPO,
 167                              nsAString&       aTitle,
 168                              nsAString&       aURLStr,
 169                              eDocTitleDefault aDefType);
 170   static void ShowPrintErrorDialog(nsresult printerror,
 171                                    bool aIsPrinting = true);
 172
 173   static bool HasFramesetChild(nsIContent* aContent);
 174
 175   bool     CheckBeforeDestroy();
 176   nsresult Cancelled();
 177
 178   nsIPresShell* GetPrintPreviewPresShell() {return mPrtPreview->mPrintObject->mPresShell;}
 179
 180   float GetPrintPreviewScale() { return mPrtPreview->mPrintObject->
 181                                         mPresContext->GetPrintPreviewScale(); }
 182
 183   static nsIPresShell* GetPresShellFor(nsIDocShell* aDocShell);
 184
 185   // These calls also update the DocViewer
 186   void SetIsPrinting(bool aIsPrinting);
 187   bool GetIsPrinting()
 188   {
 189     return mIsDoingPrinting;
 190   }
 191   void SetIsPrintPreview(bool aIsPrintPreview);
 192   bool GetIsPrintPreview()
 193   {
 194     return mIsDoingPrintPreview;
 195   }
 196   void SetIsCreatingPrintPreview(bool aIsCreatingPrintPreview)
 197   {
 198     mIsCreatingPrintPreview = aIsCreatingPrintPreview;
 199   }
 200   bool GetIsCreatingPrintPreview()
 201   {
 202     return mIsCreatingPrintPreview;
 203   }
 204
 205   void SetDisallowSelectionPrint(bool aDisallowSelectionPrint)
 206   {
 207     mDisallowSelectionPrint = aDisallowSelectionPrint;
 208   }
 209
 210   void SetNoMarginBoxes(bool aNoMarginBoxes) {
 211     mNoMarginBoxes = aNoMarginBoxes;
 212   }
 213
 214 protected:
 215   ~nsPrintEngine();
 216
 217   nsresult CommonPrint(bool aIsPrintPreview, nsIPrintSettings* aPrintSettings,
 218                        nsIWebProgressListener* aWebProgressListener,
 219                        nsIDOMDocument* aDoc);
 220
 221   nsresult DoCommonPrint(bool aIsPrintPreview, nsIPrintSettings* aPrintSettings,
 222                          nsIWebProgressListener* aWebProgressListener,
 223                          nsIDOMDocument* aDoc);
 224
 225   void FirePrintCompletionEvent();
 226   static nsresult GetSeqFrameAndCountPagesInternal(nsPrintObject*  aPO,
 227                                                    nsIFrame*&      aSeqFrame,
 228                                                    int32_t&        aCount);
 229
 230   static nsresult FindSelectionBoundsWithList(nsPresContext* aPresContext,
 231                                               nsRenderingContext& aRC,
 232                                               nsFrameList::Enumerator& aChildFrames,
 233                                               nsIFrame *      aParentFrame,
 234                                               nsRect&         aRect,
 235                                               nsIFrame *&     aStartFrame,
 236                                               nsRect&         aStartRect,
 237                                               nsIFrame *&     aEndFrame,
 238                                               nsRect&         aEndRect);
 239
 240   static nsresult FindSelectionBounds(nsPresContext* aPresContext,
 241                                       nsRenderingContext& aRC,
 242                                       nsIFrame *      aParentFrame,
 243                                       nsRect&         aRect,
 244                                       nsIFrame *&     aStartFrame,
 245                                       nsRect&         aStartRect,
 246                                       nsIFrame *&     aEndFrame,
 247                                       nsRect&         aEndRect);
 248
 249   static nsresult GetPageRangeForSelection(nsIPresShell *        aPresShell,
 250                                            nsPresContext*        aPresContext,
 251                                            nsRenderingContext&   aRC,
 252                                            nsISelection*         aSelection,
 253                                            nsIPageSequenceFrame* aPageSeqFrame,
 254                                            nsIFrame**            aStartFrame,
 255                                            int32_t&              aStartPageNum,
 256                                            nsRect&               aStartRect,
 257                                            nsIFrame**            aEndFrame,
 258                                            int32_t&              aEndPageNum,
 259                                            nsRect&               aEndRect);
 260
 261   static void MapContentForPO(nsPrintObject* aPO, nsIContent* aContent);
 262
 263   static void MapContentToWebShells(nsPrintObject* aRootPO, nsPrintObject* aPO);
 264
 265   static void SetPrintAsIs(nsPrintObject* aPO, bool aAsIs = true);
 266
 267   // Static member variables
 268   bool mIsCreatingPrintPreview;
 269   bool mIsDoingPrinting;
 270   bool mIsDoingPrintPreview; // per DocumentViewer
 271   bool mProgressDialogIsShown;
 272
 273   nsCOMPtr<nsIDocumentViewerPrint> mDocViewerPrint;
 274   nsWeakPtr               mContainer;
 275   float                   mScreenDPI;
 276
 277   nsPrintData*            mPrt;
 278   nsPagePrintTimer*       mPagePrintTimer;
 279   nsIPageSequenceFrame*   mPageSeqFrame;
 280
 281   // Print Preview
 282   nsPrintData*            mPrtPreview;
 283   nsPrintData*            mOldPrtPreview;
 284
 285   nsCOMPtr<nsIDocument>   mDocument;
 286
 287   FILE* mDebugFile;
 288
 289   int32_t mLoadCounter;
 290   bool mDidLoadDataForPrinting;
 291   bool mIsDestroying;
 292   bool mDisallowSelectionPrint;
 293   bool mNoMarginBoxes;
 294
 295   nsresult AfterNetworkPrint(bool aHandleError);
 296
 297   nsresult SetRootView(nsPrintObject* aPO,
 298                        bool& aDoReturn,
 299                        bool& aDocumentIsTopLevel,
 300                        nsSize& aAdjSize);
 301   nsView* GetParentViewForRoot();
 302   bool DoSetPixelScale();
 303   void UpdateZoomRatio(nsPrintObject* aPO, bool aSetPixelScale);
 304   nsresult ReconstructAndReflow(bool aDoSetPixelScale);
 305   nsresult UpdateSelectionAndShrinkPrintObject(nsPrintObject* aPO,
 306                                                bool aDocumentIsTopLevel);
 307   nsresult InitPrintDocConstruction(bool aHandleError);
 308   void FirePrintPreviewUpdateEvent();
 309 private:
 310   nsPrintEngine& operator=(const nsPrintEngine& aOther) = delete;
 311 };
 312
 313 #endif /* nsPrintEngine_h___ */