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 20 namespace clang { 21 namespace format { 22 23 typedef std::function<std::pair<tooling::Replacements, unsigned>( 24 const Environment &)> 25 AnalyzerPass; 26 27 void addQualifierAlignmentFixerPasses(const FormatStyle &Style, 28 SmallVectorImpl<AnalyzerPass> &Passes); 29 30 void 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 class LeftRightQualifierAlignmentFixer : public TokenAnalyzer { 36 std::string Qualifier; 37 bool RightAlign; 38 SmallVector<tok::TokenKind, 8> QualifierTokens; 39 std::vector<tok::TokenKind> ConfiguredQualifierTokens; 40 41 public: 42 LeftRightQualifierAlignmentFixer( 43 const Environment &Env, const FormatStyle &Style, 44 const std::string &Qualifier, 45 const std::vector<tok::TokenKind> &ConfiguredQualifierTokens, 46 bool RightAlign); 47 48 std::pair<tooling::Replacements, unsigned> 49 analyze(TokenAnnotator &Annotator, 50 SmallVectorImpl<AnnotatedLine *> &AnnotatedLines, 51 FormatTokenLexer &Tokens) override; 52 53 static tok::TokenKind getTokenFromQualifier(const std::string &Qualifier); 54 55 void fixQualifierAlignment(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines, 56 FormatTokenLexer &Tokens, 57 tooling::Replacements &Fixes); 58 59 const FormatToken *analyzeRight(const SourceManager &SourceMgr, 60 const AdditionalKeywords &Keywords, 61 tooling::Replacements &Fixes, 62 const FormatToken *Tok, 63 const std::string &Qualifier, 64 tok::TokenKind QualifierType); 65 66 const FormatToken *analyzeLeft(const SourceManager &SourceMgr, 67 const AdditionalKeywords &Keywords, 68 tooling::Replacements &Fixes, 69 const FormatToken *Tok, 70 const std::string &Qualifier, 71 tok::TokenKind QualifierType); 72 73 // Is the Token a simple or qualifier type 74 static bool isQualifierOrType(const FormatToken *Tok); 75 static bool 76 isConfiguredQualifierOrType(const FormatToken *Tok, 77 const std::vector<tok::TokenKind> &Qualifiers); 78 79 // Is the Token likely a Macro 80 static bool isPossibleMacro(const FormatToken *Tok); 81 }; 82 83 } // end namespace format 84 } // end namespace clang 85 86 #endif 87