Files
swift-mirror/lib/IRGen/GenTuple.h
Ben Barham ef8825bfe6 Migrate llvm::Optional to std::optional
LLVM has removed llvm::Optional, move over to std::optional. Also
clang-format to fix up all the renamed #includes.
2024-02-21 11:20:06 -08:00

86 lines
3.3 KiB
C++

//===--- GenTuple.h - Swift IR generation for tuples ------------*- 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
//
//===----------------------------------------------------------------------===//
//
// This file provides the private interface to the tuple-emission code.
//
//===----------------------------------------------------------------------===//
#ifndef SWIFT_IRGEN_GENTUPLE_H
#define SWIFT_IRGEN_GENTUPLE_H
#include "swift/Basic/LLVM.h"
namespace llvm {
class Value;
}
namespace swift {
class CanType;
namespace irgen {
class Address;
class Explosion;
class IRGenFunction;
class Size;
/// Project the address of a tuple element.
Address projectTupleElementAddress(IRGenFunction &IGF,
Address base,
SILType tupleType,
unsigned fieldNo);
/// Project the address of a tuple element, given a dynamic index.
Address projectTupleElementAddressByDynamicIndex(IRGenFunction &IGF,
Address base,
SILType tupleType,
llvm::Value *index,
SILType elementType);
/// Project a tuple element rvalue from an already-exploded tuple rvalue.
void projectTupleElementFromExplosion(IRGenFunction &IGF,
SILType tupleType,
Explosion &tuple,
unsigned fieldNo,
Explosion &out);
/// Return the offset to the given tuple element, if it's fixed.
///
/// This API is used by RemoteAST.
std::optional<Size> getFixedTupleElementOffset(IRGenModule &IGM,
SILType tupleType,
unsigned fieldNo);
/// Returns the index of the element in the llvm struct type which represents
/// \p fieldNo in \p tupleType.
///
/// Returns None if the tuple element is an empty type and therefore has no
/// corresponding element in the llvm type.
std::optional<unsigned> getPhysicalTupleElementStructIndex(IRGenModule &IGM,
SILType tupleType,
unsigned fieldNo);
/// Emit a string encoding the labels in the given tuple type.
llvm::Constant *getTupleLabelsString(IRGenModule &IGM,
CanTupleType type);
/// Load the NumElements of a tuple type metadata.
llvm::Value *emitTupleTypeMetadataLength(IRGenFunction &IGF,
llvm::Value *metadata);
llvm::Value *emitTupleTypeMetadataElementType(IRGenFunction &IGF,
llvm::Value *metadata,
llvm::Value *index);
} // end namespace irgen
} // end namespace swift
#endif