Add tutorial on adding Rust wrappers for Qt C++ API #171
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds set_flag as a separate method on Graph struct, to extend the tutorial with fully usable wrapper and wrapper-specific documentation. Fixes potential compilation issue of Graph example: cpp! with #include was missing from main.rs, and the C++ code using QQuickItem accidentally worked, because of #include declared in cpp! inside another Rust file/module. But cpp crate does not specify in which order content of cpp! content between files, so it should not be relied on. Reorders #include lines in Graph example, such that external (Qt) stuff is on top, and local imports follow below. Resolves woboq#169
ratijas
added
A-wrappers
|
@dearkarm you are welcome to review too! What do you think? It would be nice to know whether such tutorial could've helped you on your adventure. |
ogoffart
approved these changes
Jul 12, 2021
There was a problem hiding this comment.
Thank you, this is great!
one thing maybe is that we want to emphasis that this should normaly not be needed.
Maybe the tutorial should be in a different .md file linked from the README instead of being dirrectly in the README, so we don't show in the README the scary cpp! macro for someone just browsing through.
ratijas
added
S-waiting-on-author
* Rewords dependencies section, to nudge reader toward using published versions of qttypes. * Changes local path to explicitly absurd, to avoid assumptions that we are working from qmetaobject-rs subdirectory. * Removes "..." from features array, to make this line copy-pastable. * Comments out ... in appendSample function to avoid breaking Rust syntax (and make it copy-pastable too). * Formats qttypes cargo features comma-separated list of Qt modules into a table.
Shhhh!.. 🤫 |
ratijas
added
S-waiting-on-review
ogoffart
approved these changes
Jul 12, 2021
ratijas
removed
the
S-waiting-on-review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sir, one review for me please
I'm not sure about that last list of "This applies to the
following situations".
Adds set_flag as a separate method on Graph struct, to extend the
tutorial with fully usable wrapper and wrapper-specific documentation.
Fixes potential compilation issue of Graph example: cpp! with #include
was missing from main.rs, and the C++ code using QQuickItem
accidentally worked, because of #include declared in cpp! inside
another Rust file/module. But cpp crate does not specify in which order
content of cpp! content between files, so it should not be relied on.
Reorders #include lines in Graph example, such that external (Qt) stuff
is on top, and local imports follow below.
Resolves #169