summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGlenn Morris <rgm@gnu.org>2019-07-06 12:51:30 -0700
committerGlenn Morris <rgm@gnu.org>2019-07-06 12:51:30 -0700
commit16a8a7695f6696e0f637c71bd1a0ba9442d4c5f5 (patch)
treebeff7d5c18968279c63ea29e4d31e2b7cb863997
parentd07dd64fd0476e0346d2de65b965193703ae6e7a (diff)
parent316f5a3b717d727d46c15da46471e196bfea9a36 (diff)
downloademacs-16a8a7695f6696e0f637c71bd1a0ba9442d4c5f5.tar.gz
Merge from origin/emacs-26
316f5a3 Fix typo in doc string of file-exists-p (bug#36408) bfc7c6e * test/lisp/url/url-file-tests.el (url-file): Fix for POSIX f... 13b95e1 Fix typo in windows.texi 8b775c3 Clarify & update (elisp) Writing Emacs Primitives 7648c12 Clarify a subtle issue in the Internals chapter of lispref
-rw-r--r--doc/lispref/internals.texi72
-rw-r--r--doc/lispref/windows.texi2
-rw-r--r--src/fileio.c2
-rw-r--r--test/lisp/url/url-file-tests.el5
4 files changed, 44 insertions, 37 deletions
diff --git a/doc/lispref/internals.texi b/doc/lispref/internals.texi
index cfeb492af40..f1f2ea215a5 100644
--- a/doc/lispref/internals.texi
+++ b/doc/lispref/internals.texi
@@ -702,8 +702,8 @@ appearance.)
@smallexample
@group
DEFUN ("or", For, Sor, 0, UNEVALLED, 0,
- doc: /* Eval args until one of them yields non-nil, then return
-that value.
+ doc: /* Eval args until one of them yields non-nil,
+then return that value.
The remaining args are not evalled at all.
If all args return nil, return nil.
@end group
@@ -777,7 +777,7 @@ less than 8.
This is an interactive specification, a string such as might be used
as the argument of @code{interactive} in a Lisp function
(@pxref{Using Interactive}). In the case
-of @code{or}, it is 0 (a null pointer), indicating that @code{or}
+of @code{or}, it is @code{0} (a null pointer), indicating that @code{or}
cannot be called interactively. A value of @code{""} indicates a
function that should receive no arguments when called interactively.
If the value begins with a @samp{"(}, the string is evaluated as a
@@ -785,11 +785,11 @@ Lisp form. For example:
@example
@group
-DEFUN ("foo", Ffoo, Sfoo, 0, UNEVALLED, 0
+DEFUN ("foo", Ffoo, Sfoo, 0, 3,
"(list (read-char-by-name \"Insert character: \")\
(prefix-numeric-value current-prefix-arg)\
- t))",
- doc: /* @dots{} */)
+ t)",
+ doc: /* @dots{} */)
@end group
@end example
@@ -826,8 +826,8 @@ this:
@example
@group
DEFUN ("bar", Fbar, Sbar, 0, UNEVALLED, 0
- doc: /* @dots{} */
- attributes: @var{attr1} @var{attr2} @dots{})
+ doc: /* @dots{} */
+ attributes: @var{attr1} @var{attr2} @dots{})
@end group
@end example
@@ -863,15 +863,18 @@ arguments. If the primitive accepts a fixed maximum number of Lisp
arguments, there must be one C argument for each Lisp argument, and
each argument must be of type @code{Lisp_Object}. (Various macros and
functions for creating values of type @code{Lisp_Object} are declared
-in the file @file{lisp.h}.) If the primitive has no upper limit on
-the number of Lisp arguments, it must have exactly two C arguments:
-the first is the number of Lisp arguments, and the second is the
-address of a block containing their values. These have types
-@code{int} and @w{@code{Lisp_Object *}} respectively. Since
-@code{Lisp_Object} can hold any Lisp object of any data type, you
-can determine the actual data type only at run time; so if you want
-a primitive to accept only a certain type of argument, you must check
-the type explicitly using a suitable predicate (@pxref{Type Predicates}).
+in the file @file{lisp.h}.) If the primitive is a special form, it
+must accept a Lisp list containing its unevaluated Lisp arguments as a
+single argument of type @code{Lisp_Object}. If the primitive has no
+upper limit on the number of evaluated Lisp arguments, it must have
+exactly two C arguments: the first is the number of Lisp arguments,
+and the second is the address of a block containing their values.
+These have types @code{ptrdiff_t} and @w{@code{Lisp_Object *}},
+respectively. Since @code{Lisp_Object} can hold any Lisp object of
+any data type, you can determine the actual data type only at run
+time; so if you want a primitive to accept only a certain type of
+argument, you must check the type explicitly using a suitable
+predicate (@pxref{Type Predicates}).
@cindex type checking internals
@cindex garbage collection protection
@@ -880,10 +883,14 @@ the type explicitly using a suitable predicate (@pxref{Type Predicates}).
@code{args} refers to objects controlled by Emacs's stack-marking
garbage collector. Although the garbage collector does not reclaim
objects reachable from C @code{Lisp_Object} stack variables, it may
-move non-object components of an object, such as string contents; so
-functions that access non-object components must take care to refetch
-their addresses after performing Lisp evaluation. Lisp evaluation can
-occur via calls to @code{eval_sub} or @code{Feval}, either directly or
+move some of the components of an object, such as the contents of a
+string or the text of a buffer. Therefore, functions that access
+these components must take care to refetch their addresses after
+performing Lisp evaluation. This means that instead of keeping C
+pointers to string contents or buffer text, the code should keep the
+buffer or string position, and recompute the C pointer from the
+position after performing Lisp evaluation. Lisp evaluation can occur
+via calls to @code{eval_sub} or @code{Feval}, either directly or
indirectly.
@cindex @code{maybe_quit}, use in Lisp primitives
@@ -957,9 +964,9 @@ of macros and functions to manipulate Lisp objects.
@smallexample
@group
DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
- Scoordinates_in_window_p, 2, 2, 0,
- doc: /* Return non-nil if COORDINATES are in WINDOW.
- ...
+ Scoordinates_in_window_p, 2, 2, 0,
+ doc: /* Return non-nil if COORDINATES are in WINDOW.
+ @dots{}
@end group
@group
or `right-margin' is returned. */)
@@ -972,16 +979,15 @@ DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
@end group
@group
- CHECK_LIVE_WINDOW (window);
- w = XWINDOW (window);
+ w = decode_live_window (window);
f = XFRAME (w->frame);
CHECK_CONS (coordinates);
lx = Fcar (coordinates);
ly = Fcdr (coordinates);
- CHECK_NUMBER_OR_FLOAT (lx);
- CHECK_NUMBER_OR_FLOAT (ly);
- x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH(f);
- y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH(f);
+ CHECK_NUMBER (lx);
+ CHECK_NUMBER (ly);
+ x = FRAME_PIXEL_X_FROM_CANON_X (f, lx) + FRAME_INTERNAL_BORDER_WIDTH (f);
+ y = FRAME_PIXEL_Y_FROM_CANON_Y (f, ly) + FRAME_INTERNAL_BORDER_WIDTH (f);
@end group
@group
@@ -991,14 +997,14 @@ DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
return Qnil;
@end group
- ...
+ @dots{}
@group
case ON_MODE_LINE: /* In mode line of window. */
return Qmode_line;
@end group
- ...
+ @dots{}
@group
case ON_SCROLL_BAR: /* On scroll-bar of window. */
@@ -1008,7 +1014,7 @@ DEFUN ("coordinates-in-window-p", Fcoordinates_in_window_p,
@group
default:
- abort ();
+ emacs_abort ();
@}
@}
@end group
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index a6cb86eb84c..b5ca053e466 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -3874,7 +3874,7 @@ should be a list of the same form as that returned by
@code{window-prev-buffers}.
@end defun
-In addition, each buffer maintains a list of @dfn{next buffers}, which
+In addition, each window maintains a list of @dfn{next buffers}, which
is a list of buffers re-shown by @code{switch-to-prev-buffer} (see
below). This list is mainly used by @code{switch-to-prev-buffer} and
@code{switch-to-next-buffer} for choosing buffers to switch to.
diff --git a/src/fileio.c b/src/fileio.c
index 2825c1b54c6..505e4ec33bf 100644
--- a/src/fileio.c
+++ b/src/fileio.c
@@ -2666,7 +2666,7 @@ On Unix, absolute file names start with `/'. */)
}
DEFUN ("file-exists-p", Ffile_exists_p, Sfile_exists_p, 1, 1, 0,
- doc: /* Return t if file FILENAME exists (whether or not you can read it.)
+ doc: /* Return t if file FILENAME exists (whether or not you can read it).
See also `file-readable-p' and `file-attributes'.
This returns nil for a symlink to a nonexistent file.
Use `file-symlink-p' to test for such links. */)
diff --git a/test/lisp/url/url-file-tests.el b/test/lisp/url/url-file-tests.el
index 84b7c3a70b0..58e0250ba96 100644
--- a/test/lisp/url/url-file-tests.el
+++ b/test/lisp/url/url-file-tests.el
@@ -34,10 +34,11 @@
(ert-deftest url-file ()
"Test reading file via file:/// URL."
- (let ((file (expand-file-name "file.txt" url-file-tests-data-directory)))
+ (let* ((file (expand-file-name "file.txt" url-file-tests-data-directory))
+ (uri-prefix (if (eq (aref file 0) ?/) "file://" "file:///")))
(should (equal
(with-current-buffer
- (url-file (url-generic-parse-url (concat "file:///" file))
+ (url-file (url-generic-parse-url (concat uri-prefix file))
#'ignore nil)
(prog1 (buffer-substring (point) (point-max))
(kill-buffer)))