{"id":80,"date":"2010-06-22T17:52:30","date_gmt":"2010-06-23T01:52:30","guid":{"rendered":"http:\/\/bynomial.com\/blog\/?p=80"},"modified":"2010-06-22T17:52:30","modified_gmt":"2010-06-23T01:52:30","slug":"clash-happy-method-names","status":"publish","type":"post","link":"http:\/\/bynomial.com\/blog\/?p=80","title":{"rendered":"Clash-happy method names"},"content":{"rendered":"

This post lists a few special-case method names that are somewhat likely to be used accidentally by you but can only be used correctly if you understand their built-in functions. \u00c2\u00a0Specifically: class, description, load, and hash.<\/p>\n

Why it’s tricky, by example<\/h2>\n

Here’s an easy way to mess this up: start with a model object meant to match a table of a database on your server. \u00c2\u00a0Maybe you started by defining your fields. \u00c2\u00a0You’re making a table to represent player characters, so they have properties like alignment, level, race, or class. \u00c2\u00a0Sounds fine, right? \u00c2\u00a0Next you mirror these types in your iOS code, with just a bunch of instance variables with the same names. \u00c2\u00a0Instance variable names won’t class with method names, so you’re still ok. \u00c2\u00a0And then down the road you want to turn these things into properties. \u00c2\u00a0So you mindlessly turn everything into a property and BAM<\/strong> your code suddenly starts acting extremely weird, and you have no idea why.<\/p>\n

It’s because you implicitly have defined a method called “class” when you declared all your instance variables as property, and you copied all those from your server’s table fields. \u00c2\u00a0Now you have a choice:<\/p>\n

1. Make your code uglier by avoiding properties, or<\/p>\n

2. Make your code uglier by dropping consistency, and do some special-case handling for the “class” field.<\/p>\n

Of course, the real<\/em> solution is<\/p>\n

3. Don’t use clash-friendly names anywhere<\/em> in your pipeline, even across platforms.<\/p>\n

Hence the usefulness of this post (there are other cases too). \u00c2\u00a0Some people might argue in favor of<\/p>\n

4? Change every single instance variable everywhere to start (or end) with an underscore to avoid name clashes,<\/p>\n

but I think it is confusing to even allow names that are off-by-an-underscore, and that it is more a work-around than a good general approach. \u00c2\u00a0But that is also a prevalent and valid perspective.<\/p>\n

In any case, it’s good to know about these few special-case methods:<\/p>\n

class<\/h2>\n

This method is meant to return the<\/p>\n

Class<\/div><\/div>\n

object for the class of the receiver. You never need to write it, and overriding it is probably not your best move. It can be used for things like deciding what methods your object can respond to, and confusion about that can lead to horrible burning crashes with blood, disembodied limbs, and gory stack traces flying willy-nilly about the room.<\/p>\n

description<\/h2>\n

Beginners often think (at least I did) that %@, as a string formatter, means “print out an NSString.” But that’s not true – it really means, “print out an object,” and an object can be anything<\/em>, including an NSString (so if you previously thought it was for NSString’s, your thought is true – it’s just that you can print out so much more than you ever dreamed). Of course, there is the big question of how do you convert any object to a string?<\/em> And the answer is that every object has a<\/p>\n

description<\/div><\/div>\n

method which is meant to return a string representing that object. If you override this method, anyone printing your object (which could easily happen indirectly by, say, printing out the contents of an NSArray) will invoke your description call — if you provide some other type of<\/p>\n

description<\/div><\/div>\n

method, you will end up scratching your head at the weird debug output you get.<\/p>\n

load<\/h2>\n

The<\/p>\n

load<\/div><\/div>\n

method is a class method (signature + (void)[MyClass<\/em> load]). It is designed to give you a chance to run some code at the load-time of a binary, in a way that does not require any specific invocation. For example, you could build an audio library that has to call some one-time global init function like AudioInit(). Instead of having run-once code in your init function that looks like this:<\/p>\n

if (didGlobalInit == NO) {\r\n  AudioInit();\r\n  didGlobalInit = YES;\r\n}<\/pre>\n
You can just do this:<\/p>\n
+ (void)load {\r\n  AudioInit();\r\n}<\/pre>\n
So if you were thinking of have static methods called<\/p>\n
load<\/div><\/div>\n
and<\/p>\n
save<\/div><\/div>\n
meant to be called explicitly by your own code, you need to choose new names.<\/p>\n
hash<\/h2>\n
The hash method is used by collections like dictionaries and sets to do fast lookups (more info \u00c2\u00a0on that here<\/a>). \u00c2\u00a0If you override it for your own hash purposes, your dictionaries and sets are most likely to (a) simply act like things you added aren’t there during lookups, or (b) possibly crash.<\/p>\n
Others?<\/h2>\n
I’m probably leaving out a few.  Please let me know if you’ve collided with other special-case names that you weren’t expecting – I’ll add them to this list.<\/p>\n
References<\/h2>\n
Apple’s docs on:<\/p>\n