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/tools/cmakefile_editor.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/tools/cmakefile_editor.py')
| -rw-r--r-- | gr-utils/python/modtool/tools/cmakefile_editor.py | 152 |
1 files changed, 152 insertions, 0 deletions
diff --git a/gr-utils/python/modtool/tools/cmakefile_editor.py b/gr-utils/python/modtool/tools/cmakefile_editor.py new file mode 100644 index 0000000000..0e3ede0be9 --- /dev/null +++ b/gr-utils/python/modtool/tools/cmakefile_editor.py @@ -0,0 +1,152 @@ +# +# Copyright 2013, 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. +# +""" Edit CMakeLists.txt files """ + +from __future__ import print_function +from __future__ import absolute_import +from __future__ import unicode_literals + +import re +import logging + +logger = logging.getLogger(__name__) + + +class CMakeFileEditor(object): + """A tool for editing CMakeLists.txt files. """ + def __init__(self, filename, separator='\n ', indent=' '): + self.filename = filename + with open(filename, 'r') as f: + self.cfile = f.read() + self.separator = separator + self.indent = indent + + def append_value(self, entry, value, to_ignore_start='', to_ignore_end=''): + """ Add a value to an entry. """ + regexp = re.compile(r'({}\({}[^()]*?)\s*?(\s?{})\)'.format(entry, to_ignore_start, to_ignore_end), + re.MULTILINE) + substi = r'\1' + self.separator + value + r'\2)' + (self.cfile, nsubs) = regexp.subn(substi, self.cfile, count=1) + return nsubs + + def remove_value(self, entry, value, to_ignore_start='', to_ignore_end=''): + """ + Remove a value from an entry. + Example: You want to remove file.cc from this list() entry: + list(SOURCES + file.cc + other_file.cc + ) + + Then run: + >>> C.remove_value('list', 'file.cc', 'SOURCES') + + Returns the number of occurrences of entry in the current file + that were removed. + """ + # In the case of the example above, these are cases we need to catch: + # - list(file.cc ... + # entry is right after the value parentheses, no whitespace. Can only happen + # when to_ignore_start is empty. + # - list(... file.cc) + # Other entries come first, then entry is preceded by whitespace. + # - list(SOURCES ... file.cc) # whitespace! + # When to_ignore_start is not empty, entry must always be preceded by whitespace. + if len(to_ignore_start) == 0: + regexp = r'^\s*({entry}\((?:[^()]*?\s+|)){value}\s*([^()]*{to_ignore_end}\s*\)){to_ignore_start}' + else: + regexp = r'^\s*({entry}\(\s*{to_ignore_start}[^()]*?\s+){value}\s*([^()]*{to_ignore_end}\s*\))' + regexp = regexp.format( + entry=entry, + to_ignore_start=to_ignore_start, + value=value, + to_ignore_end=to_ignore_end, + ) + regexp = re.compile(regexp, re.MULTILINE) + (self.cfile, nsubs) = re.subn(regexp, r'\1\2', self.cfile, count=1) + return nsubs + + def delete_entry(self, entry, value_pattern=''): + """Remove an entry from the current buffer.""" + regexp = r'{}\s*\([^()]*{}[^()]*\)[^\n]*\n'.format(entry, value_pattern) + regexp = re.compile(regexp, re.MULTILINE) + (self.cfile, nsubs) = re.subn(regexp, '', self.cfile, count=1) + return nsubs + + def write(self): + """ Write the changes back to the file. """ + with open(self.filename, 'w') as f: + f.write(self.cfile) + + def remove_double_newlines(self): + """Simply clear double newlines from the file buffer.""" + self.cfile = re.compile('\n\n\n+', re.MULTILINE).sub('\n\n', self.cfile) + + def find_filenames_match(self, regex): + """ Find the filenames that match a certain regex + on lines that aren't comments """ + filenames = [] + reg = re.compile(regex) + fname_re = re.compile(r'[a-zA-Z]\w+\.\w{1,5}$') + for line in self.cfile.splitlines(): + if len(line.strip()) == 0 or line.strip()[0] == '#': + continue + for word in re.split('[ /)(\t\n\r\f\v]', line): + if fname_re.match(word) and reg.search(word): + filenames.append(word) + return filenames + + def disable_file(self, fname): + """ Comment out a file. + Example: + add_library( + file1.cc + ) + + Here, file1.cc becomes #file1.cc with disable_file('file1.cc'). + """ + starts_line = False + for line in self.cfile.splitlines(): + if len(line.strip()) == 0 or line.strip()[0] == '#': + continue + if re.search(r'\b'+fname+r'\b', line): + if re.match(fname, line.lstrip()): + starts_line = True + break + comment_out_re = r'#\1' + '\n' + self.indent + if not starts_line: + comment_out_re = r'\n' + self.indent + comment_out_re + (self.cfile, nsubs) = re.subn(r'(\b'+fname+r'\b)\s*', comment_out_re, self.cfile) + if nsubs == 0: + logger.warning("Warning: A replacement failed when commenting out {}. Check the CMakeFile.txt manually.".format(fname)) + elif nsubs > 1: + logger.warning("Warning: Replaced {} {} times (instead of once). Check the CMakeFile.txt manually.".format(fname, nsubs)) + + def comment_out_lines(self, pattern, comment_str='#'): + """ Comments out all lines that match with pattern """ + for line in self.cfile.splitlines(): + if re.search(pattern, line): + self.cfile = self.cfile.replace(line, comment_str+line) + + def check_for_glob(self, globstr): + """ Returns true if a glob as in globstr is found in the cmake file """ + glob_re = r'GLOB\s[a-z_]+\s"{}"'.format(globstr.replace('*', r'\*')) + return re.search(glob_re, self.cfile, flags=re.MULTILINE|re.IGNORECASE) is not None |