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
$100.75
Apple Inc.
+0.64
MSFT
$46.36
Microsoft Corpora
-0.08
GOOG
$577.36
Google Inc.
+1.00

MacTech Search:
Community Search:

Software Updates via MacUpdate

QuickBooks 2015 16.0.0.1352 R1 - Financi...
QuickBooks 2015 helps you manage your business easily and efficiently. Organize your finances all in one place, track money going in and out of your business, and spot areas where you can save.... Read more
Mac DVDRipper Pro 5.0.1 - Copy, backup,...
Mac DVDRipper Pro is the DVD backup solution that lets you protect your DVDs from scratches, save your batteries by reading your movies from your hard disk, manage your collection with just a few... Read more
Apple OS X bash Update 1.0 - Fix for sec...
The OS X bash Update fixes a security flaw in the bash UNIX shell on OS X 10.9.5 (also on OS X 10.8 and 10.7 [see Related Links below]). OS X 10.9.5 or later Downloads for OS X 10.8 and OS X 10.7 in... Read more
SyncTwoFolders 2.0.5 - Syncs two user-sp...
SyncTwoFolders simply synchronizes two folders. It supports synchronization across mounted network drives and it is a possibility to run a simulation showing in a log what will be done. Please visit... Read more
FinderPop 2.5.7 - Classic Mac utility, n...
FinderPop is a Universal preference pane that extends OS X's contextual menus using a FinderPop Items folder much as the Apple Menu Items folder used to do for the Apple menu. It has other features... Read more
VueScan 9.4.45 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
LibreOffice 4.3.2.2 - Free Open Source o...
LibreOffice is an office suite (word processor, spreadsheet, presentations, drawing tool) compatible with other major office suites. The Document Foundation is coordinating development and... Read more
calibre 2.4 - Complete e-library managem...
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
Default Folder X 4.6.9b1 - Enhances Open...
Default Folder X attaches a toolbar to the right side of the Open and Save dialogs in any OS X-native application. The toolbar gives you fast access to various folders and commands. You just click... Read more
Beamer 2.0.4 - Stream any movie file fro...
Beamer streams to your Apple TV.... Plays any movie file - Just like the popular desktop movie players, Beamer accepts all common formats, codecs and resolutions. AVI, MKV, MOV, MP4, WMV, FLV. To... Read more

Latest Forum Discussions

See All

apeFilter (Music)
apeFilter 1.0 Device: iOS Universal Category: Music Price: $6.99, Version: 1.0 (iTunes) Description: | Read more »
Shred It! Review
Shred It! Review By Jennifer Allen on September 30th, 2014 Our Rating: :: GORGEOUS BUT BASICUniversal App - Designed for iPhone and iPad It might look lovely, but Shred It! is a pretty shallow endless runner/snowboarding game.   | Read more »
It Came From Canada: Angry Birds: Transf...
Anyone afraid that throwing Transformers into the Angry Birds mix would result in a Michael Bay-level of childhood pillaging can rest easy. While Rovio’s famous fowls may be a 21st century staple, Angry Birds: Transformers wears its affection for... | Read more »
Galaxy Trucker Review
Galaxy Trucker Review By Rob Thomas on September 30th, 2014 Our Rating: :: IN FOR THE LONG HAULiPad Only App - Designed for the iPad We got a great big convoy, rockin’ through the night… the endless night of outer space, that is.... | Read more »
Moon and Sun – children’s book Review
Moon and Sun – children’s book Review By Amy Solomon on September 30th, 2014 Our Rating: Moon and Sun is a fable-like children’s book with lush illustrations.   Developer: Marcio Monteiro Price: $3.99 Version: 1.0 App Reviewed on... | Read more »
Kairosoft Finally Brings The Pyraplex to...
Kairosoft Finally Brings The Pyraplex to iOS Posted by Jessica Fisher on September 30th, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Yeti’s Parole Officer Review
Yeti’s Parole Officer Review By Jennifer Allen on September 30th, 2014 Our Rating: Universal App - Designed for iPhone and iPad Yeti’s Parole Officer proves that looks aren’t everything in this entertaining, if plain, piece of... | Read more »
Record Keeper and World Wide Words – Two...
Record Keeper and World Wide Words – Two New Final Fantasy Games Arrive on iOS in Japan Posted by Ellis Spice on September 30th, 2014 [ permalink ] | Read more »
iPollute Review
iPollute Review By Nadia Oxford on September 30th, 2014 Our Rating: :: iPOLLUTE, uPOLLUTEUniversal App - Designed for iPhone and iPad iPollute is a delightful-looking pollution simulator, though it’s a bit light on “game” content... | Read more »
This Week at 148Apps: September 22-26, 2...
Your Source For The Latest App Reviews   | Read more »

Price Scanner via MacPrices.net

MacBook Airs on sale for $100 off MSRP, start...
Best Buy has the new 2014 MacBook Airs on sale for $100 off MSRP on their online store. Choose free home shipping or free local store pickup (if available). Prices valid for online orders only, in-... Read more
Apple Releases OS X Mavericks bash Update 1.0...
Apple has released a patch update for OS X Mavericks users to address the recently-detected “Shellshock” security bug in BSD UNIX’s bash shell. Apple says only a few Mac users who had manually... Read more
Pivotal Payments Ready for Apple Pay – FlexPo...
Pivotal Payments, a provider of merchant services and global payment processing solutions, has announced its proprietary FlexPoint platform will support credit and debit transactions through Apple’s... Read more
iStabilizer Announces Tabarm — First Friction...
iStabilizer, a specialist in universal lightweight compact tripods, steady cams, dollies, mounts, and remotes for smartphones, tablets, and cameras, announced today the iStabilizer tabArm, the first... Read more
IStabilizer Flex Smartphone Tripod Wins Usa T...
iStabilizer, a specialist in universal lightweight compact tripods, steady cams, and other products for smartphones, tablets, and cameras, has announced today that its iStabilizer Flex smartphone... Read more
13-inch 2.8GHz Retina MacBook Pro on sale for...
B&H Photo has the new 2014 13″ 2.8GHz Retina MacBook Pro on sale for $1699.99 including free shipping plus NY sales tax only. They’ll also include free copies of Parallels Desktop and LoJack for... Read more
15-inch Retina MacBook Pros on sale for up to...
B&H Photo has the new 2014 15″ Retina MacBook Pros on sale for up to $150 off MSRP. Shipping is free, and B&H charges NY sales tax only. They’ll also include free copies of Parallels Desktop... Read more
Get Down to Business On Your iPad With Free N...
Utah based Poem LLC has introduced Nexticy 1.0, a full-featured, affordable (Free) forms application for iPad. Nexticy makes it ‘way easy’ to create, store, retrieve and analyze paper-like forms of... Read more
13-inch Retina MacBook Pros on sale for $100...
Best Buy has 13-inch 2.6GHz Retina MacBook Pros on sale for $100 off MSRP on their online store. Choose free shipping or free local store pickup (if available). Prices are for online orders only, in-... Read more
Reports Outline Claimed 12-Inch Macbook Air D...
Blogger Jack March says that according to information he’s received from an anonymous “source familiar with Apple’s plans,” the next-generation MacBook Air will launch in mid-2015 and be available... Read more

Jobs Board

*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
*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
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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.