[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
master 02739149218 1/3: Merge from origin/emacs-29
|
From: |
Eli Zaretskii |
|
Subject: |
master 02739149218 1/3: Merge from origin/emacs-29 |
|
Date: |
Sat, 9 Sep 2023 04:41:45 -0400 (EDT) |
branch: master
commit 0273914921833d2e2b6548cf69297c24a50cff74
Merge: f77ea3b2d75 bc56da92d8d
Author: Eli Zaretskii <eliz@gnu.org>
Commit: Eli Zaretskii <eliz@gnu.org>
Merge from origin/emacs-29
bc56da92d8d ; Fix error in 'tex-recenter-output-buffer'
d17c5adc057 Fix regexp for recognizing PBM images
9e9f61866e7 Improve wording in ELisp manual
7427efa033b Fix typo (Bug#65764)
59c66244080 ; * lisp/ido.el (ido-completion-buffer): Fix :type (bug#6...
4ec4b18c2a0 Fix libgccjit build on Haiku
80bdcf8f351 (regexp-tests-backtrack-optimization): Mark it as failing
8a9e653cc82 ; Add regression test for bug#65726
6fad73d7cc5 * src/regex-emacs.c (mutually_exclusive_p): Fix inf-loop ...
1d3d4196073 ; * lisp/files.el (save-some-buffers-functions): Doc fix ...
42b14c6e5bb Bump seq version to 2.24
ff5190a174f Add note on ELPA to admin/notes/bug-triage
f1e4cbe72aa ; * etc/PROBLEMS: Minor wording fix.
fd5593c7f25 * etc/PROBLEMS: Mention bug#65432 and its remedy.
dd896ea1e62 Ignore errors when checking for object initializers (bug#...
3550f44c17c ; Fix typos
5b246b9b817 * CONTRIBUTE: Document making ChangeLogs with Magit.
0bd46619413 Doc fixes for obsolete functions and variables
524c0c34f24 ; * lisp/ffap.el (ffap-rfs-regexp): Fix :type (bug#65698).
f48dccc4675 Merge branch 'emacs-29' of git.savannah.gnu.org:/srv/git/...
71a85e22668 A revision to the Widget manual
dbbcf4a6599 Fix fontification of " in edit-kbd-macro
# Conflicts:
# test/src/regex-emacs-tests.el
---
CONTRIBUTE | 5 +
admin/notes/bug-triage | 71 +-
admin/notes/multi-tty | 2 -
configure.ac | 5 +-
doc/emacs/building.texi | 7 +-
doc/lispref/objects.texi | 4 +-
doc/misc/efaq-w32.texi | 12 +-
doc/misc/gnus.texi | 4 +-
doc/misc/widget.texi | 2779 ++++++++++++++++++++++++++++++-----------
etc/PROBLEMS | 12 +
lisp/ChangeLog.12 | 2 +-
lisp/align.el | 2 +-
lisp/emacs-lisp/eieio.el | 7 +-
lisp/emacs-lisp/seq.el | 2 +-
lisp/ffap.el | 3 +-
lisp/files.el | 10 +-
lisp/ido.el | 3 +-
lisp/image.el | 2 +-
lisp/org/ChangeLog.1 | 2 +-
lisp/progmodes/csharp-mode.el | 2 +-
lisp/progmodes/perl-mode.el | 4 -
lisp/subr.el | 2 +-
lisp/textmodes/ispell.el | 4 +-
lisp/textmodes/tex-mode.el | 18 +-
src/buffer.h | 6 +-
src/data.c | 2 +-
src/regex-emacs.c | 2 +-
test/src/regex-emacs-tests.el | 5 +
28 files changed, 2195 insertions(+), 784 deletions(-)
diff --git a/CONTRIBUTE b/CONTRIBUTE
index 464b800adfb..1cc98c4bdad 100644
--- a/CONTRIBUTE
+++ b/CONTRIBUTE
@@ -300,6 +300,11 @@ them right the first time, so here are guidelines for
formatting them:
blank ChangeLog entries from the diff being committed, then use
'M-q' to combine and fill them. See 'info "(emacs) Log Buffer"'.
+- If you use the third-party package Magit, you can use
+ 'magit-generate-changelog' from the commit message buffer.
+ See also 'magit-add-change-log-entry' and
+ 'magit-add-change-log-entry-other-window'.
+
- Alternatively, you can use Emacs functions for ChangeLog files; see
https://www.gnu.org/software/emacs/manual/html_node/emacs/Change-Log-Commands.html
or run 'info "(emacs)Change Log Commands"'.
diff --git a/admin/notes/bug-triage b/admin/notes/bug-triage
index bee7242337d..6fad55dc1e3 100644
--- a/admin/notes/bug-triage
+++ b/admin/notes/bug-triage
@@ -1,10 +1,10 @@
HOW TO TRIAGE EMACS BUGS -*- outline -*-
-This document just describes the procedure of triaging bugs, for information on
-how to work with the bug tracker, see the bugtracker file in this same
directory
-for the basics. You can also install the debbugs ELPA package for access to
M-x
-debbugs-gnu, an emacs interface to debbugs, and M-x debbugs-org, an emacs
-interface via org-mode.
+This document describes the procedure of triaging bugs. For information on how
+to work with the bug tracker, see the file "bugtracker" in the same directory
as
+this file for the basics. You can also install the GNU ELPA package 'debbugs'
+for access to 'M-x debbugs-gnu', an Emacs interface to the debbugs bug tracker,
+and 'M-x debbugs-org', an Emacs interface via org-mode.
* Bug backlog triage procedure
@@ -15,9 +15,10 @@ the ones that are not reproducible on the current release.
calling debbugs-gnu-emacs-release-blocking-reports. If you want
to check this for another Emacs version but the next-to-be-released-one,
use the "C-u" prefix.
- 1. After that, enter debbugs mode (either debbugs-gnu, debbugs-org, or via
the
- web browser), and accept the default list option of bugs that have
severity
- serious, important, or normal.
+ 1. After that, enter debbugs mode (either using 'M-x debbugs-gnu',
+ 'M-x debbugs-org', or via the web browser), and accept the
+ default list option of bugs that have severity "serious",
+ "important", or "normal".
2. For each bug, we want to primarily make sure it is still
reproducible. A bug can and should stay open as long as it is
still a bug and no one has fixed it. The following is a
@@ -90,21 +91,51 @@ necessary information for others to act on.
For each new bug, ask the following questions:
- 1. Is the bug report written in a way to be easy to reproduce (starts from
- "emacs -Q", etc.)? If not, ask the reporter to try and reproduce it on an
- emacs without customization.
- 2. Is the bug report written against the latest emacs? If not, try to
- reproduce on the latest version, and if it can't be reproduced, ask the
- reporter to try again with the latest version.
+ 1. Is the bug report written in a way to be easy to reproduce
+ (starts from "emacs -Q", etc.)? If not, ask the reporter to try
+ and reproduce it on an emacs without customization.
+ 2. Is the bug report written against the latest emacs? If not, try
+ to reproduce on the latest version, and if it can't be
+ reproduced, ask the reporter to try again with the latest
+ version.
3. Is the bug the same as another bug? If so, merge the bugs.
- 4. What is the priority of the bug? Add a priority: serious, important,
- normal, minor, or wishlist.
- 5. Who should be the owner? This depends on what component the bug is part
- of. You can look at the admin/MAINTAINERS file (then you can just search
- emacs-devel to match the name with an email address).
+ 4. What is the priority of the bug? Add a priority: "serious",
+ "important", "normal", "minor, or "wishlist".
+ 5. Who should be the owner? This depends on what component the bug
+ is part of. You can look at the "Maintainer" comment header in
+ the relevant Lisp files. If you can't find the name there, look
+ at admin/MAINTAINERS file (then you can just search emacs-devel
+ to match the name with an email address).
In the debbugs-gnu buffer, bugs are marked in the "State" column
according to the communication flow. Red bugs mean that nobody has
-answered, these bugs need primary attention. Green bugs flag that
+answered; these bugs need primary attention. Green bugs flag that
there is a recent communication about, and orange bugs flag that the
bug hasn't been touched for at least two weeks.
+
+* Bugs in GNU ELPA and NonGNU ELPA packages
+
+The goal here is to ping the relevant maintainers, as Emacs core
+developers aren't always up-to-date with recent developments in all
+GNU ELPA packages, and can't do anything with reports about bugs in
+NonGNU ELPA packages.
+
+This is how we deal with them:
+
+ 1. Bugs in GNU ELPA packages can always be reported to our bug
+ tracker, even if they are usually tracked by other means. Search
+ for the maintainer of that package, e.g. on
+ https://elpa.gnu.org/packages and take note of their email
+ address. Send a reply with an email body like "<name> is the
+ maintainer of <package>, so I'm copying them in here.", and
+ include their email address in Cc.
+ 2. Bugs in NonGNU ELPA packages should be sent to their maintainers,
+ because we can't do anything to fix them. If you suspect that
+ the bug is about a NonGNU ELPA package, it's usually polite to
+ ask the reporter if this is indeed the case (in case you
+ misunderstood something), and then to point them in the right
+ direction. Such bugs can be closed once the confusion has been
+ resolved.
+ 3. Bugs in third-party packages that are not in any of the above
+ repositories are handled in the same way as packages in NonGNU
+ ELPA.
diff --git a/admin/notes/multi-tty b/admin/notes/multi-tty
index d0b63f166fd..16f2bec4d80 100644
--- a/admin/notes/multi-tty
+++ b/admin/notes/multi-tty
@@ -480,8 +480,6 @@ THINGS TO DO
** Have a look at set_frame_matrix_frame.
-** Check if we got term-setup-hook right.
-
** I think tip_frame should be display-local.
** Check display reference count handling in x_create_tip_frame.
diff --git a/configure.ac b/configure.ac
index ee13b2e0659..7ca75be996d 100644
--- a/configure.ac
+++ b/configure.ac
@@ -5171,8 +5171,9 @@ if test "${with_native_compilation}" != "no"; then
case "${opsys}" in
# mingw32 loads the library dynamically.
mingw32) ;;
- # OpenBSD doesn't have libdl, all the functions are in libc
- netbsd|openbsd)
+ # Neither NetBSD, OpenBSD nor Haiku have libdl, with all dynamic
+ # linker functions placed within libc.
+ netbsd|openbsd|haiku)
LIBGCCJIT_LIBS="-lgccjit" ;;
darwin)
LIBGCCJIT_CFLAGS="${MAC_CFLAGS}"
diff --git a/doc/emacs/building.texi b/doc/emacs/building.texi
index f82b605598e..d6610099460 100644
--- a/doc/emacs/building.texi
+++ b/doc/emacs/building.texi
@@ -701,7 +701,6 @@ to recompile and restart the program.
@cindex GUD Tooltip mode
@cindex mode, GUD Tooltip
@findex gud-tooltip-mode
-@vindex gud-tooltip-echo-area
GUD Tooltip mode is a global minor mode that adds tooltip support to
GUD@. To toggle this mode, type @kbd{M-x gud-tooltip-mode}. It is
disabled by default. If enabled, you can move the mouse pointer over a
@@ -713,10 +712,8 @@ you can tell Emacs more explicitly what expression to
evaluate by
dragging the mouse over the expression, then leaving the mouse inside
the marked area. The GUD Tooltip mode takes effect in the GUD
interaction buffer, and in all source buffers with major modes listed
-in the variable @code{gud-tooltip-modes}. If the variable
-@code{gud-tooltip-echo-area} is non-@code{nil}, or if you turned off
-the tooltip mode, values are shown in the echo area instead of a
-tooltip.
+in the variable @code{gud-tooltip-modes}. If you turned off the
+tooltip mode, values are shown in the echo area instead of a tooltip.
When using GUD Tooltip mode with @kbd{M-x gud-gdb}, displaying an
expression's value in GDB can sometimes expand a macro, potentially
diff --git a/doc/lispref/objects.texi b/doc/lispref/objects.texi
index 784d59720ed..9febcbefa33 100644
--- a/doc/lispref/objects.texi
+++ b/doc/lispref/objects.texi
@@ -82,7 +82,9 @@ it does not make sense to enter objects of these types as
constants in
a Lisp program. These objects are printed in @dfn{hash notation},
which consists of the characters @samp{#<}, a descriptive string
(typically the type name followed by the name of the object), and a
-closing @samp{>}. For example:
+closing @samp{>}. (This is called ``hash notation'' because it begins
+with the @samp{#} character, known as ``hash'' or ``number sign'').
+For example:
@example
(current-buffer)
diff --git a/doc/misc/efaq-w32.texi b/doc/misc/efaq-w32.texi
index 71d4b4e1fc2..de9354500df 100644
--- a/doc/misc/efaq-w32.texi
+++ b/doc/misc/efaq-w32.texi
@@ -1168,15 +1168,15 @@ binary and the Ctrl-M characters are significant.
@subsection CR/LF translation by file system
@cindex line ends, determining by filesystem
@cindex binary files, determining by filesystem
-@vindex untranslated-filesystem-list
-@findex add-untranslated-filesystem
-@findex remove-untranslated-filesystem
+@vindex w32-untranslated-filesystem-list
+@findex w32-add-untranslated-filesystem
+@findex w32-remove-untranslated-filesystem
-The variable @code{untranslated-filesystem-list} defines whole
+The variable @code{w32-untranslated-filesystem-list} defines whole
directory trees that should not have CR/LF autodetection performed on
them. The list can be manipulated with the functions
-@code{add-untranslated-filesystem} and
-@code{remove-untranslated-filesystem}. With auto-detection in
+@code{w32-add-untranslated-filesystem} and
+@code{w32-remove-untranslated-filesystem}. With auto-detection in
recent versions of Emacs, this is seldom useful for existing files,
but can still be used to influence the choice of line ends for newly
created files.
diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi
index f017b011d71..7ebd82c5bed 100644
--- a/doc/misc/gnus.texi
+++ b/doc/misc/gnus.texi
@@ -24526,8 +24526,8 @@ that is needed. It can also contain @samp{(@var{addr}
@var{string}
@var{amount})} cells, where the @var{string} is the string to use
(normally the email address or newsgroup name is used).
-@item hashcash-path
-@vindex hashcash-path
+@item hashcash-program
+@vindex hashcash-program
Where the @code{hashcash} binary is installed. This variable should
be automatically set by @code{executable-find}, but if it's @code{nil}
(usually because the @code{hashcash} binary is not in your path)
diff --git a/doc/misc/widget.texi b/doc/misc/widget.texi
index 13b37ab5b54..eb411f29c5c 100644
--- a/doc/misc/widget.texi
+++ b/doc/misc/widget.texi
@@ -49,14 +49,16 @@ modify this GNU manual.''
* Introduction::
* User Interface::
* Programming Example::
+* Widgets Basics::
* Setting Up the Buffer::
-* Basic Types::
-* Sexp Types::
-* Widget Properties::
+* Working with Widgets::
+* Widgets and the Buffer::
+* Widget Gallery::
* Defining New Widgets::
-* Widget Browser::
+* Inspecting Widgets::
* Widget Minor Mode::
* Utilities::
+* Customization::
* Widget Wishlist::
* GNU Free Documentation License::
* Index::
@@ -68,7 +70,7 @@ modify this GNU manual.''
Most graphical user interface toolkits provide a number of standard
user interface controls (sometimes known as ``widgets'' or ``gadgets'').
Emacs doesn't really support anything like this, except for an
-incredibly powerful text ``widget.'' On the other hand, Emacs does
+incredibly powerful text ``widget''. On the other hand, Emacs does
provide the necessary primitives to implement many other widgets
within a text buffer. The @code{widget} package simplifies this task.
@@ -85,13 +87,13 @@ Like link, but intended for stand-alone buttons.
@item editable-field
An editable text field. It can be either variable or fixed length.
@item menu-choice
-Allows the user to choose one of multiple options from a menu, each
-option is itself a widget. Only the selected option will be visible in
-the buffer.
+Allows the user to choose one of multiple options from a menu, where
+each option is itself a widget. Only the selected option is visible
+in the buffer.
@item radio-button-choice
Allows the user to choose one of multiple options by activating radio
-buttons. The options are implemented as widgets. All options will be
-visible in the buffer.
+buttons. The options are implemented as widgets. All options are
+visible in the buffer, with the selected one marked as chosen.
@item item
A simple constant widget intended to be used in the @code{menu-choice} and
@code{radio-button-choice} widgets.
@@ -137,9 +139,9 @@ Editing happens in the buffer, not in the mini-buffer.
Packages using the library get a uniform look, making them easier for
the user to learn.
@item
-As support for embedded graphics improve, the widget library will be
+As support for embedded graphics improve, the Widget library will be
extended to use the GUI features. This means that your code using the
-widget library will also use the new graphic features automatically.
+Widget library will also use the new graphic features automatically.
@end enumerate
@node User Interface
@@ -201,12 +203,6 @@ middle of another field is prohibited.
Editable text fields are created by the @code{editable-field} widget.
-@strong{Warning:} In an @code{editable-field} widget, the editable
-field must not be adjacent to another widget---that won't work.
-You must put some text in between. Either make this text part of
-the @code{editable-field} widget itself, or insert it with
-@code{widget-insert}.
-
The @code{:format} keyword is useful for generating the necessary
text; for instance, if you give it a value of @code{"Name: %v "},
the @samp{Name: } part will provide the necessary separating text
@@ -215,17 +211,9 @@ separating text after the field. If you don't include the
@code{:size} keyword, the field will extend to the end of the
line, and the terminating newline will provide separation after.
-@strong{Warning:} In an @code{editable-field} widget, the @samp{%v} escape
-must be preceded by some other text in the @code{:format} string
-(if specified).
-
The editing text fields are highlighted with the
@code{widget-field-face} face, making them easy to find.
-@deffn Face widget-field-face
-Face used for other editing fields.
-@end deffn
-
@section Buttons
@cindex widget buttons
@@ -233,24 +221,9 @@ Face used for other editing fields.
Some portions of the buffer have an associated @dfn{action}, which can
be @dfn{invoked} by a standard key or mouse command. These portions
are called @dfn{buttons}. The default commands for activating a button
-are:
-
-@table @kbd
-@item @key{RET}
-@deffn Command widget-button-press @var{pos} &optional @var{event}
-Invoke the button at @var{pos}, defaulting to point.
-If point is not located on a button, invoke the binding in
-@code{widget-global-map} (by default the global map).
-@end deffn
-
-@kindex mouse-2 @r{(on button widgets})
-@item mouse-2
-@deffn Command widget-button-click @var{event}
-Invoke the button at the location of the mouse pointer. If the mouse
-pointer is located in an editable text field, invoke the binding in
-@code{widget-global-map} (by default the global map).
-@end deffn
-@end table
+are @code{widget-button-press} and @code{widget-button-click}. The
+user typically interacts with the buttons with a key, like @key{RET},
+or with the mouse buttons.
There are several different kind of buttons, all of which are present in
the example:
@@ -286,33 +259,15 @@ main difference from the @code{link} widget is that the
buttons will be
displayed as GUI buttons when possible.
@end table
-To make them easier to locate, buttons are emphasized in the buffer.
-
-@deffn Face widget-button-face
-Face used for buttons.
-@end deffn
-
-@defopt widget-mouse-face
-Face used for highlighting a button when the mouse pointer moves across
-it.
-@end defopt
+To make them easier to locate, buttons are emphasized in the buffer
+with a distinctive face, like @code{widget-button-face} or
+@code{widget-mouse-face}.
@section Navigation
You can use all the normal Emacs commands to move around in a form
-buffer, plus you will have these additional commands:
-
-@table @kbd
-@item @key{TAB}
-@deffn Command widget-forward &optional count
-Move point @var{count} buttons or editing fields forward.
-@end deffn
-@item @kbd{M-@key{TAB}}
-@itemx @kbd{S-@key{TAB}}
-@deffn Command widget-backward &optional count
-Move point @var{count} buttons or editing fields backward.
-@end deffn
-@end table
+buffer, plus you will have these additional commands to navigate from
+widget to widget: @code{widget-forward} and @code{widget-backward}.
@node Programming Example
@chapter Programming Example
@@ -414,315 +369,1050 @@ Interface}).
(widget-setup))
@end lisp
+@node Widgets Basics
+@chapter Widgets Basics
+@cindex widget object
+The Widget Library deals with widgets objects. A widget object has
+properties whose value may be anything, be it numbers, strings,
+symbols, functions, etc. Those properties are referred to as keywords
+and are responsible for the way a widget is represented in a buffer,
+and control the way a user or a program can interact with it.
+
+@cindex widget inheritance
+The library defines several widget types, and gives you a way to
+define new types as well. In addition, widgets can derive from other
+types, creating a sort of widget inheritance. In fact, all widgets
+defined in the Widget Library share a common parent, the @dfn{default}
+widget. In this manual, when we talk about a default behavior, we
+usually mean the behavior as defined by this @code{default} widget.
+@xref{Widget Gallery}, for a description of each defined widget.
+
+Defining a new type that derives from a previous one is not mandatory
+to create widgets that work very different from a specified type.
+When creating a widget, you can override any default property,
+including functions, that control the widget. That is, you can
+specialize a widget on creation, without having to define it as a new
+type of widget.
+
+In addition to the function for defining a widget, this library
+provides functions to create widgets, query and change its properties,
+respond to user events and destroy them. The following sections
+describe them.
+
+@cindex widget value
+One important property of a widget is its @dfn{value}. All widgets
+may have a value, which is stored in a so-called @dfn{internal format}.
+For the rest of Emacs, the widget presents its value in a so-called
+@dfn{external format}. Both formats can be equal or different, and
+each widget is responsible for defining how the conversion between
+each format should happen.
+
+@c FIXME: Briefly describe inline widgets?
+@c The inline concept is described elsewhere, and it's difficult to
+@c describe.
+
+The value property is an important property for almost all widgets,
+and perhaps more important for @code{editable-field} widgets. This
+type of widgets allow the user to edit them via the usual editing
+commands in Emacs. They can also be edited programmatically.
+@strong{Important:} You @emph{must} call @code{widget-setup} after
+modifying the value of a widget before the user is allowed to edit the
+widget again. It is enough to call @code{widget-setup} once if you
+modify multiple widgets. This is currently only necessary if the widget
+contains an editing field, but may be necessary for other widgets in the
+future.
+
+@cindex widget properties
+If your application needs to associate some information with the widget
+objects, for example a reference to the item being edited, it can be
+done with the @code{widget-put} and @code{widget-get} functions. The
+property names, as shown, are keywords, so they must begin with a
+@samp{:}.
+
@node Setting Up the Buffer
@chapter Setting Up the Buffer
+@cindex widget creation, widget conversion
+To show the widgets in a buffer, you have to create them. Widget
+creation is actually a two-step process: conversion and creation per
+se. With simple projects, usually the conversion step isn't really
+important, and you only care about widget creation, so feel free to
+skip the conversion description until you really need to know it.
+
+Widget conversion is the process that involves taking a widget
+specification and transforming it into a @dfn{widget} object, suitable
+to be created, queried and manipulated with other widget functions.
+Widget creation is the process that takes a widget object and actually
+inserts it in the buffer.
+
+The simplest function to create a widget is @code{widget-create}, which
+gets a widget specification and returns a widget object.
+
+@defun widget-create type [ keyword argument ]@dots{} args
+Create and return a widget of type @var{type}, converting it.
+
+@var{type} is a symbol that specifies a widget type. @var{keyword}
+may be one of the properties supported by the widget type, and
+@var{argument} specify the value for that property. These keyword
+arguments can be used to overwrite the keyword arguments that are part
+of @var{type} by default, as well as to provide other properties not
+present in @var{type} by default. @var{args} holds additional
+information for the creation of @var{type} and each widget type is
+responsible for handling that information in a specific way.
+
+The syntax for the @var{type} argument is described in @ref{Widget
+Gallery}, and in more detail in every widget where it's relevant.
+@end defun
+
+There are other functions for creating widgets, useful when you work
+with composite widgets. That is, widgets that are part of other
+widgets.
-Widgets are created with @code{widget-create}, which returns a
-@dfn{widget} object. This object can be queried and manipulated by
-other widget functions, until it is deleted with @code{widget-delete}.
-After the widgets have been created, @code{widget-setup} must be called
-to enable them.
+@defun widget-create-child-and-convert parent type &rest args
+Create a widget of type @var{type} as a child of @var{parent}.
-@defun widget-create type [ keyword argument ]@dots{}
-Create and return a widget of type @var{type}.
-The syntax for the @var{type} argument is described in @ref{Basic Types}.
+Before creating it, converts @var{type} using the keyword arguments
+provided in @var{args}.
+@c FIXME: Is this description useful?
+Adds the @code{:indent} property, unless it is already present, and
+sets it to the sum of the values of: @code{:indent} and @code{:offset}
+from @var{parent} and @code{:extra-offset} from @var{type}.
-The keyword arguments can be used to overwrite the keyword arguments
-that are part of @var{type}.
+Returns a widget object, with the property @code{:parent} set to
+@var{PARENT}.
@end defun
-@defun widget-delete widget
-Delete @var{widget} and remove it from the buffer.
+@defun widget-create-child parent type
+Create a widget of type @var{type} as a child of @var{parent}.
+
+This function is like @code{widget-create-child-and-convert} but it
+doesn't convert @var{type}, so it expects an already converted widget.
@end defun
+@defun widget-create-child-value parent type value
+Create a widget of type @var{type} as a child of @var{parent} with
+value @var{value}.
+
+This function is like @code{widget-create-child}, but it lets you
+specify a value for the widget.
+
+Converts @var{value} to the internal format, as specified by
+@var{type}, and stores it into the @code{:value} property of @var{type}.
+That means, @var{value} should be in the external format, as
+specified by @var{type}.
+@end defun
+
+All these creating functions described here use the function stored in
+the @code{:create} property. So, to modify the creation logic for a
+widget, you can provide a different @code{:create} function.
+
+When you're done creating widgets and you're ready for the user to
+interact with the buffer, use the function @code{widget-setup}.
+
@defun widget-setup
-Set up a buffer to support widgets.
+Setup the current buffer, so that editable widgets can be edited.
This should be called after creating all the widgets and before allowing
the user to edit them.
@end defun
-If you want to insert text outside the widgets in the form, the
-recommended way to do that is with @code{widget-insert}.
+As mentioned, all these functions return a widget object. That widget
+object can be queried and manipulated with widget functions that
+take widgets as arguments, until deleting it with the widgets
+functions available to delete widgets. Even if you don't save the
+returned widget object, you still can interact programmatically with
+the widget. @xref{Working with Widgets}.
-@defun widget-insert
-Insert the arguments, either strings or characters, at point.
-The inserted text will be read-only.
+@defun widget-delete widget
+Delete the widget @var{widget} and remove it from the buffer.
@end defun
-There is a standard widget keymap which you might find useful.
+@defun widget-children-value-delete widget
+Delete all children and buttons in widget @var{widget}.
-@findex widget-button-press
-@findex widget-button-click
-@defvr Const widget-keymap
-@key{TAB} and @kbd{C-@key{TAB}} are bound to @code{widget-forward} and
-@code{widget-backward}, respectively. @key{RET} and @kbd{mouse-2}
-are bound to @code{widget-button-press} and
-@code{widget-button-click}.
-@end defvr
+This function does not delete @var{widget} itself, only the widgets
+stored in the @code{:children} and @code{:buttons} properties. It
+also sets those properties to @code{nil}.
+@end defun
-@defvar widget-global-map
-Keymap used by @code{widget-button-press} and @code{widget-button-click}
-when not on a button. By default this is @code{global-map}.
-@end defvar
+As with the creation mechanism, the function stored in @code{:delete}
+controls the deletion mechanism for a widget.
-@node Basic Types
-@chapter Basic Types
+Additionally, the library provides a way to make a copy of a widget.
-This is the general syntax of a type specification:
+@defun widget-copy widget
+Makes a copy of widget @var{widget} and returns it.
-@example
-@var{name} ::= (@var{name} [@var{keyword} @var{argument}]... @var{args})
- | @var{name}
-@end example
+It uses the function stored in the @code{:copy} property of @var{widget}
+and returns the widget that that function returns.
+@end defun
-Where, @var{name} is a widget name, @var{keyword} is the name of a
-property, @var{argument} is the value of the property, and @var{args}
-are interpreted in a widget specific way.
+As discussed, there is a conversion step when creating a widget. To
+do the conversion without actually creating the widget, you can use
+the @code{widget-convert} function.
-@cindex keyword arguments
-The following keyword arguments apply to all widgets:
+@defun widget-convert type &rest args
+Convert @var{type} to a widget object, using keyword arguments @var{args}.
-@table @code
-@cindex internal format
-@cindex external format
-@vindex value@r{ keyword}
-@item :value
-The initial value for widgets of this type. Typically, a widget
-represents its value in two formats: external and internal. The
-external format is the value as the rest of Emacs sees it, and the
-internal format is a representation that the widget defines and uses
-in a widget specific way.
+Returns a widget object, suitable for creation. It calls the function
+stored in the @code{:convert-widget} property, after putting into the
+@code{:args} property the arguments that the widget in question needs.
+If @var{type} has a @code{:value} property, either originally or after
+doing the conversion, this function converts the value stored in
+@code{:value} to the internal format, and stores it into @code{:value}.
+@end defun
-Both formats might be the same for certain widgets and might differ
-for others, and there is no guarantee about which format the value
-stored in the @code{:value} property has. However, when creating a
-widget or defining a new one (@pxref{Defining New Widgets}), the
-@code{:value} should be in the external format.
+Apart from only creating widgets in the buffer, It's useful to have
+plain text. For inserting text, the recommended way is with the
+@code{widget-insert} function.
-@vindex format@r{ keyword}
-@item :format
-This string will be inserted in the buffer when you create a widget.
-The following @samp{%} escapes are available:
+@defun widget-insert &rest args
+Insert @var{args}, either strings or characters, at point.
-@table @samp
-@item %[
-@itemx %]
-The text inside will be marked as a button.
+Uses @code{insert} to perform the insertion, passing @var{args} as
+argument. @xref{Insertion,,,elisp, the Emacs Lisp Reference Manual},
+for more information about @var{args}.
-By default, the text will be shown in @code{widget-button-face}, and
-surrounded by brackets.
+The resulting text will be read-only.
+@end defun
-@defopt widget-button-prefix
-String to prefix buttons.
-@end defopt
+@node Working with Widgets
+@chapter Working with Widgets
+This section covers the more important functions needed to query and
+manipulate widgets in a generic way. Widgets may have additional
+functions for interacting with them, those are described in the
+description for each widget. @xref{Widget Gallery}.
-@defopt widget-button-suffix
-String to suffix buttons.
-@end defopt
+@defun widgetp widget
+Non-@code{nil} if @var{widget} is a widget.
+@end defun
-@item %@{
-@itemx %@}
-The text inside will be displayed with the face specified by
-@code{:sample-face}.
+@defun widget-type widget
+Return the type of widget @var{widget}, a symbol.
-@item %v
-This will be replaced with the buffer representation of the widget's
-value. What this is depends on the widget type.
+This function is useful to find out which kind of widget @var{widget}
+represents, i.e., the name of the widget type when the widget
+was created.
+@end defun
-@strong{Warning:} In an @code{editable-field} widget, the @samp{%v} escape
-must be preceded by some other text in the format string (if specified).
+@defun widget-member widget property
+Non-@code{nil} if widget @var{widget} has a value (even @code{nil}) for
+property @var{property}.
+@end defun
-@item %d
-Insert the string specified by @code{:doc} here.
+@defun widget-get widget property
+For widget @var{widget}, return the value of the property @var{property}.
-@item %h
-Like @samp{%d}, with the following modifications: If the documentation
-string is more than one line, it will add a button which will toggle
-between showing only the first line, and showing the full text.
-Furthermore, if there is no @code{:doc} property in the widget, it will
-instead examine the @code{:documentation-property} property. If it is a
-lambda expression, it will be called with the widget's value as an
-argument, and the result will be used as the documentation text.
+@var{property} should be a keyword, and the value is what was last set by
+@code{widget-put} for @var{property}.
+@end defun
-@item %t
-Insert the string specified by @code{:tag} here, or the @code{princ}
-representation of the value if there is no tag.
+@defun widget-put widget property value
+For widget @var{widget}, set the property @var{property} to @var{value}.
+@var{property} should be a keyword, while @var{value} can be anything.
+@end defun
-@item %%
-Insert a literal @samp{%}.
-@end table
+@defun widget-at &optional pos
+Return the widget at position @var{pos}, or at point if @var{pos} is
@code{nil}.
+@end defun
-@vindex button-face@r{ keyword}
-@item :button-face
-Face used to highlight text inside %[ %] in the format.
+@defun widget-field-at pos
+Return the widget field at position POS, or @code{nil} if there is none.
+@end defun
-@vindex button-prefix@r{ keyword}
-@vindex button-suffix@r{ keyword}
-@item :button-prefix
-@itemx :button-suffix
-Text around %[ %] in the format.
+@defun widget-apply widget property &rest args
+Apply the function stored in @var{property} to @var{widget}, passing @var{args}
+as additional arguments to the function.
-These can be
-@table @emph
-@item nil
-No text is inserted.
+Returns the result of that function call.
+@end defun
-@item a string
-The string is inserted literally.
+@defun widget-value widget
+Return the current value contained in @var{widget}.
-@item a symbol
-The value of the symbol is expanded according to this table.
-@end table
+Note that the value returned by this function might differ from what's
+stored in the @code{:value} property of @var{widget}. This is because
+this function extracts the current value of @var{widget} from the
+buffer, taking editions into account.
-@vindex doc@r{ keyword}
-@item :doc
-The string inserted by the @samp{%d} escape in the format
-string.
+The value returned is in the external format, after getting it with
+the @code{:value-get} function.
-@vindex tag@r{ keyword}
-@item :tag
-The string inserted by the @samp{%t} escape in the format
-string.
+It is an error to call this function on an uninitialized widget.
+@end defun
-@vindex tag-glyph@r{ keyword}
-@item :tag-glyph
-Name of image to use instead of the string specified by @code{:tag} on
-Emacsen that supports it.
+@defun widget-value-set widget value
+Set the value contained in @var{widget} to @var{value}.
-@vindex help-echo@r{ keyword}
-@item :help-echo
-Specifies how to display a message whenever you move to the widget with
-either @code{widget-forward} or @code{widget-backward} or move the mouse
-over it (using the standard @code{help-echo} mechanism). The argument
-is either a string to display, a function of one argument, the widget,
-which should return a string to display, or a form that evaluates to
-such a string.
+Converts @var{value} to the internal format, and then sets it by
+applying the @code{:value-set} function.
-@vindex follow-link@r{ keyword}
-@item :follow-link
-Specifies how to interpret a @key{mouse-1} click on the widget.
-@xref{Clickable Text,, Defining Clickable Text, elisp, the Emacs Lisp
Reference Manual}.
+It is an error to call this function with an invalid @var{value}, that
+is, a value that @var{widget} cannot represent.
+@end defun
-@vindex indent@r{ keyword}
-@item :indent
-An integer indicating the absolute number of spaces to indent children
-of this widget.
+@defun widget-default-get widget
+Return the default external value of widget @var{widget}.
-@vindex offset@r{ keyword}
-@item :offset
-An integer indicating how many extra spaces to add to the widget's
-grandchildren compared to this widget.
+The default value is the one stored in @code{:value} or the result of
+applying the @code{:default-get} function to the arguments of
+@var{widget}, as stored in @code{:args}. A value of @code{nil} is
+ignored by default, so in order for a widget to respect @code{nil} as
+a value, it has to override the @code{:default-get} function.
+@end defun
-@vindex extra-offset@r{ keyword}
-@item :extra-offset
-An integer indicating how many extra spaces to add to the widget's
-children compared to this widget.
+@defun widget-type-default-get widget
+Convert the @code{:type} attribute in @var{widget} and return its
+default value.
+@end defun
-@vindex notify@r{ keyword}
-@item :notify
-A function called each time the widget or a nested widget is changed.
-The function is called with two or three arguments. The first argument
-is the widget itself, the second argument is the widget that was
-changed, and the third argument is the event leading to the change, if
-any.
+@defun widget-child-value-get widget
+Return the value of the first member of @code{:children} in
+@var{widget}.
+@end defun
-@vindex menu-tag@r{ keyword}
-@item :menu-tag
-Tag used in the menu when the widget is used as an option in a
-@code{menu-choice} widget.
+@defun widget-child-value-inline widget
+Return the inline value of the first member of @code{:children} in
+@var{widget}.
-@vindex menu-tag-get@r{ keyword}
-@item :menu-tag-get
-Function used for finding the tag when the widget is used as an option
-in a @code{menu-choice} widget. By default, the tag used will be either the
-@code{:menu-tag} or @code{:tag} property if present, or the @code{princ}
-representation of the @code{:value} property if not.
+The inline value is whatever the function stored in
+@code{:value-inline} returns.
+@end defun
-@vindex match@r{ keyword}
-@item :match
-Should be a function called with two arguments, the widget and an
-external value, and should return non-@code{nil} if the widget can
-represent the specified value.
+@defun widget-type-value-create widget
+Create a child widget for @var{widget}, of type stored in
+@code{:type}.
-@vindex validate@r{ keyword}
-@item :validate
-A function which takes a widget as an argument, and returns @code{nil}
-if the widget's current value is valid for the widget. Otherwise it
-should return the widget containing the invalid data, and set that
-widget's @code{:error} property to a string explaining the error.
+Creates the child widget taking the value from the @code{:value}
+property and stores the newly created widget in the @code{:children}
+property of @var{widget}.
+
+The value stored in @code{:type} should be an unconverted widget
+type.
+@end defun
-The following predefined function can be used:
+@defun widget-value-convert-widget widget
+Initializes the @code{:value} property of @var{widget} from
+@code{:args}.
-@defun widget-children-validate widget
-All the @code{:children} of @var{widget} must be valid.
+Sets @code{:args} to @code{nil} and returns the modified widget
+@var{widget}.
@end defun
-@vindex tab-order@r{ keyword}
-@item :tab-order
-Specify the order in which widgets are traversed with
-@code{widget-forward} or @code{widget-backward}. This is only partially
-implemented.
+@defun widget-value-value-get widget
+Return the value stored in @code{:value} for widget @var{widget}.
-@enumerate a
-@item
-Widgets with tabbing order @code{-1} are ignored.
+This is different to getting the current value for @var{widget} with
+@code{widget-value}, since that function extracts the value from the
+buffer.
+@end defun
-@item
-(Unimplemented) When on a widget with tabbing order @var{n}, go to the
-next widget in the buffer with tabbing order @var{n+1} or @code{nil},
-whichever comes first.
+@defun widget-apply-action widget &optional event
+Apply the function stored in @code{:action} to @var{widget}, in
+response to @var{event}.
-@item
-When on a widget with no tabbing order specified, go to the next widget
+It is an error to call this function with an inactive widget.
+@end defun
+
+@defun widget-parent-action widget &optional event
+Tell @code{:parent} of @var{widget} to handle @var{event}.
+
+Optional @var{event} is the event that triggered the action.
+@end defun
+
+@defun widget-child-validate widget
+Check that the first member of @code{:children} in @var{widget} is valid.
+
+To be valid means that the widget value passes the checks that the
+function stored in @code{:validate} makes.
+@end defun
+
+@defun widget-children-validate widget
+Check that all @code{:children} in @var{widget} are valid.
+
+Returns @code{nil} on success, or the first child that isn't valid.
+@end defun
+
+@defun widget-type-match widget value
+Return non-@code{nil} if @var{VALUE} matches the value for the
+@code{:type} widget.
+
+As with the other type functions, the widget stored in @code{:type}
+should be an unconverted widget.
+@end defun
+
+@defun widget-types-copy widget
+Copy the @code{:args} value in @var{widget} and store them in @code{:args}.
+
+Makes the copies by calling @code{widget-copy} on each element present
+in @code{:args}. Returns the modified widget @var{widget}.
+@end defun
+
+@defun widget-types-convert-widget widget
+Convert the @code{:args} value in @var{widget} and store them in
+@code{args}.
+
+Returns the modified widget @var{widget}.
+@end defun
+
+@node Widgets and the Buffer
+@chapter Widgets and the Buffer
+This chapter describes commands that are specific to buffers that
+contain widgets.
+
+@cindex widget keybindings
+@defvr Const widget-keymap
+Keymap containing useful bindings for buffers containing widgets.
+
+Binds @key{TAB} and @kbd{C-@key{TAB}} to @code{widget-forward} and
+@code{widget-backward}, respectively. It also binds @key{RET} to
+@code{widget-button-press} and @kbd{down-mouse-1} and
+@kbd{down-mouse-2} to @code{widget-button-click}.
+@end defvr
+
+There's also a keymap for events that the Widget library doesn't need
+to handle.
+
+@defvar widget-global-map
+Keymap used by @code{widget-button-press} and @code{widget-button-click}
+when not on a button. By default this is @code{global-map}.
+@end defvar
+
+In addition to these two keymaps, each widget might define a keymap of
+its own, active when events happen at that widget.
+
+@cindex widget navigation
+The following navigation commands are available:
+
+@table @kbd
+@item @key{TAB}
+@deffn Command widget-forward &optional count
+Move point @var{count} buttons or editing fields forward.
+@end deffn
+@item @kbd{M-@key{TAB}}
+@itemx @kbd{S-@key{TAB}}
+@deffn Command widget-backward &optional count
+Move point @var{count} buttons or editing fields backward.
+@end deffn
+@end table
+
+
+When editing an @code{editable-field} widget, the following commands
+are available:
+
+@table @kbd
+@item @key{C-e}
+@deffn Command widget-end-of-line
+Move point to the end of field or end of line, whichever is first.
+@end deffn
+
+@item @kbd{C-k}
+@deffn Command widget-kill-line
+Kill to end of field or end of line, whichever is first.
+@end deffn
+
+@item @kbd{M-TAB}
+@deffn Command widget-complete
+Complete the content of the editable field at point.
+@end deffn
+
+@item @kbd{C-m}
+@deffn Command widget-field-activate
+Invoke the editable field at point.
+@end deffn
+@end table
+
+The following two are commands that can execute widget actions.
+@table @kbd
+@item @key{RET}
+@findex widget-button-press
+@deffn Command widget-button-press @var{pos} &optional @var{event}
+Invoke the button at @var{pos}, defaulting to point.
+
+Invocation means to run the function stored in the @code{:action}
+property.
+
+If point is not located on a button, invoke the binding in
+@code{widget-global-map} (by default the global map).
+@end deffn
+
+@kindex mouse-2 @r{(on button widgets})
+@item mouse-2
+@findex widget-button-click
+@deffn Command widget-button-click @var{event}
+Invoke the button at the location of the mouse pointer.
+
+If the mouse pointer is located in an editable text field, invoke the
+binding in @code{widget-global-map} (by default the global map).
+
+In case the mouse-click is on a widget, calls the function stored in
+the @code{:mouse-down-action} property.
+@end deffn
+@end table
+
+@node Widget Gallery
+@chapter Widget Gallery
+@cindex widget syntax
+All widgets can be created from a type specification. The general
+syntax of a type specification is:
+
+@c FIXME: Add BNF reference here? If yes, what reference?
+@example
+@var{name} ::= (@var{name} [@var{keyword} @var{argument}]... @var{args})
+ | @var{name}
+@end example
+
+Where @var{name} is a widget name, as defined with
+@code{define-widget}, @var{keyword} is the name of a property and
+@var{argument} is the value for that property, and @var{args} are
+interpreted in a widget specific way. @xref{Defining New Widgets}.
+
+@menu
+* Basic Types::
+* Sexp Types::
+@end menu
+
+@node Basic Types
+@section Basic Types
+
+@menu
+* default::
+* item::
+* link::
+* url-link::
+* info-link::
+* function-link::
+* variable-link::
+* face-link::
+* file-link::
+* emacs-library-link::
+* emacs-commentary-link::
+* push-button::
+* editable-field::
+* text::
+* menu-choice::
+* radio-button-choice::
+* choice-item::
+* toggle::
+* radio-button-toggle::
+* checkbox::
+* checklist::
+* editable-list::
+* group::
+* documentation-string::
+@end menu
+
+@node default
+@subsection The @code{default} Widget
+@findex default@r{ widget}
+The most basic widget in the Widget Library is the @dfn{default}
+widget. It provides the basic behavior for all other widgets, and all
+its properties are present by default in derived widgets. You're
+seldom (if ever) going to effectively create a default widget, but
+here we describe its properties and behavior, so that we can describe
+other widgets only by mentioning the properties and behavior those
+other widgets specialize.
+
+@deffn Widget default
+Widget used as a base for other widgets.
+
+It provides most of the functionality that is referred to as ``by
+default'' in this text. If you want to define a new widget from
+scratch, use the @code{default} widget as its base.
+@end deffn
+
+@cindex keyword arguments
+The following keyword arguments apply to all widgets:
+
+@table @code
+@vindex create@r{ keyword}
+@item :create
+Function to create a widget from scratch.
+
+The function takes one argument, a widget type, and creates a widget
+of that type, inserts it in the buffer, and returns a widget object.
+
+By default, it inserts the widget at point, using the format provided
+in the @code{:format} property.
+
+@vindex delete@r{ keyword}
+@item :delete
+Function to delete a widget.
+
+The function should take one argument, a widget, and should remove all
+traces of the widget from the buffer.
+
+The default value is:
+
+@defun widget-default-delete widget
+Remove @var{widget} from the buffer.
+Delete all @code{:children} and @code{:buttons} in @var{widget}.
+@end defun
+
+In most cases you should not change this value, but instead use
+@code{:value-delete} to make any additional cleanup.
+
+@cindex internal format
+@cindex external format
+@vindex value@r{ keyword}
+@item :value
+The initial value for widgets of this type.
+
+Typically, a widget represents its value in two formats: external and
+internal. The external format is the value as the rest of Emacs sees
+it, and the internal format is a representation that the widget
+defines and uses in a widget specific way.
+
+Both formats might be the same for certain widgets and might differ
+for others, and there is no guarantee about which format the value
+stored in the @code{:value} property has. However, when creating a
+widget or defining a new one (@pxref{Defining New Widgets}), the
+@code{:value} should be in the external format.
+
+@vindex value-to-internal@r{ keyword}
+@item :value-to-internal
+Function to convert the value to the internal format.
+
+The function takes two arguments, a widget and an external value, and
+returns the internal value. The function is called on the present
+@code{:value} when the widget is created, and on any value set later
+with @code{widget-value-set}.
+
+@vindex value-to-external@r{ keyword}
+@item :value-to-external
+Function to convert the value to the external format.
+
+The function takes two arguments, a widget and an internal value, and
+returns the value in the external format.
+
+@vindex value-create@r{ keyword}
+@item :value-create
+Function to expand the @samp{%v} escape in the format string.
+
+It will be called with the widget as its argument and should insert a
+representation of the widget's value in the buffer.
+
+@vindex value-delete@r{ keyword}
+@item :value-delete
+A function that should remove the representation of the widget's value
+from the buffer.
+
+It will be called with the widget as its argument. It doesn't have to
+remove the text, but it should release markers and delete nested widgets
+if these are not listed in @code{:children} or @code{:buttons}.
+
+By default, it's a no-op.
+
+@vindex value-get@r{ keyword}
+@item :value-get
+Function to extract the value of a widget, as it is displayed in the
+buffer.
+
+@vindex value-set@r{ keyword}
+@item :value-set
+Function that takes a widget and a value as arguments, and recreates
+it.
+
+The value must already be in the internal format for widget. By
+default, it deletes the widget with the @code{:delete} function and
+creates it again with the @code{:create} function.
+
+@vindex value-inline@r{ keyword}
+@item :value-inline
+Function that takes a widget and returns its value, inlined.
+
+Inlined means that if the widget is not inline (i.e., its
+@code{:inline} property is @code{nil}), the return value is wrapped in
+a list.
+
+@vindex default-get@r{ keyword}
+@item :default-get
+Function that takes a widget and returns its default value.
+
+By default, it just returns the value stored in @code{:value}.
+
+@vindex format@r{ keyword}
+@item :format
+This string will be inserted in the buffer when you create a widget.
+The following @samp{%} escapes are available:
+
+@table @samp
+@item %[
+@itemx %]
+The text inside will be marked as a button.
+
+By default, the text will be shown in @code{widget-button-face}, and
+surrounded by brackets.
+
+@item %@{
+@itemx %@}
+The text inside will be displayed with the face specified by
+@code{:sample-face}.
+
+@item %v
+This will be replaced with the buffer representation of the widget's
+value. What this is depends on the widget type.
+
+@item %d
+Insert the string specified by @code{:doc} here.
+
+@item %h
+Like @samp{%d}, with the following modifications: If the documentation
+string is more than one line, it will add a button which will toggle
+between showing only the first line, and showing the full text.
+Furthermore, if there is no @code{:doc} property in the widget, it will
+instead examine the @code{:documentation-property} property. If it is a
+lambda expression, it will be called with the widget's value as an
+argument, and the result will be used as the documentation text.
+
+@item %t
+Insert the string specified by @code{:tag} here, or the @code{princ}
+representation of the value if there is no tag.
+
+@item %%
+Insert a literal @samp{%}.
+@end table
+
+@vindex button-face@r{ keyword}
+@item :button-face
+Face used to highlight text inside %[ %] in the format.
+
+@vindex button-prefix@r{ keyword}
+@vindex button-suffix@r{ keyword}
+@item :button-prefix
+@itemx :button-suffix
+Strings used as prefix and suffix for widgets that are buttons.
+
+By default, the values are @code{widget-button-prefix} and
+@code{widget-button-suffix}.
+
+Text around %[ %] in the format.
+
+These can be
+@table @emph
+@item nil
+No text is inserted.
+
+@item a string
+The string is inserted literally.
+
+@item a symbol
+The value of the symbol is expanded according to this table.
+@end table
+
+@vindex doc@r{ keyword}
+@item :doc
+The string inserted by the @samp{%d} escape in the format
+string.
+
+@vindex tag@r{ keyword}
+@item :tag
+The string inserted by the @samp{%t} escape in the format
+string.
+
+@vindex tag-glyph@r{ keyword}
+@item :tag-glyph
+Name of image to use instead of the string specified by @code{:tag} on
+Emacsen that supports it.
+
+@vindex help-echo@r{ keyword}
+@item :help-echo
+Specifies how to display a message whenever you move to the widget with
+either @code{widget-forward} or @code{widget-backward} or move the mouse
+over it (using the standard @code{help-echo} mechanism).
+
+The value is either a string to display, or a function of one
+argument, the widget. If a function, it should return a string to
+display, or a form that evaluates to such a string.
+
+@vindex follow-link@r{ keyword}
+@item :follow-link
+Specifies how to interpret a @key{mouse-1} click on the widget.
+@xref{Clickable Text,, Defining Clickable Text, elisp, the Emacs Lisp
Reference Manual}.
+
+@vindex indent@r{ keyword}
+@item :indent
+An integer indicating the absolute number of spaces to indent children
+of this widget. Its value might be @code{nil} too, which corresponds
+to a value of 0.
+
+The default @code{:create} functions and the functions that create the
+value per se use this property as a rudimentary layout mechanism for
+the widgets.
+
+@vindex offset@r{ keyword}
+@item :offset
+An integer indicating how many extra spaces to add to the widget's
+grandchildren compared to this widget.
+
+@vindex extra-offset@r{ keyword}
+@item :extra-offset
+An integer indicating how many extra spaces to add to the widget's
+children compared to this widget.
+
+@vindex menu-tag@r{ keyword}
+@item :menu-tag
+Tag used in the menu when the widget is used as an option in a
+@code{menu-choice} widget.
+
+@vindex menu-tag-get@r{ keyword}
+@item :menu-tag-get
+Function that takes a widget and returns the tag when the widget is
+used as an option in a @code{menu-choice} widget.
+
+By default, the tag used will be either the @code{:menu-tag} or
+@code{:tag} property if present, or the @code{princ} representation of
+the @code{:value} property if not.
+
+@vindex match@r{ keyword}
+@item :match
+Should be a function called with two arguments, the widget and an
+external value, and should return non-@code{nil} if the widget can
+represent the specified value.
+
+@vindex validate@r{ keyword}
+@item :validate
+A function which takes a widget as an argument, and returns @code{nil}
+if the widget's current value is valid for the widget.
+
+Otherwise, it should return the widget containing the invalid data,
+and set that widget's @code{:error} property to a string explaining
+the error.
+
+By default, it always returns @code{nil}.
+
+@vindex tab-order@r{ keyword}
+@item :tab-order
+Specify the order in which widgets are traversed with
+@code{widget-forward} or @code{widget-backward}. This is only partially
+implemented.
+@enumerate a
+@item
+Widgets with tabbing order @code{-1} are ignored.
+
+@item
+(Unimplemented) When on a widget with tabbing order @var{n}, go to the
+next widget in the buffer with tabbing order @var{n+1} or @code{nil},
+whichever comes first.
+
+@item
+When on a widget with no tabbing order specified, go to the next widget
in the buffer with a positive tabbing order, or @code{nil}
@end enumerate
-@vindex parent@r{ keyword}
-@item :parent
-The parent of a nested widget (e.g., a @code{menu-choice} item or an
-element of a @code{editable-list} widget).
+@vindex parent@r{ keyword}
+@item :parent
+The parent of a nested widget (e.g., a @code{menu-choice} item or an
+element of a @code{editable-list} widget).
+
+@vindex sibling-args@r{ keyword}
+@item :sibling-args
+This keyword is only used for members of a @code{radio-button-choice} or
+@code{checklist}. The value should be a list of extra keyword
+arguments, which will be used when creating the @code{radio-button} or
+@code{checkbox} associated with this item.
+
+@vindex completions-function@r{ keyword}
+@item :completions-function
+Function that takes a widget and returns completion data for that
+widget, like @code{completion-at-point-functions} would.
+@xref{Completion,,,elisp, the Emacs Lisp Reference Manual}. It's
+used by @code{editable-field} widgets to provide completions.
+
+By default, it looks into the property @code{:completions}, which
+should be a completion table. If @code{:completions} is @code{nil},
+then it calls the function stored either in the @code{:complete} or
+@code{:complete-function} property.
+
+@vindex format-handler@r{ keyword}
+@item :format-handler
+Function to handle unknown @samp{%} escapes in the format string.
+
+It takes a widget and the character that follows the @samp{%} as
+arguments. You can set this to allow your widget to handle
+non-standard escapes in your own specialized widgets.
+
+@findex widget-default-format-handler
+You should end up calling @code{widget-default-format-handler} to handle
+unknown escape sequences, which will handle the @samp{%h} and any future
+escape sequences, as well as give an error for unknown escapes.
+
+@vindex button-face-get@r{ keyword}
+@item :button-face-get
+Function to return the face used to fontify a widget button.
+
+Takes a widget and returns an appropriate face for the widget. By
+default, it either returns the face stored in the @code{:button-face}
+property, or calls the @code{:button-face-get} function from the
+parent of the widget, if it has one.
+
+@vindex mouse-face-get@r{ keyword}
+@item :mouse-face-get
+Function to return the face used to fontify a widget when the mouse
+pointer hovers over it.
+
+Takes a widget and returns an appropriate face. By default, it either
+returns the face stored in the @code{:mouse-face} property, or calls
+the @code{:button-face-get} function from the parent of the widget, if
+it has one.
+
+@vindex copy@r{ keyword}
+@item :copy
+Function to deep copy a widget type.
+
+It takes a shallow copy of the widget type as an argument (made by
+@code{copy-sequence}), and returns a deep copy. The purpose of this
+is to avoid having different instances of combined widgets share
+nested attributes.
+
+Its value by default is @code{identity}.
+
+@vindex active@r{ keyword}
+@item :active
+Function that takes a widget and returns @code{t} if it is active.
+
+A widget might be effectively always active, if its
+@code{:always-active} property is @code{t}.
+
+@cindex active widget
+@cindex inactive widget
+@cindex activate a widget
+@cindex deactivate a widget
+Widgets can be in two states: active, which means they are modifiable by
+the user, or inactive, which means they cannot be modified by the user.
+You can query or set the state with the following code:
+
+@lisp
+;; Examine if @var{widget} is active or not.
+(if (widget-apply @var{widget} :active)
+ (message "Widget is active.")
+ (message "Widget is inactive.")
+
+;; Make @var{widget} inactive.
+(widget-apply @var{widget} :deactivate)
+
+;; Make @var{widget} active.
+(widget-apply @var{widget} :activate)
+@end lisp
+
+A widget is inactive if it, or any of its ancestors (found by
+following the @code{:parent} link), have been deactivated. To make sure
+a widget is really active, you must therefore activate both it and
+all its ancestors.
+
+@lisp
+(while widget
+ (widget-apply widget :activate)
+ (setq widget (widget-get widget :parent)))
+@end lisp
+
+You can check if a widget has been made inactive by examining the value
+of the @code{:inactive} keyword. If this is non-@code{nil}, the widget itself
+has been deactivated. This is different from using the @code{:active}
+keyword, in that the latter tells you if the widget @strong{or} any of
+its ancestors have been deactivated. Do not attempt to set the
+@code{:inactive} keyword directly. Use the @code{:activate}
+@code{:deactivate} functions instead.
+
+@vindex activate@r{ keyword}
+@item :activate
+Function that takes a widget and makes it active for user
+modifications.
+
+@vindex deactivate@r{ keyword}
+@item :deactivate
+Function that takes a widget and makes it inactive for user
+modifications.
+
+@vindex action@r{ keyword}
+@item :action
+Function that takes a widget and optionally an event, and handles a
+user initiated event.
+
+By default, uses the @code{:notify} function to notify the widget's
+parent about the event.
+
+@vindex mouse-down-action@r{ keyword}
+@item :mouse-down-action
+Function that takes a widget and optionally an event, and handles a
+mouse click on the widget.
+
+By default, it does nothing.
+
+@vindex notify@r{ keyword}
+@item :notify
+A function called each time the widget or a nested widget is changed.
+
+The function is called with two or three arguments. The first argument
+is the widget itself, the second argument is the widget that was
+changed, and the third argument is the event leading to the change, if
+any.
+
+By default, it passes the notification to the widget's parent.
+
+@vindex prompt-value@r{ keyword}
+@item :prompt-value
+Function to prompt for a value in the minibuffer.
+
+The function should take four arguments, a widget, a prompt (a
+string), a value and a boolean, and should return a value for the
+widget, entered by the user.
+
+The prompt is the prompt to use. The value is the default value to
+use, unless the fourtha argument is non-@code{nil}, in which case
+there is no default value.
+
+The function should read the value using the method most natural for
+this widget, and does not have to check that it matches.
+@end table
+
+@node item
+@subsection The @code{item} Widget
+@findex item@r{ widget}
+
+Syntax:
+
+@example
+@var{type} ::= (item [@var{keyword} @var{argument}]... @var{value})
+@end example
-@vindex sibling-args@r{ keyword}
-@item :sibling-args
-This keyword is only used for members of a @code{radio-button-choice} or
-@code{checklist}. The value should be a list of extra keyword
-arguments, which will be used when creating the @code{radio-button} or
-@code{checkbox} associated with this item.
+A useful widget that holds a constant value, and can be included in
+other widgets. Its super is the @code{default} widget.
-@end table
+As can be seen in the syntax, the @code{item} widget is one of the
+widget that handles the @var{args} argument to @code{widget-create} in
+a specific way. If present, @var{value} is used to initialize the
+@code{:value} property. When created, it inserts the value as a
+string in the buffer.
-@deffn {User Option} widget-image-directory
-Directory where Widget should look for images.
-Widget will look here for a file with the same name as specified for the
-image, with either a @file{.xpm} (if supported) or @file{.xbm} extension.
-@end deffn
+By default, it has the following properties:
-@deffn{User Option} widget-image-enable
-If non-@code{nil}, allow images to appear on displays where they are supported.
-@end deffn
+@table @code
+@item :convert-widget
+The function that allows it to handle @var{value}.
+@item :value-create
+Prints the representation of @code{:value} in the buffer.
-@menu
-* link::
-* url-link::
-* info-link::
-* push-button::
-* editable-field::
-* text::
-* menu-choice::
-* radio-button-choice::
-* item::
-* choice-item::
-* toggle::
-* checkbox::
-* checklist::
-* editable-list::
-* group::
-@end menu
+@item :value-get
+Returns the value stored in @code{:value}.
+
+@item :match
+A value matches the @code{item} widget if it's @code{equal} to its
+@code{:value}.
+
+@item :match-inline
+Inline values match the @code{item} widget if @code{:value} is a
+sublist of values.
+
+@item :action
+The @code{item} widget notifies itself of an event.
+
+@item :format
+By default, the @code{item} widget inserts its tag in the buffer.
+@end table
@node link
-@section The @code{link} Widget
+@subsection The @code{link} Widget
@findex link@r{ widget}
Syntax:
@@ -731,22 +1421,42 @@ Syntax:
@var{type} ::= (link [@var{keyword} @var{argument}]... [ @var{value} ])
@end example
+A widget to represent an embedded link. Its super is the @code{item}
+widget.
+
The @var{value}, if present, is used to initialize the @code{:value}
property. The value should be a string, which will be inserted in the
buffer.
-By default the link will be shown in brackets.
+By default, it has the following properties:
-@defopt widget-link-prefix
-String to prefix links.
-@end defopt
+@table @code
+@item :button-prefix
+The value of @code{widget-link-prefix}.
-@defopt widget-link-suffix
-String to suffix links.
-@end defopt
+@item :button-suffix
+The value of @code{widget-link-suffix}.
+
+@item :keymap
+A custom keymap for the link widget, so that it can respond to mouse clicks.
+
+@item :follow-link
+This property allows the link to respect the value of
+@code{mouse-1-click-follows-link}. @xref{Clickable Text,,,elisp, the Emacs
Lisp Reference Manual}.
+
+@item :format
+Buttonizes the link, to make it clickable.
+
+If you override this property, you should make sure to provide the
+@samp{%[} and @samp{%]} escape sequences, so that the link is
+clickable.
+
+@end table
+
+By default the link will be shown in brackets.
@node url-link
-@section The @code{url-link} Widget
+@subsection The @code{url-link} Widget
@findex url-link@r{ widget}
Syntax:
@@ -755,12 +1465,14 @@ Syntax:
@var{type} ::= (url-link [@var{keyword} @var{argument}]... @var{url})
@end example
-@findex browse-url-browser-function@r{, and @code{url-link} widget}
-When this link is invoked, the @acronym{WWW} browser specified by
-@code{browse-url-browser-function} will be called with @var{url}.
+A widget to represent a link to a web page. Its super is the
+@code{link} widget.
+
+It overrides the @code{:action} property to open up the @var{url}
+specified.
@node info-link
-@section The @code{info-link} Widget
+@subsection The @code{info-link} Widget
@findex info-link@r{ widget}
Syntax:
@@ -769,11 +1481,104 @@ Syntax:
@var{type} ::= (info-link [@var{keyword} @var{argument}]... @var{address})
@end example
-When this link is invoked, the built-in Info reader is started on
-@var{address}.
+A widget to represent a link to an info file. Its super is the
+@code{link} widget.
+
+It overrides the @code{:action} property, to a function to start the
+built-in Info reader on @var{address}, when invoked.
+
+@node function-link
+@subsection The @code{function-link} Widget
+@findex function-link@r{ widget}
+Syntax:
+
+@example
+@var{type} ::= (function-link [@var{keyword} @var{argument}]...
@var{function})
+@end example
+
+A widget to represent a link to an Emacs function. Its super is the
+@code{link} widget.
+
+It overrides the @code{:action} property, to a function to describe
+@var{function}.
+
+@node variable-link
+@subsection The @code{variable-link} Widget
+@findex variable-link@r{ widget}
+Syntax:
+
+@example
+@var{type} ::= (variable-link [@var{keyword} @var{argument}]... @var{var})
+@end example
+
+A widget to represent a link to an Emacs variable. Its super is the
+@code{link} widget.
+
+It overrides the @code{:action} property, to a function to describe
+@var{var}.
+
+@node face-link
+@subsection The @code{face-link} Widget
+@findex face-link@r{ widget}
+Syntax:
+
+@example
+@var{type} ::= (face-link [@var{keyword} @var{argument}]... @var{face})
+@end example
+
+A widget to represent a link to an Emacs face. Its super is the
+@code{link} widget.
+
+It overrides the @code{:action} property, to a function to describe
+@var{face}.
+
+@node file-link
+@subsection The @code{file-link} Widget
+@findex file-link@r{ widget}
+Syntax:
+
+@example
+@var{type} ::= (file-link [@var{keyword} @var{argument}]... @var{file})
+@end example
+
+A widget to represent a link to a file. Its super is the
+@code{link} widget.
+
+It overrides the @code{:action} property, to a function to find the file
+@var{file}.
+
+@node emacs-library-link
+@subsection The @code{emacs-library-link} Widget
+@findex emacs-library-link@r{ widget}
+Syntax:
+
+@example
+@var{type} ::= (emacs-library-link [@var{keyword} @var{argument}]...
@var{file})
+@end example
+
+A widget to represent a link to an Emacs Lisp file. Its super is the
+@code{link} widget.
+
+It overrides the @code{:action} property, to a function to find the file
+@var{file}.
+
+@node emacs-commentary-link
+@subsection The @code{emacs-commentary-link} Widget
+@findex emacs-commentary-link@r{ widget}
+Syntax:
+
+@example
+@var{type} ::= (emacs-commentary-link [@var{keyword} @var{argument}]...
@var{file})
+@end example
+
+A widget to represent a link to the Comment section of an Emacs Lisp
+file. Its super is the @code{link} widget.
+
+It overrides the @code{:action} property, to a function to find the file
+@var{file} and put point in the Comment section.
@node push-button
-@section The @code{push-button} Widget
+@subsection The @code{push-button} Widget
@findex push-button@r{ widget}
Syntax:
@@ -782,22 +1587,37 @@ Syntax:
@var{type} ::= (push-button [@var{keyword} @var{argument}]... [ @var{value} ])
@end example
+A widget that acts as a pushable button. Its super is the @code{item}
+widget.
+
The @var{value}, if present, is used to initialize the @code{:value}
property. The value should be a string, which will be inserted in the
buffer.
-By default the tag will be shown in brackets.
+By default, it has the following properties:
+@table @code
+@item :button-prefix
+The empty string.
-@defopt widget-push-button-prefix
-String to prefix push buttons.
-@end defopt
+@item :button-suffix
+The empty string.
-@defopt widget-push-button-suffix
-String to suffix push buttons.
-@end defopt
+@item :value-create
+Inserts a representation of the ``on'' and ``off'' states for the push
+button.
+
+The representation might be an image, stored in the @code{:tag-glyph}
+property, or text. If it is text, it might be the value of the
+@code{:tag} property, or the @code{:value} of the widget, surrounded
+with @code{widget-push-button-prefix} and
+@code{widget-push-button-suffix}. @xref{Customization}.
+
+@item :format
+Buttonizes the widget, to make it clickable.
+@end table
@node editable-field
-@section The @code{editable-field} Widget
+@subsection The @code{editable-field} Widget
@findex editable-field@r{ widget}
Syntax:
@@ -806,56 +1626,137 @@ Syntax:
@var{type} ::= (editable-field [@var{keyword} @var{argument}]... [ @var{value}
])
@end example
+A widget that can be edited by the user. Its super is the
+@code{default} widget.
+
The @var{value}, if present, is used to initialize the @code{:value}
property. The value should be a string, which will be inserted in the
-field. This widget will match all string values.
+field. If not present, @code{:value} is the empty string.
+
+@strong{Warning:} In an @code{editable-field} widget, the editable
+field must not be adjacent to another widget---that won't work.
+You must put some text in between. Either make this text part of
+the @code{editable-field} widget itself, or insert it with
+@code{widget-insert}.
-The following extra properties are recognized:
+This widget either overrides or adds the following properties:
@table @code
+@item :convert-widget
+Just like the @code{item} widget, this function allows it to
+initialize @code{:value} from @var{value}.
+
+@vindex keymap@r{ keyword}
+@vindex widget-field-keymap
+@item :keymap
+Keymap used in the editable field.
+
+The default value is @code{widget-field-keymap}, which allows the user
+to use all the normal editing commands, even if the buffer's major
+mode suppresses some of them. Pressing @key{RET} invokes the function
+specified by @code{:action}.
+
+@item :format
+By default, it specifies to insert only the widget's value.
+
+@strong{Warning:} In an @code{editable-field} widget, the @samp{%v} escape
+must be preceded by some other text in the @code{:format} string (if
+specified).
+
@vindex size@r{ keyword}
@item :size
-The width of the editable field.@*
+The width of the editable field.
+
By default the field will reach to the end of the line.
@vindex value-face@r{ keyword}
@item :value-face
-Face used for highlighting the editable field. Default is
-@code{widget-field-face}, see @ref{User Interface}.
+Face used for highlighting the editable field.
+
+Default is @code{widget-field-face}, @pxref{User Interface}.
@vindex secret@r{ keyword}
@item :secret
-Character used to display the value. You can set this to, e.g., @code{?*}
-if the field contains a password or other secret information. By
-default, this is @code{nil}, and the value is not secret.
+Character used to display the value.
+
+You can set this to, e.g., @code{?*} if the field contains a password
+or other secret information. By default, this is @code{nil}, and the
+value is not secret.
@vindex valid-regexp@r{ keyword}
@item :valid-regexp
By default the @code{:validate} function will match the content of the
-field with the value of this attribute. The default value is @code{""}
-which matches everything.
+field with the value of this attribute.
-@vindex keymap@r{ keyword}
-@vindex widget-field-keymap
-@item :keymap
-Keymap used in the editable field. The default value is
-@code{widget-field-keymap}, which allows you to use all the normal
-editing commands, even if the buffer's major mode suppresses some of
-them. Pressing @key{RET} invokes the function specified by
-@code{:action}.
+The default value is @code{""} which matches everything.
+
+@item :validate
+Returns @code{nil} if the current value of the widget matches the
+@code{:valid-regexp} value.
+
+@item :prompt-internal
+A function to read a value for widget, used by the
+@code{:prompt-value} function.
+
+@item :prompt-history
+A variable that holds the history of field minibuffer edits.
+
+@item :prompt-value
+A function that uses the @code{:prompt-internal} function and the
+@code{:prompt-history} value to prompt for a string, and retun the
+user response in the external format.
+
+@item :action
+When invoked, moves point to the next field.
+
+@item :value-create
+Function that takes care of creating the widget, respecting its
+@code{:size} and @code{:value}.
+
+@item :value-set
+Function to use to modify programatically the current value of the
+widget.
+
+@item :value-delete
+Function that removes the widget so it cannot be edited anymore.
+
+@item :value-get
+Function to return the current text in the widget.
+
+It takes an optional argument, @var{no-truncate}. If
+@var{no-truncate} is nil, truncates trailing spaces.
+
+@item :match
+Function that makes the widget match any string value.
@end table
@node text
-@section The @code{text} Widget
+@subsection The @code{text} Widget
@findex text@r{ widget}
+Syntax:
+
+@example
+@var{type} ::= (text [@var{keyword} @var{argument}]... [ @var{value} ])
+@end example
+
+A widget just like the @code{editable-field} widget, but intended for
+multiline text fields. Its super is the @code{editable-field} widget.
+
+It overrides the following properties:
+
+@table @code
+@item :format
+By default, prints a tag and the value.
+
@vindex widget-text-keymap
-This is just like @code{editable-field}, but intended for multiline text
-fields. The default @code{:keymap} is @code{widget-text-keymap}, which
-does not rebind the @key{RET} key.
+@item :keymap
+The default is @code{widget-text-keymap}, which does not rebind the
+@key{RET} key.
+@end table
@node menu-choice
-@section The @code{menu-choice} Widget
+@subsection The @code{menu-choice} Widget
@findex menu-choice@r{ widget}
Syntax:
@@ -864,21 +1765,37 @@ Syntax:
@var{type} ::= (menu-choice [@var{keyword} @var{argument}]... @var{type} ... )
@end example
+A widget to represent a menu of options. Its super is the
+@code{default} widget.
+
The @var{type} argument represents each possible choice. The widget's
-value will be that of the chosen @var{type} argument. This widget will
-match any value matching at least one of the specified @var{type}
-arguments.
+value will be that of the chosen @var{type} argument.
+
+It either overrides or adds the following properties:
@table @code
+@item :convert-widget
+A function that takes care of converting each possible choice.
+
+@item :copy
+A function to copy each possible choice.
+
+@item :format
+By default, buttonize the tag and show the value.
+
@vindex void@r{ keyword}
@item :void
Widget type used as a fallback when the value does not match any of the
specified @var{type} arguments.
+By default this is an @code{item} widget.
+
@vindex case-fold@r{ keyword}
@item :case-fold
-Set this to @code{nil} if you don't want to ignore case when prompting for a
-choice through the minibuffer.
+If @code{nil} don't ignore case when prompting for a choice through
+the minibuffer.
+
+By default, its value is @code{t}.
@vindex children@r{ keyword}
@item :children
@@ -892,10 +1809,54 @@ The current chosen type.
@vindex args@r{ keyword}
@item :args
The list of types.
+
+@item :value-create
+The function that inserts the current value for the widget.
+
+It inserts the first choice that matches, as with the @code{:match}
+function, the value of the widget.
+
+@item :value-get
+Returns the value of the first child for the widget (see the
+description for @code{:children} above).
+
+@item :value-inline
+Returns the inline value of the first child for the widget.
+
+@item :default-get
+The default value for this widget is the default value for the first
+choice, in case @code{:value} is missing.
+
+This means that if you want a specific default value for the
+@code{menu-choice} widget, you should either pass a @code{:value}
+property when creating it, or arrange the choices so that the first
+one can hold your desired default value.
+
+@item :mouse-down-action
+A function that takes care of showing a menu, if possible and desired.
+
+@item :action
+A function that takes care of getting a new choice for the widget.
+
+Depending on the number of choices available, it may show a menu or
+just toggle the choices, or even do nothing at all.
+
+After getting the choice, it recreates the widget and notifies it.
+
+@item :validate
+Returns @code{nil} if the widget's value is a valid choice.
+
+@item :match
+This widget will match any value matching at least one of the
+specified @var{type} arguments.
+
+@item :match-inline
+A function that returns non-@code{nil} if the values match the widget,
+taking into account the @code{:inline} property.
@end table
@node radio-button-choice
-@section The @code{radio-button-choice} Widget
+@subsection The @code{radio-button-choice} Widget
@findex radio-button-choice@r{ widget}
Syntax:
@@ -904,14 +1865,28 @@ Syntax:
@var{type} ::= (radio-button-choice [@var{keyword} @var{argument}]...
@var{type} ... )
@end example
-The component types specify the choices, with one radio button for
+A widget to represent a choice from multiple options. Its super is
+the @code{default} widget.
+
+The component @var{types} specify the choices, with one radio button for
each. The widget's value will be that of the chosen @var{type}
-argument. This widget matches any value that matches at least one of
-the specified @var{type} arguments.
+argument.
-The following extra properties are recognized.
+It overrides the following properties:
@table @code
+@item :convert-widget
+As other composite widgets, a function that takes care of converting
+each available choice.
+
+@item :copy
+A function to copy each available choice.
+
+@item :action
+A function that checks if any radio button was pressed and activates
+the pressed one, possibly deactivating an old one. Then, it notifies
+itself.
+
@vindex entry-format@r{ keyword}
@item :entry-format
This string will be inserted for each entry in the list.
@@ -925,6 +1900,9 @@ Replace with the radio button.
Insert a literal @samp{%}.
@end table
+@item :format
+By default, it inserts its value.
+
@vindex button-args@r{ keyword}
@item :button-args
A list of keywords to pass to the radio buttons. Useful for setting,
@@ -940,42 +1918,55 @@ The widgets representing each type.
@vindex choice@r{ keyword}
@item :choice
-The current chosen type
+The current chosen type.
@vindex args@r{ keyword}
@item :args
The list of types.
-@end table
-You can add extra radio button items to a @code{radio-button-choice}
-widget after it has been created with the function
-@code{widget-radio-add-item}.
+@item :value-create
+A function to insert all available choices.
-@defun widget-radio-add-item widget type
-Add to @code{radio-button-choice} widget @var{widget} a new radio button
-item of type @var{type}.
-@end defun
+@item :value-get
+Returns the value for the chosen widget.
-Please note that such items added after the @code{radio-button-choice}
-widget has been created will @strong{not} be properly destructed when
-you call @code{widget-delete}.
+@item :value-set
+A function to set the value to one of its available options.
-@node item
-@section The @code{item} Widget
-@findex item@r{ widget}
+@item :value-inline
+A function that returns the inline value of the child widget.
-Syntax:
+@item :offset
+By default, this widget has an offset of 4.
-@example
-@var{item} ::= (item [@var{keyword} @var{argument}]... @var{value})
-@end example
+@item :validate
+The widget validates if the current value is valid for one of its
+children.
+
+@item :match
+This widget matches any value that matches at least one of
+the specified @var{type} arguments.
+
+@item :match-inline
+Like the @code{:match} function, but taking into account inline
+values.
+@end table
+
+You can add extra radio button items to a @code{radio-button-choice}
+widget after it has been created with the function
+@code{widget-radio-add-item}.
+
+@defun widget-radio-add-item widget type
+Add to @code{radio-button-choice} widget @var{widget} a new radio button
+item of type @var{type}.
+@end defun
-The @var{value}, if present, is used to initialize the @code{:value}
-property. The value should be a string, which will be inserted in the
-buffer. This widget will only match the specified value.
+Please note that such items added after the @code{radio-button-choice}
+widget has been created will @strong{not} be properly destructed when
+you call @code{widget-delete}.
@node choice-item
-@section The @code{choice-item} Widget
+@subsection The @code{choice-item} Widget
@findex choice-item@r{ widget}
Syntax:
@@ -984,14 +1975,26 @@ Syntax:
@var{item} ::= (choice-item [@var{keyword} @var{argument}]... @var{value})
@end example
+A widget to represent a choice in a @code{menu-choice} widget. Its
+super is the @code{item} widget.
+
The @var{value}, if present, is used to initialize the @code{:value}
-property. The value should be a string, which will be inserted in the
-buffer as a button. Activating the button of a @code{choice-item} is
-equivalent to activating the parent widget. This widget will only match
-the specified value.
+property.
+
+It overrides the following properties:
+
+@table @code
+@item :action
+Activating the button of a @code{choice-item} is equivalent to
+activating the parent widget.
+
+@item :format
+By default, it buttonizes the tag (i.e., its value) and adds a newline
+character at the end of the widget.
+@end table
@node toggle
-@section The @code{toggle} Widget
+@subsection The @code{toggle} Widget
@findex toggle@r{ widget}
Syntax:
@@ -1000,43 +2003,136 @@ Syntax:
@var{type} ::= (toggle [@var{keyword} @var{argument}]...)
@end example
+A widget that can toggle between two states. Its super is the
+@code{item} widget.
+
The widget has two possible states, @samp{on} and @samp{off}, which
correspond to a @code{t} or @code{nil} value, respectively.
-The following extra properties are recognized:
+It either overrides or adds the following properties:
@table @code
+@item :format
+By default, it buttonizes the value and adds a newline at the end of
+the widget.
+
@item :on
A string representing the @samp{on} state. By default the string
@samp{on}.
+
@item :off
A string representing the @samp{off} state. By default the string
@samp{off}.
+
@vindex on-glyph@r{ keyword}
@item :on-glyph
Name of a glyph to be used instead of the @samp{:on} text string, on
emacsen that supports this.
+
@vindex off-glyph@r{ keyword}
@item :off-glyph
Name of a glyph to be used instead of the @samp{:off} text string, on
emacsen that supports this.
+
+@item :value-create
+A function for creating the widget's value, according to its
+@samp{:on} or @samp{:off} state.
+
+@item :action
+Function to toggle the state of the widget. After toggling, it
+notifies itself.
+
+@item :match
+This widget matches anything.
+@end table
+
+@node radio-button-toggle
+@subsection The @code{radio-button-toggle} Widget
+@findex radio-button-toggle@r{ widget}
+Syntax:
+
+@example
+@var{type} ::= (radio-button-toggle [@var{keyword} @var{argument}]...)
+@end example
+
+A toggle to use in the @code{radio} widget.
+
+It overrides the following properties:
+
+@table @code
+@item :button-prefix
+The empty string.
+
+@item :button-suffix
+The empty string.
+
+@item :on
+The string ``(*)'', to represent the @samp{on} state.
+
+@item :off
+The string ``( )'', to represent the @samp{off} state.
+
+@item :on-glyph
+The name of an image to represent the @samp{on} state.
+
+@item :off-glpyh
+The name of an image to represent the @samp{off} state.
+
+@item :format
+By default, it buttonizes its value.
+
+@item :notify
+A function to notify its parent.
@end table
@node checkbox
-@section The @code{checkbox} Widget
+@subsection The @code{checkbox} Widget
@findex checkbox@r{ widget}
-This widget has two possible states, @samp{selected} and
-@samp{unselected}, which corresponds to a @code{t} or @code{nil} value.
-
Syntax:
@example
@var{type} ::= (checkbox [@var{keyword} @var{argument}]...)
@end example
+A widget to represent a toggle widget, with a checkbox. Its super is
+the @code{toggle} widget.
+
+This widget has two possible states, @samp{selected} and
+@samp{unselected}, which corresponds to a @code{t} or @code{nil}
+value, respectively.
+
+It either overrides or adds the following properties:
+
+@table @code
+@item :button-prefix
+The empty string.
+
+@item :button-suffix
+The empty string.
+
+@item :format
+By default, buttonizes the value.
+
+@item :on
+By default, the string ``[X]''.
+
+@item :off
+By default, the string ``[ ]''.
+
+@item :on-glyph
+The name of the image to use when the state is @samp{on}.
+
+@item :off-glyph
+The name of the image to use when the state is @samp{off}.
+
+@item :action
+A function that toggles the checkbox, notifies the parents and in the
+@samp{on} state, activates its siblings.
+@end table
+
@node checklist
-@section The @code{checklist} Widget
+@subsection The @code{checklist} Widget
@findex checklist@r{ widget}
Syntax:
@@ -1045,14 +2141,26 @@ Syntax:
@var{type} ::= (checklist [@var{keyword} @var{argument}]... @var{type} ... )
@end example
+A widget to represent a multiplice choice. Its super is the
+@code{default} widget.
+
The @var{type} arguments represent each checklist item. The widget's
value will be a list containing the values of all checked @var{type}
-arguments. The checklist widget will match a list whose elements all
-match at least one of the specified @var{type} arguments.
+arguments.
-The following extra properties are recognized:
+It either overrides or adds the following properties:
@table @code
+@item :convert-widget
+As other composite widgets, a function that takes care of converting
+each checklist item.
+
+@item :copy
+A function to copy each checklist item.
+
+@item :format
+By default, it inserts its value.
+
@vindex entry-format@r{ keyword}
@item :entry-format
This string will be inserted for each entry in the list.
@@ -1066,14 +2174,6 @@ Replace with the checkbox.
Insert a literal @samp{%}.
@end table
-@vindex greedy@r{ keyword}
-@item :greedy
-Usually a checklist will only match if the items are in the exact
-sequence given in the specification. By setting @code{:greedy} to
-non-@code{nil}, it will allow the items to come in any sequence.
-However, if you extract the value they will be in the sequence given
-in the checklist, i.e., the original sequence is forgotten.
-
@vindex button-args@r{ keyword}
@item :button-args
A list of keywords to pass to the checkboxes. Useful for setting,
@@ -1090,10 +2190,35 @@ The widgets representing each type.
@vindex args@r{ keyword}
@item :args
The list of types.
+
+@item :value-create
+The function that takes care of inserting all values.
+
+@item :value-get
+A function that returns all values of selected items.
+
+@item :validate
+A function that ensures all selected children are valid.
+
+@item :match
+The checklist widget will match a list whose elements all
+match at least one of the specified @var{type} arguments.
+
+@item :match-inline
+Like the @code{:match} function, but taking into account the
+@code{:inline} property.
+
+@vindex greedy@r{ keyword}
+@item :greedy
+Usually a checklist will only match if the items are in the exact
+sequence given in the specification. By setting @code{:greedy} to
+non-@code{nil}, it will allow the items to come in any sequence.
+However, if you extract the value they will be in the sequence given
+in the checklist, i.e., the original sequence is forgotten.
@end table
@node editable-list
-@section The @code{editable-list} Widget
+@subsection The @code{editable-list} Widget
@findex editable-list@r{ widget}
Syntax:
@@ -1102,12 +2227,19 @@ Syntax:
@var{type} ::= (editable-list [@var{keyword} @var{argument}]... @var{type})
@end example
-The value is a list, where each member represents one widget of type
-@var{type}.
+A widget that can hold a variable list of widgets of the same type,
+represented by @var{type}. Its super is the @code{default} widget.
-The following extra properties are recognized:
+It either overrides or adds the following properties:
@table @code
+@item :convert-widget
+As other composite widgets, a function that takes care of converting
+each type in @var{type}.
+
+@item :copy
+A function to copy the types given in @var{type}.
+
@vindex entry-format@r{ keyword}
@item :entry-format
This string will be inserted for each entry in the list.
@@ -1117,9 +2249,9 @@ The following @samp{%} escapes are available:
This will be replaced with the buffer representation of the @var{type}
widget.
@item %i
-Insert the @b{[INS]} button.
+Insert the @b{[INS]} button, a widget of type @code{insert-button}.
@item %d
-Insert the @b{[DEL]} button.
+Insert the @b{[DEL]} button, a widget of type @code{delete-button}.
@item %%
Insert a literal @samp{%}.
@end table
@@ -1140,6 +2272,18 @@ A list of keyword arguments to pass to the trailing
insert button.
@item :buttons
The widgets representing the insert and delete buttons.
+@item :format
+By default, insert its value and at the and adds an insert button.
+
+This is useful so that new elements can be added to the list upon user
+request.
+
+@item :format-handler
+A function that recognize the escape for inserting an insert button.
+
+@item :offset
+By default, this widget has an offset of 12.
+
@vindex children@r{ keyword}
@item :children
The widgets representing the elements of the list.
@@ -1147,24 +2291,124 @@ The widgets representing the elements of the list.
@vindex args@r{ keyword}
@item :args
List whose @sc{car} is the type of the list elements.
+
+@item :insert-before
+Function to insert a new widget as a child of the @code{editable-list}
+widget.
+
+This function inserts a recently deleted child, if there is one. That
+is useful, so that the user can move elements in a list easily. If
+there is not a recently deleted child, it inserts a child with its
+default value.
+
+@item :delete-at
+Function to delete a child from the widget, and store it into the
+@code{:last-deleted} list, so that it can be reinserted when the
+@code{:insert-before} function executes.
+
+@item :value-create
+The function that takes care of inserting all values.
+
+@item :value-get
+Function that returns a list with the value of the child widgets.
+
+@item :validate
+This widget validates if all children validate.
+
+@item :match
+To match, the value must be a list and all the list members must match
+the specified @var{type}.
+
+@item :match-inline
+Like the @code{:match} function, but taking into account inline
+values and widgets.
@end table
@node group
-@section The @code{group} Widget
+@subsection The @code{group} Widget
@findex group@r{ widget}
-This widget simply group other widgets together.
-
Syntax:
@example
@var{type} ::= (group [@var{keyword} @var{argument}]... @var{type}...)
@end example
-The value is a list, with one member for each @var{type}.
+A widget to group other widgets. Its super is the @code{default}
+widget.
+
+Its value is a list, with one member for each @var{type}.
+
+It overrides the following properties:
+
+@table @code
+@item :convert-widget
+As other composite widgets, a function that takes care of converting
+each widget in @var{type}.
+
+@item :copy
+A function to copy the types given in @var{type}.
+
+@item :format
+By default, displays a newline character and its value.
+
+@item :value-create
+A function to create each of its components.
+
+@item :value-get
+The same function used by the @code{editable-list} widget.
+
+@item :default-get
+A function that returns a list whose members are the default values of
+each widget it groups.
+
+@item :validate
+This widget validates if all of its children validate.
+
+@item :match
+This widget matches a value that matches each of its components.
+
+@item :match-inline
+As @code{:match}, but taking into account widgets and values that are
+inline.
+@end table
+
+@node documentation-string
+@subsection The @code{documentation-string} Widget
+@findex documentation-string@r{ widget}
+Syntax:
+
+@example
+@var{type} ::= (documentation-string [@var{keyword} @var{argument}]...
@var{value})
+@end example
+
+A widget to represent a documentation string. Its super is the
+@code{item} widget.
+
+It either overrides or adds the following properties:
+
+@table @code
+@item :format
+By default, insert its value.
+
+@item :value-create
+Function to insert a documentation string, possibly hiding part of the
+documentation if its large.
+
+To show or hide the rest of the documentation, uses a
+@code{visibility} widget.
+
+@item :action
+Function to toggle showing the documentation upon an event.
+
+@item :visibility-widget
+A symbol, the type of the widget to use for the visibility widget.
+
+This is, by default, the symbol @code{visibility}.
+@end table
@node Sexp Types
-@chapter Sexp Types
+@section Sexp Types
@cindex sexp types
A number of widgets for editing @dfn{s-expressions} (Lisp types), sexp
@@ -1179,7 +2423,7 @@ categories described in this section.
@end menu
@node constants
-@section The Constant Widgets
+@subsection The Constant Widgets
@cindex constant widgets
The @code{const} widget can contain any Lisp expression, but the user is
@@ -1192,19 +2436,26 @@ The syntax for the @code{const} widget is:
@var{type} ::= (const [@var{keyword} @var{argument}]... [ @var{value} ])
@end example
-The @var{value}, if present, is used to initialize the @code{:value}
-property and can be any s-expression.
+Its super is the @code{item} widget. The @var{value}, if present, is
+used to initialize the @code{:value} property and can be any
+s-expression.
@deffn Widget const
This will display any valid s-expression in an immutable part of the
buffer.
+
+It overrides the @code{:prompt-value} function, to avoid prompting and
+just return the widget's value.
@end deffn
There are two variations of the @code{const} widget, namely
@code{variable-item} and @code{function-item}. These should contain a
-symbol with a variable or function binding. The major difference from
-the @code{const} widget is that they will allow the user to see the
-variable or function documentation for the symbol.
+symbol with a variable or function binding, respectively. The major
+difference from the @code{const} widget is that they will allow the
+user to see the variable or function documentation for the symbol.
+
+This is accomplished via using the @samp{%h} format escape, and adding
+an appropiate @code{:documentation-property} function for each widget.
@deffn Widget variable-item
An immutable symbol that is bound as a variable.
@@ -1215,7 +2466,7 @@ An immutable symbol that is bound as a function.
@end deffn
@node generic
-@section Generic Sexp Widget
+@subsection Generic Sexp Widget
@cindex generic sexp widget
The @code{sexp} widget can contain any Lisp expression, and allows the
@@ -1228,23 +2479,42 @@ The syntax for the @code{sexp} widget is:
@end example
@deffn Widget sexp
-This will allow you to edit any valid s-expression in an editable buffer
-field.
+This widget represents an editable field that's useful to edit any
+valid s-expression.
The @code{sexp} widget takes the same keyword arguments as the
@code{editable-field} widget. @xref{editable-field}.
+
+Its default value is @code{nil}.
+@end deffn
+
+@deffn Widget restricted-sexp
+A widget to edit Lisp expressions restricted to certain values or
+types. Its super is the @code{sexp} widget.
+
+It works just like the sexp widget, but it overrides the @code{:match}
+function to match for certain values. To use this widget, either you
+must define a @code{:match} function or give a
+@code{:match-alternatives} property. The @code{:match-alternatives}
+property holds a list of predicate functions to call when checking if
+a given value matches the widget. Each predicate function will be
+called with one argument, the value to be matched, and should return
+non-@code{nil} on success.
+
+As an example, the @code{integer} widget overrides
+@code{:match-alternatives} to @code{(integerp)}.
@end deffn
@node atoms
-@section Atomic Sexp Widgets
+@subsection Atomic Sexp Widgets
@cindex atomic sexp widget
The atoms are s-expressions that do not consist of other s-expressions.
For example, a string, a file name, or a symbol are atoms, while a list
is a composite type. You can edit the value of an atom with the
-following widgets.
+widgets described in this section.
-The syntax for all the atoms are:
+The syntax for all the atoms is:
@example
@var{type} ::= (@var{construct} [@var{keyword} @var{argument}]... [
@var{value} ])
@@ -1252,68 +2522,151 @@ The syntax for all the atoms are:
The @var{value}, if present, is used to initialize the @code{:value}
property and must be an expression of the same type as the widget.
-That is, the string widget can only be initialized with a string.
+That is, for example, the string widget can only be initialized with a
+string.
All the atom widgets take the same keyword arguments as the
@code{editable-field} widget. @xref{editable-field}.
@deffn Widget string
-Allows you to edit a string in an editable field.
+An editable field widget that can represent any Lisp string.
+
+It offers completion via the ispell library and the @code{:complete}
+property.
@end deffn
@deffn Widget regexp
-Allows you to edit a regular expression in an editable field.
+An editable field widget that can represent a regular expression.
+
+Overrides the @code{:match} and the @code{:validate} properties to
+check that the value is a valid regexp.
@end deffn
@deffn Widget character
-Allows you to enter a character in an editable field.
+An editable field widget that can represent a character.
+
+The character widget represents some characters (like the newline
+character) in a special manner, to make it easier for the user to see
+what's the content of the character field.
@end deffn
@deffn Widget file
-Allows you to edit a file name in an editable field.
+A widget for editing file names.
Keywords:
@table @code
+@item :completions
+Offers file name completion to the user.
+
+@item :prompt-value
+A function to read a file name from the minibuffer.
+
@vindex must-match@r{ keyword}
@item :must-match
-If this is set to non-@code{nil}, only existing file names will be
-allowed in the minibuffer.
+If this is set to non-@code{nil}, only existing file names are allowed
+when prompting for a value in the minibuffer.
+
+@item :match
+The widget matches if the value is a string, and the file whose name
+is that string is an existing file, or if @code{:must-match} is
+@code{nil}.
+
+@item :validate
+The widget is valid if its value matches.
+
@end table
@end deffn
@deffn Widget directory
-Allows you to edit a directory name in an editable field.
-Similar to the @code{file} widget.
+A widget for editing directory names.
+
+Its super is the @code{file} widget, and it overrides the
+@code{:completions} property, to offer completions only for
+directories.
@end deffn
@deffn Widget symbol
-Allows you to edit a Lisp symbol in an editable field.
+A widget for editing a Lisp symbol.
+
+Its value by default is @code{nil}.
@end deffn
@deffn Widget function
-Allows you to edit a lambda expression, or a function name with completion.
+A widget for editing a lambda expression, or a function name, offering
+completion. Its super is the @code{restricted-sexp} widget.
@end deffn
@deffn Widget variable
-Allows you to edit a variable name, with completion.
+A widget for editing variable names, offering completion. Its super
+is the @code{symbol} widget.
@end deffn
@deffn Widget integer
-Allows you to edit an integer in an editable field.
+A widget for editing integers in an editable field. Its super is the
+@code{restricted-sexp} widget.
+
+It has a default @code{:value} of 0.
+@end deffn
+
+@deffn Widget natnum
+A widget for editing non-negative integers. Its super is the
+@code{restricted-sexp} widget.
+
+It has a default @code{:value} of 0.
+@end deffn
+
+@deffn Widget float
+A widget for editing a floating point number. Its super is the
+@code{restricted-sexp} widget.
+
+It has a default @code{:value} of 0.0.
@end deffn
@deffn Widget number
-Allows you to edit a number in an editable field.
+A widget for editing a number, either floating point or integer. Its
+super is the @code{restricted-sexp} widget.
+
+It has a default @code{:value} of 0.0.
@end deffn
@deffn Widget boolean
-Allows you to edit a boolean. In Lisp this means a variable which is
-either @code{nil} meaning false, or non-@code{nil} meaning true.
+A widget for editing a boolean value. Its super is the @code{toggle}
+widget.
+
+Its value may be @code{nil}, meaning false, or non-@code{nil}, meaning
+true.
+@end deffn
+
+@deffn Widget color
+A widget to edit a color name.
+
+In addition, shows a sample that shows the selected color, if any.
@end deffn
+@deffn Widget other
+A widget useful as the last item in a @code{choice} widget, since it
+matches any value.
+
+Its super is the @code{sexp} widget, and its @code{:value} is
+@code{other}, by default.
+@end deffn
+
+@deffn Widget coding-system
+A widget that can represent a coding system name, offering
+completions. @xref{Coding Systems,,,elisp, the Emacs Lisp Reference
+Manual}. Its super is the @code{symbol} widget.
+
+It has a default value of @code{undecided}.
+@end deffn
+
+@deffn Widget key
+A widget to represent a key sequence.
+
+It uses a special keymap as the @code{:keymap}.
+@end deffn
@node composite
-@section Composite Sexp Widgets
+@subsection Composite Sexp Widgets
@cindex composite sexp widgets
The syntax for the composite widget construct is:
@@ -1327,6 +2680,9 @@ where each @var{component} must be a widget type. Each
component widget
will be displayed in the buffer, and will be editable by the user.
@deffn Widget cons
+A widget to edit cons-cell values. Its super is the @code{group}
+widget.
+
The value of a @code{cons} widget must be a cons-cell whose @sc{car}
and @sc{cdr} have two specified types. It uses this syntax:
@@ -1336,8 +2692,10 @@ and @sc{cdr} have two specified types. It uses this
syntax:
@end deffn
@deffn Widget choice
-The value matched by a @code{choice} widget must have one of a fixed
-set of types. The widget's syntax is as follows:
+A widget to hold a value of one of a fixed set of types. Its super is
+the @code{menu-choice} widget.
+
+The widget's syntax is as follows:
@example
@var{type} ::= (choice [@var{keyword} @var{argument}]... @var{type} ... )
@@ -1345,9 +2703,19 @@ set of types. The widget's syntax is as follows:
The value of a @code{choice} widget can be anything that matches any of the
@var{types}.
+
+This widget only displays the widget that corresponds to the current
+choice.
+@end deffn
+
+@deffn Widget radio
+A widget to hold a value of one of a fixed set of options. Its super is
+the @code{radio-button-choice} widget.
@end deffn
@deffn Widget list
+A widget to edit a list value. Its super is the @code{group} widget.
+
The value of a @code{list} widget must be a list whose element types
match the specified component types:
@@ -1355,15 +2723,18 @@ match the specified component types:
@var{type} ::= (list [@var{keyword} @var{argument}]...
@var{component-type}...)
@end example
-Thus, @code{(list string number)} matches lists of two elements,
-the first being a string and the second being a number.
+Thus, for example, @code{(list string number)} matches lists of two
+elements, the first being a string and the second being a number.
@end deffn
@deffn Widget vector
+A widget to edit a vector value. Its super is the @code{group}
+widget.
+
The @code{vector} widget is like the @code{list} widget but matches
-vectors instead of lists. Thus, @code{(vector string number)} matches
-vectors of two elements, the first being a string and the second being
-a number.
+vectors instead of lists. Thus, for example, @code{(vector string
+number)} matches vectors of two elements, the first being a string and
+the second being a number.
@end deffn
The above suffice for specifying fixed size lists and vectors. To get
@@ -1392,126 +2763,74 @@ certainly hard to implement, so instead of confusing
you more by
trying to explain it here, I'll just suggest you meditate over it for
a while.
-@deffn Widget set
-Specifies a type whose values are the lists whose elements all belong
-to a given set. The order of elements of the list is not significant.
-Here's the syntax:
-
-@example
-@var{type} ::= (set [@var{keyword} @var{argument}]... @var{permitted-element}
... )
-@end example
-
-Use @code{const} to specify each permitted element, like this:
-@code{(set (const a) (const b))}.
-@end deffn
-
-@deffn Widget repeat
-Specifies a list of any number of elements that fit a certain type.
-
-@example
-@var{type} ::= (repeat [@var{keyword} @var{argument}]... @var{type})
-@end example
-@end deffn
-
-@node Widget Properties
-@chapter Properties
-@cindex properties of widgets
-@cindex widget properties
-
-You can examine or set the value of a widget by using the widget object
-that was returned by @code{widget-create}.
-
-@defun widget-value widget
-Return the current value contained in @var{widget}.
-It is an error to call this function on an uninitialized widget.
-@end defun
-
-@defun widget-value-set widget value
-Set the value contained in @var{widget} to @var{value}.
-It is an error to call this function with an invalid @var{value}.
-@end defun
-
-@strong{Important:} You @emph{must} call @code{widget-setup} after
-modifying the value of a widget before the user is allowed to edit the
-widget again. It is enough to call @code{widget-setup} once if you
-modify multiple widgets. This is currently only necessary if the widget
-contains an editing field, but may be necessary for other widgets in the
-future.
+@deffn Widget set
+A widget to hold a list of members from a fixed set. Its super is the
+@code{checklist} widget.
-If your application needs to associate some information with the widget
-objects, for example a reference to the item being edited, it can be
-done with @code{widget-put} and @code{widget-get}. The property names
-must begin with a @samp{:}.
+Its value is a list where the elements all belong to a given set. The
+order of elements of the list is not significant.
-@defun widget-put widget property value
-In @var{widget} set @var{property} to @var{value}.
-@var{property} should be a symbol, while @var{value} can be anything.
-@end defun
+Here's the syntax:
-@defun widget-get widget property
-In @var{widget} return the value for @var{property}.
-@var{property} should be a symbol, the value is what was last set by
-@code{widget-put} for @var{property}.
-@end defun
+@example
+@var{type} ::= (set [@var{keyword} @var{argument}]... @var{permitted-element}
... )
+@end example
-@defun widget-member widget property
-Non-@code{nil} if @var{widget} has a value (even @code{nil}) for
-property @var{property}.
-@end defun
+Use @code{const} to specify each permitted element, like this:
+@code{(set (const a) (const b))}.
+@end deffn
-@defun widget-apply widget property &rest args
-Apply the value of @var{property} to @var{widget}, passing @var{args}
-as additional arguments to the function. Return the result of that
-function call.
-@end defun
+@deffn Widget repeat
+Specifies a list of any number of elements that fit a certain type.
+Its super is the @code{editable-list} widget.
-Occasionally it can be useful to know which kind of widget you have,
-i.e., the name of the widget type you gave when the widget was created.
+@example
+@var{type} ::= (repeat [@var{keyword} @var{argument}]... @var{type})
+@end example
+@end deffn
-@defun widget-type widget
-Return the name of @var{widget}, a symbol.
-@end defun
+@deffn Widget plist
+A widget to edit property lists. Its super is the @code{list} widget.
-@cindex active widget
-@cindex inactive widget
-@cindex activate a widget
-@cindex deactivate a widget
-Widgets can be in two states: active, which means they are modifiable by
-the user, or inactive, which means they cannot be modified by the user.
-You can query or set the state with the following code:
+It recognizes the following properties:
-@lisp
-;; Examine if @var{widget} is active or not.
-(if (widget-apply @var{widget} :active)
- (message "Widget is active.")
- (message "Widget is inactive.")
+@table @code
+@item :options
+A given set of recommended key-value values for the @code{plist}
+widget. Each option shows up as a checklist item.
-;; Make @var{widget} inactive.
-(widget-apply @var{widget} :deactivate)
+@item :key-type
+The widget type to use for the plist keys. By default, it uses the
+@code{symbol} widget.
-;; Make @var{widget} active.
-(widget-apply @var{widget} :activate)
-@end lisp
+@item :value-type
+The widget type to use for the plist values. By default, it uses the
+@code{sexp} widget.
+@end table
+@end deffn
-A widget is inactive if it, or any of its ancestors (found by
-following the @code{:parent} link), have been deactivated. To make sure
-a widget is really active, you must therefore activate both it and
-all its ancestors.
+@deffn Widget alist
+A widget to edit association lists. Its super is the @code{list}
+widget.
-@lisp
-(while widget
- (widget-apply widget :activate)
- (setq widget (widget-get widget :parent)))
-@end lisp
+It recognizes the same properties that the @code{plist} widget, with
+the difference that the @code{:key-type} uses by default a @code{sexp}
+widget.
+@end deffn
-You can check if a widget has been made inactive by examining the value
-of the @code{:inactive} keyword. If this is non-@code{nil}, the widget itself
-has been deactivated. This is different from using the @code{:active}
-keyword, in that the latter tells you if the widget @strong{or} any of
-its ancestors have been deactivated. Do not attempt to set the
-@code{:inactive} keyword directly. Use the @code{:activate}
-@code{:deactivate} keywords instead.
+Most composite widgets do not allow for recursion. That is, none of
+the contained widgets may be of the same type that is currently being
+defined. To allow for this kind of widgets, there's the @code{lazy}
+widget.
+
+@deffn Widget lazy
+A base widget for recursive data structures. Its super is the
+@code{default} widget.
+When instantiated, it contains a single inferior widget of the widget
+type specified in the @code{:type} property. Its value is the same as
+the value of this inferior widget.
+@end deffn
@node Defining New Widgets
@chapter Defining New Widgets
@@ -1520,19 +2839,27 @@ its ancestors have been deactivated. Do not attempt to
set the
You can define specialized widgets with @code{define-widget}. It allows
you to create a shorthand for more complex widgets, including specifying
-component widgets and new default values for the keyword
-arguments.
+component widgets and new default values for the keyword arguments.
@defun define-widget name class doc &rest args
-Define a new widget type named @var{name} from @code{class}.
+Define a new widget type named @var{name} that derives from @var{class}.
-@var{name} and class should both be symbols, @code{class} should be one
-of the existing widget types.
+@var{name} and @var{class} should both be symbols, and @var{class}
+should be one of the existing widget types.
The third argument @var{doc} is a documentation string for the widget.
-After the new widget has been defined, the following two calls will
-create identical widgets:
+@var{args} should be key-value pairs, overriding keyword values of
+@var{class}, or adding new recognized keywords for @var{name}.
+
+Usually, you'll want to derive from an existing widget type, like the
+@code{editable-field} widget, or the @code{default} widget, but it's
+also possible to derive from nothing, by passing a value of @code{nil}
+as @var{class}. Note that if you do this, you're entirely responsible
+for defining a whole new default behavior for your widgets.
+
+After using this function, the following two calls will create
+identical widgets:
@itemize @bullet
@item
@@ -1555,170 +2882,67 @@ in the @code{widget-type} property of @var{name},
which is what
If you only want to specify defaults for keywords with no complex
conversions, you can use @code{identity} as your conversion function.
-The following additional keyword arguments are useful when defining new
-widgets:
+When defining new widgets, the @code{:convert-widget} property might
+be useful:
+
@table @code
@vindex convert-widget@r{ keyword}
@item :convert-widget
Function to convert a widget type before creating a widget of that
-type. It takes a widget type as an argument, and returns the converted
-widget type. When a widget is created, this function is called for the
-widget type and all the widget's parent types, most derived first.
-
-The following predefined functions can be used here:
-
-@defun widget-types-convert-widget widget
-Convert @code{:args} as widget types in @var{widget}.
-@end defun
-
-@defun widget-value-convert-widget widget
-Initialize @code{:value} from @code{:args} in @var{widget}.
-@end defun
-
-@vindex copy@r{ keyword}
-@item :copy
-Function to deep copy a widget type. It takes a shallow copy of the
-widget type as an argument (made by @code{copy-sequence}), and returns a
-deep copy. The purpose of this is to avoid having different instances
-of combined widgets share nested attributes.
-
-The following predefined functions can be used here:
-
-@defun widget-types-copy widget
-Copy @code{:args} as widget types in @var{widget}.
-@end defun
-
-@vindex value-to-internal@r{ keyword}
-@item :value-to-internal
-Function to convert the value to the internal format. The function
-takes two arguments, a widget and an external value, and returns the
-internal value. The function is called on the present @code{:value}
-when the widget is created, and on any value set later with
-@code{widget-value-set}.
-
-@vindex value-to-external@r{ keyword}
-@item :value-to-external
-Function to convert the value to the external format. The function
-takes two arguments, a widget and an internal value, and returns the
-external value.
-
-@vindex create@r{ keyword}
-@item :create
-Function to create a widget from scratch. The function takes one
-argument, a widget type, and creates a widget of that type, inserts it
-in the buffer, and returns a widget object.
-
-@vindex delete@r{ keyword}
-@item :delete
-Function to delete a widget. The function takes one argument, a widget,
-and should remove all traces of the widget from the buffer.
-
-The default value is:
-
-@defun widget-default-delete widget
-Remove @var{widget} from the buffer.
-Delete all @code{:children} and @code{:buttons} in @var{widget}.
-@end defun
-
-In most cases you should not change this value, but instead use
-@code{:value-delete} to make any additional cleanup.
-
-@vindex value-create@r{ keyword}
-@item :value-create
-Function to expand the @samp{%v} escape in the format string. It will
-be called with the widget as its argument and should insert a
-representation of the widget's value in the buffer.
-
-Nested widgets should be listed in @code{:children} or @code{:buttons}
-to make sure they are automatically deleted.
-
-@vindex value-delete@r{ keyword}
-@item :value-delete
-Should remove the representation of the widget's value from the buffer.
-It will be called with the widget as its argument. It doesn't have to
-remove the text, but it should release markers and delete nested widgets
-if these are not listed in @code{:children} or @code{:buttons}.
-
-@vindex value-get@r{ keyword}
-@item :value-get
-Function to extract the value of a widget, as it is displayed in the
-buffer.
-
-The following predefined function can be used here:
-
-@defun widget-value-value-get widget
-Return the @code{:value} property of @var{widget}.
-@end defun
-
-@vindex format-handler@r{ keyword}
-@item :format-handler
-Function to handle unknown @samp{%} escapes in the format string. It
-will be called with the widget and the character that follows the
-@samp{%} as arguments. You can set this to allow your widget to handle
-non-standard escapes.
-
-@findex widget-default-format-handler
-You should end up calling @code{widget-default-format-handler} to handle
-unknown escape sequences, which will handle the @samp{%h} and any future
-escape sequences, as well as give an error for unknown escapes.
-
-@vindex action@r{ keyword}
-@item :action
-Function to handle user initiated events. By default, @code{:notify}
-the parent.
+type.
-The following predefined function can be used here:
-
-@defun widget-parent-action widget &optional event
-Tell @code{:parent} of @var{widget} to handle the @code{:action}.
-Optional @var{event} is the event that triggered the action.
-@end defun
+It takes a widget type as an argument, and returns the converted
+widget type. When a widget is created, this function is called for
+the widget type and all the widget's parent types, most derived first.
-@vindex prompt-value@r{ keyword}
-@item :prompt-value
-Function to prompt for a value in the minibuffer. The function should
-take four arguments, @var{widget}, @var{prompt}, @var{value}, and
-@var{unbound} and should return a value for widget entered by the user.
-@var{prompt} is the prompt to use. @var{value} is the default value to
-use, unless @var{unbound} is non-@code{nil}, in which case there is no default
-value. The function should read the value using the method most natural
-for this widget, and does not have to check that it matches.
+The predefined functions @code{widget-types-convert-widget} and
+@code{widget-value-convert-widget} can be used here.
@end table
-If you want to define a new widget from scratch, use the @code{default}
-widget as its base.
-
-@deffn Widget default
-Widget used as a base for other widgets.
-
-It provides most of the functionality that is referred to as ``by
-default'' in this text.
-@end deffn
-
-@node Widget Browser
-@chapter Widget Browser
+@node Inspecting Widgets
+@chapter Inspecting Widgets
@cindex widget browser
-There is a separate package to browse widgets. This is intended to help
-programmers who want to examine the content of a widget. The browser
-shows the value of each keyword, but uses links for certain keywords
-such as @samp{:parent}, which avoids printing cyclic structures.
+There is a separate package to browse widgets, in
+@samp{wid-browse.el}. This is intended to help programmers who want
+to examine the content of a widget. The browser shows the value of
+each keyword, but uses links for certain keywords such as
+@samp{:parent}, which avoids printing cyclic structures.
@deffn Command widget-browse @var{widget}
Create a widget browser for @var{widget}.
+
When called interactively, prompt for @var{widget}.
@end deffn
@deffn Command widget-browse-other-window @var{widget}
Create a widget browser for @var{widget} and show it in another window.
+
When called interactively, prompt for @var{widget}.
@end deffn
@deffn Command widget-browse-at @var{pos}
Create a widget browser for the widget at @var{pos}.
+
When called interactively, use the position of point.
@end deffn
+In addition, there's a function to describe the widget at point.
+
+@deffn Command widget-describe &optional widget-or-pos
+Describe the widget at point.
+
+When called from Lisp, @var{widget-or-pos} might be the widget to
+describe or a buffer position where a widget is present. If
+@var{widget-or-pos} is @code{nil}, the widget to describe is the
+widget at point.
+
+This command sets up a help buffer for providing information about the
+widget, mainly its @code{:action} and @code{:mouse-down-action}
+functions, and provides links to describe it in more detail using the
+@code{widget-browse} commands described above.
+@end deffn
+
@node Widget Minor Mode
@chapter Widget Minor Mode
@cindex widget minor mode
@@ -1740,14 +2964,24 @@ Keymap used in @code{widget-minor-mode}.
@chapter Utilities
@cindex utility functions for widgets
+Here we describe some utility functions that don't really have a place
+earlier in this manual.
+
@defun widget-prompt-value widget prompt [ value unbound ]
Prompt for a value matching @var{widget}, using @var{prompt}.
The current value is assumed to be @var{value}, unless @var{unbound} is
non-@code{nil}.
+
+Converts @var{widget} before prompting, and for prompting it uses the
+@code{:prompt-value} function. This function returns the user
+``answer'', and it's an error if that answer doesn't match the widget,
+as with the @code{:match} function.
+
+If the answer matches the widget, returns the answer.
@end defun
@defun widget-get-sibling widget
-Get the item which @var{widget} is assumed to toggle.
+Get the item which @var{widget} should toggle.
This is only meaningful for radio buttons or checkboxes in a list.
@end defun
@@ -1773,6 +3007,142 @@ the form (@var{name} . @var{value}) (i.e., the
simplified format),
then the return value is the @var{value} of the chosen element.
@end defun
+@defun widget-image-find image
+Create a graphical button from @var{image}, an image or a file name
+sans extension.
+
+If @var{image} is a file name, the file should be in
+@code{widget-image-directory}, or in a place where @code{find-image}
+will find it.
+@end defun
+
+@defun widget-image-insert widget tag image
+As part of @var{widget}, insert the text @var{tag} or, if supported,
+the image @var{image}.
+
+@var{image} should be as described in @code{widget-image-find}.
+@end defun
+
+@defun widget-echo-help pos
+Display help-echo text for the widget at @var{pos}.
+
+Uses the value of @code{:help-echo}. If it is a function, it calls it
+to get a string. Otherwise, it @code{eval}s it.
+@end defun
+
+@node Customization
+@chapter Customization
+This chapter is about the customization options for the Widget
+library, for the end user.
+
+@deffn Face widget-field-face
+Face used for other editing fields.
+@end deffn
+
+@deffn Face widget-button-face
+Face used for buttons.
+@end deffn
+
+@defopt widget-mouse-face
+Face used for highlighting a button when the mouse pointer moves
+across it.
+
+The default value is @code{highlight}.
+@end defopt
+
+@defopt widget-image-directory
+Directory where Widget should look for images.
+
+Widget will look here for a file with the same name as specified for the
+image, with either a @file{.xpm} (if supported) or @file{.xbm} extension.
+@end defopt
+
+@defopt widget-image-enable
+If non-@code{nil}, allow images to appear on displays where they are supported.
+@end defopt
+
+@defopt widget-image-conversion
+An alist to convert symbols from image formats to file name suffixes.
+
+Each element is a cons cell (@var{format} . @var{suffix}), where
+@var{format} is a symbol that represents an image format and
+@var{suffix} is its correspondent suffix.
+@end defopt
+
+@defopt widget-button-prefix
+String to prefix buttons.
+@end defopt
+
+@defopt widget-button-suffix
+String to suffix buttons.
+@end defopt
+
+@defopt widget-push-button-prefix
+String to prefix push buttons.
+@end defopt
+
+@defopt widget-push-button-suffix
+String to suffix push buttons.
+@end defopt
+
+@defopt widget-link-prefix
+String to prefix links.
+@end defopt
+
+@defopt widget-link-suffix
+String to suffix links.
+@end defopt
+
+@defopt widget-choice-toggle
+If non-@code{nil}, toggle when there are just two options.
+
+By default, its value is @code{nil}.
+@end defopt
+
+@defopt widget-documentation-links
+If non-@code{nil}, add hyperlinks to documentation strings.
+@end defopt
+
+@defopt widget-documentation-link-regexp
+A regexp that matches potential links in documentation strings. The
+link itself should match to the first group.
+@end defopt
+
+@defopt widget-documentation-link-p
+A predicate function to test if a string is useful as a link. The
+function is called with one argument, a string, and should return
+non-@code{nil} if there should be a link for that string.
+
+By default, the value is @code{intern-soft}.
+@end defopt
+
+@defopt widget-documentation-link-type
+A symbol that represents a widget type to use for links in
+documentation strings.
+
+By default, the value is @code{documentation-link}.
+@end defopt
+
+@defopt widget-menu-max-size
+Maximum size for a popup menu. By default, its value is 40.
+
+If a function ask you to choose from a menu that is larger than this
+value, it will use the minibuffer.
+@end defopt
+
+@defopt widget-menu-max-shortcuts
+Largest number of items for which it works to choose one with a
+character.
+
+For a larger number, use the minibuffer.
+@end defopt
+
+@defopt widget-menu-minibuffer-flag
+Whether to use the minibuffer to ask for a choice.
+
+If @code{nil}, the default, read a single character.
+@end defopt
+
@node Widget Wishlist
@chapter Wishlist
@cindex todo
@@ -1808,15 +3178,6 @@ Find a way to disable mouse highlight for inactive
widgets.
@item
Find a way to make glyphs look inactive.
-@item
-Add @code{property-list} widget.
-
-@item
-Add @code{association-list} widget.
-
-@item
-Add @code{key-binding} widget.
-
@item
Add @code{widget} widget for editing widget specifications.
diff --git a/etc/PROBLEMS b/etc/PROBLEMS
index c139f25e086..7b646f844de 100644
--- a/etc/PROBLEMS
+++ b/etc/PROBLEMS
@@ -1638,6 +1638,18 @@ to normal, do
(set-scroll-bar-mode 'left)
+*** Redisplay with scaled images is slow in Emacs built with Cairo.
+
+Cairo expends a noticeable amount of CPU time displaying large images
+with applied transforms. These images most frequently appear within
+EWW buffers or in Image Mode buffers after executing the image scaling
+commands `i +' or `i -', and their presence incurs a performance
+penalty of hundereds of milliseconds to seconds upon redisplay. The
+remedy is to build Emacs without Cairo after verifying the XRender
+extension is present on your X server and its headers are present on
+your system, in which case Emacs will use XRender to efficiently
+perform image transforms within the X server.
+
*** Error messages about undefined colors on X.
The messages might say something like this:
diff --git a/lisp/ChangeLog.12 b/lisp/ChangeLog.12
index 6c11bdeaa49..9bc440626dc 100644
--- a/lisp/ChangeLog.12
+++ b/lisp/ChangeLog.12
@@ -32867,7 +32867,7 @@
(reftex-index-switch-index-tag): Add `redo' to arguments of
`reftex-display-index'.
(reftex-index-make-phrase-regexp): Fix bug with case-sensitive
- indexing. Fix bug with matching is there is a quote before or
+ indexing. Fix bug with matching if there is a quote before or
after the word.
* textmodes/reftex-cite.el (reftex-all-used-citation-keys):
diff --git a/lisp/align.el b/lisp/align.el
index 13e31e2ad60..4f7e97dfc6a 100644
--- a/lisp/align.el
+++ b/lisp/align.el
@@ -1598,7 +1598,7 @@ aligner would have dealt with are."
(if (= (point) search-start)
(forward-char)))))
- ;; when they are no more matches for this rule,
+ ;; when there are no more matches for this rule,
;; align whatever was left over
(if regions
(align-regions regions align-props rule func))))))))
diff --git a/lisp/emacs-lisp/eieio.el b/lisp/emacs-lisp/eieio.el
index ccdb52d6a1f..39a5fd5b19c 100644
--- a/lisp/emacs-lisp/eieio.el
+++ b/lisp/emacs-lisp/eieio.el
@@ -449,16 +449,13 @@ If EXTRA, include that in the string returned to
represent the symbol."
(defun eieio-class-parents (class)
;; FIXME: What does "(overload of variable)" mean here?
- "Return parent classes to CLASS. (overload of variable).
-
-The CLOS function `class-direct-superclasses' is aliased to this function."
+ "Return parent classes to CLASS. (overload of variable)."
(eieio--class-parents (eieio--full-class-object class)))
(define-obsolete-function-alias 'class-parents #'eieio-class-parents "24.4")
(defun eieio-class-children (class)
- "Return child classes to CLASS.
-The CLOS function `class-direct-subclasses' is aliased to this function."
+ "Return child classes to CLASS."
(cl-check-type class class)
(eieio--class-children (cl--find-class class)))
(define-obsolete-function-alias
diff --git a/lisp/emacs-lisp/seq.el b/lisp/emacs-lisp/seq.el
index 2a229f71d38..346250c1d35 100644
--- a/lisp/emacs-lisp/seq.el
+++ b/lisp/emacs-lisp/seq.el
@@ -4,7 +4,7 @@
;; Author: Nicolas Petton <nicolas@petton.fr>
;; Keywords: sequences
-;; Version: 2.23
+;; Version: 2.24
;; Package: seq
;; Maintainer: emacs-devel@gnu.org
diff --git a/lisp/ffap.el b/lisp/ffap.el
index 907f56763ff..6f477dd790b 100644
--- a/lisp/ffap.el
+++ b/lisp/ffap.el
@@ -174,7 +174,8 @@ Note this name may be omitted if it equals the default
"\\`/\\(afs\\|net\\)/."
;; afs only: (and (file-exists-p "/afs") "\\`/afs/.")
"Matching file names are treated as remote. Use nil to disable."
- :type 'regexp
+ :type '(choice (const :tag "Disable" nil)
+ regexp)
:group 'ffap)
(defvar ffap-url-regexp
diff --git a/lisp/files.el b/lisp/files.el
index 4188615e490..b67482a2f74 100644
--- a/lisp/files.el
+++ b/lisp/files.el
@@ -6068,14 +6068,18 @@ See `save-some-buffers' for PRED values."
(defvar save-some-buffers-functions nil
"Functions to be run by `save-some-buffers' after saving the buffers.
-The functions can be called in two \"modes\", depending on the
-first argument. If the first argument is `query', then the
+These functions should accept one mandatory and one optional
+argument, and they can be called in two \"modes\", depending on
+the first argument. If the first argument is `query', then the
function should return non-nil if there is something to be
saved (but it should not actually save anything).
If the first argument is something else, then the function should
save according to the value of the second argument, which is the
-ARG argument from `save-some-buffers'.")
+ARG argument with which `save-some-buffers' was called.
+
+The main purpose of these functions is to save stuff that is kept
+in variables (rather than in buffers).")
(defun save-some-buffers (&optional arg pred)
"Save some modified file-visiting buffers. Asks user about each one.
diff --git a/lisp/ido.el b/lisp/ido.el
index 00a2e57f7ba..041ed33aa99 100644
--- a/lisp/ido.el
+++ b/lisp/ido.el
@@ -864,7 +864,8 @@ also modify the dynamic variables described for the variable
(defcustom ido-completion-buffer "*Ido Completions*"
"Name of completion buffer used by Ido.
Set to nil to disable completion buffers popping up."
- :type 'string)
+ :type '(choice (const :tag "Disable popping up completion buffer" nil)
+ string))
(defcustom ido-completion-buffer-all-completions nil
"Non-nil means to show all completions in completion buffer.
diff --git a/lisp/image.el b/lisp/image.el
index 08190cf86bc..e20fbcf4c98 100644
--- a/lisp/image.el
+++ b/lisp/image.el
@@ -38,7 +38,7 @@
(defconst image-type-header-regexps
`(("\\`/[\t\n\r ]*\\*.*XPM.\\*/" . xpm)
("\\`P[1-6]\\(?:\
-\\(?:\\(?:#[^\r\n]*[\r\n]\\)*[[:space:]]\\)+\
+\\(?:\\(?:#[^\r\n]*[\r\n]\\)*[ \t\r\n]\\)+\
\\(?:\\(?:#[^\r\n]*[\r\n]\\)*[0-9]\\)+\
\\)\\{2\\}" . pbm)
("\\`GIF8[79]a" . gif)
diff --git a/lisp/org/ChangeLog.1 b/lisp/org/ChangeLog.1
index a4eae350d98..82b1c832c40 100644
--- a/lisp/org/ChangeLog.1
+++ b/lisp/org/ChangeLog.1
@@ -25932,7 +25932,7 @@
* org-latex.el (org-export-as-latex): Do nit require the buffer to
be visiting a file when only exporting to a buffer or string.
- (org-export-latex-fix-inputenc): Only save the buffer is there is
+ (org-export-latex-fix-inputenc): Only save the buffer if there is
a file name attached to it.
2010-04-10 Dan Davison <davison@stats.ox.ac.uk>
diff --git a/lisp/progmodes/csharp-mode.el b/lisp/progmodes/csharp-mode.el
index 866c802ca43..c550c9670c8 100644
--- a/lisp/progmodes/csharp-mode.el
+++ b/lisp/progmodes/csharp-mode.el
@@ -493,7 +493,7 @@ compilation and evaluation time conflicts."
;; Next non-whitespace character should be '{'
(goto-char (c-point 'boi))
(unless (eq (char-after) ?{)
- (backward-up-list 1 t t))
+ (ignore-errors (backward-up-list 1 t t)))
(save-excursion
;; 'new' should be part of the line
(goto-char (c-point 'iopl))
diff --git a/lisp/progmodes/perl-mode.el b/lisp/progmodes/perl-mode.el
index aa130966d75..040ef187e97 100644
--- a/lisp/progmodes/perl-mode.el
+++ b/lisp/progmodes/perl-mode.el
@@ -47,10 +47,6 @@
;; comment; move to end of line; create an empty comment; tell you that
;; the line ends in a quoted string, or has a # which should be a \#.
-;; If your machine is slow, you may want to remove some of the bindings
-;; to perl-electric-terminator. I changed the indenting defaults to be
-;; what Larry Wall uses in perl/lib, but left in all the options.
-
;; I also tuned a few things: comments and labels starting in column
;; zero are left there by perl-indent-exp; perl-beginning-of-function
;; goes back to the first open brace/paren in column zero, the open brace
diff --git a/lisp/subr.el b/lisp/subr.el
index 34d87e83310..6cedaffa806 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -6039,7 +6039,7 @@ by `find-word-boundary-function-table'. It is also not
interactive."
With argument ARG, do this that many times.
If ARG is omitted or nil, move point backward one word.
-This function is like `forward-word', but it is not affected
+This function is like `backward-word', but it is not affected
by `find-word-boundary-function-table'. It is also not interactive."
(let ((find-word-boundary-function-table
(if (char-table-p word-move-empty-char-table)
diff --git a/lisp/textmodes/ispell.el b/lisp/textmodes/ispell.el
index c73f92aa0b3..9bd1135c5be 100644
--- a/lisp/textmodes/ispell.el
+++ b/lisp/textmodes/ispell.el
@@ -2524,9 +2524,9 @@ this function signals an error."
(if lookup-dict
(unless (file-readable-p lookup-dict)
- (error "lookup-words error: Unreadable or missing plain word-list %s."
+ (error "ispell-lookup-words: Unreadable or missing plain word-list %s"
lookup-dict))
- (error (concat "lookup-words error: No plain word-list found at system"
+ (error (concat "ispell-lookup-words: No plain word-list found at system"
"default locations. "
"Customize `ispell-alternate-dictionary' to set yours.")))
diff --git a/lisp/textmodes/tex-mode.el b/lisp/textmodes/tex-mode.el
index 41c4a6a1373..a26e7b9c83a 100644
--- a/lisp/textmodes/tex-mode.el
+++ b/lisp/textmodes/tex-mode.el
@@ -2673,17 +2673,17 @@ This function is more useful than \\[tex-buffer] when
you need the
The last line of the buffer is displayed on
line LINE of the window, or centered if LINE is nil."
(interactive "P")
- (let ((tex-shell (get-buffer "*tex-shell*"))
- (window))
+ (let ((tex-shell (get-buffer "*tex-shell*")))
(if (null tex-shell)
(message "No TeX output buffer")
- (setq window (display-buffer tex-shell display-tex-shell-buffer-action))
- (with-selected-window window
- (bury-buffer tex-shell)
- (goto-char (point-max))
- (recenter (if linenum
- (prefix-numeric-value linenum)
- (/ (window-height) 2)))))))
+ (when-let ((window
+ (display-buffer tex-shell display-tex-shell-buffer-action)))
+ (with-selected-window window
+ (bury-buffer tex-shell)
+ (goto-char (point-max))
+ (recenter (if linenum
+ (prefix-numeric-value linenum)
+ (/ (window-height) 2))))))))
(defcustom tex-print-file-extension ".dvi"
"The TeX-compiled file extension for viewing and printing.
diff --git a/src/buffer.h b/src/buffer.h
index e71ffe28045..b2bd15657dc 100644
--- a/src/buffer.h
+++ b/src/buffer.h
@@ -656,9 +656,9 @@ struct buffer
ptrdiff_t last_window_start;
/* If the long line scan cache is enabled (i.e. the buffer-local
- variable cache-long-line-scans is non-nil), newline_cache
- points to the newline cache, and width_run_cache points to the
- width run cache.
+ variable cache-long-scans is non-nil), newline_cache points to
+ the newline cache, and width_run_cache points to the width run
+ cache.
The newline cache records which stretches of the buffer are
known *not* to contain newlines, so that they can be skipped
diff --git a/src/data.c b/src/data.c
index 7db9e70f7ad..afb0b14c576 100644
--- a/src/data.c
+++ b/src/data.c
@@ -886,7 +886,7 @@ add_to_function_history (Lisp_Object symbol, Lisp_Object
olddef)
Lisp_Object past = Fget (symbol, Qfunction_history);
Lisp_Object file = Qnil;
/* FIXME: Sadly, `Vload_file_name` gives less precise information
- (it's sometimes non-nil when it shoujld be nil). */
+ (it's sometimes non-nil when it should be nil). */
Lisp_Object tail = Vcurrent_load_list;
FOR_EACH_TAIL_SAFE (tail)
if (NILP (XCDR (tail)) && STRINGP (XCAR (tail)))
diff --git a/src/regex-emacs.c b/src/regex-emacs.c
index 7e75f0ac597..394ba22e9b0 100644
--- a/src/regex-emacs.c
+++ b/src/regex-emacs.c
@@ -3832,7 +3832,7 @@ mutually_exclusive_p (struct re_pattern_buffer *bufp,
re_char *p1,
EXTRACT_NUMBER_AND_INCR (mcnt, p2);
/* Don't just test `mcnt > 0` because non-greedy loops have
their test at the end with an unconditional jump at the start. */
- if (p2 + mcnt > p2_orig) /* Ensure forward progress. */
+ if (p2 > p2_orig && mcnt >= 0) /* Ensure forward progress. */
return (mutually_exclusive_p (bufp, p1, p2)
&& mutually_exclusive_p (bufp, p1, p2 + mcnt));
break;
diff --git a/test/src/regex-emacs-tests.el b/test/src/regex-emacs-tests.el
index 4e2c0f67a44..60c19f1ab2d 100644
--- a/test/src/regex-emacs-tests.el
+++ b/test/src/regex-emacs-tests.el
@@ -873,6 +873,7 @@ This evaluates the TESTS test cases from glibc."
(should (equal (string-match "\\`a\\{2\\}*\\'" "a") nil)))
(ert-deftest regexp-tests-backtrack-optimization () ;bug#61514
+ :expected-result :failed
;; Make sure we don't use up the regexp stack needlessly.
(with-current-buffer (get-buffer-create "*bug*")
(erase-buffer)
@@ -965,4 +966,8 @@ This evaluates the TESTS test cases from glibc."
(re-search-forward re nil t))
nil))))
+(ert-deftest regex-tests-mutual-exclusive-inf-rec ()
+ ;; Regression test for bug#65726, where this crashed Emacs.
+ (should (equal (string-match "a*\\(?:c\\|b*\\)*" "a") 0)))
+
;;; regex-emacs-tests.el ends here