Rename internal crates and add a README.md to them

The README.md contains the warning that used to be in lib.rs.

Add README.md files to all internal crates

... pointing to the official public crate to use instead.

Rename internal crates

fixup: README files

fixup rename

Author: hunger

.github/workflows/ci.yaml

@@ -81,7 +81,7 @@ jobs:
       uses: actions-rs/cargo@v1
       with:
           command: build
-          args: --verbose --all-features --workspace --exclude slint-backend-mcu-internal # mcu backend requires nightly
+          args: --verbose --all-features --workspace --exclude i-slint-backend-mcu # mcu backend requires nightly
     - name: Run tests
       uses: actions-rs/cargo@v1
       with:

Cargo.toml

@@ -30,7 +30,7 @@ members = [
     'internal/backends/testing',
     'internal/common',
     'internal/compiler',
-    'internal/compiler/parser_test_macro',
+    'internal/compiler/parser-test-macro',
     'internal/core',
     'internal/core-macros',
     'internal/interpreter',

api/cpp/Cargo.toml

@@ -22,20 +22,20 @@ crate-type = ["lib", "cdylib"]
 # Note, these features need to be kept in sync (along with their defaults) in
 # the C++ crate's CMakeLists.txt
 [features]
-backend-gl = ["slint-backend-selector-internal/slint-backend-gl-internal"]
-backend-qt = ["slint-backend-selector-internal/slint-backend-qt-internal"]
+backend-gl = ["i-slint-backend-selector/i-slint-backend-gl"]
+backend-qt = ["i-slint-backend-selector/i-slint-backend-qt"]
 interpreter = ["slint-interpreter"]
-testing = ["slint-backend-testing-internal"] # Enable some function used by the integration tests
-wayland = ["slint-backend-selector-internal/wayland"]
-x11 = ["slint-backend-selector-internal/x11"]
+testing = ["i-slint-backend-testing"] # Enable some function used by the integration tests
+wayland = ["i-slint-backend-selector/wayland"]
+x11 = ["i-slint-backend-selector/x11"]
 
 default = ["backend-gl", "x11", "backend-qt"]
 
 [dependencies]
-slint-core-internal = { version = "=0.2.0", path="../../internal/core", features = ["ffi"] }
+i-slint-backend-selector = { version = "=0.2.0", path="../../internal/backends/selector" }
+i-slint-backend-testing = { version = "=0.2.0", path="../../internal/backends/testing", optional = true }
+i-slint-core = { version = "=0.2.0", path="../../internal/core", features = ["ffi"] }
 slint-interpreter = { version = "=0.2.0", path="../../internal/interpreter", default-features = false, features = ["ffi", "compat-0-2-0"], optional = true }
-slint-backend-selector-internal = { version = "=0.2.0", path="../../internal/backends/selector" }
-slint-backend-testing-internal = { version = "=0.2.0", path="../../internal/backends/testing", optional = true }
 
 [build-dependencies]
 anyhow = "1.0"

api/cpp/lib.rs

@@ -4,17 +4,17 @@
 /*! This crate just expose the function used by the C++ integration */
 
 use core::ffi::c_void;
-use slint_backend_selector_internal::backend;
-use slint_core_internal::window::ffi::WindowRcOpaque;
-use slint_core_internal::window::WindowRc;
+use i_slint_backend_selector::backend;
+use i_slint_core::window::ffi::WindowRcOpaque;
+use i_slint_core::window::WindowRc;
 
 #[doc(hidden)]
 #[cold]
 pub fn use_modules() -> usize {
     #[cfg(feature = "slint-interpreter")]
     slint_interpreter::use_modules();
-    slint_backend_selector_internal::use_modules();
-    slint_core_internal::use_modules()
+    i_slint_backend_selector::use_modules();
+    i_slint_core::use_modules()
 }
 
 #[no_mangle]
@@ -25,9 +25,8 @@ pub unsafe extern "C" fn slint_windowrc_init(out: *mut WindowRcOpaque) {
 
 #[no_mangle]
 pub unsafe extern "C" fn slint_run_event_loop() {
-    crate::backend().run_event_loop(
-        slint_core_internal::backend::EventLoopQuitBehavior::QuitOnLastWindowClosed,
-    );
+    crate::backend()
+        .run_event_loop(i_slint_core::backend::EventLoopQuitBehavior::QuitOnLastWindowClosed);
 }
 
 /// Will execute the given functor in the main thread
@@ -64,8 +63,8 @@ pub unsafe extern "C" fn slint_quit_event_loop() {
 
 #[no_mangle]
 pub unsafe extern "C" fn slint_register_font_from_path(
-    path: &slint_core_internal::SharedString,
-    error_str: *mut slint_core_internal::SharedString,
+    path: &i_slint_core::SharedString,
+    error_str: *mut i_slint_core::SharedString,
 ) {
     core::ptr::write(
         error_str,
@@ -78,8 +77,8 @@ pub unsafe extern "C" fn slint_register_font_from_path(
 
 #[no_mangle]
 pub unsafe extern "C" fn slint_register_font_from_data(
-    data: slint_core_internal::slice::Slice<'static, u8>,
-    error_str: *mut slint_core_internal::SharedString,
+    data: i_slint_core::slice::Slice<'static, u8>,
+    error_str: *mut i_slint_core::SharedString,
 ) {
     core::ptr::write(
         error_str,
@@ -93,5 +92,5 @@ pub unsafe extern "C" fn slint_register_font_from_data(
 #[cfg(feature = "testing")]
 #[no_mangle]
 pub unsafe extern "C" fn slint_testing_init_backend() {
-    slint_backend_testing_internal::init();
+    i_slint_backend_testing::init();
 }

api/node/native/Cargo.toml

@@ -20,8 +20,8 @@ crate-type = ["cdylib"]
 name = "slint_node_native"
 
 [dependencies]
-slint-compiler-internal = { version = "=0.2.0", path="../../../internal/compiler" }
-slint-core-internal = { version = "=0.2.0", path="../../../internal/core" }
+i-slint-compiler = { version = "=0.2.0", path="../../../internal/compiler" }
+i-slint-core = { version = "=0.2.0", path="../../../internal/core" }
 slint-interpreter = { version = "=0.2.0", path="../../../internal/interpreter",  features = ["display-diagnostics"] }
 
 vtable = { version = "0.1.1", path="../../../helper_crates/vtable" }

api/node/native/js_model.rs

@@ -1,15 +1,15 @@
 // Copyright © SixtyFPS GmbH <[email protected]>
 // SPDX-License-Identifier: (GPL-3.0-only OR LicenseRef-SixtyFPS-commercial)
 
+use i_slint_compiler::langtype::Type;
+use i_slint_core::model::Model;
 use neon::prelude::*;
-use slint_compiler_internal::langtype::Type;
-use slint_core_internal::model::Model;
 use std::cell::Cell;
 use std::rc::{Rc, Weak};
 
 /// Model coming from JS
 pub struct JsModel {
-    notify: slint_core_internal::model::ModelNotify,
+    notify: i_slint_core::model::ModelNotify,
     /// The index of the value in the PersistentContext
     value_index: u32,
     data_type: Type,
@@ -87,7 +87,7 @@ impl Model for JsModel {
         }
     }
 
-    fn model_tracker(&self) -> &dyn slint_core_internal::model::ModelTracker {
+    fn model_tracker(&self) -> &dyn i_slint_core::model::ModelTracker {
         &self.notify
     }
 

api/node/native/lib.rs

@@ -2,20 +2,20 @@
 // SPDX-License-Identifier: (GPL-3.0-only OR LicenseRef-SixtyFPS-commercial)
 
 use core::cell::RefCell;
+use i_slint_compiler::langtype::Type;
+use i_slint_core::model::{Model, ModelRc};
+use i_slint_core::window::WindowHandleAccess;
+use i_slint_core::{ImageInner, SharedVector};
 use neon::prelude::*;
 use rand::RngCore;
-use slint_compiler_internal::langtype::Type;
-use slint_core_internal::model::{Model, ModelRc};
-use slint_core_internal::window::WindowHandleAccess;
-use slint_core_internal::{ImageInner, SharedVector};
 use slint_interpreter::ComponentHandle;
 
 mod js_model;
 mod persistent_context;
 
 struct WrappedComponentType(Option<slint_interpreter::ComponentDefinition>);
 struct WrappedComponentRc(Option<slint_interpreter::ComponentInstance>);
-struct WrappedWindow(Option<slint_core_internal::window::WindowRc>);
+struct WrappedWindow(Option<i_slint_core::window::WindowRc>);
 
 /// We need to do some gymnastic with closures to pass the ExecuteContext with the right lifetime
 type GlobalContextCallback<'c> =
@@ -154,7 +154,7 @@ fn create<'cx>(
 
 fn to_eval_value<'cx>(
     val: Handle<'cx, JsValue>,
-    ty: slint_compiler_internal::langtype::Type,
+    ty: i_slint_compiler::langtype::Type,
     cx: &mut impl Context<'cx>,
     persistent_context: &persistent_context::PersistentContext<'cx>,
 ) -> NeonResult<slint_interpreter::Value> {
@@ -177,12 +177,12 @@ fn to_eval_value<'cx>(
                 .value()
                 .parse::<css_color_parser2::Color>()
                 .or_else(|e| cx.throw_error(&e.to_string()))?;
-            Ok((slint_core_internal::Color::from_argb_u8((c.a * 255.) as u8, c.r, c.g, c.b)).into())
+            Ok((i_slint_core::Color::from_argb_u8((c.a * 255.) as u8, c.r, c.g, c.b)).into())
         }
         Type::Array(a) => match val.downcast::<JsArray>() {
             Ok(arr) => {
                 let vec = arr.to_vec(cx)?;
-                Ok(Value::Model(ModelRc::new(slint_core_internal::model::SharedVectorModel::from(
+                Ok(Value::Model(ModelRc::new(i_slint_core::model::SharedVectorModel::from(
                     vec.into_iter()
                         .map(|i| to_eval_value(i, (*a).clone(), cx, persistent_context))
                         .collect::<Result<SharedVector<_>, _>>()?,
@@ -199,7 +199,7 @@ fn to_eval_value<'cx>(
         Type::Image => {
             let path = val.to_string(cx)?.value();
             Ok(Value::Image(
-                slint_core_internal::graphics::Image::load_from_path(std::path::Path::new(&path))
+                i_slint_core::graphics::Image::load_from_path(std::path::Path::new(&path))
                     .or_else(|_| cx.throw_error(format!("cannot load image {:?}", path)))?,
             ))
         }
@@ -284,7 +284,7 @@ fn to_js_value<'cx>(
             }
             js_object.as_value(cx)
         }
-        Value::Brush(slint_core_internal::Brush::SolidColor(c)) => JsString::new(
+        Value::Brush(i_slint_core::Brush::SolidColor(c)) => JsString::new(
             cx,
             &format!("#{:02x}{:02x}{:02x}{:02x}", c.red(), c.green(), c.blue(), c.alpha()),
         )
@@ -546,7 +546,7 @@ fn singleshot_timer(mut cx: FunctionContext) -> JsResult<JsValue> {
         });
     };
 
-    slint_core_internal::timers::Timer::single_shot(
+    i_slint_core::timers::Timer::single_shot(
         std::time::Duration::from_millis(duration_in_msecs),
         callback,
     );
@@ -564,6 +564,6 @@ register_module!(mut m, {
 /// let some time elapse for testing purposes
 fn mock_elapsed_time(mut cx: FunctionContext) -> JsResult<JsValue> {
     let ms = cx.argument::<JsNumber>(0)?.value();
-    slint_core_internal::tests::slint_mock_elapsed_time(ms as _);
+    i_slint_core::tests::slint_mock_elapsed_time(ms as _);
     Ok(JsUndefined::new().as_value(&mut cx))
 }

api/rs/build/Cargo.toml

@@ -19,7 +19,7 @@ path = "lib.rs"
 default = []
 
 [dependencies]
-slint-compiler-internal = { version = "=0.2.0", path = "../../../internal/compiler", features = ["rust", "display-diagnostics"] }
+i-slint-compiler = { version = "=0.2.0", path = "../../../internal/compiler", features = ["rust", "display-diagnostics"] }
 
 spin_on = "0.1"
 thiserror = "1"

api/rs/build/lib.rs

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: (GPL-3.0-only OR LicenseRef-SixtyFPS-commercial)
 
 /*!
-This crate serves as a companion crate for the slint crate.
+This crate serves as a companion crate of the slint crate.
 It is meant to allow you to compile the `.slint` files from your `build.rs` script.
 
 The main entry point of this crate is the [`compile()`] function
@@ -54,18 +54,18 @@ use std::env;
 use std::io::Write;
 use std::path::Path;
 
-use slint_compiler_internal::diagnostics::BuildDiagnostics;
+use i_slint_compiler::diagnostics::BuildDiagnostics;
 
 /// The structure for configuring aspects of the compilation of `.slint` markup files to Rust.
 pub struct CompilerConfiguration {
-    config: slint_compiler_internal::CompilerConfiguration,
+    config: i_slint_compiler::CompilerConfiguration,
 }
 
 impl Default for CompilerConfiguration {
     fn default() -> Self {
         Self {
-            config: slint_compiler_internal::CompilerConfiguration::new(
-                slint_compiler_internal::generator::OutputFormat::Rust,
+            config: i_slint_compiler::CompilerConfiguration::new(
+                i_slint_compiler::generator::OutputFormat::Rust,
             ),
         }
     }
@@ -189,7 +189,7 @@ pub fn compile_with_config(
         .join(path.as_ref());
 
     let mut diag = BuildDiagnostics::default();
-    let syntax_node = slint_compiler_internal::parser::parse_file(&path, &mut diag);
+    let syntax_node = i_slint_compiler::parser::parse_file(&path, &mut diag);
 
     if diag.has_error() {
         let vec = diag.to_string_vec();
@@ -208,9 +208,9 @@ pub fn compile_with_config(
 
     if std::env::var_os("SLINT_STYLE").is_none() && compiler_config.style.is_none() {
         compiler_config.style = std::env::var_os("OUT_DIR").and_then(|path| {
-            // Same logic as in slint-backend-selector-internal's build script to get the path
+            // Same logic as in i-slint-backend-selector's build script to get the path
             let path = Path::new(&path).parent()?.parent()?.join("SLINT_DEFAULT_STYLE.txt");
-            // unfortunately, if for some reason the file is changed by the slint-backend-selector-internal's build script,
+            // unfortunately, if for some reason the file is changed by the i-slint-backend-selector's build script,
             // it is changed after cargo decide to re-run this build script or not. So that means one will need two build
             // to settle the right thing.
             rerun_if_changed = format!("cargo:rerun-if-changed={}", path.display());
@@ -222,11 +222,8 @@ pub fn compile_with_config(
     let syntax_node = syntax_node.expect("diags contained no compilation errors");
 
     // 'spin_on' is ok here because the compiler in single threaded and does not block if there is no blocking future
-    let (doc, diag) = spin_on::spin_on(slint_compiler_internal::compile_syntax_node(
-        syntax_node,
-        diag,
-        compiler_config,
-    ));
+    let (doc, diag) =
+        spin_on::spin_on(i_slint_compiler::compile_syntax_node(syntax_node, diag, compiler_config));
 
     if diag.has_error() {
         let vec = diag.to_string_vec();
@@ -244,7 +241,7 @@ pub fn compile_with_config(
 
     let file = std::fs::File::create(&output_file_path).map_err(CompileError::SaveError)?;
     let mut code_formatter = CodeFormatter { indentation: 0, in_string: false, sink: file };
-    let generated = slint_compiler_internal::generator::rust::generate(&doc);
+    let generated = i_slint_compiler::generator::rust::generate(&doc);
 
     for x in &diag.all_loaded_files {
         if x.is_absolute() {

api/rs/macros/Cargo.toml

@@ -17,7 +17,7 @@ proc-macro = true
 path = "lib.rs"
 
 [dependencies]
-slint-compiler-internal = { version = "=0.2.0", path = "../../../internal/compiler", features = ["proc_macro_span", "rust", "display-diagnostics"] }
+i-slint-compiler = { version = "=0.2.0", path = "../../../internal/compiler", features = ["proc_macro_span", "rust", "display-diagnostics"] }
 
 proc-macro2 = "1.0.17"
 quote = "1.0"