clang 17.0.0git
QualifierAlignmentFixer.h
Go to the documentation of this file.
1//===--- LeftRightQualifierAlignmentFixer.h ------------------------------*- C++
2//-*-===//
3//
4// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5// See https://llvm.org/LICENSE.txt for license information.
6// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7//
8//===----------------------------------------------------------------------===//
9///
10/// \file
11/// This file declares LeftRightQualifierAlignmentFixer, a TokenAnalyzer that
12/// enforces either east or west const depending on the style.
13///
14//===----------------------------------------------------------------------===//
15
16#ifndef LLVM_CLANG_LIB_FORMAT_QUALIFIERALIGNMENTFIXER_H
17#define LLVM_CLANG_LIB_FORMAT_QUALIFIERALIGNMENTFIXER_H
18
19#include "TokenAnalyzer.h"
20
21namespace clang {
22namespace format {
23
24typedef std::function<std::pair<tooling::Replacements, unsigned>(
25 const Environment &)>
27
29 // Left to Right ordering requires multiple passes
31 StringRef &Code;
33 unsigned FirstStartColumn;
34 unsigned NextStartColumn;
35 unsigned LastStartColumn;
36 StringRef FileName;
37
38public:
40 StringRef &Code, ArrayRef<tooling::Range> Ranges,
41 unsigned FirstStartColumn, unsigned NextStartColumn,
42 unsigned LastStartColumn, StringRef FileName);
43
44 std::pair<tooling::Replacements, unsigned>
45 analyze(TokenAnnotator &Annotator,
47 FormatTokenLexer &Tokens) override;
48
49 static void PrepareLeftRightOrdering(const std::vector<std::string> &Order,
50 std::vector<std::string> &LeftOrder,
51 std::vector<std::string> &RightOrder,
52 std::vector<tok::TokenKind> &Qualifiers);
53};
54
56 std::string Qualifier;
57 bool RightAlign;
58 SmallVector<tok::TokenKind, 8> QualifierTokens;
59 std::vector<tok::TokenKind> ConfiguredQualifierTokens;
60
61public:
63 const Environment &Env, const FormatStyle &Style,
64 const std::string &Qualifier,
65 const std::vector<tok::TokenKind> &ConfiguredQualifierTokens,
66 bool RightAlign);
67
68 std::pair<tooling::Replacements, unsigned>
69 analyze(TokenAnnotator &Annotator,
71 FormatTokenLexer &Tokens) override;
72
73 static tok::TokenKind getTokenFromQualifier(const std::string &Qualifier);
74
75 const FormatToken *analyzeRight(const SourceManager &SourceMgr,
76 const AdditionalKeywords &Keywords,
78 const FormatToken *Tok,
79 const std::string &Qualifier,
80 tok::TokenKind QualifierType);
81
82 const FormatToken *analyzeLeft(const SourceManager &SourceMgr,
83 const AdditionalKeywords &Keywords,
85 const FormatToken *Tok,
86 const std::string &Qualifier,
87 tok::TokenKind QualifierType);
88
89 // is the Token a simple or qualifier type
90 static bool isQualifierOrType(const FormatToken *Tok,
91 const std::vector<tok::TokenKind> &Qualifiers);
92
93 // is the Token likely a Macro
94 static bool isPossibleMacro(const FormatToken *Tok);
95};
96
97} // end namespace format
98} // end namespace clang
99
100#endif
This file declares an abstract TokenAnalyzer, and associated helper classes.
The collection of all-type qualifiers we support.
Definition: Type.h:146
This class handles loading and caching of source files into memory.
const FormatToken * analyzeLeft(const SourceManager &SourceMgr, const AdditionalKeywords &Keywords, tooling::Replacements &Fixes, const FormatToken *Tok, const std::string &Qualifier, tok::TokenKind QualifierType)
const FormatToken * analyzeRight(const SourceManager &SourceMgr, const AdditionalKeywords &Keywords, tooling::Replacements &Fixes, const FormatToken *Tok, const std::string &Qualifier, tok::TokenKind QualifierType)
static bool isQualifierOrType(const FormatToken *Tok, const std::vector< tok::TokenKind > &Qualifiers)
std::pair< tooling::Replacements, unsigned > analyze(TokenAnnotator &Annotator, SmallVectorImpl< AnnotatedLine * > &AnnotatedLines, FormatTokenLexer &Tokens) override
static tok::TokenKind getTokenFromQualifier(const std::string &Qualifier)
static void PrepareLeftRightOrdering(const std::vector< std::string > &Order, std::vector< std::string > &LeftOrder, std::vector< std::string > &RightOrder, std::vector< tok::TokenKind > &Qualifiers)
std::pair< tooling::Replacements, unsigned > analyze(TokenAnnotator &Annotator, SmallVectorImpl< AnnotatedLine * > &AnnotatedLines, FormatTokenLexer &Tokens) override
const Environment & Env
Determines extra information about the tokens comprising an UnwrappedLine.
Maintains a set of replacements that are conflict-free.
Definition: Replacement.h:212
std::function< std::pair< tooling::Replacements, unsigned >(const Environment &)> AnalyzerPass
TokenKind
Provides a simple uniform namespace for tokens from all C languages.
Definition: TokenKinds.h:25
Encapsulates keywords that are context sensitive or for languages not properly supported by Clang's l...
Definition: FormatToken.h:933
The FormatStyle is used to configure the formatting to follow specific guidelines.
Definition: Format.h:55
A wrapper around a Token storing information about the whitespace characters preceding it.
Definition: FormatToken.h:247