libs-gui/Source/NSMenu.m

/** <title>NSMenu</title>

   Copyright (C) 1999,2016 Free Software Foundation, Inc.

   Author: Fred Kiefer <FredKiefer@gmx.de>
   Date: Aug 2001
   Author: David Lazaro Saz <khelekir@encomix.es>
   Date: Oct 1999
   Author: Michael Hanni <mhanni@sprintmail.com>
   Date: 1999
   Author: Felipe A. Rodriguez <far@ix.netcom.com>
   Date: July 1998
   and: 
   Author: Ovidiu Predescu <ovidiu@net-community.com>
   Date: May 1997
   
   This file is part of the GNUstep GUI Library.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library 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
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library; see the file COPYING.LIB.
   If not, see <http://www.gnu.org/licenses/> or write to the 
   Free Software Foundation, 51 Franklin Street, Fifth Floor, 
   Boston, MA 02110-1301, USA.
*/ 

#import "config.h"
#import <Foundation/NSCoder.h>
#import <Foundation/NSArray.h>
#import <Foundation/NSCharacterSet.h>
#import <Foundation/NSDebug.h>
#import <Foundation/NSException.h>
#import <Foundation/NSProcessInfo.h>
#import <Foundation/NSString.h>
#import <Foundation/NSNotification.h>
#import <Foundation/NSNotificationQueue.h>
#import <Foundation/NSRunLoop.h>
#import <Foundation/NSUserDefaults.h>
#import <Foundation/NSValue.h>

#import "AppKit/NSMatrix.h"
#import "AppKit/NSApplication.h"
#import "AppKit/NSCursor.h"
#import "AppKit/NSWindow.h"
#import "AppKit/NSEvent.h"
#import "AppKit/NSFont.h"
#import "AppKit/NSImage.h"
#import "AppKit/NSMenu.h"
#import "AppKit/NSMenuItem.h"
#import "AppKit/NSMenuView.h"
#import "AppKit/NSPanel.h"
#import "AppKit/NSPopUpButton.h"
#import "AppKit/NSPopUpButtonCell.h"
#import "AppKit/NSScreen.h"
#import "AppKit/NSAttributedString.h"

#import "GSGuiPrivate.h"
#import "NSDocumentFrameworkPrivate.h"
#import "GNUstepGUI/GSTheme.h"

/*
  Drawing related:

  NSMenu superMenu   (if not root menu, the parent meu)
    ^
    |
    |    +------------------> NSMenuView view  (content, draws the menu items)
    |    |
  NSMenu +----------+-------> NSMenuPanel A    (regular window, torn off window)
    |    |          `-------> NSMenuPanel B    (transient window)
    |    |           
    |    +------------------> NSString title   (title)
    |
    v
  NSMenu attachedMenu  (the menu attached to this one, during navigation)
              


   +--[NSMenuPanel]------+
   | +-[NSMenuView]----+ |
   | | title if applic | |
   | | +-------------+ | |
   | | | NSMenuItem- | | |
   | | | Cell        | | |
   | | +-------------+ | |
   | |       .         | |
   | |       .         | |
   | +-----------------+ |
   +---------------------+

   The two windows
   ---------------

   Basically we have for a menu two windows, window A and window B.
   Window A is the regular window and Window B is used for transient windows.

   At any one time, the views, like title view, NSMenuView are put either in
   window A or in window B.  They are moved over from one window to the oter
   when needed.

   the code is supposed to know when it is using window A or B.
   But it will probably only work correctly when

   window A correspond to transient == NO
   window B correspond to transient == YES
*/


/* Subclass of NSPanel since menus cannot become key */
@interface NSMenuPanel : NSPanel
{
  NSMenu *_the_menu;
}
- (void) _setmenu: (NSMenu *)menu;
@end

@interface NSMenuView (GNUstepPrivate)
- (NSArray *)_itemCells;
@end


static NSZone	*menuZone = NULL;
static NSString	*NSMenuLocationsKey = @"NSMenuLocations";
static NSString *NSEnqueuedMenuMoveName = @"EnqueuedMoveNotificationName";
static NSNotificationCenter *nc;
static BOOL menuBarVisible = YES;

@interface	NSMenu (GNUstepPrivate)

- (NSString *) _name;
- (void) _setName: (NSString *)name;
- (NSMenuPanel *) _createWindow;
- (NSString *) _locationKey;
- (void) _rightMouseDisplay: (NSEvent*)theEvent;
- (void) _setGeometry;
- (void) _updateUserDefaults: (id) notification;
- (void) _organizeMenu;
- (BOOL) _isVisible;
- (BOOL) _isMain;

@end


@implementation NSMenuPanel
- (void) _setmenu: (NSMenu *)menu
{
  _the_menu = menu;
}

- (BOOL) canBecomeKeyWindow
{
  /* See [NSWindow-_lossOfKeyOrMainWindow] */
  return [_the_menu _isMain];
}

- (void) orderFrontRegardless
{
  NSInterfaceStyle style = NSInterfaceStyleForKey(@"NSMenuInterfaceStyle", nil);
  if (style == NSWindows95InterfaceStyle)
    {
      // if we're the top level menu in Windows mode, don't show it.
      if([_the_menu supermenu] == nil && [_the_menu _ownedByPopUp] == NO)
	{
	  return;
	}
    }
  [super orderFrontRegardless];
}
@end

@implementation	NSMenu (GNUstepPrivate)

- (NSString *) _name;
{
  return _name;
}

- (void) _setName: (NSString *)aName
{
  ASSIGNCOPY(_name, aName);
}

- (NSString*) _locationKey
{
  NSInterfaceStyle style = NSInterfaceStyleForKey(@"NSMenuInterfaceStyle", nil);
  if (style == NSMacintoshInterfaceStyle
    || style == NSWindows95InterfaceStyle)
    {
      return nil;
    }
  if (_superMenu == nil)
    {
      if ([self _isMain])
	{
	  return @"\033";	/* Root menu.	*/
	}
      else
	{
	  return nil;		/* Unused menu.	*/
	}
    }
  else if (_superMenu->_superMenu == nil)
    {
      return [NSString stringWithFormat: @"\033%@", [self title]];
    }
  else
    {
      return [[_superMenu _locationKey] stringByAppendingFormat: @"\033%@",
	[self title]];
    }
}

/* Create a non autorelease window for this menu.  */
- (NSMenuPanel*) _createWindow
{
  NSMenuPanel *win = [[NSMenuPanel alloc] 
		     initWithContentRect: NSZeroRect
		     styleMask: NSBorderlessWindowMask
		     backing: NSBackingStoreBuffered
		     defer: YES];
  [win setBackgroundColor: [NSColor clearColor]];
  [win setLevel: NSSubmenuWindowLevel];
  [win setWorksWhenModal: NO];
  [win setBecomesKeyOnlyIfNeeded: YES];
  [win _setmenu: self];

  return win;
}

/**
   Will track the mouse movement.  It will trigger the updating of the user
   defaults in due time.
*/
- (void) _menuMoved: (id) notification
{
  NSNotification *resend;

  resend = [NSNotification notificationWithName: NSEnqueuedMenuMoveName
					 object: self];
  
  [[NSNotificationQueue defaultQueue]
    enqueueNotification: resend
    postingStyle: NSPostASAP
    coalesceMask: NSNotificationCoalescingOnSender
    forModes:  [NSArray arrayWithObject: NSDefaultRunLoopMode]];
}

- (void) _organizeMenu
{
  NSString *infoString = _(@"Info");
  NSString *servicesString = _(@"Services");
  int i;

  if ([self _isMain])
    {
      NSString *appTitle;
      NSMenu *appMenu;
      id <NSMenuItem> appItem;

      appTitle = [[[NSBundle mainBundle] localizedInfoDictionary]
                     objectForKey: @"ApplicationName"];
      if (nil == appTitle)
        {
          appTitle = [[NSProcessInfo processInfo] processName];
        }
      appItem = [self itemWithTitle: appTitle];
      appMenu = [appItem submenu];

      if (_menu.horizontal == YES)
        {
          NSMutableArray *itemsToMove;
	  
          itemsToMove = [NSMutableArray new];
          
          if (appMenu == nil)
            {
              [self insertItemWithTitle: appTitle
                    action: NULL
                    keyEquivalent: @"" 
                    atIndex: 0];
              appItem = [self itemAtIndex: 0];
              appMenu = [NSMenu new];
              [self setSubmenu: appMenu forItem: appItem];
              RELEASE(appMenu);
            }
          else
            {
              int index = [self indexOfItem: appItem];
              
              if (index != 0)
                {
                  RETAIN (appItem);
                  [self removeItemAtIndex: index];
                  [self insertItem: appItem atIndex: 0];
                  RELEASE (appItem);
                }
            }

	  if ([[GSTheme theme] menuShouldShowIcon])
	    {
              NSImage *ti;
              float bar;
	      ti = [[NSApp applicationIconImage] copy];
	      if (ti == nil)
		{
		  ti = [[NSImage imageNamed: @"GNUstep"] copy];
		}
	      [ti setScalesWhenResized: YES];
	      bar = [NSMenuView menuBarHeight] - 4;
	      [ti setSize: NSMakeSize(bar, bar)];
	      [appItem setImage: ti];
	      RELEASE(ti);
	    }

          // Collect all simple items plus "Info" and "Services"
          for (i = 1; i < [_items count]; i++)
            {
              NSMenuItem *anItem = [_items objectAtIndex: i];
              NSString *title = [anItem title];
              NSMenu *submenu = [anItem submenu];

              if (submenu == nil)
                {
                  [itemsToMove addObject: anItem];
                }
              else
                {
                  // The menu may not be localized, so we have to 
                  // check both the English and the local version.
                  if ([title isEqual: @"Info"] ||
                      [title isEqual: @"Services"] ||
                      [title isEqual: infoString] ||
                      [title isEqual: servicesString])
                    {
                      [itemsToMove addObject: anItem];
                    }
                }
            }
          
          for (i = 0; i < [itemsToMove count]; i++)
            {
              NSMenuItem *anItem = [itemsToMove objectAtIndex: i];

              [self removeItem: anItem];
              [appMenu addItem: anItem];
            }
          
          RELEASE(itemsToMove);
        }      
      else 
        {
          [appItem setImage: nil];
          if (appMenu != nil)
            {
              NSArray	*array = [NSArray arrayWithArray: [appMenu itemArray]];
              /* 
               * Everything above the Serives menu goes into the info submenu,
               * the rest into the main menu.
               */
              int k = [appMenu indexOfItemWithTitle: servicesString];

              // The menu may not be localized, so we have to 
              // check both the English and the local version.
              if (k == -1)
                k = [appMenu indexOfItemWithTitle: @"Services"];

              if ((k > 0) && ([[array objectAtIndex: k - 1] isSeparatorItem]))
                k--;

              if (k == 1)
                {
                  // Exactly one info item
                  NSMenuItem *anItem = [array objectAtIndex: 0];

                  [appMenu removeItem: anItem];
                  [self insertItem: anItem atIndex: 0];
                }
              else if (k > 1)
                {
                  id <NSMenuItem> infoItem;
                  NSMenu *infoMenu;

                  // Multiple info items, add a submenu for them
                  [self insertItemWithTitle: infoString
                        action: NULL
                        keyEquivalent: @"" 
                        atIndex: 0];
                  infoItem = [self itemAtIndex: 0];
                  infoMenu = [NSMenu new];
                  [self setSubmenu: infoMenu forItem: infoItem];
                  RELEASE(infoMenu);

                  for (i = 0; i < k; i++)
                    {
                      NSMenuItem *anItem = [array objectAtIndex: i];
                  
                      [appMenu removeItem: anItem];
                      [infoMenu addItem: anItem];
                    }
                }
              else
                {
                  // No service menu, or it is the first item.
                  // We still look for an info item.
                  NSMenuItem *anItem = [array objectAtIndex: 0];
                  NSString *title = [anItem title];

                  // The menu may not be localized, so we have to 
                  // check both the English and the local version.
                  if ([title isEqual: @"Info"] ||
                      [title isEqual: infoString])
                    {
                      [appMenu removeItem: anItem];
                      [self insertItem: anItem atIndex: 0];
                      k = 1;
                    }
                  else
                    {
                      k = 0;
                    }
                }

              // Copy the remaining entries.
              for (i = k; i < [array count]; i++)
                {
                  NSMenuItem *anItem = [array objectAtIndex: i];
                  
                  [appMenu removeItem: anItem];
                  [self addItem: anItem];
                }

              [self removeItem: appItem];
            }
        }  
    }

  // recurse over all submenus
  for (i = 0; i < [_items count]; i++)
    {
      NSMenuItem *anItem = [_items objectAtIndex: i];
      NSMenu *submenu = [anItem submenu];

      if (submenu != nil)
        {
          if ([submenu isTransient])
            {
              [submenu closeTransient];
            }
          [submenu close];
          [submenu _organizeMenu];
        }
    }

  [[self menuRepresentation] update];
  [self sizeToFit];
}

- (void) _setGeometry
{
  NSPoint        origin;

  if (_menu.horizontal == YES)
    {
      origin = NSMakePoint (0, [[NSScreen mainScreen] frame].size.height
	- [_aWindow frame].size.height);
      [_aWindow setFrameOrigin: origin];
      [_bWindow setFrameOrigin: origin];
    }
  else
    {
      NSString       *key;

      if (nil != (key = [self _locationKey]))
	{
	  NSUserDefaults *defaults;
	  NSDictionary   *menuLocations;
	  NSString       *location;

	  defaults = [NSUserDefaults standardUserDefaults];
	  menuLocations = [defaults objectForKey: NSMenuLocationsKey];

	  if ([menuLocations isKindOfClass: [NSDictionary class]])
	    location = [menuLocations objectForKey: key];
	  else
	    location = nil;
     
	  if (location && [location isKindOfClass: [NSString class]])
	    {
	      [_aWindow setFrameFromString: location];
	      [_bWindow setFrameFromString: location];
	      return;
	    }
	}
      
      if ((_aWindow != nil) && ([_aWindow screen] != nil))
        {
          origin = NSMakePoint(0, [[_aWindow screen] visibleFrame].size.height 
                               - [_aWindow frame].size.height);
	  
          [_aWindow setFrameOrigin: origin];
          [_bWindow setFrameOrigin: origin];
        }
    }
}

/**
   Save the current menu position in the standard user defaults
*/
- (void) _updateUserDefaults: (id) notification
{
  if (_menu.horizontal == NO)
    {
      NSString *key;

      NSDebugLLog (@"NSMenu", @"Synchronizing user defaults");
      key = [self _locationKey];
      if (key != nil)
        {
          NSUserDefaults	*defaults;
          NSMutableDictionary	*menuLocations;
          NSString		*locString;

          defaults = [NSUserDefaults standardUserDefaults];
          menuLocations = [defaults objectForKey: NSMenuLocationsKey];
          if ([menuLocations isKindOfClass: [NSDictionary class]])
            menuLocations = AUTORELEASE([menuLocations mutableCopy]);
          else
            menuLocations = nil;

          if ([_aWindow isVisible]
              && ([self isTornOff] || ([self _isMain])))
            {
              if (menuLocations == nil)
                {
                  menuLocations = AUTORELEASE([[NSMutableDictionary alloc]
                                                  initWithCapacity: 2]);
                }
              locString = [[self window] stringWithSavedFrame];
              [menuLocations setObject: locString forKey: key];
            }
          else
            {
              [menuLocations removeObjectForKey: key];
            }
          
          if ([menuLocations count] > 0)
            {
              [defaults setObject: menuLocations
                        forKey: NSMenuLocationsKey];
            }
          else
            {
              [defaults removeObjectForKey: NSMenuLocationsKey];
            }
          [defaults synchronize];
        }
    }
}

- (void) _rightMouseDisplay: (NSEvent*)theEvent
{
  [[GSTheme theme] rightMouseDisplay: self
			    forEvent: theEvent];
}

- (BOOL) _isVisible
{
  return [_aWindow isVisible] || [_bWindow isVisible];
}

- (BOOL) _isMain
{
  return [NSApp mainMenu] == self;
}

@end


@implementation NSMenu

/*
 * Class Methods
 */
+ (void) initialize
{
  if (self == [NSMenu class])
    {
      [self setVersion: 1];
      nc = [NSNotificationCenter defaultCenter];
    }
}

+ (void) setMenuZone: (NSZone*)zone
{
  menuZone = zone;
}

+ (NSZone*) menuZone
{
  return menuZone;
}

+ (BOOL) menuBarVisible
{
  return menuBarVisible;
}

+ (void) setMenuBarVisible: (BOOL)flag
{
  menuBarVisible = flag;
}

/*
 *
 */
- (id) init
{
  return [self initWithTitle: [[NSProcessInfo processInfo] processName]];
}

- (void) dealloc
{
  [nc removeObserver: self];

  // Now clean the pointer to us stored each _items element
  [_items makeObjectsPerformSelector: @selector(setMenu:) withObject: nil];

  RELEASE(_notifications);
  RELEASE(_title);
  RELEASE(_items);
  [_view setMenu: nil];
  RELEASE(_view);
  RELEASE(_aWindow);
  RELEASE(_bWindow);
  RELEASE(_name);

  [super dealloc];
}

/*
   
*/
- (id) initWithTitle: (NSString*)aTitle
{
  NSMenuView *menuRep;

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

  // Keep the title.
  ASSIGN(_title, aTitle);

  // Create an array to store our menu items.
  _items = [[NSMutableArray alloc] init];

  _menu.changedMessagesEnabled = YES;
  _notifications = [[NSMutableArray alloc] init];
  _menu.needsSizing = YES;
  // According to the spec, menus do autoenable by default.
  _menu.autoenable = YES;


  /* Please note that we own all this menu network of objects.  So, 
     none of these objects should be retaining us.  When we are deallocated,
     we release all the objects we own, and that should cause deallocation
     of the whole menu network.  */

  // Create the windows that will display the menu.
  _aWindow = [self _createWindow];
  _bWindow = [self _createWindow];
  [_bWindow setLevel: NSPopUpMenuWindowLevel];

  // Create a NSMenuView to draw our menu items.
  menuRep = [[NSMenuView alloc] initWithFrame: NSZeroRect];
  [self setMenuRepresentation: menuRep];
  RELEASE(menuRep);

  /* Set up the notification to start the process of redisplaying
     the menus where the user left them the last time.  
     
     Use NSApplicationDidFinishLaunching, and not
     NSApplicationWillFinishLaunching, so that the programmer can set
     up menus in NSApplicationWillFinishLaunching.
  */
  [nc addObserver: self
      selector: @selector(applicationDidFinishLaunching:)
      name: NSApplicationDidFinishLaunchingNotification 
      object: NSApp];

  [nc addObserver: self
      selector: @selector(_showOnActivateApp:)
      name: NSApplicationWillBecomeActiveNotification 
      object: NSApp];

  [nc addObserver: self
      selector: @selector (_menuMoved:)
      name: NSWindowDidMoveNotification
      object: _aWindow];

  [nc addObserver: self
      selector: @selector (_updateUserDefaults:)
      name: NSEnqueuedMenuMoveName
      object: self];
  
  return self;
}

/*
 * Setting Up the Menu Commands
 */

 - (void) menuChanged
{
  // propagate notification up to the main menu
  if ([self _isMain])
    _menu.mainMenuChanged = YES;
  else
    [[self supermenu] menuChanged];
}

- (void) insertItem: (id <NSMenuItem>)newItem
	    atIndex: (NSInteger)index
{
  NSNotification *inserted;
  NSDictionary   *d;

  if (![(id)newItem conformsToProtocol: @protocol(NSMenuItem)])
    {
      NSLog(@"You must use an object that conforms to NSMenuItem.\n");
      return;
    }

  /*
   * If the item is already attached to another menu it
   * isn't added.
   */
  if ([newItem menu] != nil)
    {
      NSLog(@"The object %@ is already attached to a menu, then it isn't possible to add it.\n", newItem);
      return;
    }
  
  [_items insertObject: newItem atIndex: index];
  _menu.needsSizing = YES;
  [(NSMenuView*)_view setNeedsSizing: YES];
  
  // Create the notification for the menu representation.
  d = [NSDictionary
	  dictionaryWithObject: [NSNumber numberWithInteger: index]
	  forKey: @"NSMenuItemIndex"];
  inserted = [NSNotification
		 notificationWithName: NSMenuDidAddItemNotification
		 object: self
		 userInfo: d];
  
  if (_menu.changedMessagesEnabled)
    [nc postNotification: inserted];
  else
    [_notifications addObject: inserted];
  [self menuChanged];

  // Set this after the insert notification has been sent.
  [newItem setMenu: self];
}

- (id <NSMenuItem>) insertItemWithTitle: (NSString*)aString
			         action: (SEL)aSelector
			  keyEquivalent: (NSString*)charCode 
			        atIndex: (NSInteger)index
{
  NSMenuItem *anItem = [[NSMenuItem alloc] initWithTitle: aString
					   action: aSelector
					   keyEquivalent: charCode];

  // Insert the new item into the menu.
  [self insertItem: anItem atIndex: index];

  // For returns sake.
  return AUTORELEASE(anItem);
}

- (void) addItem: (id <NSMenuItem>)newItem
{
  [self insertItem: newItem atIndex: [_items count]];
}

- (id <NSMenuItem>) addItemWithTitle: (NSString*)aString
			      action: (SEL)aSelector 
		       keyEquivalent: (NSString*)keyEquiv
{
  return [self insertItemWithTitle: aString
			    action: aSelector
		     keyEquivalent: keyEquiv
			   atIndex: [_items count]];
}

- (void) removeItem: (id <NSMenuItem>)anItem
{
  NSInteger index = [self indexOfItem: anItem];

  if (-1 == index)
    return;

  [self removeItemAtIndex: index];
}

- (void) removeItemAtIndex: (NSInteger)index
{
  NSNotification *removed;
  NSDictionary	 *d;
  id		 anItem = [_items objectAtIndex: index];

  if (!anItem)
    return;

  [anItem setMenu: nil];
  [_items removeObjectAtIndex: index];
  _menu.needsSizing = YES;
  [(NSMenuView*)_view setNeedsSizing: YES];
  
  d = [NSDictionary dictionaryWithObject: [NSNumber numberWithInteger: index]
		    forKey: @"NSMenuItemIndex"];
  removed = [NSNotification
		notificationWithName: NSMenuDidRemoveItemNotification
		object: self
		userInfo: d];
  
  if (_menu.changedMessagesEnabled)
    [nc postNotification: removed];
  else
    [_notifications addObject: removed];
  [self menuChanged];
}

- (void) itemChanged: (id <NSMenuItem>)anObject
{
  NSNotification *changed;
  NSDictionary   *d;
  NSInteger index = [self indexOfItem: anObject];

  if (-1 == index)
    return;

  _menu.needsSizing = YES;
  [(NSMenuView*)_view setNeedsSizing: YES];

  d = [NSDictionary dictionaryWithObject: [NSNumber numberWithInteger: index]
		    forKey: @"NSMenuItemIndex"];
  changed = [NSNotification
	      notificationWithName: NSMenuDidChangeItemNotification
	                    object: self
	                  userInfo: d];

  if (_menu.changedMessagesEnabled)
    [nc postNotification: changed];
  else
    [_notifications addObject: changed];
  [self menuChanged];

  // Update the menu.
  [self update];
}

/*
 * Finding Menu Items
 */
- (id <NSMenuItem>) itemWithTag: (NSInteger)aTag
{
  NSUInteger i;
  NSUInteger count = [_items count];

  for (i = 0; i < count; i++)
    {
      id menuItem = [_items objectAtIndex: i];

      if ([menuItem tag] == aTag)
        return menuItem;
    }
  return nil;
}

- (id <NSMenuItem>) itemWithTitle: (NSString*)aString
{
  NSUInteger i;
  NSUInteger count = [_items count];

  for (i = 0; i < count; i++)
    {
      id menuItem = [_items objectAtIndex: i];

      if ([[menuItem title] isEqualToString: aString])
        return menuItem;
    }
  return nil;
}

- (NSMenuItem *) itemAtIndex: (NSInteger)index
{
  if (index >= [_items count] || index < 0)
    [NSException  raise: NSRangeException
		 format: @"Range error in method -itemAtIndex: "];

  return [_items objectAtIndex: index];
}

- (NSInteger) numberOfItems
{
  return [_items count];
}

- (NSArray*) itemArray
{
  return (NSArray*)_items;
}

/*
 * Finding Indices of Menu Items
 */
- (NSInteger) indexOfItem: (id <NSMenuItem>)anObject
{
  NSUInteger index;

  index = [_items indexOfObjectIdenticalTo: anObject];

  if (index == NSNotFound)
    return -1;
  else
    return index;
}

- (NSInteger) indexOfItemWithTitle: (NSString*)aTitle
{
  id anItem;

  if ((anItem = [self itemWithTitle: aTitle]))
    return [_items indexOfObjectIdenticalTo: anItem];
  else
    return -1;
}

- (NSInteger) indexOfItemWithTag: (NSInteger)aTag
{
  id anItem;

  if ((anItem = [self itemWithTag: aTag]))
    return [_items indexOfObjectIdenticalTo: anItem];
  else
    return -1;
}

- (NSInteger) indexOfItemWithTarget: (id)anObject
		    andAction: (SEL)actionSelector
{
  NSUInteger i;
  NSUInteger count = [_items count];

  for (i = 0; i < count; i++)
    {
      NSMenuItem *menuItem = [_items objectAtIndex: i];

      if (actionSelector == 0 || sel_isEqual([menuItem action], actionSelector))
        {
          // There are different possibilities to implement the check here
          if ([menuItem target] == anObject)
            {
              return i;
            }
        }
    }

  return -1;
}

- (NSInteger) indexOfItemWithRepresentedObject: (id)anObject
{
  NSUInteger i;
  NSUInteger count = [_items count];

  for (i = 0; i < count; i++)
    {
      if ([[[_items objectAtIndex: i] representedObject]
              isEqual: anObject])
        {
          return i;
        }
    }

  return -1;
}

- (NSInteger) indexOfItemWithSubmenu: (NSMenu *)anObject
{
  NSUInteger i;
  NSUInteger count = [_items count];

  for (i = 0; i < count; i++)
    {
      id item = [_items objectAtIndex: i];

      if ([item hasSubmenu] && 
          [[item submenu] isEqual: anObject])
        {
          return i;
        }
    }
  
  return -1;
}

//
// Managing Submenus.
//
- (void) setSubmenu: (NSMenu *)aMenu
	    forItem: (id <NSMenuItem>)anItem 
{
  [anItem setSubmenu: aMenu];
}

- (void) submenuAction: (id)sender
{
}


- (NSMenu *) attachedMenu
{
  if (_attachedMenu && _menu.transient
      && !_attachedMenu->_menu.transient)
    return nil;

  return _attachedMenu;
}


/**
   Look for the semantics in the header.  Note that
   this implementation works because there are ... cases:
   <enum>
   <item>
   This menu is transient, its supermenu is also transient.
   In this case we just do the check between the transient windows
   and everything is fine
   </item>
   <item>
   The menu is transient, its supermenu is not transient.
   This can go WRONG
   </item>
   </enum>
*/
- (BOOL) isAttached
{
  return _superMenu && [_superMenu attachedMenu] == self;
}

- (BOOL) isTornOff
{
  return _menu.is_tornoff;
}

- (NSPoint) locationForSubmenu: (NSMenu*)aSubmenu
{
  return [_view locationForSubmenu: aSubmenu];
}

- (NSMenu *) supermenu
{
  return _superMenu;
}

- (void) setSupermenu: (NSMenu *)supermenu
{
  /* The supermenu retains us (indirectly).  Do not retain it.  */
  _superMenu = supermenu;
}

//
// Enabling and Disabling Menu Items
//
- (void) setAutoenablesItems: (BOOL)flag
{
  _menu.autoenable = flag;
}

- (BOOL) autoenablesItems
{
  return _menu.autoenable;
}

- (void) _updateSubmenu
{
  if ([self _isVisible])
    {
      // Update the menu items when the menu is visible...
      [self update];
    }
  else
    {
      // ...else only progress to submenus
      NSUInteger i;
      NSUInteger count = [_items count];

      for (i = 0; i < count; i++)
        {
          NSMenuItem *item = [_items objectAtIndex: i];
          
          if ([item hasSubmenu])
            {
              [[item submenu] _updateSubmenu];
            }
        }
    }
}

- (void) update
{
  if (_delegate)
    {
      if ([_delegate respondsToSelector: @selector(menuNeedsUpdate:)])
        {
          [_delegate menuNeedsUpdate: self];
        }
      else if ([_delegate respondsToSelector: @selector(numberOfItemsInMenu:)])
        {
          NSInteger num;

          num = [_delegate numberOfItemsInMenu: self];
          if (num > 0)
            {
              BOOL cont = YES;
              NSInteger i = 0;
              NSInteger curr = [self numberOfItems];

              while (num < curr)
                {
                  [self removeItemAtIndex: --curr];
                }
              while (num > curr)
                {
                  [self insertItemWithTitle: @"" 
                        action: NULL
                        keyEquivalent: @"" 
                        atIndex: curr++];
                }

              // FIXME: Should only process the items we display
              while (cont && i < num)
                {
                  cont = [_delegate menu: self
                                    updateItem: (NSMenuItem*)[self itemAtIndex: i]
                                    atIndex: i
                                    shouldCancel: NO];
                  i++;
                }
            }
        }
    }

  // We use this as a recursion check.
  if (!_menu.changedMessagesEnabled)
    return;

  if ([self autoenablesItems])
    {
      NSUInteger i;
      NSUInteger count = [_items count];
      
      // Temporary disable automatic displaying of menu.
      [self setMenuChangedMessagesEnabled: NO];

      NS_DURING
	{
	  for (i = 0; i < count; i++)
	    {
	      NSMenuItem *item = [_items objectAtIndex: i];
	      SEL	      action = [item action];
	      id	      validator = nil;
	      BOOL	      wasEnabled = [item isEnabled];
	      BOOL	      shouldBeEnabled;

	      if ([item hasSubmenu])
                {
                  [[item submenu] _updateSubmenu];
                }

	      // If there is no action - there can be no validator for the item.
	      if (action)
	        {
	          validator = [NSApp targetForAction: action 
				     to: [item target]
				     from: item];
	        }
	      else if (_popUpButtonCell != nil)
	        {
	          if (NULL != (action = [_popUpButtonCell action]))
	            {
		      validator = [NSApp targetForAction: action
				         to: [_popUpButtonCell target]
				         from: [_popUpButtonCell controlView]];
		    }
	        }

	      if (validator == nil)
	        {
	          if ((action == NULL) && (_popUpButtonCell != nil))
		    {
		      shouldBeEnabled = YES;
		    }
	          else 
		    {
		      shouldBeEnabled = NO;
		    }
	        }
	      else if ([validator
		         respondsToSelector: @selector(validateMenuItem:)])
	        {
	          shouldBeEnabled = [validator validateMenuItem: item];
	        }
	      else if ([validator
		         respondsToSelector: @selector(validateUserInterfaceItem:)])
	        {
	          shouldBeEnabled = [validator validateUserInterfaceItem: item];
	        }
              else if ([item hasSubmenu] && [[item submenu] numberOfItems] == 0)
                {
                  shouldBeEnabled = NO;
                }
 	      else
	        {
	          shouldBeEnabled = YES;
	        }

	      if (shouldBeEnabled != wasEnabled)
	        {
	          [item setEnabled: shouldBeEnabled];
	        }
	    }
          }
	NS_HANDLER
	  {
	    NSLog(@"Error Occurred While Updating Menu %@: %@", [self title], localException);
	  }
	NS_ENDHANDLER
      // Reenable displaying of menus
      [self setMenuChangedMessagesEnabled: YES]; // this will send pending _notifications
    }

  if (_menu.mainMenuChanged)
    {
      if (NSInterfaceStyleForKey(@"NSMenuInterfaceStyle", nil) == NSWindows95InterfaceStyle)
        {
          [[GSTheme theme] updateAllWindowsWithMenu: self];
        }
      _menu.mainMenuChanged = NO;
    }

  if (_menu.needsSizing && [self _isVisible])
    {
      NSDebugLLog (@"NSMenu", @" Calling Size To Fit (A)");
      [self sizeToFit];
    }
  
  return;
}

//
// Handling Keyboard Equivalents
//
- (BOOL) performKeyEquivalent: (NSEvent*)theEvent
{
  NSUInteger i;
  NSUInteger count = [_items count];
  NSEventType type = [theEvent type];
  NSUInteger modifiers = [theEvent modifierFlags];
  NSString *keyEquivalent = [theEvent charactersIgnoringModifiers];
  NSUInteger relevantModifiersMask = NSCommandKeyMask | NSAlternateKeyMask | NSControlKeyMask;

  if ((type != NSKeyDown && type != NSKeyUp) || [keyEquivalent length] == 0)
    return NO;
             
  /* Take shift key into account only for control keys and arrow and function keys */
  if ((modifiers & NSFunctionKeyMask)
      || ([keyEquivalent length] > 0 && [[NSCharacterSet controlCharacterSet] characterIsMember:[keyEquivalent characterAtIndex:0]]))
    relevantModifiersMask |= NSShiftKeyMask;

  if (![self _isVisible])
    {
      // Need to enable items as the automatic mechanism is switched off for invisible menus 
      [self update];
    }
  
  for (i = 0; i < count; i++)
    {
      NSMenuItem *item = [_items objectAtIndex: i];
                                    
      if ([item hasSubmenu])
        {
	  /* Ignore the Services submenu during menu traversal so that its key
	     equivalents do not accidentally shadow standard key equivalents
	     in the application's own menus. NSApp calls -performKeyEquivalent:
	     explicitly for the Services menu when no matching key equivalent
	     was found here (see NSApplication -sendEvent:).
	     Note: Shadowing is no problem for a standard OpenStep menu, where
	     the Services menu appears close to the end of the main menu, but
	     is very likely for Macintosh or Windows 95 interface styles, where
	     the Services menu appears in the first submenu of the main menu. */
	  // FIXME Should really remove conflicting key equivalents from the
	  // menus so that users don't get confused.
	  if ([item submenu] == [NSApp servicesMenu])
	    continue;
          // Recurse through submenus whether active or not.
          if ([[item submenu] performKeyEquivalent: theEvent])
            {
              // The event has been handled by an item in the submenu.
              return YES;
            }
        }
      else
        {
          NSUInteger mask = [item keyEquivalentModifierMask];

          if ([[item keyEquivalent] isEqualToString: keyEquivalent] 
            && (modifiers & relevantModifiersMask) == (mask & relevantModifiersMask))
            {
              if ([item isEnabled])
                {
                  [_view performActionWithHighlightingForItemAtIndex: i];
                }
              return YES;
            }
        }
    }
  return NO; 
}

//
// Simulating Mouse Clicks
//
- (void)  performActionForItemAtIndex: (NSInteger)index
{
  id<NSMenuItem> item = [_items objectAtIndex: index];
  NSDictionary *d;
  SEL action;

  if (![item isEnabled])
    return;

  // Send the actual action and the stipulated notifications.
  d = [NSDictionary dictionaryWithObject: item forKey: @"MenuItem"];
  [nc postNotificationName: NSMenuWillSendActionNotification
                    object: self
                  userInfo: d];


  if (_popUpButtonCell != nil)
    {
      // Tell the popup button, which item was selected
      [_popUpButtonCell selectItemAtIndex: index];
    }

  if ((action = [item action]) != NULL)
    {
      [NSApp sendAction: action
	     to: [item target]
	     from: item];
    }
  else if (_popUpButtonCell != nil)
    {
      if ((action = [_popUpButtonCell action]) != NULL)
	[NSApp sendAction: action
	       to: [_popUpButtonCell target]
	       from: [_popUpButtonCell controlView]];
    }

  [nc postNotificationName: NSMenuDidSendActionNotification
                    object: self
                  userInfo: d];
}

//
// Setting the Title
//
- (void) setTitle: (NSString*)aTitle
{
  ASSIGN(_title, aTitle);

  _menu.needsSizing = YES;
  [(NSMenuView*)_view setNeedsSizing: YES];
  if ([self _isVisible])
    {
      [self sizeToFit];
    }
}
  
- (NSString*) title
{
  return _title;
}

- (id) delegate
{
  return _delegate;
}

- (void) setDelegate: (id)delegate
{
  _delegate = delegate;
}

- (float) menuBarHeight
{
  // FIXME
  return [NSMenuView menuBarHeight];
}

//
// Setting the Representing Object
//
- (void) setMenuRepresentation: (id)menuRep
{
  NSView *contentView;

  if (![menuRep isKindOfClass: [NSMenuView class]])
    {
      NSLog(@"You must use an NSMenuView, or a derivative thereof.\n");
      return;
    }

  /* If we are replacing a menu representation with a new version,
   * we should display it in the same view as the old representation.
   * If we can't find a view for that, we display in the content view
   * of our default window.
   */
  if ([_view superview] == nil)
    {
      contentView = [_aWindow contentView];
    }
  else
    {
      contentView = [_view superview];
    }

  if (_view == menuRep)
    {
      /* Hack ... if the representation was 'borrowed' for an in-window
       * menu, we will still have it recorded as ours, but it won't be
       * in our view hierarchy, so we have to re-add it.
       */
      /*
      if (contentView != [menuRep superview])
	{
          [contentView addSubview: menuRep];
	}
      */
      return;
    }

  _menu.horizontal = [menuRep isHorizontal];

  if (_view != nil)
    {
      // remove the old representation
      [_view removeFromSuperview];
      [_view setMenu: nil];
    }

  ASSIGN(_view, menuRep);
  [_view setMenu: self];

  // add the new representation
  [contentView addSubview: _view];
}

- (id) menuRepresentation
{
  return _view;
}

- (id) contextMenuRepresentation
{
  return nil;
}

- (void) setContextMenuRepresentation: (id)representation
{
}

- (id) tearOffMenuRepresentation
{
  return nil;
}

- (void) setTearOffMenuRepresentation: (id)representation
{
}

//
// Updating the Menu Layout
//
// Wim 20030301: Question, what happens when the notification trigger
// new notifications?  I think it is not allowed to add items
// to the _notifications array while enumerating it.
- (void) setMenuChangedMessagesEnabled: (BOOL)flag
{ 
  if (_menu.changedMessagesEnabled != flag)
    {
      if (flag)
	{
	  if ([_notifications count])
	    {
	      NSEnumerator *enumerator = [_notifications objectEnumerator];
	      id            aNotification;

	      while ((aNotification = [enumerator nextObject]))
		[nc postNotification: aNotification];
	    }

	  // Clean the notification array.
	  [_notifications removeAllObjects];
	}

      _menu.changedMessagesEnabled = flag;
    }
}
 
- (BOOL) menuChangedMessagesEnabled
{
  return _menu.changedMessagesEnabled;
}

- (void) sizeToFit
{
  NSRect oldWindowFrame;
  NSRect newWindowFrame;
  NSRect menuFrame;

  [_view sizeToFit];
  
  menuFrame = [_view frame];
  
  // Main
  oldWindowFrame = [_aWindow frame];
  newWindowFrame = [NSWindow frameRectForContentRect: menuFrame
                             styleMask: [_aWindow styleMask]];
  
  if (oldWindowFrame.size.height > 1)
    {
      newWindowFrame.origin = NSMakePoint (oldWindowFrame.origin.x,
                                           oldWindowFrame.origin.y
                                           + oldWindowFrame.size.height
                                           - newWindowFrame.size.height);
    }
  [_aWindow setFrame: newWindowFrame display: NO];
  
  // Transient
  oldWindowFrame = [_bWindow frame];
  newWindowFrame = [NSWindow frameRectForContentRect: menuFrame
                             styleMask: [_bWindow styleMask]];
  if (oldWindowFrame.size.height > 1)
    {
      newWindowFrame.origin = NSMakePoint (oldWindowFrame.origin.x,
                                           oldWindowFrame.origin.y
                                           + oldWindowFrame.size.height
                                           - newWindowFrame.size.height);
    }
  [_bWindow setFrame: newWindowFrame display: NO];
  
  if (_popUpButtonCell == nil)
    {
      [_view setFrameOrigin: NSMakePoint (0, 0)];
    }
  
  [_view setNeedsDisplay: YES];
  
  _menu.needsSizing = NO;
}

/*
 * Displaying Context Sensitive Help
 */
- (void) helpRequested: (NSEvent *)event
{
  // TODO: Won't be implemented until we have NSHelp*
}

+ (void) popUpContextMenu: (NSMenu*)menu
		withEvent: (NSEvent*)event
		  forView: (NSView*)view
{
  [self popUpContextMenu: menu 
        withEvent: event 
        forView: view 
        withFont: nil];
}

+ (void) popUpContextMenu: (NSMenu *)menu 
                withEvent: (NSEvent *)event 
                  forView: (NSView *)view 
                 withFont: (NSFont *)font
{
  [menu _rightMouseDisplay: event];
}

/*
 * NSObject Protocol
 */
- (BOOL) isEqual: (id)anObject
{
  if (self == anObject)
    return YES;
  if ([anObject isKindOfClass: [NSMenu class]])
    {
      if (![_title isEqualToString: [anObject title]])
	return NO;
      return [[self itemArray] isEqual: [anObject itemArray]];
    }
  return NO;
}

/*
 * NSCoding Protocol
 */
- (void) encodeWithCoder: (NSCoder*)encoder
{
  if ([encoder allowsKeyedCoding])
    {
      [encoder encodeObject: _title forKey: @"NSTitle"];
      [encoder encodeObject: _items forKey: @"NSMenuItems"];
      
      if ([self _isMain])
	{
	  [encoder encodeObject: @"_NSMainMenu" forKey: @"NSName"];
	}
    }
  else
    {
      BOOL autoenable = _menu.autoenable;

      [encoder encodeObject: _title];
      [encoder encodeObject: _items];
      [encoder encodeValueOfObjCType: @encode(BOOL) at: &autoenable];
    }
}

- (id) initWithCoder: (NSCoder*)aDecoder
{
  NSString	*dTitle;
  NSString	*dName;
  NSArray	*dItems;
  BOOL		dAuto;
  NSUInteger i;
  NSUInteger count;

  if ([aDecoder allowsKeyedCoding])
    {
      //
      // NSNoAutoenable is present when the "Autoenable" option is NOT checked.
      // NO = Autoenable menus, YES = Don't auto enable menus.  We, therefore,
      // have to invert the values of this flag in order to get the value of
      // dAuto.
      //
      if ([aDecoder containsValueForKey: @"NSNoAutoenable"])
        {
	  dAuto = ![aDecoder decodeBoolForKey: @"NSNoAutoenable"];
	}
      else
	{
	  dAuto = YES;
	}
      dTitle = [aDecoder decodeObjectForKey: @"NSTitle"];
      dItems = [aDecoder decodeObjectForKey: @"NSMenuItems"];
      if ([aDecoder containsValueForKey: @"NSName"])
        {
	  dName = [aDecoder decodeObjectForKey: @"NSName"];
	}
      else
	{
	  dName = nil;
	}
    }
  else
    {
      dTitle = [aDecoder decodeObject];
      dItems = [aDecoder decodeObject];
      dName = nil;
      [aDecoder decodeValueOfObjCType: @encode(BOOL) at: &dAuto];
    }
  self = [self initWithTitle: dTitle];
  [self setAutoenablesItems: dAuto];
  [self _setName: dName];

  [self setMenuChangedMessagesEnabled: NO];
  /*
   * Make sure that items and submenus are set correctly.
   */
  count = [dItems count];
  for (i = 0; i < count; i++)
    {
      NSMenuItem *item = [dItems objectAtIndex: i];
      [self addItem: item];
    }
  [self setMenuChangedMessagesEnabled: YES];

  return self;
}

- (void) awakeFromNib
{
  NSString *name = [self _name];

  if (name)
    {
      if ([name isEqualToString: @"_NSMainMenu"])
        {
          // NB This is already handled by the nib loading code
          //[NSApp setMainMenu: self];
        }
      else if ([name isEqualToString: @"_NSAppleMenu"])
        {
          // GNUstep does not handle Apple's application menu specially
        }
      else if ([name isEqualToString: @"_NSWindowsMenu"])
        {
          [NSApp setWindowsMenu: self];
        }
      else if ([name isEqualToString: @"_NSServicesMenu"])
        {
          [NSApp setServicesMenu: self];
        }
      else if ([name isEqualToString: @"_NSRecentDocumentsMenu"])
        {
          [[NSDocumentController sharedDocumentController]
                  _setRecentDocumentsMenu: self];
        }
      else if ([name isEqualToString: @"_NSFontMenu"])
        {
          [[NSFontManager sharedFontManager] setFontMenu: self];
        }
    }
}

/*
 * NSCopying Protocol
 */
- (id) copyWithZone: (NSZone*)zone
{
  NSMenu *new = [[NSMenu allocWithZone: zone] initWithTitle: _title];
  NSUInteger i;
  NSUInteger count = [_items count];

  [new setAutoenablesItems: _menu.autoenable];
  for (i = 0; i < count; i++)
    {
      // This works because the copy on NSMenuItem sets the menu to nil!!!
      NSMenuItem *item = [[_items objectAtIndex: i] copyWithZone: zone];
      [new insertItem: item atIndex: i];
      RELEASE(item);
    }
  
  return new;
}

@end

@implementation NSMenu (GNUstepExtra)

- (void) setTornOff: (BOOL)flag
{
  NSMenu *supermenu;

  _menu.is_tornoff = flag; 

  if (flag)
    {
      supermenu = [self supermenu];
      if (supermenu != nil)
        {
          [[supermenu menuRepresentation] setHighlightedItemIndex: -1];
          supermenu->_attachedMenu = nil;
        }
    }
  [_view update];
}

- (void) _showTornOffMenuIfAny: (NSNotification*)notification
{
  NSInterfaceStyle style = NSInterfaceStyleForKey(@"NSMenuInterfaceStyle", nil);
  if (style == NSMacintoshInterfaceStyle
    || style == NSWindows95InterfaceStyle)
    {
      return;
    }
  if (![self _isMain])
    {
      NSString		*key;

      key = [self _locationKey];
      if (key != nil)
	{
	  NSString		*location;
	  NSUserDefaults	*defaults;
	  NSDictionary		*menuLocations;

	  defaults  = [NSUserDefaults standardUserDefaults];
	  menuLocations = [defaults objectForKey: NSMenuLocationsKey];

	  if ([menuLocations isKindOfClass: [NSDictionary class]])
	    location = [menuLocations objectForKey: key];
	  else
	    location = nil;
	  if (location && [location isKindOfClass: [NSString class]])
	    {
	      [self setTornOff: YES];
	      [self display];
	    }
	}
    }
}

- (void) applicationDidFinishLaunching:(NSNotification *)notification
{
  if (NSInterfaceStyleForKey(@"NSMenuInterfaceStyle", nil) == 
      NSWindows95InterfaceStyle)
    {
      [[GSTheme theme] updateAllWindowsWithMenu: [NSApp mainMenu]];
    }
  [self _showTornOffMenuIfAny: notification];
}

- (void) _showOnActivateApp: (NSNotification*)notification
{
  if ([self _isMain])
  {
    [self display];
    // we must make sure that any attached submenu is visible too.
    [[self attachedMenu] display];
  }
}

- (BOOL) isTransient
{
  return _menu.transient;
} 

- (BOOL) isPartlyOffScreen
{
  NSWindow *window;

  window = [self window];
  if ((nil != window) && (nil != [window screen]))
    {
      return !NSContainsRect([[window screen] visibleFrame], [window frame]);
    }
  else
    {
      NSLog(@"Menu has no window %@ or screen %@", window, [window screen]);
      return YES;
    }
}

- (void) _performMenuClose: (id)sender
{
  if (_attachedMenu)
    [_view detachSubmenu];
  
  [_view setHighlightedItemIndex: -1];
  [self close];
  [self setTornOff: NO];
  [self _updateUserDefaults: nil];
} 

- (void) display
{
  if (_menu.transient)
    {
      NSDebugLLog (@"NSMenu", 
                   @"trying to display while already displayed transient");
    }

  [self update];
  if (_menu.needsSizing)
    {
      [self sizeToFit];
    }
  
  if (_superMenu && ![self isTornOff])
    {                 
      // query super menu for position
      [_aWindow setFrameOrigin: [_superMenu locationForSubmenu: self]];
      _superMenu->_attachedMenu = self;
    }
  else if ([_aWindow frame].origin.y <= 0 
    && _popUpButtonCell == nil)   // get geometry only if not set
    {
      [self _setGeometry];
    }
  
  NSDebugLLog (@"NSMenu", 
               @"Display, origin: %@", 
               NSStringFromPoint ([_aWindow frame].origin));
  
  [_aWindow orderFrontRegardless];
}

- (void) displayTransient
{
  NSPoint location;
  NSView *contentView;

  if (_menu.transient)
    {
      NSDebugLLog (@"NSMenu", @"displaying transient while it is transient");
      return;
    }

  [self update];
  if (_menu.needsSizing)
    {
      [self sizeToFit];
    }
  
  _oldHiglightedIndex = [[self menuRepresentation] highlightedItemIndex];
  _menu.transient = YES;
  
  /*
   * Cache the old submenu if any and query the supermenu our position.
   * Otherwise, raise menu under the mouse.
   */
  if (_superMenu != nil)
    {
      _oldAttachedMenu = _superMenu->_attachedMenu;
      _superMenu->_attachedMenu = self;
      location = [_superMenu locationForSubmenu: self];
    }
  else
    {
      NSRect	frame = [_aWindow frame];
      NSInterfaceStyle style;

      location = [_aWindow mouseLocationOutsideOfEventStream];
      location = [_aWindow convertBaseToScreen: location];
      location.y -= frame.size.height;

      /* When using the standard NextStep/OpenStep interface style, the
	 center of the menu's title view is placed below the mouse cursor.
	 However, in Macintosh and Windows95 styles, menus have no visible
	 title. To prevent the user from accidentally selecting the first
	 item, the top left edge is placed below the mouse cursor for them. */
      style = NSInterfaceStyleForKey(@"NSMenuInterfaceStyle", nil);
      if (style != NSWindows95InterfaceStyle &&
	  style != NSMacintoshInterfaceStyle)
	{
	  location.x -= frame.size.width/2;
	  if (location.x < 0)
	    location.x = 0;
	  location.y += 10;
	}
    }

  [_bWindow setFrameOrigin: location];

  [_view removeFromSuperviewWithoutNeedingDisplay];

  contentView = [_bWindow contentView];
  [contentView addSubview: _view];

  [_view update];

  [_bWindow orderFront: self];

  /* Right mouse buttons which display transient menus don't update
   * the cursor. So, the current cursor is displayed over the
   * contextual menu (for example an I beam). However, when menu is
   * closed the cursor pop, this can set a wrong cursor. We push here
   * an arrow cursor, the cursor we want at menus. Being sure that
   * this will pop when menu closes.
   */
  [[NSCursor arrowCursor] push];
}

- (void) close
{
  NSMenu *sub = [self attachedMenu];

  if (_menu.transient)
    {
      NSDebugLLog (@"NSMenu", @"We should not close ordinary menu while transient version is still open");
    }
  
  /*
   * If we have an attached submenu, we must close that too - but then make
   * sure we still have a record of it so that it can be re-displayed if we
   * are redisplayed.
   */
  if (sub != nil)
    {
      [sub close];
      _attachedMenu = sub;
    }
  [_aWindow orderOut: self];

  if (_superMenu && ![self isTornOff])
    {
      _superMenu->_attachedMenu = nil;
      [[_superMenu menuRepresentation] setHighlightedItemIndex: -1];
    }
}

- (void) closeTransient
{
  NSView *contentView;

  if (_menu.transient == NO)
    {
      NSDebugLLog (@"NSMenu",
	@"Closing transient: %@ while it is NOT transient now", _title);
      return;
    }
  
  [_bWindow orderOut: self];
  [_view removeFromSuperviewWithoutNeedingDisplay];

  contentView = [_aWindow contentView];
  [contentView addSubview: _view];

  [contentView setNeedsDisplay: YES]; 
  
  // Restore the old submenu (if any).
  if (_superMenu != nil)
    {
      _superMenu->_attachedMenu = _oldAttachedMenu;
      [[_superMenu menuRepresentation] setHighlightedItemIndex:
	[_superMenu indexOfItemWithSubmenu: _superMenu->_attachedMenu]];
    }

  [[self menuRepresentation] setHighlightedItemIndex: _oldHiglightedIndex];
  
  _menu.transient = NO;
  [_view update];
}

- (NSWindow*) window
{
  if (_menu.transient)
    return (NSWindow *)_bWindow;
  else
    return (NSWindow *)_aWindow;
}

- (void) setMain: (BOOL)isMain
{
  if (isMain)
    {
      NSMenuView	*oldRep;
      NSInterfaceStyle	oldStyle;
      NSInterfaceStyle	newStyle;

      oldRep = [self menuRepresentation];
      oldStyle = [oldRep interfaceStyle];
      newStyle = NSInterfaceStyleForKey(@"NSMenuInterfaceStyle", nil);
	  
      /*
       * If necessary, rebuild menu for (different) style
       */
      if (oldStyle != newStyle)
        {
          NSMenuView *newRep;

          if (oldStyle == NSWindows95InterfaceStyle)
            {
              /* Remove the menu from all main windows.
               */
              [[GSTheme theme] updateAllWindowsWithMenu: nil];
            }
          if (newStyle == NSWindows95InterfaceStyle)
            {
              [self close];
            }
          newRep = [[NSMenuView alloc] initWithFrame: NSZeroRect];
          if (newStyle == NSMacintoshInterfaceStyle
              || newStyle == NSWindows95InterfaceStyle)
            {
              [newRep setHorizontal: YES];
            }
          else
            {
              [newRep setHorizontal: NO];
            }
          [newRep setInterfaceStyle: newStyle];
          [self setMenuRepresentation: newRep];
          [self _organizeMenu];
          RELEASE(newRep);
          if (newStyle == NSWindows95InterfaceStyle)
            {
              /* Put menu in all main windows for microsoft style.
               */
              [[GSTheme theme] updateAllWindowsWithMenu: self];
            }
        }
      
      /* Adjust the menu window to suit the menu view unless the menu
       * is being displayed in the application main window.
       */
      if (newStyle != NSWindows95InterfaceStyle)
        {
          [[self window] setTitle: [[NSProcessInfo processInfo] processName]];
          [[self window] setLevel: NSMainMenuWindowLevel];
          [self _setGeometry];
          [self sizeToFit];

          if ([NSApp isActive])
            {
              [self display];
            }
        }
    }
  else 
    {
      [[self window] setLevel: NSSubmenuWindowLevel];
    }
}

/**
   Set the frame origin of the receiver to aPoint. If a submenu of
   the receiver is attached. The frame origin of the submenu is set
   appropriately.
*/
- (void) nestedSetFrameOrigin: (NSPoint) aPoint
{
  NSWindow *theWindow = [self window];

  // Move ourself and get our width.
  [theWindow setFrameOrigin: aPoint];

  // Do the same for attached menus.
  if (_attachedMenu)
    {
      aPoint = [self locationForSubmenu: _attachedMenu];
      [_attachedMenu nestedSetFrameOrigin: aPoint];
    }
}

#define SHIFT_DELTA 18.0

- (void) shiftOnScreen
{
  NSWindow *theWindow = [self window];
  NSRect    frameRect = [theWindow frame];
  NSRect    screenRect = [[theWindow screen] visibleFrame];
  NSPoint   vector    = {0.0, 0.0};
  BOOL      moveIt    = NO;
  NSPoint location = [theWindow mouseLocationOutsideOfEventStream];
  NSPoint pointerLoc = [theWindow convertBaseToScreen: location];
  NSInterfaceStyle style = NSInterfaceStyleForKey(@"NSMenuInterfaceStyle", nil);
  
  // Don't move the main menu bar in Macintosh interface style, this is
  // annoying (in particular, since the effective screen range is reduced
  // by the height of the menu bar!)
  if (style == NSMacintoshInterfaceStyle && [self _isMain])
    return;

  // 1 - determine the amount we need to shift in the y direction.
  if (pointerLoc.y <= 1 && NSMinY (frameRect) < 0)
    {
      vector.y = MIN (SHIFT_DELTA, -NSMinY (frameRect));
      moveIt = YES;
    }
  /* Note: pointerLoc.y may be greater than NSMaxY(screenRect) if we have a
     horizontal menu bar at the top of the screen (Macintosh interface style) */
  // FIXME Don't move the horizontal menu bar downward in this case!
  else if (pointerLoc.y >= NSMaxY(screenRect) &&
	   NSMaxY (frameRect) > NSMaxY (screenRect))
    {
      vector.y = -MIN (SHIFT_DELTA, NSMaxY (frameRect) - NSMaxY (screenRect));
      moveIt = YES;
    }

  // 2 - determine the amount we need to shift in the x direction.
  if (pointerLoc.x == 0 && NSMinX (frameRect) < 0)
    {
      vector.x = MIN (SHIFT_DELTA, -NSMinX (frameRect));
      moveIt = YES;
    }
  // Note the -3.  This is done so the menu, after shifting completely
  // has some spare room on the right hand side.  This is needed otherwise
  // the user can never access submenus of this menu.
  else if (pointerLoc.x == NSMaxX(screenRect) - 1 &&
	   NSMaxX (frameRect) > NSMaxX (screenRect) - 3)
    {
      vector.x
	= -MIN (SHIFT_DELTA, NSMaxX (frameRect) - NSMaxX (screenRect) + 3);
      moveIt = YES;
    }
  
  if (moveIt)
    {
      NSPoint  masterLocation;
      NSPoint  destinationPoint;
      
      if (style == NSMacintoshInterfaceStyle || _menu.horizontal)
        {
          masterLocation = frameRect.origin;
          destinationPoint.x = masterLocation.x + vector.x;
          destinationPoint.y = masterLocation.y + vector.y;
          [self nestedSetFrameOrigin: destinationPoint];
        }
      else
        {
          NSMenu  *candidateMenu;
          NSMenu  *masterMenu;
          
          // Look for the "master" menu, i.e. the one to move from.
          for (candidateMenu = masterMenu = self;
               (candidateMenu = masterMenu->_superMenu)
                   && !candidateMenu->_menu.horizontal
                   && (!masterMenu->_menu.is_tornoff
                       || masterMenu->_menu.transient);
               masterMenu = candidateMenu);
          
          masterLocation = [[masterMenu window] frame].origin;
          destinationPoint.x = masterLocation.x + vector.x;
          destinationPoint.y = masterLocation.y + vector.y;
          [masterMenu nestedSetFrameOrigin: destinationPoint];
        }
    }
}

- (BOOL)_ownedByPopUp
{
  return _popUpButtonCell != nil;
}

- (NSPopUpButtonCell *)_owningPopUp
{
  return _popUpButtonCell;
}

- (void)_setOwnedByPopUp: (NSPopUpButtonCell*)popUp
{
  if (_popUpButtonCell != popUp)
    {
      _popUpButtonCell = popUp;
      if (popUp != nil)
	{
	  [_aWindow setLevel: NSPopUpMenuWindowLevel];
	  [_bWindow setLevel: NSPopUpMenuWindowLevel];
	}
    }
  [self update];
}

- (NSString*) description
{
  return [NSString stringWithFormat: @"NSMenu: %@ (%@)",
            _title, _menu.transient ? @"Transient": @"Normal"];
}

@end