mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
4341102c92
This library uses GenericMetadataBuilder with a ReaderWriter that can read data and resolve pointers from MachO files, and emit a JSON representation of a dylib containing the built metadata. We use LLVM's binary file readers to parse the MachO files and resolve fixups so we can follow pointers. This code is somewhat MachO specific, but could be generalized to other formats that LLVM supports. rdar://116592577
171 lines
7.3 KiB
C++
171 lines
7.3 KiB
C++
//===--- Enum.h - Runtime declarations for enums ----------------*- 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// Swift runtime functions in support of enums.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_RUNTIME_ENUM_H
|
|
#define SWIFT_RUNTIME_ENUM_H
|
|
|
|
#include "swift/Runtime/Config.h"
|
|
|
|
namespace swift {
|
|
|
|
struct OpaqueValue;
|
|
struct InProcess;
|
|
|
|
template <typename Runtime> struct TargetValueWitnessTable;
|
|
using ValueWitnessTable = TargetValueWitnessTable<InProcess>;
|
|
|
|
template <typename Runtime> struct TargetMetadata;
|
|
using Metadata = TargetMetadata<InProcess>;
|
|
|
|
template <typename Runtime> struct TargetEnumMetadata;
|
|
using EnumMetadata = TargetEnumMetadata<InProcess>;
|
|
template <typename Runtime>
|
|
struct TargetTypeLayout;
|
|
using TypeLayout = TargetTypeLayout<InProcess>;
|
|
|
|
/// Initialize the type metadata for a single-case enum type.
|
|
///
|
|
/// \param enumType - pointer to the instantiated but uninitialized metadata
|
|
/// for the enum.
|
|
/// \param flags - flags controlling the layout
|
|
/// \param payload - type metadata for the payload of the enum.
|
|
SWIFT_RUNTIME_EXPORT
|
|
void swift_initEnumMetadataSingleCase(EnumMetadata *enumType,
|
|
EnumLayoutFlags flags,
|
|
const TypeLayout *payload);
|
|
|
|
SWIFT_RUNTIME_EXPORT
|
|
void swift_initEnumMetadataSingleCaseWithLayoutString(
|
|
EnumMetadata *self, EnumLayoutFlags layoutFlags,
|
|
const Metadata *payloadType);
|
|
|
|
/// Initialize the type metadata for a single-payload enum type.
|
|
///
|
|
/// \param enumType - pointer to the instantiated but uninitialized metadata
|
|
/// for the enum.
|
|
/// \param flags - flags controlling the layout
|
|
/// \param payload - type metadata for the payload case of the enum.
|
|
/// \param emptyCases - the number of empty cases in the enum.
|
|
SWIFT_RUNTIME_EXPORT
|
|
void swift_initEnumMetadataSinglePayload(EnumMetadata *enumType,
|
|
EnumLayoutFlags flags,
|
|
const TypeLayout *payload,
|
|
unsigned emptyCases);
|
|
|
|
SWIFT_RUNTIME_EXPORT
|
|
void swift_initEnumMetadataSinglePayloadWithLayoutString(
|
|
EnumMetadata *enumType, EnumLayoutFlags flags, const Metadata *payload,
|
|
unsigned emptyCases);
|
|
|
|
using getExtraInhabitantTag_t =
|
|
SWIFT_CC(swift) unsigned (const OpaqueValue *value,
|
|
unsigned numExtraInhabitants,
|
|
const Metadata *payloadType);
|
|
|
|
/// Implement getEnumTagSinglePayload generically in terms of a
|
|
/// payload type with a getExtraInhabitantIndex function.
|
|
///
|
|
/// \param value - pointer to the enum value.
|
|
/// \param payloadType - type metadata for the payload case of the enum.
|
|
/// \param emptyCases - the number of empty cases in the enum.
|
|
///
|
|
/// \returns 0 if the payload case is inhabited. If an empty case is inhabited,
|
|
/// returns a value greater than or equal to one and less than or equal
|
|
/// emptyCases.
|
|
SWIFT_RUNTIME_EXPORT SWIFT_CC(swift)
|
|
unsigned swift_getEnumTagSinglePayloadGeneric(const OpaqueValue *value,
|
|
unsigned emptyCases,
|
|
const Metadata *payloadType,
|
|
getExtraInhabitantTag_t *getTag);
|
|
|
|
using storeExtraInhabitantTag_t =
|
|
SWIFT_CC(swift) void (OpaqueValue *value,
|
|
unsigned whichCase,
|
|
unsigned numExtraInhabitants,
|
|
const Metadata *payloadType);
|
|
|
|
/// Implement storeEnumTagSinglePayload generically in terms of a
|
|
/// payload type with a storeExtraInhabitant function.
|
|
///
|
|
/// \param value - pointer to the enum value. If the case being initialized is
|
|
/// the payload case (0), then the payload should be
|
|
/// initialized.
|
|
/// \param payloadType - type metadata for the payload case of the enum.
|
|
/// \param whichCase - unique value identifying the case. 0 for the payload
|
|
/// case, or a value greater than or equal to one and less
|
|
/// than or equal emptyCases for an empty case.
|
|
/// \param emptyCases - the number of empty cases in the enum.
|
|
SWIFT_RUNTIME_EXPORT SWIFT_CC(swift)
|
|
void swift_storeEnumTagSinglePayloadGeneric(OpaqueValue *value,
|
|
unsigned whichCase,
|
|
unsigned emptyCases,
|
|
const Metadata *payloadType,
|
|
storeExtraInhabitantTag_t *storeTag);
|
|
|
|
/// Initialize the type metadata for a generic, multi-payload
|
|
/// enum instance.
|
|
SWIFT_RUNTIME_EXPORT
|
|
void swift_initEnumMetadataMultiPayload(EnumMetadata *enumType,
|
|
EnumLayoutFlags flags,
|
|
unsigned numPayloads,
|
|
const TypeLayout * const *payloadTypes);
|
|
|
|
SWIFT_RUNTIME_EXPORT
|
|
void swift_initEnumMetadataMultiPayloadWithLayoutString(EnumMetadata *enumType,
|
|
EnumLayoutFlags flags,
|
|
unsigned numPayloads,
|
|
const Metadata * const *payloadTypes);
|
|
|
|
/// Return an integer value representing which case of a multi-payload
|
|
/// enum is inhabited.
|
|
///
|
|
/// \param value - pointer to the enum value.
|
|
/// \param enumType - type metadata for the enum.
|
|
///
|
|
/// \returns The index of the enum case.
|
|
SWIFT_RUNTIME_EXPORT
|
|
unsigned swift_getEnumCaseMultiPayload(const OpaqueValue *value,
|
|
const EnumMetadata *enumType);
|
|
|
|
/// Store the tag value for the given case into a multi-payload enum,
|
|
/// whose associated payload (if any) has already been initialized.
|
|
SWIFT_RUNTIME_EXPORT
|
|
void swift_storeEnumTagMultiPayload(OpaqueValue *value,
|
|
const EnumMetadata *enumType,
|
|
unsigned whichCase);
|
|
|
|
/// The unspecialized getEnumTagSinglePayload value witness to be used by the
|
|
/// VWTs for specialized generic enums that are multi-payload.
|
|
///
|
|
/// Runtime availability: Swift 5.6
|
|
SWIFT_RUNTIME_EXPORT
|
|
unsigned swift_getMultiPayloadEnumTagSinglePayload(const OpaqueValue *value,
|
|
uint32_t numExtraCases,
|
|
const Metadata *enumType);
|
|
|
|
/// The unspecialized storeEnumTagSinglePayload value witness to be used by the
|
|
/// VWTs for specialized generic enums that are multi-payload.
|
|
///
|
|
/// Runtime availability: Swift 5.6
|
|
SWIFT_RUNTIME_EXPORT
|
|
void swift_storeMultiPayloadEnumTagSinglePayload(OpaqueValue *value,
|
|
uint32_t index,
|
|
uint32_t numExtraCases,
|
|
const Metadata *enumType);
|
|
}
|
|
|
|
#endif
|