mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
7fc815e383
This introduces support for converting a Swift closure that captures variables from its surrounding context into an instance of `std::function`, which is useful for working with C++ APIs that use callbacks. Each instantiation of `std::function` gets a synthesized Swift constructor that takes a Swift closure. Unlike the previous implementation, the closure is _not_ marked as `@convention(c)`. The body of the constructor is created lazily. Under the hood, the closure is bitcast to a pair of a function pointer and a context pointer, which are then wrapped in a C++ object, `__SwiftFunctionWrapper`, that manages the lifetime of the context object via calls to `swift_retain`/`swift_release` from the copy constructor and the destructor. The `__SwiftFunctionWrapper` class is templated, and is instantiated by ClangImporter. rdar://133777029
196 lines
8.9 KiB
C++
196 lines
8.9 KiB
C++
//===--- Strings.h - Shared string constants across components --*- C++ -*-===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See https://swift.org/LICENSE.txt for license information
|
|
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_STRINGS_H
|
|
#define SWIFT_STRINGS_H
|
|
|
|
#include "swift/Basic/LLVM.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
|
|
namespace swift {
|
|
|
|
/// The name of the standard library, which is a reserved module name.
|
|
constexpr static const StringLiteral STDLIB_NAME = "Swift";
|
|
/// The name of the Onone support library, which is a reserved module name.
|
|
constexpr static const StringLiteral SWIFT_ONONE_SUPPORT = "SwiftOnoneSupport";
|
|
/// The name of the Concurrency module, which supports that extension.
|
|
constexpr static const StringLiteral SWIFT_CONCURRENCY_NAME = "_Concurrency";
|
|
/// The name of the Concurrency Shims Clang module
|
|
constexpr static const StringLiteral SWIFT_CONCURRENCY_SHIMS_NAME = "_SwiftConcurrencyShims";
|
|
/// The unique ABI prefix that swift-syntax uses when it's built as part of the
|
|
/// compiler.
|
|
constexpr static const StringLiteral SWIFT_MODULE_ABI_NAME_PREFIX = "Compiler";
|
|
/// The name of the Distributed module, which supports that extension.
|
|
constexpr static const StringLiteral SWIFT_DISTRIBUTED_NAME = "Distributed";
|
|
/// The name of the StringProcessing module, which supports that extension.
|
|
constexpr static const StringLiteral SWIFT_STRING_PROCESSING_NAME = "_StringProcessing";
|
|
/// The name of the SwiftShims module, which contains private stdlib decls.
|
|
constexpr static const StringLiteral SWIFT_SHIMS_NAME = "SwiftShims";
|
|
/// The name of the CxxShim module, which contains a cxx casting utility.
|
|
constexpr static const StringLiteral CXX_SHIM_NAME = "CxxShim";
|
|
/// The name of the CxxStdlibShim module, which contains utilities for the C++ stdlib overlay.
|
|
constexpr static const StringLiteral CXX_STDLIB_SHIM_NAME = "CxxStdlibShim";
|
|
/// The name of the Cxx module, which contains C++ interop helper protocols.
|
|
constexpr static const StringLiteral CXX_MODULE_NAME = "Cxx";
|
|
/// The name of the Builtin module, which contains Builtin functions.
|
|
constexpr static const StringLiteral BUILTIN_NAME = "Builtin";
|
|
/// The name of the clang imported header module.
|
|
constexpr static const StringLiteral CLANG_HEADER_MODULE_NAME = "__ObjC";
|
|
/// The prefix of module names used by LLDB to capture Swift expressions
|
|
constexpr static const StringLiteral LLDB_EXPRESSIONS_MODULE_NAME_PREFIX =
|
|
"__lldb_expr_";
|
|
|
|
/// The name of the fake module used to hold imported Objective-C things.
|
|
constexpr static const StringLiteral MANGLING_MODULE_OBJC = "__C";
|
|
/// The name of the fake module used to hold synthesized ClangImporter things.
|
|
constexpr static const StringLiteral MANGLING_MODULE_CLANG_IMPORTER =
|
|
"__C_Synthesized";
|
|
|
|
/// The name prefix for C++ template instantiation imported as a Swift struct.
|
|
constexpr static const StringLiteral CXX_TEMPLATE_INST_PREFIX =
|
|
"__CxxTemplateInst";
|
|
|
|
constexpr static const StringLiteral SEMANTICS_PROGRAMTERMINATION_POINT =
|
|
"programtermination_point";
|
|
|
|
constexpr static const StringLiteral SEMANTICS_DEFAULT_ACTOR =
|
|
"defaultActor";
|
|
|
|
constexpr static const StringLiteral SEMANTICS_UNAVAILABLE_CODE_REACHED =
|
|
"unavailable_code_reached";
|
|
|
|
constexpr static const StringLiteral DEFAULT_ACTOR_STORAGE_FIELD_NAME =
|
|
"$defaultActor";
|
|
|
|
constexpr static const StringLiteral NON_DEFAULT_DISTRIBUTED_ACTOR_STORAGE_FIELD_NAME =
|
|
"$nonDefaultDistributedActor";
|
|
|
|
/// The name of the Builtin type prefix
|
|
constexpr static const StringLiteral BUILTIN_TYPE_NAME_PREFIX = "Builtin.";
|
|
|
|
/// The default SPI group name to associate with Clang SPIs.
|
|
constexpr static const StringLiteral CLANG_MODULE_DEFAULT_SPI_GROUP_NAME =
|
|
"OBJC_DEFAULT_SPI_GROUP";
|
|
|
|
/// The attribute name for @_spi_available
|
|
constexpr static const StringLiteral SPI_AVAILABLE_ATTRNAME =
|
|
"_spi_available";
|
|
|
|
/// The attribute name for @_unavailableInEmbedded
|
|
constexpr static const StringLiteral UNAVAILABLE_IN_EMBEDDED_ATTRNAME =
|
|
"_unavailableInEmbedded";
|
|
|
|
/// A composition class containing a StringLiteral for the names of
|
|
/// Swift builtins. The reason we use this is to ensure that we when
|
|
/// necessary slice off the "Builtin." prefix from these names in a
|
|
/// constexpr way from a global constant string.
|
|
///
|
|
/// NOTE: StringLiteral is a weird class to compose with. For this to
|
|
/// work properly, one must always initialize these classes using an
|
|
/// initializer list as shown below.
|
|
struct BuiltinNameStringLiteral {
|
|
const StringLiteral literal;
|
|
|
|
constexpr operator StringRef() const { return literal; }
|
|
|
|
StringRef getWithoutPrefix() const {
|
|
return literal.drop_front(BUILTIN_TYPE_NAME_PREFIX.size());
|
|
}
|
|
};
|
|
|
|
/// The name of the Builtin type for Int
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_INT = {
|
|
"Builtin.Int"};
|
|
/// The name of the Builtin type for Int8
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_INT8 = {
|
|
"Builtin.Int8"};
|
|
/// The name of the Builtin type for Int16
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_INT16 = {
|
|
"Builtin.Int16"};
|
|
/// The name of the Builtin type for Int32
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_INT32 = {
|
|
"Builtin.Int32"};
|
|
/// The name of the Builtin type for Int64
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_INT64 = {
|
|
"Builtin.Int64"};
|
|
/// The name of the Builtin type for Int128
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_INT128 = {
|
|
"Builtin.Int128"};
|
|
/// The name of the Builtin type for Int256
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_INT256 = {
|
|
"Builtin.Int256"};
|
|
/// The name of the Builtin type for Int512
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_INT512 = {
|
|
"Builtin.Int512"};
|
|
/// The name of the Builtin type for IntLiteral
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_INTLITERAL = {
|
|
"Builtin.IntLiteral"};
|
|
/// The name of the Builtin type for IEEE Floating point types.
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_FLOAT = {
|
|
"Builtin.FPIEEE"};
|
|
// The name of the builtin type for power pc specific floating point types.
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_FLOAT_PPC = {
|
|
"Builtin.FPPPC"};
|
|
/// The name of the Builtin type for NativeObject
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_NATIVEOBJECT = {
|
|
"Builtin.NativeObject"};
|
|
/// The name of the Builtin type for BridgeObject
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_BRIDGEOBJECT = {
|
|
"Builtin.BridgeObject"};
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_IMPLICITACTOR = {
|
|
"Builtin.ImplicitActor"};
|
|
/// The name of the Builtin type for RawPointer
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_RAWPOINTER = {
|
|
"Builtin.RawPointer"};
|
|
/// The name of the Builtin type for RawUnsafeContinuation
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_RAWUNSAFECONTINUATION = {
|
|
"Builtin.RawUnsafeContinuation"};
|
|
/// The name of the Builtin type for UnsafeValueBuffer
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_UNSAFEVALUEBUFFER =
|
|
{"Builtin.UnsafeValueBuffer"};
|
|
/// The name of the Builtin type for Job
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_JOB = {
|
|
"Builtin.Job"};
|
|
/// The name of the Builtin type for SerialExecutorRef
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_EXECUTOR = {
|
|
"Builtin.Executor"};
|
|
/// The name of the Builtin type for DefaultActorStorage
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_DEFAULTACTORSTORAGE = {
|
|
"Builtin.DefaultActorStorage"};
|
|
/// The name of the Builtin type for NonDefaultDistributedActorStorage
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_NONDEFAULTDISTRIBUTEDACTORSTORAGE = {
|
|
"Builtin.NonDefaultDistributedActorStorage"};
|
|
/// The name of the Builtin type for UnknownObject
|
|
///
|
|
/// This no longer exists as an AST-accessible type, but it's still used for
|
|
/// fields shaped like AnyObject when ObjC interop is enabled.
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_UNKNOWNOBJECT = {
|
|
"Builtin.UnknownObject"};
|
|
/// The name of the Builtin type for Vector
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_VEC = {
|
|
"Builtin.Vec"};
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_FIXEDARRAY = {
|
|
"Builtin.FixedArray"};
|
|
/// The name of the Builtin type for SILToken
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_SILTOKEN = {
|
|
"Builtin.SILToken"};
|
|
/// The name of the Builtin type for Word
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_WORD = {
|
|
"Builtin.Word"};
|
|
/// The name of the Builtin type for PackIndex
|
|
constexpr static BuiltinNameStringLiteral BUILTIN_TYPE_NAME_PACKINDEX = {
|
|
"Builtin.PackIndex"};
|
|
|
|
} // end namespace swift
|
|
|
|
#endif // SWIFT_STRINGS_H
|