C++ front-end: Enable compilation with DEBUG defined [blocks: #1260]

[tautschnig]

Some of the code inside #ifdef DEBUG ... #endif had become stale. Also
perform minor style improvements.

• Each commit message has a non-empty body, explaining why the change was made.
• n/a Methods or procedures I have added are documented, following the guidelines provided in CODING_STANDARD.md.
• n/a The feature or user visible behaviour I have added or modified has been documented in the User Guide in doc/cprover-manual/
• Regression or unit tests are included, or existing tests cover the modified code (in this case I have detailed which ones those are in the commit message).
• n/a My commit message includes data points confirming performance improvements (if claimed).
• My PR is restricted to a single feature or bugfix.
• White-space or formatting changes outside the feature-related changed lines are in commits of their own.

[allredj]

✔️
Passed Diffblue compatibility checks (cbmc commit: c1f7f85).
Build URL: https://travis-ci.com/diffblue/test-gen/builds/106530275