-
Notifications
You must be signed in to change notification settings - Fork 10.5k
[docs] Add a catch all document to record C++ interop oddities. #42149
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# C++ Interoperability Oddities | ||
|
||
C++ APIs may have slightly different behavior than other C++ APIs. This is a general catch-all document where these | ||
oddities are recorded along with a few other things that are good to know when using C++ interop. | ||
|
||
**Parameters with reference types** | ||
|
||
Parameters that have mutable reference types are bridged as inout. Parameters with immutable reference types (const ref) | ||
are bridged as value types. ⚠️ This will change as soon as Swift has a way to represent immutable borrows. ⚠️ | ||
|
||
**Lifetimes** | ||
|
||
Currently, lifetimes are extended to the end of the lexical scope if any unsafe pointers are used in that scope. TODO: | ||
this should be updated to extend lifetimes whenever a C++ type is used in that scope. Currently, if there is no | ||
unsafe pointer used in teh scope, then normal Swift lifetime rules apply. | ||
|
||
**Borrowing Self** | ||
|
||
For mutating methods, self is borrowed and the access to self lasts for the duration of the call. For non-mutating | ||
methods, the access to self is currently instantanious. ⚠️ In the very near future we plan to borrow self in both cases. | ||
This will be a source breaking change from what native Swift methods do. ⚠️ | ||
|
||
_More to come soon :)_ |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo "teh"