Fix problems with some complex macros

When two decls get generated by the same macro, TargetCode compared the
spelling location of their generated source fragments and not their
expanded location. This resulted in TargetCode not adding more than once
function generated from a macro.

Author: manorom

clang/tools/sotoc/src/Debug.h

@@ -23,7 +23,7 @@ extern int SotocDebugLevel;
 #define DEBUGP(...)                            \
   do {                                         \
     if (SotocDebugLevel > 0) {                 \
-      llvm::errs() << "Sotoc: " << llvm::formatv(__VA_ARGS__);  \
+      llvm::errs() << "Sotoc: " << __VA_ARGS__;  \
       llvm::errs() << "\n";                    \
     }                                          \
   } while (false)

clang/tools/sotoc/src/DeclResolver.cpp

@@ -65,6 +65,8 @@ void DeclResolver::addDecl(clang::Decl *D) {
     return;
   }
 
+  DEBUGPDECL(D, "Add declaration to resolver: ");
+
   std::unordered_set<clang::Decl *> UnresolvedDecls;
   UnresolvedDecls.insert(D);
 
@@ -161,9 +163,11 @@ void DeclResolver::orderAndAddFragments(TargetCode &TC) {
     if (!AllDecls.at(orderStack.top()).IsFromSystemHeader) {
       auto codeDecl = std::make_shared<TargetCodeDecl>(orderStack.top());
 
+      DEBUGPDECL(orderStack.top(), "Generating Fragment for Decl: ");
       // TODO: this wont hurt but is not always necessary
       codeDecl->NeedsSemicolon = true;
-      TC.addCodeFragmentFront(codeDecl);
+      bool added = TC.addCodeFragmentFront(codeDecl);
+      DEBUGP("Decl was a duplicate: " << !added);
     }
     orderStack.pop();
   }

clang/tools/sotoc/src/TargetCode.cpp

@@ -75,7 +75,7 @@ void TargetCode::generateCode(llvm::raw_ostream &Out) {
 
     // This is a workaround, since "Decl::print" includes "pragma omp declare".
     if (PrettyCode != "")
-      TargetCodeRewriter.ReplaceText(Frag->getInnerRange(), PrettyCode);
+      TargetCodeRewriter.ReplaceText(Frag->getSpellingRange(), PrettyCode);
 
     if (TCR) {
       generateFunctionPrologue(TCR);
@@ -85,7 +85,7 @@ void TargetCode::generateCode(llvm::raw_ostream &Out) {
       generateFunctionEpilogue(TCR);
     }
     Out << "\n";
-    Out << TargetCodeRewriter.getRewrittenText(Frag->getInnerRange());
+    Out << TargetCodeRewriter.getRewrittenText(Frag->getSpellingRange());
 
     if (Frag->NeedsSemicolon) {
       Out << ";";

clang/tools/sotoc/src/TargetCodeFragment.cpp

@@ -156,6 +156,13 @@ clang::SourceRange TargetCodeRegion::getRealRange() {
   return CapturedStmtNode->getSourceRange();
 }
 
+clang::SourceRange TargetCodeRegion::getSpellingRange() {
+  auto &SM = CapturedStmtNode->getCapturedDecl()->getASTContext().getSourceManager();
+  auto InnerRange = getInnerRange();
+  return clang::SourceRange(SM.getSpellingLoc(InnerRange.getBegin()),
+                            SM.getSpellingLoc(InnerRange.getEnd()));
+}
+
 clang::SourceRange TargetCodeRegion::getInnerRange() {
   auto InnerLocStart = getStartLoc();
   auto InnerLocEnd = getEndLoc();
@@ -428,9 +435,17 @@ std::string TargetCodeRegion::PrintPretty() {
 clang::SourceRange TargetCodeDecl::getRealRange() {
   // return DeclNode->getSourceRange();
   // return DeclNode->getSourceRange();
+  //auto &SM = DeclNode->getASTContext().getSourceManager();
+  //return clang::SourceRange(SM.getSpellingLoc(DeclNode->getBeginLoc()),
+  //                          SM.getSpellingLoc(DeclNode->getEndLoc()));
+  return DeclNode->getSourceRange();
+}
+
+clang::SourceRange TargetCodeDecl::getSpellingRange() {
   auto &SM = DeclNode->getASTContext().getSourceManager();
-  return clang::SourceRange(SM.getSpellingLoc(DeclNode->getBeginLoc()),
-                            SM.getSpellingLoc(DeclNode->getEndLoc()));
+  auto InnerRange = getInnerRange();
+  return clang::SourceRange(SM.getSpellingLoc(InnerRange.getBegin()),
+                            SM.getSpellingLoc(InnerRange.getEnd()));
 }
 
 std::string TargetCodeDecl::PrintPretty() {

clang/tools/sotoc/src/TargetCodeFragment.h

@@ -83,6 +83,9 @@ class TargetCodeFragment {
   /// Gets the 'inner' source range. This can differ for target regions from the
   /// source range.
   virtual clang::SourceRange getInnerRange() { return getRealRange(); };
+  /// Get the spelling source range. That is the range without macro
+  /// expansions.
+  virtual clang::SourceRange getSpellingRange() = 0;
   /// Accessor to TargetCodeKind
   clang::OpenMPDirectiveKind getTargetCodeKind() { return TargetCodeKind; };
 };
@@ -140,6 +143,7 @@ class TargetCodeRegion : public TargetCodeFragment {
   virtual std::string PrintPretty() override;
   clang::SourceRange getRealRange() override;
   clang::SourceRange getInnerRange() override;
+  clang::SourceRange getSpellingRange() override;
   /// Returns a source location at the start of a pragma in the captured
   /// statment.
   clang::SourceLocation getStartLoc();
@@ -174,4 +178,5 @@ class TargetCodeDecl : public TargetCodeFragment {
 
   virtual std::string PrintPretty() override;
   clang::SourceRange getRealRange() override;
+  clang::SourceRange getSpellingRange() override;
 };

clang/tools/sotoc/src/main.cpp

@@ -72,6 +72,7 @@ class SourceTransformAction : public clang::ASTFrontendAction {
     // std::error_code error_code;
     // llvm::raw_fd_ostream outFile("output.txt", error_code,
     // llvm::sys::fs::F_Append);
+    DEBUGP("Generating Code§");
     Code->generateCode(llvm::outs());
     // outFile.close();
     delete Code;