clang  7.0.0svn
NamespaceEndCommentsFixer.h
Go to the documentation of this file.
1 //===--- NamespaceEndCommentsFixer.h ----------------------------*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 ///
10 /// \file
11 /// This file declares NamespaceEndCommentsFixer, a TokenAnalyzer that
12 /// fixes namespace end comments.
13 ///
14 //===----------------------------------------------------------------------===//
15 
16 #ifndef LLVM_CLANG_LIB_FORMAT_NAMESPACEENDCOMMENTSFIXER_H
17 #define LLVM_CLANG_LIB_FORMAT_NAMESPACEENDCOMMENTSFIXER_H
18 
19 #include "TokenAnalyzer.h"
20 
21 namespace clang {
22 namespace format {
23 
24 // Finds the namespace token corresponding to a closing namespace `}`, if that
25 // is to be formatted.
26 // If \p Line contains the closing `}` of a namespace, is affected and is not in
27 // a preprocessor directive, the result will be the matching namespace token.
28 // Otherwise returns null.
29 // \p AnnotatedLines is the sequence of lines from which \p Line is a member of.
30 const FormatToken *
31 getNamespaceToken(const AnnotatedLine *Line,
32  const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines);
33 
35 public:
37 
38  std::pair<tooling::Replacements, unsigned>
39  analyze(TokenAnnotator &Annotator,
40  SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
41  FormatTokenLexer &Tokens) override;
42 };
43 
44 } // end namespace format
45 } // end namespace clang
46 
47 #endif
NamespaceEndCommentsFixer(const Environment &Env, const FormatStyle &Style)
const Environment & Env
const FormatToken * getNamespaceToken(const AnnotatedLine *Line, const SmallVectorImpl< AnnotatedLine *> &AnnotatedLines)
Determines extra information about the tokens comprising an UnwrappedLine.
const AnnotatedLine * Line
std::pair< tooling::Replacements, unsigned > analyze(TokenAnnotator &Annotator, SmallVectorImpl< AnnotatedLine *> &AnnotatedLines, FormatTokenLexer &Tokens) override
The FormatStyle is used to configure the formatting to follow specific guidelines.
Definition: Format.h:48
Dataflow Directional Tag Classes.
This file declares an abstract TokenAnalyzer, and associated helper classes.