TweetFollow Us on Twitter

May 94 - Handling Preferences

Handling Preferences

Bob Hablutzel

I have something new for you this month. So far, all my articles have been MacApp-based. This month, I am going to present a generic C++ class. Actually; if you get the source code diskettes, you will get two versions of this generic class - one for the standard system header files, and one for the MacApp 3.0.1 header files. The differences are syntactic and minor; I'm just saving you the work of making the changes yourself.

The Issue

The problem to solve this month is handling user preferences. One of the marks of a good Macintosh program is the maintenance of a preference file in the preferences folder. This file can contains the information that describes how the user has customized the application for the way they work.

In general, this information can be neatly captured in resources. The data is fairly small, and usually broken into chunks that different parts of the application access. The code I present here handles preferences as resources.

Let's talk briefly about the zen of preferences. Preferences may or may not have default values. The user's company name, for example, is rarely defaulted. (The user's name can-and should-be obtained from the name entered under Sharing Setup). The color for comments in code could, however, be defaulted; the user has the option of overriding this default.

There needs to be a place for storing these default values. Generally, the application resource fork is the best, most convenient place for this. This is simply done by storing the preset preference resource in the application; when the application goes to access the preference it will be found in the application until a new resource is created in the preference file.

For saving changed resources, however, the application resource fork cannot be used. Since applications might be run from a read only volume, such as file servers; any attempt to write to the application would fail. Also, remember that in a server environment there might be multiple users of a single copy of an application. We want the preferences from each user to remain separate and distinct.

We are then left with two different strategies: one for reading and one for writing. When reading, the code needs to first look in the preference file, if any, and then in the application. Reads should not fail if the preferences file is not there. When writing, the code needs to write the resource directly to the preferences file, creating it if necessary. Additionally, the code needs to check to see if there is an existing preference resource in the preference file; this resource will need to be deleted if it exists.

The class I have written is designed to be generic. In particular, it makes no assumptions about the failure handling mechanism of the framework you are using. It therefore does not signal errors in any coherent manner. Read errors are signaled by returning a NULL handle; write operations fail silently.

This is probably not as bad a situation as you might think. Remember that preferences are generally fairly lightweight data. The application can execute without reading or writing preference information; it will simply use default information instead. (Of course, if the application is counting on a default preference resource to be there, and it's not, there might be problems. But this case means that the application resource fork is not in the state the application assumes it is in, which is probably a problem in any case).

It would be fairly trivial to enhance this code with failures, if you had the interest. If enough people tell me they are interested in a failure handler based version of this code, I will write it for inclusion in a future source diskette.

The Class

This class is used by declaring a stack based object of class CPreferencesHandler. The class takes a single argument, which is the ident of a resource of type 'Prfl'. This resource describes the resource file in case the preferences handle needs to create the file; it includes the name of the file, the type and creator, and the script system. The file will be created in the preferences folder, as specified by a FindFolder call. The resource also includes a string to include in the file for the Finder to display when the file is clicked upon.

The reason that the file name needs to be included is that the user might well change the name of the application. We don't want to have the problem of losing the preferences file if the user does so. So we make sure we always look for the same file. The file type and creator are needed because the Human Interface Guidelines say that the application should not be launched if the preferences file is double clicked upon. Since the preferences file is not the same as the document type for the application, the application will most likely get confused anyhow. So the recommended tactic is to register a creator for the preferences file and never create an application that can open this type. Then, when the Finder goes to open the file, it will fail, and post up the string specified as part of the 'Prfl' resource. This string will let the user know that the file could not be opened as it is a preference file.

Once the object has been declared, reading and writing preference resources is trivial. To read, the ReadPreference method is invoked. This opens the preference file, if any, and attempts to read the resource. If the resource or preference file could not be read, then the method attempts to read from the application. If the resource could not be found in either place, NULL is returned.

Writing resource is just as easy. In the case of writing, the handle is passed along with the type and ident of the resource. The preference file is created, if necessary, and any old copies of the resource are deleted.

A couple of final notes. This class is a little inefficient in a number of ways. First, it insists on continually opening and closing the resource file for each read/write. Also, it does not check to see if the file is already open before opening it; this could lead to the file getting closed behind someone's back. I have an idea for fixing both these problems, but that is next months column. Preferences files are special enough that these limitations should not prevent you from using the class as it is, and I promise that the interfaces for the class will not change when the new version comes out.

In any case, these classes reduce the headache of preferences files down to a couple of simple calls; the class hides all the complexity (as it should). I have found these classes to be extremely useful; I hope you will too.

**** Sidebar ***

//  Declare the preference file data type
typedef struct
{
    OSType                      creator;
    OSType                      type;
    short                       script;
    short                       fileOpenCommentIdent;
    Str31                       fileName;
} PreferencesFileData, *PreferencesFileDataPtr,
    **PreferencesFileDataHandle;

//  Declare our class
class   CPreferencesHandler
{
public:
    CPreferencesHandler(
        short   preferencesFileDataIdent = 128 );
    ~CPreferencesHandler( void );

    //  ReadPreference is called to get a resource from the 
    //  preferences file, if available, or from the application,
    // if available.
    Handle ReadPreference(
        OSType          resourceType,
        short           resourceIdent );

    //  WritePreference is called to write a resource to the
    //  preferences file, creating it if neccessary
    void WritePreference(
        Handle              preference,
        OSType              resourceType,
        short               resourceIdent,
        const Str255&   resourceName );

private:

    //  GetApplicationResource is called to get a resource from the
    //  application file
    Handle GetApplicationResource(
        OSType          resourceType,
        short           resourceIdent );

    //  fPreferencesFileSpec contains the preferences file spec
    FSSpec                          fPreferencesFileSpec;

    //  fSpecificationValid contains TRUE if the specification is
    //  valid - the preferences file name could be found.
    Boolean                         fSpecificationValid;

    //  fPrefData contains a handle to the preferences data
    PreferencesFileDataHandle       fPrefData;
};
 

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.