Fix publishing of newer drawing modules

Rename generated api bindings, which are not the initial version of this API bindings. This allows us to easily exclude those files from publishing. We still want to keep the full generated files in our VCS since it allows us to track changes, and update the modules containing the newly added apis for a given feature level. Signed-off-by: Jonathan Schwender <[email protected]> Signed-off-by: Jonathan Schwender <[email protected]>
openharmony-rs · Jul 18, 2024 · 28cf1dc · 28cf1dc
1 parent 7e208ae
commit 28cf1dc
Show file tree

Hide file tree

Showing 34 changed files with 17 additions and 4 deletions.
diff --git a/components/drawing/Cargo.toml b/components/drawing/Cargo.toml
@@ -6,7 +6,7 @@ description = "Bindings to the `native_drawing` API of OpenHarmony OS"
 license = "Apache-2.0"
 repository = "https://github.com/openharmony-rs/ohos-sys"
 keywords = ["OpenHarmony", "HarmonyOS", "ffi", "drawing"]
-exclude = ["src/**/*_api11.rs", "src/**/*_api12.rs"]
+exclude = ["src/**/*_nopublish.rs"]
 
 [dependencies]
 document-features = { version = "0.2", optional = true }

diff --git a/...onents/drawing/src/bitmap/bitmap_api11.rs → ...wing/src/bitmap/bitmap_api11_nopublish.rs b/...onents/drawing/src/bitmap/bitmap_api11.rs → ...wing/src/bitmap/bitmap_api11_nopublish.rs
diff --git a/...onents/drawing/src/bitmap/bitmap_api12.rs → ...wing/src/bitmap/bitmap_api12_nopublish.rs b/...onents/drawing/src/bitmap/bitmap_api12.rs → ...wing/src/bitmap/bitmap_api12_nopublish.rs
diff --git a/components/drawing/src/brush/brush_api11.rs → ...rawing/src/brush/brush_api11_nopublish.rs b/components/drawing/src/brush/brush_api11.rs → ...rawing/src/brush/brush_api11_nopublish.rs
diff --git a/components/drawing/src/brush/brush_api12.rs → ...rawing/src/brush/brush_api12_nopublish.rs b/components/drawing/src/brush/brush_api12.rs → ...rawing/src/brush/brush_api12_nopublish.rs
diff --git a/...onents/drawing/src/canvas/canvas_api11.rs → ...wing/src/canvas/canvas_api11_nopublish.rs b/...onents/drawing/src/canvas/canvas_api11.rs → ...wing/src/canvas/canvas_api11_nopublish.rs
diff --git a/...onents/drawing/src/canvas/canvas_api12.rs → ...wing/src/canvas/canvas_api12_nopublish.rs b/...onents/drawing/src/canvas/canvas_api12.rs → ...wing/src/canvas/canvas_api12_nopublish.rs
diff --git a/components/drawing/src/color/color_api11.rs → ...rawing/src/color/color_api11_nopublish.rs b/components/drawing/src/color/color_api11.rs → ...rawing/src/color/color_api11_nopublish.rs
diff --git a/components/drawing/src/color/color_api12.rs → ...rawing/src/color/color_api12_nopublish.rs b/components/drawing/src/color/color_api12.rs → ...rawing/src/color/color_api12_nopublish.rs
diff --git a/...ng/src/color_filter/color_filter_api12.rs → ...or_filter/color_filter_api12_nopublish.rs b/...ng/src/color_filter/color_filter_api12.rs → ...or_filter/color_filter_api12_nopublish.rs
diff --git a/...onents/drawing/src/filter/filter_api12.rs → ...wing/src/filter/filter_api12_nopublish.rs b/...onents/drawing/src/filter/filter_api12.rs → ...wing/src/filter/filter_api12_nopublish.rs
diff --git a/components/drawing/src/font/font_api12.rs → .../drawing/src/font/font_api12_nopublish.rs b/components/drawing/src/font/font_api12.rs → .../drawing/src/font/font_api12_nopublish.rs
diff --git a/.../font_collection/font_collection_api11.rs → ...ection/font_collection_api11_nopublish.rs b/.../font_collection/font_collection_api11.rs → ...ection/font_collection_api11_nopublish.rs
diff --git a/.../font_collection/font_collection_api12.rs → ...ection/font_collection_api12_nopublish.rs b/.../font_collection/font_collection_api12.rs → ...ection/font_collection_api12_nopublish.rs
diff --git a/...wing/src/mask_filter/mask_filter_api12.rs → ...ask_filter/mask_filter_api12_nopublish.rs b/...wing/src/mask_filter/mask_filter_api12.rs → ...ask_filter/mask_filter_api12_nopublish.rs
diff --git a/...onents/drawing/src/matrix/matrix_api12.rs → ...wing/src/matrix/matrix_api12_nopublish.rs b/...onents/drawing/src/matrix/matrix_api12.rs → ...wing/src/matrix/matrix_api12_nopublish.rs
diff --git a/components/drawing/src/path/path_api11.rs → .../drawing/src/path/path_api11_nopublish.rs b/components/drawing/src/path/path_api11.rs → .../drawing/src/path/path_api11_nopublish.rs
diff --git a/components/drawing/src/path/path_api12.rs → .../drawing/src/path/path_api12_nopublish.rs b/components/drawing/src/path/path_api12.rs → .../drawing/src/path/path_api12_nopublish.rs
diff --git a/components/drawing/src/pen/pen_api11.rs → ...ts/drawing/src/pen/pen_api11_nopublish.rs b/components/drawing/src/pen/pen_api11.rs → ...ts/drawing/src/pen/pen_api11_nopublish.rs
diff --git a/components/drawing/src/pen/pen_api12.rs → ...ts/drawing/src/pen/pen_api12_nopublish.rs b/components/drawing/src/pen/pen_api12.rs → ...ts/drawing/src/pen/pen_api12_nopublish.rs
diff --git a/components/drawing/src/point/point_api12.rs → ...rawing/src/point/point_api12_nopublish.rs b/components/drawing/src/point/point_api12.rs → ...rawing/src/point/point_api12_nopublish.rs
diff --git a/components/drawing/src/rect/rect_api12.rs → .../drawing/src/rect/rect_api12_nopublish.rs b/components/drawing/src/rect/rect_api12.rs → .../drawing/src/rect/rect_api12_nopublish.rs
diff --git a/.../src/register_font/register_font_api12.rs → ...ter_font/register_font_api12_nopublish.rs b/.../src/register_font/register_font_api12.rs → ...ter_font/register_font_api12_nopublish.rs
diff --git a/...rawing/src/round_rect/round_rect_api12.rs → .../round_rect/round_rect_api12_nopublish.rs b/...rawing/src/round_rect/round_rect_api12.rs → .../round_rect/round_rect_api12_nopublish.rs
diff --git a/.../src/shader_effect/shader_effect_api12.rs → ...r_effect/shader_effect_api12_nopublish.rs b/.../src/shader_effect/shader_effect_api12.rs → ...r_effect/shader_effect_api12_nopublish.rs
diff --git a/.../drawing/src/text_blob/text_blob_api12.rs → ...rc/text_blob/text_blob_api12_nopublish.rs b/.../drawing/src/text_blob/text_blob_api12.rs → ...rc/text_blob/text_blob_api12_nopublish.rs
diff --git a/...ext_declaration/text_declaration_api11.rs → ...ation/text_declaration_api11_nopublish.rs b/...ext_declaration/text_declaration_api11.rs → ...ation/text_declaration_api11_nopublish.rs
diff --git a/...ext_declaration/text_declaration_api12.rs → ...ation/text_declaration_api12_nopublish.rs b/...ext_declaration/text_declaration_api12.rs → ...ation/text_declaration_api12_nopublish.rs
diff --git a/.../text_typography/text_typography_api11.rs → ...graphy/text_typography_api11_nopublish.rs b/.../text_typography/text_typography_api11.rs → ...graphy/text_typography_api11_nopublish.rs
diff --git a/.../text_typography/text_typography_api12.rs → ...graphy/text_typography_api12_nopublish.rs b/.../text_typography/text_typography_api12.rs → ...graphy/text_typography_api12_nopublish.rs
diff --git a/...ts/drawing/src/typeface/typeface_api12.rs → .../src/typeface/typeface_api12_nopublish.rs b/...ts/drawing/src/typeface/typeface_api12.rs → .../src/typeface/typeface_api12_nopublish.rs
diff --git a/components/drawing/src/types/types_api11.rs → ...rawing/src/types/types_api11_nopublish.rs b/components/drawing/src/types/types_api11.rs → ...rawing/src/types/types_api11_nopublish.rs
diff --git a/components/drawing/src/types/types_api12.rs → ...rawing/src/types/types_api12_nopublish.rs b/components/drawing/src/types/types_api12.rs → ...rawing/src/types/types_api12_nopublish.rs
diff --git a/scripts/generate_bindings.sh b/scripts/generate_bindings.sh
@@ -35,6 +35,7 @@ export CLANG_PATH=${OHOS_NDK_HOME}/llvm/bin/clang
 
 OHOS_API_VERSION=$(jq '.apiVersion' -j < "${OHOS_NDK_HOME}/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)
 BASE_BINDGEN_ARGS+=(--blocklist-file='.*stdint\.h' --blocklist-file='.*stddef\.h')
@@ -149,8 +150,9 @@ for abs_drawing_header in "${OHOS_SYSROOT_DIR}/usr/include/native_drawing"/* ; d
     echo "Generating bindings for ${drawing_header}"
     rust_name=${drawing_header#"drawing_"}
     rust_name=${rust_name%".h"}
-    if [ ! -d "${ROOT_DIR}/src/drawing/${rust_name}" ]; then
-        mkdir "${ROOT_DIR}/src/drawing/${rust_name}"
+    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
@@ -161,6 +163,16 @@ for abs_drawing_header in "${OHOS_SYSROOT_DIR}/usr/include/native_drawing"/* ; d
         echo "Have additional args!"
         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.
@@ -170,7 +182,7 @@ for abs_drawing_header in "${OHOS_SYSROOT_DIR}/usr/include/native_drawing"/* ; d
         --no-recursive-allowlist \
         "${rs_includes[@]}" \
         "${DRAWING_NOCOPY_ARGS[@]}" \
-        --output "${ROOT_DIR}/components/drawing/src/${rust_name}/${rust_name}_api${OHOS_API_VERSION}.rs" \
+        --output "${output_dir}/${rust_name}_api${OHOS_API_VERSION}${no_publish_suffix}.rs" \
         "${OHOS_SYSROOT_DIR}/usr/include/native_drawing/${drawing_header}" \
         -- "${BASE_CLANG_ARGS[@]}" \
         -x c++ \
@@ -181,3 +193,4 @@ done
 
 cargo fmt
 fd -e rs . 'src/' --exec rustfmt
+fd -e rs . 'components' --exec rustfmt