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

Bookends 12.8 - Reference management and...
Bookends is a full-featured bibliography/reference and information-management system for students and professionals. Bookends uses the cloud to sync reference libraries on all the Macs you use.... Read more
Adobe Creative Cloud 4.0.0.185 - Access...
Adobe Creative Cloud costs $19.99/month for a single app, or $49.99/month for the entire suite. Introducing Adobe Creative Cloud desktop applications, including Adobe Photoshop CC and Illustrator CC... Read more
Default Folder X 5.1.4 - Enhances Open a...
Default Folder X attaches a toolbar to the right side of the Open and Save dialogs in any OS X-native application. The toolbar gives you fast access to various folders and commands. You just click on... Read more
Amazon Chime 4.1.5587 - Amazon-based com...
Amazon Chime is a communications service that transforms online meetings with a secure, easy-to-use application that you can trust. Amazon Chime works seamlessly across your devices so that you can... Read more
Persecond 1.0.9 - Timelapse video made e...
Persecond is the easy, fun way to create a beautiful timelapse video. Import an image sequence from any camera, trim the length of your video, adjust the speed and playback direction, and you’re done... Read more
CrossOver 16.2 - Run Windows apps on you...
CrossOver can get your Windows productivity applications and PC games up and running on your Mac quickly and easily. CrossOver runs the Windows software that you need on Mac at home, in the office,... Read more
MegaSeg 6.0.2 - Professional DJ and radi...
MegaSeg is a complete solution for pro audio/video DJ mixing, radio automation, and music scheduling with rock-solid performance and an easy-to-use design. Mix with visual waveforms and Magic... Read more
Apple iTunes 12.6 - Play Apple Music and...
Apple iTunes lets you organize and stream Apple Music, download and watch video and listen to Podcasts. It can automatically download new music, app, and book purchases across all your devices and... Read more
GraphicConverter 10.4 - $39.95
GraphicConverter is an all-purpose image-editing program that can import 200 different graphic-based formats, edit the image, and export it to any of 80 available file formats. The high-end editing... Read more
OpenEmu 2.0.5 - Open Source game-emulati...
OpenEmu is about to change the world of video game emulation, one console at a time... For the first time, the 'It just works' philosophy now extends to open source video game emulation on the Mac.... Read more

Orphan Black: The Game (Games)
Orphan Black: The Game 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: Dive into a dark and twisted puzzle-adventure that retells the pivotal events of Orphan Black. | Read more »
The Elder Scrolls: Legends is now availa...
| Read more »
Ticket to Earth beginner's guide: H...
Robot Circus launched Ticket to Earth as part of the App Store's indie games event last week. If you're not quite digging the space operatics Mass Effect: Andromeda is serving up, you'll be pleased to know that there's a surprising alternative on... | Read more »
Leap to victory in Nexx Studios new plat...
You’re always a hop, skip, and a jump away from a fiery death in Temple Jump, a new platformer-cum-endless runner from Nexx Studio. It’s out now on both iOS and Android if you’re an adventurer seeking treasure in a crumbling, pixel-laden temple. | Read more »
Failbetter Games details changes coming...
Sunless Sea, Failbetter Games' dark and gloomy sea explorer, sets sail for the iPad tomorrow. Ahead of the game's launch, Failbetter took to Twitter to discuss what will be different in the mobile version of the game. Many of the changes make... | Read more »
Splish, splash! The Pokémon GO Water Fes...
Niantic is back with a new festival for dedicated Pokémon GO collectors. The Water Festival officially kicks off today at 1 P.M. PDT and runs through March 29. Magikarp, Squirtle, Totodile, and their assorted evolved forms will be appearing at... | Read more »
Death Road to Canada (Games)
Death Road to Canada 1.0 Device: iOS Universal Category: Games Price: $7.99, Version: 1.0 (iTunes) Description: Get it now at the low launch price! Price will go up a dollar every major update. Update news at the bottom of this... | Read more »
Bean's Quest Beginner's Guide:...
Bean's Quest is a new take on both the classic platformer and the endless runner, and it's free on the App Store for the time being. Instead of running constantly, you can't stop jumping. That adds a surprising new level of challenge to the game... | Read more »
How to rake in the cash in Bit City
Our last Bit City guide covered the basics. Now it's time to get into some of the more advanced techniques. In the later cities, cash flow becomes much more difficult, so you'll want to develop some strategies if you want to complete each level.... | Read more »
PixelTerra (Games)
PixelTerra 1.1.1 Device: iOS Universal Category: Games Price: $.99, Version: 1.1.1 (iTunes) Description: The world of PixelTerra is quite dangerous so you need to build a shelter, find some food supply and get ready to protect... | Read more »

Price Scanner via MacPrices.net

SSD Speeder RAM Disk SSD Life Extender App Fo...
Fehraltorf, Switzerland based B-Eng has announced they are making their SSD Speeder app for macOS publicly available for purchase on their website. SSD Speeder is a RAM disk utility that prevents... Read more
iPhone Scores Highest Overall in Smartphone D...
Customer satisfaction is much higher among smartphone owners who use their device to operate other connected home services such as smart thermostats and smart appliances, according to the J.D. Power... Read more
Swipe CRM Free Photo-Centric CRM Sales DEal C...
Swipe CRM LLC has introduced Swipe CRM: Visual Sales 1.0 for iPad, an app for creating, managing, and sharing visually stunning sales deals. Swipe CRM is targeted to small-and-medium creative... Read more
13-inch 2.0GHz Apple MacBook Pros on sale for...
B&H has the non-Touch Bar 13″ 2.0GHz MacBook Pros in stock today and on sale for $150 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 2.0GHz MacBook Pro Space Gray (... Read more
15-inch Touch Bar MacBook Pros on sale for up...
B&H Photo has the new 2016 15″ Apple Touch Bar MacBook Pros in stock today and on sale for up to $150 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.7GHz Touch Bar... Read more
Apple’s iPhone 6s Tops Best-Selling Smartphon...
In terms of shipments, the iPhone 6s from Apple bested all competitors for sales in 2016, according to new analysis from IHS Markit, a world leader in critical information, analytics and solutions.... Read more
Logitech Rugged Combo Protective iPad Case an...
Logitech has announced its Logitech Rugged Combo, Logitech Rugged Case, and Logitech Add-on Keyboard for Rugged Case for Apple’s new, more affordable $329 9.7-inch iPad, a complete solution designed... Read more
T-Mobile To Offer iPhone 7 and iPhone 7 Plus...
T-Mobile has announced it will offer iPhone 7 and iPhone 7 Plus (PRODUCT)RED Special Edition in a vibrant red aluminum finish. The introduction of this special edition iPhone celebrates Apple’s 10... Read more
9-inch 128GB iPad Pros on sale for $50-$70 of...
B&H Photo has 9.7″ 128GB Apple WiFi iPad Pros on sale for up to $70 off MSRP, each including free shipping. B&H charges sales tax in NY only: - 9″ Space Gray 128GB WiFi iPad Pro: $649 $50... Read more
27-inch iMacs on sale for up to $200 off MSRP...
B&H Photo has 27″ Apple iMacs on sale for up to $200 off MSRP, each including free shipping plus NY sales tax only: - 27″ 3.3GHz iMac 5K: $2099 $200 off MSRP - 27″ 3.2GHz/1TB Fusion iMac 5K: $... Read more

Jobs Board

*Apple* Retail - Multiple Positions- Chicago...
SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
Fulltime aan de slag als shopmanager in een h...
Ben jij helemaal gek van Apple -producten en vind je het helemaal super om fulltime shopmanager te zijn in een jonge en hippe elektronicazaak? Wil jij werken in Read more
Starte Dein Karriere-Abenteuer in den Hauptst...
…mehrsprachigen Teams betreust Du Kunden von bekannten globale Marken wie Apple , Mercedes, Facebook, Expedia, und vielen anderen! Funktion Du wolltest schon Read more
*Apple* macOS Systems Integration Administra...
…most exceptional support available in the industry. SCI is seeking an Junior Apple macOS systems integration administrator that will be responsible for providing Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.