File: CodeSynthesis.h

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (109 lines) | stat: -rw-r--r-- 4,162 bytes parent folder | download
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
//===--- CodeSynthesis.h - Typechecker code synthesis -----------*- 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 defines a typechecker-internal interface to a bunch of
//  routines for synthesizing various declarations.
//
//===----------------------------------------------------------------------===//

#ifndef SWIFT_TYPECHECKING_CODESYNTHESIS_H
#define SWIFT_TYPECHECKING_CODESYNTHESIS_H

#include "swift/AST/ASTWalker.h"
#include "swift/AST/ForeignErrorConvention.h"
#include "swift/Basic/ExternalUnion.h"
#include "swift/Basic/LLVM.h"
#include <optional>

namespace swift {

class AbstractFunctionDecl;
class AbstractStorageDecl;
class Argument;
class ArgumentList;
class ASTContext;
class ClassDecl;
class ConstructorDecl;
class FuncDecl;
class GenericParamList;
class NominalTypeDecl;
class ObjCReason;
class ParamDecl;
class Type;
class ValueDecl;
class VarDecl;

enum class SelfAccessorKind {
  /// We're building a derived accessor on top of whatever this
  /// class provides.
  Peer,

  /// We're building a setter or something around an underlying
  /// implementation, which might be storage or inherited from a
  /// superclass.
  Super,
};

/// Builds a reference to the \c self decl in a function.
///
/// \param selfDecl The self decl to reference.
/// \param selfAccessorKind The kind of access being performed.
/// \param isLValue Whether the resulting expression is an lvalue.
/// \param convertTy The type of the resulting expression. For a reference to
/// super, this can be a superclass type to upcast to.
Expr *buildSelfReference(VarDecl *selfDecl, SelfAccessorKind selfAccessorKind,
                         bool isLValue, Type convertTy = Type());

/// Builds a reference to the \c self decl in a function, for use as an argument
/// to a function.
///
/// \param selfDecl The self decl to reference.
/// \param selfAccessorKind The kind of access being performed.
/// \param isMutable Whether the resulting argument is for a mutable self
/// argument. Such an argument is passed 'inout'.
Argument buildSelfArgument(VarDecl *selfDecl, SelfAccessorKind selfAccessorKind,
                           bool isMutable);

/// Build an argument list that forwards references to the specified parameter
/// list.
ArgumentList *buildForwardingArgumentList(ArrayRef<ParamDecl *> params,
                                          ASTContext &ctx);

/// Returns the protocol requirement with the specified name.
ValueDecl *getProtocolRequirement(ProtocolDecl *protocol, Identifier name);

// Returns true if given nominal type declaration has a `let` stored property
// with an initial value.
bool hasLetStoredPropertyWithInitialValue(NominalTypeDecl *nominal);

/// Add 'nonisolated' to the synthesized declaration when needed. Returns true
/// if an attribute was added.
bool addNonIsolatedToSynthesized(NominalTypeDecl *nominal, ValueDecl *value);

/// Adds the `@_spi` groups from \p inferredFromDecl to \p decl.
void applyInferredSPIAccessControlAttr(Decl *decl, const Decl *inferredFromDecl,
                                       ASTContext &ctx);

/// Asserts that the synthesized fields appear in the expected order.
///
/// The `id` and `actorSystem` MUST be the first two fields of a distributed
/// actor, because we assume their location in IRGen, and also when we allocate
/// a distributed remote actor, we're able to allocate memory ONLY for those and
/// without allocating any of the storage for the actor's properties.
///         [id, actorSystem, unownedExecutor]
/// followed by the executor fields for a default distributed actor.
void assertRequiredSynthesizedPropertyOrder(ASTContext &Context,
                                            NominalTypeDecl *nominal);

} // end namespace swift

#endif