TweetFollow Us on Twitter

Shell Game: Calling Shell Commands from Applications, Part 2

Volume Number: 20 (2004)
Issue Number: 5
Column Tag: Programming

Mac OS X Programming Secrets

by Scott Knaster

Shell Game: Calling Shell Commands from Applications, Part 2

Well, I really hope you saw last month's column, because it was a fun introduction into how to call a shell command from a Cocoa application, which is a neat trick. If you didn't read that column, stick around anyway - we'll recap. This month, we'll extend our knowledge by performing input and output with a shell command from a Cocoa app.

Task Oriented

Last month, we explained how to use Cocoa class NSTask to represent a shell command that we want to execute. We discussed a few methods of NSTask:

setLaunchPath, which specifies the path to the shell command we call from our application.

setArguments, used to pass arguments to the shell command, which you normally do by typing them on the command line itself in Terminal.

launch, which starts the process running.

These methods get us the basic features we need to run a shell command from a Cocoa app. This time, we're going to take a broader look at what you can do with NSTask. When you create and launch a new task, it gets its own little world to run in. Part of this world includes its own copy of environment variables and its own setting for the current directory. NSTask has methods that let you specify these values. Call setEnvironment to change the process's environment variables to its own custom set, which you pass in as a dictionary. Use setCurrentDirectoryPath to pass a string indicating the directory the task should use as the base for relative paths.

When you call a shell command from Terminal, you can set paths for standard input, standard output, and standard error. These let you choose the source of input for the command, specify where the output should go, and indicate what to do with error messages. NSTask has methods for each of these: setStandardInput, setStandardOutput, and setStandardError. When you call these methods, you pass an object, either an NSPipe or an NSFileHandle, as the input or output. In the next section, we'll discuss what on earth these classes are.

Piece Pipe

NSFileHandle is a class that provides a Cocoa-licious way to exercise control over reading and writing files. NSPipe represents a Unix pipe, a communication channel that reads data from one process and writes it to another. In Cocoa, NSPipe is implemented using two NSFileHandles, one for reading and one for writing. You can use an NSPipe together with an NSTask to send data to a shell command's standard input and then get data from its standard output. As an example, we'll create a application that takes a list of words in an NSTextView and alphabetizes the words by calling the sort shell command. The alphabetized list is then displayed in a another NSTextView. This example is based on code from the course material for the awesome Big Nerd Ranch Cocoa Boot Camp (http://www.bignerdranch.com).


Figure 1. This is what our finished application will look like.

First, go to Xcode and create a new Cocoa Application project. We'll begin our app with the part that's easy to do and so hard to describe in text: the Interface Builder portion. In IB, in the main window, add two NSTextView objects, with a button between them. When you run this app, you'll type words in the first text view, then click the button, and the words will appear, sorted, in the second text view.

Now let's make the obligatory AppController class and object. Select NSObject on the Classes tab and choose Classes a Subclass NSObject. Name the new class AppController. Next, open the Info window (Tools a Show Info), go to the Attributes screen, and add two outlets (inText and outText) and one action (sort). Create the source files for Xcode by choosing Classes a Create Files for AppController. Finally, add an instance of your AppController class by choosing Classes a Instantiate AppController.

Now it's time to get our objects to partner up. We want AppController to be connected to both text views, one for input and the other for output. First, Control-drag from the AppController instance to the text view on the left. Double-click inText. Then Control-drag from the AppController to the text view on the right, and double-click outText to connect it. Finally, we need to make the button perform the sort method. Control-drag from the button to AppController, make sure you're on the Target/Action tab of the info window, then double-click sort. Bueno.


Figure 2. Lay out the user interface in Interface Builder, as usual.

Revealing the Code

Now it's time to write the code, so warm up your brain and your typing fingers. All our code will be the implementation for the sort method in AppController.m. First things first:

- (IBAction)sort:(id)sender
{
   NSTask *task;   
      // Task object that will call "sort"
   NSData *sortResult; 
      // Data object for grabbing sorted text
      
   NSFileHandle *fileToWrite;
      // Handle to standard input for pipe
   NSPipe *inputPipe, *outputPipe;
      // The pipes themselves, for input and output
   NSString *typedText;
      // Holds text typed by the user in the text view
   NSString *sortedText;
      // Will hold sorted text after user clicks button
   task = [[NSTask alloc] init];
   inputPipe = [[NSPipe alloc] init];
   outputPipe = [[NSPipe alloc] init];
      // Don't forget to release these later

After declaring and initializing variables, it's time to get the sort command going. We need to create a task and tell it that it's going to execute sort, set up its other values, then send it out into the world, like so:

   [task setLaunchPath:@"/usr/bin/sort"];
      // Set the path to the executable. You can find
      // the path for a shell command by using the
      // command "which" in Terminal, e.g. "which sort".
   [task setStandardOutput: outputPipe];
   [task setStandardInput: inputPipe];
      // Set the standard input and standard output
      // for the task. By assigning these to pipes,
      // we can feed input to the task and read its output.
   [task setArguments: [NSArray arrayWithObject:@"-f"]];
      // Set the arguments for sort. We're setting one
      // argument, -f, which specifies a case-insensitive
      // sort (you know, the way humans like it).
   
   [task launch];
      // The task is all ready to go - start it up!

Now that sort is ready to run, it's time for us to supply it with something to sort. We'll take the text the user has typed into the view on the left and ship it off to the process, using a pipe:

   fileToWrite = [inputPipe fileHandleForWriting];
      // Get a handle to the pipe that we can use
      // for writing.
   typedText = [inText string];
      // Extract the text out of the
      // first text view (inText).
   [fileToWrite writeData:[
      typedText dataUsingEncoding: NSASCIIStringEncoding]];
      // We've got the text out of the field. Now turn around
      // and write it to the task's standard input as ASCII.
      // Mmm...ASCII.
   [fileToWrite closeFile];
      // Close the pipe when we're done writing.

The sort command can now execute, using the text we've written to its standard input. The command proceeds to do its sorting on the input, then writes the sorted result to standard output. We previously hooked up standard output to outputPipe, so now we can deal with the sorted text:

   sortResult = 
    [[outputPipe fileHandleForReading] readDataToEndOfFile];
      // Grab the sorted text by getting a handle for reading
      // the pipe, then read all the data.
   sortedText = [[NSString alloc] initWithData: sortResult
                           encoding: NSASCIIStringEncoding];
      // Encode the text as ASCII and put the result into 
      // sortedText.
   [outText setString: sortedText];
      // Copy the string into the outText view (the one
      // on the right).

At this point, we're basically finished - the sorted text appears in the text view on the right. But just like Mom said, we need to clean up before we're completely done.

   [sortedText release];
   [task release];
   [inputPipe release];
   [outputPipe release];

All About the Process

Now that you've seen how to wrap a shell command in a Cocoa application, you can use shell commands as you need them in your apps. As we saw in this month's installment, you don't have to show any sign of the underlying command if you don't want to - just get control of standard input and standard output, and you can keep the shell command hidden.

For fun projects that use this technique, try writing apps that wrap your own favorite shell commands. Or, for extra credit, you could write a Cocoa app that lets the user type any shell command and its arguments, then executes that command and shows its output. Whatever you do, remember that it's your computer -- you're in command!


Scott Knaster writes all sorts of stuff for all kinds of people to read, but nothing is more fun than messing around with Cocoa and OS X. Scott's latest book is Mac Toys, from Wiley Publishing. Scott eats a nutritious assortment of fruits and vegetables.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

SpamSieve 2.9.38 - Robust spam filter fo...
SpamSieve is a robust spam filter for major email clients that uses powerful Bayesian spam filtering. SpamSieve understands what your spam looks like in order to block it all, but also learns what... Read more
TeamViewer 15.0.8397 - Establish remote...
TeamViewer gives you remote control of any computer or Mac over the Internet within seconds or can be used for online meetings. Find out why more than 200 million users trust TeamViewer! Free for non... Read more
SteerMouse 5.4.3 - Powerful third-party...
SteerMouse is an advanced driver for USB and Bluetooth mice. SteerMouse can assign various functions to buttons that Apple's software does not allow, including double-clicks, modifier clicks,... Read more
Toast Titanium 18.2.1 - The ultimate med...
Roxio Toast Titanium, the leading DVD burner for Mac, makes burning even better, adding Roxio Secure Burn to protect your files on disc and USB in Mac- or Windows-compatible formats. Get more style... Read more
HoudahSpot 5.0.11 - Advanced file-search...
HoudahSpot is a versatile desktop search tool. Use HoudahSpot to locate hard-to-find files and keep frequently used files within reach. HoudahSpot will immediately feel familiar. It works just the... Read more
ClipGrab 3.8.6 - Download videos from Yo...
ClipGrab is a free downloader and converter for YouTube, Vimeo, Facebook and many other online video sites. It converts downloaded videos to MPEG4, MP3 or other formats in just one easy step Version... Read more
ExpanDrive 7.4.0 - Access cloud storage...
ExpanDrive builds cloud storage in every application, acts just like a USB drive plugged into your Mac. With ExpanDrive, you can securely access any remote file server directly from the Finder or... Read more
Adobe Dreamweaver CC 2020 20.0 - Build w...
Dreamweaver CC 2020 is available as part of Adobe Creative Cloud for as little as $20.99/month (or $9.99/month if you're a previous Dreamweaver customer). Adobe Dreamweaver CC 2020 allows you to... Read more
Eye Candy 7.2.3.85 - 30 professional Pho...
Eye Candy renders realistic effects that are difficult or impossible to achieve in Photoshop alone, such as Fire, Chrome, and the new Lightning. Effects like Animal Fur, Smoke, and Reptile Skin are... Read more
Sparkle Pro 2.8.5 - Visual website creat...
Sparkle Pro will change your mind if you thought building websites wasn't for you. Sparkle is the intuitive site builder that lets you create sites for your online portfolio, team or band pages, or... Read more

Latest Forum Discussions

See All

Pre-register for Hello Kitty AR: Kawaii...
Hello Kitty — the cute cat that launched a multi-billion-pound franchise — has been brought to life… sort of. Sanrio has teamed up with the Bublar Group to create a new mobile game that uses AR tech to turn the real world into Hello Kitty’s... | Read more »
Gorgeous and tranquil puzzler Spring Fal...
One-man indie studio SPARSE//GameDev has now launched its tranquil puzzler, Spring Falls. It's described as "a peaceful puzzle game about water, erosion, and watching things grow". [Read more] | Read more »
Black Desert Mobile gets an official rel...
Pearl Abyss has just announced that its highly-anticipated MMO, Black Desert Mobile, will launch globally for iOS and Android on December 11th. [Read more] | Read more »
Another Eden receives new a episode, cha...
Another Eden, WFS' popular RPG, has received another update that brings new story content to the game alongside a few new heroes to discover. [Read more] | Read more »
Overdox guide - Tips and tricks for begi...
Overdox is a clever battle royale that changes things up by adding MOBA mechanics and melee combat to the mix. This new hybrid game can be quite a bit to take in at first, so we’ve put together a list of tips to help you get a leg up on the... | Read more »
Roterra Extreme - Great Escape is a pers...
Roterra Extreme – Great Escape has been described by developers Dig-It Games as a mini-sequel to their acclaimed title Roterra: Flip the Fairytale. It continues that game's tradition of messing with which way is up, tasking you with solving... | Read more »
Hearthstone: Battlegrounds open beta lau...
Remember earlier this year when auto battlers were the latest hotness? We had Auto Chess, DOTA Underlords, Chess Rush, and more all gunning for our attention. They all had their own reasons to play, but, at least from where I'm standing, most... | Read more »
The House of Da Vinci 2 gets a new gamep...
The House of Da Vinci launched all the way back in 2017. Now, developer Blue Brain Games is gearing up to deliver a second dose of The Room-inspired puzzling. Some fresh details have now emerged, alongside the game's first official trailer. [Read... | Read more »
Shoot 'em up action awaits in Battl...
BattleBrew Productions has just introduced another entry into its award winning, barrelpunk inspired, BattleSky Brigade series. Whilst its previous title BattleSky Brigade TapTap provided fans with idle town building gameplay, this time the... | Read more »
Arcade classic R-Type Dimensions EX blas...
If you're a long time fan of shmups and have been looking for something to play lately, Tozai Games may have just released an ideal game for you on iOS. R-Type Dimensions EX brings the first R-Type and its sequel to iOS devices. [Read more] | Read more »

Price Scanner via MacPrices.net

13″ 2.4GHz MacBook Pros available for up to $...
Apple has a full line of Certified Refurbished 2019 13″ 2.4GHz 4-Core Touch Bar MacBook Pros available starting at $1529 and up to $300 off MSRP. Apple’s one-year warranty is included, shipping is... Read more
New at T-Mobile: Switch to T-Mobile, and get...
T-Mobile is offering a free 64GB iPhone 8 for new customers who switch to T-Mobile and open a new line of service. Eligible trade-in required, and discount applied over a 24 month period. The fine... Read more
Xfinity Mobile’s Black Friday Apple savings:...
Take $250 off the purchase of any iPhone at Xfinity Mobile with a new line activation, and transfer of phone number to Xfinity Mobile, through December 8, 2019. This includes Apple’s new iPhone 11... Read more
2019 13″ 1.4GHz MacBook Pros available starti...
Apple has a full line of Certified Refurbished 2019 13″ 1.4GHz 4-Core Touch Bar MacBook Pros available starting at $1099 and up to $230 off MSRP. Apple’s one-year warranty is included, shipping is... Read more
Save up to $350 on a 21″ or 27″ iMac with the...
Apple has Certified Refurbished 2019 21″ & 27″ iMacs available starting at $929 and up to $350 off the cost of new models. Apple’s one-year warranty is standard, shipping is free, and each iMac... Read more
Early Holiday 2019 Sale: B&H again offers...
B&H Photo has 10.2″ iPads on sale again for $30 off Apple’s MSRP, starting at $299, as part of their early Holiday 2019 sale. Overnight shipping is free to many addresses in the US: – 10.2″ 32GB... Read more
Apple iMacs on sale today at B&H Photo fo...
B&H Photo has new 2019 21″ and 27″ 5K iMacs on stock today and on sale for up to $150 off Apple’s MSRP. Overnight shipping is free to many locations in the US. These are the same iMacs sold by... Read more
2018 4 and 6-Core Mac minis on sale today for...
Apple resellers are offering new 2018 4-Core and 6-Core Mac minis for $80-$100 off MSRP for a limited time. B&H Photo has the new 2018 4-Core and 6-Core Mac minis on sale for up to $100 off Apple... Read more
Early Holiday 2019 sale at B&H Photo: 12....
B&H Photo has new 12.9″ iPad Pros on sale for up to $120 off Apple’s MSRP as part of their early Holiday 2019 sale. Overnight shipping is free to many addresses in the US: – 12.9″ 64GB WiFi iPad... Read more
8-Core iMac Pro on sale today for $4499 at B...
B&H Photo has the base 8-Core 3.2GHz 32GB/1TB iMac Pro on sale today for $4499 — $500 off Apple’s MSRP. Shipping is free. Their price is the lowest available for a new iMac Pro from any Apple... Read more

Jobs Board

*Apple* Health Benefit Specialist - Call Cen...
Description ** Apple Health Benefit Specialist - Call Center (MAS 3/MACSC)** **Olympia, WA Multiple Positions** *The ideal candidate for this position will have Read more
Hair Stylist - *Apple* Blossom Mall - JCPen...
Hair Stylist - Apple Blossom Mall Location:Winchester, VA, United States- Apple Blossom Mall 1850 Apple Blossom Dr Job ID:1065040Salon Professionals Job Read more
*Apple* Mobility Pro - Best Buy (United Stat...
**747088BR** **Job Title:** Apple Mobility Pro **Job Category:** Store Associates **Store NUmber or Department:** 000297-Reston-Store **Job Description:** At Best Read more
Nurse Practitioner - Field Based (San Bernard...
Nurse Practitioner - Field Based (San Bernardino, CA, Apple Valley, Hesperia) **Location:** **United States** **Requisition #:** PS30312 **Post Date:** Nov 11, 2019 Read more
Best Buy *Apple* Computing Master - Best Bu...
**747061BR** **Job Title:** Best Buy Apple Computing Master **Job Category:** Store Associates **Store NUmber or Department:** 000647-Kildeer-Store **Job Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.