Commit c618f91e authored by Paul Sokolovsky's avatar Paul Sokolovsky
Browse files

py: Rework QSTR extraction to work in simple and obvious way.

When there're C files to be (re)compiled, they're all passed first to
preprocessor. QSTR references are extracted from preprocessed output and
split per original C file. Then all available qstr files (including those
generated previously) are catenated together. Only if the resulting content
has changed, the output file is written (causing almost global rebuild
to pick up potentially renumbered qstr's). Otherwise, it's not updated
to not cause spurious rebuilds. Related make rules are split to minimize
amount of commands executed in the interim case (when some C files were
updated, but no qstrs were changed).
parent 8aa3cbf1
......@@ -20,39 +20,85 @@ def debug(message):
def write_out(fname, output):
if output:
fname = fname.replace("/", "__").replace("..", "@@")
with open(args.output_dir + "/" + fname + ".qstr", "w") as f:
f.write("\n".join(output) + "\n")
def process_file(f):
output = []
last_fname = None
outf = None
for line in f:
if line and line[0] == "#":
comp = line.split()
fname = comp[2]
assert fname[0] == '"' and fname[-1] == '"'
fname = fname[1:-1]
if fname[0] == "/" or not fname.endswith(".c"):
if fname != last_fname:
write_out(last_fname, output)
output = []
last_fname = fname
for match in re.findall(r'MP_QSTR_[_a-zA-Z0-9]+', line):
name = match.replace('MP_QSTR_', '')
if name not in QSTRING_BLACK_LIST:
output.append('Q(' + name + ')')
# make sure there is a newline at the end of the output
return '\n'.join(output)
write_out(last_fname, output)
return ""
def cat_together():
import glob
import hashlib
hasher = hashlib.md5()
all_lines = []
outf = open(args.output_dir + "/out", "wb")
for fname in glob.glob(args.output_dir + "/*.qstr"):
with open(fname, "rb") as f:
lines = f.readlines()
all_lines += lines
all_lines = b"\n".join(all_lines)
new_hash = hasher.hexdigest()
old_hash = None
with open(args.output_file + ".hash") as f:
old_hash =
except IOError:
if old_hash != new_hash:
print("QSTR updated")
os.rename(args.output_dir + "/out", args.output_file)
with open(args.output_file + ".hash", "w") as f:
print("QSTR not updated")
if __name__ == "__main__":
parser = argparse.ArgumentParser(description='Generates qstr definitions from a specified source')
parser.add_argument('-o', '--output-file', dest='output_filename',
help='Output filename (defaults to stdout)')
parser.add_argument('input_filename', nargs='?',
help='Name of the input file (when not specified, the script reads standard input')
parser.add_argument('-s', '--skip-write-when-same', dest='skip_write_when_same',
action='store_true', default=False,
help="Don't write the output file if it already exists and the contents have not changed (disabled by default)")
help='Name of the input file (when not specified, the script reads standard input)')
help='Output directory to store individual qstr files')
help='Name of the output file with collected qstrs')
args = parser.parse_args()
# Check if the file contents changed from last time
write_file = True
# By default write into STDOUT
outfile = sys.stdout
real_output_filename = 'STDOUT'
except OSError:
if args.input_filename:
infile = open(args.input_filename, 'r')
......@@ -61,24 +107,4 @@ if __name__ == "__main__":
file_data = process_file(infile)
# Detect custom output file name
if args.output_filename:
real_output_filename = args.output_filename
if os.path.isfile(args.output_filename) and args.skip_write_when_same:
with open(args.output_filename, 'r') as f:
existing_data =
if existing_data == file_data:
debug("Skip regeneration of: %s\n" % real_output_filename)
write_file = False
debug("File HAS changed, overwriting\n")
outfile = open(args.output_filename, 'w')
outfile = open(args.output_filename, 'w')
# Only write the file if we the data has changed
if write_file:
sys.stderr.write("QSTR %s\n" % real_output_filename)
......@@ -52,7 +52,7 @@ EMPTY_QSTRDEFS_GENERATED_H = $(BUILD)/tmp/genhdr/qstrdefs.generated.h
# List all native flags since the current build system doesn't have
# the micropython configuration available. However, these flags are
# needed to extract all qstrings
vpath %.c . $(TOP)
......@@ -81,13 +81,13 @@ $(EMPTY_QSTRDEFS_GENERATED_H):
# to get built before we try to compile any of them.
$(OBJ): | $(HEADER_BUILD)/qstrdefs.generated.h $(HEADER_BUILD)/mpversion.h
# This rule joins all generated qstr files
$(QSTR_DEFS_COLLECTED): $(addprefix $(HEADER_BUILD)/,$(addsuffix .qstr,$(SRC_QSTR)))
$(HEADER_BUILD)/qstr.i.last: $(SRC_QSTR) | $(HEADER_BUILD)/mpversion.h
$(ECHO) "GEN $@"
$(Q)cat $^ > $@
$(ECHO) "GEN $@"
# $(sort $(var)) removes duplicates
......@@ -93,9 +93,11 @@ const qstr_pool_t mp_qstr_const_pool = {
10, // set so that the first dynamically allocated pool is twice this size; must be <= the len (just below)
MP_QSTRnumber_of, // corresponds to number of strings in array just below
#ifndef __QSTR_EXTRACT
#define QDEF(id, str) str,
#include "genhdr/qstrdefs.generated.h"
#undef QDEF
......@@ -37,9 +37,11 @@
// first entry in enum will be MP_QSTR_NULL=0, which indicates invalid/no qstr
enum {
#ifndef __QSTR_EXTRACT
#define QDEF(id, str) id,
#include "genhdr/qstrdefs.generated.h"
#undef QDEF
MP_QSTRnumber_of, // no underscore so it can't clash with any of the above
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment