1 //===--- UnicodeCharRanges.h - Types and functions for character ranges ---===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
9 #ifndef LLVM_SUPPORT_UNICODECHARRANGES_H
10 #define LLVM_SUPPORT_UNICODECHARRANGES_H
12 #include "llvm/ADT/ArrayRef.h"
13 #include "llvm/ADT/SmallPtrSet.h"
14 #include "llvm/Support/Compiler.h"
15 #include "llvm/Support/Debug.h"
16 #include "llvm/Support/Mutex.h"
17 #include "llvm/Support/MutexGuard.h"
18 #include "llvm/Support/raw_ostream.h"
24 #define DEBUG_TYPE "unicode"
26 /// \brief Represents a closed range of Unicode code points [Lower, Upper].
27 struct UnicodeCharRange {
32 inline bool operator<(uint32_t Value, UnicodeCharRange Range) {
33 return Value < Range.Lower;
35 inline bool operator<(UnicodeCharRange Range, uint32_t Value) {
36 return Range.Upper < Value;
39 /// \brief Holds a reference to an ordered array of UnicodeCharRange and allows
40 /// to quickly check if a code point is contained in the set represented by this
42 class UnicodeCharSet {
44 typedef ArrayRef<UnicodeCharRange> CharRanges;
46 /// \brief Constructs a UnicodeCharSet instance from an array of
47 /// UnicodeCharRanges.
49 /// Array pointed by \p Ranges should have the lifetime at least as long as
50 /// the UnicodeCharSet instance, and should not change. Array is validated by
51 /// the constructor, so it makes sense to create as few UnicodeCharSet
52 /// instances per each array of ranges, as possible.
53 UnicodeCharSet(CharRanges Ranges) : Ranges(Ranges) {
54 assert(rangesAreValid());
57 /// \brief Returns true if the character set contains the Unicode code point
59 bool contains(uint32_t C) const {
60 return std::binary_search(Ranges.begin(), Ranges.end(), C);
64 /// \brief Returns true if each of the ranges is a proper closed range
65 /// [min, max], and if the ranges themselves are ordered and non-overlapping.
66 bool rangesAreValid() const {
68 for (CharRanges::const_iterator I = Ranges.begin(), E = Ranges.end();
70 if (I != Ranges.begin() && Prev >= I->Lower) {
71 DEBUG(dbgs() << "Upper bound 0x");
72 DEBUG(dbgs().write_hex(Prev));
73 DEBUG(dbgs() << " should be less than succeeding lower bound 0x");
74 DEBUG(dbgs().write_hex(I->Lower) << "\n");
77 if (I->Upper < I->Lower) {
78 DEBUG(dbgs() << "Upper bound 0x");
79 DEBUG(dbgs().write_hex(I->Lower));
80 DEBUG(dbgs() << " should not be less than lower bound 0x");
81 DEBUG(dbgs().write_hex(I->Upper) << "\n");
90 const CharRanges Ranges;
93 #undef DEBUG_TYPE // "unicode"
99 #endif // LLVM_SUPPORT_UNICODECHARRANGES_H