TweetFollow Us on Twitter

Separate Data, Code
Volume 8
Number4
Column Title:Getting Started

Related Info: Resource Manager Window Manager Picture Utilities

Separating Data from Code

Using those little pockets of data called resources

By Dave Mark, MacTutor Regular Contributing Author

Note: Source code files accompanying article are located on MacTech CD-ROM or source code disks.

Last month’s column focused on QuickDraw, the Macintosh drawing environment. The TextBoxer program showed you how to use QuickDraw in combination with the Window Manager to draw text and graphics in a window. This month we’ll learn about resources, the Mac’s mechanism for separating data from code.

Resources

Resources are little pockets of data, designed to pull descriptive data out of your program’s source code. For example, a WIND resource describes the size, location, and characteristics of a Macintosh window. In last month’s column, we used the Window Manager call NewWindow() to create a new window:

/* 1 */

WindowPtr window;
Rect    windowRect;
 
SetRect( &windowRect, 20, 40, 260, 74 );

window = NewWindow( nil, &windowRect, "\pBox o’ Text",
 kVisible, documentProc, kMoveToFront,
 kNoGoAway, kNilRefCon );

The parameters passed to NewWindow() completely describe the window. The trouble is, the description is inexorably bound into the source code. To change the size or position of the window, you’ve got to recompile your program. The WIND resource gives you an alternative to this strategy. Here’s how it works...

Basic Resource Strategy

At the heart of any resource strategy is a resource editor. Though there are others, for my money [especially since it is free - Ed.] ResEdit can’t be beat. ResEdit allows you to edit resources using a graphic resource editor designed for that resource type. For example, Figure 1 shows ResEdit’s WIND editing window.

This window gives you all the tools you’ll need to completely describe a window. At the top is a row of icons that let you select the type of window you’d like to create. At bottom-left is a series of fields you can use to describe the size and location of the window. In the center is a miniature version of your screen, showing how your window will look once it’s created.

Figure 1. ResEdit’s WIND editing window.

Once you design your resources, you load them into your program using a set of Toolbox routines designed to work with resources. As an example, the routine GetNewWindow() loads a WIND resource and creates the same kind of WindowRecord as the Window Manager routine NewWindow():

/* 2 */

window = GetNewWindow( kBaseResID, nil, kMoveToFront );

If you use NewWindow() to create a window, the data that describes the window is embedded in the source code in the form of NewWindow() parameters. If you use GetNewWindow(), the data that describes the window resides outside of your program’s code, in the WIND resource. The WIND resource acts as a template for creating a window.

As you spend more time programming the Macintosh, you’ll learn more and more about the enormous potential of resources. For now, we’ll start slowly, introducing a few basic resources in this column, and adding to our list each month.

Resource Management Specifics

Resources are identified by a resource type and a resource ID. The resource type is a four-byte value, typically made up of readable ASCII characters. The resource type defines the data described by the resource. For example, a WIND resource always follows the same format and always describes a Macintosh window. There are lots of different resource types.

A program can contain more than one resource of a given type. The resource ID serves to differentiate one resource of a given type from another. Typically, resource IDs start at 128 and move upwards from there. If your program used three WIND resources, you’d number them 128, 129, and 130.

This month’s sample program, PICTWindow, makes use of two resources, a PICT and a WIND. The PICT resource contains a Macintosh picture. PICTWindow uses the WIND resource to create a new window, loads the PICT resource into memory, then draws the PICT in the window.

Let’s get to work...

Creating the PICTWindow Resources

If you don’t already have a copy of ResEdit, go out and get one. You can download ResEdit from most of the big bulletin boards, and you can purchase ResEdit from APDA.

In my latest APDA catalog, there were three entries for ResEdit version 2.1.1. $29.95 gets you the manual and disk, $14.95 is the manual only, and $15.00 for the disk only. You can reach APDA by phone at (800) 282-2732 in the United States, (800) 637-0029 in Canada, and (408) 562-3910 internationally.

You might also consider ordering the book ResEdit Complete, a fine book written by Peter Alley and Carolyn Strange ($29.95 from APDA).

Once you’ve copied your copy of ResEdit to your hard drive, create a folder for all the PICTWindow files inside your development folder. I called my folder (logically enough) PICTWindow.

Next, use your favorite graphics package to create a pleasing picture. Copy the picture, then paste it into the Scrapbook. Feel free to use color, text, and whatever else pleases your eye in your picture. PICTWindow can handle anything you can paste into the Scrapbook.

Now you’re ready to create some resources. Double-click on the ResEdit icon to start-up ResEdit. When the bouncing Jack-in-the-box appears, click the mouse button. You’ll be prompted for a file to open (if your version of ResEdit doesn’t prompt you, it’s OK, just ignore the rest of this paragraph). Click the Cancel button.

We’re going to create a new resource file. Select New... from the File menu. The dialog box shown in Figure 2 will appear, asking you to name the new resource file. Using the standard techniques, navigate over and in to the PICTWindow folder you created earlier. In the text field at the bottom of the dialog box, type the file name PICTWindow.Π.rsrc exactly as it appears in Figure 2. To type the Π character, hold down the option key and press the p key. Be sure to type the name exactly as shown. Don’t add anything. Don’t leave anything out. You’ll see why later in the column.

Figure 2. Naming your new resource file.

Once the name is typed in, click on the New button. ResEdit will create the new resource file and display a window showing the resources in this file. So far, there are none. We’ll fix that right now.

Select Create New Resource from the Resource menu. A scrolling list of resource types will appear (Figure 3). Scroll to the bottom of the list and select WIND (if you prefer, you can type WIND in the text field). Once WIND is selected (or typed) click the OK button. A WIND icon will be added to the PICTWindow.Π.rsrc main window, showing you that a WIND resource exists. A WIND picker window will appear, listing all the WIND resources in this file. Finally, on top of the other two, a WIND editing window will appear, allowing you to edit your new WIND.

Figure 3. Creating a new WIND resource.

By default, your new WIND resource is given the resource ID 128. That’s convenient, since that’s the number we wanted it to have. Use the settings shown in Figure 4 to modify your WIND resource. Click the second icon from the left (at the top of the window) and type in the four numbers shown in the lower left corner.

Figure 4. The WIND editing window from WIND 128.

Next, select Set 'WIND' Characteristics... from the WIND menu that appeared along with the WIND editor. Type in an appropriate window title (don’t change any of the other fields) and click the OK button. Congratulations! You’ve just created your first Macintosh resource. Close the WIND editing window and the WIND picker window, leaving the main window for the resource file. A WIND icon should appear in this window.

Let’s add the second resource needed by our program, the PICT resource. Go to the Scrapbook and Copy the picture you pasted in there earlier (if you prefer, Copy one of the pictures that come with the Scrapbook - Don’t copy plain text. Plain text won’t do what we want).

Once your picture is copied, bring the PICTWindow.Π.rsrc window back to the front and select Paste from ResEdit’s Edit menu. A new resource will be created and a PICT icon will appear in the main window verifying this fact. The PICT resource will automatically be given the resource ID 128. Now would be an excellent time to select Save from the File menu. You are done creating resources.

Quit ResEdit by selecting Quit from the File menu.

Creating the PICTWindow Project

Startup THINK C and create a new project in the PICTWindow folder. Name the new project PICTWindow.Π (be sure to spell it exactly this way). When you run a project, THINK C automatically tacks on the five characters “.rsrc” to the end of the project name and looks for a resource file with that name. If a resource file with that name is found, the resources in that file are automatically made available to your program. PICTWindow.Π is the name of your project file and PICTWindow.Π.rsrc is the name of your resource file.

Once the project is created, go into the Mac Libraries folder and add MacTraps to the project. Next, select New from the File menu to create a new source code file. Type in this source code:

/* 3 */

#define kBaseResID 128
#define kMoveToFront (WindowPtr)-1L


/***************/
/*  Functions  */
/***************/

void  ToolBoxInit( void );
void  WindowInit( void );
void  DrawMyPicture( void );


/****************** main ***************************/

void  main( void )
{
 ToolBoxInit();
 WindowInit();
 
 DrawMyPicture();
 
 while ( !Button() ) ;
}


/****************** ToolBoxInit *********************/

void  ToolBoxInit( void )
{
 InitGraf( &thePort );
 InitFonts();
 InitWindows();
 InitMenus();
 TEInit();
 InitDialogs( nil );
 InitCursor();
}


/****************** WindowInit ***********************/

void  WindowInit( void )
{
 WindowPtrwindow;
 
 window = GetNewWindow( kBaseResID, nil, kMoveToFront );
 
 if ( window == nil )
 {
 SysBeep( 10 );  /*  Couldn't load the WIND resource!!!  */
 ExitToShell();
 }
 
 ShowWindow( window );
 SetPort( window );
}


/****************** DrawMyPicture ********************/

void  DrawMyPicture( void )
{
 Rect   pictureRect;
 PicHandlepicture;
 
 picture = GetPicture( kBaseResID );
 
 if ( picture == nil )
 {
 SysBeep( 10 );  /*  Couldn't load the PICT resource!!!  */
 ExitToShell();
 }
 
 pictureRect = (**picture).picFrame;
 
 OffsetRect( &pictureRect, - pictureRect.left,
 - pictureRect.top );
 
 DrawPicture( picture, &pictureRect );
 
 FrameRect( &pictureRect );
}

Once your source code is typed in, select Save from the File menu. Save the file under the name “PICTWindow.c”. Next, add the source file to the project by select Add (not Add...) from the Source menu. Your project window should look like the one shown in Figure 5.

Figure 5. The project window for PICTWindow.Π.

Running the Program

Now you’re ready to run your program. Select Run from the Project menu. If you encounter any errors, check your source code for typos and make sure your project window has the two files shown in Figure 5. Once your program runs, you should see a window similar to the one shown in Figure 6.

Notice that the picture is drawn in the upper left corner of the window. The upper left corner of the picture is at (0,0) in the window’s local coordinate system.

Figure 6. The PICTWindow window!

Key Lines of Code

Most of the program should make sense to you if you read through last month’s TextBoxer example. Rather than repeat last weeks explanations, I’d like to point out three key segments of code. The first is the code that loads the WIND resource and creates a new window:

/* 4 */

 window = GetNewWindow( kBaseResID, nil, kMoveToFront );

As mentioned earlier, this line of code accomplishes the same thing as NewWindow(), except that GetNewWindow() gets its information from the WIND resource, instead of its parameter list. GetNewWindow() is described in Volume I of Inside Macintosh, on page 283.

The second key line of code is the line that loads the PICT resource:

/* 5 */

 picture = GetPicture( kBaseResID );

This line of code loads the PICT resource with an ID matching kBaseResID. Match this line of code up with the following:

/* 6 */

 DrawPicture( picture, &pictureRect );

and you can really see the power of resources. Two lines of code and you’ve drawn a complex graphic in a window!!! By the way, GetPicture() is on page 475 of Volume I of Inside Macintosh and DrawPicture() is on page 190 of Volume I.

Till Next Month

Take some time to play around with ResEdit. Use ResEdit to modify your WIND resource, changing the type of window (click on the icons on the top row of the WIND editor) and the window’s location. Notice that the picture is drawn in the upper left of the window, no matter where the window is drawn on the screen. Look up OffsetRect() in Inside Macintosh and try to figure out why the picture is drawn where it is.

Finally, try to write a routine that centers the picture in the window. For a little help with this last exercise, you can check out the ShowPICT program in Volume I of the Mac Primer.

Sorry to cut this column short, but the next time I speak with you all, I should be a proud new poppa! Stay tuned...

 
AAPL
$118.80
Apple Inc.
+1.20
MSFT
$47.48
Microsoft Corpora
+0.01
GOOG
$539.34
Google Inc.
-1.74

MacTech Search:
Community Search:

Software Updates via MacUpdate

RapidWeaver 6.0.3 - Create template-base...
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
iPhoto Library Manager 4.1.10 - Manage m...
iPhoto Library Manager lets you organize your photos into multiple iPhoto libraries. Separate your high school and college photos from your latest summer vacation pictures. Or keep some photo... Read more
iExplorer 3.5.1.9 - View and transfer al...
iExplorer is an iPhone browser for Mac lets you view the files on your iOS device. By using a drag and drop interface, you can quickly copy files and folders between your Mac and your iPhone or... Read more
MacUpdate Desktop 6.0.3 - Discover and i...
MacUpdate Desktop 6 brings seamless 1-click installs and version updates to your Mac. With a free MacUpdate account and MacUpdate Desktop 6, Mac users can now install almost any Mac app on macupdate.... Read more
SteerMouse 4.2.2 - Powerful third-party...
SteerMouse is an advanced driver for USB and Bluetooth mice. It also supports Apple Mighty Mouse very well. SteerMouse can assign various functions to buttons that Apple's software does not allow,... Read more
iMazing 1.1 - Complete iOS device manage...
iMazing (was DiskAid) is the ultimate iOS device manager with capabilities far beyond what iTunes offers. With iMazing and your iOS device (iPhone, iPad, or iPod), you can: Copy music to and from... Read more
PopChar X 7.0 - Floating window shows av...
PopChar X helps you get the most out of your font collection. With its crystal-clear interface, PopChar X provides a frustration-free way to access any font's special characters. Expanded... Read more
Carbon Copy Cloner 4.0.3 - Easy-to-use b...
Carbon Copy Cloner backups are better than ordinary backups. Suppose the unthinkable happens while you're under deadline to finish a project: your Mac is unresponsive and all you hear is an ominous,... Read more
ForeverSave 2.1.3 - Universal auto-save...
ForeverSave auto-saves all documents you're working on while simultaneously doing backup versioning in the background. Lost data can be quickly restored at any time. Losing data, caused by... Read more
Voila 3.8.1 - Capture, annotate, organiz...
Voila is a screen-capture, recording, and annotation tool that is a full-featured replacement for Mac's screen-capture and screen-recording capabilities. It has a large and robust set of editing,... Read more

Latest Forum Discussions

See All

Sunburn! Review
Sunburn! Review By Campbell Bird on November 26th, 2014 Our Rating: :: DON'T DIE ALONEUniversal App - Designed for iPhone and iPad Platform through the depths of space to make sure your entire crew dies together in this satisfying... | Read more »
Black Friday has Started Early – Lots an...
It’s almost turkey time! Which means lots and lots of food but also lots and lots of sales. Some sales have even started a few days early, which is why we’ve put together a list of iOS games that are currently discounted (sometimes by a lot).... | Read more »
Loose Leaf Review
Loose Leaf Review By Jennifer Allen on November 26th, 2014 Our Rating: :: SIMPLE SKETCHINGiPad Only App - Designed for the iPad Sketch out ideas with simple drawing tools, courtesy of Loose Leaf.   | Read more »
Screeny (Utilities)
Screeny 1.0 Device: iOS iPhone Category: Utilities Price: $.99, Version: 1.0 (iTunes) Description: Screeny is an utility app that helps you save space consumed by screenshots. It screens your camera roll and helps you to filter and... | Read more »
Tilt to Live Bundle Set to Arrive This T...
Tilt to Live Bundle Set to Arrive This Thanksgiving Posted by Ellis Spice on November 25th, 2014 [ permalink ] One Man Left has unveiled an upcoming Tilt to Live bundle, allowing players to get the series for a di | Read more »
BattleLore: Command (Entertainment)
BattleLore: Command 1.0 Device: iOS Universal Category: Entertainment Price: $9.99, Version: 1.0 (iTunes) Description: ***NOTE: Compatible with iPad 2/iPad mini, iPod touch 5 and up and iPhone 4S and up – WILL NOT RUN ON EARLIER... | Read more »
Weather Or Not Review
Weather Or Not Review By Jennifer Allen on November 25th, 2014 Our Rating: :: STYLISH WEATHER REPORTINGiPhone App - Designed for the iPhone, compatible with the iPad Check the weather quickly and conveniently with Weather or Not... | Read more »
The All-New Football Manager Handheld 20...
The All-New Football Manager Handheld 2015 is Available Now Posted by Jessica Fisher on November 25th, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Six iOS Games to Get You Ready for Thank...
Image Source: Friends Wiki At this point in the month, you or at least a few people you know are probably getting ready to scramble around (or are already scrambling around) for Thanksgiving Dinner. It’s a hectic day of precise oven utilization, but... | Read more »
Call of Duty: Heroes: Tips, Tricks, and...
Hello Heroes: What’d we think of Call of Duty‘s take on Clash of Clans? Check out our Call of Duty: Heroes review to find out! Just downloaded Call of Duty: Heroes and need some handy tips and tricks on how to get ahead of the rest? As we often do,... | Read more »

Price Scanner via MacPrices.net

Early Black Friday Mac Pro sale, 6-Core 3.5GH...
 B&H Photo has the 6-Core 3.5GHz Mac Pro on sale today for $3499 including free shipping plus NY sales tax. Their price is $500 off MSRP, and it’s the lowest price available for this model from... Read more
Early Black Friday sale price: 15-inch 2.2GHz...
 B&H Photo has the 2014 15″ 2.2GHz Retina MacBook Pro on sale today for $1699.99. Shipping is free, and B&H charges NY sales tax only. Their price is $300 off MSRP, equalling Best Buy’s price... Read more
13-inch 2.5GHz MacBook Pro (refurbished) avai...
The Apple Store has Apple Certified Refurbished 13″ 2.5GHz MacBook Pros available for $170 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free: - 13″ 2.5GHz... Read more
Early Black Friday iPad mini 3 sale: $75 off...
 Best Buy has iPad mini 3s on sale for $75 off MSRP on their online store for a limited time. Choose free shipping or free local store pickup (if available). Sale prices available for online orders... Read more
Early Black Friday MacBook Pro sale: 15-inch...
 Best Buy has posted early Black Friday prices on 15″ Retina MacBook Pros, with models on sale for $300 off MSRP on their online store for a limited time. Choose free local store pickup (if available... Read more
A9 Chips Already?
It’s barely more than a couple of months since Apple got the first A8 systems-on-chip into consumer hands, but rumor and news focus is already turning to the next-generation A9 SoC. Apple Daily... Read more
NewerTech Announces NuGuard KXs Impact X-Orbi...
NewerTech has announced updates to its family of Impact X-Orbing Screen Armor bringing military grade, triple layer protection to Apple’s new iPhone 6 and 6 Plus. Like all models in the NuGuard KXs... Read more
13-inch 1.4GHz MacBook Air on sale for $889,...
 B&H Photo has the 13″ 1.4GHz/128GB MacBook Air on sale for $889 including free shipping plus NY tax only. Their price is $110 off MSRP. B&H will also include free copies of Parallels Desktop... Read more
Save up to $300 on Macs and iPads with your A...
Purchase a new Mac or iPad at The Apple Store for Education and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free,... Read more
Apple refurbished Mac Pros available for up t...
The Apple Store is offering Apple Certified Refurbished 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

Jobs Board

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