SkPDFDocument.h

Go to the documentation of this file.

// Copyright 2018 Google LLC.
// Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.
#ifndef SkPDFDocument_DEFINED
#define SkPDFDocument_DEFINED
 
#include "include/core/SkDocument.h"
 
#include <vector>
 
#include "include/core/SkColor.h"
#include "include/core/SkMilestone.h"
#include "include/core/SkScalar.h"
#include "include/core/SkString.h"
#include "include/private/base/SkNoncopyable.h"
#include "src/base/SkTime.h"
 
#define SKPDF_STRING(X) SKPDF_STRING_IMPL(X)
#define SKPDF_STRING_IMPL(X) #X
 
class SkExecutor;
class SkPDFArray;
class SkPDFTagTree;
 
namespace SkPDF {
 
class SK_API AttributeList : SkNoncopyable {
public:
    AttributeList();
    ~AttributeList();
 
    // Each attribute must have an owner (e.g. "Layout", "List", "Table", etc)
    // and an attribute name (e.g. "BBox", "RowSpan", etc.) from PDF32000_2008 14.8.5,
    // and then a value of the proper type according to the spec.
    void appendInt(const char* owner, const char* name, int value);
    void appendFloat(const char* owner, const char* name, float value);
    void appendName(const char* owner, const char* attrName, const char* value);
    void appendFloatArray(const char* owner,
                          const char* name,
                          const std::vector<float>& value);
    void appendNodeIdArray(const char* owner,
                           const char* attrName,
                           const std::vector<int>& nodeIds);
 
private:
    friend class ::SkPDFTagTree;
 
    std::unique_ptr<SkPDFArray> fAttrs;
};
 
struct StructureElementNode {
    SkString fTypeString;
    std::vector<std::unique_ptr<StructureElementNode>> fChildVector;
    int fNodeId = 0;
    std::vector<int> fAdditionalNodeIds;
    AttributeList fAttributes;
    SkString fAlt;
    SkString fLang;
};
 
struct DateTime {
    int16_t  fTimeZoneMinutes;  // The number of minutes that this
                                // is ahead of or behind UTC.
    uint16_t fYear;          
    uint8_t  fMonth;         
    uint8_t  fDayOfWeek;     
    uint8_t  fDay;           
    uint8_t  fHour;          
    uint8_t  fMinute;        
    uint8_t  fSecond;        
 
    void toISO8601(SkString* dst) const;
};
 
struct Metadata {
    SkString fTitle;
 
    SkString fAuthor;
 
    SkString fSubject;
 
    SkString fKeywords;
 
    SkString fCreator;
 
    SkString fProducer = SkString("Skia/PDF m" SKPDF_STRING(SK_MILESTONE));
 
    DateTime fCreation = {0, 0, 0, 0, 0, 0, 0, 0};
 
    DateTime fModified = {0, 0, 0, 0, 0, 0, 0, 0};
 
    SkScalar fRasterDPI = SK_ScalarDefaultRasterDPI;
 
    bool fPDFA = false;
 
    int fEncodingQuality = 101;
 
    StructureElementNode* fStructureElementTreeRoot = nullptr;
 
    enum class Outline : int {
        None = 0,
        StructureElementHeaders = 1,
    } fOutline = Outline::None;
 
    SkExecutor* fExecutor = nullptr;
 
    enum class CompressionLevel : int {
        Default = -1,
        None = 0,
        LowButFast = 1,
        Average = 6,
        HighButSlow = 9,
    } fCompressionLevel = CompressionLevel::Default;
 
    enum Subsetter {
        kHarfbuzz_Subsetter,
        kSfntly_Subsetter,
    } fSubsetter = kHarfbuzz_Subsetter;
};
 
SK_API void SetNodeId(SkCanvas* dst, int nodeID);
 
SK_API sk_sp<SkDocument> MakeDocument(SkWStream* stream, const Metadata& metadata);
 
static inline sk_sp<SkDocument> MakeDocument(SkWStream* stream) {
    return MakeDocument(stream, Metadata());
}
 
}  // namespace SkPDF
 
#undef SKPDF_STRING
#undef SKPDF_STRING_IMPL
#endif  // SkPDFDocument_DEFINED