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
$102.99
Apple Inc.
+0.52
MSFT
$44.38
Microsoft Corpora
-0.50
GOOG
$532.71
Google Inc.
+6.17

MacTech Search:
Community Search:

Software Updates via MacUpdate

OmniOutliner 4.1.3 - Organize your ideas...
OmniOutliner is a flexible program for creating, collecting, and organizing information. Give your creativity a kick start by using an application that's actually designed to help you think. It's... Read more
BBEdit 11.0 - Powerful text and HTML edi...
BBEdit is the leading professional HTML and text editor for the Mac. Specifically crafted in response to the needs of Web authors and software developers, this award-winning product provides a... Read more
Apple Security Update 2014-005 - For OS...
Apple Security Update is recommended for all users and improves the security of Mac OS X. For information on the security content of this update, please visit this website: http://support.apple.com/... Read more
EyeTV 3.6.6 - Watch and record TV on you...
EyeTV brings a rich TV experience to your Mac. Watch live TV on your Mac. Pause, rewind, and record whenever you want. EyeTV gives you powerful control over what you watch and how you watch it. Put... Read more
RapidWeaver 6.0 - Create template-based...
RapidWeaver is a next-generation Web design application to help you easily create professional-looking Web sites in minutes. No knowledge of complex code is required, RapidWeaver will take care of... Read more
NTFS 12.0.39 - Provides full read and wr...
Paragon NTFS breaks down the barriers between Windows and OS X. Paragon NTFS effectively solves the communication problems between the Mac system and NTFS, providing full read and write access to... Read more
RestoreMeNot 2.0.3 - Disable window rest...
RestoreMeNot provides a simple way to disable the window restoration for individual applications so that you can fine-tune this behavior to suit your needs. Please note that RestoreMeNot is designed... Read more
Command-C 1.1.5 - Clipboard sharing tool...
Command-C is a revolutionary app which makes easy to share your clipboard between iOS and OS X using your local WiFi network, even if the app is not currently opened. Copy anything (text, pictures,... Read more
Macgo Blu-ray Player 2.10.9.1750 - Blu-r...
Macgo Mac Blu-ray Player can bring you the most unforgettable Blu-ray experience on your Mac. Overview Macgo Mac Blu-ray Player can satisfy just about every need you could possibly have in a Blu-ray... Read more
Apple iOS 8.1 - The latest version of Ap...
The latest version of iOS can be downloaded through iTunes. Apple iOS 8 comes with big updates to apps you use every day, like Messages and Photos. A whole new way to share content with your family.... Read more

Latest Forum Discussions

See All

TinType by Hipstamatic (Photography)
TinType by Hipstamatic 1.0 Device: iOS iPhone Category: Photography Price: $.99, Version: 1.0 (iTunes) Description: Create hauntingly beautiful, soul capturing portraits with TinType by Hipstamatic. Inspired by daguerreotypes,... | Read more »
The Latest Update for Heroes of Dragon A...
The Latest Update for Heroes of Dragon Age Introduces Daily PvE Challenges Posted by Ellis Spice on October 22nd, 2014 [ permalink ] | Read more »
A New Trailer has Been Revealed for Epic...
A New Trailer has Been Revealed for Epic of Kings Posted by Jessica Fisher on October 22nd, 2014 [ permalink ] Dead Mage Inc. has released a new, action-packed trailer for the upcoming Epic of Kings. | Read more »
Find the Line Review
Find the Line Review By Campbell Bird on October 22nd, 2014 Our Rating: :: INSLIDE THE LINESUniversal App - Designed for iPhone and iPad Tease out beautiful line drawings in this unique, free-to-play puzzle game.   | Read more »
The Silent Age Episode 2 Review
The Silent Age Episode 2 Review By Jennifer Allen on October 22nd, 2014 Our Rating: :: ROUNDING THINGS OFF NICELYUniversal App - Designed for iPhone and iPad Rounding off a great point and click adventure comes The Silent Age... | Read more »
Craft Your Own Mini-Games with Papercade
Craft Your Own Mini-Games with Papercade Posted by Jessica Fisher on October 22nd, 2014 [ permalink ] iPad Only App - Designed for the iPad Scrapbookers move over, Scrapgaming is the new thing. | Read more »
Reshape Review
Reshape Review By Jennifer Allen on October 22nd, 2014 Our Rating: :: SIMPLE SHAPESUniversal App - Designed for iPhone and iPad Match triangles together to form cubes in this fast-paced and twitchy game.   | Read more »
Miika (Games)
Miika 1.0.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0.0 (iTunes) Description: Miika is a beautiful 3D puzzle game based on camera perspectives combined with the use of optical illusions. Miika challenges... | Read more »
Infuse Pro (Photography)
Infuse Pro 3.0 Device: iOS Universal Category: Photography Price: $9.99, Version: 3.0 (iTunes) Description: ** All-new version 3 includes fully licensed and certified DTS® and DTS-HD® audio! ** | Read more »
Swap Heroes (Games)
Swap Heroes 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: **Half price for a limited time only** Swap Heroes is a casual turn-based strategy adventure. Form a group of heroes and guide them... | Read more »

Price Scanner via MacPrices.net

Save with Best Buy’s College Student Deals
Take an additional $50 off all MacBooks and iMacs at Best Buy Online with their College Students Deals Savings, valid through November 1st. Anyone with a valid .EDU email address can take advantage... Read more
iPad Air 2 & iPad mini 3 Best Tablets Yet...
The new iPads turned out to be pretty much everything I’d been hoping for and more than I’d expected.”More” particularly in terms of a drinking-from-a-firehose choice of models and configurations,... Read more
Drafts 4 Reinvents iOS Productivity App
N Richland Hills, Texas based Agile Tortoise has announced the release of Drafts 4 for iPhone and iPad. Drafts is a quick capture note taking app with flexible output actions. Drafts 4 scales from... Read more
AT&T accepting preorders for new iPads fo...
AT&T Wireless is accepting preorders for the new iPad Air 2 and iPad mini 3, cellular models, for $100 off MSRP with a 2-year service agreement: - 16GB iPad Air 2 WiFi + Cellular: $529.99 - 64GB... Read more
Apple offering refurbished Mac Pros for up to...
The Apple Store is offering Apple Certified Refurbished 2013 Mac Pros for up to $600 off the cost of new models. An Apple one-year warranty is included with each Mac Pro, and shipping is free. The... Read more
Select MacBook Airs $100 off MSRP, free shipp...
B&H Photo has 2014 a couple of MacBook Airs on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only. They also include free copies of Parallels Desktop and LoJack for... Read more
13-inch 2.5GHz MacBook Pro on sale for $100 o...
B&H Photo has the 13″ 2.5GHz MacBook Pro on sale for $999.99 including free shipping plus NY sales tax only. Their price is $100 off MSRP. Read more
Strong iPhone, Mac And App Store Sales Drive...
Apple on Monday announced financial results for its fiscal 2014 fourth quarter ended September 27, 2014. The Company posted quarterly revenue of $42.1 billion and quarterly net profit of $8.5 billion... Read more
Apple Posts How-To For OS X Recovery
OS X 10.7 Lion and later include OS X Recovery. This feature includes all of the tools you need to reinstall OS X, repair your disk, and even restore from a Time Machine backup. OS X Recovery... Read more
Mac OS X Versions (Builds) Supported By Vario...
Apple Support has posted a handy resource explaining which Mac OS X versions (builds) originally shipped with or are available for your computer via retail discs, downloads, or Software Update. Apple... Read more

Jobs Board

Senior Event Manager, *Apple* Retail Market...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global event strategy. Delivering an overarching brand story; in-store, Read more
*Apple* Solutions Consultant (ASC) - Apple (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
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...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Position Opening at *Apple* - Apple (United...
…customers purchase our products, you're the one who helps them get more out of their new Apple technology. Your day in the Apple Store is filled with a range of Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.