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;
};
 
AAPL
$99.18
Apple Inc.
-1.57
MSFT
$45.90
Microsoft Corpora
-0.46
GOOG
$568.27
Google Inc.
-9.09

MacTech Search:
Community Search:

Software Updates via MacUpdate

Cocktail Family License (5 Macs) 7.6.1 -...
Cocktail is a general purpose utility for OS X that lets you clean, repair and optimize your Mac. It is a powerful digital toolset that helps hundreds of thousands of Mac users around the world get... Read more
Cocktail 8.0 Beta 2 - General maintenanc...
Cocktail is a general purpose utility for OS X that lets you clean, repair and optimize your Mac. It is a powerful digital toolset that helps hundreds of thousands of Mac users around the world get... Read more
QuickBooks 2015 16.0.0.1352 R1 - Financi...
QuickBooks 2015 helps you manage your business easily and efficiently. Organize your finances all in one place, track money going in and out of your business, and spot areas where you can save.... Read more
Mac DVDRipper Pro 5.0.1 - 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
Apple OS X bash Update 1.0 - Fix for sec...
The OS X bash Update fixes a security flaw in the bash UNIX shell on OS X 10.9.5 (also on OS X 10.8 and 10.7 [see Related Links below]). OS X 10.9.5 or later Downloads for OS X 10.8 and OS X 10.7 in... Read more
SyncTwoFolders 2.0.5 - Syncs two user-sp...
SyncTwoFolders simply synchronizes two folders. It supports synchronization across mounted network drives and it is a possibility to run a simulation showing in a log what will be done. Please visit... Read more
FinderPop 2.5.7 - Classic Mac utility, n...
FinderPop is a Universal preference pane that extends OS X's contextual menus using a FinderPop Items folder much as the Apple Menu Items folder used to do for the Apple menu. It has other features... Read more
VueScan 9.4.45 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
LibreOffice 4.3.2.2 - Free Open Source o...
LibreOffice is an office suite (word processor, spreadsheet, presentations, drawing tool) compatible with other major office suites. The Document Foundation is coordinating development and... Read more
calibre 2.4 - Complete e-library managem...
Calibre is a complete e-book library manager. Organize your collection, convert your books to multiple formats, and sync with all of your devices. Let Calibre be your multi-tasking digital... Read more

Latest Forum Discussions

See All

iKeywi - Customizable 5-Row Keyboard (U...
iKeywi - Customizable 5-Row Keyboard 1.0 Device: iOS Universal Category: Utilities Price: $.99, Version: 1.0 (iTunes) Description: Want to add an extra row to your iPhone/iPad? One of the most popular keyboard extension in iOS... | Read more »
Manage Your Cloud – Wunderlist Now Suppo...
Manage Your Cloud – Wunderlist Now Supports Dropbox Posted by Jessica Fisher on October 1st, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Nexticy Review
Nexticy Review By Jennifer Allen on October 1st, 2014 Our Rating: :: IDEAL FORM CREATIONiPad Only App - Designed for the iPad Nexticy allows you to make your own forms for research purposes or to organize your business better. It’s... | Read more »
Tiny Troopers: Alliance Marches onto the...
Tiny Troopers: Alliance Marches onto the App Store Tomorrow Posted by Jessica Fisher on October 1st, 2014 [ permalink ] Tiny Troopers: Alliance, by Kukouri, is a | Read more »
HeroCraft Introduces Unlimited Sequel to...
HeroCraft Introduces Unlimited Sequel to WW2: Sandbox. Strategy & Tactics Posted by Jessica Fisher on October 1st, 2014 [ permalink ] | Read more »
RGB Express Review
RGB Express Review By Jennifer Allen on October 1st, 2014 Our Rating: :: DELIGHTFUL PUZZLINGUniversal App - Designed for iPhone and iPad Guide trucks along their delivery routes in RGB Express, a testing but charming puzzle game... | Read more »
The Sagas of Fire*Wolf (Games)
The Sagas of Fire*Wolf 1.0 Device: iOS Universal Category: Games Price: $9.99, Version: 1.0 (iTunes) Description: | Read more »
BuggyFun Review
BuggyFun Review By Amy Solomon on October 1st, 2014 Our Rating: iPad Only App - Designed for the iPad BuggyFun allows children to create their own tracks for bugs to interact with for a unique open-ended experience.   | Read more »
Fold the Adventure Review
Fold the Adventure Review By Jennifer Allen on October 1st, 2014 Our Rating: :: AWKWARD FOLDSUniversal App - Designed for iPhone and iPad Fold pieces of paper to create platforms for a princely rabbit in this puzzle game; something... | Read more »
WW2: Sandbox. Strategy & Tactics (G...
WW2: Sandbox. Strategy & Tactics 1.0.0 Device: iOS Universal Category: Games Price: $9.99, Version: 1.0.0 (iTunes) Description: ***NOTE: Compatible with iPhone 4s and up, iPad 2 and up - may not work properly on earlier devices... | Read more »

Price Scanner via MacPrices.net

Amazon offers 13-inch MacBook Air for $899, $...
Amazon.com has the 13″ 1.4GHz 128GB MacBook Air on sale for $100 off MSRP including free shipping: - 13″ 1.4GHz 128GB MacBook Air: $899.99 Read more
Apple resting On Its iPhone Laurels? – The ‘B...
Apple calls its new iPhone 6 and 6 Plus “The Biggest Advancements in iPhone History,” but does reality live up to the hype? “Seldom have so many waited so breathlessly for so little,” tweeted veteran... Read more
Roundup of Apple Mac and iPad Education disco...
Purchase a new Mac or iPad at The Apple Store for Education and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free,... Read more
Apple Boycotts German Magazine Computer Bild...
Apple has revoked its PR accreditation of Germany’s Computer Bild, Europe’s best-selling PC magazine, in reaction to Bild’s posting of a “#Bentgate” YouTube video. Axel Telzerow, editor in chief of... Read more
iPhone 6 & iPhone 6 Plus Available in Chi...
Apple has announced that iPhone 6 and iPhone 6 Plus will be available in China beginning Friday, October 17 from the Apple Online Store (http://www.apple.com), Apple’s retail stores, and an expansive... Read more
MacBook Airs on sale for $100 off MSRP, start...
Best Buy has the new 2014 MacBook Airs on sale for $100 off MSRP on their online store. Choose free home shipping or free local store pickup (if available). Prices valid for online orders only, in-... Read more
Apple Releases OS X Mavericks bash Update 1.0...
Apple has released a patch update for OS X Mavericks users to address the recently-detected “Shellshock” security bug in BSD UNIX’s bash shell. Apple says only a few Mac users who had manually... Read more
Pivotal Payments Ready for Apple Pay – FlexPo...
Pivotal Payments, a provider of merchant services and global payment processing solutions, has announced its proprietary FlexPoint platform will support credit and debit transactions through Apple’s... Read more
iStabilizer Announces Tabarm — First Friction...
iStabilizer, a specialist in universal lightweight compact tripods, steady cams, dollies, mounts, and remotes for smartphones, tablets, and cameras, announced today the iStabilizer tabArm, the first... Read more
IStabilizer Flex Smartphone Tripod Wins Usa T...
iStabilizer, a specialist in universal lightweight compact tripods, steady cams, and other products for smartphones, tablets, and cameras, has announced today that its iStabilizer Flex smartphone... 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* 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
Senior Event Manager, *Apple* Retail Market...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global event strategy. Delivering an overarching brand story; in-store, Read more
*Apple* Solutions Consultant (ASC) - Apple (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
Project Manager / Business Analyst, WW *Appl...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.