{"id":3183,"date":"2018-07-14T00:01:15","date_gmt":"2018-07-14T07:01:15","guid":{"rendered":"https:\/\/c-for-dummies.com\/blog\/?p=3183"},"modified":"2018-06-30T13:30:16","modified_gmt":"2018-06-30T20:30:16","slug":"lets-be-assertive","status":"publish","type":"post","link":"https:\/\/c-for-dummies.com\/blog\/?p=3183","title":{"rendered":"Let’s Be Assertive"},"content":{"rendered":"

I find it fun to debug code. I add various printf()<\/em> statements to a program to display values and quickly determine what’s going on. This process seems easier than toiling with a debugger.
\n
\nFor example, and especially with pointers, when I see a memory location changing between two functions, I use printf()<\/em> statements to display the pointer’s memory address and value in each function:<\/p>\n

printf(\"Address %p, Value %d\\n\",ptr,*ptr);<\/code><\/p>\n

These statements help me unravel mysteries in the code and eventually fix the issue.<\/p>\n

Another way to spot bugs in you code is to use assert()<\/em>.<\/p>\n

The assert()<\/em> macro is defined in the assert.h<\/code> header. You may have seen it in some code samples, though most coders pull it out when they’re done testing. What assert()<\/em> does is to perform a simple test, to verify a variable or condition. If the condition isn’t met (is false), the program halts.<\/p>\n

In the following code, the assert()<\/em> macro appears at Line 10. It tests the value of variable x<\/code>. As long as x<\/code> is less than 7, assert()<\/em> is good with the code; the value is asserted to be less than 7. When x<\/code> hits 7, however, the program halts.<\/p>\n

\r\n#include <stdio.h>\r\n#include <assert.h>\r\n\r\nint main()\r\n{\r\n    int x;\r\n\r\n    for(x=0;x<10;x++)\r\n    {\r\n        assert(x<7);\r\n        printf(\"%d\\n\",x);\r\n    }\r\n\r\n    return(0);\r\n}<\/pre>\n
Here’s a sample run:<\/p>\n
0\r\n1\r\n2\r\n3\r\n4\r\n5\r\n6\r\nAssertion failed: (x<7), function main, file 0714.c, line 10.\r\nAbort trap: 6<\/code><\/pre>\n
I find the details displayed by the assert()<\/em> macro to be most useful: The condition is displayed, (x<7)<\/code>; the function, main()<\/em>; the filename, 0714.c<\/code>, and best of all, the line number 10<\/code>. (The text Abort trap<\/code> may not appear in your output.)<\/p>\n
You can deploy the assert()<\/em> macro at various points of your code to ensure that variables are properly initialized. Even so, keep in mind that this macro is for your purposes as the programmer to aid in debugging. It's not intended to trap errors that a user may see.<\/p>\n
For example, if a chunk of memory can't be allocated, I would use a standard if<\/em> test instead of assert:<\/p>\n
if(p==NULL)\r\n\/* DO handle condition here *\/<\/code><\/pre>\n
And not:<\/p>\n
assert(p!=NULL);     \/* DON'T *\/<\/code><\/pre>\n
Further, if you want to keep the assert()<\/em> tests in your code, or you forget where they're located in some massive, multi-line program monster, you can disable them by adding the following constant definition:<\/p>\n
#define NDEBUG<\/code><\/p>\n
When NDEBUG<\/code> is defined in your source code file, the assert.h<\/code> header file rubs out the assert()<\/em> macro definition. So you can switch assert()<\/em> off by adding the above preprocessor directive or turn assert()<\/em> back on by removing the line or commenting it out.<\/p>\n
Consider the assert()<\/em> macro yet another arrow in your C language debugging quiver.<\/p>\n","protected":false},"excerpt":{"rendered":"
Debugging is a major issue for any programmer. Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[2],"tags":[],"class_list":["post-3183","post","type-post","status-publish","format-standard","hentry","category-main"],"_links":{"self":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/3183","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=3183"}],"version-history":[{"count":4,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/3183\/revisions"}],"predecessor-version":[{"id":3194,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/3183\/revisions\/3194"}],"wp:attachment":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=3183"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=3183"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=3183"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}