[reggen] Wrap output to meet code standards
Fixes #578
regtool could output comments and #defines that went over the 80
character line limit leading to a failure of C/C++ lint checking. This
fixes all instances of that currently seen but doesn't entirely prevent
it.
Included with the commit are the new results of running regtool which
pass the C/C++ lint checks.
diff --git a/util/reggen/gen_cheader.py b/util/reggen/gen_cheader.py
index 84ad28e..7f8836d 100644
--- a/util/reggen/gen_cheader.py
+++ b/util/reggen/gen_cheader.py
@@ -9,6 +9,7 @@
import logging as log
import re
import sys
+import textwrap
def genout(outfile, msg):
@@ -23,19 +24,71 @@
return r
-def clean_desc(s):
+def first_line(s):
+ """Returns the first line of a multi-line string"""
return s.splitlines()[0]
+def format_comment(s):
+ """Formats a string to comment wrapped to an 80 character line width
+
+ Returns wrapped string including newline and // comment characters.
+ """
+ return '\n'.join(
+ textwrap.wrap(
+ s, width=77, initial_indent='// ', subsequent_indent='// ')) + '\n'
+
+
+def gen_define(name, args, body, indent=' '):
+ r"""Produces a #define string, will split into two lines if a single line
+ has a width greater than 80 characters. Result includes newline.
+
+ Arguments:
+ name - Name of the #define
+ args - List of arguments for the define, provide an empty list if there are
+ none
+ body - Body of the #define
+ indent - Gives string to prepend on any new lines produced by
+ wrapping (default ' ')
+
+ Example result:
+ name = 'A_MACRO'
+ args = ['arg1', 'arg2'],
+ body = 'arg1 + arg2 + 10'
+
+ #define A_MACRO(arg1, arg2) arg1 + arg2 + 10
+
+ When the macro is wrapped the break happens after the argument list (or
+ macro name if there is no argument list
+
+ #define A_MACRO(arg1, arg2) \
+ arg1 + arg2 + 10
+
+ """
+ if len(args) != 0:
+ define_declare = '#define ' + name + '(' + ', '.join(args) + ')'
+ else:
+ define_declare = '#define ' + name
+
+ oneline_define = define_declare + ' ' + body
+
+ if len(oneline_define) <= 80:
+ return oneline_define + '\n'
+
+ return define_declare + ' \\\n' + indent + body + '\n'
+
+
def gen_cdefine_register(outstr, reg, comp, width, rnames):
rname = reg['name']
offset = reg['genoffset']
- genout(outstr, '// ' + clean_desc(reg['desc']) + '\n')
+ genout(outstr, format_comment(first_line(reg['desc'])))
defname = as_define(comp + '_' + rname)
genout(
- outstr, '#define ' + defname + '(id) (' + as_define(comp) +
- '##id##_BASE_ADDR + ' + hex(offset) + ')\n')
+ outstr,
+ gen_define(
+ defname, ['id'],
+ '(' + as_define(comp) + '##id##_BASE_ADDR + ' + hex(offset) + ')'))
for field in reg['fields']:
fieldlsb = field['bitinfo'][2]
@@ -47,22 +100,22 @@
if field['bitinfo'][1] == 1:
# single bit
- genout(outstr, '#define ' + dname + ' ' + str(fieldlsb) + '\n')
+ genout(outstr, gen_define(dname, [], str(fieldlsb)))
else:
# multiple bits (unless it is the whole register)
if field['bitinfo'][1] != width:
mask = field['bitinfo'][0] >> fieldlsb
- genout(outstr,
- '#define ' + dname + '_MASK ' + hex(mask) + '\n')
- genout(outstr,
- '#define ' + dname + '_OFFSET ' + str(fieldlsb) + '\n')
+ genout(outstr, gen_define(dname + '_MASK', [], hex(mask)))
+ genout(outstr, gen_define(dname + '_OFFSET', [],
+ str(fieldlsb)))
if 'enum' in field:
for enum in field['enum']:
ename = as_define(enum['name'])
genout(
outstr,
- '#define ' + defname + '_' + as_define(field['name']) +
- '_' + ename + ' ' + enum['value'] + '\n')
+ gen_define(
+ defname + '_' + as_define(field['name']) + '_' +
+ ename, [], enum['value']))
genout(outstr, '\n')
return
@@ -71,20 +124,22 @@
wname = win['name']
offset = win['genoffset']
- genout(outstr, '// Memory area: ' + clean_desc(win['desc']) + '\n')
+ genout(outstr, format_comment('Memory area: ' + first_line(win['desc'])))
defname = as_define(comp + '_' + wname)
genout(
- outstr, '#define ' + defname + '(id) (' + as_define(comp) +
- '##id##_BASE_ADDR + ' + hex(offset) + ')\n')
+ outstr,
+ gen_define(
+ defname, ['id'],
+ '(' + as_define(comp) + '##id##_BASE_ADDR + ' + hex(offset) + ')'))
items = int(win['items'])
- genout(outstr, '#define ' + defname + '_SIZE_WORDS ' + str(items) + '\n')
+ genout(outstr, gen_define(defname + '_SIZE_WORDS', [], str(items)))
items = items * (regwidth // 8)
- genout(outstr, '#define ' + defname + '_SIZE_BYTES ' + str(items) + '\n')
+ genout(outstr, gen_define(defname + '_SIZE_BYTES', [], str(items)))
wid = win['genvalidbits']
if (wid != regwidth):
mask = (1 << wid) - 1
- genout(outstr, '#define ' + defname + '_MASK ' + hex(mask) + '\n')
+ genout(outstr, gen_define(defname + '_MASK ', [], hex(mask)))
# Must have called validate, so should have no errors
@@ -145,3 +200,37 @@
genout(outfile, '// End generated register defines for ' + component)
return
+
+
+def test_gen_define():
+ basic_oneline = '#define MACRO_NAME body\n'
+ assert gen_define('MACRO_NAME', [], 'body') == basic_oneline
+
+ basic_oneline_with_args = '#define MACRO_NAME(arg1, arg2) arg1 + arg2\n'
+ assert (gen_define('MACRO_NAME', ['arg1', 'arg2'],
+ 'arg1 + arg2') == basic_oneline_with_args)
+
+ long_macro_name = 'A_VERY_VERY_VERY_VERY_VERY_VERY_VERY_VERY_VERY_VERY_VERY_LONG_MACRO_NAME'
+
+ multiline = ('#define ' + long_macro_name + ' \\\n' +
+ ' a_fairly_long_body + something_else + 10\n')
+
+ assert (gen_define(
+ long_macro_name, [],
+ 'a_fairly_long_body + something_else + 10') == multiline)
+
+ multiline_with_args = ('#define ' + long_macro_name +
+ '(arg1, arg2, arg3) \\\n' +
+ ' a_fairly_long_body + arg1 + arg2 + arg3\n')
+
+ assert (gen_define(
+ long_macro_name, ['arg1', 'arg2', 'arg3'],
+ 'a_fairly_long_body + arg1 + arg2 + arg3') == multiline_with_args)
+
+ multiline_with_args_big_indent = (
+ '#define ' + long_macro_name + '(arg1, arg2, arg3) \\\n' +
+ ' a_fairly_long_body + arg1 + arg2 + arg3\n')
+
+ assert (gen_define(long_macro_name, ['arg1', 'arg2', 'arg3'],
+ 'a_fairly_long_body + arg1 + arg2 + arg3',
+ indent=' ') == multiline_with_args_big_indent)
