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);
 
AAPL
$101.06
Apple Inc.
+0.10
MSFT
$47.06
Microsoft Corpora
-0.46
GOOG
$587.37
Google Inc.
-8.71

MacTech Search:
Community Search:

Software Updates via MacUpdate

Evernote 5.6.0 - Create searchable notes...
Evernote allows you to easily capture information in any environment using whatever device or platform you find most convenient, and makes this information accessible and searchable at anytime, from... Read more
Monosnap 2.2.2 - Versatile screenshot ut...
Monosnap allows you to save screenshots easily, conveniently, and quickly, sharing them with friends and colleagues at once. It's the ideal choice for anyone who is looking for a smart and fast... Read more
Tunnelblick 3.4beta36 - GUI for OpenVPN...
Tunnelblick is a free, open source graphic user interface for OpenVPN on OS X. It provides easy control of OpenVPN client and/or server connections. It comes as a ready-to-use application with all... Read more
SoftRAID 5.0.4 - High-quality RAID manag...
SoftRAID allows you to create and manage disk arrays to increase performance and reliability. SoftRAID's intuitive interface and powerful feature set makes this utility a must have for any Mac OS X... Read more
Audio Hijack Pro 2.11.3 - Record and enh...
Audio Hijack Pro drastically changes the way you use audio on your computer, giving you the freedom to listen to audio when you want and how you want. Record and enhance any audio with Audio Hijack... Read more
Airfoil 4.8.9 - Send audio from any app...
Airfoil allows you to send any audio to AirPort Express units, Apple TVs, and even other Macs and PCs, all in sync! It's your audio - everywhere. With Airfoil you can take audio from any... Read more
WhatRoute 1.13.0 - Geographically trace...
WhatRoute is designed to find the names of all the routers an IP packet passes through on its way from your Mac to a destination host. It also measures the round-trip time from your Mac to the... Read more
Chromium 37.0.2062.122 - 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. FreeSMUG-Free OpenSource Mac User Group build is... Read more
Attachment Tamer 3.1.14b9 - Take control...
Attachment Tamer gives you control over attachment handling in Apple Mail. It fixes the most annoying Apple Mail flaws, ensures compatibility with other email software, and allows you to set up how... Read more
Duplicate Annihilator 5.0 - Find and del...
Duplicate Annihilator takes on the time-consuming task of comparing the images in your iPhoto library using effective algorithms to make sure that no duplicate escapes. Duplicate Annihilator detects... Read more

Latest Forum Discussions

See All

This Week at 148Apps: September 15-19, 2...
Expert App Reviewers   So little time and so very many apps. What’s a poor iPhone/iPad lover to do? Fortunately, 148Apps is here to give you the rundown on the latest and greatest releases. And we even have a tremendous back catalog of reviews; just... | Read more »
Kitty Powers’ Matchmaker – Tips, Tricks,...
Hey There, Kittens: | Read more »
Goblin Sword Review
Goblin Sword Review By Andrew Fisher on September 22nd, 2014 Our Rating: :: RETRO GOODNESSUniversal App - Designed for iPhone and iPad Fun visuals, good music, engaging level design, and lots of content make Goblin Sword an... | Read more »
Major New Update for CSR Racing Adds Fer...
Major New Update for CSR Racing Adds Ferrari and Multiplaye​r Posted by Jessica Fisher on September 22nd, 2014 [ permalink ] | Read more »
Veditor Review
Veditor Review By Jennifer Allen on September 22nd, 2014 Our Rating: :: PIMP YOUR VIDEOUniversal App - Designed for iPhone and iPad Want to add stickers and music to your videos? Veditor can do that easily.   | Read more »
1849′s Nevada Silver DLC is Still Search...
A few months ago, I took a look at 1849 from SomaSim. This Gold Rush-themed city builder for iPad had a fair bit going for it, but lacked in a few crucial areas to make it a true stand-out on the App Store. SomaSim has since added in a sandbox mode... | Read more »
Fruit Ninja Will be Reborn With a Massiv...
Fruit Ninja Will be Reborn With a Massive Update and Origins Animation Series Posted by Jessica Fisher on September 22nd, 2014 [ permalink ] Halfbrick Studios is rebuilding | Read more »
Daniel Tiger’s Grr-ific Feelings Review
Daniel Tiger’s Grr-ific Feelings Review By Amy Solomon on September 22nd, 2014 Our Rating: iPad Only App - Designed for the iPad Daniel Tiger’s Grr-ific Feelings includes activities that allow young children explore different... | Read more »
CloudMagic Updated for iOS 8 – Adds Inte...
CloudMagic Updated for iOS 8 – Adds Interactive Notifications, Share Extension, and More Posted by Jessica Fisher on September 22nd, 2014 [ | Read more »
Starbase Annex (Games)
Starbase Annex 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: "it’s really very clever... a little bit of Hearthstone and a dash of Eclipse" - PocketTactics.com From the creator of Starbase... | Read more »

Price Scanner via MacPrices.net

Apple restocks some refurbished 2014 MacBook...
The Apple Store has restocked some Apple Certified Refurbished 2014 MacBook Airs, with prices starting at $769. An Apple one-year warranty is included with each MacBook, and shipping is free. These... Read more
13-inch 128GB MacBook Air on sale for $949, s...
B&H Photo has the new 2014 13″ 1.4GHz/128GB MacBook Air on sale for $949.99 including free shipping plus NY tax only. Their price is $50 off MSRP. B&H will also include free copies of... Read more
Apple offering free $25 iTunes Gift Card with...
The Apple Store is offering a free $25 iTunes Gift Card with the purchase of a $99 Apple TV for a limited time. Shipping is free. Read more
Apple refurbished iPod touch available for up...
The Apple Store has Apple Certified Refurbished 5th generation iPod touches available starting at $149. Apple’s one-year warranty is included with each model, and shipping is free. Most colors are... Read more
iFixIt Tears Down iPhone 6; Awards Respectabl...
iFixit notes that even the smaller 4.7″ iPhone 6 is a giant among iPhones; so big that Apple couldn’t fit it into the familiar iPhone form factor. In a welcome reversal of a recent trend to more or... Read more
Phone 6 Guide – Tips Book For Both iPhone 6...
iOS Guides has announced its latest eBook: iPhone 6 Guide. Brought to you by the expert team at iOS Guides, and written by best-selling technology author Tom Rudderham, iPhone 6 Guide is packed with... Read more
How to Upgrade iPhone iPad to iOS 8 without D...
PhoneClean, a iPhone cleaner utility offered by iMobie Inc., reveals a solution for upgrading iPhone and iPad to iOS 8 without deleting photos, apps, the new U2 album or anything. Thanks to more than... Read more
Inpaint 6 – Photo Retouching Tool Gets Faster...
TeoreX has announced Inpaint 6, a simple retouching tool for end users that helps remove scratches, watermarks, and timestamps as well as more complex objects like strangers, unwanted elements and... Read more
Worldwide PC Monitor Market Sees Growth in To...
Worldwide PC monitor shipments totaled 32.5 million units in the second quarter of 2014 (2Q14), a year-over-year decline of -2.9%, according to the International Data Corporation (IDC) Worldwide... Read more
Updated Price Trackers
We’ve updated our Mac Price Trackers with the latest information on prices, bundles, and availability on systems from Apple’s authorized internet/catalog resellers: - 15″ MacBook Pros - 13″ MacBook... Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Position Opening at *Apple* - Apple (United...
…customers purchase our products, you're the one who helps them get more out of their new Apple technology. Your day in the Apple Store is filled with a range of 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
Position Opening at *Apple* - Apple (United...
**Job Summary** At the Apple Store, you connect business professionals and entrepreneurs with the tools they need in order to put Apple solutions to work in their Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** The Apple Store is a retail environment like no other - uniquely focused on delivering amazing customer experiences. As an Expert, you introduce people Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.