1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
|
//===--- EnumMetadataVisitor.h - CRTP for enum metadata ---------*- 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
//
//===----------------------------------------------------------------------===//
//
// A CRTP class useful for visiting all of the fields in an
// enum metadata object.
//
//===----------------------------------------------------------------------===//
#ifndef SWIFT_IRGEN_ENUMMETADATAVISITOR_H
#define SWIFT_IRGEN_ENUMMETADATAVISITOR_H
#include "NominalMetadataVisitor.h"
#include "GenEnum.h"
namespace swift {
namespace irgen {
/// A CRTP class for laying out enum metadata.
///
/// This produces an object corresponding to the EnumMetadata type.
/// It does not itself doing anything special for metadata templates.
template <class Impl> class EnumMetadataVisitor
: public NominalMetadataVisitor<Impl> {
using super = NominalMetadataVisitor<Impl>;
protected:
using super::IGM;
using super::asImpl;
/// The Enum.
EnumDecl *const Target;
EnumMetadataVisitor(IRGenModule &IGM, EnumDecl *target)
: super(IGM), Target(target) {}
public:
void layout() {
static_assert(MetadataAdjustmentIndex::ValueType == 2,
"Adjustment index must be synchronized with this layout");
asImpl().addLayoutStringPointer();
// Metadata header.
super::layout();
// EnumMetadata header.
asImpl().addNominalTypeDescriptor();
// Everything after this is type-specific.
asImpl().noteStartOfTypeSpecificMembers();
// Generic arguments.
// This must always be the first piece of trailing data.
asImpl().addGenericFields(Target);
// Reserve a word to cache the payload size if the type has dynamic layout.
auto &strategy = getEnumImplStrategy(IGM,
Target->getDeclaredTypeInContext()->getCanonicalType());
if (strategy.needsPayloadSizeInMetadata())
asImpl().addPayloadSize();
if (asImpl().hasTrailingFlags())
asImpl().addTrailingFlags();
}
bool hasTrailingFlags() {
return Target->isGenericContext() &&
IGM.shouldPrespecializeGenericMetadata();
}
};
/// An "implementation" of EnumMetadataVisitor that just scans through
/// the metadata layout, maintaining the next index: the offset (in
/// pointer-sized chunks) into the metadata for the next field.
template <class Impl>
class EnumMetadataScanner : public EnumMetadataVisitor<Impl> {
using super = EnumMetadataVisitor<Impl>;
protected:
Size NextOffset = Size(0);
EnumMetadataScanner(IRGenModule &IGM, EnumDecl *target)
: super(IGM, target) {}
public:
void addMetadataFlags() { addPointer(); }
void addLayoutStringPointer() { addPointer(); }
void addValueWitnessTable() { addPointer(); }
void addNominalTypeDescriptor() { addPointer(); }
void addGenericRequirement(GenericRequirement requirement) { addPointer(); }
void addPayloadSize() { addPointer(); }
void noteStartOfTypeSpecificMembers() {}
void addTrailingFlags() { addInt64(); }
private:
void addPointer() {
NextOffset += super::IGM.getPointerSize();
}
void addInt64() { NextOffset += Size(8); }
};
} // end namespace irgen
} // end namespace swift
#endif
|