Finish applying clang-tidy to 3C (for now).

- Update clang/docs/checkedc/3C/clang-tidy.md with much more information
  about the process. Note that some warnings remain that we haven't yet
  decided what to do about.

- Disable misc-no-recursion rule for now because it looks like we make
  significant intentional use of recursion.

- Remove blank lines between #include lines so that the
  `llvm-include-order` check will sort all the lines. Minor tweaks to
  nearby formatting.

- Run `clang-tidy --fix` multiple times, then `clang-format`, then fix
  up formatting mistakes from `llvm-else-after-return` as described in
  clang-tidy.md.

- Manually rename some elements where we're not happy with what the
  default `readability-identifier-naming` fix did.

- Get the clangd3c target to build and enable it again! After clang-tidy
  fixed some broken references without being asked, there was only one
  real error left, which was straightforward to fix. We still think
  clangd3c doesn't work, but as long as it builds, it will be easier for
  us to include it in bulk code edits like this one if we want to.

Author: mattmccutchen-cci

clang-tools-extra/clangd/3CCommands.cpp

@@ -16,7 +16,7 @@ namespace clangd {
 
 #define _3CSOURCE "3C_RealWild"
 
-static bool GetPtrIDFromDiagMessage(const Diagnostic &DiagMsg,
+static bool getPtrIdFromDiagMessage(const Diagnostic &DiagMsg,
                                     unsigned long &PtrId) {
   if (DiagMsg.source.rfind(_3CSOURCE, 0) == 0) {
     PtrId = atoi(DiagMsg.code.c_str());
@@ -25,13 +25,13 @@ static bool GetPtrIDFromDiagMessage(const Diagnostic &DiagMsg,
   return false;
 }
 
-void As3CCommands(const Diagnostic &D, std::vector<Command> &OutCommands) {
+void as3CCommands(const Diagnostic &D, std::vector<Command> &OutCommands) {
   unsigned long PtrId;
-  if (GetPtrIDFromDiagMessage(D, PtrId)) {
+  if (getPtrIdFromDiagMessage(D, PtrId)) {
     Command AllPtrsCmd;
     _3CManualFix PtrFix;
-    PtrFix.ptrID = PtrId;
-    AllPtrsCmd._3CManualFix = PtrFix;
+    PtrFix.PtrId = PtrId;
+    AllPtrsCmd.The3CManualFix = PtrFix;
     Command SinglePtrCmd = AllPtrsCmd;
 
     AllPtrsCmd.command = Command::_3C_APPLY_FOR_ALL;
@@ -47,22 +47,22 @@ void As3CCommands(const Diagnostic &D, std::vector<Command> &OutCommands) {
   }
 }
 
-bool Is3CCommand(const ExecuteCommandParams &Params) {
+bool is3CCommand(const ExecuteCommandParams &Params) {
   return (Params.command.rfind(Command::_3C_APPLY_ONLY_FOR_THIS, 0) == 0) ||
          (Params.command.rfind(Command::_3C_APPLY_FOR_ALL, 0) == 0);
 }
 
-bool Execute3CCommand(const ExecuteCommandParams &Params,
+bool execute3CCommand(const ExecuteCommandParams &Params,
                       std::string &ReplyMessage, _3CInterface &CcInterface) {
   ReplyMessage = "Checked C Pointer Modified.";
   if (Params.command.rfind(Command::_3C_APPLY_ONLY_FOR_THIS, 0) == 0) {
-    int PtrId = Params._3CManualFix->ptrID;
-    CcInterface.MakeSinglePtrNonWild(PtrId);
+    int PtrId = Params.The3CManualFix->PtrId;
+    CcInterface.makeSinglePtrNonWild(PtrId);
     return true;
   }
   if (Params.command.rfind(Command::_3C_APPLY_FOR_ALL, 0) == 0) {
-    int PtrId = Params._3CManualFix->ptrID;
-    CcInterface.InvalidateWildReasonGlobally(PtrId);
+    int PtrId = Params.The3CManualFix->PtrId;
+    CcInterface.invalidateWildReasonGlobally(PtrId);
     return true;
   }
   return false;

clang-tools-extra/clangd/3CCommands.h

@@ -18,13 +18,13 @@
 namespace clang {
 namespace clangd {
 // Convert the provided Diagnostic into Commands.
-void As3CCommands(const Diagnostic &D, std::vector<Command> &OutCommands);
+void as3CCommands(const Diagnostic &D, std::vector<Command> &OutCommands);
 // Check if the execute command request from the client is a 3C command.
-bool Is3CCommand(const ExecuteCommandParams &Params);
+bool is3CCommand(const ExecuteCommandParams &Params);
 
 // Interpret the provided execute command request as 3C command
 // and execute them.
-bool Execute3CCommand(const ExecuteCommandParams &Params,
+bool execute3CCommand(const ExecuteCommandParams &Params,
                       std::string &ReplyMessage, _3CInterface &CcInterface);
 } // namespace clangd
 } // namespace clang

clang-tools-extra/clangd/3CDiagnostics.cpp

@@ -16,40 +16,40 @@ namespace clangd {
 
 #define DEFAULT_PTRSIZE 4
 
-void _3CDiagnostics::ClearAllDiags() {
+void _3CDiagnostics::clearAllDiags() {
   std::lock_guard<std::mutex> Lock(DiagMutex);
   AllFileDiagnostics.clear();
 }
 
-static bool IsValidSourceFile(ConstraintsInfo &CCRes, std::string &FilePath) {
+static bool isValidSourceFile(ConstraintsInfo &CCRes, std::string &FilePath) {
   return CCRes.ValidSourceFiles.find(FilePath) != CCRes.ValidSourceFiles.end();
 }
 
-bool _3CDiagnostics::PopulateDiagsFromConstraintsInfo(ConstraintsInfo &Line) {
+bool _3CDiagnostics::populateDiagsFromConstraintsInfo(ConstraintsInfo &Line) {
   std::lock_guard<std::mutex> Lock(DiagMutex);
   std::set<ConstraintKey> ProcessedCKeys;
   ProcessedCKeys.clear();
   auto GetLocRange = [](uint32_t Line, uint32_t ColNoS,
                         uint32_t ColNoE) -> Range {
-    Range nRange;
+    Range NRange;
     Line--;
-    nRange.start.line = Line;
-    nRange.end.line = Line;
-    nRange.start.character = ColNoS;
+    NRange.start.line = Line;
+    NRange.end.line = Line;
+    NRange.start.character = ColNoS;
     if (ColNoE > 0) {
-      nRange.end.character = ColNoE;
+      NRange.end.character = ColNoE;
     } else {
-      nRange.end.character = ColNoS + DEFAULT_PTRSIZE;
+      NRange.end.character = ColNoS + DEFAULT_PTRSIZE;
     }
-    return nRange;
+    return NRange;
   };
 
   for (auto &WReason : Line.RootWildAtomsWithReason) {
     if (Line.AtomSourceMap.find(WReason.first) != Line.AtomSourceMap.end()) {
       auto *PsInfo = Line.AtomSourceMap[WReason.first];
       std::string FilePath = PsInfo->getFileName();
       // If this is not a file in a project? Then ignore.
-      if (!IsValidSourceFile(Line, FilePath))
+      if (!isValidSourceFile(Line, FilePath))
         continue;
 
       ProcessedCKeys.insert(WReason.first);
@@ -59,7 +59,7 @@ bool _3CDiagnostics::PopulateDiagsFromConstraintsInfo(ConstraintsInfo &Line) {
                                   PsInfo->getColENo());
       NewDiag.Source = Diag::_3CMain;
       NewDiag.Severity = DiagnosticsEngine::Level::Error;
-      NewDiag.code = std::to_string(WReason.first);
+      NewDiag.Code = std::to_string(WReason.first);
       NewDiag.Message =
           "Pointer is wild because of:" + WReason.second.getWildPtrReason();
 
@@ -85,36 +85,41 @@ bool _3CDiagnostics::PopulateDiagsFromConstraintsInfo(ConstraintsInfo &Line) {
         auto *PsInfo = Line.AtomSourceMap[NonWildCk];
         std::string FilePath = PsInfo->getFileName();
         // If this is not a file in a project? Then ignore.
-        if (!IsValidSourceFile(Line, FilePath))
+        if (!isValidSourceFile(Line, FilePath))
           continue;
 
         ProcessedCKeys.insert(NonWildCk);
         Diag NewDiag;
         NewDiag.Range = GetLocRange(PsInfo->getLineNo(), PsInfo->getColSNo(),
                                     PsInfo->getColENo());
 
-        NewDiag.code = std::to_string(NonWildCk);
+        NewDiag.Code = std::to_string(NonWildCk);
         NewDiag.Source = Diag::_3CSec;
         NewDiag.Severity = DiagnosticsEngine::Level::Warning;
         NewDiag.Message = "Pointer is wild because it transitively "
                           "depends on other pointer(s)";
 
         // find the pointer group
-        CVars &DirectWildPtrs = Line.GetRCVars(NonWildCk);
+        CVars &DirectWildPtrs = Line.getRCVars(NonWildCk);
 
         unsigned MaxPtrReasons = 4;
-        for (auto tC : DirectWildPtrs) {
+        for (auto TC : DirectWildPtrs) {
           Note DiagNote;
 
-          if (Line.AtomSourceMap.find(tC) != Line.AtomSourceMap.end()) {
-            PsInfo = Line.AtomSourceMap[tC];
+          if (Line.AtomSourceMap.find(TC) != Line.AtomSourceMap.end()) {
+            PsInfo = Line.AtomSourceMap[TC];
             FilePath = PsInfo->getFileName();
             DiagNote.AbsFile = FilePath;
             DiagNote.Range = GetLocRange(
                 PsInfo->getLineNo(), PsInfo->getColSNo(), PsInfo->getColENo());
             MaxPtrReasons--;
+            // NOTE: Matt changed [] to `at` to fix a compile error after the
+            // default constructor of WildPointerInferenceInfo was removed in
+            // 3c3098c8724889a12eba383dec9088094bced99c. Right now, we don't
+            // care because we're not running clangd3c at all, but if and when
+            // we revive it, we should consider whether this assumption is safe.
             DiagNote.Message =
-                Line.RootWildAtomsWithReason[tC].getWildPtrReason();
+                Line.RootWildAtomsWithReason.at(TC).getWildPtrReason();
             if (MaxPtrReasons <= 1)
               DiagNote.Message += " (others)";
             NewDiag.Notes.push_back(DiagNote);

clang-tools-extra/clangd/3CDiagnostics.h

@@ -29,11 +29,11 @@ class _3CDiagnostics {
 
   // GUARDED by DiagMutex
   // Populate diagnostics from the given disjoint set.
-  bool PopulateDiagsFromConstraintsInfo(ConstraintsInfo &Line);
+  bool populateDiagsFromConstraintsInfo(ConstraintsInfo &Line);
   // GUARDED by DiagMutex
   // Clear diagnostics of all files.
-  void ClearAllDiags();
-  std::map<std::string, std::vector<Diag>> &GetAllFilesDiagnostics() {
+  void clearAllDiags();
+  std::map<std::string, std::vector<Diag>> &getAllFilesDiagnostics() {
     return AllFileDiagnostics;
   }
 

clang-tools-extra/clangd/ClangdLSPServer.cpp

@@ -365,7 +365,7 @@ void ClangdLSPServer::onInitialize(const InitializeParams &Params,
               ClangdServerOpts.ResourceDir);
   Server.emplace(*CDB, FSProvider, static_cast<DiagnosticsConsumer &>(*this),
 #ifdef INTERACTIVE3C
-                 ClangdServerOpts, _3CInterface);
+                 ClangdServerOpts, The3CInterface);
 #else
                  ClangdServerOpts);
 #endif
@@ -462,7 +462,7 @@ void ClangdLSPServer::onShutdown(const ShutdownParams &Params,
 #ifdef INTERACTIVE3C
   send3CMessage("Writing all CheckedC files back to disk");
   // Write all files back.
-  auto &AllDiags = Server->_3CDiagInfo.GetAllFilesDiagnostics();
+  auto &AllDiags = Server->_3CDiagInfo.getAllFilesDiagnostics();
   for (auto &CD : AllDiags) {
     Server->_3CCloseDocument(CD.first);
   }
@@ -533,11 +533,11 @@ void ClangdLSPServer::_3CResultsReady(std::string FileName, bool ClearDiags) {
   std::vector<Diag> Diagnostics;
   Diagnostics.clear();
   if (!ClearDiags) {
-    std::lock_guard<std::mutex> lock(Server->_3CDiagInfo.DiagMutex);
-    auto &allDiags = Server->_3CDiagInfo.GetAllFilesDiagnostics();
-    if (allDiags.find(FileName) != allDiags.end()) {
-      Diagnostics.insert(Diagnostics.begin(), allDiags[FileName].begin(),
-                         allDiags[FileName].end());
+    std::lock_guard<std::mutex> Lock(Server->_3CDiagInfo.DiagMutex);
+    auto &AllDiags = Server->_3CDiagInfo.getAllFilesDiagnostics();
+    if (AllDiags.find(FileName) != AllDiags.end()) {
+      Diagnostics.insert(Diagnostics.begin(), AllDiags[FileName].begin(),
+                         AllDiags[FileName].end());
     }
   }
   this->onDiagnosticsReady(FileName, Diagnostics);
@@ -556,7 +556,7 @@ void ClangdLSPServer::onCommand(const ExecuteCommandParams &Params,
                                 Callback<llvm::json::Value> Reply) {
 #ifdef INTERACTIVE3C
   // In this mode, we support only 3C commands.
-  if (Is3CCommand(Params)) {
+  if (is3CCommand(Params)) {
     Server->execute3CCommand(Params, this);
     Reply("3C Background work scheduled.");
   } else {
@@ -811,7 +811,7 @@ void ClangdLSPServer::onCodeAction(const CodeActionParams &Params,
   std::vector<Command> Commands;
   // Convert the diagnostics into 3C commands.
   for (const Diagnostic &D : Params.context.diagnostics) {
-    As3CCommands(D, Commands);
+    as3CCommands(D, Commands);
   }
   Reply(llvm::json::Array(Commands));
 #else
@@ -914,14 +914,14 @@ void ClangdLSPServer::onCodeLens(const CodeLensParams &Params,
   // This is just a beacon to display for user.
   std::vector<CodeLens> AllCodeLens;
   CodeLens CcBecon;
-  CcBecon.range.start.line = 15;
-  CcBecon.range.end.line = 16;
-  CcBecon.range.start.character = 13;
-  CcBecon.range.end.character = 17;
+  CcBecon.TheRange.start.line = 15;
+  CcBecon.TheRange.end.line = 16;
+  CcBecon.TheRange.start.character = 13;
+  CcBecon.TheRange.end.character = 17;
   Command NewCmd;
   NewCmd.command = "3C Interactive Mode On";
   NewCmd.title = "3C Mode On";
-  CcBecon.command = NewCmd;
+  CcBecon.TheCommand = NewCmd;
   AllCodeLens.clear();
   AllCodeLens.push_back(CcBecon);
   Reply(llvm::json::Array(AllCodeLens));
@@ -930,7 +930,7 @@ void ClangdLSPServer::onCodeLens(const CodeLensParams &Params,
 void ClangdLSPServer::onCodeLensResolve(const CodeLens &Params,
                                         Callback<llvm::json::Value> Reply) {
   CodeLens CcBeaconResolve;
-  CcBeaconResolve.range = Params.range;
+  CcBeaconResolve.TheRange = Params.TheRange;
   Reply(clang::clangd::toJSON(CcBeaconResolve));
 }
 #endif
@@ -1126,7 +1126,7 @@ ClangdLSPServer::ClangdLSPServer(
       UseDirBasedCDB(UseDirBasedCDB),
       CompileCommandsDir(std::move(CompileCommandsDir)), ClangdServerOpts(Opts),
 #ifdef INTERACTIVE3C
-      NegotiatedOffsetEncoding(ForcedOffsetEncoding), _3CInterface(Cinter) {
+      NegotiatedOffsetEncoding(ForcedOffsetEncoding), The3CInterface(Cinter) {
 #else
       NegotiatedOffsetEncoding(ForcedOffsetEncoding) {
 #endif

clang-tools-extra/clangd/ClangdLSPServer.h

@@ -203,9 +203,7 @@ class ClangdLSPServer : private DiagnosticsConsumer {
   llvm::Optional<ClangdServer> Server;
   llvm::Optional<OffsetEncoding> NegotiatedOffsetEncoding;
 #ifdef INTERACTIVE3C
-  // See clang/docs/checkedc/3C/clang-tidy.md#_3c-name-prefix
-  // NOLINTNEXTLINE(readability-identifier-naming)
-  _3CInterface &_3CInterface;
+  _3CInterface &The3CInterface;
 #endif
 };
 } // namespace clangd

clang-tools-extra/clangd/ClangdServer.cpp

@@ -177,14 +177,14 @@ void ClangdServer::addDocument(PathRef File, llvm::StringRef Contents,
 void ClangdServer::report3CDiagsForAllFiles(ConstraintsInfo &CcInfo,
                                             _3CLSPCallBack *ConvCB) {
   // Update the diag information for all the valid files.
-  for (auto &SrcFileDiags : _3CDiagInfo.GetAllFilesDiagnostics()) {
+  for (auto &SrcFileDiags : _3CDiagInfo.getAllFilesDiagnostics()) {
     ConvCB->_3CResultsReady(SrcFileDiags.first);
   }
 }
 
 void ClangdServer::clear3CDiagsForAllFiles(ConstraintsInfo &CcInfo,
                                            _3CLSPCallBack *ConvCB) {
-  for (auto &SrcFileDiags : _3CDiagInfo.GetAllFilesDiagnostics()) {
+  for (auto &SrcFileDiags : _3CDiagInfo.getAllFilesDiagnostics()) {
     // Clear diags for all files.
     ConvCB->_3CResultsReady(SrcFileDiags.first, true);
   }
@@ -193,15 +193,15 @@ void ClangdServer::clear3CDiagsForAllFiles(ConstraintsInfo &CcInfo,
 void ClangdServer::_3CCollectAndBuildInitialConstraints(
     _3CLSPCallBack *ConvCB) {
   auto Task = [=]() {
-    _3CDiagInfo.ClearAllDiags();
+    _3CDiagInfo.clearAllDiags();
     ConvCB->send3CMessage("Running 3C for first time.");
-    _3CInter.BuildInitialConstraints();
-    _3CInter.SolveConstraints(true);
+    _3CInter.buildInitialConstraints();
+    _3CInter.solveConstraints(true);
     ConvCB->send3CMessage("Finished running 3C.");
     log("3C: Built initial constraints successfully.\n");
-    auto &WildPtrsInfo = _3CInter.GetWILDPtrsInfo();
+    auto &WildPtrsInfo = _3CInter.getWildPtrsInfo();
     log("3C: Got WILD Ptrs Info.\n");
-    _3CDiagInfo.PopulateDiagsFromConstraintsInfo(WildPtrsInfo);
+    _3CDiagInfo.populateDiagsFromConstraintsInfo(WildPtrsInfo);
     log("3C: Populated Diags from Disjoint Sets.\n");
     report3CDiagsForAllFiles(WildPtrsInfo, ConvCB);
     ConvCB->send3CMessage("3C: Finished updating problems.");
@@ -214,19 +214,19 @@ void ClangdServer::execute3CCommand(ExecuteCommandParams Params,
                                     _3CLSPCallBack *ConvCB) {
   auto Task = [this, Params, ConvCB]() {
     std::string RplMsg;
-    auto &WildPtrsInfo = _3CInter.GetWILDPtrsInfo();
+    auto &WildPtrsInfo = _3CInter.getWildPtrsInfo();
     auto &PtrSourceMap = WildPtrsInfo.AtomSourceMap;
-    if (PtrSourceMap.find(Params._3CManualFix->ptrID) != PtrSourceMap.end()) {
+    if (PtrSourceMap.find(Params.The3CManualFix->PtrId) != PtrSourceMap.end()) {
       std::string PtrFileName =
-          PtrSourceMap[Params._3CManualFix->ptrID]->getFileName();
+          PtrSourceMap[Params.The3CManualFix->PtrId]->getFileName();
       log("3C: File of the pointer {0}\n", PtrFileName);
       clear3CDiagsForAllFiles(WildPtrsInfo, ConvCB);
       ConvCB->send3CMessage("3C modifying constraints.");
-      Execute3CCommand(Params, RplMsg, _3CInter);
-      this->_3CDiagInfo.ClearAllDiags();
+      ::clang::clangd::execute3CCommand(Params, RplMsg, _3CInter);
+      this->_3CDiagInfo.clearAllDiags();
       ConvCB->send3CMessage("3C Updating new issues "
                             "after editing constraints.");
-      this->_3CDiagInfo.PopulateDiagsFromConstraintsInfo(WildPtrsInfo);
+      this->_3CDiagInfo.populateDiagsFromConstraintsInfo(WildPtrsInfo);
       log("3C calling call-back\n");
       // ConvCB->_3CResultsReady(ptrFileName);
       ConvCB->send3CMessage("3C Updated new issues.");
@@ -241,7 +241,7 @@ void ClangdServer::execute3CCommand(ExecuteCommandParams Params,
 void ClangdServer::_3CCloseDocument(std::string FileName) {
   auto Task = [=]() {
     log("3C: Trying to write back file: {0}\n", FileName);
-    if (_3CInter.WriteConvertedFileToDisk(FileName)) {
+    if (_3CInter.writeConvertedFileToDisk(FileName)) {
       log("3C: Finished writing back file: {0}\n", FileName);
     } else {
       log("3C: File not included during constraint solving phase. "

clang-tools-extra/clangd/Diagnostics.cpp

@@ -319,7 +319,7 @@ void toLSPDiags(
 
   clangd::Diagnostic Main = FillBasicFields(D);
 #ifdef INTERACTIVE3C
-  Main.code = D.code;
+  Main.code = D.Code;
 #else
   Main.code = D.Name;
 #endif

clang-tools-extra/clangd/Diagnostics.h

@@ -58,7 +58,7 @@ struct DiagBase {
   // Absolute path to containing file, if available.
   llvm::Optional<std::string> AbsFile;
 #ifdef INTERACTIVE3C
-  std::string code;
+  std::string Code;
 #endif
   clangd::Range Range;
   DiagnosticsEngine::Level Severity = DiagnosticsEngine::Note;