SkPDF: Factor SkPDFCatalog into SkPDFObjNumMap and SkPDFSubstituteMap

src/pdf/SkPDFTypes.h

 
 /*
  * Copyright 2010 The Android Open Source Project
  *
  * Use of this source code is governed by a BSD-style license that can be
  * found in the LICENSE file.
  */
 
 
 #ifndef SkPDFTypes_DEFINED
 #define SkPDFTypes_DEFINED
 
+#include "SkPDFTypes.h"
 #include "SkRefCnt.h"
 #include "SkScalar.h"
 #include "SkString.h"
 #include "SkTDArray.h"
+#include "SkTHash.h"
 #include "SkTypes.h"
 
-class SkPDFCatalog;
+class SkPDFObjNumMap;
+class SkPDFObject;
+class SkPDFSubstituteMap;
 class SkWStream;
 
-class SkPDFObject;
-
 /** \class SkPDFObject
 
     A PDF Object is the base class for primitive elements in a PDF file.  A
     common subtype is used to ease the use of indirect object references,
     which are common in the PDF format.
 */
 class SkPDFObject : public SkRefCnt {
 public:
     SK_DECLARE_INST_COUNT(SkPDFObject)
 
     /** Subclasses must implement this method to print the object to the
      *  PDF file.
      *  @param catalog  The object catalog to use.
      *  @param stream   The writable output stream to send the output to.
      */
     // TODO(halcanary): make this method const
-    virtual void emitObject(SkWStream* stream, SkPDFCatalog* catalog) = 0;
+    virtual void emitObject(SkWStream* stream,
+                            const SkPDFObjNumMap& objNumMap,
+                            const SkPDFSubstituteMap& substitutes) = 0;
 
     /**
      *  Adds all transitive dependencies of this object to the
      *  catalog.  Implementations should respect the catalog's object
      *  substitution map.
      */
-    virtual void addResources(SkPDFCatalog* catalog) const {}
+    virtual void addResources(SkPDFObjNumMap* catalog,
+                              const SkPDFSubstituteMap& substitutes) const {}
 
 private:
     typedef SkRefCnt INHERITED;
 };
 
 /** \class SkPDFObjRef
 
     An indirect reference to a PDF object.
 */
 class SkPDFObjRef : public SkPDFObject {
 public:
     SK_DECLARE_INST_COUNT(SkPDFObjRef)
 
     /** Create a reference to an existing SkPDFObject.
      *  @param obj The object to reference.
      */
     explicit SkPDFObjRef(SkPDFObject* obj);
     virtual ~SkPDFObjRef();
 
     // The SkPDFObject interface.
-    virtual void emitObject(SkWStream* stream, SkPDFCatalog* catalog) override;
-    virtual void addResources(SkPDFCatalog*) const override;
+    virtual void emitObject(SkWStream* stream,
+                            const SkPDFObjNumMap& objNumMap,
+                            const SkPDFSubstituteMap& substitutes) override;
+    virtual void addResources(SkPDFObjNumMap*,
+                              const SkPDFSubstituteMap&) const override;
 
 private:
     SkAutoTUnref<SkPDFObject> fObj;
 
     typedef SkPDFObject INHERITED;
 };
 
 /** \class SkPDFInt
 
     An integer object in a PDF.
 */
 class SkPDFInt : public SkPDFObject {
 public:
     SK_DECLARE_INST_COUNT(SkPDFInt)
 
     /** Create a PDF integer (usually for indirect reference purposes).
      *  @param value An integer value between 2^31 - 1 and -2^31.
      */
     explicit SkPDFInt(int32_t value);
     virtual ~SkPDFInt();
 
     // The SkPDFObject interface.
-    virtual void emitObject(SkWStream* stream, SkPDFCatalog* catalog) override;
+    virtual void emitObject(SkWStream* stream,
+                            const SkPDFObjNumMap& objNumMap,
+                            const SkPDFSubstituteMap& substitutes) override;
 
 private:
     int32_t fValue;
 
     typedef SkPDFObject INHERITED;
 };
 
 /** \class SkPDFBool
 
     An boolean value in a PDF.
 */
 class SkPDFBool : public SkPDFObject {
 public:
     SK_DECLARE_INST_COUNT(SkPDFBool)
 
     /** Create a PDF boolean.
      *  @param value true or false.
      */
     explicit SkPDFBool(bool value);
     virtual ~SkPDFBool();
 
     // The SkPDFObject interface.
-    virtual void emitObject(SkWStream* stream, SkPDFCatalog* catalog) override;
+    virtual void emitObject(SkWStream* stream,
+                            const SkPDFObjNumMap& objNumMap,
+                            const SkPDFSubstituteMap& substitutes) override;
 
 private:
     bool fValue;
 
     typedef SkPDFObject INHERITED;
 };
 
 /** \class SkPDFScalar
 
     A real number object in a PDF.
 */
 class SkPDFScalar : public SkPDFObject {
 public:
     SK_DECLARE_INST_COUNT(SkPDFScalar)
 
     /** Create a PDF real number.
      *  @param value A real value.
      */
     explicit SkPDFScalar(SkScalar value);
     virtual ~SkPDFScalar();
 
     static void Append(SkScalar value, SkWStream* stream);
 
     // The SkPDFObject interface.
-    virtual void emitObject(SkWStream* stream, SkPDFCatalog* catalog) override;
+    virtual void emitObject(SkWStream* stream,
+                            const SkPDFObjNumMap& objNumMap,
+                            const SkPDFSubstituteMap& substitutes) override;
 
 private:
     SkScalar fValue;
 
     typedef SkPDFObject INHERITED;
 };
 
 /** \class SkPDFString
 
     A string object in a PDF.
@@ skipping 11 matching lines @@
     /** Create a PDF string. Maximum length (in bytes) is 65,535.
      *  @param value     A string value.
      *  @param len       The length of value.
      *  @param wideChars Indicates if the top byte in value is significant and
      *                   should be encoded (true) or not (false).
      */
     SkPDFString(const uint16_t* value, size_t len, bool wideChars);
     virtual ~SkPDFString();
 
     // The SkPDFObject interface.
-    virtual void emitObject(SkWStream* stream, SkPDFCatalog* catalog) override;
+    virtual void emitObject(SkWStream* stream,
+                            const SkPDFObjNumMap& objNumMap,
+                            const SkPDFSubstituteMap& substitutes) override;
 
     static SkString FormatString(const char* input, size_t len);
     static SkString FormatString(const uint16_t* input, size_t len,
                                  bool wideChars);
 private:
     static const size_t kMaxLen = 65535;
 
     const SkString fValue;
 
     static SkString DoFormatString(const void* input, size_t len,
@@ skipping 13 matching lines @@
     /** Create a PDF name object. Maximum length is 127 bytes.
      *  @param value The name.
      */
     explicit SkPDFName(const char name[]);
     explicit SkPDFName(const SkString& name);
     virtual ~SkPDFName();
 
     bool operator==(const SkPDFName& b) const;
 
     // The SkPDFObject interface.
-    virtual void emitObject(SkWStream* stream, SkPDFCatalog* catalog) override;
+    virtual void emitObject(SkWStream* stream,
+                            const SkPDFObjNumMap& objNumMap,
+                            const SkPDFSubstituteMap& substitutes) override;
 
 private:
     static const size_t kMaxLen = 127;
 
     const SkString fValue;
 
     static SkString FormatName(const SkString& input);
 
     typedef SkPDFObject INHERITED;
 };
 
 /** \class SkPDFArray
 
     An array object in a PDF.
 */
 class SkPDFArray : public SkPDFObject {
 public:
     SK_DECLARE_INST_COUNT(SkPDFArray)
 
     /** Create a PDF array. Maximum length is 8191.
      */
     SkPDFArray();
     virtual ~SkPDFArray();
 
     // The SkPDFObject interface.
-    virtual void emitObject(SkWStream* stream, SkPDFCatalog* catalog) override;
-    virtual void addResources(SkPDFCatalog*) const override;
+    virtual void emitObject(SkWStream* stream,
+                            const SkPDFObjNumMap& objNumMap,
+                            const SkPDFSubstituteMap& substitutes) override;
+    virtual void addResources(SkPDFObjNumMap*,
+                              const SkPDFSubstituteMap&) const override;
 
     /** The size of the array.
      */
     int size() { return fValue.count(); }
 
     /** Preallocate space for the given number of entries.
      *  @param length The number of array slots to preallocate.
      */
     void reserve(int length);
 
@@ skipping 50 matching lines @@
     SkPDFDict();
 
     /** Create a PDF dictionary with a Type entry.
      *  @param type   The value of the Type entry.
      */
     explicit SkPDFDict(const char type[]);
 
     virtual ~SkPDFDict();
 
     // The SkPDFObject interface.
-    virtual void emitObject(SkWStream* stream, SkPDFCatalog* catalog) override;
-    virtual void addResources(SkPDFCatalog*) const override;
+    virtual void emitObject(SkWStream* stream,
+                            const SkPDFObjNumMap& objNumMap,
+                            const SkPDFSubstituteMap& substitutes) override;
+    virtual void addResources(SkPDFObjNumMap*,
+                              const SkPDFSubstituteMap&) const override;
 
     /** The size of the dictionary.
      */
     int size() const;
 
     /** Add the value to the dictionary with the given key.  Refs value.
      *  @param key   The key for this dictionary entry.
      *  @param value The value for this dictionary entry.
      *  @return The value argument is returned.
      */
@@ skipping 64 matching lines @@
 
     static const int kMaxLen = 4095;
 
     SkTDArray<struct Rec> fValue;
 
     SkPDFObject* append(SkPDFName* key, SkPDFObject* value);
 
     typedef SkPDFObject INHERITED;
 };
 
+////////////////////////////////////////////////////////////////////////////////
+
+/** \class SkPDFSubstituteMap
+
+    The PDF Substitute Map manages substitute objects and owns the
+    substitutes.
+*/
+class SkPDFSubstituteMap : SkNoncopyable {
+public:
+    ~SkPDFSubstituteMap();
+    /** Set substitute object for the passed object.
+        Refs substitute.
+     */
+    void setSubstitute(SkPDFObject* original, SkPDFObject* substitute);
+
+    /** Find and return any substitute object set for the passed object. If
+     *  there is none, return the passed object.
+     */
+    SkPDFObject* getSubstitute(SkPDFObject* object) const;
+
+private:
+    SkTHashMap<SkPDFObject*, SkPDFObject*> fSubstituteMap;
+};
+
+/** \class SkPDFObjNumMap
+
+    The PDF Object Number Map manages object numbers.  It is used to
+    create the PDF cross reference table.
+*/
+class SkPDFObjNumMap : SkNoncopyable {
+public:
+    /** Add the passed object to the catalog.
+     *  @param obj         The object to add.
+     *  @return True iff the object was not already added to the catalog.
+     */
+    bool addObject(SkPDFObject* obj);
+
+    /** Get the object number for the passed object.
+     *  @param obj         The object of interest.
+     */
+    int32_t getObjectNumber(SkPDFObject* obj) const;
+
+    const SkTDArray<SkPDFObject*>& objects() const { return fObjects; }
+
+private:
+    SkTDArray<SkPDFObject*> fObjects;
+    SkTHashMap<SkPDFObject*, int32_t> fObjectNumbers;
+};
+
 #endif