TweetFollow Us on Twitter

ROM Exploring
Volume Number:7
Issue Number:4
Column Tag:Pascal Procedures

Related Info: Resource Manager

Exploring the ROM

By Micheal Budiansky, Berkeley, CA

[Michael Budiansky is a physicist-turned-engineer specializing in Macintosh software. He worked in the areas of heavy-ion collisions, optical telescope design, and semiconductor image processing, before discovering the Macintosh in 1986. He’s been programming the Mac ever since, first for Bear River Associates, then for Applied Biosystems. He received a Ph.D. in Physics from the University of California at Berkeley.]

Re: Sources of Resources

Resources only come from the resource fork of disk files. Right? Wrong! Since the days of the 128K ROM a number of important resources have also been stored in the ROM itself. In this article, we’ll discuss how to get at these hidden resources - the accompanying Pascal code for a simple MPW tool illustrates the necessary technique, as well as providing a means of exploring what these resources are and finding out which of them have been modified by later patches to the System software.

The Resource Chain

First, let’s review how resources are loaded by a program. When an application requests a resource, the Resource Manager searches through a chain of resource files until it is found. Normally, the chain begins with the most-recently-opened document’s resource file, followed by the application’s resource fork, and then the System file. If the resource isn’t in the document (or if there’s no document open), the manager looks in the application. If it’s not in the application, the manager looks in the System file. If it’s not in the System file, you’re probably in trouble.

To get at the ROM resources, you’ll need to adjust the resource chain by means of techniques described in Inside Macintosh,Volumes IV and V. There are two different methods: one is to set the values of certain low-memory globals before making an ordinary Resource Manager call, and the other is to use the special toolbox call RGetResource. The first method puts the ROM resource map at the front of the resource chain for one call to the Resource Manager, as shown in Figure 1. Set the low-memory global RomMapInsert to true and then make your call; the ROM resource map will be searched first for that one call only. The second method is to use the RGetResource call; this behaves exactly like GetResource, except that it puts the ROM resource map at the end of the chain, as shown in Figure 2. After all the resource files in the chain have been searched for the requested resource, RGetResource looks in the ROM resource map.

Figure 1. Moving ROM resources to the front

Figure 2. ROM resources at front

Roving around

What are the resources in the ROM and what good are they? Obtaining the complete list is an exercise left to the reader - armed with the program that follows. (Lazy readers can look up the answer in Inside Macintosh - but those lucky enough to own one of the newer models may have to wait until volume VI is published.) Here are three examples of how these resources can be used:

First, you may find a secret resource that is not present in the system file. The only way to get at these is from the ROM. In Macintosh II class machines, for example, the ROM contains a hidden ‘snd’ resource. It’s named “Brass Horn,” (although it actually sounds more like a squeaky toy) and if it catches your fancy, you could copy it, renumber it, and paste it into your System file to use as a beep sound.

Also, you can optimize your code to use a ROM resource if it is available, thus saving the time required to read in the resource from disk. This technique is used by MacApp to save time in reading the standard cursor resources (watch, plus, cross, and I-beam). This is a fairly safe technique, since if for some reason the resource that you expected to be in ROM is not there, the Resource manager will simply continue looking for it farther along the resource file chain (probably to find it in the System file). You need to be a little careful, however, since sometimes resources are present in both the System file and in the ROM for a reason: the one in ROM is no good any more, and the System file version is a replacement!

Finally, you may need to know about the ROM resources if you want to replace or modify one of the standard system resources. If a resource is first loaded into the System Heap from the ROM, then it doesn’t matter if you edit the copy in the System file--you’re stuck with the ROM version. As it does for so many other functions, however, the Macintosh operating system provides a “hook” that lets you override the default behavior: the ‘Rov#’ resource. The System file contains a number of ‘Rov#’ resources; a ‘Rov#’ resource contains a list of types and ID numbers of ROM resources that are to be replaced by their System file counterparts. In current systems, there is one ‘Rov#’ resource for each version of the ROM (e.g., Mac Plus in resource #117, Mac SE in resource #630, Mac II in resource #376, etc.). By editing the appropriate ‘Rov#’ resource in the System file, you can instruct the system to ignore the ROM version of a resource and to use the version in the System file itself. Readers who are now all set to disassemble and rewrite the Disk Driver ROM resource may proceed without further delay; they probably wouldn’t pay much attention to the safety lecture below, anyway. As for the rest of you, there is an example of resource overriding that may be of interest to any programmer, even those who aren’t the daredevil type.

The Monaco font is a clean, monospaced, font--ideal for viewing program listings on the screen. Its one deficiency, however, is that the digit ‘0’ and the capital letter ‘O’ are indistinguishable, as are the lower case ‘l’ and the capital letter ‘I’. You can repair this problem by using ResEdit to edit the Monaco ‘FONT’ resources (9 point and 12 point) in a copy of your System file: add a dot in the middle of the zero digit and add serifs (short horizontal lines at the top and bottom of the character) to the capital ‘I’. (Please! edit a copy, not your current and/or only version of the System file! And read the safety lecture, too!) If you try out this edited System file on a Mac newer than the Plus, however, you will probably find that while the modifications appear when you use Monaco 12, they do NOT when you use Monaco 9; that’s because Monaco 9 is in a ROM resource. To use the System file’s version of the font, you must edit the ‘Rov#’ resource appropriate for your machine by adding a entry for ‘FONT’ number 521. This will take a certain amount of skill with ResEdit, since to add the entry requires editing the resource in hex form. Open the ‘Rov#’ as a general hex resource. The second word (group of 4 hex digits) in the resource is the number of overridden resources minus one. Edit this number to be one greater than its current value, then add three words of zeroes at the end of the resource; these three words are placeholders for the new entry. Close the resource, then open it again, in the ordinary way that uses the ‘Rov#’ template. The last entry in the list should be blank; change it to FONT 521. If you run into trouble, refer to Inside Macintosh IV-20 for the detailed format of the ‘Rov#’ resource. (Note: Inside Macintosh, Volume IV says that you’ll need to obtain a ‘Rovr’ resource from Developer Tech Support at Apple before you can do any overriding; current System files already contain this resource, so there’s no need to bug the folks at DTS to send it to you.)

ROMRes tool: Theory & Practice

This MPW tool has three options for exploring the ROM resources, plus a self-contained help text. If no option or an invalid option is supplied, the help text is printed out; this is a convenient feature for MPW tools in general, particularly those that are not likely to be used frequently. The listing feature (-l) looks up and lists all resources in the ROM; resources are listed by type, ID, and name. The override feature (-r) looks in your System file and lists all the ‘Rov#’ resources found. For each one, it lists the ROM resources that are flagged to be overridden. Note that only the resources listed for the particular ‘Rov#’ that matches your machine will actually be overridden in your machine. The extract feature (-x) copies a particular resource from the ROM into the file of your choice; if the file does not exist, it will be created.

The comment at the beginning of the code contains the text for the make file; copy the text between (* and *) and paste it into a file named ‘ROMRes.make’. The main section of the program sets up a few variables and then has a case statement that dispatches control to one of three subroutines, one for each feature. If there is a problem with the command line arguments, the code at the end of the main section prints out the help text. The tool gets access to the text on the command line via the global variables ArgC and ArgV, which are defined in the unit IntEnv included in the MPW development system.

The tool uses the first method described above for gaining access to the ROM resources: setting the appropriate low-memory global to TRUE. The routine that lists all the ROM resources deserves some comment. This routine examines all the resources in the resource chain, and identifies those that are in the ROM by using the call HomeResFile; HomeResFile returns a reference number of 1 for resources in ROM. The value 1 is ordinarily an illegal value for a resource file reference number, but in this one case it is used to identify the source of ROM resources. The call CurResFile does not return a value of 1, even if you have set the low-memory global RomMapInsert to true. Trying the call UseResFile(1) will not give good results either. The ROM resource map is not a “file,” and it does not work in general to pretend that it is. This explains why we can’t simply use the Resource Manager calls Count1Types, Count1Resources, and Get1IndResource to examine resources that are only in the ROM. These calls, described in volume IV of Inside Macintosh, search the current resource file only, rather than the entire resource chain, but they don’t behave the way you might expect for the ROM resource map.

Safety lecture

First of all, if you choose to use ResEdit on your System file, be aware that it’s serious business. Back up your files, work on a copy of your System file, and be prepared for your system to crash if you make a mistake. MacTutor readers are a pretty fearless bunch, but even rock climbers use ropes, so you should take reasonable precautions when experimenting with your System.

Almost as fearsome as system crashes are lawyers. If you filch some nifty resource out of the ROM, it’s fine to play around with it on your own machine, but before you include it in an insanely great application to be distributed for fame and fortune, it might be a good idea to talk to Software Licensing at Apple.

Software compatibility is what separates the professionals from the amateurs. Obviously, if you write a program that depends on a ROM resource being there, you are asking for trouble when a new model of the Macintosh comes out. Similarly, if you write a program that expects a newer ROM version, you may unnecessarily be shutting out thousands of Mac owners with a Plus or SE. More subtle (i.e., hard to debug) problems may arise if your program demands a ROM version of a resource when the current System file actually supplies a new and improved version of the resource. Remember, your users will not thank you for saving them a few microseconds by reading a resource from ROM instead of disk if it costs them hours of trying to figure out why the program doesn’t work with a new System version!

Happy exploring!

PROGRAM ROMRes;
(* ROMRes.Make

ROMRes.p.o ƒ ROMRes.Make 
 ROMRes.p
 Pascal ROMRes.p  

ROMRes ƒƒ   ROMRes.Make 
 ROMRes.p.o
 Link -w -t ‘MPST’ -c ‘MPS ‘ 
 ROMRes.p.o 
 “{Libraries}”Runtime.o 
 “{Libraries}”Interface.o 
 “{PLibraries}”PasLib.o 
 “{Libraries}”ToolLibs.o 
 -o ROMRes
*)

USES
 MemTypes,
 QuickDraw,
 OSIntf,
 ToolIntf,
 PackIntf,
 SysEqu,
 Signal,
 PasLibIntf,
 IntEnv;

TYPE
 IntPtr = ^INTEGER;

VAR
 printUsage:BOOLEAN;
 flagPtr: IntPtr;
 numTypes:INTEGER;
 theType: ResType;
 aType: ResType;
 numOfType: INTEGER;
 index: INTEGER;
 aHandle: Handle;
 theID: INTEGER;
 name:  Str255;

 {=========================}
 PROCEDURE ListROMResources;

 VAR
 i:INTEGER;
 k:INTEGER;

 BEGIN
 flagPtr^ := mapTrue;
 numTypes := CountTypes;
 { Scan all types of resources }
 FOR i := 1 TO numTypes DO
 BEGIN
 flagPtr^ := mapTrue;
 GetIndType(theType, i);
 flagPtr^ := mapTrue;
 numOfType := CountResources(theType);
 { Scan all resources of each type }
 FOR k := 1 TO numOfType DO
 BEGIN
 flagPtr^ := mapFalse;
 aHandle := GetIndResource(theType, k);
 GetResInfo(aHandle, theID, aType, name);
 flagPtr^ := mapFalse;
 { Only print the ROM resources }
 IF HomeResFile(aHandle) = 1 THEN
  Writeln(theType,’ ‘, theID,’ ‘,name);
 END;
 END;
 END;

 {=========================}
 PROCEDURE ListROvResources;

 TYPE
 OneROv = PACKED RECORD
 rType: ResType;
 rID: INTEGER;
 END;
 ROvType = PACKED RECORD
 romVersion:INTEGER;
 count: INTEGER;
 rovs:  PACKED ARRAY [0..32000] OF OneROv;
 END;
 ROvTypePtr = ^ROvType;
 ROvTypeHdl = ^ROvTypePtr;

 VAR
 i:INTEGER;
 k:INTEGER;
 rovHandle: ROvTypeHdl;

 BEGIN
 numOfType := CountResources(‘ROv#’);
 FOR k := 1 TO numOfType DO
 BEGIN
 aHandle := GetIndResource(‘ROv#’, k);
 GetResInfo(aHandle, theID, aType, name);
 rovHandle := ROvTypeHdl(aHandle);
 Writeln(‘ROv# ‘, theID:0);
 Write(‘  Rom version ‘, rovHandle^^.romVersion:0,’ - ‘);
 { Identify ROM version type }
 CASE rovHandle^^.romVersion OF
 117: Writeln(‘Mac Plus’);
 376: Writeln(‘Mac II’);  
 630: Writeln(‘Mac SE’);  
 890: Writeln(‘Mac Portable’);
 1660:  Writeln(‘Mac IIci’);
 OTHERWISE
 Writeln(‘ Unknown’);
 END;
 { List contents of each Rov# }
 FOR i := 0 TO rovHandle^^.count DO
 BEGIN
 Writeln(‘  ‘, rovHandle^^.rovs[i].rType, ‘ ‘,
 rovHandle^^.rovs[i].rID:0);
 END;
 Writeln;
 END;
 END;
 
 {===========================}
 PROCEDURE ExtractROMResource;
 VAR
 rType: ResType;
 rTypePtr:StringPtr;
 value: LongInt;
 rID:   INTEGER;
 fileName:Str255;
 i:INTEGER;
 refNum:INTEGER;
 BEGIN
 { Get desired type from command line }
 rType := ‘    ‘;
 rTypePtr := StringPtr(@rType);
 FOR i := 1 TO Ord(argV^[2]^[0]) DO
 rTypePtr^[i - 1] := argV^[2]^[i];
 { Get ID number from command line }
 StringToNum(argV^[3]^, value);
 rID := INTEGER(value);
 { Get output file name from command line }
 fileName := argV^[4]^;
 { Get ROM resource, if there }
 flagPtr^ := mapTrue;
 aHandle := GetResource(rType, rID);
 IF aHandle = NIL THEN
 Writeln(‘No such resource’)
 ELSE
 BEGIN
 Writeln(‘Extracting ‘,rType, ‘ ‘, rID:0, ‘ to file ‘,fileName);
 GetResInfo(aHandle, theID, aType, name);
 HNoPurge(aHandle);
 DetachResource(aHandle);
 { Open output file; create it if it doesn’t exist }
 refNum := OpenResFile(fileName);
 IF refNum = -1 THEN
 BEGIN
 IF Create(fileName, 0, ‘RSED’,    ‘rsrc’) = noErr THEN
 BEGIN
 CreateResFile(fileName);
 refNum := OpenResFile(fileName);
 END;
 END;
 IF refNum = -1 THEN
 Writeln(‘Problem with file’)
 ELSE
 BEGIN
 AddResource(aHandle, rType, rID, name);
 CloseResFile(refNum);
 END;
 END;
 END;

BEGIN
 { if error in command line, print info }
 printUsage := TRUE;
 { save pointer to low-mem global, for convenience }
 flagPtr := IntPtr(RomMapInsert);
 { act on option: -l -r or -x }
 IF argC > 1 THEN
 IF (Ord(argV^[1]^[0]) > 1) AND 
 (argV^[1]^[1] = ‘-’) THEN
 CASE argV^[1]^[2] OF
 ‘l’:
 BEGIN
 ListROMResources;
 printUsage := FALSE;
 END;
 ‘r’:
 BEGIN
 ListRovResources;
 printUsage := FALSE;
 END;
 ‘x’:
 IF argC > 4 THEN
 BEGIN
 ExtractROMResource;
 printUsage := FALSE;
 END;
 END;
 { print instructions if problem with command line }
 IF printUsage THEN
 BEGIN
 Writeln(‘ROMRes [option ]’);
 Write(‘    -l                            #’);
 Writeln(‘ list types and ids of ROM resources’);
 Write(‘    -r                            #’);
 Writeln(‘ list all overridden resources’);
 Write(‘    -x resType resID outputFile   #’);
 Writeln(‘ extract a ROM resource and write to file’);
 END;
END.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

ExpanDrive 4.3.2 - Access cloud storage...
ExpanDrive builds cloud storage in every application, acts just like a USB drive plugged into your Mac. With ExpanDrive, you can securely access any remote file server directly from the Finder or... Read more
RapidWeaver 6.0.8 - 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
Artlantis Studio 5.1.2.7 - 3D rendering...
Artlantis Studio is a unique and ideal tool for performing very high resolution rendering easily and in real time. The new FastRadiosity engine now lets you compute images in radiosity-even in... Read more
MacUpdate Desktop 6.0.5 - Search and ins...
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
BitTorrent Sync 2.0.82 - Sync files secu...
BitTorrent Sync allows you to sync unlimited files between your own devices, or share a folder with friends and family to automatically sync anything. File transfers are encrypted. Your information... Read more
Google Drive 1.20 - File backup and shar...
Google Drive is a place where you can create, share, collaborate, and keep all of your stuff. Whether you're working with a friend on a joint research project, planning a wedding with your fiancé, or... Read more
Simon 4.0.3 - Monitor changes and crashe...
Simon monitors websites and alerts you of crashes and changes. Select pages to monitor, choose your alert options, and customize your settings. Simon does the rest. Keep a watchful eye on your... Read more
Vitamin-R 2.23 - Personal productivity t...
Vitamin-R creates the optimal conditions for your brain to work at its best by structuring your work into short bursts of distraction-free, highly focused activity alternating with opportunities for... Read more
iDefrag 5.0.0 - Disk defragmentation and...
iDefrag helps defragment and optimize your disk for improved performance. Features include: Supports HFS and HFS+ (Mac OS Extended). Supports case sensitive and journaled filesystems. Supports... Read more
PCalc 4.2 - Full-featured scientific cal...
PCalc is a full-featured, scriptable scientific calculator with support for hexadecimal, octal, and binary calculations, as well as an RPN mode, programmable functions, and an extensive set of unit... Read more

Warner Bros. Interactive Entertainment A...
Warner Bros. has some exciting games coming down the pipe! | Read more »
GDC 2015 – Star Trek Timelines will Prob...
GDC 2015 – Star Trek Timelines will Probably Make Your Inner Trekkie Squeal With Glee Posted by Rob Rich on March 4th, 2015 [ permalink ] Any popular fictional universe has its fair share of fan fiction – where belo | Read more »
Protect Yourself from an Onslaught of Ca...
Surprise Attack Games has announced a Cat-astrophic new physics puzzler called Fort Meow! In the game, a young girl named Nia finds her grandfather’s journal which triggers an all mighty feline attack! Why do the cats want the journal? Who knows,... | Read more »
GDC 2015 – Jelly Reef will be Game Oven’...
GDC 2015 – Jelly Reef will be Game Oven’s Last Hurrah, and it Seems like a Good Note to Go Out on Posted by Rob Rich on March 4th, 2015 [ permalink ] It’s sad knowing that Game Oven ( | Read more »
daWindci Deluxe Review
daWindci Deluxe Review By Campbell Bird on March 4th, 2015 Our Rating: :: BLUSTERY PUZZLESUniversal App - Designed for iPhone and iPad This updated puzzle game offers some creative gameplay and new mechanics, but still suffers from... | Read more »
Dungeon Hunter 5 Coming on March 12
Gameloft has excitedly announced that Dungeon Hunter 5 is on its way! Once again, you will adventure across the land of Valenthia exploring dungeons and fighting monsters. The game will have a new asynchronous multiplayer mode called Strongholds... | Read more »
GDC 2015 – The Sandbox 2 is Coming, and...
GDC 2015 – The Sandbox 2 is Coming, and Now it has Textures! | Read more »
Warner Bros. Interactive Announces Mort...
Mortal Kombat X, by Warner Bros. and NetherRealm Studios, will be a a free-to-play fighting/card-battle Mortal Kombat game. The game promises card collecting, multiplayer team combat, classic characters such as Scorpion, Sub-Zero and Raiden, and the... | Read more »
GDC 2015 – Piloteer is Whitaker Trebella...
GDC 2015 – Piloteer is Whitaker Trebella’s Latest Project, and it’s Definitely Something DIfferent Posted by Rob Rich on March 3rd, 2015 [ permalink ] You know | Read more »
PangoLand Review
PangoLand Review By Amy Solomon on March 3rd, 2015 Our Rating: :: COME VISIT PANGO AND FRIENDSUniversal App - Designed for iPhone and iPad PangoLand is an open-ended world full of familiar characters, bright colors and interactive... | Read more »

Price Scanner via MacPrices.net

iPad: A More Positive Outlook – The ‘Book Mys...
It’s good to hear someone saying positive things about the iPad. I’ve been trying to bend my mind around how Apple’s tablet could have gone from zero to bestselling personal computing device on the... Read more
Mac Pros on sale for up to $279 off MSRP
Amazon has Mac Pros in stock and on sale for up to $279 off MSRP. Shipping is free: - 4-Core Mac Pro: $2725.87, $273 off MSRP (9%) - 6-Core Mac Pro: $3719.99, $279 off MSRP (7%) Read more
Sale! 13-inch Retina MacBook Pros for up to $...
B&H Photo has 13″ Retina MacBook Pros on sale for up to $205 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 2.6GHz/128GB Retina MacBook Pro: $1219.99 save $80 - 13″ 2.... Read more
Another Tranche Of IBM MobileFirst For iOS Ap...
IBM has announced the next expansion phase for  its IBM MobileFirst for iOS portfolio, with a troika of new apps to address key priorities for the Banking and Financial Services, Airline and Retail... Read more
Sale! 15-inch Retina MacBook Pros for up to $...
B&H Photo has the new 2014 15″ Retina MacBook Pros on sale for up to $250 off MSRP for a limited time. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.2GHz Retina MacBook Pro: $... Read more
WaterField Designs Introduces the Minimalist...
With Apple Pay gaining popularity, Android Pay coming in May 2015, and loyalty cards and receipts that can be accessed from smartphones, San Francisco’s WaterField Designs observes that it may be... Read more
Sale! 15-inch 2.2GHz Retina MacBook Pro for $...
 Best Buy has the 15″ 2.2GHz Retina MacBook Pro on sale for $1774.99 $1799.99, or $225 off MSRP. Choose free home shipping or free local store pickup (if available). Price valid for online orders... 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
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
27-inch 3.5GHz 5K iMac in stock today and on...
 B&H Photo has the 27″ 3.5GHz 5K iMac in stock today and on sale for $2299 including free shipping plus NY sales tax only. Their price is $200 off MSRP, and it’s the lowest price available for... 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* 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
Position Opening at *Apple* - Apple (United...
…Summary** As a Specialist, you help create the energy and excitement around Apple products, providing the right solutions and getting products into customers' hands. You Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** The Apple Store is a retail environment like no other - uniquely focused on delivering amazing customer experiences. As an Expert, you introduce people 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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.