From: Stefan Monnier <monnier@iro.umontreal.ca>
To: Lennart Borgman <lennart.borgman@gmail.com>
Cc: Juanma Barranquero <lekktu@gmail.com>
Subject: bug#6299: In read-file-name: (args-out-of-range "c:" 0 3)
Date: Sun, 30 May 2010 17:18:57 -0400 [thread overview]
Message-ID: <jwv1vct166i.fsf-monnier+emacs@gnu.org> (raw)
In-Reply-To: <AANLkTikI6BVNvDa3WAiGJzU39lxKz3usbBZRLBvCwUi2@mail.gmail.com> (Lennart Borgman's message of "Sun, 30 May 2010 19:40:39 +0200")
>> I've installed the patch below which should hopefully fix the
>> original problem. Please confirm.
> Thanks, it works.
Good thing done,
> I meant the argument ACTION to some function, but what exactly was
> I reading??
[...]
> There is no ACTION arg to try-completion etc.
The ACTION is not passed to try-completion but from try-completion to
the completion table (when it's a function). I've just installed the
patch below to try and improve the documentation of those issues.
Stefan
=== modified file 'doc/lispref/minibuf.texi'
--- doc/lispref/minibuf.texi 2010-05-03 22:01:23 +0000
+++ doc/lispref/minibuf.texi 2010-05-30 21:10:01 +0000
@@ -812,6 +812,24 @@
If @var{collection} is a function, it is called with three arguments,
the values @var{string}, @var{predicate} and @code{lambda}; whatever
it returns, @code{test-completion} returns in turn.
+
+@defun completion-boundaries string collection predicate suffix
+This function returns the boundaries of the field on which @var{collection}
+will operate, assuming that @var{string} holds the text before point
+and @var{suffix} holds the text after point.
+
+Normally completion operates on the whole string, so for all normal
+collections, this will always return @code{(0 . (length
+@var{suffix}))}. But more complex completion such as completion on
+files is done one field at a time. For example, completion of
+@code{"/usr/sh"} will include @code{"/usr/share/"} but not
+@code{"/usr/share/doc"} even if @code{"/usr/share/doc"} exists.
+Also @code{all-completions} on @code{"/usr/sh"} will not include
+@code{"/usr/share/"} but only @code{"share/"}. So if @var{string} is
+@code{"/usr/sh"} and @var{suffix} is @code{"e/doc"},
+@code{completion-boundaries} will return @code{(5 . 1)} which tells us
+that the @var{collection} will only return completion information that
+pertains to the area after @code{"/usr/"} and before @code{"/doc"}.
@end defun
If you store a completion alist in a variable, you should mark the
@@ -1618,13 +1636,14 @@
can supply your own function to compute the completion of a given
string. This is called @dfn{programmed completion}. Emacs uses
programmed completion when completing file names (@pxref{File Name
-Completion}).
+Completion}), among many other cases.
- To use this feature, pass a symbol with a function definition as the
-@var{collection} argument to @code{completing-read}. The function
+ To use this feature, pass a function as the @var{collection}
+argument to @code{completing-read}. The function
@code{completing-read} arranges to pass your completion function along
-to @code{try-completion} and @code{all-completions}, which will then let
-your function do all the work.
+to @code{try-completion}, @code{all-completions}, and other basic
+completion functions, which will then let your function do all
+the work.
The completion function should accept three arguments:
@@ -1638,10 +1657,14 @@
and ignore the possible match if the predicate returns @code{nil}.
@item
-A flag specifying the type of operation.
+A flag specifying the type of operation. The best way to think about
+it is that the function stands for an object (in the
+``object-oriented'' sense of the word), and this third argument
+specifies which method to run.
@end itemize
- There are three flag values for three operations:
+ There are currently four methods, i.e. four flag values, one for
+ each of the four different basic operations:
@itemize @bullet
@item
@@ -1663,6 +1686,13 @@
@code{lambda} specifies @code{test-completion}. The completion
function should return @code{t} if the specified string is an exact
match for some possibility; @code{nil} otherwise.
+
+@item
+@code{(boundaries . SUFFIX)} specifies @code{completion-boundaries}.
+The function should return a value of the form @code{(boundaries
+START . END)} where START is the position of the beginning boundary in
+in the string to complete, and END is the position of the end boundary
+in SUFFIX.
@end itemize
It would be consistent and clean for completion functions to allow
next prev parent reply other threads:[~2010-05-30 21:18 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-05-29 1:35 bug#6299: In read-file-name: (args-out-of-range "c:" 0 3) Lennart Borgman
2010-05-29 16:12 ` Eli Zaretskii
2010-05-29 21:18 ` Stefan Monnier
2010-05-29 21:24 ` Lennart Borgman
2010-05-29 22:07 ` Lennart Borgman
2010-05-29 23:29 ` Stefan Monnier
2010-05-30 0:10 ` Lennart Borgman
2010-05-30 3:34 ` Stefan Monnier
2010-05-30 4:27 ` Juanma Barranquero
2010-05-30 10:11 ` Lennart Borgman
2010-05-30 14:18 ` Stefan Monnier
2010-05-30 17:40 ` Lennart Borgman
2010-05-30 21:18 ` Stefan Monnier [this message]
2010-05-30 13:39 ` Lennart Borgman
2010-05-30 14:05 ` Stefan Monnier
2010-05-30 17:39 ` Lennart Borgman
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=jwv1vct166i.fsf-monnier+emacs@gnu.org \
--to=monnier@iro.umontreal.ca \
--cc=lekktu@gmail.com \
--cc=lennart.borgman@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.