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

How to become the ultimate robot warrior...
Chrono Strike is a delightfully immersive beat ‘em up with a sense of humor (any game with a good Sims reference gets points in my book). [Read more] | Read more »
Tips and tricks to get a higher score in...
Snow Roll is a devilish endless runner very much in the vein of Flappy Bird. It revels in its dastardly level of difficulty, and doesn’t really care how angry you get at it as it knows you’ll keep coming back for more. [Read more] | Read more »
How to win big in Slots Deluxe
Cheating while gambling is illegal and morally wrong, and in some parts of the world it leads to men with names like Vinnie "Six Knuckles" Manchenzo beating you to a pulp in a dark alley. [Read more] | Read more »
How to take over the world in Dictator 2
Running a country isn't easy - especially when you're a dictator who wants to take over the world and crush everyone in your path while you do it. [Read more] | Read more »
Tips and tricks to get a higher score in...
Tank.iois - you guessed it! - another multiplayer arena battler likeAgar.io and Slither.io. It does differentiate itself by putting you in a tiny tank though, so it's not exactly the same. To help you get that all-important high score, we've got a... | Read more »
How to unlock characters in One Tap Tenn...
As the title suggests, One Tap Tennis requires only a single tap to play its particular brand of tennis, and rewards you with a ton of unlockable characters if you perform well. Fortunately for you, we at 148Apps have got a few tips and tricks to... | Read more »
Grab it now: Game Craft’s Legend of War...
The real time strategy game is now available for you to sink your teeth into, through the App Store and Google Play. Combining elements of skill, strategy and empire building, Legend of War is a real gamers’ game. [Read more] | Read more »
Skateboard Party 3 ft. Greg Lutzka (Gam...
Skateboard Party 3 ft. Greg Lutzka 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Skateboard Party is back! This third edition of the popular sports franchise features professional skater... | Read more »
Cubious (Games)
Cubious 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: Cubious – How smart are you? How high is your IQube? Solve the impossible puzzles to find out, and help a lost little cube find his... | Read more »
Goat Simulator Waste of Space (Games)
Goat Simulator Waste of Space 1.1 Device: iOS Universal Category: Games Price: $4.99, Version: 1.1 (iTunes) Description: ** IMPORTANT - SUPPORTED DEVICESiPhone 4S, iPad 2, iPod Touch 5 or better.** | Read more »

Price Scanner via MacPrices.net

Enterprise Workers Pick Technology Over Perks...
New Adobe study shows surprising attitudes about office jobs and where the future of work is heading. Adobe has released survey findings revealing that a surprising 70 percent of U.S. office workers... Read more
Memorial Day Weekend Sale: $50-$100 off 11-in...
B&H Photo has 13″ and 11″ MacBook Airs with 256GB SSDs on sale for $50-$100 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 11″ 1.6GHz/256GB MacBook Air: $999 $100 off MSRP... Read more
Memorial Day Weekend Sales: Apple MacBook Pro...
B&H Photo has 13″ and 15″ Retina MacBook Pros on sale for up to $210 off MSRP. Shipping is free, and B&H charges NY tax only: - 15″ 2.2GHz Retina MacBook Pro: $1799 $200 off MSRP - 15″ 2.5GHz... Read more
Memorial Day Weekend Sales: Apple iMacs and M...
Take up to $150 off the price of a new iMac or Mac mini at the following Apple resellers this Memorial Day weekend: iMacs: B&H Photo has 21″ and 27″ iMacs on sale for up to $150 off MSRP... Read more
Apple refurbished Retina MacBook Pros availab...
Apple has Certified Refurbished 2015 13″ and 15″ Retina MacBook Pros available for up to $380 off the cost of new models. An Apple one-year warranty is included with each model, and shipping is free... Read more
Apple refurbished 11-inch MacBook Airs availa...
Apple has Certified Refurbished 11″ MacBook Airs (the latest models), available for up to $170 off the cost of new models. An Apple one-year warranty is included with each MacBook, and shipping is... Read more
Goal Zero and OtterBox Partner to Expand iPh...
Goal Zero, specialists in portable power, have announced a partnership with OtterBox, brand smartphone case protection, to offer the Slide and Slide Plus Batteries as modules compatible with the new... Read more
15-inch Retina MacBook Pros on sale for up to...
B&H Photo has 15″ Retina MacBook Pros on sale for up to $210 off MSRP. Shipping is free, and B&H charges NY tax only: - 15″ 2.2GHz Retina MacBook Pro: $1799 $200 off MSRP - 15″ 2.5GHz Retina... Read more
Clearance 2015 13-inch MacBook Airs available...
B&H Photo has clearance 2015 13″ MacBook Airs available for $250 off original MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 1.6GHz/4GB/128GB MacBook Air (MJVE2LL/A): $799... Read more
Apple refurbished Apple TVs available for up...
Apple has Certified Refurbished 32GB and 64GB Apple TVs available for up to $30 off the cost of new models. Apple’s standard one-year warranty is included with each model, and shipping is free: -... Read more

Jobs Board

*Apple* Solutions Consultant - APPLE (United...
Job Summary As an Apple Solutions Consultant, you'll be the link between our future customers and our products. You'll showcase your entrepreneurial spirit as you Read more
*Apple* Project Engineer - Smart Source Inc...
SmartSource is in need of an Apple Project Engineer for a 12 month contract opportunity in Pittsburg, PA. Role: Apple Project Engineer Location: Pittsburg, PA Read more
Automotive Sales Consultant - Apple Ford Linc...
…you. The best candidates are smart, technologically savvy and are customer focused. Apple Ford Lincoln Apple Valley is different, because: $30,000 annual salary Read more
Service Assistant - *Apple* Chevrolet *App...
Apple Automotive is one of the fastest growing dealer...and it shows. Consider making the switch to the Apple Automotive Group today! At Apple Automotive, we Read more
Editor, *Apple* News - APPLE (United States...
Job Summary The Apple News team is looking for a passionate and knowledgeable editor with experience covering entertainment/pop culture and experience running social Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.