Move private header in a private directory

As to make more obvious that these header are private
slint-ui · Jul 25, 2023 · 45146d3 · 45146d3
1 parent 69a11f7
commit 45146d3
Show file tree

Hide file tree

Showing 16 changed files with 33 additions and 32 deletions.
diff --git a/api/cpp/CMakeLists.txt b/api/cpp/CMakeLists.txt
@@ -254,36 +254,34 @@ foreach(header IN LISTS api_headers)
 endforeach()
 
 set(generated_headers
-    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/slint_internal.h
-    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/slint_enums_internal.h
-    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/slint_enums.h
-    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/slint_string_internal.h
-    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/slint_brush_internal.h
-    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/slint_sharedvector_internal.h
-    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/slint_properties_internal.h
-    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/slint_image_internal.h
-    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/slint_color_internal.h
-    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/slint_pathdata_internal.h
-    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/slint_qt_internal.h
-    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/slint_backend_internal.h
-    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/slint_generated_public.h
+    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/private/slint_internal.h
+    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/private/slint_enums_internal.h
+    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/private/slint_enums.h
+    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/private/slint_string_internal.h
+    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/private/slint_brush_internal.h
+    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/private/slint_sharedvector_internal.h
+    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/private/slint_properties_internal.h
+    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/private/slint_image_internal.h
+    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/private/slint_color_internal.h
+    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/private/slint_pathdata_internal.h
+    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/private/slint_qt_internal.h
+    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/private/slint_backend_internal.h
+    ${CMAKE_CURRENT_BINARY_DIR}/generated_include/private/slint_generated_public.h
 )
 
 if(SLINT_FEATURE_INTERPRETER)
     list(APPEND generated_headers
-        ${CMAKE_CURRENT_BINARY_DIR}/generated_include/slint_interpreter_internal.h
-        ${CMAKE_CURRENT_BINARY_DIR}/generated_include/slint_interpreter_generated_public.h
+        ${CMAKE_CURRENT_BINARY_DIR}/generated_include/private/slint_interpreter_internal.h
+        ${CMAKE_CURRENT_BINARY_DIR}/generated_include/private/slint_interpreter_generated_public.h
     )
 endif()
 
 
-foreach(header IN LISTS generated_headers)
-    set_property(TARGET Slint APPEND PROPERTY PUBLIC_HEADER ${header})
-endforeach()
-
 target_include_directories(Slint INTERFACE
     $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/generated_include>
     $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/generated_include/private>
+    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include/private>
     $<INSTALL_INTERFACE:include/slint>
 )
 
@@ -297,6 +295,8 @@ export(TARGETS Slint slint-cpp
 install(EXPORT SlintTargets NAMESPACE Slint:: DESTINATION lib/cmake/Slint)
 install(TARGETS Slint slint-cpp
     EXPORT SlintTargets LIBRARY DESTINATION lib PUBLIC_HEADER DESTINATION include/slint)
+install(DIRECTORY include/private DESTINATION include/slint FILES_MATCHING PATTERN "*.h")
+install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/generated_include/private DESTINATION include/slint FILES_MATCHING PATTERN "*.h")
 
 include(CMakePackageConfigHelpers)
 include(GNUInstallDirs)

diff --git a/api/cpp/cbindgen.rs b/api/cpp/cbindgen.rs
@@ -749,23 +749,24 @@ impl EnabledFeatures {
 
 /// Generate the headers.
 /// `root_dir` is the root directory of the slint git repo
-/// `include_dir` is the output directory
+/// `out_dir` is the output directory
 /// Returns the list of all paths that contain dependencies to the generated output. If you call this
 /// function from build.rs, feed each entry to stdout prefixed with `cargo:rerun-if-changed=`.
 pub fn gen_all(
     root_dir: &Path,
-    include_dir: &Path,
+    out_dir: &Path,
     enabled_features: EnabledFeatures,
 ) -> anyhow::Result<Vec<PathBuf>> {
     proc_macro2::fallback::force(); // avoid a abort if panic=abort is set
-    std::fs::create_dir_all(include_dir).context("Could not create the include directory")?;
+    let gen_dir = out_dir.join("private");
+    std::fs::create_dir_all(&gen_dir).context("Could not create the include directory")?;
     let mut deps = Vec::new();
-    enums(include_dir)?;
-    gen_corelib(root_dir, include_dir, &mut deps, enabled_features)?;
-    gen_backend_qt(root_dir, include_dir, &mut deps)?;
-    gen_backend(root_dir, include_dir, &mut deps)?;
+    enums(&gen_dir)?;
+    gen_corelib(root_dir, &gen_dir, &mut deps, enabled_features)?;
+    gen_backend_qt(root_dir, &gen_dir, &mut deps)?;
+    gen_backend(root_dir, &gen_dir, &mut deps)?;
     if enabled_features.interpreter {
-        gen_interpreter(root_dir, include_dir, &mut deps)?;
+        gen_interpreter(root_dir, &gen_dir, &mut deps)?;
     }
     Ok(deps)
 }
diff --git a/api/cpp/include/slint_brush.h → api/cpp/include/private/slint_brush.h b/api/cpp/include/slint_brush.h → api/cpp/include/private/slint_brush.h
diff --git a/api/cpp/include/slint_callbacks.h → api/cpp/include/private/slint_callbacks.h b/api/cpp/include/slint_callbacks.h → api/cpp/include/private/slint_callbacks.h
diff --git a/api/cpp/include/slint_color.h → api/cpp/include/private/slint_color.h b/api/cpp/include/slint_color.h → api/cpp/include/private/slint_color.h
diff --git a/api/cpp/include/slint_config.h → api/cpp/include/private/slint_config.h b/api/cpp/include/slint_config.h → api/cpp/include/private/slint_config.h
diff --git a/api/cpp/include/slint_image.h → api/cpp/include/private/slint_image.h b/api/cpp/include/slint_image.h → api/cpp/include/private/slint_image.h
diff --git a/api/cpp/include/slint_pathdata.h → api/cpp/include/private/slint_pathdata.h b/api/cpp/include/slint_pathdata.h → api/cpp/include/private/slint_pathdata.h
diff --git a/api/cpp/include/slint_point.h → api/cpp/include/private/slint_point.h b/api/cpp/include/slint_point.h → api/cpp/include/private/slint_point.h
diff --git a/api/cpp/include/slint_properties.h → api/cpp/include/private/slint_properties.h b/api/cpp/include/slint_properties.h → api/cpp/include/private/slint_properties.h
diff --git a/api/cpp/include/slint_sharedvector.h → api/cpp/include/private/slint_sharedvector.h b/api/cpp/include/slint_sharedvector.h → api/cpp/include/private/slint_sharedvector.h
diff --git a/api/cpp/include/slint_size.h → api/cpp/include/private/slint_size.h b/api/cpp/include/slint_size.h → api/cpp/include/private/slint_size.h
diff --git a/api/cpp/include/slint_string.h → api/cpp/include/private/slint_string.h b/api/cpp/include/slint_string.h → api/cpp/include/private/slint_string.h
diff --git a/api/cpp/include/slint_testing.h → api/cpp/include/private/slint_testing.h b/api/cpp/include/slint_testing.h → api/cpp/include/private/slint_testing.h
diff --git a/api/cpp/include/vtable.h → api/cpp/include/private/vtable.h b/api/cpp/include/vtable.h → api/cpp/include/private/vtable.h
diff --git a/api/cpp/include/slint.h b/api/cpp/include/slint.h
@@ -8,11 +8,11 @@
 #    pragma GCC diagnostic ignored "-Winvalid-offsetof"
 #endif
 
-#include "slint_internal.h"
-#include "slint_size.h"
-#include "slint_point.h"
-#include "slint_backend_internal.h"
-#include "slint_qt_internal.h"
+#include "private/slint_internal.h"
+#include "private/slint_size.h"
+#include "private/slint_point.h"
+#include "private/slint_backend_internal.h"
+#include "private/slint_qt_internal.h"
 
 #include <vector>
 #include <memory>