"""
Copyright 2008-2012 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 .. base.Port import Port as _Port
from .. gui.Port import Port as _GUIPort
import Constants
def _get_source_from_virtual_sink_port(vsp):
"""
Resolve the source port that is connected to the given virtual sink port.
Use the get source from virtual source to recursively resolve subsequent ports.
"""
try: return _get_source_from_virtual_source_port(
vsp.get_enabled_connections()[0].get_source())
except: raise Exception, 'Could not resolve source for virtual sink port %s'%vsp
def _get_source_from_virtual_source_port(vsp, traversed=[]):
"""
Recursively resolve source ports over the virtual connections.
Keep track of traversed sources to avoid recursive loops.
"""
if not vsp.get_parent().is_virtual_source(): return vsp
if vsp in traversed: raise Exception, 'Loop found when resolving virtual source %s'%vsp
try: return _get_source_from_virtual_source_port(
_get_source_from_virtual_sink_port(
filter(#get all virtual sinks with a matching stream id
lambda vs: vs.get_param('stream_id').get_value() == vsp.get_parent().get_param('stream_id').get_value(),
filter(#get all enabled blocks that are also virtual sinks
lambda b: b.is_virtual_sink(),
vsp.get_parent().get_parent().get_enabled_blocks(),
),
)[0].get_sinks()[0]
), traversed + [vsp],
)
except: raise Exception, 'Could not resolve source for virtual source port %s'%vsp
def _get_sink_from_virtual_source_port(vsp):
"""
Resolve the sink port that is connected to the given virtual source port.
Use the get sink from virtual sink to recursively resolve subsequent ports.
"""
try: return _get_sink_from_virtual_sink_port(
vsp.get_enabled_connections()[0].get_sink()) # Could have many connections, but use first
except: raise Exception, 'Could not resolve source for virtual source port %s'%vsp
def _get_sink_from_virtual_sink_port(vsp, traversed=[]):
"""
Recursively resolve sink ports over the virtual connections.
Keep track of traversed sinks to avoid recursive loops.
"""
if not vsp.get_parent().is_virtual_sink(): return vsp
if vsp in traversed: raise Exception, 'Loop found when resolving virtual sink %s'%vsp
try: return _get_sink_from_virtual_sink_port(
_get_sink_from_virtual_source_port(
filter(#get all virtual source with a matching stream id
lambda vs: vs.get_param('stream_id').get_value() == vsp.get_parent().get_param('stream_id').get_value(),
filter(#get all enabled blocks that are also virtual sinks
lambda b: b.is_virtual_source(),
vsp.get_parent().get_parent().get_enabled_blocks(),
),
)[0].get_sources()[0]
), traversed + [vsp],
)
except: raise Exception, 'Could not resolve source for virtual sink port %s'%vsp
class Port(_Port, _GUIPort):
def __init__(self, block, n, dir):
"""
Make a new port from nested data.
Args:
block: the parent element
n: the nested odict
dir: the direction
"""
self._n = n
if n['type'] == 'msg': n['key'] = 'msg'
if n['type'] == 'message': n['key'] = n['name']
if dir == 'source' and not n.find('key'):
n['key'] = str(block._source_count)
block._source_count += 1
if dir == 'sink' and not n.find('key'):
n['key'] = str(block._sink_count)
block._sink_count += 1
#build the port
_Port.__init__(
self,
block=block,
n=n,
dir=dir,
)
_GUIPort.__init__(self)
self._nports = n.find('nports') or ''
self._vlen = n.find('vlen') or ''
self._optional = bool(n.find('optional'))
self._clones = [] # references to cloned ports (for nports > 1)
def get_types(self): return Constants.TYPE_TO_SIZEOF.keys()
def is_type_empty(self): return not self._n['type']
def validate(self):
_Port.validate(self)
if not self.get_enabled_connections() and not self.get_optional():
self.add_error_message('Port is not connected.')
if not self.is_source() and (not self.get_type() == "message") and len(self.get_enabled_connections()) > 1:
self.add_error_message('Port has too many connections.')
#message port logic
if self.get_type() == 'msg':
if self.get_nports():
self.add_error_message('A port of type "msg" cannot have "nports" set.')
if self.get_vlen() != 1:
self.add_error_message('A port of type "msg" must have a "vlen" of 1.')
def rewrite(self):
"""
Handle the port cloning for virtual blocks.
"""
_Port.rewrite(self)
if self.is_type_empty():
try: #clone type and vlen
source = self.resolve_empty_type()
self._type = str(source.get_type())
self._vlen = str(source.get_vlen())
except: #reset type and vlen
self._type = ''
self._vlen = ''
def resolve_virtual_source(self):
if self.get_parent().is_virtual_sink(): return _get_source_from_virtual_sink_port(self)
if self.get_parent().is_virtual_source(): return _get_source_from_virtual_source_port(self)
def resolve_empty_type(self):
if self.is_sink():
try:
src = _get_source_from_virtual_sink_port(self)
if not src.is_type_empty(): return src
except: pass
sink = _get_sink_from_virtual_sink_port(self)
if not sink.is_type_empty(): return sink
if self.is_source():
try:
src = _get_source_from_virtual_source_port(self)
if not src.is_type_empty(): return src
except: pass
sink = _get_sink_from_virtual_source_port(self)
if not sink.is_type_empty(): return sink
def get_vlen(self):
"""
Get the vector length.
If the evaluation of vlen cannot be cast to an integer, return 1.
Returns:
the vector length or 1
"""
vlen = self.get_parent().resolve_dependencies(self._vlen)
try: return int(self.get_parent().get_parent().evaluate(vlen))
except: return 1
def get_nports(self):
"""
Get the number of ports.
If already blank, return a blank
If the evaluation of nports cannot be cast to a positive integer, return 1.
Returns:
the number of ports or 1
"""
nports = self.get_parent().resolve_dependencies(self._nports)
if not nports: # return blank if nports is blank
return ''
try:
return max(1, int(self.get_parent().get_parent().evaluate(nports)))
except:
return 1
def get_optional(self): return bool(self._optional)
def get_color(self):
"""
Get the color that represents this port's type.
Codes differ for ports where the vec length is 1 or greater than 1.
Returns:
a hex color code.
"""
try:
color = Constants.TYPE_TO_COLOR[self.get_type()]
vlen = self.get_vlen()
if vlen == 1: return color
color_val = int(color[1:], 16)
r = (color_val >> 16) & 0xff
g = (color_val >> 8) & 0xff
b = (color_val >> 0) & 0xff
dark = (0, 0, 30, 50, 70)[min(4, vlen)]
r = max(r-dark, 0)
g = max(g-dark, 0)
b = max(b-dark, 0)
return '#%.2x%.2x%.2x'%(r, g, b)
except: return _Port.get_color(self)
def get_clones(self):
"""
Get clones of this master port
"""
return self._clones
def add_clone(self):
"""
Create a clone of this (master) port and store it internally
This clone will have the same key. The name get an index
If this is the first clone, this (master) port will get a 0 appended to its name
Returns:
the newly create clone
"""
if not self._clones: # add index to master port name
self._name = self._n['name'] + '0'
if not self._key.isdigit():
self._n['key'] = self._name
# Prepare a copy of the odict for the clone
n = self._n.copy()
if 'nports' in n: n.pop('nports') # remove nports from the key so the copy cannot be a duplicator
n['name'] = self._n['name'] + str(len(self._clones) + 1)
n['key'] = '99999' if self._key.isdigit() else n['name']
port = self.__class__(self.get_parent(), n, self._dir)
self._clones.append(port)
return port
def remove_duplicate(self, port):
"""
Remove a cloned port from the internal list
Remove to index 0 of the master port name if there are no more clones
"""
self._clones.remove(port)
if not self._clones:
self._name = self._n['key'] = self._n['name']