diff --git a/ohos/ndk/BUILD.gn b/ohos/ndk/BUILD.gn index 16d6d6dc84eaefb3d976b8391faefea9c6163129..a11b3f258cb092e6dd144976d3dfc2d9d58ae5d5 100755 --- a/ohos/ndk/BUILD.gn +++ b/ohos/ndk/BUILD.gn @@ -47,7 +47,7 @@ if (!use_current_sdk) { write_file(package_info_file, package_info, "json") action_with_pydeps("_collect_ndk_syscap") { - deps = all_ndk_targets_list + deps = [ ":_parse_ndk_headers" ] script = "//build/ohos/ndk/collect_ndk_syscap.py" depfile = "$target_gen_dir/$target_name.d" _ndk_syscap_desc_file = @@ -71,11 +71,21 @@ if (!use_current_sdk) { } } + action_with_pydeps("_parse_ndk_headers") { + deps = all_ndk_targets_list + script = "//build/ohos/ndk/parse_ndk_headers.py" + outputs = [ "${ndk_os_irrelevant_out_dir}/parse_ndk_headers.tmp" ] + args = [ + "--input", + rebase_path("$ndk_headers_out_dir", root_build_dir), + ] + } + if (!defined(ext_ndk_config_file) || ext_ndk_config_file == "") { action_with_pydeps("_clean_ndk_ani") { deps = [ ":_collect_ndk_syscap" ] script = "//interface/sdk_c/build-tools/clean_ndk_ani.py" - outputs = [ "${ndk_os_irrelevant_out_dir}/clean_ndk_ani.json" ] + outputs = [ "${ndk_os_irrelevant_out_dir}/clean_ndk_ani_header.tmp" ] _native_syscap_config_file = "${ndk_os_irrelevant_out_dir}/nativeapi_syscap_config.json" args = [ diff --git a/ohos/ndk/parse_ndk_headers.py b/ohos/ndk/parse_ndk_headers.py new file mode 100755 index 0000000000000000000000000000000000000000..b3b7d3eba427c44d79defe235cbd2dc00603b9fa --- /dev/null +++ b/ohos/ndk/parse_ndk_headers.py @@ -0,0 +1,309 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright (c) 2025 Huawei Device Co., Ltd. +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import argparse +import re +import sys +import os +import time +from typing import Optional, Tuple + + +# 不需要处理的目录 +_DIR_BLACKLIST = [ + "aarch64-linux-ohos", + "arm-linux-ohos", + "arpa", + "asm-generic", + "asm-loongarch", + "asm-mips", + "asm-riscv", + "drm", + "EGL", + "fortify", + "GLES2", + "GLES3", + "i686-linux-ohos", + "KHR", + "linux", + "mtd", + "rdma", + "scsi", + "SLES", + "sound", + "sys", + "unicode", + "uv", + "video", + "vk_video", + "vulkan", + "x86_64-linux-ohos" +] + + +# 根目录白名单文件,根目录下面的头文件一般无需处理 +_ROOT_FILES_WHITELIST = [ + "deviceinfo.h", + "syscap_ndk.h" +] + + +class HeaderProcessor: + MAX_LINE_LENGTH = 120 # 最大行长度限制（超过则换行显示版本宏） + + + def __init__(self): + # 头文件保护宏正则 + self.guard_pattern = re.compile(r'^#define\s+([A-Za-z0-9_]+_H(_)?)\s*$', re.MULTILINE) + + # 先匹配带@since的注释块 + self.since_comment_pattern = re.compile( + r'(?P/\*\*[^\*]*(?:\*(?!/)[^\*]*)*@since\s+\S+[^\*]*(?:\*(?!/)[^\*]*)*\*/)' # 带@since的完整注释块 + r'(?P[\s\n\r]*)' # 注释块后仅允许空格/制表符（无空行) + r'(?P\w+|extern)', # 后续代码的起始特征（字段/接口） + re.MULTILINE | re.DOTALL + ) + + # 字段判断正则 + self.extern_field_start_pattern = re.compile(r'^extern\s+(?!\"C\"\s*\{)[^(){}\[\]]*?;', re.DOTALL) + # 接口判断正则 + self.func_interface_start_pattern = re.compile( + r'^(?!typedef|.*inline)' # 排除typedef和含inline的声明 + r'[\w\s\*]+?\b\w+\s*\(' # 匹配返回值+函数名+左括号（支持指针类型） + r'[^;]*?' # 匹配任意参数（包括__restrict、const等修饰符），直到遇到分号 + r'\)\s*;' # 右括号+分号（确保是纯声明，非函数体） + , re.MULTILINE | re.DOTALL + ) + + # @since支持两种格式：数字或x.y.z(n) + self.since_pattern = re.compile(r'@since\s+(\d+(?:\.\d+\.\d+\(\d+\))?)') + # @deprecated since仅支持数字格式 + self.deprecated_pattern = re.compile(r'@deprecated since\s+(\d+)') + + # 严格注释验证正则（允许*/前有空格/制表符） + self.strict_comment_pattern = re.compile(r'^\s*\*/\s*$', re.MULTILINE) + + + def process_file(self, file_path: str) -> None: + """处理单个头文件""" + try: + with open(file_path, 'r+', encoding='utf-8') as f: + content = f.read() + modified, has_changes = self._process_content(content) + + if has_changes: + f.seek(0) + f.write(modified) + f.truncate() + print(f"modify success: {file_path}") + else: + print(f"No modifications are needed: {file_path}") + except Exception as e: + print(f"Processing failed. {file_path}: {str(e)}") + + + def _process_content(self, content: str) -> tuple[str, bool]: + """处理文件内容逻辑：先处理注释块关联的字段/接口，最后添加版本引用""" + original_content = content + # 处理所有带@since注释块关联的字段/接口 + content = self._process_since_comment_related_code(content) + + has_changes = content != original_content + if has_changes: + # 有改动则添加头文件 + content = self._add_version_include(content) + + return content, has_changes + + + def _process_since_comment_related_code(self, content: str) -> str: + """处理带@since注释块关联的字段或接口""" + # 找到所有带@since且后续有代码的合规注释块 + comment_matches = list(self.since_comment_pattern.finditer(content)) + # 倒序处理：先修改后面的注释块，避免前面修改导致后面索引错位 + for match in reversed(comment_matches): + comment_block = match.group('comment') + whitespace = match.group('whitespace') + # 代码块起始索引 + code_start_idx = match.start('code_start') + + # 提取注释块后的第一个完整代码块（字段或接口） + code_block, code_end_idx = self._extract_single_code_block(content, code_start_idx) + if not code_block: + continue # 无有效代码块，跳过 + + # 提取版本信息 + since_version = self._extract_tag(comment_block, self.since_pattern) + if not since_version: + continue # 无@since版本，跳过 + deprecated_version = self._extract_tag(comment_block, self.deprecated_pattern) or '0' + + # 根据版本信息生成宏 + version_macro = self._get_version_macro(since_version, deprecated_version) + # 格式化代码块 + formatted_code = self._format_declaration(code_block.rstrip(';'), version_macro) + ';' + + # 替换原注释块+代码块内容 + old_segment = comment_block + whitespace + content[code_start_idx:code_end_idx] + new_segment = comment_block + whitespace + formatted_code + content = content.replace(old_segment, new_segment, 1) + + return content + + + def _extract_single_code_block(self, content: str, start_idx: int) -> Tuple[Optional[str], int]: + """从start_idx提取第一个完整代码块（字段或接口），仅取紧接注释块的第一个""" + remaining_content = content[start_idx:] + + # 判断是否为extern字段 + field_match = self.extern_field_start_pattern.match(remaining_content) + if field_match: + field_content = field_match.group(0).strip() + end_idx = start_idx + field_match.end() + return (field_content, end_idx) + + # 判断是否为函数接口（支持多行，通过括号配对确认完整性） + interface_match = self.func_interface_start_pattern.match(remaining_content) + if interface_match: + interface_content = interface_match.group(0).strip() + end_idx = start_idx + interface_match.end() + # 二次确认括号完整性 + if interface_content.count('(') == interface_content.count(')'): + return (interface_content, end_idx) + + # 非字段/接口或不完整代码块 + return (None, -1) + + + def _add_version_include(self, content: str) -> str: + """在头文件保护宏后添加#include "info/application_target_sdk_version.h"，无保护宏则在第一个#include前添加""" + target_include = '#include "info/application_target_sdk_version.h"' + + # 尝试在头文件保护宏后添加 + def replacer(match): + return f"{match.group(0)}\n{target_include}" + content_with_include = self.guard_pattern.sub(replacer, content, count=1) + + # 若未添加成功（未匹配到保护宏），在第一个#include前插入 + if target_include not in content_with_include: + first_include_match = re.search(r'^\s*#include', content_with_include, re.MULTILINE) + if first_include_match: + insert_pos = first_include_match.start() + content_with_include = ( + content_with_include[:insert_pos] + + f"{target_include}\n" + + content_with_include[insert_pos:] + ) + + return content_with_include + + + def _get_version_macro(self, since_version: str, deprecated_version: str) -> str: + """根据since版本格式和deprecated数字生成对应宏""" + distributeos_pattern = re.compile(r'^(\d+)\.(\d+)\.(\d+)\((\d+)\)$') + since_match = distributeos_pattern.match(since_version) + + if since_match: + # 生成__DISTRIBUTEOS_AVAILABILITY宏 + major, minor, patch, oh_version = since_match.groups() + return (f'__DISTRIBUTEOS_AVAILABILITY(__HMS_VERSION({major},{minor.zfill(2)},{patch.zfill(2)}), ' + f'__OH_VERSION({oh_version},{deprecated_version}))') + else: + # 纯数字格式，生成__OH_AVAILABILITY宏 + return f'__OH_AVAILABILITY(__OH_VERSION({since_version},{deprecated_version}))' + + + def _format_declaration(self, decl: str, macro: str) -> str: + """格式化声明：根据行长度决定单行或换行显示，保留原缩进""" + last_line = decl.split('\n')[-1] + # 计算原缩进长度 + indent_length = len(last_line) - len(last_line.lstrip()) + indent = ' ' * indent_length + + # 尝试单行显示 + combined = f"{decl.rstrip()} {macro}" + if len(combined) <= self.MAX_LINE_LENGTH: + return combined + + # 单行超宽，换行显示宏 + return f"{decl.rstrip()}\n{indent}{macro}" + + + def _extract_tag(self, text: str, pattern: re.Pattern) -> Optional[str]: + """从文本中提取指定标签的值（如@since、@deprecated since）""" + tag_match = pattern.search(text) + return tag_match.group(1) if tag_match else None + + +def _is_blacklist_dir(rel_path: str) -> bool: + """判断目录是否需要处理（仅检查第一级子目录）""" + first_level_dir = rel_path.split(os.sep)[0] + return first_level_dir in _DIR_BLACKLIST + + +def _process_root_files(root: str, processor: HeaderProcessor) -> None: + """处理根目录下的白名单文件""" + for file_name in os.listdir(root): + if file_name in _ROOT_FILES_WHITELIST and file_name.endswith('.h'): + processor.process_file(os.path.join(root, file_name)) + + +def _process_subdir_files(root: str, processor: HeaderProcessor) -> None: + """处理子目录下的所有.h文件""" + for file_name in os.listdir(root): + if file_name.endswith('.h'): + processor.process_file(os.path.join(root, file_name)) + + +def add_files_to_process(header_path, recursive=True): + """遍历目录并处理符合条件的头文件""" + abs_root_dir = os.path.abspath(header_path) + header_processor = HeaderProcessor() + + for root, dirs, files in os.walk(abs_root_dir, topdown=True): + rel_dir_path = os.path.relpath(root, abs_root_dir) + + if root == abs_root_dir: + _process_root_files(root, header_processor) + continue + + if _is_blacklist_dir(rel_dir_path): + dirs[:] = [] + print(f"the dir is in blacklists: {root}") + continue + + _process_subdir_files(root, header_processor) + + +def main(): + parser = argparse.ArgumentParser(description="Process ndk header files to add version macros.") + parser.add_argument('--input', required=True, help="NDK头文件路径") + args = parser.parse_args() + + if not os.path.exists(args.input): + print(f"ndk header path does not exist -> {args.input}") + exit(1) + + # 记录开始处理时间 + start_time = time.time() + add_files_to_process(args.input) + # 计算并打印总处理时间 + end_time = time.time() + total_time = end_time - start_time + print(f"\nTotal processing time: {total_time:.2f} seconds") + + +if __name__ == '__main__': + sys.exit(main()) \ No newline at end of file diff --git a/ohos/ndk/parse_ndk_headers.pydeps b/ohos/ndk/parse_ndk_headers.pydeps new file mode 100644 index 0000000000000000000000000000000000000000..68aff820f16e7e4c8046d859339ed0a6bcddf48c --- /dev/null +++ b/ohos/ndk/parse_ndk_headers.pydeps @@ -0,0 +1,9 @@ +# Generated by running: +# build/print_python_deps.py --root build/ohos/ndk --output build/ohos/ndk/parse_ndk_headers.pydeps build/ohos/ndk/parse_ndk_headers.py +../../gn_helpers.py +../../scripts/__init__.py +../../scripts/util/__init__.py +../../scripts/util/build_utils.py +../../scripts/util/md5_check.py +../../scripts/util/pycache.py +parse_ndk_headers.py