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

Last change on this file since 5276 was 5240, checked in by nmedfort, 3 years ago

Cleaned up memory leaks + some warning messages.

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 <boost/iterator/iterator_facade.hpp>
6#include <util/slab_allocator.h>
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 = unsigned;
49    using interval_t = std::pair<codepoint_t, codepoint_t>;
50
51    using RunVector = std::vector<run_t, ProxyAllocator<run_t>>;
52    using QuadVector = std::vector<bitquad_t, ProxyAllocator<bitquad_t>>;
53    using RunIterator = RunVector::const_iterator;
54    using QuadIterator = QuadVector::const_iterator;
55
56    using size_type = RunVector::size_type;
57
58    class iterator : public boost::iterator_facade<iterator, interval_t, boost::forward_traversal_tag, interval_t> {
59        friend class UnicodeSet;
60        friend class boost::iterator_core_access;
61    protected:
62
63        iterator(const RunVector::const_iterator runIterator, const QuadVector::const_iterator quadIterator, const codepoint_t baseCodePoint)
64        : mRunIterator(runIterator), mQuadIterator(quadIterator)
65        , mMixedRunIndex(0), mQuadOffset(0), mBaseCodePoint(baseCodePoint), mMinCodePoint(baseCodePoint), mMaxCodePoint(baseCodePoint) {
66
67        }
68
69        void advance(const unsigned n);
70
71        inline interval_t dereference() const {
72            return std::make_pair(mMinCodePoint, mMaxCodePoint);
73        }
74
75        inline void increment() {
76            advance(1);
77        }
78
79        inline bool equal(const iterator & other) const {
80            return (mMinCodePoint == other.mMinCodePoint);
81        }
82    private:
83        RunIterator         mRunIterator;
84        QuadIterator        mQuadIterator;
85        unsigned            mMixedRunIndex;
86        bitquad_t           mQuadOffset;
87        codepoint_t         mBaseCodePoint;
88        codepoint_t         mMinCodePoint;
89        codepoint_t         mMaxCodePoint;
90    };
91
92    inline iterator begin() const {
93        // note: preincrement forces the iterator to advance onto and capture the first interval.
94        return ++iterator(mRuns.cbegin(), mQuads.cbegin(), 0);
95    }
96
97    inline iterator end() const {
98        return iterator(mRuns.cend(), mQuads.cend(), 0x110000);
99    }
100
101    bool contains(const codepoint_t codepoint) const;
102
103    bool intersects(const codepoint_t lo, const codepoint_t hi) const;
104
105    void insert(const codepoint_t cp);
106
107    void insert_range(const codepoint_t lo, const codepoint_t hi);
108
109    bool empty() const;
110
111    size_type size() const;
112
113    interval_t front() const;
114
115    interval_t back() const;
116
117    void dump(llvm::raw_ostream & out) const;
118
119    UnicodeSet operator~() const;
120    UnicodeSet operator&(const UnicodeSet & other) const;
121    UnicodeSet operator+(const UnicodeSet & other) const;
122    UnicodeSet operator-(const UnicodeSet & other) const;
123    UnicodeSet operator^(const UnicodeSet & other) const;
124
125    inline UnicodeSet & operator=(const UnicodeSet & other) = default;
126    inline UnicodeSet & operator=(UnicodeSet && other) = default;
127    bool operator==(const UnicodeSet & other) const;
128    bool operator<(const UnicodeSet & other) const;
129
130    UnicodeSet();
131    UnicodeSet(const codepoint_t codepoint);
132    UnicodeSet(const codepoint_t lo, const codepoint_t hi);
133    UnicodeSet(const UnicodeSet & other);
134    UnicodeSet(std::initializer_list<run_t> r, std::initializer_list<bitquad_t> q);
135    UnicodeSet(std::initializer_list<interval_t>::iterator begin, std::initializer_list<interval_t>::iterator end);
136    UnicodeSet(const std::vector<interval_t>::iterator begin, const std::vector<interval_t>::iterator end);
137
138    inline void swap(UnicodeSet & other);
139    inline void swap(UnicodeSet && other);
140
141protected:
142
143    UnicodeSet(std::vector<run_t> && r, std::vector<bitquad_t> && q);
144
145    class quad_iterator : public boost::iterator_facade<quad_iterator, quad_iterator_return_t, boost::random_access_traversal_tag, quad_iterator_return_t> {
146        friend class UnicodeSet;
147        friend class boost::iterator_core_access;
148    public:
149        quad_iterator(RunIterator runIterator, QuadIterator quadIterator)
150            : mRunIterator(runIterator), mQuadIterator(quadIterator), mOffset(0) {}
151
152        void advance(unsigned n);
153
154        inline quad_iterator_return_t dereference() const {
155            return std::make_pair(std::make_pair(type(), length()), quad());
156        }
157
158        inline void increment() {
159            advance(1);
160        }
161
162        inline run_type_t type() const {
163            return mRunIterator->first;
164        }
165
166        inline length_t length() const {
167            return mRunIterator->second - mOffset;
168        }
169
170        inline bitquad_t quad() const {
171            return *mQuadIterator;
172        }
173
174        inline bool equal(const quad_iterator & other) const {
175            return (mRunIterator == other.mRunIterator) && (mQuadIterator == other.mQuadIterator);
176        }
177
178    private:
179        RunIterator     mRunIterator;
180        QuadIterator    mQuadIterator;
181        unsigned        mOffset;
182    };
183
184    inline quad_iterator quad_begin() const {
185        return quad_iterator(mRuns.cbegin(), mQuads.cbegin());
186    }
187
188    inline quad_iterator quad_end() const {
189        return quad_iterator(mRuns.cend(), mQuads.cend());
190    }
191
192private:
193
194    RunVector               mRuns;
195    QuadVector              mQuads;
196    static SlabAllocator<>  mAllocator;
197};
198
199enum : UnicodeSet::codepoint_t { UNICODE_MAX = 0x10FFFF };
200
201inline void UnicodeSet::swap(UnicodeSet & other) {
202    mRuns.swap(other.mRuns); mQuads.swap(other.mQuads);
203}
204
205inline void UnicodeSet::swap(UnicodeSet && other) {
206    mRuns.swap(other.mRuns); mQuads.swap(other.mQuads);
207}
208
209}
210
211#endif
212
Note: See TracBrowser for help on using the repository browser.