Shortcuts on this page
r m x toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1"""ttLib.tables.ttProgram.py -- Assembler/disassembler for TrueType bytecode programs."""
3from __future__ import annotations
5from fontTools.misc.textTools import num2binary, binary2num, readHex, strjoin
6import array
7from io import StringIO
8from typing import List
9import re
10import logging
13log = logging.getLogger(__name__)
15# fmt: off
17# first, the list of instructions that eat bytes or words from the instruction stream
19streamInstructions = [
20#
21# opcode mnemonic argBits descriptive name pops pushes eats from instruction stream pushes
22#
23 (0x40, 'NPUSHB', 0, 'PushNBytes', 0, -1), # n, b1, b2,...bn b1,b2...bn
24 (0x41, 'NPUSHW', 0, 'PushNWords', 0, -1), # n, w1, w2,...w w1,w2...wn
25 (0xb0, 'PUSHB', 3, 'PushBytes', 0, -1), # b0, b1,..bn b0, b1, ...,bn
26 (0xb8, 'PUSHW', 3, 'PushWords', 0, -1), # w0,w1,..wn w0 ,w1, ...wn
27]
30# next, the list of "normal" instructions
32instructions = [
33#
34# opcode mnemonic argBits descriptive name pops pushes eats from instruction stream pushes
35#
36 (0x7f, 'AA', 0, 'AdjustAngle', 1, 0), # p -
37 (0x64, 'ABS', 0, 'Absolute', 1, 1), # n |n|
38 (0x60, 'ADD', 0, 'Add', 2, 1), # n2, n1 (n1 + n2)
39 (0x27, 'ALIGNPTS', 0, 'AlignPts', 2, 0), # p2, p1 -
40 (0x3c, 'ALIGNRP', 0, 'AlignRelativePt', -1, 0), # p1, p2, ... , ploopvalue -
41 (0x5a, 'AND', 0, 'LogicalAnd', 2, 1), # e2, e1 b
42 (0x2b, 'CALL', 0, 'CallFunction', 1, 0), # f -
43 (0x67, 'CEILING', 0, 'Ceiling', 1, 1), # n ceil(n)
44 (0x25, 'CINDEX', 0, 'CopyXToTopStack', 1, 1), # k ek
45 (0x22, 'CLEAR', 0, 'ClearStack', -1, 0), # all items on the stack -
46 (0x4f, 'DEBUG', 0, 'DebugCall', 1, 0), # n -
47 (0x73, 'DELTAC1', 0, 'DeltaExceptionC1', -1, 0), # argn, cn, argn-1,cn-1, , arg1, c1 -
48 (0x74, 'DELTAC2', 0, 'DeltaExceptionC2', -1, 0), # argn, cn, argn-1,cn-1, , arg1, c1 -
49 (0x75, 'DELTAC3', 0, 'DeltaExceptionC3', -1, 0), # argn, cn, argn-1,cn-1, , arg1, c1 -
50 (0x5d, 'DELTAP1', 0, 'DeltaExceptionP1', -1, 0), # argn, pn, argn-1, pn-1, , arg1, p1 -
51 (0x71, 'DELTAP2', 0, 'DeltaExceptionP2', -1, 0), # argn, pn, argn-1, pn-1, , arg1, p1 -
52 (0x72, 'DELTAP3', 0, 'DeltaExceptionP3', -1, 0), # argn, pn, argn-1, pn-1, , arg1, p1 -
53 (0x24, 'DEPTH', 0, 'GetDepthStack', 0, 1), # - n
54 (0x62, 'DIV', 0, 'Divide', 2, 1), # n2, n1 (n1 * 64)/ n2
55 (0x20, 'DUP', 0, 'DuplicateTopStack', 1, 2), # e e, e
56 (0x59, 'EIF', 0, 'EndIf', 0, 0), # - -
57 (0x1b, 'ELSE', 0, 'Else', 0, 0), # - -
58 (0x2d, 'ENDF', 0, 'EndFunctionDefinition', 0, 0), # - -
59 (0x54, 'EQ', 0, 'Equal', 2, 1), # e2, e1 b
60 (0x57, 'EVEN', 0, 'Even', 1, 1), # e b
61 (0x2c, 'FDEF', 0, 'FunctionDefinition', 1, 0), # f -
62 (0x4e, 'FLIPOFF', 0, 'SetAutoFlipOff', 0, 0), # - -
63 (0x4d, 'FLIPON', 0, 'SetAutoFlipOn', 0, 0), # - -
64 (0x80, 'FLIPPT', 0, 'FlipPoint', -1, 0), # p1, p2, ..., ploopvalue -
65 (0x82, 'FLIPRGOFF', 0, 'FlipRangeOff', 2, 0), # h, l -
66 (0x81, 'FLIPRGON', 0, 'FlipRangeOn', 2, 0), # h, l -
67 (0x66, 'FLOOR', 0, 'Floor', 1, 1), # n floor(n)
68 (0x46, 'GC', 1, 'GetCoordOnPVector', 1, 1), # p c
69 (0x88, 'GETINFO', 0, 'GetInfo', 1, 1), # selector result
70 (0x91, 'GETVARIATION', 0, 'GetVariation', 0, -1), # - a1,..,an
71 (0x0d, 'GFV', 0, 'GetFVector', 0, 2), # - px, py
72 (0x0c, 'GPV', 0, 'GetPVector', 0, 2), # - px, py
73 (0x52, 'GT', 0, 'GreaterThan', 2, 1), # e2, e1 b
74 (0x53, 'GTEQ', 0, 'GreaterThanOrEqual', 2, 1), # e2, e1 b
75 (0x89, 'IDEF', 0, 'InstructionDefinition', 1, 0), # f -
76 (0x58, 'IF', 0, 'If', 1, 0), # e -
77 (0x8e, 'INSTCTRL', 0, 'SetInstrExecControl', 2, 0), # s, v -
78 (0x39, 'IP', 0, 'InterpolatePts', -1, 0), # p1, p2, ... , ploopvalue -
79 (0x0f, 'ISECT', 0, 'MovePtToIntersect', 5, 0), # a1, a0, b1, b0, p -
80 (0x30, 'IUP', 1, 'InterpolateUntPts', 0, 0), # - -
81 (0x1c, 'JMPR', 0, 'Jump', 1, 0), # offset -
82 (0x79, 'JROF', 0, 'JumpRelativeOnFalse', 2, 0), # e, offset -
83 (0x78, 'JROT', 0, 'JumpRelativeOnTrue', 2, 0), # e, offset -
84 (0x2a, 'LOOPCALL', 0, 'LoopAndCallFunction', 2, 0), # f, count -
85 (0x50, 'LT', 0, 'LessThan', 2, 1), # e2, e1 b
86 (0x51, 'LTEQ', 0, 'LessThenOrEqual', 2, 1), # e2, e1 b
87 (0x8b, 'MAX', 0, 'Maximum', 2, 1), # e2, e1 max(e1, e2)
88 (0x49, 'MD', 1, 'MeasureDistance', 2, 1), # p2,p1 d
89 (0x2e, 'MDAP', 1, 'MoveDirectAbsPt', 1, 0), # p -
90 (0xc0, 'MDRP', 5, 'MoveDirectRelPt', 1, 0), # p -
91 (0x3e, 'MIAP', 1, 'MoveIndirectAbsPt', 2, 0), # n, p -
92 (0x8c, 'MIN', 0, 'Minimum', 2, 1), # e2, e1 min(e1, e2)
93 (0x26, 'MINDEX', 0, 'MoveXToTopStack', 1, 1), # k ek
94 (0xe0, 'MIRP', 5, 'MoveIndirectRelPt', 2, 0), # n, p -
95 (0x4b, 'MPPEM', 0, 'MeasurePixelPerEm', 0, 1), # - ppem
96 (0x4c, 'MPS', 0, 'MeasurePointSize', 0, 1), # - pointSize
97 (0x3a, 'MSIRP', 1, 'MoveStackIndirRelPt', 2, 0), # d, p -
98 (0x63, 'MUL', 0, 'Multiply', 2, 1), # n2, n1 (n1 * n2)/64
99 (0x65, 'NEG', 0, 'Negate', 1, 1), # n -n
100 (0x55, 'NEQ', 0, 'NotEqual', 2, 1), # e2, e1 b
101 (0x5c, 'NOT', 0, 'LogicalNot', 1, 1), # e ( not e )
102 (0x6c, 'NROUND', 2, 'NoRound', 1, 1), # n1 n2
103 (0x56, 'ODD', 0, 'Odd', 1, 1), # e b
104 (0x5b, 'OR', 0, 'LogicalOr', 2, 1), # e2, e1 b
105 (0x21, 'POP', 0, 'PopTopStack', 1, 0), # e -
106 (0x45, 'RCVT', 0, 'ReadCVT', 1, 1), # location value
107 (0x7d, 'RDTG', 0, 'RoundDownToGrid', 0, 0), # - -
108 (0x7a, 'ROFF', 0, 'RoundOff', 0, 0), # - -
109 (0x8a, 'ROLL', 0, 'RollTopThreeStack', 3, 3), # a,b,c b,a,c
110 (0x68, 'ROUND', 2, 'Round', 1, 1), # n1 n2
111 (0x43, 'RS', 0, 'ReadStore', 1, 1), # n v
112 (0x3d, 'RTDG', 0, 'RoundToDoubleGrid', 0, 0), # - -
113 (0x18, 'RTG', 0, 'RoundToGrid', 0, 0), # - -
114 (0x19, 'RTHG', 0, 'RoundToHalfGrid', 0, 0), # - -
115 (0x7c, 'RUTG', 0, 'RoundUpToGrid', 0, 0), # - -
116 (0x77, 'S45ROUND', 0, 'SuperRound45Degrees', 1, 0), # n -
117 (0x7e, 'SANGW', 0, 'SetAngleWeight', 1, 0), # weight -
118 (0x85, 'SCANCTRL', 0, 'ScanConversionControl', 1, 0), # n -
119 (0x8d, 'SCANTYPE', 0, 'ScanType', 1, 0), # n -
120 (0x48, 'SCFS', 0, 'SetCoordFromStackFP', 2, 0), # c, p -
121 (0x1d, 'SCVTCI', 0, 'SetCVTCutIn', 1, 0), # n -
122 (0x5e, 'SDB', 0, 'SetDeltaBaseInGState', 1, 0), # n -
123 (0x86, 'SDPVTL', 1, 'SetDualPVectorToLine', 2, 0), # p2, p1 -
124 (0x5f, 'SDS', 0, 'SetDeltaShiftInGState', 1, 0), # n -
125 (0x0b, 'SFVFS', 0, 'SetFVectorFromStack', 2, 0), # y, x -
126 (0x04, 'SFVTCA', 1, 'SetFVectorToAxis', 0, 0), # - -
127 (0x08, 'SFVTL', 1, 'SetFVectorToLine', 2, 0), # p2, p1 -
128 (0x0e, 'SFVTPV', 0, 'SetFVectorToPVector', 0, 0), # - -
129 (0x34, 'SHC', 1, 'ShiftContourByLastPt', 1, 0), # c -
130 (0x32, 'SHP', 1, 'ShiftPointByLastPoint', -1, 0), # p1, p2, ..., ploopvalue -
131 (0x38, 'SHPIX', 0, 'ShiftZoneByPixel', -1, 0), # d, p1, p2, ..., ploopvalue -
132 (0x36, 'SHZ', 1, 'ShiftZoneByLastPoint', 1, 0), # e -
133 (0x17, 'SLOOP', 0, 'SetLoopVariable', 1, 0), # n -
134 (0x1a, 'SMD', 0, 'SetMinimumDistance', 1, 0), # distance -
135 (0x0a, 'SPVFS', 0, 'SetPVectorFromStack', 2, 0), # y, x -
136 (0x02, 'SPVTCA', 1, 'SetPVectorToAxis', 0, 0), # - -
137 (0x06, 'SPVTL', 1, 'SetPVectorToLine', 2, 0), # p2, p1 -
138 (0x76, 'SROUND', 0, 'SuperRound', 1, 0), # n -
139 (0x10, 'SRP0', 0, 'SetRefPoint0', 1, 0), # p -
140 (0x11, 'SRP1', 0, 'SetRefPoint1', 1, 0), # p -
141 (0x12, 'SRP2', 0, 'SetRefPoint2', 1, 0), # p -
142 (0x1f, 'SSW', 0, 'SetSingleWidth', 1, 0), # n -
143 (0x1e, 'SSWCI', 0, 'SetSingleWidthCutIn', 1, 0), # n -
144 (0x61, 'SUB', 0, 'Subtract', 2, 1), # n2, n1 (n1 - n2)
145 (0x00, 'SVTCA', 1, 'SetFPVectorToAxis', 0, 0), # - -
146 (0x23, 'SWAP', 0, 'SwapTopStack', 2, 2), # e2, e1 e1, e2
147 (0x13, 'SZP0', 0, 'SetZonePointer0', 1, 0), # n -
148 (0x14, 'SZP1', 0, 'SetZonePointer1', 1, 0), # n -
149 (0x15, 'SZP2', 0, 'SetZonePointer2', 1, 0), # n -
150 (0x16, 'SZPS', 0, 'SetZonePointerS', 1, 0), # n -
151 (0x29, 'UTP', 0, 'UnTouchPt', 1, 0), # p -
152 (0x70, 'WCVTF', 0, 'WriteCVTInFUnits', 2, 0), # n, l -
153 (0x44, 'WCVTP', 0, 'WriteCVTInPixels', 2, 0), # v, l -
154 (0x42, 'WS', 0, 'WriteStore', 2, 0), # v, l -
155]
157# fmt: on
160def bitRepr(value: int, bits: int) -> str:
161 s = ""
162 for i in range(bits):
163 s = "01"[value & 0x1] + s
164 value = value >> 1
165 return s
168_mnemonicPat = re.compile(r"[A-Z][A-Z0-9]*$")
171def _makeDict(
172 instructionList: list[tuple[int, str, int, str, int, int]],
173) -> tuple[dict, dict]:
174 opcodeDict = {}
175 mnemonicDict = {}
176 for op, mnemonic, argBits, name, pops, pushes in instructionList:
177 assert _mnemonicPat.match(mnemonic)
178 mnemonicDict[mnemonic] = op, argBits, name
179 if argBits:
180 argoffset = op
181 for i in range(1 << argBits):
182 opcodeDict[op + i] = mnemonic, argBits, argoffset, name
183 else:
184 opcodeDict[op] = mnemonic, 0, 0, name
185 return opcodeDict, mnemonicDict
188streamOpcodeDict, streamMnemonicDict = _makeDict(streamInstructions)
189opcodeDict, mnemonicDict = _makeDict(instructions)
192class tt_instructions_error(Exception):
193 def __init__(self, error: str) -> None:
194 self.error = error
196 def __str__(self) -> str:
197 return "TT instructions error: %s" % repr(self.error)
200_comment = r"/\*.*?\*/"
201_instruction = r"([A-Z][A-Z0-9]*)\s*\[(.*?)\]"
202_number = r"-?[0-9]+"
203_token = "(%s)|(%s)|(%s)" % (_instruction, _number, _comment)
205_tokenRE = re.compile(_token)
206_whiteRE = re.compile(r"\s*")
208_pushCountPat = re.compile(r"[A-Z][A-Z0-9]*\s*\[.*?\]\s*/\* ([0-9]+).*?\*/")
210_indentRE = re.compile(r"^FDEF|IF|ELSE\[ \]\t.+")
211_unindentRE = re.compile(r"^ELSE|ENDF|EIF\[ \]\t.+")
214def _skipWhite(data: str, pos: int) -> int:
215 m = _whiteRE.match(data, pos)
216 newPos = m.regs[0][1]
217 assert newPos >= pos
218 return newPos
221class Program:
222 def __init__(self) -> None:
223 pass
225 def fromBytecode(self, bytecode: bytes) -> None:
226 self.bytecode = array.array("B", bytecode)
227 if hasattr(self, "assembly"):
228 del self.assembly
230 def fromAssembly(self, assembly: list[str] | str) -> None:
231 if isinstance(assembly, list):
232 self.assembly = assembly
233 elif isinstance(assembly, str):
234 self.assembly = assembly.splitlines()
235 else:
236 raise TypeError(f"expected str or List[str], got {type(assembly).__name__}")
237 if hasattr(self, "bytecode"):
238 del self.bytecode
240 def getBytecode(self) -> bytes:
241 if not hasattr(self, "bytecode"):
242 self._assemble()
243 return self.bytecode.tobytes()
245 def getAssembly(self, preserve=True) -> List[str]:
246 if not hasattr(self, "assembly"):
247 self._disassemble(preserve=preserve)
248 return self.assembly
250 def toXML(self, writer, ttFont) -> None:
251 if (
252 not hasattr(ttFont, "disassembleInstructions")
253 or ttFont.disassembleInstructions
254 ):
255 try:
256 assembly = self.getAssembly()
257 except:
258 import traceback
260 tmp = StringIO()
261 traceback.print_exc(file=tmp)
262 msg = "An exception occurred during the decompilation of glyph program:\n\n"
263 msg += tmp.getvalue()
264 log.error(msg)
265 writer.begintag("bytecode")
266 writer.newline()
267 writer.comment(msg.strip())
268 writer.newline()
269 writer.dumphex(self.getBytecode())
270 writer.endtag("bytecode")
271 writer.newline()
272 else:
273 if not assembly:
274 return
275 writer.begintag("assembly")
276 writer.newline()
277 i = 0
278 indent = 0
279 nInstr = len(assembly)
280 while i < nInstr:
281 instr = assembly[i]
282 if _unindentRE.match(instr):
283 indent -= 1
284 writer.write(writer.indentwhite * indent)
285 writer.write(instr)
286 writer.newline()
287 m = _pushCountPat.match(instr)
288 i = i + 1
289 if m:
290 nValues = int(m.group(1))
291 line: List[str] = []
292 j = 0
293 for j in range(nValues):
294 if j and not (j % 25):
295 writer.write(writer.indentwhite * indent)
296 writer.write(" ".join(line))
297 writer.newline()
298 line = []
299 line.append(assembly[i + j])
300 writer.write(writer.indentwhite * indent)
301 writer.write(" ".join(line))
302 writer.newline()
303 i = i + j + 1
304 if _indentRE.match(instr):
305 indent += 1
306 writer.endtag("assembly")
307 writer.newline()
308 else:
309 bytecode = self.getBytecode()
310 if not bytecode:
311 return
312 writer.begintag("bytecode")
313 writer.newline()
314 writer.dumphex(bytecode)
315 writer.endtag("bytecode")
316 writer.newline()
318 def fromXML(self, name, attrs, content, ttFont) -> None:
319 if name == "assembly":
320 self.fromAssembly(strjoin(content))
321 self._assemble()
322 del self.assembly
323 else:
324 assert name == "bytecode"
325 self.fromBytecode(readHex(content))
327 def _assemble(self) -> None:
328 assembly = " ".join(getattr(self, "assembly", []))
329 bytecode: List[int] = []
330 push = bytecode.append
331 lenAssembly = len(assembly)
332 pos = _skipWhite(assembly, 0)
333 while pos < lenAssembly:
334 m = _tokenRE.match(assembly, pos)
335 if m is None:
336 raise tt_instructions_error(
337 "Syntax error in TT program (%s)" % assembly[pos - 5 : pos + 15]
338 )
339 dummy, mnemonic, arg, number, comment = m.groups()
340 pos = m.regs[0][1]
341 if comment:
342 pos = _skipWhite(assembly, pos)
343 continue
345 arg = arg.strip()
346 if mnemonic.startswith("INSTR"):
347 # Unknown instruction
348 op = int(mnemonic[5:])
349 push(op)
350 elif mnemonic not in ("PUSH", "NPUSHB", "NPUSHW", "PUSHB", "PUSHW"):
351 op, argBits, name = mnemonicDict[mnemonic]
352 if len(arg) != argBits:
353 raise tt_instructions_error(
354 "Incorrect number of argument bits (%s[%s])" % (mnemonic, arg)
355 )
356 if arg:
357 arg = binary2num(arg)
358 push(op + arg)
359 else:
360 push(op)
361 else:
362 args = []
363 pos = _skipWhite(assembly, pos)
364 while pos < lenAssembly:
365 m = _tokenRE.match(assembly, pos)
366 if m is None:
367 raise tt_instructions_error(
368 "Syntax error in TT program (%s)" % assembly[pos : pos + 15]
369 )
370 dummy, _mnemonic, arg, number, comment = m.groups()
371 if number is None and comment is None:
372 break
373 pos = m.regs[0][1]
374 pos = _skipWhite(assembly, pos)
375 if comment is not None:
376 continue
377 args.append(int(number))
378 nArgs = len(args)
379 if mnemonic == "PUSH":
380 # Automatically choose the most compact representation
381 nWords = 0
382 while nArgs:
383 while (
384 nWords < nArgs
385 and nWords < 255
386 and not (0 <= args[nWords] <= 255)
387 ):
388 nWords += 1
389 nBytes = 0
390 while (
391 nWords + nBytes < nArgs
392 and nBytes < 255
393 and 0 <= args[nWords + nBytes] <= 255
394 ):
395 nBytes += 1
396 if (
397 nBytes < 2
398 and nWords + nBytes < 255
399 and nWords + nBytes != nArgs
400 ):
401 # Will write bytes as words
402 nWords += nBytes
403 continue
405 # Write words
406 if nWords:
407 if nWords <= 8:
408 op, argBits, name = streamMnemonicDict["PUSHW"]
409 op = op + nWords - 1
410 push(op)
411 else:
412 op, argBits, name = streamMnemonicDict["NPUSHW"]
413 push(op)
414 push(nWords)
415 for value in args[:nWords]:
416 assert -32768 <= value < 32768, (
417 "PUSH value out of range %d" % value
418 )
419 push((value >> 8) & 0xFF)
420 push(value & 0xFF)
422 # Write bytes
423 if nBytes:
424 pass
425 if nBytes <= 8:
426 op, argBits, name = streamMnemonicDict["PUSHB"]
427 op = op + nBytes - 1
428 push(op)
429 else:
430 op, argBits, name = streamMnemonicDict["NPUSHB"]
431 push(op)
432 push(nBytes)
433 for value in args[nWords : nWords + nBytes]:
434 push(value)
436 nTotal = nWords + nBytes
437 args = args[nTotal:]
438 nArgs -= nTotal
439 nWords = 0
440 else:
441 # Write exactly what we've been asked to
442 words = mnemonic[-1] == "W"
443 op, argBits, name = streamMnemonicDict[mnemonic]
444 if mnemonic[0] != "N":
445 assert nArgs <= 8, nArgs
446 op = op + nArgs - 1
447 push(op)
448 else:
449 assert nArgs < 256
450 push(op)
451 push(nArgs)
452 if words:
453 for value in args:
454 assert -32768 <= value < 32768, (
455 "PUSHW value out of range %d" % value
456 )
457 push((value >> 8) & 0xFF)
458 push(value & 0xFF)
459 else:
460 for value in args:
461 assert 0 <= value < 256, (
462 "PUSHB value out of range %d" % value
463 )
464 push(value)
466 pos = _skipWhite(assembly, pos)
468 if bytecode:
469 assert max(bytecode) < 256 and min(bytecode) >= 0
470 self.bytecode = array.array("B", bytecode)
472 def _disassemble(self, preserve=False) -> None:
473 assembly = []
474 i = 0
475 bytecode = getattr(self, "bytecode", [])
476 numBytecode = len(bytecode)
477 while i < numBytecode:
478 op = bytecode[i]
479 try:
480 mnemonic, argBits, argoffset, name = opcodeDict[op]
481 except KeyError:
482 if op in streamOpcodeDict:
483 values = []
485 # Merge consecutive PUSH operations
486 while bytecode[i] in streamOpcodeDict:
487 op = bytecode[i]
488 mnemonic, argBits, argoffset, name = streamOpcodeDict[op]
489 words = mnemonic[-1] == "W"
490 if argBits:
491 nValues = op - argoffset + 1
492 else:
493 i = i + 1
494 nValues = bytecode[i]
495 i = i + 1
496 assert nValues > 0
497 if not words:
498 for j in range(nValues):
499 value = bytecode[i]
500 values.append(repr(value))
501 i = i + 1
502 else:
503 for j in range(nValues):
504 # cast to signed int16
505 value = (bytecode[i] << 8) | bytecode[i + 1]
506 if value >= 0x8000:
507 value = value - 0x10000
508 values.append(repr(value))
509 i = i + 2
510 if preserve:
511 break
513 if not preserve:
514 mnemonic = "PUSH"
515 nValues = len(values)
516 if nValues == 1:
517 assembly.append("%s[ ] /* 1 value pushed */" % mnemonic)
518 else:
519 assembly.append(
520 "%s[ ] /* %s values pushed */" % (mnemonic, nValues)
521 )
522 assembly.extend(values)
523 else:
524 assembly.append("INSTR%d[ ]" % op)
525 i = i + 1
526 else:
527 if argBits:
528 assembly.append(
529 mnemonic
530 + "[%s] /* %s */" % (num2binary(op - argoffset, argBits), name)
531 )
532 else:
533 assembly.append(mnemonic + "[ ] /* %s */" % name)
534 i = i + 1
535 self.assembly = assembly
537 def __bool__(self) -> bool:
538 """
539 >>> p = Program()
540 >>> bool(p)
541 False
542 >>> bc = array.array("B", [0])
543 >>> p.fromBytecode(bc)
544 >>> bool(p)
545 True
546 >>> p.bytecode.pop()
547 0
548 >>> bool(p)
549 False
551 >>> p = Program()
552 >>> asm = ['SVTCA[0]']
553 >>> p.fromAssembly(asm)
554 >>> bool(p)
555 True
556 >>> p.assembly.pop()
557 'SVTCA[0]'
558 >>> bool(p)
559 False
560 """
561 return (hasattr(self, "assembly") and len(self.assembly) > 0) or (
562 hasattr(self, "bytecode") and len(self.bytecode) > 0
563 )
565 __nonzero__ = __bool__
567 def __eq__(self, other) -> bool:
568 if type(self) != type(other):
569 return NotImplemented
570 return self.__dict__ == other.__dict__
572 def __ne__(self, other) -> bool:
573 result = self.__eq__(other)
574 return result if result is NotImplemented else not result
577def _test():
578 """
579 >>> _test()
580 True
581 """
583 bc = b"""@;:9876543210/.-,+*)(\'&%$#"! \037\036\035\034\033\032\031\030\027\026\025\024\023\022\021\020\017\016\015\014\013\012\011\010\007\006\005\004\003\002\001\000,\001\260\030CXEj\260\031C`\260F#D#\020 \260FN\360M/\260\000\022\033!#\0213Y-,\001\260\030CX\260\005+\260\000\023K\260\024PX\261\000@8Y\260\006+\033!#\0213Y-,\001\260\030CXN\260\003%\020\362!\260\000\022M\033 E\260\004%\260\004%#Jad\260(RX!#\020\326\033\260\003%\020\362!\260\000\022YY-,\260\032CX!!\033\260\002%\260\002%I\260\003%\260\003%Ja d\260\020PX!!!\033\260\003%\260\003%I\260\000PX\260\000PX\270\377\3428!\033\260\0208!Y\033\260\000RX\260\0368!\033\270\377\3608!YYYY-,\001\260\030CX\260\005+\260\000\023K\260\024PX\271\000\000\377\3008Y\260\006+\033!#\0213Y-,N\001\212\020\261F\031CD\260\000\024\261\000F\342\260\000\025\271\000\000\377\3608\000\260\000<\260(+\260\002%\020\260\000<-,\001\030\260\000/\260\001\024\362\260\001\023\260\001\025M\260\000\022-,\001\260\030CX\260\005+\260\000\023\271\000\000\377\3408\260\006+\033!#\0213Y-,\001\260\030CXEdj#Edi\260\031Cd``\260F#D#\020 \260F\360/\260\000\022\033!! \212 \212RX\0213\033!!YY-,\001\261\013\012C#Ce\012-,\000\261\012\013C#C\013-,\000\260F#p\261\001F>\001\260F#p\261\002FE:\261\002\000\010\015-,\260\022+\260\002%E\260\002%Ej\260@\213`\260\002%#D!!!-,\260\023+\260\002%E\260\002%Ej\270\377\300\214`\260\002%#D!!!-,\260\000\260\022+!!!-,\260\000\260\023+!!!-,\001\260\006C\260\007Ce\012-, i\260@a\260\000\213 \261,\300\212\214\270\020\000b`+\014d#da\\X\260\003aY-,\261\000\003%EhT\260\034KPZX\260\003%E\260\003%E`h \260\004%#D\260\004%#D\033\260\003% Eh \212#D\260\003%Eh`\260\003%#DY-,\260\003% Eh \212#D\260\003%Edhe`\260\004%\260\001`#D-,\260\011CX\207!\300\033\260\022CX\207E\260\021+\260G#D\260Gz\344\033\003\212E\030i \260G#D\212\212\207 \260\240QX\260\021+\260G#D\260Gz\344\033!\260Gz\344YYY\030-, \212E#Eh`D-,EjB-,\001\030/-,\001\260\030CX\260\004%\260\004%Id#Edi\260@\213a \260\200bj\260\002%\260\002%a\214\260\031C`\260F#D!\212\020\260F\366!\033!!!!Y-,\001\260\030CX\260\002%E\260\002%Ed`j\260\003%Eja \260\004%Ej \212\213e\260\004%#D\214\260\003%#D!!\033 EjD EjDY-,\001 E\260\000U\260\030CZXEh#Ei\260@\213a \260\200bj \212#a \260\003%\213e\260\004%#D\214\260\003%#D!!\033!!\260\031+Y-,\001\212\212Ed#EdadB-,\260\004%\260\004%\260\031+\260\030CX\260\004%\260\004%\260\003%\260\033+\001\260\002%C\260@T\260\002%C\260\000TZX\260\003% E\260@aDY\260\002%C\260\000T\260\002%C\260@TZX\260\004% E\260@`DYY!!!!-,\001KRXC\260\002%E#aD\033!!Y-,\001KRXC\260\002%E#`D\033!!Y-,KRXED\033!!Y-,\001 \260\003%#I\260@`\260 c \260\000RX#\260\002%8#\260\002%e8\000\212c8\033!!!!!Y\001-,KPXED\033!!Y-,\001\260\005%\020# \212\365\000\260\001`#\355\354-,\001\260\005%\020# \212\365\000\260\001a#\355\354-,\001\260\006%\020\365\000\355\354-,F#F`\212\212F# F\212`\212a\270\377\200b# \020#\212\261KK\212pE` \260\000PX\260\001a\270\377\272\213\033\260F\214Y\260\020`h\001:-, E\260\003%FRX\260\002%F ha\260\003%\260\003%?#!8\033!\021Y-, E\260\003%FPX\260\002%F ha\260\003%\260\003%?#!8\033!\021Y-,\000\260\007C\260\006C\013-,\212\020\354-,\260\014CX!\033 F\260\000RX\270\377\3608\033\260\0208YY-, \260\000UX\270\020\000c\260\003%Ed\260\003%Eda\260\000SX\260\002\033\260@a\260\003Y%EiSXED\033!!Y\033!\260\002%E\260\002%Ead\260(QXED\033!!YY-,!!\014d#d\213\270@\000b-,!\260\200QX\014d#d\213\270 \000b\033\262\000@/+Y\260\002`-,!\260\300QX\014d#d\213\270\025Ub\033\262\000\200/+Y\260\002`-,\014d#d\213\270@\000b`#!-,KSX\260\004%\260\004%Id#Edi\260@\213a \260\200bj\260\002%\260\002%a\214\260F#D!\212\020\260F\366!\033!\212\021#\022 9/Y-,\260\002%\260\002%Id\260\300TX\270\377\3708\260\0108\033!!Y-,\260\023CX\003\033\002Y-,\260\023CX\002\033\003Y-,\260\012+#\020 <\260\027+-,\260\002%\270\377\3608\260(+\212\020# \320#\260\020+\260\005CX\300\033<Y \020\021\260\000\022\001-,KS#KQZX8\033!!Y-,\001\260\002%\020\320#\311\001\260\001\023\260\000\024\020\260\001<\260\001\026-,\001\260\000\023\260\001\260\003%I\260\003\0278\260\001\023-,KS#KQZX E\212`D\033!!Y-, 9/-"""
585 p = Program()
586 p.fromBytecode(bc)
587 asm = p.getAssembly(preserve=True)
588 p.fromAssembly(asm)
589 print(bc == p.getBytecode())
592if __name__ == "__main__":
593 import sys
594 import doctest
596 sys.exit(doctest.testmod().failed)