TweetFollow Us on Twitter

Dumb bugs
Volume 9
Number 11
Column TagsState of the Industry

Glenn’s Philosophy on Programming

Tricks to avoid wasting time on “dumb” bugs

By G. Weinreb, Somerville, Massachusetts

The most important thing in software development is that the programmer must love their code. If the programmer does not love his code, coding becomes a chore as opposed to a joy, causing code quality, coding productivity, and the programmer's mental state to degrade. In order for a programmer to love their code, ALL of the following must be true:

• The code must be well organized with specific functionality localized to one area, as opposed to appearing multiple times.

• ALL routines must be extremely well tested.

• ALL routines must be extremely well documented.

• Many routines must contain defensive code, especially the low level ones.

• The programmer must have a decent machine with which to develop.

• The programmer must have a decent development environment and a decent understanding of how to use it.

• The programmer must have a good debugger. Working with complex black boxes, into which you cannot peer, is a hell that I would not wish upon even the fiercest of competitors.

The fundamental principle behind programming is that each issue must be localized to one area (e.g. one function); and that this one area do it's job extremely well (i.e. employ defensive code, include outstanding documentation, and be extremely well tested). And then all the other routines are to rely on ONE to implement the specific functionality. If similar functionality is copied and implemented in different places, then the programmer has less time to make each copy solid. Unsolid (non defensive, non documented, non tested) code leads to the following scenario:

A programmer is programming one function that calls another, and finds that the called one is not working well. So the programmer stops what he/she is doing and goes to fix the lower level routine. Now, if it is undocumented, the programmer needs to read each line, figure out what it's doing, and then document it - which can take more time than coding the thing from scratch. Therefore, undocumented code is in a sense disposable - you use it once and then throw it away and get another (like a Kleenex) when you need to change it. So the poor programmer documents the routine, tests it and makes it solid. But then we find that many other routines call this function, and our making it solid has changed it a little, causing it to not work for some of it's other callers. Subsequently, the programmer must fight to make it work in all cases - which requires coding in other areas - which can lead to new frontiers. And much time goes by while the poor programmer has accomplished very little on the original routine. And subsequently, they find it very hard to love their code.


• Code MUST be well documented, which includes:

+ function headers for all functions

+ descriptive headers for each file

+ descriptions of passed arguments

+ documentation in the code which describes what it does and how it does it

• Code must be thoroughly tested because the devil is in the details and the details are what will bite you. Subsequently, you've got to DIG, DIG, DIG to uncover those subtle little problems. And the key to this is to have the confidence that they exist, else you will not dig for them - SO ASSUME THEY EXIST AND DIG, DIG, DIG.

• Code MUST be defensive in order to get ahead of the bugs. Defensive coding entails looking for problems and showing an alert if one is found. Several examples:

a) Arguments passed to low level routines (i.e. the one's called by many other routines) are checked if doing development. A global variable, 'gDevelopment', is set TRUE when doing development, and at any time, the user can press an Option key to toggle the state of 'gDevelopment' TRUE/FALSE. 'gDevelopment' is typically used in the following way:

/* 1 */

void SetUserItem (
 DialogPtr dialog, //ptr to dialog box
 short itemNr,   //item's DITL #
 ProcPtr doDraw) //procedure pointer for                       
 //user  DITL item
 if (gDevelopment)  {// if doing develop...
 if (IfPtrIsNullOrBadYell ((Ptr) dialog, 1))                   return;
 // test for null or bad ptr
 if (IfDitlNrIsBadYell (itemNr, TRUE)) return;           // test for 
bad ditl #
 if (IfPtrIsNullOrBadYell ((Ptr) doDraw, 1))
 return;// test for null or bad ptr
 body .....
 body .....

Subsequently, if there is trouble, the programmer knows about the problem before it causes harm. And bugs can cause harm in a manner which is not obvious and/or a manner which does not lead the programmer to the bad code (e.g. a bug in area A destroys memory in area B, which crashes 100 mouse clicks latter). Defensive coding is like being at the window with a shotgun when the burglar climbs in - "Hey, what the hell do you think you're doing?". Programmers must get ahead of bugs, not behind, in order to love their code.

Someone playing devil's advocate might say, "Doesn't it take time to install defensive code and doesn't it slow your program?". It does take some time to implement, yet not much since it involves mindless cut/copy/paste of similar existing code fragments. The time for the processor to check for 'gDevelopment' TRUE is less than a microsecond (for perspective, HLock() costs 121µs on a Mac IIcx). Subsequently, adding "if (gDevelopment)" increases execution time by only a tiny amount. Freeing the programmer from fighting bugs will give him/her more time to optimize code - which will save orders of magnitude more execution time.

b) One can use macros to add defensive coding to toolbox routines. e.g.

/* 2 */

 #define HLock_(h) \
 if (gDevelopment) { \
 if (CheckHandle((Handle) h, TRUE, TRUE))    \
 HLock((Handle) h);\
 } \
 else if (h){    \
 HLock((Handle) h);\

This simple little macro has saved my life on a number of occasions.

c) We will define the phrase "memory problem" as code which writes to memory where it should not, and possibly causes trouble in an unrelated area and/or in an intermittent way - both of which are infamous to programmers. In the case of a "memory problem", one must have a strategy for dealing with it (other than fumbling around and saying, "Gee's, this really IS a tough one."). One technique is to use a global, 'gShakeLikeHell', which is toggled TRUE/FALSE by pressing an Option key (it is always set to FALSE when you first launch the application), and a macro defined as follows:

/* 3 */

 if (gShakeLikeHell) \

ShakeLikeHellifShaking() compacts the heap, creates handles, disposes of handles, and tests existing data structures. If you have an intermittent or nebulous bug, the best response is to install the SHAKELIKEHELLIFSHAKING macro throughout your code under development, run the application, and press the Option key to turn it on. Chances are you will crash, or see the problem sooner (i.e. closer to the bad code). Ideally you would like to isolate the problem area between 2 SHAKELIKEHELLIFSHAKING macros (which is a mechanism which identifies if the problem does or does not originate from a specified range of code). After installing the macro, you can leave it in your code - it cost less than a microsecond. [Except for the time spent in the ShakeLikeHellifShaking routine. - Tech. Ed]. Installing this macro may seem silly, yet I can attest it has worked beautifully on many occasions - encouraging me to love my code.


Community Search:
MacTech Search:

Software Updates via MacUpdate

Facility 47 (Games)
Facility 47 1.0.1 Device: iOS Universal Category: Games Price: $3.99, Version: 1.0.1 (iTunes) Description: You wake up alone and freezing in an icy cell. You try the cell door but it’s locked, it seems that you are stuck with no... | Read more »
The Walking Dead: No Man’s Land guide -...
A new update for The Walking Dead: No Man’s Land was released last week, making it the perfect time for you to head back to your base and take out some walkers. Here’s the lowdown on what’s new to the game, and how to take advantage. [Read more] | Read more »
Goat Rider guide - Tips and tricks to st...
We've all been there. One second, we're riding high on a crazed goat, and the next, we've been tossed off it like someone who's no good at goat ridin'. [Read more] | Read more »
Real Boxing 2 CREED: How to become a gre...
Just in time for Rocky fans who can’t wait to see CREED, the latest movie, we have the official tie-in game,Real Boxing 2 CREED. It builds on the success of its predecessor and there’s lots to take in so we at 148apps thought we’d run you through... | Read more »
CoinOp Heroes 2 guide - How to build an...
CoinOp Heroes 2 justlaunched and, like all clickers, it's dangerously addictive stuff. You have to furiously tap your screen to defeat wave after wave of foes and earn an insane amount of cash to spend on character upgrades and an army of minions... | Read more »
Dr. Panda Firefighters (Education)
Dr. Panda Firefighters 1.0.1 Device: iOS Universal Category: Education Price: $2.99, Version: 1.0.1 (iTunes) Description: FIGHT FIRES AND SAVE THE DAY!Work together with Dr. Panda and his firefighting team to rescue his trapped... | Read more »
Puddle + (Games)
Puddle + 1.0 Device: iOS iPhone Category: Games Price: $2.99, Version: 1.0 (iTunes) Description: Puddle is back in a new "+" edition featuring enhanced graphics, new videos and Apple TV support ! No IAP and No Ads. Dive into Puddle... | Read more »
Football Manager Mobile 2016 (Games)
Football Manager Mobile 2016 7.0.0 Device: iOS Universal Category: Games Price: $8.99, Version: 7.0.0 (iTunes) Description: Football Manager Mobile 2016 is designed to be played on the move and is the quickest way to manage your... | Read more »
Kill Shot Bravo guide - How to become an...
Kill Shot Bravo is a disturbing amount of fun. No matter how many times I play a game that encourages me to snipe people in the head, I feel a little uneasy at how satisfying it is. Here are some useful tips to get you started on your path to... | Read more »
The best note-taking app on iPhone and i...
Word processors are handy and all, but sometimes you just want to make a quick note. Whether it's to jot down your shopping list, some quick song lyrics, or a phone number, the ease of use of a note-taking app easily surpasses that of a heftier... | Read more »

Price Scanner via

Al Jazeera Launches New iOS And Android Mobil...
Doha, Qatar based Al Jazeera has launched new mobile and tablet apps on the iOS and Android systems bringing the latest Al Jazeera news and programmes live together with on-demand personalisation.... Read more
B&H Photo Holiday Sale: Up to $250 off Ma...
B&H Photo has all new Macs on sale for up to $500 off MSRP as part of their Holiday sale including free shipping plus NY sales tax only: - 15″ 2.2GHz Retina MacBook Pro: $1799 $200 off - 15″ 2.... Read more
Free Aura ‘Ultimate’ Mac App For Gmail Update...
Miami, Florida based Crosscoded has announced Aura 1.2.0, an update to the Mac app for Gmail. Aura mixes the power of a native client with the flexibility of the Gmail web app with support for up to... Read more
Apple Will Edge Closer to Samsung in Smartpho...
Total smartphone shipments for 2015 are projected to decline by 9.7% to 1.286 billion units, according to the latest report from global market research firm TrendForce. Though Chinese vendors have... Read more
12-inch MacBooks in stock for up to $120 off,...
Adorama has 12″ Retina MacBooks in stock for up to $120 off MSRP including free shipping plus NY & NJ sales tax only. For a limited time, Adorama will include a free Apple USB-C to USB Adapter,... Read more
Save 15% with Apple refurbished Mac Pros
The Apple Store has Apple Certified Refurbished Mac Pros available for up to $600 off the cost of new models. An Apple one-year warranty is included with each Mac Pro, and shipping is free. The... Read more
iPod touch (6th Gen) on sale for $40-$60 off...
Save $40 to $60 on a 6th generation iPod touch at Target with free shipping or free local store pickup (if available). Sale prices for online orders only, in-store prices may vary: - 16GB iPod touch... Read more
13-inch 1.6GHz MacBook Air on sale for $849,...
Best Buy has the 2015 13″ 1.6GHz/128GB MacBook Air on sale for $849.99 on their online store. Choose free shipping or free local store pickup (if available). Sale price for online orders only, in-... Read more
Apple refurbished 15-inch 2.2GHz Retina MacBo...
Apple has Certified Refurbished 2014 15″ 2.2GHz Retina MacBook Pros available for $1609, $390 off original MSRP. Apple’s one-year warranty is included, and shipping is free. Read more
Weekend sale: 13-inch Retina MacBook Pros for...
Save up to $100 on the purchase of a new 2015 13″ Retina MacBook Pro at the following resellers. Shipping is free with each model: 2.7GHz/128GB MSRP $1299 2.7GHz/256GB... Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
Senior Business Development Manager, - *Appl...
# Senior Business Development Manager, - Apple Pay Job Number: 44473850 Santa Clara Valley, Califo ia, United States Posted: Nov. 20, 2015 Weekly Hours: **Job Summary** Read more
Content Producer, *Apple* University - Appl...
# Content Producer, Apple University Job Number: 44135153 Santa Clara Valley, Califo ia, United States Posted: Nov. 20, 2015 Weekly Hours: 40.00 **Job Summary** The Read more
*Apple* Media QA Manager - Apple (United Sta...
# Apple Media QA Manager Job Number: 44409763 Santa Clara Valley, Califo ia, United States Posted: Nov. 17, 2015 Weekly Hours: 40.00 **Job Summary** Apple Media Inte Read more
*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.