LLVM 19.0.0git
Unicode.h
Go to the documentation of this file.
1//===- llvm/Support/Unicode.h - Unicode character properties -*- 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// This file defines functions that allow querying certain properties of Unicode
10// characters.
11//
12//===----------------------------------------------------------------------===//
13
14#ifndef LLVM_SUPPORT_UNICODE_H
15#define LLVM_SUPPORT_UNICODE_H
16
18#include <optional>
19#include <string>
20
21namespace llvm {
22class StringRef;
23
24namespace sys {
25namespace unicode {
26
30};
31
32/// Determines if a character is likely to be displayed correctly on the
33/// terminal. Exact implementation would have to depend on the specific
34/// terminal, so we define the semantic that should be suitable for generic case
35/// of a terminal capable to output Unicode characters.
36///
37/// Printable codepoints are those in the categories L, M, N, P, S and Zs
38/// \return true if the character is considered printable.
39bool isPrintable(int UCS);
40
41// Formatting codepoints are codepoints in the Cf category.
42bool isFormatting(int UCS);
43
44/// Gets the number of positions the UTF8-encoded \p Text is likely to occupy
45/// when output on a terminal ("character width"). This depends on the
46/// implementation of the terminal, and there's no standard definition of
47/// character width.
48///
49/// The implementation defines it in a way that is expected to be compatible
50/// with a generic Unicode-capable terminal.
51///
52/// \return Character width:
53/// * ErrorNonPrintableCharacter (-1) if \p Text contains non-printable
54/// characters (as identified by isPrintable);
55/// * 0 for each non-spacing and enclosing combining mark;
56/// * 2 for each CJK character excluding halfwidth forms;
57/// * 1 for each of the remaining characters.
59
60/// Fold input unicode character according the Simple unicode case folding
61/// rules.
62int foldCharSimple(int C);
63
64/// Maps the name or the alias of a Unicode character to its associated
65/// codepoints.
66/// The names and aliases are derived from UnicodeData.txt and NameAliases.txt
67/// For compatibility with the semantics of named character escape sequences in
68/// C++, this mapping does an exact match sensitive to casing and spacing.
69/// \return The codepoint of the corresponding character, if any.
70std::optional<char32_t> nameToCodepointStrict(StringRef Name);
71
73 char32_t CodePoint;
75};
76
77std::optional<LooseMatchingResult> nameToCodepointLooseMatching(StringRef Name);
78
80 std::string Name;
82 char32_t Value = 0;
83};
84
86nearestMatchesForCodepointName(StringRef Pattern, std::size_t MaxMatchesCount);
87
88} // namespace unicode
89} // namespace sys
90} // namespace llvm
91
92#endif
std::string Name
This file defines the SmallString class.
SmallString - A SmallString is just a SmallVector with methods and accessors that make it work better...
Definition: SmallString.h:26
This is a 'vector' (really, a variable-sized array), optimized for the case when the array is small.
Definition: SmallVector.h:1209
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
LLVM Value Representation.
Definition: Value.h:74
@ C
The default llvm calling convention, compatible with C.
Definition: CallingConv.h:34
@ ErrorNonPrintableCharacter
Definition: Unicode.h:29
int foldCharSimple(int C)
Fold input unicode character according the Simple unicode case folding rules.
std::optional< char32_t > nameToCodepointStrict(StringRef Name)
Maps the name or the alias of a Unicode character to its associated codepoints.
SmallVector< MatchForCodepointName > nearestMatchesForCodepointName(StringRef Pattern, std::size_t MaxMatchesCount)
int columnWidthUTF8(StringRef Text)
Gets the number of positions the UTF8-encoded Text is likely to occupy when output on a terminal ("ch...
Definition: Unicode.cpp:481
std::optional< LooseMatchingResult > nameToCodepointLooseMatching(StringRef Name)
bool isFormatting(int UCS)
Unicode code points of the Cf category are considered formatting characters.
Definition: Unicode.cpp:277
bool isPrintable(int UCS)
Determines if a character is likely to be displayed correctly on the terminal.
Definition: Unicode.cpp:27
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18