From 236d75e67d936055c5a7656d644ce7fd87d992dd Mon Sep 17 00:00:00 2001 From: Jonathan Schwender Date: Wed, 4 Dec 2024 14:06:59 +0100 Subject: [PATCH] Remove old generator script Wrap the new generator instead and run the formatter after. Signed-off-by: Jonathan Schwender --- scripts/generate_bindings.sh | 380 +---------------------------------- scripts/generator/Cargo.toml | 3 + 2 files changed, 8 insertions(+), 375 deletions(-) diff --git a/scripts/generate_bindings.sh b/scripts/generate_bindings.sh index 6ce7ec8..d667d5e 100755 --- a/scripts/generate_bindings.sh +++ b/scripts/generate_bindings.sh @@ -1,383 +1,13 @@ #!/usr/bin/env bash # Deprecated script. Use the generator written in Rust instead. - -set -eu - -if [ "${BASH_VERSINFO:-0}" -le 4 ]; then - echo "Your installed version of bash is too old." - echo "If you are using a mac, please install bash from homebrew." - exit 1 -fi +set -eux ROOT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )"/.. &> /dev/null && pwd ) -if ! command -v bindgen -then - echo "Error: bindgen not found. Please install it." - exit 1 -fi - -if ! command -v jq -then - echo "Error: jq not found. Please install it." - exit 1 -fi - -if [[ -z "${OHOS_SDK_NATIVE}" ]] -then - echo "OHOS_SDK_NATIVE was not set. Please set it to the base directory of the OHOS NDK" - echo "Note: the NDK directory is the 'native' directory in the SDK" - exit 1 -fi - -if [[ ! -d "${OHOS_SDK_NATIVE}" ]] -then - echo "OHOS_SDK_NATIVE was set to '${OHOS_SDK_NATIVE}', which is not a valid directory" - exit 1 -fi - -OHOS_SYSROOT_DIR="${OHOS_SDK_NATIVE}/sysroot" -if [[ ! -d "${OHOS_SYSROOT_DIR}" ]] -then - echo "OpenHarmony sysroot not found under \${OHOS_SDK_NATIVE}/sysroot (${OHOS_SDK_NATIVE}/sysroot)" - exit 1 -fi - -export LIBCLANG_PATH=${OHOS_SDK_NATIVE}/llvm/lib -export CLANG_PATH=${OHOS_SDK_NATIVE}/llvm/bin/clang - -OHOS_API_VERSION=$(jq '.apiVersion' -j < "${OHOS_SDK_NATIVE}/oh-uni-package.json") -echo "Generating bindings for API version ${OHOS_API_VERSION}" -PREVIOUS_API_VERSION=$((OHOS_API_VERSION - 1)) - -BASE_BINDGEN_ARGS=(--no-layout-tests --formatter=prettyplease --merge-extern-blocks --rust-target=1.77) -BASE_BINDGEN_ARGS+=(--blocklist-file='.*stdint\.h' --blocklist-file='.*stddef\.h') -BASE_BINDGEN_ARGS+=(--blocklist-file='.*stdarg\.h' --blocklist-file='.*stdbool\.h') -BASE_BINDGEN_ARGS+=(--blocklist-file='.*/std[a-z]{3,4}\.h' --blocklist-file='.*/__std[a-z_]+\.h') -BASE_BINDGEN_ARGS+=(--blocklist-item='__(BYTE_ORDER|LONG_MAX|LITTLE_ENDIAN|BIG_ENDIAN|USE_TIME_BITS64)') -BASE_BINDGEN_ARGS+=(--blocklist-item='u?intmax_t') -BASE_BINDGEN_ARGS+=(--use-core --raw-line="#![allow(non_upper_case_globals)]") -BASE_BINDGEN_ARGS+=(--raw-line="#![allow(non_camel_case_types)]" --raw-line="#![allow(non_snake_case)]") - -# TODO: How to detect / deal with target specific bindings -BASE_CLANG_ARGS=("--sysroot=${OHOS_SYSROOT_DIR}") -BASE_CLANG_ARGS+=(--target=aarch64-linux-ohos) - -set -x - -(cd "${ROOT_DIR}/scripts/generator" && cargo run) - -#bindgen "${BASE_BINDGEN_ARGS[@]}" \ -# --default-enum-style=newtype \ -# --output "${ROOT_DIR}/components/deviceinfo/src/deviceinfo_api${OHOS_API_VERSION}.rs" \ -# "${OHOS_SYSROOT_DIR}/usr/include/deviceinfo.h" \ -# -- \ -# "${BASE_CLANG_ARGS[@]}" -# -#bindgen "${BASE_BINDGEN_ARGS[@]}" \ -# --default-enum-style=newtype \ -# --output "${ROOT_DIR}/src/syscap/syscap_api${OHOS_API_VERSION}.rs" \ -# "${OHOS_SYSROOT_DIR}/usr/include/syscap_ndk.h" \ -# -- \ -# "${BASE_CLANG_ARGS[@]}" - -#bindgen "${BASE_BINDGEN_ARGS[@]}" \ -# --default-enum-style=newtype \ -# --output "${ROOT_DIR}/components/hilog/src/hilog_api${OHOS_API_VERSION}.rs" \ -# --allowlist-file="${OHOS_SYSROOT_DIR}/usr/include/hilog/log.h" \ -# --blocklist-var "LOG_DOMAIN" \ -# "${OHOS_SYSROOT_DIR}/usr/include/hilog/log.h" \ -# -- \ -# "${BASE_CLANG_ARGS[@]}" - -#bindgen "${BASE_BINDGEN_ARGS[@]}" \ -# --output "${ROOT_DIR}/components/hitrace/src/hitrace_api${OHOS_API_VERSION}.rs" \ -# --default-enum-style=newtype \ -# --bitfield-enum "^HiTrace_Flag$" \ -# --allowlist-file="${OHOS_SYSROOT_DIR}/usr/include/hitrace/trace.h" \ -# "${OHOS_SYSROOT_DIR}/usr/include/hitrace/trace.h" \ -# -- \ -# -include "stdbool.h" \ -# "${BASE_CLANG_ARGS[@]}" - -#bindgen "${BASE_BINDGEN_ARGS[@]}" \ -# --default-enum-style=newtype \ -# --allowlist-file ".*/xcomponent/native_.*xcomponent.*\.h" \ -# --no-copy="^OH_NativeXComponent$" \ -# --no-copy="^OH_NativeXComponent_KeyEvent$" \ -# --no-debug="^OH_NativeXComponent$" \ -# --no-debug="^OH_NativeXComponent_KeyEvent$" \ -# --output "${ROOT_DIR}/components/xcomponent/src/xcomponent_api${OHOS_API_VERSION}.rs" \ -# "${OHOS_SYSROOT_DIR}/usr/include/ace/xcomponent/native_interface_xcomponent.h" \ -# -- \ -# -x c++ \ -# "${BASE_CLANG_ARGS[@]}" - -NAPI_NOCOPY_STRUCTS=(napi_env__ napi_value__ napi_ref__ napi_handle_scope__ napi_escapable_handle_scope__ ) -NAPI_NOCOPY_STRUCTS+=(napi_callback_info__ napi_deferred__ napi_callback_scope__ napi_async_context__ napi_async_work__) -NAPI_NOCOPY_STRUCTS+=(napi_threadsafe_function__ napi_async_cleanup_hook_handle__ uv_loop_s napi_module) -NAPI_NOCOPY_ARGS=() -for val in "${NAPI_NOCOPY_STRUCTS[@]}"; do - NAPI_NOCOPY_ARGS+=("--no-copy=^${val}\$" "--no-debug=^${val}\$") -done - -bindgen "${BASE_BINDGEN_ARGS[@]}" \ - --default-enum-style=newtype \ - --blocklist-file '.*/stdarg\.h' \ - --blocklist-file '.*stddef\.h' \ - --blocklist-file '.*/stdbool\.h' \ - "${NAPI_NOCOPY_ARGS[@]}" \ - --output "${ROOT_DIR}/src/napi/napi_api${OHOS_API_VERSION}.rs" \ - "${OHOS_SYSROOT_DIR}/usr/include/napi/native_api.h" \ - -- \ - "${BASE_CLANG_ARGS[@]}" - -#bindgen "${BASE_BINDGEN_ARGS[@]}" \ -# --allowlist-file ".*/native_buffer/.*\.h" \ -# --bitfield-enum 'OH_NativeBuffer_Usage' \ -# --blocklist-item '^(OH)?NativeWindow(Buffer)?$' \ -# --default-enum-style=newtype \ -# --no-copy '^OH_NativeBuffer$' \ -# --no-copy '^OHIPCParcel$' \ -# --no-debug '^OH_NativeBuffer$' \ -# --output "${ROOT_DIR}/src/native_buffer/native_buffer_api${OHOS_API_VERSION}.rs" \ -# "${OHOS_SYSROOT_DIR}/usr/include/native_buffer/native_buffer.h" \ -# -- \ -# -x c++ \ -# "${BASE_CLANG_ARGS[@]}" -# -#bindgen "${BASE_BINDGEN_ARGS[@]}" \ -# --raw-line="use crate::native_window::OHNativeWindow;" \ -# --allowlist-file ".*/native_image/.*\.h" \ -# --blocklist-item '^(OH)?NativeWindow?$' \ -# --blocklist-item '^(OH)?NativeWindowBuffer' \ -# --default-enum-style=newtype \ -# --no-copy '^OH_NativeImage$' \ -# --no-copy 'OH_OnFrameAvailableListener' \ -# --no-debug '^OH_NativeImage$' \ -# --output "${ROOT_DIR}/src/native_image/native_image_api${OHOS_API_VERSION}.rs" \ -# "${OHOS_SYSROOT_DIR}/usr/include/native_image/native_image.h" \ -# -- \ -# "${BASE_CLANG_ARGS[@]}" - -# NativeWindowOperation has wrong documentation for one of the parameters in API 10. -#block_native_window_operation="" -#if [[ ${OHOS_API_VERSION} -eq 10 ]]; then -# block_native_window_operation='--blocklist-item=^NativeWindowOperation$' -#fi - -#bindgen "${BASE_BINDGEN_ARGS[@]}" \ -# --default-enum-style=newtype \ -# --no-derive-copy \ -# ${block_native_window_operation} \ -# --output "${ROOT_DIR}/src/native_window/native_window_api${OHOS_API_VERSION}.rs" \ -# "${OHOS_SYSROOT_DIR}/usr/include/native_window/external_window.h" \ -# -- \ -# "${BASE_CLANG_ARGS[@]}" - -#bindgen "${BASE_BINDGEN_ARGS[@]}" \ -# --default-enum-style=newtype \ -# --no-derive-copy \ -# --no-derive-debug \ -# --allowlist-file ".*/native_vsync\.h" \ -# --output "${ROOT_DIR}/src/vsync/vsync_api${OHOS_API_VERSION}.rs" \ -# "${OHOS_SYSROOT_DIR}/usr/include/native_vsync/native_vsync.h" \ -# -- \ -# "${BASE_CLANG_ARGS[@]}" - -## API-10 -#DRAWING_NOCOPY_STRUCTS=(OH_Drawing_Canvas OH_Drawing_Pen OH_Drawing_Brush OH_Drawing_Path OH_Drawing_Bitmap) -#DRAWING_NOCOPY_STRUCTS+=(OH_Drawing_FontCollection OH_Drawing_Typography OH_Drawing_TextStyle OH_Drawing_TypographyStyle) -#DRAWING_NOCOPY_STRUCTS+=(OH_Drawing_TypographyCreate) -## API-11 -#DRAWING_NOCOPY_STRUCTS+=(OH_Drawing_Point OH_Drawing_Rect OH_Drawing_RoundRect OH_Drawing_ShaderEffect OH_Drawing_Filter) -#DRAWING_NOCOPY_STRUCTS+=(OH_Drawing_MaskFilter OH_Drawing_ColorFilter OH_Drawing_Font OH_Drawing_Typeface) -#DRAWING_NOCOPY_STRUCTS+=(OH_Drawing_TextBlob OH_Drawing_TextBlobBuilder OH_Drawing_TextBox OH_Drawing_PositionAndAffinity) -#DRAWING_NOCOPY_STRUCTS+=(OH_Drawing_Range OH_Drawing_Matrix OH_Drawing_RunBuffer) -## API-12 -#DRAWING_NOCOPY_STRUCTS+=(OH_Drawing_Region OH_Drawing_PixelMap OH_Drawing_ColorSpace OH_Drawing_Point2D OH_Drawing_Point3D) -#DRAWING_NOCOPY_STRUCTS+=(OH_Drawing_PathEffect OH_Drawing_ShadowLayer OH_Drawing_MemoryStream OH_Drawing_Image ) -#DRAWING_NOCOPY_STRUCTS+=(OH_Drawing_ImageFilter OH_Drawing_SamplingOptions OH_Drawing_GpuContext OH_Drawing_Surface) -#DRAWING_NOCOPY_STRUCTS+=(OH_Drawing_FontMgr OH_Drawing_FontStyleSet OH_Drawing_BitmapFormat OH_Drawing_FontParser) -#DRAWING_NOCOPY_STRUCTS+=(OH_Drawing_TextShadow) -## Maybe: OH_Drawing_StrutStyle -# -#DRAWING_NOCOPY_ARGS=() -#for val in "${DRAWING_NOCOPY_STRUCTS[@]}"; do -# DRAWING_NOCOPY_ARGS+=("--no-copy=^${val}\$" "--no-debug=^${val}\$") -#done -# -#DRAWING_font_collection_ADDITIONAL_ARGS=("--raw-line=use crate::text_declaration::*;") -#DRAWING_text_typography_ADDITIONAL_ARGS=("--raw-line=use crate::text_declaration::*;" ) -#DRAWING_register_font_ADDITIONAL_ARGS=("--raw-line=use crate::text_declaration::*;" ) -#DRAWING_image_filter_ADDITIONAL_ARGS=("--raw-line=use crate::shader_effect::*;") -#DRAWING_font_mgr_ADDITIONAL_ARGS=("--raw-line=use crate::text_typography::*;" ) -# -#for abs_drawing_header in "${OHOS_SYSROOT_DIR}/usr/include/native_drawing"/* ; do -# drawing_header=$(basename "${abs_drawing_header}") -# echo "Generating bindings for ${drawing_header}" -# rust_name=${drawing_header#"drawing_"} -# rust_name=${rust_name%".h"} -# output_dir="${ROOT_DIR}/components/drawing/src/${rust_name}" -# if [ ! -d "${output_dir}" ]; then -# mkdir "${output_dir}" -# fi -# rs_includes=() -# if [[ "${rust_name}" != "types" ]]; then -# rs_includes+=("--raw-line=use crate::types::*;") -# fi -# additional_args_var_name="DRAWING_${rust_name}_ADDITIONAL_ARGS" -# if [[ ! -z "${!additional_args_var_name+x}" ]]; then -# echo "Have additional args!" -# # Add [@] to the name, so that the indirect expansion via `${!name}` expands everything. -# additional_args_var_name="${additional_args_var_name}[@]" -# rs_includes+=( "${!additional_args_var_name}" ) -# fi -# # We want to commit all generated files to version control, so we can easily see if something changed, -# # when updating bindgen or the SDK patch release. -# # However, we any split changes into incremental modules, and don't use any of the newer versions of the API -# # besides the first one. If a binding was not introduced in the current api version, then we add a nopublish -# # suffix, so we can exclude the file from cargo publish and save some download bandwidth. -# no_publish_suffix="" -# if [[ -f "${output_dir}/${rust_name}_api${PREVIOUS_API_VERSION}.rs" -# || -f "${output_dir}/${rust_name}_api${PREVIOUS_API_VERSION}_nopublish.rs" ]]; then -# no_publish_suffix="_nopublish" -# fi -# -# # Some drawing headers are not valid C, so we need to use libclang in c++ mode. -# # Note: block-listing `^std_.*` doesn't seem to work, perhaps the underscore replaces some other character. -# bindgen "${BASE_BINDGEN_ARGS[@]}" \ -# --default-enum-style=newtype \ -# --allowlist-file ".*/drawing_${rust_name}\.h" \ -# --no-recursive-allowlist \ -# "${rs_includes[@]}" \ -# "${DRAWING_NOCOPY_ARGS[@]}" \ -# --output "${output_dir}/${rust_name}_api${OHOS_API_VERSION}${no_publish_suffix}.rs" \ -# "${abs_drawing_header}" \ -# -- "${BASE_CLANG_ARGS[@]}" \ -# -x c++ \ -# -include stdbool.h \ -# -include stddef.h \ -# -include stdint.h -#done - -#IME_text_editor_proxy_ADDITIONAL_ARGS=("--raw-line=use crate::private_command::InputMethod_PrivateCommand;") -#IME_text_editor_proxy_ADDITIONAL_ARGS+=("--raw-line=use crate::text_config::InputMethod_TextConfig;") -#IME_text_config_ADDITIONAL_ARGS=("--raw-line=use crate::text_avoid_info::InputMethod_TextAvoidInfo;") -#IME_text_config_ADDITIONAL_ARGS+=("--raw-line=use crate::cursor_info::InputMethod_CursorInfo;") -#IME_inputmethod_proxy_ADDITIONAL_ARGS=("--raw-line=use crate::private_command::InputMethod_PrivateCommand;") -#IME_inputmethod_proxy_ADDITIONAL_ARGS+=("--raw-line=use crate::cursor_info::InputMethod_CursorInfo;") -#IME_controller_ADDITIONAL_ARGS=("--raw-line=use crate::inputmethod_proxy::InputMethod_InputMethodProxy;") -#IME_controller_ADDITIONAL_ARGS+=("--raw-line=use crate::text_editor_proxy::InputMethod_TextEditorProxy;") -#IME_controller_ADDITIONAL_ARGS+=("--raw-line=use crate::attach_options::InputMethod_AttachOptions;") -# -#if (( OHOS_API_VERSION >= 12)); then -# for abs_ime_header in "${OHOS_SYSROOT_DIR}/usr/include/inputmethod"/* ; do -# ime_header=$(basename "${abs_ime_header}") -# echo "Generating bindings for ${ime_header}" -# rust_name=${ime_header#"inputmethod_"} -# rust_name=${rust_name%"_capi.h"} -# output_dir="${ROOT_DIR}/components/inputmethod/src/${rust_name}" -# if [ ! -d "${output_dir}" ]; then -# mkdir "${output_dir}" -# fi -# rs_includes=() -# if [[ "${rust_name}" != "types" ]]; then -# rs_includes+=("--raw-line=use crate::types::*;") -# fi -# additional_args_var_name="IME_${rust_name}_ADDITIONAL_ARGS" -# if [[ ! -z "${!additional_args_var_name+x}" ]]; then -# echo "Have additional args!" -# additional_args_var_name="${additional_args_var_name}[@]" -# rs_includes+=( "${!additional_args_var_name}" ) -# fi -# # We want to commit all generated files to version control, so we can easily see if something changed, -# # when updating bindgen or the SDK patch release. -# # However, we any split changes into incremental modules, and don't use any of the newer versions of the API -# # besides the first one. If a binding was not introduced in the current api version, then we add a nopublish -# # suffix, so we can exclude the file from cargo publish and save some download bandwidth. -# no_publish_suffix="" -# if [[ -f "${output_dir}/${rust_name}_api${PREVIOUS_API_VERSION}.rs" -# || -f "${output_dir}/${rust_name}_api${PREVIOUS_API_VERSION}_nopublish.rs" ]]; then -# no_publish_suffix="_nopublish" -# fi -# -# # Some drawing headers are not valid C, so we need to use libclang in c++ mode. -# # Note: block-listing `^std_.*` doesn't seem to work, perhaps the underscore replaces some other character. -# bindgen "${BASE_BINDGEN_ARGS[@]}" \ -# --default-enum-style=newtype \ -# --allowlist-file ".*/${ime_header}$" \ -# --no-recursive-allowlist \ -# "${rs_includes[@]}" \ -# --no-derive-copy \ -# --no-derive-debug \ -# --output "${output_dir}/${rust_name}_api${OHOS_API_VERSION}${no_publish_suffix}.rs" \ -# "${abs_ime_header}" \ -# -- "${BASE_CLANG_ARGS[@]}" \ -# -x c++ -# done -#fi - -## Todo: Add the necessary imports / relations and remove this restriction again. -#IMG_pixelmap_ADDITIONAL_ARGS=('--blocklist-function=^OH_PixelmapNative_ConvertPixelmapNative(To|From)Napi') -#IMG_image_source_ADDITIONAL_ARGS=('--blocklist-function=^OH_ImageSourceNative_CreateFromRawFile') -## Todo: these bindings are hand-picked and feature guarded right now - autogenerate... -#IMG_image_source_ADDITIONAL_ARGS+=('--blocklist-function=^OH_ImageSourceNative_CreatePixelmap(List)?') -#IMG_image_receiver_ADDITIONAL_ARGS=('--raw-line=use crate::native_image::image::OH_ImageNative;') -#IMG_image_packer_ADDITIONAL_ARGS=('--blocklist-function=^OH_ImagePackerNative_PackTo(Data|File)FromImageSource') -#IMG_image_packer_ADDITIONAL_ARGS+=('--blocklist-function=^OH_ImagePackerNative_PackTo(Data|File)FromPixelmap') -#IMG_image_ADDITIONAL_ARGS+=('--blocklist-function=^OH_ImageNative_GetByteBuffer') -# -# -#if (( OHOS_API_VERSION >= 12)); then -# for abs_img_header in "${OHOS_SYSROOT_DIR}/usr/include/multimedia/image_framework/image"/* ; do -# img_header=$(basename "${abs_img_header}") -# echo "Generating bindings for ${img_header}" -# rust_name=${img_header} -# rust_name=${rust_name%".h"} -# rust_name=${rust_name%"_native"} -# output_dir="${ROOT_DIR}/components/multimedia/image_framework/src/native_image/${rust_name}" -# if [ ! -d "${output_dir}" ]; then -# mkdir "${output_dir}" -# fi -# rs_includes=() -# if [[ "${rust_name}" != "image_common" ]]; then -# rs_includes+=("--raw-line=use crate::native_image::common::*;") -# fi -# additional_args_var_name="IMG_${rust_name}_ADDITIONAL_ARGS" -# if [[ ! -z "${!additional_args_var_name+x}" ]]; then -# echo "Have additional args!" -# additional_args_var_name="${additional_args_var_name}[@]" -# rs_includes+=( "${!additional_args_var_name}" ) -# fi -# # We want to commit all generated files to version control, so we can easily see if something changed, -# # when updating bindgen or the SDK patch release. -# # However, we any split changes into incremental modules, and don't use any of the newer versions of the API -# # besides the first one. If a binding was not introduced in the current api version, then we add a nopublish -# # suffix, so we can exclude the file from cargo publish and save some download bandwidth. -# no_publish_suffix="" -# if [[ -f "${output_dir}/${rust_name}_api${PREVIOUS_API_VERSION}.rs" -# || -f "${output_dir}/${rust_name}_api${PREVIOUS_API_VERSION}_nopublish.rs" ]]; then -# no_publish_suffix="_nopublish" -# fi -# -# # Note: block-listing `^std_.*` doesn't seem to work, perhaps the underscore replaces some other character. -# bindgen "${BASE_BINDGEN_ARGS[@]}" \ -# --default-enum-style=newtype \ -# --allowlist-file ".*/${img_header}$" \ -# --no-recursive-allowlist \ -# "${rs_includes[@]}" \ -# --no-derive-copy \ -# --no-derive-debug \ -# --no-prepend-enum-name \ -# --output "${output_dir}/${rust_name}_api${OHOS_API_VERSION}${no_publish_suffix}.rs" \ -# "${abs_img_header}" \ -# -- "${BASE_CLANG_ARGS[@]}" \ -# -x c++ -# done -#fi +(cd "${ROOT_DIR}/scripts/generator" && cargo run ) +cd "${ROOT_DIR}" cargo fmt -fd -e rs . 'src/' --exec rustfmt -fd -e rs . 'components' --exec rustfmt +fd -e rs . "${ROOT_DIR}/src/" --exec rustfmt +fd -e rs . "${ROOT_DIR}/components" --exec rustfmt diff --git a/scripts/generator/Cargo.toml b/scripts/generator/Cargo.toml index 65782a0..042a056 100644 --- a/scripts/generator/Cargo.toml +++ b/scripts/generator/Cargo.toml @@ -10,3 +10,6 @@ bindgen = { version = "=0.70.1", features = ["prettyplease"] } anyhow = "1.0.93" # Keep this feature in sync with the clang version of the SDK. clang-sys = { version = "1.8.1", features = ["clang_15_0"] } + +[profile.dev.package."*"] +opt-level = 2