{"id":603,"date":"2010-05-24T00:31:42","date_gmt":"2010-05-24T05:31:42","guid":{"rendered":"http:\/\/vgable.com\/blog\/?p=603"},"modified":"2010-05-24T00:31:45","modified_gmt":"2010-05-24T05:31:45","slug":"never-name-a-variable-index","status":"publish","type":"post","link":"https:\/\/vgable.com\/blog\/2010\/05\/24\/never-name-a-variable-index\/","title":{"rendered":"Never Name a Variable “Index”"},"content":{"rendered":"

Never<\/em> name a variable index<\/code><\/strong>, especially in C.<\/p>\n

Instead say what<\/em> it indexes<\/strong>. For example, if it is used to index an array of Foo<\/code> objects, call it fooArrayIndex<\/code>, or currentFooIndex<\/code>.<\/p>\n

If the index variable is just used to enumerate over a collection of objects, (eg. for(int i = 0; i < arraySize; i++){\u2026} <\/code>) then iterate smarter<\/a>, using a simpler construct that doesn’t require declaring auxiliary variables. (Eg., in Objective-C use Fast Enumeration<\/a>). It’s not always possible to do this, but it’s always a good idea to try.1<\/sup><\/p>\n

Why index<\/code> is Especially Bad in C<\/h3>\n

The standard strings.h<\/code> header declares a function named index<\/code>, that finds the first occurrence of a charicter in a C-string. In practical terms every C program will have the index<\/code> function declared everywhere<\/strong>.<\/p>\n

But when a variable is declared with the name index<\/code> it shadows<\/a> the function\u00a0— meaning the local variable named index<\/code> takes over the name index<\/code>, so the function can’t be called anymore:<\/p>\n

\nchar * world = index(\"Hello, World\", 'W');\nNSLog(@\"'%s'\", world);\n<\/pre>\n
Prints “‘World'”, but<\/p>\n
\nint index = 0;\nchar * world = index(\"Hello, World\", 'W');\nNSLog(@\"'%s'\", world);\n<\/pre>\n
Won’t compile, because an int<\/code> isn’t a function.<\/p>\n
Obviously this is a problem for code that uses the index()<\/code> function \u2014 but honestly modern code probably uses a safer, unicode-aware<\/a> string parsing function instead. What’s given me the most trouble is that shadowing index<\/code> makes the compiler give lots of bogus warnings, if you have the useful GCC_WARN_SHADOW<\/code> warning turned on<\/a><\/strong>.<\/p>\n
There are other good reasons as, specific to Objective-C, which Peter Hosey covers<\/a>.<\/p>\n
1<\/sup>If you really<\/em> can’t think of a better name than “index”, I prefer the more terse i<\/code>. It sucks, but at least it’s shorter. Brevity is a virtue.<\/small><\/p>\n","protected":false},"excerpt":{"rendered":"
Never name a variable index, especially in C. Instead say what it indexes. For example, if it is used to index an array of Foo objects, call it fooArrayIndex, or currentFooIndex. If the index variable is just used to enumerate over a collection of objects, (eg. for(int i = 0; i &lt arraySize; i++){\u2026} ) […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[18,7,6,5,4],"tags":[613,413],"class_list":["post-603","post","type-post","status-publish","format-standard","hentry","category-bug-bite","category-c","category-cocoa","category-objective-c","category-programming","tag-c","tag-names"],"_links":{"self":[{"href":"https:\/\/vgable.com\/blog\/wp-json\/wp\/v2\/posts\/603","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/vgable.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/vgable.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/vgable.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/vgable.com\/blog\/wp-json\/wp\/v2\/comments?post=603"}],"version-history":[{"count":1,"href":"https:\/\/vgable.com\/blog\/wp-json\/wp\/v2\/posts\/603\/revisions"}],"predecessor-version":[{"id":604,"href":"https:\/\/vgable.com\/blog\/wp-json\/wp\/v2\/posts\/603\/revisions\/604"}],"wp:attachment":[{"href":"https:\/\/vgable.com\/blog\/wp-json\/wp\/v2\/media?parent=603"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/vgable.com\/blog\/wp-json\/wp\/v2\/categories?post=603"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/vgable.com\/blog\/wp-json\/wp\/v2\/tags?post=603"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}