src/pdf/SkPDFStream.h

   1
   2 /*
   3  * Copyright 2010 Google Inc.
   4  *
   5  * Use of this source code is governed by a BSD-style license that can be
   6  * found in the LICENSE file.
   7  */
   8
   9
  10 #ifndef SkPDFStream_DEFINED
  11 #define SkPDFStream_DEFINED
  12
  13 #include "SkPDFTypes.h"
  14 #include "SkRefCnt.h"
  15 #include "SkStream.h"
  16 #include "SkTemplates.h"
  17
  18 class SkPDFCatalog;
  19
  20 /** \class SkPDFStream
  21
  22     A stream object in a PDF.  Note, all streams must be indirect objects (via
  23     SkObjRef).
  24 */
  25 class SkPDFStream : public SkPDFDict {
  26     SK_DECLARE_INST_COUNT(SkPDFStream)
  27 public:
  28     /** Create a PDF stream. A Length entry is automatically added to the
  29      *  stream dictionary.
  30      *  @param data   The data part of the stream.  Will be ref()ed.
  31      */
  32     explicit SkPDFStream(SkData* data);
  33
  34     /** Create a PDF stream. A Length entry is automatically added to the
  35      *  stream dictionary.
  36      *  @param stream The data part of the stream.  Will be duplicate()d.
  37      */
  38     explicit SkPDFStream(SkStream* stream);
  39
  40     virtual ~SkPDFStream();
  41
  42     // The SkPDFObject interface.
  43     virtual void emitObject(SkWStream* stream, SkPDFCatalog* catalog) override;
  44
  45 protected:
  46     enum State {
  47         kUnused_State,         //!< The stream hasn't been requested yet.
  48         kNoCompression_State,  //!< The stream's been requested in an
  49                                //   uncompressed form.
  50         kCompressed_State,     //!< The stream's already been compressed.
  51     };
  52
  53     /** Create a PDF stream with the same content and dictionary entries
  54      *  as the passed one.
  55      */
  56     explicit SkPDFStream(const SkPDFStream& pdfStream);
  57
  58     /* Create a PDF stream with no data.  The setData method must be called to
  59      * set the data.
  60      */
  61     SkPDFStream();
  62
  63     // Populate the stream dictionary.  This method returns false if
  64     // fSubstitute should be used.
  65     virtual bool populate(SkPDFCatalog* catalog);
  66
  67     void setSubstitute(SkPDFStream* stream) {
  68         fSubstitute.reset(stream);
  69     }
  70
  71     SkPDFStream* getSubstitute() const {
  72         return fSubstitute.get();
  73     }
  74
  75     void setData(SkData* data);
  76     void setData(SkStream* stream);
  77
  78     size_t dataSize() const;
  79
  80     void setState(State state) {
  81         fState = state;
  82     }
  83
  84     State getState() const {
  85         return fState;
  86     }
  87
  88 private:
  89     // Indicates what form (or if) the stream has been requested.
  90     State fState;
  91
  92     SkAutoTDelete<SkStreamRewindable> fDataStream;
  93     SkAutoTUnref<SkPDFStream> fSubstitute;
  94
  95     typedef SkPDFDict INHERITED;
  96 };
  97
  98 #endif