clang  14.0.0git
TokenAnalyzer.cpp
Go to the documentation of this file.
1 //===--- TokenAnalyzer.cpp - Analyze Token Streams --------------*- 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 /// \file
10 /// This file implements an abstract TokenAnalyzer and associated helper
11 /// classes. TokenAnalyzer can be extended to generate replacements based on
12 /// an annotated and pre-processed token stream.
13 ///
14 //===----------------------------------------------------------------------===//
15 
16 #include "TokenAnalyzer.h"
17 #include "AffectedRangeManager.h"
18 #include "Encoding.h"
19 #include "FormatToken.h"
20 #include "FormatTokenLexer.h"
21 #include "TokenAnnotator.h"
22 #include "UnwrappedLineParser.h"
23 #include "clang/Basic/Diagnostic.h"
27 #include "clang/Format/Format.h"
28 #include "llvm/ADT/STLExtras.h"
29 #include "llvm/Support/Debug.h"
30 
31 #define DEBUG_TYPE "format-formatter"
32 
33 namespace clang {
34 namespace format {
35 
36 Environment::Environment(StringRef Code, StringRef FileName,
38  unsigned FirstStartColumn, unsigned NextStartColumn,
39  unsigned LastStartColumn)
40  : VirtualSM(new SourceManagerForFile(FileName, Code)), SM(VirtualSM->get()),
41  ID(VirtualSM->get().getMainFileID()), FirstStartColumn(FirstStartColumn),
42  NextStartColumn(NextStartColumn), LastStartColumn(LastStartColumn) {
43  SourceLocation StartOfFile = SM.getLocForStartOfFile(ID);
44  for (const tooling::Range &Range : Ranges) {
45  SourceLocation Start = StartOfFile.getLocWithOffset(Range.getOffset());
46  SourceLocation End = Start.getLocWithOffset(Range.getLength());
47  CharRanges.push_back(CharSourceRange::getCharRange(Start, End));
48  }
49 }
50 
52  : Style(Style), Env(Env),
53  AffectedRangeMgr(Env.getSourceManager(), Env.getCharRanges()),
54  UnwrappedLines(1),
55  Encoding(encoding::detectEncoding(
56  Env.getSourceManager().getBufferData(Env.getFileID()))) {
57  LLVM_DEBUG(
58  llvm::dbgs() << "File encoding: "
59  << (Encoding == encoding::Encoding_UTF8 ? "UTF8" : "unknown")
60  << "\n");
61  LLVM_DEBUG(llvm::dbgs() << "Language: " << getLanguageName(Style.Language)
62  << "\n");
63 }
64 
65 std::pair<tooling::Replacements, unsigned> TokenAnalyzer::process() {
66  tooling::Replacements Result;
67  llvm::SpecificBumpPtrAllocator<FormatToken> Allocator;
70  Env.getFirstStartColumn(), Style, Encoding, Allocator,
71 
72  IdentTable);
73  ArrayRef<FormatToken *> Toks(Lex.lex());
74  SmallVector<FormatToken *, 10> Tokens(Toks.begin(), Toks.end());
76  Env.getFirstStartColumn(), Tokens, *this);
77  Parser.parse();
78  assert(UnwrappedLines.rbegin()->empty());
79  unsigned Penalty = 0;
80  for (unsigned Run = 0, RunE = UnwrappedLines.size(); Run + 1 != RunE; ++Run) {
81  LLVM_DEBUG(llvm::dbgs() << "Run " << Run << "...\n");
82  SmallVector<AnnotatedLine *, 16> AnnotatedLines;
83 
84  TokenAnnotator Annotator(Style, Lex.getKeywords());
85  for (unsigned i = 0, e = UnwrappedLines[Run].size(); i != e; ++i) {
86  AnnotatedLines.push_back(new AnnotatedLine(UnwrappedLines[Run][i]));
87  Annotator.annotate(*AnnotatedLines.back());
88  }
89 
90  std::pair<tooling::Replacements, unsigned> RunResult =
91  analyze(Annotator, AnnotatedLines, Lex);
92 
93  LLVM_DEBUG({
94  llvm::dbgs() << "Replacements for run " << Run << ":\n";
95  for (tooling::Replacements::const_iterator I = RunResult.first.begin(),
96  E = RunResult.first.end();
97  I != E; ++I) {
98  llvm::dbgs() << I->toString() << "\n";
99  }
100  });
101  for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
102  delete AnnotatedLines[i];
103  }
104 
105  Penalty += RunResult.second;
106  for (const auto &R : RunResult.first) {
107  auto Err = Result.add(R);
108  // FIXME: better error handling here. For now, simply return an empty
109  // Replacements to indicate failure.
110  if (Err) {
111  llvm::errs() << llvm::toString(std::move(Err)) << "\n";
112  return {tooling::Replacements(), 0};
113  }
114  }
115  }
116  return {Result, Penalty};
117 }
118 
120  assert(!UnwrappedLines.empty());
121  UnwrappedLines.back().push_back(TheLine);
122 }
123 
126 }
127 
128 } // end namespace format
129 } // end namespace clang
clang::format::FormatTokenLexer::lex
ArrayRef< FormatToken * > lex()
Definition: FormatTokenLexer.cpp:63
clang::format::TokenAnalyzer::analyze
virtual std::pair< tooling::Replacements, unsigned > analyze(TokenAnnotator &Annotator, SmallVectorImpl< AnnotatedLine * > &AnnotatedLines, FormatTokenLexer &Tokens)=0
clang::format::TokenAnalyzer::Env
const Environment & Env
Definition: TokenAnalyzer.h:98
llvm::SmallVector
Definition: LLVM.h:38
clang::SourceLocation
Encodes a location in the source.
Definition: SourceLocation.h:88
clang::SourceLocation::getLocWithOffset
SourceLocation getLocWithOffset(IntTy Offset) const
Return a source location with the specified offset from this SourceLocation.
Definition: SourceLocation.h:136
clang::tooling::Range
A source range independent of the SourceManager.
Definition: Replacement.h:44
clang::tooling::Replacements
Maintains a set of replacements that are conflict-free.
Definition: Replacement.h:209
clang::format::FormatStyle
The FormatStyle is used to configure the formatting to follow specific guidelines.
Definition: Format.h:59
clang::Parser
Parser - This implements a parser for the C family of languages.
Definition: Parser.h:60
clang::format::encoding::Encoding_UTF8
@ Encoding_UTF8
Definition: Encoding.h:28
SourceManager.h
clang::format::UnwrappedLine
An unwrapped line is a sequence of Token, that we would like to put on a single line if there was no ...
Definition: UnwrappedLineParser.h:36
clang::format::TokenAnalyzer::process
std::pair< tooling::Replacements, unsigned > process()
Definition: TokenAnalyzer.cpp:65
Format.h
clang::format::Environment::getFileID
FileID getFileID() const
Definition: TokenAnalyzer.h:47
End
SourceLocation End
Definition: USRLocFinder.cpp:167
clang::format::UnwrappedLineParser
Definition: UnwrappedLineParser.h:75
clang::format::encoding::detectEncoding
Encoding detectEncoding(StringRef Text)
Detects encoding of the Text.
Definition: Encoding.h:34
Encoding.h
clang::format::TokenAnalyzer::TokenAnalyzer
TokenAnalyzer(const Environment &Env, const FormatStyle &Style)
Definition: TokenAnalyzer.cpp:51
clang::format::FormatTokenLexer::getKeywords
const AdditionalKeywords & getKeywords()
Definition: FormatTokenLexer.h:47
TokenAnnotator.h
clang::CharSourceRange::getCharRange
static CharSourceRange getCharRange(SourceRange R)
Definition: SourceLocation.h:267
clang::tooling::Replacements::const_iterator
ReplacementsImpl::const_iterator const_iterator
Definition: Replacement.h:214
clang::format::encoding::Encoding
Encoding
Definition: Encoding.h:27
clang::threadSafety::sx::toString
std::string toString(const til::SExpr *E)
Definition: ThreadSafetyCommon.h:89
clang::format::TokenAnalyzer::consumeUnwrappedLine
void consumeUnwrappedLine(const UnwrappedLine &TheLine) override
Definition: TokenAnalyzer.cpp:119
Diagnostic.h
clang::format::AnnotatedLine
Definition: TokenAnnotator.h:38
clang::format::TokenAnalyzer::UnwrappedLines
SmallVector< SmallVector< UnwrappedLine, 16 >, 2 > UnwrappedLines
Definition: TokenAnalyzer.h:101
clang::format::Environment
Definition: TokenAnalyzer.h:36
clang::format::getFormattingLangOpts
LangOptions getFormattingLangOpts(const FormatStyle &Style=getLLVMStyle())
Returns the LangOpts that the formatter expects you to set.
Definition: Format.cpp:3076
clang::format::TokenAnnotator
Determines extra information about the tokens comprising an UnwrappedLine.
Definition: TokenAnnotator.h:158
clang::SourceManagerForFile
SourceManager and necessary depdencies (e.g.
Definition: SourceManager.h:1907
clang::format::TokenAnalyzer::Encoding
encoding::Encoding Encoding
Definition: TokenAnalyzer.h:102
clang::format::TokenAnnotator::annotate
void annotate(AnnotatedLine &Line)
Definition: TokenAnnotator.cpp:2366
UnwrappedLineParser.h
clang::SourceManager::getLocForStartOfFile
SourceLocation getLocForStartOfFile(FileID FID) const
Return the source location corresponding to the first byte of the specified file.
Definition: SourceManager.h:1118
clang::format::Environment::getSourceManager
const SourceManager & getSourceManager() const
Definition: TokenAnalyzer.h:49
clang::format::FormatStyle::Language
LanguageKind Language
Language, this format style is targeted at.
Definition: Format.h:2675
clang::format::TokenAnalyzer::finishRun
void finishRun() override
Definition: TokenAnalyzer.cpp:124
llvm::ArrayRef
Definition: LLVM.h:34
FormatTokenLexer.h
clang::Builtin::ID
ID
Definition: Builtins.h:48
clang
Definition: CalledOnceCheck.h:17
clang::format::getLanguageName
StringRef getLanguageName(FormatStyle::LanguageKind Language)
Definition: Format.h:4006
clang::IdentifierTable
Implements an efficient mapping from strings to IdentifierInfo nodes.
Definition: IdentifierTable.h:559
clang::format::FormatTokenLexer
Definition: FormatTokenLexer.h:38
DiagnosticOptions.h
FormatToken.h
FileManager.h
SM
#define SM(sm)
Definition: Cuda.cpp:78
clang::format::Environment::Environment
Environment(StringRef Code, StringRef FileName, ArrayRef< tooling::Range > Ranges, unsigned FirstStartColumn=0, unsigned NextStartColumn=0, unsigned LastStartColumn=0)
Definition: TokenAnalyzer.cpp:36
clang::format::TokenAnalyzer::Style
FormatStyle Style
Definition: TokenAnalyzer.h:96
clang::format::Environment::getFirstStartColumn
unsigned getFirstStartColumn() const
Definition: TokenAnalyzer.h:55
AffectedRangeManager.h
TokenAnalyzer.h