refactor: rename variables, remove unused headers

Signed-off-by: Nitish <snapdgnn@proton.me>
p4lang · Aug 26, 2024 · b87606d · b87606d
1 parent e9f53dc
commit b87606d
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 12 deletions.
diff --git a/backends/p4fmt/attach.cpp b/backends/p4fmt/attach.cpp
@@ -35,9 +35,9 @@ const IR::Node *Attach::attachCommentsToNode(IR::Node *node, TraversalType ttype
 
     const auto nodeStart = node->srcInfo.getStart();
 
-    for (auto &[comment, isVisited] : processedComments) {
+    for (auto &[comment, isAttached] : processedComments) {
         // Skip if already attached
-        if (isVisited) {
+        if (isAttached) {
             continue;
         }
 
@@ -47,14 +47,14 @@ const IR::Node *Attach::attachCommentsToNode(IR::Node *node, TraversalType ttype
             case TraversalType::Preorder:
                 if (commentEnd.getLineNumber() == nodeStart.getLineNumber() - 1) {
                     addPrefixComments(node->id, comment);
-                    isVisited = true;  // Mark the comment as attached
+                    isAttached = true;  // Mark the comment as attached
                 }
                 break;
 
             case TraversalType::Postorder:
                 if (commentEnd.getLineNumber() == nodeStart.getLineNumber()) {
                     addSuffixComments(node->id, comment);
-                    isVisited = true;
+                    isAttached = true;
                 }
                 break;
 

diff --git a/backends/p4fmt/attach.h b/backends/p4fmt/attach.h
@@ -1,12 +1,10 @@
 #ifndef BACKENDS_P4FMT_ATTACH_H_
 #define BACKENDS_P4FMT_ATTACH_H_
 
+#include <filesystem>
 #include <unordered_map>
-#include <unordered_set>
 #include <vector>
 
-#include "backends/p4fmt/p4fmt.h"
-#include "ir/ir.h"
 #include "ir/visitor.h"
 #include "lib/source_file.h"
 
@@ -22,7 +20,7 @@ class Attach : public Transform {
     using CommentsMap = std::unordered_map<NodeId, Comments>;
     enum class TraversalType { Preorder, Postorder };
 
-    explicit Attach(const std::unordered_map <const Util::Comment *, bool> &processedComments)
+    explicit Attach(const std::unordered_map<const Util::Comment *, bool> &processedComments)
         : processedComments(processedComments){};
     ~Attach() override;
 
@@ -41,7 +39,11 @@ class Attach : public Transform {
     const CommentsMap &getCommentsMap() const;
 
  private:
+    // This map associates each comment with a boolean value that tracks whether the comment
+    // has been processed for attachment to IR nodes. Initially, all comments are set to 'false',
+    // indicating that they have not yet been processed.
     std::unordered_map<const Util::Comment *, bool> processedComments;
+
     CommentsMap commentsMap;
 };
 

diff --git a/backends/p4fmt/p4fmt.cpp b/backends/p4fmt/p4fmt.cpp
@@ -28,14 +28,12 @@ std::stringstream getFormattedOutput(std::filesystem::path inputFile) {
     std::unordered_map<const Util::Comment *, bool> globalCommentsMap;
 
     // Initialize the global comments map from the list of comments in the program.
-    // The map associates each comment with a boolean value that tracks whether the comment
-    // has been processed for attachment to IR nodes. Initially, all comments are set to 'false',
-    // indicating that they have not yet been processed.
     if (!program->objects.empty()) {
         const auto *firstNode = program->objects.front();
         if (firstNode->srcInfo.isValid()) {
             for (const auto *comment : firstNode->srcInfo.getAllFileComments()) {
-                globalCommentsMap[comment] = false;  // Initialize all comments as not visited
+                globalCommentsMap[comment] =
+                    false;  // Initialize all comments as not yet attached to nodes
             }
         }
     }