mirror/pico-sdk
1
0
Fork 0
mirror of https://github.com/raspberrypi/pico-sdk.git synced 2025-04-16 23:43:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Handle newlines elsewhere - just remove #

Browse Source 
Also print warnings for functions missing descriptions
This commit is contained in:
William Vinnicombe 2025-04-14 15:26:32 +01:00
parent 078986dcc5
commit 677667dc0d
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
tools/extract_cmake_functions.py
View File

@ -30,6 +30,7 @@ outfile = sys.argv[2] if len(sys.argv) > 2 else 'pico_cmake_functions.tsv'
CMAKE_FUNCTION_RE = re.compile(r'^#(.*)((\n\s*#.*)*)\nfunction\(([^\s]*)', re.MULTILINE)
CMAKE_PICO_FUNCTIONS_RE = re.compile(r'^\s*function\((pico_[^\s]*)', re.MULTILINE)
all_functions = {}
@ -37,7 +38,6 @@ all_functions = {}
# Scan all CMakeLists.txt and .cmake files in the specific path, recursively.
for dirpath, dirnames, filenames in os.walk(scandir):
# dirnames[:] = [d for d in dirnames if d != "lib"]
for filename in filenames:
group = os.path.basename(dirpath)
file_ext = os.path.splitext(filename)[1]
@ -50,13 +50,15 @@ for dirpath, dirnames, filenames in os.walk(scandir):
name = match.group(4)
signature = match.group(1).strip()
description = match.group(2)
description = description.strip('#').strip('\n')
description = description.replace('\n#\n', ';').strip()
description = description.replace('\n#', '').strip()
description = description.replace('#', '').strip()
if signature.startswith(name):
all_functions[name] = (signature, description, group)
for match in CMAKE_PICO_FUNCTIONS_RE.finditer(text):
name = match.group(1)
if name not in all_functions:
print(f"Warning: {name} function has no description")
with open(outfile, 'w', newline='') as csvfile:
fieldnames = ('name', 'signature', 'description', 'group')