Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

qtypes: add support for Qt alias types that don't match #904

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

ahayzen-kdab
Copy link
Collaborator

Closes #882

crates/cxx-qt-lib/src/core/qtypes.rs Outdated Show resolved Hide resolved
crates/cxx-qt-lib/src/core/qtypes.cpp Outdated Show resolved Hide resolved
crates/cxx-qt-lib-headers/include/core/qtypes.h Outdated Show resolved Hide resolved
Copy link

codecov bot commented Sep 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (e6ee353) to head (709d25d).

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #904   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           71        71           
  Lines        11949     11949           
=========================================
  Hits         11949     11949           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ahayzen-kdab ahayzen-kdab force-pushed the 882-add-qtypes branch 2 times, most recently from debf9b7 to 79cc8fe Compare October 11, 2024 10:49
@ahayzen-kdab ahayzen-kdab force-pushed the 882-add-qtypes branch 3 times, most recently from 6a21207 to c67af09 Compare October 11, 2024 14:27
@ahayzen-kdab ahayzen-kdab marked this pull request as ready for review October 11, 2024 14:29
@ahayzen-kdab ahayzen-kdab changed the title WIP: qtypes: add support for Qt alias types that don't match qtypes: add support for Qt alias types that don't match Oct 11, 2024
Copy link
Collaborator

@LeonMatthesKDAB LeonMatthesKDAB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall this looks good.
Naming wise I would just copy Qts casing (so lowercase). These types are quiet "fundamental types", which even in Rust are lowercase (i64, isize, etc.).

A sort-off open question is still how many operations we want to support on these...
Do we basically just enable From/Into and call it a day, or do we want to have support for using the type more directly, like support for +-*/ on qint64...

For now it's probably good enough if we just have them convertable to their inner type, but something to keep in mind.

On the same note: Maybe we don't want to support Deref on these types?
It may be weird if you call e.g. abs on qint64, but get an i64 back...
And now it would be a breaking change for us to add our own abs method that returns qint64...

So it seems like limiting the API to just From/To with some derives is maybe best?


/// Typedef for long long int. This type is guaranteed to be 64-bit on all platforms supported by Qt.
#[repr(transparent)]
#[derive(Default, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add Clone and Copy to this list as well...

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

/// Typedef for long long int. This type is guaranteed to be 64-bit on all platforms supported by Qt.
#[repr(transparent)]
#[derive(Default, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub struct QInt64(i64);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's go with qint64 here. No need to rename the type. It's still a sort off "fundamental type" like i64, which is also lowercase.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


/// Integral type for representing pointers in a signed integer (useful for hashing, etc.).
#[repr(transparent)]
#[derive(Default, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, let's add Copy and Clone to that list :)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

///
/// Note that configuring Qt with -qreal float is not supported
#[repr(transparent)]
#[derive(Default, Debug, PartialEq, PartialOrd)]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy + Clone

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


/// Typedef for unsigned long long int. This type is guaranteed to be 64-bit on all platforms supported by Qt.
#[repr(transparent)]
#[derive(Default, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy + Clone

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


/// Integral type for representing pointers in an unsigned integer (useful for hashing, etc.).
#[repr(transparent)]
#[derive(Default, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy + Clone

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

/// Integral type providing Posix' ssize_t for all platforms.
///
/// This type is guaranteed to be the same size as a size_t on all platforms supported by Qt.
#[derive(Default, Debug, Hash, PartialEq, Eq, PartialOrd, Ord)]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy + Clone

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -17,6 +17,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased](https://github.com/KDAB/cxx-qt/compare/v0.7.0...HEAD)

### Added

- Support for further types: `qreal`, `qint64`, `qintptr`, `qsizetype`, `quint64`, `quintptr`
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we also want qlonglong, qulonglong, or qptrdiff ?

See https://doc.qt.io/qt-6/qttypes.html#types for full types in Qt

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add qsizetype to cxx-qt crate
3 participants