Merge branch 'main' into support_qmake_scripts

Author: SanderVocke

crates/cxx-qt-lib/Cargo.toml

@@ -6,12 +6,16 @@
 [package]
 name = "cxx-qt-lib"
 version.workspace = true
-authors = ["Andrew Hayzen <andrew.hayzen@kdab.com>", "Gerhard de Clercq <gerhard.declercq@kdab.com>", "Leon Matthes <leon.matthes@kdab.com>"]
+authors = [
+  "Andrew Hayzen <andrew.hayzen@kdab.com>",
+  "Gerhard de Clercq <gerhard.declercq@kdab.com>",
+  "Leon Matthes <leon.matthes@kdab.com>",
+]
 edition.workspace = true
 license.workspace = true
 description = "Qt types for integrating `cxx-qt` crate with `cxx`"
 repository.workspace = true
-exclude = [ "**/generate.sh" ]
+exclude = ["**/generate.sh"]
 
 # When creating a library with cxx-qt-build, we need to set a fake "links" key
 # to make sure the build scripts are run in the correct order and the build scripts
@@ -20,6 +24,10 @@ exclude = [ "**/generate.sh" ]
 links = "cxx-qt-lib"
 rust-version.workspace = true
 
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
 [dependencies]
 cxx.workspace = true
 cxx-qt.workspace = true
@@ -30,7 +38,7 @@ rgb = { version = "0.8", optional = true }
 time = { version = "0.3.20", optional = true }
 url = { version = "2.3", optional = true }
 uuid = { version = "1.1.0", optional = true }
-serde = { version = "1", features=["derive"], optional = true }
+serde = { version = "1", features = ["derive"], optional = true }
 # Note: The image crate is not yet at 1.0 and a new version is released regularly.
 # To avoid a breaking change at each update, we don't specify a default version, and make the versions explicit.
 # Once 1.0 is released, we can add a dependency on `image`, which would then be `image = "1"`
@@ -46,7 +54,19 @@ qt-build-utils.workspace = true
 serde_json = "1.0.135"
 
 [features]
-full = ["qt_full", "serde", "url", "uuid", "time", "rgb", "http", "chrono", "bytes", "image-v0-24", "image-v0-25"]
+full = [
+  "qt_full",
+  "serde",
+  "url",
+  "uuid",
+  "time",
+  "rgb",
+  "http",
+  "chrono",
+  "bytes",
+  "image-v0-24",
+  "image-v0-25",
+]
 default = []
 
 qt_full = ["qt_gui", "qt_qml", "qt_quickcontrols"]

crates/cxx-qt-lib/src/core/qdate.rs

@@ -167,8 +167,8 @@ impl QDate {
     /// Returns the number of days from this date to d (which is negative if d is earlier than this date).
     ///
     /// Returns 0 if either date is invalid.
-    pub fn days_to(&self, date: Self) -> ffi::qint64 {
-        ffi::qdate_days_to(self, date)
+    pub fn days_to(&self, date: Self) -> i64 {
+        ffi::qdate_days_to(self, date).into()
     }
 
     /// Returns the time as a string. The format parameter determines the format of the result string.
@@ -277,14 +277,14 @@ mod test {
     fn qdate_current_date() {
         let date_a = QDate::current_date();
         let date_b = date_a.add_days(100.into());
-        assert_eq!(i64::from(date_a.days_to(date_b)), 100);
+        assert_eq!(date_a.days_to(date_b), 100);
     }
 
     #[test]
     fn qdate_julian_day() {
         let date_a = QDate::from_julian_day(1000);
         let date_b = QDate::from_julian_day(1010);
-        assert_eq!(i64::from(date_a.days_to(date_b)), 10);
+        assert_eq!(date_a.days_to(date_b), 10);
     }
 
     #[cfg(feature = "chrono")]

crates/cxx-qt-lib/src/core/qdatetime.rs

@@ -57,10 +57,8 @@ mod ffi {
         /// Returns the date part of the datetime.
         fn date(self: &QDateTime) -> QDate;
 
-        /// Returns the number of days from this datetime to the other datetime.
-        /// The number of days is counted as the number of times midnight is reached between this datetime to the other datetime.
-        /// This means that a 10 minute difference from 23:55 to 0:05 the next day counts as one day.
-        #[rust_name = "days_to"]
+        #[doc(hidden)]
+        #[rust_name = "days_to_qint64"]
         fn daysTo(self: &QDateTime, other: &QDateTime) -> qint64;
 
         /// Returns if this datetime falls in Daylight-Saving Time.
@@ -79,14 +77,12 @@ mod ffi {
         #[rust_name = "offset_from_utc"]
         fn offsetFromUtc(self: &QDateTime) -> i32;
 
-        /// Returns the number of milliseconds from this datetime to the other datetime.
-        /// If the other datetime is earlier than this datetime, the value returned is negative.
-        #[rust_name = "msecs_to"]
+        #[doc(hidden)]
+        #[rust_name = "msecs_to_qint64"]
         fn msecsTo(self: &QDateTime, other: &QDateTime) -> qint64;
 
-        /// Returns the number of seconds from this datetime to the other datetime.
-        /// If the other datetime is earlier than this datetime, the value returned is negative.
-        #[rust_name = "secs_to"]
+        #[doc(hidden)]
+        #[rust_name = "secs_to_qint64"]
         fn secsTo(self: &QDateTime, other: &QDateTime) -> qint64;
 
         #[doc(hidden)]
@@ -126,16 +122,16 @@ mod ffi {
         #[rust_name = "to_local_time"]
         fn toLocalTime(self: &QDateTime) -> QDateTime;
 
-        /// Returns the datetime as the number of milliseconds that have passed since 1970-01-01T00:00:00.000, Coordinated Universal Time (Qt::UTC).
-        #[rust_name = "to_msecs_since_epoch"]
+        #[doc(hidden)]
+        #[rust_name = "to_msecs_since_epoch_qint64"]
         fn toMSecsSinceEpoch(self: &QDateTime) -> qint64;
 
         /// Returns a copy of this datetime converted to a spec of Qt::OffsetFromUTC with the given offsetSeconds.
         #[rust_name = "to_offset_from_utc"]
         fn toOffsetFromUtc(self: &QDateTime, offset_seconds: i32) -> QDateTime;
 
-        /// Returns the datetime as the number of seconds that have passed since 1970-01-01T00:00:00.000, Coordinated Universal Time (Qt::UTC).
-        #[rust_name = "to_secs_since_epoch"]
+        #[doc(hidden)]
+        #[rust_name = "to_secs_since_epoch_qint64"]
         fn toSecsSinceEpoch(self: &QDateTime) -> qint64;
 
         /// Returns the time as a string. The format parameter determines the format of the string.
@@ -274,13 +270,20 @@ impl QDateTime {
 
     /// Returns the number of milliseconds since 1970-01-01T00:00:00 Universal Coordinated Time.
     /// This number is like the POSIX time_t variable, but expressed in milliseconds instead.
-    pub fn current_msecs_since_epoch() -> ffi::qint64 {
-        ffi::qdatetime_current_msecs_since_epoch()
+    pub fn current_msecs_since_epoch() -> i64 {
+        ffi::qdatetime_current_msecs_since_epoch().into()
     }
 
     /// Returns the number of seconds since 1970-01-01T00:00:00 Universal Coordinated Time.
-    pub fn current_secs_since_epoch() -> ffi::qint64 {
-        ffi::qdatetime_current_secs_since_epoch()
+    pub fn current_secs_since_epoch() -> i64 {
+        ffi::qdatetime_current_secs_since_epoch().into()
+    }
+
+    /// Returns the number of days from this datetime to the other datetime.
+    /// The number of days is counted as the number of times midnight is reached between this datetime to the other datetime.
+    /// This means that a 10 minute difference from 23:55 to 0:05 the next day counts as one day.
+    pub fn days_to(&self, other: &Self) -> i64 {
+        self.days_to_qint64(other).into()
     }
 
     /// Construct a Rust QDateTime from a given QDate, QTime, and QTimeZone
@@ -307,14 +310,14 @@ impl QDateTime {
 
     /// Returns a datetime whose date and time are the number of milliseconds msecs that have passed since 1970-01-01T00:00:00.000,
     /// Coordinated Universal Time (Qt::UTC) and with the given timeZone.
-    pub fn from_msecs_since_epoch(msecs: ffi::qint64, time_zone: &ffi::QTimeZone) -> Self {
-        ffi::qdatetime_from_msecs_since_epoch(msecs, time_zone)
+    pub fn from_msecs_since_epoch(msecs: i64, time_zone: &ffi::QTimeZone) -> Self {
+        ffi::qdatetime_from_msecs_since_epoch(msecs.into(), time_zone)
     }
 
     /// Returns a datetime whose date and time are the number of seconds secs that have passed since 1970-01-01T00:00:00.000,
     /// Coordinated Universal Time (Qt::UTC) and converted to the given spec.
-    pub fn from_secs_since_epoch(secs: ffi::qint64, time_zone: &ffi::QTimeZone) -> Self {
-        ffi::qdatetime_from_secs_since_epoch(secs, time_zone)
+    pub fn from_secs_since_epoch(secs: i64, time_zone: &ffi::QTimeZone) -> Self {
+        ffi::qdatetime_from_secs_since_epoch(secs.into(), time_zone)
     }
 
     /// Returns the datetime represented in the string as a QDateTime using the format given, or None if this is not possible.
@@ -327,6 +330,18 @@ impl QDateTime {
         }
     }
 
+    /// Returns the number of milliseconds from this datetime to the other datetime.
+    /// If the other datetime is earlier than this datetime, the value returned is negative.
+    pub fn msecs_to(self: &QDateTime, other: &QDateTime) -> i64 {
+        self.msecs_to_qint64(other).into()
+    }
+
+    /// Returns the number of seconds from this datetime to the other datetime.
+    /// If the other datetime is earlier than this datetime, the value returned is negative.
+    pub fn secs_to(self: &QDateTime, other: &QDateTime) -> i64 {
+        self.secs_to_qint64(other).into()
+    }
+
     /// Sets the date part of this datetime to date. If no time is set yet, it is set to midnight.
     /// If date is invalid, this QDateTime becomes invalid.
     pub fn set_date(&mut self, date: QDate) {
@@ -355,6 +370,16 @@ impl QDateTime {
     pub fn time_zone(&self) -> cxx::UniquePtr<ffi::QTimeZone> {
         ffi::qdatetime_time_zone(self)
     }
+
+    /// Returns the datetime as the number of milliseconds that have passed since 1970-01-01T00:00:00.000, Coordinated Universal Time (Qt::UTC).
+    pub fn to_msecs_since_epoch(self: &QDateTime) -> i64 {
+        self.to_msecs_since_epoch_qint64().into()
+    }
+
+    /// Returns the datetime as the number of seconds that have passed since 1970-01-01T00:00:00.000, Coordinated Universal Time (Qt::UTC).
+    pub fn to_secs_since_epoch(self: &QDateTime) -> i64 {
+        self.to_secs_since_epoch_qint64().into()
+    }
 }
 
 impl Clone for QDateTime {

crates/cxx-qt-lib/src/core/qmodelindex.rs

@@ -36,8 +36,8 @@ mod ffi {
         #[rust_name = "sibling_at_row"]
         fn siblingAtRow(self: &QModelIndex, row: i32) -> QModelIndex;
 
-        /// Returns a `quintptr` used by the model to associate the index with the internal data structure.
-        #[rust_name = "internal_id"]
+        #[doc(hidden)]
+        #[rust_name = "internal_id_quintptr"]
         fn internalId(self: &QModelIndex) -> quintptr;
         /// Returns a `*mut c_void` pointer used by the model to associate the index with the internal data structure.
         #[rust_name = "internal_pointer_mut"]
@@ -98,6 +98,13 @@ impl fmt::Debug for QModelIndex {
     }
 }
 
+impl QModelIndex {
+    /// Returns a `usize` used by the model to associate the index with the internal data structure.
+    pub fn internal_id(self: &QModelIndex) -> usize {
+        self.internal_id_quintptr().into()
+    }
+}
+
 // Safety:
 //
 // Static checks on the C++ side to ensure the size is the same.

crates/cxx-qt-lib/src/lib.rs

@@ -4,6 +4,8 @@
 //
 // SPDX-License-Identifier: MIT OR Apache-2.0
 
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
+
 #[cfg(not(any(cxxqt_qt_version_major = "5", cxxqt_qt_version_major = "6")))]
 compile_error!("cxxqt_qt_version_major must be either \"5\" or \"6\"");
 

tests/qt_types_standalone/rust/src/qmodelindex.rs

@@ -47,5 +47,5 @@ fn internal_pointer_qmodelindex(i: &QModelIndex) -> *mut qmodelindex_cxx::c_void
 }
 
 fn internal_id_qmodelindex(i: &QModelIndex) -> cxx_qt_lib::quintptr {
-    i.internal_id()
+    i.internal_id().into()
 }