December 18th, 2006
Most of you are familiar with the material in this article, but I read a lot of programming questions on message boards that could have been answered by running the code in a debugger. I hope new programmers will be able to find this article and use it to learn how to debug their programs.
What is a Debugger?
Computers run programs fast, which is normally a good thing. But if you have a problem in your code, the code runs too fast for you to figure out what is wrong. It’s like trying to watch a DVD in fast forward mode.
A debugger lets you slow things down so you can see what is happening when your program runs. By using a debugger you can pause your program at any line of code, step through your code line by line, and examine the values of your program’s variables. A debugger helps immensely when you’re trying to find out what’s wrong with your code. If you’re serious about being a software developer, one of the best things you can do is learn to use a debugger.
Running the Debugger
Xcode is set up so you don’t have to do much work to run the debugger. Every Xcode project you create has a Debug (older versions of Xcode call it Development instead of Debug) build configuration that is set for debugging. The Debug build configuration is the default configuration so all you have to do is choose Build > Build and Debug to open the debugger window and start debugging.
The debugger window has four areas. At the top is the toolbar, which has buttons for performing the most common debugging tasks. You can also find these debugging commands in Xcode’s Debug menu.
Below the toolbar on the left is the call stack viewer. At the top of the call stack is the function where your program current is. Below that is the function that called the current function. Below that is the function that called the second function and so on. The call stack viewer is the least interesting part of the debugging window for those of you who are new to debuggers.
Next to the call stack viewer is the variable viewer. The variable viewer lets you see the values of the current function’s local variables and arguments as well as any constant variables that are in the current function’s source code file.
At the bottom of the debugger window is the editor, which lets you see what line of code the program is currently at.
Launching the debugger initially doesn’t do anything because you haven’t told the debugger when to pause. Breakpoints tell the debugger to pause your program when it reaches a certain line of code. What you have to do is set breakpoints where you want your program to pause.
Click the gutter next to a line of source code in the editor window to set a breakpoint at that line of code. The gutter runs along the left edge of the window. When you set a breakpoint, a gray arrow appears next to the line of code. Dragging the arrow off the gutter removes the breakpoint.
Now when you run your program in the debugger, it will pause when it reaches any of the breakpoints you set.
Stepping Through Your Code
Stepping is one of the most important functions a debugger performs. It lets you walk through one line of code at a time and see the effects of executing that line of code. If you look at Xcode’s debugger window toolbar, you will see three buttons: Step Over, Step Into, and Step Out. If the current line of code does not call a function, the Step Over and Step Into buttons do the same thing. They execute the current line of code and move to the next line.
The Step Over and Step Into buttons perform different tasks when making a function call. Clicking the Step Over button tells the debugger to execute all the code in the function you’re calling and move to the line of code after the function call. It steps over the function you’re calling.
Clicking the Step Into button takes you inside the function you’re calling, which lets you step through the code inside the called function. It steps into the function you’re calling. When you step into a function, the Step Out button becomes relevant. Clicking the Step Out buttons takes you out of the called function and moves to the line of code after the function call. Clicking the Step Into and Step Out buttons is the equivalent of clicking the Step Over button.
For more information on Xcode’s debugger, read the Xcode’s User Guide, which you can open in Xcode by choosing Help > Xcode Help. There is an entire section on debugging.