commit 0093e2bb083b0c61a8b8d25f4a25914fa88ea5b8
author Jean Perier <jperier@nvidia.com> Thu Sep 30 23:16:29 2021 +0200
committer Copybara-Service <copybara-worker@google.com> Thu Sep 30 14:30:21 2021 -0700
tree 6bf615d29f890530796647a756a092364fdffdea
parent 5cba5c9dd991842052d8276cdacd707038db2b8b

[flang][NFC] Add debug dump method to evaluate::Expr and semantics::Symbol

Helps debugging when working with symbol/expression issue. The dump
method is easy to call in the debugger.

Co-authored-by: Eric Schweitz <eschweitz@nvidia.com>

Differential Revision: https://reviews.llvm.org/D110856

GitOrigin-RevId: fdcbb540fc5ffbf5faa03c2f10fa88ca2c38f845

include/flang/Evaluate/expression.h

diff --git a/include/flang/Evaluate/expression.h b/include/flang/Evaluate/expression.h
index ea68f6e..c33c242 100644
--- a/include/flang/Evaluate/expression.h
+++ b/include/flang/Evaluate/expression.h
@@ -93,6 +93,9 @@
   std::optional<DynamicType> GetType() const;
   int Rank() const;
   std::string AsFortran() const;
+#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
+  LLVM_DUMP_METHOD void dump() const;
+#endif
   llvm::raw_ostream &AsFortran(llvm::raw_ostream &) const;
   static Derived Rewrite(FoldingContext &, Derived &&);
 };

include/flang/Semantics/symbol.h

diff --git a/include/flang/Semantics/symbol.h b/include/flang/Semantics/symbol.h
index b287b91..2282d2b 100644
--- a/include/flang/Semantics/symbol.h
+++ b/include/flang/Semantics/symbol.h
@@ -657,6 +657,9 @@
   const DerivedTypeSpec *GetParentTypeSpec(const Scope * = nullptr) const;
 
   SemanticsContext &GetSemanticsContext() const;
+#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
+  LLVM_DUMP_METHOD void dump() const;
+#endif
 
 private:
   const Scope *owner_;

lib/Evaluate/expression.cpp

diff --git a/lib/Evaluate/expression.cpp b/lib/Evaluate/expression.cpp
index c08e977..576e330 100644
--- a/lib/Evaluate/expression.cpp
+++ b/lib/Evaluate/expression.cpp
@@ -111,6 +111,12 @@
   return left().GetType().value();
 }
 
+#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
+template <typename A> LLVM_DUMP_METHOD void ExpressionBase<A>::dump() const {
+  llvm::errs() << "Expr is <{" << AsFortran() << "}>\n";
+}
+#endif
+
 // Equality testing
 
 bool ImpliedDoIndex::operator==(const ImpliedDoIndex &that) const {

lib/Semantics/symbol.cpp

diff --git a/lib/Semantics/symbol.cpp b/lib/Semantics/symbol.cpp
index 60e4572..78074c3 100644
--- a/lib/Semantics/symbol.cpp
+++ b/lib/Semantics/symbol.cpp
@@ -535,6 +535,10 @@
   return os;
 }
 
+#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
+void Symbol::dump() const { llvm::errs() << *this << '\n'; }
+#endif
+
 // Output a unique name for a scope by qualifying it with the names of
 // parent scopes. For scopes without corresponding symbols, use the kind
 // with an index (e.g. Block1, Block2, etc.).