2 Copyright 2008 Free Software Foundation, Inc.
3 This file is part of GNU Radio
5 GNU Radio Companion is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License
7 as published by the Free Software Foundation; either version 2
8 of the License, or (at your option) any later version.
10 GNU Radio Companion is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
20 from .. base.Block import Block as _Block
21 from utils import extract_docs
26 ##for make source to keep track of indexes
28 ##for make sink to keep track of indexes
31 def __init__(self, flow_graph, n):
33 Make a new block from nested data.
34 @param flow graph the parent element
35 @param n the nested odict
36 @return block a new block
39 doc = utils.exists_or_else(n, 'doc', '')
40 imports = map(lambda i: i.strip(), utils.listify(n, 'import'))
42 checks = utils.listify(n, 'check')
43 callbacks = utils.listify(n, 'callback')
47 flow_graph=flow_graph,
51 self._imports = imports
53 self._callbacks = callbacks
59 Call the base class validate.
60 Evaluate the checks: each check must evaluate to True.
65 for check in self._checks:
66 check_res = self.resolve_dependencies(check)
68 check_eval = self.get_parent().evaluate(check_res)
69 try: assert check_eval
70 except AssertionError: self._add_error_message('Check "%s" failed.'%check)
71 except: self._add_error_message('Check "%s" did not evaluate.'%check)
73 (self._sources, self.get_parent().get_parent().Source),
74 (self._sinks, self.get_parent().get_parent().Sink),
77 num_ports = len(ports)
78 #do nothing for 0 ports
79 if not num_ports: continue
80 #get the nports setting
82 nports = port0.get_nports()
83 #do nothing for no nports
84 if not nports: continue
85 #do nothing if nports is already num ports
86 if nports == num_ports: continue
87 #remove excess ports and connections
88 if nports < num_ports:
89 #remove the connections
90 for key in map(str, range(nports, num_ports)):
92 for connection in port.get_connections():
93 self.get_parent().remove_element(connection)
95 for key in map(str, range(nports, num_ports)): ports.pop(key)
98 if nports > num_ports:
99 for key in map(str, range(num_ports, nports)):
107 doc = self._doc.strip('\n').replace('\\\n', '')
108 #merge custom doc with doxygen docs
109 return '\n'.join([doc, extract_docs.extract(self.get_key())]).strip('\n')
111 def get_imports(self):
113 Resolve all import statements.
114 Split each import statement at newlines.
115 Combine all import statments into a list.
116 Filter empty imports.
117 @return a list of import statements
119 return filter(lambda i: i, sum(map(lambda i: self.resolve_dependencies(i).split('\n'), self._imports), []))
121 def get_make(self): return self.resolve_dependencies(self._make)
123 def get_callbacks(self):
125 Get a list of function callbacks for this block.
126 @return a list of strings
128 return map(lambda c: self.get_id() + '.' + self.resolve_dependencies(c), self._callbacks)