mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
4e4d281aa7
Previously we had two separate mechanisms to turn a metatype into a string. The swift_typeName() function was used to print the metatype in a human-readable fashion, whereas the _swift_buildDemanglingForMetadata() was used when naming generated generic Objective-C classes. Unify them, since what swift_typeName() does is redundant; instead of going directly from the metatype to a human-readable string, we can get the mangling, and print that using the demangler. This fixes some issues with unnecessary parenthesis when printing function types, and also allows Objective-C classes to be instantiated with nested generic types as parameters.
303 lines
11 KiB
C++
303 lines
11 KiB
C++
#include "../../../lib/Basic/Demangle.cpp"
|
|
#include "../../../lib/Basic/Punycode.cpp"
|
|
#include "swift/Runtime/Metadata.h"
|
|
#include "Private.h"
|
|
|
|
#if SWIFT_OBJC_INTEROP
|
|
|
|
#include <objc/runtime.h>
|
|
|
|
// FIXME: This stuff should be merged with the existing logic in
|
|
// include/swift/Reflection/TypeRefBuilder.h as part of the rewrite
|
|
// to change stdlib reflection over to using remote mirrors.
|
|
|
|
Demangle::NodePointer
|
|
swift::_swift_buildDemanglingForMetadata(const Metadata *type);
|
|
|
|
// Build a demangled type tree for a nominal type.
|
|
static Demangle::NodePointer
|
|
_buildDemanglingForNominalType(const Metadata *type) {
|
|
using namespace Demangle;
|
|
|
|
const Metadata *parent;
|
|
Node::Kind boundGenericKind;
|
|
const NominalTypeDescriptor *description;
|
|
|
|
// Demangle the parent type, if any.
|
|
switch (type->getKind()) {
|
|
case MetadataKind::Class: {
|
|
auto classType = static_cast<const ClassMetadata *>(type);
|
|
parent = classType->getParentType(classType->getDescription());
|
|
boundGenericKind = Node::Kind::BoundGenericClass;
|
|
description = classType->getDescription();
|
|
break;
|
|
}
|
|
case MetadataKind::Enum:
|
|
case MetadataKind::Optional: {
|
|
auto enumType = static_cast<const EnumMetadata *>(type);
|
|
parent = enumType->Parent;
|
|
boundGenericKind = Node::Kind::BoundGenericEnum;
|
|
description = enumType->Description;
|
|
break;
|
|
}
|
|
case MetadataKind::Struct: {
|
|
auto structType = static_cast<const StructMetadata *>(type);
|
|
parent = structType->Parent;
|
|
boundGenericKind = Node::Kind::BoundGenericStructure;
|
|
description = structType->Description;
|
|
break;
|
|
}
|
|
default:
|
|
return nullptr;
|
|
}
|
|
|
|
// Demangle the base name.
|
|
auto node = demangleTypeAsNode(description->Name,
|
|
strlen(description->Name));
|
|
assert(node->getKind() == Node::Kind::Type);
|
|
|
|
// Demangle the parent.
|
|
if (parent) {
|
|
auto parentNode = _swift_buildDemanglingForMetadata(parent);
|
|
if (parentNode->getKind() == Node::Kind::Type)
|
|
parentNode = parentNode->getChild(0);
|
|
|
|
auto typeNode = node->getChild(0);
|
|
auto newTypeNode = NodeFactory::create(typeNode->getKind());
|
|
newTypeNode->addChild(parentNode);
|
|
newTypeNode->addChild(typeNode->getChild(1));
|
|
|
|
auto newNode = NodeFactory::create(Node::Kind::Type);
|
|
newNode->addChild(newTypeNode);
|
|
node = newNode;
|
|
}
|
|
|
|
// If generic, demangle the type parameters.
|
|
if (description->GenericParams.NumPrimaryParams > 0) {
|
|
auto typeParams = NodeFactory::create(Node::Kind::TypeList);
|
|
auto typeBytes = reinterpret_cast<const char *>(type);
|
|
auto genericParam = reinterpret_cast<const Metadata * const *>(
|
|
typeBytes + sizeof(void*) * description->GenericParams.Offset);
|
|
for (unsigned i = 0, e = description->GenericParams.NumPrimaryParams;
|
|
i < e; ++i, ++genericParam) {
|
|
auto demangling = _swift_buildDemanglingForMetadata(*genericParam);
|
|
if (demangling == nullptr)
|
|
return nullptr;
|
|
typeParams->addChild(demangling);
|
|
}
|
|
|
|
auto genericNode = NodeFactory::create(boundGenericKind);
|
|
genericNode->addChild(node);
|
|
genericNode->addChild(typeParams);
|
|
return genericNode;
|
|
}
|
|
return node;
|
|
}
|
|
|
|
// Build a demangled type tree for a type.
|
|
Demangle::NodePointer swift::_swift_buildDemanglingForMetadata(const Metadata *type) {
|
|
using namespace Demangle;
|
|
|
|
switch (type->getKind()) {
|
|
case MetadataKind::Class:
|
|
case MetadataKind::Enum:
|
|
case MetadataKind::Optional:
|
|
case MetadataKind::Struct:
|
|
return _buildDemanglingForNominalType(type);
|
|
case MetadataKind::ObjCClassWrapper: {
|
|
#if SWIFT_OBJC_INTEROP
|
|
auto objcWrapper = static_cast<const ObjCClassWrapperMetadata *>(type);
|
|
const char *className = class_getName((Class)objcWrapper->Class);
|
|
|
|
// ObjC classes mangle as being in the magic "__ObjC" module.
|
|
auto module = NodeFactory::create(Node::Kind::Module, "__ObjC");
|
|
|
|
auto node = NodeFactory::create(Node::Kind::Class);
|
|
node->addChild(module);
|
|
node->addChild(NodeFactory::create(Node::Kind::Identifier,
|
|
llvm::StringRef(className)));
|
|
|
|
return node;
|
|
#else
|
|
assert(false && "no ObjC interop");
|
|
return nullptr;
|
|
#endif
|
|
}
|
|
case MetadataKind::ForeignClass: {
|
|
auto foreign = static_cast<const ForeignClassMetadata *>(type);
|
|
return Demangle::demangleTypeAsNode(foreign->getName(),
|
|
strlen(foreign->getName()));
|
|
}
|
|
case MetadataKind::Existential: {
|
|
auto exis = static_cast<const ExistentialTypeMetadata *>(type);
|
|
NodePointer proto_list = NodeFactory::create(Node::Kind::ProtocolList);
|
|
NodePointer type_list = NodeFactory::create(Node::Kind::TypeList);
|
|
|
|
proto_list->addChild(type_list);
|
|
|
|
std::vector<const ProtocolDescriptor *> protocols;
|
|
protocols.reserve(exis->Protocols.NumProtocols);
|
|
for (unsigned i = 0, e = exis->Protocols.NumProtocols; i < e; ++i)
|
|
protocols.push_back(exis->Protocols[i]);
|
|
|
|
// Sort the protocols by their mangled names.
|
|
// The ordering in the existential type metadata is by metadata pointer,
|
|
// which isn't necessarily stable across invocations.
|
|
std::sort(protocols.begin(), protocols.end(),
|
|
[](const ProtocolDescriptor *a, const ProtocolDescriptor *b) -> bool {
|
|
return strcmp(a->Name, b->Name) < 0;
|
|
});
|
|
|
|
for (auto *protocol : protocols) {
|
|
// The protocol name is mangled as a type symbol, with the _Tt prefix.
|
|
auto protocolNode = demangleSymbolAsNode(protocol->Name,
|
|
strlen(protocol->Name));
|
|
|
|
// ObjC protocol names aren't mangled.
|
|
if (!protocolNode) {
|
|
auto module = NodeFactory::create(Node::Kind::Module,
|
|
MANGLING_MODULE_OBJC);
|
|
auto node = NodeFactory::create(Node::Kind::Protocol);
|
|
node->addChild(module);
|
|
node->addChild(NodeFactory::create(Node::Kind::Identifier,
|
|
llvm::StringRef(protocol->Name)));
|
|
auto typeNode = NodeFactory::create(Node::Kind::Type);
|
|
typeNode->addChild(node);
|
|
type_list->addChild(typeNode);
|
|
continue;
|
|
}
|
|
|
|
// FIXME: We have to dig through a ridiculous number of nodes to get
|
|
// to the Protocol node here.
|
|
protocolNode = protocolNode->getChild(0); // Global -> TypeMangling
|
|
protocolNode = protocolNode->getChild(0); // TypeMangling -> Type
|
|
protocolNode = protocolNode->getChild(0); // Type -> ProtocolList
|
|
protocolNode = protocolNode->getChild(0); // ProtocolList -> TypeList
|
|
protocolNode = protocolNode->getChild(0); // TypeList -> Type
|
|
|
|
assert(protocolNode->getKind() == Node::Kind::Type);
|
|
assert(protocolNode->getChild(0)->getKind() == Node::Kind::Protocol);
|
|
type_list->addChild(protocolNode);
|
|
}
|
|
|
|
return proto_list;
|
|
}
|
|
case MetadataKind::ExistentialMetatype: {
|
|
auto metatype = static_cast<const ExistentialMetatypeMetadata *>(type);
|
|
auto instance = _swift_buildDemanglingForMetadata(metatype->InstanceType);
|
|
auto node = NodeFactory::create(Node::Kind::ExistentialMetatype);
|
|
node->addChild(instance);
|
|
return node;
|
|
}
|
|
case MetadataKind::Function: {
|
|
auto func = static_cast<const FunctionTypeMetadata *>(type);
|
|
|
|
Node::Kind kind;
|
|
switch (func->getConvention()) {
|
|
case FunctionMetadataConvention::Swift:
|
|
kind = Node::Kind::FunctionType;
|
|
break;
|
|
case FunctionMetadataConvention::Block:
|
|
kind = Node::Kind::ObjCBlock;
|
|
break;
|
|
case FunctionMetadataConvention::CFunctionPointer:
|
|
kind = Node::Kind::CFunctionPointer;
|
|
break;
|
|
case FunctionMetadataConvention::Thin:
|
|
kind = Node::Kind::ThinFunctionType;
|
|
break;
|
|
}
|
|
|
|
std::vector<NodePointer> inputs;
|
|
for (unsigned i = 0, e = func->getNumArguments(); i < e; ++i) {
|
|
auto arg = func->getArguments()[i];
|
|
auto input = _swift_buildDemanglingForMetadata(arg.getPointer());
|
|
if (arg.getFlag()) {
|
|
NodePointer inout = NodeFactory::create(Node::Kind::InOut);
|
|
inout->addChild(input);
|
|
input = inout;
|
|
}
|
|
inputs.push_back(input);
|
|
}
|
|
|
|
NodePointer totalInput;
|
|
if (inputs.size() > 1) {
|
|
auto tuple = NodeFactory::create(Node::Kind::NonVariadicTuple);
|
|
for (auto &input : inputs)
|
|
tuple->addChild(input);
|
|
totalInput = tuple;
|
|
} else {
|
|
totalInput = inputs.front();
|
|
}
|
|
|
|
NodePointer args = NodeFactory::create(Node::Kind::ArgumentTuple);
|
|
args->addChild(totalInput);
|
|
|
|
NodePointer resultTy = _swift_buildDemanglingForMetadata(func->ResultType);
|
|
NodePointer result = NodeFactory::create(Node::Kind::ReturnType);
|
|
result->addChild(resultTy);
|
|
|
|
auto funcNode = NodeFactory::create(kind);
|
|
if (func->throws())
|
|
funcNode->addChild(NodeFactory::create(Node::Kind::ThrowsAnnotation));
|
|
funcNode->addChild(args);
|
|
funcNode->addChild(result);
|
|
return funcNode;
|
|
}
|
|
case MetadataKind::Metatype: {
|
|
auto metatype = static_cast<const MetatypeMetadata *>(type);
|
|
auto instance = _swift_buildDemanglingForMetadata(metatype->InstanceType);
|
|
auto typeNode = NodeFactory::create(Node::Kind::Type);
|
|
typeNode->addChild(instance);
|
|
auto node = NodeFactory::create(Node::Kind::Metatype);
|
|
node->addChild(typeNode);
|
|
return node;
|
|
}
|
|
case MetadataKind::Tuple: {
|
|
auto tuple = static_cast<const TupleTypeMetadata *>(type);
|
|
const char *labels = tuple->Labels;
|
|
auto tupleNode = NodeFactory::create(Node::Kind::NonVariadicTuple);
|
|
for (unsigned i = 0, e = tuple->NumElements; i < e; ++i) {
|
|
auto elt = NodeFactory::create(Node::Kind::TupleElement);
|
|
|
|
// Add a label child if applicable:
|
|
if (labels) {
|
|
// Look for the next space in the labels string.
|
|
if (const char *space = strchr(labels, ' ')) {
|
|
// If there is one, and the label isn't empty, add a label child.
|
|
if (labels != space) {
|
|
auto eltName =
|
|
NodeFactory::create(Node::Kind::TupleElementName,
|
|
std::string(labels, space));
|
|
elt->addChild(std::move(eltName));
|
|
}
|
|
|
|
// Skip past the space.
|
|
labels = space + 1;
|
|
}
|
|
}
|
|
|
|
// Add the element type child.
|
|
auto eltType =
|
|
_swift_buildDemanglingForMetadata(tuple->getElement(i).Type);
|
|
elt->addChild(std::move(eltType));
|
|
|
|
// Add the completed element to the tuple.
|
|
tupleNode->addChild(std::move(elt));
|
|
}
|
|
return tupleNode;
|
|
}
|
|
case MetadataKind::Opaque:
|
|
// FIXME: Some opaque types do have manglings, but we don't have enough info
|
|
// to figure them out.
|
|
case MetadataKind::HeapLocalVariable:
|
|
case MetadataKind::HeapGenericLocalVariable:
|
|
case MetadataKind::ErrorObject:
|
|
break;
|
|
}
|
|
// Not a type.
|
|
return nullptr;
|
|
}
|
|
|
|
#endif
|