nit: clean up

Author: bobtista

tools/clang-tidy-plugin/GeneralsGameCodeTidyModule.cpp

@@ -19,14 +19,9 @@ void GeneralsGameCodeTidyModule::addCheckFactories(
 
 } // namespace clang::tidy::generalsgamecode
 
-// Static registration using LLVM's registry system
-// This is the "hack" mentioned in the documentation for out-of-tree plugins
-// The static initializer should run when the library is loaded
 static llvm::Registry<::clang::tidy::ClangTidyModule>::Add<
     ::clang::tidy::generalsgamecode::GeneralsGameCodeTidyModule>
     X("generalsgamecode", "GeneralsGameCode-specific checks");
 
-// Anchor variable to force linker to include this file
-// This ensures the static initializer above actually runs
 volatile int GeneralsGameCodeTidyModuleAnchorSource = 0;
 

tools/clang-tidy-plugin/README.md

@@ -22,37 +22,57 @@ if (!str.isEmpty()) { ... }
 
 ## Building
 
-This plugin requires LLVM and Clang to be installed. You can build it with CMake:
+This plugin requires LLVM and Clang to be installed. Build it with CMake:
 
 ```bash
 cd tools/clang-tidy-plugin
-mkdir build
-cd build
+mkdir build && cd build
 cmake .. -DLLVM_DIR=/path/to/llvm/lib/cmake/llvm -DClang_DIR=/path/to/clang/lib/cmake/clang
 make
 ```
 
 The plugin will be built as a shared library (`.so` on Linux, `.dylib` on macOS, `.dll` on Windows) in the `build/lib/` directory.
 
+## Prerequisites
+
+Before using the plugin, you need to generate a compile commands database:
+
+```bash
+cmake -B build/clang-tidy -DCMAKE_DISABLE_PRECOMPILE_HEADERS=ON -G Ninja
+```
+
+This creates `build/clang-tidy/compile_commands.json` which tells clang-tidy how to compile each file.
+
 ## Usage
 
-Load the plugin when running clang-tidy:
+### Basic Usage
 
 ```bash
-clang-tidy --checks=-*,generals-use-is-empty \
-  -load build/lib/GeneralsGameCodeClangTidyPlugin.so \
-  source.cpp
+clang-tidy -p build/clang-tidy \
+  --checks='-*,generals-use-is-empty' \
+  -load tools/clang-tidy-plugin/build/lib/libGeneralsGameCodeClangTidyPlugin.so \
+  file.cpp
 ```
 
-Or add it to your `.clang-tidy` configuration file:
+### With Automatic Fixes
 
-```yaml
-Checks: '-*,generals-use-is-empty'
+```bash
+clang-tidy -p build/clang-tidy \
+  --checks='-*,generals-use-is-empty' \
+  -load tools/clang-tidy-plugin/build/lib/libGeneralsGameCodeClangTidyPlugin.so \
+  -fix-errors \
+  file.cpp
 ```
 
-And load it with:
+### On Multiple Files
 
 ```bash
-clang-tidy -load build/lib/GeneralsGameCodeClangTidyPlugin.so source.cpp
+find Core -name "*.cpp" -type f -exec clang-tidy \
+  -p build/clang-tidy \
+  --checks='-*,generals-use-is-empty' \
+  -load tools/clang-tidy-plugin/build/lib/libGeneralsGameCodeClangTidyPlugin.so \
+  -fix-errors {} \;
 ```
 
+The `-p build/clang-tidy` flag tells clang-tidy to use the compile commands database to understand how to parse each file.
+

tools/clang-tidy-plugin/readability/UseIsEmptyCheck.cpp

@@ -19,15 +19,12 @@ using namespace clang::ast_matchers;
 namespace clang::tidy::generalsgamecode::readability {
 
 void UseIsEmptyCheck::registerMatchers(MatchFinder *Finder) {
-  // Match member calls to getLength() on AsciiString or UnicodeString
-  // followed by comparison with 0
   auto GetLengthCall = cxxMemberCallExpr(
       callee(cxxMethodDecl(hasName("getLength"))),
       on(hasType(hasUnqualifiedDesugaredType(
           recordType(hasDeclaration(cxxRecordDecl(
               hasAnyName("AsciiString", "UnicodeString"))))))));
 
-  // Match: obj.getLength() == 0
   Finder->addMatcher(
       binaryOperator(
           hasOperatorName("=="),
@@ -36,7 +33,6 @@ void UseIsEmptyCheck::registerMatchers(MatchFinder *Finder) {
           .bind("comparison"),
       this);
 
-  // Match: obj.getLength() != 0
   Finder->addMatcher(
       binaryOperator(
           hasOperatorName("!="),
@@ -45,7 +41,6 @@ void UseIsEmptyCheck::registerMatchers(MatchFinder *Finder) {
           .bind("comparison"),
       this);
 
-  // Match: obj.getLength() > 0
   Finder->addMatcher(
       binaryOperator(
           hasOperatorName(">"),
@@ -54,7 +49,6 @@ void UseIsEmptyCheck::registerMatchers(MatchFinder *Finder) {
           .bind("comparison"),
       this);
 
-  // Match: obj.getLength() <= 0
   Finder->addMatcher(
       binaryOperator(
           hasOperatorName("<="),
@@ -63,7 +57,6 @@ void UseIsEmptyCheck::registerMatchers(MatchFinder *Finder) {
           .bind("comparison"),
       this);
 
-  // Match: 0 == obj.getLength()
   Finder->addMatcher(
       binaryOperator(
           hasOperatorName("=="),
@@ -72,7 +65,6 @@ void UseIsEmptyCheck::registerMatchers(MatchFinder *Finder) {
           .bind("comparison"),
       this);
 
-  // Match: 0 != obj.getLength()
   Finder->addMatcher(
       binaryOperator(
           hasOperatorName("!="),
@@ -90,12 +82,10 @@ void UseIsEmptyCheck::check(const MatchFinder::MatchResult &Result) {
   if (!Comparison || !GetLengthCall)
     return;
 
-  // Get the object on which getLength() is called
   const Expr *ObjectExpr = GetLengthCall->getImplicitObjectArgument();
   if (!ObjectExpr)
     return;
 
-  // Determine the replacement based on the operator
   StringRef Operator = Comparison->getOpcodeStr();
   bool ShouldNegate = false;
 
@@ -108,23 +98,20 @@ void UseIsEmptyCheck::check(const MatchFinder::MatchResult &Result) {
   } else if (Operator == "<=") {
     ShouldNegate = false;
   } else {
-    return; // Unsupported operator
+    return;
   }
 
-  // Get the source text for the object expression
   StringRef ObjectText = Lexer::getSourceText(
       CharSourceRange::getTokenRange(ObjectExpr->getSourceRange()),
       *Result.SourceManager, Result.Context->getLangOpts());
 
-  // Build the replacement text
   std::string Replacement;
   if (ShouldNegate) {
     Replacement = "!" + ObjectText.str() + ".isEmpty()";
   } else {
     Replacement = ObjectText.str() + ".isEmpty()";
   }
 
-  // Create the fix - replace the entire comparison
   SourceLocation StartLoc = Comparison->getBeginLoc();
   SourceLocation EndLoc = Comparison->getEndLoc();