A Java Debugging Template

#	User	Rating
1	tourist	4009
2	jiangly	3821
3	Benq	3736
4	Radewoosh	3631
5	jqdai0815	3620
6	orzdevinwang	3529
7	ecnerwala	3446
8	Um_nik	3396
9	ksun48	3388
10	gamegame	3386

#	User	Contrib.
1	cry	164
1	maomao90	164
3	Um_nik	163
4	atcoder_official	161
5	-is-this-fft-	158
6	awoo	157
7	adamant	156
8	TheScrasse	154
8	nor	154
10	Dominater069	153

Hello CodeForces,
due to the lack of a debugging template in Java (and really just any template in Java), I have decided to write my own template. To use it, add -DLOCAL to your custom VM Parameters. Note that you must use LOCAL = System.getProperty("ONLINE_JUDGE")==null; for CodeForces; this is not necessary for other OJs. Then call dbg(what you want to print) to print the "what you want to print" part to stderr.

To be more exact, when calling dbg(), It will print "Line #%d: [%s]" to stderr, where %d is the line number where you called dbg() and %s is the parameters, separated by commas. For each parameter, if it is able to be iterated using a for each loop (e.g. an array or some class implementing Iterable), it will be printed as {%s} where %s is each element printed, recursively, separated by commas. Otherwise, the .toString() method will be used.

Unfortunately, there is no way to get the names of the variables passed into the parameters of a method in Java, so I'd recommend calling dbg("variable_name", variable) to make it easier to read.

The code is not very clean (mainly due to the fact that arrays can't be cast to Iterable and because primitives can't be used in parametized methods). Please comment below if you have any suggestions or additions to the template (e.g. a class which this dbg method fails to print properly). I'll try to keep the code updated to the best of my ability.

Code

public static class Debug {
	//change to System.getProperty("ONLINE_JUDGE")==null; for CodeForces
	public static final boolean LOCAL = System.getProperty("LOCAL")!=null;
	private static <T> String ts(T t) {
		if(t==null) {
			return "null";
		}
		try {
			return ts((Iterable) t);
		}catch(ClassCastException e) {
			if(t instanceof int[]) {
				String s = Arrays.toString((int[]) t);
				return "{"+s.substring(1, s.length()-1)+"}";
			}else if(t instanceof long[]) {
				String s = Arrays.toString((long[]) t);
				return "{"+s.substring(1, s.length()-1)+"}";
			}else if(t instanceof char[]) {
				String s = Arrays.toString((char[]) t);
				return "{"+s.substring(1, s.length()-1)+"}";
			}else if(t instanceof double[]) {
				String s = Arrays.toString((double[]) t);
				return "{"+s.substring(1, s.length()-1)+"}";
			}else if(t instanceof boolean[]) {
				String s = Arrays.toString((boolean[]) t);
				return "{"+s.substring(1, s.length()-1)+"}";
			}
			try {
				return ts((Object[]) t);
			}catch(ClassCastException e1) {
				return t.toString();
			}
		}
	}
	private static <T> String ts(T[] arr) {
		StringBuilder ret = new StringBuilder();
		ret.append("{");
		boolean first = true;
		for(T t: arr) {
			if(!first) {
				ret.append(", ");
			}
			first = false;
			ret.append(ts(t));
		}
		ret.append("}");
		return ret.toString();
	}
	private static <T> String ts(Iterable<T> iter) {
		StringBuilder ret = new StringBuilder();
		ret.append("{");
		boolean first = true;
		for(T t: iter) {
			if(!first) {
				ret.append(", ");
			}
			first = false;
			ret.append(ts(t));
		}
		ret.append("}");
		return ret.toString();
	}
	public static void dbg(Object... o) {
		if(LOCAL) {
			System.err.print("Line #"+Thread.currentThread().getStackTrace()[2].getLineNumber()+": [");
			for(int i = 0; i<o.length; i++) {
				if(i!=0) {
					System.err.print(", ");
				}
				System.err.print(ts(o[i]));
			}
			System.err.println("]");
		}
	}
}

UPD:* Just realized that CodeForces doesn't allow you to query any property other than "ONLINE_JUDGE". I have accordingly updated the code and added a note.

Comments (13)

Write comment?

edchen

4 years ago, # |

surprisingly underutilized

→ Reply

skittles1412

Auto comment: topic has been updated by skittles1412 (previous revision, new revision, compare).

PassionUnlimited

Java is not my primary language, but wow, this seems like a great template! I appreciate this, given that many of the resources for debugging are written in C++.

Java

orz

_prophet

Can you like show an example or something> It would be easier to get used to this then.

4 years ago, # ^ |

Copy and paste this code into a java class (not including the public static class Debug) part. Then, in your main function, run dbg([insert variables]); For example,

//This is inside your main function
int[] arr = new int[10];
for(int i = 0; i<10; i++) {
    arr[i] = i;
}
dbg(arr);

Ok sounds like fun. I wont have to put print statements everywhere now. Just a little noobish question. System.getProperty("Local") is false for my local system. How should I change it for different places. You already mentioned codeforces. So i'm guessing in codeforces the variable Local will be false and dbg won't run.

For my local system what should I do? Thanks.

For CodeForces, useboolean LOCAL = System.getProperty("ONLINE_JUDGE")==null;
However, most OJs don't define that so run your code with -DLOCAL. To do so, google "How to add command line arguments in [insert your ide]". Follow the instructions and add -DLOCAL as a command line argument. Now, System.getProperty("LOCAL")!=null will evaluate to true.

satya26

← Rev. 2 →

This template can be made a lot simpler, take a look at my template it is just 2 lines of code. For custom classes you just need to override toString() function and you are good to go.

debug template

public static void debug(Object... o){
    System.out.println(Arrays.deepToString(o));
}

taran_1407

It's even better to use error stream than output stream, in case you forget to comment it, the output would still get accepted (assuming solution fits TL including extra printing to error stream). Proof

So, the debugging template I use is

static void dbg(Object... o){System.err.println(Arrays.deepToString(o));}

There's no need to comment it. In your code, add
static boolean LOCAL = System.getProperty("ONLINE_JUDGE")==null;
Then change your template to
static void dbg(Object... o){if(LOCAL)System.err.println(Arrays.deepToString(o));}

True, I just don't like using that. :)

I realized this after about a week of writing this blog. :p

However, having this generic template is still useful, as you can modify it however you want. Nevertheless, knowing Arrays.deepToString(); is useful for competitions where template code isn't allowed.

skittles1412's blog