1//===--- QualifierAlignmentFixer.h -------------------------------*- 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 declares QualifierAlignmentFixer, a TokenAnalyzer that
11/// enforces either east or west const depending on the style.
12///
13//===----------------------------------------------------------------------===//
14
15#ifndef LLVM_CLANG_LIB_FORMAT_QUALIFIERALIGNMENTFIXER_H
16#define LLVM_CLANG_LIB_FORMAT_QUALIFIERALIGNMENTFIXER_H
17
18#include "TokenAnalyzer.h"
19
20namespace clang {
21namespace format {
22
23typedef std::function<std::pair<tooling::Replacements, unsigned>(
24 const Environment &)>
25 AnalyzerPass;
26
27void addQualifierAlignmentFixerPasses(const FormatStyle &Style,
28 SmallVectorImpl<AnalyzerPass> &Passes);
29
30void prepareLeftRightOrderingForQualifierAlignmentFixer(
31 const std::vector<std::string> &Order, std::vector<std::string> &LeftOrder,
32 std::vector<std::string> &RightOrder,
33 std::vector<tok::TokenKind> &Qualifiers);
34
35// Is the Token a simple or qualifier type
36bool isQualifierOrType(const FormatToken *Tok, const LangOptions &LangOpts);
37bool isConfiguredQualifierOrType(const FormatToken *Tok,
38 const std::vector<tok::TokenKind> &Qualifiers,
39 const LangOptions &LangOpts);
40
41class LeftRightQualifierAlignmentFixer : public TokenAnalyzer {
42 std::string Qualifier;
43 bool RightAlign;
44 SmallVector<tok::TokenKind, 8> QualifierTokens;
45 std::vector<tok::TokenKind> ConfiguredQualifierTokens;
46
47public:
48 LeftRightQualifierAlignmentFixer(
49 const Environment &Env, const FormatStyle &Style,
50 const std::string &Qualifier,
51 const std::vector<tok::TokenKind> &ConfiguredQualifierTokens,
52 bool RightAlign);
53
54 std::pair<tooling::Replacements, unsigned>
55 analyze(TokenAnnotator &Annotator,
56 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
57 FormatTokenLexer &Tokens) override;
58
59 static tok::TokenKind getTokenFromQualifier(const std::string &Qualifier);
60
61 void fixQualifierAlignment(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
62 FormatTokenLexer &Tokens,
63 tooling::Replacements &Fixes);
64
65 const FormatToken *analyzeRight(const SourceManager &SourceMgr,
66 const AdditionalKeywords &Keywords,
67 tooling::Replacements &Fixes,
68 const FormatToken *Tok,
69 const std::string &Qualifier,
70 tok::TokenKind QualifierType);
71
72 const FormatToken *analyzeLeft(const SourceManager &SourceMgr,
73 const AdditionalKeywords &Keywords,
74 tooling::Replacements &Fixes,
75 const FormatToken *Tok,
76 const std::string &Qualifier,
77 tok::TokenKind QualifierType);
78};
79
80} // end namespace format
81} // end namespace clang
82
83#endif
84