TweetFollow Us on Twitter

Portability
Volume Number:9
Issue Number:10
Column Tag:Software design

Related Info: Memory Manager File Manager

Beyond the Macintosh

Here’s a way to design your code to be portable

By Lala “Red” Dutta, DataViz, Inc.

Here we are... 1993 and the playing field has narrowed down to a handful of machines and architectures. The contenders left on the field are Unix boxes, PC’s and Mac’s. However, soon to enter the playing field is the Power PC based Macintosh. And where are we? Since the majority of MacTech readers are Macintosh programmers, it is safe to assume... “We’re On A Macintosh!” (And I say that while making some Tim Allen grunts)

But for a moment, let me state a few observations of mine...

• Macintosh programmers know what the game really is... “Make something obvious and simple, and people will use it.”

• Wouldn’t it be nice if we could show the rest of the world how to write a better application?

• Wouldn’t it be nice if we made lots of money selling this stuff to the unenlightend?

So with those observations, let me ask the million dollar questions... Is your code portable? Will you be able to recompile and run on the Power PC? And what about Windows and OS/2? Can you recompile and run there too? After all, if you can do that, you can make money on many fronts!!! (Mo’ Money, Mo’ Money, Mo’ Money!)

At this time, I want to make a couple of statements about what’s up and coming, and what’s not! A lot of gratuitous code will not be present! After all, we’re all adults, and we’re bright enough to code this stuff on our own! (We don’t need no stink’in code!) You can also expect to see quotes from many movies and sitcoms. Also, even if you’re not a techie, you should have no problem understanding the gist of what I’ll be talking about (although a vague idea about C and C++ would help).

Zen And Portability

Before we can walk down the golden path, we need to have an objective. So here is the line my co-workers are use to hearing me say...

If truly portable code is written, it can be used anywhere, any time, and in any form.

So there’s the target we wish to hit. But now to get back to the real world, we know we can’t hit that 100% of the time. So the true key is to separate what can hit that target from that stuff which cannot. To get a little more specific, we need to achieve the following:

• Create platform independent code that relies on other platform dependent code to do the dirty work.

• Have uniform API’s between the platform dependent and independent code.

• Ensure that the platform independent code is completely insensitive to the underlying hardware and operating environment.

• Ensure that the platform dependent code has a completely general interface and takes full advantage of the underlying hardware and operating environment.

• Finally, ensure that portability is retained through maintenance.

Portability Overview

So what does this all mean? Hopefully, this diagram clears things up a little bit:

With this type of model, your core code deals with doing the main task at hand. It then relies on other code to take care of the platform specific stuff. So what kind of things go in each group of code? It really is entirely your choice, but this happens to be my model:

Environment Manager TApplication, InitApp, MaxApplZone

User Interface Manager TWindow, TLists, TButton, TStatic,

DrawRect, DrawCircle, Line, etc...

I/O Manager NewFile, OpenFile, CloseFile, Read,

Write, Seek, Tell, etc..

Memory Manager AllocHandle, FreeHandle,

AppendToHandle, HandleSize, etc...

Another preference of mine is to have C++ classes and objects in the Environment and User Interface managers. Also, I prefer standard C routines for I/O and Memory Management. However, you can do whatever you are comfortable with.

Finally, I prefer to keep sub-folders (or sub-directories that contain the non-portable code. This way my main folder (or directory) contains only the portable code. I also prefer keeping everything on a Macintosh server (because of resource forks). Then I can have a batch file that mounts the volumes that contain all the code, copies what I need, and starts the makefile. On the Mac, I can just use a makefile.

Portable Data Types

One of the most prevalent problems in portability is data. (Red’s proverb on cross-platform computing: “one machine’s garbage is another machine’s data.”) What do I mean... byte order and data size. The Motorola and Intel chips store numbers in reverse order from each other. For example, lets say I have a long unsigned integer with the value 110 (hex 6E). On the Motorola, it would exist as 0x0000006E. On an Intel machine, it would exist as 0x6E000000.

Another problem to keep in mind is the size of data types. For instance, what is the size of an ‘int’ under MPW, Think, or Microsoft? Are they all the same size? And moreover, what is the size of a ‘double’ under all those compilers?

And now for the clinchers... is a Handle always a pointer to a pointer? Is a Handle always four bytes? Does a pointer always point to the right segment?

So how do we get around these problems. Actually, the solution is pretty easy. What you need a set of data types that have the same meaning regardless of their native environment. You can achieve this by having an include file (I usually call it defTypes.h) for each platform which defines some standard types:

Byte Single byte signed character

UByte Unsigned single byte

Word Two byte signed integer

UWord Two byte unsigned integer

Long Four Byte signed integer

ULong Four Byte unsigned integer

Float64 64 bit IEEE Float

Float80 80 bit IEEE Float

Pointer Pointer to an absolute address

Handle Token for relocatable space

etc...

Now lets take some real world examples. If I were under Think C and I had to use 64 bit IEEE floats, I would typedef Float64 as a short double. If I were under MPW and I needed a two byte integer I would typedef Word as a short. If I needed a pointer under Borland C, I would typedef Pointer as a (void far *). This way I can have a known data type and definition under each platform.

Additionally, I have routines that take a Pointer to a certain data type and returns the data in its native form. These routines include:

/* 1 */

Word            macword(Pointer p);
Long             maclong(Pointer p);
Float64        macFloat64(Pointer p);
Float80        macFloat80(Pointer p);
etc...
Word            pcword(Pointer p);
Long             pclong(Pointer p);
etc...

Each routine describes the type of data it uses as an argument. For example whenever I use the function pcFloat64, I’m saying that the thing p points to is a 64 bit pc based IEEE float and I want a native 64 bit float returned. So what does the code look like?

/* 2 */

// Borland Implementation of pcFloat64
Float64 pcFloat64(Pointer p)
{
 return *((Float64 *) p);
}


// MPW Implementation of pcFloat64
Float64 pcFloat64(Pointer p)
{
 Float64f;

 revmem(p, (Pointer) &f, 8);// reverses p onto f
 return f;
}

Notice how the Macintosh implementation needed to reverse the data in order to use it. And since the PC implementation already had it in its required form, it merely sent the value along.

Finally, how do we manipulate this data. Generally, I have a library of platform independent routines that do the following:

/* 3 */

myGetc(TBuff)  Get one byte from a buffer
myGetN(TBuff, Ptr, Word)  Get n bytes, put it at Ptr
myGetw(TBuff)  Get a word from a buffer
myGetl(TBuff)  Get a long from a buffer
etc...
myPutc(TBuff, Byte)Put one byte into a buffer
myPutN(TBuff, Ptr, Word)  Put n bytes into a buffer
myPutw(TBuff, Word)Put a word into a buffer
myPutl(TBuff, Long)Put a long into a buffer
etc...
// TBuff is a C++ class

Inside each of these routines, they would read the data in it’s actual form, and return the value in it’s native (or default form). So lets look at the following platform independent code that fetches a long integer from a pc based spreadsheet file:

/* 4 */

Long  myGetl(TBuff b)
{
 UByte  d[4];
 Long x;

 myGetN(b, (Pointer) d, (Word) 4);
 x = pclong((Pointer) d);

 return x;
}

Remember this code is platform independent! However, it does call pclong which has a platform independent interface, and platform dependent code.

Code Fragments And Re-Entrancy

Of course there is more to life than just applications. In the real world there are code resources, shared libraries, and dynamically loaded libraries. These code fragments are really good for localization or creating sub-applications. Or even if you wanted to create different libraries that several applications could share, they are good for that too. The topic of re-entrancy becomes prevalent if you are talking about having several applications share code at run-time. At that point, you cannot have any critical global data. (Not gonna do it! Can’t do it! Wouldn’t be prudent! Thousand Points of Light!)

But back to the issue at hand, we need to break these things down into their portable and non-portable parts and still be able to build these things as any of the three types of code fragments. Also, to be able to build code as any of the three types, we need to satisfy the most stringent requirements of all three. So let’s discuss some of the requirements of each of these types of code fragments:

Code Resources - One main entry point and must be under 32K. Also, under MPW it cannot have global data space. While under Think it may use global data space.

DLLs - Can have multiple entry points and can have global data.

Shared Libraries - These are equivalent to DLLs, but are only available under MPW. The biggie is that it will be available on the PowerPC.

So what are the overall requirements? We need code that has no global data space and is under 32K. Furthermore, it can have only one entry point. This isn’t too bad. If anybody has written any control panel devices you know how to get away without using global data and having only one entry point. Furthermore, we can also break our big code fragments into several smaller fragments. After all, isn’t that the definition of a code fragment? So we’re going to use the Macintosh Control Panel as our overall model.

But how do you do it? Well, this takes a little more finesse. Let’s go back to our original diagram of platform independent code. But now imagine that we put a platform specific front end (and export module for shared libraries). Also, we must create a standard calling sequence for using these fragments. I prefer the calling sequence described below:

OSErr fragMain (Word instruction, Pointer ctlStruct)

I use instructions for things like fragOpen, fragClose, fragDoTask, etc., and I use ctlStruct as a bucket for whatever I want to pass into and out of a fragment. Here is an example of a ctlStruct:

/* 5 */

typedef struct fragCtl {
 Word   paramCnt;
 PointerparamList;
 Handle fragWorkSpace;
} fragCtl;

And the way the fragMain would be laid out is as follows:

/* 6 */

OSErr fragMain (Word instruction, Pointer ctlStruct)
{
 OSErr  rc = noErr;

 switch (instruction) {
 case fragOpen:
 ctlStruct->fragWorkSpace = 
 AllocHandle (sizeof(mySpace));
 rc = MemErr();
 break;
 case fragClose:
 FreeHandle(ctlStruct->fragWorkSpace);
 rc = MemErr();
 break;
 case ...
 case ...
 default:
 rc = unknownFragInstruction;
 break;
 };

 return rc;
}

Remember you are free to have any types of calls you want. I’m just giving you an example of what can be done. At any rate, now that we have platform independent code for a fragment, how do we construct this stuff in the fragment type we need? Actually, this is the easy part. I have a header file that gets included that simple states the following:

/* 7 */

// Think C fragment Front End
#ifdef CodeResource
OSErr main (Word instruction, Pointer ctlStruct)
{
 Handle self;
 OSErr  rc;

 RememberA0();
 SetUpA4();
 asm  {
 _RecoverHandle
 move.l a0,self
 }
 HLock(self);  /* Don't move while running   */

 rc = fragMain (instruction, ctlStruct);

 HUnlock(self);
 RestoreA4();

 return rc;
}
#endif

And as far as shared libraries are concerned, I have a file called fragMain.exp which contains:

exports = extern fragMain;

For more details on Apple’s Shared Library Manager, you can contact Apple’s Developer Support.

Non-Portable Code

Let’s take a quick look back at our assertion about non-portable code. That assertion was to “insure that the platform dependent code has a completely general interface and takes full advantage of the underlying hardware and operating environment.”

Let’s also look back at the example of the pcFloat64 code. This is a good example of code that is platform dependent, yet has a completely platform independent interface. This makes life easy for the caller.

Now I want to take that concept one step further. Let's say I am working on the user interface part of my application. What I want is to create a TButton class for each platform that implements a regular push button. After all, I want to use push buttons. To get really specific, let’s look at Borland’s Object Windows Library.

Wouldn’t it be nice if we could have Borland’s OWL on all platforms? Actually, we can! All it takes is us rolling up our sleeves a little and creating these UI Libraries for all of the platforms we wish to support. Overall, we want C++ objects for the following user interface metaphors:

TWindow Put up a blank window

TMenu Object for a menu list

TPopUp Object for a pop up list

TScrollList Object for a scroll list

TList Create a list for scrolling, pop ups...

TCheckBox Standard check boxes

TButton Standard push buttons

TRadioButton Standard radio buttons

etc...

These C++ classes should have member functions that do whatever it is that you want. For instance, let’s take TButton. For TButton you need a constructor, a destructor, a hilite metaphor, disable metaphor, enable, and whatever else you may want.

You can take the same principles and extrapolate them for file management and memory management. However with those items, I prefer having straight C routines instead of C++ classes. (Give it to me straight Doc!)

Portable Code

Believe it or not, at this point, writing platform independent code is almost elementary. The only thing you need to do is to call your UI Manager for user interface work, call your file manager for I/O, call your memory manager for memory usage, and don’t call anything platform specific.

I know you’re saying “easier said than done.” At first it is easier said than done. But once your libraries are created, the problem is much easier the next round. Moreover, once you get into the habit, it becomes very easy. And the knowledge of what is portable, and what is not becomes more apparent. Moreover, I hope I have given you some ideas to think about and some plans to go cross-platform. And for the big Macintosh payoff, hopefully, you can position yourself well so compiling for the native PowerPC is trivial.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

VMware Fusion 11.5.6 - Run Windows apps...
VMware Fusion and Fusion Pro - virtualization software for running Windows, Linux, and other systems on a Mac without rebooting. The latest version includes full support for Windows 10, macOS Mojave... Read more
Alfred 4.1 - Quick launcher for apps and...
Alfred is an award-winning productivity application for OS X. Alfred saves you time when you search for files online or on your Mac. Be more productive with hotkeys, keywords, and file actions at... Read more
Dashlane 6.2032.0 - Password manager and...
Dashlane is an award-winning service that revolutionizes the online experience by replacing the drudgery of everyday transactional processes with convenient, automated simplicity - in other words,... Read more
Skype 8.63.0.76 - Voice-over-internet ph...
Skype is a telecommunications app that provides HD video calls, instant messaging, calling to any phone number or landline, and Skype for Business for productive cooperation on the projects. This... Read more
Mellel 5.0.3 - The word processor for sc...
Mellel is the leading word processor for OS X and has been widely considered the industry standard for long form documents since its inception. Mellel focuses on writers and scholars for technical... Read more
A Better Finder Rename 11.20 - File, pho...
A Better Finder Rename is the most complete renaming solution available on the market today. That's why, since 1996, tens of thousands of hobbyists, professionals and businesses depend on A Better... Read more
TunnelBear 3.9.10 - Subscription-based p...
TunnelBear is a subscription-based virtual private network (VPN) service and companion app, enabling you to browse the internet privately and securely. Features Browse privately - Secure your data... Read more
Dropbox 103.4.383 - Cloud backup and syn...
Dropbox for Mac is a file hosting service that provides cloud storage, file synchronization, personal cloud, and client software. It is a modern workspace that allows you to get to all of your files... Read more
Daylite 2020.29.1 - Dynamic business org...
Daylite helps businesses organize themselves with tools such as shared calendars, contacts, tasks, projects, notes, and more. Enable easy collaboration with features such as task and project... Read more
HoudahSpot 5.1.5 - Advanced file-search...
HoudahSpot is a versatile desktop search tool. Use HoudahSpot to locate hard-to-find files and keep frequently used files within reach. HoudahSpot will immediately feel familiar. It works just the... Read more

Latest Forum Discussions

See All

Motorball is a car football game from No...
A few years back Noodlecake Studios announced that they would be dipping in the multiplayer gaming realm with two different games. The first of those, Golf Blitz, released a while back and has proven to be very popular. Now, the second has arrived... | Read more »
SINoALICE's latest update introduce...
SINoALICE's latest update has now arrived, adding several fan-favourite characters from popular RPG series NieR. Young Nier, Kaine, and Young Emil are available in-game as part of a limited-time crossover event set to run until August 20th. [Read... | Read more »
Rocat Jumpurr is an intense roguelite pl...
Rocat Jumpurr is a roguelite platformer from developer Mousetrap Games. You might already be familiar with it if you follow the Big Indie Pitch, where it won first place during this year's Pocket Gamer Connects London competition. Following its... | Read more »
PUBG Mobile's Play As One campaign...
Back in mid-July, we reported that PUGB Mobile had teamed up with Direct Relief to help raise money for the charity's COVID-19 response project. It focused on an in-game running challenge for players, which lead to the PUBG Mobile donating $2... | Read more »
Marvel Contest of Champions' latest...
Marvel Contest of Champions' latest motion comic has arrived, and it shows off new fighters Air-Walker and Dragon Man. Both characters are set to arrive in-game this month. [Read more] | Read more »
Clash Royale: The Road to Legendary Aren...
Supercell recently celebrated its 10th anniversary and their best title, Clash Royale, is as good as it's ever been. Even for lapsed players, returning to the game is as easy as can be. If you want to join us in picking the game back up, we've put... | Read more »
Global Spy is an intriguing 2D spy sim f...
Developer Yuyosoft Innovations' Global Spy launched last month for iOS and Android, though if you missed it at the time, we're here to tell you why it's well worth a go. This one's all about international espionage, tracking down elusive spies,... | Read more »
Distract Yourself With These Great Mobil...
There’s a lot going on right now, and I don’t really feel like trying to write some kind of pithy intro for it. All I’ll say is lots of people have been coming together and helping each other in small ways, and I’m choosing to focus on that as I... | Read more »
Hyena Squad is sci-fi turn-based strateg...
Wave Light Games has just revealed its latest release, Hyena Squad, a turn-based RPG set in a space station infested by gross aliens and the living dead. The announcement was first reported on by Touch Arcade. [Read more] | Read more »
Idle Guardians: Never Die is a pixel art...
SuperPlanet has been fairly prolific with game releases so far this year with both Evil Hunter Tycoon and Lucid Adventure releasing earlier this year. Now, they've released another idle RPG called Idle Guardians: Never Die, which you can download... | Read more »

Price Scanner via MacPrices.net

Apple restocks refurbished 2020 13″ MacBook A...
Apple has restocked Certified Refurbished 2020 13″ MacBook Airs starting at only $849 and up to $200 off the cost of new Airs. Each MacBook features a new outer case, comes with a standard Apple one-... Read more
Apple restocks clearance 2019 13″ 2.4GHz MacB...
Apple has restocked Certified Refurbished 2019 13″ 2.4GHz 4-Core Touch Bar MacBook Pros starting at $1359 and up to $560 off original MSRP. Apple’s one-year warranty is included, shipping is free,... Read more
Apple restocks refurbished iPhone XR models s...
Apple has restocked Certified Refurbished, unlocked, iPhone XR models in the refurbished section of their online store starting at $539. Each iPhone comes with Apple’s standard one-year warranty,... Read more
Price drops! $100-$200 off clearance 27″ 5K i...
B&H Photo has dropped prices on clearance, previous-generation 27″ 5K iMacs by up to $200 off Apple’s original MSRP: – 27″ 3.0GHz 6-Core 5K iMac: $1699 $100 off original MSRP – 27″ 3.1GHz 6-Core... Read more
Woot offers Apple Watch and iPhone models fro...
Amazon-owned Woot has refurbished Apple Watch and iPhone models available from $99-$749 through August 6th. According to Woot, the items may show some wear, but they have all been fully tested and... Read more
Apple’s Phil Schiller Steps Down As SVP OF Wo...
NEWS: 08.05.20 – Former Apple senior Vice President of worldwide marketing, Phil Schiller, is stepping down from his long time role at the company in order to focus on spending more time with family... Read more
Expercom offers $320 discount on the 6-core 1...
Apple reseller Expercom has the Silver 16″ 6-core MacBook Pro on sale for a limited time for $2079 shipped. Their price is $320 off Apple’s MSRP for this model, and it’s the cheapest price currently... Read more
Apple announces Education pricing for new 202...
Purchase a new 2020 iMac or iMac Pro at Apple using Apple’s Education discount, and take up to $400 off MSRP. All teachers, students, and staff of any educational institution with a .edu email... Read more
Apple reseller Expercom offers $256 discount...
Expercom has Apple’s new 2020 10-core iMac Pro available for order and on sale for $4743 shipped. Their price is $256 off Apple’s MSRP for this new model, and it’s the cheapest price we’ve seen so... Read more
Apple releases refreshed 2020 27″ iMacs with...
Apple today released updated versions of their 27″ iMacs featuring 10th generation Intel processors, SSDs across the board, a better 5K display, and improvements to the camera, speakers, and mic.... Read more

Jobs Board

Executive Team Leader GM Sales (Assistant Man...
…(Assistant Manager General Merchandise and Operations) - Apple Valley, CaliforniaApply NowJob ID:R0000082364job family:Store Managementschedule:Full Read more
Cub Foods - *Apple* Valley - Now Hiring Par...
Cub Foods - Apple Valley - Now Hiring Part Time! United States of America, Minnesota, Apple Valley New Retail Post Date 2 days ago Requisition # 122305 Sign Up Read more
Part-time Geek Squad *Apple* Consultation P...
**770829BR** **Job Title:** Part-time Geek Squad Apple Consultation Professional-Store 384(Ithaca) **Job Category:** Store Associates **Store Number or Department:** Read more
Product Manager, *Apple* Commercial Sales -...
Product Manager, Apple Commercial Sales Austin, TX, US Requisition Number:77652 As an Apple Product Manager for the Commercial Sales team at Insight, you Read more
Cub Foods - *Apple* Valley - Now Hiring Par...
Cub Foods - Apple Valley - Now Hiring Part Time! United States of America, Minnesota, Apple Valley New Retail Post Date 1 day ago Requisition # 122305 Sign Up Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.