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