Coverage Report

Created: 2022-05-14 11:35

/Users/buildslave/jenkins/workspace/coverage/llvm-project/clang/include/clang/Basic/CharInfo.h
Line
Count
Source (jump to first uncovered line)
1
//===--- clang/Basic/CharInfo.h - Classifying ASCII Characters --*- C++ -*-===//
2
//
3
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4
// See https://llvm.org/LICENSE.txt for license information.
5
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6
//
7
//===----------------------------------------------------------------------===//
8
9
#ifndef LLVM_CLANG_BASIC_CHARINFO_H
10
#define LLVM_CLANG_BASIC_CHARINFO_H
11
12
#include "clang/Basic/LLVM.h"
13
#include "llvm/ADT/StringRef.h"
14
#include "llvm/Support/Compiler.h"
15
#include "llvm/Support/DataTypes.h"
16
17
namespace clang {
18
namespace charinfo {
19
  extern const uint16_t InfoTable[256];
20
21
  enum {
22
    CHAR_HORZ_WS  = 0x0001,  // '\t', '\f', '\v'.  Note, no '\0'
23
    CHAR_VERT_WS  = 0x0002,  // '\r', '\n'
24
    CHAR_SPACE    = 0x0004,  // ' '
25
    CHAR_DIGIT    = 0x0008,  // 0-9
26
    CHAR_XLETTER  = 0x0010,  // a-f,A-F
27
    CHAR_UPPER    = 0x0020,  // A-Z
28
    CHAR_LOWER    = 0x0040,  // a-z
29
    CHAR_UNDER    = 0x0080,  // _
30
    CHAR_PERIOD   = 0x0100,  // .
31
    CHAR_RAWDEL   = 0x0200,  // {}[]#<>%:;?*+-/^&|~!=,"'
32
    CHAR_PUNCT    = 0x0400   // `$@()
33
  };
34
35
  enum {
36
    CHAR_XUPPER = CHAR_XLETTER | CHAR_UPPER,
37
    CHAR_XLOWER = CHAR_XLETTER | CHAR_LOWER
38
  };
39
} // end namespace charinfo
40
41
/// Returns true if a byte is an ASCII character.
42
70.8M
LLVM_READNONE inline bool isASCII(char c) {
43
70.8M
  return static_cast<unsigned char>(c) <= 127;
44
70.8M
}
45
46
675M
LLVM_READNONE inline bool isASCII(unsigned char c) { return c <= 127; }
47
48
/// Returns true if a codepoint is an ASCII character.
49
241
LLVM_READNONE inline bool isASCII(uint32_t c) { return c <= 127; }
50
1.00k
LLVM_READNONE inline bool isASCII(int64_t c) { return 0 <= c && c <= 127; }
51
52
/// Returns true if this is a valid first character of a C identifier,
53
/// which is [a-zA-Z_].
54
LLVM_READONLY inline bool isAsciiIdentifierStart(unsigned char c,
55
8.60M
                                                 bool AllowDollar = false) {
56
8.60M
  using namespace charinfo;
57
8.60M
  if (InfoTable[c] & (CHAR_UPPER|CHAR_LOWER|CHAR_UNDER))
58
443k
    return true;
59
8.15M
  return AllowDollar && 
c == '$'5
;
60
8.60M
}
61
62
/// Returns true if this is a body character of a C identifier,
63
/// which is [a-zA-Z0-9_].
64
LLVM_READONLY inline bool isAsciiIdentifierContinue(unsigned char c,
65
8.15G
                                                    bool AllowDollar = false) {
66
8.15G
  using namespace charinfo;
67
8.15G
  if (InfoTable[c] & (CHAR_UPPER|CHAR_LOWER|CHAR_DIGIT|CHAR_UNDER))
68
6.80G
    return true;
69
1.35G
  return AllowDollar && 
c == '$'4.01k
;
70
8.15G
}
71
72
/// Returns true if this character is horizontal ASCII whitespace:
73
/// ' ', '\\t', '\\f', '\\v'.
74
///
75
/// Note that this returns false for '\\0'.
76
3.08G
LLVM_READONLY inline bool isHorizontalWhitespace(unsigned char c) {
77
3.08G
  using namespace charinfo;
78
3.08G
  return (InfoTable[c] & (CHAR_HORZ_WS|CHAR_SPACE)) != 0;
79
3.08G
}
80
81
/// Returns true if this character is vertical ASCII whitespace: '\\n', '\\r'.
82
///
83
/// Note that this returns false for '\\0'.
84
2.36G
LLVM_READONLY inline bool isVerticalWhitespace(unsigned char c) {
85
2.36G
  using namespace charinfo;
86
2.36G
  return (InfoTable[c] & CHAR_VERT_WS) != 0;
87
2.36G
}
88
89
/// Return true if this character is horizontal or vertical ASCII whitespace:
90
/// ' ', '\\t', '\\f', '\\v', '\\n', '\\r'.
91
///
92
/// Note that this returns false for '\\0'.
93
63.7M
LLVM_READONLY inline bool isWhitespace(unsigned char c) {
94
63.7M
  using namespace charinfo;
95
63.7M
  return (InfoTable[c] & (CHAR_HORZ_WS|CHAR_VERT_WS|CHAR_SPACE)) != 0;
96
63.7M
}
97
98
/// Return true if this character is an ASCII digit: [0-9]
99
40.6M
LLVM_READONLY inline bool isDigit(unsigned char c) {
100
40.6M
  using namespace charinfo;
101
40.6M
  return (InfoTable[c] & CHAR_DIGIT) != 0;
102
40.6M
}
103
104
/// Return true if this character is a lowercase ASCII letter: [a-z]
105
460k
LLVM_READONLY inline bool isLowercase(unsigned char c) {
106
460k
  using namespace charinfo;
107
460k
  return (InfoTable[c] & CHAR_LOWER) != 0;
108
460k
}
109
110
/// Return true if this character is an uppercase ASCII letter: [A-Z]
111
1.06k
LLVM_READONLY inline bool isUppercase(unsigned char c) {
112
1.06k
  using namespace charinfo;
113
1.06k
  return (InfoTable[c] & CHAR_UPPER) != 0;
114
1.06k
}
115
116
/// Return true if this character is an ASCII letter: [a-zA-Z]
117
3.18M
LLVM_READONLY inline bool isLetter(unsigned char c) {
118
3.18M
  using namespace charinfo;
119
3.18M
  return (InfoTable[c] & (CHAR_UPPER|CHAR_LOWER)) != 0;
120
3.18M
}
121
122
/// Return true if this character is an ASCII letter or digit: [a-zA-Z0-9]
123
5.46M
LLVM_READONLY inline bool isAlphanumeric(unsigned char c) {
124
5.46M
  using namespace charinfo;
125
5.46M
  return (InfoTable[c] & (CHAR_DIGIT|CHAR_UPPER|CHAR_LOWER)) != 0;
126
5.46M
}
127
128
/// Return true if this character is an ASCII hex digit: [0-9a-fA-F]
129
5.57M
LLVM_READONLY inline bool isHexDigit(unsigned char c) {
130
5.57M
  using namespace charinfo;
131
5.57M
  return (InfoTable[c] & (CHAR_DIGIT|CHAR_XLETTER)) != 0;
132
5.57M
}
133
134
/// Return true if this character is an ASCII punctuation character.
135
///
136
/// Note that '_' is both a punctuation character and an identifier character!
137
632k
LLVM_READONLY inline bool isPunctuation(unsigned char c) {
138
632k
  using namespace charinfo;
139
632k
  return (InfoTable[c] & (CHAR_UNDER|CHAR_PERIOD|CHAR_RAWDEL|CHAR_PUNCT)) != 0;
140
632k
}
141
142
/// Return true if this character is an ASCII printable character; that is, a
143
/// character that should take exactly one column to print in a fixed-width
144
/// terminal.
145
43.1k
LLVM_READONLY inline bool isPrintable(unsigned char c) {
146
43.1k
  using namespace charinfo;
147
43.1k
  return (InfoTable[c] & (CHAR_UPPER|CHAR_LOWER|CHAR_PERIOD|CHAR_PUNCT|
148
43.1k
                          CHAR_DIGIT|CHAR_UNDER|CHAR_RAWDEL|CHAR_SPACE)) != 0;
149
43.1k
}
150
151
/// Return true if this is the body character of a C preprocessing number,
152
/// which is [a-zA-Z0-9_.].
153
217M
LLVM_READONLY inline bool isPreprocessingNumberBody(unsigned char c) {
154
217M
  using namespace charinfo;
155
217M
  return (InfoTable[c] &
156
217M
          (CHAR_UPPER|CHAR_LOWER|CHAR_DIGIT|CHAR_UNDER|CHAR_PERIOD)) != 0;
157
217M
}
158
159
/// Return true if this is the body character of a C++ raw string delimiter.
160
1.81k
LLVM_READONLY inline bool isRawStringDelimBody(unsigned char c) {
161
1.81k
  using namespace charinfo;
162
1.81k
  return (InfoTable[c] & (CHAR_UPPER|CHAR_LOWER|CHAR_PERIOD|
163
1.81k
                          CHAR_DIGIT|CHAR_UNDER|CHAR_RAWDEL)) != 0;
164
1.81k
}
165
166
enum class EscapeChar {
167
  Single = 1,
168
  Double = 2,
169
  SingleAndDouble = static_cast<int>(Single) | static_cast<int>(Double),
170
};
171
172
/// Return C-style escaped string for special characters, or an empty string if
173
/// there is no such mapping.
174
template <EscapeChar Opt, class CharT>
175
43.4k
LLVM_READONLY inline auto escapeCStyle(CharT Ch) -> StringRef {
176
43.4k
  switch (Ch) {
177
59
  case '\\':
178
59
    return "\\\\";
179
33
  case '\'':
180
33
    if ((static_cast<int>(Opt) & static_cast<int>(EscapeChar::Single)) == 0)
181
7
      break;
182
26
    return "\\'";
183
38
  case '"':
184
38
    if ((static_cast<int>(Opt) & static_cast<int>(EscapeChar::Double)) == 0)
185
9
      break;
186
29
    return "\\\"";
187
32
  case '\a':
188
32
    return "\\a";
189
32
  case '\b':
190
32
    return "\\b";
191
16
  case '\f':
192
16
    return "\\f";
193
24
  case '\n':
194
24
    return "\\n";
195
22
  case '\r':
196
22
    return "\\r";
197
32
  case '\t':
198
32
    return "\\t";
199
16
  case '\v':
200
16
    return "\\v";
201
43.4k
  }
202
43.1k
  return {};
203
43.4k
}
llvm::StringRef clang::escapeCStyle<(clang::EscapeChar)3, unsigned char>(unsigned char)
Line
Count
Source
175
998
LLVM_READONLY inline auto escapeCStyle(CharT Ch) -> StringRef {
176
998
  switch (Ch) {
177
7
  case '\\':
178
7
    return "\\\\";
179
5
  case '\'':
180
5
    if ((static_cast<int>(Opt) & static_cast<int>(EscapeChar::Single)) == 0)
181
0
      break;
182
5
    return "\\'";
183
5
  case '"':
184
5
    if ((static_cast<int>(Opt) & static_cast<int>(EscapeChar::Double)) == 0)
185
0
      break;
186
5
    return "\\\"";
187
2
  case '\a':
188
2
    return "\\a";
189
2
  case '\b':
190
2
    return "\\b";
191
2
  case '\f':
192
2
    return "\\f";
193
5
  case '\n':
194
5
    return "\\n";
195
5
  case '\r':
196
5
    return "\\r";
197
2
  case '\t':
198
2
    return "\\t";
199
2
  case '\v':
200
2
    return "\\v";
201
998
  }
202
961
  return {};
203
998
}
llvm::StringRef clang::escapeCStyle<(clang::EscapeChar)1, unsigned int>(unsigned int)
Line
Count
Source
175
653
LLVM_READONLY inline auto escapeCStyle(CharT Ch) -> StringRef {
176
653
  switch (Ch) {
177
19
  case '\\':
178
19
    return "\\\\";
179
21
  case '\'':
180
21
    if ((static_cast<int>(Opt) & static_cast<int>(EscapeChar::Single)) == 0)
181
0
      break;
182
21
    return "\\'";
183
9
  case '"':
184
9
    if ((static_cast<int>(Opt) & static_cast<int>(EscapeChar::Double)) == 0)
185
9
      break;
186
0
    return "\\\"";
187
10
  case '\a':
188
10
    return "\\a";
189
10
  case '\b':
190
10
    return "\\b";
191
10
  case '\f':
192
10
    return "\\f";
193
10
  case '\n':
194
10
    return "\\n";
195
10
  case '\r':
196
10
    return "\\r";
197
10
  case '\t':
198
10
    return "\\t";
199
10
  case '\v':
200
10
    return "\\v";
201
653
  }
202
543
  return {};
203
653
}
llvm::StringRef clang::escapeCStyle<(clang::EscapeChar)2, unsigned int>(unsigned int)
Line
Count
Source
175
41.8k
LLVM_READONLY inline auto escapeCStyle(CharT Ch) -> StringRef {
176
41.8k
  switch (Ch) {
177
33
  case '\\':
178
33
    return "\\\\";
179
7
  case '\'':
180
7
    if ((static_cast<int>(Opt) & static_cast<int>(EscapeChar::Single)) == 0)
181
7
      break;
182
0
    return "\\'";
183
24
  case '"':
184
24
    if ((static_cast<int>(Opt) & static_cast<int>(EscapeChar::Double)) == 0)
185
0
      break;
186
24
    return "\\\"";
187
20
  case '\a':
188
20
    return "\\a";
189
20
  case '\b':
190
20
    return "\\b";
191
4
  case '\f':
192
4
    return "\\f";
193
9
  case '\n':
194
9
    return "\\n";
195
7
  case '\r':
196
7
    return "\\r";
197
20
  case '\t':
198
20
    return "\\t";
199
4
  case '\v':
200
4
    return "\\v";
201
41.8k
  }
202
41.6k
  return {};
203
41.8k
}
204
205
/// Converts the given ASCII character to its lowercase equivalent.
206
///
207
/// If the character is not an uppercase character, it is returned as is.
208
892
LLVM_READONLY inline char toLowercase(char c) {
209
892
  if (isUppercase(c))
210
247
    return c + 'a' - 'A';
211
645
  return c;
212
892
}
213
214
/// Converts the given ASCII character to its uppercase equivalent.
215
///
216
/// If the character is not a lowercase character, it is returned as is.
217
363k
LLVM_READONLY inline char toUppercase(char c) {
218
363k
  if (isLowercase(c))
219
349k
    return c + 'A' - 'a';
220
14.3k
  return c;
221
363k
}
222
223
224
/// Return true if this is a valid ASCII identifier.
225
///
226
/// Note that this is a very simple check; it does not accept UCNs as valid
227
/// identifier characters.
228
LLVM_READONLY inline bool isValidAsciiIdentifier(StringRef S,
229
24.4k
                                                 bool AllowDollar = false) {
230
24.4k
  if (S.empty() || 
!isAsciiIdentifierStart(S[0], AllowDollar)24.4k
)
231
22
    return false;
232
233
400k
  
for (StringRef::iterator I = S.begin(), E = S.end(); 24.4k
I != E;
++I376k
)
234
376k
    if (!isAsciiIdentifierContinue(*I, AllowDollar))
235
130
      return false;
236
237
24.3k
  return true;
238
24.4k
}
239
240
} // end namespace clang
241
242
#endif