path: root/awlsim/core/operators.py

# -*- coding: utf-8 -*-
#
# AWL simulator - operators
#
# Copyright 2012-2018 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.cython_support cimport * #@cy
from awlsim.common.compat import *

from awlsim.common.datatypehelpers import * #+cimport
from awlsim.common.exceptions import *
from awlsim.common.util import *

from awlsim.core.operatortypes import * #+cimport
from awlsim.core.memory import * #+cimport
from awlsim.core.offset import * #+cimport
from awlsim.core.statusword import * #+cimport
from awlsim.core.timers import * #+cimport


class AwlOperator(object): #+cdef
	"""An AWL operator.
	An operator is an 'argument' to an instruction.
	For example MW 10 in:
	L  MW 10
	"""

	# Type to string map
	type2str = AwlOperatorTypes.type2str


	# Immediate integer.
	# Only used for IMM types.
	immediate = 0 #@nocy

	# Immediate bytes/bytearray.
	# Only used for IMM_DT, IMM_STR and LBL_REF types.
	immediateBytes = None #@nocy

	# Immediate pointer.
	# Only used for IMM_PTR type.
	pointer = None #@nocy

	# Extended-operator flag.
	isExtended = False #@nocy

	# Possible label index.
	labelIndex = 0xFFFFFFFF #@nocy

	# Interface index number.
	# May be set by the symbol resolver.
	interfaceIndex = 0xFFFF #@nocy

	# Compound data type flag.
	# Set to true for accesses > 32 bit or
	# arrays/structs or array/struct elements.
	compound = False #@nocy

	# The access data type (AwlDataType), if known.
	# Only set for resolved symbolic accesses.
	dataType = None #@nocy

#@cy	cdef void _cy_init(self):
#@cy		self.immediate = 0
#@cy		self.immediateBytes = None
#@cy		self.pointer = None
#@cy		self.isExtended = False
#@cy		self.labelIndex = 0xFFFFFFFF
#@cy		self.interfaceIndex = 0xFFFF
#@cy		self.compound = False
#@cy		self.dataType = None

	def __eq__(self, other): #@nocy
#@cy	cdef _Bool __eq(self, AwlOperator other):
		return (self is other) or (\
			isinstance(other, AwlOperator) and\
			self.operType == other.operType and\
			self.width == other.width and\
			self.offset == other.offset and\
			self.immediate == other.immediate and\
			self.immediateBytes == other.immediateBytes and\
			self.pointer == other.pointer and\
			super(AwlOperator, self).__eq__(other)\
		)

	def __ne__(self, other):		#@nocy
		return not self.__eq__(other)	#@nocy

#@cy	def __richcmp__(self, object other, int op):
#@cy		if op == 2: # __eq__
#@cy			return self.__eq(other)
#@cy		elif op == 3: # __ne__
#@cy			return not self.__eq(other)
#@cy		return False

	# Make a deep copy, except for "insn".
	def dup(self): #@nocy
#@cy	cpdef AwlOperator dup(self):
#@cy		cdef AwlOperator oper
#@cy		cdef AwlOffset offset

		offset = self.offset
		if offset is not None:
			offset = offset.dup()
		oper = make_AwlOperator(self.operType,
					self.width,
					offset,
					self.insn)
		oper.pointer = self.pointer
		oper.immediate = self.immediate
		if self.immediateBytes is None:
			oper.immediateBytes = None
		else:
			oper.immediateBytes = bytearray(self.immediateBytes)
		oper.isExtended = self.isExtended
		oper.labelIndex = self.labelIndex
		oper.interfaceIndex = self.interfaceIndex
		return oper

	@property
	def immediateStr(self):
		from awlsim.common.sources import AwlSource
		try:
			return self.immediateBytes.decode(AwlSource.COMPAT_ENCODING)
		except UnicodeError as e: #@nocov
			raise AwlSimError("Invalid characters in operator (decode).")

	@immediateStr.setter
	def immediateStr(self, newStr):
		from awlsim.common.sources import AwlSource
		try:
			self.immediateBytes = bytearray(newStr.encode(AwlSource.COMPAT_ENCODING))
		except UnicodeError as e: #@nocov
			raise AwlSimError("Invalid characters in operator (encode).")

	def setInsn(self, newInsn):
		self.insn = newInsn

	def setExtended(self, isExtended):
		self.isExtended = isExtended

	def setLabelIndex(self, newLabelIndex):
		self.labelIndex = newLabelIndex

	def isImmediate(self): #@nocy
#@cy	cdef _Bool isImmediate(self):
		return self.operType > AwlOperatorTypes._IMM_START and\
		       self.operType < AwlOperatorTypes._IMM_END

	def _raiseTypeError(self, actualType, expectedTypes):
		expectedTypes = [ self.type2str[t] for t in sorted(expectedTypes) ]
		raise AwlSimError("Invalid operator type. Got %s, but expected %s." %\
			(self.type2str[actualType],
			 listToHumanStr(expectedTypes)),
			insn=self.insn)

	def assertType(self, types, lowerLimit=None, upperLimit=None, widths=None):
		if self.operType == AwlOperatorTypes.NAMED_LOCAL or\
		   self.operType == AwlOperatorTypes.NAMED_LOCAL_PTR:
			return #FIXME we should check type for these, too.
		types = toSet(types)
		if not self.operType in types:
			self._raiseTypeError(self.operType, types)
		if lowerLimit is not None:
			if not self.isImmediate() or self.operType == AwlOperatorTypes.IMM_DT:
				raise AwlSimBug("Invalid operator type for lowerLimit check")
			if self.immediate < lowerLimit:
				raise AwlSimError("Operator value too small",
						  insn=self.insn)
		if upperLimit is not None:
			if not self.isImmediate() or self.operType == AwlOperatorTypes.IMM_DT:
				raise AwlSimBug("Invalid operator type for upperLimit check")
			if self.immediate > upperLimit:
				raise AwlSimError("Operator value too big",
						  insn=self.insn)
		if widths is not None:
			if not (makeAwlOperatorWidthMask(self.width) & widths):
				raise AwlSimError("Invalid operator width. "
					"Got %d, but expected %s." % (
					self.width,
					listToHumanStr(AwlOperatorWidths.maskToList(widths))))

	def checkDataTypeCompat(self, _cpu, dataType):
#@cy		cdef S7CPU cpu
		from awlsim.core.datatypes import AwlDataType

		cpu = _cpu
		assert(isinstance(dataType, AwlDataType))

		if self.operType in (AwlOperatorTypes.NAMED_LOCAL,
				     AwlOperatorTypes.NAMED_LOCAL_PTR,
				     AwlOperatorTypes.NAMED_DBVAR,
				     AwlOperatorTypes.SYMBOLIC):
			# These are checked again after resolve.
			# So don't check them now.
			return

		def mismatch(dataType, oper, operWidth):
			raise AwlSimError("Data type '%s' of width %d bits "
				"is not compatible with operator '%s' "
				"of width %d bits." %\
				(str(dataType), dataType.width, str(oper), operWidth))

		if dataType.type == AwlDataType.TYPE_UDT_X:
			udt = cpu.getUDT(dataType.index)
			if not udt or udt._struct.getSize() * 8 != self.width:
				mismatch(dataType, self, self.width)
		elif dataType.type in {AwlDataType.TYPE_POINTER,
				       AwlDataType.TYPE_ANY}:
			if self.operType == AwlOperatorTypes.IMM_PTR:
				if dataType.type == AwlDataType.TYPE_POINTER and\
				   self.width > 48:
					raise AwlSimError("Invalid immediate pointer "
						"assignment to POINTER type.")
			else:
				if self.isImmediate():
					raise AwlSimError("Invalid immediate "
						"assignment to '%s' type." %\
						str(dataType))
				# Try to make pointer from operator.
				# This will raise AwlSimError on failure.
				self.makePointer()
		elif dataType.type == AwlDataType.TYPE_CHAR:
			if self.operType == AwlOperatorTypes.IMM_STR:
				if self.width != (2 + 1) * 8:
					raise AwlSimError("String to CHAR parameter "
						"must be only one single character "
						"long.")
			else:
				if (self.isImmediate() and
				    self.operType != AwlOperatorTypes.IMM):
					raise AwlSimError("Invalid immediate '%s'"
						"for CHAR data type." %\
						str(self))
				if self.width != dataType.width:
					mismatch(dataType, self, self.width)
		elif dataType.type == AwlDataType.TYPE_STRING:
			if self.operType == AwlOperatorTypes.IMM_STR:
				if self.width > dataType.width:
					mismatch(dataType, self, self.width)
			else:
				if self.isImmediate():
					raise AwlSimError("Invalid immediate '%s'"
						"for STRING data type." %\
						str(self))
				assert(self.width <= (254 + 2) * 8)
				assert(dataType.width <= (254 + 2) * 8)
				if dataType.width != (254 + 2) * 8:
					if self.width != dataType.width:
						mismatch(dataType, self, self.width)
		else:
			if self.width != dataType.width:
				mismatch(dataType, self, self.width)

	# Resolve this indirect operator to a direct operator.
	def resolve(self, store): #@nocy
#@cy	cdef AwlOperator resolve(self, _Bool store):
		# This already is a direct operator.
		if self.operType == AwlOperatorTypes.NAMED_LOCAL:
			# This is a named-local access (#abc).
			# Resolve it to an interface-operator.
			return self.insn.cpu.callStackTop.getInterfIdxOper(self.interfaceIndex).resolve(store)
		return self

	# Make an area-spanning Pointer (32 bit) to this memory area.
	def makePointer(self):
		return Pointer(self.makePointerValue())

	# Make an area-spanning pointer value (32 bit) to this memory area.
	def makePointerValue(self): #@nocy
#@cy	cdef uint32_t makePointerValue(self) except? 0xFFFFFFFF:
#@cy		cdef int64_t area

		area = AwlIndirectOpConst.optype2area(self.operType)
		if area < 0 or area > 0xFFFFFFFF: #+suffix-u #+unlikely
			raise AwlSimError("Could not transform operator '%s' "
				"into a pointer." % str(self))
		return area | self.offset.toPointerValue()

	# Make a DBPointer (48 bit) to this memory area.
	def makeDBPointer(self):
		return DBPointer(self.makePointerValue(),
				 self.offset.dbNumber)

	# Make an ANY-pointer to this memory area.
	# Returns an ANYPointer().
	def makeANYPointer(self, areaShifted=None):
		ptrValue = self.makePointerValue()
		if areaShifted:
			ptrValue &= ~PointerConst.AREA_MASK_S
			ptrValue |= areaShifted
		if ANYPointer.dataTypeIsSupported(self.dataType):
			return ANYPointer.makeByAutoType(dataType = self.dataType,
							 ptrValue = ptrValue,
							 dbNr = self.offset.dbNumber)
		return ANYPointer.makeByTypeWidth(bitWidth = self.width,
						  ptrValue = ptrValue,
						  dbNr = self.offset.dbNumber)

	def __repr__(self):
		from awlsim.core.datatypes import AwlDataType
		from awlsim.common.sources import AwlSource

		if self.operType == AwlOperatorTypes.IMM:
			if self.width == 1:
				return "TRUE" if (self.immediate & 1) else "FALSE"
			elif self.width == 8:
				return str(self.immediate)
			elif self.width == 16:
				return str(wordToSignedPyInt(self.immediate))
			elif self.width == 32:
				return "L#" + str(dwordToSignedPyInt(self.immediate))
		if self.operType == AwlOperatorTypes.IMM_REAL:
			return str(dwordToPyFloat(self.immediate))
		elif self.operType == AwlOperatorTypes.IMM_S5T:
			seconds = Timer_s5t_to_seconds(self.immediate)
			return "S5T#" + AwlDataType.formatTime(seconds)
		elif self.operType == AwlOperatorTypes.IMM_TIME:
			return "T#" + AwlDataType.formatTime(self.immediate / 1000.0)
		elif self.operType == AwlOperatorTypes.IMM_DATE:
			return "D#" #TODO
		elif self.operType == AwlOperatorTypes.IMM_TOD:
			return "TOD#" #TODO
		elif self.operType == AwlOperatorTypes.IMM_PTR:
			return self.pointer.toPointerString()
		elif self.operType == AwlOperatorTypes.IMM_STR:
			strLen = self.immediateBytes[1]
			return "'" + self.immediateBytes[2:2+strLen].decode(
					AwlSource.COMPAT_ENCODING) + "'"
		elif self.operType in {AwlOperatorTypes.MEM_A,
				       AwlOperatorTypes.MEM_E,
				       AwlOperatorTypes.MEM_M,
				       AwlOperatorTypes.MEM_L,
				       AwlOperatorTypes.MEM_VL}:
			pfx = self.type2str[self.operType]
			if self.width == 1:
				return "%s %d.%d" %\
					(pfx, self.offset.byteOffset, self.offset.bitOffset)
			elif self.width == 8:
				return "%sB %d" % (pfx, self.offset.byteOffset)
			elif self.width == 16:
				return "%sW %d" % (pfx, self.offset.byteOffset)
			elif self.width == 32:
				return "%sD %d" % (pfx, self.offset.byteOffset)
			return self.makeANYPointer().toPointerString()
		elif self.operType == AwlOperatorTypes.MEM_DB:
			if self.offset.dbNumber < 0:
				dbPrefix = ""
			else:
				dbPrefix = "DB%d." % self.offset.dbNumber
			if self.width == 1:
				return "%sDBX %d.%d" % (dbPrefix,
							self.offset.byteOffset,
							self.offset.bitOffset)
			elif self.width == 8:
				return "%sDBB %d" % (dbPrefix, self.offset.byteOffset)
			elif self.width == 16:
				return "%sDBW %d" % (dbPrefix, self.offset.byteOffset)
			elif self.width == 32:
				return "%sDBD %d" % (dbPrefix, self.offset.byteOffset)
			return self.makeANYPointer().toPointerString()
		elif self.operType == AwlOperatorTypes.MEM_DI:
			if self.width == 1:
				return "DIX %d.%d" % (self.offset.byteOffset, self.offset.bitOffset)
			elif self.width == 8:
				return "DIB %d" % self.offset.byteOffset
			elif self.width == 16:
				return "DIW %d" % self.offset.byteOffset
			elif self.width == 32:
				return "DID %d" % self.offset.byteOffset
			return self.makeANYPointer().toPointerString()
		elif self.operType == AwlOperatorTypes.MEM_T:
			return "T %d" % self.offset.byteOffset
		elif self.operType == AwlOperatorTypes.MEM_Z:
			return "Z %d" % self.offset.byteOffset
		elif self.operType == AwlOperatorTypes.MEM_PA:
			if self.width == 8:
				return "PAB %d" % self.offset.byteOffset
			elif self.width == 16:
				return "PAW %d" % self.offset.byteOffset
			elif self.width == 32:
				return "PAD %d" % self.offset.byteOffset
			return self.makeANYPointer().toPointerString()
		elif self.operType == AwlOperatorTypes.MEM_PE:
			if self.width == 8:
				return "PEB %d" % self.offset.byteOffset
			elif self.width == 16:
				return "PEW %d" % self.offset.byteOffset
			elif self.width == 32:
				return "PED %d" % self.offset.byteOffset
			return self.makeANYPointer().toPointerString()
		elif self.operType == AwlOperatorTypes.MEM_STW:
			if self.width == 1:
				bitNumber = self.offset.bitOffset
				bitName = S7StatusWord.nr2name_german[bitNumber]
				if bitNumber in {4, 5, 8}:
					return bitName
				return "__STW " + bitName
			else:
				return "STW"
		elif self.operType == AwlOperatorTypes.LBL_REF:
			return self.immediateStr
		elif self.operType == AwlOperatorTypes.BLKREF_FC:
			return "FC %d" % self.offset.byteOffset
		elif self.operType == AwlOperatorTypes.BLKREF_SFC:
			return "SFC %d" % self.offset.byteOffset
		elif self.operType == AwlOperatorTypes.BLKREF_FB:
			return "FB %d" % self.offset.byteOffset
		elif self.operType == AwlOperatorTypes.BLKREF_SFB:
			return "SFB %d" % self.offset.byteOffset
		elif self.operType == AwlOperatorTypes.BLKREF_UDT:
			return "UDT %d" % self.offset.byteOffset
		elif self.operType == AwlOperatorTypes.BLKREF_DB:
			return "DB %d" % self.offset.byteOffset
		elif self.operType == AwlOperatorTypes.BLKREF_DI:
			return "DI %d" % self.offset.byteOffset
		elif self.operType == AwlOperatorTypes.BLKREF_OB:
			return "OB %d" % self.offset.byteOffset
		elif self.operType == AwlOperatorTypes.BLKREF_VAT:
			return "VAT %d" % self.offset.byteOffset
		elif self.operType == AwlOperatorTypes.MULTI_FB:
			return "#FB<" + self.makeANYPointer(PointerConst.AREA_DI_S).toPointerString() + ">"
		elif self.operType == AwlOperatorTypes.MULTI_SFB:
			return "#SFB<" + self.makeANYPointer(PointerConst.AREA_DI_S).toPointerString() + ">"
		elif self.operType == AwlOperatorTypes.SYMBOLIC:
			return '"%s"' % self.offset.identChain.getString()
		elif self.operType == AwlOperatorTypes.NAMED_LOCAL:
			return "#" + self.offset.identChain.getString()
		elif self.operType == AwlOperatorTypes.NAMED_LOCAL_PTR:
			return "P##" + self.offset.identChain.getString()
		elif self.operType == AwlOperatorTypes.NAMED_DBVAR:
			return str(self.offset)
		elif self.operType == AwlOperatorTypes.INDIRECT:
			assert(0) # Overloaded in AwlIndirectOp
		elif self.operType == AwlOperatorTypes.VIRT_ACCU:
			return "__ACCU %d" % self.offset.byteOffset
		elif self.operType == AwlOperatorTypes.VIRT_AR:
			return "__AR %d" % self.offset.byteOffset
		elif self.operType == AwlOperatorTypes.VIRT_DBR:
			return "__DBR %d" % self.offset.byteOffset
		elif self.operType == AwlOperatorTypes.UNSPEC:
			return "__UNSPEC"
		try:
			return self.type2str[self.operType]
		except KeyError: #@nocov
			assert(0)

#
# make_AwlOperator - Construct an AwlOperator instance.
#
# operType -> The operator type ID number. See "Operator types" above.
# width -> The bit width of the access.
# offset -> The AwlOffset of this operator. May be None.
# insn -> The instruction this operator is used in. May be None.
#
def make_AwlOperator(operType, width, offset, insn,			#@nocy
		     AwlOperator=AwlOperator):				#@nocy
#cdef AwlOperator make_AwlOperator(uint32_t operType, int32_t width,	#@cy
#				   AwlOffset offset, AwlInsn insn):	#@cy
#@cy	cdef AwlOperator operator

	operator = AwlOperator()
#@cy	operator._cy_init()

	operator.operType, operator.width, operator.offset, operator.insn =\
		operType, width, offset, insn

	return operator

class AwlIndirectOp(AwlOperator): #+cdef
	"""Indirect addressing operand.
	"""

	# Make a deep copy, except for "insn".
	def dup(self): #@nocy
#@cy	cpdef AwlOperator dup(self):
		return make_AwlIndirectOp(self.area,
					  self.width,
					  self.addressRegister,
					  self.offsetOper.dup(),
					  self.insn)

	def setInsn(self, newInsn):
		AwlOperator.setInsn(self, newInsn)
		self.offsetOper.setInsn(newInsn)

	def assertType(self, types, lowerLimit=None, upperLimit=None):
		types = toSet(types)
		if not AwlIndirectOpConst.area2optype(self.area, False) in types and\
		   not AwlIndirectOpConst.area2optype(self.area, True) in types:
			self._raiseTypeError(AwlIndirectOpConst.area2optype(self.area, False), types)
		assert(lowerLimit is None)
		assert(upperLimit is None)

	# Resolve this indirect operator to a direct operator.
	def resolve(self, store): #@nocy
#@cy	cdef AwlOperator resolve(self, _Bool store):
#@cy		cdef _Bool bitwiseDirectOffset
#@cy		cdef AwlOffset directOffset
#@cy		cdef AwlOperator offsetOper
#@cy		cdef uint32_t offsetValue
#@cy		cdef uint64_t pointer
#@cy		cdef int32_t optype

		bitwiseDirectOffset = True
		offsetOper = self.offsetOper
		# Construct the pointer
		if self.addressRegister == AwlIndirectOpConst.AR_NONE:
			# Memory-indirect access
			if self.area == PointerConst.AREA_NONE_S:
				raise AwlSimError("Area-spanning access not "
					"possible in indirect access without "
					"address register.")
			if self.area > PointerConst.AREA_MASK_S:
				# Is extended area
				bitwiseDirectOffset = False
				if offsetOper.width not in (8, 16, 32):
					raise AwlSimError("Offset operator in indirect "
						"access is not of 8, 16 or 32 bit width.")
			else:
				# Is standard area
				if offsetOper.width != 32:
					raise AwlSimError("Offset operator in indirect "
						"access is not of 32 bit width.")
			if offsetOper.operType not in (AwlOperatorTypes.MEM_M,
						       AwlOperatorTypes.MEM_L,
						       AwlOperatorTypes.MEM_DB,
						       AwlOperatorTypes.MEM_DI):
				raise AwlSimError("Offset operator in indirect "
					"access is not a valid memory offset.")
			offsetValue = AwlMemoryObject_asScalar(
				self.insn.cpu.fetch(offsetOper,
						    AwlOperatorWidths.WIDTH_MASK_8_16_32))
			pointer = (self.area | (offsetValue & 0x0007FFFF)) #+suffix-u
		else:
			# Register-indirect access
			if offsetOper.operType != AwlOperatorTypes.IMM_PTR:
				raise AwlSimError("Offset operator in "
					"register-indirect access is not a "
					"pointer immediate.")
			offsetValue = AwlMemoryObject_asScalar(
				self.insn.cpu.fetch(offsetOper,
						    (AwlOperatorWidths.WIDTH_MASK_8_16_32 &
						     0x0007FFFF))) #+suffix-u
			if self.area == PointerConst.AREA_NONE_S:
				# Area-spanning access
				pointer = ((self.insn.cpu.getAR(self.addressRegister).get() +
					    offsetValue) & 0xFFFFFFFF) #+suffix-u
			else:
				# Area-internal access
				pointer = (((self.insn.cpu.getAR(self.addressRegister).get() +
					     offsetValue) & 0x0007FFFF) | #+suffix-u
					   self.area)
		# Create a direct operator
		if store:
			optype = AwlIndirectOpConst.area2optype(
					(pointer & AwlIndirectOpConst.EXT_AREA_MASK_S),
					True)
		else:
			optype = AwlIndirectOpConst.area2optype(
					(pointer & AwlIndirectOpConst.EXT_AREA_MASK_S),
					False)
		if optype < 0: #+unlikely
			raise AwlSimError("Invalid area code (%X hex) in indirect addressing" %\
				((pointer & AwlIndirectOpConst.EXT_AREA_MASK_S) >>\
				 PointerConst.AREA_SHIFT))
		if bitwiseDirectOffset:
			# 'pointer' has pointer format
			directOffset = make_AwlOffset_fromPointerValue(pointer)
		else:
			# 'pointer' is a byte offset
			directOffset = make_AwlOffset(pointer & 0x0000FFFF, 0) #+suffix-u
		if self.width != 1 and directOffset.bitOffset:
			raise AwlSimError("Bit offset (lowest three bits) in %d-bit "
				"indirect addressing is not zero. "
				"(Computed offset is: %s)" %\
				(self.width, str(directOffset)))
		return make_AwlOperator(optype, self.width, directOffset, self.insn)

	def __pointerError(self): #@nocov
		# This is a programming error.
		# The caller should resolve() the operator first.
		raise AwlSimBug("Can not transform indirect operator "
			"into a pointer. Resolve it first.")

	def makePointer(self):
		self.__pointerError() #@nocov

	def makePointerValue(self): #@nocy
#@cy	cdef uint32_t makePointerValue(self) except? 0xFFFFFFFF:
		self.__pointerError() #@nocov

	def makeDBPointer(self):
		self.__pointerError() #@nocov

	def makeANYPointer(self, areaShifted=None):
		self.__pointerError() #@nocov

	def __repr__(self):
		return "__INDIRECT" #TODO

#
# make_AwlIndirectOp() - Construct an AwlIndirectOp instance.
#
# area -> The area code for this indirect operation.
#         AREA_... or EXT_AREA_...
#         This corresponds to the area code in AWL pointer format.
# width -> The width (in bits) of the region that is being adressed.
# addressRegister -> One of:
#                    AR_NONE => This is a memory-indirect access.
#                    AR_1 => This is a register-indirect access with AR1.
#                    AR_2 => This is a register-indirect access with AR2.
# offsetOper -> This is the AwlOperator for the offset.
#               For memory-indirect access, this must be an AwlOperator
#               with type MEM_M, MEM_L, MEM_DB or MEM_DI.
#               For register-indirect access, this must be an AwlOperator
#               with "type==IMM_PTR".
# insn -> The instruction this operator is used in. May be None.
#
def make_AwlIndirectOp(area, width, addressRegister, offsetOper, insn,	#@nocy
		       AwlIndirectOp=AwlIndirectOp):			#@nocy
#cdef AwlIndirectOp make_AwlIndirectOp(uint64_t area,			#@cy
#				       int32_t width,			#@cy
#				       uint32_t addressRegister,	#@cy
#				       AwlOperator offsetOper,		#@cy
#				       AwlInsn insn):			#@cy
#@cy	cdef AwlIndirectOp operator

	operator = AwlIndirectOp()
#@cy	operator._cy_init()

	operator.operType = AwlOperatorTypes.INDIRECT
	operator.width = width
	operator.offset = None
	operator.insn = insn

	operator.area = area
	operator.addressRegister = addressRegister
	operator.offsetOper = offsetOper

	return operator