source: proto/parabix2/pablo.py @ 5845

Last change on this file since 5845 was 2023, checked in by cameron, 7 years ago

Scan and Span operations

File size: 7.2 KB
Line 
1#
2# pablo.py
3#
4# Bitstream Utilities
5#
6# These are quick-and-dirty Python implementations of utilities
7# for demo purposes only.
8#
9# Dan Lin, Robert D. Cameron
10# March 24, 2012
11#
12#----------------------------------------------------------------------------
13#
14# We use python's unlimited precision integers for unbounded bit streams.
15# This permits simple logical operations on the entire stream.
16# Assumption: bitstreams are little-endian (e.g., as on x86).
17#
18#----------------------------------------------------------------------------
19#
20import sys
21import codecs
22# Utility functions for demo purposes.
23
24EOF_mask = 0
25data = ''
26
27def writefile(filename, s, charcode='utf-8',):
28        f = codecs.open(filename, 'w', encoding=charcode)
29        f.write(s) # writes encoded bytes to file
30        f.close()
31
32def readfile(filename):
33        f = open(filename, 'r')
34        contents = f.read() 
35        f.close()
36        return contents
37
38def transpose_streams(s, b):
39        mask = 128
40        index = 0
41        global data
42        while index < 8:
43                current = 0
44                cursor = 1
45                for byte in s:
46                        if  (ord(byte) & mask != 0):
47                                current += cursor
48                        cursor <<= 1
49                       
50                index+=1
51                mask>>=1
52                if index == 1:
53                        b.bit_0 = current
54                elif index == 2:
55                        b.bit_1 = current
56                elif index == 3:
57                        b.bit_2 = current
58                elif index == 4:
59                        b.bit_3 = current
60                elif index == 5:
61                        b.bit_4 = current
62                elif index == 6:
63                        b.bit_5 = current
64                elif index == 7:
65                        b.bit_6 = current
66                elif index == 8:
67                        b.bit_7 = current
68        data  = s
69        return cursor-1  # basis streams and EOF mask
70
71def match(s,marker):
72        pos = count_leading_zeroes(marker)
73        i = 0
74        for byte in s:
75                if byte != data[pos+i]:
76                        return 0
77                i +=1
78        return marker
79
80def inFile(lex_error):
81        return EOF_mask & lex_error
82
83def atEOF(strm):
84        if strm > EOF_mask or strm < 0:
85                return EOF_mask + 1
86        else:
87                return 0
88
89def count_leading_zeroes(strm):
90        zeroes = 0
91        while (strm & 0xFFFFFFFF) == 0: 
92                zeroes += 32
93                strm >>= 32
94        while (strm & 1) == 0:
95                zeroes += 1
96                strm >>= 1
97        return zeroes
98#
99#
100#  Are there any bits in a stream
101def any(strm):
102        return strm != 0
103#
104#  ScanThru is the core operation for parallel scanning.
105#  Given a bitstream Cursors marking current cursor positions,
106#  advance each cursor through occurrences of a character
107#  class identified by ScanStream.
108
109def ScanThru(Cursors, ScanStream):
110        return (Cursors + ScanStream) & ~ScanStream
111       
112def ScanTo(Cursors, ScanStream): 
113        return (Cursors + (~ScanStream & EOF_mask) ) & ScanStream
114
115def ScanToFirst(ScanStream):
116        return ScanTo(1, ScanStream)
117#
118# Advance all cursors by one position.
119def Advance(stream):
120        return stream + stream
121       
122def AdvancebyPos(stream, pos):
123        return stream << pos
124
125
126#
127# Advance-and-Scan
128#
129# These are common and useful operations, with a slight
130# optimization to avoid a separate Advance.   
131#
132# Warning:  they each require a "separation" property
133# between markers and scanclass streams.   This property
134# normally seems to hold in our applications, but we should
135# work out methods for formally establishing it.
136#
137# AdvanceThenScanThru(marker, scanclass)
138# optimizes: ScanThru(Advance(marker), scanclass)
139# requires: scanclass-marker separation: no occurrence of
140# a marker immediately after a scanclass run.  That is,
141# any(Advance(scanclass) & marker) == False
142# (this is a sufficient precondition, but maybe not weakest.)
143#
144def AdvanceThenScanThru(marker, scanclass):     
145        return ScanThru(marker, marker | scanclass)
146#
147# AdvanceThenScanTo(marker, scanclass)
148# optimizes: ScanTo(Advance(marker), scanclass)
149# requires: scanclass existence between markers
150
151def AdvanceThenScanTo(marker, scanclass):
152        return ScanTo(marker, scanclass &~ marker)
153
154#
155# Span operations
156# These operations define spans of positions from
157# starting to ending positions.
158# Requirement:  start and end positions are properly
159# matched: popcount(ends)==popcount(starts) and
160# nth-one(starts, n) < nth-one(ends, n), if n < popcount(starts)
161# nth-one(ends, n) < nth-one(starts, n+1) if n < popcount(starts)
162
163def SpanUpTo(starts, ends):
164        return (ends - starts)
165
166def InclusiveSpan(starts, ends): 
167        return (ends - starts) | ends
168
169def ExclusiveSpan(starts, ends): 
170        return (ends - starts) &~ starts
171
172
173
174
175
176
177
178
179#Functions copied from bitutil.py
180def writefile(filename, s, charcode='utf-8',):
181        f = codecs.open(filename, 'w', encoding=charcode)
182        f.write(s) # writes encoded bytes to file
183        f.close()
184
185def EOF_mask(strm_lgth):
186        mask = 1
187        mask <<= (strm_lgth)
188        mask -= 1
189        return mask
190
191def extract_bit(strm, pos):
192        bit = (strm >> pos) & 1
193        return bit
194
195def inverse_transpose(bitset, len):
196        bytestream=""
197        cursor = 1
198        for i in range(0, len):
199                byteval = 0
200                for j in range(0,8):
201                        if bitset[j] & cursor != 0:
202                                byteval += 128 >> j
203                bytestream += chr(byteval)
204                cursor += cursor
205        return bytestream
206                       
207def filter_bits(bitstream, delmask):
208        newstream = 0
209        cursor = 1
210        while delmask > 0:
211                if delmask & 1 == 0:
212                        if bitstream & 1 == 1:
213                                newstream += cursor
214                        cursor += cursor
215                delmask >>= 1
216                bitstream >>= 1
217        while bitstream > 0:
218                if bitstream & 1 == 1:
219                        newstream += cursor
220                cursor += cursor
221                bitstream >>= 1         
222        return newstream
223                       
224def filter_bytes(bytestream, delmask):
225        newstream=""
226        cursor = 1
227        for c in bytestream:
228                if delmask & cursor == 0:
229                        newstream += c
230                cursor += cursor
231        return newstream
232                       
233def merge_bytes(stream1, stream2):
234        s = ""
235        for i in range(len(stream1)):
236                s += stream1[i]
237                s += stream2[i]
238        return s
239
240def bitstream2string(stream, lgth):
241        str = ""
242        for i in range(lgth):
243                if stream & 1 == 1: str += '1'
244                else: str += '_'
245                stream >>= 1
246        return str
247
248def bitstream2stringLE(stream, lgth):
249        str = ""
250        for i in range(lgth):
251                if stream & 1 == 1: str = '1' + str
252                else: str = '_' + str
253                stream >>= 1
254        return str
255
256def print_aligned_streams(stream_list):
257        """Print out a set of aligned streams."""
258        label_max = max([len(p[0]) for p in stream_list])
259        for p in stream_list:
260                print (p[0] + " "*(label_max - len(p[0]))) + ": " + p[1] 
261
262def latex_streams(stream_list):
263        """Return a latex table for streams."""
264        table = "\\begin{tabular}{cr}"
265        for p in stream_list:
266                table += "\\\\\n" + p[0] +" & \\verb`" + p[1] +"`"
267        return table + "\n\\end{tabular}\n"
268
269def print_aligned_u8_byte_streams(u8_byte_stream):
270        """Print out a set of 'encoding' aligned streams."""
271
272        # Set the system info to print utf-8
273        info = codecs.lookup('utf-8')
274        sys.stdout = info.streamwriter(sys.stdout) 
275
276        label_max = max([len(p[0]) for p in u8_byte_stream])
277        for p in u8_byte_stream:
278                sys.stdout.write(p[0] + " "*(label_max - len(p[0])) + ": ")
279               
280                for c in (p[1].decode('utf-8')):                        # for each unicode character
281                        u8_seq_len = len(c.encode('utf-8'))     # encode the unicode character as utf-8 and get the utf-8 sequence length
282                        if u8_seq_len == 1:
283                                sys.stdout.write(c)
284                        elif u8_seq_len == 2:
285                                sys.stdout.write('2_')                          # align 2 byte sequences with a trailing _
286                        elif u8_seq_len == 3:
287                                sys.stdout.write('3__')                         # align 3 byte sequences with 2 trailing _
288                        elif u8_seq_len == 4:
289                                sys.stdout.write('4___')                        # align 2 byte sequences with 3 trailing _               
290                        else:
291                                sys.stdout.write('Error: Invalid UTF-8 character sequence of length: ' + str(u8_seq_len) + '.')                 
292                sys.stdout.write('\n')   
293
294def high_nybble_stream(bytes):
295        str=""
296        for b in bytes:
297                h = hex(ord(b))[-2]
298                if h == 'x': str += '0'
299                else: str += h
300        return str
301
302def low_nybble_stream(bytes):
303        str=""
304        for b in bytes:
305                str += hex(ord(b))[-1]
306        return str
307
Note: See TracBrowser for help on using the repository browser.