199ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com/* 299ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * Copyright 2013 Google Inc. 399ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * 499ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * Use of this source code is governed by a BSD-style license that can be 599ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * found in the LICENSE file. 699ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com */ 799ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com 899ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com#ifndef SkDocument_DEFINED 999ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com#define SkDocument_DEFINED 1099ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com 11b5a6651f9f69570d964382134d64360915db9a29commit-bot@chromium.org#include "SkBitmap.h" 12b5a6651f9f69570d964382134d64360915db9a29commit-bot@chromium.org#include "SkPicture.h" 1399ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com#include "SkRect.h" 1499ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com#include "SkRefCnt.h" 1599ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com 1699ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.comclass SkCanvas; 1799ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.comclass SkWStream; 1899ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com 198c294900f31d8d032b62182f011019276d27d5d0commit-bot@chromium.org/** SK_ScalarDefaultDPI is 72 DPI. 208c294900f31d8d032b62182f011019276d27d5d0commit-bot@chromium.org*/ 214b413c8bb123e42ca4b9c7bfa6bc2167283cb84ccommit-bot@chromium.org#define SK_ScalarDefaultRasterDPI 72.0f 228c294900f31d8d032b62182f011019276d27d5d0commit-bot@chromium.org 2399ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com/** 2499ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * High-level API for creating a document-based canvas. To use.. 2599ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * 2699ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * 1. Create a document, specifying a stream to store the output. 2799ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * 2. For each "page" of content: 2899ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * a. canvas = doc->beginPage(...) 2999ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * b. draw_my_content(canvas); 3099ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * c. doc->endPage(); 3199ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * 3. Close the document with doc->close(). 3299ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com */ 3385588344c3ef43768e27881f71079edb372119b5halcanaryclass SK_API SkDocument : public SkRefCnt { 3499ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.compublic: 35ef284a84f503adfd08ee52b5aee142c548698ea4commit-bot@chromium.org SK_DECLARE_INST_COUNT(SkDocument) 36ef284a84f503adfd08ee52b5aee142c548698ea4commit-bot@chromium.org 3799ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com /** 388c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary * Create a PDF-backed document, writing the results into a SkWStream. 398c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary * 408c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary * PDF pages are sized in point units. 1 pt == 1/72 inch == 127/360 mm. 418c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary * 428c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary * @param SkWStream* A PDF document will be written to this 438c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary * stream. The document may write to the stream at 448c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary * anytime during its lifetime, until either close() is 458c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary * called or the document is deleted. 468c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary * @param dpi The DPI (pixels-per-inch) at which features without 478c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary * native PDF support will be rasterized (e.g. draw image 488c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary * with perspective, draw text with perspective, ...) A 498c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary * larger DPI would create a PDF that reflects the 508c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary * original intent with better fidelity, but it can make 518c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary * for larger PDF files too, which would use more memory 528c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary * while rendering, and it would be slower to be processed 538c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary * or sent online or to printer. 548c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary * @returns NULL if there is an error, otherwise a newly created 558c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary * PDF-backed SkDocument. 5699ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com */ 578c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary static SkDocument* CreatePDF(SkWStream*, 588c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary SkScalar dpi = SK_ScalarDefaultRasterDPI); 5999ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com 6099ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com /** 618c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary * Create a PDF-backed document, writing the results into a file. 628c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary */ 638c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary static SkDocument* CreatePDF(const char outputFilePath[], 648c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary SkScalar dpi = SK_ScalarDefaultRasterDPI); 6599ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com 6699ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com /** 6747ef4d5d934bba86848aa238efab21f54a160c1ahalcanary * Create a XPS-backed document, writing the results into the stream. 6847ef4d5d934bba86848aa238efab21f54a160c1ahalcanary * Returns NULL if XPS is not supported. 6947ef4d5d934bba86848aa238efab21f54a160c1ahalcanary */ 7047ef4d5d934bba86848aa238efab21f54a160c1ahalcanary static SkDocument* CreateXPS(SkWStream* stream, 7147ef4d5d934bba86848aa238efab21f54a160c1ahalcanary SkScalar dpi = SK_ScalarDefaultRasterDPI); 7247ef4d5d934bba86848aa238efab21f54a160c1ahalcanary 7347ef4d5d934bba86848aa238efab21f54a160c1ahalcanary /** 7447ef4d5d934bba86848aa238efab21f54a160c1ahalcanary * Create a XPS-backed document, writing the results into a file. 7547ef4d5d934bba86848aa238efab21f54a160c1ahalcanary * Returns NULL if XPS is not supported. 7647ef4d5d934bba86848aa238efab21f54a160c1ahalcanary */ 7747ef4d5d934bba86848aa238efab21f54a160c1ahalcanary static SkDocument* CreateXPS(const char path[], 7847ef4d5d934bba86848aa238efab21f54a160c1ahalcanary SkScalar dpi = SK_ScalarDefaultRasterDPI); 7947ef4d5d934bba86848aa238efab21f54a160c1ahalcanary /** 8099ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * Begin a new page for the document, returning the canvas that will draw 8199ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * into the page. The document owns this canvas, and it will go out of 8299ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * scope when endPage() or close() is called, or the document is deleted. 8399ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com */ 8499ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com SkCanvas* beginPage(SkScalar width, SkScalar height, 8599ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com const SkRect* content = NULL); 8699ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com 8799ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com /** 8899ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * Call endPage() when the content for the current page has been drawn 8999ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * (into the canvas returned by beginPage()). After this call the canvas 9099ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * returned by beginPage() will be out-of-scope. 9199ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com */ 9299ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com void endPage(); 9399ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com 9499ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com /** 9599ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * Call close() when all pages have been drawn. This will close the file 9699ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * or stream holding the document's contents. After close() the document 9799ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * can no longer add new pages. Deleting the document will automatically 9899ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com * call close() if need be. 99b5a6651f9f69570d964382134d64360915db9a29commit-bot@chromium.org * Returns true on success or false on failure. 10099ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com */ 101b5a6651f9f69570d964382134d64360915db9a29commit-bot@chromium.org bool close(); 102b5a6651f9f69570d964382134d64360915db9a29commit-bot@chromium.org 103b5a6651f9f69570d964382134d64360915db9a29commit-bot@chromium.org /** 104b5a6651f9f69570d964382134d64360915db9a29commit-bot@chromium.org * Call abort() to stop producing the document immediately. 105b5a6651f9f69570d964382134d64360915db9a29commit-bot@chromium.org * The stream output must be ignored, and should not be trusted. 106b5a6651f9f69570d964382134d64360915db9a29commit-bot@chromium.org */ 107b5a6651f9f69570d964382134d64360915db9a29commit-bot@chromium.org void abort(); 10899ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com 10999ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.comprotected: 110701b40543d5d124dfa1e59b051cba9d2aaf61670robertphillips@google.com SkDocument(SkWStream*, void (*)(SkWStream*, bool aborted)); 1118c92dc1dc281649f9e6b0ff534c25bc89dded3eahalcanary 11299ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com // note: subclasses must call close() in their destructor, as the base class 11399ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com // cannot do this for them. 11499ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com virtual ~SkDocument(); 11599ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com 11699ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com virtual SkCanvas* onBeginPage(SkScalar width, SkScalar height, 11799ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com const SkRect& content) = 0; 11899ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com virtual void onEndPage() = 0; 119b5a6651f9f69570d964382134d64360915db9a29commit-bot@chromium.org virtual bool onClose(SkWStream*) = 0; 120b5a6651f9f69570d964382134d64360915db9a29commit-bot@chromium.org virtual void onAbort() = 0; 12199ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com 122902d4d18dec27b6991516a235fc04a7af7290287halcanary // Allows subclasses to write to the stream as pages are written. 123902d4d18dec27b6991516a235fc04a7af7290287halcanary SkWStream* getStream() { return fStream; } 124902d4d18dec27b6991516a235fc04a7af7290287halcanary 12599ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com enum State { 12699ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com kBetweenPages_State, 12799ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com kInPage_State, 12899ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com kClosed_State 12999ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com }; 13099ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com State getState() const { return fState; } 13199ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com 13299ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.comprivate: 13399ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com SkWStream* fStream; 134701b40543d5d124dfa1e59b051cba9d2aaf61670robertphillips@google.com void (*fDoneProc)(SkWStream*, bool aborted); 1356319367bdcbf5e5050632ab97973f5035d0dd8faskia.committer@gmail.com State fState; 136ef284a84f503adfd08ee52b5aee142c548698ea4commit-bot@chromium.org 137ef284a84f503adfd08ee52b5aee142c548698ea4commit-bot@chromium.org typedef SkRefCnt INHERITED; 13899ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com}; 13999ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com 14099ac02bb701c1e30b20f2174aac25ffbe487c0afreed@google.com#endif 141