Commit dbbf0827 authored by Pavel Moravec's avatar Pavel Moravec Committed by Damien George
Browse files

py/makeqstrdefs: Add script to automate extraction of qstr from sources.

This script will search for patterns of the form Q(...) and generate a
list of them.

The original code by Pavel Moravec has been significantly simplified to
remove the part that searched for C preprocessor directives (eg #if).
This is because all source is now run through CPP before being fed into
this script.
parent 050e645e
This script processes the output from the C preprocessor and extracts all
qstr. Each qstr is transformed into a qstr definition of the form 'Q(...)'.
This script works with Python 2.6, 2.7, 3.3 and 3.4.
import sys
import re
import argparse
import os
# Blacklist of qstrings that are specially handled in further
# processing and should be ignored
QSTRING_BLACK_LIST = {'NULL', 'number_of', }
def debug(message):
#sys.stderr.write("%s\n" % message)
def process_file(f):
output = []
for line in f:
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)
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)")
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'
if args.input_filename:
infile = open(args.input_filename, 'r')
infile = sys.stdin
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)
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