TweetFollow Us on Twitter

Rez Is Your Friend

Volume Number: 14 (1998)
Issue Number: 9
Column Tag: Tools Of The Trade

Rez is Your Friend

by Marshall Clow
Edited by the MacTech Editorial Staff

What is Rez and why should I care?

What is Rez?

Every Macintosh program is made up of resources. Dialogs, Alerts, String Lists, the list goes on and on. These resources have to be created by the someone, and are part of the program. Every programmer is familiar with ResEdit or Resorcerer, which let you edit resources visually. Fewer programmers know about Rez, the resource compiler.

Rez is a compiler, like a C, Pascal or C++ compiler. It takes text files (usually with the suffix '.r' ) as input, and produces a resource file as output. MPW also ships with DeRez, which takes a resource file and produces a text file that can be input back into Rez. Originally, Rez ran only under MPW, but both Symantec and Metrowerks have shipped versions of Rez as part of their integrated development environments.

In this article, I'm not going to give a tutorial on Rez. Instead, I'm going to concentrate on the reasons that you should be using Rez to manage your resources. A full manual for Rez (and DeRez) can be found in Appendix C of "Building and Managing Programs in MPW, available at ftp://ftp.apple.com/devworld/Tool_Chest/Core_Mac_OS_Tools/MPW_etc./Documentation/MPW_Reference/Bldg%26Mng_Progs_In_MPW.sit.hqx.

A Little History

When first Macintosh development environments shipped (back in 1985), they included a tool called RMaker. (ResEdit didn't appear until late 1985 or early 1986) RMaker (short for Resource Maker), like Rez, was a resource compiler, translating a text file into a resource file. However, RMaker knew about only a few resource types, and was not easily extensible. So, when Apple shipped MPW 1.0 in 1986, they provided a completely new set of resource tools. Rez, DeRez, and RezDet. Joel West wrote an article for this magazine about the new tools in MPW 1.0. See www.mactech.com/articles/mactech/Vol.03/03.02/Rez-ervations/index.html for a description of those tools as they appeared in MPW 1.0.

An improved version of Rez shipped with MPW 2.0 in 1988, and Rez 3.0 included support for QuickDraw pictures.

Symantec shipped stand-alone versions of Rez and DeRez (cunningly named SA-Rez and SA-DeRez) with Think C 6, and incorporated Rez into the IDE with the THINK Project Manager 7.0 (68K) and the Symantec Project Manager (PPC).

Metrowerks incorporated Rez into their IDE starting with CodeWarrior 6.

Why Rez?

At this point you are probably asking yourself, "Why should I care about Rez? I do all my resource editing in ResEdit/Resorcerer, why would anyone use Rez?". There are several reasons:

Comments

Since Rez source files are text files, they can contain comments about why a resource contains some information. A change history is another good thing to put here. Unless you have a great memory, you will want to put comments in your resource files so that when you look back a year (or two later), you can tell why this number in a table was changed from a 23 to a 42. Since resource files are binary data, there is no place to put comments there.

Don't underestimate the importance of comments. Would you write code without comments? They have saved me hours (or days!) of debugging on many occasions.

Macros

This is a big feature. Since Rez supports C-style macro processing, you can give symbolic names to your resource types and IDs, and use these definitions in a header file for both your resources and your C/C++ code. Whenever I see a bit of code that says something like:

   h = Get1Resource ( 'Foo!', 234 );

I cringe. I just know that somewhere down the line, someone will need to change the ID of that resource, and they may or may not find all the places that load/use that resource. I use a header file that is shared between my resource files and my source files.

// File Foo.h
#define   kNormalFooResID

// File Foo.c
   h = Get1Resource ( 'Foo!', kNormalFooResID );

// File Foo.r
resource 'Foo!' ( kNormalFooResID, purgeable ) {

If you prefer a less made-up example, here's one that uses familiar resource types:

// File Foo.h
#define   kNoAppleEventsAlert      130

// File Foo.c
   if (( Gestalt( gestaltAppleEventsAttr, &attrs )) != noErr )
      Alert ( kNoAppleEventsAlert, nil );
   else { // normal processing

// File Foo.r
resource 'ALRT' ( kNoAppleEventsAlert ) {
   { 0, 0, 200, 400 },    // bounds for the alert
   kNoAppleEventsAlert,   // the DITL associated with this alert
   {                      // Alert Stages
      OK, visible, silent,
      OK, visible, silent,
      OK, visible, silent,
      OK, visible, silent
   },
   centerMainScreen       // Where to show the alert
   };

resource 'DITL' ( kNoAppleEventsAlert ) {
// Dialog items go here
   };

To renumber the alert, all I have to do is change one line in Foo.h and rebuild. The resources will be renumbered automatically, even the reference to the DITL inside the ALRT resource.

Not convinced yet? Here's another example. Suppose that you want all the buttons in your application to have the same "look". For the sake of argument, let's say that you want them all to have the same height. Using ResEdit or Resorcerer, this is a nightmare, because you would have to go through each and every dialog and find each button, and check (and possibly change) the height of each button, to conform to your standard. Heaven help you if some UI designer or product manager decides that all the buttons need to be two pixels higher (to aid in translation to Urdu, no doubt).

Using Rez, (and a little foresight), it's a one line change!

// File Foo.h
#define   kButtonHeight      20

// File Foo.r
resource 'ALRT' ( kNoAppleEventsAlert ) {
// We've seen this before.....
   };

resource 'DITL' ( kNoAppleEventsAlert ) {{
   {260, 129, 260 + kButtonHeight, 209},
                  Button { enabled, "OK" };
   {260,  40, 260 + kButtonHeight, 120},
                  Button { enabled, "Cancel" };
   {8, 72, 23, 264},            StaticText { disabled, "Hi Mom!" };
   };
   };

When I change the kButtonHeight constant in the header file, all the buttons in the application change to match the new regime.

Of course, you can extend this for button widths, height and widths of other items.

Extensibility

Rez is extensible, i.e, you can write resource definitions for you own resource types. In fact, Rez comes with a set of header files that define the structure of all the common Mac resources types; Rez does not have any "built-in" resource types. It does have a set of built-in types that you can use as fields in your resources, such as bytes, 16 and 32 bit integers, C and Pascal-style strings, and a few others. Here's an example of a C struct definition and a corresponding Rez definition:

// In a header file
struct FooListEntry {
   short   fooIndex;
   short   fooValue;
   };

struct FooResource {
   short   fooVersion;
   short   fooMinorVersion;
   long    fooCount;
   FooListEntry   fooList [ 1 ];
//   Really a list of 'fooCount'
   };

typedef   struct FooResource FooResource, *FooResourcePtr,             **FooResourceHandle;

// --------------- Rez ---------------
type 'Foo!' {
   integer;   // fooVersion
   integer;   // minor Version
   long = $$CountOf ( fooList );   // size filled in by Rez
   array fooList {
      integer;      // index
      integer;      // value
      };
   };

// Usage
resource 'Foo!" ( kDefaultFooList ) {
   kCurrentFooVersion, kCurrentFooMinorVersion,
   {
      12, 23;      // See bug #32
      34, 45;
      45, 56;      // 54 was wrong! changed to 56 mtc 07/02/98
      123, 987;
   };
};

In a perfect world, Rez would read C/C++ structure definitions directly, and we wouldn't need to have different definitions for the same data structure. However, a Rez definition specifies exactly how to lay out the bits in the data structure, while C/C++ compilers are allowed considerable leeway in structure alignments and padding. Look at Apple's header files. All those lines that start out '#pragma options align' are there to control structure alignment so that 68K and PowerPC programs can share data structures and data files.

Source and configuration control

There are several source control systems available today. Projector, SourceSafe, SCCS, are CVS are just a few. Most of them handle binary files, but they all handle text files much better. Diffing tools are designed to work on text files. Having your resources in text files makes it much easier to track changes, additions, and deletions of resources.

Batch Processing

Since Rez files are text files, it is easy to generate them from other sources. A long time ago, I worked on a project to print to plotters. We had a database (in Hypercard!) that contained information on a variety of plotters (margins, paper sizes, commands supported, etc.). We had many people gather this information and enter it into the stack. This stack generated a ".r" file that we then compiled.

Today, a great deal of information is contained in databases. Sometimes you have to include information from a database into your application. Most databases have extensive report-writing facilities. It is usually fairly easy to make a database divulge the data that you are interested in formatted in Rez format. This also makes it easy to "refresh" the data in your application, by including up-to-date information as part of the build process. The database could hold anything, from sample data for the user to manipulate to the current structure of your web site.

Translation

One of the main reasons for the existence of resources is to decouple the user interface from the code, thereby making changes (especially translation between languages) easier. When I wrote printer drivers at HP we put all of our literal strings into a single header file, along with comments about how the string was used. When the time came for translation, we sent this single text file to the people doing the translations. They sent us back a translated file, and we built a translated driver. After that, all that was required of the translators was to adjust the layout of the dialogs, to take into account the changed sizes of some of the dialog items. Using this scheme, we were able to ship 12 different language versions of our driver software within 3 weeks of releasing our English version.

When Not to Use Rez

There are some resource types for which Rez is not appropriate. For example, there is no real structure for ICON (or icl8, etc.) resources. They are really just small bitmaps. So a Rez definition of a ICON resource is just a string of hex digits. Icon files are better kept as binary files, and edited with a resource editor. However, you can still have your cake and eat it too; by using Rez to assemble the final resource file. Suppose that you have an icon in a file called "Foo.rsrc", and in that file it is 'ICN#'(128). You can include it using Rez thusly:

include "Foo.rsrc" 'ICN#' ( 128 ) as 'ICN#' ( kFooIcon );

This will include the icon into your output file, while giving it the resource ID that you want (which is defined by a symbolic constant).

Conclusion

Keeping your resources as text files and using a resource compiler has many advantages over using a resource file editor. You can add comments to your resources, use symbolic constants, define your own resource types, and use all the tools that exist for maintaining and manipulating text files. The next time you find yourself reaching for ResEdit or Resorcerer, consider a third option. Sometimes the old tricks work best, and often Rez is the right tool.

Bibliography and References

West, Joel. "No Rez-ervations Needed!". MacTech Magazine (formerly MacTutor) 3:2 (February 1986).


Marshall Clow is a programmer. He has worked for Palomar Software, Hewlett-Packard, and Aladdin Systems. Among other things, he has written PICT Detective, Aladdin's Resource Compression Toolkit, and way too many resource processing tools. He currently works for Adobe Systems, where his title is "Bad Influence". When he's not coding, he can be found mountain biking or checking out micro breweries. He can be reached at mclow@mailhost2.csusm.edu

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Hopper Disassembler 4.2.5- - Binary disa...
Hopper Disassembler is a binary disassembler, decompiler, and debugger for 32-bit and 64-bit executables. It will let you disassemble any binary you want, and provide you all the information about... Read more
BetterTouchTool 2.261 - Customize Multi-...
BetterTouchTool adds many new, fully customizable gestures to the Magic Mouse, Multi-Touch MacBook trackpad, and Magic Trackpad. These gestures are customizable: Magic Mouse: Pinch in / out (zoom... Read more
Sketch 44.1 - Design app for UX/UI for i...
Sketch is an innovative and fresh look at vector drawing. Its intentionally minimalist design is based upon a drawing space of unlimited size and layers, free of palettes, panels, menus, windows, and... Read more
BetterTouchTool 2.260 - Customize Multi-...
BetterTouchTool adds many new, fully customizable gestures to the Magic Mouse, Multi-Touch MacBook trackpad, and Magic Trackpad. These gestures are customizable: Magic Mouse: Pinch in / out (zoom... Read more
Chromium 59.0.3071.115 - Fast and stable...
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all Internet users to experience the web. Version 59.0.3071.115: This update has no Flash plug... Read more
SyncTwoFolders 2.2.3 - 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
Myriad 4.1 - $79.00
Myriad is, simply put, one of the best audio batch processors. Totally redesigned, it looks beautiful and delivers incredible performance. Let Myriad do the heavy lifting while you get back to doing... Read more
Suitcase Fusion 7 18.2.4 - Font manageme...
Suitcase Fusion 7 is the creative professional's font manager. Every professional font manager should deliver the basics: spectacular previews, powerful search tools, and efficient font organization... Read more
SoftRAID 5.6.1 - High-quality RAID manag...
SoftRAID allows you to create and manage disk arrays to increase performance and reliability. SoftRAID allows the user to create and manage RAID 4 and 5 volumes, RAID 1+0, and RAID 1 (Mirror) and... Read more
BetterTouchTool 2.25 - Customize Multi-T...
BetterTouchTool adds many new, fully customizable gestures to the Magic Mouse, Multi-Touch MacBook trackpad, and Magic Trackpad. These gestures are customizable: Magic Mouse: Pinch in / out (zoom... Read more

Latest Forum Discussions

See All

Ravenscroft 275 Piano (Music)
Ravenscroft 275 Piano 1.0.0 Device: iOS Universal Category: Music Price: $35.99, Version: 1.0.0 (iTunes) Description: Experience the splendor of a Ravenscroft Grand with the most realistic sounding piano ever created for iOS. Launch... | Read more »
This War of Mine gets a new ending and m...
This War of Mine just got a big new update, featuring free DLC that adds a new ending to the game, among other exciting changes. The update is celebrating the game's two-year release anniversary. Apart from the new ending, which will be quite... | Read more »
Summon eight new heroes in Fire Emblem H...
Nintendo keeps coming at us with Fire Emblem Heroes updates, and it doesn't look like that trend is stopping anytime soon. The folks behind the game have just announced the new War of the Clerics Voting Gauntlet, expected to start next Tuesday. [... | Read more »
The best deals on the App Store this wee...
iOS publishers are pulling out all the stops this week -- there's a huge number of seriously great games at discounted prices this week. Let's not waste any time and get right down to business. [Read more] | Read more »
The House of da Vinci (Games)
The House of da Vinci 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: Enter The House of Da Vinci, a new must-try 3D puzzle adventure game. Solve mechanical puzzles, discover hidden... | Read more »
Solve the disappearance of history’s gre...
Blue Brain Games invites you to indulge in an immersive hands-on 3D puzzle adventure in similar vein to The Room series, with its debut release The House of Da Vinci. Set during the historic period of the Italian Renaissance (when Leonardo himself... | Read more »
Age of Rivals (Games)
Age of Rivals 3.3 Device: iOS Universal Category: Games Price: $.99, Version: 3.3 (iTunes) Description: Deep civilization-building strategy in a fast-paced card game! | Read more »
Panthera Frontier (Games)
Panthera Frontier 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: | Read more »
Angry Birds Evolution beginner's gu...
Angry Birds changes things up a fair bit in its latest iteration, Angry Birds Evolution. The familiar sling-shot physics mechanics are still there, but the game now features team-based gameplay, RPG elements, and a new top-down view. With all of... | Read more »
Sega Forever is for the retro game fans
Sega is launching a new retro games service titled Sega Forever, in a move that's sure to delight games enthusiasts with a bit of nostalgia. Sega's releasing five classic games for free. The titles include Sonic the Hedgehog, Phantasy Star II,... | Read more »

Price Scanner via MacPrices.net

Apple Releases iOS 11 Public Beta; How To Get...
The official release of Apple’s latest mobile operating system iOS 11 is vaguely slated for the fall, but as of June 26, ordinary users can download an iOS 11 public beta. To download the iOS 11... Read more
Extend Life of MacBook Pro Retina 2.0TB With...
MacSales.com/Other World Computing has announced availability of the new OWC 2.0TB Aura Pro Solid State Drive for mid-2012 to early 2013 Apple MacBook Pro with Retina display. One of the fastest... Read more
BBEdit SummerFest 2017 Discount Ends Friday,...
You can get 20% off BBEdit for a limited time in Bare Bones Software’s http://www.eastgate.com/Tinderbox/Specials/SummerFest.html?mc_cid=f2101ca260&mc_eid=[UNIQID]SummerFest 2017 sale and... Read more
Use Apple’s Education discount to save up to...
Purchase a new Mac using Apple’s Education discount, and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free: - 15″ 2... Read more
Clearance 27-inch 3.3GHz 5K iMac available fo...
Amazon clearance 27″ 3.3GHz 5K iMacs (MK482LL/A) available for $1799.90 including free shipping. Their price is $500 off original MSRP, and it’s the lowest price available for this model from any... Read more
13-inch 1.8GHz/256GB MacBook Air on sale for...
B&H Photo has the updated 2017 13″ 1.8GHz/256GB MacBook Air (MQD42LL/A) in stock and on sale for $1129 including free shipping plus NY & NJ tax only. Their price is $70 off MSRP. Read more
27-inch 3.4GHz iMac on sale for $1699, save $...
B&H Photo has the new 2017 27″ 3.4GHz iMac (MNE92LL/A) in stock and on sale for $1699 including free shipping plus NY & NJ sales tax only. Their price is $100 off MSRP. Read more
21-inch 2.3GHz iMac on sale for $1049, save $...
B&H Photo has the new 2017 21″ 2.3GHz iMac (MMQA2LL/A) in stock and on sale for $1049 including free shipping plus NY & NJ tax only. Their price is $50 off MSRP. Read more
ABBYY TextGrabber 6 for iOS Implements Instan...
ABBYY has announced the release of TextGrabber 6.0.0, an important feature update to the company’s productivity app developed for iOS and Android devices. TextGrabber 6.0 now offers Real-Time... Read more
vPhone, First Smartphone That Can’t Be Lost,...
Austin, Texas based Hypori has introduced the vPhone, a virtual smartphone that affords every business user the benefits of separate work and personal phones, conveniently delivered on a single... Read more

Jobs Board

*Apple* News Product Marketing Mgr., Publish...
…organizational consensus on strategy and vision for publisher tools, authoring, and Apple News Format.Carries this strategy and vision across the organization to Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Security Data Analyst - *Apple* Information...
…data sources need to be collected to allow Information Security to better protect Apple employees and customers from a wide range of threats.Act as the subject matter Read more
Lead *Apple* Solutions Consultant - Apple I...
…integrity, and trust.Success Metrics/Key Performance Indicators:Quantitative* Year over Year growth in Apple Product and Beyond the Box sales in the assigned Point of Read more
*Apple* Solutions Consultant till v%u00E5r...
…ethics, integrity, and trust.Success Metrics/Key Performance Indicators:QuantitativeYear over Year growth in Apple Product and Beyond the Box sales in the assigned Point Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.