Implement tool-bar separators for non-GTK tool-bars.

* lisp/tool-bar.el (tool-bar--image-expression): New function.
(tool-bar-local-item, tool-bar--image-exp): Use it.
(tool-bar-setup): Initialize tool-bar-separator-image-expression.
Use :enable instead of :visible to avoid changing the tool-bar
configuration unnecessarily.

* src/keyboard.c (Vtool_bar_separator_image_expression): New variable.
(parse_tool_bar_item): Use it to obtain image separators for
displays not using native tool-bar separators.

* src/xdisp.c (build_desired_tool_bar_string): Don't handle separators
specially, since this is now done in parse_tool_bar_item.

* lisp/info.el (info-tool-bar-map): Add separators.

3 files changed, 32 insertions, 6 deletions

diff --git a/src/ChangeLog b/src/ChangeLog
index 4313c68f593..a6ee107422c 100644
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,12 @@
+2010-12-20  Chong Yidong  <cyd@stupidchicken.com>
+
+        * keyboard.c (Vtool_bar_separator_image_expression): New variable.
+        (parse_tool_bar_item): Use it to obtain image separators for
+        displays not using native tool-bar separators.
+
+        * xdisp.c (build_desired_tool_bar_string): Don't handle separators
+        specially, since this is now done in parse_tool_bar_item.
+
 2010-12-19  Stefan Monnier  <monnier@iro.umontreal.ca>
 
         Minor clean up to silence some gcc warnings.
diff --git a/src/keyboard.c b/src/keyboard.c
index 959c57a81e3..27c311d72e2 100644
--- a/src/keyboard.c
+++ b/src/keyboard.c
@@ -212,6 +212,12 @@ Lisp_Object Vprefix_help_command;
 /* List of items that should move to the end of the menu bar.  */
 Lisp_Object Vmenu_bar_final_items;
 
+/* Expression to evaluate for the tool bar separator image.
+   This is used for build_desired_tool_bar_string only.  For GTK, we
+   use GTK tool bar seperators.  */
+
+Lisp_Object Vtool_bar_separator_image_expression;
+
 /* Non-nil means show the equivalent key-binding for
    any M-x command that has one.
    The value can be a length of time to show the message for.
@@ -8294,6 +8300,15 @@ parse_tool_bar_item (Lisp_Object key, Lisp_Object item)
       if (menu_separator_name_p (SDATA (caption)))
         {
           PROP (TOOL_BAR_ITEM_TYPE) = Qt;
+#if !defined (USE_GTK) && !defined (HAVE_NS)
+          /* If we use build_desired_tool_bar_string to render the
+             tool bar, the separator is rendered as an image.  */
+          PROP (TOOL_BAR_ITEM_IMAGES)
+            = menu_item_eval_property (Vtool_bar_separator_image_expression);
+          PROP (TOOL_BAR_ITEM_ENABLED_P) = Qnil;
+          PROP (TOOL_BAR_ITEM_SELECTED_P) = Qnil;
+          PROP (TOOL_BAR_ITEM_CAPTION) = Qnil;
+#endif
           return 1;
         }
       return 0;
@@ -12151,6 +12166,12 @@ might happen repeatedly and make Emacs nonfunctional.  */);
 The elements of the list are event types that may have menu bar bindings.  */);
   Vmenu_bar_final_items = Qnil;
 
+  DEFVAR_LISP ("tool-bar-separator-image-expression", &Vtool_bar_separator_image_expression,
+    doc: /* Expression evaluating to the image spec for a tool-bar separator.
+This is used internally by graphical displays that do not render
+tool-bar separators natively.  Otherwise it is unused (e.g. on GTK).  */);
+  Vtool_bar_separator_image_expression = Qnil;
+
   DEFVAR_KBOARD ("overriding-terminal-local-map",
                  Voverriding_terminal_local_map,
                  doc: /* Per-terminal keymap that overrides all other local keymaps.
diff --git a/src/xdisp.c b/src/xdisp.c
index 41204e0a5b4..7a299055185 100644
--- a/src/xdisp.c
+++ b/src/xdisp.c
@@ -10317,10 +10317,6 @@ build_desired_tool_bar_string (struct frame *f)
       int selected_p = !NILP (PROP (TOOL_BAR_ITEM_SELECTED_P));
       int hmargin, vmargin, relief, idx, end;
 
-      /* Ignore separator items.  */
-      if (EQ (PROP (TOOL_BAR_ITEM_TYPE), Qt))
-        continue;
-
       /* If image is a vector, choose the image according to the
          button state.  */
       image = PROP (TOOL_BAR_ITEM_IMAGES);
@@ -10495,7 +10491,7 @@ display_tool_bar_line (struct it *it, int height)
               row->used[TEXT_AREA] = n_glyphs_before;
               *it = it_before;
               /* If this is the only glyph on this line, it will never fit on the
-                 toolbar, so skip it.  But ensure there is at least one glyph,
+                 tool-bar, so skip it.  But ensure there is at least one glyph,
                  so we don't accidentally disable the tool-bar.  */
               if (n_glyphs_before == 0
                   && (it->vpos > 0 || IT_STRING_CHARPOS (*it) < it->end_charpos-1))
@@ -26885,7 +26881,7 @@ vertical margin.  */);
   tool_bar_button_relief = DEFAULT_TOOL_BAR_BUTTON_RELIEF;
 
   DEFVAR_LISP ("tool-bar-style", &Vtool_bar_style,
-    doc: /* *Tool bar style to use.
+    doc: /* Tool bar style to use.
 It can be one of
  image            - show images only
  text             - show text only