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

1Password 6.8.1 - Powerful password mana...
1Password is a password manager that uniquely brings you both security and convenience. It is the only program that provides anti-phishing protection and goes beyond password management by adding Web... Read more
EtreCheck 3.4.4 - For troubleshooting yo...
EtreCheck is an app that displays the important details of your system configuration and allow you to copy that information to the Clipboard. It is meant to be used with Apple Support Communities to... Read more
GarageSale 7.0.8 - Create outstanding eB...
GarageSale is a slick, full-featured client application for the eBay online auction system. Create and manage your auctions with ease. With GarageSale, you can create, edit, track, and manage... Read more
Backblaze 5.0.0.116 - Online backup serv...
Backblaze is an online backup service designed from the ground-up for the Mac. With unlimited storage available for $5 per month, as well as a free 15-day trial, peace of mind is within reach with... Read more
Parallels Desktop 13.0.0 - Run Windows a...
Parallels allows you to run Windows and Mac applications side by side. Choose your view to make Windows invisible while still using its applications, or keep the familiar Windows background and... Read more
Mellel 4.0.0 - 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
Adobe Muse CC 2017 2017.1.0 - Design and...
Muse CC 2017 is available as part of Adobe Creative Cloud for as little as $14.99/month (or $9.99/month if you're a previous Muse customer). Adobe Muse 2017 enables designers to create websites as... Read more
WhatsApp 0.2.5862 - Desktop client for W...
WhatsApp is the desktop client for WhatsApp Messenger, a cross-platform mobile messaging app which allows you to exchange messages without having to pay for SMS. WhatsApp Messenger is available for... Read more
WhatsApp 0.2.5862 - Desktop client for W...
WhatsApp is the desktop client for WhatsApp Messenger, a cross-platform mobile messaging app which allows you to exchange messages without having to pay for SMS. WhatsApp Messenger is available for... Read more
Things 3.1.3 - 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

The best deals on the App Store this wee...
The summer is drawing quickly to a close, but luckily there's a game for every season. It's an excellent week for some bargain shopping if that's what you're after. There are some big names and indie darlings in this week's roundup. It's a great... | Read more »
KORG iMono/Poly (Music)
KORG iMono/Poly 1.0.0 Device: iOS Universal Category: Music Price: $19.99, Version: 1.0.0 (iTunes) Description: *** Special Sale for a limited time to celebrate the debut of KORG iMono/Poly (33% OFF) until Sep 30! *** Reviving a... | Read more »
Super Phantom Cat 2 beginner's guid...
Super Phantom Cat 2 presents a whole new world of fun platforming challenges and perplexing puzzles. It's a well-designed platformer with a bright, neon aesthetic that brings the genre up to date. [Read more] | Read more »
Shadow Fight 2 Special Edition (Games)
Shadow Fight 2 Special Edition 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: ** New story chapter! **** No Ads! **** No energy! ** The best fighting series on mobile has returned and... | Read more »
4 RPGs like Final Fantasy XV that deserv...
Square Enix announced another Final Fantasy XV spin-off today - Final Fantasy XV Pocket Edition. This mobile, episodic version of the hit RPG gives the game a chibi-fied makeover. The first episode will be free, followed by 9 more premium episodes... | Read more »
Guild sieges and soul gems in latest upd...
Webzen’s MU Origin hit app stores last year, giving fans of fantasy hack-n-slash MMOs like Diablo a new fix to fixate on. This latest update introduces a competitive guild battle, a fresh dungeon challenge, a mini-game and some elemental gems to... | Read more »
Little Red Lie (Games)
Little Red Lie 1.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0 (iTunes) Description: ARE YOU MORE AFRAID OF POVERTY THAN DEATH? Little Red Lie is a narrative-focused, interactive fiction experience that reduces... | Read more »
You can now apply to be Clash of Clans...
Earlier this month, word got out that the Builder, the trusty handiman who tirelessly built every single building inevery singleClash of Clansbase had called it quits. Sick of seeing his work destroyed endless, the Builder has set out for our world... | Read more »
Meshi Quest beginner's guide - how...
Meshi Quest is Square Enix's newest free-to-play release, and it's a real charmer. You start off as the head of a sushi restaurant, upgrading your food and equipment as you serve visitors heaping helpings of your delicious meals. As you progress,... | Read more »
BUST-A-MOVE JOURNEY (Games)
BUST-A-MOVE JOURNEY 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: BUST-A-MOVE Features:- Shoot bubbles and match 3 or more bubbles of the same color to make them pop!- Complete your... | Read more »

Price Scanner via MacPrices.net

Low Cost Subscription Graphics App Alternativ...
I’m not a fan of the subscription software model, I don’t use any subscription apps. Used to be that you paid your license fee and the app was yours to use indefinitely, or until one opted for a paid... Read more
Clearance 2016 13-inch MacBook Airs, Apple re...
Apple has Certified Refurbished 2016 13″ MacBook Airs available starting at $809. An Apple one-year warranty is included with each MacBook, and shipping is free: – 13″ 1.6GHz/8GB/128GB MacBook Air: $... Read more
2017 13-inch MacBook Airs on sale for $100 of...
B&H Photo new 2017 13″ MacBook Airs on sale today for $100 off MSRP, starting at $899: – 13″ 1.8GHz/128GB MacBook Air (MQD32LL/A): $899, $100 off MSRP – 13″ 1.8GHz/256GB MacBook Air (MQD42LL/A... Read more
Sale! 13-inch 2.3GHz MacBook Pros for $100 of...
B&H Photo has 13″ 2.3GHz MacBook Pros in stock today and on sale for $100 off MSRP including free shipping plus NY & NJ sales tax only: – 13-inch 2.3GHz/128GB Space Gray MacBook Pro (MPXQ2LL... Read more
2016 MacBook Pros, Apple refurbished, availab...
Apple has Certified Refurbished 2016 15″ and 13″ MacBook Pros available starting at $1189. An Apple one-year warranty is included with each model, and shipping is free: – 15″ 2.7GHz Touch Bar Space... Read more
Apple offers Certified Refurbished iPhone 6s...
Apple has Certified Refurbished unlocked iPhone 6s’s and 6s Plus’s available starting at $449. An Apple one-year warranty is included with each phone, and shipping is free: – 16GB iPhone 6s: $449, $... Read more
Apple offers Certified Refurbished Pencils fo...
Apple has Certified Refurbished Apple Pencils available for $85 including free shipping. Their price is $14 off MSRP, and it’s the lowest price available for a Pencil. Read more
2016 15-inch 2.6GHz Touch Bar MacBook Pro ava...
B&H Photo has clearance 2016 15″ 2.6GHz MacBook Pros in stock today and on sale for $500 off original MSRP. Shipping is free, and B&H charges NY & NJ sales tax only: – 15″ 2.6GHz Touch... Read more
21-inch 2.3GHz iMac on sale for $999, save $1...
Amazon has the new 2017 21″ 2.3GHz iMac (MMQA2LL/A) in stock and on sale for $999.99 including free shipping. Their price is $100 off MSRP, and it’s the lowest price available for this model. Read more
Free Instant Translator 2.0 App For iOS Relea...
Mobile application development company, Neoappz has announced the release and immediate availability of Instant Translator 2.0 for iOS devices. Instant Translator is a user-friendly application which... Read more

Jobs Board

*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Development Operations and Site Reliability E...
Development Operations and Site Reliability Engineer, Apple Payment Gateway Job Number: 57572631 Santa Clara Valley, California, United States Posted: Jul. 27, 2017 Read more
Frameworks Engineering Manager, *Apple* Wat...
Frameworks Engineering Manager, Apple Watch Job Number: 41632321 Santa Clara Valley, California, United States Posted: Jun. 15, 2017 Weekly Hours: 40.00 Job Summary Read more
Development Operations and Site Reliability E...
Development Operations and Site Reliability Engineer, Apple Payment Gateway Job Number: 57572631 Santa Clara Valley, California, United States Posted: Jul. 27, 2017 Read more
Frameworks Engineering Manager, *Apple* Wat...
Frameworks Engineering Manager, Apple Watch Job Number: 41632321 Santa Clara Valley, California, United States Posted: Jun. 15, 2017 Weekly Hours: 40.00 Job Summary Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.