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(uint32_t w, uint32_t h);
62
63            Region&     orSelf(const Rect& rhs);
64            Region&     xorSelf(const Rect& rhs);
65            Region&     andSelf(const Rect& rhs);
66            Region&     subtractSelf(const Rect& rhs);
67
68            // boolean operators, applied on this
69            Region&     orSelf(const Region& rhs);
70            Region&     xorSelf(const Region& rhs);
71            Region&     andSelf(const Region& rhs);
72            Region&     subtractSelf(const Region& rhs);
73
74            // boolean operators
75    const   Region      merge(const Rect& rhs) const;
76    const   Region      mergeExclusive(const Rect& rhs) const;
77    const   Region      intersect(const Rect& rhs) const;
78    const   Region      subtract(const Rect& rhs) const;
79
80            // boolean operators
81    const   Region      merge(const Region& rhs) const;
82    const   Region      mergeExclusive(const Region& rhs) const;
83    const   Region      intersect(const Region& rhs) const;
84    const   Region      subtract(const Region& rhs) const;
85
86            // these translate rhs first
87            Region&     translateSelf(int dx, int dy);
88            Region&     orSelf(const Region& rhs, int dx, int dy);
89            Region&     xorSelf(const Region& rhs, int dx, int dy);
90            Region&     andSelf(const Region& rhs, int dx, int dy);
91            Region&     subtractSelf(const Region& rhs, int dx, int dy);
92
93            // these translate rhs first
94    const   Region      translate(int dx, int dy) const;
95    const   Region      merge(const Region& rhs, int dx, int dy) const;
96    const   Region      mergeExclusive(const Region& rhs, int dx, int dy) const;
97    const   Region      intersect(const Region& rhs, int dx, int dy) const;
98    const   Region      subtract(const Region& rhs, int dx, int dy) const;
99
100    // convenience operators overloads
101    inline  const Region      operator | (const Region& rhs) const;
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 Point& pt) const;
106
107    inline  Region&     operator |= (const Region& rhs);
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 Point& pt);
112
113
114    // returns true if the regions share the same underlying storage
115    bool isTriviallyEqual(const Region& region) const;
116
117
118    /* various ways to access the rectangle list */
119
120
121    // STL-like iterators
122    typedef Rect const* const_iterator;
123    const_iterator begin() const;
124    const_iterator end() const;
125
126    // returns an array of rect which has the same life-time has this
127    // Region object.
128    Rect const* getArray(size_t* count) const;
129
130    // returns a SharedBuffer as well as the number of rects.
131    // ownership is transfered to the caller.
132    // the caller must call SharedBuffer::release() to free the memory.
133    SharedBuffer const* getSharedBuffer(size_t* count) const;
134
135    /* no user serviceable parts here... */
136
137            // add a rectangle to the internal list. This rectangle must
138            // be sorted in Y and X and must not make the region invalid.
139            void        addRectUnchecked(int l, int t, int r, int b);
140
141    inline  bool        isFixedSize() const { return false; }
142            size_t      getFlattenedSize() const;
143            status_t    flatten(void* buffer, size_t size) const;
144            status_t    unflatten(void const* buffer, size_t size);
145
146    void        dump(String8& out, const char* what, uint32_t flags=0) const;
147    void        dump(const char* what, uint32_t flags=0) const;
148
149private:
150    class rasterizer;
151    friend class rasterizer;
152
153    Region& operationSelf(const Rect& r, int op);
154    Region& operationSelf(const Region& r, int op);
155    Region& operationSelf(const Region& r, int dx, int dy, int op);
156    const Region operation(const Rect& rhs, int op) const;
157    const Region operation(const Region& rhs, int op) const;
158    const Region operation(const Region& rhs, int dx, int dy, int op) const;
159
160    static void boolean_operation(int op, Region& dst,
161            const Region& lhs, const Region& rhs, int dx, int dy);
162    static void boolean_operation(int op, Region& dst,
163            const Region& lhs, const Rect& rhs, int dx, int dy);
164
165    static void boolean_operation(int op, Region& dst,
166            const Region& lhs, const Region& rhs);
167    static void boolean_operation(int op, Region& dst,
168            const Region& lhs, const Rect& rhs);
169
170    static void translate(Region& reg, int dx, int dy);
171    static void translate(Region& dst, const Region& reg, int dx, int dy);
172
173    static bool validate(const Region& reg,
174            const char* name, bool silent = false);
175
176    // mStorage is a (manually) sorted array of Rects describing the region
177    // with an extra Rect as the last element which is set to the
178    // bounds of the region. However, if the region is
179    // a simple Rect then mStorage contains only that rect.
180    Vector<Rect> mStorage;
181};
182
183
184const Region Region::operator | (const Region& rhs) const {
185    return merge(rhs);
186}
187const Region Region::operator ^ (const Region& rhs) const {
188    return mergeExclusive(rhs);
189}
190const Region Region::operator & (const Region& rhs) const {
191    return intersect(rhs);
192}
193const Region Region::operator - (const Region& rhs) const {
194    return subtract(rhs);
195}
196const Region Region::operator + (const Point& pt) const {
197    return translate(pt.x, pt.y);
198}
199
200
201Region& Region::operator |= (const Region& rhs) {
202    return orSelf(rhs);
203}
204Region& Region::operator ^= (const Region& rhs) {
205    return xorSelf(rhs);
206}
207Region& Region::operator &= (const Region& rhs) {
208    return andSelf(rhs);
209}
210Region& Region::operator -= (const Region& rhs) {
211    return subtractSelf(rhs);
212}
213Region& Region::operator += (const Point& pt) {
214    return translateSelf(pt.x, pt.y);
215}
216// ---------------------------------------------------------------------------
217}; // namespace android
218
219#endif // ANDROID_UI_REGION_H
220
221