Merge pull request #452 from secure-software-engineering/f-ClangTidyIdentifierRenameControlFlow

clang-tidy: Identifier rename ControlFlow

Author: pdschubert

include/phasar/PhasarClang/RandomChangeFrontendAction.h

@@ -41,7 +41,7 @@ class RandomChangeFrontendAction : public clang::ASTFrontendAction {
   void EndSourceFileAction() override;
 
   std::unique_ptr<clang::ASTConsumer>
-  CreateASTConsumer(clang::CompilerInstance &CI, llvm::StringRef file) override;
+  CreateASTConsumer(clang::CompilerInstance &CI, llvm::StringRef File) override;
 };
 
 } // namespace psr

include/phasar/PhasarLLVM/AnalysisStrategy/Strategies.h

@@ -24,7 +24,7 @@ std::string toString(const AnalysisStrategy &S);
 
 AnalysisStrategy toAnalysisStrategy(const std::string &S);
 
-std::ostream &operator<<(std::ostream &os, const AnalysisStrategy &S);
+std::ostream &operator<<(std::ostream &OS, const AnalysisStrategy &S);
 
 } // namespace psr
 

include/phasar/PhasarLLVM/AnalysisStrategy/WholeProgramAnalysis.h

@@ -92,9 +92,9 @@ class WholeProgramAnalysis {
                             IRDB, CallGraphAnalysisType::OTF, EntryPoints,
                             this->TypeHierarchy.get(), this->PointerInfo.get())
                       : std::unique_ptr<CallGraphAnalysisTy>(CallGraph)),
-        EntryPoints(EntryPoints), Config(Config), OwnsConfig(false),
-        ConfigPath(""), ProblemDesc(&IRDB, TypeHierarchy, CallGraph,
-                                    PointerInfo, *Config, EntryPoints),
+        EntryPoints(EntryPoints), Config(Config),
+        ProblemDesc(&IRDB, TypeHierarchy, CallGraph, PointerInfo, *Config,
+                    EntryPoints),
         DataFlowSolver(ProblemDesc) {}
 
   template <typename T = ProblemDescription,

include/phasar/PhasarLLVM/ControlFlow/BiDiICFG.h

@@ -27,33 +27,33 @@ template <typename N, typename F> class BiDiICFG : public ICFG<N, F> {
 public:
   virtual ~BiDiICFG() = default;
 
-  virtual std::vector<N> getPredsOf(N u) = 0;
+  virtual std::vector<N> getPredsOf(N U) = 0;
 
-  virtual std::set<N> getEndPointsOf(F f) = 0;
+  virtual std::set<N> getEndPointsOf(F Func) = 0;
 
-  virtual std::vector<N> getPredsOfCallAt(N u) = 0;
+  virtual std::vector<N> getPredsOfCallAt(N U) = 0;
 
   virtual std::set<N> allNonCallEndNodes() = 0;
 
   // also exposed to some clients who need it
   // virtual DirectedGraph<N> getOrCreateUnitGraph(F body) = 0;
 
-  virtual std::vector<N> getParameterRefs(F f) = 0;
+  virtual std::vector<N> getParameterRefs(F Func) = 0;
 
   /**
    * Gets whether the given statement is a return site of at least one call
    * @param n The statement to check
    * @return True if the given statement is a return site, otherwise false
    */
-  virtual bool isReturnSite(N n) = 0;
+  virtual bool isReturnSite(N U) = 0;
 
   /**
    * Checks whether the given statement is reachable from the entry point
    * @param u The statement to check
    * @return True if there is a control flow path from the entry point of the
    * program to the given statement, otherwise false
    */
-  virtual bool isReachable(N u) = 0;
+  virtual bool isReachable(N U) = 0;
 };
 
 } // namespace psr

include/phasar/PhasarLLVM/ControlFlow/CFG.h

@@ -36,7 +36,7 @@ std::string toString(const SpecialMemberFunctionType &SMFT);
 
 SpecialMemberFunctionType toSpecialMemberFunctionType(const std::string &SMFT);
 
-std::ostream &operator<<(std::ostream &os,
+std::ostream &operator<<(std::ostream &OS,
                          const SpecialMemberFunctionType &SMFT);
 
 template <typename N, typename F> class CFG {

include/phasar/PhasarLLVM/ControlFlow/ICFG.h

@@ -41,7 +41,7 @@ std::string toString(const CallGraphAnalysisType &CGA);
 
 CallGraphAnalysisType toCallGraphAnalysisType(const std::string &S);
 
-std::ostream &operator<<(std::ostream &os, const CallGraphAnalysisType &CGA);
+std::ostream &operator<<(std::ostream &OS, const CallGraphAnalysisType &CGA);
 
 template <typename N, typename F> class ICFG : public virtual CFG<N, F> {
 

include/phasar/PhasarLLVM/ControlFlow/LLVMBasedBackwardICFG.h

@@ -104,7 +104,7 @@ class LLVMBasedBackwardsICFG
 
   [[nodiscard]] bool isExitInst(const llvm::Instruction *Stmt) const override;
 
-  void mergeWith(const LLVMBasedBackwardsICFG &other);
+  void mergeWith(const LLVMBasedBackwardsICFG &Other);
 
   using LLVMBasedBackwardCFG::print; // tell the compiler we wish to have both
                                      // prints

include/phasar/PhasarLLVM/ControlFlow/LLVMBasedCFG.h

@@ -117,13 +117,15 @@ class LLVMBasedCFG
     std::string IR;
   };
 
-  friend void from_json(const nlohmann::json &J, SourceCodeInfoWithIR &Info);
-  friend void to_json(nlohmann::json &J, const SourceCodeInfoWithIR &Info);
+  friend void from_json(const nlohmann::json &J, // NOLINT
+                        SourceCodeInfoWithIR &Info);
+  friend void to_json(nlohmann::json &J, // NOLINT
+                      const SourceCodeInfoWithIR &Info);
 
   /// Used by export(I)CFGAsJson
   static SourceCodeInfoWithIR
-  getFirstNonEmpty(llvm::BasicBlock::const_iterator &it,
-                   llvm::BasicBlock::const_iterator end);
+  getFirstNonEmpty(llvm::BasicBlock::const_iterator &It,
+                   llvm::BasicBlock::const_iterator End);
   static SourceCodeInfoWithIR getFirstNonEmpty(const llvm::BasicBlock *BB);
 };
 

include/phasar/PhasarLLVM/ControlFlow/LLVMBasedICFG.h

@@ -130,10 +130,8 @@ class LLVMBasedICFG
 
   bool constructDynamicCall(const llvm::Instruction *I, Resolver &Resolver);
 
-  std::unique_ptr<Resolver> makeResolver(ProjectIRDB &IRDB,
-                                         CallGraphAnalysisType CGT,
-                                         LLVMTypeHierarchy &TH,
-                                         LLVMPointsToInfo &PT);
+  std::unique_ptr<Resolver>
+  makeResolver(ProjectIRDB &IRDB, LLVMTypeHierarchy &TH, LLVMPointsToInfo &PT);
 
   template <typename MapTy>
   static void insertGlobalCtorsDtorsImpl(MapTy &Into, const llvm::Module *M,
@@ -184,7 +182,8 @@ class LLVMBasedICFG
                 LLVMTypeHierarchy *TH = nullptr, LLVMPointsToInfo *PT = nullptr,
                 Soundness S = Soundness::Soundy, bool IncludeGlobals = true);
 
-  LLVMBasedICFG(const LLVMBasedICFG &);
+  LLVMBasedICFG(const LLVMBasedICFG &ICF);
+
   LLVMBasedICFG &operator=(const LLVMBasedICFG &) = delete;
 
   ~LLVMBasedICFG() override;
@@ -291,7 +290,7 @@ class LLVMBasedICFG
   void print(std::ostream &OS = std::cout) const override;
 
   void printAsDot(std::ostream &OS = std::cout,
-                  bool printEdgeLabels = true) const;
+                  bool PrintEdgeLabels = true) const;
 
   void printInternalPTGAsDot(std::ostream &OS = std::cout) const;
 
@@ -320,26 +319,26 @@ class LLVMBasedICFG
   [[nodiscard]] const llvm::Function *
   getRegisteredDtorsCallerOrNull(const llvm::Module *Mod);
 
-  template <typename Fn> void forEachGlobalCtor(Fn &&fn) const {
+  template <typename Fn> void forEachGlobalCtor(Fn &&F) const {
     for (auto [Prio, Fun] : GlobalCtors) {
-      fn(static_cast<const llvm::Function *>(Fun));
+      F(static_cast<const llvm::Function *>(Fun));
     }
   }
 
-  template <typename Fn> void forEachGlobalDtor(Fn &&fn) const {
+  template <typename Fn> void forEachGlobalDtor(Fn &&F) const {
     for (auto [Prio, Fun] : GlobalDtors) {
-      fn(static_cast<const llvm::Function *>(Fun));
+      F(static_cast<const llvm::Function *>(Fun));
     }
   }
 
 protected:
-  void collectGlobalCtors() override;
+  void collectGlobalCtors() final;
 
-  void collectGlobalDtors() override;
+  void collectGlobalDtors() final;
 
-  void collectGlobalInitializers() override;
+  void collectGlobalInitializers() final;
 
-  void collectRegisteredDtors() override;
+  void collectRegisteredDtors() final;
 };
 
 } // namespace psr

include/phasar/PhasarLLVM/ControlFlow/Resolver/DTAResolver.h

@@ -40,21 +40,21 @@ class DTAResolver : public CHAResolver {
   using TypeGraph_t = CachedTypeGraph;
 
 protected:
-  TypeGraph_t typegraph;
+  TypeGraph_t TypeGraph;
 
   /**
    * An heuristic that return true if the bitcast instruction is interesting to
    * take into the DTA relational graph
    */
   static bool
-  heuristicAntiConstructorThisType(const llvm::BitCastInst *bitcast);
+  heuristicAntiConstructorThisType(const llvm::BitCastInst *BitCast);
 
   /**
    * Another heuristic that return true if the bitcast instruction is
    * interesting to take into the DTA relational graph (use the presence or not
    * of vtable)
    */
-  bool heuristicAntiConstructorVtablePos(const llvm::BitCastInst *bitcast);
+  bool heuristicAntiConstructorVtablePos(const llvm::BitCastInst *BitCast);
 
 public:
   DTAResolver(ProjectIRDB &IRDB, LLVMTypeHierarchy &TH);