source: icGREP/icgrep-devel/icgrep/UCD/unicode_set.h @ 4709

Last change on this file since 4709 was 4631, checked in by nmedfort, 4 years ago

Fix for SCX and updated property objects.

File size: 6.5 KB
Line 
1#ifndef UNICODE_SET_H
2#define UNICODE_SET_H
3#include <stdint.h>
4#include <vector>
5#include <re/re_cc.h>
6#include <boost/iterator/iterator_facade.hpp>
7
8//
9// unicode_set.h - representing and manipulating sets of Unicode
10// characters, based on data from UCD - the Unicode Character Database
11//
12// Robert D. Cameron
13// September 18, 2014
14//
15// Licensed under Open Software License 3.0.
16//
17// Unicode Sparse Bitset Representation
18//
19// The Unicode Sparse Bitset representation is based on
20// (a) Dividing the Unicode codepoint space into groups of 2^k codepoints called quads.
21// (b) Specifying the quads using a run-length encoding, in which each run
22//     is Empty (quads contain no members), Mixed (quads contain some members and
23//     some nonmembers) or Full (all codepoints in each quad are members of the set).
24// (c) Explicitly listing all the quads of Mixed type.
25//
26
27//
28// The internal datatype for quads - bitsets of 2^k codepoints.
29// Default: 64 codepoints (k=6).
30//
31
32namespace llvm {
33class raw_ostream;
34}
35
36namespace UCD {
37
38enum run_type_t : uint16_t {Empty, Mixed, Full};
39
40class UnicodeSet {
41public:
42
43    using bitquad_t = uint32_t;
44    using length_t = uint16_t;
45    using run_t = std::pair<run_type_t, length_t>;
46    using quad_iterator_return_t = std::pair<run_t, bitquad_t>;
47
48    using codepoint_t = re::codepoint_t;
49    using interval_t = re::interval_t;
50    using RunVector = std::vector<run_t>;
51    using QuadVector = std::vector<bitquad_t>;
52
53    class iterator : public boost::iterator_facade<iterator, interval_t, boost::forward_traversal_tag, interval_t> {
54        friend class UnicodeSet;
55        friend class boost::iterator_core_access;
56    protected:
57
58        iterator(const RunVector::const_iterator runIterator, const QuadVector::const_iterator quadIterator, const codepoint_t baseCodePoint)
59        : mRunIterator(runIterator), mQuadIterator(quadIterator)
60        , mMixedRunIndex(0), mQuadOffset(0), mBaseCodePoint(baseCodePoint), mMinCodePoint(baseCodePoint), mMaxCodePoint(baseCodePoint) {
61
62        }
63
64        void advance(const unsigned n);
65
66        inline interval_t dereference() const {
67            return std::make_pair(mMinCodePoint, mMaxCodePoint);
68        }
69
70        inline void increment() {
71            advance(1);
72        }
73
74        inline bool equal(const iterator & other) const {
75            return (mMinCodePoint == other.mMinCodePoint);
76        }
77    private:
78        RunVector::const_iterator           mRunIterator;
79        QuadVector::const_iterator          mQuadIterator;
80        unsigned                            mMixedRunIndex;
81        bitquad_t                           mQuadOffset;
82        codepoint_t                         mBaseCodePoint;
83        codepoint_t                         mMinCodePoint;
84        codepoint_t                         mMaxCodePoint;
85    };
86
87    inline iterator begin() const {
88        // note: preincrement forces the iterator to advance onto and capture the first interval.
89        return ++iterator(mRuns.cbegin(), mQuads.cbegin(), 0);
90    }
91
92    inline iterator end() const {
93        return iterator(mRuns.cend(), mQuads.cend(), 0x110000);
94    }
95
96    class quad_iterator : public boost::iterator_facade<quad_iterator, quad_iterator_return_t, boost::random_access_traversal_tag, quad_iterator_return_t> {
97        friend class UnicodeSet;
98        friend class boost::iterator_core_access;
99    public:
100        quad_iterator(RunVector::const_iterator runIterator, QuadVector::const_iterator quadIterator)
101            : mRunIterator(runIterator), mQuadIterator(quadIterator), mOffset(0) {}
102
103        void advance(unsigned n);
104
105        inline quad_iterator_return_t dereference() const {
106            return std::make_pair(std::make_pair(type(), length()), quad());
107        }
108
109        inline void increment() {
110            advance(1);
111        }
112
113        inline run_type_t type() const {
114            return std::get<0>(*mRunIterator);
115        }
116
117        inline length_t length() const {
118            return std::get<1>(*mRunIterator) - mOffset;
119        }
120
121        inline bitquad_t quad() const {
122            return *mQuadIterator;
123        }
124
125        inline bool equal(const quad_iterator & other) const {
126            return (mRunIterator == other.mRunIterator) && (mQuadIterator == other.mQuadIterator);
127        }
128
129    private:
130        RunVector::const_iterator   mRunIterator;
131        QuadVector::const_iterator  mQuadIterator;
132        unsigned                    mOffset;
133    };
134
135    inline quad_iterator quad_begin() const {
136        return quad_iterator(mRuns.cbegin(), mQuads.cbegin());
137    }
138
139    inline quad_iterator quad_end() const {
140        return quad_iterator(mRuns.cend(), mQuads.cend());
141    }
142
143    bool contains(const codepoint_t codepoint) const;
144
145    bool intersects(const codepoint_t lo, const codepoint_t hi) const;
146
147    void dump(llvm::raw_ostream & out) const;
148
149    UnicodeSet operator~() const;
150    UnicodeSet operator&(const UnicodeSet & other) const;
151    UnicodeSet operator+(const UnicodeSet & other) const;
152    UnicodeSet operator-(const UnicodeSet & other) const;
153    UnicodeSet operator^(const UnicodeSet & other) const;
154    inline UnicodeSet & operator=(const UnicodeSet & other) = default;
155    inline UnicodeSet & operator=(UnicodeSet && other) = default;
156    UnicodeSet operator==(const UnicodeSet & other) const;
157
158    UnicodeSet();
159    UnicodeSet(const codepoint_t codepoint);
160    UnicodeSet(const codepoint_t lo_codepoint, const codepoint_t hi_codepoint);
161    inline UnicodeSet(const UnicodeSet & other) = default;
162    UnicodeSet(std::initializer_list<run_t> r, std::initializer_list<bitquad_t> q) : mRuns(r), mQuads(q) {}
163    UnicodeSet(std::vector<run_t> && r, std::vector<bitquad_t> && q) : mRuns(r), mQuads(q) {}
164
165    inline void swap(UnicodeSet & other);
166    inline void swap(UnicodeSet && other);
167
168private:
169
170    RunVector       mRuns;
171    QuadVector      mQuads;
172};
173
174inline void UnicodeSet::swap(UnicodeSet & other) {
175    mRuns.swap(other.mRuns); mQuads.swap(other.mQuads);
176}
177
178inline void UnicodeSet::swap(UnicodeSet && other) {
179    mRuns.swap(other.mRuns); mQuads.swap(other.mQuads);
180}
181
182inline UnicodeSet uset_complement(const UnicodeSet & s) {
183    return ~s;
184}
185
186inline UnicodeSet uset_intersection(const UnicodeSet & s1, const UnicodeSet & s2) {
187    return s1 & s2;
188}
189
190inline UnicodeSet uset_union(const UnicodeSet & s1, const UnicodeSet & s2) {
191    return s1 + s2;
192}
193
194inline UnicodeSet uset_difference(const UnicodeSet & s1, const UnicodeSet & s2) {
195    return s1 - s2;
196}
197
198inline UnicodeSet uset_symmetric_difference(const UnicodeSet & s1, const UnicodeSet & s2) {
199    return s1 ^ s2;
200}
201
202}
203
204#endif
205
Note: See TracBrowser for help on using the repository browser.