From db5d659762bbdf6608b320434d161e87f2c78d58 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Tue, 2 Jun 2020 10:44:18 +1000 Subject: [PATCH] docs: Log the full list of macros, remove code-style macros to prevent Doxygen errors --- docs/idf_extensions/gen_defines.py | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/docs/idf_extensions/gen_defines.py b/docs/idf_extensions/gen_defines.py index 8effe6bc2..da5f325f1 100644 --- a/docs/idf_extensions/gen_defines.py +++ b/docs/idf_extensions/gen_defines.py @@ -7,6 +7,7 @@ import glob import os +import pprint import subprocess import re @@ -32,6 +33,11 @@ def generate_defines(app, project_description): for soc_header in soc_headers: defines.update(get_defines(soc_header, sdk_config_path)) + # write a list of definitions to make debugging easier + with open(os.path.join(app.config.build_dir, "macro-definitions.txt"), "w") as f: + pprint.pprint(defines, f) + print("Saved macro list to %s" % f.name) + add_tags(app, defines) app.emit('idf-defines-generated', defines) @@ -48,8 +54,14 @@ def get_defines(header_path, sdk_config_path): for line in processed_output.split("\n"): line = line.strip() m = re.search("#define ([^ ]+) ?(.*)", line) - if m and not m.group(1).startswith("_"): - defines[m.group(1)] = m.group(2) + if m: + name = m.group(1) + value = m.group(2) + if name.startswith("_"): + continue # toolchain macro + if (" " in value) or ("=" in value): + value = "" # macros that expand to multiple tokens (ie function macros) cause doxygen errors, so just mark as 'defined' + defines[name] = value return defines @@ -69,4 +81,4 @@ def setup(app): app.connect('idf-info', generate_defines) app.add_event('idf-defines-generated') - return {'parallel_read_safe': True, 'parallel_write_safe': True, 'version': '0.1'} + return {'parallel_read_safe': True, 'parallel_write_safe': True, 'version': '0.2'}