e16/src/focus.c

/*
 * Copyright (C) 2000-2004 Carsten Haitzler, Geoff Harrison and various contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies of the Software, its documentation and marketing & publicity
 * materials, and acknowledgment shall be given in the documentation, materials
 * and software packages that this Software was used.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
#include "E.h"

static int          new_desk_focus_nesting = 0;

/*
 * Return !0 if it is OK to focus ewin.
 */
static int
FocusEwinValid(EWin * ewin)
{
   if (ewin->skipfocus || ewin->neverfocus || ewin->shaded || ewin->iconified)
      return 0;

   if (!ewin->mapped)
      return 0;

   return EwinIsOnScreen(ewin);
}

/*
 * Return the ewin to focus after entering area or losing focused window.
 */
static EWin        *
FocusEwinSelect(void)
{
   EWin              **lst, *ewin = NULL;
   int                 num, i;

   switch (conf.focus.mode)
     {
     default:
     case MODE_FOCUS_POINTER:
     case MODE_FOCUS_SLOPPY:
	ewin = GetEwinPointerInClient();
	break;
     case MODE_FOCUS_CLICK:
	lst = (EWin **) ListItemType(&num, LIST_TYPE_EWIN);
	for (i = 0; i < num; i++)
	  {
	     if (!FocusEwinValid(lst[i]))
		continue;
	     ewin = lst[i];
	     break;
	  }
	if (lst)
	   Efree(lst);
	break;
     }

   return ewin;
}

static void
AutoraiseTimeout(int val, void *data)
{
   EWin               *ewin;

   if (conf.focus.mode == MODE_FOCUS_CLICK)
      return;

   ewin = FindItem("", val, LIST_FINDBY_ID, LIST_TYPE_EWIN);
   if (ewin)
      RaiseEwin(ewin);

   return;
   data = NULL;
}

static void
ReverseTimeout(int val, void *data)
{
   EWin               *ewin;

   ewin = RemoveItem("EWIN", val, LIST_FINDBY_ID, LIST_TYPE_EWIN);
   if (ewin)
      AddItem(ewin, "EWIN", ewin->client.win, LIST_TYPE_EWIN);

   return;
   data = NULL;
}

static void
FocusCycle(int inc)
{
   EWin              **lst0, **lst, *ewin;
   int                 i, num0, num, ax, ay;

   EDBUG(5, "FocusCycle");

   /* On previous only ? */
   RemoveTimerEvent("REVERSE_FOCUS_TIMEOUT");
   DoIn("REVERSE_FOCUS_TIMEOUT", 1.0, ReverseTimeout, 0, NULL);

   GetCurrentArea(&ax, &ay);

   lst0 = (EWin **) ListItemType(&num0, LIST_TYPE_EWIN);
   if (lst0 == NULL)
      EDBUG_RETURN_;

   num = 0;
   lst = NULL;
   for (i = 0; i < num0; i++)
     {
	ewin = lst0[i];
	if (FocusEwinValid(ewin))
	  {
	     num++;
	     lst = Erealloc(lst, sizeof(EWin *) * num);
	     lst[num - 1] = ewin;
	  }
     }
   Efree(lst0);

   if (lst == NULL)
      EDBUG_RETURN_;

   for (i = 0; i < num; i++)
     {
	if (mode.focuswin == lst[i])
	   break;
     }
   i += inc + num;
   i %= num;
   ewin = lst[i];
   Efree(lst);

   FocusToEWin(ewin, FOCUS_NEXT);

   EDBUG_RETURN_;
}

void
FocusGetNextEwin(void)
{
   FocusCycle(1);
}

void
FocusGetPrevEwin(void)
{
   FocusCycle(-1);
}

void
FocusEwinSetGrabs(EWin * ewin)
{
   if ((conf.focus.mode != MODE_FOCUS_CLICK &&
	ewin->active && conf.focus.clickraises) ||
       (conf.focus.mode == MODE_FOCUS_CLICK && !ewin->active))
     {
	XGrabButton(disp, AnyButton, AnyModifier, ewin->win_container,
		    False, ButtonPressMask, GrabModeSync, GrabModeAsync,
		    None, None);
     }
   else
     {
	XUngrabButton(disp, AnyButton, AnyModifier, ewin->win_container);
     }
}

void
FocusFix(void)
{
   EWin              **lst, *ewin;
   int                 i, num;

   EDBUG(5, "FocusFix");

   num = 0;
   lst = (EWin **) ListItemType(&num, LIST_TYPE_EWIN);
   if (lst == NULL)
      EDBUG_RETURN_;

   for (i = 0; i < num; i++)
     {
	ewin = lst[i];
	XUngrabButton(disp, AnyButton, AnyModifier, ewin->win_container);
	FocusEwinSetGrabs(ewin);
     }
   Efree(lst);

   EDBUG_RETURN_;
}

void
FocusToEWin(EWin * ewin, int why)
{
   int                 do_follow = 0;

   EDBUG(4, "FocusToEWin");

   if (EventDebug(50))
     {
	if (ewin)
	   printf("FocusToEWin %#lx %s why=%d\n", ewin->client.win,
		  ewin->icccm.wm_res_name, why);
	else
	   printf("FocusToEWin None why=%d\n", why);
     }

   switch (why)
     {
     default:
	if (ewin == mode.focuswin)
	   EDBUG_RETURN_;
	break;

     case FOCUS_EWIN_GONE:
	if (ewin != mode.focuswin)
	   EDBUG_RETURN_;
	ewin = FocusEwinSelect();
	break;

     case FOCUS_EWIN_NEW:
	if (conf.focus.all_new_windows_get_focus)
	  {
	     do_follow = 2;
	  }
	else if (conf.focus.new_transients_get_focus)
	  {
	     if (ewin->client.transient)
		do_follow = 2;
	  }
	else if (conf.focus.new_transients_get_focus_if_group_focused)
	  {
	     EWin               *ewin2;

	     ewin2 = FindItem(NULL, ewin->client.transient_for,
			      LIST_FINDBY_ID, LIST_TYPE_EWIN);
	     if ((ewin2) && (mode.focuswin == ewin2))
		do_follow = 2;
	  }
	else if (mode.place)
	  {
	     do_follow = 1;
	  }

	if (!do_follow)
	   EDBUG_RETURN_;
	break;

     case FOCUS_WARP_NEXT:
	why = FOCUS_NEXT;
	break;

     case FOCUS_WARP_DONE:
	break;
     }

   if (!ewin)
      goto exit;

   /* NB! ewin != NULL */

   if (ewin->iconified || ewin->neverfocus)
      EDBUG_RETURN_;

   if (!ewin->client.need_input)
      EDBUG_RETURN_;

   /* Don't focus menus (use client.need_input?) */
   if (ewin->menu)
      EDBUG_RETURN_;

   if (do_follow && !mode.startup)
      GotoDesktopByEwin(ewin);

   if (!EwinIsOnScreen(ewin))
      EDBUG_RETURN_;

   if (conf.autoraise.enable)
     {
	RemoveTimerEvent("AUTORAISE_TIMEOUT");

	if (conf.focus.mode != MODE_FOCUS_CLICK)
	   DoIn("AUTORAISE_TIMEOUT", conf.autoraise.delay, AutoraiseTimeout,
		ewin->client.win, NULL);
     }

   if ((conf.focus.raise_on_next_focus && (why == FOCUS_NEXT)) ||
       (conf.focus.raise_after_next_focus && (why == FOCUS_WARP_DONE)))
      RaiseEwin(ewin);

   if ((conf.focus.warp_on_next_focus && (why == FOCUS_NEXT)) ||
       (conf.focus.warp_after_next_focus && (why == FOCUS_WARP_DONE)))
     {
	if (ewin != mode.mouse_over_win)
	   XWarpPointer(disp, None, ewin->win, 0, 0, 0, 0, ewin->w / 2,
			ewin->h / 2);
     }

   RemoveTimerEvent("REVERSE_FOCUS_TIMEOUT");
   if (why != FOCUS_DESK_ENTER)
      DoIn("REVERSE_FOCUS_TIMEOUT", 0.5, ReverseTimeout, ewin->client.win,
	   NULL);

   SoundPlay("SOUND_FOCUS_SET");
   EwinListFocusRaise(ewin);
 exit:
   ICCCM_Cmap(ewin);
   ICCCM_Focus(ewin);
   mode.focuswin = ewin;

   EDBUG_RETURN_;
}

void
FocusNewDeskBegin(void)
{
   EWin               *ewin, **lst;
   int                 i, j, num;

   if (new_desk_focus_nesting++)
      return;

   FocusToEWin(NULL, FOCUS_DESK_LEAVE);

   /* we are about to flip desktops or areas - disable enter and leave events
    * temporarily */

   lst = (EWin **) ListItemType(&num, LIST_TYPE_EWIN);
   if (lst)
     {
	for (i = 0; i < num; i++)
	  {
	     ewin = lst[i];

	     XSelectInput(disp, ewin->win,
			  FocusChangeMask | SubstructureNotifyMask |
			  SubstructureRedirectMask | PropertyChangeMask |
			  ResizeRedirectMask);

	     if (ewin->pager)
	       {
#if 0				/* ??? */
		  XSelectInput(disp, ewin->client.win,
			       PropertyChangeMask | FocusChangeMask |
			       ResizeRedirectMask | StructureNotifyMask |
			       ColormapChangeMask | ButtonPressMask |
			       ButtonReleaseMask | PointerMotionMask);
#endif
	       }
	     else if (ewin->dialog)
		XSelectInput(disp, ewin->client.win,
			     PropertyChangeMask | FocusChangeMask |
			     ResizeRedirectMask | StructureNotifyMask |
			     ColormapChangeMask | ExposureMask | KeyPressMask);
	     else
		XSelectInput(disp, ewin->client.win,
			     PropertyChangeMask | FocusChangeMask |
			     ResizeRedirectMask | StructureNotifyMask |
			     ColormapChangeMask);

	     for (j = 0; j < ewin->border->num_winparts; j++)
	       {
		  if (ewin->border->part[j].flags & FLAG_TITLE)
		     XSelectInput(disp, ewin->bits[j].win,
				  ExposureMask | ButtonPressMask |
				  ButtonReleaseMask);
		  else
		     XSelectInput(disp, ewin->bits[j].win,
				  ButtonPressMask | ButtonReleaseMask);
	       }
	  }
	Efree(lst);
     }

   for (i = 0; i < ENLIGHTENMENT_CONF_NUM_DESKTOPS; i++)
      XSelectInput(disp, desks.desk[i].win,
		   PropertyChangeMask | SubstructureRedirectMask |
		   ButtonPressMask | ButtonReleaseMask);
}

void
FocusNewDesk(void)
{
   EWin               *ewin, **lst;
   int                 i, j, num;

   EDBUG(4, "FocusNewDesk");

   if (--new_desk_focus_nesting)
      return;

   /* we flipped - re-enable enter and leave events */
   lst = (EWin **) ListItemType(&num, LIST_TYPE_EWIN);
   if (lst)
     {
	for (i = 0; i < num; i++)
	  {
	     ewin = lst[i];

	     XSelectInput(disp, ewin->win,
			  FocusChangeMask | SubstructureNotifyMask |
			  SubstructureRedirectMask | EnterWindowMask |
			  LeaveWindowMask | PointerMotionMask |
			  PropertyChangeMask | ResizeRedirectMask |
			  ButtonPressMask | ButtonReleaseMask);

	     if (ewin->pager)
		XSelectInput(disp, ewin->client.win,
			     PropertyChangeMask | EnterWindowMask |
			     LeaveWindowMask | FocusChangeMask |
			     ResizeRedirectMask | StructureNotifyMask |
			     ColormapChangeMask | ButtonPressMask |
			     ButtonReleaseMask | PointerMotionMask);
	     else if (ewin->dialog)
		XSelectInput(disp, ewin->client.win,
			     PropertyChangeMask | EnterWindowMask |
			     LeaveWindowMask | FocusChangeMask |
			     ResizeRedirectMask | StructureNotifyMask |
			     ColormapChangeMask | ExposureMask | KeyPressMask);
	     else
		XSelectInput(disp, ewin->client.win,
			     PropertyChangeMask | EnterWindowMask |
			     LeaveWindowMask | FocusChangeMask |
			     ResizeRedirectMask | StructureNotifyMask |
			     ColormapChangeMask);

	     for (j = 0; j < ewin->border->num_winparts; j++)
	       {
		  if (ewin->border->part[j].flags & FLAG_TITLE)
		     XSelectInput(disp, ewin->bits[j].win,
				  ExposureMask | KeyPressMask | KeyReleaseMask |
				  ButtonPressMask | ButtonReleaseMask |
				  EnterWindowMask | LeaveWindowMask |
				  PointerMotionMask);
		  else
		     XSelectInput(disp, ewin->bits[j].win,
				  KeyPressMask | KeyReleaseMask |
				  ButtonPressMask | ButtonReleaseMask |
				  EnterWindowMask | LeaveWindowMask |
				  PointerMotionMask);
	       }

	     if (mode.mode == MODE_DESKSWITCH && ewin->sticky && ewin->visible)
		EwinRefresh(ewin);
	  }
	Efree(lst);
     }

   for (i = 0; i < ENLIGHTENMENT_CONF_NUM_DESKTOPS; i++)
      XSelectInput(disp, desks.desk[i].win,
		   SubstructureNotifyMask | ButtonPressMask |
		   ButtonReleaseMask | EnterWindowMask | LeaveWindowMask |
		   ButtonMotionMask | PropertyChangeMask |
		   SubstructureRedirectMask | KeyPressMask | KeyReleaseMask |
		   PointerMotionMask);

   ewin = FocusEwinSelect();
   if (ewin)
      FocusToEWin(ewin, FOCUS_DESK_ENTER);

   EDBUG_RETURN_;
}

/*
 * Focus event handlers
 */

void
FocusHandleEnter(XEvent * ev)
{
   EWin               *ewin;

   EDBUG(5, "FocusHandleEnter");

   ewin = GetEwinByCurrentPointer();

   mode.mouse_over_win = ewin;

   switch (conf.focus.mode)
     {
     default:
     case MODE_FOCUS_CLICK:
	break;
     case MODE_FOCUS_SLOPPY:
	if (!ewin || ewin->focusclick)
	   break;
	FocusToEWin(ewin, FOCUS_ENTER);
	break;
     case MODE_FOCUS_POINTER:
	if (ewin && ewin->focusclick)
	   break;
	FocusToEWin(ewin, FOCUS_ENTER);
	break;
     }

   EDBUG_RETURN_;
   ev = NULL;
}

void
FocusHandleLeave(XEvent * ev)
{
   Window              win = ev->xcrossing.window;

   /* Leaving root may mean entering other screen */
   if (win == root.win &&
       (ev->xcrossing.mode == NotifyNormal &&
	ev->xcrossing.detail != NotifyInferior))
      FocusToEWin(NULL, FOCUS_SET);
}

#if 0				/* Remove old code */
void
FocusHandleEnter(XEvent * ev)
{
   /*
    * multi screen handling -- root windows receive
    * enter / leave notify
    */
   if (ev->xany.window == root.win)
     {
	if (!mode.focuswin || conf.focus.mode == MODE_FOCUS_POINTER)
	   HandleFocusWindow(0);
     }
   else
     {
	HandleFocusWindow(ev->xcrossing.window);
     }
}

void
FocusHandleLeave(XEvent * ev)
{
   /*
    * If we are leaving the root window, we are switching
    * screens on a multi screen system - need to unfocus
    * to allow other desk to grab focus...
    */
   if (ev->xcrossing.window == root.win)
     {
	if (ev->xcrossing.mode == NotifyNormal
	    && ev->xcrossing.detail != NotifyInferior && mode.focuswin)
	   HandleFocusWindow(0);
	else
	   HandleFocusWindow(ev->xcrossing.window);
     }
/* THIS caused the "emacs focus bug" ? */
/*      else */
/*      HandleFocusWindow(ev->xcrossing.window); */
}
#endif

void
FocusHandleClick(Window win)
{
   EWin               *ewin;

   ewin = GetEwinByCurrentPointer();
   if (!ewin)
      return;

   if ((conf.focus.clickraises) || (conf.focus.mode == MODE_FOCUS_CLICK))
     {
	RaiseEwin(ewin);
	FocusToEWin(ewin, FOCUS_CLICK);

	/* allow click to pass thorugh */
	if (win == ewin->win_container)
	  {
	     XSync(disp, False);
	     XAllowEvents(disp, ReplayPointer, CurrentTime);
	     XSync(disp, False);
	  }
     }
   else if (ewin->focusclick)
     {
	FocusToEWin(ewin, FOCUS_CLICK);
     }
}