Region.h revision fe4966d59b31ae6fd6dd4d81dd73d2f4f7be33fe 
1/*
2 * Copyright (C) 2007 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ANDROID_UI_REGION_H
18#define ANDROID_UI_REGION_H
19
20#include <stdint.h>
21#include <sys/types.h>
22
23#include <utils/Vector.h>
24
25#include <ui/Rect.h>
26#include <utils/Flattenable.h>
27
28namespace android {
29// ---------------------------------------------------------------------------
30
31class SharedBuffer;
32class String8;
33
34// ---------------------------------------------------------------------------
35class Region : public LightFlattenable<Region>
36{
37public:
38                        Region();
39                        Region(const Region& rhs);
40    explicit            Region(const Rect& rhs);
41                        ~Region();
42
43    static  Region      createTJunctionFreeRegion(const Region& r);
44
45        Region& operator = (const Region& rhs);
46
47    inline  bool        isEmpty() const     { return getBounds().isEmpty(); }
48    inline  bool        isRect() const      { return mStorage.size() == 1; }
49
50    inline  Rect        getBounds() const   { return mStorage[mStorage.size() - 1]; }
51    inline  Rect        bounds() const      { return getBounds(); }
52
53            bool        contains(const Point& point) const;
54            bool        contains(int x, int y) const;
55
56            // the region becomes its bounds
57            Region&     makeBoundsSelf();
58
59            void        clear();
60            void        set(const Rect& r);
61            void        set(int32_t w, int32_t h);
62            void        set(uint32_t w, uint32_t h);
63
64            Region&     orSelf(const Rect& rhs);
65            Region&     xorSelf(const Rect& rhs);
66            Region&     andSelf(const Rect& rhs);
67            Region&     subtractSelf(const Rect& rhs);
68
69            // boolean operators, applied on this
70            Region&     orSelf(const Region& rhs);
71            Region&     xorSelf(const Region& rhs);
72            Region&     andSelf(const Region& rhs);
73            Region&     subtractSelf(const Region& rhs);
74
75            // boolean operators
76    const   Region      merge(const Rect& rhs) const;
77    const   Region      mergeExclusive(const Rect& rhs) const;
78    const   Region      intersect(const Rect& rhs) const;
79    const   Region      subtract(const Rect& rhs) const;
80
81            // boolean operators
82    const   Region      merge(const Region& rhs) const;
83    const   Region      mergeExclusive(const Region& rhs) const;
84    const   Region      intersect(const Region& rhs) const;
85    const   Region      subtract(const Region& rhs) const;
86
87            // these translate rhs first
88            Region&     translateSelf(int dx, int dy);
89            Region&     orSelf(const Region& rhs, int dx, int dy);
90            Region&     xorSelf(const Region& rhs, int dx, int dy);
91            Region&     andSelf(const Region& rhs, int dx, int dy);
92            Region&     subtractSelf(const Region& rhs, int dx, int dy);
93
94            // these translate rhs first
95    const   Region      translate(int dx, int dy) const;
96    const   Region      merge(const Region& rhs, int dx, int dy) const;
97    const   Region      mergeExclusive(const Region& rhs, int dx, int dy) const;
98    const   Region      intersect(const Region& rhs, int dx, int dy) const;
99    const   Region      subtract(const Region& rhs, int dx, int dy) const;
100
101    // convenience operators overloads
102    inline  const Region      operator | (const Region& rhs) const;
103    inline  const Region      operator ^ (const Region& rhs) const;
104    inline  const Region      operator & (const Region& rhs) const;
105    inline  const Region      operator - (const Region& rhs) const;
106    inline  const Region      operator + (const Point& pt) const;
107
108    inline  Region&     operator |= (const Region& rhs);
109    inline  Region&     operator ^= (const Region& rhs);
110    inline  Region&     operator &= (const Region& rhs);
111    inline  Region&     operator -= (const Region& rhs);
112    inline  Region&     operator += (const Point& pt);
113
114
115    // returns true if the regions share the same underlying storage
116    bool isTriviallyEqual(const Region& region) const;
117
118
119    /* various ways to access the rectangle list */
120
121
122    // STL-like iterators
123    typedef Rect const* const_iterator;
124    const_iterator begin() const;
125    const_iterator end() const;
126
127    // returns an array of rect which has the same life-time has this
128    // Region object.
129    Rect const* getArray(size_t* count) const;
130
131    // returns a SharedBuffer as well as the number of rects.
132    // ownership is transfered to the caller.
133    // the caller must call SharedBuffer::release() to free the memory.
134    SharedBuffer const* getSharedBuffer(size_t* count) const;
135
136    /* no user serviceable parts here... */
137
138            // add a rectangle to the internal list. This rectangle must
139            // be sorted in Y and X and must not make the region invalid.
140            void        addRectUnchecked(int l, int t, int r, int b);
141
142    inline  bool        isFixedSize() const { return false; }
143            size_t      getFlattenedSize() const;
144            status_t    flatten(void* buffer, size_t size) const;
145            status_t    unflatten(void const* buffer, size_t size);
146
147    void        dump(String8& out, const char* what, uint32_t flags=0) const;
148    void        dump(const char* what, uint32_t flags=0) const;
149
150private:
151    class rasterizer;
152    friend class rasterizer;
153
154    Region& operationSelf(const Rect& r, int op);
155    Region& operationSelf(const Region& r, int op);
156    Region& operationSelf(const Region& r, int dx, int dy, int op);
157    const Region operation(const Rect& rhs, int op) const;
158    const Region operation(const Region& rhs, int op) const;
159    const Region operation(const Region& rhs, int dx, int dy, int op) const;
160
161    static void boolean_operation(int op, Region& dst,
162            const Region& lhs, const Region& rhs, int dx, int dy);
163    static void boolean_operation(int op, Region& dst,
164            const Region& lhs, const Rect& rhs, int dx, int dy);
165
166    static void boolean_operation(int op, Region& dst,
167            const Region& lhs, const Region& rhs);
168    static void boolean_operation(int op, Region& dst,
169            const Region& lhs, const Rect& rhs);
170
171    static void translate(Region& reg, int dx, int dy);
172    static void translate(Region& dst, const Region& reg, int dx, int dy);
173
174    static bool validate(const Region& reg,
175            const char* name, bool silent = false);
176
177    // mStorage is a (manually) sorted array of Rects describing the region
178    // with an extra Rect as the last element which is set to the
179    // bounds of the region. However, if the region is
180    // a simple Rect then mStorage contains only that rect.
181    Vector<Rect> mStorage;
182};
183
184
185const Region Region::operator | (const Region& rhs) const {
186    return merge(rhs);
187}
188const Region Region::operator ^ (const Region& rhs) const {
189    return mergeExclusive(rhs);
190}
191const Region Region::operator & (const Region& rhs) const {
192    return intersect(rhs);
193}
194const Region Region::operator - (const Region& rhs) const {
195    return subtract(rhs);
196}
197const Region Region::operator + (const Point& pt) const {
198    return translate(pt.x, pt.y);
199}
200
201
202Region& Region::operator |= (const Region& rhs) {
203    return orSelf(rhs);
204}
205Region& Region::operator ^= (const Region& rhs) {
206    return xorSelf(rhs);
207}
208Region& Region::operator &= (const Region& rhs) {
209    return andSelf(rhs);
210}
211Region& Region::operator -= (const Region& rhs) {
212    return subtractSelf(rhs);
213}
214Region& Region::operator += (const Point& pt) {
215    return translateSelf(pt.x, pt.y);
216}
217// ---------------------------------------------------------------------------
218}; // namespace android
219
220#endif // ANDROID_UI_REGION_H
221
222