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