blob: c6b20ebca953172cb7b6418d5e16b9f183cde733 [file] [log] [blame]
/*
* Copyright 2011 Google Inc.
*
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#ifndef SkDumpCanvas_DEFINED
#define SkDumpCanvas_DEFINED
#include "SkCanvas.h"
#ifdef SK_DEVELOPER
/** This class overrides all the draw methods on SkCanvas, and formats them
as text, and then sends that to a Dumper helper object.
Typical use might be to dump a display list to a log file to see what is
being drawn.
*/
class SkDumpCanvas : public SkCanvas {
public:
class Dumper;
explicit SkDumpCanvas(Dumper* = 0);
virtual ~SkDumpCanvas();
enum Verb {
kNULL_Verb,
kSave_Verb,
kRestore_Verb,
kMatrix_Verb,
kClip_Verb,
kDrawPaint_Verb,
kDrawPoints_Verb,
kDrawOval_Verb,
kDrawRect_Verb,
kDrawRRect_Verb,
kDrawDRRect_Verb,
kDrawPath_Verb,
kDrawBitmap_Verb,
kDrawText_Verb,
kDrawPicture_Verb,
kDrawVertices_Verb,
kDrawPatch_Verb,
kDrawData_Verb, // obsolete
kBeginCommentGroup_Verb,
kAddComment_Verb,
kEndCommentGroup_Verb,
kCull_Verb
};
/** Subclasses of this are installed on the DumpCanvas, and then called for
each drawing command.
*/
class Dumper : public SkRefCnt {
public:
SK_DECLARE_INST_COUNT(Dumper)
virtual void dump(SkDumpCanvas*, SkDumpCanvas::Verb, const char str[],
const SkPaint*) = 0;
private:
typedef SkRefCnt INHERITED;
};
Dumper* getDumper() const { return fDumper; }
void setDumper(Dumper*);
int getNestLevel() const { return fNestLevel; }
void beginCommentGroup(const char* description) SK_OVERRIDE;
void addComment(const char* kywd, const char* value) SK_OVERRIDE;
void endCommentGroup() SK_OVERRIDE;
protected:
void willSave() SK_OVERRIDE;
SaveLayerStrategy willSaveLayer(const SkRect*, const SkPaint*, SaveFlags) SK_OVERRIDE;
void willRestore() SK_OVERRIDE;
void didConcat(const SkMatrix&) SK_OVERRIDE;
void didSetMatrix(const SkMatrix&) SK_OVERRIDE;
void onDrawDRRect(const SkRRect&, const SkRRect&, const SkPaint&) SK_OVERRIDE;
virtual void onDrawText(const void* text, size_t byteLength, SkScalar x, SkScalar y,
const SkPaint&) SK_OVERRIDE;
virtual void onDrawPosText(const void* text, size_t byteLength, const SkPoint pos[],
const SkPaint&) SK_OVERRIDE;
virtual void onDrawPosTextH(const void* text, size_t byteLength, const SkScalar xpos[],
SkScalar constY, const SkPaint&) SK_OVERRIDE;
virtual void onDrawTextOnPath(const void* text, size_t byteLength, const SkPath& path,
const SkMatrix* matrix, const SkPaint&) SK_OVERRIDE;
virtual void onDrawTextBlob(const SkTextBlob* blob, SkScalar x, SkScalar y,
const SkPaint& paint) SK_OVERRIDE;
virtual void onDrawPatch(const SkPoint cubics[12], const SkColor colors[4],
const SkPoint texCoords[4], SkXfermode* xmode,
const SkPaint& paint) SK_OVERRIDE;
void onDrawPaint(const SkPaint&) SK_OVERRIDE;
void onDrawPoints(PointMode, size_t count, const SkPoint pts[], const SkPaint&) SK_OVERRIDE;
void onDrawRect(const SkRect&, const SkPaint&) SK_OVERRIDE;
void onDrawOval(const SkRect&, const SkPaint&) SK_OVERRIDE;
void onDrawRRect(const SkRRect&, const SkPaint&) SK_OVERRIDE;
void onDrawPath(const SkPath&, const SkPaint&) SK_OVERRIDE;
void onDrawBitmap(const SkBitmap&, SkScalar left, SkScalar top, const SkPaint*) SK_OVERRIDE;
void onDrawBitmapRect(const SkBitmap&, const SkRect* src, const SkRect& dst, const SkPaint*,
DrawBitmapRectFlags flags) SK_OVERRIDE;
void onDrawImage(const SkImage*, SkScalar left, SkScalar top, const SkPaint*) SK_OVERRIDE;
void onDrawImageRect(const SkImage*, const SkRect* src, const SkRect& dst,
const SkPaint*) SK_OVERRIDE;
void onDrawBitmapNine(const SkBitmap&, const SkIRect& center, const SkRect& dst,
const SkPaint*) SK_OVERRIDE;
void onDrawSprite(const SkBitmap&, int left, int top, const SkPaint*) SK_OVERRIDE;
void onDrawVertices(VertexMode vmode, int vertexCount,
const SkPoint vertices[], const SkPoint texs[],
const SkColor colors[], SkXfermode* xmode,
const uint16_t indices[], int indexCount,
const SkPaint&) SK_OVERRIDE;
void onClipRect(const SkRect&, SkRegion::Op, ClipEdgeStyle) SK_OVERRIDE;
void onClipRRect(const SkRRect&, SkRegion::Op, ClipEdgeStyle) SK_OVERRIDE;
void onClipPath(const SkPath&, SkRegion::Op, ClipEdgeStyle) SK_OVERRIDE;
void onClipRegion(const SkRegion&, SkRegion::Op) SK_OVERRIDE;
void onDrawPicture(const SkPicture*, const SkMatrix*, const SkPaint*) SK_OVERRIDE;
static const char* EdgeStyleToAAString(ClipEdgeStyle edgeStyle);
private:
Dumper* fDumper;
int fNestLevel; // for nesting recursive elements like pictures
void dump(Verb, const SkPaint*, const char format[], ...);
typedef SkCanvas INHERITED;
};
/** Formats the draw commands, and send them to a function-pointer provided
by the caller.
*/
class SkFormatDumper : public SkDumpCanvas::Dumper {
public:
SkFormatDumper(void (*)(const char text[], void* refcon), void* refcon);
// override from baseclass that does the formatting, and in turn calls
// the function pointer that was passed to the constructor
virtual void dump(SkDumpCanvas*, SkDumpCanvas::Verb, const char str[],
const SkPaint*) SK_OVERRIDE;
private:
void (*fProc)(const char*, void*);
void* fRefcon;
typedef SkDumpCanvas::Dumper INHERITED;
};
/** Subclass of Dumper that dumps the drawing command to SkDebugf
*/
class SkDebugfDumper : public SkFormatDumper {
public:
SkDebugfDumper();
private:
typedef SkFormatDumper INHERITED;
};
#endif
#endif