summaryrefslogtreecommitdiffstats
path: root/awlsim/fupcompiler/elem.py
blob: 5d44bad318c509205b7aead6a86642d8cd1da08f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
# -*- coding: utf-8 -*-
#
# AWL simulator - FUP compiler - Element
#
# Copyright 2016-2017 Michael Buesch <m@bues.ch>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#

from __future__ import division, absolute_import, print_function, unicode_literals
from awlsim.common.compat import *

from awlsim.common.xmlfactory import *
from awlsim.common.util import *

from awlsim.fupcompiler.base import *
from awlsim.fupcompiler.conn import *

from awlsim.awlcompiler.optrans import *

from awlsim.core.instructions.all_insns import * #+cimport


class FupCompiler_ElemFactory(XmlFactory):
	CONTAINER_TAG	= "elements"

	def parser_open(self, tag=None):
		self.inElem = False
		self.elem = None
		self.subelemsFakeGrid = None
		XmlFactory.parser_open(self, tag)

	def parser_beginTag(self, tag):
		if self.inElem:
			if self.elem and tag.name == "connections":
				self.parser_switchTo(FupCompiler_Conn.factory(elem=self.elem))
				return
			if self.elem and tag.name == "subelements":
				from awlsim.fupcompiler.grid import FupCompiler_Grid
				if self.subelemsFakeGrid:
					raise self.Error("Found multiple <subelements> tags "
						"inside of boolean <element>.")
				self.subelemsFakeGrid = FupCompiler_Grid(None)
				self.parser_switchTo(FupCompiler_Elem.factory(grid=self.subelemsFakeGrid,
									      CONTAINER_TAG="subelements"))
				return
		else:
			if tag.name == "element":
				self.inElem = True
				x = tag.getAttrInt("x")
				y = tag.getAttrInt("y")
				elemType = tag.getAttr("type")
				subType = tag.getAttr("subtype", None)
				content = tag.getAttr("content", None)
				uuid = tag.getAttr("uuid", None)
				self.elem = FupCompiler_Elem.parse(self.grid,
					x, y, elemType, subType, content, uuid)
				if not self.elem:
					raise self.Error("Failed to parse element "
						"type '%s'%s at x=%d y=%d" % (
						elemType,
						"" if subType is None else (" subtype '%s'" % subType),
						x, y))
				return
		XmlFactory.parser_beginTag(self, tag)

	def parser_endTag(self, tag):
		if self.inElem:
			if tag.name == "element":
				if self.elem:
					if self.subelemsFakeGrid and\
					   self.subelemsFakeGrid.elems:
						self.elem.subElems = self.subelemsFakeGrid.elems.copy()
						for e in self.elem.subElems:
							e.grid = self.grid
						self.subelemsFakeGrid = None
					self.grid.addElem(self.elem)
				self.inElem = False
				self.elem = None
				return
		else:
			if tag.name == self.CONTAINER_TAG:
				self.parser_finish()
				return
		XmlFactory.parser_endTag(self, tag)

class FupCompiler_Elem(FupCompiler_BaseObj):
	factory = FupCompiler_ElemFactory

	ELEM_NAME = "FUP-element"

	EnumGen.start
	TYPE_BOOLEAN		= EnumGen.item
	TYPE_OPERAND		= EnumGen.item
	TYPE_MOVE		= EnumGen.item
	TYPE_ARITH		= EnumGen.item
	TYPE_SHIFT		= EnumGen.item
	TYPE_CMP		= EnumGen.item
	TYPE_COMMENT		= EnumGen.item
	TYPE_AWL		= EnumGen.item
	EnumGen.end

	str2type = {
		"boolean"	: TYPE_BOOLEAN,
		"operand"	: TYPE_OPERAND,
		"move"		: TYPE_MOVE,
		"arithmetic"	: TYPE_ARITH,
		"shift"		: TYPE_SHIFT,
		"compare"	: TYPE_CMP,
		"comment"	: TYPE_COMMENT,
		"awl"		: TYPE_AWL,
	}

	DUMP_SHOW_CONTENT = True

	@classmethod
	def sorted(cls, elems):
		"""Sort all elements from 'elems' sequence in ascending order by Y position.
		The Y position in the diagram is the basic evaluation order.
		Also sort by X position as a secondary key.
		The sorted list is returned.
		"""
		elems = tuple(elems)
		try:
			yShift = max(e.x for e in elems).bit_length()
		except ValueError:
			return []
		return sorted(elems,
			      key=lambda e: (e.y << yShift) + e.x)

	@classmethod
	def parse(cls, grid, x, y, elemType, subType, content, uuid):
		from awlsim.fupcompiler.elembool import FupCompiler_ElemBool
		from awlsim.fupcompiler.elemoper import FupCompiler_ElemOper
		from awlsim.fupcompiler.elemmove import FupCompiler_ElemMove
		from awlsim.fupcompiler.elemarith import FupCompiler_ElemArith
		from awlsim.fupcompiler.elemshift import FupCompiler_ElemShift
		from awlsim.fupcompiler.elemcmp import FupCompiler_ElemCmp
		from awlsim.fupcompiler.elemcomment import FupCompiler_ElemComment
		from awlsim.fupcompiler.elemawl import FupCompiler_ElemAWL
		try:
			elemType = cls.str2type[elemType]
			type2class = {
				cls.TYPE_BOOLEAN	: FupCompiler_ElemBool,
				cls.TYPE_OPERAND	: FupCompiler_ElemOper,
				cls.TYPE_MOVE		: FupCompiler_ElemMove,
				cls.TYPE_ARITH		: FupCompiler_ElemArith,
				cls.TYPE_SHIFT		: FupCompiler_ElemShift,
				cls.TYPE_CMP		: FupCompiler_ElemCmp,
				cls.TYPE_COMMENT	: FupCompiler_ElemComment,
				cls.TYPE_AWL		: FupCompiler_ElemAWL,
			}
			elemClass = None
			with contextlib.suppress(KeyError):
				elemClass = type2class[elemType]
			if elemClass:
				elem = elemClass.parse(grid=grid,
						       x=x, y=y,
						       subType=subType,
						       content=content)
				elem.uuid = uuid
				return elem
		except KeyError:
			pass
		return None

	def __init__(self, grid, x, y, elemType, subType, content, virtual=False, uuid=None):
		FupCompiler_BaseObj.__init__(self, uuid=uuid)
		self.grid = grid			# FupCompiler_Grid
		self.x = x				# X coordinate
		self.y = y				# Y coordinate
		self.elemType = elemType		# TYPE_...
		self.subType = subType			# SUBTYPE_... or None
		self.content = content or ""		# content string
		self.connections = set()		# FupCompiler_Conn
		self.virtual = bool(virtual)		# Flag: Virtual element
		self.subElems = set()			# Set of sub-elements (if any)

		# This dict contains the values of the connections,
		# if this element has already been compiled.
		# Dict key is FupCompiler_Conn and value is the TEMP var name string.
		self.__tempVarNames = {}

		if virtual:
			self.forceCompileState(self.COMPILE_PREPROCESSED)

	@property
	def compiler(self):
		if self.grid:
			return self.grid.compiler
		return None

	def isType(self, elemType, subType=None):
		"""Check the TYPE and SUBTYPE of this element.
		If 'subType' is None, the subType is not checked.
		Both elemType or subType may be iterables. In this case
		all types from the iterable are allowed.
		True is returned, if the types match.
		"""
		elemTypes = toList(elemType)
		if subType is None:
			return self.elemType in elemTypes
		subTypes = toList(subType)
		return self.elemType in elemTypes and\
		       self.subType in subTypes

	@property
	def opTrans(self):
		return self.grid.compiler.opTrans

	def addConn(self, conn):
		self.connections.add(conn)
		return True

	@property
	def inConnections(self):
		"""Get all input connections.
		"""
		for conn in self.connections:
			if conn.dirIn:
				yield conn

	@property
	def outConnections(self):
		"""Get all output connections.
		"""
		for conn in self.connections:
			if conn.dirOut:
				yield conn

	def connIsOptional(self, conn):
		"""Check if a connection is optional.
		The default implementation always returns False.
		"""
		return False

	def getConnType(self, conn, preferVKE=False):
		"""Get the type of a connection.
		The default implementation always returns VKE based type.
		"""
		return FupCompiler_Conn.TYPE_VKE

	def getConnByText(self, connText,
			  searchInputs=False, searchOutputs=False,
			  caseSensitive=False):
		"""Get connections by name.
		Search in inputs, if 'searchInputs' is True.
		Search in outputs, if 'searchOutputs' is True.
		Returns a generator over the found connections.
		"""
		for conn in self.connections:
			if not strEqual(connText, conn.text, caseSensitive):
				continue
			if searchInputs and conn.dirIn:
				yield conn
			if searchOutputs and conn.dirOut:
				yield conn

	def getUniqueConnByText(self, connText,
				searchInputs=False, searchOutputs=False,
				caseSensitive=False):
		"""Get a unique connection by name.
		Search in inputs, if 'searchInputs' is True.
		Search in outputs, if 'searchOutputs' is True.
		This raises FupElemError, if the connection is not unique.
		Returns the FupCompiler_Conn() or None if not found.
		"""
		connections = list(self.getConnByText(connText,
						      searchInputs,
						      searchOutputs,
						      caseSensitive))
		if len(connections) <= 0:
			return None
		if len(connections) > 1:
			raise FupElemError("The element '%s' "
				"has multiple connections with the "
				"same name '%s'." % (
				str(self), connText),
				self)
		return connections[0]

	MAIN_RESULT = 42

	def _storeToTemp(self, dataTypeName, insnClass, connections):
		"""Store a value from ACCU or VKE to TEMP.
		dataTypeName: The name string of the TEMP field data type.
		insnClass: The AWL instruction class to store the value.
		connections: An iterable of connections this value belongs to.
			     The iterable may contain the special value MAIN_RESULT.
		"""
		insns = []

		if connections:
			varName = self.grid.compiler.interf.allocTEMP(dataTypeName,
								      elem=self)
			opDesc = self.opTrans.translateFromString("#" + varName)
			insns.append(self.newInsn(insnClass,
						  ops=[opDesc.operator]))
			for conn in connections:
				self.__tempVarNames[conn] = varName

		return insns

	def _loadFromTemp(self, insnClass, conn=MAIN_RESULT):
		"""Get a value associated with a connection from TEMP.
		insnClass: The AWL instruction class to fetch the value.
		conn: The connection to get the value for.
		      If conn is MAIN_RESULT the main value of the element is fetched.
		"""
		insns = []

		# otherElem has already been compiled and the result has
		# been stored in TEMP. Use the stored result.
		assert(not self.needCompile)
		try:
			varName = self.__tempVarNames[conn]
		except KeyError as e:
			if conn and conn != self.MAIN_RESULT and conn.text:
				connText = "The output %s" % conn.text
			else:
				connText = "The result"
			raise FupElemError("%s of the "
				"compiled element %s has not been stored "
				"to a TEMP variable." % (
				connText, str(self)),
				self)
		opDesc = self.opTrans.translateFromString("#" + varName)
		insns.append(self.newInsn(insnClass, ops=[opDesc.operator]))

		return insns

	def compileConn(self, conn, desiredTarget, inverted=False):
		"""Compile this element
		and get the value corresponding to the given connection.
		The desiredTarget is one of FupCompiler_Conn.TARGET_...
		If 'inverted' is True, the result will be stored inverted.
		Inversion is only possible for VKE based targets.
		The default implementation raises an exception.
		Override this method, if required.
		"""
		raise FupElemError("It is not known how to "
			"compile the connection %s of element %s. "
			"That probably means it's not allowed to "
			"connect these FUP elements in this way." % (
			str(conn), str(self)),
			self)

	def _compileConn_checkTarget(self, conn, desiredTarget, inverted,
				     targetExpectVKE=False,
				     allowInversion=False):
		"""compileConn() helper to check whether the target matches expectations.
		targetExpectVKE: True, if desiredTarget must be a VKE based target.
		allowInversion: True, if 'inverted=True' is allowed.
		"""
		targetIsVKE = FupCompiler_Conn.targetIsVKE(desiredTarget)
		if targetIsVKE != targetExpectVKE:
			raise FupElemError("The %s %s "
				"of FUP element %s must only be connected "
				"to %s %s." % (
				str(conn),
				"input" if conn.dirIn else "output",
				str(self),
				"boolean" if targetExpectVKE else "non-boolean",
				"outputs" if conn.dirIn else "inputs"),
				self)
		if not allowInversion and inverted:
			raise FupElemError("Inversion is not allowed on %s %s "
				"of FUP element %s." % (
				str(conn),
				"input" if conn.dirIn else "output",
				str(self)),
				self)

	def _doPreprocess(self):
		"""Element preprocessor.
		Defaults to no preprocessing.
		Override this method, if required.
		"""
		pass

	def _doCompile(self):
		"""Element compiler.
		Override this.
		"""
		raise NotImplementedError

	def preprocess(self):
		"""Main element preprocessor entry point.
		Do not override this. Override _doPreprocess instead.
		"""
		self.compileState = self.COMPILE_PREPROCESSING

		# Preprocess the elements connected to the in-connections first.
		for conn in self.inConnections:
			for elem in conn.getConnectedElems(viaOut=True):
				if elem.needPreprocess:
					elem.preprocess()

		# Preprocess this element
		self._doPreprocess()

		self.compileState = self.COMPILE_PREPROCESSED

	def compile(self):
		"""Main element compiler entry point.
		Do not override this. Override _doCompile instead.
		"""
		self.compileState = self.COMPILE_RUNNING
		result = self._doCompile()
		self.compileState = self.COMPILE_DONE
		return result

	def newInsn(self, *args, **kwargs):
		"""Wrapper: Call the compiler method to create an instruction.
		"""
		return self.grid.compiler.newInsn(self, *args, **kwargs)

	def newInsn_INLINEAWL(self, *args, **kwargs):
		"""Wrapper: Call the compiler method to create a INLINE-AWL pseudo instruction.
		"""
		return self.grid.compiler.newInsn_INLINEAWL(self, *args, **kwargs)

	def newInsn_JMP(self, *args, **kwargs):
		"""Wrapper: Call the compiler method to create a jump instruction.
		"""
		return self.grid.compiler.newInsn_JMP(self, *args, **kwargs)

	def newInsn_NOP(self, *args, **kwargs):
		"""Wrapper: Call the compiler method to create a NOP instruction.
		"""
		return self.grid.compiler.newInsn_NOP(self, *args, **kwargs)

	def newInsn_LOAD_BIE(self, *args, **kwargs):
		"""Wrapper: Call the compiler method to create a BIE load instruction.
		"""
		return self.grid.compiler.newInsn_LOAD_BIE(self, *args, **kwargs)

	def newInsn_L_STW(self, *args, **kwargs):
		"""Wrapper: Call the compiler method to create a L STW instruction.
		"""
		return self.grid.compiler.newInsn_L_STW(self, *args, **kwargs)

	def newInsn_T_STW(self, *args, **kwargs):
		"""Wrapper: Call the compiler method to create a T STW instruction.
		"""
		return self.grid.compiler.newInsn_T_STW(self, *args, **kwargs)

	def newInsn_SRD(self, *args, **kwargs):
		"""Wrapper: Call the compiler method to create a SRD instruction.
		"""
		return self.grid.compiler.newInsn_SRD(self, *args, **kwargs)

	def __repr__(self):
		return "FupCompiler_Elem(grid, x=%d, y=%d, elemType=%d, "\
			"subType=%s, content=\"%s\", virtual=%s)" % (
			self.x, self.y, self.elemType,
			str(self.subType), self.content,
			str(self.virtual))

	def toStr(self, extra=()):
		values = []
		if self.x >= 0 and self.y >= 0:
			values.append("x%d/y%d" % (
				self.x + 1,
				self.y + 1))
		if self.virtual:
			values.append("VIRTUAL")
		if self.DUMP_SHOW_CONTENT and self.content.strip():
			content = self.content.strip().replace('\n', ' ').replace('\r', '')
			values.append("'%s'" % content)
		values.append(shortUUID(self.uuid))
		values.extend(extra)
		return "%s(%s)" % (self.ELEM_NAME, ", ".join(values))

	def __str__(self):
		return self.toStr()
bues.ch cgit interface