TweetFollow Us on Twitter

Charting Resource Map
Volume Number:6
Issue Number:9
Column Tag:XCMD Corner

Related Info: Resource Manager

Charting The Resource Map

By Donald Koscheka, Ernst & Young, MacTutor Contributing Editor

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

Fourth Party Developers

If you read this column regularly, you may be a charter member of a new class of programmers that Apple has recently labelled as “Fourth party developers”. This term is used to denote those programmers who add or modify an existing package for a customer. By this token, XCMDs are 4th party programs since you are adding code to an off-the-shelf product (Hypercard) to enhance its capabilities.

4th Party Programming seems to be an interesting way to make a living. First off, the assignments are manageable since most 4th party work tends to be minor additions to existing work. Second, the 4th party developer needs to be a master of all trades. Gone are the days when a programmer could specialize in data base design, or system software or report generation.

If 4th party programming becomes commercially viable, the practitioner will need to be well-versed in many areas but it’s a safe bet that you can focus your expertise on the following: I/O, communications, searching, sorting, report generation, file translators and graphics. The problem is, most programmers don’t have a repertoire that spans this wide a spectrum. If you feel equally comfortable talking LAP as you do discussing the TIFF format, then maybe you should try your hand at becoming a 4th party programmer.

Personally, I think this area can turn out to be very interesting. I remain skeptical as to whether anyone can make a living at it, but I’m willing to consider anything. After all, the most far-fetched ideas are often the ones that lead to innovation.

End of Sermon.

Charting The Resource Map

Although I’ve read just about every page of Inside Macintosh at least twice, there are certain pages that I still find myself glossing over. I don’t skip these pages out of lack of interest, every manager in the Toolbox has some interesting nuance that is just begging to be exploited. I gloss over certain sections of IM solely because I know that reading that section will lead me down a long path that I just never seem to have time for.

One such path for me is decoding the format of the resource fork. I have always looked on pages I-128 through 1-131 as a sort of black hole; the resource forks just seemed too convoluted to ever have to try to understand. Besides, anything one needs to do with the resource fork can be done via the high level resource manager calls. Or so it would seem. But here’s a simple request that cannot be resolved by the resource manager -- give me a list of the type and id of all resources in a particular resource file.

One needs to understand the spirit of the resource manager in order to understand why this seemingly simple problem doesn’t have a simple solution. The resource manager was intended to act as what I call “soft virtual EPROM”. In essence, resources should only be created during the construction of an application. Once the product ships, the resource fork should remain stable. This is exactly how Engineers use EPROM in computer designs. The “soft” nature of resources alludes to the fact that resources are easy to change as one might need to do to internationalize a certain package. This does not mean that the resource fork should be used for storing dynamically altering data. The resource manager is NOT a data base. A lot of early Mac programmers abused the resource fork by using it as a simple sort of data base. The RM doesn’t respond well to constantly changing data -- it is relatively slow for writing and it lacks any inherent compaction scheme. Neither of these are a shortcoming, the resource fork was never meant to be used as a random access data base. Any programmer who uses the resource fork in this way is asking for trouble and is building an inherently unstable program -- if you have data base needs, either buy or develop a data base, but please, keep your paws out of the resource fork.

The next attribute of the resource fork that is significant is its “virtual” nature. The resource manager has a built-in mechanism for searching all open resource files for a given resource. This is good -- it frees the programmer from needing to know how to access the system resources, they just magically appear along with your resources at load time. Of course there is nothing magical about the resource manager develops this virtual behaviour, each file contains a resource map that is loaded into memory when the resource fork is opened. Each resource map stores a handle to the next resource map in the search order. Thus searching all open resource forks becomes straightforward. But herein lies the crux of our problem. The resource manager itself wants to search all open resource files. If we want to get a list of all resources stored in a particular file, then we would first have to close down all open resource files so that they are excluded from the search path. This would be bad and not even worth trying because shutting down your system resource fork and application resource fork would almost certainly be fatal to the application.

Thus, to read all resources from one particular resource file, we are forced to scan the resource map for that file. Listing 1 (GetRsrcList.c) returns a list of all resources by type and id (names will be added in the future, you can use the resource manager to get the name for now). Notice that in order to do this, I needed to reconstruct the structures used in the resource file. I couldn’t find these structures in my libraries so I create my own.

Our strategy for scanning the resource file goes like this (refer to page I-131 for a good picture of this strategy). First, we read in the resource header (256 bytes). The resource header contains, among other things, the offset and length of the resource map. I find it noteworthy that the resource map always follows the resource data in the file. This seems reasonable enough. Since we know how big the resource map is, allocate a pointer that contains enough space to read the map into, then move the file mark to the start of the map and read it in. Once the map is read in, we need to move through two levels: the type list and the reference list. The type list immediately follows the map header and tells us how many types of resources the fork contains as well as the resource type (4 bytes), the number of resources of that type and where the reference list starts for that type. Type lists and reference lists are constant-sized structures so we can increment a pointer to sashay nicely through the lists.

Each resource type contains a reference list. This list holds information about each individual resource. There are as many entries as there are resources of a given type (counting from 0 not 1). If your file contains 4 XCMDs then your XCMD reference list will contain 4 contiguous entries, one for each XCMD. Pascal programmers take note -- the count is stored as 1 less than the actual number of items. We walk the reference list thusly:

/* 1 */

 for( i = 0; i <= rTL->r_count; i++ ){
 rRef = (resRefPtr)((long)rTL + (long)rTyp->r_ref );
 for( j = 0; j <= rTyp->r_count; j++ )
 rRef++;

 rTyp++; 
 }

The outer loop (i) walks through the type list (again these are stored contiguously immediately following the the resource map header). If rTyp is a pointer to a type list entry (an 8-byte struct), then all we need to do to move to the next type is increment the pointer. “C” is a natural for this type of work but the equivalent Pascal code looks like this:

/* 2 */

 rTyp = ResTypPtr( ORD4( rTyp ) + LongInt( sizeof( ResTyp) );
       { rTyp++ }

Each type entry contains the offset to the start of the reference list for this type. This offset is relative to the start of the type list itself. Adding this offset to the start of the type list (rTL in the example above) yields the physical location of the reference list. Each resource in the file has a reference list entry. To scan all resources of a given type (eg ‘XCMD’) we can increment the pointer to the reference list entries (rRef).

You may never need to know how to scan a resource map but it does serve two pedantic purposes -- it shows how resource files are created and it absolutely convinces the serious programmer that the resource fork is not intended to be a data base. The 16-bit offsets used throughout the fork should provide some clue as to the limitations on the fork’s capacity. For example, what is the maximum number of resource types that you can have? What is the total number of resources that can be stored safely in the resource fork? Listing 1 provides clues to the answers (hint: study the structures). Understanding limits is an important part of programming. See what you can do with this information.

The resource manager is fun to poke around in and I will visit this theme in the future. In the meantime, if you have an interesting problem that needs solving in an XCMD, drop me a line. I’ll see what I can do.

Listing 1:  GetRsrcList.c

/********************************/
/* File: GetRsrcList.c    */
/* */
/* Given the name of a file,  */
/* return a list of all the */
/* resources in that file.  The */
/* list contains 1 line per */
/* resource with the following  */
/* format:*/
/* */
/* item1 == Resource Type */
/* item2 == Resource ID   */
/* item3 == Resource name */
/* */
/* If the resource fork is empty*/
/* or non-existent, return empty*/
/* */
/* ----------------------------  */
/* ©1990 Donald Koscheka  */
/* All Rights Reserved    */
/********************************/

#define UsingHypercard

#include<MacTypes.h>
#include<OSUtil.h>
#include<MemoryMgr.h>
#include<FileMgr.h>
#include<ResourceMgr.h>
#include<pascal.h>
#include<string.h>
#include<hfs.h>
#include  “HyperXCmd.h”
#include“HyperUtils.h”

#define nil 0L

/*** definition of resource header ***/
typedef struct {
 long r_data_offset;
 long r_map_offset;
 long r_data_size;
 long r_map_size;
 char r_reserved[112];
 char r_application[128];
} resHdr, *resHdrPtr, **resHdrHand;

/*** definition of resource map ***/
typedef struct {
 long   r_header[4];/* duplicates first 16 bytes in header*/
 long   next_map;
 short  f_ref;
 short  attributes;
 short  r_type_list;
 short  r_name_list;
} resMap, *resMapPtr, **resMapHand;

/*** definition of type list entry ***/
typedef struct {
 char   r_type[4]; /*** this resource type   ***/
 short  r_count; /*** # of resources of this type ***/
 short  r_ref;   
 /*** offset from start of type list to***/
 /*** reference list for resources of  ***/
 /*** this type (not used here)    ***/
} resTyp, *resTypPtr, **resTypHand;

/*** definition of resource type list ***/
typedef struct {
 short  r_count; /* 0..n */
 resTyp r_typ[]; /* array of type entries */
} resTypeList, *resTypeListPtr, **resTypeListHand;

/*** definition of resource reference list ***/
typedef struct {
 short  r_id;    
 short  r_name;  
 /* offset from start of name list to this name */
 long r_offset;  /* offset to date (hi byte == attributes */
 Handle r_handle;/* handle when resource is in memory */
} resRef, *resRefPtr, **resRefHand;

pascal void main( paramPtr )
 XCmdBlockPtr  paramPtr;
{
 resMapPtrrMap = NIL;
 resTypeListPtr  rTL;
 resTypPtrrTyp;
 resRefPtrrRef;
 Handle rsrcList = NIL; /* the output*/
 resHdr rHdr;
 Str31  fName;   /* name of the file */
 short  ref;
 OSErr  err;
 long   temp;
 short  i,j;/* loop counters*/
 Str255 str;
 
 paramPtr->returnValue = NIL; /* prepare for the worst */
 /* (but plan for the best) */
 
 if( paramPtr->params[0] ){

 HLock( paramPtr->params[0] );
 ZeroToPas( paramPtr, *(paramPtr->params[0]), &fName );
 HUnlock( paramPtr->params[0] );

 err  = (short)OpenRF( &fName, -1, &ref );

 if( !err ) /*** Move to  start of  file & read header ***/
 err = SetFPos( ref, fsFromStart, 0L );
 else
 return;
 
 if( !err ){/*** read in the resource header ***/
 temp = (long)sizeof( resHdr );
 err = FSRead( ref, &temp, &rHdr );
 }
 
 if( !err ) /*** Move to start of map & read it in ***/
 err = SetFPos( ref, fsFromStart, rHdr.r_map_offset );
 
 if( !err ){
 rMap = (resMapPtr)NewPtr( rHdr.r_map_size );
 err = FSRead( ref, &rHdr.r_map_size, rMap);
 }
 
 if( !err ){
 /*** this calculation doesn’t seem correct ***/
 rTL = (resTypeListPtr)((long)rMap + (long)(rMap->r_type_list));

 /*** move to the start of the reference list ***/
 rTyp = (resTypPtr)((long)rTL + (long)sizeof( short )); 
 
 /* Allocate handle for the output list*/
 if( rsrcList = NewHandle( 0L ) ){
 for( i = 0; i <= rTL->r_count; i++ ){
 rRef = (resRefPtr)((long)rTL + (long)rTyp->r_ref );
 for( j = 0; j <= rTyp->r_count; j++ ){
 /*** read the reference list entry int ***/
 
 /*** add this type & id to the output list ***/
 AppendCharToHandle( rsrcList, (char)rTyp->r_type[0]);
 AppendCharToHandle( rsrcList, (char)rTyp->r_type[1]);
 AppendCharToHandle( rsrcList, (char)rTyp->r_type[2]);
 AppendCharToHandle( rsrcList, (char)rTyp->r_type[3]);
 AppendCharToHandle( rsrcList, ‘,’);
 
 /*** convert id to a string & add to list ***/
 NumToStr( paramPtr, (long)rRef->r_id, &str );
 pStrToField( (char *)str, ‘\r’,  rsrcList );
 rRef++;
 }/* for j = 0 to # of resources of this type */
 rTyp++; 
 }/* for i = 0 to the number of resource types */
 
 }/* if( rsrcList allocated */
 
 AppendCharToHandle( rsrcList, ‘\0’ );
 } 
 
 if( rMap )
 DisposPtr( (Ptr)rMap );
 /*** Only reach here if file was opened     ***/
 err = FSClose( ref );
 }
 
 paramPtr->returnValue = rsrcList;
}

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

pwSafe 4.0.1 - Secure password managemen...
pwSafe provides simple and secure password management across devices and computers. pwSafe uses iCloud to keep your password databases backed-up and synced between Macs and iOS devices. It is... Read more
WALTR 1.5.4 - Drag-and-drop any media fi...
WALTR is designed to make it easy to upload and convert any music or video file to an iPad or iPhone format for native playback. It supports a huge variety of media file types, including MP3, MP4,... Read more
Audio Hijack 3.1 - Record and enhance au...
Audio Hijack (was Audio Hijack Pro) drastically changes the way you use audio on your computer, giving you the freedom to listen to audio when you want and how you want. Record and enhance any audio... Read more
PopChar 7.1 - Floating window shows avai...
We're also selling a 5-license family pack for only $25.99! PopChar helps you get the most out of your font collection. With its crystal-clear interface, PopChar X provides a frustration-free way to... Read more
BBEdit 11.1.1 - Powerful text and HTML e...
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
Picasa 3.9.139 - Organize, edit, and sha...
Picasa and Picasa Web Albums allows you to organize, edit, and upload your photos to the Web from your computer in quick, simple steps. Arrange your photos into folders and albums and erase their... Read more
Mac DVDRipper Pro 5.0.5 - 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
NetShade 6.2 - Browse privately using an...
This promotion is for NetShade and 1 year of Proxy and VPN services NetShade is an anonymous proxy and VPN app+service for Mac. Unblock your Internet through NetShade's high-speed proxy and VPN... Read more
CrossOver 14.1.3 - Run Windows apps on y...
CrossOver can get your Windows productivity applications and PC games up and running on your Mac quickly and easily. CrossOver runs the Windows software that you need on Mac at home, in the office,... Read more
Little Snitch 3.5.3 - Alerts you about o...
Little Snitch gives you control over your private outgoing data. Track background activity As soon as your computer connects to the Internet, applications often have permission to send any... Read more

Block Fortress has a Big New Update for...
Block Fortress is a survival-style game that's as fun as it is blocky. It's also just gotten a rather sizeable update that adds a lot more cool stuff. [Read more] | Read more »
Simple and Surreal Star Base Sim rymdkap...
I really like rymdkapsel. Not just because I'm a sucker for games that are cleverly simple or highly stylisitc, but because it's fun and challenging. Actually it's extremely challenging, which is why I was excited to learn that it's getting a couple... | Read more »
Check out the anticipated Angel Stone in...
Fincon has finally revealed Angel Stone in action in the first ever official gameplay trailer for the anticipated hack and slasher. Angel Stone is set in a post-apocalyptic world in which humanity is in danger of being wiped out by the demonic... | Read more »
Moleskine Timepage is an All-New Calenda...
Moleskine Timepage is a bit of a departure for the notebook manufacturer (since it has little to do with notebooks), but it certainly carries their simple and elegant style quite well. [Read more] | Read more »
Jog on Over and Check Out the New Runtas...
Runtastic has put out a fair number of apps to help you sleep, track excercise, and train various parts of your body. Now it's time for your legs to have their own time in the spotlight with Runtastic Leg Trainer. [Read more] | Read more »
It's Lights Out in the Upcoming Pla...
Ember’s Journey is a stark puzzle platformer with a twist: the entire game is played in darkness. The only light you can see by is the one emanating from your own character. [Read more] | Read more »
MooVee - Your Movies Guru (Entertainmen...
MooVee - Your Movies Guru 1.0 Device: iOS iPhone Category: Entertainment Price: $1.99, Version: 1.0 (iTunes) Description: MooVee helps you effortlessly manage your movies, on your iPhone. | Read more »
Geometry Wars 3: Dimensions (Games)
Geometry Wars 3: Dimensions 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: Enjoy the next chapter in the award-winning Geometry Wars franchise and enjoy stunning, console-quality... | Read more »
CHAOS RINGS Ⅲ (Games)
CHAOS RINGS Ⅲ 1.0.0 Device: iOS Universal Category: Games Price: $19.99, Version: 1.0.0 (iTunes) Description: The newest addition to the popular smartphone RPG series is finally here! ・CHAOS RINGS Overview | Read more »
The Popular Insight Series of Travel Gui...
Getting around in a country when you can't understand the primary language can be tough. Fortunately there are several options available to help wold travellers with the important stuff like giving directions to a cab driver or asking where the... | Read more »

Price Scanner via MacPrices.net

Top Markets Saturation To Slow Global Smartph...
According to a new mobile phone forecast from the International Data Corporation (IDC) Worldwide Quarterly Mobile Phone Tracker, smartphone shipments are expected to grow 11.3% in 2015 — down from 27... Read more
Apple refurbished 2014 13-inch Retina MacBook...
The Apple Store has Apple Certified Refurbished 2014 13″ Retina MacBook Pros available for up to $400 off original MSRP, starting at $979. An Apple one-year warranty is included with each model, and... Read more
What Would the ideal Apple Productivity Platf...
For the past four years I’ve kept a foot in both the Mac and iPad camps respectively. my daily computing hours divided about 50/50 between the two devices with remarkable consistency. However, there’... Read more
PageMeUp 1.2.1 Ten Dollar Page Layout Applica...
Paris, France-based Softobe, an OS X software development company, has announced that their PageMeUp v. 1.2.1, is available on the Mac App Store for $9.99. The license can be installed on up to 5... Read more
Eight New Products For USB Type-C Application...
Fresco Logic, specialists in advanced connectivity technologies and ICs, has introduced two new product families targeting the Type-C connector recently introduced across a number of consumer... Read more
Scripps National Spelling Bee Launches Buzzwo...
Scripps National Spelling Bee fans can monitor the action at the 2015 Spelling Bee with the new Buzzworthy app for iOS, Android and Windows mobile devices. The free Buzzworthy app provides friendly... Read more
13-inch 2.5GHz MacBook Pro on sale for $120 o...
B&H Photo has the 13″ 2.5GHz MacBook Pro on sale for $979 including free shipping plus NY sales tax only. Their price is $120 off MSRP, and it’s the lowest price for this model (except for Apple’... Read more
27-inch 3.3GHz 5K iMac on sale for $1899, $10...
B&H Photo has the new 27″ 3.3GHz 5K iMac on sale for $1899.99 including free shipping plus NY tax only. Their price is $100 off MSRP. Read more
Save up to $50 on iPad Air 2, NY tax only, fr...
B&H Photo has iPad Air 2s on sale for up to $50 off MSRP including free shipping plus NY sales tax only: - 16GB iPad Air 2 WiFi: $469 $30 off - 64GB iPad Air 2 WiFi: $549.99 $50 off - 128GB iPad... Read more
Updated Mac Price Trackers
We’ve updated our Mac Price Trackers with the latest information on prices, bundles, and availability on systems from Apple’s authorized internet/catalog resellers: - 15″ MacBook Pros - 13″ MacBook... Read more

Jobs Board

*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
Program Manager, *Apple* Community Support...
**Job Summary** Apple Support Communities ( discussions. apple .com) helps customers get the most from their Apple products and services by providing access to Read more
Senior Data Scientist, *Apple* Retail - Onl...
**Job Summary** Apple Retail - Online sells Apple products to customers around the world. In addition to selling Apple products with unique services such as iPad Read more
*Apple* Solutions Consultant - Retail Sales...
**Job Summary** As an Apple Solutions Consultant (ASC) you are the link between our customers and our products. Your role is to drive the Apple business in a retail Read more
*Apple* Watch SW Application Project Manager...
**Job Summary** The Apple Watch software team is looking for an Application Engineering Project Manager to work on new projects for Apple . The successful candidate Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.