Make `GenericSignature::getCanonicalSignature` not crash for nullptr `GenericSignature`?

Development Compiler
1

Currently, GenericSignatureImpl::getCanonicalSignature() crashes for GenericSignature with underlying nullptr. This leads to lots of boilerplate code:

// Ideal:
auto canGenSig = genSig->getCanonicalSignature();

// Workaround:
CanGenericSignature canGenSig;
if (genSig)
  canGenSig = genSig->getCanonicalSignature();

// Workaround:
auto canGenSig =
  genSig ? genSig->getCanonicalSignature() : CanGenericSignature();

Is this intentional? Is it possible to change GenericSignatureImpl::getCanonicalSignature() to return CanGenericSignature() when this is nullptr?

I wonder if TypeBase::getCanonicalType has the same issue (crashing when this is nullptr), and whether that can be changed too.

cc @codafi

2

It is undefined behavior to call a method on a null pointer in C++. I would guess that the intent was eventually to make getCanonicalSignature a method directly on the GenericSignature wrapper type, which could check for null before invoking the method on the underlying impl. Eventually, most of the important API for GenericSignature should probably live on GenericSignature, and provide reasonable default behavior for empty generic signatures, so that GenericSignatureImpl can be hidden.

3

Ah, oops.

That sounds great! I can start a patch to do this and to rewrite caller workarounds, if that's acceptable.

4

Sounds great, thanks!

5

Done in NFC: Add `GenericSignature::getCanonicalSignature`. by dan-zheng · Pull Request #29105 · apple/swift · GitHub, awaiting review.

1 Like