include/llvm/Support/UnicodeCharRanges.h

   1 //===--- UnicodeCharRanges.h - Types and functions for character ranges ---===//
   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 #ifndef LLVM_SUPPORT_UNICODECHARRANGES_H
  10 #define LLVM_SUPPORT_UNICODECHARRANGES_H
  11
  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"
  19
  20 #include <algorithm>
  21
  22 namespace llvm {
  23 namespace sys {
  24
  25 /// \brief Represents a closed range of Unicode code points [Lower, Upper].
  26 struct UnicodeCharRange {
  27   uint32_t Lower;
  28   uint32_t Upper;
  29 };
  30
  31 inline bool operator<(uint32_t Value, UnicodeCharRange Range) {
  32   return Value < Range.Lower;
  33 }
  34 inline bool operator<(UnicodeCharRange Range, uint32_t Value) {
  35   return Range.Upper < Value;
  36 }
  37
  38 /// \brief Holds a reference to an ordered array of UnicodeCharRange and allows
  39 /// to quickly check if a code point is contained in the set represented by this
  40 /// array.
  41 class UnicodeCharSet {
  42 public:
  43   typedef llvm::ArrayRef<UnicodeCharRange> CharRanges;
  44
  45   /// \brief Constructs a UnicodeCharSet instance from an array of
  46   /// UnicodeCharRanges.
  47   ///
  48   /// Array pointed by \p Ranges should have the lifetime at least as long as
  49   /// the UnicodeCharSet instance, and should not change. Array is validated by
  50   /// the constructor, so it makes sense to create as few UnicodeCharSet
  51   /// instances per each array of ranges, as possible.
  52 #ifdef NDEBUG
  53   LLVM_CONSTEXPR
  54 #endif
  55   UnicodeCharSet(CharRanges Ranges) : Ranges(Ranges) {
  56     assert(rangesAreValid());
  57   }
  58
  59   /// \brief Returns true if the character set contains the Unicode code point
  60   /// \p C.
  61   bool contains(uint32_t C) const {
  62     return std::binary_search(Ranges.begin(), Ranges.end(), C);
  63   }
  64
  65 private:
  66   /// \brief Returns true if each of the ranges is a proper closed range
  67   /// [min, max], and if the ranges themselves are ordered and non-overlapping.
  68   bool rangesAreValid() const {
  69     uint32_t Prev = 0;
  70     for (CharRanges::const_iterator I = Ranges.begin(), E = Ranges.end();
  71          I != E; ++I) {
  72       if (I != Ranges.begin() && Prev >= I->Lower) {
  73         DEBUG(llvm::dbgs() << "Upper bound 0x");
  74         DEBUG(llvm::dbgs().write_hex(Prev));
  75         DEBUG(llvm::dbgs() << " should be less than succeeding lower bound 0x");
  76         DEBUG(llvm::dbgs().write_hex(I->Lower) << "\n");
  77         return false;
  78       }
  79       if (I->Upper < I->Lower) {
  80         DEBUG(llvm::dbgs() << "Upper bound 0x");
  81         DEBUG(llvm::dbgs().write_hex(I->Lower));
  82         DEBUG(llvm::dbgs() << " should not be less than lower bound 0x");
  83         DEBUG(llvm::dbgs().write_hex(I->Upper) << "\n");
  84         return false;
  85       }
  86       Prev = I->Upper;
  87     }
  88
  89     return true;
  90   }
  91
  92   const CharRanges Ranges;
  93 };
  94
  95 } // namespace sys
  96 } // namespace llvm
  97
  98
  99 #endif // LLVM_SUPPORT_UNICODECHARRANGES_H