SkPDF: SkPDFDevice has ptr to SkPDFDocument

src/pdf/SkPDFDevice.h

 /*
  * Copyright 2011 Google Inc.
  *
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
 #ifndef SkPDFDevice_DEFINED
 #define SkPDFDevice_DEFINED
 
 #include "SkBitmap.h"
 #include "SkCanvas.h"
 #include "SkClipStack.h"
 #include "SkData.h"
 #include "SkDevice.h"
 #include "SkPaint.h"
 #include "SkPath.h"
 #include "SkPicture.h"
 #include "SkRect.h"
 #include "SkRefCnt.h"
 #include "SkStream.h"
 #include "SkTDArray.h"
 #include "SkTemplates.h"
 
 class SkPDFArray;
 class SkPDFCanon;
 class SkPDFDevice;
+class SkPDFDocument;
 class SkPDFDict;
 class SkPDFFont;
 class SkPDFFormXObject;
 class SkPDFGlyphSetMap;
 class SkPDFGraphicState;
 class SkPDFObject;
 class SkPDFShader;
 class SkPDFStream;
 class SkRRect;
 
@@ skipping 14 matching lines @@
      *         1 point == 127/360 mm == 1/72 inch
      *  @param rasterDpi the DPI at which features without native PDF
      *         support will be rasterized (e.g. draw image with
      *         perspective, draw text with perspective, ...).  A
      *         larger DPI would create a PDF that reflects the
      *         original intent with better fidelity, but it can make
      *         for larger PDF files too, which would use more memory
      *         while rendering, and it would be slower to be processed
      *         or sent online or to printer.  A good choice is
      *         SK_ScalarDefaultRasterDPI(72.0f).
-     *  @param SkPDFCanon.  Should be non-null, and shared by all
+     *  @param SkPDFDocument.  Should be non-null, and shared by all
      *         devices in a document.

[tomhudson, 2016/03/21 14:49:48]

This comment doesn't explain to me why. In the old days I might have been able
to go read SkPDFCanon.h and figure out why there was one being provided, but now
I have no clue unless I git into the code far enough that I realize the Canon
off of this Document is being returned by getCanon() and I need to know what
that canon is; even that isn't sufficient for me to know if it's the *only*
reason this Document is being provided.

[hal.canary, 2016/03/21 21:06:02]

better?

@param SkPDFDocument.  A non-null pointer back to the
       document.  The document is repsonsible for
       de-duplicating across pages (via the SkPDFCanon) and
       for early serializing of large immutable objects, such
       as images (via SkPDFDocument::serialize()).

[tomhudson, 2016/03/21 21:09:56]

Yes, thanks.

      */
     static SkPDFDevice* Create(SkISize pageSize,
                                SkScalar rasterDpi,
-                               SkPDFCanon* canon) {
-        return new SkPDFDevice(pageSize, rasterDpi, canon, true);
+                               SkPDFDocument* doc) {
+        return new SkPDFDevice(pageSize, rasterDpi, doc, true);
     }
 
     /** Create a PDF drawing context without fipping the y-axis. */
     static SkPDFDevice* CreateUnflipped(SkISize pageSize,
                                         SkScalar rasterDpi,
-                                        SkPDFCanon* canon) {
-        return new SkPDFDevice(pageSize, rasterDpi, canon, false);
+                                        SkPDFDocument* doc) {
+        return new SkPDFDevice(pageSize, rasterDpi, doc, false);
     }
 
     virtual ~SkPDFDevice();
 
     /** These are called inside the per-device-layer loop for each draw call.
      When these are called, we have already applied any saveLayer operations,
      and are handling any looping from the paint, and any effects from the
      DrawFilter.
      */
     void drawPaint(const SkDraw&, const SkPaint& paint) override;
@@ skipping 91 matching lines @@
         return fInitialTransform;
     }
 
     /** Returns a SkPDFGlyphSetMap which represents glyph usage of every font
      *  that shows on this device.
      */
     const SkPDFGlyphSetMap& getFontGlyphUsage() const {
         return *(fFontGlyphUsage.get());
     }
 
-    SkPDFCanon* getCanon() const { return fCanon; }
+    SkPDFCanon* getCanon() const;
 
 protected:
     const SkBitmap& onAccessBitmap() override {
         return fLegacyBitmap;
     }
 
     SkSurface* newSurface(const SkImageInfo&, const SkSurfaceProps&) override;
 
     void drawAnnotation(const SkDraw&, const SkRect&, const char key[], SkData* value) override;
 
@@ skipping 56 matching lines @@
     // Accessor and setter functions based on the current DrawingArea.
     SkAutoTDelete<ContentEntry>* getContentEntries();
 
     // Glyph ids used for each font on this device.
     SkAutoTDelete<SkPDFGlyphSetMap> fFontGlyphUsage;
 
     SkScalar fRasterDpi;
 
     SkBitmap fLegacyBitmap;
 
-    SkPDFCanon* fCanon;  // Owned by SkDocument_PDF
+    SkPDFDocument* fDocument;
     ////////////////////////////////////////////////////////////////////////////
 
     SkPDFDevice(SkISize pageSize,
                 SkScalar rasterDpi,
-                SkPDFCanon* canon,
+                SkPDFDocument* doc,
                 bool flip);
 
     ContentEntry* getLastContentEntry();
     void setLastContentEntry(ContentEntry* contentEntry);
 
     SkBaseDevice* onCreateDevice(const CreateInfo&, const SkPaint*) override;
 
     void init();
     void cleanUp(bool clearFontUsage);
     SkPDFFormXObject* createFormXObjectFromDevice();
@@ skipping 53 matching lines @@
 
     typedef SkBaseDevice INHERITED;
 
     // TODO(edisonn): Only SkDocument_PDF and SkPDFImageShader should be able to create
     // an SkPDFDevice
     //friend class SkDocument_PDF;
     //friend class SkPDFImageShader;
 };
 
 #endif