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

TunnelBear 4.0.2 - 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
Kodi 18.9 - Powerful media center tool f...
Kodi (was XBMC) is an award-winning free and open-source (GPL) software media player and entertainment hub that can be installed on Linux, OS X, Windows, iOS, and Android, featuring a 10-foot user... Read more
Iridient Developer 3.4.1 - Powerful imag...
Iridient Developer (was RAW Developer) is a powerful image-conversion application designed specifically for OS X. Iridient Developer gives advanced photographers total control over every aspect of... Read more
Vallum 3.3.4 - $15.00
Vallum is a little tool that helps you monitor and block apps connections and throttle apps bandwidth. It is able to intercept connections at the application layer, and hold them while you decide... Read more
DiskCatalogMaker 8.2.6 - Catalog your di...
DiskCatalogMaker is a simple disk management tool which catalogs disks. Simple, light-weight, and fast Finder-like intuitive look and feel Super-fast search algorithm Can compress catalog data for... Read more
SoftRAID 5.8.4 - High-quality RAID manag...
SoftRAID allows you to create and manage disk arrays to increase performance and reliability. SoftRAID allows the user to create and manage RAID 4 and 5 volumes, RAID 1+0, and RAID 1 (Mirror) and... Read more
Audio Hijack 3.7.3 - Record and enhance...
Audio Hijack (was 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... Read more
CleanMyMac X 4.6.15 - Delete files that...
CleanMyMac makes space for the things you love. Sporting a range of ingenious new features, CleanMyMac lets you safely and intelligently scan and clean your entire system, delete large, unused files... Read more
Suitcase Fusion 21.2.1 - Font management...
Suitcase Fusion is the creative professional's font manager. Every professional font manager should deliver the basics: spectacular previews, powerful search tools, and efficient font organization.... Read more
Civilization VI 1.3.6 - Next iteration o...
Civilization® VI is the award-winning experience. Expand your empire across the map, advance your culture, and compete against history’s greatest leaders to build a civilization that will stand the... Read more

Latest Forum Discussions

See All

Mulled 2 is a refreshingly simple ball-p...
Some of the greatest mobile games are actually the simplest ones, and it’s this philosophy that Mulled 2 was built on. Out now for iOS and Android, the puzzle sequel takes the accessible mechanics of its predecessor and builds on them with enticing... | Read more »
Physics-based tower defense game Goblin...
Indie developer Arif Games has released Goblin Raiders on iOS and Android. [Read more] | Read more »
PUBG Mobile has provided yet another upd...
PUBG Mobile has been making a point of publicly mentioning all of their ongoing efforts to vanquish cheating from the popular battle royale. Today two teams within the company have provided updates on their progress. [Read more] | Read more »
Zombieland: AFK Survival is celebrating...
Zombieland: AFK Survival is currently celebrating its one-year anniversary. If you don't quite recognise the name that's because it initially launched as Zombieland: Double Tapper. Anyway, the game is celebrating turning one with two Halloween-... | Read more »
Distract Yourself With These Great Mobil...
There’s a lot going on right now, and I don’t really feel like trying to write some kind of pithy intro for it. All I’ll say is lots of people have been coming together and helping each other in small ways, and I’m choosing to focus on that as I... | Read more »
Genshin Impact Guide - Gacha Strategy: W...
If you're playing Genshin Impact without spending money, you'll always need to be looking for ways to optimize your play to maximize rewards without getting stuck in a position where you're tempted to spend. The most obvious trap here is the game'... | Read more »
Genshin Impact Adventurer's Guide
Hello and well met, fellow adventurers of Teyvat! Check out our all-in-one resource for all things Genshin Impact. We'll be sure to add more as we keep playing the game, so be sure to come back here to check for updates! [Read more] | Read more »
Genshin Impact Currency Guide - What...
Genshin Impact is great fun, but make no mistake: this is a gacha game. It is designed specifically to suck away time and money from you, and one of the ways the game does this is by offering a drip-feed of currencies you will feel compelled to... | Read more »
XCOM 2 Collection on iOS now available f...
The XCOM 2 Collection, which was recently announced to be coming to iOS in November, is now available to pre-order on the App Store. [Read more] | Read more »
Presidents Run has returned for the 2020...
IKIN's popular endless runner Presidents Run has returned to iOS and Android just in time for the 2020 election season. It will see players choosing their favourite candidate and guiding them on a literal run for presidency to gather as many votes... | Read more »

Price Scanner via MacPrices.net

Amazon issues $50-$71 instant discount on all...
Amazon has new 2020 Apple 11″ iPad Pros on sale for $50-$70 off Apple’s MSRP. These are the same iPad Pros sold by Apple in its retail and online stores. Be sure to select Amazon as the seller,... Read more
B&H Photo offers early Black Friday prici...
B&H Photo has Apple AirPods on sale for as little as $129 and up to $50 off MSRP for a limited time. Expedited shipping is free to many addresses in the US: – AirPods with Charging Case: $129.99... Read more
Get a 13″ 2.0GHz MacBook Pro for $300 off MSR...
Apple has a full line of Certified Refurbished 2020 13″ 2.0GHz 4-Core Touch Bar MacBook Pros, with 10th generation Intel processors, available starting at $1529 and up to $300 off MSRP. Apple’s one-... Read more
Apple’s 16″ MacBook Pros are back in stock st...
Apple has Certified Refurbished 2019 16″ MacBook Pros back in stock for up to $420 off the cost of new models, starting at $2039. Each model features a new outer case, shipping is free, and an Apple... Read more
Use our exclusive iPhone Price Trackers to fi...
Looking for a new Apple iPhone 12 or 12 Pro? Perhaps a deal on last year’s iPhone 11? Check out our iPhone Price Tracker here at MacPrices.net. We track new and clearance iPhone prices from Apple as... Read more
Weekend deal: $100 off 13″ MacBook Airs at Am...
Amazon has new 2020 13″ MacBook Airs on sale for $100 off Apple’s MSRP, starting at only $899. Their prices are the lowest available for new MacBooks from any Apple resellers. These are the same 13″... Read more
New 10.9″ 64GB Apple iPad Air on sale for $55...
Amazon has Apple’s new 2020 10.9″ 64GB WiFi iPad Air on sale today for $549.99 shipped. That’s $40 off MSRP. Pre-orders are available today at this discounted price, and Amazon states that the iPad... Read more
Get a clearance 2019 27″ 5K iMac for up to $5...
Apple has Certified Refurbished 2019 27″ 5K iMacs available starting at $1439 and up to $520 off their original MSRP. Apple’s one-year warranty is standard and shipping is free. The following... Read more
AT&T offers the Apple iPhone 11 for $10/m...
AT&T is offering Apple’s 64GB iPhone 11 for $10 per month, for customers opening a new line of service, no trade-in required. Discount is applied via monthly bill credits over a 30 month period.... Read more
Apple’s 2020 11″ iPad Pros on sale today for...
Apple reseller Expercom has new 2020 11″ Apple iPad Pros on sale for $50-$75 off MSRP, with prices starting at $749. These are the same iPad Pros sold by Apple in their retail and online stores: – 11... Read more

Jobs Board

Geek Squad *Apple* Consultation Professiona...
**789134BR** **Job Title:** Geek Squad Apple Consultation Professional **Job Category:** Store Associates **Store Number or Department:** 000554-Boca Raton-Store Read more
*Apple* Mobility Specialist - Best Buy (Unit...
**787854BR** **Job Title:** Apple Mobility Specialist **Job Category:** Store Associates **Store Number or Department:** 001764-Downingtown-Store **Job Read more
*Apple* Mac, Windows & Mobile Device Sup...
Apple Mac, Windows & Mobile Device Support Engineer at created 30-Sep-2020"/> Skip to content **Xerox** at https://xerox.avature.net/en_US/careers Menu ** Apple Read more
Freelance Features Writer ( *Apple* Products...
…interested in iOS, watchOS, iPadOS, macOS? Do you like to explain and teach Apple products to other people with less understanding? If these things sound like you, Read more
Geek Squad *Apple* Consultation Professiona...
**788452BR** **Job Title:** Geek Squad Apple Consultation Professional **Job Category:** Store Associates **Store Number or Department:** 000401-Southland Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.