apps-projectcenter/TextFinder.m

/*
   TextFinder.m
   Copyright (c) 1995-1996, NeXT Software, Inc.
   All rights reserved.
   Author: Ali Ozer

   You may freely copy, distribute and reuse the code in this example.
   NeXT disclaims any warranty of any kind, expressed or implied,
   as to its fitness for any particular use.

   Find and replace functionality with a minimal panel...

   In addition to including this class and FindPanel.nib in your app, you
   probably need to hook up the following action methods in your document
   object (or whatever object is first responder) to call the appropriate
   methods in [TextFinder sharedInstance]:

   orderFrontFindPanel:
     	      findNext:
	  findPrevious:
	enterSelection: (calls setFindString:)

   2/21/95 aozer	Created for Edit II.
   2/24/95 aozer	Find pasteboard support
   8/16/95 aozer	Replace functionality
   10/4/95 aozer	Status field update
   11/12/96 aozer	Correctly send shouldChange... to the textview 
                        while doing a replace

 */

#import <AppKit/AppKit.h>
#import "TextFinder.h"

@implementation TextFinder

- (id)init
{
  if (!(self = [super init]))
    return nil;

  [[NSNotificationCenter defaultCenter]
    addObserver:self
       selector:@selector (appDidActivate:)
	   name:NSApplicationDidBecomeActiveNotification
	 object:[NSApplication sharedApplication]];

  [[NSNotificationCenter defaultCenter]
    addObserver:self
       selector:@selector (addWillDeactivate:)
	   name:NSApplicationWillResignActiveNotification
	 object:[NSApplication sharedApplication]];

  [self setFindString:@""];
  [self loadFindStringFromPasteboard];

  return self;
}

- (void)appDidActivate:(NSNotification *)notification
{
  [self loadFindStringFromPasteboard];
}

- (void)addWillDeactivate:(NSNotification *)notification
{
  [self loadFindStringToPasteboard];
}

- (void)loadFindStringFromPasteboard
{
  NSPasteboard	*pasteboard = [NSPasteboard pasteboardWithName:NSFindPboard];

  if ([[pasteboard types] containsObject:NSStringPboardType])
    {
      NSString *string = [pasteboard stringForType:NSStringPboardType];
      if (string && [string length])
	{
	  [self setFindString:string];
	  findStringChangedSinceLastPasteboardUpdate = NO;
	}
    }
}

- (void)loadFindStringToPasteboard
{
  NSPasteboard	*pasteboard = [NSPasteboard pasteboardWithName: NSFindPboard];

  if (findStringChangedSinceLastPasteboardUpdate)
    {
      [pasteboard declareTypes:[NSArray arrayWithObject:NSStringPboardType]
			 owner:nil];
      [pasteboard setString:[self findString] forType:NSStringPboardType];
      findStringChangedSinceLastPasteboardUpdate = NO;
    }
}

static id sharedFindObject = nil;

+ (id)sharedInstance
{
  if (!sharedFindObject)
    {
      sharedFindObject = [[self alloc] init];
    }
  return sharedFindObject;
}

- (void)awakeFromNib
{
  [ignoreCaseButton setRefusesFirstResponder:YES];
  [findNextButton setRefusesFirstResponder:YES];
  [replaceAllScopeMatrix setRefusesFirstResponder:YES];
  [statusField setRefusesFirstResponder:YES];
}

- (void)loadUI
{
  if (!findTextField)
    {
      if (![NSBundle loadNibNamed:@"FindPanel" owner:self])
	{
	  NSLog(@"Failed to load FindPanel.gorm");
	  NSBeep();
	}
      if (self == sharedFindObject)
	{
	  [[findTextField window] setFrameAutosaveName:@"Find"];
	}
    }
  [findTextField setStringValue:[self findString]];
}

- (void)dealloc
{
  if (self != sharedFindObject)
    {
      [findString release];
      [super dealloc];
    }
}

- (NSString *)findString
{
  return findString;
}

- (void)setFindString:(NSString *)string
{
  if ([string isEqualToString:findString])
    {
      return;
    }

  [findString autorelease];
  findString = [string copy];

  if (findTextField)
    {
      [findTextField setStringValue:string];
      [findTextField selectText:nil];
    }

  findStringChangedSinceLastPasteboardUpdate = YES;
}

- (NSTextView *)textObjectToSearchIn
{
  id obj = [[NSApp mainWindow] firstResponder];

  return (obj && [obj isKindOfClass:[NSTextView class]]) ? obj : nil;
}

- (NSPanel *)findPanel
{
  if (!findTextField)
    {
      [self loadUI];
    }

  return (NSPanel *)[findTextField window];
}

/*
   The primitive for finding; this ends up setting the status field (and
   beeping if necessary)...
 */
- (BOOL)find:(BOOL)direction
{
  NSTextView *text = [self textObjectToSearchIn];

  lastFindWasSuccessful = NO;

  if (text)
    {
      NSString	   *textContents = [text string];
      unsigned int textLength;

      if (textContents && (textLength = [textContents length]))
	{
	  NSRange      range;
	  unsigned int options = 0;

	  if (direction == Backward)
	    options |= NSBackwardsSearch;
	  if ([ignoreCaseButton state])
	    options |= NSCaseInsensitiveSearch;

	  range = [textContents findString:[self findString] 
			     selectedRange:[text selectedRange]
				   options:options
				      wrap:YES];
	  if (range.length)
	    {
	      [text setSelectedRange:range];
	      [text scrollRangeToVisible:range];
	      lastFindWasSuccessful = YES;
	    }
	}
    }

  if (!lastFindWasSuccessful)
    {
      NSBeep ();
      [statusField setStringValue:@"Not found"];
    }
  else
    {
      [statusField setStringValue:@""];
    }
  return lastFindWasSuccessful;
}

- (void)orderFrontFindPanel:(id)sender
{
  NSPanel *panel = [self findPanel];

  [findTextField selectText:nil];
  [panel makeKeyAndOrderFront:nil];
}

/**** Action methods for gadgets in the find panel; these should all end up setting or clearing the status field ****/

- (void)findNextAndOrderFindPanelOut:(id)sender
{
  [findNextButton performClick:nil];

  if (lastFindWasSuccessful)
    {
      [[self findPanel] orderOut: sender];
    }
  else
    {
      [findTextField selectText:nil];
    }
}

- (void)findNext:(id)sender
{
  if (findTextField)
    {
      // findTextField should be set
      [self setFindString:[findTextField stringValue]];
    }

  [self find:Forward];
}

- (void)findPrevious:(id)sender
{
  if (findTextField)
    {
      // findTextField should be set
      [self setFindString:[findTextField stringValue]];
    }

  [self find:Backward];
}

- (void)enterSelection:(id)sender
{
  NSTextView *text = [self textObjectToSearchIn];
  NSString   *string = [text string];

  if (text && string)
    {
      [self setFindString:[string substringWithRange:[text selectedRange]]];
    }
}

- (void)jumpToSelection:(id)sender
{
  NSTextView *text = [self textObjectToSearchIn];

  if (text)
    {
      [text scrollRangeToVisible:[text selectedRange]];
    }
}

- (void)replace:(id)sender
{
  NSTextView *text = [self textObjectToSearchIn];

  if (!text)
    {
      NSBeep ();
    }
  else
    {
      [[text textStorage]
	replaceCharactersInRange:[text selectedRange]
		      withString:[replaceTextField stringValue]];
      [text didChangeText];
    }

  [statusField setStringValue:@""];
}

- (void)replaceAndFind:(id)sender
{
  [self replace:sender];
  [self findNext:sender];
}

#define ReplaceAllScopeEntireFile 42
#define ReplaceAllScopeSelection 43

- (void)replaceAll:(id)sender
{
  NSTextView *text = [self textObjectToSearchIn];

  if (!text)
    {
      NSBeep();
    }
  else
    {	
      NSTextStorage *textStorage = [text textStorage];
      NSString      *textContents = [text string];
      NSString      *replaceString = [replaceTextField stringValue];
      BOOL          entireFile = replaceAllScopeMatrix ? ([replaceAllScopeMatrix selectedTag] == ReplaceAllScopeEntireFile) : YES;
      NSRange       replaceRange = entireFile ? NSMakeRange (0, [textStorage length]) : [text selectedRange];
      unsigned int  options = NSBackwardsSearch | ([ignoreCaseButton state] ? NSCaseInsensitiveSearch : 0);
      unsigned int  replaced = 0;

      if (findTextField)
	{
	  [self setFindString:[findTextField stringValue]];
	}

      while (1)
	{
	  NSRange foundRange = [textContents rangeOfString:[self findString]
						   options:options
						     range:replaceRange];

	  if (foundRange.length == 0)
	    break;

	  if ([text shouldChangeTextInRange:foundRange 
			  replacementString:replaceString])
	    {
	      if (replaced == 0)
		[textStorage beginEditing];

	      replaced++;

	      [textStorage replaceCharactersInRange:foundRange
					 withString:replaceString];
	      replaceRange.length = foundRange.location - replaceRange.location;
	    }
	}

      if (replaced > 0)
	{ /* There was at least one replacement */

  	  /* We need this to bracket the beginEditing */
	  [textStorage endEditing];
	  /* We need one of these to terminate the shouldChange... 
	   * methods we sent */
	  [text didChangeText];	
	  [statusField setStringValue:[NSString stringWithFormat:@"%d replaced", replaced]];
	}
      else
	{	/* No replacements were done... */
	  NSBeep();
	  [statusField setStringValue:@"Not found"];
	}
    }
}

- (BOOL)validateMenuItem:(NSMenuItem *)anItem
{

  if ([anItem action] == @selector(orderFrontFindPanel:))
    {
      return ([self textObjectToSearchIn] != NULL);
    }
  if ([anItem action] == @selector(findNext:))
    {
      return ([self textObjectToSearchIn] != NULL);
    }
  if ([anItem action] == @selector(findPrevious:))
    {
      return ([self textObjectToSearchIn] != NULL);
    }
  if ([anItem action] == @selector(enterSelection:))
    {
      return ([self textObjectToSearchIn] != NULL);
    }
  if ([anItem action] == @selector(jumpToSelection:))
    {
      return ([self textObjectToSearchIn] != NULL);
    }
  // if it isn't one of our menu items, we'll let the
  // superclass take care of it
  return [super validateMenuItem:anItem];
}

@end


@implementation NSString (NSStringTextFinding)

 - (NSRange)findString:(NSString *)string
	 selectedRange:(NSRange)selectedRange
	       options:(unsigned)options
		  wrap:(BOOL)wrap
{
  BOOL         forwards = (options & NSBackwardsSearch) == 0;
  unsigned int length = [self length];
  NSRange      searchRange, range;

  if (forwards)
    {
      searchRange.location = NSMaxRange(selectedRange);
      searchRange.length = length - searchRange.location;
      range = [self rangeOfString:string options:options range:searchRange];

      if ((range.length == 0) && wrap)
	{ // If not found look at the first part of the string
	  searchRange.location = 0;
	  searchRange.length = selectedRange.location;
	  range = [self rangeOfString:string options:options range:searchRange];
	}
    }
  else
    {
      searchRange.location = 0;
      searchRange.length = selectedRange.location;
      range = [self rangeOfString:string options:options range:searchRange];

      if ((range.length == 0) && wrap)
	{
	  searchRange.location = NSMaxRange(selectedRange);
	  searchRange.length = length - searchRange.location;
	  range = [self rangeOfString:string options:options range:searchRange];
	}
    }

  return range;
}

@end