File: Size.h

package info (click to toggle)
android-platform-tools 35.0.2-1~exp6
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 211,716 kB
  • sloc: cpp: 995,749; java: 290,495; ansic: 145,647; xml: 58,531; python: 39,608; sh: 14,500; javascript: 5,198; asm: 4,866; makefile: 3,115; yacc: 769; awk: 368; ruby: 183; sql: 140; perl: 88; lex: 67
file content (192 lines) | stat: -rw-r--r-- 6,712 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
/*
 * Copyright 2019 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include <algorithm>
#include <cstdint>
#include <limits>
#include <ostream>
#include <type_traits>
#include <utility>

#include <ui/Rotation.h>

namespace android::ui {

// A simple value type representing a two-dimensional size.
struct Size {
    int32_t width = -1;
    int32_t height = -1;

    constexpr Size() = default;

    template <typename T>
    constexpr Size(T w, T h) : width(clamp<int32_t>(w)), height(clamp<int32_t>(h)) {}

    int32_t getWidth() const { return width; }
    int32_t getHeight() const { return height; }

    // Valid means non-negative width and height
    bool isValid() const { return width >= 0 && height >= 0; }

    // Empty means zero width and height
    bool isEmpty() const;

    template <typename T>
    void setWidth(T v) {
        width = clamp<int32_t>(v);
    }

    template <typename T>
    void setHeight(T v) {
        height = clamp<int32_t>(v);
    }

    void set(Size size) { *this = size; }

    template <typename T>
    void set(T w, T h) {
        set(Size(w, h));
    }

    // Applies a rotation onto the size
    void rotate(Rotation rotation) {
        if (rotation == ROTATION_90 || rotation == ROTATION_270) {
            transpose();
        }
    }

    // Swaps the width and height, emulating a 90 degree rotation.
    void transpose() { std::swap(width, height); }

    // Sets the value to kInvalidSize
    void makeInvalid();

    // Sets the value to kEmptySize
    void clear();

    // TODO: Replace with std::remove_cvref_t in C++20.
    template <typename T>
    using remove_cvref_t = std::remove_cv_t<std::remove_reference_t<T>>;

    // Takes a value of type FromType, and ensures it can be represented as a value of type ToType,
    // clamping the input value to the output range if necessary.
    template <typename ToType, typename FromType>
    static constexpr remove_cvref_t<ToType> clamp(FromType v) {
        using BareToType = remove_cvref_t<ToType>;
        using ToLimits = std::numeric_limits<BareToType>;

        using BareFromType = remove_cvref_t<FromType>;
        using FromLimits = std::numeric_limits<BareFromType>;

        static_assert(ToLimits::is_specialized && FromLimits::is_specialized);

        constexpr auto toHighest = ToLimits::max();
        constexpr auto toLowest = ToLimits::lowest();
        constexpr auto fromHighest = FromLimits::max();
        constexpr auto fromLowest = FromLimits::lowest();

        // Get the closest representation of [toLowest, toHighest] in type
        // FromType to use to clamp the input value before conversion.

        // std::common_type<...> is used to get a value-preserving type for the
        // top end of the range.
        using CommonHighestType = std::common_type_t<BareToType, BareFromType>;
        using CommonLimits = std::numeric_limits<CommonHighestType>;

        // std::make_signed<std::common_type<...>> is used to get a
        // value-preserving type for the bottom end of the range, except this is
        // a bit trickier for non-integer types like float.
        using CommonLowestType = std::conditional_t<
                CommonLimits::is_integer,
                std::make_signed_t<std::conditional_t<CommonLimits::is_integer, CommonHighestType,
                                                      int /* not used */>>,
                CommonHighestType>;

        // We can then compute the clamp range in a way that can be later
        // trivially converted to either the 'from' or 'to' types, and be
        // representable in either.
        constexpr auto commonClampHighest = std::min(static_cast<CommonHighestType>(fromHighest),
                                                     static_cast<CommonHighestType>(toHighest));
        constexpr auto commonClampLowest = std::max(static_cast<CommonLowestType>(fromLowest),
                                                    static_cast<CommonLowestType>(toLowest));

        constexpr auto fromClampHighest = static_cast<BareFromType>(commonClampHighest);
        constexpr auto fromClampLowest = static_cast<BareFromType>(commonClampLowest);

        // A clamp is needed only if the range we are clamping to is not the
        // same as the range of the input.
        constexpr bool isClampNeeded =
                (fromLowest != fromClampLowest) || (fromHighest != fromClampHighest);

        // If a clamp is not needed, the conversion is just a trivial cast.
        if constexpr (!isClampNeeded) {
            return static_cast<BareToType>(v);
        }

        // Note: Clang complains about the value of INT32_MAX not being
        // convertible back to int32_t from float if this is made "constexpr",
        // when clamping a float value to an int32_t value. This is however
        // covered by a test case to ensure the run-time cast works correctly.
        const auto toClampHighest = static_cast<BareToType>(commonClampHighest);
        const auto toClampLowest = static_cast<BareToType>(commonClampLowest);

        // Otherwise clamping is done by using the already computed endpoints
        // for each type.
        if (v <= fromClampLowest) {
            return toClampLowest;
        }

        return v >= fromClampHighest ? toClampHighest : static_cast<BareToType>(v);
    }
};

constexpr Size kInvalidSize;
constexpr Size kEmptySize{0, 0};

inline void Size::makeInvalid() {
    set(kInvalidSize);
}

inline void Size::clear() {
    set(kEmptySize);
}

inline bool operator==(Size lhs, Size rhs) {
    return lhs.width == rhs.width && lhs.height == rhs.height;
}

inline bool Size::isEmpty() const {
    return *this == kEmptySize;
}

inline bool operator!=(Size lhs, Size rhs) {
    return !(lhs == rhs);
}

inline bool operator<(Size lhs, Size rhs) {
    // Orders by increasing width, then height.
    if (lhs.width != rhs.width) return lhs.width < rhs.width;
    return lhs.height < rhs.height;
}

// Defining PrintTo helps with Google Tests.
inline void PrintTo(Size size, std::ostream* stream) {
    *stream << "Size(" << size.width << ", " << size.height << ')';
}

} // namespace android::ui