summaryrefslogtreecommitdiff
path: root/grc/src/platforms/python/Param.py
blob: 321913ea88f2d63d66ca036d5968bb7a1503749e (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
"""
Copyright 2008 Free Software Foundation, Inc.
This file is part of GNU Radio

GNU Radio Companion 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.

GNU Radio Companion 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 utils import expr_utils
from .. base.Param import Param as _Param
import Constants
import numpy
import os

#define types, native python + numpy
VECTOR_TYPES = (tuple, list, set, numpy.ndarray)
COMPLEX_TYPES = [complex, numpy.complex, numpy.complex64, numpy.complex128]
REAL_TYPES = [float, numpy.float, numpy.float32, numpy.float64]
INT_TYPES = [int, long, numpy.int, numpy.int8, numpy.int16, numpy.int32, numpy.uint64,
	numpy.uint, numpy.uint8, numpy.uint16, numpy.uint32, numpy.uint64]
#cast to tuple for isinstance, concat subtypes
COMPLEX_TYPES = tuple(COMPLEX_TYPES + REAL_TYPES + INT_TYPES)
REAL_TYPES = tuple(REAL_TYPES + INT_TYPES)
INT_TYPES = tuple(INT_TYPES)

class Param(_Param):

	_init = False
	_hostage_cells = list()

	##possible param types
	TYPES = _Param.TYPES + [
		'complex', 'real', 'int',
		'complex_vector', 'real_vector', 'int_vector',
		'hex', 'string',
		'file_open', 'file_save',
		'id',
		'grid_pos', 'import',
	]

	def get_color(self):
		"""
		Get the color that represents this param's type.
		@return a hex color code.
		"""
		try:
			return {
				#number types
				'complex': Constants.COMPLEX_COLOR_SPEC,
				'real': Constants.FLOAT_COLOR_SPEC,
				'int': Constants.INT_COLOR_SPEC,
				#vector types
				'complex_vector': Constants.COMPLEX_VECTOR_COLOR_SPEC,
				'real_vector': Constants.FLOAT_VECTOR_COLOR_SPEC,
				'int_vector': Constants.INT_VECTOR_COLOR_SPEC,
				#special
				'hex': Constants.INT_COLOR_SPEC,
				'string': Constants.BYTE_VECTOR_COLOR_SPEC,
				'id': '#DDDDDD',
				'grid_pos': Constants.INT_VECTOR_COLOR_SPEC,
			}[self.get_type()]
		except: return _Param.get_color(self)

	def get_hide(self):
		"""
		Get the hide value from the base class.
		Hide the ID parameter for most blocks. Exceptions below.
		If the parameter controls a port type, vlen, or nports, return part.
		If the parameter is an empty grid position, return part.
		These parameters are redundant to display in the flow graph view.
		@return hide the hide property string
		"""
		hide = _Param.get_hide(self)
		if hide: return hide
		#hide ID in non variable blocks
		if self.get_key() == 'id' and self.get_parent().get_key() not in (
			'variable', 'variable_slider', 'variable_chooser', 'variable_text_box', 'parameter', 'options'
		): return 'part'
		#hide port controllers
		if self.get_key() in ' '.join(map(
			lambda p: ' '.join([p._type, p._vlen, p._nports]), self.get_parent().get_ports())
		): return 'part'
		#hide empty grid positions
		if self.get_key() == 'grid_pos' and not self.get_value(): return 'part'
		return hide

	def evaluate(self):
		"""
		Evaluate the value.
		@return evaluated type
		"""
		self._lisitify_flag = False
		self._stringify_flag = False
		self._hostage_cells = list()
		def eval_string(v):
			try:
				e = self.get_parent().get_parent().evaluate(v)
				assert isinstance(e, str)
				return e
			except:
				self._stringify_flag = True
				return v
		t = self.get_type()
		v = self.get_value()
		#########################
		# Enum Type
		#########################
		if self.is_enum(): return self.get_value()
		#########################
		# Numeric Types
		#########################
		elif t in ('raw', 'complex', 'real', 'int', 'complex_vector', 'real_vector', 'int_vector', 'hex'):
			#raise exception if python cannot evaluate this value
			try: e = self.get_parent().get_parent().evaluate(v)
			except:
				self._add_error_message('Value "%s" cannot be evaluated.'%v)
				raise Exception
			#raise an exception if the data is invalid
			if t == 'raw': return e
			elif t == 'complex':
				try: assert(isinstance(e, COMPLEX_TYPES))
				except AssertionError:
					self._add_error_message('Expression "%s" is invalid for type complex.'%str(e))
					raise Exception
				return e
			elif t == 'real':
				try: assert(isinstance(e, REAL_TYPES))
				except AssertionError:
					self._add_error_message('Expression "%s" is invalid for type real.'%str(e))
					raise Exception
				return e
			elif t == 'int':
				try: assert(isinstance(e, INT_TYPES))
				except AssertionError:
					self._add_error_message('Expression "%s" is invalid for type integer.'%str(e))
					raise Exception
				return e
			#########################
			# Numeric Vector Types
			#########################
			elif t == 'complex_vector':
				if not isinstance(e, VECTOR_TYPES):
					self._lisitify_flag = True
					e = [e]
				try:
					for ei in e:
						assert(isinstance(ei, COMPLEX_TYPES))
				except AssertionError:
					self._add_error_message('Expression "%s" is invalid for type complex vector.'%str(e))
					raise Exception
				return e
			elif t == 'real_vector':
				if not isinstance(e, VECTOR_TYPES):
					self._lisitify_flag = True
					e = [e]
				try:
					for ei in e:
						assert(isinstance(ei, REAL_TYPES))
				except AssertionError:
					self._add_error_message('Expression "%s" is invalid for type real vector.'%str(e))
					raise Exception
				return e
			elif t == 'int_vector':
				if not isinstance(e, VECTOR_TYPES):
					self._lisitify_flag = True
					e = [e]
				try:
					for ei in e:
						assert(isinstance(ei, INT_TYPES))
				except AssertionError:
					self._add_error_message('Expression "%s" is invalid for type integer vector.'%str(e))
					raise Exception
				return e
			elif t == 'hex':
				return hex(e)
			else: raise TypeError, 'Type "%s" not handled'%t
		#########################
		# String Types
		#########################
		elif t in ('string', 'file_open', 'file_save'):
			#do not check if file/directory exists, that is a runtime issue
			e = eval_string(v)
			return str(e)
		#########################
		# Unique ID Type
		#########################
		elif t == 'id':
			#can python use this as a variable?
			try:
				assert(len(v) > 0)
				assert(v[0].isalpha())
				for c in v: assert(c.isalnum() or c in ('_',))
			except AssertionError:
				self._add_error_message('ID "%s" must be alpha-numeric or underscored, and begin with a letter.'%v)
				raise Exception
			params = self.get_all_params('id')
			keys = [param.get_value() for param in params]
			try: assert(len(keys) == len(set(keys)))
			except:
				self._add_error_message('ID "%s" is not unique.'%v)
				raise Exception
			return v
		#########################
		# Grid Position Type
		#########################
		elif t == 'grid_pos':
			if not v: return '' #allow for empty grid pos
			e = self.get_parent().get_parent().evaluate(v)
			try:
				assert(isinstance(e, (list, tuple)) and len(e) == 4)
				for ei in e: assert(isinstance(ei, int))
			except AssertionError:
				self._add_error_message('A grid position must be a list of 4 integers.')
				raise Exception
			row, col, row_span, col_span = e
			#check row, col
			try: assert(row >= 0 and col >= 0)
			except AssertionError:
				self._add_error_message('Row and column must be non-negative.')
				raise Exception
			#check row span, col span
			try: assert(row_span > 0 and col_span > 0)
			except AssertionError:
				self._add_error_message('Row and column span must be greater than zero.')
				raise Exception
			#calculate hostage cells
			for r in range(row_span):
				for c in range(col_span):
					self._hostage_cells.append((row+r, col+c))
			#avoid collisions
			params = filter(lambda p: p is not self, self.get_all_params('grid_pos'))
			for param in params:
				for cell in param._hostage_cells:
					if cell in self._hostage_cells:
						self._add_error_message('Another graphical element is using cell "%s".'%str(cell))
						raise Exception
			return e
		#########################
		# Import Type
		#########################
		elif t == 'import':
			n = dict() #new namespace
			try: exec v in n
			except ImportError:
				self._add_error_message('Import "%s" failed.'%v)
				raise Exception
			except Exception:
				self._add_error_message('Bad import syntax: "%s".'%v)
				raise Exception
			return filter(lambda k: str(k) != '__builtins__', n.keys())
		#########################
		else: raise TypeError, 'Type "%s" not handled'%t

	def to_code(self):
		"""
		Convert the value to code.
		@return a string representing the code
		"""
		#run init tasks in evaluate
		#such as setting flags
		if not self._init:
			self.evaluate()
			self._init = True
		v = self.get_value()
		t = self.get_type()
		if t in ('string', 'file_open', 'file_save'): #string types
			if self._stringify_flag:
				return '"%s"'%v.replace('"', '\"')
			else:
				return v
		elif t in ('complex_vector', 'real_vector', 'int_vector'): #vector types
			if self._lisitify_flag:
				return '(%s, )'%v
			else:
				return '(%s)'%v
		else:
			return v

	def get_all_params(self, type):
		"""
		Get all the params from the flowgraph that have the given type.
		@param type the specified type
		@return a list of params
		"""
		return sum([filter(lambda p: p.get_type() == type, block.get_params()) for block in self.get_parent().get_parent().get_blocks()], [])