From 6741866b111371328ad1c70f29fe7a26b837cc4d Mon Sep 17 00:00:00 2001
From: Sriteja Kummita <sriteja.ku@gmail.com>
Date: Fri, 9 Feb 2024 14:17:37 +0100
Subject: [PATCH] more TODOs

---
 .../PhasarLLVM/Utils/SourceMgrPrinter.h       | 22 +++++++------------
 include/phasar/Utils/AnalysisPrinterBase.h    |  5 ++++-
 2 files changed, 12 insertions(+), 15 deletions(-)

diff --git a/include/phasar/PhasarLLVM/Utils/SourceMgrPrinter.h b/include/phasar/PhasarLLVM/Utils/SourceMgrPrinter.h
index 6144086ad..85fe68552 100644
--- a/include/phasar/PhasarLLVM/Utils/SourceMgrPrinter.h
+++ b/include/phasar/PhasarLLVM/Utils/SourceMgrPrinter.h
@@ -12,7 +12,7 @@
 #include <llvm/ADT/StringMap.h>
 #include <llvm/ADT/StringRef.h>
 #include <llvm/Support/SourceMgr.h>
-#include <llvm/Support/raw_ostream.h> // quoting style
+#include <llvm/Support/raw_ostream.h> /// TODO: quoting style
 
 namespace psr {
 template <typename AnalysisDomainTy>
@@ -29,22 +29,16 @@ class SourceMgrPrinter : public AnalysisPrinterBase<AnalysisDomainTy> {
     auto BufIdOpt = getSourceBufId(getFilePathFromIR(Warn.Instr));
     if (BufIdOpt.has_value()) {
       /// TODO: getLineAndColFromIR call only once
-      /// TODO:Configuration options for warning or error
-      SrcMgr.PrintMessage(*OS,
-                          SrcMgr.FindLocForLineAndColumn(
-                              BufIdOpt.value(),
-                              getLineAndColFromIR(Warn.Instr).first,
-                              getLineAndColFromIR(Warn.Instr).second),
-                          llvm::SourceMgr::DK_Warning,
-
-                          GetPrintMessage(Warn.AnalysisType));
+      /// TODO: Configuration options for warning or error
+      SrcMgr.PrintMessage(
+          *OS,
+          SrcMgr.FindLocForLineAndColumn(
+              BufIdOpt.value(), getLineAndColFromIR(Warn.Instr).first,
+              getLineAndColFromIR(Warn.Instr).second),
+          llvm::SourceMgr::DK_Warning, GetPrintMessage(Warn.AnalysisType));
     }
   }
 
-  /// TODO: use non-virtual function to call virtual function with default
-  /// parameters +
-  /// TODO: templace magic - #include "memory_resource"
-
   /// TODO: move this to cpp file and refactor the imports
   std::optional<unsigned> getSourceBufId(llvm::StringRef FileName) {
     if (auto It = FileNameIDMap.find(FileName); It != FileNameIDMap.end()) {
diff --git a/include/phasar/Utils/AnalysisPrinterBase.h b/include/phasar/Utils/AnalysisPrinterBase.h
index 1a90a35f7..101440614 100644
--- a/include/phasar/Utils/AnalysisPrinterBase.h
+++ b/include/phasar/Utils/AnalysisPrinterBase.h
@@ -7,7 +7,7 @@
 
 namespace psr {
 
-// move warning to default analysis printer
+/// TODO: move warning to default analysis printer
 template <typename AnalysisDomainTy> struct Warning {
   using n_t = typename AnalysisDomainTy::n_t;
   using d_t = typename AnalysisDomainTy::d_t;
@@ -27,6 +27,9 @@ template <typename AnalysisDomainTy> struct Warning {
 
 template <typename AnalysisDomainTy> class AnalysisPrinterBase {
 public:
+  /// TODO: use non-virtual function to call virtual function with default
+  /// parameters +
+  /// TODO: templace magic - #include "memory_resource"
   virtual void onResult(Warning<AnalysisDomainTy> /*Warn*/) = 0;
   virtual void onInitialize() = 0;
   virtual void onFinalize() = 0;