DEBUGMSG - Revision history

Wes: /* DEBUGMSGTL */

2010-06-22T14:51:18Z

‎DEBUGMSGTL

Wes: /* DEBUG */

2010-06-22T14:50:41Z

‎DEBUG

Wes at 14:47, 22 June 2010

2010-06-22T14:47:30Z

New page

If you want to add [[Debugging output]] statements to your own code, you can use the following conventions:

== DEBUGMSGTL ==

DEBUGMSGTL(("token", "statement of some kind: %s\n", "with printf arguments"));

This actually outputs two lines:
* A "trace" line showing where in the source it came from (that's what the T stands for)
* Your debugging line (when -Dtoken is turned on)

This should be the most common debugging statement used. It should be used for complete debugging lines.

== DEBUG ==

For creating lines a piece at a time, start with DEBUGMSGTL followed by DEBUGMSG macros until you hit the newline ("\n"). This is a stupid example but shows how it works:

int total = 0;
DEBUGMSGTL(("token", "Calculating something: "));
for(int i = 0; i < 5; i++) {
total = total + i;

@@ Line 3: / Line 3: @@
 == DEBUGMSGTL ==
-DEBUGMSGTL(("token", "statement of some kind: %s\n", "with printf arguments"));
+'''Note the double (( ))s in these statements!'''
 This actually outputs two lines:

@@ Line 11: / Line 11: @@
 This should be the most common debugging statement used.  It should be used for complete debugging lines.
-== DEBUG ==
+== DEBUGMSG ==
 For creating lines a piece at a time, start with DEBUGMSGTL followed by DEBUGMSG macros until you hit the newline ("\n").  This is a stupid example but shows how it works:
    int total = 0;
-   DEBUGMSGTL(("token", "Calculating something: "));
+   DEBUGMSGTL(("token", "Calculating running total: "));
    for(int i = 0; i < 5; i++) {
       total = total + i;