diff options
| author | Swapnil Negi <swapnil.negi09@gmail.com> | 2019-01-04 18:29:50 +0100 |
|---|---|---|
| committer | Andrej Rode <mail@andrejro.de> | 2019-01-04 18:58:02 +0100 |
| commit | 055287896c8c97eb0cdda825559e217d8db54a14 (patch) | |
| tree | 613262f5ed45ba4eaadf1bd76009aa16ad22806f /gr-utils/python/modtool/core/update.py | |
| parent | 2fcf3b8afe51092003b7f916edb9e5d6372d4842 (diff) | |
modtool: gr-modtool overhaul GSoC 2018
This commit contains all the changes done during the 2018 GSoC
"gr-modtool overhaul".
Changes include:
- Rewrite of gr-modtool based on Python Click
- Split of gr-modtool in cli and core
- Adherence to new GNU Radio 3.8 API for OOTs
- Pylint improvements
- Py3k and Py2k compatibility
This feature is merged in a squash-merge due to big refactoring
on the head and base branch and the impossibility to unclutter both.
Diffstat (limited to 'gr-utils/python/modtool/core/update.py')
| -rw-r--r-- | gr-utils/python/modtool/core/update.py | 109 |
1 files changed, 109 insertions, 0 deletions
diff --git a/gr-utils/python/modtool/core/update.py b/gr-utils/python/modtool/core/update.py new file mode 100644 index 0000000000..ec8a519d45 --- /dev/null +++ b/gr-utils/python/modtool/core/update.py @@ -0,0 +1,109 @@ +# +# Copyright 2018 Free Software Foundation, Inc. +# +# This file is part of GNU Radio +# +# GNU Radio 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 3, or (at your option) +# any later version. +# +# GNU Radio 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 GNU Radio; see the file COPYING. If not, write to +# the Free Software Foundation, Inc., 51 Franklin Street, +# Boston, MA 02110-1301, USA. +# +""" Module to convert XML bindings to YAML bindings """ + +from __future__ import print_function +from __future__ import absolute_import +from __future__ import unicode_literals + +import os +import re +import glob +import logging + +from gnuradio.grc.converter import Converter +from .base import ModTool, ModToolException + +logger = logging.getLogger(__name__) + + +def get_xml_candidates(): + """ Returns a list of XML candidates for update """ + xml_candidates = [] + xml_files = [x for x in glob.glob1("grc", "*.xml")] + for candidate in xml_files: + candidate = os.path.splitext(candidate)[0] + candidate = candidate.split("_", 1)[-1] + xml_candidates.append(candidate) + return xml_candidates + + +class ModToolUpdate(ModTool): + """ Update the grc bindings for a block """ + name = 'update' + description = 'Update the grc bindings for a block' + + def __init__(self, blockname=None, complete=False, **kwargs): + ModTool.__init__(self, blockname, **kwargs) + self.info['complete'] = complete + + + def validate(self): + """ Validates the arguments """ + ModTool._validate(self) + if self.info['complete']: + return + if not self.info['blockname'] or self.info['blockname'].isspace(): + raise ModToolException('Block name not specified!') + block_candidates = get_xml_candidates() + if self.info['blockname'] not in block_candidates: + choices = [x for x in block_candidates if self.info['blockname'] in x] + if len(choices) > 0: + print("Suggested alternatives: "+str(choices)) + raise ModToolException("The XML bindings does not exists!") + + def run(self): + if not self.cli: + self.validate() + logger.warning("Warning: This is an experimental feature. Please verify the bindings.") + module_name = self.info['modname'] + path = './grc/' + conv = Converter(path, path) + if self.info['complete']: + blocks = get_xml_candidates() + else: + blocks = [self.info['blockname']] + for blockname in blocks: + xml_file = "{}_{}.xml".format(module_name, blockname) + yml_file = "{}_{}.block.yml".format(module_name, blockname) + conv.load_block_xml(path+xml_file) + logger.info("Converted {} to {}".format(xml_file, yml_file)) + os.remove(path+xml_file) + nsubs = self._run_cmakelists(xml_file, yml_file) + if nsubs > 1: + logger.warning("Changed more than expected for the block '%s' in the CMakeLists.txt. " + "Please verify the CMakeLists manually.", blockname) + elif nsubs == 0: + logger.warning("No entry found for the block '%s' in the CMakeLists.txt. " + 'Please verify the CMakeLists manually.', blockname) + else: + logger.info('Updated the CMakeLists.txt') + + def _run_cmakelists(self, to_remove, to_add): + """ Changes in the CMakeLists """ + filename = './grc/CMakeLists.txt' + with open(filename) as f: + cfile = f.read() + (cfile, nsubs) = re.subn(to_remove, to_add, cfile) + with open(filename, 'w') as f: + f.write(cfile) + self.scm.mark_file_updated(filename) + return nsubs |