annotate lwlib/dispatch.c @ 20102:c00f010468c2

Using cl macros push, pop, when, unless throughout the file. This is not further mentioned in this ChangeLog entry. Documentation largely updated. Parser rewritten for better Multifile Document processing. Macros with naked label arguments supported. Some Mule related changes. (reftex-default-label-alist-entries): Customization type is now computed from reftex-label-alist-builtin. Enumerate has new typekey `i'. `n' is now reserved for footnotes etc. (reftex-label-alist): Introduced default regular expressions. Customization type is now computed from reftex-label-alist-builtin. (reftex-label-menu-flags): New flag for showing file borders. (reftex-refontify-context): New option. (reftex-bibfile-ignore-list): Now a user option (was: variable). (reftex-cite-format): Now a user option (was: variable). Customization type is now computed from reftex-cite-format-builtin. (reftex-comment-citations): Now a user option (was: variable). (reftex-toc-follow-mode): Now a user option (was: variable). (reftex-optimizations-for-large-documents): New custom group. (reftex-keep-temporary-buffers): 1 as additional value. (reftex-initialize-temporary-buffers): New option. (reftex-enable-partial-scans): New option. (reftex-save-parse-info): New option. (reftex-plug-into-AUCTeX): Now a user option (was: variable). (reftex-auto-show-entry): New value 'copy allowed. (reftex-load-hook): Now a declared variable. (reftex-mode-hook): Now a declared variable. (reftex-label-numbers-symbol): Variable removed. (reftex-list-of-labels-symbol): Variable removed. (reftex-label-numbers-symbol): Variable removed. (reftex-bibfile-list-symbol): Variable removed. (reftex-docstruct-symbol): New variable (buffer-local). (reftex-master-include-list): Variable removed. (reftex-make-master-buffer): Function removed. (reftex-make-master-buffer-hook): Hook removed. (reftex-insert-buffer-or-file): Function removed. (reftex-parse-document): Function adapted to new parser. (reftex-access-scan-info): Changed to fit new parser. Now detects changes in label-alist related variables automatically. (reftex-parse-one,reftex-parse-all): New functions. (reftex-all-document-files): New function. (reftex-grep-document,reftex-search-document, reftex-query-replace-document): Now use `reftex-all-document-files'. (reftex-section-or-include-regexp): New variable. (reftex-everything-regexp): New variable. (reftex-find-label-regexp-format): New variable. (reftex-find-label-regexp-format2): New variable. (reftex-do-parse): New function. (reftex-is-multi): New function. (reftex-parse-from-file): New function. (reftex-locate-bibliography-files): New function. (reftex-last-assoc-before-elt): New function. (reftex-replace-label-list-segment): New function. (reftex-silence-toc-markers): New function. (reftex-access-parse-file): New function. (reftex-label): Now uses `reftex-where-am-I'. (reftex-offer-label-menu): New keys `%' and `i' and `r'. (reftex-select-item): Recursive edit moved to key `e'. New key `x' for external documents. Works now also with nin-nil pop-frame. (reftex-offer-label-menu): Now uses `reftex-where-am-I'. (reftex-make-and-insert-label-menu): More efficient, allow optional extra fontification. (reftex-find-nearby-label): Function removed. (reftex-scan-buffer-for-labels): Function removed. (reftex-section-info): New function. (reftex-nth-parens-substring): Renamed to reftex-nth-arg. Return nil when not enough args are present. (reftex-move-over-touching-args): New function. (reftex-where-am-I): New function. (reftex-nth-arg-wrapper): New function. (reftex-select-label-callback): Deal with special macros as well. (reftex-find-duplicate-labels): Ignore special entries in docstruct. (reftex-kill-temporary-buffers): New arg buffer. (reftex-show-entry): Copy context when necessary. (reftex-toc): New key `R', use reftex-where-am-I. (reftex-nearest-section): Use reftex-where-am-I. (reftex-toc-visit-line): Completely rewritten. Uses markers and several backup methods. (reftex-citation): Recursive edit moved to `e' key. (reftex-scan-buffer): Function removed. (reftex-get-bibfile-list): Changed to work with chapterbib package. (reftex-find-tex-file): New function. (reftex-find-files-on-path): Now first looks for file with additional .tex extension, then for the naked file name. (reftex-citation): Split into reftex-citation and reftex-do-citation. (reftex-do-citation): Recursive edit now on `e' key. (reftex-what-macro): Allow white space between macro arguments. (reftex-allow-for-ctrl-m): Renamed to `reftex-make-regexp-allow-for-ctrl-m'. (reftex-nearest-match): New function. (reftex-auto-mode-alist): New function. (reftex-make-desparate-section-regexp): New funtion. (reftex-get-file-buffer-force): Rewritten to use new variable `reftex-initialize-temporary-buffers'. (reftex-label-alist-builtin): Use abbreviated regexps. (reftex-label-mac-list): New variable. (reftex-parse-args): New function. (easy-menu-define): Menu extended. Some parts are now computed. from the user options. (reftex-move-to-next-arg,reftex-move-to-previous-arg) New functions. Now we can parse macros with distributed arguments. (reftex-goto-label): Function removed. (reftex-position-cursor): Function removed. (reftex-item): Function removed. (reftex-add-to-label-alist): No longer autoloaded. (reftex-toc-indent): Constant removed. (reftex-label-indent): Constant removed. (reftex-context-indent): Constant removed. (reftex-match-string): New function. (reftex-memory): New variable (reftex-reset-mode): No longer hacks local variables. Now resets path variables as well. (reftex-truncate): New functions, to make RefTeX work with Mule. (reftex-fp): New macro, to make RefTeX work with Mule. (reftex-format-bib-entry): Now uses `reftex-truncate' to truncate author names. `extra' and `title' are no longer truncated at all. (reftex-all-assq): New function. (reftex-view-crossref): Works now also if mouse click is on macro. (reftex-context-substring): Now returns substring without text properties. (reftex-tex-path,reftex-bib-path): New variables. (reftex-split): Function replaced with builtin `split-string'. (reftex-find-bib-file): New function. (reftex-find-files-on-path): Function removed. (reftex-find-file-on-path): New function. (reftex-access-search-path,reftex-parse-colon-path, reftex-recursive-directory-list,reftex-expand-path): New functions, dealing with recursive TEXINPUTS and BIBINPUTS definitions.

/* Defines a function to find the Widget that XtDispatchEvent() would use.
   Copyright (C) 1992 Lucid, Inc.

This file is part of the Lucid Widget Library.

The Lucid Widget Library 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 1, or (at your option)
any later version.

The Lucid Widget 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 General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA. */

/* 
 *   The function XtWidgetToDispatchTo(), given an XEvent, returns the 
 *   widget that XtDispatchEvent() would send that event to if called now.
 *   This file copies much code from the X11r4 Xt source, and is thus a
 *   portability problem.  It also requires data structures defined in
 *   IntrinsicI.h, which is a non-exported Xt header file, so you can't
 *   compile this file unless you have the Xt sources online.
 */

#include <IntrinsicI.h>   /* Don't change this: see comments in Imakefile. */
#include <X11/Xatom.h>
#include "dispatch.h"

#include <X11/Xlib.h>
#include <X11/cursorfont.h>
#include <X11/Xutil.h>

#ifdef XlibSpecificationRelease
#if XlibSpecificationRelease >= 5
#define HAVE_X11R5
#endif
#endif

/* ##  All of the code on this page was copied from the X11R5 lib/Xt/Event.c,
   ##  but is compatible with X11R4; the code in Event.c is different, but
   ##  functionally equivalent for our purposes.
 */

#if __STDC__
#define Const const
#else
#define Const /**/
#endif

#define NonMaskableMask ((EventMask)0x80000000L)

#define COMP_EXPOSE   (widget->core.widget_class->core_class.compress_exposure)
#define COMP_EXPOSE_TYPE (COMP_EXPOSE & 0x0f)
#define GRAPHICS_EXPOSE  ((XtExposeGraphicsExpose & COMP_EXPOSE) || \
			  (XtExposeGraphicsExposeMerged & COMP_EXPOSE))
#define NO_EXPOSE        (XtExposeNoExpose & COMP_EXPOSE)


/* -- lots of stuff we don't need to copy, omitted -- */


static EventMask Const masks[] = {
	0,			    /* Error, should never see  */
	0,			    /* Reply, should never see  */
	KeyPressMask,		    /* KeyPress			*/
	KeyReleaseMask,		    /* KeyRelease		*/
	ButtonPressMask,	    /* ButtonPress		*/
	ButtonReleaseMask,	    /* ButtonRelease		*/
	PointerMotionMask	    /* MotionNotify		*/
		| ButtonMotionMask,
	EnterWindowMask,	    /* EnterNotify		*/
	LeaveWindowMask,	    /* LeaveNotify		*/
	FocusChangeMask,	    /* FocusIn			*/
	FocusChangeMask,	    /* FocusOut			*/
	KeymapStateMask,	    /* KeymapNotify		*/
	ExposureMask,		    /* Expose			*/
	NonMaskableMask,	    /* GraphicsExpose, in GC    */
	NonMaskableMask,	    /* NoExpose, in GC		*/
	VisibilityChangeMask,       /* VisibilityNotify		*/
	SubstructureNotifyMask,     /* CreateNotify		*/
	StructureNotifyMask	    /* DestroyNotify		*/
		| SubstructureNotifyMask,
	StructureNotifyMask	    /* UnmapNotify		*/
		| SubstructureNotifyMask,
	StructureNotifyMask	    /* MapNotify		*/
		| SubstructureNotifyMask,
	SubstructureRedirectMask,   /* MapRequest		*/
	StructureNotifyMask	    /* ReparentNotify		*/
		| SubstructureNotifyMask,
	StructureNotifyMask	    /* ConfigureNotify		*/
		| SubstructureNotifyMask,
	SubstructureRedirectMask,   /* ConfigureRequest		*/
	StructureNotifyMask	    /* GravityNotify		*/
		| SubstructureNotifyMask,
	ResizeRedirectMask,	    /* ResizeRequest		*/
	StructureNotifyMask	    /* CirculateNotify		*/
		| SubstructureNotifyMask,
	SubstructureRedirectMask,   /* CirculateRequest		*/
	PropertyChangeMask,	    /* PropertyNotify		*/
	NonMaskableMask,	    /* SelectionClear		*/
	NonMaskableMask,	    /* SelectionRequest		*/
	NonMaskableMask,	    /* SelectionNotify		*/
	ColormapChangeMask,	    /* ColormapNotify		*/
	NonMaskableMask,	    /* ClientMessage		*/
	NonMaskableMask		    /* MappingNotify		*/
};

#ifndef HAVE_X11R5

static /* in R5, this is not static, so we don't need to define it at all */
EventMask _XtConvertTypeToMask (eventType)
    int		eventType;
{
    eventType &= 0x7f;	/* Events sent with XSendEvent have high bit set. */
    if (eventType < XtNumber(masks))
	return masks[eventType];
    else
	return 0;
}

#endif /* not HAVE_X11R5 */

/* -- _XtOnGrabList() omitted -- */


static Widget LookupSpringLoaded(grabList)
    XtGrabList	grabList;
{
    XtGrabList	gl;

    for (gl = grabList; gl != NULL; gl = gl->next) {
	if (gl->spring_loaded)
	  if (XtIsSensitive(gl->widget))
	    return gl->widget;
	  else
	    return NULL;
	if (gl->exclusive) break;
    }
    return NULL;
}



/* This function is new. */

static Boolean WouldDispatchEvent(event, widget, mask, pd)
     register XEvent    *event;
     Widget    widget;
     EventMask mask;
     XtPerDisplay pd;
{
  XtEventRec *p;   
  Boolean would_dispatched = False;
  
  if ((mask == ExposureMask) ||
      ((event->type == NoExpose) && NO_EXPOSE) ||
      ((event->type == GraphicsExpose) && GRAPHICS_EXPOSE) )
    if (widget->core.widget_class->core_class.expose != NULL )
      return True;
  
  
  if ((mask == VisibilityChangeMask) &&
      XtClass(widget)->core_class.visible_interest) 
    return True;
  
  for (p=widget->core.event_table; p != NULL; p = p->next) 
    if ((mask & p->mask) != 0
#ifndef HAVE_X11R5
	|| (mask == 0 && p->non_filter)
#endif
	)
      return True;

  return False;
}


/* ####  This function is mostly copied from DecideToDispatch().
 */

typedef enum _GrabType {pass, ignore, remap} GrabType;

Widget
XtWidgetToDispatchTo (XEvent* event)
{
  register    Widget widget;
  EventMask   mask;
  GrabType    grabType;
  Widget	dspWidget;
  Time	time = 0;
  XtPerDisplay pd;
  XtPerDisplayInput pdi;
  XtGrabList  grabList;
  
  widget = XtWindowToWidget (event->xany.display, event->xany.window);
  pd = _XtGetPerDisplay(event->xany.display);
  pdi = _XtGetPerDisplayInput(event->xany.display);
  grabList = *_XtGetGrabList(pdi);
  
  mask = _XtConvertTypeToMask(event->xany.type);
  grabType = pass;
  switch (event->xany.type & 0x7f) {
  case KeyPress:
  case KeyRelease:	grabType = remap; break;
  case ButtonPress:
  case ButtonRelease:	grabType = remap; break;
  case MotionNotify:	grabType = ignore;
#define XKnownButtons (Button1MotionMask|Button2MotionMask|Button3MotionMask|\
                       Button4MotionMask|Button5MotionMask)
			mask |= (event->xmotion.state & XKnownButtons);
#undef XKnownButtons
				break;
  case EnterNotify:	grabType = ignore; break;
  }
  
  if (widget == NULL) {
    if (grabType != remap) return False;
    /* event occurred in a non-widget window, but we've promised also
       to dispatch it to the nearest accessible spring_loaded widget */
    else if ((widget = LookupSpringLoaded(grabList)) != NULL)
      return widget;
    return False;
  }

  switch(grabType) {
  case pass:
    return widget;
    
  case ignore:
    if ((grabList == NULL || _XtOnGrabList(widget,grabList))
	&& XtIsSensitive(widget)) {
      return widget;
    }
    return NULL;
    
  case remap:
    
    {
      Widget was_dispatched_to= NULL;
      extern Widget _XtFindRemapWidget();
      extern void _XtUngrabBadGrabs();
      
      dspWidget = _XtFindRemapWidget(event, widget, mask, pdi);
      
      if ((grabList == NULL || 
	   _XtOnGrabList(dspWidget, grabList)) &&
	  XtIsSensitive(dspWidget)) {
	if (WouldDispatchEvent (event, dspWidget, mask, pd))
	  was_dispatched_to = dspWidget;
      }
      
      /* Also dispatch to nearest accessible spring_loaded. */
      /* Fetch this afterward to reflect modal list changes */
      grabList = *_XtGetGrabList(pdi);
      widget = LookupSpringLoaded(grabList);
      if (widget != NULL && widget != dspWidget) {
	if (!was_dispatched_to)
	  was_dispatched_to =  widget;
      }
      
      return was_dispatched_to;
    }
  }
  /* should never reach here */
  return NULL;
}