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.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Google Chrome 53.0.2785.143 - Modern and...
Google Chrome is a Web browser by Google, created to be a modern platform for Web pages and applications. It utilizes very fast loading of Web pages and has a V8 engine, which is a custom built... Read more
Chromium 53.0.2785.143 - 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. Version 53.0.2785.143: [Security Fix] High CVE-2016-... Read more
QuickBooks 2015 16.1.7.1524 R8 - Financi...
Save 20% on QuickBooks Pro for Mac today through this special discount link QuickBooks 2015 helps you manage your business easily and efficiently. Organize your finances all in one place, track... Read more
Sierra Cache Cleaner 11.0.1 - Clear cach...
Sierra Cache Cleaner is an award-winning general purpose tool for macOS X. SCC makes system maintenance simple with an easy point-and-click interface to many macOS X functions. Novice and expert... Read more
Default Folder X 5.0.7 - 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
Safari Technology Preview 10.1 - The new...
Safari Technology Preview contains the most recent additions and improvements to WebKit and the latest advances in Safari web technologies. And once installed, you will receive notifications of... Read more
Tweetbot 2.4.4 - Popular Twitter client.
Tweetbot is a full-featured OS X Twitter client with a lot of personality. Whether it's the meticulously-crafted interface, sounds and animation, or features like multiple timelines and column views... Read more
Google Earth 7.1.7.2602 - View and contr...
Google Earth gives you a wealth of imagery and geographic information. Explore destinations like Maui and Paris, or browse content from Wikipedia, National Geographic, and more. Google Earth combines... Read more
Things 2.8.8 - Elegant personal task man...
Things is a task management solution that helps to organize your tasks in an elegant and intuitive way. Things combines powerful features with simplicity through the use of tags and its intelligent... Read more
Firefox 49.0.1 - Fast, safe Web browser.
Firefox offers a fast, safe Web browsing experience. Browse quickly, securely, and effortlessly. With its industry-leading features, Firefox is the choice of Web development professionals and casual... Read more

Cybird’s latest release - BFB Champions...
Launched in the UK in early September, BFB Champions’ newest update is loaded with great new features, and looks set to outshine the original version by taking it out of soft launch and giving it a new lease of life. | Read more »
3 apps to boost your focus
As someone who works from home, my workspace is a minefield of distraction. Cats, tasty snacks, the wind blowing past my window, that cleaning that I suddenly can’t put off any longer. If I let distraction takes its course, I find that soon half... | Read more »
4 games like Burly Men at Sea to inspire...
Burly Men at Sea is out today and it looks a treat. It tells the tale of three Scandinavian fishermen who leave the humdrum of their daily lives to go exploring. It’s a beautiful folksy story that unfurls as you interact with the environment... | Read more »
3 reasons you need to play Kingdom: New...
Developed by a tag team of indie developers - Thomas "Noio" van den Berg and Marco "Licorice" Bancale - Kingdom is a vibrant medieval fantasy adventure that casts players as a king or queen who must expand their empire by exploring the vasts lands... | Read more »
JoyCity have launched a brand new King o...
Great news for all of you Game of Dice fans out there - JoyCity have just released a brand new limited edition pack with a really cool twist. The premise of Game of Dice is fairly straightforward, asking you to roll dice to navigate your way around... | Read more »
Burly Men at Sea (Games)
Burly Men at Sea 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: Burly Men at Sea is a folktale about a trio of large, bearded fishermen who step away from the ordinary to seek adventure. | Read more »
3 tips for catching the gnarliest waves...
Like a wave breaking on the shore, Tidal Rider swept its way onto the App Store charts this week settling firmly in the top 10. It’s a one-touch high score-chaser in which you pull surfing stunts while dodging seagulls and collecting coins. The... | Read more »
The beginner's guide to destroying...
Age of Heroes: Conquest is 5th Planet Games’ all new turn-based multiplayer RPG, full of fantasy exploration, guild building, and treasure hunting. It’s pretty user-friendly as far as these games go, but when you really get down to it, you’ll find... | Read more »
Infinite Tanks (Games)
Infinite Tanks 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: | Read more »
Agatha Christie - The ABC Murders (FULL)...
Agatha Christie - The ABC Murders (FULL) 1.0 Device: iOS Universal Category: Games Price: $6.99, Version: 1.0 (iTunes) Description: Agatha Christie: The ABC Murders Your weapon is your knowledge. Your wits will be put to the ultimate... | Read more »

Price Scanner via MacPrices.net

Apple refurbished 2015 13-inch MacBook Airs a...
Apple has Certified Refurbished 2015 13″ MacBook Airs available starting at $759. An Apple one-year warranty is included with each MacBook, and shipping is free: - 2015 13″ 1.6GHz/4GB/128GB MacBook... Read more
MacBook Airs on sale for up to $100 off MSRP
B&H Photo has 13″ and 11″ MacBook Airs on sale for up to $100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 11″ 1.6GHz/128GB MacBook Air: $799 $100 MSRP - 11″ 1.6GHz/256GB... Read more
Apple refurbished 12-inch 128GB iPad Pros ava...
Apple has Certified Refurbished 12″ Apple iPad Pros available for up to $160 off the cost of new iPads. An Apple one-year warranty is included with each model, and shipping is free: - 32GB 12″ iPad... Read more
Phone2Action Unveils New Voter Turnout Techno...
Phone2Action, a leading digital advocacy platform, today launched its Tech to Vote Civic Action Center digital advocacy and communications platform on National Voter Registration Day September 27.... Read more
Apple & Deloitte Team Up to Help Business...
Apple and international professional services firm Deloitte have announced a partnership to help companies quickly and easily transform their workflow dynamics by maximizing the power, ease-of-use,... Read more
Chop Commute – See Traffic and Drive Times on...
Shrewsbury, Massachusetts based Indie developer, InchWest has released Chop Commute 1.61, a Mac app that takes the guesswork out of daily commute by showing real-time traffic and drive times right on... Read more
12-inch 32GB WiFi iPad Pros on sale for $50 o...
B&H Photo has 12″ 32GB WiFi Apple iPad Pros on sale for $50 off MSRP, each including free shipping. B&H charges sales tax in NY only: - 12″ Space Gray 32GB WiFi iPad Pro: $749 $50 off MSRP -... Read more
Recent price drops on refurbished iPad minis...
Apple recently dropped prices on several Certified Refurbished iPad mini 4s and 2s as well as iPad Air 2s. An Apple one-year warranty is included with each model, and shipping is free: - 16GB iPad... Read more
Apple refurbished Mac minis available startin...
Apple has Certified Refurbished Mac minis available starting at $419. Apple’s one-year warranty is included with each mini, and shipping is free: - 1.4GHz Mac mini: $419 $80 off MSRP - 2.6GHz Mac... Read more
13-inch 2.5GHz MacBook Pro available for $928...
Overstock has the 13″ 2.5GHz MacBook Pro available for $927.99 including free shipping. Their price is $171 off MSRP. 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
Restaurant Manager (Neighborhood Captain) - A...
…in every aspect of daily operation. WHY YOU'LL LIKE IT: You'll be the Big Apple . You'll solve problems. You'll get to show your ability to handle the stress and Read more
*Apple* Wireless Lead - T-ROC - The Retail O...
…wealth of knowledge in wireless sales and activations to the Beautiful and NEW APPLE Experience store within MACYS.. THIS role, APPLE Wireless Lead, isbrandnewas Read more
Lead *Apple* Advocate - T-ROC - The Retail...
…Company, is proud of its unprecedented relationship with our partner and client, APPLE ,in bringing amazing" APPLE ADVOCATES"to "non" Apple store locations. Read more
*Apple* Advocate - T-ROC - The Retail Outsou...
…Company, is proud of its unprecedented relationship with our partner and client, APPLE ,in bringing amazing" APPLE ADVOCATES"to "non" Apple store locations. Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.