{"id":188,"date":"2008-12-20T22:55:25","date_gmt":"2008-12-21T03:55:25","guid":{"rendered":"http:\/\/vgable.com\/blog\/2008\/12\/20\/automatically-freeing-every-property\/"},"modified":"2009-11-29T18:24:53","modified_gmt":"2009-11-29T23:24:53","slug":"automatically-freeing-every-property","status":"publish","type":"post","link":"https:\/\/vgable.com\/blog\/2008\/12\/20\/automatically-freeing-every-property\/","title":{"rendered":"Automatically Freeing Every @property"},"content":{"rendered":"

Here’s a category of NSObject<\/code> that can simplify a dealloc<\/code> method.<\/a> It adds the method, setEveryObjCObjectPropertyToNil<\/code>, that sets every property of the receiver to nil<\/code>. (Properties that are readonly<\/code> or not an Objective-C object are ignored.) This frees the underlying object, if the property is declared copy<\/code> or retain<\/code>; and it does no harm if it was declared assign<\/code>.<\/p>\n

If every ivar (member variable) in your object has a property declared for it, then your dealloc<\/code> method can often be replaced by this macro, or it’s two-line expansion:
\n
\n#define PROPERTY_ONLY_OBJECT_DEALLOC \\
\n- (void) dealloc { \\
\n   [self setEveryObjCObjectPropertyToNil]; \\
\n   [super dealloc]; \\
\n}
\n<\/code><\/p>\n

Limitations<\/h3>\n

Pointers<\/h4>\n

Any pointers (eg char*<\/code>) will not<\/em> be set to NULL<\/code>; this includes pointers to an Objective-C object (eg NSError** outError<\/code>). Of course NSObject* obj<\/code> will<\/em> be set to nil<\/code> since it is considered an Objective-C object, even though it is written as if it were a pointer.<\/p>\n

It is easy to build on setEveryObjCObjectPropertyToNil<\/code> and have something that sets pointers to NULL<\/code> as well. But I felt it was too risky. Sending a message to nil<\/code> is valid<\/a>, but dereferencing a NULL<\/code> pointer is a “bus error” crash. [nil release];<\/code> does no harm, but free(NULL);<\/code> is bad news. A settable @property<\/code> that takes a raw pointer is a hybrid Objective-C, and “old”-C creature — I’ve never seen such a thing, so I’m wary of assuming that feeding it a NULL<\/code> would be valid. Plus, opening the door to pointers means dealing with handles<\/em> (pointers-to-pointers) and their ilk.<\/p>\n

ivars<\/h4>\n

Any ivars (member variables) with no settable @property<\/code> declared on them will not be freed. You can inspect your own ivars like you can @property<\/code>s (example<\/a>), but it would not<\/em> be safe to automatically release<\/code> them. Some of them might be weak-links, meaning the object they point to was not sent a retain<\/code> message. Weak-links are not terribly rare, for example objects always have a weak link to their delegate.<\/p>\n

The Code<\/a><\/h3>\n

You will still need to download the source<\/a> to get helper functions like SetterNameFromPropertyName()<\/code> for this to actually run, but this should give you an idea of how it works:<\/p>\n


\n@implementation NSObject(CleanUpProperties)
\n- (void) setEveryObjCObjectPropertyToNil;
\n{
\n   unsigned int i, propertyCount = 0;
\n   objc_property_t *propertyList = class_copyPropertyList([self class], &propertyCount);
\n   if(propertyList){
\n      for(i = 0; i < propertyCount; i++){
\n         const char *propertyAttrs = property_getAttributes(propertyList[i]);
\n         if(PropertyIsObjCObject(propertyAttrs) && PropertyIsSettable(propertyAttrs)) {
\n            NSString *setterName = SetterNameFromAttributes(propertyAttrs);
\n            if(!setterName)
\n               setterName = SetterNameFromPropertyName(property_getName(propertyList[i]));
\n            [self performSelector:NSSelectorFromString(setterName) withObject:nil];
\n         }
\n      }
\n      free(propertyList);
\n   }
\n}
\n@end
\n<\/code><\/p>\n

<\/p>\n

Download The Code<\/h3>\n

<\/a>
\nAnd please let me know how it works for you. I’ve started using setEveryObjCObjectPropertyToNil<\/code> even if I only have one @property<\/code>, because it means I’ll never forget to free one.<\/p>\n

Warning (Update 2009-05-29)<\/h3>\n

Uli Kusterer gives a good reason not<\/em> to use this code<\/a>,<\/p>\n

\n

Don’t Use Accessors in Constructors or Destructors<\/h3>\n

This may sound a bit odd, but there is a reason to this madness. Constructors (i.e. -init<\/code> methods in ObjC) and destructors (i.e. -dealloc<\/code> or -finalize<\/code>) are special methods: They are called before your object has fully been initialized, or may be called after it has already been partially torn down.<\/p>\n

If someone subclasses your class, your object is still an object of that subclass. So, by the time your -dealloc<\/code> method is called, the subclass has already been asked to do its -dealloc<\/code>, and most of the instance variables are gone. If you now call an accessor, and that accessor does anything more than change the instance variable (e.g. send out notifications to interested parties), it might pass a pointer to its half-destructed zombie self to those other objects, or make decisions based on half-valid object state. The same applies to the constructor, but of course in reverse.<\/p>\n

Now, some people that accessors should not be doing anything but change instance variables, but that is utter nonsense. If that was all they’re supposed to do, we wouldn’t need them. Accessors are supposed to maintain encapsulation. They’re supposed to insulate you from the internal details of how a particular object does its work, so you can easily revise the object to work in a completely different way, without anyone on the outside noticing. If an accessor could only change an instance variable, you would have very limited means to change this internal implementation.<\/p>\n

Moreover, I don’t think Apple would have introduced Key-Value-Coding and Key-Value-Observing if they didn’t agree at least partially that it’s fine to do a bunch of things in response to an accessor being used to mutate an object.\n<\/p><\/blockquote>\n

Update 2009-11-29<\/h3>\n

I’m amused at the prevalent “Apple knows best” attitude. Bindings, garbage collection, NSOperationQueue, and so many other things, Apple has gotten wrong and burned me in the process. I always trust my own evaluation over their recommendations.\n<\/p><\/blockquote>\n

—Mike Ash, Using Accessors in Init and Dealloc<\/cite><\/a><\/p>\n","protected":false},"excerpt":{"rendered":"

Here’s a category of NSObject that can simplify a dealloc method. It adds the method, setEveryObjCObjectPropertyToNil, that sets every property of the receiver to nil. (Properties that are readonly or not an Objective-C object are ignored.) This frees the underlying object, if the property is declared copy or retain; and it does no harm if […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[6,3,5,4,13],"tags":[224,263,264],"class_list":["post-188","post","type-post","status-publish","format-standard","hentry","category-cocoa","category-macosx","category-objective-c","category-programming","category-sample-code","tag-memory-management","tag-objective-c-20","tag-properties"],"_links":{"self":[{"href":"https:\/\/vgable.com\/blog\/wp-json\/wp\/v2\/posts\/188","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=188"}],"version-history":[{"count":2,"href":"https:\/\/vgable.com\/blog\/wp-json\/wp\/v2\/posts\/188\/revisions"}],"predecessor-version":[{"id":514,"href":"https:\/\/vgable.com\/blog\/wp-json\/wp\/v2\/posts\/188\/revisions\/514"}],"wp:attachment":[{"href":"https:\/\/vgable.com\/blog\/wp-json\/wp\/v2\/media?parent=188"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/vgable.com\/blog\/wp-json\/wp\/v2\/categories?post=188"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/vgable.com\/blog\/wp-json\/wp\/v2\/tags?post=188"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}