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
$94.24
Apple Inc.
+0.30
MSFT
$44.91
Microsoft Corpora
+0.08
GOOG
$597.95
Google Inc.
+8.48

MacTech Search:
Community Search:

Software Updates via MacUpdate

MacBook Air EFI Firmware Update 2.9 - Fo...
MacBook Air EFI Firmware Update is recommended for MacBook Air (Mid 2011) models. This update addresses an issue where systems may take longer to wake from sleep than expected and fixes a rare issue... Read more
FileZilla 3.9.0.1 - Fast and reliable FT...
FileZilla (ported from Windows) is a fast and reliable FTP client and server with lots of useful features and an intuitive interface.Version 3.9.0.1: MSW: Fix installation issue with locked DLLs... Read more
OS X Yosemite 10.10 DP4 - Developer Prev...
Note: This is a Developer Preview. You must be a registered Apple Mac Developer to download this update. OS X Yosemite is Apple's newest operating system for Mac. An elegant design that feels... Read more
FinderPop 2.5.6 - 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
SpiderOak 5.1.7 - Secure cloud backup, s...
SpiderOak is a multi-platform secure online backup, storage, access, and sharing solution engineered for the consumer and small businesses. You must first sign up to use SpiderOak. Running natively... Read more
Espionage 3.6 - Simple, state of the art...
Espionage offers state-of-the-art encryption and plausible deniability for your confidential data. Sometimes, encrypting your data isn't enough to protect it. That's why Espionage 3 goes beyond data... Read more
calibre 1.45.0 - Complete e-library mana...
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
iFFmpeg 4.3.1 - Convert multimedia files...
iFFmpeg is a graphical front-end for FFmpeg, a command-line tool used to convert multimedia files between formats. The command line instructions can be very hard to master/understand, so iFFmpeg does... Read more
Chromium 36.0.1985.125 - Fast and stable...
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all Internet users to experience the web. FreeSMUG-Free OpenSource Mac User Group build is... Read more
pwSafe 3.0 - Secure password management...
pwSafe provides simple and secure password management across devices and computers. pwSafe uses iCloud to keep your password databases backed-up and synced between Macs and iOS devices. It is... Read more

Latest Forum Discussions

See All

MTN Review
MTN Review By Jessica Fisher on July 22nd, 2014 Our Rating: :: ADORABLE, SERENE, AND AMUSINGUniversal App - Designed for iPhone and iPad MTN is an adorable, talking pet mountain that is less game and more zen garden.   | Read more »
Fly High with Ninja UP! Now Available o...
Fly High with Ninja UP! Now Available on the App Store Posted by Jessica Fisher on July 22nd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Bio Inc. Review
Bio Inc. Review By Nadia Oxford on July 22nd, 2014 Our Rating: :: SICKENING - IN A COMPELLING WAYUniversal App - Designed for iPhone and iPad Bio Inc is about orchestrating the medical destruction of a single person. If that doesn’... | Read more »
HELMUT Review
HELMUT Review By Andrew Fisher on July 21st, 2014 Our Rating: :: TRUNDLE SIMULATOR 2014Universal App - Designed for iPhone and iPad HELMUT is a fun, fleeting time-sink that offers a momentary distraction and nothing else.   | Read more »
Walkr Review
Walkr Review By Jennifer Allen on July 21st, 2014 Our Rating: :: ORIGINAL WALKINGiPhone App - Designed for the iPhone, compatible with the iPad Walking is a bit more exciting thanks to this planet building/discovering sim reliant... | Read more »
Zombie Commando Review
Zombie Commando Review By Jennifer Allen on July 21st, 2014 Our Rating: :: MINDLESS SLAUGHTERUniversal App - Designed for iPhone and iPad Briefly fun but ultimately forgettable, Zombie Commando will scratch an itch then be... | Read more »
Swords & Poker Adventures Review
Swords & Poker Adventures Review By Jennifer Allen on July 21st, 2014 Our Rating: :: SOULLESS POKER PLAYUniversal App - Designed for iPhone and iPad Swords & Poker Adventures is a mishmash of Poker and RPGing, but it lacks... | Read more »
Warhammer 40,000: The Horus Heresy: Drop...
Warhammer 40,000: The Horus Heresy: Drop Assault Coming Soon to iOS Posted by Jennifer Allen on July 21st, 2014 [ permalink ] Coming soon to iOS will be an all-new Warhammer 40,000 tactical strategy game by the name of The Horus Heresy: Drop As | Read more »
A Life Worth Dying For Review
A Life Worth Dying For Review By Jordan Minor on July 21st, 2014 Our Rating: :: A BEAUTIFUL MINDUniversal App - Designed for iPhone and iPad A Life Worth Dying For is a fascinating portrait of a serious subject.   | Read more »
Zombie Puzzle Panic Review
Zombie Puzzle Panic Review By Jordan Minor on July 21st, 2014 Our Rating: :: THE MATCHING DEADUniversal App - Designed for iPhone and iPad Zombie Puzzle Panic puts some pretty neat undead twists on Match-3 puzzling.   | Read more »

Price Scanner via MacPrices.net

Twelve South HiRise For MacBook – Height-Adju...
If you use your MacBook as a workhorse desktop substitute, as many of us do, a laptop stand combined with an external keyboard and pointing device are pretty much obligatory if you want to avoid... Read more
Why The Mac Was Not Included In The Apple/IBM...
TUAW’s Yoni Heisler cites Fredrick Paul of Network World whoi blogged last week that the Mac’s conspicuous absence from Apple and IBM’s landmark partnership agreement represents a huge squandered... Read more
Save $100 on 13-inch Retina MacBook Pros, plu...
Adorama has 13″ Retina MacBook Pros on sale for $100 off MSRP. Shipping is free, and Adorama charges sales tax in NY & NJ only: - 13″ 2.4GHz/128GB MacBook Pro with Retina Display: $1199 - 13″ 2.... Read more
Blurr it 2.3 for iOS – Quickly Blurs Selected...
Hyderabad, India based TouchLabs has announced a new update of Blurr it 2.3, their photography app for iOS users. Blurr it allows you to blur part of the image to hide potentially sensitive or... Read more
MacBook Airs on sale for $100 off MSRP, start...
Best Buy has the new 2014 MacBook Airs on sale for up to $100 off MSRP on their online store. Choose free home shipping or free local store pickup (if available). Prices valid for online orders only... Read more
Amazon Announces Kindle Unlimited: Unlimited...
Amazon.com has introduced Kindle Unlimited — a new subscription service which allows customers to freely read as much as they want from over 600,000 Kindle books, and listen as much as they want to... Read more
New Linksys Wireless Range Extenders Boost Wi...
Linksys has announced its new lineup of Linksys Wi-Fi Range Extenders. Consumers often experience a weak wireless signal in some parts of their house or apartment caused by blocking elements such as... Read more
MacBook Airs available starting at $719
The Apple Store has Apple Certified Refurbished 2013 & 2012 MacBook Airs in stock today starting at $719. An Apple one-year warranty is included with each MacBook, and shipping is free: 2013... Read more
Get the best deals on iPad minis with Apple r...
The Apple Store has Certified Refurbished 2nd generation iPad minis with Retina Displays available for up to $130 off the cost of new models, starting at $339. Apple’s one-year warranty is included... Read more
Best Buy’s College Student Deals: $100 off Ma...
Take an additional $100 off all MacBooks and iMacs, $50 off iPad Airs and iPad minis, at Best Buy Online with their College Students Deals Savings, valid through July 25th. Anyone with a valid .EDU... Read more

Jobs Board

*Apple* Computer Technician - Fairfield Coun...
Company DescriptionWe are an Apple Authorized Sales and Service Provider. We have been selling and servicing Apple computers in the Fairfield County area for over 20 Read more
*Apple* Computer Technician - Fairfield Coun...
Company DescriptionWe are an Apple Authorized Sales and Service Provider. We have been selling and servicing Apple computers in the Fairfield County area for over 20 Read more
Mac Expert - *Apple* Online Store Mexico -...
…MUST be fluent in English and Spanish to be considered for this position At Apple , we believe that hard work, a fun environment, creativity and innovation fuel the Read more
*Apple* Computer Technician - Fairfield Coun...
Company DescriptionWe are an Apple Authorized Sales and Service Provider. We have been selling and servicing Apple computers in the Fairfield County area for over 20 Read more
Mac Expert - *Apple* Online Store - Apple (...
**Job Summary** At Apple , we believe that hard work, a fun environment, creativity and innovation fuel the ultimate customer experience. We believe each customer Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.