blob: 4f25ff977b81d4a22b197aa7c1a7a5c2b4ef0a78 [file] [log] [blame]
//===--- Context.h - Context for the constexpr VM ---------------*- C++ -*-===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
// Defines the constexpr execution context.
// The execution context manages cached bytecode and the global context.
// It invokes the compiler and interpreter, propagating errors.
#include "InterpStack.h"
#include "clang/AST/APValue.h"
#include "llvm/ADT/PointerIntPair.h"
namespace clang {
class ASTContext;
class LangOptions;
class Stmt;
class FunctionDecl;
class VarDecl;
namespace interp {
class Function;
class Program;
class State;
enum PrimType : unsigned;
/// Holds all information required to evaluate constexpr code in a module.
class Context {
/// Initialises the constexpr VM.
Context(ASTContext &Ctx);
/// Cleans up the constexpr VM.
/// Checks if a function is a potential constant expression.
bool isPotentialConstantExpr(State &Parent, const FunctionDecl *FnDecl);
/// Evaluates a toplevel expression as an rvalue.
bool evaluateAsRValue(State &Parent, const Expr *E, APValue &Result);
/// Evaluates a toplevel initializer.
bool evaluateAsInitializer(State &Parent, const VarDecl *VD, APValue &Result);
/// Returns the AST context.
ASTContext &getASTContext() const { return Ctx; }
/// Returns the language options.
const LangOptions &getLangOpts() const;
/// Returns the interpreter stack.
InterpStack &getStack() { return Stk; }
/// Returns CHAR_BIT.
unsigned getCharBit() const;
/// Classifies an expression.
llvm::Optional<PrimType> classify(QualType T);
/// Runs a function.
bool Run(State &Parent, Function *Func, APValue &Result);
/// Checks a result from the interpreter.
bool Check(State &Parent, llvm::Expected<bool> &&R);
/// Current compilation context.
ASTContext &Ctx;
/// Interpreter stack, shared across invocations.
InterpStack Stk;
/// Constexpr program.
std::unique_ptr<Program> P;
} // namespace interp
} // namespace clang