mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
a47bd7089e
We have finally reached our goal of optimising deferred node creation for SyntaxTreeCreator. Instead of creating dedicated deferred nodes and copying the data into a RawSyntax node when recording, we always create RawSyntax nodes. Recording a deferred node is thus a no-op, since we have already created a RawSyntax node. Should a deferred node not be recorded, it stays alive in the SyntaxArena without any reference to it. While this means, we are leaking some memory for such nodes, most nodes do get recorded, so the overhead should be fine compared to the performance benefit.
97 lines
3.4 KiB
C++
97 lines
3.4 KiB
C++
//===--- SyntaxTreeCreator.h - Syntax Tree Creation ------------*- C++ -*-===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2019 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_SYNTAX_PARSE_SYNTAXTREECREATOR_H
|
|
#define SWIFT_SYNTAX_PARSE_SYNTAXTREECREATOR_H
|
|
|
|
#include "swift/Parse/SyntaxParseActions.h"
|
|
#include "swift/Syntax/References.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
|
|
namespace swift {
|
|
class SourceManager;
|
|
class SyntaxParsingCache;
|
|
class SourceFile;
|
|
|
|
namespace syntax {
|
|
class SyntaxArena;
|
|
class SourceFileSyntax;
|
|
}
|
|
|
|
/// Receives the parsed syntax info from the parser and constructs a persistent
|
|
/// syntax tree by converting the data into \c RawSyntax objects, allocated from
|
|
/// a \c SyntaxArena.
|
|
///
|
|
/// It also handles caching re-usable RawSyntax objects and skipping parsed
|
|
/// nodes via consulting a \c SyntaxParsingCache.
|
|
class SyntaxTreeCreator final : public SyntaxParseActions {
|
|
SourceManager &SM;
|
|
unsigned BufferID;
|
|
RC<syntax::SyntaxArena> Arena;
|
|
|
|
/// A string allocated in \c Arena that contains an exact copy of the source
|
|
/// file for which this \c SyntaxTreeCreator creates a syntax tree. \c
|
|
/// RawSyntax nodes can safely reference text inside this buffer since they
|
|
/// retain the \c SyntaxArena which holds the buffer.
|
|
StringRef ArenaSourceBuffer;
|
|
|
|
/// A cache of nodes that can be reused when creating the current syntax
|
|
/// tree.
|
|
SyntaxParsingCache *SyntaxCache;
|
|
|
|
llvm::BumpPtrAllocator ScratchAlloc;
|
|
|
|
public:
|
|
SyntaxTreeCreator(SourceManager &SM, unsigned bufferID,
|
|
SyntaxParsingCache *syntaxCache,
|
|
RC<syntax::SyntaxArena> arena);
|
|
~SyntaxTreeCreator();
|
|
|
|
Optional<syntax::SourceFileSyntax>
|
|
realizeSyntaxRoot(OpaqueSyntaxNode root, const SourceFile &SF) override;
|
|
|
|
private:
|
|
OpaqueSyntaxNode recordToken(tok tokenKind, StringRef leadingTrivia,
|
|
StringRef trailingTrivia,
|
|
CharSourceRange range) override;
|
|
|
|
OpaqueSyntaxNode recordMissingToken(tok tokenKind, SourceLoc loc) override;
|
|
|
|
OpaqueSyntaxNode
|
|
recordRawSyntax(syntax::SyntaxKind kind,
|
|
ArrayRef<OpaqueSyntaxNode> elements) override;
|
|
|
|
std::pair<size_t, OpaqueSyntaxNode>
|
|
lookupNode(size_t lexerOffset, syntax::SyntaxKind kind) override;
|
|
|
|
OpaqueSyntaxNode makeDeferredToken(tok tokenKind, StringRef leadingTrivia,
|
|
StringRef trailingTrivia,
|
|
CharSourceRange range,
|
|
bool isMissing) override;
|
|
|
|
OpaqueSyntaxNode
|
|
makeDeferredLayout(syntax::SyntaxKind k, bool IsMissing,
|
|
const ArrayRef<RecordedOrDeferredNode> &children) override;
|
|
|
|
OpaqueSyntaxNode recordDeferredToken(OpaqueSyntaxNode deferred) override;
|
|
OpaqueSyntaxNode recordDeferredLayout(OpaqueSyntaxNode deferred) override;
|
|
|
|
DeferredNodeInfo getDeferredChild(OpaqueSyntaxNode node, size_t ChildIndex,
|
|
SourceLoc StartLoc) override;
|
|
|
|
size_t getDeferredNumChildren(OpaqueSyntaxNode node) override;
|
|
};
|
|
|
|
} // end namespace swift
|
|
|
|
#endif
|