mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2025-01-21 18:23:59 +00:00
Code Issues Releases Activity

Put doc strings in comments.

Browse Source
This commit is contained in:
Gerd Moellmann 2001-10-14 09:40:40 +00:00
parent 79c2a4fc68
commit c061c855c8
2 changed files with 296 additions and 286 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/ChangeLog
View File

@ -1,3 +1,7 @@
2001-10-14 Gerd Moellmann <gerd@gnu.org>
* xfns.c: Put doc strings in comments.
2001-10-13 Gerd Moellmann <gerd@gnu.org> 2001-10-13 Gerd Moellmann <gerd@gnu.org>
* lisp.h (DEFUN, DEFVAR_LISP, ...) [DOC_STRINGS_IN_COMMENTS]: * lisp.h (DEFUN, DEFVAR_LISP, ...) [DOC_STRINGS_IN_COMMENTS]:

578
src/xfns.c
View File

@ -19,6 +19,8 @@ along with GNU Emacs; see the file COPYING. If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330, the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA. */ Boston, MA 02111-1307, USA. */
#define DOC_STRINGS_IN_COMMENTS
#include <config.h> #include <config.h>
#include <signal.h> #include <signal.h>
#include <stdio.h> #include <stdio.h>
@ -2639,16 +2641,16 @@ validate_x_resource_name ()
extern char *x_get_string_resource (); extern char *x_get_string_resource ();
DEFUN ("x-get-resource", Fx_get_resource, Sx_get_resource, 2, 4, 0, DEFUN ("x-get-resource", Fx_get_resource, Sx_get_resource, 2, 4, 0,
"Return the value of ATTRIBUTE, of class CLASS, from the X defaults database.\n\ /* Return the value of ATTRIBUTE, of class CLASS, from the X defaults database.
This uses `INSTANCE.ATTRIBUTE' as the key and `Emacs.CLASS' as the\n\ This uses `INSTANCE.ATTRIBUTE' as the key and `Emacs.CLASS' as the
class, where INSTANCE is the name under which Emacs was invoked, or\n\ class, where INSTANCE is the name under which Emacs was invoked, or
the name specified by the `-name' or `-rn' command-line arguments.\n\ the name specified by the `-name' or `-rn' command-line arguments.
\n\
The optional arguments COMPONENT and SUBCLASS add to the key and the\n\ The optional arguments COMPONENT and SUBCLASS add to the key and the
class, respectively. You must specify both of them or neither.\n\ class, respectively. You must specify both of them or neither.
If you specify them, the key is `INSTANCE.COMPONENT.ATTRIBUTE'\n\ If you specify them, the key is `INSTANCE.COMPONENT.ATTRIBUTE'
and the class is `Emacs.CLASS.SUBCLASS'.") and the class is `Emacs.CLASS.SUBCLASS'. */
(attribute, class, component, subclass) (attribute, class, component, subclass))
Lisp_Object attribute, class, component, subclass; Lisp_Object attribute, class, component, subclass;
{ {
register char *value; register char *value;
@ -2997,13 +2999,13 @@ x_default_scroll_bar_color_parameter (f, alist, prop, xprop, xclass,
DEFUN ("x-parse-geometry", Fx_parse_geometry, Sx_parse_geometry, 1, 1, 0, DEFUN ("x-parse-geometry", Fx_parse_geometry, Sx_parse_geometry, 1, 1, 0,
"Parse an X-style geometry string STRING.\n\ /* Parse an X-style geometry string STRING.
Returns an alist of the form ((top . TOP), (left . LEFT) ... ).\n\ Returns an alist of the form ((top . TOP), (left . LEFT) ... ).
The properties returned may include `top', `left', `height', and `width'.\n\ The properties returned may include `top', `left', `height', and `width'.
The value of `left' or `top' may be an integer,\n\ The value of `left' or `top' may be an integer,
or a list (+ N) meaning N pixels relative to top/left corner,\n\ or a list (+ N) meaning N pixels relative to top/left corner,
or a list (- N) meaning -N pixels relative to bottom/right corner.") or a list (- N) meaning -N pixels relative to bottom/right corner. */
(string) (string))
Lisp_Object string; Lisp_Object string;
{ {
int geometry, x, y; int geometry, x, y;
@ -4090,16 +4092,16 @@ unwind_create_frame (frame)
DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame, DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
1, 1, 0, 1, 1, 0,
"Make a new X window, which is called a \"frame\" in Emacs terms.\n\ /* Make a new X window, which is called a "frame" in Emacs terms.
Returns an Emacs frame object.\n\ Returns an Emacs frame object.
ALIST is an alist of frame parameters.\n\ ALIST is an alist of frame parameters.
If the parameters specify that the frame should not have a minibuffer,\n\ If the parameters specify that the frame should not have a minibuffer,
and do not specify a specific minibuffer window to use,\n\ and do not specify a specific minibuffer window to use,
then `default-minibuffer-frame' must be a frame whose minibuffer can\n\ then `default-minibuffer-frame' must be a frame whose minibuffer can
be shared by the new frame.\n\ be shared by the new frame.
\n\
This function is an internal primitive--use `make-frame' instead.") This function is an internal primitive--use `make-frame' instead. */
(parms) (parms))
Lisp_Object parms; Lisp_Object parms;
{ {
struct frame *f; struct frame *f;
@ -4553,9 +4555,9 @@ x_get_focus_frame (frame)
following a user-command. */ following a user-command. */
DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0, DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
"Set the input focus to FRAME.\n\ /* Set the input focus to FRAME.
FRAME nil means use the selected frame.") FRAME nil means use the selected frame. */
(frame) (frame))
Lisp_Object frame; Lisp_Object frame;
{ {
struct frame *f = check_x_frame (frame); struct frame *f = check_x_frame (frame);
@ -4574,8 +4576,8 @@ FRAME nil means use the selected frame.")
DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0, DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
"Internal function called by `color-defined-p', which see.") /* Internal function called by `color-defined-p', which see. */
(color, frame) (color, frame))
Lisp_Object color, frame; Lisp_Object color, frame;
{ {
XColor foo; XColor foo;
@ -4590,8 +4592,8 @@ DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
} }
DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0, DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
"Internal function called by `color-values', which see.") /* Internal function called by `color-values', which see. */
(color, frame) (color, frame))
Lisp_Object color, frame; Lisp_Object color, frame;
{ {
XColor foo; XColor foo;
@ -4613,8 +4615,8 @@ DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
} }
DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0, DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
"Internal function called by `display-color-p', which see.") /* Internal function called by `display-color-p', which see. */
(display) (display))
Lisp_Object display; Lisp_Object display;
{ {
struct x_display_info *dpyinfo = check_x_display_info (display); struct x_display_info *dpyinfo = check_x_display_info (display);
@ -4636,13 +4638,13 @@ DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
} }
DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p, DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p, Sx_display_grayscale_p,
0, 1, 0, 0, 1, 0,
"Return t if the X display supports shades of gray.\n\ /* Return t if the X display supports shades of gray.
Note that color displays do support shades of gray.\n\ Note that color displays do support shades of gray.
The optional argument DISPLAY specifies which display to ask about.\n\ The optional argument DISPLAY specifies which display to ask about.
DISPLAY should be either a frame or a display name (a string).\n\ DISPLAY should be either a frame or a display name (a string).
If omitted or nil, that stands for the selected frame's display.") If omitted or nil, that stands for the selected frame's display. */
(display) (display))
Lisp_Object display; Lisp_Object display;
{ {
struct x_display_info *dpyinfo = check_x_display_info (display); struct x_display_info *dpyinfo = check_x_display_info (display);
@ -4666,12 +4668,12 @@ If omitted or nil, that stands for the selected frame's display.")
} }
DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width, DEFUN ("x-display-pixel-width", Fx_display_pixel_width, Sx_display_pixel_width,
0, 1, 0, 0, 1, 0,
"Returns the width in pixels of the X display DISPLAY.\n\ /* Returns the width in pixels of the X display DISPLAY.
The optional argument DISPLAY specifies which display to ask about.\n\ The optional argument DISPLAY specifies which display to ask about.
DISPLAY should be either a frame or a display name (a string).\n\ DISPLAY should be either a frame or a display name (a string).
If omitted or nil, that stands for the selected frame's display.") If omitted or nil, that stands for the selected frame's display. */
(display) (display))
Lisp_Object display; Lisp_Object display;
{ {
struct x_display_info *dpyinfo = check_x_display_info (display); struct x_display_info *dpyinfo = check_x_display_info (display);
@ -4680,12 +4682,12 @@ If omitted or nil, that stands for the selected frame's display.")
} }
DEFUN ("x-display-pixel-height", Fx_display_pixel_height, DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
Sx_display_pixel_height, 0, 1, 0, Sx_display_pixel_height, 0, 1, 0,
"Returns the height in pixels of the X display DISPLAY.\n\ /* Returns the height in pixels of the X display DISPLAY.
The optional argument DISPLAY specifies which display to ask about.\n\ The optional argument DISPLAY specifies which display to ask about.
DISPLAY should be either a frame or a display name (a string).\n\ DISPLAY should be either a frame or a display name (a string).
If omitted or nil, that stands for the selected frame's display.") If omitted or nil, that stands for the selected frame's display. */
(display) (display))
Lisp_Object display; Lisp_Object display;
{ {
struct x_display_info *dpyinfo = check_x_display_info (display); struct x_display_info *dpyinfo = check_x_display_info (display);
@ -4694,12 +4696,12 @@ If omitted or nil, that stands for the selected frame's display.")
} }
DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes, DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
0, 1, 0, 0, 1, 0,
"Returns the number of bitplanes of the X display DISPLAY.\n\ /* Returns the number of bitplanes of the X display DISPLAY.
The optional argument DISPLAY specifies which display to ask about.\n\ The optional argument DISPLAY specifies which display to ask about.
DISPLAY should be either a frame or a display name (a string).\n\ DISPLAY should be either a frame or a display name (a string).
If omitted or nil, that stands for the selected frame's display.") If omitted or nil, that stands for the selected frame's display. */
(display) (display))
Lisp_Object display; Lisp_Object display;
{ {
struct x_display_info *dpyinfo = check_x_display_info (display); struct x_display_info *dpyinfo = check_x_display_info (display);
@ -4708,12 +4710,12 @@ If omitted or nil, that stands for the selected frame's display.")
} }
DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells, DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
0, 1, 0, 0, 1, 0,
"Returns the number of color cells of the X display DISPLAY.\n\ /* Returns the number of color cells of the X display DISPLAY.
The optional argument DISPLAY specifies which display to ask about.\n\ The optional argument DISPLAY specifies which display to ask about.
DISPLAY should be either a frame or a display name (a string).\n\ DISPLAY should be either a frame or a display name (a string).
If omitted or nil, that stands for the selected frame's display.") If omitted or nil, that stands for the selected frame's display. */
(display) (display))
Lisp_Object display; Lisp_Object display;
{ {
struct x_display_info *dpyinfo = check_x_display_info (display); struct x_display_info *dpyinfo = check_x_display_info (display);
@ -4724,12 +4726,12 @@ If omitted or nil, that stands for the selected frame's display.")
DEFUN ("x-server-max-request-size", Fx_server_max_request_size, DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
Sx_server_max_request_size, Sx_server_max_request_size,
0, 1, 0, 0, 1, 0,
"Returns the maximum request size of the X server of display DISPLAY.\n\ /* Returns the maximum request size of the X server of display DISPLAY.
The optional argument DISPLAY specifies which display to ask about.\n\ The optional argument DISPLAY specifies which display to ask about.
DISPLAY should be either a frame or a display name (a string).\n\ DISPLAY should be either a frame or a display name (a string).
If omitted or nil, that stands for the selected frame's display.") If omitted or nil, that stands for the selected frame's display. */
(display) (display))
Lisp_Object display; Lisp_Object display;
{ {
struct x_display_info *dpyinfo = check_x_display_info (display); struct x_display_info *dpyinfo = check_x_display_info (display);
@ -4738,11 +4740,11 @@ If omitted or nil, that stands for the selected frame's display.")
} }
DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0, DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
"Returns the vendor ID string of the X server of display DISPLAY.\n\ /* Returns the vendor ID string of the X server of display DISPLAY.
The optional argument DISPLAY specifies which display to ask about.\n\ The optional argument DISPLAY specifies which display to ask about.
DISPLAY should be either a frame or a display name (a string).\n\ DISPLAY should be either a frame or a display name (a string).
If omitted or nil, that stands for the selected frame's display.") If omitted or nil, that stands for the selected frame's display. */
(display) (display))
Lisp_Object display; Lisp_Object display;
{ {
struct x_display_info *dpyinfo = check_x_display_info (display); struct x_display_info *dpyinfo = check_x_display_info (display);
@ -4753,14 +4755,15 @@ If omitted or nil, that stands for the selected frame's display.")
} }
DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0, DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
"Returns the version numbers of the X server of display DISPLAY.\n\ /* Returns the version numbers of the X server of display DISPLAY.
The value is a list of three integers: the major and minor\n\ The value is a list of three integers: the major and minor
version numbers of the X Protocol in use, and the vendor-specific release\n\ version numbers of the X Protocol in use, and the vendor-specific release
number. See also the function `x-server-vendor'.\n\n\ number. See also the function `x-server-vendor'.
The optional argument DISPLAY specifies which display to ask about.\n\
DISPLAY should be either a frame or a display name (a string).\n\ The optional argument DISPLAY specifies which display to ask about.
If omitted or nil, that stands for the selected frame's display.") DISPLAY should be either a frame or a display name (a string).
(display) If omitted or nil, that stands for the selected frame's display. */
(display))
Lisp_Object display; Lisp_Object display;
{ {
struct x_display_info *dpyinfo = check_x_display_info (display); struct x_display_info *dpyinfo = check_x_display_info (display);
@ -4772,11 +4775,11 @@ If omitted or nil, that stands for the selected frame's display.")
} }
DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0, DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
"Returns the number of screens on the X server of display DISPLAY.\n\ /* Return the number of screens on the X server of display DISPLAY.
The optional argument DISPLAY specifies which display to ask about.\n\ The optional argument DISPLAY specifies which display to ask about.
DISPLAY should be either a frame or a display name (a string).\n\ DISPLAY should be either a frame or a display name (a string).
If omitted or nil, that stands for the selected frame's display.") If omitted or nil, that stands for the selected frame's display. */
(display) (display))
Lisp_Object display; Lisp_Object display;
{ {
struct x_display_info *dpyinfo = check_x_display_info (display); struct x_display_info *dpyinfo = check_x_display_info (display);
@ -4785,11 +4788,11 @@ If omitted or nil, that stands for the selected frame's display.")
} }
DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0, DEFUN ("x-display-mm-height", Fx_display_mm_height, Sx_display_mm_height, 0, 1, 0,
"Returns the height in millimeters of the X display DISPLAY.\n\ /* Return the height in millimeters of the X display DISPLAY.
The optional argument DISPLAY specifies which display to ask about.\n\ The optional argument DISPLAY specifies which display to ask about.
DISPLAY should be either a frame or a display name (a string).\n\ DISPLAY should be either a frame or a display name (a string).
If omitted or nil, that stands for the selected frame's display.") If omitted or nil, that stands for the selected frame's display. */
(display) (display))
Lisp_Object display; Lisp_Object display;
{ {
struct x_display_info *dpyinfo = check_x_display_info (display); struct x_display_info *dpyinfo = check_x_display_info (display);
@ -4798,11 +4801,11 @@ If omitted or nil, that stands for the selected frame's display.")
} }
DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0, DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
"Returns the width in millimeters of the X display DISPLAY.\n\ /* Return the width in millimeters of the X display DISPLAY.
The optional argument DISPLAY specifies which display to ask about.\n\ The optional argument DISPLAY specifies which display to ask about.
DISPLAY should be either a frame or a display name (a string).\n\ DISPLAY should be either a frame or a display name (a string).
If omitted or nil, that stands for the selected frame's display.") If omitted or nil, that stands for the selected frame's display. */
(display) (display))
Lisp_Object display; Lisp_Object display;
{ {
struct x_display_info *dpyinfo = check_x_display_info (display); struct x_display_info *dpyinfo = check_x_display_info (display);
@ -4811,13 +4814,13 @@ If omitted or nil, that stands for the selected frame's display.")
} }
DEFUN ("x-display-backing-store", Fx_display_backing_store, DEFUN ("x-display-backing-store", Fx_display_backing_store,
Sx_display_backing_store, 0, 1, 0, Sx_display_backing_store, 0, 1, 0,
"Returns an indication of whether X display DISPLAY does backing store.\n\ /* Returns an indication of whether X display DISPLAY does backing store.
The value may be `always', `when-mapped', or `not-useful'.\n\ The value may be `always', `when-mapped', or `not-useful'.
The optional argument DISPLAY specifies which display to ask about.\n\ The optional argument DISPLAY specifies which display to ask about.
DISPLAY should be either a frame or a display name (a string).\n\ DISPLAY should be either a frame or a display name (a string).
If omitted or nil, that stands for the selected frame's display.") If omitted or nil, that stands for the selected frame's display. */
(display) (display))
Lisp_Object display; Lisp_Object display;
{ {
struct x_display_info *dpyinfo = check_x_display_info (display); struct x_display_info *dpyinfo = check_x_display_info (display);
@ -4846,14 +4849,15 @@ If omitted or nil, that stands for the selected frame's display.")
} }
DEFUN ("x-display-visual-class", Fx_display_visual_class, DEFUN ("x-display-visual-class", Fx_display_visual_class,
Sx_display_visual_class, 0, 1, 0, Sx_display_visual_class, 0, 1, 0,
"Returns the visual class of the X display DISPLAY.\n\ /* Return the visual class of the X display DISPLAY.
The value is one of the symbols `static-gray', `gray-scale',\n\ The value is one of the symbols `static-gray', `gray-scale',
`static-color', `pseudo-color', `true-color', or `direct-color'.\n\n\ `static-color', `pseudo-color', `true-color', or `direct-color'.
The optional argument DISPLAY specifies which display to ask about.\n\
DISPLAY should be either a frame or a display name (a string).\n\ The optional argument DISPLAY specifies which display to ask about.
If omitted or nil, that stands for the selected frame's display.") DISPLAY should be either a frame or a display name (a string).
(display) If omitted or nil, that stands for the selected frame's display. */
(display))
Lisp_Object display; Lisp_Object display;
{ {
struct x_display_info *dpyinfo = check_x_display_info (display); struct x_display_info *dpyinfo = check_x_display_info (display);
@ -4888,12 +4892,12 @@ If omitted or nil, that stands for the selected frame's display.")
} }
DEFUN ("x-display-save-under", Fx_display_save_under, DEFUN ("x-display-save-under", Fx_display_save_under,
Sx_display_save_under, 0, 1, 0, Sx_display_save_under, 0, 1, 0,
"Returns t if the X display DISPLAY supports the save-under feature.\n\ /* Returns t if the X display DISPLAY supports the save-under feature.
The optional argument DISPLAY specifies which display to ask about.\n\ The optional argument DISPLAY specifies which display to ask about.
DISPLAY should be either a frame or a display name (a string).\n\ DISPLAY should be either a frame or a display name (a string).
If omitted or nil, that stands for the selected frame's display.") If omitted or nil, that stands for the selected frame's display. */
(display) (display))
Lisp_Object display; Lisp_Object display;
{ {
struct x_display_info *dpyinfo = check_x_display_info (display); struct x_display_info *dpyinfo = check_x_display_info (display);
@ -5109,12 +5113,13 @@ x_display_info_for_name (name)
DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection, DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
1, 3, 0, "Open a connection to an X server.\n\ 1, 3, 0,
DISPLAY is the name of the display to connect to.\n\ /* Open a connection to an X server.
Optional second arg XRM-STRING is a string of resources in xrdb format.\n\ DISPLAY is the name of the display to connect to.
If the optional third arg MUST-SUCCEED is non-nil,\n\ Optional second arg XRM-STRING is a string of resources in xrdb format.
terminate Emacs if we can't open the connection.") If the optional third arg MUST-SUCCEED is non-nil,
(display, xrm_string, must_succeed) terminate Emacs if we can't open the connection. */
(display, xrm_string, must_succeed))
Lisp_Object display, xrm_string, must_succeed; Lisp_Object display, xrm_string, must_succeed;
{ {
unsigned char *xrm_option; unsigned char *xrm_option;
@ -5142,9 +5147,9 @@ terminate Emacs if we can't open the connection.")
if (dpyinfo == 0) if (dpyinfo == 0)
{ {
if (!NILP (must_succeed)) if (!NILP (must_succeed))
fatal ("Cannot connect to X server %s.\n\ fatal ("Cannot connect to X server %s.
Check the DISPLAY environment variable or use `-d'.\n\ Check the DISPLAY environment variable or use `-d'.
Also use the `xhost' program to verify that it is set to permit\n\ Also use the `xhost' program to verify that it is set to permit
connections from your machine.\n", connections from your machine.\n",
XSTRING (display)->data); XSTRING (display)->data);
else else
@ -5159,11 +5164,11 @@ connections from your machine.\n",
DEFUN ("x-close-connection", Fx_close_connection, DEFUN ("x-close-connection", Fx_close_connection,
Sx_close_connection, 1, 1, 0, Sx_close_connection, 1, 1, 0,
"Close the connection to DISPLAY's X server.\n\ /* Close the connection to DISPLAY's X server.
For DISPLAY, specify either a frame or a display name (a string).\n\ For DISPLAY, specify either a frame or a display name (a string).
If DISPLAY is nil, that stands for the selected frame's display.") If DISPLAY is nil, that stands for the selected frame's display. */
(display) (display))
Lisp_Object display; Lisp_Object display;
{ {
struct x_display_info *dpyinfo = check_x_display_info (display); struct x_display_info *dpyinfo = check_x_display_info (display);
int i; int i;
@ -5198,8 +5203,8 @@ If DISPLAY is nil, that stands for the selected frame's display.")
} }
DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0, DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
"Return the list of display names that Emacs has connections to.") /* Return the list of display names that Emacs has connections to. */
() ())
{ {
Lisp_Object tail, result; Lisp_Object tail, result;
@ -5211,15 +5216,15 @@ DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
} }
DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0, DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
"If ON is non-nil, report X errors as soon as the erring request is made.\n\ /* If ON is non-nil, report X errors as soon as the erring request is made.
If ON is nil, allow buffering of requests.\n\ If ON is nil, allow buffering of requests.
Turning on synchronization prohibits the Xlib routines from buffering\n\ Turning on synchronization prohibits the Xlib routines from buffering
requests and seriously degrades performance, but makes debugging much\n\ requests and seriously degrades performance, but makes debugging much
easier.\n\ easier.
The optional second argument DISPLAY specifies which display to act on.\n\ The optional second argument DISPLAY specifies which display to act on.
DISPLAY should be either a frame or a display name (a string).\n\ DISPLAY should be either a frame or a display name (a string).
If DISPLAY is omitted or nil, that stands for the selected frame's display.") If DISPLAY is omitted or nil, that stands for the selected frame's display. */
(on, display) (on, display))
Lisp_Object display, on; Lisp_Object display, on;
{ {
struct x_display_info *dpyinfo = check_x_display_info (display); struct x_display_info *dpyinfo = check_x_display_info (display);
@ -5598,12 +5603,12 @@ image_spec_value (spec, key, found)
DEFUN ("image-size", Fimage_size, Simage_size, 1, 3, 0, DEFUN ("image-size", Fimage_size, Simage_size, 1, 3, 0,
"Return the size of image SPEC as pair (WIDTH . HEIGHT).\n\ /* Return the size of image SPEC as pair (WIDTH . HEIGHT).
PIXELS non-nil means return the size in pixels, otherwise return the\n\ PIXELS non-nil means return the size in pixels, otherwise return the
size in canonical character units.\n\ size in canonical character units.
FRAME is the frame on which the image will be displayed. FRAME nil\n\ FRAME is the frame on which the image will be displayed. FRAME nil
or omitted means use the selected frame.") or omitted means use the selected frame. */
(spec, pixels, frame) (spec, pixels, frame))
Lisp_Object spec, pixels, frame; Lisp_Object spec, pixels, frame;
{ {
Lisp_Object size; Lisp_Object size;
@ -5631,10 +5636,10 @@ or omitted means use the selected frame.")
DEFUN ("image-mask-p", Fimage_mask_p, Simage_mask_p, 1, 2, 0, DEFUN ("image-mask-p", Fimage_mask_p, Simage_mask_p, 1, 2, 0,
"Return t if image SPEC has a mask bitmap.\n\ /* Return t if image SPEC has a mask bitmap.
FRAME is the frame on which the image will be displayed. FRAME nil\n\ FRAME is the frame on which the image will be displayed. FRAME nil
or omitted means use the selected frame.") or omitted means use the selected frame. */
(spec, frame) (spec, frame))
Lisp_Object spec, frame; Lisp_Object spec, frame;
{ {
Lisp_Object mask; Lisp_Object mask;
@ -5977,10 +5982,10 @@ clear_image_cache (f, force_p)
DEFUN ("clear-image-cache", Fclear_image_cache, Sclear_image_cache, DEFUN ("clear-image-cache", Fclear_image_cache, Sclear_image_cache,
0, 1, 0, 0, 1, 0,
"Clear the image cache of FRAME.\n\ /* Clear the image cache of FRAME.
FRAME nil or omitted means use the selected frame.\n\ FRAME nil or omitted means use the selected frame.
FRAME t means clear the image caches of all frames.") FRAME t means clear the image caches of all frames. */
(frame) (frame))
Lisp_Object frame; Lisp_Object frame;
{ {
if (EQ (frame, Qt)) if (EQ (frame, Qt))
@ -10242,10 +10247,10 @@ x_kill_gs_process (pixmap, f)
DEFUN ("x-change-window-property", Fx_change_window_property, DEFUN ("x-change-window-property", Fx_change_window_property,
Sx_change_window_property, 2, 3, 0, Sx_change_window_property, 2, 3, 0,
"Change window property PROP to VALUE on the X window of FRAME.\n\ /* Change window property PROP to VALUE on the X window of FRAME.
PROP and VALUE must be strings. FRAME nil or omitted means use the\n\ PROP and VALUE must be strings. FRAME nil or omitted means use the
selected frame. Value is VALUE.") selected frame. Value is VALUE. */
(prop, value, frame) (prop, value, frame))
Lisp_Object frame, prop, value; Lisp_Object frame, prop, value;
{ {
struct frame *f = check_x_frame (frame); struct frame *f = check_x_frame (frame);
@ -10270,9 +10275,9 @@ selected frame. Value is VALUE.")
DEFUN ("x-delete-window-property", Fx_delete_window_property, DEFUN ("x-delete-window-property", Fx_delete_window_property,
Sx_delete_window_property, 1, 2, 0, Sx_delete_window_property, 1, 2, 0,
"Remove window property PROP from X window of FRAME.\n\ /* Remove window property PROP from X window of FRAME.
FRAME nil or omitted means use the selected frame. Value is PROP.") FRAME nil or omitted means use the selected frame. Value is PROP. */
(prop, frame) (prop, frame))
Lisp_Object prop, frame; Lisp_Object prop, frame;
{ {
struct frame *f = check_x_frame (frame); struct frame *f = check_x_frame (frame);
@ -10293,11 +10298,11 @@ FRAME nil or omitted means use the selected frame. Value is PROP.")
DEFUN ("x-window-property", Fx_window_property, Sx_window_property, DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
1, 2, 0, 1, 2, 0,
"Value is the value of window property PROP on FRAME.\n\ /* Value is the value of window property PROP on FRAME.
If FRAME is nil or omitted, use the selected frame. Value is nil\n\ If FRAME is nil or omitted, use the selected frame. Value is nil
if FRAME hasn't a property with name PROP or if PROP has no string\n\ if FRAME hasn't a property with name PROP or if PROP has no string
value.") value. */
(prop, frame) (prop, frame))
Lisp_Object prop, frame; Lisp_Object prop, frame;
{ {
struct frame *f = check_x_frame (frame); struct frame *f = check_x_frame (frame);
@ -10936,28 +10941,28 @@ compute_tip_xy (f, parms, dx, dy, width, height, root_x, root_y)
DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0, DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
"Show STRING in a \"tooltip\" window on frame FRAME.\n\ /* Show STRING in a "tooltip" window on frame FRAME.
A tooltip window is a small X window displaying a string.\n\ A tooltip window is a small X window displaying a string.
\n\
FRAME nil or omitted means use the selected frame.\n\ FRAME nil or omitted means use the selected frame.
\n\
PARMS is an optional list of frame parameters which can be\n\ PARMS is an optional list of frame parameters which can be used to
used to change the tooltip's appearance.\n\ change the tooltip's appearance.
\n\
Automatically hide the tooltip after TIMEOUT seconds.\n\ Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
TIMEOUT nil means use the default timeout of 5 seconds.\n\ means use the default timeout of 5 seconds.
\n\
If the list of frame parameters PARAMS contains a `left' parameters,\n\ If the list of frame parameters PARAMS contains a `left' parameters,
the tooltip is displayed at that x-position. Otherwise it is\n\ the tooltip is displayed at that x-position. Otherwise it is
displayed at the mouse position, with offset DX added (default is 5 if\n\ displayed at the mouse position, with offset DX added (default is 5 if
DX isn't specified). Likewise for the y-position; if a `top' frame\n\ DX isn't specified). Likewise for the y-position; if a `top' frame
parameter is specified, it determines the y-position of the tooltip\n\ parameter is specified, it determines the y-position of the tooltip
window, otherwise it is displayed at the mouse position, with offset\n\ window, otherwise it is displayed at the mouse position, with offset
DY added (default is -10).\n\ DY added (default is -10).
\n\
A tooltip's maximum size is specified by `x-max-tooltip-size'.\n\ A tooltip's maximum size is specified by `x-max-tooltip-size'.
Text larger than the specified size is clipped.") Text larger than the specified size is clipped. */
(string, frame, parms, timeout, dx, dy) (string, frame, parms, timeout, dx, dy))
Lisp_Object string, frame, parms, timeout, dx, dy; Lisp_Object string, frame, parms, timeout, dx, dy;
{ {
struct frame *f; struct frame *f;
@ -11145,9 +11150,9 @@ Text larger than the specified size is clipped.")
DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0, DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
"Hide the current tooltip window, if there is any.\n\ /* Hide the current tooltip window, if there is any.
Value is t if tooltip was open, nil otherwise.") Value is t if tooltip was open, nil otherwise. */
() ())
{ {
int count; int count;
Lisp_Object deleted, frame, timer; Lisp_Object deleted, frame, timer;
@ -11235,12 +11240,12 @@ file_dialog_unmap_cb (widget, client_data, call_data)
DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 4, 0, DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 4, 0,
"Read file name, prompting with PROMPT in directory DIR.\n\ /* Read file name, prompting with PROMPT in directory DIR.
Use a file selection dialog.\n\ Use a file selection dialog.
Select DEFAULT-FILENAME in the dialog's file selection box, if\n\ Select DEFAULT-FILENAME in the dialog's file selection box, if
specified. Don't let the user enter a file name in the file\n\ specified. Don't let the user enter a file name in the file
selection dialog's entry field, if MUSTMATCH is non-nil.") selection dialog's entry field, if MUSTMATCH is non-nil. */
(prompt, dir, default_filename, mustmatch) (prompt, dir, default_filename, mustmatch))
Lisp_Object prompt, dir, default_filename, mustmatch; Lisp_Object prompt, dir, default_filename, mustmatch;
{ {
int result; int result;
@ -11393,11 +11398,11 @@ selection dialog's entry field, if MUSTMATCH is non-nil.")
DEFUN ("x-backspace-delete-keys-p", Fx_backspace_delete_keys_p, DEFUN ("x-backspace-delete-keys-p", Fx_backspace_delete_keys_p,
Sx_backspace_delete_keys_p, 0, 1, 0, Sx_backspace_delete_keys_p, 0, 1, 0,
"Check if both Backspace and Delete keys are on the keyboard of FRAME.\n\ /* Check if both Backspace and Delete keys are on the keyboard of FRAME.
FRAME nil means use the selected frame.\n\ FRAME nil means use the selected frame.
Value is t if we know that both keys are present, and are mapped to the\n\ Value is t if we know that both keys are present, and are mapped to the
usual X keysyms.") usual X keysyms. */
(frame) (frame))
Lisp_Object frame; Lisp_Object frame;
{ {
#ifdef HAVE_XKBGETKEYBOARD #ifdef HAVE_XKBGETKEYBOARD
@ -11590,122 +11595,123 @@ syms_of_xfns ()
init_x_parm_symbols (); init_x_parm_symbols ();
DEFVAR_BOOL ("cross-disabled-images", &cross_disabled_images, DEFVAR_BOOL ("cross-disabled-images", &cross_disabled_images
"Non-nil means always draw a cross over disabled images.\n\ /* Non-nil means always draw a cross over disabled images.
Disabled images are those having an `:conversion disabled' property.\n\ Disabled images are those having an `:conversion disabled' property.
A cross is always drawn on black & white displays."); A cross is always drawn on black & white displays. */);
cross_disabled_images = 0; cross_disabled_images = 0;
DEFVAR_LISP ("x-bitmap-file-path", &Vx_bitmap_file_path, DEFVAR_LISP ("x-bitmap-file-path", &Vx_bitmap_file_path
"List of directories to search for bitmap files for X."); /* List of directories to search for bitmap files for X. */);
Vx_bitmap_file_path = decode_env_path ((char *) 0, PATH_BITMAPS); Vx_bitmap_file_path = decode_env_path ((char *) 0, PATH_BITMAPS);
DEFVAR_LISP ("x-pointer-shape", &Vx_pointer_shape, DEFVAR_LISP ("x-pointer-shape", &Vx_pointer_shape
"The shape of the pointer when over text.\n\ /* The shape of the pointer when over text.
Changing the value does not affect existing frames\n\ Changing the value does not affect existing frames
unless you set the mouse color."); unless you set the mouse color. */);
Vx_pointer_shape = Qnil; Vx_pointer_shape = Qnil;
DEFVAR_LISP ("x-resource-name", &Vx_resource_name, DEFVAR_LISP ("x-resource-name", &Vx_resource_name
"The name Emacs uses to look up X resources.\n\ /* The name Emacs uses to look up X resources.
`x-get-resource' uses this as the first component of the instance name\n\ `x-get-resource' uses this as the first component of the instance name
when requesting resource values.\n\ when requesting resource values.
Emacs initially sets `x-resource-name' to the name under which Emacs\n\ Emacs initially sets `x-resource-name' to the name under which Emacs
was invoked, or to the value specified with the `-name' or `-rn'\n\ was invoked, or to the value specified with the `-name' or `-rn'
switches, if present.\n\ switches, if present.
\n\
It may be useful to bind this variable locally around a call\n\ It may be useful to bind this variable locally around a call
to `x-get-resource'. See also the variable `x-resource-class'."); to `x-get-resource'. See also the variable `x-resource-class'. */);
Vx_resource_name = Qnil; Vx_resource_name = Qnil;
DEFVAR_LISP ("x-resource-class", &Vx_resource_class, DEFVAR_LISP ("x-resource-class", &Vx_resource_class
"The class Emacs uses to look up X resources.\n\ /* The class Emacs uses to look up X resources.
`x-get-resource' uses this as the first component of the instance class\n\ `x-get-resource' uses this as the first component of the instance class
when requesting resource values.\n\ when requesting resource values.
Emacs initially sets `x-resource-class' to \"Emacs\".\n\
\n\ Emacs initially sets `x-resource-class' to "Emacs".
Setting this variable permanently is not a reasonable thing to do,\n\
but binding this variable locally around a call to `x-get-resource'\n\ Setting this variable permanently is not a reasonable thing to do,
is a reasonable practice. See also the variable `x-resource-name'."); but binding this variable locally around a call to `x-get-resource'
is a reasonable practice. See also the variable `x-resource-name'. */);
Vx_resource_class = build_string (EMACS_CLASS); Vx_resource_class = build_string (EMACS_CLASS);
#if 0 /* This doesn't really do anything. */ #if 0 /* This doesn't really do anything. */
DEFVAR_LISP ("x-nontext-pointer-shape", &Vx_nontext_pointer_shape, DEFVAR_LISP ("x-nontext-pointer-shape", &Vx_nontext_pointer_shape
"The shape of the pointer when not over text.\n\ /* The shape of the pointer when not over text.
This variable takes effect when you create a new frame\n\ This variable takes effect when you create a new frame
or when you set the mouse color."); or when you set the mouse color. */);
#endif #endif
Vx_nontext_pointer_shape = Qnil; Vx_nontext_pointer_shape = Qnil;
DEFVAR_LISP ("x-hourglass-pointer-shape", &Vx_hourglass_pointer_shape, DEFVAR_LISP ("x-hourglass-pointer-shape", &Vx_hourglass_pointer_shape
"The shape of the pointer when Emacs is busy.\n\ /* The shape of the pointer when Emacs is busy.
This variable takes effect when you create a new frame\n\ This variable takes effect when you create a new frame
or when you set the mouse color."); or when you set the mouse color. */);
Vx_hourglass_pointer_shape = Qnil; Vx_hourglass_pointer_shape = Qnil;
DEFVAR_BOOL ("display-hourglass", &display_hourglass_p, DEFVAR_BOOL ("display-hourglass", &display_hourglass_p
"Non-zero means Emacs displays an hourglass pointer on window systems."); /* Non-zero means Emacs displays an hourglass pointer on window systems. */);
display_hourglass_p = 1; display_hourglass_p = 1;
DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay, DEFVAR_LISP ("hourglass-delay", &Vhourglass_delay
"*Seconds to wait before displaying an hourglass pointer.\n\ /* *Seconds to wait before displaying an hourglass pointer.
Value must be an integer or float."); Value must be an integer or float. */);
Vhourglass_delay = make_number (DEFAULT_HOURGLASS_DELAY); Vhourglass_delay = make_number (DEFAULT_HOURGLASS_DELAY);
#if 0 /* This doesn't really do anything. */ #if 0 /* This doesn't really do anything. */
DEFVAR_LISP ("x-mode-pointer-shape", &Vx_mode_pointer_shape, DEFVAR_LISP ("x-mode-pointer-shape", &Vx_mode_pointer_shape
"The shape of the pointer when over the mode line.\n\ /* The shape of the pointer when over the mode line.
This variable takes effect when you create a new frame\n\ This variable takes effect when you create a new frame
or when you set the mouse color."); or when you set the mouse color. */);
#endif #endif
Vx_mode_pointer_shape = Qnil; Vx_mode_pointer_shape = Qnil;
DEFVAR_LISP ("x-sensitive-text-pointer-shape", DEFVAR_LISP ("x-sensitive-text-pointer-shape",
&Vx_sensitive_text_pointer_shape, &Vx_sensitive_text_pointer_shape
"The shape of the pointer when over mouse-sensitive text.\n\ /* The shape of the pointer when over mouse-sensitive text.
This variable takes effect when you create a new frame\n\ This variable takes effect when you create a new frame
or when you set the mouse color."); or when you set the mouse color. */);
Vx_sensitive_text_pointer_shape = Qnil; Vx_sensitive_text_pointer_shape = Qnil;
DEFVAR_LISP ("x-window-horizontal-drag-cursor", DEFVAR_LISP ("x-window-horizontal-drag-cursor",
&Vx_window_horizontal_drag_shape, &Vx_window_horizontal_drag_shape
"Pointer shape to use for indicating a window can be dragged horizontally.\n\ /* Pointer shape to use for indicating a window can be dragged horizontally.
This variable takes effect when you create a new frame\n\ This variable takes effect when you create a new frame
or when you set the mouse color."); or when you set the mouse color. */);
Vx_window_horizontal_drag_shape = Qnil; Vx_window_horizontal_drag_shape = Qnil;
DEFVAR_LISP ("x-cursor-fore-pixel", &Vx_cursor_fore_pixel, DEFVAR_LISP ("x-cursor-fore-pixel", &Vx_cursor_fore_pixel
"A string indicating the foreground color of the cursor box."); /* A string indicating the foreground color of the cursor box. */);
Vx_cursor_fore_pixel = Qnil; Vx_cursor_fore_pixel = Qnil;
DEFVAR_LISP ("x-max-tooltip-size", &Vx_max_tooltip_size, DEFVAR_LISP ("x-max-tooltip-size", &Vx_max_tooltip_size
"Maximum size for tooltips. Value is a pair (COLUMNS . ROWS).\n\ /* Maximum size for tooltips. Value is a pair (COLUMNS . ROWS).
Text larger than this is clipped."); Text larger than this is clipped. */);
Vx_max_tooltip_size = Fcons (make_number (80), make_number (40)); Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
DEFVAR_LISP ("x-no-window-manager", &Vx_no_window_manager, DEFVAR_LISP ("x-no-window-manager", &Vx_no_window_manager
"Non-nil if no X window manager is in use.\n\ /* Non-nil if no X window manager is in use.
Emacs doesn't try to figure this out; this is always nil\n\ Emacs doesn't try to figure this out; this is always nil
unless you set it to something else."); unless you set it to something else. */);
/* We don't have any way to find this out, so set it to nil /* We don't have any way to find this out, so set it to nil
and maybe the user would like to set it to t. */ and maybe the user would like to set it to t. */
Vx_no_window_manager = Qnil; Vx_no_window_manager = Qnil;
DEFVAR_LISP ("x-pixel-size-width-font-regexp", DEFVAR_LISP ("x-pixel-size-width-font-regexp",
&Vx_pixel_size_width_font_regexp, &Vx_pixel_size_width_font_regexp
"Regexp matching a font name whose width is the same as `PIXEL_SIZE'.\n\ /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
\n\
Since Emacs gets width of a font matching with this regexp from\n\ Since Emacs gets width of a font matching with this regexp from
PIXEL_SIZE field of the name, font finding mechanism gets faster for\n\ PIXEL_SIZE field of the name, font finding mechanism gets faster for
such a font. This is especially effective for such large fonts as\n\ such a font. This is especially effective for such large fonts as
Chinese, Japanese, and Korean."); Chinese, Japanese, and Korean. */);
Vx_pixel_size_width_font_regexp = Qnil; Vx_pixel_size_width_font_regexp = Qnil;
DEFVAR_LISP ("image-cache-eviction-delay", &Vimage_cache_eviction_delay, DEFVAR_LISP ("image-cache-eviction-delay", &Vimage_cache_eviction_delay
"Time after which cached images are removed from the cache.\n\ /* Time after which cached images are removed from the cache.
When an image has not been displayed this many seconds, remove it\n\ When an image has not been displayed this many seconds, remove it
from the image cache. Value must be an integer or nil with nil\n\ from the image cache. Value must be an integer or nil with nil
meaning don't clear the cache."); meaning don't clear the cache. */);
Vimage_cache_eviction_delay = make_number (30 * 60); Vimage_cache_eviction_delay = make_number (30 * 60);
#ifdef USE_X_TOOLKIT #ifdef USE_X_TOOLKIT
@ -11713,8 +11719,8 @@ meaning don't clear the cache.");
#ifdef USE_MOTIF #ifdef USE_MOTIF
Fprovide (intern ("motif"), Qnil); Fprovide (intern ("motif"), Qnil);
DEFVAR_LISP ("motif-version-string", &Vmotif_version_string, DEFVAR_LISP ("motif-version-string", &Vmotif_version_string
"Version info for LessTif/Motif."); /* Version info for LessTif/Motif. */);
Vmotif_version_string = build_string (XmVERSION_STRING); Vmotif_version_string = build_string (XmVERSION_STRING);
#endif /* USE_MOTIF */ #endif /* USE_MOTIF */
#endif /* USE_X_TOOLKIT */ #endif /* USE_X_TOOLKIT */