clang 19.0.0git
QualifierAlignmentFixer.h
Go to the documentation of this file.
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 &)>
26
29
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);
38 const std::vector<tok::TokenKind> &Qualifiers,
39 const LangOptions &LangOpts);
40
41// Is the Token likely a Macro
42bool isPossibleMacro(const FormatToken *Tok);
43
45 std::string Qualifier;
46 bool RightAlign;
47 SmallVector<tok::TokenKind, 8> QualifierTokens;
48 std::vector<tok::TokenKind> ConfiguredQualifierTokens;
49
50public:
52 const Environment &Env, const FormatStyle &Style,
53 const std::string &Qualifier,
54 const std::vector<tok::TokenKind> &ConfiguredQualifierTokens,
55 bool RightAlign);
56
57 std::pair<tooling::Replacements, unsigned>
58 analyze(TokenAnnotator &Annotator,
60 FormatTokenLexer &Tokens) override;
61
62 static tok::TokenKind getTokenFromQualifier(const std::string &Qualifier);
63
65 FormatTokenLexer &Tokens,
67
68 const FormatToken *analyzeRight(const SourceManager &SourceMgr,
69 const AdditionalKeywords &Keywords,
71 const FormatToken *Tok,
72 const std::string &Qualifier,
73 tok::TokenKind QualifierType);
74
75 const FormatToken *analyzeLeft(const SourceManager &SourceMgr,
76 const AdditionalKeywords &Keywords,
78 const FormatToken *Tok,
79 const std::string &Qualifier,
80 tok::TokenKind QualifierType);
81};
82
83} // end namespace format
84} // end namespace clang
85
86#endif
This file declares an abstract TokenAnalyzer, and associated helper classes.
Keeps track of the various options that can be enabled, which controls the dialect of C or C++ that i...
Definition: LangOptions.h:461
The collection of all-type qualifiers we support.
Definition: Type.h:318
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)
std::pair< tooling::Replacements, unsigned > analyze(TokenAnnotator &Annotator, SmallVectorImpl< AnnotatedLine * > &AnnotatedLines, FormatTokenLexer &Tokens) override
void fixQualifierAlignment(SmallVectorImpl< AnnotatedLine * > &AnnotatedLines, FormatTokenLexer &Tokens, tooling::Replacements &Fixes)
static tok::TokenKind getTokenFromQualifier(const std::string &Qualifier)
const Environment & Env
Definition: TokenAnalyzer.h:97
Determines extra information about the tokens comprising an UnwrappedLine.
Maintains a set of replacements that are conflict-free.
Definition: Replacement.h:212
void addQualifierAlignmentFixerPasses(const FormatStyle &Style, SmallVectorImpl< AnalyzerPass > &Passes)
bool isConfiguredQualifierOrType(const FormatToken *Tok, const std::vector< tok::TokenKind > &Qualifiers, const LangOptions &LangOpts)
std::function< std::pair< tooling::Replacements, unsigned >(const Environment &)> AnalyzerPass
bool isPossibleMacro(const FormatToken *Tok)
bool isQualifierOrType(const FormatToken *Tok, const LangOptions &LangOpts)
void prepareLeftRightOrderingForQualifierAlignmentFixer(const std::vector< std::string > &Order, std::vector< std::string > &LeftOrder, std::vector< std::string > &RightOrder, std::vector< tok::TokenKind > &Qualifiers)
TokenKind
Provides a simple uniform namespace for tokens from all C languages.
Definition: TokenKinds.h:25
The JSON file list parser is used to communicate input to InstallAPI.
Encapsulates keywords that are context sensitive or for languages not properly supported by Clang's l...
Definition: FormatToken.h:995
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:290