TweetFollow Us on Twitter

Jun 97 - Getting Started

Volume Number: 13 (1997)
Issue Number: 6
Column Tag: Getting Started

Filling in Some of the Objective-C Pieces

by Dave Mark

Last month, we learned most of the syntax of the Objective-C language. Since then, I have been scorching the e-mail, newsgroups, and phone lines trying to learn more. Much thanks to Michael Rutman, David Klingler, Bob McBeth, and Eric Gundrum for their time and energies in trying to get me on the straight and narrow. As always, the good stuff is theirs, the mistakes, mine.

@private, @public, and @protected

For me, much of the Objective-C learning process involves learning the differences between C++ and Objective-C. For example, C++ allows you to use the access specifiers public:, private:, and protected: to define the scope of a classes' data members and member functions. Objective-C offers a similar mechanism you can use to specify the scope of a classes' instance variables (methods are always public): the compiler directives @private, @public, and @protected.

Here's the official description of each of these compiler directives:

@private
the instance variable is accessible only within the class that declares it.
@protected
The instance variable is accessible within the class that declares it and within classes that inherit it.
@public
The instance variable is accessible everywhere.

Instance variables default to @protected, which makes sense. After all, if you mark an instance variable as @public, that would defeat the whole point of data encapsulation. The point is, you want to force access to your instance variables to occur via one of your classes' methods. So just forget about the @public compiler directive. The default setting of @protected will serve you in the vast majority of cases.

The @private directive does have its place, though. You would use @private if you don't want the instance variable inherited by subclasses. Perhaps you don't want a subclass monkeying with a variable that is key to the architecture of the base class. Or perhaps you want to minimize the dependencies between the base and sub classes. Though @private does have its place, don't use it unless you absolutely have a reason to. The general opinion seems to hold that you should never use @private at all -- that all classes should have all functionality overridable. Just wanted to make sure you heard both sides...

Here's an example that uses all three directives:

@interface Employee : Object
{
	char		*name;

@private
	int		yearsWithCompany;
	int		hoursVacation;

@protected
	char		*title;

@public
	id			supervisor;
	id			officeMate;
}

The @public, @private, and @protected compiler directives hold true for all instance variables that follow until either the end of the class or another directive is encountered. In the example above, the name variable is @protected, since it is not marked otherwise. yearsWithCompany and hoursVacation are @private, title is protected, and supervisor and officeMate are public. Of course, this sample was just to show you how this works and is not intended as realistic code.

Bottom line, your best bet is to leave these directives out of your code and just use the default setting of @protected. On the other hand, it is worth knowing how this works so you can read sample code that uses it and so you can use @private if you find a case where it makes sense.

Init vs. Init:

In last month's column, we looked at a sample program that included a simple class named Number. Here's the Number implementation:

#import "Number.h"

@implementation Number 

- init:(int)startValue /* This is BAD FORM - see below */
{
 [super init];

 value = startValue;

 return self;
}

- squareSelf
{
 value *= value;

 return self;
}

- print
{
 printf( "Number value: %d\n", value );

 return self;
}

@end

The Number class includes a method named init: which takes a single parameter. As it turns out, calling an initialization method init when it takes a parameter is a bad thing. The name init should be reserved for initialization methods with no parameters. Imagine if you had two different classes, each of which declared an init: method, one of which took a float, and one of which took an int as a parameter. Now imagine you had two object pointers, each declared as an id, one pointing to an object of one class, the second pointing to an object of the second class. If you send an init: method to one of these objects, the fact that both init: methods have the same name and yet take different parameter types will cause confusion and potential bad behavior. The name of your initialization method is what sets it apart from others. You'll see examples of this throughout the remainder of this column.

In the simplest case, an initialization method with no parameters, you'll definitely want to use the name init. The name init implies no parameters. The parameterless init starts off by sending the init method to its superclass, then initializing any instance variables that don't depend on parameters, and finally returning self.

Here's an example:

- init
{
	[super init];

	blockSize = 512;

	return self;
}

In this hypothetical example, blockSize is an instance variable whose initial value does not depend on a parameter. (In real life, we'd likely use a #define or, in C++ a const, but bear with the example.) Note that we sent the init message to our superclass before we do anything else. It is important that you send the initialization message to your superclass before you mess with your instance variables or call any of your other methods. Reason being, when you call your superclasses' initialization method, you give your superclass a chance to initialize its variables and a chance to initialize its superclass, etc.

If your class requires an initialization method that takes a parameter, give it a name that starts with init, then add text that reflects the parameters. For example, suppose you had a sequence of classes, Shape, Circle, and Cylinder, where Circle was derived from Shape, and Cylinder derived from Circle. Asssuming it took no parameters, the Shape initialization method would be called init. The Circle initialization method would require a radius, and might be called initRadius:, and the Cylinder's initialization method might be called initRadius:height:. You get the idea.

A Multi-Class Example

Designing your initialization methods can get a little more complex when you are working with subclasses. In the example above, the Shape class has an init method, while the Circle class, derived from Shape, adds a radius parameter in a method named initRadius:. So far, no problem. To initialize its superclass, initRadius: just sends an init message to its superclass:

[super init]

But what about the initRadius:height: method of the Cylinder class? Should it send an init message to its superclass? That doesn't make sense, since its superclasses' initialization method is initRadius: and takes a parameter. The correct approach is for each class to include all initialization methods of its superclass, adding in any additional methods for extra/differing parameters that it brings to the table. In our example, Shape would feature an init method, Circle would feature init and initRadius: methods, and Cylinder would feature init, initRadius:, and initRadius:height: methods.

Each init method will send an init message to its superclass, and set any instance variables unique to its class to a default value. For example, the Circle init method would set radius to 0 (or whatever) and the Cylinder init method would set height to 0.

Additional methods that are overriding existing super class methods send an initialization message to the superclass, passing parameters as appropriate. For example, the Cylinder initRadius: method sends an initRadius: message to Circle.

Finally, methods that don't have a matching method in the superclass send an initialization message to self using the method that most closely matches itself. For example, the Circle classes' initRadius: method sends an init message to self (no parameters), while the Cylinder classes' initRadius:height: method sends an initRadius: message to itself but includes the radius parameter. Once the called initialization method returns, the calling method continues by setting its unique instance variables to the parameter passed in to it. For example, once initRadius:height: calls [self initRadius:r] (which will set the radius instance variable to r), it then sets the height instance variable to h (the passed in height parameter).

If the last few paragraphs have left you a bit dazed and confused, not to worry. Here's a program that brings this all to life. As you go through the code, try to follow the chain of initialization. Where does each instance variable get initialized? Can you predict the sequence of initializations when initRadius:height: gets called? Try to work this out before you get to the project run at the end of the column.

The source code that follows is a ".m" and ".h" file for each of the three classes Shape, Circle, and Cylinder. In addition, you'll see a listing for main.m, the main() function that starts the ball rolling.

Shape.m

#import "Shape.h"

@implementation Shape

- init
{
 [super init];

 printf( "\n[Shape init]\n" );

 return self;
}

@end

Shape.h

#import <Object.h>

@interface Shape : Object
{
}

- init;

@end

Circle.m

#import "Circle.h"

@implementation Circle

- init
{
 [super init];

 printf( "[Circle init] - Set radius to 0...\n" );

 radius = 0;

 return self;
}

- initRadius:(int)r
{
 [self init];
 radius = r;

 printf( "[Circle initRadius] - Set radius to %d...\n",
									r );

 return self;
}

@end

Circle.h

#import "Shape.h"

@interface Circle : Shape
{
 int radius;
}

- init;
- initRadius:(int)r;

@end

Cylinder.m

#import "Cylinder.h"

@implementation Cylinder


- init
{
 [super init];

 printf( "[Cylinder init] - Set height to 0...\n" );

 height = 0;

 return self;
}

- initRadius:(int)r
{
 [super initRadius:r];

 printf( "[Cylinder initRadius]\n" );

 return self;
}

- initRadius:(int)r height:(int)h
{
 [self initRadius:r];

 height = h;

 printf
 ( "[Cylinder initRadius:height:] - Set height to %d...\n", h );

 return self;
}

@end

Cylinder.h

#import "Circle.h"

@interface Cylinder : Circle
{
 int height;
}

- init;
- initRadius:(int)r;
- initRadius:(int)r height:(int)h;

@end

main.m

#include "Cylinder.h"

void main()
{
 id shape = [[Shape alloc] init];
 id circle = [[Circle alloc] initRadius:33];
 id cylinder = [[Cylinder alloc] initRadius:27 height:10];

 [shape free];
 [circle free];
 [cylinder free];
}

Running the Program

When you run the program above, here's what you see:

[Shape init]

[Shape init]
[Circle init] - Set radius to 0...
[Circle initRadius] - Set radius to 33...

[Shape init]
[Circle init] - Set radius to 0...
[Cylinder init] - Set height to 0...
[Circle initRadius] - Set radius to 27...
[Cylinder initRadius]
[Cylinder initRadius:height:] - Set height to 10...

As you can see, the listing is broken into three parts, each produced by the initialization of a Shape, Circle, and Cylinder, respectively. Note that when (inside main.m) we created a Shape and sent it an init message, this produced a call of the Shape classes' init method. Simple. Of course, we really should have left the init method out of the Shape class, since it doesn't do anything but add overhead. If we left it out, the right thing would have happened (the init message would have found its way to the Object class).

When we created a Circle and sent it the initRadius: message, we spawn a chain of init messages to Shape and then Circle. Finally, the initRadius: message gets sent to Circle.

The Cylinder object produces a similar chain of initialization. First, we see the chain of init messages from Shape to Circle to Cylinder, then the chain of initRadius: messages from Circle to Cylinder, followed finally by the initRadius:height: message to Cylinder.

Till Next Month...

Spend some time looking over this output till you get the pattern. Once you understand this initialization technique, think about what would happen if you added an Oval class as a subclass to Circle, with an added width instance variable. How would this affect the initialization chain? If you have access to an Objective-C environment, take the time to enter this code and take it for a spin. Add some methods of your own (an area method for Circle, perhaps?) and experiment! See you next month...

 
AAPL
$101.32
Apple Inc.
+0.74
MSFT
$45.15
Microsoft Corpora
-0.07
GOOG
$582.56
Google Inc.
-0.81

MacTech Search:
Community Search:

Software Updates via MacUpdate

calibre 2.0.0 - Complete e-library manag...
Calibre is a complete e-book library manager. Organize your collection, convert your books to multiple formats, and sync with all of your devices. Let Calibre be your multi-tasking digital... Read more
Apple iMovie 10.0.5 - Edit personal vide...
With an all-new design, Apple iMovie lets you enjoy your videos like never before. Browse your clips more easily, instantly share your favorite moments, and create beautiful HD movies and Hollywood-... Read more
Apple Keynote 6.2.2 - Apple's prese...
Apple Keynote makes it simple to create and deliver beautiful presentations. Powerful tools and dazzling effects bring your ideas to life. You can work seamlessly between Mac and iOS devices. And... Read more
Apple Numbers 3.2.2 - Apple's sprea...
With Apple Numbers, sophisticated spreadsheets are just the start. The whole sheet is your canvas. Just add dramatic interactive charts, tables, and images that paint a revealing picture of your data... Read more
OpenOffice 4.1.1 - Free and open-source...
OpenOffice.org is both an Open Source product and a project. The product is a multi-platform office productivity suite. It includes the key desktop applications, such as a word processor,... Read more
Pages 5.2.2 - Apple's word processo...
Apple Pages is a powerful word processor that gives you everything you need to create documents that look beautiful. And read beautifully. It lets you work seamlessly between Mac and iOS devices. And... Read more
Quicken 2015 2.0.1 - Complete personal f...
The new Quicken 2015 helps you manage all your personal finances in one place, so you can see where you're spending and where you can save. Quicken automatically categorizes your financial... Read more
CleanMyMac 2.2.7 - Delete files that was...
CleanMyMac makes space for the things you love. Sporting a range of ingenious new features, CleanMyMac 2 lets you safely and intelligently scan and clean your entire system, delete large, unused... Read more
MacFamilyTree 7.2.4 - Create and explore...
MacFamilyTree gives genealogy a facelift: it's modern, interactive, incredibly fast, and easy to use. We're convinced that generations of chroniclers would have loved to trade in their genealogy... Read more
Videobox 4.1.1 - Download Flash video th...
Videobox allows you to quickly and easily download Flash video from most all of the popular video sites on the internet. Videobox will convert the video into a native Quicktime format so it's ready... Read more

Latest Forum Discussions

See All

Trolls vs Vikings Update Adds Over One H...
Trolls vs Vikings Update Adds Over One Hundred Levels, Reduces Item Cost, and More Posted by Ellis Spice on August 22nd, 2014 [ permalink ] | Read more »
SNK Celebrates the 20th Anniversary of T...
SNK Celebrates the 20th Anniversary of The King of Fighters With a Big Sale Posted by Ellis Spice on August 22nd, 2014 [ permalink ] | Read more »
It Came From Canada: Star Wars: Commande...
With a brand new Star Wars trilogy on the horizon, prepare yourselves for Disney and George Lucas’s space fantasy throwback to be more omnipresent than ever before. So it should come as no surprise that new adventures in that galaxy far, far away... | Read more »
Swing Copters Review
Swing Copters Review By Jordan Minor on August 22nd, 2014 Our Rating: :: DIE TRYINGUniversal App - Designed for iPhone and iPad The creator of Flappy Bird is back with a vengeance.   | Read more »
The Outcast Review
The Outcast Review By Nadia Oxford on August 22nd, 2014 Our Rating: :: HANDS OFF. WAY OFF.Universal App - Designed for iPhone and iPad It’s easy to see what The Outcast is trying for, but its execution needs a lot of work.   | Read more »
Brain+ Review
Brain+ Review By Nadia Oxford on August 22nd, 2014 Our Rating: :: DIM BULBUniversal App - Designed for iPhone and iPad Brain+ is just another entry in an over-saturated brain-training marketplace – and not a particularly fun entry... | Read more »
The Witcher Battle Arena – New Gameplay...
The Witcher Battle Arena – New Gameplay Trailer Revealed Posted by Jessica Fisher on August 22nd, 2014 [ permalink ] Based in the Witcher universe, | Read more »
Max Gentlemen Review
Max Gentlemen Review By Jennifer Allen on August 22nd, 2014 Our Rating: :: OUTSTAYING ITS WELCOMEiPhone App - Designed for the iPhone, compatible with the iPad Max Gentlemen seems pretty quirky initially but that appeal wears thin... | Read more »
Club Penguin Gets Frozen All Over in Lat...
Club Penguin Gets Frozen All Over in Latest Takeover Event Posted by Ellis Spice on August 22nd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Doctor Who: Legacy Review
Doctor Who: Legacy Review By Jennifer Allen on August 22nd, 2014 Our Rating: :: RUN OF THE MILLUniversal App - Designed for iPhone and iPad Doctor Who: Legacy is an ok match-3 puzzle game, but it lacks some much needed personality... | Read more »

Price Scanner via MacPrices.net

Leftover 15-inch 2.0GHz Retina MacBook Pros a...
B&H Photo has leftover previous-generation 15″ 2.0GHz Retina MacBook Pros now available for $1599 including free shipping plus NY sales tax only. Their price is $400 off original MSRP. B&H... Read more
Pro.Calendar – New Productivity App for iPad...
Austin, Texas based mobile business and productivity app developer LightArrow, Inc. has announced Pro.Calendar, a powerful and intuitive calendar app with eight versatile calendar options including... Read more
SanDisk Ultra II SSD — Supercharge Your Syste...
SanDisk Corporation has announced the new SanDisk Ultra II SSD with enhanced SSD Dashboard. The new drive is designed to deliver a cost-effective and easy upgrade solution for PC owners looking to... Read more
Samsung and Barnes & Noble Introduce New...
Samsung Electronics America and NOOK Media, a subsidiary of Barnes & Noble, Inc. have announced the introduction of the new Samsung Galaxy Tab 4 NOOK, a 7-inch tablet combining Samsung’s leading... Read more
21-inch iMacs on sale for up to $150 off MSRP
B&H Photo has 21″ iMacs on sale for up to $150 off MSRP including free shipping plus NY sales tax only. B&H will also include a free copy of Parallels Desktop software: - 21″ 2.7GHz iMac: $... Read more
27-inch 3.2GHz iMac on sale for $1698, save $...
Abt has the 27″ 3.2GHz iMac on sale for $1698 including free shipping. Their price is $101 off MSRP. Read more
Mac Backup Guru 2.0 Drive Backup/Cloneing Uti...
Mac Backup Guru developer MacDaddy has released Mac Backup Guru 2.0, offering new and enhanced advanced features, such as bootable backups, synchronised volumes and folders, and a Snapshot mode that... Read more
Operate GE’s New Free-Standing KItchen Range...
Think you accidentally left the oven on? Switch it off while on the go. The new free-standing Profile™ Series gas and electric ranges are GE’s second cooking appliances, following their wall oven, to... Read more
Parallels Announces Parallels Desktop 10 for...
The no. 1-selling software for running Windows applications on a Mac becomes an even easier choice for millions of consumers and IT professionals worldwide with the launch of the most powerful... Read more
Apple now offering certified refurbished 2014...
 The Apple Store is now offering Apple Certified Refurbished 2014 MacBook Airs for up to $180 off the cost of new models. An Apple one-year warranty is included with each MacBook, and shipping is... Read more

Jobs Board

Project Manager / Business Analyst, WW *Appl...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work 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
Position Opening at *Apple* - Apple (United...
**Job Summary** As more and more people discover Apple , they visit our stores seeking ways to incorporate our products into their lives. It's your job, as a Store Read more
Position Opening at *Apple* - Apple (United...
…Summary** As a Specialist, you help create the energy and excitement around Apple products, providing the right solutions and getting products into customers' hands. You Read more
Project Manager, *Apple* Financial Services...
**Job Summary** Apple Financial Services (AFS) offers consumers, businesses and educational institutions ways to finance Apple purchases. We work with national and Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.