Coverage Report

Created: 2018-11-16 02:38

/Users/buildslave/jenkins/workspace/clang-stage2-coverage-R/llvm/tools/clang/include/clang/AST/CharUnits.h
Line
Count
Source
1
//===--- CharUnits.h - Character units for sizes and offsets ----*- C++ -*-===//
2
//
3
//                     The LLVM Compiler Infrastructure
4
//
5
// This file is distributed under the University of Illinois Open Source
6
// License. See LICENSE.TXT for details.
7
//
8
//===----------------------------------------------------------------------===//
9
//
10
//  This file defines the CharUnits class
11
//
12
//===----------------------------------------------------------------------===//
13
14
#ifndef LLVM_CLANG_AST_CHARUNITS_H
15
#define LLVM_CLANG_AST_CHARUNITS_H
16
17
#include "llvm/ADT/DenseMapInfo.h"
18
#include "llvm/Support/DataTypes.h"
19
#include "llvm/Support/MathExtras.h"
20
21
namespace clang {
22
23
  /// CharUnits - This is an opaque type for sizes expressed in character units.
24
  /// Instances of this type represent a quantity as a multiple of the size
25
  /// of the standard C type, char, on the target architecture. As an opaque
26
  /// type, CharUnits protects you from accidentally combining operations on
27
  /// quantities in bit units and character units.
28
  ///
29
  /// In both C and C++, an object of type 'char', 'signed char', or 'unsigned
30
  /// char' occupies exactly one byte, so 'character unit' and 'byte' refer to
31
  /// the same quantity of storage. However, we use the term 'character unit'
32
  /// rather than 'byte' to avoid an implication that a character unit is
33
  /// exactly 8 bits.
34
  ///
35
  /// For portability, never assume that a target character is 8 bits wide. Use
36
  /// CharUnit values wherever you calculate sizes, offsets, or alignments
37
  /// in character units.
38
  class CharUnits {
39
    public:
40
      typedef int64_t QuantityType;
41
42
    private:
43
      QuantityType Quantity = 0;
44
45
52.5M
      explicit CharUnits(QuantityType C) : Quantity(C) {}
46
47
    public:
48
49
      /// CharUnits - A default constructor.
50
36.8M
      CharUnits() = default;
51
52
      /// Zero - Construct a CharUnits quantity of zero.
53
1.88M
      static CharUnits Zero() {
54
1.88M
        return CharUnits(0);
55
1.88M
      }
56
57
      /// One - Construct a CharUnits quantity of one.
58
1.09M
      static CharUnits One() {
59
1.09M
        return CharUnits(1);
60
1.09M
      }
61
62
      /// fromQuantity - Construct a CharUnits quantity from a raw integer type.
63
43.3M
      static CharUnits fromQuantity(QuantityType Quantity) {
64
43.3M
        return CharUnits(Quantity);
65
43.3M
      }
66
67
      // Compound assignment.
68
447k
      CharUnits& operator+= (const CharUnits &Other) {
69
447k
        Quantity += Other.Quantity;
70
447k
        return *this;
71
447k
      }
72
231
      CharUnits& operator++ () {
73
231
        ++Quantity;
74
231
        return *this;
75
231
      }
76
319
      CharUnits operator++ (int) {
77
319
        return CharUnits(Quantity++);
78
319
      }
79
1.15k
      CharUnits& operator-= (const CharUnits &Other) {
80
1.15k
        Quantity -= Other.Quantity;
81
1.15k
        return *this;
82
1.15k
      }
83
      CharUnits& operator-- () {
84
        --Quantity;
85
        return *this;
86
      }
87
      CharUnits operator-- (int) {
88
        return CharUnits(Quantity--);
89
      }
90
91
      // Comparison operators.
92
2.70M
      bool operator== (const CharUnits &Other) const {
93
2.70M
        return Quantity == Other.Quantity;
94
2.70M
      }
95
704k
      bool operator!= (const CharUnits &Other) const {
96
704k
        return Quantity != Other.Quantity;
97
704k
      }
98
99
      // Relational operators.
100
4.61M
      bool operator<  (const CharUnits &Other) const {
101
4.61M
        return Quantity <  Other.Quantity;
102
4.61M
      }
103
1.11M
      bool operator<= (const CharUnits &Other) const {
104
1.11M
        return Quantity <= Other.Quantity;
105
1.11M
      }
106
2.23M
      bool operator>  (const CharUnits &Other) const {
107
2.23M
        return Quantity >  Other.Quantity;
108
2.23M
      }
109
624k
      bool operator>= (const CharUnits &Other) const {
110
624k
        return Quantity >= Other.Quantity;
111
624k
      }
112
113
      // Other predicates.
114
115
      /// isZero - Test whether the quantity equals zero.
116
1.88M
      bool isZero() const     { return Quantity == 0; }
117
118
      /// isOne - Test whether the quantity equals one.
119
6.55k
      bool isOne() const      { return Quantity == 1; }
120
121
      /// isPositive - Test whether the quantity is greater than zero.
122
1.92k
      bool isPositive() const { return Quantity  > 0; }
123
124
      /// isNegative - Test whether the quantity is less than zero.
125
109k
      bool isNegative() const { return Quantity  < 0; }
126
127
      /// isPowerOfTwo - Test whether the quantity is a power of two.
128
      /// Zero is not a power of two.
129
411
      bool isPowerOfTwo() const {
130
411
        return (Quantity & -Quantity) == Quantity;
131
411
      }
132
133
      /// Test whether this is a multiple of the other value.
134
      ///
135
      /// Among other things, this promises that
136
      /// self.alignTo(N) will just return self.
137
12.1k
      bool isMultipleOf(CharUnits N) const {
138
12.1k
        return (*this % N) == 0;
139
12.1k
      }
140
141
      // Arithmetic operators.
142
132k
      CharUnits operator* (QuantityType N) const {
143
132k
        return CharUnits(Quantity * N);
144
132k
      }
145
4.33k
      CharUnits &operator*= (QuantityType N) {
146
4.33k
        Quantity *= N;
147
4.33k
        return *this;
148
4.33k
      }
149
238
      CharUnits operator/ (QuantityType N) const {
150
238
        return CharUnits(Quantity / N);
151
238
      }
152
60
      CharUnits &operator/= (QuantityType N) {
153
60
        Quantity /= N;
154
60
        return *this;
155
60
      }
156
1.07k
      QuantityType operator/ (const CharUnits &Other) const {
157
1.07k
        return Quantity / Other.Quantity;
158
1.07k
      }
159
112
      CharUnits operator% (QuantityType N) const {
160
112
        return CharUnits(Quantity % N);
161
112
      }
162
753k
      QuantityType operator% (const CharUnits &Other) const {
163
753k
        return Quantity % Other.Quantity;
164
753k
      }
165
3.09M
      CharUnits operator+ (const CharUnits &Other) const {
166
3.09M
        return CharUnits(Quantity + Other.Quantity);
167
3.09M
      }
168
49.9k
      CharUnits operator- (const CharUnits &Other) const {
169
49.9k
        return CharUnits(Quantity - Other.Quantity);
170
49.9k
      }
171
22.3k
      CharUnits operator- () const {
172
22.3k
        return CharUnits(-Quantity);
173
22.3k
      }
174
175
176
      // Conversions.
177
178
      /// getQuantity - Get the raw integer representation of this quantity.
179
38.7M
      QuantityType getQuantity() const { return Quantity; }
180
181
      /// alignTo - Returns the next integer (mod 2**64) that is
182
      /// greater than or equal to this quantity and is a multiple of \p Align.
183
      /// Align must be non-zero.
184
1.91M
      CharUnits alignTo(const CharUnits &Align) const {
185
1.91M
        return CharUnits(llvm::alignTo(Quantity, Align.Quantity));
186
1.91M
      }
187
188
      /// Given that this is a non-zero alignment value, what is the
189
      /// alignment at the given offset?
190
1.05M
      CharUnits alignmentAtOffset(CharUnits offset) const {
191
1.05M
        assert(Quantity != 0 && "offsetting from unknown alignment?");
192
1.05M
        return CharUnits(llvm::MinAlign(Quantity, offset.Quantity));
193
1.05M
      }
194
195
      /// Given that this is the alignment of the first element of an
196
      /// array, return the minimum alignment of any element in the array.
197
123k
      CharUnits alignmentOfArrayElement(CharUnits elementSize) const {
198
123k
        // Since we don't track offsetted alignments, the alignment of
199
123k
        // the second element (or any odd element) will be minimally
200
123k
        // aligned.
201
123k
        return alignmentAtOffset(elementSize);
202
123k
      }
203
204
205
  }; // class CharUnit
206
} // namespace clang
207
208
inline clang::CharUnits operator* (clang::CharUnits::QuantityType Scale,
209
119k
                                   const clang::CharUnits &CU) {
210
119k
  return CU * Scale;
211
119k
}
212
213
namespace llvm {
214
215
template<> struct DenseMapInfo<clang::CharUnits> {
216
344k
  static clang::CharUnits getEmptyKey() {
217
344k
    clang::CharUnits::QuantityType Quantity =
218
344k
      DenseMapInfo<clang::CharUnits::QuantityType>::getEmptyKey();
219
344k
220
344k
    return clang::CharUnits::fromQuantity(Quantity);
221
344k
  }
222
223
247k
  static clang::CharUnits getTombstoneKey() {
224
247k
    clang::CharUnits::QuantityType Quantity =
225
247k
      DenseMapInfo<clang::CharUnits::QuantityType>::getTombstoneKey();
226
247k
227
247k
    return clang::CharUnits::fromQuantity(Quantity);
228
247k
  }
229
230
259k
  static unsigned getHashValue(const clang::CharUnits &CU) {
231
259k
    clang::CharUnits::QuantityType Quantity = CU.getQuantity();
232
259k
    return DenseMapInfo<clang::CharUnits::QuantityType>::getHashValue(Quantity);
233
259k
  }
234
235
  static bool isEqual(const clang::CharUnits &LHS,
236
1.64M
                      const clang::CharUnits &RHS) {
237
1.64M
    return LHS == RHS;
238
1.64M
  }
239
};
240
241
template <> struct isPodLike<clang::CharUnits> {
242
  static const bool value = true;
243
};
244
245
} // end namespace llvm
246
247
#endif // LLVM_CLANG_AST_CHARUNITS_H