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
|
#
# Copyright 2014, 2018 Free Software Foundation, Inc.
#
# This file is part of GNU Radio
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
#
""" Module to rename blocks """
import os
import re
import logging
from .base import get_block_candidates, ModTool, ModToolException, validate_name
logger = logging.getLogger(__name__)
class ModToolRename(ModTool):
""" Rename a block in the out-of-tree module. """
name = 'rename'
description = 'Rename a block inside a module.'
def __init__(self, blockname=None, new_name=None, **kwargs):
ModTool.__init__(self, blockname, **kwargs)
self.info['oldname'] = blockname
self.info['newname'] = new_name
def validate(self):
""" Validates the arguments """
ModTool._validate(self)
if not self.info['oldname']:
raise ModToolException('Old block name (blockname) not specified.')
validate_name('old block', self.info['oldname'])
block_candidates = get_block_candidates()
if self.info['oldname'] not in block_candidates:
choices = [x for x in block_candidates if self.info['oldname'] in x]
if len(choices) > 0:
print("Suggested alternatives: " + str(choices))
raise ModToolException("Blockname for renaming does not exists!")
if not self.info['newname']:
raise ModToolException('New blockname (new_name) not specified.')
validate_name('new block', self.info['newname'])
def assign(self):
self.info['fullnewname'] = self.info['modname'] + \
'_' + self.info['newname']
def run(self):
""" Go, go, go. """
# This portion will be covered by the CLI
if not self.cli:
self.validate()
self.assign()
module = self.info['modname']
oldname = self.info['oldname']
newname = self.info['newname']
logger.info(
f"In module '{module}' rename block '{oldname}' to '{newname}'")
self._run_grc_rename(self.info['modname'], oldname, newname)
self._run_python_qa(self.info['modname'], oldname, newname)
self._run_python(self.info['modname'], oldname, newname)
self._run_lib(self.info['modname'], oldname, newname)
self._run_include(self.info['modname'], oldname, newname)
self._run_pybind(self.info['modname'], oldname, newname)
return
def _run_lib(self, module, old, new):
ccfile = './lib/' + old + '_impl.cc'
if not os.path.isfile(ccfile): # in case it is a 'noblock'
ccfile = './lib/' + old + '.cc'
hfile = './lib/' + old + '_impl.h'
self._run_file_replace(ccfile, old, new)
self._run_file_replace(hfile, old, new)
# take care of include guards
self._run_file_replace(hfile, old.upper(), new.upper())
self._run_cmakelists('./lib/', old, new, '_impl.cc')
self._run_cmakelists('./lib/', old, new, '_impl.h')
self._run_file_rename('./lib/', old, new, '_impl.cc')
self._run_file_rename('./lib/', old, new, '_impl.h')
self._run_cpp_qa(module, old, new)
def _run_cpp_qa(self, module, old, new):
path = './lib/'
filename = 'qa_' + module + '.cc'
nsubs = self._run_file_replace(path + filename, old, new)
if nsubs > 0:
logger.info("C++ QA code detected, renaming...")
filename = 'qa_' + old + '.cc'
self._run_file_replace(path + filename, old, new)
filename = 'qa_' + old + '.h'
self._run_file_replace(path + filename, old, new)
self._run_file_replace(path + filename, old.upper(), new.upper())
self._run_file_rename(path, 'qa_' + old, 'qa_' + new, '.cc')
self._run_file_rename(path, 'qa_' + old, 'qa_' + new, '.h')
else:
logger.info("No C++ QA code detected, skipping...")
def _run_include(self, module, old, new):
path = self.info['includedir']
filename = os.path.join(path, old + '.h')
self._run_file_replace(filename, old, new)
# take care of include guards
self._run_file_replace(filename, old.upper(), new.upper())
self._run_cmakelists(path, old, new, '.h')
self._run_file_rename(path, old, new, '.h')
def _run_python(self, module, old, new):
path = self.info['pydir']
filename = '__init__.py'
nsubs = self._run_file_replace(os.path.join(path, filename), old, new)
if nsubs > 0:
logger.info("Python block detected, renaming...")
filename = old + '.py'
self._run_file_replace(path + filename, old, new)
self._run_cmakelists(path, old, new, '.py')
self._run_file_rename(path, old, new, '.py')
else:
logger.info("Not a Python block, nothing to do here...")
def _run_pybind(self, module, old, new):
path = os.path.join(self.info['pydir'], 'bindings')
filename = os.path.join(path, old + '_python.cc')
self._run_file_replace(filename, old, new)
self._run_file_rename(path, old, new, '_python.cc')
self._run_cmakelists(path, old, new, '_python.cc')
# update the hash in the new file
import hashlib
hasher = hashlib.md5()
# note this requires _run_pybind to be called after _run_include
header_filename = os.path.join(self.info['includedir'], new + '.h')
with open(header_filename, 'rb') as file_in:
buf = file_in.read()
hasher.update(buf)
newhash = hasher.hexdigest()
newfilename = os.path.join(path, new + '_python.cc')
with open(newfilename) as f:
file_txt = f.read()
m = re.search(r'BINDTOOL_HEADER_FILE_HASH\(([^\s]*)\)', file_txt)
if (m):
oldhash = m.group(1)
file_txt = re.sub(oldhash, newhash, file_txt)
with open(newfilename, "w") as f:
f.write(file_txt)
filename = path + 'python_bindings.cc'
self._run_file_replace(filename, ' bind_' +
old + '\\(', ' bind_' + new + '(')
path = os.path.join(path, 'docstrings')
filename = os.path.join(path, old + '_pydoc_template.h')
self._run_file_replace(filename, old, new)
self._run_file_rename(path, old, new, '_pydoc_template.h')
def _run_python_qa(self, module, old, new):
new = 'qa_' + new
old = 'qa_' + old
filename = os.path.join(self.info['pydir'], old + '.py')
self._run_file_replace(filename, old, new)
self._run_cmakelists(self.info['pydir'], old, new, '.py')
self._run_file_rename(self.info['pydir'], old, new, '.py')
def _run_grc_rename(self, module, old, new):
grcfile = './grc/' + module + '_' + old + '.block.yml'
self._run_file_replace(grcfile, old, new)
self._run_cmakelists('./grc/', module + '_' + old,
module + '_' + new, '.block.yml')
self._run_file_rename('./grc/', module + '_' + old,
module + '_' + new, '.block.yml')
def _run_cmakelists(self, path, first, second, suffix):
filename = os.path.join(path, 'CMakeLists.txt')
# space character and suffix ensures similiarly named blocks are not mixed up
nsubs = self._run_file_replace(
filename, ' ' + first + suffix, ' ' + second + suffix)
if nsubs < 1:
logger.info(f"'{first}' wasn't in '{filename}'.")
def _run_file_rename(self, path, old, new, suffix):
old = old + suffix
new = new + suffix
old_regex = '^' + old
files = os.listdir(path)
for file in files:
if re.search(old_regex, file):
nl = file.replace(old, new)
src = os.path.join(path, file)
dst = os.path.join(path, nl)
logger.info(f"Renaming file '{src}' to '{dst}'.")
os.rename(src, dst)
def _run_file_replace(self, filename, old, new):
if not os.path.isfile(filename):
return False
else:
logger.info(
f"In '{filename}' renaming occurrences of '{old}' to '{new}'")
with open(filename) as f:
cfile = f.read()
(cfile, nsubs) = re.subn(old, new, cfile)
with open(filename, 'w') as f:
f.write(cfile)
self.scm.mark_file_updated(filename)
return nsubs
|
