aboutsummaryrefslogtreecommitdiffstats
path: root/awlsim/gui/fup/fup_elembool.py
blob: de92174d24ec2f975b79d723ee66e5503769c2f0 (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
# -*- coding: utf-8 -*-
#
# AWL simulator - FUP - Boolean element classes
#
# 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.gui.fup.fup_base import *
from awlsim.gui.fup.fup_elem import *
from awlsim.gui.fup.fup_elemoperand import *


class FupElem_BOOLEAN_factory(FupElem_factory):
	def parser_open(self, tag):
		assert(tag)
		x = tag.getAttrInt("x")
		y = tag.getAttrInt("y")
		subType = tag.getAttr("subtype")
		uuid = tag.getAttr("uuid", None)
		elemClass = {
			FupElem_AND.OP_SYM_NAME	: FupElem_AND,
			FupElem_OR.OP_SYM_NAME	: FupElem_OR,
			FupElem_XOR.OP_SYM_NAME	: FupElem_XOR,
			FupElem_S.OP_SYM_NAME	: FupElem_S,
			FupElem_R.OP_SYM_NAME	: FupElem_R,
			FupElem_SR.OP_SYM_NAME	: FupElem_SR,
			FupElem_RS.OP_SYM_NAME	: FupElem_RS,
			FupElem_FP.OP_SYM_NAME	: FupElem_FP,
			FupElem_FN.OP_SYM_NAME	: FupElem_FN,
		}.get(subType)
		if not elemClass:
			raise self.Error("Boolean subtype '%s' is not known "
				"to the element parser." % (
				subType))
		self.elem = elemClass(
			x=x, y=y, nrInputs=0, uuid=uuid)
		self.elem.grid = self.grid
		self.subelemsFakeGrid = None
		XmlFactory.parser_open(self, tag)

	def parser_beginTag(self, tag):
		if tag.name == "connections":
			self.parser_switchTo(FupConn.factory(elem=self.elem))
			return
		if tag.name == "subelements":
			from awlsim.gui.fup.fup_grid import FupGridStub
			if self.subelemsFakeGrid:
				raise self.Error("Found multiple <subelements> tags "
					"inside of boolean <element>.")
			self.subelemsFakeGrid = FupGridStub()
			self.parser_switchTo(FupElem.factory(grid=self.subelemsFakeGrid,
							     CONTAINER_TAG="subelements"))
			return
		XmlFactory.parser_beginTag(self, tag)

	def parser_endTag(self, tag):
		if tag.name == "element":
			# Add body element
			if self.elem.WITH_BODY_OPERATOR:
				subelements = self.subelemsFakeGrid.elements
				if subelements:
					if len(subelements) != 1 or\
					   not isinstance(subelements[0], FupElem_EmbeddedOper):
						raise self.Error("Only one subelement of type "
							"'embedded operand' supported in "
							"boolean <element>.")
					del self.elem.bodyOper
					self.elem.bodyOper = subelements[0]
					self.elem.bodyOper.parentElem = self.elem
					del self.elem.bodyOper.grid
			else:
				if self.subelemsFakeGrid:
					raise self.Error("<subelements> is not "
						"supported for %s." % (
						str(self.elem)))
			# Insert the element into the grid.
			if not self.grid.placeElem(self.elem):
				raise self.Error("<element> caused "
					"a grid collision.")
			self.parser_finish()
			return
		XmlFactory.parser_endTag(self, tag)

	def composer_getTags(self):
		elem = self.elem

		connTags = []
		for inp in elem.inputs:
			connTags.extend(inp.factory(conn=inp).composer_getTags())
		for out in elem.outputs:
			connTags.extend(out.factory(conn=out).composer_getTags())

		subElemTags = []
		if elem.WITH_BODY_OPERATOR:
			bodyOper = elem.bodyOper
			subElemTags.extend(bodyOper.factory(elem=bodyOper).composer_getTags())

		return [
			self.Tag(name="element",
				attrs={
					"type" : "boolean",
					"subtype" : elem.OP_SYM_NAME,
					"x" : str(elem.x),
					"y" : str(elem.y),
					"uuid" : str(elem.uuid),
				},
				tags=[
					self.Tag(name="connections",
						 tags=connTags),
					self.Tag(name="subelements",
						 tags=subElemTags),
				])
		]

class FupElem_BOOLEAN(FupElem):
	"""Boolean FUP/FBD element base class"""

	factory			= FupElem_BOOLEAN_factory

	FIXED_INPUTS		= None
	FIXED_OUTPUTS		= [ "Q", ]
	WITH_BODY_OPERATOR	= False
	OPTIONAL_CONNS		= set()
	BLANK_CONNS		= { "Q", }

	def __init__(self, x, y, nrInputs=2, uuid=None):
		FupElem.__init__(self, x, y, uuid=uuid)

		if self.FIXED_INPUTS is None:
			self.inputs = [ FupConnIn(self)
					for i in range(nrInputs) ]
		else:
			self.inputs = [ FupConnIn(self, text=text)
					for text in self.FIXED_INPUTS ]

		if self.FIXED_OUTPUTS is None:
			self.outputs = []
		else:
			self.outputs = [ FupConnOut(self, text=text)
					 for text in self.FIXED_OUTPUTS ]

		if self.WITH_BODY_OPERATOR:
			self.bodyOper = FupElem_EmbeddedOper(parentElem=self)

	# Overridden method. For documentation see base class.
	def insertConn(self, beforeIndex, conn):
		if conn and conn.OUT:
			return False
		return FupElem.insertConn(self, beforeIndex, conn)

	# Overridden method. For documentation see base class.
	def addConn(self, conn):
		if conn and conn.OUT:
			return False
		return FupElem.addConn(self, conn)

	# Overridden method. For documentation see base class.
	def getAreaViaPixCoord(self, pixelX, pixelY):
		if self.grid:
			cellWidth = self.grid.cellPixWidth
			cellHeight = self.grid.cellPixHeight
			totalWidth = cellWidth
			totalHeight = cellHeight * self.height
			xpad, ypad = self._xpadding, self._ypadding
			if self.WITH_BODY_OPERATOR:
				if pixelY >= ypad and pixelY < cellHeight and\
				   pixelX >= xpad and pixelX < cellWidth - xpad:
					return self.AREA_BODYOPER, 0
				yInBodyRange = pixelY >= cellHeight + ypad and\
					       pixelY < totalHeight - ypad
			else:
				yInBodyRange = pixelY >= ypad and\
					       pixelY < totalHeight - ypad
			if yInBodyRange:
				if pixelX < xpad:
					# inputs
					idx = pixelY // cellHeight
					if self.WITH_BODY_OPERATOR:
						idx -= 1
					return self.AREA_INPUT, idx
				elif pixelX >= totalWidth - xpad:
					# outputs
					if pixelY >= totalHeight - cellHeight:
						return self.AREA_OUTPUT, 0
				else:
					# body
					return self.AREA_BODY, 0
		return self.AREA_NONE, 0

	# Overridden method. For documentation see base class.
	def getConnRelCoords(self, conn):
		x, y = 0, -1
		if conn.IN:
			y = self.inputs.index(conn)
			if self.WITH_BODY_OPERATOR and y >= 0:
				y += 1
		elif conn.OUT:
			y = self.outputs.index(conn)
			if y >= 0:
				y = self.height - 1
		if x >= 0 and y >= 0:
			return x, y
		return FupElem.getConnRelCoords(self, conn)

	# Overridden method. For documentation see base class.
	@property
	def height(self):
		return len(self.inputs) +\
			(1 if self.WITH_BODY_OPERATOR else 0)

	# Overridden method. For documentation see base class.
	def draw(self, painter):
		grid = self.grid
		if not grid:
			return
		cellWidth = grid.cellPixWidth
		cellHeight = grid.cellPixHeight
		xpad, ypad = self._xpadding, self._ypadding
		elemHeight = cellHeight * self.height
		elemWidth = cellWidth
		selected = self.selected
		notR = int(round(3 * grid.zoom))
		notD = notR * 2

		# Draw body
		painter.setPen(self._outlineSelPen if selected
			       else self._outlinePen)
		painter.setBrush(self._bgSelBrush if selected
				 else self._bgBrush)
		(tlX, tlY), (trX, trY), (blX, blY), (brX, brY) = self._calcBodyBox()
		if self.WITH_BODY_OPERATOR:
			offset = cellHeight
		else:
			offset = 0
		painter.drawRoundedRect(tlX, tlY + offset,
					trX - tlX, blY - (tlY + offset),
					self.BODY_CORNER_RADIUS,
					self.BODY_CORNER_RADIUS)

		# Draw inputs
		painter.setBrush(self._bgSelBrush if selected
				 else self._bgBrush)
		painter.setFont(self.getFont(8))
		for i, conn in enumerate(self.inputs):
			cellIdx = i
			if self.WITH_BODY_OPERATOR:
				cellIdx += 1

			connPen = self._connPen\
				if (conn.isConnected or conn.text in self.OPTIONAL_CONNS)\
				else self._connOpenPen

			x = conn.drawOffset
			y = (cellIdx * cellHeight) + (cellHeight // 2)
			painter.setPen(connPen)
			painter.drawLine(x, y, xpad, y)
			if conn.inverted:
				painter.setPen(self._connInvSelPen
					       if selected else
					       self._connInvPen)
				painter.drawEllipse(xpad - notD, y - notR,
						    notD, notD)
			if conn.text and conn.text not in self.BLANK_CONNS:
				painter.setPen(connPen)
				x = xpad + 2
				y = (cellIdx * cellHeight)
				painter.drawText(x, y,
						 elemWidth - xpad - 2, cellHeight,
						 Qt.AlignLeft | Qt.AlignVCenter,
						 conn.text)

		# Draw output
		if self.outputs:
			assert(len(self.outputs) == 1)
			conn = self.outputs[0]

			connPen = self._connPen\
				if (conn.isConnected or conn.text in self.OPTIONAL_CONNS)\
				else self._connOpenPen

			x = cellWidth - conn.drawOffset
			y = elemHeight - (cellHeight // 2)
			painter.setPen(connPen)
			painter.setBrush(self._bgSelBrush if selected
					 else self._bgBrush)
			painter.drawLine(cellWidth - xpad, y,
					 x, y)
			if conn.inverted:
				painter.setPen(self._connInvSelPen
					       if selected else
					       self._connInvPen)
				painter.drawEllipse(cellWidth - xpad, y - notR,
						    notD, notD)
			if conn.text and conn.text not in self.BLANK_CONNS:
				painter.setPen(connPen)
				painter.setFont(self.getFont(8))
				x = 0
				y = elemHeight - cellHeight
				painter.drawText(x, y,
						 elemWidth - xpad - 2, cellHeight,
						 Qt.AlignRight | Qt.AlignVCenter,
						 conn.text)

		# Draw symbol text
		painter.setPen(self._outlineSelPen if selected
			       else self._outlinePen)
		painter.setBrush(self._bgSelBrush if selected
				 else self._bgBrush)
		painter.setFont(self.getFont(12, bold=True))
		if self.WITH_BODY_OPERATOR:
			y, h = cellHeight, elemHeight - cellHeight
		else:
			y, h = 0, elemHeight
		painter.drawText(0, y,
				 elemWidth, h,
				 Qt.AlignVCenter | Qt.AlignHCenter,
				 self.OP_SYM)

		# Draw body operator
		if self.WITH_BODY_OPERATOR:
			self.bodyOper.draw(painter)

	# Overridden method. For documentation see base class.
	def edit(self, parentWidget):
		if self.WITH_BODY_OPERATOR:
			return self.bodyOper.edit(parentWidget)
		return False

	# Overridden method. For documentation see base class.
	def expand(self, expand=True, area=None):
		if self.WITH_BODY_OPERATOR and\
		   (not expand or area == self.AREA_BODYOPER):
			changed = self.bodyOper.expand(expand)
			self.expanded = self.bodyOper.expanded
			return changed
		return False

	# Overridden method. For documentation see base class.
	def prepareContextMenu(self, menu, area=None, conn=None):
		if self.WITH_BODY_OPERATOR:
			menu.enableEdit(True)
		menu.enableInvertConn(True)
		menu.enableAddInput(self.FIXED_INPUTS is None)
		menu.enableRemoveConn(conn is not None and conn.IN and len(self.inputs) > 1)
		menu.enableDisconnWire(conn is not None and conn.isConnected)

	# Overridden method. For documentation see base class.
	def setConnInverted(self, conn, inverted=True):
		if conn in self.inputs or conn in self.outputs:
			conn.inverted = inverted
			return True
		return False

class FupElem_AND(FupElem_BOOLEAN):
	"""AND FUP/FBD element"""

	OP_SYM			= "&"
	OP_SYM_NAME		= "and"	# XML ABI name

class FupElem_OR(FupElem_BOOLEAN):
	"""OR FUP/FBD element"""

	OP_SYM			= ">=1"
	OP_SYM_NAME		= "or"	# XML ABI name

class FupElem_XOR(FupElem_BOOLEAN):
	"""XOR FUP/FBD element"""

	OP_SYM			= "X"
	OP_SYM_NAME		= "xor"	# XML ABI name

class FupElem_S(FupElem_BOOLEAN):
	"""SET FUP/FBD element"""

	OP_SYM			= "S"
	OP_SYM_NAME		= "s" # XML ABI name

	FIXED_INPUTS		= [ "S", ]
	FIXED_OUTPUTS		= [ "Q", ]
	WITH_BODY_OPERATOR	= True
	OPTIONAL_CONNS		= { "Q", }
	BLANK_CONNS		= { "S", "Q", }

class FupElem_R(FupElem_BOOLEAN):
	"""RESET FUP/FBD element"""

	OP_SYM			= "R"
	OP_SYM_NAME		= "r" # XML ABI name

	FIXED_INPUTS		= [ "R", ]
	FIXED_OUTPUTS		= [ "Q", ]
	WITH_BODY_OPERATOR	= True
	OPTIONAL_CONNS		= { "Q", }
	BLANK_CONNS		= { "R", "Q", }

class FupElem_SR(FupElem_BOOLEAN):
	"""SR flip-flop FUP/FBD element"""

	OP_SYM			= "SR"
	OP_SYM_NAME		= "sr" # XML ABI name

	FIXED_INPUTS		= [ "S", "R", ]
	FIXED_OUTPUTS		= [ "Q", ]
	WITH_BODY_OPERATOR	= True
	OPTIONAL_CONNS		= { "R", "Q", }
	BLANK_CONNS		= set()

class FupElem_RS(FupElem_BOOLEAN):
	"""RS flip-flop FUP/FBD element"""

	OP_SYM			= "RS"
	OP_SYM_NAME		= "rs" # XML ABI name

	FIXED_INPUTS		= [ "R", "S", ]
	FIXED_OUTPUTS		= [ "Q", ]
	WITH_BODY_OPERATOR	= True
	OPTIONAL_CONNS		= { "S", "Q", }
	BLANK_CONNS		= set()

class FupElem_FP(FupElem_BOOLEAN):
	"""Positive edge FUP/FBD element"""

	OP_SYM			= "FP"
	OP_SYM_NAME		= "fp" # XML ABI name

	FIXED_INPUTS		= [ "IN", ]
	FIXED_OUTPUTS		= [ "Q", ]
	WITH_BODY_OPERATOR	= True
	OPTIONAL_CONNS		= set()
	BLANK_CONNS		= { "IN", "Q", }

class FupElem_FN(FupElem_FP):
	"""Negative edge FUP/FBD element"""

	OP_SYM			= "FN"
	OP_SYM_NAME		= "fn" # XML ABI name
bues.ch cgit interface