Cleanup and improvement of tracking of native windows in Cocoa; thanks to Marc Culler for patch

4 files changed, 74 insertions, 89 deletions

diff --git a/macosx/tkMacOSXEvent.c b/macosx/tkMacOSXEvent.c
index 73a67ad..6685b80 100644
--- a/macosx/tkMacOSXEvent.c
+++ b/macosx/tkMacOSXEvent.c
@@ -30,18 +30,19 @@ enum {
     NSEvent	    *processedEvent = theEvent;
     NSEventType	    type = [theEvent type];
     NSInteger	    subtype;
-    NSUInteger	    flags;
 
     switch ((NSInteger)type) {
     case NSAppKitDefined:
         subtype = [theEvent subtype];
 
 	switch (subtype) {
+	    /* Ignored at the moment. */
 	case NSApplicationActivatedEventType:
 	    break;
 	case NSApplicationDeactivatedEventType:
 	    break;
 	case NSWindowExposedEventType:
+	    break;
 	case NSScreenChangedEventType:
 	    break;
 	case NSWindowMovedEventType:
@@ -52,13 +53,12 @@ enum {
         default:
             break;
 	}
-	break;
+	break; /* AppkitEvent. Return theEvent */
     case NSKeyUp:
     case NSKeyDown:
     case NSFlagsChanged:
-	flags = [theEvent modifierFlags];
 	processedEvent = [self tkProcessKeyEvent:theEvent];
-	break;
+	break; /* Key event.  Return the processed event. */
     case NSLeftMouseDown:
     case NSLeftMouseUp:
     case NSRightMouseDown:
@@ -75,7 +75,7 @@ enum {
     case NSTabletPoint:
     case NSTabletProximity:
 	processedEvent = [self tkProcessMouseEvent:theEvent];
-	break;
+	break; /* Mouse event.  Return the processed event. */
 #if 0
     case NSSystemDefined:
         subtype = [theEvent subtype];
@@ -99,7 +99,7 @@ enum {
 #endif
 
     default:
-	break;
+	break; /* return theEvent */
     }
     return processedEvent;
 }
@@ -112,36 +112,32 @@ enum {
  *
  * TkMacOSXFlushWindows --
  *
- *	This routine flushes all the windows of the application. It is
+ *	This routine flushes all the visible windows of the application. It is
  *	called by XSync().
  *
  * Results:
  *	None.
  *
  * Side effects:
- *	Flushes all Carbon windows
+ *	Flushes all visible Cocoa windows
  *
  *----------------------------------------------------------------------
  */
-
 MODULE_SCOPE void
 TkMacOSXFlushWindows(void)
 {
-    NSInteger windowCount;
-    NSInteger *windowNumbers;
+    /* This can be called from outside the Appkit event loop,
+     * so it needs its own AutoreleasePool.
+     */
+    NSAutoreleasePool *pool = [NSAutoreleasePool new];
+    NSArray *macWindows = [NSApp orderedWindows];
 
-    NSCountWindows(&windowCount);
-    if(windowCount) {
-	windowNumbers = (NSInteger *) ckalloc(windowCount * sizeof(NSInteger));
-	NSWindowList(windowCount, windowNumbers);
-	for (NSInteger index = 0; index < windowCount; index++) {
-	    NSWindow *w = [NSApp windowWithWindowNumber:windowNumbers[index]];
-	    if (TkMacOSXGetXWindow(w)) {
-		[w flushWindow];
-	    }
+    for (NSWindow *w in macWindows) {
+	if (TkMacOSXGetXWindow(w)) {
+	    [w flushWindow];
 	}
-	ckfree((char*) windowNumbers);
     }
+    [pool drain];
 }
 
 /*
diff --git a/macosx/tkMacOSXKeyEvent.c b/macosx/tkMacOSXKeyEvent.c
index c9ad9f1..09cdf94 100644
--- a/macosx/tkMacOSXKeyEvent.c
+++ b/macosx/tkMacOSXKeyEvent.c
@@ -78,16 +78,18 @@ static unsigned isFunctionKey(unsigned int code);
     case NSFlagsChanged:
 	modifiers = [theEvent modifierFlags];
 	keyCode = [theEvent keyCode];
-	w = [self windowWithWindowNumber:[theEvent windowNumber]];
+	//	w = [self windowWithWindowNumber:[theEvent windowNumber]];
+	w = [theEvent window];
 #if defined(TK_MAC_DEBUG_EVENTS) || NS_KEYLOG == 1
 	NSLog(@"-[%@(%p) %s] r=%d mods=%u '%@' '%@' code=%u c=%d %@ %d", [self class], self, _cmd, repeat, modifiers, characters, charactersIgnoringModifiers, keyCode,([charactersIgnoringModifiers length] == 0) ? 0 : [charactersIgnoringModifiers characterAtIndex: 0], w, type);
 #endif
 	break;
 
     default:
-	return theEvent;
+	return theEvent; /* Unrecognized key event. */
     }
 
+    /* Create an Xevent to add to the Tk queue. */
     if (!processingCompose) {
         unsigned int state = 0;
 
@@ -128,7 +130,7 @@ static unsigned isFunctionKey(unsigned int code);
         tkwin = (Tk_Window) winPtr->dispPtr->focusPtr;
         if (!tkwin) {
           TkMacOSXDbgMsg("tkwin == NULL");
-          return theEvent;
+          return theEvent;  /* Give up. No window for this event. */
         }
 
         /*
diff --git a/macosx/tkMacOSXMouseEvent.c b/macosx/tkMacOSXMouseEvent.c
index 89f0642..d1b4114 100644
--- a/macosx/tkMacOSXMouseEvent.c
+++ b/macosx/tkMacOSXMouseEvent.c
@@ -52,19 +52,17 @@ enum {
     case NSCursorUpdate:
 #if 0
 	trackingArea = [theEvent trackingArea];
-#endif
 	/* fall through */
+#endif
     case NSLeftMouseDown:
     case NSLeftMouseUp:
     case NSRightMouseDown:
     case NSRightMouseUp:
     case NSOtherMouseDown:
     case NSOtherMouseUp:
-
     case NSLeftMouseDragged:
     case NSRightMouseDragged:
     case NSOtherMouseDragged:
-
     case NSMouseMoved:
 #if 0
 	eventNumber = [theEvent eventNumber];
@@ -73,19 +71,17 @@ enum {
 	    buttonNumber = [theEvent buttonNumber];
 	}
 #endif
-
     case NSTabletPoint:
     case NSTabletProximity:
-
     case NSScrollWheel:
-	win = [self windowWithWindowNumber:[theEvent windowNumber]];
         break;
 
-    default:
+    default: /* Unrecognized mouse event. */
 	return theEvent;
-	break;
     }
 
+    /* Create an Xevent to add to the Tk queue. */
+    win = [theEvent window];
     NSPoint global, local = [theEvent locationInWindow];
     if (win) {
 	global = [win convertBaseToScreen:local];
@@ -103,7 +99,7 @@ enum {
 	tkwin = TkMacOSXGetCapture();
     }
     if (!tkwin) {
-	return theEvent;
+	return theEvent; /* Give up.  No window for this event. */
     }
 
     /*
@@ -203,7 +199,6 @@ enum {
 	    Tk_QueueWindowEvent(&xEvent, TCL_QUEUE_TAIL);
 	}
     }
-
     return theEvent;
 }
 @end
diff --git a/macosx/tkMacOSXWm.c b/macosx/tkMacOSXWm.c
index 23b107f..a852ac9 100644
--- a/macosx/tkMacOSXWm.c
+++ b/macosx/tkMacOSXWm.c
@@ -464,28 +464,20 @@ static TkWindow*
 FrontWindowAtPoint(
     int x, int y)
 {
-
     NSPoint p = NSMakePoint(x, tkMacOSXZeroScreenHeight - y);
-    NSWindow *win = nil;
-    NSInteger windowCount;
-    NSInteger *windowNumbers;
-
-    NSCountWindows(&windowCount);
-    if (windowCount) {
-	windowNumbers = (NSInteger *) ckalloc(windowCount * sizeof(NSInteger));
-	NSWindowList(windowCount, windowNumbers);
-	for (NSInteger index = 0; index < windowCount; index++) {
-	    NSWindow *w = [NSApp windowWithWindowNumber:windowNumbers[index]];
+    NSAutoreleasePool *pool = [NSAutoreleasePool new];
+    NSArray *windows = [NSApp orderedWindows];
+    TkWindow *front = NULL;
+
+    for (NSWindow *w in windows) {
 	    if (w && NSMouseInRect(p, [w frame], NO)) {
-		win = w;
+		front = TkMacOSXGetTkWindow(w);
 		break;
 	    }
 	}
-	ckfree((char *) windowNumbers);
-    }
-    return (win ? TkMacOSXGetTkWindow(win) : NULL);
+    [pool drain];
+    return front;
 }
-
 
 /*
  *----------------------------------------------------------------------
@@ -681,6 +673,7 @@ TkWmMapWindow(
      */
 
     XMapWindow(winPtr->display, winPtr->window);
+
 }
 
 /*
@@ -703,7 +696,7 @@ TkWmMapWindow(
 void
 TkWmUnmapWindow(
     TkWindow *winPtr)		/* Top-level window that's about to be
-				 * mapped. */
+				 * unmapped. */
 {
     XUnmapWindow(winPtr->display, winPtr->window);
 }
@@ -786,25 +779,30 @@ TkWmDeadWindow(
      */
 
     NSWindow *window = wmPtr->window;
+
     if (window && !Tk_IsEmbedded(winPtr) ) {
-	[[window parentWindow] removeChildWindow:window];
+	NSWindow *parent = [window parentWindow];
+	if (parent) {
+	    [parent removeChildWindow:window];
+	}
 	[window setExcludedFromWindowsMenu:YES];
 	[window close];
-    TkMacOSXUnregisterMacWindow(window);
-    if (winPtr->window) {
-             ((MacDrawable *) winPtr->window)->view = nil;
-         }
-    [window release];
-    wmPtr->window = NULL;
-    /* Activate the highest window left on the screen. */
-    NSArray *windows = [NSApp orderedWindows];
-    NSWindow *front = [windows objectAtIndex:0];
-    if ( front && [front canBecomeKeyWindow] ) {
-                [front makeKeyAndOrderFront:NSApp];
+	TkMacOSXUnregisterMacWindow(window);
+        if (winPtr->window) {
+            ((MacDrawable *) winPtr->window)->view = nil;
         }
-    }
-
-    ckfree((char *) wmPtr);
+        [window release];
+	wmPtr->window = NULL;
+       /* Activate the highest window left on the screen. */
+       NSArray *windows = [NSApp orderedWindows];
+       if ( [windows count] > 0 ) {
+	   NSWindow *front = [windows objectAtIndex:0];
+	   if ( front && [front canBecomeKeyWindow] ) {
+               [front makeKeyAndOrderFront:NSApp];
+           }
+       }
+    }
+    ckfree(wmPtr);
     winPtr->wmInfoPtr = NULL;
 }
 
@@ -5867,6 +5865,7 @@ TkpChangeFocus(
 
     if (Tk_IsTopLevel(winPtr) && !Tk_IsEmbedded(winPtr) ){
     	NSWindow *win = TkMacOSXDrawableWindow(winPtr->window);
+	NSAutoreleasePool *pool = [NSAutoreleasePool new];
     	TkWmRestackToplevel(winPtr, Above, NULL);
     	if (force ) {
     	    [NSApp activateIgnoringOtherApps:YES];
@@ -5874,6 +5873,7 @@ TkpChangeFocus(
 	if ( win && [win canBecomeKeyWindow] ) {
 	    [win makeKeyAndOrderFront:NSApp];
 	}
+	[pool drain];
     }
 	
     /*
@@ -5892,7 +5892,7 @@ TkpChangeFocus(
  * WmStackorderToplevelWrapperMap --
  *
  *	This procedure will create a table that maps the reparent wrapper X id
- *	for a toplevel to the TkWindow structure that is wraps. Tk keeps track
+ *	for a toplevel to the TkWindow structure that it wraps. Tk keeps track
  *	of a mapping from the window X id to the TkWindow structure but that
  *	does us no good here since we only get the X id of the wrapper window.
  *	Only those toplevel windows that are mapped have a position in the
@@ -5951,12 +5951,10 @@ TkWindow **
 TkWmStackorderToplevel(
     TkWindow *parentPtr)	/* Parent toplevel window. */
 {
-    TkWindow *childWinPtr, **windows, **window_ptr;
+    TkWindow *childWinPtr, **windows, **windowPtr;
     Tcl_HashTable table;
     Tcl_HashEntry *hPtr;
     Tcl_HashSearch search;
-    NSInteger windowCount;
-    NSInteger *windowNumbers;
 
     /*
      * Map mac windows to a TkWindow of the wrapped toplevel.
@@ -5983,31 +5981,26 @@ TkWmStackorderToplevel(
 	goto done;
     }
 
-    NSCountWindows(&windowCount);
+    NSArray *macWindows = [NSApp orderedWindows];
+    NSInteger windowCount = [macWindows count];
+
     if (!windowCount) {
-	ckfree((char *) windows);
+	ckfree(windows);
 	windows = NULL;
     } else {
-	window_ptr = windows + table.numEntries;
-	*window_ptr-- = NULL;
-	windowNumbers = (NSInteger*)ckalloc(windowCount * sizeof(NSInteger));
-	NSWindowList(windowCount, windowNumbers);
-	for (NSInteger index = 0; index < windowCount; index++) {
-	    NSWindow *w = [NSApp windowWithWindowNumber:windowNumbers[index]];
-
-	    if (w) {
-		hPtr = Tcl_FindHashEntry(&table, (char*) w);
-		if (hPtr != NULL) {
-		    childWinPtr = Tcl_GetHashValue(hPtr);
-		    *window_ptr-- = childWinPtr;
-		}
+	windowPtr = windows + table.numEntries;
+	*windowPtr-- = NULL;
+	for (NSWindow *w in macWindows) {
+	    hPtr = Tcl_FindHashEntry(&table, (char*) w);
+	    if (hPtr != NULL) {
+		childWinPtr = Tcl_GetHashValue(hPtr);
+		*windowPtr-- = childWinPtr;
 	    }
 	}
-	if (window_ptr != (windows-1)) {
+	if (windowPtr != windows-1) {
 	    Tcl_Panic("num matched toplevel windows does not equal num "
-		    "children");
+		      "children");
 	}
-	ckfree((char *) windowNumbers);
     }
 
   done:
@@ -6569,7 +6562,6 @@ RemapWindows(
     MacDrawable *parentWin)
 {
     TkWindow *childPtr;
-
     /*
      * Remove the OS specific window. It will get rebuilt when the window gets
      * Mapped.