8.4 Debugging

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199

/*

Local-only debug printing for contest code. The macro expands to a no-op unless `LOCAL` is defined
(e.g. by passing `-DLOCAL` to the compiler flags), so it can remain in submitted code without
producing output.

- `dbg_repr(x)` returns a string representation of arithmetic types, strings, pairs, tuples,
  iterable containers, and custom types that support insertion into `std::ostream`.
- `dbg(a, b, c)` prints the function name, line number, argument names, and values to `std::cerr`
  when `LOCAL` is defined.
- `pr(a, b, c)` prints only the values to `std::cerr` when `LOCAL` is defined.
- `dbg(...)` evaluates to no output when `LOCAL` is not defined.
- `pr(...)` evaluates to no output when `LOCAL` is not defined.

Avoid naming these helpers `to_string()` unless you want them mixed into overload resolution with
`std::to_string()` and other user-defined `to_string()` functions. A separate name keeps debug
formatting local to this snippet.

*/

#include <cstddef>
#include <iomanip>
#include <iostream>
#include <sstream>
#include <string>
#include <tuple>
#include <type_traits>
#include <utility>

template<typename T, typename = void>
struct is_iterable : std::false_type {};

template<typename T>
struct is_iterable<
    T, std::void_t<decltype(std::begin(std::declval<T>())), decltype(std::end(std::declval<T>()))>>
    : std::true_type {};

template<typename T, typename = void>
struct is_streamable : std::false_type {};

template<typename T>
struct is_streamable<
    T, std::void_t<decltype(std::declval<std::ostream &>() << std::declval<const T &>())>>
    : std::true_type {};

// clang-format off
std::string dbg_repr(const std::string &s) { return '"' + s + '"'; }
std::string dbg_repr(const char *s) { return dbg_repr(std::string(s)); }
std::string dbg_repr(char c) { return std::string("'") + c + "'"; }
std::string dbg_repr(bool b) { return b ? "true" : "false"; }
// clang-format on

template<typename T>
typename std::enable_if<
    std::is_arithmetic<T>::value && !std::is_same<T, char>::value &&
        !std::is_same<T, bool>::value && !std::is_floating_point<T>::value,
    std::string>::type
dbg_repr(T x) {
  std::ostringstream out;
  out << x;
  return out.str();
}

template<typename T>
typename std::enable_if<std::is_floating_point<T>::value, std::string>::type dbg_repr(T x) {
  std::ostringstream out;
  out << std::setprecision(10) << x;  // Set floating point dbg precision here.
  return out.str();
}

template<typename T>
typename std::enable_if<
    is_streamable<T>::value && !is_iterable<T>::value && !std::is_arithmetic<T>::value &&
        !std::is_convertible<T, std::string>::value,
    std::string>::type
dbg_repr(const T &x) {
  std::ostringstream out;
  out << x;
  return out.str();
}

template<typename A, typename B>
std::string dbg_repr(const std::pair<A, B> &p) {
  return "(" + dbg_repr(p.first) + ", " + dbg_repr(p.second) + ")";
}

template<typename Tuple, std::size_t... Is>
std::string dbg_tuple_repr(const Tuple &t, std::index_sequence<Is...>) {
  std::string res = "(";
  bool first = true;
  ((res += (first ? (first = false, "") : ", ") + dbg_repr(std::get<Is>(t))), ...);
  return res + ")";
}

template<typename... Ts>
std::string dbg_repr(const std::tuple<Ts...> &t) {
  return dbg_tuple_repr(t, std::index_sequence_for<Ts...>{});
}

template<typename T>
typename std::enable_if<
    is_iterable<T>::value && !std::is_convertible<T, std::string>::value, std::string>::type
dbg_repr(const T &v) {
  std::string res = "{";
  bool first = true;
  for (const auto &x : v) {
    if (!first) {
      res += ", ";
    }
    first = false;
    res += dbg_repr(x);
  }
  return res + "}";
}

template<typename Head, typename... Tail>
void dbg_out(bool leading_space, const Head &head, const Tail &...tail) {
  if (leading_space) {
    std::cerr << ' ';
  }
  std::cerr << dbg_repr(head);
  ((std::cerr << ' ' << dbg_repr(tail)), ...);
  std::cerr << '\n';
}

#ifdef LOCAL
#define dbg(...)                                                                  \
  std::cerr << "[" << __func__ << ":" << __LINE__ << "] " << #__VA_ARGS__ << ":", \
      dbg_out(true, __VA_ARGS__)
#define pr(...) dbg_out(false, __VA_ARGS__)
#else
#define dbg(...) ((void)0)
#define pr(...) ((void)0)
#endif

/*** Example Usage and Output:

[main:166] v: {1, 2, 3}
[main:167] p, t, mp: (4, "x") (1, true, "ok") {("a", 1), ("b", 2)}
[main:168] pt, e: Point(2, 3) Edge{0->1, w=5}
"plain output" 3.141592654

***/

#include <cassert>
#include <map>
#include <set>
#include <vector>
using namespace std;

struct Point {
  int x, y;
};

// Can overload dbg_repr to dbg your custom structs.
string dbg_repr(const Point &p) {
  return "Point(" + dbg_repr(p.x) + ", " + dbg_repr(p.y) + ")";
}

struct Edge {
  int u, v, w;
};

string dbg_repr(const Edge &e) {
  return "Edge{" + dbg_repr(e.u) + "->" + dbg_repr(e.v) + ", w=" + dbg_repr(e.w) + "}";
}

struct Streamable {
  int value;

  friend ostream &operator<<(ostream &out, const Streamable &x) {
    return out << "Streamable(" << x.value << ")";
  }
};

int main() {
  vector<int> v = {1, 2, 3};
  auto p = make_pair(4, string("x"));
  auto t = make_tuple(1, true, string("ok"));
  map<string, int> mp = {{"a", 1}, {"b", 2}};
  Point pt{2, 3};
  Edge e{0, 1, 5};
  assert(dbg_repr(v) == "{1, 2, 3}");
  assert(dbg_repr(p) == "(4, \"x\")");
  assert(dbg_repr(t) == "(1, true, \"ok\")");
  assert(dbg_repr(mp) == "{(\"a\", 1), (\"b\", 2)}");
  assert(dbg_repr(pt) == "Point(2, 3)");
  assert(dbg_repr(e) == "Edge{0->1, w=5}");
  assert(dbg_repr(Streamable{6}) == "Streamable(6)");
  assert(dbg_repr(vector<Streamable>{{7}, {8}}) == "{Streamable(7), Streamable(8)}");
  double d = 3.141592653589793;
  dbg(v);
  dbg(p, t, mp);
  dbg(pt, e);
  pr("plain output", d);
  assert(dbg_repr(1.0 / 3.0) == "0.3333333333");
  assert(dbg_repr(d) == "3.141592654");
  return 0;
}