TweetFollow Us on Twitter

Dynamic Localization
Volume Number:11
Issue Number:3
Column Tag:Think Globally, Act Locally

Dynamic Localization

Prepare your software for going global

By Brian Sutter, MindVision Software

Note: Source code files accompanying article are located on MacTech CD-ROM or source code disks.

Recently, while working on our installer program, one of our developers needed a feature to dynamically localize the installer to the language in use on the destination computer. That is, when the installer runs, make sure it uses the language that the user expects to see. After throwing around ideas for a couple of days, we agreed on a way to do it (sometimes you just have to let the boss win the arguments just so you don’t ruin your chance of getting a pay raise).

Breaking Things Down

While thinking about how to do dynamic localization, it occurred to us there are two groups of resources that our application needs to use. One group of resources don’t need to be localized. For example, CODE, ICN#, CURS, LDEF, etc. These are the resources users will never see, or are the same in every language. The other group of resources need to be localized for different languages. For example, STR#, DITL, STR , vers, etc These are resources the user may read at one time or another.

Now, when we build an installation kit, we typically put everything into a single file which we call an installer. A good part of the challenge we faced was how to keep everything in a single file while still allowing ourselves to keep all the localizing material in resources like everyone is used to. In this article, I’ll go through the specifics of how we dealt with this challenge in our application, and provide code samples you might find useful for doing similar things.

We broke our installer down into two parts. The first part we call the “Base Installer”, which includes the resources that don’t need to be localized. The second part includes resources that need to be localized for each language the installer needs to support. For example, we need different DITL and STR# resources for each different language we want to support. For these resources we have files called, “English Installer” , “French Installer”, “German Installer”, etc. We call these our “Language Resource Files”.

We have all these different files of resources, and we want to combine them all into a single file (so users see only one file, not a bunch of files). For example, we have STR# with ID of 1000 for English, French, German, Italian, etc. How can our installer have resources with these same types and IDs in it? The answer is, don’t. When we assemble our application, we open each language resource file for block reading, and read the entire resource fork into a handle. We write the handle into our own resource type of ‘Lirs’, and give it an ID based on the language. Here’s how we did it.

OSErr ResFile2Resource(Str32 *fileName, short vRefNum, 
      long dirID, short languageID);
{
 OSErr  err;
 short  refNum;
 long     eof;
 Handle   tHandle;

    // Open the resource fork of the file for BLOCK reads
 if (err = HOpenRF(vRefNum,dirID,fileName,fsRdPerm,&refNum)) goto exit:

    // Get the size of the resource fork
 if (err = GetEOF(refNum, &eof)) goto exitErr;

    // Create a handle to hold the entire resource fork
 tHandle = NewHandle(eof);
 if (err = MemError()) goto exitErr;

    // Read the entire resource fork into our handle
 if (err = FSRead(refNum, &eof, *tHandle)) goto exitErr;
 
    // The current resource file is our installer application
    // Add this entire resource fork to our installer application
 AddResource(tHandle,'Lirs',languageID,"\p");
 if (err = ResError()) goto exitErr;

 WriteResource(tHandle);
 err = ResError();

    // Release memory occupied by this resource
 ReleaseResource(tHandle);
 tHandle = nil;

exitErr:
 FSClose(refNum);
 if (tHandle) DisposeHandle(tHandle);

exit:
 return err;
}

We call ResFile2Resource for every file containing localized resources.

• filename is the name of the resource file on hard drive.

• vRefNum is the volume reference number where the file resides.

• dirID is the directory id on the specified volume where the file resides.

• languageID is the resource ID of the language file. We use the same defines as Apple’s Languages.h file for the resource IDs for different languages, but we add 1000 to those numbers because Apple says don’t use resource ID’s less than 128. So for the English resources the ID = 1000, French = 1001, German = 1002, etc.

Once we’ve called ResFile2Resource for each file of localized resources, each is a resource in our installer application.

We’ve got an additional twist for our application. An installer may need to create a number of files. Each of these files may need a localized name. The next thing we do is add lists of localized file names (supplied by the developer) to be installed, one for each language. We use the same ID scheme as the above language resources, but use the ‘Flnm’ (filename) resource type. The developer stores these in another resource file. When the installer is built, we merge these ‘Flnm’ resources into the installer application.

After these language and filename resources are added to the installer, we add the rest of the stuff our application needs to carry around (all the stuff that’s going to get installed).

Language Magic

When our application is launched, we do a little magic to find out what language is being used on the user’s Mac.

// Assume English in case something fails
gLanguageCode  = 0;

// The following chunk of code was graciously provided to me by a engineer at 
// Adobe Systems, THANKS!
// Make sure Script Manager calls are available
if (TrapAvailable(_ScriptUtil)) {

    // Get the ID of the current system font and use it to find out
    // the script code
 scriptCode = Font2Script(GetSysFont());

    // use the script code to find out the language code for that script
   gLanguageCode = GetScript(scriptCode,smScriptLang);
 
    // “GetScript(scriptCode, smScriptLang)” doesn’t return the
    // correct language code on KanjiTalk 6.0.7-J, if it returns zero and if
    // the current script is not Roman, we directly get the language code
    // from the itlb resource.
 if (gLanguageCode == 0 && scriptCode != 0) {                  
 if (tHandle = GetResource('itlb', scriptCode)) {
 gLanguageCode = (*(ItlbRecord **)tHandle)->itlbLang;
 }
 }

}

// Add 1000 to get the resource ID of localized resources
gLanguageCode += 1000;

At this point in the process, the current resource file is our installer application, and it contains all the localized resources and filenames the installer needs to localize itself for the current language.

Localizing File Names

Now that we know which language resource ID to search for (gLanguageCode), we’ll call Get1Resource to find any localized filenames to install. If it’s found, we copy the localized names to the list of file names to install. If not, we’ll just leave the file names alone.

// See if there are any localized filenames
tFilesHdl = Get1Resource('Flnm', gLanguageCode);
if (tFilesHdl) {
    .. Our installer contains a handle of filenames, so we need to call a routine to                      
    .. replace the original names with these localized filenames.
 ReleaseResource(tFIlesHdl);
}

Localizing Installer Resources

Now that we have localized file names, let’s see if there are localized resources for the installer. Remember that these resources contain entire resource forks of the localized language files.

// See if there are any localized resources.
tHandle = Get1Resource('Lirs',gLanuageCode);
if (tHandle) {
 DetachResource(tHandle);

    // Store the size of the resource
 count = GetHandleSize(tHandle);

    // Call routine to find a volume that is large enough to create a file the            
    // size of the resource.
 vRefNum = FindValidVolume(count);

 if  (vRefNum) {
    // Come up with a unique filename
 NumToString(TickCount(),tFileName);

    // Create file to the root directory (dirID = 2)
 err = HCreateResFile(vRefNum, 2, tFileName);
 if (err) goto doDispose;

    // Open the Resource fork for block writing
 err = HOpenRF(vRefNum, 2, tFileName, &refNum);
 if (err) goto doDispose;

    // Write out resource to create the file’s resource fork
 err = FSWrite(refNum, &count,*tHandle);

 FSClose(refNum);
 if (err) goto doDispose;

    // Open the resource file we just created
 gExtraResRefNum = HOpenResFile(vRefNum, 2, tFileName, 
 fsRdPerm);
 }

doDispose:
 DisposeHandle(tHandle);
}

If we successfully create and open this resource file, it will be the current resource file, and it will be searched first for dialogs, strings, and other resources. If the Resource Manager isn’t able to find it there, it will automatically search in the installer application’s resources to find what it needs.

One thing not discussed here is how to make the temporary resource file invisible. It’s a good thing to do so the user won’t see a weird file name appear on their volume while the install is taking place.

resNotFound (0xFF40)

What happens when the language in use on the destination computer isn’t supported by the installer? The installer could bring up a dialog alerting the user to this fact, and allow them to choose the language to install, but what language do you use for this dialog? We chose to sidestep the problem by running with a default language if the system language is not supported by the installer.

Clean Up After Yourself

Before quitting our application, we need to clean up a little bit. We need to close and delete the file of localized resources.

// Cleanup
if (gExtraResRefNum != -1) {
    // Since we don’t store this filename anywhere, we call PBGetFCBInfo to get it
 FCBPBRec pb;
 OSErr  err;
 Str32  tStr;
 
 pb.ioFCBIndx = 0; // We’re not indexing
 pb.ioVRefNum = 0; // 0 = All open files
 pb.ioRefNum = gExtraResRefNum;  // Refnum of our resource file
 pb.ioNamePtr = tStr;// Storage place for the name
 err = PBGetFCBInfo(&pb, false);
 if (!err) {
    // Close the Resource File before trying to delete it
 CloseResFile(gExtraResRefNum);

    // Delete the Resource File now that we have the vRefNum, directory ID,
    // and the Filename
 err = HDelete(pb.ioFCBVRefNum, pb.ioFCBParID, tStr);
 }
}

Other Localization Tips

Other localization items to keep in mind when writing your application:

• Double byte languages. Make sure any strings you allocate in your applications are long enough to support double byte languages.

• Make sure all strings are in resources. Don’t hard code any text within your application. This will save you from having to recompile multiple versions of your application, one for each language. It’s a lot easier to add different resources to one set of compiled code than it is to maintain multiple sources.

• Don’t split your strings up and recombine them later. You might be surprised by what happens when different language grammar rules are applied.

• Really, don’t embed any strings, not even single character strings like quotes. Some languages use multiple characters for quotation, so patching the application gets terribly unpleasant.

• Don’t specify a font by name when you really mean system font or application font.

Tipping is Not a City in China

Another tip for copying the resource fork of a file: use block read and write operations, don’t use the resource manager. You might be surprised how many programs copy or build applications by copying a resource at a time. This is way too slow! Even if you don’t need all of the resources, in most cases it’s better to copy the entire resource fork using block reads and writes and then delete the resources which aren’t needed.

// Copying the Resource Fork from one file to another 
HOpenRF(sourceFile &sourceRefNum);
HOpenRF(destFile &destRefNum);
GetEOF(sourceRefNum,&sourceSize);
CopyBytes(sourceRefNum,destRefNum,sourceSize);
FSClose(sourceRefNum);
FSClose(destRefNum);

// If you need to, then delete some resources 
SetResLoad(false);
destRefNum = HOpenResFile(destFile );
Get1Resource();
RmveResource();
CloseResFile(destRefNum);
SetResLoad(true);

Notice the SetResLoad(false). You don’t have to load in an entire resource to be able to delete it. Also, call SetResLoad(false) before opening the resource file to prevent “preload” resources from loading. It saves time and space. Just be sure to set it back to true when you’re done.

File This Tip Away

For examples on how to do just about any file operation, look for “MoreFiles” on the Developer CDs from Apple [one random place on the Internet that we found it was at:

ftp://src.doc.ic.ac.uk/computing/systems/mac/Mac-Technical/sc/morefiles,

and there’s always Apple’s site:

ftp://ftp.info.apple.com/Apple.Support.Area/Developer_Services - ed stb].

Picture If You Will

Now it’s time to give you a visual example of the difference you might see. Here’s an example of an installer as presented in English.

English System

Here’s the installer localized to German and Kanji. I don’t speak German or Japanese, so I wasn’t able to localize the “Install your favorite ” text in the window. I just changed the text to show you that it does show different text for German and Kanji systems.

German System

Kanji System

Here’s a screen dump of our app in ResEdit. It contains all the normal resources as well as our two special resources:

‘Flnm’ - Resource containing the localized file names for German and Kanji.

‘Lirs’ - Resource containing the localized resources for the dialogs, strings, etc. for German and Kanji.

There is also a TEXT resource containing the text to appear in the installer window - one for each language (English, German, and Kanji.)

Notice there isn’t a separate English resource for ‘Flmn’ and ‘Lirs’. This is because English is the default language and those resources are represented by the normal DLOG, STR#, MENU resources in the Segment.1 file.

Well, now you’ve seen how we go about adapting to the current situation. I hope this gives you some ideas about how you might pack more punch into your software.

 
AAPL
$517.96
Apple Inc.
-3.72
MSFT
$39.75
Microsoft Corpora
+0.57
GOOG
$536.44
Google Inc.
+3.92

MacTech Search:
Community Search:

Software Updates via MacUpdate

Starcraft II: Wings of Liberty 1.1.1.180...
Download the patch by launching the Starcraft II game and downloading it through the Battle.net connection within the app. Starcraft II: Wings of Liberty is a strategy game played in real-time. You... Read more
Sibelius 7.5.0 - Music notation solution...
Sibelius is the world's best-selling music notation software for Mac. It is as intuitive to use as a pen, yet so powerful that it does most things in less than the blink of an eye. The demo includes... Read more
Typinator 5.9 - Speedy and reliable text...
Typinator turbo-charges your typing productivity. Type a little. Typinator does the rest. We've all faced projects that require repetitive typing tasks. With Typinator, you can store commonly used... Read more
MYStuff Pro 2.0.16 - Create inventories...
MYStuff Pro is the most flexible way to create detail-rich inventories for your home or small business. Add items to MYStuff by dragging and dropping existing information, uploading new images, or... Read more
TurboTax 2013.r17.002 - Manage your 2013...
TurboTax guides you through your tax return step by step, does all the calculations, and checks your return for errors and overlooked deductions. It lets you file your return electronically to get... Read more
TrailRunner 3.8.769 - Route planning for...
Note: While the software is classified as freeware, it is actually donationware. Please consider making a donation to help support development. TrailRunner is the perfect companion for runners,... Read more
Flavours 1.1.10 - Create and apply theme...
Flavours is a Mac application that allow users to create, apply and share beautifully designed themes. Classy Give your Mac a gorgeous new look by applying delicious themes! Easy Unleash your... Read more
Spotify 0.9.8.296. - Stream music, creat...
Spotify is a streaming music service that gives you on-demand access to millions of songs. Whether you like driving rock, silky R&B, or grandiose classical music, Spotify's massive catalogue... Read more
SlingPlayer Plugin 3.3.20.475 - Browser...
SlingPlayer is the screen interface software that works hand-in-hand with the hardware inside the Slingbox to make your TV viewing experience just like that at home. It features an array of... Read more
S.M.A.R.T. for USB and FireWire Drives 0...
S.M.A.R.T. for USB and FireWire Drives is a kernel driver for OS X external usb or firewire drives. It extends the standard driver behaviour by providing access to drive smart data. The interface to... Read more

Latest Forum Discussions

See All

148Apps Live on Twitch: Pivvot’s Looper...
On our latest Twitch stream, we’ll be playing a pair of minimalist arcade games, one that just got a big content update in Pivvot, and another that was inspired by it in 15 Coins. Whitaker Trebella, creator of Pivvot, will discuss the new modes... | Read more »
Word Cubes Review
Word Cubes Review By Jordan Minor on April 15th, 2014 Our Rating: :: SQUARESVILLEUniversal App - Designed for iPhone and iPad Word Cubes is fine, but it is barely any different from any other word game.   | Read more »
PAX East 2014 – Desert Fox: The Battle o...
PAX East 2014 – Desert Fox: The Battle of El Alamein is Coming to iOS Soon Posted by Rob Rich on April 15th, 2014 [ permalink ] Shenandoah Studio has become one of the go-to developers for war games on iOS, with | Read more »
Tank of Tanks Review
Tank of Tanks Review By Carter Dotson on April 15th, 2014 Our Rating: :: TANKS A LOT!iPad Only App - Designed for the iPad This multiplayer game played on a single iPad is simple, chaotic fun.   | Read more »
PAX East 2014 – Dungeon of the Endless J...
PAX East 2014 – Dungeon of the Endless Just Might Have a Shot at an iPad Release Posted by Rob Rich on April 15th, 2014 [ permalink ] I think it’s fair to say that | Read more »
SideSwype Review
SideSwype Review By Carter Dotson on April 15th, 2014 Our Rating: :: ON YOUR SIDEUniversal App - Designed for iPhone and iPad SideSwype is a puzzler that takes inspiration from Threes, but becomes its own incredibly fun game.   | Read more »
PAX East 2014 – Bigfoot Hunter Invites P...
PAX East 2014 – Bigfoot Hunter Invites Players on a Wild and Wooly Photo Safari Posted by Rob Rich on April 15th, 2014 [ permalink ] Yeti. Sasquatch. Wendigo. | Read more »
Dungeon Quest Review
Dungeon Quest Review By Cata Modorcea on April 15th, 2014 Our Rating: :: NO STORY, BUT GOOD FUNUniversal App - Designed for iPhone and iPad Dungeon Quest does a lot of things right, but ultimately forgets about one of the core... | Read more »
Tempo AI and Speek Join Forces to “Kill...
Tempo AI and Speek Join Forces to “Kill the Conference Call PIN” Posted by Rob Rich on April 15th, 2014 [ permalink ] Today Tempo AI, makers of Tempo Smart Calendar, and | Read more »
Fighting Fantasy: Starship Traveller Rev...
Fighting Fantasy: Starship Traveller Review By Jennifer Allen on April 15th, 2014 Our Rating: :: A SIGNIFICANT VOYAGEUniversal App - Designed for iPhone and iPad Continuing the release of Fighting Fantasy titles, Starship Traveller... | Read more »

Price Scanner via MacPrices.net

Save $50 on Mac mini Server
B&H Photo has the 2012 Mac mini Server on sale for $949 including free shipping plus NY sales tax only. Their price is $50 off MSRP. Read more
PhatWare’s “Ultimate Writing App For iOS” Ren...
PhatWare Corp. has announced it has renamed its new WritePro word processing app for iPhone and iPad: WritePad Pro. The decision to change the app’s name to leverages the strong brand awareness and... Read more
Full Resolution Photo Editor Tint Mint 1.0 Re...
California based independent developer, Jeffrey Sun, creator of the iOS app Modern Editor, has released Tint Mint, a new photography app for editing enthusiasts. The app costs a dollar, and it packs... Read more
16GB iPad mini (Apple refurbished) available...
The Apple Store has refurbished 1st generation 16GB iPad minis available for $249 including free shipping. Both black and white models are available. Read more
Save $120 on the 27-inch 3.2GHz Haswell iMac
B&H Photo has the 27″ 3.2GHz iMac on sale for $1679.99 including free shipping plus NY sales tax only. Their price is about $120 off MSRP. Read more
Using a Mac Doesn’t Eliminate The Heartbleed...
Low End Mac’s Dan Knight notes that any time you visit a website with an https: prefix or see that secure lock icon on your browser, some type of security software is busy trying to protect your data... Read more
AirPrint Basics Tutorial Posted
A new Apple Knowledge Base article helps get you started using AirPrint, the Apple protocol that enables instant printing from iPad, iPhone, iPod touch, and Mac without the need to install drivers or... Read more
Speed Tips For Running LibreOffice On The Mac
LibreOffice is my favorite of several free, open-source application suites, and the one I have configured on my Mac as my default app for Word documents that one frequently has to deal with. It also... Read more
Snag a 15-inch Retina MacBook Pro for $115 of...
B&H Photo has 2013 15″ Retina MacBook Pros on sale for up to $115 off MSRP for a limited time. Shipping is free, and B&H charges NY sales tax only: - 15″ 2.3GHz Retina MacBook Pro: $2489.99... Read more
MacBook Airs on sale for $50 to $100 off MSRP
Several resellers are offering $50-$100 discounts on 11″ and 13″ MacBook Airs today, including Amazon, Best Buy, B&H, and others. See the breakdown of deals on our MacBook Air Price Tracker,... Read more

Jobs Board

*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
*Apple* Retail - Market Leader - Cincinnati...
…challenges of developing individuals, building teams, and affecting growth across Apple Stores. You demonstrate successful leadership ability - focusing on excellence Read more
*Apple* Retail - Manager - SoHo - Apple (Uni...
Job SummaryKeeping an Apple Store thriving requires a diverse set of leadership skills, and as a Manager, you're a master of them all. In the store's fast-paced, dynamic Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** Every day, business customers come to the Apple Store to discover what powerful, easy-to-use Apple products can do for them. As a Business Leader, Read more
Position Opening at *Apple* - Apple (United...
…challenges of developing individuals, building teams, and affecting growth across Apple Stores. You demonstrate successful leadership ability - focusing on excellence Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.