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

Latest Forum Discussions

See All

Six fantastic ways to spend National Vid...
As if anyone needed an excuse to play games today, I am about to give you one: it is National Video Games Day. A day for us to play games, like we no doubt do every day. Let’s not look a gift horse in the mouth. Instead, feast your eyes on this... | Read more »
Old School RuneScape players turn out in...
The sheer leap in technological advancements in our lifetime has been mind-blowing. We went from Commodore 64s to VR glasses in what feels like a heartbeat, but more importantly, the internet. It can be a dark mess, but it also brought hundreds of... | Read more »
Today's Best Mobile Game Discounts...
Every day, we pick out a curated list of the best mobile discounts on the App Store and post them here. This list won't be comprehensive, but it every game on it is recommended. Feel free to check out the coverage we did on them in the links below... | Read more »
Nintendo and The Pokémon Company's...
Unless you have been living under a rock, you know that Nintendo has been locked in an epic battle with Pocketpair, creator of the obvious Pokémon rip-off Palworld. Nintendo often resorts to legal retaliation at the drop of a hat, but it seems this... | Read more »
Apple exclusive mobile games don’t make...
If you are a gamer on phones, no doubt you have been as distressed as I am on one huge sticking point: exclusivity. For years, Xbox and PlayStation have done battle, and before this was the Sega Genesis and the Nintendo NES. On console, it makes... | Read more »
Regionally exclusive events make no sens...
Last week, over on our sister site AppSpy, I babbled excitedly about the Pokémon GO Safari Days event. You can get nine Eevees with an explorer hat per day. Or, can you? Specifically, you, reader. Do you have the time or funds to possibly fly for... | Read more »
As Jon Bellamy defends his choice to can...
Back in March, Jagex announced the appointment of a new CEO, Jon Bellamy. Mr Bellamy then decided to almost immediately paint a huge target on his back by cancelling the Runescapes Pride event. This led to widespread condemnation about his perceived... | Read more »
Marvel Contest of Champions adds two mor...
When I saw the latest two Marvel Contest of Champions characters, I scoffed. Mr Knight and Silver Samurai, thought I, they are running out of good choices. Then I realised no, I was being far too cynical. This is one of the things that games do best... | Read more »
Grass is green, and water is wet: Pokémo...
It must be a day that ends in Y, because Pokémon Trading Card Game Pocket has kicked off its Zoroark Drop Event. Here you can get a promo version of another card, and look forward to the next Wonder Pick Event and the next Mass Outbreak that will be... | Read more »
Enter the Gungeon review
It took me a minute to get around to reviewing this game for a couple of very good reasons. The first is that Enter the Gungeon's style of roguelike bullet-hell action is teetering on the edge of being straight-up malicious, which made getting... | Read more »

Price Scanner via MacPrices.net

Take $150 off every Apple 11-inch M3 iPad Air
Amazon is offering a $150 discount on 11-inch M3 WiFi iPad Airs right now. Shipping is free: – 11″ 128GB M3 WiFi iPad Air: $449, $150 off – 11″ 256GB M3 WiFi iPad Air: $549, $150 off – 11″ 512GB M3... Read more
Apple iPad minis back on sale for $100 off MS...
Amazon is offering $100 discounts (up to 20% off) on Apple’s newest 2024 WiFi iPad minis, each with free shipping. These are the lowest prices available for new minis among the Apple retailers we... Read more
Apple’s 16-inch M4 Max MacBook Pros are on sa...
Amazon has 16-inch M4 Max MacBook Pros (Silver and Black colors) on sale for up to $410 off Apple’s MSRP right now. Shipping is free. Be sure to select Amazon as the seller, rather than a third-party... Read more
Red Pocket Mobile is offering a $150 rebate o...
Red Pocket Mobile has new Apple iPhone 17’s on sale for $150 off MSRP when you switch and open up a new line of service. Red Pocket Mobile is a nationwide MVNO using all the major wireless carrier... Read more
Switch to Verizon, and get any iPhone 16 for...
With yesterday’s introduction of the new iPhone 17 models, Verizon responded by running “on us” promos across much of the iPhone 16 lineup: iPhone 16 and 16 Plus show as $0/mo for 36 months with bill... Read more
Here is a summary of the new features in Appl...
Apple’s September 2025 event introduced major updates across its most popular product lines, focusing on health, performance, and design breakthroughs. The AirPods Pro 3 now feature best-in-class... Read more
Apple’s Smartphone Lineup Could Use A Touch o...
COMMENTARY – Whatever happened to the old adage, “less is more”? Apple’s smartphone lineup. — which is due for its annual refresh either this month or next (possibly at an Apple Event on September 9... Read more
Take $50 off every 11th-generation A16 WiFi i...
Amazon has Apple’s 11th-generation A16 WiFi iPads in stock on sale for $50 off MSRP right now. Shipping is free: – 11″ 11th-generation 128GB WiFi iPads: $299 $50 off MSRP – 11″ 11th-generation 256GB... Read more
Sunday Sale: 14-inch M4 MacBook Pros for up t...
Don’t pay full price! Amazon has Apple’s 14-inch M4 MacBook Pros (Silver and Black colors) on sale for up to $220 off MSRP right now. Shipping is free. Be sure to select Amazon as the seller, rather... Read more
Mac mini with M4 Pro CPU back on sale for $12...
B&H Photo has Apple’s Mac mini with the M4 Pro CPU back on sale for $1259, $140 off MSRP. B&H offers free 1-2 day shipping to most US addresses: – Mac mini M4 Pro CPU (24GB/512GB): $1259, $... Read more

Jobs Board

All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.