Source/WebKit/android/jni/PictureSet.h

/*
 * Copyright 2008, The Android Open Source Project
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * 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 THE COPYRIGHT HOLDERS ``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 THE COPYRIGHT OWNER 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 PictureSet_h
#define PictureSet_h

#define PICTURE_SET_DUMP 0
#define PICTURE_SET_DEBUG 0
#define PICTURE_SET_VALIDATE 0

#if PICTURE_SET_DEBUG
#define DBG_SET_LOG(message) LOGD("%s %s", __FUNCTION__, message)
#define DBG_SET_LOGD(format, ...) LOGD("%s " format, __FUNCTION__, __VA_ARGS__)
#define DEBUG_SET_UI_LOGD(...) LOGD(__VA_ARGS__)
#else
#define DBG_SET_LOG(message) ((void)0)
#define DBG_SET_LOGD(format, ...) ((void)0)
#define DEBUG_SET_UI_LOGD(...) ((void)0)
#endif

#include "jni.h"
#include "SkRegion.h"
#include <wtf/Vector.h>
#include <wtf/HashMap.h>

// #define FAST_PICTURESET // use a hierarchy of pictures

class SkCanvas;
class SkPicture;
class SkIRect;

namespace android {

#ifdef FAST_PICTURESET
    struct BucketPicture {
        SkPicture* mPicture;
        SkIRect mArea;
        SkIRect mRealArea;
        bool mBase;
    };

    typedef std::pair<int, int> BucketPosition;
    typedef WTF::Vector<BucketPicture> Bucket;
    typedef WTF::HashMap<BucketPosition , Bucket* > BucketMap;
#endif

    class PictureSet {
    public:
        PictureSet();
        PictureSet(const PictureSet& src) { set(src); }
        PictureSet(SkPicture* picture);
        virtual ~PictureSet();

#ifdef FAST_PICTURESET
        void displayBucket(Bucket* bucket);
        void displayBuckets();
        WTF::Vector<Bucket*>* bucketsToUpdate() { return &mUpdatedBuckets; }
        Bucket* getBucket(int x, int y);
        void addToBucket(Bucket* bucket, int dx, int dy, SkIRect& rect);
        void gatherBucketsForArea(WTF::Vector<Bucket*>& list, const SkIRect& rect);
        void splitAdd(const SkIRect& rect);
#endif

        void add(const SkRegion& area, SkPicture* picture,
            uint32_t elapsed, bool split);

        // Update mWidth/mHeight, and adds any additional inval region
        void setDimensions(int width, int height, SkRegion* inval = 0);
        void clear();
        bool draw(SkCanvas* );
        static PictureSet* GetNativePictureSet(JNIEnv* env, jobject jpic);
        int height() const { return mHeight; }
        bool isEmpty() const; // returns true if empty or only trivial content
        void set(const PictureSet& );

#ifdef FAST_PICTURESET
#else
        void add(const SkRegion& area, SkPicture* picture,
            uint32_t elapsed, bool split, bool empty);
        const SkIRect& bounds(size_t i) const {
            return mPictures[i].mArea.getBounds(); }
        bool reuseSubdivided(const SkRegion& );
        void setPicture(size_t i, SkPicture* p);
        void setDrawTimes(const PictureSet& );
        size_t size() const { return mPictures.size(); }
        void split(PictureSet* result) const;
        bool upToDate(size_t i) const { return mPictures[i].mPicture != NULL; }
#endif
        int width() const { return mWidth; }
        void dump(const char* label) const;
        bool validate(const char* label) const;
    private:
        bool emptyPicture(SkPicture* ) const; // true if no text, images, paths

#ifdef FAST_PICTURESET
        BucketMap mBuckets;
        WTF::Vector<Bucket*> mUpdatedBuckets;
        int mBucketSizeX;
        int mBucketSizeY;
        int mBucketCountX;
        int mBucketCountY;
#else
        struct Pictures {
            SkRegion mArea;
            SkPicture* mPicture;
            SkIRect mUnsplit;
            uint32_t mElapsed;
            bool mSplit : 8;
            bool mWroteElapsed : 8;
            bool mBase : 8; // true if nothing is drawn underneath this
            bool mEmpty : 8; // true if the picture only draws white
        };
        void add(const Pictures* temp);
        WTF::Vector<Pictures> mPictures;
#endif
        float mBaseArea;
        float mAdditionalArea;
        int mHeight;
        int mWidth;
    };
}

#endif