Files
swift-mirror/lib/Sema/InstrumenterSupport.h
Hamish Knight 4716f61fba [AST] Introduce explicit actions for ASTWalker
Replace the use of bool and pointer returns for
`walkToXXXPre`/`walkToXXXPost`, and instead use
explicit actions such as `Action::Continue(E)`,
`Action::SkipChildren(E)`, and `Action::Stop()`.
There are also conditional variants, e.g
`Action::SkipChildrenIf`, `Action::VisitChildrenIf`,
and `Action::StopIf`.

There is still more work that can be done here, in
particular:

- SourceEntityWalker still needs to be migrated.
- Some uses of `return false` in pre-visitation
methods can likely now be replaced by
`Action::Stop`.
- We still use bool and pointer returns internally
within the ASTWalker traversal, which could likely
be improved.

But I'm leaving those as future work for now as
this patch is already large enough.
2022-09-13 10:35:29 +01:00

101 lines
2.9 KiB
C++

//===--- InstrumenterSupport.h - Instrumenter Support -----------*- 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 implements the supporting functions for writing instrumenters of
// the Swift AST.
//
//===----------------------------------------------------------------------===//
#include "TypeChecker.h"
#include "swift/AST/ASTWalker.h"
namespace swift {
namespace instrumenter_support {
template <class E> class Added {
private:
E Contents;
public:
Added() {}
Added(E NewContents) : Contents(NewContents) {}
Added(const Added<E> &rhs) : Contents(rhs.Contents) {}
const Added<E> &operator=(const Added<E> &rhs) {
Contents = rhs.Contents;
return *this;
}
E &operator*() { return Contents; }
E &operator->() { return Contents; }
};
class InstrumenterBase {
protected:
ASTContext &Context;
DeclContext *TypeCheckDC;
Optional<DeclNameRef> ModuleIdentifier;
Optional<DeclNameRef> FileIdentifier;
InstrumenterBase(ASTContext &C, DeclContext *DC);
virtual ~InstrumenterBase() = default;
virtual void anchor();
virtual BraceStmt *transformBraceStmt(BraceStmt *BS,
bool TopLevel = false) = 0;
/// Create an expression which retrieves a valid ModuleIdentifier or
/// FileIdentifier, if available.
Expr *buildIDArgumentExpr(Optional<DeclNameRef> name, SourceRange SR);
class ClosureFinder : public ASTWalker {
private:
InstrumenterBase &I;
public:
ClosureFinder(InstrumenterBase &Inst) : I(Inst) {}
PreWalkResult<Stmt *> walkToStmtPre(Stmt *S) override {
if (isa<BraceStmt>(S)) {
return Action::SkipChildren(S); // don't walk into brace statements; we
// need to respect nesting!
} else {
return Action::Continue(S);
}
}
PreWalkResult<Expr *> walkToExprPre(Expr *E) override {
if (auto *CE = dyn_cast<ClosureExpr>(E)) {
BraceStmt *B = CE->getBody();
if (B) {
BraceStmt *NB = I.transformBraceStmt(B);
CE->setBody(NB, false);
// just with the entry and exit logging this is going to
// be more than a single expression!
}
}
return Action::Continue(E);
}
};
ClosureFinder CF;
template <class T>
bool doTypeCheck(ASTContext &Ctx, DeclContext *DC, Added<T *> &parsedExpr) {
Expr *E = *parsedExpr;
bool result = doTypeCheckImpl(Ctx, DC, E);
parsedExpr = Added<T *>(dyn_cast<T>(E));
return result;
}
private:
bool doTypeCheckImpl(ASTContext &Ctx, DeclContext *DC, Expr * &parsedExpr);
};
}
}