mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
d2a5fbd94a
This change attempts to introduce the functionality without being too
disruptive. After we branch, I want to consolidate some of the runtime
functions and implement this functionality for multi-payload enums
as well, which requires adding new runtime metadata.
Example:
(swift) enum Color { case Red, Green, Blue(Int) }
(swift) print(Color.Red)
REPL.Color.Red
(swift) print(Color.Blue(5))
REPL.Color.Blue(5)
Implements <rdar://problem/18334936>.
Swift SVN r28430
103 lines
4.6 KiB
C++
103 lines
4.6 KiB
C++
//===--- Enum.h - Runtime declarations for enums ---------------*- C++ -*--===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2015 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See http://swift.org/LICENSE.txt for license information
|
|
// See http://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
|
|
|
|
namespace swift {
|
|
|
|
struct OpaqueValue;
|
|
struct ValueWitnessTable;
|
|
struct Metadata;
|
|
struct EnumMetadata;
|
|
|
|
/// \brief Return an integer value representing which case is inhabited for
|
|
/// an enum where all cases are empty.
|
|
///
|
|
/// Only used by reflection and not called from generated code, but extern
|
|
/// it for consistency.
|
|
///
|
|
/// \param value - pointer to the enum value.
|
|
/// \param emptyCases - the number of empty cases in the enum.
|
|
///
|
|
/// \returns a value greater than or equal to zero and less than emptyCases.
|
|
extern "C" int swift_getEnumCaseSimple(const OpaqueValue *value,
|
|
unsigned emptyCases);
|
|
|
|
/// \brief Initialize the value witness table for a generic, single-payload
|
|
/// enum instance.
|
|
///
|
|
/// \param vwtable - pointer to the instantiated but uninitialized value
|
|
/// witness table for the enum.
|
|
/// \param payload - type metadata for the payload case of the enum.
|
|
/// \param emptyCases - the number of empty cases in the enum.
|
|
extern "C" void swift_initEnumValueWitnessTableSinglePayload(
|
|
ValueWitnessTable *vwtable,
|
|
const Metadata *payload,
|
|
unsigned emptyCases);
|
|
|
|
/// \brief Return an integer value representing which case of a single-payload
|
|
/// enum is inhabited.
|
|
///
|
|
/// \param value - pointer to the enum value.
|
|
/// \param payload - type metadata for the payload case of the enum.
|
|
/// \param emptyCases - the number of empty cases in the enum.
|
|
///
|
|
/// \returns -1 if the payload case is inhabited. If an empty case is inhabited,
|
|
/// returns a value greater than or equal to zero and less than
|
|
/// emptyCases.
|
|
extern "C" int swift_getEnumCaseSinglePayload(const OpaqueValue *value,
|
|
const Metadata *payload,
|
|
unsigned emptyCases);
|
|
|
|
/// \brief Store the tag value for the given case into a single-payload enum,
|
|
/// whose associated payload (if any) has already been initialized.
|
|
///
|
|
/// \param value - pointer to the enum value. If the case being initialized is
|
|
/// the payload case (-1), then the payload should be
|
|
/// initialized.
|
|
/// \param payload - type metadata for the payload case of the enum.
|
|
/// \param whichCase - unique value identifying the case. -1 for the payload
|
|
/// case, or a value greater than or equal to zero and less
|
|
/// than emptyCases for an empty case.
|
|
/// \param emptyCases - the number of empty cases in the enum.
|
|
extern "C" void swift_storeEnumTagSinglePayload(OpaqueValue *value,
|
|
const Metadata *payload,
|
|
int whichCase,
|
|
unsigned emptyCases);
|
|
|
|
/// \brief Initialize the value witness table for a generic, multi-payload
|
|
/// enum instance.
|
|
extern "C" void swift_initEnumMetadataMultiPayload(ValueWitnessTable *vwtable,
|
|
EnumMetadata *enumType,
|
|
unsigned numPayloads,
|
|
const Metadata * const *payloadTypes);
|
|
|
|
/// \brief Return an integer value representing which case of a multi-payload
|
|
/// enum is inhabited.
|
|
extern "C" unsigned swift_getEnumCaseMultiPayload(const OpaqueValue *value,
|
|
const EnumMetadata *enumType);
|
|
|
|
/// \brief Store the tag value for the given case into a multi-payload enum,
|
|
/// whose associated payload (if any) has already been initialized.
|
|
extern "C" void swift_storeEnumTagMultiPayload(OpaqueValue *value,
|
|
const EnumMetadata *enumType,
|
|
unsigned whichCase);
|
|
|
|
}
|
|
|
|
#endif
|