root/trunk/lwlib/lwlib-Xm.c

/* The lwlib interface to Motif widgets.
   Copyright (C) 1994, 1995, 1996, 1997, 1999, 2000, 2001, 2002, 2003,
                 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
   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., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <unistd.h>
#include <stdio.h>

#include <X11/StringDefs.h>
#include <X11/IntrinsicP.h>
#include <X11/ObjectP.h>
#include <X11/CoreP.h>
#include <X11/CompositeP.h>

#include "../src/lisp.h"

#include "lwlib-Xm.h"
#include "lwlib-utils.h"

#include <Xm/BulletinB.h>
#include <Xm/CascadeB.h>
#include <Xm/CascadeBG.h>
#include <Xm/DrawingA.h>
#include <Xm/FileSB.h>
#include <Xm/Label.h>
#include <Xm/List.h>
#include <Xm/MainW.h>
#include <Xm/MenuShell.h>
#include <Xm/MessageB.h>
#include <Xm/PanedW.h>
#include <Xm/PushB.h>
#include <Xm/PushBG.h>
#include <Xm/ArrowB.h>
#include <Xm/SelectioB.h>
#include <Xm/Text.h>
#include <Xm/TextF.h>
#include <Xm/ToggleB.h>
#include <Xm/ToggleBG.h>
#include <Xm/RowColumn.h>
#include <Xm/ScrolledW.h>
#include <Xm/Separator.h>
#include <Xm/DialogS.h>
#include <Xm/Form.h>

#undef P_
#if defined __STDC__ || defined PROTOTYPES
#define P_(X) X
#else
#define P_(X) ()
#endif

enum do_call_type { pre_activate, selection, no_selection, post_activate };


/* Structures to keep destroyed instances */
typedef struct _destroyed_instance
{
  char*         name;
  char*         type;
  Widget        widget;
  Widget        parent;
  Boolean       pop_up_p;
  struct _destroyed_instance*   next;
} destroyed_instance;

static destroyed_instance *make_destroyed_instance P_ ((char *, char *,
                                                        Widget, Widget,
                                                        Boolean));
static void free_destroyed_instance P_ ((destroyed_instance*));
Widget first_child P_ ((Widget));
Boolean lw_motif_widget_p P_ ((Widget));
static XmString resource_motif_string P_ ((Widget, char *));
static void destroy_all_children P_ ((Widget, int));
static void xm_update_label P_ ((widget_instance *, Widget, widget_value *));
static void xm_update_list P_ ((widget_instance *, Widget, widget_value *));
static void xm_update_pushbutton P_ ((widget_instance *, Widget,
                                      widget_value *));
static void xm_update_cascadebutton P_ ((widget_instance *, Widget,
                                         widget_value *));
static void xm_update_toggle P_ ((widget_instance *, Widget, widget_value *));
static void xm_update_radiobox P_ ((widget_instance *, Widget, widget_value *));
static void make_menu_in_widget P_ ((widget_instance *, Widget,
                                     widget_value *, int));
static void update_one_menu_entry P_ ((widget_instance *, Widget,
                                       widget_value *, Boolean));
static void xm_update_menu P_ ((widget_instance *, Widget, widget_value *,
                                Boolean));
static void xm_update_text P_ ((widget_instance *, Widget, widget_value *));
static void xm_update_text_field P_ ((widget_instance *, Widget,
                                      widget_value *));
void xm_update_one_value P_ ((widget_instance *, Widget, widget_value *));
static void activate_button P_ ((Widget, XtPointer, XtPointer));
static Widget make_dialog P_ ((char *, Widget, Boolean, char *, char *,
                               Boolean, Boolean, Boolean, int, int));
static destroyed_instance* find_matching_instance P_ ((widget_instance*));
static void mark_dead_instance_destroyed P_ ((Widget, XtPointer, XtPointer));
static void recenter_widget P_ ((Widget));
static Widget recycle_instance P_ ((destroyed_instance*));
Widget xm_create_dialog P_ ((widget_instance*));
static Widget make_menubar P_ ((widget_instance*));
static void remove_grabs P_ ((Widget, XtPointer, XtPointer));
static Widget make_popup_menu P_ ((widget_instance*));
static Widget make_main P_ ((widget_instance*));
void xm_destroy_instance P_ ((widget_instance*));
void xm_popup_menu P_ ((Widget, XEvent *));
static void set_min_dialog_size P_ ((Widget));
static void do_call P_ ((Widget, XtPointer, enum do_call_type));
static void xm_generic_callback P_ ((Widget, XtPointer, XtPointer));
static void xm_nosel_callback P_ ((Widget, XtPointer, XtPointer));
static void xm_pull_down_callback P_ ((Widget, XtPointer, XtPointer));
static void xm_pop_down_callback P_ ((Widget, XtPointer, XtPointer));
void xm_set_keyboard_focus P_ ((Widget, Widget));
void xm_set_main_areas P_ ((Widget, Widget, Widget));
static void xm_internal_update_other_instances P_ ((Widget, XtPointer,
                                                    XtPointer));
static void xm_arm_callback P_ ((Widget, XtPointer, XtPointer));

#if 0
void xm_update_one_widget P_ ((widget_instance *, Widget, widget_value *,
                               Boolean));
void xm_pop_instance P_ ((widget_instance*, Boolean));
void xm_manage_resizing P_ ((Widget, Boolean));
#endif


#if 0

/* Print the complete X resource name of widget WIDGET to stderr.
   This is sometimes handy to have available.  */

void
x_print_complete_resource_name (widget)
     Widget widget;
{
  int i;
  String names[100];

  for (i = 0; i < 100 && widget != NULL; ++i)
    {
      names[i] = XtName (widget);
      widget = XtParent (widget);
    }

  for (--i; i >= 1; --i)
    fprintf (stderr, "%s.", names[i]);
  fprintf (stderr, "%s\n", names[0]);
}

#endif /* 0 */


static destroyed_instance *all_destroyed_instances = NULL;

static destroyed_instance*
make_destroyed_instance (name, type, widget, parent, pop_up_p)
     char* name;
     char* type;
     Widget widget;
     Widget parent;
     Boolean pop_up_p;
{
  destroyed_instance* instance =
    (destroyed_instance*)malloc (sizeof (destroyed_instance));
  instance->name = safe_strdup (name);
  instance->type = safe_strdup (type);
  instance->widget = widget;
  instance->parent = parent;
  instance->pop_up_p = pop_up_p;
  instance->next = NULL;
  return instance;
}

static void
free_destroyed_instance (instance)
     destroyed_instance* instance;
{
  free (instance->name);
  free (instance->type);
  free (instance);
}

/* motif utility functions */
Widget
first_child (widget)
     Widget widget;
{
  return ((CompositeWidget)widget)->composite.children [0];
}

Boolean
lw_motif_widget_p (widget)
     Widget widget;
{
  return
    XtClass (widget) == xmDialogShellWidgetClass
      || XmIsPrimitive (widget) || XmIsManager (widget) || XmIsGadget (widget);
}

static XmString
resource_motif_string (widget, name)
     Widget widget;
     char* name;
{
  XtResource resource;
  XmString result = 0;

  resource.resource_name = name;
  resource.resource_class = XmCXmString;
  resource.resource_type = XmRXmString;
  resource.resource_size = sizeof (XmString);
  resource.resource_offset = 0;
  resource.default_type = XtRImmediate;
  resource.default_addr = 0;

  XtGetSubresources (widget, (XtPointer)&result, "dialogString",
                     "DialogString", &resource, 1, NULL, 0);
  return result;
}

/* Destroy all of the children of WIDGET
   starting with number FIRST_CHILD_TO_DESTROY.  */

static void
destroy_all_children (widget, first_child_to_destroy)
     Widget widget;
     int first_child_to_destroy;
{
  Widget* children;
  unsigned int number;
  int i;

  children = XtCompositeChildren (widget, &number);
  if (children)
    {
      XtUnmanageChildren (children + first_child_to_destroy,
                          number - first_child_to_destroy);

      /* Unmanage all children and destroy them.  They will only be
         really destroyed when we get out of DispatchEvent.  */
      for (i = first_child_to_destroy; i < number; i++)
        {
          Arg al[2];
          Widget submenu = 0;
          /* Cascade buttons have submenus,and these submenus
             need to be freed.  But they are not included in
             XtCompositeChildren.  So get it out of the cascade button
             and free it.  If this child is not a cascade button,
             then submenu should remain unchanged.  */
          XtSetArg (al[0], XmNsubMenuId, &submenu);
          XtGetValues (children[i], al, 1);
          if (submenu)
            {
              destroy_all_children (submenu, 0);
              XtDestroyWidget (submenu);
            }
          XtDestroyWidget (children[i]);
        }

      XtFree ((char *) children);
    }
}



/* Callback XmNarmCallback and XmNdisarmCallback for buttons in a
   menu.  CLIENT_DATA contains a pointer to the widget_value
   corresponding to widget W.  CALL_DATA contains a
   XmPushButtonCallbackStruct containing the reason why the callback
   is called.  */

static void
xm_arm_callback (w, client_data, call_data)
     Widget w;
     XtPointer client_data, call_data;
{
  XmPushButtonCallbackStruct *cbs = (XmPushButtonCallbackStruct *) call_data;
  widget_value *wv = (widget_value *) client_data;
  widget_instance *instance;

  /* Get the id of the menu bar or popup menu this widget is in.  */
  while (w != NULL)
    {
      if (XmIsRowColumn (w))
        {
          unsigned char type = 0xff;

          XtVaGetValues (w, XmNrowColumnType, &type, NULL);
          if (type == XmMENU_BAR || type == XmMENU_POPUP)
            break;
        }

      w = XtParent (w);
    }

  if (w != NULL)
    {
      instance = lw_get_widget_instance (w);
      if (instance && instance->info->highlight_cb)
        {
          call_data = cbs->reason == XmCR_DISARM ? NULL : wv;
          instance->info->highlight_cb (w, instance->info->id, call_data);
        }
    }
}



/* Update the label of widget WIDGET.  WIDGET must be a Label widget
   or a subclass of Label.  WIDGET_INSTANCE is unused.  VAL contains
   the value to update.

   Menus:

   Emacs fills VAL->name with the text to display in the menu, and
   sets VAL->value to null.  Function make_menu_in_widget creates
   widgets with VAL->name as resource name.  This works because the
   Label widget uses its resource name for display if no
   XmNlabelString is set.

   Dialogs:

   VAL->name is again set to the resource name, but VAL->value is
   not null, and contains the label string to display.  */

static void
xm_update_label (instance, widget, val)
     widget_instance* instance;
     Widget widget;
     widget_value* val;
{
  XmString res_string = 0;
  XmString built_string = 0;
  XmString key_string = 0;
  Arg al [256];
  int ac;

  ac = 0;

  if (val->value)
    {
      /* A label string is specified, i.e. we are in a dialog.  First
         see if it is overridden by something from the resource file.  */
      res_string = resource_motif_string (widget, val->value);

      if (res_string)
        {
          XtSetArg (al [ac], XmNlabelString, res_string); ac++;
        }
      else
        {
          built_string =
            XmStringCreateLocalized (val->value);
          XtSetArg (al [ac], XmNlabelString, built_string); ac++;
        }

      XtSetArg (al [ac], XmNlabelType, XmSTRING); ac++;
    }

  if (val->key)
    {
      key_string = XmStringCreateLocalized (val->key);
      XtSetArg (al [ac], XmNacceleratorText, key_string); ac++;
    }

  if (ac)
    XtSetValues (widget, al, ac);

  if (built_string)
    XmStringFree (built_string);

  if (key_string)
    XmStringFree (key_string);
}

/* update of list */
static void
xm_update_list (instance, widget, val)
     widget_instance* instance;
     Widget widget;
     widget_value* val;
{
  widget_value* cur;
  int i;
  XtRemoveAllCallbacks (widget, XmNsingleSelectionCallback);
  XtAddCallback (widget, XmNsingleSelectionCallback, xm_generic_callback,
                 instance);
  for (cur = val->contents, i = 0; cur; cur = cur->next)
    if (cur->value)
      {
        XmString xmstr = XmStringCreateLocalized (cur->value);
        i += 1;
        XmListAddItem (widget, xmstr, 0);
        if (cur->selected)
          XmListSelectPos (widget, i, False);
        XmStringFree (xmstr);
      }
}

/* update of buttons */
static void
xm_update_pushbutton (instance, widget, val)
     widget_instance* instance;
     Widget widget;
     widget_value* val;
{
  XtVaSetValues (widget, XmNalignment, XmALIGNMENT_CENTER, NULL);
  XtRemoveAllCallbacks (widget, XmNactivateCallback);
  XtAddCallback (widget, XmNactivateCallback, xm_generic_callback, instance);
}

static void
xm_update_cascadebutton (instance, widget, val)
     widget_instance* instance;
     Widget widget;
     widget_value* val;
{
  /* Should also rebuild the menu by calling ...update_menu... */
  XtRemoveAllCallbacks (widget, XmNcascadingCallback);
  XtAddCallback (widget, XmNcascadingCallback, xm_pull_down_callback,
                 instance);
}

/* update toggle and radiobox */
static void
xm_update_toggle (instance, widget, val)
     widget_instance* instance;
     Widget widget;
     widget_value* val;
{
  XtRemoveAllCallbacks (widget, XmNvalueChangedCallback);
  XtAddCallback (widget, XmNvalueChangedCallback,
                 xm_generic_callback, instance);
  XtVaSetValues (widget, XmNset, val->selected,
                 XmNalignment, XmALIGNMENT_BEGINNING, NULL);
}

static void
xm_update_radiobox (instance, widget, val)
     widget_instance* instance;
     Widget widget;
     widget_value* val;

{
  Widget toggle;
  widget_value* cur;

  /* update the callback */
  XtRemoveAllCallbacks (widget, XmNentryCallback);
  XtAddCallback (widget, XmNentryCallback, xm_generic_callback, instance);

  /* first update all the toggles */
  /* Energize kernel interface is currently bad.  It sets the selected widget
     with the selected flag but returns it by its name.  So we currently
     have to support both setting the selection with the selected slot
     of val contents and setting it with the "value" slot of val.  The latter
     has a higher priority.  This to be removed when the kernel is fixed. */
  for (cur = val->contents; cur; cur = cur->next)
    {
      toggle = XtNameToWidget (widget, cur->value);
      if (toggle)
        {
          XtSetSensitive (toggle, cur->enabled);
          if (!val->value && cur->selected)
            XtVaSetValues (toggle, XmNset, cur->selected, NULL);
          if (val->value && strcmp (val->value, cur->value))
            XtVaSetValues (toggle, XmNset, False, NULL);
        }
    }

  /* The selected was specified by the value slot */
  if (val->value)
    {
      toggle = XtNameToWidget (widget, val->value);
      if (toggle)
        XtVaSetValues (toggle, XmNset, True, NULL);
    }
}


/* update a popup menu, pulldown menu or a menubar */

/* KEEP_FIRST_CHILDREN gives the number of initial children to keep.  */

static void
make_menu_in_widget (instance, widget, val, keep_first_children)
     widget_instance* instance;
     Widget widget;
     widget_value* val;
     int keep_first_children;
{
  Widget* children = 0;
  int num_children;
  int child_index;
  widget_value* cur;
  Widget button = 0;
  Widget title = 0;
  Widget menu;
  Arg al [256];
  int ac;
  Boolean menubar_p;
  unsigned char type;

  Widget* old_children;
  unsigned int old_num_children;

  /* Disable drag and drop for labels in menu bar.  */
  static char overrideTrans[] = "<Btn2Down>: Noop()";
  XtTranslations override = XtParseTranslationTable (overrideTrans);

  old_children = XtCompositeChildren (widget, &old_num_children);

  /* Allocate the children array */
  for (num_children = 0, cur = val; cur; num_children++, cur = cur->next)
    ;
  children = (Widget*)XtMalloc (num_children * sizeof (Widget));

  /* WIDGET should be a RowColumn.  */
  if (!XmIsRowColumn (widget))
    abort ();

  /* Determine whether WIDGET is a menu bar.  */
  type = -1;
  XtSetArg (al[0], XmNrowColumnType, &type);
  XtGetValues (widget, al, 1);
  if (type != XmMENU_BAR && type != XmMENU_PULLDOWN && type != XmMENU_POPUP)
    abort ();
  menubar_p = type == XmMENU_BAR;

  /* Add a callback to popups and pulldowns that is called when
     it is made invisible again.  */
  if (!menubar_p)
    XtAddCallback (XtParent (widget), XmNpopdownCallback,
                   xm_pop_down_callback, (XtPointer)instance);

  /* Preserve the first KEEP_FIRST_CHILDREN old children.  */
  for (child_index = 0, cur = val; child_index < keep_first_children;
       child_index++, cur = cur->next)
    children[child_index] = old_children[child_index];