TweetFollow Us on Twitter

January 92 - The Soup Kitchen - Extending C++ with C++

The Soup Kitchen - Extending C++ with C++

Eric M. Berdahl

This month I'll look at C++ from a slightly different perspective. One of my central themes has been object code compatibility with Pascal and MacApp. But this will not be an issue today. Instead, I'll be looking at tools intended to make the C++ programmer's life easier by extending the language with "pure" C++ classes.

THE MEANING OF "EXTENDABLE"

Most languages are judged, at least initially, by the support they provide for certain "key" issues. String manipulation is a typical example of such an issue.

Support for strings in C and Pascal marks two extremes of a spectrum. Pascal provides rather intuitive syntax for dealing with strings, while C provides for support via a powerful but non-intuitive library of functions. The advantage of standard C is the programmer's ability to easily create superior string handling functions at the cost of readability. The advantage of standard Pascal is the programmer's ability to create very readable code at the expense of flexibility.

C++ provides something between these C and Pascal. C++ doesn't have built-in support for strings, but the class structure and messaging protocol allows you to design string classes that are intuitive and easy to change. When this is done, you can use strings as if C++ has predefined definitions for what strings are and how to manipulate them. Furthermore, C++ lets you create small classes whose sole purpose is to aid in housekeeping chores or other code-level cleanup that is sometimes required when programming complex systems like the Macintosh.

HOUSEKEEPING À LA C++

General techniques One of the more tedious tasks facing Macintosh programmers is the necessity to save different states at various points in one's code. MacApp does nothing but add to the complexity of the problem. Lock state of handles, pen states, focused views, and permanent allocation flags are simple examples of things MacApp programmers need to keep track of and keep in sync with code.

The classic approach to this problem is to write code resembling the following:

{
    StateRecord aState;
    GetCurrentState(aState);
    //  Insert code here that screws around
    //  with the element we want to save
    SetCurrentState(aState);
}

This code is straightforward and works fine. However, it will run into problems when you need to contend with MacApp failure handling. In this situation, you need to provide failure handling code to restore the state appropriately, as follows:

{
    StateRecord         aState;
    FailInfo            fi;
    GetCurrentState(aState);
    if (fi.Try())
    {
        //  Insert code here that screws around
        //  with the element we want to save
        SetCurrentState(aState);
        fi.Success();
    }
    else
    {
        SetCurrentState(aState);
        fi.ReSignal();
    }
}

This code is functional and perfectly acceptable, though rather wordy. It uses a simple concept-it preserves the state across this section of code. This bit of housekeeping is a perfect candidate for an object.

The technique I describe here applies to all forms of housekeeping. But for sake of brevity, I'll restrict my explication to one application-locking a handle.

CHandleLocker
class CHandleLocker
{
private:
    Handle      fHandle;
    Boolean     fWasLocked;
    FailInfo    fFailInfo;
protected:
    pascal void HandleFailure(OSErr err, long message);
    virtual pascal RestoreLockState();
public:
    CHandleLocker(Handle theHandle);
    virtual ~CHandleLocker();
};

CHandleLocker is a simple class that assures a handle remains locked within a particular scope and that it reverts to its previous state outside that scope. Using CHandleLocker, you can write code that utilizes handle locking in the following manner:

{
    CHandleLocker   lockSomeHandle(someHandle);
    //  Insert code that relies on someHandle being locked
}

Magically, when this code block executes, someHandle will be locked. The intervening code will execute, and someHandle will be returned to the state it was in (either locked or unlocked) when the block began. As an added bonus, if a MacApp failure is raised somewhere in the intervening code, someHandle will still be left in its original state. Amazingly, CHandleLocker adds safe handle locking to C++, and gives it a syntax that is relatively simple and unobtrusive.

Under the hood of CHandleLocker

To accomplish this little bit of heaven, CHandleLocker relies on the constructor and destructor mechanisms of C++ classes. The constructor and destructor are the core of the class. The constructor is called automatically when an instance is created, as in the declaration of lockSomeHandle in the example above. The destructor is called when an instance is destroyed, as in the closing curly brace in the same example.
CHandleLocker::CHandleLocker(Handle theHandle)
{
    fHandle = theHandle;
    fWasLocked = IsHandleLocked(fHandle);
    if (!fWasLocked)
        HLock(fHandle);
    CatchFailures(fFailInfo, CHandleLocker::HandleFailure, this);
}

CHandleLocker::~CHandleLocker()
{
    Success(fFailInfo);
    this->RestoreLockState();
}

The constructor simply saves the handle and its original lock state in instance variables. If the object is originally unlocked, it locks it. Finally, a MacApp failure handler is installed. In the destructor, the failure handler is removed and the lock state is restored. The remaining parts of the class are the method to restore the lock state and the failure handler:

void CHandleLocker::RestoreLockState()
{
    if (!fWasLocked)
        HUnlock(fWasLocked);
}

pascal void CHandleLocker::HandleFailure(OSErr err, long message)
{
    this->RestoreLockState();
}

RestoreLockState is straightforward. It simply refers to the fWasLocked boolean instance variable and unlocks the handle if it was originally unlocked. But the failure handler is a bit more involved and will take a short explanation.

CHandleLocker::HandleFailure is mediated using the Pascal-style failure handling routines, CatchFailures and Success. Therefore, the failure handling routine does not need to resignal the failure since returning from the routine automatically invokes the next failure handler on the stack.

Also, the method is declared with the keyword pascal, indicating that we want the return values and arguments passed Pascal-style. This is important once you recognize that methods with Pascal-style arguments will have the metavariable this passed as the last "argument" of the routine, the same position the Pascal static link variables occupy (see the September installment of The Soup Kitchen for a discussion of nested procedures and static links). Notice that this is passed as the static link variable in the CatchFailures argument list above.

That's all there is to this simple little utility class. I challenge the reader to write utility objects to handle other housekeeping chores. To get started, look at the PenState of QuickDraw, and the focus information in the MacApp view architecture. It should be fairly simple to use CHandleLocker as a template to build a useful library of magic little objects.

STRINGS

Admittedly, utility classes are simple examples and do not come close to making the case for language extensibility. However, having opened the door and provided some decent groundwork, let's take a look at CStr255, a very nice piece of work from the MacApp Team at Apple.

Any Macintosh programmer is familiar with the basic Pascal string. The Pascal string differs from the C string in the following ways:

  • Pascal strings are limited to 255 characters; C strings are basically unlimited in length.
  • Pascal strings contain the length of the string in their first byte; C strings are terminated with a null byte (hex 00).
  • Pascal strings are supported with Pascal language syntax; C strings are supported by convention and a standard C library.

Pascal programmers are fortunate to be able to use standard Macintosh strings, Str255, with little or no effort. Since these strings are nothing more than real Pascal strings, the compiler and run time environment take care of the details. The C++ programmer has the ability to use Pascal-like syntax to define and manipulate Pascal strings, but must be constantly aware of the difference and must maintain discipline to convert to the appropriate format as necessary.

Unlike the example of maintaining the lock state of a handle, writing a fully capable language-extending class like CStr255 is beyond the skill of all but master C++ architects. CStr255 provides an excellent example of what C++ can do, but it should not be imitated by the novice. This warning is sorely lacking in all C++ books I've encountered and is the primary cause of problems with novice and intermediate level C++ programmers. To quote Barnum and Bailey, "Kids, don't try this at home."

In its final form, CStr255 allows you to write code that looks like this:

{
    CStr255 aString;
    aString = "A string";
    aString = aString + "another string";
    if (aString == anotherString)
        gApplication->Beep(3);
    theLength = aString.Length();
    theFifthCharacter = aString[5];
    DrawString(aString);
    DrawString("A string constant");
    printf("This line prints C strings %s", (char*)aString);
}

In short, you can write code that looks like Pascal but that integrates well with your C++ code.

Constructor magic

The first rabbit I'll pull out of CStr255 involves its constructors. The designers of CStr255 provide a constructor that takes a single char* as an argument: CStr255::CStr255(char*).

Since all standard C strings and string constants in C++ are of type char*, this means you can assign C strings and string constants directly to any variable of type CStr255. Furthermore, any routine that takes a CStr255 as an argument, like DrawString, can be passed a C string or string constant with no difficulty.

Similarly, CStr255 provides for constructors from other Macintosh string types (CStr63 for example), other C types (like unsigned char*), and even a constructor from a longint that is used to convert ResType and OSType variables to their string equivalents. As with all the CStr255 code I'll quote from here, these constructors are found in the file PascalString.h in the MacApp 3.0b3 release.

Operator magic

Constructors are handy and useful, but without the operators +, =, ==, and others, CStr255 would just be a neat utility class. Instead, with these operators, you have access to a truly powerful class that adds Pascal strings to the C++ language with a very simple and intuitive syntax. Since it's not reasonable to reproduce the CStr255 code here, I'll leave you with a taste of the features available for string handling and short examples of their utility.

Constructors

CStr255();                            //  CStr255 aStr
CStr255(char*);                       //  aStr = "A string"
CStr255(const CStr255&);          // aStr = anotherStr255
CStr255(const CStr63&);           //  aStr = aStr63
CStr255(long);                        //  aStr = 'PICT'

Operators

char& operator[](short pos);      //  aStr[4] = 'P'
CStr255 operator+(CStr255&);      //  aStr = bStr + cStr
CStr255 operator=(CStr255&);      //  aStr = bStr
Boolean operator==(CStr255&);     //  if (aStr = bStr)
Boolean operator==(const char*);      //  if (aStr == "A string")
Boolean operator>(const char*);    //  if (aStr > "ABC")

Handy functions

char& Length();                   //  aStr.Length() = 7
Boolean IsEmpty();                    //  if (aStr.IsEmpty())

Conversions

operator char*();                     //  printf("%s", aStr);
operator long();                      //  GetResource(long(aStr), kID);
 

Community Search:
MacTech Search:

Software Updates via MacUpdate

TunnelBear 3.0.1 - Subscription-based pr...
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
ExpanDrive 5.4.0 - Access cloud storage...
ExpanDrive builds cloud storage in every application, acts just like a USB drive plugged into your Mac. With ExpanDrive, you can securely access any remote file server directly from the Finder or... Read more
Opera 40.0.2308.62 - High-performance We...
Opera is a fast and secure browser trusted by millions of users. With the intuitive interface, Speed Dial and visual bookmarks for organizing favorite sites, news feature with fresh, relevant content... Read more
Apple iOS 10.0.2 - The latest version of...
iOS 10 is the biggest release of iOS ever. A massive update to Messages brings the power of the App Store to your conversations and makes messaging more personal than ever. Find your route with... Read more
Herald 7.0 - Notification plugin for Mai...
Note: Versions 2.1.3 (for OS X 10.7), 3.0.6 (for OS X 10.8), 4.0.8 (for OS X 10.9), 5.0.2 (for OS X 10.10), and 6.0.3 (for OS X 10.11) are no longer supported by the developer. Herald is a... Read more
Postbox 5.0.2 - Powerful and flexible em...
Postbox is a new email application that helps you organize your work life and get stuff done. It has all the elegance and simplicity of Apple Mail, but with more power and flexibility to manage even... Read more
Yummy FTP Pro 1.11.10 - $29.99
Yummy FTP Pro is an advanced Mac file transfer app which provides a full-featured professional toolkit combined with blazing speeds and impeccable reliability, so whether you want to transfer a few... Read more
Tidy Up 4.1.17 - $29.99
Tidy Up is a full-featured duplicate finder and disk-tidiness utility. Features With Tidy Up you can search for duplicate files and packages by the owner application, content, type, creator,... Read more
Logitech Control Center 3.9.5 - Keyboard...
Logitech Control Center (LCC) is designed to support OS X and allows you to take full advantage of your Logitech keyboard, mouse, or trackball. With the LCC you can: Browse the Internet using... Read more
Macgo Blu-ray Player 2.16.17 - Blu-ray p...
Macgo Blu-ray Player can bring you the most unforgettable Blu-ray experience on your Mac. Overview Macgo Mac Blu-ray Player can satisfy just about every need you could possibly have in a Blu-ray... Read more

How to build and care for your team in D...
Before you hit the trail and become a dog sledding legend, there’s actually a fair bit of prep work to be done. In Dog Sled Saga, you’re not only racing, you’re also building and caring for a team of furry friends. There’s a lot to consider—... | Read more »
How to win every race in Dog Sled Saga
If I had to guess, I’d say Dog Sled Saga is the most adorable racing game on the App Store right now. It’s a dog sled racing sim full of adorable, loyal puppies. Just look at those fluffy little tails wagging. Behind that cute, pixelated facade is... | Read more »
Let the war games commence in Gunship Ba...
Buzz Lightyear famously said, “This isn’t flying, this is falling – with style!” In the case of Gunship Battle: Second War, though, this really is flying - with style! The flight simulator app from Joycity puts you in control of 20 faithfully... | Read more »
How to get a high score in Fired Up
Fired Up is Noodlecake Games’ high score chasing, firefighting adventure. You take control of a wayward firefighter who propels himself up the side of a highrise with blasts of water. Sound silly? It is. It’s also pretty difficult. You can’t... | Read more »
NBA 2K17 (Games)
NBA 2K17 1.0 Device: iOS iPhone Category: Games Price: $7.99, Version: 1.0 (iTunes) Description: Following the record-breaking launch of NBA 2K16, the NBA 2K franchise continues to stake its claim as the most authentic sports video... | Read more »
Dog Sled Saga (Games)
Dog Sled Saga 1.0.1 Device: iOS Universal Category: Games Price: $3.99, Version: 1.0.1 (iTunes) Description: A game by Dan + Lisa As a rookie musher, foster a dogsledding team whose skills will grow if they're treated right. Week by... | Read more »
60 Seconds! Atomic Adventure (Games)
60 Seconds! Atomic Adventure 1.2 Device: iOS Universal Category: Games Price: $2.99, Version: 1.2 (iTunes) Description: 60 Seconds! is a dark comedy atomic adventure of scavenge and survival. Collect supplies and rescue your family... | Read more »
Tons of Bullets! (Games)
Tons of Bullets! 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Tons of BulletsA retro 2D pixel platformer infused with tons of bullets and tons of features!Fight as Kenji the Ninja and... | Read more »
Sorcery! 4 (Games)
Sorcery! 4 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: *** PLEASE NOTE: Sorcery! 4 requires a minimum of iPad 3 or iPhone 4 *** An epic adventure through a cursed citadel of monsters,... | Read more »
Building the perfect Animation Throwdown...
Animation Throwdown is a casual card game full of plenty of inside jokes from some of your favorite cartoons. It’s accessible as far as card games go, but that’s not to say that it hands your victories to you easily. There’s quite a bit that goes... | Read more »

Price Scanner via MacPrices.net

Duplicate Sweeper Free On Mac App Store For O...
To celebrate the launch of Apple’s latest macOS Sierra, Stafford, United Kingdom based Wide Angle Software has announced that its duplicate file finder software, Duplicate Sweeper, is now available... Read more
13-inch Retina MacBook Pros on sale for up to...
B&H Photo has 13″ Retina Apple MacBook Pros on sale for up to $150 off MSRP. Shipping is free, and B&H charges NY tax only: - 13″ 2.7GHz/128GB Retina MacBook Pro: $1174.99 $125 off MSRP - 13... Read more
Evidence Surfaces Pointing To New A10X Chip F...
Citing a job description for a Project Lead position at Apple’s Austin, Texas engineering labs, Motley Fool’s Ashraf Eassa deduces that development is progressing well on Apple’s next-generation in-... Read more
Check Print’R for macOS Allows Anyone to Easi...
Delaware-based Match Software has announced the release and immediate availability of Check Print’R 3.21, an important update to their easy-to-use check printing application for macOS. Check Print’R... Read more
Apple refurbished 11-inch MacBook Airs availa...
Apple has Certified Refurbished 11″ MacBook Airs (the latest models), available for up to $170 off the cost of new models. An Apple one-year warranty is included with each MacBook, and shipping is... Read more
Apple refurbished 15-inch Retina MacBook Pros...
Apple has Certified Refurbished 2015 15″ Retina MacBook Pros available for up to $380 off the cost of new models. An Apple one-year warranty is included with each model, and shipping is free: - 15″ 2... Read more
Major Version 5 Release Of Free myTuner Radio...
AppGeneration Software has announced the release of myTuner Radio 5.0.1, an important update to their live radio app for iOS and Android platforms. With myTuner Radio, you can listen to more than 30,... Read more
TheAppStore Searches And Filters iOS And macO...
Boston based InchWest has announced the official launch of TheAppStore, a free web based service that lets users search iOS and Mac apps on the web without iTunes or the App store. TheAppStore... Read more
2TB Time Capsule on sale for $199, save $100
Amazon has 2TB Apple Time Capsules on sale for $199 including free shipping. Their price is $100 off MSRP. Choose Amazon as the seller when making your purchase, rather than a third party seller. Read more
12-inch 1.2GHz Rose Gold Retina MacBook on sa...
Amazon.com has the 2016 12″ 1.2GHz Rose Gold Retina MacBook on sale for $1254.02 including free shipping. Their price is $345 off MSRP, and it’s the lowest price available for this model from any... Read more

Jobs Board

Senior *Apple* Administrator - Pratt Instit...
POSITION SUMMARY: Directs the coordination and standardization of campus-wide Apple systems, including planning, analysis and implementation of Apple -related 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* Retail - Multiple Positions- Napervi...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
US- *Apple* Store Leader Program - Apple (Un...
…Summary Learn and grow as you explore the art of leadership at the Apple Store. You'll master our retail business inside and out through training, hands-on Read more
*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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.