Move the qttypes module to its own crate

Author: ogoffart

Cargo.toml

@@ -1,5 +1,6 @@
 [workspace]
 members = [
+    'qttypes',
     'qmetaobject_impl',
     'qmetaobject',
     'examples/todos',

qmetaobject/Cargo.toml

@@ -12,14 +12,14 @@ repository = "https://github.com/woboq/qmetaobject-rs"
 
 [features]
 default = ["log"]
-chrono_qdatetime = ["chrono"]
+chrono_qdatetime = ["qttypes/chrono"]
 webengine = []
 
 [dependencies]
+qttypes = { path = "../qttypes", version = "0.1.4" }
 qmetaobject_impl = { path = "../qmetaobject_impl", version = "=0.1.4"}
 lazy_static = "1.0"
 cpp = "0.5.4"
-chrono = { version = "0.4", optional = true }
 log = { version = "0.4", optional = true }
 
 [build-dependencies]

qmetaobject/src/lib.rs

@@ -75,9 +75,8 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
     # Basic types
 
-    The re-exported module [qttypes](qttypes/index.html) contains binding to the most usefull
-    basic types such as [QString](qttypes/struct.QString.html),
-    [QVariant](qttypes/struct.QVariant.html), ...
+    The re-exported crate [`qttypes`] contains binding to the most usefull
+    basic types such as [`QString`], [`QVariant`], ...
 
     You can also simply use rust type `String`, but using QString might avoid unecessary
     conversions in some case.
@@ -96,7 +95,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
     impl QMetaType for MyPoint {};
     ```
 
-    With that it is also possible to put the type in a  [QVariant](qttypes/struct.QVariant.html)
+    With that it is also possible to put the type in a  [`QVariant`]
 
     # Object pinning
 
@@ -177,6 +176,8 @@ macro_rules! qmetaobject_lazy_static { ($($t:tt)*) => { lazy_static!($($t)*) } }
 use std::cell::RefCell;
 use std::os::raw::{c_char, c_void};
 
+pub use qttypes;
+
 pub use crate::log::*;
 pub use connections::RustSignal;
 pub use connections::{connect, Signal, SignalInner};
@@ -200,7 +201,6 @@ pub mod qrc;
 pub mod qtdeclarative;
 #[cfg(qt_5_7)]
 pub mod qtquickcontrols2;
-pub mod qttypes;
 pub mod scenegraph;
 pub mod tablemodel;
 #[cfg(feature = "webengine")]

qmetaobject/src/qmetatype.rs

@@ -415,3 +415,26 @@ fn test_qmetatype_register_wrong_type2() {
     // registering with the name of an existing type should panic
     MyType::register(Some(&std::ffi::CString::new("String").unwrap()));
 }
+
+#[test]
+fn test_qvariant_datetime() {
+    let dt = QDateTime::from_date_time_local_timezone(
+        QDate::from_y_m_d(2019, 10, 23),
+        QTime::from_h_m_s_ms(10, 30, Some(40), Some(100)),
+    );
+    let v = QVariant::from(dt);
+    let qstring = QString::from_qvariant(v.clone()).unwrap();
+    let mut s = qstring.to_string();
+    if s.ends_with(".100") {
+        // Old version of qt did not include the milliseconds, so remove it
+        s.truncate(s.len() - 4);
+    }
+    assert_eq!(s, "2019-10-23T10:30:40");
+    let qdate = QDate::from_qvariant(v.clone()).unwrap();
+    assert!(qdate == QDate::from_y_m_d(2019, 10, 23));
+    assert!(qdate != QDate::from_y_m_d(2019, 10, 24));
+
+    let qtime = QTime::from_qvariant(v.clone()).unwrap();
+    assert!(qtime == QTime::from_h_m_s_ms(10, 30, Some(40), Some(100)));
+    assert!(qtime != QTime::from_h_m_s_ms(10, 30, Some(40), None));
+}

qttypes/Cargo.toml

@@ -0,0 +1,23 @@
+[package]
+name = "qttypes"
+version = "0.1.4"
+edition = "2018"
+authors = ["Olivier Goffart <ogoffart@woboq.com>"]
+build = "build.rs"
+description = "Manually maintained building for Qt basic types"
+readme = "README.md"
+license = "MIT"
+keywords = ["Qt"]
+repository = "https://github.com/woboq/qmetaobject-rs"
+
+[dependencies]
+cpp = "0.5.6"
+chrono = { version = "0.4", optional = true }
+
+[build-dependencies]
+cpp_build = "0.5.6"
+semver = "0.11"
+
+[package.metadata.docs.rs]
+dependencies = [ "qtbase5-dev", "qtdeclarative5-dev" ]
+rustc-args = [ "--cfg feature=\"docs-only\"" ]

qttypes/build.rs

@@ -0,0 +1,122 @@
+/* Copyright (C) 2018 Olivier Goffart <ogoffart@woboq.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction,
+including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
+OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+extern crate cpp_build;
+use semver::Version;
+use std::io::prelude::*;
+use std::io::BufReader;
+use std::path::Path;
+use std::process::Command;
+
+fn qmake_query(var: &str) -> String {
+    let qmake = std::env::var("QMAKE").unwrap_or("qmake".to_string());
+    String::from_utf8(
+        Command::new(qmake)
+            .env("QT_SELECT", "qt5")
+            .args(&["-query", var])
+            .output()
+            .expect("Failed to execute qmake. Make sure 'qmake' is in your path")
+            .stdout,
+    )
+    .expect("UTF-8 conversion failed")
+}
+
+// qreal is a double, unless QT_COORD_TYPE says otherwise:
+// https://doc.qt.io/qt-5/qtglobal.html#qreal-typedef
+fn detect_qreal_size(qt_include_path: &str) {
+    let path = Path::new(qt_include_path).join("QtCore").join("qconfig.h");
+    let f = std::fs::File::open(&path).expect(&format!("Cannot open `{:?}`", path));
+    let b = BufReader::new(f);
+
+    // Find declaration of QT_COORD_TYPE
+    for line in b.lines() {
+        let line = line.expect("qconfig.h is valid UTF-8");
+        if line.contains("QT_COORD_TYPE") {
+            if line.contains("float") {
+                println!("cargo:rustc-cfg=qreal_is_float");
+                return;
+            } else {
+                panic!("QT_COORD_TYPE with unknown declaration {}", line);
+            }
+        }
+    }
+}
+
+fn main() {
+    let qt_include_path = qmake_query("QT_INSTALL_HEADERS");
+    let qt_library_path = qmake_query("QT_INSTALL_LIBS");
+    let qt_version =
+        qmake_query("QT_VERSION").parse::<Version>().expect("Parsing Qt version failed");
+    let mut config = cpp_build::Config::new();
+
+    if cfg!(target_os = "macos") {
+        config.flag("-F");
+        config.flag(qt_library_path.trim());
+    }
+
+    for minor in 7..=15 {
+        if qt_version >= Version::new(5, minor, 0) {
+            println!("cargo:rustc-cfg=qt_{}_{}", 5, minor);
+        }
+    }
+
+    detect_qreal_size(&qt_include_path.trim());
+
+    config.include(qt_include_path.trim()).build("src/lib.rs");
+
+    let macos_lib_search = if cfg!(target_os = "macos") { "=framework" } else { "" };
+    let macos_lib_framework = if cfg!(target_os = "macos") { "" } else { "5" };
+
+    let debug = std::env::var("DEBUG").ok().map_or(false, |s| s == "true");
+    let windows_dbg_suffix = if debug {
+        if cfg!(target_os = "windows") {
+            println!("cargo:rustc-link-lib=msvcrtd");
+            "d"
+        } else {
+            ""
+        }
+    } else {
+        ""
+    };
+    println!("cargo:rustc-link-search{}={}", macos_lib_search, qt_library_path.trim());
+    println!(
+        "cargo:rustc-link-lib{}=Qt{}Widgets{}",
+        macos_lib_search, macos_lib_framework, windows_dbg_suffix
+    );
+    println!(
+        "cargo:rustc-link-lib{}=Qt{}Gui{}",
+        macos_lib_search, macos_lib_framework, windows_dbg_suffix
+    );
+    println!(
+        "cargo:rustc-link-lib{}=Qt{}Core{}",
+        macos_lib_search, macos_lib_framework, windows_dbg_suffix
+    );
+    println!(
+        "cargo:rustc-link-lib{}=Qt{}Quick{}",
+        macos_lib_search, macos_lib_framework, windows_dbg_suffix
+    );
+    println!(
+        "cargo:rustc-link-lib{}=Qt{}Qml{}",
+        macos_lib_search, macos_lib_framework, windows_dbg_suffix
+    );
+    if cfg!(feature = "webengine") {
+        println!(
+            "cargo:rustc-link-lib{}=Qt{}WebEngine{}",
+            macos_lib_search, macos_lib_framework, windows_dbg_suffix
+        );
+    }
+}

qmetaobject/src/qttypes.rs renamed to qttypes/src/lib.rs

@@ -16,17 +16,29 @@ OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
 //! Various bindings and wrappers for Qt classes, enums, member/static methods and functions.
-extern crate std;
+
+use cpp::{cpp, cpp_class};
 use std::convert::From;
 use std::fmt::Display;
 use std::iter::FromIterator;
 use std::ops::{Index, IndexMut};
 use std::os::raw::c_char;
 use std::str::Utf8Error;
 
-#[cfg(feature = "chrono_qdatetime")]
+#[cfg(feature = "chrono")]
 use chrono::prelude::*;
 
+cpp! {{
+    #include <QtCore/QByteArray>
+    #include <QtCore/QString>
+    #include <QtCore/QDateTime>
+    #include <QtCore/QVariant>
+    #include <QtCore/QModelIndex>
+    #include <QtCore/QUrl>
+
+    #include <QtGui/QImage>
+}}
+
 cpp_class!(
     /// Wrapper around [`QByteArray`][class] class.
     ///
@@ -144,13 +156,13 @@ impl QDate {
         })
     }
 }
-#[cfg(feature = "chrono_qdatetime")]
+#[cfg(feature = "chrono")]
 impl From<NaiveDate> for QDate {
     fn from(a: NaiveDate) -> QDate {
         QDate::from_y_m_d(a.year() as i32, a.month() as i32, a.day() as i32)
     }
 }
-#[cfg(feature = "chrono_qdatetime")]
+#[cfg(feature = "chrono")]
 impl Into<NaiveDate> for QDate {
     fn into(self) -> NaiveDate {
         let (y, m, d) = self.get_y_m_d();
@@ -173,7 +185,7 @@ fn test_qdate_is_valid() {
     assert!(!invalid_qdate.is_valid());
 }
 
-#[cfg(feature = "chrono_qdatetime")]
+#[cfg(feature = "chrono")]
 #[test]
 fn test_qdate_chrono() {
     let chrono_date = NaiveDate::from_ymd(2019, 10, 22);
@@ -260,7 +272,7 @@ impl QTime {
     }
 }
 
-#[cfg(feature = "chrono_qdatetime")]
+#[cfg(feature = "chrono")]
 impl From<NaiveTime> for QTime {
     fn from(a: NaiveTime) -> QTime {
         QTime::from_h_m_s_ms(
@@ -272,7 +284,7 @@ impl From<NaiveTime> for QTime {
     }
 }
 
-#[cfg(feature = "chrono_qdatetime")]
+#[cfg(feature = "chrono")]
 impl Into<NaiveTime> for QTime {
     fn into(self) -> NaiveTime {
         let (h, m, s, ms) = self.get_h_m_s_ms();
@@ -286,7 +298,7 @@ fn test_qtime() {
     assert_eq!((10, 30, 40, 300), qtime.get_h_m_s_ms());
 }
 
-#[cfg(feature = "chrono_qdatetime")]
+#[cfg(feature = "chrono")]
 #[test]
 fn test_qtime_chrono() {
     let chrono_time = NaiveTime::from_hms(10, 30, 50);
@@ -874,31 +886,6 @@ mod tests {
         assert_eq!(qs2.to_string(), "hello");
         assert_eq!(qba4.to_string(), "hello");
     }
-
-    #[test]
-    fn test_qvariant_datetime() {
-        use crate::QMetaType;
-
-        let dt = QDateTime::from_date_time_local_timezone(
-            QDate::from_y_m_d(2019, 10, 23),
-            QTime::from_h_m_s_ms(10, 30, Some(40), Some(100)),
-        );
-        let v = QVariant::from(dt);
-        let qstring = QString::from_qvariant(v.clone()).unwrap();
-        let mut s = qstring.to_string();
-        if s.ends_with(".100") {
-            // Old version of qt did not include the milliseconds, so remove it
-            s.truncate(s.len() - 4);
-        }
-        assert_eq!(s, "2019-10-23T10:30:40");
-        let qdate = QDate::from_qvariant(v.clone()).unwrap();
-        assert!(qdate == QDate::from_y_m_d(2019, 10, 23));
-        assert!(qdate != QDate::from_y_m_d(2019, 10, 24));
-
-        let qtime = QTime::from_qvariant(v.clone()).unwrap();
-        assert!(qtime == QTime::from_h_m_s_ms(10, 30, Some(40), Some(100)));
-        assert!(qtime != QTime::from_h_m_s_ms(10, 30, Some(40), None));
-    }
 }
 
 cpp_class!(