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

Go from lowly lizard to wicked Wyvern in...
Do you like questing, and do you like dragons? If not then boy is this not the announcement for you, as Loongcheer Game has unveiled Quest Dragon: Idle Mobile Game. Yes, it is amazing Square Enix hasn’t sued them for copyright infringement, but... | Read more »
Aether Gazer unveils Chapter 16 of its m...
After a bit of maintenance, Aether Gazer has released Chapter 16 of its main storyline, titled Night Parade of the Beasts. This big update brings a new character, a special outfit, some special limited-time events, and, of course, an engaging... | Read more »
Challenge those pesky wyverns to a dance...
After recently having you do battle against your foes by wildly flailing Hello Kitty and friends at them, GungHo Online has whipped out another surprising collaboration for Puzzle & Dragons. It is now time to beat your opponents by cha-cha... | Read more »
Pack a magnifying glass and practice you...
Somehow it has already been a year since Torchlight: Infinite launched, and XD Games is celebrating by blending in what sounds like a truly fantastic new update. Fans of Cthulhu rejoice, as Whispering Mist brings some horror elements, and tests... | Read more »
Summon your guild and prepare for war in...
Netmarble is making some pretty big moves with their latest update for Seven Knights Idle Adventure, with a bunch of interesting additions. Two new heroes enter the battle, there are events and bosses abound, and perhaps most interesting, a huge... | Read more »
Make the passage of time your plaything...
While some of us are still waiting for a chance to get our hands on Ash Prime - yes, don’t remind me I could currently buy him this month I’m barely hanging on - Digital Extremes has announced its next anticipated Prime Form for Warframe. Starting... | Read more »
If you can find it and fit through the d...
The holy trinity of amazing company names have come together, to release their equally amazing and adorable mobile game, Hamster Inn. Published by HyperBeard Games, and co-developed by Mum Not Proud and Little Sasquatch Studios, it's time to... | Read more »
Amikin Survival opens for pre-orders on...
Join me on the wonderful trip down the inspiration rabbit hole; much as Palworld seemingly “borrowed” many aspects from the hit Pokemon franchise, it is time for the heavily armed animal survival to also spawn some illegitimate children as Helio... | Read more »
PUBG Mobile teams up with global phenome...
Since launching in 2019, SpyxFamily has exploded to damn near catastrophic popularity, so it was only a matter of time before a mobile game snapped up a collaboration. Enter PUBG Mobile. Until May 12th, players will be able to collect a host of... | Read more »
Embark into the frozen tundra of certain...
Chucklefish, developers of hit action-adventure sandbox game Starbound and owner of one of the cutest logos in gaming, has released their roguelike deck-builder Wildfrost. Created alongside developers Gaziter and Deadpan Games, Wildfrost will... | Read more »

Price Scanner via MacPrices.net

13-inch M2 MacBook Airs in stock today at App...
Apple has 13″ M2 MacBook Airs available for only $849 today in their Certified Refurbished store. These are the cheapest M2-powered MacBooks for sale at Apple. Apple’s one-year warranty is included,... Read more
New today at Apple: Series 9 Watches availabl...
Apple is now offering Certified Refurbished Apple Watch Series 9 models on their online store for up to $80 off MSRP, starting at $339. Each Watch includes Apple’s standard one-year warranty, a new... Read more
The latest Apple iPhone deals from wireless c...
We’ve updated our iPhone Price Tracker with the latest carrier deals on Apple’s iPhone 15 family of smartphones as well as previous models including the iPhone 14, 13, 12, 11, and SE. Use our price... Read more
Boost Mobile will sell you an iPhone 11 for $...
Boost Mobile, an MVNO using AT&T and T-Mobile’s networks, is offering an iPhone 11 for $149.99 when purchased with their $40 Unlimited service plan (12GB of premium data). No trade-in is required... Read more
Free iPhone 15 plus Unlimited service for $60...
Boost Infinite, part of MVNO Boost Mobile using AT&T and T-Mobile’s networks, is offering a free 128GB iPhone 15 for $60 per month including their Unlimited service plan (30GB of premium data).... Read more
$300 off any new iPhone with service at Red P...
Red Pocket Mobile has new Apple iPhones on sale for $300 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
Clearance 13-inch M1 MacBook Airs available a...
Apple has clearance 13″ M1 MacBook Airs, Certified Refurbished, available for $759 for 8-Core CPU/7-Core GPU/256GB models and $929 for 8-Core CPU/8-Core GPU/512GB models. Apple’s one-year warranty is... Read more
Updated Apple MacBook Price Trackers
Our Apple award-winning MacBook Price Trackers are continually updated with the latest information on prices, bundles, and availability for 16″ and 14″ MacBook Pros along with 13″ and 15″ MacBook... Read more
Every model of Apple’s 13-inch M3 MacBook Air...
Best Buy has Apple 13″ MacBook Airs with M3 CPUs in stock and on sale today for $100 off MSRP. Prices start at $999. Their prices are the lowest currently available for new 13″ M3 MacBook Airs among... Read more
Sunday Sale: Apple iPad Magic Keyboards for 1...
Walmart has Apple Magic Keyboards for 12.9″ iPad Pros, in Black, on sale for $150 off MSRP on their online store. Sale price for online orders only, in-store price may vary. Order online and choose... Read more

Jobs Board

Solutions Engineer - *Apple* - SHI (United...
**Job Summary** An Apple Solution Engineer's primary role is tosupport SHI customers in their efforts to select, deploy, and manage Apple operating systems and Read more
DMR Technician - *Apple* /iOS Systems - Haml...
…relevant point-of-need technology self-help aids are available as appropriate. ** Apple Systems Administration** **:** Develops solutions for supporting, deploying, Read more
Omnichannel Associate - *Apple* Blossom Mal...
Omnichannel Associate - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Read more
Operations Associate - *Apple* Blossom Mall...
Operations Associate - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Read more
Cashier - *Apple* Blossom Mall - JCPenney (...
Cashier - Apple Blossom Mall Location:Winchester, VA, United States (https://jobs.jcp.com/jobs/location/191170/winchester-va-united-states) - Apple Blossom Mall Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.