[cxx-interop] Use more correct type names in C++ template parameters #68620
Conversation
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
|
This unblocks #68240. |
|
@swift-ci please smoke test |
|
@swift-ci please test |
egorzhdan
force-pushed
the
egorzhdan/template-type-names
branch
from
23fc265 to
856216d
Compare
egorzhdan
requested review from
ahoppen,
bnbarham,
rintaro and
hamishknight
as code owners
|
@swift-ci please smoke test |
egorzhdan
force-pushed
the
egorzhdan/template-type-names
branch
from
856216d to
6cbdcaf
Compare
|
@swift-ci please smoke test |
1 similar comment
|
@swift-ci please smoke test |
egorzhdan
force-pushed
the
egorzhdan/template-type-names
branch
from
6cbdcaf to
dae04e2
Compare
|
@swift-ci please smoke test |
egorzhdan
force-pushed
the
egorzhdan/template-type-names
branch
from
dae04e2 to
c83df4f
Compare
|
@swift-ci please smoke test |
egorzhdan
force-pushed
the
egorzhdan/template-type-names
branch
2 times, most recently
from
bcaa474 to
3fa512d
Compare
|
@swift-ci please smoke test |
egorzhdan
force-pushed
the
egorzhdan/template-type-names
branch
from
3fa512d to
eee38f0
Compare
|
@swift-ci please smoke test |
egorzhdan
force-pushed
the
egorzhdan/template-type-names
branch
from
eee38f0 to
6f146a0
Compare
|
@swift-ci please smoke test |
egorzhdan
force-pushed
the
egorzhdan/template-type-names
branch
from
6f146a0 to
f2e4832
Compare
|
@swift-ci please smoke test |
When importing a C++ class template instantiation, Swift translates the template parameter type names from C++ into their Swift equivalent. For instance, `basic_string<wchar_t, char_traits<wchar_t>, allocator<wchar_t>>` gets imported as `basic_string<Scalar, char_traits<Scalar>, allocator<Scalar>>`: `wchar_t` is imported as `CWideChar`, which is a typealias for `Scalar` on most platforms including Darwin. Notice that Swift goes through the `CWideChar` typealias on the specific platform. Another instantiation `basic_string<uint32_t, char_traits<uint32_t>, allocator<uint32_t>>` also gets imported as `basic_string<Scalar, char_traits<Scalar>, allocator<Scalar>>`: `uint32_t` is also imported as `Scalar`. This is problematic because we have two distinct C++ types that have the same name in Swift. This change makes sure Swift doesn't go through typealiases when emitting names of template parameters, so `wchar_t` would now get printed as `CWideChar`, `int` would get printed as `CInt`, etc. This also encourages clients to use the correct type (`CInt`, `CWideChar`, etc) instead of relying on platform-specific typealiases. rdar://115673622
egorzhdan
force-pushed
the
egorzhdan/template-type-names
branch
from
f2e4832 to
041005a
Compare
|
@swift-ci please smoke test |
egorzhdan
commented
Oct 9, 2023
| @@ -2217,7 +2217,7 @@ ImportedName NameImporter::importNameImpl(const clang::NamedDecl *D, | |||
| version, givenName); | |||
| if (!isa<clang::ClassTemplatePartialSpecializationDecl>(D)) { | |||
| auto getSwiftBuiltinTypeName = | |||
| [&](const clang::BuiltinType *builtin) -> std::optional<StringRef> { | |||
| [&](const clang::BuiltinType *builtin) -> std::optional<std::string> { | |||
There was a problem hiding this comment.
This dangling pointer issue got exposed by this patch
hyp
approved these changes
Oct 9, 2023
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.
When importing a C++ class template instantiation, Swift translates the template parameter type names from C++ into their Swift equivalent.
For instance,
basic_string<wchar_t, char_traits<wchar_t>, allocator<wchar_t>>gets imported asbasic_string<Scalar, char_traits<Scalar>, allocator<Scalar>>:wchar_tis imported asCWideChar, which is a typealias forScalaron most platforms including Darwin. Notice that Swift goes through theCWideChartypealias on the specific platform. Another instantiationbasic_string<uint32_t, char_traits<uint32_t>, allocator<uint32_t>>also gets imported asbasic_string<Scalar, char_traits<Scalar>, allocator<Scalar>>:uint32_tis also imported asScalar. This is problematic because we have two distinct C++ types that have the same name in Swift.This change makes sure Swift doesn't go through typealiases when emitting names of template parameters, so
wchar_twould now get printed asCWideChar,intwould get printed asCInt, etc.This also encourages clients to use the correct type (
CInt,CWideChar, etc) instead of relying on platform-specific typealiases.rdar://115673622