Source/WebCore/platform/graphics/cg/PDFDocumentImage.h

/*
 * Copyright (C) 2004, 2005, 2006, 2013 Apple Inc.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 */

#ifndef PDFDocumentImage_h
#define PDFDocumentImage_h

#include "AffineTransform.h"
#include "FloatRect.h"
#include "GraphicsTypes.h"
#include "Image.h"
#include "Settings.h"

#if USE(CG)

#if PLATFORM(MAC)
#define USE_PDFKIT_FOR_PDFDOCUMENTIMAGE 1
#endif

typedef struct CGPDFDocument *CGPDFDocumentRef;
OBJC_CLASS PDFDocument;

namespace WebCore {

class GraphicsContext;
class ImageBuffer;

class PDFDocumentImage final : public Image {
public:
    static Ref<PDFDocumentImage> create(ImageObserver* observer)
    {
        return adoptRef(*new PDFDocumentImage(observer));
    }

    void setPdfImageCachingPolicy(PDFImageCachingPolicy);
    
#if PLATFORM(MAC)
    WEBCORE_EXPORT static RetainPtr<CFMutableDataRef> convertPostScriptDataToPDF(RetainPtr<CFDataRef>&& postScriptData);
#endif

    unsigned cachingCountForTesting() const { return m_cachingCountForTesting; }

private:
    PDFDocumentImage(ImageObserver*);
    virtual ~PDFDocumentImage();

    bool isPDFDocumentImage() const override { return true; }

    String filenameExtension() const override;

    bool hasSingleSecurityOrigin() const override { return true; }

    EncodedDataStatus dataChanged(bool allDataReceived) override;

    void destroyDecodedData(bool /*destroyAll*/ = true) override;

    void computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio) override;
    FloatSize size(ImageOrientation = ImageOrientation::FromImage) const override;

    ImageDrawResult draw(GraphicsContext&, const FloatRect& dstRect, const FloatRect& srcRect, const ImagePaintingOptions& = { }) override;

    // FIXME: Implement this to be less conservative.
    bool currentFrameKnownToBeOpaque() const override { return false; }

    void dump(WTF::TextStream&) const override;

    void createPDFDocument();
    void computeBoundsForCurrentPage();
    unsigned pageCount() const;
    void drawPDFPage(GraphicsContext&);

    void decodedSizeChanged(size_t newCachedBytes);
    void updateCachedImageIfNeeded(GraphicsContext&, const FloatRect& dstRect, const FloatRect& srcRect);
    bool cacheParametersMatch(GraphicsContext&, const FloatRect& dstRect, const FloatRect& srcRect) const;

    PDFImageCachingPolicy m_pdfImageCachingPolicy { PDFImageCachingDefault };

#if USE(PDFKIT_FOR_PDFDOCUMENTIMAGE)
    RetainPtr<PDFDocument> m_document;
#else
    RetainPtr<CGPDFDocumentRef> m_document;
#endif

    std::unique_ptr<ImageBuffer> m_cachedImageBuffer;
    FloatRect m_cachedImageRect;
    AffineTransform m_cachedTransform;
    FloatRect m_cachedDestinationRect;
    FloatRect m_cachedSourceRect;
    size_t m_cachedBytes { 0 };
    unsigned m_cachingCountForTesting { 0 };

    FloatRect m_cropBox;
    int m_rotationDegrees { 0 }; // Can only be 0, 90, 180, or 270 degrees.
    bool m_hasPage { false };
};

}

SPECIALIZE_TYPE_TRAITS_IMAGE(PDFDocumentImage)

#endif // USE(CG)

#endif // PDFDocumentImage_h