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

X Lossless Decoder 20141129a - Encode, t...
X Lossless Decoder (XLD) is a tool for OS X that is able to decode/convert/play various 'lossless' audio files. The supported audio files can be split into some tracks with cue sheet when decoding... Read more
Mariner Write 3.9.4 - Light-weight and s...
Mariner Write is your Mac OS go-to word processing tool! Professional writer, educator or student, Write has all the functionality you need for that important letter, technical paper or research... Read more
Google Chrome 45.0.2454.85 - Modern and...
Google Chrome is a Web browser by Google, created to be a modern platform for Web pages and applications. It utilizes very fast loading of Web pages and has a V8 engine, which is a custom built... Read more
Apple Pro Video Formats 2.0.2 - Updates...
Apple Pro Video Formats brings updates to Apple's professional-level codes for Final Cut Pro X, Motion 5, and Compressor 4. Version 2.0.2: Includes support for the following professional video codecs... Read more
Apple Final Cut Pro X 10.2.2 - Professio...
Apple Final Cut Pro X is a professional video editing solution.Completely redesigned from the ground up, Final Cut Pro adds extraordinary speed, quality, and flexibility to every part of the post-... Read more
Apple Compressor 4.2.1 - Adds power and...
Compressor adds power and flexibility to Final Cut Pro X export. Customize output settings, work faster with distributed encoding, and tap into a comprehensive set of delivery features. Powerful... Read more
Apple Motion 5.2.2 - Create and customiz...
Apple Motion is designed for video editors, Motion 5 lets you customize Final Cut Pro titles, transitions, and effects. Or create your own dazzling animations in 2D or 3D space, with real-time... Read more
Posterino 3.2.2 - Create posters, collag...
Posterino offers enhanced customization and flexibility including a variety of new, stylish templates featuring grids of identical or odd-sized image boxes. You can customize the size and shape of... Read more
A Better Finder Rename 10.00b1 - File, p...
A Better Finder Rename is the most complete renaming solution available on the market today. That's why, since 1996, tens of thousands of hobbyists, professionals and businesses depend on A Better... Read more
CrossOver 14.1.6 - Run Windows apps on y...
CrossOver can get your Windows productivity applications and PC games up and running on your Mac quickly and easily. CrossOver runs the Windows software that you need on Mac at home, in the office,... Read more

Spirit Hunter is an Upcoming Collectible...
Boomlagoon, the team behind hybrid CCG/runner Monsu, has announced their newest project: a collectible card game/action RPG named Spirit Hunter. [Read more] | Read more »
Zen Brush 2 (Entertainment)
Zen Brush 2 1.0 Device: iOS Universal Category: Entertainment Price: $2.99, Version: 1.0 (iTunes) Description: Zen Brush 2 is a drawing app focused on the strong yet beautiful feel of the East Asian ink brush. | Read more »
NetNewsWire (News)
NetNewsWire 4.0.0 Device: iOS iPhone Category: News Price: $3.99, Version: 4.0.0 (iTunes) Description: Follow the Web NetNewsWire 4, completely written from the ground up for iPhone. NetNewsWire is the best way to keep up with the... | Read more »
Huzzah! Farming Simulator 16 Supports Cl...
As though it weren't difficult enough to resist the siren call of Farming Simulator 16, now it's been updated with cloud saves - so you can jump between devices without missing any of that precious crop-harvesting time. [Read more] | Read more »
Don't Starve: Pocket Edition Finall...
I've made no effort to hide my enjoyment of Don't Starve: Pocket Edition, but I will admit I was a tiny bit disappointed that it was only available for the iPad. Well nuts to that, because Klei Entertainment has made it universal! [Read more] | Read more »
Goat Simulator Wasn't Enough? Then...
If you just didn't get enough goat in Goat Simulator - or if you've been wanting to play a simulated MMO as a microwave - then you're in luck! Goat Simulator MMO Simulator is out now, and it's a game about simulated goats in simulated MMOs. Plus... | Read more »
You Can Play Madfinger Games' Unkil...
Madfinger Games - probably best known for the Dead Trigger series - has officially launched their newest zombie shooter (that isn't called Dead Trigger), named Unkilled. [Read more] | Read more »
KORG iELECTRIBE for iPhone (Music)
KORG iELECTRIBE for iPhone 1.0.1 Device: iOS iPhone Category: Music Price: $9.99, Version: 1.0.1 (iTunes) Description: ** 50% OFF Special Launch Sale - For a Limited Time **The ELECTRIBE reborn in an even smaller form A full-fledged... | Read more »
Toca Life: City Just Got a Bunch of New...
Toca Life: City is Toca Boca's most popular app (number 1 in 47 different countries, apparently), and it's just had an update that adds a bunch of new content. [Read more] | Read more »
My Country 3D is More About Cities than...
My Country 3D is an upcoming city builder from Game Insight that looks pretty decent - although the name seems a tad out of whack for a city builder. Ah well, it is what it is. [Read more] | Read more »

Price Scanner via MacPrices.net

DEVONthink and Co. 40% Off For Students And E...
Students and teachers are either preparing for the new semester or are already back in school. And the better organized they are the easier it is for them to concentrate on what’s really important:... Read more
Labor Day Weekend Sale: MacBook Air for up to...
Best Buy has MacBook Airs on sale for up to $150 off MSRP on their online store this weekend. Choose free shipping or free local store pickup (if available). Sale prices for online orders only, in-... Read more
BassJump Subwoofer for MacBook Refreshed...
Twelve South has released a software update for BassJump, their portable subwoofer for Macbook. BassJump 3.0 has a radically redesigned interface, and the software refresh makes the BassJump... Read more
Near-Office Input Functionality Virtually Any...
Today Logitech introduced the Logitech K380 Multi-Device Bluetooth Keyboard and the Logitech M535 Bluetooth Mouse, giving users the freedom to work on any device, most anywhere. According to... Read more
College Student Deals: Additional $100 off Ma...
Take an additional $100 off all MacBooks and iMacs at Best Buy Online with their College Students Deals Savings, valid through September 4, 2015. Anyone with a valid .EDU email address can take... Read more
2.8GHz Mac mini available for $988, includes...
Adorama has the 2.8GHz Mac mini available for $988, $11 off MSRP, including a free copy of Apple’s 3-Year AppleCare Protection Plan. Shipping is free, and Adorama charges sales tax in NY & NJ... Read more
Will You Buy An iPad Pro? – The ‘Book Mystiqu...
It looks like we may not have to wait much longer to see what finally materializes as a new, larger-panel iPad (Pro/Plus?) Usually reliable Apple product prognosticator KGI Securities analyst Ming-... Read more
eFileCabinet Announces SMB Document Managemen...
Electronic document management (EDM) eFileCabinet, Inc., a hosted solutions provider for small to medium businesses, has announced that its SecureDrawer and eFileCabinet Online services will be... Read more
WaterField Designs Unveils American-Made, All...
San Francisco’s WaterField Designs today unveiled their all-leather Cozmo 2.0 — an elegant attach laptop bag with carefully-designed features to suit any business environment. The Cozmo 2.0 is... Read more
Apple’s 2015 Back to School promotion: Free B...
Purchase a new Mac or iPad at The Apple Store for Education and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free,... 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
Content Partner Engineer - *Apple* TV - App...
**Job Summary** The Apple TV team is looking for an experienced engineer with a passion for delivering first in class home entertainment solutions. The candidate will Read more
*Apple* Desktop Analyst - KDS Staffing (Unit...
…field and consistent professional recruiting achievement. Job Description: Title: Apple Desktop AnalystPosition Type: Full-time PermanentLocation: White Plains, NYHot Read more
*Apple* Retail - Multiple Customer Support P...
Job Description: Customer Support Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the Read more
*Apple* Desktop Analyst - KDS Staffing (Unit...
…field and consistent professional recruiting achievement. Job Description: Title: Apple Desktop AnalystPosition Type: Full-time PermanentLocation: White Plains, NYHot Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.