apps-gorm/GormWindowEditor.m

/* GormWindowEditor.m
 *
 * Copyright (C) 1999 Free Software Foundation, Inc.
 *
 * Author:	Richard Frith-Macdonald <richard@brainstrom.co.uk>
 * Date:	1999
 * 
 * This file is part of GNUstep.
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include "GormPrivate.h"

static NSRect
NSRectFromPoints(NSPoint p0, NSPoint p1)
{
  NSRect	r;

  if (p0.x < p1.x)
    {
      r.origin.x = p0.x;
      r.size.width = p1.x - p0.x;
    }
  else
    {
      r.origin.x = p1.x;
      r.size.width = p0.x - p1.x;
    }
  if (p0.y < p1.y)
    {
      r.origin.y = p0.y;
      r.size.height = p1.y - p0.y;
    }
  else
    {
      r.origin.y = p1.y;
      r.size.height = p0.y - p1.y;
    }
  return r;
}

/*
 * Methods to return the images that should be used to display objects within
 * the matrix containing the objects in a document.
 */
@implementation NSMenu (GormObjectAdditions)
- (NSImage*) imageForViewer
{
  static NSImage	*image = nil;

  if (image == nil)
    {
      NSBundle	*bundle = [NSBundle mainBundle];
      NSString	*path = [bundle pathForImageResource: @"GormMenu"];

      image = [[NSImage alloc] initWithContentsOfFile: path];
    }
  return image;
}
@end

@implementation NSWindow (GormObjectAdditions)
- (NSString*) editorClassName
{
  return @"GormWindowEditor";
}
- (NSImage*) imageForViewer
{
  static NSImage	*image = nil;

  if (image == nil)
    {
      NSBundle	*bundle = [NSBundle mainBundle];
      NSString	*path = [bundle pathForImageResource: @"GormWindow"];

      image = [[NSImage alloc] initWithContentsOfFile: path];
    }
  return image;
}
@end

/*
 *	Default implementations of methods used for updating a view by
 *	direct action through an editor.
 */
@implementation NSView (ViewAdditions)

- (BOOL) acceptsColor: (NSColor*)color atPoint: (NSPoint)point
{
  return NO;	/* Can the view accept a color drag-and-drop?	*/
}

- (BOOL) allowsAltDragging
{
  return NO;	/* Can the view be dragged into a matrix?	*/
}

- (void) depositColor: (NSColor*)color atPoint: (NSPoint)point
{
  					/* Handle color drop in view.	*/
}

- (NSSize) maximumSizeFromKnobPosition: (IBKnobPosition)knobPosition
{
  NSView	*s = [self superview];
  NSRect	r = (s != nil) ? [s bounds] : [self bounds];

  return r.size;			/* maximum resize permitted	*/
}

- (NSSize) minimumSizeFromKnobPosition: (IBKnobPosition)position
{
  return NSZeroSize;			/* Minimum resize permitted	*/
}

- (void) placeView: (NSRect)newFrame
{
  [self setFrame: newFrame];		/* View changed by editor.	*/
}

@end



@interface	GormWindowEditor : NSView <IBEditors>
{
  id<IBDocuments>	document;
  NSWindow		*edited;
  NSView		*original;
  NSMutableArray	*selection;
  NSMutableArray	*subeditors;
  BOOL			shouldBeginDrag;
  BOOL			isClosed;
  NSPasteboard		*dragPb;
}
- (BOOL) acceptsTypeFromArray: (NSArray*)types;
- (BOOL) activate;
- (id) initWithObject: (id)anObject inDocument: (id<IBDocuments>)aDocument;
- (void) close;
- (void) closeSubeditors;
- (void) copySelection;
- (void) deleteSelection;
- (id<IBDocuments>) document;
- (void) draggedImage: (NSImage*)i endedAt: (NSPoint)p deposited: (BOOL)f;
- (unsigned int) draggingSourceOperationMaskForLocal: (BOOL)flag;
- (id) editedObject;
- (void) makeSelectionVisible: (BOOL)flag;
- (id<IBEditors>) openSubeditorForObject: (id)anObject;
- (void) orderFront;
- (void) pasteInSelection;
- (void) resetObject: (id)anObject;
- (void) selectObjects: (NSArray*)objects;
- (void) validateEditing;
- (BOOL) wantsSelection;
- (NSWindow*) window;
@end

@implementation	GormWindowEditor

/*
 *	Intercepting events in the view and handling them
 */
- (NSView*) hitTest: (NSPoint)loc
{
  if ([(id<IB>)NSApp isTestingInterface] == YES)
    {
      return [super hitTest: loc];
    }
  else
    {
      /*
       * Stop the subviews receiving events - we grab them all.
       */
      if ([super hitTest: loc] != nil)
	{
	  return self;
	}
      return nil;
    }
}

- (void) mouseDown: (NSEvent*)theEvent
{
  if ([(id<IB>)NSApp isTestingInterface] == YES)
    {
      [super mouseDown: theEvent];
      return;
    }
  else
    {
      NSEnumerator	*enumerator;
      NSView		*view = nil;
      IBKnobPosition	knob = IBNoneKnobPosition;
      NSDate		*future = [NSDate distantFuture];
      BOOL		acceptsMouseMoved;
      NSPoint		mouseDownPoint;
      NSPoint		lastPoint;
      NSPoint		point;
      unsigned		eventMask;
      NSEvent		*e;

      /*
       * Save window state info.
       */
      acceptsMouseMoved = [[self window] acceptsMouseMovedEvents];

      mouseDownPoint = [theEvent locationInWindow];
      eventMask = NSLeftMouseDownMask | NSLeftMouseUpMask
	| NSLeftMouseDraggedMask | NSMouseMovedMask | NSPeriodicMask;
      [[self window] setAcceptsMouseMovedEvents: YES];

      /*
       * If our selection is not our window, it must be one or more
       * subviews, so we need to check to see if the knob of any subview
       * has been hit, or if a subview itsself has been hit.
       */
      if ([selection lastObject] != edited)
	{
	  enumerator = [selection objectEnumerator];
	  while ((view = [enumerator nextObject]) != nil)
	    {
	      knob = GormKnobHitInRect([view frame], mouseDownPoint);
	      if (knob != IBNoneKnobPosition)
		{
		  /*
		   * Clicked on the knob of a selected subview.
		   * If it's not the only selected view - make it so.
		   * We now expect to drag from this.
		   */
		  if ([selection count] != 1)
		    {
		      [self selectObjects: [NSArray arrayWithObject: view]];
		      [self makeSelectionVisible: NO];
		    }
		  break;
		}
	    }
	  if (view == nil)
	    {
	      enumerator = [selection objectEnumerator];
	      while ((view = [enumerator nextObject]) != nil)
		{
		  if (NSMouseInRect(mouseDownPoint, [view frame], NO) == YES)
		    {
		      /*
		       * Clicked inside a selected subview.
		       */
		      if ([theEvent modifierFlags] & NSShiftKeyMask)
			{
			  NSMutableArray	*array;

			  /*
			   * remove this view from the selection.
			   */
			  [self makeSelectionVisible: NO];
			  array = [NSMutableArray arrayWithArray: selection];
			  [array removeObjectIdenticalTo: view];
			  [self selectObjects: array];
			}
		      else
			{
			  [self makeSelectionVisible: YES];
			}
		      break;
		    }
		}
	    }
	}

      /*
       * If we haven't clicked in a selected subview - find out where we
       * actually did click.
       */
      if (view == nil)
	{
	  view = [super hitTest: mouseDownPoint];
	  if (view != nil && view != self)
	    {
	      /*
	       * Clicked on an unselected subview.
	       */
	      if ([theEvent modifierFlags] & NSShiftKeyMask)
		{
		  if ([selection lastObject] == edited
		    || ([theEvent modifierFlags] & NSControlKeyMask))
		    {
		      /*
		       * Can't extend the selection - change it to the subview.
		       */
		      [self makeSelectionVisible: NO];
		      [self selectObjects: [NSArray arrayWithObject: view]];
		    }
		  else
		    {
		      NSMutableArray	*array;

		      /*
		       * extend the selection to include this subview.
		       */
		      array = [NSMutableArray arrayWithArray: selection];
		      [array addObject: view];
		      [self selectObjects: array];
		    }
		}
	      else
		{
		  /*
		   * Select the new view (clear the old selection markings)
		   */
		  [self makeSelectionVisible: NO];
		  [self selectObjects: [NSArray arrayWithObject: view]];
		}
	    }
	}
      else if ([selection indexOfObjectIdenticalTo: view] == NSNotFound)
	{
	  /*
	   * This view has just been deselected.
	   */
	  view = nil;
	}

      if (view == self)
	{
	  NSGraphicsContext	*ctxt = [NSGraphicsContext currentContext];
	  NSEnumerator		*enumerator;
	  NSMutableArray	*array;
	  NSEventType		eType;
	  NSRect		r;

	  /*
	   * Clicked on an window background - make window the selection.
	   */
	  [self makeSelectionVisible: NO];
	  [self selectObjects: [NSArray arrayWithObject: edited]];

	  /*
	   * Track mouse movements until left mouse up.
	   * While we keep track of all mouse movements, we only act on a
	   * movement when a periodic event arives (every 20th of a second)
	   * in order to avoid excessive amounts of drawing.
	   */
	  lastPoint = mouseDownPoint;
	  [self lockFocus];
	  [NSEvent startPeriodicEventsAfterDelay: 0.1 withPeriod: 0.05];
	  e = [NSApp nextEventMatchingMask: eventMask
				 untilDate: future
				    inMode: NSEventTrackingRunLoopMode
				   dequeue: YES];
	  eType = [e type];
	  while (eType != NSLeftMouseUp)
	    {
	      if (eType != NSPeriodic)
		{
		  point = [self convertPoint: [e locationInWindow]
				    fromView: nil];
		}
	      if (eType == NSPeriodic &&  NSEqualPoints(point, lastPoint) == NO)
		{
		  /*
		   * Clear old box and draw new one.
		   * FIXME - there has to be a more efficient way to restore
		   * the display under the box.
		   * FIXME - does the fact that we need to redisplay a
		   * rectangle slightly larger than the one we drew mean that
		   * there is a drawing bug?
		   */
		  [[self window] disableFlushWindow];
		  r = NSRectFromPoints(lastPoint, mouseDownPoint);
		  r.origin.x--;
		  r.origin.y--;
		  r.size.width += 2;
		  r.size.height += 2;
		  [self displayRect: r];
		  r = NSRectFromPoints(point, mouseDownPoint);
		  DPSsetgray(ctxt, NSBlack);
		  DPSmoveto(ctxt, NSMinX(r), NSMinY(r));
		  DPSlineto(ctxt, NSMinX(r), NSMaxY(r));
		  DPSlineto(ctxt, NSMaxX(r), NSMaxY(r));
		  DPSlineto(ctxt, NSMaxX(r), NSMinY(r));
		  DPSlineto(ctxt, NSMinX(r), NSMinY(r));
		  DPSstroke(ctxt);
		  [[self window] enableFlushWindow];
		  [[self window] flushWindow];
		  lastPoint = point;
		}
	      e = [NSApp nextEventMatchingMask: eventMask
				     untilDate: future
					inMode: NSEventTrackingRunLoopMode
				       dequeue: YES];
	      eType = [e type];
	    }
	  [NSEvent stopPeriodicEvents];

	  /*
	   * restore the display
	   */
	  r = NSRectFromPoints(lastPoint, mouseDownPoint);
	  r.origin.x--;
	  r.origin.y--;
	  r.size.width += 2;
	  r.size.height += 2;
	  [self displayRect: r];
	  [self unlockFocus];

	  /*
	   * Now finally check the selected rectangle to find the views in it
	   * and make them (if any) into our current selection.
	   */
	  point = [self convertPoint: [e locationInWindow]
			    fromView: nil];
	  r = NSRectFromPoints(point, mouseDownPoint);
	  array = [NSMutableArray arrayWithCapacity: 8];
	  enumerator = [[self subviews] objectEnumerator];
	  while ((view = [enumerator nextObject]) != nil)
	    {
	      if (NSIntersectsRect(r, [view frame]) == YES)
		{
		  [array addObject: view];
		}
	    }
	  if ([array count] > 0)
	    {
	      [self selectObjects: array];
	    }
	}
      else if (view != nil)
	{
	  if (knob == IBNoneKnobPosition)
	    {
	      if ([theEvent modifierFlags] & NSControlKeyMask)
		{
		  NSLog(@"Control key not yet supported");
		  /* FIXME */
		}
	      else
		{
		  [self makeSelectionVisible: YES];
		}
	    }
	  else
	    {
	      /*
	       * Expecting to drag a handle.
	       */
	    }
	}

      [self makeSelectionVisible: YES];

      /*
       * Restore state to what it was on entry.
       */
      [[self window] setAcceptsMouseMovedEvents: acceptsMouseMoved];
    }
}

- (void) mouseDragged: (NSEvent*)theEvent
{
  if ([(id<IB>)NSApp isTestingInterface] == YES)
    {
      [super mouseDown: theEvent];
      return;
    }
}

- (BOOL) acceptsTypeFromArray: (NSArray*)types
{
  /*
   * A window editor can accept views dropped in to the window.
   */
  return [types containsObject: IBViewPboardType];
}

- (BOOL) activate
{
  if (original == nil)
    {
      NSEnumerator	*enumerator;
      NSView		*sub;

      /*
       * Swap ourselves in as a replacement for the original window
       * content view.
       */
      original = RETAIN([edited contentView]);
      [self setFrame: [original frame]];
      enumerator = [[original subviews] objectEnumerator];
      while ((sub = [enumerator nextObject]) != nil)
	{
	  [self addSubview: sub];
	}
      [edited setContentView: self];
    }
  if ([edited isKeyWindow] == NO)
    {
      [window makeKeyAndOrderFront: self];
    }
  if ([selection count] == 0)
    {
      [selection addObject: edited];
    }
  if ([(id<IB>)NSApp selectionOwner] != self)
    {
      [document setSelectionFromEditor: self];
    }
  return YES;
}

- (void) close
{
  [self closeSubeditors];

  if (original != nil)
    {
      NSEnumerator	*enumerator;
      NSView		*sub;

      /*
       * Swap ourselves out and the original window content view in.
       */
      [original setFrame: [self frame]];
      enumerator = [[self subviews] objectEnumerator];
      while ((sub = [enumerator nextObject]) != nil)
	{
	  [original addSubview: sub];
	}
      [edited setContentView: original];
      DESTROY(original);
    }
  if ([(id<IB>)NSApp selectionOwner] == self)
    {
      [document resignSelectionForEditor: self];
    }
  [document editor: self didCloseForObject: edited];
}

- (void) closeSubeditors
{
  while ([subeditors count] > 0)
    {
      id<IBEditors>	sub = [subeditors lastObject];

      [sub close];
      [subeditors removeObjectIdenticalTo: sub];
    }
}

- (void) copySelection
{
  switch ([selection count])
    {
      case 0:
	break;

      case 1:
	{
	  id	obj = [selection lastObject];

	  if (obj == edited)
	    {
	      [document copyObject: selection
			      type: IBWindowPboardType
		      toPasteboard: [NSPasteboard generalPasteboard]];
	    }
	  else
	    {
	      [document copyObject: selection
			      type: IBViewPboardType
		      toPasteboard: [NSPasteboard generalPasteboard]];
	    }
	}
	break;

      default:
        [document copyObjects: selection
			 type: IBViewPboardType
		 toPasteboard: [NSPasteboard generalPasteboard]];
	break;
    }
}

- (void) dealloc
{
  [[NSNotificationCenter defaultCenter] removeObserver: self];
  [self close];
  RELEASE(edited);
  RELEASE(selection);
  RELEASE(subeditors);
  RELEASE(document);
  [super dealloc];
}

- (void) deleteSelection
{
  NSArray	*a = [NSArray arrayWithArray: selection];
  unsigned	c = [a count];

  [selection removeAllObjects];
  [document resignSelectionForEditor: self];
  while (c-- > 0)
    {
      id	obj = [a objectAtIndex: c];

      [document detachObject: obj];
    }
}

/*
 *	Dragging source protocol implementation
 */
- (void) draggedImage: (NSImage*)i endedAt: (NSPoint)p deposited: (BOOL)f
{
  NSString	*type = [[dragPb types] lastObject];

  /*
   * Windows are an exception to the normal DnD mechanism - we create them
   * if they are dropped anywhere except back in the pallettes view -
   * ie. if they are dragged, but the drop fails.
   */
  if (f == NO && [type isEqual: IBWindowPboardType] == YES)
    {
      id<IBDocuments>	active = [(id<IB>)NSApp activeDocument];

      if (active != nil)
	{
	  [active pasteType: type fromPasteboard: dragPb parent: nil];
	}
    }
}

- (unsigned int) draggingSourceOperationMaskForLocal: (BOOL)flag
{
  return NSDragOperationCopy;
}

- (unsigned) draggingEntered: (id<NSDraggingInfo>)sender
{
  /*
   * Let the dragging source know we will copy the dragged object.
   */
  return NSDragOperationCopy;;
}

- (void) drawSelection
{
  if ([selection count] > 0 && [selection lastObject] != edited)
    {
      NSEnumerator	*enumerator = [selection objectEnumerator];
      NSView		*view;

      [self lockFocus];
      while ((view = [enumerator nextObject]) != nil)
	{
	  GormDrawKnobsForRect([view frame]);
	}
      GormShowFastKnobFills();
      [self unlockFocus];
    }
}

- (id<IBDocuments>) document
{
  return document;
}

- (id) editedObject
{
  return edited;
}

- (id) initWithObject: (id)anObject inDocument: (id<IBDocuments>)aDocument
{
  NSWindow	*win = (NSWindow*)anObject;
  NSView	*cv = [win contentView];
  NSView	*sub;
  NSEnumerator	*enumerator;

  /*
   * Initialize with current window content frame, move window subviews to
   * self, and replace window content view with self.
   */
  if ((self = [super initWithFrame: [cv frame]]) == nil)
    return nil;
  original = RETAIN(cv);
  enumerator = [[original subviews] objectEnumerator];
  while ((sub = [enumerator nextObject]) != nil)
    {
      [self addSubview: sub];
    }
  [win setContentView: self];

  ASSIGN(document, aDocument);
  ASSIGN(edited, anObject);
  selection = [NSMutableArray new];
  [selection addObject: edited];
  subeditors = [NSMutableArray new];

  /*
   * Permit views to be dragged in to the window.
   */
  [self registerForDraggedTypes: [NSArray arrayWithObjects:
    IBViewPboardType, nil]];

  return self;
}

- (void) makeSelectionVisible: (BOOL)flag
{
  if (flag == NO)
    {
      if ([selection count] > 0 && [selection lastObject] != edited)
	{
	  NSEnumerator	*enumerator = [selection objectEnumerator];
	  NSView	*view;

	  [[self window] disableFlushWindow];
	  while ((view = [enumerator nextObject]) != nil)
	    {
	      NSRect	rect = GormExtBoundsForRect([view frame]);

	      [self displayRect: rect];
	    }
	  [[self window] enableFlushWindow];
	  [[self window] flushWindowIfNeeded];
	}
    }
  else
    {
      [self drawSelection];
      [[self window] flushWindow];
    }
}

- (id<IBEditors>) openSubeditorForObject: (id)anObject
{
  id<IBEditors>	sub;

  sub = [document editorForObject: anObject inEditor: self create: YES];
  /*
   * If we don't already have this subeditor, make a note of it so we
   * can close it later.
   */
  if ([subeditors indexOfObjectIdenticalTo: sub] == NSNotFound)
    {
      [subeditors addObject: sub];
    }
  return sub;
}

- (void) orderFront
{
  [edited orderFront: self];
}

- (void) pasteInSelection
{
}

- (BOOL) performDragOperation: (id<NSDraggingInfo>)sender
{
  NSPoint	loc = [sender draggedImageLocation];
  NSPasteboard	*pb = [sender draggingPasteboard];
  NSArray	*views;
  NSEnumerator	*enumerator;
  NSView	*sub;

  /*
   * Ask the document to get the dragged views from the pasteboard and add
   * them to it's collection of known objects.
   */
  views = [document pasteType: IBViewPboardType
	       fromPasteboard: pb
		       parent: edited];
  /*
   * Now make all the views subviews of ourself, setting their origin to be
   * the point at which they were dropped (converted from window coordinates
   * to our own coordinates).
   */
  loc = [self convertPoint: loc fromView: nil];
  enumerator = [views objectEnumerator];
  while ((sub = [enumerator nextObject]) != nil)
    {
      NSRect	rect = [sub frame];

      rect.origin = loc;
      [sub setFrame: rect];
      [self addSubview: sub];
    }
  return YES;
}

- (BOOL) prepareForDragOperation: (id<NSDraggingInfo>)sender
{
  /*
   * Tell the source that we will accept the drop.
   */
  return YES;
}

- (void) resetObject: (id)anObject
{
  [self display];
}

- (void) selectObjects: (NSArray*)anArray
{
  if (anArray != selection)
    {
      [selection removeAllObjects];
      [selection addObjectsFromArray: anArray];
      if ([selection indexOfObjectIdenticalTo: edited] != NSNotFound)
	{
	  /*
	   * we have selected our edited window ... we can't have anything
	   * else selected at the same time.
	   */
	  if ([selection count] > 0)
	    {
	      [selection removeAllObjects];
	      [selection addObject: edited];
	    }
	}
      else
	{
	  unsigned	count = [selection count];

	  /*
	   * We can only select views that are direct subviews - discard others.
	   */
	  while (count-- > 0)
	    {
	      id	o = [selection objectAtIndex: count];

	      if ([[self subviews] indexOfObjectIdenticalTo: o] == NSNotFound)
		{
		  [selection removeObjectAtIndex: count];
		}
	    }
	}
    }
  /*
   * Now we must let the document (and hence the rest of the app) know about
   * our new selection.
   */
  [document setSelectionFromEditor: self];
}

- (NSArray*) selection
{
  return [NSArray arrayWithArray: selection];
}

- (unsigned) selectionCount
{
  return [selection count];
}

- (void) validateEditing
{
}

- (BOOL) wantsSelection
{
  /*
   * We only want to be the selection owner if we are active (have been
   * swapped for the windows original content view) and if we have some
   * object selected.
   */
  if (original == nil)
    return NO;
  if ([selection count] == 0)
    return NO;
  return YES;
}

- (NSWindow*) window
{
  return [super window];
}
@end