Add more logging to polysat (#5186)

* Add polysat logging support

* Don't really need the usual log levels

* Indent log headings

* Add display method to ptr_vector

* Add some logging to solver

* Use __FUNCSIG__ on MSVC

src/math/polysat/log.h

@@ -0,0 +1,106 @@
+#ifndef POLYSAT_LOG_HPP
+#define POLYSAT_LOG_HPP
+
+
+// By default, enable logging only in debug mode
+#ifndef POLYSAT_LOGGING_ENABLED
+#   ifndef NDEBUG
+#       define POLYSAT_LOGGING_ENABLED 1
+#   else
+#       define POLYSAT_LOGGING_ENABLED 0
+#   endif
+#endif
+
+
+#if POLYSAT_LOGGING_ENABLED
+
+
+#include <cstdint>
+#include <iostream>
+#include <string>
+
+class polysat_log_indent
+{
+  int m_amount;
+public:
+  polysat_log_indent(int amount);
+  ~polysat_log_indent();
+};
+
+/// Lower log level means more important
+enum class LogLevel : int {
+  None = 0,
+  Heading1 = 1,
+  Heading2 = 2,
+  Heading3 = 3,
+  Default = 4,
+  Verbose = 5,
+};
+
+/// Filter log messages
+bool
+polysat_should_log(LogLevel msg_level, std::string fn, std::string pretty_fn);
+
+std::pair<std::ostream&, bool>
+polysat_log(LogLevel msg_level, std::string fn, std::string pretty_fn);
+
+#ifdef _MSC_VER
+#define __PRETTY_FUNCTION__ __FUNCSIG__
+#endif
+
+#define LOG_(lvl, x)                                               \
+  do {                                                             \
+    if (polysat_should_log(lvl, __func__, __PRETTY_FUNCTION__)) {  \
+      auto pair = polysat_log(lvl, __func__, __PRETTY_FUNCTION__); \
+      std::ostream& os = pair.first;                               \
+      bool should_reset = pair.second;                             \
+      os << x;                                                     \
+      if (should_reset) {                                          \
+        os << "\x1B[0m"; /* reset color */                         \
+      }                                                            \
+      os << std::endl;                                             \
+    }                                                              \
+  } while (false)
+
+#define LOG_CONCAT_HELPER(a,b) a ## b
+#define LOG_CONCAT(a,b) LOG_CONCAT_HELPER(a,b)
+
+#define LOG_INDENT(lvl, x)  \
+  LOG_(lvl, x);             \
+  polysat_log_indent LOG_CONCAT(polysat_log_indent_obj_, __LINE__) (4);
+
+#define LOG_H1(x) LOG_INDENT(LogLevel::Heading1, x)
+#define LOG_H2(x) LOG_INDENT(LogLevel::Heading2, x)
+#define LOG_H3(x) LOG_INDENT(LogLevel::Heading3, x)
+#define LOG(x)    LOG_(LogLevel::Default , x)
+#define LOG_V(x)  LOG_(LogLevel::Verbose , x)
+
+#define IF_LOGGING(x) \
+  do {                \
+    x;                \
+  } while (false)
+
+
+#else  // POLYSAT_LOGGING_ENABLED
+
+
+#define LOG_(lvl, x)  \
+  do {               \
+    /* do nothing */ \
+  } while (false)
+
+#define LOG_H1(x) LOG_(0, x)
+#define LOG_H2(x) LOG_(0, x)
+#define LOG_H3(x) LOG_(0, x)
+#define LOG(x)    LOG_(0, x)
+#define LOG_V(x)  LOG_(0, x)
+
+#define IF_LOGGING(x) \
+  do {                \
+    /* do nothing */  \
+  } while (false)
+
+#endif  // POLYSAT_LOGGING_ENABLED
+
+
+#endif  // POLYSAT_LOG_HPP