[SYCLomatic][NFC] Refactor utility (#2486)

zhimingwang36 · web-flow · commit 93123b10ad80 · 2024-11-13T14:34:48.000+08:00
Also removed dead code.
diff --git a/clang/include/clang/DPCT/DPCTOptions.inc b/clang/include/clang/DPCT/DPCTOptions.inc
@@ -87,7 +87,7 @@
 
 #ifndef DPCT_ENUM_OPTION
 #define DPCT_ENUM_OPTION(TEMPLATE, ENUM_TYPE, ...)                             \
-  DPCT_OPTION(TEMPLATE, ENUM_TYPE, __VA_ARGS__)
+  DPCT_OPTION(TEMPLATE, clang::dpct::ENUM_TYPE, __VA_ARGS__)
 #endif
 
 #ifndef DPCT_FLAG_OPTION
@@ -478,7 +478,7 @@ DPCT_ENUM_OPTION(
     llvm::cl::Optional)
 
 DPCT_ENUM_OPTION(
-    clang::dpct::opt, format::FormatRange, FormatRng,
+    clang::dpct::opt, FormatRange, FormatRng,
     clang::dpct::DpctOptionClass::OC_Attribute,
     DPCT_OPTION_ACTIONS(clang::dpct::DpctActionKind::DAK_Migration),
     "format-range",
@@ -599,25 +599,25 @@ DPCT_ENUM_OPTION(
                         clang::dpct::DpctActionKind::DAK_Analysis),
     "use-explicit-namespace",
     DPCT_OPTION_VALUES(
-        DPCT_OPTION_ENUM_VALUE("dpct", int(ExplicitNamespace::EN_DPCT),
+        DPCT_OPTION_ENUM_VALUE("dpct", int(clang::dpct::ExplicitNamespace::EN_DPCT),
                                "Generate code with dpct:: namespace.", false),
-        DPCT_OPTION_ENUM_VALUE("none", int(ExplicitNamespace::EN_None),
+        DPCT_OPTION_ENUM_VALUE("none", int(clang::dpct::ExplicitNamespace::EN_None),
                                "Generate code without any namespaces. Cannot "
                                "be used with other values.",
                                false),
         DPCT_OPTION_ENUM_VALUE(
-            "sycl", int(ExplicitNamespace::EN_SYCL),
+            "sycl", int(clang::dpct::ExplicitNamespace::EN_SYCL),
             "Generate code with sycl:: namespace. Cannot be used with cl or "
             "sycl-math values.",
             false),
         DPCT_OPTION_ENUM_VALUE(
-            "sycl-math", int(ExplicitNamespace::EN_SYCL_Math),
+            "sycl-math", int(clang::dpct::ExplicitNamespace::EN_SYCL_Math),
             "Generate code with sycl:: namespace, applied only for "
             "SYCL math functions.\n"
             "Cannot be used with cl or sycl values.",
             false),
         DPCT_OPTION_ENUM_VALUE("syclcompat",
-                               int(ExplicitNamespace::EN_SYCLCompat),
+                               int(clang::dpct::ExplicitNamespace::EN_SYCLCompat),
                                "Generate code with syclcompat:: namespace.",
                                false)),
     llvm::cl::desc("Define the namespaces to use explicitly in generated "
diff --git a/clang/lib/DPCT/AnalysisInfo.cpp b/clang/lib/DPCT/AnalysisInfo.cpp
@@ -27,9 +27,9 @@
 #define TYPELOC_CAST(Target) static_cast<const Target &>(TL)
 
 llvm::StringRef getReplacedName(const clang::NamedDecl *D) {
-  auto Iter = MapNames::TypeNamesMap.find(D->getQualifiedNameAsString(false));
-  if (Iter != MapNames::TypeNamesMap.end()) {
-    auto Range = getDefinitionRange(D->getBeginLoc(), D->getEndLoc());
+  auto Iter = clang::dpct::MapNames::TypeNamesMap.find(D->getQualifiedNameAsString(false));
+  if (Iter != clang::dpct::MapNames::TypeNamesMap.end()) {
+    auto Range = clang::dpct::getDefinitionRange(D->getBeginLoc(), D->getEndLoc());
     for (auto ItHeader = Iter->second->Includes.begin();
          ItHeader != Iter->second->Includes.end(); ItHeader++) {
       clang::dpct::DpctGlobalInfo::getInstance().insertHeader(Range.getBegin(),
@@ -6987,7 +6987,7 @@ void CallFunctionExpr::buildInfo() {
 bool isInSameLine(SourceLocation First, SourceLocation Second,
                   const SourceManager &SM) {
   bool Invalid = false;
-  return ::isInSameLine(SM.getExpansionLoc(First), SM.getExpansionLoc(Second),
+  return isInSameLine(SM.getExpansionLoc(First), SM.getExpansionLoc(Second),
                         SM, Invalid) &&
          !Invalid;
 }
diff --git a/clang/lib/DPCT/AnalysisInfo.h b/clang/lib/DPCT/AnalysisInfo.h
@@ -43,6 +43,8 @@ void setGetReplacedNamePtr(llvm::StringRef (*Ptr)(const clang::NamedDecl *D));
 
 namespace clang {
 namespace dpct {
+
+using format::FormatRange;
 using LocInfo = std::pair<tooling::UnifiedPath, unsigned int>;
 template <class F, class... Ts>
 std::string buildStringFromPrinter(F Func, Ts &&...Args) {
diff --git a/clang/lib/DPCT/CommandOption/ValidateArguments.cpp b/clang/lib/DPCT/CommandOption/ValidateArguments.cpp
@@ -23,6 +23,10 @@ using namespace llvm;
 using namespace std;
 namespace path = llvm::sys::path;
 namespace fs = llvm::sys::fs;
+
+namespace clang {
+namespace dpct {
+
 bool isOutRootAccess(SmallString<256> &OutRoot) {
   if (!fs::can_write(OutRoot)) {
     llvm::errs() << "Could not access out-root directory.\n";
@@ -95,7 +99,7 @@ bool makeInRootCanonicalOrSetDefaults(
       return false;
   } else if (InRoot.getCanonicalPath().empty()) {
     clang::dpct::ShowStatus(MigrationErrorInvalidInRootPath);
-    dpctExit(MigrationErrorInvalidInRootPath);
+    clang::dpct::dpctExit(MigrationErrorInvalidInRootPath);
   }
   if (fs::get_file_type(InRoot.getCanonicalPath()) !=
       fs::file_type::directory_file) {
@@ -168,7 +172,7 @@ int validateBuildScriptPaths(const clang::tooling::UnifiedPath &InRoot,
                    << InRoot << "'\n";
     }
     if (fs::is_regular_file(Canonical.getCanonicalPath()) &&
-        !isChildPath(InRoot, Canonical)) {
+        !clang::dpct::isChildPath(InRoot, Canonical)) {
       Ok = -4;
       llvm::errs() << "Error: File '" << Canonical.getCanonicalPath()
                    << "' is not under the specified input root directory '"
@@ -243,3 +247,5 @@ bool checkReportArgs(ReportTypeEnum &RType, ReportFormatEnum &RFormat,
 
   return Success;
 }
+} // namespace dpct
+} // namespace clang
diff --git a/clang/lib/DPCT/CommandOption/ValidateArguments.h b/clang/lib/DPCT/CommandOption/ValidateArguments.h
@@ -14,6 +14,9 @@
 #include <string>
 #include <vector>
 
+namespace clang {
+namespace dpct {
+
 #if defined(_WIN32)
 #define MAX_PATH_LEN _MAX_PATH
 #define MAX_NAME_LEN _MAX_FNAME
@@ -140,4 +143,6 @@ bool checkReportArgs(ReportTypeEnum &RType, ReportFormatEnum &RFormat,
 /// -1: Path is invalid
 int checkSDKPathOrIncludePath(clang::tooling::UnifiedPath &Path);
 
+} // namespace dpct
+} // namespace clang
 #endif // DPCT_VALIDATE_ARGUMENTS_H
diff --git a/clang/lib/DPCT/DPCT.cpp b/clang/lib/DPCT/DPCT.cpp
@@ -139,6 +139,7 @@ static llvm::cl::opt<AutoCompletePrinter, true, llvm::cl::parser<std::string>> A
 // TODO: implement one of this for each source language.
 UnifiedPath CudaPath;
 UnifiedPath DpctInstallPath;
+
 std::unordered_map<std::string, bool> ChildOrSameCache;
 std::unordered_map<std::string, bool> ChildPathCache;
 std::unordered_map<std::string, bool> IsDirectoryCache;
@@ -1066,7 +1067,7 @@ int runDPCT(int argc, const char **argv) {
     DpctGlobalInfo::setExcludePath(ExcludePathList);
   }
 
-  std::set<ExplicitNamespace> ExplicitNamespaces;
+  std::set<clang::dpct::ExplicitNamespace> ExplicitNamespaces;
   if (UseExplicitNamespace.getNumOccurrences()) {
     ExplicitNamespaces.insert(UseExplicitNamespace.begin(),
                               UseExplicitNamespace.end());
diff --git a/clang/lib/DPCT/Diagnostics/Diagnostics.h b/clang/lib/DPCT/Diagnostics/Diagnostics.h
@@ -27,7 +27,7 @@
 
 extern clang::dpct::DpctOption<clang::dpct::list, std::string> SuppressWarnings;
 extern clang::dpct::DpctOption<clang::dpct::opt, std::string> OutputFile;
-extern clang::dpct::DpctOption<clang::dpct::opt, OutputVerbosityLevel> OutputVerbosity;
+extern clang::dpct::DpctOption<clang::dpct::opt, clang::dpct::OutputVerbosityLevel> OutputVerbosity;
 extern clang::dpct::DpctOption<clang::dpct::opt, bool> SuppressWarningsAll;
 
 namespace clang {
diff --git a/clang/lib/DPCT/ErrorHandle/Error.cpp b/clang/lib/DPCT/ErrorHandle/Error.cpp
@@ -247,5 +247,28 @@ std::string getCheckVersionFailWarning() {
          "details.\n";
 }
 
+bool IsUsingDefaultOutRoot = false;
+
+void removeDefaultOutRootFolder(const clang::tooling::UnifiedPath &DefaultOutRoot) {
+  if (isDirectory(DefaultOutRoot)) {
+    std::error_code EC;
+    llvm::sys::fs::directory_iterator Iter(DefaultOutRoot.getCanonicalPath(), EC);
+    if ((bool)EC)
+      return;
+    llvm::sys::fs::directory_iterator End;
+    if (Iter == End) {
+      // This folder is empty, then remove it.
+      llvm::sys::fs::remove_directories(DefaultOutRoot.getCanonicalPath(), false);
+    }
+  }
+}
+
+void dpctExit(int ExitCode, bool NeedCleanUp) {
+  if (IsUsingDefaultOutRoot && NeedCleanUp) {
+    removeDefaultOutRootFolder(dpct::DpctGlobalInfo::getOutRoot());
+  }
+  std::exit(ExitCode);
+}
+
 } // namespace dpct
 } // namespace clang
diff --git a/clang/lib/DPCT/ErrorHandle/Error.h b/clang/lib/DPCT/ErrorHandle/Error.h
@@ -75,6 +75,12 @@ namespace dpct {
 void ShowStatus(int Status, std::string Message = "");
 std::string getLoadYamlFailWarning(const clang::tooling::UnifiedPath& YamlPath);
 std::string getCheckVersionFailWarning();
+
+extern bool IsUsingDefaultOutRoot;
+void removeDefaultOutRootFolder(const clang::tooling::UnifiedPath &DefaultOutRoot);
+void dpctExit(int ExitCode, bool NeedCleanUp = true);
+
+
 } // namespace dpct
 } // namespace clang
 
diff --git a/clang/lib/DPCT/FileGenerator/GenFiles.cpp b/clang/lib/DPCT/FileGenerator/GenFiles.cpp
@@ -50,8 +50,29 @@ UnifiedPath getFormatSearchPath();
 } // namespace tooling
 } // namespace clang
 
+
 extern std::map<std::string, uint64_t> ErrorCnt;
 
+/// Calculate the ranges of the input \p Ranges after \p Repls is applied to
+/// the files.
+/// \param Repls Replacements to apply.
+/// \param Ranges Ranges before applying the replacements.
+/// \return The result ranges.
+std::vector<clang::tooling::Range>
+calculateUpdatedRanges(const clang::tooling::Replacements &Repls,
+                       const std::vector<clang::tooling::Range> &Ranges) {
+  std::vector<clang::tooling::Range> Result;
+  for (const auto &R : Ranges) {
+    unsigned int BOffset = Repls.getShiftedCodePosition(R.getOffset());
+    unsigned int EOffset =
+        Repls.getShiftedCodePosition(R.getOffset() + R.getLength());
+    if (BOffset > EOffset)
+      continue;
+    Result.emplace_back(BOffset, EOffset - BOffset);
+  }
+  return Result;
+}
+
 static bool formatFile(const clang::tooling::UnifiedPath &FileName,
                        const std::vector<clang::tooling::Range> &Ranges,
                        clang::tooling::Replacements &FormatChanges) {
diff --git a/clang/lib/DPCT/IncMigration/IncrementalMigrationUtility.h b/clang/lib/DPCT/IncMigration/IncrementalMigrationUtility.h
@@ -13,8 +13,6 @@
 #include <set>
 #include <string>
 
-enum class ExplicitNamespace : unsigned int;
-
 namespace clang {
 namespace dpct {
 
diff --git a/clang/lib/DPCT/MigrateScript/MigrateBuildScript.cpp b/clang/lib/DPCT/MigrateScript/MigrateBuildScript.cpp
@@ -13,6 +13,9 @@ using namespace clang::dpct;
 
 namespace fs = llvm::sys::fs;
 
+namespace clang {
+namespace dpct {
+
 std::string readFile(const clang::tooling::UnifiedPath &Name) {
   std::ifstream Stream(Name.getCanonicalPath().str(),
                        std::ios::in | std::ios::binary);
@@ -269,3 +272,6 @@ void unifyInputFileFormat(
     ScriptFileCRLFMap[Entry.first] = IsCRLF;
   }
 }
+
+} // namespace dpct
+} // namespace clang
diff --git a/clang/lib/DPCT/MigrateScript/MigrateBuildScript.h b/clang/lib/DPCT/MigrateScript/MigrateBuildScript.h
@@ -14,6 +14,8 @@
 #include "clang/Tooling/Core/UnifiedPath.h"
 
 #include <map>
+namespace clang {
+namespace dpct {
 
 std::string readFile(const clang::tooling::UnifiedPath &Name);
 std::vector<std::string> split(const std::string &Input,
@@ -49,4 +51,9 @@ void unifyInputFileFormat(
     std::map<clang::tooling::UnifiedPath, std::string>
         &BuildScriptFileBufferMap,
     std::map<clang::tooling::UnifiedPath, bool> &ScriptFileCRLFMap);
-#endif
+
+
+} // namespace dpct
+} // namespace clang
+
+#endif //!DPCT_MIGRATE_BUILD_SCRIPT_H
diff --git a/clang/lib/DPCT/RuleInfra/MapNames.cpp b/clang/lib/DPCT/RuleInfra/MapNames.cpp
@@ -19,6 +19,10 @@ using namespace clang;
 using namespace clang::dpct;
 // Not use sycl:: namespace explicitly
 // KeepNamespace = false/true --> ""/"sycl::"
+
+namespace clang {
+namespace dpct {
+
 std::vector<std::string> MapNames::ClNamespace;
 // Not use dpct:: namespace explicitly
 // KeepNamespace = false/true --> ""/"dpct::"
@@ -4802,3 +4806,7 @@ const std::unordered_map<std::string, HelperFeatureEnum>
         {"channel_type", HelperFeatureEnum::device_ext},
         {"sampler", HelperFeatureEnum::device_ext},
 };
+
+
+} // namespace dpct
+} // namespace clang
diff --git a/clang/lib/DPCT/RuleInfra/MapNames.h b/clang/lib/DPCT/RuleInfra/MapNames.h
@@ -18,15 +18,11 @@
 namespace clang {
 namespace dpct {
 enum class KernelArgType;
-enum class HelperFileEnum : unsigned int;
-struct HelperFunc;
 enum class HelperFuncCatalog {
   GetDefaultQueue,
   GetOutOfOrderQueue,
   GetInOrderQueue,
 };
-} // namespace dpct
-} // namespace clang
 
 const std::string StringLiteralUnsupported{"UNSUPPORTED"};
 
@@ -446,4 +442,6 @@ class MigrationStatistics {
   static std::map<std::string, bool> &GetTypeTable(void);
 };
 
+} // namespace dpct
+} // namespace clang
 #endif
diff --git a/clang/lib/DPCT/RuleInfra/TypeLocRewriters.cpp b/clang/lib/DPCT/RuleInfra/TypeLocRewriters.cpp
@@ -118,7 +118,7 @@ inline auto CheckForPostfixDeclaratorType(unsigned Idx) {
     if (const auto TSTL = TL.getAs<TemplateSpecializationTypeLoc>()) {
       const auto TAT = TSTL.getArgLoc(Idx).getArgument().getAsType();
       const auto CT = TAT.getCanonicalType();
-      return typeIsPostfix(CT);
+      return isTypePostfix(CT);
     }
     return false;
   };
diff --git a/clang/lib/DPCT/RulesLang/RulesLang.cpp b/clang/lib/DPCT/RulesLang/RulesLang.cpp
@@ -617,7 +617,7 @@ void ErrorHandlingHostAPIRule::runRule(const MatchFinder::MatchResult &Result) {
   // For each reference of TD, check if the location is after CE,
   // if yes, add try catch.
   std::vector<const DeclRefExpr *> Refs;
-  VarReferencedInFD(FD->getBody(), TD, Refs);
+  getVarReferencedInFD(FD->getBody(), TD, Refs);
   SourceManager &SM = DpctGlobalInfo::getSourceManager();
   auto CallLoc = SM.getExpansionLoc(CE->getBeginLoc());
   for (auto It = Refs.begin(); It != Refs.end(); ++It) {
@@ -6502,7 +6502,7 @@ void MemoryMigrationRule::mallocMigrationWithTransformation(
 
 /// e.g., for int *a and cudaMalloc(&a, size), print "a = ".
 /// If \p DerefType is not null, assign a string "int *".
-void printDerefOp(std::ostream &OS, const Expr *E, std::string *DerefType) {
+void clang::dpct::printDerefOp(std::ostream &OS, const Expr *E, std::string *DerefType) {
   E = E->IgnoreImplicitAsWritten();
   bool NeedDerefOp = true;
   if (auto UO = dyn_cast<UnaryOperator>(E)) {
diff --git a/clang/lib/DPCT/RulesLangLib/CUBAPIMigration.cpp b/clang/lib/DPCT/RulesLangLib/CUBAPIMigration.cpp
@@ -49,6 +49,7 @@
 
 using namespace clang;
 using namespace dpct;
+using namespace clang::dpct;
 using namespace tooling;
 using namespace ast_matchers;
 
diff --git a/clang/lib/DPCT/UserDefinedRules/PatternRewriter.cpp b/clang/lib/DPCT/UserDefinedRules/PatternRewriter.cpp
@@ -25,6 +25,10 @@
 #include <variant>
 #include <vector>
 
+
+namespace clang {
+namespace dpct {
+
 std::set<std::string> MainSrcFilesHasCudaSyntex;
 bool LANG_Cplusplus_20_Used = false;
 
@@ -867,3 +871,6 @@ std::string applyPatternRewriter(const MetaRuleObject::PatternRewriter &PP,
   }
   return OutputStream.str();
 }
+
+} // namespace dpct
+} // namespace clang
diff --git a/clang/lib/DPCT/UserDefinedRules/PatternRewriter.h b/clang/lib/DPCT/UserDefinedRules/PatternRewriter.h
@@ -14,6 +14,8 @@
 
 #include "UserDefinedRules/UserDefinedRules.h"
 
+namespace clang {
+namespace dpct {
 std::string
 applyPatternRewriter(const MetaRuleObject::PatternRewriter &PP,
                      const std::string &Input, std::string FileName = "",
@@ -27,4 +29,8 @@ void setFileTypeProcessed(enum SourceFileType FileType);
 
 extern std::set<std::string> MainSrcFilesHasCudaSyntex;
 extern bool LANG_Cplusplus_20_Used;
+
+} // namespace dpct
+} // namespace clang
+
 #endif // DPCT_PATTERN_REWRITER_H
diff --git a/clang/lib/DPCT/Utility.cpp b/clang/lib/DPCT/Utility.cpp
diff --git a/clang/lib/DPCT/Utility.h b/clang/lib/DPCT/Utility.h
diff --git a/clang/lib/DPCT/Windows/VcxprojParser.cpp b/clang/lib/DPCT/Windows/VcxprojParser.cpp
diff --git a/clang/lib/DPCT/Windows/VcxprojParser.h b/clang/lib/DPCT/Windows/VcxprojParser.h
