TweetFollow Us on Twitter

Feb 98 Factory Floor

Volume Number: 14 (1998)
Issue Number: 2
Column Tag: From The Factory Floor

CodeWarrior Latitude: Porting Custom Definition Functions and More

by David Hempling, Bob McBeth, and Dave Mark, ©1998 by Metrowerks, Inc., all rights reserved.

This month, we'll continue our ongoing look at CodeWarrior Latitude. We'll start off with a look at the issues that crop up when porting custom definition functions from the Mac to Unix systems such as Rhapsody.

CodeWarrior Latitude is a porting library that greatly simplifies the process of porting Mac OS applications to Rhapsody. Latitude is an implementation of the Macintosh System 7 application programming interfaces (APIs) that allows source code for a Macintosh application to be compiled with little modification on a Rhapsody platform, resulting in a native Rhapsody application. Latitude maps the Mac API requests to native Unix system calls. An application built with Latitude attains the look and feel of the new native platform.

Custom Definition Functions

Customized definition functions provided to the Mac Toolbox API as function pointers require no changes for porting from the Mac OS platform using CodeWarrior Latitude. The function pointer you provide to ModalDialog(), for example, does not need to be changed. However, you may want to add functionality to your modal definition function to handle events that weren't expected on the Mac.

On platforms supported by Latitude, modal dialog windows are moveable at all times. If the user moves a modal dialog window, the mouseDown inDrag event will go undetected in your own modal definition function ported from the Mac since on the Mac your app didn't have to deal with this possibility. Therefore, you will need to add a case for the mouseDown inDrag event, which calls DragWindow() to handle that event's processing. You will know if you neglected to handle the mouseDown inDrag event if your dialog window contains a popup menu. If DragWindow() has not been called in a moved window and the user clicks on the popup menu button, the menu will appear on screen were the popup button was on the screen before the window was moved. The DragWindow() call updates the window's port bounds which are used by PopUpMenuSelect() to display the popup menu.

Because this new possibility of unforeseen events arises on non Mac OS platforms, your own application's windows may become obscured or uncovered at times when they couldn't have been on the Mac. For example, say the user causes a system dialog to appear, such as one of Latitude's "Apple" menu desktop services like Copy Files or other system level alerts which are movable, and then the user moves one of these alerts causing a portion of your own app's windows to require updating. You now have a blank area of your application windows that you want to refresh. But, you don't have control since Latitude is servicing some other request.

Latitude provides a means for applications to register a special modal filter function whose job is to receive update events for all application windows when Latitude is in control of a presently displayed modal dialog. The filter function prototype is simply:

void my_app_modal_update_hook(EventRecord *theEvent)

You provide this function at lg_latitude_init() time as one of the field settings in the LG_APP_INFO_BLOCK:

void  main( long argc, char **argv )
{
#ifdef _LATITUDE_
    LG_APP_INFO_BLOCK lblock;

    lblock.flags =   LG_APP_INFO_SIGNATURE |
                           LG_APP_INFO_CLASSNAME |
                           LG_APP_INFO_MODAL_EVENT_HOOK;
    lblock.signature = QUADCONST('C','T','T','R');
    lblock.classname = "Latitude";
    lblock.modal_event_hook = my_app_modal_update_hook;
    lg_latitude_init(argc,argv, &lblock);
#endif

Another type of custom definition function are those that define custom controls, menus, lists, and windows. Mac applications provide these functions to the Mac toolbox in one of two ways. They either compile these functions separately into special code resources -- CDEF for controls, MDEF for menus, LDEF for lists, and WDEF for windows -- or they compile these functions with their application and patch special CDEF, MDEF, LDEF, or WDEF resources that contain assembly instructions. These patch resources typically contain twelve byte structures defined like this:

typedef struct {
  short jmp_inst;
  ProcPtr long def_func;
} DEF_STRUCT;

And are set up at init time like this:

DEF_STRUCT **my_cdef;
extern long my_cdef(short varCode, ControlHandle theControl,
        short message, long param);

my_cdef = (DEF_STRUCT **) GetResoure('CDEF', 128);

(**my_cdef).jmp_inst = 0x4EF9; 
                /* 680x0 for JMP (i.e. Jump) */
(**my_cdef).def_func = (ProcPtr) my_cdef;

There are two problems with this practice that come up for porting. The first problem is the 680x0 assembly code in the handle. Since CodeWarrior Latitude contains no machine code interpreter, the 680x0 JMP instruction is meaningless. The second problem is a little less obvious and far more hazardous. Since we're probably porting to a RISC based platform where long words are aligned on long word boundaries, the size of the DEF_STRUCT structure above is not 12 bytes, it's 16! (The compiler will insert 4 bytes of padding after the jmp_inst member so that def_func falls on a long word boundary.) The size of the CDEF 128 handle is 12 bytes. The assignment of the structure's def_func member writes passed the end of the 12 byte handle, thus corrupting memory.

CodeWarrior Latitude provides a means to register your definition functions so as to avoid these types of problems:

Handle lg_latitude_code_resource(ResType type, short id, 
          StringPtr name, ProcPtr defproc);

Latitude creates a special handle and places it in the ROM Resource Map (ROMMapHndl). When CW Latitude's toolbox requires a CDEF, LDEF, MDEF, or WDEF, it searches the ROM Map for the registered code resource first.

If your app needs to get at the handle, you can use the one returned by lg_latitude_code_resource(), or if that one isn't readily available, you can use regular Resource Manager calls to retrieve it. The standard way to get a ROM map resource is:

  short cur_map;
  Handle h;

  cur_map = CurResFile();
  UseResFile(1);
  h = Get1Resource(QUADCONST('C','D','E','F'), 128);
  UseResFile(cur_map);

To get the function pointer out of a CW Latitude created code resource handle, use the call

ProcPtr lg_latitude_code_address(Handle h);

CDEFs, LDEFs and MDEFs for popup menus are completely handled by CW Latitude. MDEFs for menus off of the menubar need to be handled differently since CW Latitude is not drawing those menus itself but rather sending the appropriate instructions to the native system to display the menus.

If your app has a custom MDEF for menubar menus solely for the purpose of displaying multiple key combination menu item key equivalents (such as shift-control-option-F), then you can use a special MDEF provided by CW Latitude, called lg_latitude_custom_mdef, specifically designed for such menus.

WDEFs are also a little tricky. Again, CodeWarrior Latitude is not drawing the window itself, so you have no way of drawing a window's adornments under Latitude. However, by using some of Latitude's special window functions like lg_latitude_next_window (discussed in last month's article) and lg_latitude_register_window, you can provide Latitude with a description of the functionality of your WDEF, including floating attributes, and let Latitude handle communicating those details to the native system.

Games with A5

Macintosh applications have all kinds of games they play with the A5 register to save and restore contexts. Sometimes this is done when the application is in the background but wants to communicate something to the user. Since the native Unix systems supported by CodeWarrior Latitude do their own context switching, your application doesn't have to provide its own context management. If your application is awoken from suspension, you can be assured that the system will restore the proper stack and processor register context before executing more of your application's code.

Some applications use A5 as a sort of stack jump maneuver to recover from an error. The equivalent in Unix systems is the setjmp and longjmp pair of functions. You use setjmp to save the stack environment in a given buffer for later use by longjmp. A call to longjmp zaps execution and context back to the place were the setjmp call was made.

Games with the Memory Manager

Some Macintosh applications play interesting games with the Mac Memory Manager. They try to gobble up all of the memory available, tickling a grow zone proc in the process, to determine how much memory is really available. Others allocate a large block of memory and proceed to parse off parts of it themselves, acting as their own Memory Manager. CodeWarrior Latitude's Memory Manager provides handles and pointers the way Mac applications expect, even simulating a System Zone and an Application Zone. However there are no large, specially zoned pools of memory that Latitude allocates from. Each handle and pointer allocation done by CW Latitude's Memory Manager is mapped directly to Unix system malloc() and realloc() calls. Since we're operating in true virtual memory systems, these common games applications play with the Memory Manager are completely meaningless. If your app is using these tricks, you should disable them and just let Latitude's Memory Manager do its thing.

Precompiled Headers

On Latitude supported systems where the available compilers do not support precompiled headers, you will have to explicitly add inclusion of your desired include files to your source code. It will probably be helpful to create one include file that sites the set of files included in the precompiled header you used on the Mac. CodeWarrior Latitude includes an include file like this for the often used MacHeaders file. It is located in the $LATITUDE_ROOT/utilities directory. You can copy it to your application's development environment for your use.

At the time of this article's writing, Metrowerks has not yet released our own C/C++/ObjC compiler for Rhapsody. However, by the time this article hits the stands, this issue of precompiled headers will be moot for Rhapsody. However, until we bring the IDE to Rhapsody, you will still have to explicitly add any includes that were implicitly added by the IDE's prefix file feature.

 
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* 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
Position Opening at *Apple* - Apple (United...
…Summary** As a Specialist, you help create the energy and excitement around Apple products, providing the right solutions and getting products into customers' hands. You Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.