TweetFollow Us on Twitter

Jan 02 MacOSX

Volume Number: 18 (2002)
Issue Number: 01
Column Tag: Mac OS X

Smart Quotes

by ©2001 Andrew C. Stone. All Rights Reserved.

Adding automated curly quotes to Cocoa's Text system

Cocoa's Text System architecture is open, open-ended, and contains hooks for easy behavior modification. Because Cocoa Text is a unicode based system, it is by default international and lets your applications work correctly in a variety of scripts and languages. This article will teach you how to inspect the user's typed stream of keys, and convert straight quotes to open and closed curly quotes as the user types:

"Love is ‘THE' answer," she said.

Remembering all the modifier keys to create a curly quote is troublesome for end users, so we'll add the functionality to replace the boring straight quotes with fancy curly ones as they type. We'll also include a mechanism to "toggle through" the various options for those odd border cases, such as words beginning with a quote: 'Tis.

The Unicode

Cocoa's Text system relies on Unicode which allows each character in most standard font to be mapped to a unique short integer, a "unichar" defined in NSString.h:

typedef unsigned short unichar;

For example, each glyph in the Symbol font and Dingbats font are represented by unicode characters. The HTML standard also allows use of unicode characters, and here are the Unicode and HTML codes (which correspond to the unicode value) for curly quotes:

Character Unicode HTML Name How to type in manually
" 8220 “ double open quote Option-[
' 8216 ‘ single open quote Option-]
" 8221 ” double close Option-Shift-[
' 8217 ’ single close Option-Shift-]

Now that we know what will replace the straight quotes, we need a strategy for determining if a quote should be open or closed! It turns out that a very simple heuristic will work:

if character typed is a Straight Quote then

If it's the first character or is preceded by whitespace, turn it into Open Curly Quote

       else turn it into Close Curly Quote

So, when a newline, tab or space precedes a quote, it's probably an open quote. Note that this fails with ‘Tis! So, let's refine our heuristic to include a mechanism to "move through" the options straight, open and closed if the user has the quote in question solely selected:

if character typed is ‘ or " then

if selection contains a  single quote of any style,  replace with the next style in a loop (straight -> 
open -> closed -> straight and so on)

    else

If it's the first character or is preceded by whitespace, turn into Open Quote (single or double)

       else turn it into Close Quote

We have one more feature to add - the user should be able to DIRECTLY type in a straight quote when fancy quotes are enabled. We'll let them do this by changing any typed fancy quote to its straight counterpart (see How to type in manually in table above).

The Hook

One aspect of Cocoa that reigns supreme is the ease in which functionality can added, as well as the many different approaches that can be taken to accomplish the same task.

Where you put code depends on your architectural design. While you can always override a class, it's often easier to simply look at the "Delegate Methods" defined in various classes. These methods are optional: if an object, such as a text view, has a delegate, and that delegate implements one of these methods, then that method will be called at the appropriate time by the text view. If you overrode "keyDown" in NSTextView in a subclass, your text wouldn't swap the quotes on pasted text, since pasting does not call keyDown! So, instead we'll use this NSTextView delegate method that gets called anytime text is inserted either via keys or paste:

- (BOOL)textView:(NSTextView *)textView shouldChangeTextInRange:(NSRange)affectedCharRange 
replacementString:(NSString *)replacementString;

    // Delegate only.  If characters are changing, replacementString is what will replace the 
    affectedCharRange.  If attributes only are changing, replacementString will be nil.

This delegate method will work for us since we are only replacing single characters with another single character. If I had designed this method, instead of returning a boolean, I would have had this method return the actual new string to be inserted. Working with the method the way it is, we'll simply brute force stick in the character of our choice and return NO.

The Code

// Code is always more readable if you can turn the magic numbers into English!
#define SINGLE_QUOTE      ‘\''
#define SINGLE_OPEN_QUOTE   8216
#define SINGLE_CLOSE_QUOTE   8217
#define DOUBLE_QUOTE      ‘"‘
#define DOUBLE_OPEN_QUOTE   8220
#define DOUBLE_CLOSE_QUOTE   8221

// Smart Quote support - in our NSTextView's delegate class, we implement this method
// Be sure to connect the TextView's delegate outlet to your custom delegate class in Interface Builder
// or use  [myTextView setDelegate:self]; in your delegate class so this gets called:

- (BOOL)textView:(NSTextView *)textView shouldChangeTextInRange:(NSRange)affectedCharRange 
replacementString:(NSString *)replacementString;

    // Delegate only.  If characters are changing, replacementString is what will replace the 
    affectedCharRange.  If attributes only are changing, replacementString will be nil.
{

   // if we're just changing text attributes then we don't enter our processing loop
   // Also, provide a defaults mechanism to turn this fancy quoting off:
   
    if (replacementString && [[NSUserDefaults standardUserDefaults]boolForKey:SmartQuotes]) {
    
       // This is what is in our text object before anything is added:
        NSString *text = [[textView textStorage] string];
   
      // We want to know if we are at the very first character:
        unsigned int textLength = [text length];
   
      // how much are  we actually adding at this time:
        unsigned int i, length = [replacementString length];
        unichar c;
   
      // Should we change the string, we'll use this mutable string to hold the new values:
      // If it's non-nil when we get done, that means we've got work to do!
        NSMutableString *s = nil;
            
       // First, our toggle through mechanism:
        // special case: one char typed OVER a smart quote -> toggle them around 3 way
        // plain -> open -> closed -> plain
        // First deal with the case where they want another type of quote or a plain quote!
        if (length == 1 &&  affectedCharRange.length == 1) {
   
            if (((c = [text characterAtIndex:affectedCharRange.location])==DOUBLE_OPEN_QUOTE) || 
            (c == SINGLE_OPEN_QUOTE)) {
                // they had an open quote -> make it a closed one
                s = [NSString stringWithFormat:@"%C", c == DOUBLE_OPEN_QUOTE ? 
                DOUBLE_CLOSE_QUOTE : SINGLE_CLOSE_QUOTE];
      
            } else if (c == DOUBLE_CLOSE_QUOTE || c == SINGLE_CLOSE_QUOTE) {
                // they had a closed quote -> make it plain
                s = [NSString stringWithFormat:@"%C", c == DOUBLE_CLOSE_QUOTE  ? 
                DOUBLE_QUOTE : SINGLE_QUOTE];
      
            } else if (c == SINGLE_QUOTE || c == DOUBLE_QUOTE) {
             // they had a straight quote -> make it open
                 s = [NSString stringWithFormat:@"%C", c == SINGLE_QUOTE  ?  
                 SINGLE_OPEN_QUOTE : DOUBLE_OPEN_QUOTE];
           }
        } else {
   
        // otherwise go through replacement string one by one - paste can put in many characters at 
        one time!
            NSCharacterSet *startSet = [NSCharacterSet whitespaceAndNewlineCharacterSet];
            for (i = 0; i < length; i++) {
       
                unichar theChar = [replacementString characterAtIndex:i];
                unichar previousChar;
                
            // Find out the character which preceeds this one - context is everything!
                if(i == 0) {
                    if (affectedCharRange.location == 0 || textLength==0) previousChar = 0; 
                    // first char
                    else previousChar = [text characterAtIndex:affectedCharRange.location - 1];
                } else previousChar = [replacementString characterAtIndex:i-1];
                
            // When we encounter a straight quote, we decide whether it should be open or closed:
                if ((theChar == SINGLE_QUOTE) || (theChar == DOUBLE_QUOTE)){
      
               // lazily allocate the mutable string if we find something interesting
                    if (!s) s = [NSMutableString stringWithString:replacementString]; 
                    
                    if (previousChar == 0 || [startSet characterIsMember:previousChar] || 
                    (previousChar == DOUBLE_OPEN_QUOTE && theChar == SINGLE_QUOTE) || 
                    (previousChar == SINGLE_OPEN_QUOTE && theChar == DOUBLE_QUOTE))
                        c =  (theChar  == SINGLE_QUOTE  ?  SINGLE_OPEN_QUOTE : DOUBLE_OPEN_QUOTE);
                    else c =  (theChar  == SINGLE_QUOTE  ?  SINGLE_CLOSE_QUOTE : DOUBLE_CLOSE_QUOTE);
                    
                    [s replaceCharactersInRange:NSMakeRange(i,1) 
                    withString:[NSString stringWithFormat:@"%C", c]];
          
                } else if ((i==0) && (length == 1)) {
      
                    // we don't want to do this unless they are typing - paste may contain curly's 
                    already!
                    // reverse the meaning - they want to type in a plain one from the keyboard 
                    directly:
          
                    if ((theChar == SINGLE_CLOSE_QUOTE) || (theChar == SINGLE_OPEN_QUOTE)) {
                            s = [NSMutableString stringWithFormat:@"%C", SINGLE_QUOTE];
                    } else if ((theChar == DOUBLE_CLOSE_QUOTE) || (theChar == DOUBLE_OPEN_QUOTE)) {
                            s = [NSMutableString stringWithFormat:@"%C", DOUBLE_QUOTE];
                    }
                }
                        
            }
        }
        if (s) {
                // We'll be responsible for inserting the changed text ourselves
            // ideally, this method would return the string desired, but it doesn't
            // so we'll just pop the changes in directly ourselves:
                [[textView textStorage] replaceCharactersInRange:affectedCharRange withString:s];
                return NO;               
        }
    }
    // Otherwise, let the text system insert the text as typed...
    return YES;
}

Conclusion

The Cocoa Text system is easy to use and very extensible in a straightforward manner. An improvement you might consider for this smart quoting technique is to allow for internationalization. For example, in Germany, the open quote is along the text baseline, and other languages might use ‹› or other characters for quoting. To accomplish this, you would use NSLocalizedStringFromTable() and create an entry in the .strings file for each of the quotes in the languages that you support - refer to my article on Localization in MacTech a few months back for more information.


Andrew Stone, CEO of Stone Design, www.stone.com, has been coding in Cocoa as an independent software developer for over 13 years.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Duplicate Annihilator 5.7.5 - Find and d...
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... Read more
BusyContacts 1.0.2 - Fast, efficient con...
BusyContacts is a contact manager for OS X that makes creating, finding, and managing contacts faster and more efficient. It brings to contact management the same power, flexibility, and sharing... Read more
Capture One Pro 8.2.0.82 - RAW workflow...
Capture One Pro 8 is a professional RAW converter offering you ultimate image quality with accurate colors and incredible detail from more than 300 high-end cameras -- straight out of the box. It... Read more
Backblaze 4.0.0.872 - 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
Little Snitch 3.5.2 - Alerts you about o...
Little Snitch gives you control over your private outgoing data. Track background activity As soon as your computer connects to the Internet, applications often have permission to send any... Read more
Monolingual 1.6.4 - Remove unwanted OS X...
Monolingual is a program for removing unnecesary language resources from OS X, in order to reclaim several hundred megabytes of disk space. If you use your computer in only one (human) language, you... Read more
CleanApp 5.0 - Application deinstaller a...
CleanApp is an application deinstaller and archiver.... Your hard drive gets fuller day by day, but do you know why? CleanApp 5 provides you with insights how to reclaim disk space. There are... Read more
Fantastical 2.0 - Create calendar events...
Fantastical is the Mac calendar you'll actually enjoy using. Creating an event with Fantastical is quick, easy, and fun: Open Fantastical with a single click or keystroke Type in your event details... Read more
Cocktail 8.2 - General maintenance and o...
Cocktail is a general purpose utility for OS X that lets you clean, repair and optimize your Mac. It is a powerful digital toolset that helps hundreds of thousands of Mac users around the world get... Read more
Direct Mail 4.0.4 - Create and send grea...
Direct Mail is an easy-to-use, fully-featured email marketing app purpose-built for OS X. It lets you create and send great looking email campaigns. Start your newsletter by selecting from a gallery... Read more

Fast & Furious: Legacy's Creati...
| Read more »
N-Fusion and 505's Ember is Totally...
| Read more »
These are All the Apple Watch Apps and G...
The Apple Watch is less than a month from hitting store shelves, and once you get your hands on it you're probably going to want some apps and games to install. Fear not! We've compiled a list of all the Apple Watch apps and games we've been able to... | Read more »
Appy to Have Known You - Lee Hamlet Look...
Being at 148Apps these past 2 years has been an awesome experience that has taught me a great deal, and working with such a great team has been a privilege. Thank you to Rob Rich, and to both Rob LeFebvre and Jeff Scott before him, for helping me... | Read more »
Hands-On With Allstar Heroes - A Promisi...
Let’s get this out of the way quickly. Allstar Heroes looks a lot like a certain other recent action RPG release, but it turns out that while it’s not yet available here, Allstar Heroes has been around for much longer than that other title. Now that... | Read more »
Macho Man and Steve Austin Join the Rank...
WWE Immortals, by Warner Bros. Interactive Entertainment and WWE, has gotten a superstar update. You'll now have access to Macho Man Randy Savage and Steve Austin. Both characters have two different versions: Macho Man Randy Savage Renegade or Macho... | Read more »
Fearless Fantasy is Fantastic for the iF...
I actually had my first look at Fearless Fantasy last year at E3, but it was on a PC so there wasn't much for me to talk about. But now that I've been able to play with a pre-release version of the iOS build, there's quite a bit for me to talk... | Read more »
MLB Manager 2015 (Games)
MLB Manager 2015 5.0.14 Device: iOS Universal Category: Games Price: $4.99, Version: 5.0.14 (iTunes) Description: Guide your favorite MLB franchise to glory! MLB Manager 2015, officially licensed by MLB.com and based on the award-... | Read more »
Breath of Light (Games)
Breath of Light 1.0.1421 Device: iOS Universal Category: Games Price: $2.99, Version: 1.0.1421 (iTunes) Description: Hold a quiet moment. Breath of Light is a meditative and beautiful puzzle game with a hypnotic soundtrack by... | Read more »
WWE WrestleMania Tags into the App Store
Are You ready to rumble? The official WWE WrestleMania app, by World Wrestling Entertainment, is now available. Now you can get all your WrestleMania info in one place before anyone else. The app offers details on superstar signings, interactive... | Read more »

Price Scanner via MacPrices.net

13-inch 2.5GHz MacBook Pro (refurbished) avai...
The Apple Store has Apple Certified Refurbished 13″ 2.5GHz MacBook Pros available for $829, or $270 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free: - 13″ 2.... Read more
Save up to $80 on iPad Air 2s, NY tax only, f...
 B&H Photo has iPad Air 2s on sale for $80 off MSRP including free shipping plus NY sales tax only: - 16GB iPad Air 2 WiFi: $469.99 $30 off - 64GB iPad Air 2 WiFi: $549.99 $50 off - 128GB iPad... Read more
iMacs on sale for up to $205 off MSRP
B&H Photo has 21″ and 27″ iMacs on sale for up to $205 off MSRP including free shipping plus NY sales tax only: - 21″ 1.4GHz iMac: $1019 $80 off - 21″ 2.7GHz iMac: $1189 $110 off - 21″ 2.9GHz... Read more
Färbe Technik Offers iPhone Battery Charge LI...
Färbe Technik, which manufactures and markets of mobile accessories for Apple, Blackberry and Samsung mobile devices, is offering tips on how to keep your iPhone charged while in the field: •... Read more
Electronic Recyclers International CEO Urges...
Citing a recent story on CNBC about concerns some security professionals have about the forthcoming Apple Watch, John Shegerian, Chairman and CEO of Electronic Recyclers International (ERI), the... Read more
Save up to $380 with Apple refurbished iMacs
The Apple Store has Apple Certified Refurbished iMacs available for up to $380 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free: - 27″ 3.5GHz 5K iMac – $2119 $... Read more
Mac minis on sale for up to $75 off, starting...
MacMall has Mac minis on sale for up to $75 off MSRP including free shipping. Their prices are the lowest available for these models from any reseller: - 1.4GHz Mac mini: $459.99 $40 off - 2.6GHz Mac... Read more
College Student Deals: Additional $50 off Mac...
Take an additional $50 off all MacBooks and iMacs at Best Buy Online with their College Students Deals Savings, valid through April 11, 2015. Anyone with a valid .EDU email address can take advantage... Read more
Mac Pros on sale for up to $260 off MSRP
B&H Photo has Mac Pros on sale for up to $260 off MSRP. Shipping is free, and B&H charges sales tax in NY only: - 3.7GHz 4-core Mac Pro: $2799, $200 off MSRP - 3.5GHz 6-core Mac Pro: $3719.99... Read more
13-inch 2.5GHz MacBook Pro on sale for $100 o...
B&H Photo has the 13″ 2.5GHz MacBook Pro on sale for $999 including free shipping plus NY sales tax only. Their price is $100 off MSRP. Read more

Jobs Board

DevOps Software Engineer - *Apple* Pay, iOS...
**Job Summary** Imagine what you could do here. At Apple , great ideas have a way of becoming great products, services, and customer experiences very quickly. Bring 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
Sr. Technical Services Consultant, *Apple*...
**Job Summary** Apple Professional Services (APS) has an opening for a senior technical position that contributes to Apple 's efforts for strategic and transactional Read more
Lead *Apple* Solutions Consultant - Retail...
**Job Summary** Job Summary The Lead ASC is an Apple employee who serves as the Apple business manager and influencer in a hyper-business critical Reseller's store Read more
*Apple* Pay - Site Reliability Engineer - Ap...
**Job Summary** Imagine what you could do here. At Apple , great ideas have a way of becoming great products, services, and customer experiences very quickly. Bring Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.