epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 1 | |
| 2 | /* |
| 3 | * Copyright 2011 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 | */ |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 8 | #ifndef SkDumpCanvas_DEFINED |
| 9 | #define SkDumpCanvas_DEFINED |
| 10 | |
| 11 | #include "SkCanvas.h" |
| 12 | |
robertphillips@google.com | 76f9e93 | 2013-01-15 20:17:47 +0000 | [diff] [blame] | 13 | #ifdef SK_DEVELOPER |
| 14 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 15 | /** This class overrides all the draw methods on SkCanvas, and formats them |
| 16 | as text, and then sends that to a Dumper helper object. |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 17 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 18 | Typical use might be to dump a display list to a log file to see what is |
| 19 | being drawn. |
| 20 | */ |
| 21 | class SkDumpCanvas : public SkCanvas { |
| 22 | public: |
| 23 | class Dumper; |
| 24 | |
| 25 | explicit SkDumpCanvas(Dumper* = 0); |
| 26 | virtual ~SkDumpCanvas(); |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 27 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 28 | enum Verb { |
| 29 | kNULL_Verb, |
| 30 | |
| 31 | kSave_Verb, |
| 32 | kRestore_Verb, |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 33 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 34 | kMatrix_Verb, |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 35 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 36 | kClip_Verb, |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 37 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 38 | kDrawPaint_Verb, |
| 39 | kDrawPoints_Verb, |
reed@google.com | 4ed0fb7 | 2012-12-12 20:48:18 +0000 | [diff] [blame] | 40 | kDrawOval_Verb, |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 41 | kDrawRect_Verb, |
reed@google.com | 4ed0fb7 | 2012-12-12 20:48:18 +0000 | [diff] [blame] | 42 | kDrawRRect_Verb, |
commit-bot@chromium.org | ab58273 | 2014-02-21 12:20:45 +0000 | [diff] [blame] | 43 | kDrawDRRect_Verb, |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 44 | kDrawPath_Verb, |
| 45 | kDrawBitmap_Verb, |
| 46 | kDrawText_Verb, |
| 47 | kDrawPicture_Verb, |
reed@android.com | cb60844 | 2009-12-04 21:32:27 +0000 | [diff] [blame] | 48 | kDrawVertices_Verb, |
robertphillips@google.com | 0a4805e | 2013-05-29 13:24:23 +0000 | [diff] [blame] | 49 | kDrawData_Verb, |
| 50 | |
| 51 | kBeginCommentGroup_Verb, |
| 52 | kAddComment_Verb, |
commit-bot@chromium.org | 210ae2a | 2014-02-27 17:40:13 +0000 | [diff] [blame] | 53 | kEndCommentGroup_Verb, |
| 54 | |
| 55 | kCull_Verb |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 56 | }; |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 57 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 58 | /** Subclasses of this are installed on the DumpCanvas, and then called for |
| 59 | each drawing command. |
| 60 | */ |
| 61 | class Dumper : public SkRefCnt { |
| 62 | public: |
reed@google.com | 563a3b4 | 2012-06-26 19:24:50 +0000 | [diff] [blame] | 63 | SK_DECLARE_INST_COUNT(Dumper) |
| 64 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 65 | virtual void dump(SkDumpCanvas*, SkDumpCanvas::Verb, const char str[], |
| 66 | const SkPaint*) = 0; |
rmistry@google.com | fbfcd56 | 2012-08-23 18:09:54 +0000 | [diff] [blame] | 67 | |
reed@google.com | 563a3b4 | 2012-06-26 19:24:50 +0000 | [diff] [blame] | 68 | private: |
| 69 | typedef SkRefCnt INHERITED; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 70 | }; |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 71 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 72 | Dumper* getDumper() const { return fDumper; } |
| 73 | void setDumper(Dumper*); |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 74 | |
reed@android.com | 9b46e77 | 2009-06-05 12:24:41 +0000 | [diff] [blame] | 75 | int getNestLevel() const { return fNestLevel; } |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 76 | |
reed@google.com | 2d4297c | 2011-10-06 13:14:12 +0000 | [diff] [blame] | 77 | virtual void drawPaint(const SkPaint& paint) SK_OVERRIDE; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 78 | virtual void drawPoints(PointMode mode, size_t count, const SkPoint pts[], |
reed@google.com | 2d4297c | 2011-10-06 13:14:12 +0000 | [diff] [blame] | 79 | const SkPaint& paint) SK_OVERRIDE; |
reed@google.com | 4ed0fb7 | 2012-12-12 20:48:18 +0000 | [diff] [blame] | 80 | virtual void drawOval(const SkRect&, const SkPaint& paint) SK_OVERRIDE; |
bsalomon@google.com | 7ce564c | 2013-10-22 16:54:15 +0000 | [diff] [blame] | 81 | virtual void drawRect(const SkRect&, const SkPaint& paint) SK_OVERRIDE; |
reed@google.com | 4ed0fb7 | 2012-12-12 20:48:18 +0000 | [diff] [blame] | 82 | virtual void drawRRect(const SkRRect&, const SkPaint& paint) SK_OVERRIDE; |
bsalomon@google.com | 7ce564c | 2013-10-22 16:54:15 +0000 | [diff] [blame] | 83 | virtual void drawPath(const SkPath& path, const SkPaint& paint) SK_OVERRIDE; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 84 | virtual void drawBitmap(const SkBitmap& bitmap, SkScalar left, SkScalar top, |
reed@google.com | 43d7484 | 2011-12-07 14:46:39 +0000 | [diff] [blame] | 85 | const SkPaint* paint) SK_OVERRIDE; |
reed@google.com | 7112173 | 2012-09-18 15:14:33 +0000 | [diff] [blame] | 86 | virtual void drawBitmapRectToRect(const SkBitmap& bitmap, const SkRect* src, |
commit-bot@chromium.org | eed779d | 2013-08-16 10:24:37 +0000 | [diff] [blame] | 87 | const SkRect& dst, const SkPaint* paint, |
| 88 | DrawBitmapRectFlags flags) SK_OVERRIDE; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 89 | virtual void drawBitmapMatrix(const SkBitmap& bitmap, const SkMatrix& m, |
reed@google.com | 43d7484 | 2011-12-07 14:46:39 +0000 | [diff] [blame] | 90 | const SkPaint* paint) SK_OVERRIDE; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 91 | virtual void drawSprite(const SkBitmap& bitmap, int left, int top, |
reed@google.com | 43d7484 | 2011-12-07 14:46:39 +0000 | [diff] [blame] | 92 | const SkPaint* paint) SK_OVERRIDE; |
reed@google.com | 2d4297c | 2011-10-06 13:14:12 +0000 | [diff] [blame] | 93 | virtual void drawPicture(SkPicture&) SK_OVERRIDE; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 94 | virtual void drawVertices(VertexMode vmode, int vertexCount, |
| 95 | const SkPoint vertices[], const SkPoint texs[], |
| 96 | const SkColor colors[], SkXfermode* xmode, |
| 97 | const uint16_t indices[], int indexCount, |
reed@google.com | 2d4297c | 2011-10-06 13:14:12 +0000 | [diff] [blame] | 98 | const SkPaint& paint) SK_OVERRIDE; |
| 99 | virtual void drawData(const void*, size_t) SK_OVERRIDE; |
robertphillips@google.com | 0a4805e | 2013-05-29 13:24:23 +0000 | [diff] [blame] | 100 | virtual void beginCommentGroup(const char* description) SK_OVERRIDE; |
| 101 | virtual void addComment(const char* kywd, const char* value) SK_OVERRIDE; |
| 102 | virtual void endCommentGroup() SK_OVERRIDE; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 103 | |
commit-bot@chromium.org | ab58273 | 2014-02-21 12:20:45 +0000 | [diff] [blame] | 104 | protected: |
commit-bot@chromium.org | e54a23f | 2014-03-12 20:21:48 +0000 | [diff] [blame] | 105 | virtual void willSave(SaveFlags) SK_OVERRIDE; |
| 106 | virtual SaveLayerStrategy willSaveLayer(const SkRect*, const SkPaint*, SaveFlags) SK_OVERRIDE; |
| 107 | virtual void willRestore() SK_OVERRIDE; |
| 108 | |
commit-bot@chromium.org | 44c48d0 | 2014-03-13 20:03:58 +0000 | [diff] [blame] | 109 | virtual void didConcat(const SkMatrix&) SK_OVERRIDE; |
| 110 | virtual void didSetMatrix(const SkMatrix&) SK_OVERRIDE; |
| 111 | |
commit-bot@chromium.org | ab58273 | 2014-02-21 12:20:45 +0000 | [diff] [blame] | 112 | virtual void onDrawDRRect(const SkRRect&, const SkRRect&, const SkPaint&) SK_OVERRIDE; |
reed@google.com | e0d9ce8 | 2014-04-23 04:00:17 +0000 | [diff] [blame^] | 113 | virtual void onDrawText(const void* text, size_t byteLength, SkScalar x, SkScalar y, |
| 114 | const SkPaint&) SK_OVERRIDE; |
| 115 | virtual void onDrawPosText(const void* text, size_t byteLength, const SkPoint pos[], |
| 116 | const SkPaint&) SK_OVERRIDE; |
| 117 | virtual void onDrawPosTextH(const void* text, size_t byteLength, const SkScalar xpos[], |
| 118 | SkScalar constY, const SkPaint&) SK_OVERRIDE; |
| 119 | virtual void onDrawTextOnPath(const void* text, size_t byteLength, const SkPath& path, |
| 120 | const SkMatrix* matrix, const SkPaint&) SK_OVERRIDE; |
commit-bot@chromium.org | 210ae2a | 2014-02-27 17:40:13 +0000 | [diff] [blame] | 121 | virtual void onPushCull(const SkRect& cullRect) SK_OVERRIDE; |
| 122 | virtual void onPopCull() SK_OVERRIDE; |
commit-bot@chromium.org | ab58273 | 2014-02-21 12:20:45 +0000 | [diff] [blame] | 123 | |
robertphillips@google.com | 8f90a89 | 2014-02-28 18:19:39 +0000 | [diff] [blame] | 124 | virtual void onClipRect(const SkRect&, SkRegion::Op, ClipEdgeStyle) SK_OVERRIDE; |
| 125 | virtual void onClipRRect(const SkRRect&, SkRegion::Op, ClipEdgeStyle) SK_OVERRIDE; |
| 126 | virtual void onClipPath(const SkPath&, SkRegion::Op, ClipEdgeStyle) SK_OVERRIDE; |
| 127 | virtual void onClipRegion(const SkRegion&, SkRegion::Op) SK_OVERRIDE; |
| 128 | |
| 129 | static const char* EdgeStyleToAAString(ClipEdgeStyle edgeStyle); |
| 130 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 131 | private: |
| 132 | Dumper* fDumper; |
reed@android.com | 9b46e77 | 2009-06-05 12:24:41 +0000 | [diff] [blame] | 133 | int fNestLevel; // for nesting recursive elements like pictures |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 134 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 135 | void dump(Verb, const SkPaint*, const char format[], ...); |
| 136 | |
| 137 | typedef SkCanvas INHERITED; |
| 138 | }; |
| 139 | |
| 140 | /** Formats the draw commands, and send them to a function-pointer provided |
| 141 | by the caller. |
| 142 | */ |
| 143 | class SkFormatDumper : public SkDumpCanvas::Dumper { |
| 144 | public: |
| 145 | SkFormatDumper(void (*)(const char text[], void* refcon), void* refcon); |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 146 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 147 | // override from baseclass that does the formatting, and in turn calls |
| 148 | // the function pointer that was passed to the constructor |
| 149 | virtual void dump(SkDumpCanvas*, SkDumpCanvas::Verb, const char str[], |
reed@google.com | 2d4297c | 2011-10-06 13:14:12 +0000 | [diff] [blame] | 150 | const SkPaint*) SK_OVERRIDE; |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 151 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 152 | private: |
| 153 | void (*fProc)(const char*, void*); |
| 154 | void* fRefcon; |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 155 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 156 | typedef SkDumpCanvas::Dumper INHERITED; |
| 157 | }; |
| 158 | |
| 159 | /** Subclass of Dumper that dumps the drawing command to SkDebugf |
| 160 | */ |
| 161 | class SkDebugfDumper : public SkFormatDumper { |
| 162 | public: |
| 163 | SkDebugfDumper(); |
| 164 | |
| 165 | private: |
| 166 | typedef SkFormatDumper INHERITED; |
| 167 | }; |
| 168 | |
| 169 | #endif |
robertphillips@google.com | 76f9e93 | 2013-01-15 20:17:47 +0000 | [diff] [blame] | 170 | |
| 171 | #endif |