clang 19.0.0git
State.h
Go to the documentation of this file.
1//===--- State.h - State chain for the VM and AST Walker --------*- C++ -*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// Defines the base class of the interpreter and evaluator state.
10//
11//===----------------------------------------------------------------------===//
12
13#ifndef LLVM_CLANG_AST_INTERP_STATE_H
14#define LLVM_CLANG_AST_INTERP_STATE_H
15
17#include "clang/AST/Expr.h"
18
19namespace clang {
20class OptionalDiagnostic;
21
22/// Kinds of access we can perform on an object, for diagnostics. Note that
23/// we consider a member function call to be a kind of access, even though
24/// it is not formally an access of the object, because it has (largely) the
25/// same set of semantic restrictions.
37};
38
39/// The order of this enum is important for diagnostics.
48};
49
50namespace interp {
51class Frame;
52class SourceInfo;
53
54/// Interface for the VM to interact with the AST walker's context.
55class State {
56public:
57 virtual ~State();
58
59 virtual bool checkingForUndefinedBehavior() const = 0;
60 virtual bool checkingPotentialConstantExpression() const = 0;
61 virtual bool noteUndefinedBehavior() = 0;
62 virtual bool keepEvaluatingAfterFailure() const = 0;
63 virtual Frame *getCurrentFrame() = 0;
64 virtual const Frame *getBottomFrame() const = 0;
65 virtual bool hasActiveDiagnostic() = 0;
66 virtual void setActiveDiagnostic(bool Flag) = 0;
67 virtual void setFoldFailureDiagnostic(bool Flag) = 0;
68 virtual Expr::EvalStatus &getEvalStatus() const = 0;
69 virtual ASTContext &getCtx() const = 0;
70 virtual bool hasPriorDiagnostic() = 0;
71 virtual unsigned getCallStackDepth() = 0;
72
73public:
74 State() = default;
75 /// Diagnose that the evaluation could not be folded (FF => FoldFailure)
78 diag::kind DiagId = diag::note_invalid_subexpr_in_const_expr,
79 unsigned ExtraNotes = 0);
80
82 FFDiag(const Expr *E,
83 diag::kind DiagId = diag::note_invalid_subexpr_in_const_expr,
84 unsigned ExtraNotes = 0);
85
87 FFDiag(const SourceInfo &SI,
88 diag::kind DiagId = diag::note_invalid_subexpr_in_const_expr,
89 unsigned ExtraNotes = 0);
90
91 /// Diagnose that the evaluation does not produce a C++11 core constant
92 /// expression.
93 ///
94 /// FIXME: Stop evaluating if we're in EM_ConstantExpression or
95 /// EM_PotentialConstantExpression mode and we produce one of these.
98 diag::kind DiagId = diag::note_invalid_subexpr_in_const_expr,
99 unsigned ExtraNotes = 0);
100
102 CCEDiag(const Expr *E,
103 diag::kind DiagId = diag::note_invalid_subexpr_in_const_expr,
104 unsigned ExtraNotes = 0);
105
107 CCEDiag(const SourceInfo &SI,
108 diag::kind DiagId = diag::note_invalid_subexpr_in_const_expr,
109 unsigned ExtraNotes = 0);
110
111 /// Add a note to a prior diagnostic.
113
114 /// Add a stack of notes to a prior diagnostic.
116
117 /// Directly reports a diagnostic message.
119
120 const LangOptions &getLangOpts() const;
121
122 /// Whether or not we're in a context where the front end requires a
123 /// constant value.
124 bool InConstantContext = false;
125
126private:
127 void addCallStack(unsigned Limit);
128
130
132 unsigned ExtraNotes, bool IsCCEDiag);
133};
134
135} // namespace interp
136} // namespace clang
137
138#endif
SourceLocation Loc
Definition: SemaObjC.cpp:755
Holds long-lived AST nodes (such as types and decls) that can be referred to throughout the semantic ...
Definition: ASTContext.h:185
A little helper class used to produce diagnostics.
Definition: Diagnostic.h:1271
This represents one expression.
Definition: Expr.h:110
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:461
A partial diagnostic which we might know in advance that we are not going to emit.
Encodes a location in the source.
Base class for stack frames, shared between VM and walker.
Definition: Frame.h:25
Describes the statement/declaration an opcode was generated from.
Definition: Source.h:72
Interface for the VM to interact with the AST walker's context.
Definition: State.h:55
virtual bool hasActiveDiagnostic()=0
virtual void setActiveDiagnostic(bool Flag)=0
virtual bool checkingPotentialConstantExpression() const =0
DiagnosticBuilder report(SourceLocation Loc, diag::kind DiagId)
Directly reports a diagnostic message.
Definition: State.cpp:76
virtual Frame * getCurrentFrame()=0
virtual bool noteUndefinedBehavior()=0
OptionalDiagnostic FFDiag(SourceLocation Loc, diag::kind DiagId=diag::note_invalid_subexpr_in_const_expr, unsigned ExtraNotes=0)
Diagnose that the evaluation could not be folded (FF => FoldFailure)
Definition: State.cpp:21
virtual Expr::EvalStatus & getEvalStatus() const =0
virtual unsigned getCallStackDepth()=0
virtual bool checkingForUndefinedBehavior() const =0
virtual ASTContext & getCtx() const =0
virtual bool keepEvaluatingAfterFailure() const =0
void addNotes(ArrayRef< PartialDiagnosticAt > Diags)
Add a stack of notes to a prior diagnostic.
Definition: State.cpp:69
virtual const Frame * getBottomFrame() const =0
const LangOptions & getLangOpts() const
Definition: State.cpp:116
OptionalDiagnostic CCEDiag(SourceLocation Loc, diag::kind DiagId=diag::note_invalid_subexpr_in_const_expr, unsigned ExtraNotes=0)
Diagnose that the evaluation does not produce a C++11 core constant expression.
Definition: State.cpp:42
virtual void setFoldFailureDiagnostic(bool Flag)=0
virtual bool hasPriorDiagnostic()=0
bool InConstantContext
Whether or not we're in a context where the front end requires a constant value.
Definition: State.h:124
virtual ~State()
Definition: State.cpp:19
The JSON file list parser is used to communicate input to InstallAPI.
CheckSubobjectKind
The order of this enum is important for diagnostics.
Definition: State.h:40
@ CSK_ArrayToPointer
Definition: State.h:44
@ CSK_Derived
Definition: State.h:42
@ CSK_Base
Definition: State.h:41
@ CSK_Real
Definition: State.h:46
@ CSK_ArrayIndex
Definition: State.h:45
@ CSK_Imag
Definition: State.h:47
@ CSK_Field
Definition: State.h:43
AccessKinds
Kinds of access we can perform on an object, for diagnostics.
Definition: State.h:26
@ AK_TypeId
Definition: State.h:34
@ AK_Construct
Definition: State.h:35
@ AK_Increment
Definition: State.h:30
@ AK_DynamicCast
Definition: State.h:33
@ AK_Read
Definition: State.h:27
@ AK_Assign
Definition: State.h:29
@ AK_MemberCall
Definition: State.h:32
@ AK_ReadObjectRepresentation
Definition: State.h:28
@ AK_Destroy
Definition: State.h:36
@ AK_Decrement
Definition: State.h:31
EvalStatus is a struct with detailed info about an evaluation in progress.
Definition: Expr.h:606