TweetFollow Us on Twitter

Transmuting Text

Volume Number: 13 (1997)
Issue Number: 4
Column Tag: Programming Techniques

Transmuting Text

By Martin Frické, Tucson, Arizona

Seemlessly exchanging text labels and editable text objects

One common problem with diagrams and intricate dialogs is that there are often many separate editable text items that have a small storage overhead relative to their own data content. For example, the user may want to label the four corners of a square; each label editable and most labels, but perhaps not all, consist of only a few characters in one style. A problem arises in that the data-structures to support style and styled-editing are reasonably substantial.

For example, the Mac TERec is 96 bytes large compared with one byte to represent the single character that is actually on one of the corners of the drawn square. If a single body of text is large, the supporting style data-structures are insignificant, but with a multiplicity of small labels in a diagram, the content can easily get swamped by the support - as much as 200k can be used for one page of symbols. On the other hand, if the program considers a label to be just a string of characters, the label can be stored frugally and drawn easily, but it would not be as easily editable.

Many commercial programs do not fare terribly well with this problem (no names, no pack drill). There are a few standard techniques. Several painting programs use once-only editing. A new label is editable, but the moment that new label is de-activated, the text in it is converted into a bit-map and merged into the background. Therefore, this label cannot be recovered back into text and edited again. Other programs use a string to represent an individual small text item, then they float editable text over the top of the single active item. This can work, but conceptually it is pretty unattractive and often aligning the floater and the background string can be awkward.

The Transmuting Approach

We are obviously going to use objects as far as we can. What is required most often are string objects for the individual small text items. However, at most there will be one editable text, so this will be an editable text object, and any of the string objects can assume this role. What is needed are transmuting objects.

There are to be many string objects, and at most, one of these may be transmuted back and forth to an editable text object as required. The time to transmute is clearly on activation and de-activation, since there is only one editable text at a time (the active one). The only other property required of the objects is the ability to draw themselves, especially when inactive, as might occur during an update. Care must be taken over the drawing, because the pen may have to produce and match exactly the same result when drawing either version of a transmuted object.

Transmutation here amounts to replacing one object with another - perhaps creating one and deleting the other. You would not want to do this with an object that is referred to by other parts of the program, for that might leave dangling references. Caution suggests hiding the transmuted object within a public object - all public references will then be to the public object.

It may be that the editing by the user makes what formerly was a simple label into complex styled text (maybe akin to the opening page of a King James Bible), in which case, the text is not transmuted back to a string on de-activation. Another decision concerns a default style for the labels - each label can have its own, or there could be a global style. The choice is left to the designing programmer.

A Code Example

The code uses Marco Piovanelli's WASTE styled-text engine http://cirrus.sprl.umich.edu/waste/. In a perfect world the code looks something like the following.

class TText : public CAbstractText
    // Abstract text supplies all the other methods
 {
 private:
 TPrivateText  *fInternalText;
 public:
 void   ActivateText (Boolean OnOff);
 void   Compact();
 void   UnCompact();
 virtual void    Update(RgnHandle updateRgn);
 }

void TText::ActivateText (Boolean OnOff)
 {
 if (OnOff)
 {
 UnCompact();    // transmutes from a string, if needed
 FocusToDraw();
 fInternalText->Activate(true);
 }
 else
 {
 FocusToDraw();
 fInternalText->Activate(false);
 Compact(); // attempts to transmute into a string
 }
 }

void TText::Compact()
 {
 Handle itsText;
 TInternalText *newText;
 Point itsPenStart;
 
 if (fInternalText->CanCompact())  {
 itsText= fInternalText->GetText();
 itsPenStart= fInternalText->GetPenStart();
 newText= new TString(itsText,itsPenStart);
 delete fInternalText;
 fInternalText=newText;
 }
 }

void TText::UnCompact()
 {
 Handle itsText;
 TInternalText *newText;
 
 if (fInternalText->CanExpand())   {
 itsText= fInternalText->GetText();
 newText= new TStyledText(itsText);
 delete fInternalText;
 fInternalText=newText;
 }
 }

void TText::Update(RgnHandle updateRgn)
 {
 
 if (RectInRgn(&fBoundingBox, updateRgn))
 {
 FocusToDraw();
 Frame();
 fInternalText->Update(updateRgn);
 }
 } 


class TInternalText  // important fields and methods only
 {
 virtual void    ActivateText (Boolean OnOff) {;};
 virtual Boolean CanCompact() {return false};
 virtual Boolean CanExpand() {return false};
 virtual Handle  GetText();
 virtual Point   GetPenStart(){return PointOf(0,0)};
 virtual void    SetPenStart(Point aStart){;};
 virtual void    Update(RgnHandle updateRgn);
 }

class TString  : public TInternalText
    // important fields and methods only          
 {
 Handle fText;
 Point fPenStart;

 Boolean  CanExpand() {return true};
 Handle GetText() {return fText};
 void   SetPenStart(Point aStart){fPenStart=aStart};
 void   Update(RgnHandle updateRgn);
 }

class TStyledText: public TInternalText
    // important fields and methods only 
 {
 void   ActivateText (Boolean OnOff);
 Boolean  CanCompact();
 virtual Point GetPenStart(){return PointOf(0,0)};
 Handle GetText();
 void   Update(RgnHandle updateRgn);
 }


void TString::Update(RgnHandle updateRgn)
 {
 MoveTo(fPenStart.h,fPenStart.v);
 HLock(fText);   
 DrawText( *fText, 0, GetHandleSize (fText) ); // Toolbox Routine           HUnlock( 
fText );
 }


Boolean TStyledText::CanCompact()
 {
 long oldStart,oldEnd,length;
 long kMaxString=999;
 SignedByte alignment;
 Boolean canDo=false;
 
 length= WEGetTextLength(fMacWE);
 
 WEGetSelection(&oldStart,&oldEnd,fMacWE);
 
 if ((oldEnd-oldStart)<kMaxString) // not too long
 {
 WESetSelection(0,kMaxString,fMacWE);
 
 mode = doFont + doFace + doSize + doColor;
 
 alignment=WEGetAlignment(fMacWE);
 
    // one style
 if ((WEContinuousStyle(&mode, &aStyle, fMacWE)) &&
    // one line
 (WEOffsetToLine(kMaxString, fMacWE)==0) &&  
    // no fancy alignment
 ((alignment== weFlushLeft)
 || (alignment== weFlushDefault))  
 )
 canDo=true;
 
 WESetSelection(oldStart,oldEnd,fMacWE);
 }
else
 return canDo    
 }

Point TStyledText::GetPenStart()
 {
 Point penStart;
 short lineAscent,lineDescent;
 LongRect destRect;
 
 WEGetDestRect(&destRect,fMacWE);  
 
 penStart.h=destRect.left;
 
 _WECalcHeights(0, 1, &lineAscent, &lineDescent, fMacWE);
 
 penStart.v= destRect.top+lineAscent;
 
 return
 penStart
 }

void TStyledText::Update(RgnHandle updateRgn)
 {
 WEUpdate(updateRgn, fMacWE); // passed to the styled text engine
 }

Unfortunately, the real world forced some modifications to this code. The Macintosh styled-text engine and the WASTE styled-text engine were not originally written as objects. They could have been given a wrapper to make them into objects, but normally they are used as Handles to records. This is not much different from Handles to objects. In the practical implementation the internal private text objects are not used. Instead, the fInternalText field is either just a Handle directly to a WASTE record or a handle to the raw text. Strictly speaking, the text transmutes a Handle based internal data structure rather than a Handle based internal object. However, it does work perfectly to produce results like the following sequence.

Figure 1. The top label is active editable text.

Figure 2. Some of the text is obscured (to demonstrate that the drawing routines mesh properly).

At this point, both labels are strings. The first several letters of the top label have been drawn by the text drawing routine.

Figure 3. Text is redrawn by string drawinf routine.

If we move the the obscuring window to one side (Figure 3) we notice that the half ‘e' and the ‘xt' in the top label are drawn perfectly by the string drawing routine and the mesh of half-a-text-draw and half-a-string-draw is exact.

Next, the document and the top label is activated and the ‘xt' changed to Chicago 18. This makes the label styled text, which will not transmute. The text is obscured again. Remove the obscuring window, and there is a perfect redraw of the top label (as styled text) and the bottom label (as a string). (See Figure 4.)

Figure 4. Obscured styled-text redrawn.

Similarly, the document and the bottom label can be activated, the bottom label made into styled text, and the obscuring sequence repeated.

A sceptic might say that the drawing routines here and the end results are visually indistinguishable from one another - how do we know that all this transmutation is actually happening? To see that the code was working properly, a single debugging SysBeep(5) is enclosed with the string drawing routine, and a double SysBeep(5) with the text drawing routine - you can hear the Updates.

 
AAPL
$103.30
Apple Inc.
+0.80
MSFT
$45.09
Microsoft Corpora
-0.34
GOOG
$577.33
Google Inc.
+5.73

MacTech Search:
Community Search:

Software Updates via MacUpdate

TextSoap 7.4.0 - Flexible text editing u...
TextSoap is for people who work with text. TextSoap effortlessly cleans up text from endlessly different formats. Wash away unwanted characters, spaces, tabs. Fix paragraphs with hard returns at the... Read more
NetShade 6.0.2 - Browse privately using...
NetShade is an Internet security tool that conceals your IP address on the web. NetShade routes your Web connection through either a public anonymous proxy server, or one of NetShade's own dedicated... Read more
Mac DVDRipper Pro 5.0 - Copy, backup, an...
Mac DVDRipper Pro is the DVD backup solution that lets you protect your DVDs from scratches, save your batteries by reading your movies from your hard disk, manage your collection with just a few... Read more
pwSafe 3.1 - Secure password management...
pwSafe provides simple and secure password management across devices and computers. pwSafe uses iCloud to keep your password databases backed-up and synced between Macs and iOS devices. It is... Read more
StatsBar 1.8 - Monitor system processes...
StatsBar gives you a comprehensive and detailed analysis of the following areas of your Mac: CPU usage Memory usage Disk usage Network and bandwidth usage Battery power and health (MacBooks only)... Read more
Path Finder 6.5.5 - Powerful, award-winn...
Path Finder is a file browser that combines the familiar Finder interface with the powerful utilities and innovative features. Just a small selection of the Path Finder 6 feature set: Dual pane... Read more
QuarkXPress 10.2.1 - Desktop publishing...
With QuarkXPress, you can communicate in all the ways you need to -- and always look professional -- in print and digital media, all in a single tool. Features include: Easy to Use -- QuarkXPress is... Read more
Skype 6.19.0.450 - Voice-over-internet p...
Skype allows you to talk to friends, family and co-workers across the Internet without the inconvenience of long distance telephone charges. Using peer-to-peer data transmission technology, Skype... Read more
VueScan 9.4.41 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
Cloud 3.0.0 - File sharing from your men...
Cloud is simple file sharing for the Mac. Drag a file from your Mac to the CloudApp icon in the menubar and we take care of the rest. A link to the file will automatically be copied to your clipboard... Read more

Latest Forum Discussions

See All

Modern Combat 5 Gets a Major Multiplayer...
Modern Combat 5 Gets a Major Multiplayer Update Posted by Jessica Fisher on September 2nd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Alien Creeps TD Review
Alien Creeps TD Review By Jennifer Allen on September 2nd, 2014 Our Rating: :: EXPENSIVE DEFENSESUniversal App - Designed for iPhone and iPad Alien Creeps TD would be a fun if unremarkable Tower Defense game, but its heavy focus on... | Read more »
The Journey Down: Chapter Two Review
The Journey Down: Chapter Two Review By Jennifer Allen on September 2nd, 2014 Our Rating: :: DARK YET ENTICINGUniversal App - Designed for iPhone and iPad It’s a little dark, in every sense of the word, but The Journey Down:... | Read more »
Function Space, a Social Network App for...
Function Space, a Social Network App for Science, Launches on iOS Posted by Ellis Spice on September 2nd, 2014 [ permalink ] | Read more »
Stupidfast – How Taylor Martinez Switche...
How do you make an Endless Running game more than just another Endless Running game? By adding real life prizes to it, of course! That’s the thinking behind StupidFast: a game designed for football enthusiasts, and the brainchild of former college... | Read more »
Little Raiders: Robin’s Revenge Review
Little Raiders: Robin’s Revenge Review By Jennifer Allen on September 2nd, 2014 Our Rating: :: CASUAL RAIDINGUniversal App - Designed for iPhone and iPad Combining simple combat with village building is a potent combination for... | Read more »
Treasure Tombs: Ra Deal Coming from Bulk...
Treasure Tombs: Ra Deal Coming from Bulkypix and Dark Tonic This Fall Posted by Jessica Fisher on September 2nd, 2014 [ permalink ] Dark Tonic and | Read more »
Pirate Bash Review
Pirate Bash Review By Nadia Oxford on September 2nd, 2014 Our Rating: :: BAD PIRATES, GOOD TIMESUniversal App - Designed for iPhone and iPad Pirate Bash’s turn-based battles add an intriguing twist to a typical physics game.   | Read more »
Tiny Tower Vegas Review
Tiny Tower Vegas Review By Jennifer Allen on September 2nd, 2014 Our Rating: :: STEADY DEVELOPMENTUniversal App - Designed for iPhone and iPad Build a huge tower again but Vegas-style in Tiny Tower Vegas.   | Read more »
The Manhattan Project Review
The Manhattan Project Review By Andrew Fisher on September 2nd, 2014 Our Rating: :: ROCKET SCIENCEUniversal App - Designed for iPhone and iPad The Manhattan Project offers a great Euro-style gameplay experience, but it is totally... | Read more »

Price Scanner via MacPrices.net

Apple refurbished iPads available for up to $...
Apple is offering Certified Refurbished iPad Airs for up to $140 off MSRP. Apple’s one-year warranty is included with each model, and shipping is free. Stock tends to come and go with some of these... Read more
Are We Now In The Post-Post-PC Era?
A longtime and thoroughgoing laptop aficionado, I was more than a little dismayed by Steve Jobs’s declaration back in 2010 when he sprang the iPad on an unsuspecting world. that we’d entered a “post-... Read more
PC Outlook Improves, But 2014 Shipments Still...
According to the International Data Corporation (IDC) Worldwide Quarterly PC Tracker, worldwide PC shipments are expected to fall by -3.7 percent in 2014. To hat’s actually an improvement from the... Read more
IDC Lowers Tablet Sales Projections for 2014...
Following a second consecutive quarter of softer than expected demand, International Data Corporation (IDC) has lowered its worldwide tablet plus 2-in-1 forecast for 2014 to 233.1 million units. The... Read more
Apple now offering refurbished 21-inch 1.4GHz...
The Apple Store is now offering Apple Certified Refurbished 21″ 1.4GHz iMacs for $929 including free shipping plus Apple’s standard one-year warranty. Their price is $170 off the cost of new models,... Read more
Save $50 on the 2.5GHz Mac mini, on sale for...
B&H Photo has the 2.5GHz Mac mini on sale for $549.99 including free shipping. That’s $50 off MSRP, and B&H will also include a free copy of Parallels Desktop software. NY sales tax only. Read more
Save up to $300 on an iMac with Apple refurbi...
The Apple Store has Apple Certified Refurbished iMacs available for up to $300 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free. These are the best prices on... Read more
The Rise of Phablets
Carlisle & Gallagher Consulting Group, a businesses and technology consulting firm focused solely on the financial services industry, has released an infographic depicting the convergence of... Read more
Bad Driver Database App Allows Good Drivers t...
Bad Driver Database 1.4 by Facile Group is a new iOS and Android app that lets users instantly input and see how many times a careless, reckless or just plain stupid driver has been added to the... Read more
Eddy – Cloud Music Player for iPhone/iPad Fre...
Ukraine based CapableBits announces the release of Eddy, its tiny, but smart and powerful cloud music player for iPhone and iPad that allows users to stream or download music directly from cloud... Read more

Jobs Board

*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
*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
*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
*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
Senior Event Manager, *Apple* Retail Market...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global event strategy. Delivering an overarching brand story; in-store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.