Zxc200611/pocketpy
1
0
Fork 0
mirror of https://github.com/pocketpy/pocketpy synced 2025-10-20 03:20:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adding Documentation to amalgamate.py

Browse Source 
Adding Documentation to amalgamate.py
This commit is contained in:
Anindhiths 2025-03-19 18:11:07 +05:30 committed by GitHub
parent c502ce172f
commit ba1b6499aa
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 182 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

296
amalgamate.py
View File

@ -5,11 +5,16 @@ import sys
import time import time
from typing import List, Dict from typing import List, Dict
# Run the prebuild script before starting the amalgamation process
assert os.system("python prebuild.py") == 0 assert os.system("python prebuild.py") == 0
# Define the root directory containing headers
ROOT = 'include/pocketpy' ROOT = 'include/pocketpy'
# List of public headers that will be included in the final amalgamated header
PUBLIC_HEADERS = ['config.h', 'export.h', 'linalg.h', 'pocketpy.h'] PUBLIC_HEADERS = ['config.h', 'export.h', 'linalg.h', 'pocketpy.h']
# Copyright notice to be added at the beginning of amalgamated files
COPYRIGHT = '''/* COPYRIGHT = '''/*
* Copyright (c) 2025 blueloveTH * Copyright (c) 2025 blueloveTH
* Distributed Under The MIT License * Distributed Under The MIT License
@ -18,142 +23,205 @@ COPYRIGHT = '''/*
''' '''
def read_file(path): def read_file(path):
with open(path, 'rt', encoding='utf-8') as f: """Read the content of a file with UTF-8 encoding."""
return f.read() with open(path, 'rt', encoding='utf-8') as f:
return f.read()
def write_file(path, content): def write_file(path, content):
with open(path, 'wt', encoding='utf-8', newline='\n') as f: """Write content to a file with UTF-8 encoding and Unix line endings."""
f.write(content) with open(path, 'wt', encoding='utf-8', newline='\n') as f:
f.write(content)
if os.path.exists('amalgamated'):
shutil.rmtree('amalgamated')
time.sleep(0.5)
# Remove existing amalgamated directory if it exists and create a new one
if os.path.exists('amalgamated'):
shutil.rmtree('amalgamated')
time.sleep(0.5) # Wait briefly to ensure directory is fully removed
os.mkdir('amalgamated') os.mkdir('amalgamated')
class Header: class Header:
path: str """
content: str # header source Class to represent and process a header file.
dependencies: List[str]
Attributes:
def __init__(self, path: str): path: Relative path to the header file
self.path = path content: Processed content of the header file
self.dependencies = [] dependencies: List of other headers this header depends on
self.content = read_file(f'{ROOT}/{path}') """
path: str
# process raw content and get dependencies content: str
self.content = self.content.replace('#pragma once', '') dependencies: List[str]
def _replace(m):
path = m.group(1) def __init__(self, path: str):
if path.startswith('xmacros/'): """
return read_file(f'{ROOT}/{path}') + '\n' Initialize a Header object.
if path in PUBLIC_HEADERS:
return '' # remove include Args:
if path != self.path: path: Relative path to the header file
self.dependencies.append(path) """
return '' # remove include self.path = path
self.dependencies = []
self.content = re.sub( self.content = read_file(f'{ROOT}/{path}')
r'#include\s+"pocketpy/(.+)"\s*',
_replace, # Process raw content and extract dependencies
self.content self.content = self.content.replace('#pragma once', '') # Remove pragma once directives
)
def _replace(m):
def __repr__(self): """
return f'Header({self.path!r}, dependencies={self.dependencies})' Process #include directives in the header.
def text(self): Returns:
return f'// {self.path}\n{self.content}\n' - For xmacros: the content of the included file
- For public headers: empty string (removed)
- For other headers: empty string and adds the header to dependencies
"""
path = m.group(1)
if path.startswith('xmacros/'):
return read_file(f'{ROOT}/{path}') + '\n' # Inline xmacros directly
if path in PUBLIC_HEADERS:
return '' # Remove includes of public headers
if path != self.path:
self.dependencies.append(path) # Add to dependencies
return '' # Remove include directive
# Process all include directives
self.content = re.sub(
r'#include\s+"pocketpy/(.+)"\s*',
_replace,
self.content
)
def __repr__(self):
"""Return string representation of the Header object."""
return f'Header({self.path!r}, dependencies={self.dependencies})'
def text(self):
"""Return the processed header content with a comment indicating its source."""
return f'// {self.path}\n{self.content}\n'
# Dictionary to store all header objects
headers: Dict[str, Header] = {} headers: Dict[str, Header] = {}
# Process all header files in the ROOT directory
for entry in os.listdir(ROOT): for entry in os.listdir(ROOT):
if os.path.isdir(f'{ROOT}/{entry}'): if os.path.isdir(f'{ROOT}/{entry}'):
if entry == 'xmacros' or entry in PUBLIC_HEADERS: if entry == 'xmacros' or entry in PUBLIC_HEADERS:
continue continue # Skip xmacros directory and public headers
files = os.listdir(f'{ROOT}/{entry}') files = os.listdir(f'{ROOT}/{entry}')
for file in sorted(files): for file in sorted(files):
assert file.endswith('.h') assert file.endswith('.h') # Ensure we're only processing header files
if entry in PUBLIC_HEADERS: if entry in PUBLIC_HEADERS:
continue continue
headers[f'{entry}/{file}'] = Header(f'{entry}/{file}') headers[f'{entry}/{file}'] = Header(f'{entry}/{file}')
def merge_c_files(): def merge_c_files():
c_files = [COPYRIGHT, '\n', '#include "pocketpy.h"', '\n'] """
Merge all C source files into a single file.
# merge internal headers
internal_h = [] Uses a topological sort to ensure headers are included in the correct order
while True: based on their dependencies.
for h in headers.values():
if not h.dependencies: Returns:
break String containing the amalgamated C source
else: """
if headers: c_files = [COPYRIGHT, '\n', '#include "pocketpy.h"', '\n'] # Start with copyright and main include
print(headers)
raise RuntimeError("Circular dependencies detected") # Merge internal headers in dependency order
break internal_h = []
# print(h.path) while True:
internal_h.append(h.text()) # Find a header with no dependencies
del headers[h.path] for h in headers.values():
for h2 in headers.values(): if not h.dependencies:
h2.dependencies = [d for d in h2.dependencies if d != h.path] break
else:
c_files.extend(internal_h) # If no headers without dependencies were found and headers still remain,
# there must be a circular dependency
def _replace(m): if headers:
path = m.group(1) print(headers)
if path.startswith('xmacros/'): raise RuntimeError("Circular dependencies detected")
return read_file(f'{ROOT}/{path}') + '\n' break # No headers left, we're done
return '' # remove include
# Add this header to the amalgamated file
for root, _, files in os.walk('src/'): internal_h.append(h.text())
for file in files: del headers[h.path]
if file.endswith('.c'):
path = os.path.join(root, file) # Remove this header from the dependencies of other headers
c_files.append(f'// {path}\n') for h2 in headers.values():
content = read_file(path) h2.dependencies = [d for d in h2.dependencies if d != h.path]
content = re.sub(
r'#include\s+"pocketpy/(.+)"\s*', c_files.extend(internal_h)
_replace,
content, def _replace(m):
) """Process include directives in C files."""
c_files.append(content) path = m.group(1)
c_files.append('\n') if path.startswith('xmacros/'):
return ''.join(c_files) return read_file(f'{ROOT}/{path}') + '\n' # Inline xmacros
return '' # Remove other includes
# Process all C source files
for root, _, files in os.walk('src/'):
for file in files:
if file.endswith('.c'):
path = os.path.join(root, file)
c_files.append(f'// {path}\n') # Add comment with original file path
content = read_file(path)
# Process include directives
content = re.sub(
r'#include\s+"pocketpy/(.+)"\s*',
_replace,
content,
)
c_files.append(content)
c_files.append('\n')
return ''.join(c_files)
def merge_h_files(): def merge_h_files():
h_files = [COPYRIGHT, '#pragma once'] """
Merge all public header files into a single header file.
def _replace(m):
path = m.group(1) Returns:
if path.startswith('xmacros/'): String containing the amalgamated header
return read_file(f'{ROOT}/{path}') + '\n' """
return '' # remove include h_files = [COPYRIGHT, '#pragma once'] # Start with copyright and pragma once
for path in PUBLIC_HEADERS: def _replace(m):
content = read_file(f'{ROOT}/{path}') """Process include directives in header files."""
content = content.replace('#pragma once', '') path = m.group(1)
content = re.sub( if path.startswith('xmacros/'):
r'#include\s+"pocketpy/(.+)"\s*', return read_file(f'{ROOT}/{path}') + '\n' # Inline xmacros
_replace, return '' # Remove other includes
content,
) # Process all public headers
h_files.append(content) for path in PUBLIC_HEADERS:
return '\n'.join(h_files) content = read_file(f'{ROOT}/{path}')
content = content.replace('#pragma once', '') # Remove pragma once directives
# Process include directives
content = re.sub(
r'#include\s+"pocketpy/(.+)"\s*',
_replace,
content,
)
h_files.append(content)
return '\n'.join(h_files)
# Generate amalgamated files
write_file('amalgamated/pocketpy.c', merge_c_files()) write_file('amalgamated/pocketpy.c', merge_c_files())
write_file('amalgamated/pocketpy.h', merge_h_files()) write_file('amalgamated/pocketpy.h', merge_h_files())
# Copy the main.c file to the amalgamated directory
shutil.copy("src2/main.c", "amalgamated/main.c") shutil.copy("src2/main.c", "amalgamated/main.c")
# Test compile on Linux or macOS
if sys.platform in ['linux', 'darwin']: if sys.platform in ['linux', 'darwin']:
ok = os.system("gcc -o main amalgamated/pocketpy.c amalgamated/main.c -O1 --std=c11 -lm -ldl") ok = os.system("gcc -o main amalgamated/pocketpy.c amalgamated/main.c -O1 --std=c11 -lm -ldl")
if ok == 0: if ok == 0:
print("Test build success!") print("Test build success!")
print("amalgamated/pocketpy.h") print("amalgamated/pocketpy.h")
# Copy the amalgamated files to the Flutter plugin directory
shutil.copy("amalgamated/pocketpy.h", "plugins/flutter/pocketpy/src/pocketpy.h") shutil.copy("amalgamated/pocketpy.h", "plugins/flutter/pocketpy/src/pocketpy.h")
shutil.copy("amalgamated/pocketpy.c", "plugins/flutter/pocketpy/src/pocketpy.c") shutil.copy("amalgamated/pocketpy.c", "plugins/flutter/pocketpy/src/pocketpy.c")