TweetFollow Us on Twitter

May 02 Cover Story

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

DOCtor - Wrapping UNIX CLI's into GUIs

by Andrew Stone

With OS X comes a wealth of UNIX command line programs to accomplish all sorts of tasks. Wrapping these CLI's into a graphical user interface that Mac users expect and even demand can quickly turn this fortune into usable programs. This month I'll provide the complete source to the graphical user interface and CLI glue for "DOCtor" - an application to convert Microsoft Word .doc documents into Mac OS X viewable PDF. Although this program calls the UNIX executable "antiword", it provides a framework skeleton which could be used on any executable. You will learn how to:

  • modify UNIX programs to work in a GUI
  • launch and log the output of a UNIX program
  • accept drag and drops on a window
  • communicate with another program via its API
  • extend NSFilemanager via categories
  • open URLs programmatically

Full source code to both DOCtor and antiword is available at our web site at: http://www.stone.com/DOCtor/DOCtor.tar.gz.

Is There a DOCtor in the House?

Proprietary file formats are annoying and almost useless to the ever-growing number of people who refuse to use this class of software. The GNU (GNU means "GNU Not UNIX", recursively) community is a diverse, global collection of forward thinking programmers who produce code that is protected under the GNU Foundation's "Copyleft". Instead of taking away the user's rights, it guarantees that others can copy and use the code, as long they continue to give it away complete and free.

When the PStill™ engine author, Frank Siegert, informed me of the antiword project, I thought it would be useful to add a GUI and more functionality to this UNIX program. Antiword converts Word documents into PostScript. While PS can be printed, it cannot be viewed directly under Mac OS X. DOCtor calls PStill's published application programmer's interface (API) to distill the PS into PDF. It then passes the PDF to another program for display. If Stone Design's Create® is installed, DOCtor will show the file in Create; otherwise, it will use the user's default PDF viewer (Preview, for example).

Call the DOCtor!

The design of a GUI for a UNIX executable is really a task of mapping the possible parameters of the command line program to user interface elements. Here's the output from running antiword from the command line without any parameters:

[ibis:AntiWord/DOCtor/antiword] andrew% ./antiword 
   Name: antiword
   Purpose: Display MS-Word files
   Author: (C) 1998-2001 Adri van Os
   Version: 0.32  (05 Oct 2001)
   Status: GNU General Public License
   Usage: antiword [switches] wordfile1 [wordfile2 ...]
   Switches: [-t|-p papersize][-m mapping][-w #][-i #][-X #][-Ls]
         -t text output (default)
         -p <paper size name> PostScript output
               like: a4, letter or legal
         -m <mapping> character mapping file
         -w <width> in characters of text output
         -i <level> image level (PostScript only)
         -X <encoding> character set (Postscript only)
         -L use landscape mode (PostScript only)
         -s Show hidden (by Word) text

First, decide which parameters are relevant. We're not interested in the parameters that apply to a simple text translation of the document; we want the flags for PostScript output. Second, decide which parameters the program should support. We will let the user specify the paper type ( -p) and orientation (-L), but leave image level (-i) and character set (-X) for future enhancements. Third, decide how to display the options. I often choose to simplify the interface by hiding expert options in drawers. This way, the "easy" interface is simple and clean, but experts have the options at their fingertips:


The good DOCtor's interface is simple — but exposes more options for the expert in the drawer

The Classes and Their Responsibilities

The DOCtor is composed of 3 "brain" classes, 2 user interface subclasses, and 2 category extensions. The basic design is a central controller that coordinates the user interface with the antiword process.

The Brain Classes: DRController, ConversionJob and SDLogTask

The mapping between the user interface and antiword is handled by our NSApplication's delegate class, DRController. DRController is responsible for accepting input from the UI, handling drag and drops, and providing feedback on the process to the user. It also manages what happens after antiword has successfully translated the .doc into PostScript, including calling the PStill™ API.

Each translation job is represented by an instance of ConversionJob - this neatly wraps up the options into the instance variables of this class. ConversionJob's responsibilities are to create an argument array and launch and monitor the antiword UNIX process. ConversionJob also determines what files can be translated - note the use of NSFileTypeForHFSTypeCode(‘WDBN') which allows WORD files without a ".doc" extension to be correctly identified as a WORD document.

The SDLogTask is a reusable wrapper on NSTask that simplifies the calling of a CLI, as well as providing any output from the running of the program to the console window, if its visible. It's a standard addition to many of the Stone applications.

The User Interface Classes: EasyWindow and DragFromWell

The main conversion window is an instance of EasyWindow - a subclass of NSWindow that handles the drag and drop of .doc files. The reason we subclass window is to get cursor change feedback whenever the user drags a relevant file over any part of the window, including the title bar. Instead of including program specific knowledge in this class, EasyWindow asks the NSApp's delegate, DRController to both determine which files are acceptable and what gets done when the file is dropped. This is a good strategy for reuse of UI components - concentrate the logic in the controller, and make the UI components as versatile as possible.

When the file conversion is complete, an instance of DragFromWell, an NSImageWell subclass, displays the output file's icon. DragFromWell also allows you to copy the file to the desktop or other Finder location, as well as show you how to implement a "Reveal In Finder". Finally, it passes on "drags" to the window, so that all drag and drop code is centralized. The DragFromWell is also a standard Stone component.

Category Helpers

Categories are additional or replacement methods on an existing Objective C class. This language feature lets you add power to Apple's Frameworks, and are very suited to reuse.

NSFileManager(NSFileManager_Extensions) knows how to create writable folders, determine a suitable temporary folder, and hand out unique names based on a template, and is a standard addition to all of my applications.

NSFileHandle(CFRNonBlockingIO), written by Bill Bumgarner, provides some fixes and additions to the Foundation class NSFileHandle.

Making the Application Tile Accept Drags

The simplest way to use DOCtor is to drag a file onto the DOCtor's application icon in the Dock or Finder. By implementing one simple method in the NSApplication's delegate class, you add this functionality:

-(BOOL)application:(NSApplication *)sender openFile:(NSString *)path
{
  return [self convertAndOpenFile:path];
}

There is one more thing you have to do - set up the acceptable document types in Project Builder's Target inspector, Application Settings panel:


Setting the Document Types alerts Finder to what sorts of documents you can open

The Cool Stuff

Modifying antiword

I wanted to use the standard distribution of Adri van Os's antiword (http://www.winfield.demon.nl/index.html), as ported to Mac OS X by Ronaldo Nascimento. There was a glitch however: antiword expects its resource files to be in a certain location, which makes a simple installation difficult. I opted for minimal changes that wouldn't affect the base distribution. By adding a _macosx define in the makefile and redefining GLOBAL_ANTIWORD_DIR to "." (the current directory) in antiword.h, we add support for having the resource files local to the executable, wherever the user installs the application. In conjunction with this change, we also need to set an environment variable $HOME when calling antiword from SDLogTask:

   [[SDLogTask alloc]initAndLaunchWithArgs:[self arguments] 
      executable:[antiword 
      stringByAppendingPathComponent:@"antiword"]
      directory:antiword  logToText:[[NSApp delegate] logText]
      includeStandardOutput:NO  outFile:outputPath owner:self
      environment:[NSDictionary 
      dictionaryWithObjectsAndKeys:antiword, @"HOME",nil]];

For the most part, standard Unix executables will not require any code tweaking to be incorporated into your application.

Remote methods

Moving data between applications is pretty easy, and getting a quick connection to an application via low level mach calls can avoid the overhead of the extremely easy to use NSConnection method rootProxyForConnectionWithRegisteredName:. See lookupPStillDOServer() for usage of bootstrap_look_up() and connectionWithReceivePort:. Don't forget to assign the proxy its "knowledge":

// in order for a remote object to respond to methods, it needs to be told what it will respond to! 
[theProxy setProtocolForProxy:@protocol(PStillVended)];

Once you have this rootProxy connection with PStill, you can access the Objective C methods of the 
PStillVended protocol in PStill. For example to convert an eps  file to a pdf file:

   if ([theProxy convertFile:inputFile toPDFFile:outputFile deleteInput:NO])
      // success!

Then, to view the PDF, we first try the Stone Studio's Create - otherwise, we let NSWorkspace figure out the user's default application for viewing PDF:

   NSWorkspace *wm = [NSWorkspace sharedWorkspace];
   if (([[NSUserDefaults standardUserDefaults] boolForKey:@"DontOpenInCreate"]) || 
   ![wm openFile:pdfFile withApplication:@"Create" andDeactivate:YES]) {
      return [wm openFile:pdfFile];
   }

Also, note use of NSWorkspace's openURL: - this makes the launching of the user's favorite browser to a given URL "just work":

   [[NSWorkspace sharedWorkspace] openURL:[NSURL URLWithString:@"http://www.stone.com/"]];

The Code

antiword 0.32 diffs:

diff -r -C2 antiword.0.32/Makefile.MacOSX antiword.0.32-gui/Makefile.MacOSX
*** antiword.0.32/Makefile.MacOSX       Wed Oct 24 18:38:04 2001
—- antiword.0.32-gui/Makefile.MacOSX   Tue Nov 13 10:20:09 2001
***************
*** 9,13 ****
  DB    = NDEBUG
  # Optimization: -O<n> or debugging: -g
! OPT   = -O2
  
  LDLIBS        =
—- 9,13 ——
  DB    = NDEBUG
  # Optimization: -O<n> or debugging: -g
! OPT   = -O2 -D__macosx
  
  LDLIBS        =
diff -r -C2 antiword.0.32/antiword.h antiword.0.32-gui/antiword.h
*** antiword.0.32/antiword.h    Tue Sep 25 17:36:47 2001
—- antiword.0.32-gui/antiword.h        Tue Nov 13 10:18:34 2001
***************
*** 143,146 ****
—- 143,150 ——
  #define ANTIWORD_DIR                  "antiword"
  #define FONTNAMES_FILE                  "fontname.txt"
+ #elif defined(__macosx)
+ #define GLOBAL_ANTIWORD_DIR         "."
+ #define ANTIWORD_DIR                     "antiword"
+ #define FONTNAMES_FILE                  "fontnames"
  #else
  #define GLOBAL_ANTIWORD_DIR   "/opt/antiword/share"


////////  DRController.h  ///////

#import <Cocoa/Cocoa.h>

@interface DRController : NSObject
{
    IBOutlet id statusField;
    IBOutlet id well;
    IBOutlet id window;
    
    IBOutlet id portraitLandscapeMatrix;
    IBOutlet id paperSizePopUp;
    IBOutlet id openInCreateSwitch;
    
    IBOutlet id textLogView;   // the console
    
    IBOutlet id drawer;
    
    IBOutlet id tabView;   // GPL license and other help info
}

// exposed API for drag and drops:

- (BOOL)convertAndOpenFile:(NSString *)docFile;

// the callback after the antiword executable terminates:

- (void)taskTerminated:(BOOL)success outputFile:(NSString *)outpout;


// IB actions - open MainMenu.nib in IB to see what's connected to what:

// menu items:
- (IBAction)gotoStoneSite:(id)sender;
- (IBAction)showLogAction:(id)sender;
- (IBAction)showGPLAction:(id)sender;
- (IBAction)showSourceAction:(id)sender;
- (IBAction)showDOCtorSourceAction:(id)sender;


// ui items:

- (IBAction)changeOpenInCreateAction:(id)sender;
- (IBAction)toggleDrawer:(id)sender;

// our console text:
- (id)logText;

@end


////////  DRController.m  ///////

#import <Foundation/Foundation.h>
#import <AppKit/AppKit.h>
#import <stdio.h>
#import <mach/mach.h>
#import <servers/bootstrap.h>
#include <unistd.h>
#import "DRController.h"
#import "ConversionJob.h"
#import "NSFileManager-Extensions.h"
#import "DragFromWell.h"


// the first part of this file contains the routines needed to ask another Cocoa app
// to do something. In this case, we ask PStill to convert a PostScript file into PDF.

#define PStillFilterServer  ([NSString \
               stringWithFormat:@"PStillFilterServer-%@",\
               [[NSProcessInfo processInfo] hostName]])

@protocol PStillVended

// 0 = succes anything else = failure
// caller's responsibility to make sure outputFile is writeable and not
// existing!

- (int)convertFile:(NSString *)inputFile
    toPDFFile:(NSString *)outputFile deleteInput:(BOOL)deleteInput;

// you can also convert many files to one single PDF with this one:

- (int)convertFiles:(NSArray *)fullPathsToFiles
    toPDFFile:(NSString *)outputFile deleteInput:(BOOL)deleteInput;

// when licensing is done, this will return YES, otherwise NO

- (BOOL)applicationReadyForInput;

// for jobs to show a preview from a thread

- (void) showImageFile:(NSString *)file width:(int)width height:(int)height
    isEPS:(BOOL)isEPS rotation:(int)rotation pageNumber:(int)pageNumber;

@end

#define USAGE NSLog(@"This Print Filter requires PStill for Mac OS X by Stone Design and Frank Siegert. 
Visit www.stone.com to download and full information.")

#define WAKE_UP_WAIT   5

static id<PStillVended> lookupPStillDOServer(void) {
    port_t sendMachPort;
    NSDistantObject *rootProxy = nil;
    id<PStillVended> result;

    // First, try look up PStill;s DO object in the bootstrap server.
    // This is where the app registers it by default.
    if ((BOOTSTRAP_SUCCESS ==
    bootstrap_look_up(bootstrap_port,
            (char *)([PStillFilterServer cString]),
            &sendMachPort)) && (PORT_NULL != sendMachPort)) {
   NSConnection *conn = [NSConnection
               connectionWithReceivePort: [NSPort port]
               sendPort:[NSMachPort
               portWithMachPort:sendMachPort]];
   rootProxy = [conn rootProxy];
    }

    // If the previous call failed, the following might succeed if the user
    // logged in is running Terminal with the PublicDOServices user default
    // set.

    if (!rootProxy) {
   rootProxy = [NSConnection rootProxyForConnectionWithRegisteredName:
           PStillFilterServer host:@""];
    }

    // We could also try to launch PStill at this point, using
    // the NSWorkspace protocol.

    if (!rootProxy) {
   if (![[NSWorkspace sharedWorkspace] launchApplication:@"PStill"]) {
       USAGE;
       return nil;
   }
   sleep(WAKE_UP_WAIT);
   rootProxy = [NSConnection rootProxyForConnectionWithRegisteredName:PStillFilterServer host:@""];
    }

    if (!rootProxy) {
   fprintf(stderr,"Can't connect to PStill\n");
   return nil;
    }

    [rootProxy setProtocolForProxy:@protocol(PStillVended)];
    result = (id<PStillVended>)rootProxy;
    return result;
}

BOOL convertFiles(NSArray *inputFiles, NSString *outputFile) {
    id<PStillVended> theProxy = lookupPStillDOServer();
    // if we can't find it, bail:
    if (theProxy != nil) {
   // if she's not launched, we wait until she's licensed or they
   // give up on licensing:

   while (![theProxy applicationReadyForInput]) {
       [NSThread sleepUntilDate:[NSDate dateWithTimeIntervalSinceNow:0.1]];
   }

   if (([inputFiles count]==1 && [theProxy convertFile:[inputFiles objectAtIndex:0] 
   toPDFFile:outputFile
        deleteInput:NO] == 0)) {
       return YES;
   } else if ([theProxy convertFiles:inputFiles toPDFFile:outputFile
        deleteInput:NO]) {
       return YES;
        } else {
       NSLog(@"Couldn't convert %@",[inputFiles objectAtIndex:0]);
   }
    }
    else {
   NSLog(@"Couldn't connect to PStill");
    }
    return NO;
}

@implementation DRController


// Launching a URL in the user's favorite browser is this simple in Cocoa:

- (IBAction)gotoStoneSite:(id)sender {
    [[NSWorkspace sharedWorkspace] openURL:[NSURL URLWithString:@"http://www.stone.com/"]];
}

- (IBAction)showDOCtorSourceAction:(id)sender {
    [[NSWorkspace sharedWorkspace] openURL:[NSURL URLWithString:@"http://www.stone.com/DOCtor/"]];
}

// when the Application launches, set the state of the interface to match the user's preferences:

- (void)awakeFromNib {
    [openInCreateSwitch setState:![[NSUserDefaults standardUserDefaults] boolForKey:@"DontOpenInCreate"]];
}

- (IBAction)changeOpenInCreateAction:(id)sender;
{
     [[NSUserDefaults standardUserDefaults] setBool:![openInCreateSwitch state] 
     forKey:@"DontOpenInCreate"];
}

- (IBAction)showGPLAction:(id)sender {

// In Interface Builder, you can set the identifier on each tab view
// this allows you to programmatically select a given Tab:

   [tabView selectTabViewItemWithIdentifier:@"GPL"];
   
// Don't forget to order the window front in case it's hidden:

   [[tabView window] makeKeyAndOrderFront:self];
}


- (void)revealInFinder:(NSString *)path {
   BOOL isDir;
   if ([[NSFileManager defaultManager] fileExistsAtPath:path isDirectory:&isDir]) {
            if (isDir)
            [[NSWorkspace sharedWorkspace] selectFile:nil inFileViewerRootedAtPath:path];
            else
            [[NSWorkspace sharedWorkspace] selectFile:path inFileViewerRootedAtPath:nil];
   }
}

- (IBAction)showSourceAction:(id)sender {
    NSString *antiword = [[[NSBundle mainBundle]pathForResource:@"antiword" 
    ofType:@""]stringByAppendingPathComponent:@"antiword.0.32.tar.gz"];
    [self revealInFinder:antiword];
    
}

- (IBAction)toggleDrawer:(id)sender {
    if ([drawer state]== NSDrawerClosedState) [drawer openOnEdge:NSMinYEdge];
    else if ([drawer state] == NSDrawerOpenState) [drawer close:nil];
}

- (IBAction)showLogAction:(id)sender {
        [[textLogView window] makeKeyAndOrderFront:self];
}

// drag & drop routines
// a standard way to name output files, based on an input name:

- (NSString *)fileForInput:(NSString *)docFile extension:(NSString *)extension {
   NSFileManager *fm = [NSFileManager defaultManager];
    return [fm nextUniqueNameUsing:[[fm temporaryDirectory] 
    stringByAppendingPathComponent:[[[docFile lastPathComponent] 
    stringByDeletingPathExtension]stringByAppendingPathExtension:extension]]];
}

- (NSString *)psFileForDocFile:docFile {
   return [self fileForInput:docFile extension:@"ps"];
}

- (NSString *)pdfFileForDocFile:docFile {
   return [self fileForInput:docFile extension:@"pdf"];
}

- (BOOL)convertFile:(NSString *)docFile toFile:(NSString *)psFile {
   // call antiword with a ConversionJob instance:
      ConversionJob *job = [[ConversionJob allocWithZone:[self zone]] 
      initWithInputFile:(NSString *)docFile outputFile:(NSString *)psFile 
      landscape:[portraitLandscapeMatrix selectedTag] paperName:[paperSizePopUp titleOfSelectedItem]];

   // pending : QUEUES
   // we may go threaded later...

   return [job doExecution:self];

}


- (BOOL)openFile:(NSString *)pdfFile {
    NSWorkspace *wm = [NSWorkspace sharedWorkspace];
    if (([[NSUserDefaults standardUserDefaults] boolForKey:@"DontOpenInCreate"]) || 
    ![wm openFile:pdfFile withApplication:@"Create" andDeactivate:YES]) {
        return [wm openFile:pdfFile];
    }
    return NO;
}


// Ask PStill to do convert the file:

- (BOOL)pstillConvert:(NSString *)ps toFile:(NSString *)pdf {
    return convertFiles([NSArray arrayWithObject:ps], pdf);
}


// Once the job finishes, this is called - let's give the user some feedback:

- (void)taskTerminated:(BOOL)success outputFile:(NSString *)outpout {

    if (success) {
        NSString *pdfFile = [self pdfFileForDocFile:outpout];
        [well setFile:outpout];
        [statusField setStringValue:@"Success - click image to reveal in Finder"];
        
        // We have a valid PS file - let's begin the next step of translation to PDF:
        if ([self pstillConvert:outpout toFile:pdfFile]) {
        

                // success! Let's give some feedback and open the file:

                [well setFile:pdfFile];
                [self openFile:pdfFile];
        } else {
            [statusField setStringValue:@"PStill had trouble - see PStill's Log"];
        }


    } else {
        [well setFile:@""];
 
[statusField setStringValue:@"Converted failed - see Log!"];
    }
}

- (id)logText {
    return textLogView;
}


- (BOOL)convertAndOpenFile:(NSString *)docFile {
    NSString *psFile = [self psFileForDocFile:docFile];
    [self convertFile:docFile toFile:psFile];
    return YES;
}

// In order for your app to open files that are dragged upon the dock tile, you need to do two things
// 1. Implement - application: openFile: in your NSApplications's delegate class
// 2. In PB, specify valid Document Types in Target inspector, Application settings


- (BOOL)application:(NSApplication *)sender openFile:(NSString *)path
{
    return [self convertAndOpenFile:path];
}

@end


////////  ConversionJob.h  ///////
//
//  ConversionJob.h
//  DOCtor
//
//  Created by andrew on Thu Apr 12 2001.
//


typedef enum {
   ConversionNeedsInfo,
   ConversionReadyToBegin,
   ConversionBusy,
   ConversionDone,
   ConversionAborted,
   ConversionError
} ConversionStatus;

@interface ConversionJob: NSObject <NSCopying>
{
   NSString *inputPath;
   NSString *outputPath;
   NSString *statusString;    
        NSString *paperName;    
        BOOL _isLandscape;
   ConversionStatus conversionStatus;
}


// these class methods let the UI determine what can really be converted:
+ (NSArray *)convertibleFileTypes;
+ (BOOL)canConvertFile:(NSString *)path;

- (void)abort;

// this is ConversionJob's designated initializer:
- (id)initWithInputFile:(NSString *)docFile outputFile:(NSString *)psFile 
landscape:(BOOL)landscape paperName:(NSString *)paper;


// these represent the various paramters to a conversion:

- (void)setLandscape:(BOOL)bin;
- (BOOL)landscape;

- (NSArray *)arguments;
- (int)doExecution:(id)delegate;

- (NSString *)inputPath;
- (void)setInputPath:(NSString *)path;

- (NSString *)outputPath;
- (void)setOutputPath:(NSString *)path;
- (NSString *)validOutputPath;

- (NSString *)statusString;
- (void)setStatusString:(NSString *)status;

- (NSString *)paperName;
- (void)setPaperName:(NSString *)name;

- (ConversionStatus)conversionStatus;
- (void)setConversionStatus:(ConversionStatus)status;


extern NSString *JobStatusDidChangeNotification;

@end


////////  ConversionJob.m  ///////
//
//  ConversionJob.m
//  
//
//  Created by andrew on Thu Apr 12 2001.
// Andrew C. Stone and Stone Design Corp
//

#include <stdio.h>
#include <stdlib.h>
#import <Carbon/Carbon.h>

#import <Cocoa/Cocoa.h>
#import "NSFileManager-Extensions.h"

#import "ConversionJob.h"
#import "DRController.h"
#import "SDLogTask.h"

@implementation ConversionJob

NSString *JobStatusDidChangeNotification = @"JobStatusDidChange";

/*
        Usage: antiword [switches] wordfile1 [wordfile2 ...]
        Switches: [-t|-p papersize][-m mapping][-w #][-i #][-X #][-Ls]
                -t text output (default)
                -p <paper size name> PostScript output
                   like: a4, letter or legal
                -w <width> in characters of text output
    -i <level> image level (PostScript only)
    -m <mapping> character mapping file
    -X <encoding> character set (Postscript only)
                -L use landscape mode (PostScript only)
                -s Show hidden (by Word) text
*/

// We live in a world of both file extensions AND traditional Mac types - so let's look for both:

+ (NSArray *)convertibleFileTypes {
    return [NSArray arrayWithObjects:@"doc",@"DOC",NSFileTypeForHFSTypeCode(‘WDBN'),nil];
}

+ (BOOL)canConvertFile:(NSString *)path {
    NSString *extension = [path pathExtension];
    
    // IF there is no extension, let's see if there is a Mac Type:

    if (IS_NULL(extension)) extension = NSHFSTypeOfFile(path);
    
    if ([[self convertibleFileTypes] containsObject:extension]) return YES;
    return NO;
}


- (id)init {
    self = [super init];
    if (self) {
        inputPath = @"";
        outputPath = @"";
        statusString = @"";
        conversionStatus = ConversionNeedsInfo;
    }
    return self;
}

// the designated initializer

- (id)initWithInputFile:(NSString *)docFile outputFile:(NSString *)outpath 
landscape:(BOOL)landscape paperName:(NSString *)paper;
 {
    self = [self init];
    
    inputPath = [docFile copyWithZone:[self zone]];
    outputPath = [outpath copyWithZone:[self zone]];
    paperName = [paper copyWithZone:[self zone]];
    _isLandscape = landscape;
    return self;
}


// Don't Litter!

- (void)dealloc {
    [inputPath release];
    [outputPath release];
    [statusString release];
    [paperName release];
    [super dealloc];
}

// note that we do not copy status or status string!

- (id)copyWithZone:(NSZone *)zone {
    ConversionJob *newJob = [[ConversionJob allocWithZone:zone] init];
    [newJob setInputPath:inputPath];
    [newJob setOutputPath:outputPath];
    [newJob setPaperName:paperName];
    [newJob setLandscape:_isLandscape];
    return newJob;
}


// sets and gets

- (NSString *)paperName {
    return paperName;
}

- (void)setPaperName:(NSString *)path {
    if (![path isEqualToString:paperName]) {
        [paperName release];
        paperName = [path copyWithZone:[self zone]];
        [self setConversionStatus:ConversionReadyToBegin];
    }
}


- (void)setLandscape:(BOOL)bin {
   _isLandscape = bin;
}

- (BOOL)landscape {
    return _isLandscape;
}

- (NSString *)inputPath {
    return inputPath;
}


- (void)setInputPath:(NSString *)path {
    if (![path isEqualToString:inputPath]) {
        [inputPath release];
        inputPath = [path copyWithZone:[self zone]];
        [self setConversionStatus:ConversionReadyToBegin];
    }
}

- (NSString *)outputPath {
    return outputPath;
}

- (void)setOutputPath:(NSString *)path {
    if (![path isEqualToString:outputPath]) {
        [outputPath release];
        outputPath = [path copyWithZone:[self zone]];
    }
}

+ (BOOL)pathValid:(NSString *)path {
    BOOL isDir;
    return (NOT_NULL(path) && [[NSFileManager defaultManager] fileExistsAtPath:path 
    isDirectory:&isDir] && isDir && [[NSFileManager defaultManager] 
    isWritableFileAtPath:path]);
}

- (NSString *)defaultOutputFolder:(NSString *)nextToInput {
   return [[NSFileManager defaultManager] temporaryDirectory];
}

- (BOOL)canWriteTo:(NSString *)file {
    return [[NSFileManager defaultManager]isWritableFileAtPath:[file 
    stringByDeletingLastPathComponent]];
}


// This method will create a valid output path:

- (NSString *)validOutputPath {
    static int unique = 0;
    if (NOT_NULL(outputPath) && [self canWriteTo:outputPath]) return outputPath;    
    else {
        [self setOutputPath:[[[NSFileManager defaultManager] temporaryDirectory] 
        stringByAppendingPathComponent:[NSString stringWithFormat:@"%@_%d.%@",[[inputPath 
        lastPathComponent] stringByDeletingPathExtension],++unique,[inputPath pathExtension]]]];
   return outputPath;
    }
}

- (NSString *)statusString {
    if (NOT_NULL(statusString))
         return statusString;
    else {
        switch(conversionStatus) {
            case ConversionNeedsInfo:
                return NSLocalizedStringFromTable(@"Awaiting Input Font or Folder - drag one 
                on!",@"DOC",@"status string when info is still needed");
            case ConversionReadyToBegin:
                return NSLocalizedStringFromTable(@"Initializing Job",@"DOC",@"status string when 
                job starts");
            case ConversionBusy:
                return [NSString stringWithFormat:@"%@ %@...",
                NSLocalizedStringFromTable(@"Converting",@"DOC",@"status string when conversion is 
                happening"),[inputPath lastPathComponent]];
            case ConversionDone:
                return NSLocalizedStringFromTable(@"Conversion complete - drag it out!",@"DOC",@"status 
                string when conversion is done");
            case ConversionAborted:
                return NSLocalizedStringFromTable(@"Conversion was stopped",@"DOC",@"status string when 
                conversion is stopped");
       case ConversionError:
       default:
                   return NSLocalizedStringFromTable(@"ERROR! See Log...",@"DOC",@"status string when 
                   error converting");

        }
    }
}

- (void)abort {
// PENDING: kill the job!

    [self setConversionStatus:ConversionAborted];
}

- (void)setStatusString:(NSString *)status {
    if (![status isEqualToString:statusString]) {
   [statusString release];
        statusString = [status copyWithZone:[self zone]];
    }
}


- (ConversionStatus)conversionStatus {
   return conversionStatus;
}

- (void)setConversionStatus:(ConversionStatus)status {
    conversionStatus = status;
    [[NSNotificationCenter defaultCenter] postNotificationName:JobStatusDidChangeNotification 
    object:self];
}


- (NSArray *)arguments {
    NSMutableArray *args = [NSMutableArray array];

    [args addObject:@"-p"];
    [args addObject:paperName];
    
    if (_isLandscape)    [args addObject:@"-L"];

    [args addObject:inputPath];
    
// future options can be added here...

    return args;  
}

//
// Here is the callback from SDLogText
// We'll pass it on up to DRController
//

- (void)taskTerminated:(BOOL)success
{
    [[NSApp delegate] taskTerminated:success outputFile:outputPath];
}



- (int)doExecution:(id)delegate {
    volatile int statusAtCompletion = -1;
    
    // we place each execution inside of it's own NSAutoreleasePool

    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    // the actual executable is inside the folder ‘antiword'

    NSString *antiword = [[NSBundle mainBundle]pathForResource:@"antiword" ofType:@""];  
    // the folder!

    [self setConversionStatus:ConversionBusy];

    [self validOutputPath];


// Here's my groovy Task wrapper which logs errors:
// the one interesting variable is the dictionary passed into the environment:
// We need to set the HOME (where the resources will be sought by antiword)
// 

        [[SDLogTask alloc]initAndLaunchWithArgs:[self arguments] executable:[antiword 
        stringByAppendingPathComponent:@"antiword"]
                directory:antiword 
                    logToText:[[NSApp delegate] logText] includeStandardOutput:NO outFile:outputPath 
                    owner:self environment:[NSDictionary dictionaryWithObjectsAndKeys:antiword, 
                    @"HOME",nil]];
                             

     [pool release];

    return 1;
}


@end


////////  SDLogTask.h  ///////
/* SDLogTask.h created by andrew on Thu 30-Apr-1998 */
//
// A wrapper of some intense multi-threaded code
// To allow you to spawn a task and see the errors
//


#import <AppKit/AppKit.h>

@interface SDLogTask : NSObject
{
   id owner;
   NSTextView *logText;
   NSTask *task;
   BOOL includeStandardOutput;
        NSString *outFile;
   NSPipe *standardErrorPipe;
   NSPipe *standardOutputPipe;
   NSFileHandle *standardErrorHandle;
        NSFileHandle *standardOutputHandle;
        NSFileHandle *outputFileHandle;
}

//
// executable is full path to program
// args is an array of strings of the arguments
// send in an NSTextView if you want console behaviour
// includeStandardOut: is YES if you also want stdout logged to Text
//

- (id)initAndLaunchWithArgs:(NSArray *)args executable:(NSString *)pathToExe directory:(NSString *)dir 
logToText:(NSTextView *)text includeStandardOutput:(BOOL)includeStandardOut outFile:(NSString *)outFile 
owner:anOwner environment:(NSDictionary *)environment;


+ (void)appendString:(NSString *)string toText:(NSTextView *)tv newLine:(BOOL)newLine;

@end


////////  SDLogTask.m  ///////
//
/* SDLogTask.m created by andrew on Thu 30-Apr-1998 */


#import "SDLogTask.h"

// kudos to bbum@codefab.com for helping me fix IO:
#import "NSFileHandle_CFRNonBlockingIO.h"

//
// If you want notification when the task completes
// implement this method in the "owner" class
//

@interface NSObject(SDLogTask_Delegate)
- (void)taskTerminated:(BOOL)success;
@end

@implementation SDLogTask

- (void)dealloc
{
   if (outFile) [outFile release];
   [super dealloc];
}

//
// Methods to make it easy to spew feedback to user:
//

#define END_RANGE NSMakeRange([[tv string]length],0)
+ (void)appendString:(NSString *)string toText:(NSTextView *)tv newLine:(BOOL)newLine;
{
        [tv replaceCharactersInRange:END_RANGE withString:string];
        if (newLine)
                [tv replaceCharactersInRange:END_RANGE withString:@"\n"];
        else
                [tv replaceCharactersInRange:END_RANGE withString:@" "];

        if ([[tv window] isVisible]) {
                [tv scrollRangeToVisible:END_RANGE];
        }
}

- (void)appendString:(NSString *)string newLine:(BOOL)newLine
{
    [[self class] appendString:string toText:logText newLine:newLine];
 }

- (void)outputData:(NSData *)data
{
   [self appendString:[[[NSString alloc]initWithData:data encoding:[NSString defaultCStringEncoding]]
   autorelease] newLine:YES];
}


- (void) processAvailableData;
{
   NSData *data;
   BOOL dataProcessed;
NS_DURING
   dataProcessed = NO;
   data = [standardErrorHandle availableDataNonBlocking];
   if ( (data != nil) && ([data length] != 0) ) {
      [self outputData:data];
      dataProcessed = YES;
   }
NS_HANDLER
   dataProcessed = NO;
NS_ENDHANDLER

NS_DURING

   if (includeStandardOutput) {
      data = [standardOutputHandle availableDataNonBlocking];
      if ( (data != nil) && ([data length] != 0) ) {
         [self outputData:data];
         dataProcessed = YES;
      }
   }
NS_HANDLER
        dataProcessed = NO;
NS_ENDHANDLER


   if ([task isRunning] == YES) {
      if (dataProcessed == YES)
         [self performSelector: @selector(processAvailableData)
            withObject: nil afterDelay: .1];
        else
      [self performSelector: @selector(processAvailableData)
            withObject: nil afterDelay: 2.5];
   }
}


- (void) outputInfoAtStart:(NSString *)pathToExe args:(NSArray *)args
{
   int i;
   // clear it out from last time:
   //[logText setString:@""];

   [self appendString:pathToExe newLine:NO];
   for (i = 0; i < [args count]; i++)
      [self appendString:[args objectAtIndex:i] newLine:NO];
   [self appendString:@"\n" newLine:YES];
}

- initAndLaunchWithArgs:(NSArray *)args executable:(NSString *)pathToExe directory:(NSString *)dir 
logToText:(NSTextView *)text includeStandardOutput:(BOOL)includeStandardOut 
outFile:(NSString *)anOutFile owner:anOwner environment:(NSDictionary *)environment
{

   [super init];
   logText = text;
        includeStandardOutput = includeStandardOut;
        outFile = [anOutFile copy];
   owner = anOwner;

   standardErrorPipe = [NSPipe pipe];
   standardErrorHandle =  [standardErrorPipe fileHandleForReading];

        if ((outFile!=nil) && ![outFile isEqualToString:@""]) {
            [[NSFileManager defaultManager] removeFileAtPath:outFile  handler:nil];
            if ([[NSFileManager defaultManager] createFileAtPath:outFile  contents:[NSData data] 
            attributes:nil])
            outputFileHandle = [NSFileHandle fileHandleForWritingAtPath:outFile];
            else {
                NSLog(@"Cannot open %@! Aborting...",outFile);
                if ([owner respondsToSelector:@selector(taskTerminated:)])
                        [owner taskTerminated:0];
      return nil;
            }
        }else if (includeStandardOutput) {
            standardOutputPipe = [NSPipe pipe];
            standardOutputHandle =   [standardOutputPipe fileHandleForReading];

        } 
   task = [[NSTask alloc] init];

        [task setArguments:args];
   [task setCurrentDirectoryPath:dir];
        [task setLaunchPath:pathToExe];

   [task setStandardError:standardErrorPipe];

   if (environment != nil) [task setEnvironment:environment];

        if (outputFileHandle != nil) [task setStandardOutput:outputFileHandle];
   else if (includeStandardOutput) [task setStandardOutput:standardOutputPipe];

        [self outputInfoAtStart:pathToExe args:args];

   [self performSelector: @selector(processAvailableData) withObject: nil afterDelay: 1.0];
   
   // HERE WE GO: spin off a thread to do this:
   [task launch];

   [[NSNotificationCenter defaultCenter]
      addObserver: self
      selector: @selector(checkATaskStatus:)
      name: NSTaskDidTerminateNotification
      object: task];
   return self;

}

#define TASK_SUCCEEDED NSLocalizedStringFromTable(@"Job SUCCEEDED!\n", @"PackIt", "message when task is 
successful")

#define TASK_FAILED NSLocalizedStringFromTable(@"Job FAILED!\nPlease see log.", @"PackIt", "when the 
task fails...")


- (void)checkATaskStatus:(NSNotification *)aNotification
{
   int status = [[aNotification object] terminationStatus];
   if (status == 0 /* STANDARD SILLY UNIX RETURN VALUE */) {
      [self appendString:TASK_SUCCEEDED newLine:YES];
   }   else {
      [self appendString:TASK_FAILED newLine:YES];
      [[logText window] orderFront:self];
   }
        if (outputFileHandle != nil)
      [outputFileHandle release];    // this will close it according to docs

   if ([owner respondsToSelector:@selector(taskTerminated:)])
      [owner taskTerminated:(status == 0)];
}

@end

Diagnosis

As of this writing, antiword's -i and -X flags are not supported - this would be a nice enhancement for DOCtor to be able to specify alternate encodings and the level of PS compliance. Another useful addition would be to provide a simple text translation using the -t option, as well as having the UI process folders of files instead of just one at a time.

One of Cocoa's great strengths is the ability to quickly wrap traditional command line programs into mere mortal usable graphical user interfaces — I wrote DOCtor in an afternoon, reusing some standard Stone components.


Andrew Stone andrew@stone.com is founder of Stone Design Corp http://www.stone.com/ and divides his time between farming on the earth and in cyperspace.

 
AAPL
$103.30
Apple Inc.
+0.80
MSFT
$45.09
Microsoft Corpora
-0.34
GOOG
$577.33
Google Inc.
+5.73

MacTech Search:
Community Search:

Software Updates via MacUpdate

TextSoap 7.4.0 - Flexible text editing u...
TextSoap is for people who work with text. TextSoap effortlessly cleans up text from endlessly different formats. Wash away unwanted characters, spaces, tabs. Fix paragraphs with hard returns at the... Read more
NetShade 6.0.2 - Browse privately using...
NetShade is an Internet security tool that conceals your IP address on the web. NetShade routes your Web connection through either a public anonymous proxy server, or one of NetShade's own dedicated... Read more
Mac DVDRipper Pro 5.0 - Copy, backup, an...
Mac DVDRipper Pro is the DVD backup solution that lets you protect your DVDs from scratches, save your batteries by reading your movies from your hard disk, manage your collection with just a few... Read more
pwSafe 3.1 - Secure password management...
pwSafe provides simple and secure password management across devices and computers. pwSafe uses iCloud to keep your password databases backed-up and synced between Macs and iOS devices. It is... Read more
StatsBar 1.8 - Monitor system processes...
StatsBar gives you a comprehensive and detailed analysis of the following areas of your Mac: CPU usage Memory usage Disk usage Network and bandwidth usage Battery power and health (MacBooks only)... Read more
Path Finder 6.5.5 - Powerful, award-winn...
Path Finder is a file browser that combines the familiar Finder interface with the powerful utilities and innovative features. Just a small selection of the Path Finder 6 feature set: Dual pane... Read more
QuarkXPress 10.2.1 - Desktop publishing...
With QuarkXPress, you can communicate in all the ways you need to -- and always look professional -- in print and digital media, all in a single tool. Features include: Easy to Use -- QuarkXPress is... Read more
Skype 6.19.0.450 - Voice-over-internet p...
Skype allows you to talk to friends, family and co-workers across the Internet without the inconvenience of long distance telephone charges. Using peer-to-peer data transmission technology, Skype... Read more
VueScan 9.4.41 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
Cloud 3.0.0 - File sharing from your men...
Cloud is simple file sharing for the Mac. Drag a file from your Mac to the CloudApp icon in the menubar and we take care of the rest. A link to the file will automatically be copied to your clipboard... Read more

Latest Forum Discussions

See All

Modern Combat 5 Gets a Major Multiplayer...
Modern Combat 5 Gets a Major Multiplayer Update Posted by Jessica Fisher on September 2nd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Alien Creeps TD Review
Alien Creeps TD Review By Jennifer Allen on September 2nd, 2014 Our Rating: :: EXPENSIVE DEFENSESUniversal App - Designed for iPhone and iPad Alien Creeps TD would be a fun if unremarkable Tower Defense game, but its heavy focus on... | Read more »
The Journey Down: Chapter Two Review
The Journey Down: Chapter Two Review By Jennifer Allen on September 2nd, 2014 Our Rating: :: DARK YET ENTICINGUniversal App - Designed for iPhone and iPad It’s a little dark, in every sense of the word, but The Journey Down:... | Read more »
Function Space, a Social Network App for...
Function Space, a Social Network App for Science, Launches on iOS Posted by Ellis Spice on September 2nd, 2014 [ permalink ] | Read more »
Stupidfast – How Taylor Martinez Switche...
How do you make an Endless Running game more than just another Endless Running game? By adding real life prizes to it, of course! That’s the thinking behind StupidFast: a game designed for football enthusiasts, and the brainchild of former college... | Read more »
Little Raiders: Robin’s Revenge Review
Little Raiders: Robin’s Revenge Review By Jennifer Allen on September 2nd, 2014 Our Rating: :: CASUAL RAIDINGUniversal App - Designed for iPhone and iPad Combining simple combat with village building is a potent combination for... | Read more »
Treasure Tombs: Ra Deal Coming from Bulk...
Treasure Tombs: Ra Deal Coming from Bulkypix and Dark Tonic This Fall Posted by Jessica Fisher on September 2nd, 2014 [ permalink ] Dark Tonic and | Read more »
Pirate Bash Review
Pirate Bash Review By Nadia Oxford on September 2nd, 2014 Our Rating: :: BAD PIRATES, GOOD TIMESUniversal App - Designed for iPhone and iPad Pirate Bash’s turn-based battles add an intriguing twist to a typical physics game.   | Read more »
Tiny Tower Vegas Review
Tiny Tower Vegas Review By Jennifer Allen on September 2nd, 2014 Our Rating: :: STEADY DEVELOPMENTUniversal App - Designed for iPhone and iPad Build a huge tower again but Vegas-style in Tiny Tower Vegas.   | Read more »
The Manhattan Project Review
The Manhattan Project Review By Andrew Fisher on September 2nd, 2014 Our Rating: :: ROCKET SCIENCEUniversal App - Designed for iPhone and iPad The Manhattan Project offers a great Euro-style gameplay experience, but it is totally... | Read more »

Price Scanner via MacPrices.net

Apple refurbished iPads available for up to $...
Apple is offering Certified Refurbished iPad Airs for up to $140 off MSRP. Apple’s one-year warranty is included with each model, and shipping is free. Stock tends to come and go with some of these... Read more
Are We Now In The Post-Post-PC Era?
A longtime and thoroughgoing laptop aficionado, I was more than a little dismayed by Steve Jobs’s declaration back in 2010 when he sprang the iPad on an unsuspecting world. that we’d entered a “post-... Read more
PC Outlook Improves, But 2014 Shipments Still...
According to the International Data Corporation (IDC) Worldwide Quarterly PC Tracker, worldwide PC shipments are expected to fall by -3.7 percent in 2014. To hat’s actually an improvement from the... Read more
IDC Lowers Tablet Sales Projections for 2014...
Following a second consecutive quarter of softer than expected demand, International Data Corporation (IDC) has lowered its worldwide tablet plus 2-in-1 forecast for 2014 to 233.1 million units. The... Read more
Apple now offering refurbished 21-inch 1.4GHz...
The Apple Store is now offering Apple Certified Refurbished 21″ 1.4GHz iMacs for $929 including free shipping plus Apple’s standard one-year warranty. Their price is $170 off the cost of new models,... Read more
Save $50 on the 2.5GHz Mac mini, on sale for...
B&H Photo has the 2.5GHz Mac mini on sale for $549.99 including free shipping. That’s $50 off MSRP, and B&H will also include a free copy of Parallels Desktop software. NY sales tax only. Read more
Save up to $300 on an iMac with Apple refurbi...
The Apple Store has Apple Certified Refurbished iMacs available for up to $300 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free. These are the best prices on... Read more
The Rise of Phablets
Carlisle & Gallagher Consulting Group, a businesses and technology consulting firm focused solely on the financial services industry, has released an infographic depicting the convergence of... Read more
Bad Driver Database App Allows Good Drivers t...
Bad Driver Database 1.4 by Facile Group is a new iOS and Android app that lets users instantly input and see how many times a careless, reckless or just plain stupid driver has been added to the... Read more
Eddy – Cloud Music Player for iPhone/iPad Fre...
Ukraine based CapableBits announces the release of Eddy, its tiny, but smart and powerful cloud music player for iPhone and iPad that allows users to stream or download music directly from cloud... 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
*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
*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
*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
Senior Event Manager, *Apple* Retail Market...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global event strategy. Delivering an overarching brand story; in-store, Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.