* bug#8439: [PATCH] ffap.el -- detect paths with spaces @ 2011-04-07 15:24 Jari Aalto 2011-07-03 23:29 ` Lars Magne Ingebrigtsen ` (2 more replies) 0 siblings, 3 replies; 29+ messages in thread From: Jari Aalto @ 2011-04-07 15:24 UTC (permalink / raw) To: 8439 [-- Attachment #1: Type: text/plain, Size: 1015 bytes --] Package: emacs Version: 23.2+1-7 Severity: normal Tags: patch An example under Windows: (locate-library "ffap.el")C-xC-e c:/Program Files/emacs/emacs-23.3/lisp/ffap.el M-x ffap on line => c:/Program With the patch, M-x ffap will offer: => c:/Program Files/emacs/emacs-23.3/lisp/ffap.el 2011-04-07 Jari Aalto <jari.aalto@cante.net> * ffap.el (ffap-string-at-point): Handle paths and file names with spaces. -- System Information Debian Release: wheezy/sid APT Prefers testing APT policy: (990, testing) (500, unstable) (1, experimental) Architecture: amd64 Kernel: Linux picasso 2.6.32-5-amd64 #1 SMP Wed Jan 12 03:40:32 UTC 2011 x86_64 GNU/Linux Locale: LANG=en_US.UTF-8, LC_ALL= -- Versions of packages `emacs depends on'. Depends: emacs23 23.2+1-7 GNU Emacs is the extensible self-documenting emacs23-lucid 23.2+1-7 GNU Emacs is the extensible self-documenting emacs23-nox 23.2+1-7 GNU Emacs is the extensible self-documenting [-- Warning: decoded text below may be mangled, UTF-8 assumed --] [-- Attachment #2: 0001-lisp-ffap.el-ffap-string-at-point-Support-spaces-in-.patch --] [-- Type: text/x-diff, Size: 2950 bytes --] From 0706445da3f7e10aceef8b371d458deb4ec1c39d Mon Sep 17 00:00:00 2001 From: Jari Aalto <jari.aalto@cante.net> Date: Thu, 7 Apr 2011 18:20:17 +0300 Subject: [PATCH] lisp/ffap.el: (ffap-string-at-point): Support spaces in paths Organization: Private Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit Signed-off-by: Jari Aalto <jari.aalto@cante.net> --- lisp/ffap.el | 47 +++++++++++++++++++++++++++++------------------ 1 files changed, 29 insertions(+), 18 deletions(-) diff --git a/lisp/ffap.el b/lisp/ffap.el index 97105ed..dcc16f2 100644 --- a/lisp/ffap.el +++ b/lisp/ffap.el @@ -1006,24 +1006,35 @@ If MODE is not found, we use `file' instead of MODE. If the region is active, return a string from the region. Sets `ffap-string-at-point' and `ffap-string-at-point-region'." (let* ((args - (cdr - (or (assq (or mode major-mode) ffap-string-at-point-mode-alist) - (assq 'file ffap-string-at-point-mode-alist)))) - (pt (point)) - (str - (if (and transient-mark-mode mark-active) - (buffer-substring - (setcar ffap-string-at-point-region (region-beginning)) - (setcar (cdr ffap-string-at-point-region) (region-end))) - (buffer-substring - (save-excursion - (skip-chars-backward (car args)) - (skip-chars-forward (nth 1 args) pt) - (setcar ffap-string-at-point-region (point))) - (save-excursion - (skip-chars-forward (car args)) - (skip-chars-backward (nth 2 args) pt) - (setcar (cdr ffap-string-at-point-region) (point))))))) + (cdr + (or (assq (or mode major-mode) ffap-string-at-point-mode-alist) + (assq 'file ffap-string-at-point-mode-alist)))) + (pt (point)) + space-p + end + (str + (if (and transient-mark-mode mark-active) + (buffer-substring + (setcar ffap-string-at-point-region (region-beginning)) + (setcar (cdr ffap-string-at-point-region) (region-end))) + (buffer-substring + (save-excursion + (skip-chars-backward (car args)) + (skip-chars-forward (nth 1 args) pt) + ;; Paths may contains spaces, check those + ;; FIXME: may need better tuning. Currenly matches "/paths like/exam ple.txt" + (if (looking-at ".*/.* [^[:space:]]*/.*[^[:space:]]") + (setq space-p (match-end 0))) + (setcar ffap-string-at-point-region (point))) + (save-excursion + (skip-chars-forward (car args)) + (skip-chars-backward (nth 2 args) pt) + (setq end (point)) + (if (and space-p + (> space-p end) + (memq mode '(file nil))) + (setq end space-p)) + (setcar (cdr ffap-string-at-point-region) end)))))) (set-text-properties 0 (length str) nil str) (setq ffap-string-at-point str))) -- 1.7.4.1 ^ permalink raw reply related [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces 2011-04-07 15:24 bug#8439: [PATCH] ffap.el -- detect paths with spaces Jari Aalto @ 2011-07-03 23:29 ` Lars Magne Ingebrigtsen 2012-10-19 7:39 ` bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) Jari Aalto 2012-10-19 8:35 ` Jari Aalto 2 siblings, 0 replies; 29+ messages in thread From: Lars Magne Ingebrigtsen @ 2011-07-03 23:29 UTC (permalink / raw) To: Jari Aalto; +Cc: 8439 Jari Aalto <jari.aalto@cante.net> writes: > An example under Windows: > > (locate-library "ffap.el")C-xC-e > c:/Program Files/emacs/emacs-23.3/lisp/ffap.el M-x ffap on line > > => c:/Program > > With the patch, M-x ffap will offer: > > => c:/Program Files/emacs/emacs-23.3/lisp/ffap.el [...] > + ;; FIXME: may need better tuning. Currenly matches "/paths like/exam ple.txt" > + (if (looking-at ".*/.* [^[:space:]]*/.*[^[:space:]]") Won't this be more problematic than helpful? There may be more matches of stuff that's not part of the file name. And spaces in file names aren't that common in non-Windowsey environments... -- (domestic pets only, the antidote for overdose, milk.) bloggy blog http://lars.ingebrigtsen.no/ ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) 2011-04-07 15:24 bug#8439: [PATCH] ffap.el -- detect paths with spaces Jari Aalto 2011-07-03 23:29 ` Lars Magne Ingebrigtsen @ 2012-10-19 7:39 ` Jari Aalto 2012-10-19 9:49 ` Eli Zaretskii 2012-10-19 8:35 ` Jari Aalto 2 siblings, 1 reply; 29+ messages in thread From: Jari Aalto @ 2012-10-19 7:39 UTC (permalink / raw) To: 8439; +Cc: Yigal Hochberg With some more field testing, the following patch works better. 1. New variable ffap-paths-with-spaces controls if the behavior is in use. By default it is set to "t" in Windows/Cygwin where spaces in paths are encountered. 2. The "path skipping" is based on finding longest distance: - from first "drive letter", "/" or "\" - until last "/", "\" followed by last non-matching-char-not-usually-found-in-file-names 3. In Cygwin Emacs the paths are expected to be in "/cygdrive/<letter>/" format. This is handled as a last step. Test by placing cursor anywhere of these path names and evaluating with "M-:" the lisp code "(ffap-string-at-point)" over them: ;; c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program here.txt ;; c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program Files/Hummingbird/ ;; c:\Program Files\Freescale\CW for MPC55xx and MPC56xx 2.10\PowerPC_EABI_Tools\Command_Line_Tools\CLT_Usage_Notes.txt It is not possible to test the above paths with "M-x ffap" as the code by design starts to chop path components if the path does not exist in current environment. See: (defun ffap-file-at-point () ...near the end.... ;; Try all parent directories by deleting the trailing directory ;; name until existing directory is found or name stops changing I'm sure the patch is not perfect as it's hard to come by a strategy to deal with spaces but it appears to give good results. I think users' would benefit from the space detection support. Thanks for Yigal Hochberg for testing the functionality in Windows, Jari ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) 2012-10-19 7:39 ` bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) Jari Aalto @ 2012-10-19 9:49 ` Eli Zaretskii 2012-10-19 10:05 ` jari 2012-10-19 21:47 ` Andrew W. Nosenko 0 siblings, 2 replies; 29+ messages in thread From: Eli Zaretskii @ 2012-10-19 9:49 UTC (permalink / raw) To: Jari Aalto; +Cc: hochberg, 8439 > From: Jari Aalto <jari.aalto@cante.net> > Date: Fri, 19 Oct 2012 10:39:36 +0300 > Cc: Yigal Hochberg <hochberg@dmhsoftware.com> > > > With some more field testing, the following patch works better. > > 1. New variable ffap-paths-with-spaces controls if the behavior is in use. > By default it is set to "t" in Windows/Cygwin where spaces in paths > are encountered. GNU Coding Standards frown upon using "path" for anything except PATH-style lists of directories. Use "file name" or "leading directories" instead. > 2. The "path skipping" is based on finding longest distance: > > - from first "drive letter", "/" or "\" > - until last "/", "\" followed by last non-matching-char-not-usually-found-in-file-names What will this do to text such as the one below? C:\emacs\bin\prog1.exe on Windows or /usr/bin/prog1 on Unix. > 3. In Cygwin Emacs the paths are expected to be in "/cygdrive/<letter>/" > format. What about Posix-standard /foo/bar/baz, which is the usual case on Cygwin? ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) 2012-10-19 9:49 ` Eli Zaretskii @ 2012-10-19 10:05 ` jari 2012-10-19 11:15 ` Yigal Hochberg ` (2 more replies) 2012-10-19 21:47 ` Andrew W. Nosenko 1 sibling, 3 replies; 29+ messages in thread From: jari @ 2012-10-19 10:05 UTC (permalink / raw) To: Eli Zaretskii; +Cc: hochberg, 8439 On 2012-10-19 11:49, Eli Zaretskii wrote: | > | > 1. New variable ffap-paths-with-spaces controls if the behavior is in use. | > By default it is set to "t" in Windows/Cygwin where spaces in paths | > are encountered. | | GNU Coding Standards frown upon using "path" for anything except | PATH-style lists of directories. Use "file name" or "leading | directories" instead. | | > 2. The "path skipping" is based on finding longest distance: | > | > - from first "drive letter", "/" or "\" | > - until last "/", "\" followed by last non-matching-char-not-usually-found-in-file-names | | What will this do to text such as the one below? | | C:\emacs\bin\prog1.exe on Windows or /usr/bin/prog1 on Unix. User can enable/disable if spaces are taken into account. If enabled, the result is: "C:\emacs\bin\prog1.exe on Windows or /usr/bin/prog1" If disabled, depending on cursor position: "C:\emacs\bin\prog1.exe" "/usr/bin/prog1" If you have strategiy to make it better, please suggest. | > 3. In Cygwin Emacs the paths are expected to be in "/cygdrive/<letter>/" | > format. | | What about Posix-standard /foo/bar/baz, which is the usual case on | Cygwin? Only "<drive letter>:" is converted into "/cygdrive/<drive letter>" under Cygwin. Jari ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) 2012-10-19 10:05 ` jari @ 2012-10-19 11:15 ` Yigal Hochberg 2012-10-19 11:22 ` Eli Zaretskii 2012-10-19 12:15 ` Nicolas Richard 2 siblings, 0 replies; 29+ messages in thread From: Yigal Hochberg @ 2012-10-19 11:15 UTC (permalink / raw) To: jari; +Cc: Yigal Hochberg, 8439 [-- Attachment #1: Type: text/plain, Size: 2495 bytes --] Hi Jari, Eli: A thank you note for Jari. I asked Jari if he could improve ffap to match these Windows paths like this: c:/Program Files/Freescale/CW for MPC55xx and MPC56xx 2.10/PowerPC_EABI_Tools/Command_Line_Tools/CLT_EABI_PPC_Tools_Notes.txt c:\Program Files\Freescale\CW for MPC55xx and MPC56xx 2.10\PowerPC_EABI_Tools\Command_Line_Tools\CLT_Usage_Notes.txt c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program Files/Hummingbird/Connectivity/14.00/Default User/PerUser Settings.ini c:\Program Files\Open Text Evaluation Media\Open Text Exceed 14 x86\Program Files\Hummingbird\Connectivity\14.00\Default User\PerUser Settings.ini c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program Files/Hummingbird/ c:\Program Files\Open Text Evaluation Media\Open Text Exceed 14 x86\Program Files\Hummingbird\ From a user view this is a very helpful and useful solution to get to these files/dirs in one keystroke. Thanks to Jari for the hard work. I will report if I find issues. Regards, Yigal On Fri, Oct 19, 2012 at 6:05 AM, jari <jari.aalto@cante.net> wrote: > On 2012-10-19 11:49, Eli Zaretskii wrote: > | > > | > 1. New variable ffap-paths-with-spaces controls if the behavior is > in use. > | > By default it is set to "t" in Windows/Cygwin where spaces in > paths > | > are encountered. > | > | GNU Coding Standards frown upon using "path" for anything except > | PATH-style lists of directories. Use "file name" or "leading > | directories" instead. > | > | > 2. The "path skipping" is based on finding longest distance: > | > > | > - from first "drive letter", "/" or "\" > | > - until last "/", "\" followed by last > non-matching-char-not-usually-found-in-file-names > | > | What will this do to text such as the one below? > | > | C:\emacs\bin\prog1.exe on Windows or /usr/bin/prog1 on Unix. > > User can enable/disable if spaces are taken into account. If enabled, > the result is: > > "C:\emacs\bin\prog1.exe on Windows or /usr/bin/prog1" > > If disabled, depending on cursor position: > > "C:\emacs\bin\prog1.exe" > "/usr/bin/prog1" > > If you have strategiy to make it better, please suggest. > > | > 3. In Cygwin Emacs the paths are expected to be in > "/cygdrive/<letter>/" > | > format. > | > | What about Posix-standard /foo/bar/baz, which is the usual case on > | Cygwin? > > Only "<drive letter>:" is converted into "/cygdrive/<drive letter>" under > Cygwin. > > Jari > -- Yigal [-- Attachment #2: Type: text/html, Size: 3303 bytes --] ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) 2012-10-19 10:05 ` jari 2012-10-19 11:15 ` Yigal Hochberg @ 2012-10-19 11:22 ` Eli Zaretskii 2012-10-19 12:15 ` Nicolas Richard 2 siblings, 0 replies; 29+ messages in thread From: Eli Zaretskii @ 2012-10-19 11:22 UTC (permalink / raw) To: jari; +Cc: hochberg, 8439 > Date: Fri, 19 Oct 2012 13:05:56 +0300 > From: jari <jari.aalto@cante.net> > Cc: 8439@debbugs.gnu.org, hochberg@dmhsoftware.com > > | What will this do to text such as the one below? > | > | C:\emacs\bin\prog1.exe on Windows or /usr/bin/prog1 on Unix. > > User can enable/disable if spaces are taken into account. If enabled, > the result is: > > "C:\emacs\bin\prog1.exe on Windows or /usr/bin/prog1" Why would it exclude the " on Unix." part? > If you have strategiy to make it better, please suggest. (I don't use ffap, so take the below with a grain of salt.) Several things come to mind: . You could modify the heuristics depending on the major mode. E.g., if it's Text or anything derived from text, file names with spaces will generally be delimited by quotes. . You could by default stop "skipping" when you see common words like "on", "and", "or", "and/or", etc. . You could by default stop when the slash flavor changes, like first \, then / (see my example). . At least in text modes, punctuation (with the notable exception of a period) will not normally be part of a file name. > | > 3. In Cygwin Emacs the paths are expected to be in "/cygdrive/<letter>/" > | > format. > | > | What about Posix-standard /foo/bar/baz, which is the usual case on > | Cygwin? > > Only "<drive letter>:" is converted into "/cygdrive/<drive letter>" under > Cygwin. Sorry, I don't follow. You said "In Cygwin Emacs the paths are _expected_ to be", so I assumed you mean the file names on Cygwin are _required_ to be in the /cygdrive/x/foo form. Maybe I misunderstood what you meant. ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) 2012-10-19 10:05 ` jari 2012-10-19 11:15 ` Yigal Hochberg 2012-10-19 11:22 ` Eli Zaretskii @ 2012-10-19 12:15 ` Nicolas Richard 2 siblings, 0 replies; 29+ messages in thread From: Nicolas Richard @ 2012-10-19 12:15 UTC (permalink / raw) To: 8439 jari <jari.aalto@cante.net> writes: > On 2012-10-19 11:49, Eli Zaretskii wrote: > | C:\emacs\bin\prog1.exe on Windows or /usr/bin/prog1 on Unix. > If you have strategiy to make it better, please suggest. From the example, I'd suggest that if there is a period followed by up to three letters and then a space, the filename ends before that space. From what I see, most filenames which have an extension don't have more text after the extension (with the exception of another extension, which is why I suggest that there must be a final space). Would that fit ? -- Nico. ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) 2012-10-19 9:49 ` Eli Zaretskii 2012-10-19 10:05 ` jari @ 2012-10-19 21:47 ` Andrew W. Nosenko 2012-10-19 22:23 ` Eli Zaretskii ` (3 more replies) 1 sibling, 4 replies; 29+ messages in thread From: Andrew W. Nosenko @ 2012-10-19 21:47 UTC (permalink / raw) To: Eli Zaretskii; +Cc: hochberg, 8439, Jari Aalto On Fri, Oct 19, 2012 at 12:49 PM, Eli Zaretskii <eliz@gnu.org> wrote: >> From: Jari Aalto <jari.aalto@cante.net> >> Date: Fri, 19 Oct 2012 10:39:36 +0300 >> Cc: Yigal Hochberg <hochberg@dmhsoftware.com> >> >> >> With some more field testing, the following patch works better. >> >> 1. New variable ffap-paths-with-spaces controls if the behavior is in use. >> By default it is set to "t" in Windows/Cygwin where spaces in paths >> are encountered. > > GNU Coding Standards frown upon using "path" for anything except > PATH-style lists of directories. Use "file name" or "leading > directories" instead. > >> 2. The "path skipping" is based on finding longest distance: >> >> - from first "drive letter", "/" or "\" >> - until last "/", "\" followed by last non-matching-char-not-usually-found-in-file-names > > What will this do to text such as the one below? > > C:\emacs\bin\prog1.exe on Windows or /usr/bin/prog1 on Unix. Eli, excuse me very much, but you cheating. Even under Unix (where spaces inside filenames are very unusual) people instinctively trying heavy to distinguish/decorate them from outside/descriptive text. The only one problem that there no consensus about how to do it. What characters pair to use? <>? ""? ''? But anyway just separate filename with possible spaces just by spaces... It's out of my ability to imagine. Therefore, I would to discard this example as rare. After all, any heuristic have his own false positives (and it is the reason, why I said "cheating": for every heuristic it's always possible to imagine a situation/input data when heuristic will fail). But, if there no way to make false positives amount small enough, I would to propose an idea for extension: find-file-at-region(). You just select a region of text, and Emacs tries to interprets it as default value for find-file(). > >> 3. In Cygwin Emacs the paths are expected to be in "/cygdrive/<letter>/" >> format. > > What about Posix-standard /foo/bar/baz, which is the usual case on > Cygwin? > > > -- Andrew W. Nosenko <andrew.w.nosenko@gmail.com> ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) 2012-10-19 21:47 ` Andrew W. Nosenko @ 2012-10-19 22:23 ` Eli Zaretskii 2012-10-19 22:36 ` Yigal Hochberg ` (2 subsequent siblings) 3 siblings, 0 replies; 29+ messages in thread From: Eli Zaretskii @ 2012-10-19 22:23 UTC (permalink / raw) To: Andrew W. Nosenko; +Cc: hochberg, 8439, jari.aalto > Date: Sat, 20 Oct 2012 00:47:55 +0300 > From: "Andrew W. Nosenko" <andrew.w.nosenko@gmail.com> > Cc: Jari Aalto <jari.aalto@cante.net>, hochberg@dmhsoftware.com, 8439@debbugs.gnu.org > > >> 2. The "path skipping" is based on finding longest distance: > >> > >> - from first "drive letter", "/" or "\" > >> - until last "/", "\" followed by last non-matching-char-not-usually-found-in-file-names > > > > What will this do to text such as the one below? > > > > C:\emacs\bin\prog1.exe on Windows or /usr/bin/prog1 on Unix. > > Eli, excuse me very much, but you cheating. Actually, I had this weird idea that maybe the suggested heuristics could be improved. Now I'm sorry that I have spoken. ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) 2012-10-19 21:47 ` Andrew W. Nosenko 2012-10-19 22:23 ` Eli Zaretskii @ 2012-10-19 22:36 ` Yigal Hochberg 2012-10-19 22:57 ` Andrew W. Nosenko 2012-10-19 23:24 ` Yigal Hochberg 2012-10-20 1:45 ` Stefan Monnier 2012-10-20 11:01 ` Juri Linkov 3 siblings, 2 replies; 29+ messages in thread From: Yigal Hochberg @ 2012-10-19 22:36 UTC (permalink / raw) To: Eli Zaretskii; +Cc: hochberg, 8439, jari.aalto Eli, Andrew: What Jari did is an excellent solution (increment cheeking if file exists). From a user point of view it is very powerful and useful. Marking a region is trivial but way too costly for me. I want to be one keystroke away from getting this file. On Windows I use these type of paths: c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program Files/Hummingbird/Connectivity/14.00/Default User/PerUser Settings.ini c:\Program Files\Open Text Evaluation Media\Open Text Exceed 14 x86\Program Files\Hummingbird\Connectivity\14.00\Default User\PerUser Settings.ini c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program Files/Hummingbird/ c:\Program Files\Open Text Evaluation Media\Open Text Exceed 14 x86\Program Files\Hummingbird\ With Jari solution I can get to the file/dir in one keystroke. I think that this is the power of emacs. No? Thanks, Yigal On Fri, Oct 19, 2012 at 6:23 PM, Eli Zaretskii <eliz@gnu.org> wrote: >> Date: Sat, 20 Oct 2012 00:47:55 +0300 >> From: "Andrew W. Nosenko" <andrew.w.nosenko@gmail.com> >> Cc: Jari Aalto <jari.aalto@cante.net>, hochberg@dmhsoftware.com, 8439@debbugs.gnu.org >> >> >> 2. The "path skipping" is based on finding longest distance: >> >> >> >> - from first "drive letter", "/" or "\" >> >> - until last "/", "\" followed by last non-matching-char-not-usually-found-in-file-names >> > >> > What will this do to text such as the one below? >> > >> > C:\emacs\bin\prog1.exe on Windows or /usr/bin/prog1 on Unix. >> >> Eli, excuse me very much, but you cheating. > >Actually, I had this weird idea that maybe the suggested heuristics >could be improved. Now I'm sorry that I have spoken. > ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) 2012-10-19 22:36 ` Yigal Hochberg @ 2012-10-19 22:57 ` Andrew W. Nosenko 2012-10-19 23:24 ` Yigal Hochberg 1 sibling, 0 replies; 29+ messages in thread From: Andrew W. Nosenko @ 2012-10-19 22:57 UTC (permalink / raw) To: Yigal Hochberg; +Cc: 8439, jari.aalto On Sat, Oct 20, 2012 at 1:36 AM, Yigal Hochberg <hochberg@dmhsoftware.com> wrote: > Eli, Andrew: > > What Jari did is an excellent solution (increment cheeking if file exists). > From a user point of view it is very powerful and useful. > > Marking a region is trivial but way too costly for me. I want to be one keystroke > away from getting this file. O, sorry, sorry and sorry again! I ever didn't mind that my "fallback" proposal can sound so seriously! It was intended as a very last resort, if there will be no reasonable way to avoid 50%/50% false positive/negative ratio. Logic was very simple: in any way to mark a region and call a function is faster than to mark a region, copy, call a function, paste and, optionally if copied pathname is relative, move to the beginning of the pasted pathname and then to kill to the beginning of minibuffer. > On Windows I use these type of paths: > > c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program Files/Hummingbird/Connectivity/14.00/Default User/PerUser Settings.ini > c:\Program Files\Open Text Evaluation Media\Open Text Exceed 14 x86\Program Files\Hummingbird\Connectivity\14.00\Default User\PerUser Settings.ini > > c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program Files/Hummingbird/ > c:\Program Files\Open Text Evaluation Media\Open Text Exceed 14 x86\Program Files\Hummingbird\ > > With Jari solution I can get to the file/dir in one keystroke. > I think that this is the power of emacs. No? > > Thanks, > > Yigal > > > On Fri, Oct 19, 2012 at 6:23 PM, Eli Zaretskii <eliz@gnu.org> wrote: >>> Date: Sat, 20 Oct 2012 00:47:55 +0300 >>> From: "Andrew W. Nosenko" <andrew.w.nosenko@gmail.com> >>> Cc: Jari Aalto <jari.aalto@cante.net>, hochberg@dmhsoftware.com, 8439@debbugs.gnu.org >>> >>> >> 2. The "path skipping" is based on finding longest distance: >>> >> >>> >> - from first "drive letter", "/" or "\" >>> >> - until last "/", "\" followed by last non-matching-char-not-usually-found-in-file-names >>> > >>> > What will this do to text such as the one below? >>> > >>> > C:\emacs\bin\prog1.exe on Windows or /usr/bin/prog1 on Unix. >>> >>> Eli, excuse me very much, but you cheating. >> >>Actually, I had this weird idea that maybe the suggested heuristics >>could be improved. Now I'm sorry that I have spoken. >> -- Andrew W. Nosenko <andrew.w.nosenko@gmail.com> ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) 2012-10-19 22:36 ` Yigal Hochberg 2012-10-19 22:57 ` Andrew W. Nosenko @ 2012-10-19 23:24 ` Yigal Hochberg 1 sibling, 0 replies; 29+ messages in thread From: Yigal Hochberg @ 2012-10-19 23:24 UTC (permalink / raw) To: Andrew W. Nosenko; +Cc: Yigal Hochberg, 8439, jari.aalto Sorry Andrew, Marking a region is missing the whole point of ffap. One single keystroke to get to what you wanna do - no more. Yigal On Fri, Oct 19, 2012 at 6:57 PM, Andrew W. Nosenko <andrew.w.nosenko@gmail.com> wrote: >On Sat, Oct 20, 2012 at 1:36 AM, Yigal Hochberg ><hochberg@dmhsoftware.com> wrote: >> Eli, Andrew: >> >> What Jari did is an excellent solution (increment cheeking if file exists). >> From a user point of view it is very powerful and useful. >> >> Marking a region is trivial but way too costly for me. I want to be one keystroke >> away from getting this file. > >O, sorry, sorry and sorry again! I ever didn't mind that my >"fallback" proposal can sound so seriously! It was intended as a very >last resort, if there will be no reasonable way to avoid 50%/50% false >positive/negative ratio. Logic was very simple: in any way to mark a >region and call a function is faster than to mark a region, copy, call >a function, paste and, optionally if copied pathname is relative, move >to the beginning of the pasted pathname and then to kill to the >beginning of minibuffer. > >> On Windows I use these type of paths: >> >> c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program Files/Hummingbird/Connectivity/14.00/Default User/PerUser Settings.ini >> c:\Program Files\Open Text Evaluation Media\Open Text Exceed 14 x86\Program Files\Hummingbird\Connectivity\14.00\Default User\PerUser Settings.ini >> >> c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program Files/Hummingbird/ >> c:\Program Files\Open Text Evaluation Media\Open Text Exceed 14 x86\Program Files\Hummingbird\ >> >> With Jari solution I can get to the file/dir in one keystroke. >> I think that this is the power of emacs. No? >> >> Thanks, >> >> Yigal >> >> >> On Fri, Oct 19, 2012 at 6:23 PM, Eli Zaretskii <eliz@gnu.org> wrote: >>>> Date: Sat, 20 Oct 2012 00:47:55 +0300 >>>> From: "Andrew W. Nosenko" <andrew.w.nosenko@gmail.com> >>>> Cc: Jari Aalto <jari.aalto@cante.net>, hochberg@dmhsoftware.com, 8439@debbugs.gnu.org >>>> >>>> >> 2. The "path skipping" is based on finding longest distance: >>>> >> >>>> >> - from first "drive letter", "/" or "\" >>>> >> - until last "/", "\" followed by last non-matching-char-not-usually-found-in-file-names >>>> > >>>> > What will this do to text such as the one below? >>>> > >>>> > C:\emacs\bin\prog1.exe on Windows or /usr/bin/prog1 on Unix. >>>> >>>> Eli, excuse me very much, but you cheating. >>> >>>Actually, I had this weird idea that maybe the suggested heuristics >>>could be improved. Now I'm sorry that I have spoken. >>> > > > >-- >Andrew W. Nosenko <andrew.w.nosenko@gmail.com> > ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) 2012-10-19 21:47 ` Andrew W. Nosenko 2012-10-19 22:23 ` Eli Zaretskii 2012-10-19 22:36 ` Yigal Hochberg @ 2012-10-20 1:45 ` Stefan Monnier 2012-10-20 11:01 ` Juri Linkov 3 siblings, 0 replies; 29+ messages in thread From: Stefan Monnier @ 2012-10-20 1:45 UTC (permalink / raw) To: Andrew W. Nosenko; +Cc: hochberg, 8439, Jari Aalto >> C:\emacs\bin\prog1.exe on Windows or /usr/bin/prog1 on Unix. > Eli, excuse me very much, but you cheating. I don't see the relationship with cheating. Yes, his example is probably not too important, but I think if we want to add support for spaces we first need to decide which cases we want to handle, since the general case is simply impossible. Here are some disorganized thoughts: - many of the examples shown in this thread have to do with "one file name per line". But if noone tells us beforehand that the file name goes to EOL, handling these well will unavoidably end up with too many false positives. - we should think of good hints for beginning/end of file names. E.g. I think if we find something that matches "['\">,.][ \n]", we should probably assume it's the end of the file name (EOFN). Or " /" is probably a BOFN, whereas "/ " is an EOFN. - maybe if the separators are forward slashes, we should assume that there's no space in the file name. > But, if there no way to make false positives amount small enough, I > would to propose an idea for extension: find-file-at-region(). You > just select a region of text, and Emacs tries to interprets it as > default value for find-file(). M-w C-x C-f C-y already handles this case. Stefan ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) 2012-10-19 21:47 ` Andrew W. Nosenko ` (2 preceding siblings ...) 2012-10-20 1:45 ` Stefan Monnier @ 2012-10-20 11:01 ` Juri Linkov 3 siblings, 0 replies; 29+ messages in thread From: Juri Linkov @ 2012-10-20 11:01 UTC (permalink / raw) To: Andrew W. Nosenko; +Cc: hochberg, 8439, Jari Aalto > Even under Unix (where spaces inside filenames are very unusual) They are unusual for Unix native files but not rare when files created on Windows reach Unix file systems. So this problem is not unique to Windows (only the drive letter part of the problem is Windows-specific). > But, if there no way to make false positives amount small enough, I > would to propose an idea for extension: find-file-at-region(). You > just select a region of text, and Emacs tries to interprets it as > default value for find-file(). ffap used to fetch the selected region until Stefan removed this feature with the following comment: (let ((mark-active nil)) ;; Don't use the region here, since it can be something ;; completely unwieldy. If the user wants that, she could ;; use M-w before and then C-y. --Stef I have no problem with this change because ffap still can successfully fetch filenames with spaces due to `ffap-completable' that works surprisingly well in most cases (it incorrectly highlights the filename part until the first space, but correctly fetches the complete filename with spaces). ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) 2011-04-07 15:24 bug#8439: [PATCH] ffap.el -- detect paths with spaces Jari Aalto 2011-07-03 23:29 ` Lars Magne Ingebrigtsen 2012-10-19 7:39 ` bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) Jari Aalto @ 2012-10-19 8:35 ` Jari Aalto 2012-10-20 1:44 ` Stefan Monnier 2 siblings, 1 reply; 29+ messages in thread From: Jari Aalto @ 2012-10-19 8:35 UTC (permalink / raw) To: 8439 [-- Attachment #1: Type: text/plain, Size: 65 bytes --] Patch for http://debbugs.gnu.org/cgi/bugreport.cgi?bug=8439#13 [-- Warning: decoded text below may be mangled, UTF-8 assumed --] [-- Attachment #2: 0001-lisp-ffap.el-ffap-string-at-point-v2-support-spaces.patch --] [-- Type: text/x-diff, Size: 5035 bytes --] From 9d912ef5fe082c81917cf65bbacbf4d23e1cd9f3 Mon Sep 17 00:00:00 2001 From: Jari Aalto <jari.aalto@cante.net> Date: Fri, 19 Oct 2012 10:15:50 +0300 Subject: [PATCH] lisp/ffap.el: (ffap-string-at-point): v2 support spaces Organization: Private Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit Signed-off-by: Jari Aalto <jari.aalto@cante.net> --- lisp/ffap.el | 87 +++++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 68 insertions(+), 19 deletions(-) diff --git a/lisp/ffap.el b/lisp/ffap.el index 4c75609..a74f85b 100644 --- a/lisp/ffap.el +++ b/lisp/ffap.el @@ -1036,6 +1036,17 @@ possibly a major-mode name, or one of the symbol ;; Added at suggestion of RHOGEE (for ff-paths), 7/24/95. "Last string returned by `ffap-string-at-point'.") +;; Test cases: +;; +;; c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program here.txt +;; c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program Files/Hummingbird/ +;; +(defvar ffap-paths-with-spaces + (or (memq system-type '(ms-dos windows-nt)) + (string-match "cygwin" (emacs-version))) + "If non-nil, look for paths with spaces in `ffap-string-at-point'. +Enabled in W32 and Cygwin by default.") + (defun ffap-string-at-point (&optional mode) "Return a string of characters from around point. MODE (defaults to value of `major-mode') is a symbol used to look up string @@ -1043,25 +1054,63 @@ syntax parameters in `ffap-string-at-point-mode-alist'. If MODE is not found, we use `file' instead of MODE. If the region is active, return a string from the region. Sets `ffap-string-at-point' and `ffap-string-at-point-region'." - (let* ((args - (cdr - (or (assq (or mode major-mode) ffap-string-at-point-mode-alist) - (assq 'file ffap-string-at-point-mode-alist)))) - (pt (point)) - (str - (if (and transient-mark-mode mark-active) - (buffer-substring - (setcar ffap-string-at-point-region (region-beginning)) - (setcar (cdr ffap-string-at-point-region) (region-end))) - (buffer-substring - (save-excursion - (skip-chars-backward (car args)) - (skip-chars-forward (nth 1 args) pt) - (setcar ffap-string-at-point-region (point))) - (save-excursion - (skip-chars-forward (car args)) - (skip-chars-backward (nth 2 args) pt) - (setcar (cdr ffap-string-at-point-region) (point))))))) + (let* ((cygwin-p (string-match "cygwin" (emacs-version))) + (args + (cdr + (or (assq (or mode major-mode) ffap-string-at-point-mode-alist) + (assq 'file ffap-string-at-point-mode-alist)))) + (pt (point)) + space-p + end + (str + (if (and transient-mark-mode mark-active) + (buffer-substring + (setcar ffap-string-at-point-region (region-beginning)) + (setcar (cdr ffap-string-at-point-region) (region-end))) + (buffer-substring + (save-excursion + (if (and ffap-paths-with-spaces + (memq mode '(nil file))) + (if (string-match "^[ \t]*$" + (buffer-substring (line-beginning-position) + (point))) + ;; Nothing interesting before point. Move to the first character + (skip-chars-forward " \t" (line-end-position)) + ;; If at colon, move a little forward so that next + ;; `re-search-backward' can position at drive letter. + (if (looking-at ":/") + (forward-char 1)) + ;; Skip until drive path start or patch start letter + (while (re-search-backward "[a-zA-Z]:[\\\\/]\\|[/\\\\]" + (line-beginning-position) t) + (goto-char (match-beginning 0))))) + (skip-chars-backward (car args)) + (skip-chars-forward (nth 1 args) pt) + (when (and ffap-paths-with-spaces + (memq mode '(nil file))) + ;; Paths may contains spaces, allow those + (if (looking-at + "[^\t\r\n]*[/\\\\][^][<>()\"';:|\t\r\n]*[^][<>()\"';:|\r\n[:space:]]") + (setq space-p (match-end 0)))) + (setcar ffap-string-at-point-region (point))) + (save-excursion + (skip-chars-forward (car args)) + (skip-chars-backward (nth 2 args) pt) + (setq end (point)) + (if (and space-p + (> space-p end) + (memq mode '(file nil))) + (setq end space-p)) + (setcar (cdr ffap-string-at-point-region) end)))))) + ;; Under Cygwin, convert drive letters in paths. + (when (and cygwin-p + (memq mode '(nil file)) + (string-match "^\\([a-zA-Z]\\):[/\\\\]\\(.*\\)" str)) + (let ((drive (downcase (match-string 1 str))) + (path (match-string 2 str))) + (setq str (format "/cygdrive/%s/%s" + drive + (replace-regexp-in-string "[\\\\]" "/" path))))) (set-text-properties 0 (length str) nil str) (setq ffap-string-at-point str))) -- 1.7.10.4 ^ permalink raw reply related [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) 2012-10-19 8:35 ` Jari Aalto @ 2012-10-20 1:44 ` Stefan Monnier 2012-10-20 1:49 ` Daniel Colascione ` (2 more replies) 0 siblings, 3 replies; 29+ messages in thread From: Stefan Monnier @ 2012-10-20 1:44 UTC (permalink / raw) To: Jari Aalto; +Cc: 8439 A few comments about your patch below. Stefan > + (let* ((cygwin-p (string-match "cygwin" (emacs-version))) Test system-type instead. > + (if (and ffap-paths-with-spaces > + (memq mode '(nil file))) > + (if (string-match "^[ \t]*$" > + (buffer-substring (line-beginning-position) > + (point))) Better match the buffer (e.g. with forward-line + looking-at, or in this case with skip-chars-backward + bolp) than extract a part of the buffer and then apply string-match to it. > + ;; Nothing interesting before point. Move to the first character Please terminate your comments with proper punctuation. > + (skip-chars-forward " \t" (line-end-position)) > + ;; If at colon, move a little forward so that next > + ;; `re-search-backward' can position at drive letter. > + (if (looking-at ":/") > + (forward-char 1)) > + ;; Skip until drive path start or patch start letter > + (while (re-search-backward "[a-zA-Z]:[\\\\/]\\|[/\\\\]" > + (line-beginning-position) t) > + (goto-char (match-beginning 0))))) This code seems to assume Windows-style file names, whereas none of the var names nor comments mention anything about this assumption. I'm not sure we should make this assumption, but it's probably OK to consider that spaces only appear in Windows-style file names. Just make this reasoning explicit in a comment. > + (when (and ffap-paths-with-spaces > + (memq mode '(nil file))) > + ;; Paths may contains spaces, allow those > + (if (looking-at > + "[^\t\r\n]*[/\\\\][^][<>()\"';:|\t\r\n]*[^][<>()\"';:|\r\n[:space:]]") > + (setq space-p (match-end 0)))) This regexp needs some explanation. Also I don't like the control&data flow very much, here, so you need to compensate this complexity by explaining clearly what this `space-p' is supposed to represent. Same about `end'. > + (setq end (point)) > + (if (and space-p > + (> space-p end) > + (memq mode '(file nil))) > + (setq end space-p)) As mentioned, the control&data flow is pretty ugly, but even then I think the (memq mode '(file nil)) is redundant because space-p can only be non-nil if (memq mode '(file nil)) is non-nil. > + ;; Under Cygwin, convert drive letters in paths. > + (when (and cygwin-p > + (memq mode '(nil file)) > + (string-match "^\\([a-zA-Z]\\):[/\\\\]\\(.*\\)" str)) > + (let ((drive (downcase (match-string 1 str))) > + (path (match-string 2 str))) > + (setq str (format "/cygdrive/%s/%s" > + drive > + (replace-regexp-in-string "[\\\\]" "/" path))))) This shouldn't be here: the right way to do it is to make the Cygwin Emacs accept Windows-style file name. ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) 2012-10-20 1:44 ` Stefan Monnier @ 2012-10-20 1:49 ` Daniel Colascione 2012-10-20 7:56 ` bug#8439: [PATCH] ffap.el -- detect paths with spaces (v3) jari 2012-10-20 8:11 ` bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) Eli Zaretskii 2 siblings, 0 replies; 29+ messages in thread From: Daniel Colascione @ 2012-10-20 1:49 UTC (permalink / raw) To: Stefan Monnier; +Cc: 8439, Jari Aalto [-- Attachment #1: Type: text/plain, Size: 3362 bytes --] On 10/19/2012 6:44 PM, Stefan Monnier wrote: > A few comments about your patch below. > > > Stefan > > >> + (let* ((cygwin-p (string-match "cygwin" (emacs-version))) > > Test system-type instead. > >> + (if (and ffap-paths-with-spaces >> + (memq mode '(nil file))) >> + (if (string-match "^[ \t]*$" >> + (buffer-substring (line-beginning-position) >> + (point))) > > Better match the buffer (e.g. with forward-line + looking-at, or in this > case with skip-chars-backward + bolp) than extract a part of the buffer > and then apply string-match to it. > >> + ;; Nothing interesting before point. Move to the first character > > Please terminate your comments with proper punctuation. > >> + (skip-chars-forward " \t" (line-end-position)) >> + ;; If at colon, move a little forward so that next >> + ;; `re-search-backward' can position at drive letter. >> + (if (looking-at ":/") >> + (forward-char 1)) >> + ;; Skip until drive path start or patch start letter >> + (while (re-search-backward "[a-zA-Z]:[\\\\/]\\|[/\\\\]" >> + (line-beginning-position) t) >> + (goto-char (match-beginning 0))))) > > This code seems to assume Windows-style file names, whereas none of the > var names nor comments mention anything about this assumption. > > I'm not sure we should make this assumption, but it's probably OK to > consider that spaces only appear in Windows-style file names. Just make > this reasoning explicit in a comment. > >> + (when (and ffap-paths-with-spaces >> + (memq mode '(nil file))) >> + ;; Paths may contains spaces, allow those >> + (if (looking-at >> + "[^\t\r\n]*[/\\\\][^][<>()\"';:|\t\r\n]*[^][<>()\"';:|\r\n[:space:]]") >> + (setq space-p (match-end 0)))) > > This regexp needs some explanation. Also I don't like the control&data > flow very much, here, so you need to compensate this complexity by > explaining clearly what this `space-p' is supposed to represent. > Same about `end'. > >> + (setq end (point)) >> + (if (and space-p >> + (> space-p end) >> + (memq mode '(file nil))) >> + (setq end space-p)) > > As mentioned, the control&data flow is pretty ugly, but even then > I think the (memq mode '(file nil)) is redundant because space-p can > only be non-nil if (memq mode '(file nil)) is non-nil. > >> + ;; Under Cygwin, convert drive letters in paths. >> + (when (and cygwin-p >> + (memq mode '(nil file)) >> + (string-match "^\\([a-zA-Z]\\):[/\\\\]\\(.*\\)" str)) >> + (let ((drive (downcase (match-string 1 str))) >> + (path (match-string 2 str))) >> + (setq str (format "/cygdrive/%s/%s" >> + drive >> + (replace-regexp-in-string "[\\\\]" "/" path))))) > > This shouldn't be here: the right way to do it is to make the Cygwin > Emacs accept Windows-style file name. Stefan is right. But if you do want to convert Cygwin paths in some other context, please use cygwin-convert-path-from-windows and cygwin-convert-path-to-windows instead of hard-coding a particular mapping. (Not everyone's Cygwin drive prefix is "/cygdrive".) [-- Attachment #2: OpenPGP digital signature --] [-- Type: application/pgp-signature, Size: 256 bytes --] ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v3) 2012-10-20 1:44 ` Stefan Monnier 2012-10-20 1:49 ` Daniel Colascione @ 2012-10-20 7:56 ` jari 2012-10-20 8:45 ` bug#8439: [PATCH] ffap.el -- detect paths with spaces (v4) jari 2012-10-20 8:11 ` bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) Eli Zaretskii 2 siblings, 1 reply; 29+ messages in thread From: jari @ 2012-10-20 7:56 UTC (permalink / raw) To: Stefan Monnier; +Cc: 8439 [-- Attachment #1: Type: text/plain, Size: 366 bytes --] On 2012-10-19 21:44, Stefan Monnier wrote: | A few comments about your patch below. Included. I also worked on Eli's ideas about detecting "/" or "\" near point. The patch has increased significantly as there are no easy way to deal with spaces. For test cases I've used, it looks promising. Here is also ffap.el with the patch included for "live" testing. Jari [-- Attachment #2: 0001-lisp-ffap.el-Detect-patchs-with-spaces.patch --] [-- Type: text/x-diff, Size: 8627 bytes --] From e0bf484d6dd08344b53d285614300ccd42e012dc Mon Sep 17 00:00:00 2001 From: Jari Aalto <jari.aalto@cante.net> Date: Sat, 20 Oct 2012 10:43:35 +0300 Subject: [PATCH] lisp/ffap.el: Detect patchs with spaces. Organization: Private Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit 2012-10-19 Fri Jari Aalto <jari.aalto@cante.net> * ffap.el (ffap-file-name-with-spaces-flag): New variable. (ffap-cygwin-convert): New function. (ffap-search-forward-file-end): New function. (ffap-search-backward-file-end): New function. (ffap-path-separator-near-point): New function. (ffap-string-at-point): If `ffap-file-name-with-spaces-flag' is set, allow spaces in file names. Signed-off-by: Jari Aalto <jari.aalto@cante.net> --- lisp/ffap.el | 186 ++++++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 167 insertions(+), 19 deletions(-) diff --git a/lisp/ffap.el b/lisp/ffap.el index 4c75609..3195a1a 100644 --- a/lisp/ffap.el +++ b/lisp/ffap.el @@ -1036,6 +1036,135 @@ possibly a major-mode name, or one of the symbol ;; Added at suggestion of RHOGEE (for ff-paths), 7/24/95. "Last string returned by `ffap-string-at-point'.") +;; Test cases: (let ((ffap-file-name-with-spaces-flag t)) (ffap-string-at-point)) +;; +;; c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program here.txt +;; c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program Files/Hummingbird/ +;; c:\Program Files\Open Text Evaluation Media\Open Text Exceed 14 x86\Program Files\Hummingbird\ +;; c:\Program Files\Freescale\CW for MPC55xx and MPC56xx 2.10\PowerPC_EABI_Tools\Command_Line_Tools\CLT_Usage_Notes.txt +;; C:\temp\program.log on Windows or /var/log/program.log on Unix. + +(defvar ffap-file-name-with-spaces-flag (memq system-type '(ms-dos windows-nt)) + "If non-nil, enable looking for paths with spaces in `ffap-string-at-point'. +Enabled in W32 by default.") + +(defun ffap-cygwin-path (path) + "Convert \"<drive>:\" into \"/cygdrive/<drive>\"." + (if (string-match "^\\([a-zA-Z]\\):[/\\\\]\\(.*\\)" path) + (let ((drive (downcase (match-string 1 path))) + (str (match-string 2 path))) + (format "/cygdrive/%s/%s" + drive + (replace-regexp-in-string "[\\\\]" "/" str))) + path)) + +(defun ffap-cygwin-convert (path) + "If in Cygwin, convert \"<drive>:\" to \"/cygdrive/<drive>\"." + (if (eq system-type 'cygwin) + (ffap-cygwin-path path) + path)) + +(defun ffap-search-backward-file-end (&optional path-separator end) + "Search backward position point where file would probably end. +Optional PATH-SEPARATOR defaults to \"/\". The search maximum is +`line-end-position' or optional END point. + +Suppose the cursor is somewhere that might be near end of file, +the guessing would position point before punctuation (like comma) +after the file extension: + + C:\temp\file.log, which contain .... + =============================== (before) + ---------------- (after) + + + C:\temp\file.log on Windows or /tmp/file.log on Unix + =============================== (before) + ---------------- (after) + +The strategy is to search backward until PATH-SEPARATOR which defaults to +\"/\" and then take educated guesses. + +Move point and return point if an adjustment was done." + (or path-separator + (setq path-separator "/")) + (let (point + puct + end + whitespace-p) + (when (re-search-backward + (regexp-quote path-separator) (line-beginning-position) t) + (forward-char 1) ;at the very beginning of match + (when (looking-at ".*?\\([][<>()\"'`,.:;]\\)") ;until typical punctuation + (setq end (match-end 0)) + (setq punct (match-string 1)) + (setq whitespace-p (looking-at "[ \t\r\n]\\|$")) + (goto-char end) + (cond + ((and (string-equal punct ".") + whitespace-p) ;end of sentence + (setq point (1- (point)))) + ((and (string-equal punct ".") + (looking-at "[a-zA-Z0-9.]+")) ;possibly file extension + (setq point (match-end 0))) + (t + (setq point (point))))) + (when point + (goto-char point) + point)))) + +(defun ffap-search-forward-file-end (&optional path-separator) + "Search PATH-SEPARATOR and position point at file's maximum ending (including spaces). +Optional PATH-SEPARATOR defaults to \"/\". +Call `ffap-search-backward-file-end' to refine the ending point." + (or path-separator + (setq path-separator "/")) + (let* ((chars ;expected chars in file name + (concat "[^][^<>()\"'`;,#*|" + ;; exclude the opposite as we know the separator + (if (string-equal path-separator "/") + "\\\\" + "/") + "\t\r\n]")) + (re (concat + chars "*" + (if path-separator + (regexp-quote path-separator) + "/") + chars "*"))) + (when (looking-at re) + (goto-char (match-end 0))))) + +(defun ffap-path-separator-near-point () + "Search backward and forward for closest slash or backlash in line. +Return string slash or backslash. Point is moved to closest position." + (let ((point (point)) + str + pos) + (if (looking-at ".*?/") + (setq str "/" + pos (match-end 0))) + (if (looking-at ".*?\\\\") + (if (or (null pos) + (< (match-end 0) pos)) + (setq str "\\" + pos (match-end 0)))) + (goto-char point) + (if (re-search-backward "/" (line-beginning-position) t) + (if (or (null pos) + (< (- point (point)) (- pos point))) + (setq str "/" + pos (1+ (point))))) ;1+ to keep cursor at the end of char + (goto-char point) + (if (re-search-backward "\\\\" (line-beginning-position) t) + (if (or (null pos) + (< (- point (point)) (- pos point))) + (setq str "\\" + pos (1+ (point))))) + (if pos + (goto-char pos)) + str)) + (defun ffap-string-at-point (&optional mode) "Return a string of characters from around point. MODE (defaults to value of `major-mode') is a symbol used to look up string @@ -1043,26 +1172,45 @@ syntax parameters in `ffap-string-at-point-mode-alist'. If MODE is not found, we use `file' instead of MODE. If the region is active, return a string from the region. Sets `ffap-string-at-point' and `ffap-string-at-point-region'." - (let* ((args - (cdr - (or (assq (or mode major-mode) ffap-string-at-point-mode-alist) - (assq 'file ffap-string-at-point-mode-alist)))) - (pt (point)) - (str - (if (and transient-mark-mode mark-active) - (buffer-substring - (setcar ffap-string-at-point-region (region-beginning)) - (setcar (cdr ffap-string-at-point-region) (region-end))) - (buffer-substring - (save-excursion - (skip-chars-backward (car args)) - (skip-chars-forward (nth 1 args) pt) - (setcar ffap-string-at-point-region (point))) - (save-excursion - (skip-chars-forward (car args)) - (skip-chars-backward (nth 2 args) pt) - (setcar (cdr ffap-string-at-point-region) (point))))))) + (let* ((cygwin-p (string-match "cygwin" (emacs-version))) + path-separator + beg + end + (args + (cdr + (or (assq (or mode major-mode) ffap-string-at-point-mode-alist) + (assq 'file ffap-string-at-point-mode-alist)))) + (pt (point)) + (str + (if (and transient-mark-mode mark-active) + (buffer-substring + (setcar ffap-string-at-point-region (region-beginning)) + (setcar (cdr ffap-string-at-point-region) (region-end))) + (buffer-substring + (save-excursion + (if (and ffap-file-name-with-spaces-flag + (memq mode '(nil file))) + (when (setq path-separator (ffap-path-separator-near-point)) + (while (re-search-backward + (regexp-quote path-separator) + (line-beginning-position) t) + (goto-char (match-beginning 0))))) + (skip-chars-backward (car args)) + (skip-chars-forward (nth 1 args) pt) + (setcar ffap-string-at-point-region (point)) + (setq beg (point))) + (save-excursion + (skip-chars-forward (car args)) + (skip-chars-backward (nth 2 args) pt) + (setq end (point)) + (when (and ffap-file-name-with-spaces-flag + (memq mode '(nil file))) + (ffap-search-forward-file-end path-separator) + (ffap-search-backward-file-end path-separator) + (setq end (point))) + (setcar (cdr ffap-string-at-point-region) end)))))) (set-text-properties 0 (length str) nil str) + (setq str (ffap-cygwin-convert str)) (setq ffap-string-at-point str))) (defun ffap-string-around () -- 1.7.10.4 [-- Attachment #3: ffap--jari-2012-10-20-git-ec3edd7.el --] [-- Type: text/plain, Size: 78681 bytes --] ;;; ffap.el --- find file (or url) at point ;; Copyright (C) 1995-1997, 2000-2012 Free Software Foundation, Inc. ;; Author: Michelangelo Grigni <mic@mathcs.emory.edu> ;; Maintainer: FSF ;; Created: 29 Mar 1993 ;; Keywords: files, hypermedia, matching, mouse, convenience ;; X-URL: ftp://ftp.mathcs.emory.edu/pub/mic/emacs/ ;; This file is part of GNU Emacs. ;; GNU Emacs is free software: you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation, either version 3 of the License, or ;; (at your option) any later version. ;; GNU Emacs is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. \f ;;; Commentary: ;; ;; Command find-file-at-point replaces find-file. With a prefix, it ;; behaves exactly like find-file. Without a prefix, it first tries ;; to guess a default file or URL from the text around the point ;; (`ffap-require-prefix' swaps these behaviors). This is useful for ;; following references in situations such as mail or news buffers, ;; README's, MANIFEST's, and so on. Submit bugs or suggestions with ;; M-x ffap-bug. ;; ;; For the default installation, add this line to your init file: ;; ;; (ffap-bindings) ; do default key bindings ;; ;; ffap-bindings makes the following global key bindings: ;; ;; C-x C-f find-file-at-point (abbreviated as ffap) ;; C-x C-r ffap-read-only ;; C-x C-v ffap-alternate-file ;; ;; C-x d dired-at-point ;; C-x C-d ffap-list-directory ;; ;; C-x 4 f ffap-other-window ;; C-x 4 r ffap-read-only-other-window ;; C-x 4 d ffap-dired-other-window ;; ;; C-x 5 f ffap-other-frame ;; C-x 5 r ffap-read-only-other-frame ;; C-x 5 d ffap-dired-other-frame ;; ;; S-mouse-3 ffap-at-mouse ;; C-S-mouse-3 ffap-menu ;; ;; ffap-bindings also adds hooks to make the following local bindings ;; in vm, gnus, and rmail: ;; ;; M-l ffap-next, or ffap-gnus-next in gnus (l == "link") ;; M-m ffap-menu, or ffap-gnus-menu in gnus (m == "menu") ;; ;; If you do not like these bindings, modify the variable ;; `ffap-bindings', or write your own. ;; ;; If you use ange-ftp, browse-url, complete, efs, or w3, it is best ;; to load or autoload them before ffap. If you use ff-paths, load it ;; afterwards. Try apropos {C-h a ffap RET} to get a list of the many ;; option variables. In particular, if ffap is slow, try these: ;; ;; (setq ffap-alist nil) ; faster, dumber prompting ;; (setq ffap-machine-p-known 'accept) ; no pinging ;; (setq ffap-url-regexp nil) ; disable URL features in ffap ;; (setq ffap-shell-prompt-regexp nil) ; disable shell prompt stripping ;; ;; ffap uses `browse-url' (if found, else `w3-fetch') to fetch URL's. ;; For a hairier `ffap-url-fetcher', try ffap-url.el (same ftp site). ;; Also, you can add `ffap-menu-rescan' to various hooks to fontify ;; the file and URL references within a buffer. \f ;;; Change Log: ;; ;; The History and Contributors moved to ffap.LOG (same ftp site), ;; which also has some old examples and commentary from ffap 1.5. \f ;;; Todo list: ;; * use kpsewhich ;; * let "/dir/file#key" jump to key (tag or regexp) in /dir/file ;; * find file of symbol if TAGS is loaded (like above) ;; * break long menus into multiple panes (like imenu?) ;; * notice node in "(dired)Virtual Dired" (quotes, parentheses, whitespace) ;; * notice "machine.dom blah blah blah dir/file" (how?) ;; * as w3 becomes standard, rewrite to rely more on its functions ;; * regexp options for ffap-string-at-point, like font-lock (MCOOK) ;; * v19: could replace `ffap-locate-file' with a quieter `locate-library' ;; * handle "$(VAR)" in Makefiles ;; * use the font-lock machinery \f ;;; Code: (require 'url-parse) (define-obsolete-variable-alias 'ffap-version 'emacs-version "23.2") (defgroup ffap nil "Find file or URL at point." ;; Dead 2009/07/05. ;; :link '(url-link :tag "URL" "ftp://ftp.mathcs.emory.edu/pub/mic/emacs/") :group 'matching :group 'convenience) ;; The code is organized in pages, separated by formfeed characters. ;; See the next two pages for standard customization ideas. \f ;;; User Variables: (defun ffap-symbol-value (sym &optional default) "Return value of symbol SYM, if bound, or DEFAULT otherwise." (if (boundp sym) (symbol-value sym) default)) (defcustom ffap-shell-prompt-regexp ;; This used to test for some shell prompts that don't have a space ;; after them. The common root shell prompt (#) is not listed since it ;; also doubles up as a valid URL character. "[$%><]*" "Paths matching this regexp are stripped off the shell prompt. If nil, ffap doesn't do shell prompt stripping." :type '(choice (const :tag "Disable" nil) (const :tag "Standard" "[$%><]*") regexp) :group 'ffap) (defcustom ffap-ftp-regexp "\\`/[^/:]+:" "File names matching this regexp are treated as remote ffap. If nil, ffap neither recognizes nor generates such names." :type '(choice (const :tag "Disable" nil) (const :tag "Standard" "\\`/[^/:]+:") regexp) :group 'ffap) (defcustom ffap-url-unwrap-local t "If non-nil, convert some URLs to local file names before prompting. Only \"file:\" and \"ftp:\" URLs are converted, and only if they do not specify a host, or the host is either \"localhost\" or equal to `system-name'." :type 'boolean :group 'ffap) (defcustom ffap-url-unwrap-remote '("ftp") "If non-nil, convert URLs to remote file names before prompting. If the value is a list of strings, that specifies a list of URL schemes (e.g. \"ftp\"); in that case, only convert those URLs." :type '(choice (repeat string) boolean) :group 'ffap :version "24.3") (defcustom ffap-ftp-default-user "anonymous" "User name in ftp file names generated by `ffap-host-to-path'. Note this name may be omitted if it equals the default \(either `efs-default-user' or `ange-ftp-default-user'\)." :type 'string :group 'ffap) (defcustom ffap-rfs-regexp ;; Remote file access built into file system? HP rfa or Andrew afs: "\\`/\\(afs\\|net\\)/." ;; afs only: (and (file-exists-p "/afs") "\\`/afs/.") "Matching file names are treated as remote. Use nil to disable." :type 'regexp :group 'ffap) (defvar ffap-url-regexp ;; Could just use `url-nonrelative-link' of w3, if loaded. ;; This regexp is not exhaustive, it just matches common cases. (concat "\\`\\(" "news\\(post\\)?:\\|mailto:\\|file:" ; no host ok "\\|" "\\(ftp\\|https?\\|telnet\\|gopher\\|www\\|wais\\)://" ; needs host "\\)." ; require one more character ) "Regexp matching URLs. Use nil to disable URL features in ffap.") (defcustom ffap-foo-at-bar-prefix "mailto" "Presumed URL prefix type of strings like \"<foo.9z@bar>\". Sensible values are nil, \"news\", or \"mailto\"." :type '(choice (const "mailto") (const "news") (const :tag "Disable" nil) ;; string -- possible, but not really useful ) :group 'ffap) \f ;;; Peanut Gallery (More User Variables): ;; ;; Users of ffap occasionally suggest new features. If I consider ;; those features interesting but not clear winners (a matter of ;; personal taste) I try to leave options to enable them. Read ;; through this section for features that you like, put an appropriate ;; enabler in your init file. (defcustom ffap-dired-wildcards "[*?][^/]*\\'" "A regexp matching filename wildcard characters, or nil. If `find-file-at-point' gets a filename matching this pattern, and `ffap-pass-wildcards-to-dired' is nil, it passes it on to `find-file' with non-nil WILDCARDS argument, which expands wildcards and visits multiple files. To visit a file whose name contains wildcard characters you can suppress wildcard expansion by setting `find-file-wildcards'. If `find-file-at-point' gets a filename matching this pattern and `ffap-pass-wildcards-to-dired' is non-nil, it passes it on to `dired'. If `dired-at-point' gets a filename matching this pattern, it passes it on to `dired'." :type '(choice (const :tag "Disable" nil) (const :tag "Enable" "[*?][^/]*\\'") ;; regexp -- probably not useful ) :group 'ffap) (defcustom ffap-pass-wildcards-to-dired nil "If non-nil, pass filenames matching `ffap-dired-wildcards' to dired." :type 'boolean :group 'ffap) (defcustom ffap-newfile-prompt nil ;; Suggestion from RHOGEE, 11 Jul 1994. Disabled, I think this is ;; better handled by `find-file-not-found-hooks'. "Whether `find-file-at-point' prompts about a nonexistent file." :type 'boolean :group 'ffap) (defcustom ffap-require-prefix nil ;; Suggestion from RHOGEE, 20 Oct 1994. "If set, reverses the prefix argument to `find-file-at-point'. This is nil so neophytes notice ffap. Experts may prefer to disable ffap most of the time." :type 'boolean :group 'ffap) (defcustom ffap-file-finder 'find-file "The command called by `find-file-at-point' to find a file." :type 'function :group 'ffap :risky t) (defcustom ffap-directory-finder 'dired "The command called by `dired-at-point' to find a directory." :type 'function :group 'ffap :risky t) (defcustom ffap-url-fetcher (if (fboundp 'browse-url) 'browse-url ; rely on browse-url-browser-function 'w3-fetch) ;; Remote control references: ;; http://www.ncsa.uiuc.edu/SDG/Software/XMosaic/remote-control.html ;; http://home.netscape.com/newsref/std/x-remote.html "A function of one argument, called by ffap to fetch an URL. Reasonable choices are `w3-fetch' or a `browse-url-*' function. For a fancy alternative, get `ffap-url.el'." :type '(choice (const w3-fetch) (const browse-url) ; in recent versions of browse-url (const browse-url-netscape) (const browse-url-mosaic) function) :group 'ffap :risky t) (defcustom ffap-next-regexp ;; If you want ffap-next to find URL's only, try this: ;; (and ffap-url-regexp (string-match "\\\\`" ffap-url-regexp) ;; (concat "\\<" (substring ffap-url-regexp 2)))) ;; ;; It pays to put a big fancy regexp here, since ffap-guesser is ;; much more time-consuming than regexp searching: "[/:.~[:alpha:]]/\\|@[[:alpha:]][-[:alnum:]]*\\." "Regular expression governing movements of `ffap-next'." :type 'regexp :group 'ffap) (defcustom dired-at-point-require-prefix nil "If non-nil, reverse the prefix argument to `dired-at-point'. This is nil so neophytes notice FFAP. Experts may prefer to disable FFAP most of the time." :type 'boolean :group 'ffap :version "20.3") \f ;;; Compatibility: ;; ;; This version of ffap supports only the Emacs it is distributed in. ;; See the ftp site for a more general version. The following ;; functions are necessary "leftovers" from the more general version. (defun ffap-mouse-event () ; current mouse event, or nil (and (listp last-nonmenu-event) last-nonmenu-event)) (defun ffap-event-buffer (event) (window-buffer (car (event-start event)))) \f ;;; Find Next Thing in buffer (`ffap-next'): ;; ;; Original ffap-next-url (URL's only) from RPECK 30 Mar 1995. Since ;; then, broke it up into ffap-next-guess (noninteractive) and ;; ffap-next (a command). It now work on files as well as url's. (defvar ffap-next-guess nil "Last value returned by `ffap-next-guess'.") (defvar ffap-string-at-point-region '(1 1) "List (BEG END), last region returned by `ffap-string-at-point'.") (defun ffap-next-guess (&optional back lim) "Move point to next file or URL, and return it as a string. If nothing is found, leave point at limit and return nil. Optional BACK argument makes search backwards. Optional LIM argument limits the search. Only considers strings that match `ffap-next-regexp'." (or lim (setq lim (if back (point-min) (point-max)))) (let (guess) (while (not (or guess (eq (point) lim))) (funcall (if back 're-search-backward 're-search-forward) ffap-next-regexp lim 'move) (setq guess (ffap-guesser))) ;; Go to end, so we do not get same guess twice: (goto-char (nth (if back 0 1) ffap-string-at-point-region)) (setq ffap-next-guess guess))) ;;;###autoload (defun ffap-next (&optional back wrap) "Search buffer for next file or URL, and run ffap. Optional argument BACK says to search backwards. Optional argument WRAP says to try wrapping around if necessary. Interactively: use a single prefix to search backwards, double prefix to wrap forward, triple to wrap backwards. Actual search is done by `ffap-next-guess'." (interactive (cdr (assq (prefix-numeric-value current-prefix-arg) '((1) (4 t) (16 nil t) (64 t t))))) (let ((pt (point)) (guess (ffap-next-guess back))) ;; Try wraparound if necessary: (and (not guess) wrap (goto-char (if back (point-max) (point-min))) (setq guess (ffap-next-guess back pt))) (if guess (progn (sit-for 0) ; display point movement (find-file-at-point (ffap-prompter guess))) (goto-char pt) ; restore point (message "No %sfiles or URL's found" (if wrap "" "more "))))) (defun ffap-next-url (&optional back wrap) "Like `ffap-next', but search with `ffap-url-regexp'." (interactive) (let ((ffap-next-regexp ffap-url-regexp)) (if (called-interactively-p 'interactive) (call-interactively 'ffap-next) (ffap-next back wrap)))) \f ;;; Machines (`ffap-machine-p'): ;; I cannot decide a "best" strategy here, so these are variables. In ;; particular, if `Pinging...' is broken or takes too long on your ;; machine, try setting these all to accept or reject. (defcustom ffap-machine-p-local 'reject ; this happens often "What `ffap-machine-p' does with hostnames that have no domain. Value should be a symbol, one of `ping', `accept', and `reject'." :type '(choice (const ping) (const accept) (const reject)) :group 'ffap) (defcustom ffap-machine-p-known 'ping ; `accept' for higher speed "What `ffap-machine-p' does with hostnames that have a known domain. Value should be a symbol, one of `ping', `accept', and `reject'. See `mail-extr.el' for the known domains." :type '(choice (const ping) (const accept) (const reject)) :group 'ffap) (defcustom ffap-machine-p-unknown 'reject "What `ffap-machine-p' does with hostnames that have an unknown domain. Value should be a symbol, one of `ping', `accept', and `reject'. See `mail-extr.el' for the known domains." :type '(choice (const ping) (const accept) (const reject)) :group 'ffap) (defun ffap-what-domain (domain) ;; Like what-domain in mail-extr.el, returns string or nil. (require 'mail-extr) (let ((ob (or (ffap-symbol-value 'mail-extr-all-top-level-domains) (ffap-symbol-value 'all-top-level-domains)))) ; XEmacs (and ob (get (intern-soft (downcase domain) ob) 'domain-name)))) (defun ffap-machine-p (host &optional service quiet strategy) "Decide whether HOST is the name of a real, reachable machine. Depending on the domain (none, known, or unknown), follow the strategy named by the variable `ffap-machine-p-local', `ffap-machine-p-known', or `ffap-machine-p-unknown'. Pinging uses `open-network-stream'. Optional SERVICE specifies the port used \(default \"discard\"\). Optional QUIET flag suppresses the \"Pinging...\" message. Optional STRATEGY overrides the three variables above. Returned values: t means that HOST answered. 'accept means the relevant variable told us to accept. \"mesg\" means HOST exists, but does not respond for some reason." ;; Try some (Emory local): ;; (ffap-machine-p "ftp" nil nil 'ping) ;; (ffap-machine-p "nonesuch" nil nil 'ping) ;; (ffap-machine-p "ftp.mathcs.emory.edu" nil nil 'ping) ;; (ffap-machine-p "mathcs" 5678 nil 'ping) ;; (ffap-machine-p "foo.bonk" nil nil 'ping) ;; (ffap-machine-p "foo.bonk.com" nil nil 'ping) (if (or (string-match "[^-[:alnum:].]" host) ; Invalid chars (?) (not (string-match "[^0-9]" host))) ; 1: a number? 2: quick reject nil (let* ((domain (and (string-match "\\.[^.]*$" host) (downcase (substring host (1+ (match-beginning 0)))))) (what-domain (if domain (ffap-what-domain domain) "Local"))) (or strategy (setq strategy (cond ((not domain) ffap-machine-p-local) ((not what-domain) ffap-machine-p-unknown) (t ffap-machine-p-known)))) (cond ((eq strategy 'accept) 'accept) ((eq strategy 'reject) nil) ((not (fboundp 'open-network-stream)) nil) ;; assume (eq strategy 'ping) (t (or quiet (if (stringp what-domain) (message "Pinging %s (%s)..." host what-domain) (message "Pinging %s ..." host))) (condition-case error (progn (delete-process (open-network-stream "ffap-machine-p" nil host (or service "discard"))) t) (error (let ((mesg (car (cdr error)))) (cond ;; v18: ((string-match "^Unknown host" mesg) nil) ((string-match "not responding$" mesg) mesg) ;; v19: ;; (file-error "connection failed" "permission denied" ;; "nonesuch" "ffap-machine-p") ;; (file-error "connection failed" "host is unreachable" ;; "gopher.house.gov" "ffap-machine-p") ;; (file-error "connection failed" "address already in use" ;; "ftp.uu.net" "ffap-machine-p") ((equal mesg "connection failed") (if (equal (nth 2 error) "permission denied") nil ; host does not exist ;; Other errors mean the host exists: (nth 2 error))) ;; Could be "Unknown service": (t (signal (car error) (cdr error)))))))))))) \f ;;; Possibly Remote Resources: (defun ffap-replace-file-component (fullname name) "In remote FULLNAME, replace path with NAME. May return nil." ;; Use efs if loaded, but do not load it otherwise. (if (fboundp 'efs-replace-path-component) (funcall efs-replace-path-component fullname name) (and (stringp fullname) (stringp name) (concat (file-remote-p fullname) name)))) ;; (ffap-replace-file-component "/who@foo.com:/whatever" "/new") (defun ffap-file-suffix (file) "Return trailing `.foo' suffix of FILE, or nil if none." (let ((pos (string-match "\\.[^./]*\\'" file))) (and pos (substring file pos nil)))) (defvar ffap-compression-suffixes '(".gz" ".Z") ; .z is mostly dead "List of suffixes tried by `ffap-file-exists-string'.") (defun ffap-file-exists-string (file &optional nomodify) ;; Early jka-compr versions modified file-exists-p to return the ;; filename, maybe modified by adding a suffix like ".gz". That ;; broke the interface of file-exists-p, so it was later dropped. ;; Here we document and simulate the old behavior. "Return FILE (maybe modified) if the file exists, else nil. When using jka-compr (a.k.a. `auto-compression-mode'), the returned name may have a suffix added from `ffap-compression-suffixes'. The optional NOMODIFY argument suppresses the extra search." (cond ((not file) nil) ; quietly reject nil ((file-exists-p file) file) ; try unmodified first ;; three reasons to suppress search: (nomodify nil) ((not (rassq 'jka-compr-handler file-name-handler-alist)) nil) ((member (ffap-file-suffix file) ffap-compression-suffixes) nil) (t ; ok, do the search (let ((list ffap-compression-suffixes) try ret) (while list (if (file-exists-p (setq try (concat file (car list)))) (setq ret try list nil) (setq list (cdr list)))) ret)))) (defun ffap-file-remote-p (filename) "If FILENAME looks remote, return it (maybe slightly improved)." ;; (ffap-file-remote-p "/user@foo.bar.com:/pub") ;; (ffap-file-remote-p "/cssun.mathcs.emory.edu://dir") ;; (ffap-file-remote-p "/ffap.el:80") (or (and ffap-ftp-regexp (string-match ffap-ftp-regexp filename) ;; Convert "/host.com://dir" to "/host:/dir", to handle a dying ;; practice of advertising ftp files as "host.dom://filename". (if (string-match "//" filename) ;; (replace-match "/" nil nil filename) (concat (substring filename 0 (1+ (match-beginning 0))) (substring filename (match-end 0))) filename)) (and ffap-rfs-regexp (string-match ffap-rfs-regexp filename) filename))) (defun ffap-machine-at-point () "Return machine name at point if it exists, or nil." (let ((mach (ffap-string-at-point 'machine))) (and (ffap-machine-p mach) mach))) (defsubst ffap-host-to-filename (host) "Convert HOST to something like \"/USER@HOST:\" or \"/HOST:\". Looks at `ffap-ftp-default-user', returns \"\" for \"localhost\"." (if (equal host "localhost") "" (let ((user ffap-ftp-default-user)) ;; Avoid including the user if it is same as default: (if (or (equal user (ffap-symbol-value 'ange-ftp-default-user)) (equal user (ffap-symbol-value 'efs-default-user))) (setq user nil)) (concat "/" user (and user "@") host ":")))) (defun ffap-fixup-machine (mach) ;; Convert a hostname into an url, an ftp file name, or nil. (cond ((not (and ffap-url-regexp (stringp mach))) nil) ;; gopher.well.com ((string-match "\\`gopher[-.]" mach) ; or "info"? (concat "gopher://" mach "/")) ;; www.ncsa.uiuc.edu ((and (string-match "\\`w\\(ww\\|eb\\)[-.]" mach)) (concat "http://" mach "/")) ;; More cases? Maybe "telnet:" for archie? (ffap-ftp-regexp (ffap-host-to-filename mach)) )) (defvar ffap-newsgroup-regexp "^[[:lower:]]+\\.[-+[:lower:]_0-9.]+$" "Strings not matching this fail `ffap-newsgroup-p'.") (defvar ffap-newsgroup-heads ; entirely inadequate '("alt" "comp" "gnu" "misc" "news" "sci" "soc" "talk") "Used by `ffap-newsgroup-p' if gnus is not running.") (defun ffap-newsgroup-p (string) "Return STRING if it looks like a newsgroup name, else nil." (and (string-match ffap-newsgroup-regexp string) (let ((htbs '(gnus-active-hashtb gnus-newsrc-hashtb gnus-killed-hashtb)) (heads ffap-newsgroup-heads) htb ret) (while htbs (setq htb (car htbs) htbs (cdr htbs)) (condition-case nil (progn ;; errs: htb symbol may be unbound, or not a hash-table. ;; gnus-gethash is just a macro for intern-soft. (and (symbol-value htb) (intern-soft string (symbol-value htb)) (setq ret string htbs nil)) ;; If we made it this far, gnus is running, so ignore "heads": (setq heads nil)) (error nil))) (or ret (not heads) (let ((head (string-match "\\`\\([[:lower:]]+\\)\\." string))) (and head (setq head (substring string 0 (match-end 1))) (member head heads) (setq ret string)))) ;; Is there ever a need to modify string as a newsgroup name? ret))) (defsubst ffap-url-p (string) "If STRING looks like an URL, return it (maybe improved), else nil." (let ((case-fold-search t)) (and ffap-url-regexp (string-match ffap-url-regexp string) ;; I lied, no improvement: string))) ;; Broke these out of ffap-fixup-url, for use of ffap-url package. (defun ffap-url-unwrap-local (url) "Return URL as a local file name, or nil." (let* ((obj (url-generic-parse-url url)) (host (url-host obj)) (filename (car (url-path-and-query obj)))) (when (and (member (url-type obj) '("ftp" "file")) (member host `("" "localhost" ,(system-name)))) ;; On Windows, "file:///C:/foo" should unwrap to "C:/foo" (if (and (memq system-type '(ms-dos windows-nt cygwin)) (string-match "\\`/[a-zA-Z]:" filename)) (substring filename 1) filename)))) (defun ffap-url-unwrap-remote (url) "Return URL as a remote file name, or nil." (let* ((obj (url-generic-parse-url url)) (scheme (url-type obj)) (valid-schemes (if (listp ffap-url-unwrap-remote) ffap-url-unwrap-remote '("ftp"))) (host (url-host obj)) (port (url-port-if-non-default obj)) (user (url-user obj)) (filename (car (url-path-and-query obj)))) (when (and (member scheme valid-schemes) (string-match "\\`[a-zA-Z][-a-zA-Z0-9+.]*\\'" scheme) (not (equal host ""))) (concat "/" scheme ":" (if user (concat user "@")) host (if port (concat "#" (number-to-string port))) ":" filename)))) (defun ffap-fixup-url (url) "Clean up URL and return it, maybe as a file name." (cond ((not (stringp url)) nil) ((and ffap-url-unwrap-local (ffap-url-unwrap-local url))) ((and ffap-url-unwrap-remote (ffap-url-unwrap-remote url))) (url))) \f ;;; File Name Handling: ;; ;; The upcoming ffap-alist actions need various utilities to prepare ;; and search directories. Too many features here. ;; (defun ffap-last (l) (while (cdr l) (setq l (cdr l))) l) ;; (defun ffap-splice (func inlist) ;; "Equivalent to (apply 'nconc (mapcar FUNC INLIST)), but less consing." ;; (let* ((head (cons 17 nil)) (last head)) ;; (while inlist ;; (setcdr last (funcall func (car inlist))) ;; (setq last (ffap-last last) inlist (cdr inlist))) ;; (cdr head))) (defun ffap-list-env (env &optional empty) "Return a list of strings parsed from environment variable ENV. Optional EMPTY is the default list if \(getenv ENV\) is undefined, and also is substituted for the first empty-string component, if there is one. Uses `path-separator' to separate the path into substrings." ;; We cannot use parse-colon-path (files.el), since it kills ;; "//" entries using file-name-as-directory. ;; Similar: dired-split, TeX-split-string, and RHOGEE's psg-list-env ;; in ff-paths and bib-cite. The EMPTY arg may help mimic kpathsea. (if (or empty (getenv env)) ; should return something (let ((start 0) match dir ret) (setq env (concat (getenv env) path-separator)) (while (setq match (string-match path-separator env start)) (setq dir (substring env start match) start (1+ match)) ;;(and (file-directory-p dir) (not (member dir ret)) ...) (setq ret (cons dir ret))) (setq ret (nreverse ret)) (and empty (setq match (member "" ret)) (progn ; allow string or list here (setcdr match (append (cdr-safe empty) (cdr match))) (setcar match (or (car-safe empty) empty)))) ret))) (defun ffap-reduce-path (path) "Remove duplicates and non-directories from PATH list." (let (ret tem) (while path (setq tem path path (cdr path)) (if (equal (car tem) ".") (setcar tem "")) (or (member (car tem) ret) (not (file-directory-p (car tem))) (progn (setcdr tem ret) (setq ret tem)))) (nreverse ret))) (defun ffap-all-subdirs (dir &optional depth) "Return list of all subdirectories under DIR, starting with itself. Directories beginning with \".\" are ignored, and directory symlinks are listed but never searched (to avoid loops). Optional DEPTH limits search depth." (and (file-exists-p dir) (ffap-all-subdirs-loop (expand-file-name dir) (or depth -1)))) (defun ffap-all-subdirs-loop (dir depth) ; internal (setq depth (1- depth)) (cons dir (and (not (eq depth -1)) (apply 'nconc (mapcar (function (lambda (d) (cond ((not (file-directory-p d)) nil) ((file-symlink-p d) (list d)) (t (ffap-all-subdirs-loop d depth))))) (directory-files dir t "\\`[^.]") ))))) (defvar ffap-kpathsea-depth 1 "Bound on depth of subdirectory search in `ffap-kpathsea-expand-path'. Set to 0 to avoid all searching, or nil for no limit.") (defun ffap-kpathsea-expand-path (path) "Replace each \"//\"-suffixed dir in PATH by a list of its subdirs. The subdirs begin with the original directory, and the depth of the search is bounded by `ffap-kpathsea-depth'. This is intended to mimic kpathsea, a library used by some versions of TeX." (apply 'nconc (mapcar (function (lambda (dir) (if (string-match "[^/]//\\'" dir) (ffap-all-subdirs (substring dir 0 -2) ffap-kpathsea-depth) (list dir)))) path))) (defun ffap-locate-file (file nosuffix path) ;; The current version of locate-library could almost replace this, ;; except it does not let us override the suffix list. The ;; compression-suffixes search moved to ffap-file-exists-string. "A generic path-searching function. Returns the name of file in PATH, or nil. Optional NOSUFFIX, if nil or t, is like the fourth argument for `load': whether to try the suffixes (\".elc\" \".el\" \"\"). If a nonempty list, it is a list of suffixes to try instead. PATH is a list of directories. This uses `ffap-file-exists-string', which may try adding suffixes from `ffap-compression-suffixes'." (if (file-name-absolute-p file) (setq path (list (file-name-directory file)) file (file-name-nondirectory file))) (let ((dir-ok (equal "" (file-name-nondirectory file))) (suffixes-to-try (cond ((consp nosuffix) nosuffix) (nosuffix '("")) (t '(".elc" ".el" "")))) suffixes try found) (while path (setq suffixes suffixes-to-try) (while suffixes (setq try (ffap-file-exists-string (expand-file-name (concat file (car suffixes)) (car path)))) (if (and try (or dir-ok (not (file-directory-p try)))) (setq found try suffixes nil path nil) (setq suffixes (cdr suffixes)))) (setq path (cdr path))) found)) \f ;;; Action List (`ffap-alist'): ;; ;; These search actions depend on the major-mode or regexps matching ;; the current name. The little functions and their variables are ;; deferred to the next section, at some loss of "code locality". A ;; good example of featuritis. Trim this list for speed. (defvar ffap-alist '( ("" . ffap-completable) ; completion, slow on some systems ("\\.info\\'" . ffap-info) ; gzip.info ("\\`info/" . ffap-info-2) ; info/emacs ("\\`[-[:lower:]]+\\'" . ffap-info-3) ; (emacs)Top [only in the parentheses] ("\\.elc?\\'" . ffap-el) ; simple.el, simple.elc (emacs-lisp-mode . ffap-el-mode) ; rmail, gnus, simple, custom ;; (lisp-interaction-mode . ffap-el-mode) ; maybe (finder-mode . ffap-el-mode) ; type {C-h p} and try it (help-mode . ffap-el-mode) ; maybe useful (c++-mode . ffap-c-mode) ; search ffap-c-path (cc-mode . ffap-c-mode) ; same ("\\.\\([chCH]\\|cc\\|hh\\)\\'" . ffap-c-mode) ; stdio.h (fortran-mode . ffap-fortran-mode) ; FORTRAN requested by MDB ("\\.[fF]\\'" . ffap-fortran-mode) (tex-mode . ffap-tex-mode) ; search ffap-tex-path (latex-mode . ffap-latex-mode) ; similar ("\\.\\(tex\\|sty\\|doc\\|cls\\)\\'" . ffap-tex) ("\\.bib\\'" . ffap-bib) ; search ffap-bib-path ("\\`\\." . ffap-home) ; .emacs, .bashrc, .profile ("\\`~/" . ffap-lcd) ; |~/misc/ffap.el.Z| ;; This used to have a blank, but ffap-string-at-point doesn't ;; handle blanks. ;; http://lists.gnu.org/archive/html/emacs-devel/2008-01/msg01058.html ("\\`[Rr][Ff][Cc][-#]?\\([0-9]+\\)" ; no $ . ffap-rfc) ; "100% RFC2100 compliant" (dired-mode . ffap-dired) ; maybe in a subdirectory ) "Alist of \(KEY . FUNCTION\) pairs parsed by `ffap-file-at-point'. If string NAME at point (maybe \"\") is not a file or URL, these pairs specify actions to try creating such a string. A pair matches if either KEY is a symbol, and it equals `major-mode', or KEY is a string, it should match NAME as a regexp. On a match, \(FUNCTION NAME\) is called and should return a file, an URL, or nil. If nil, search the alist for further matches.") (put 'ffap-alist 'risky-local-variable t) ;; Example `ffap-alist' modifications: ;; ;; (setq ffap-alist ; remove a feature in `ffap-alist' ;; (delete (assoc 'c-mode ffap-alist) ffap-alist)) ;; ;; (setq ffap-alist ; add something to `ffap-alist' ;; (cons ;; (cons "^YSN[0-9]+$" ;; (defun ffap-ysn (name) ;; (concat ;; "http://www.physics.uiuc.edu/" ;; "ysn/httpd/htdocs/ysnarchive/issuefiles/" ;; (substring name 3) ".html"))) ;; ffap-alist)) \f ;;; Action Definitions: ;; ;; Define various default members of `ffap-alist'. (defun ffap-completable (name) (let* ((dir (or (file-name-directory name) default-directory)) (cmp (file-name-completion (file-name-nondirectory name) dir))) (and cmp (concat dir cmp)))) (defun ffap-home (name) (ffap-locate-file name t '("~"))) (defun ffap-info (name) (ffap-locate-file name '("" ".info") (or (ffap-symbol-value 'Info-directory-list) (ffap-symbol-value 'Info-default-directory-list) ))) (defun ffap-info-2 (name) (ffap-info (substring name 5))) (defun ffap-info-3 (name) ;; This ignores the node! "(emacs)Top" same as "(emacs)Intro" (and (equal (ffap-string-around) "()") (ffap-info name))) (defun ffap-el (name) (ffap-locate-file name t load-path)) (defun ffap-el-mode (name) ;; If name == "foo.el" we will skip it, since ffap-el already ;; searched for it once. (This assumes the default ffap-alist.) (and (not (string-match "\\.el\\'" name)) (ffap-locate-file name '(".el") load-path))) ;; FIXME this duplicates the logic of Man-header-file-path. ;; There should be a single central variable or function for this. ;; See also (bug#10702): ;; cc-search-directories, semantic-c-dependency-system-include-path, ;; semantic-gcc-setup (defvar ffap-c-path (let ((arch (with-temp-buffer (when (eq 0 (ignore-errors (call-process "gcc" nil '(t nil) nil "-print-multiarch"))) (goto-char (point-min)) (buffer-substring (point) (line-end-position))))) (base '("/usr/include" "/usr/local/include"))) (if (zerop (length arch)) base (append base (list (expand-file-name arch "/usr/include"))))) "List of directories to search for include files.") (defun ffap-c-mode (name) (ffap-locate-file name t ffap-c-path)) (defvar ffap-fortran-path '("../include" "/usr/include")) (defun ffap-fortran-mode (name) (ffap-locate-file name t ffap-fortran-path)) (defvar ffap-tex-path t ; delayed initialization "Path where `ffap-tex-mode' looks for TeX files. If t, `ffap-tex-init' will initialize this when needed.") (defun ffap-tex-init () ;; Compute ffap-tex-path if it is now t. (and (eq t ffap-tex-path) ;; this may be slow, so say something (message "Initializing ffap-tex-path ...") (setq ffap-tex-path (ffap-reduce-path (cons "." (ffap-kpathsea-expand-path (append (ffap-list-env "TEXINPUTS") ;; (ffap-list-env "BIBINPUTS") (ffap-symbol-value 'TeX-macro-global ; AUCTeX '("/usr/local/lib/tex/macros" "/usr/local/lib/tex/inputs"))))))))) (defun ffap-tex-mode (name) (ffap-tex-init) (ffap-locate-file name '(".tex" "") ffap-tex-path)) (defun ffap-latex-mode (name) (ffap-tex-init) ;; only rare need for "" (ffap-locate-file name '(".cls" ".sty" ".tex" "") ffap-tex-path)) (defun ffap-tex (name) (ffap-tex-init) (ffap-locate-file name t ffap-tex-path)) (defvar ffap-bib-path (ffap-list-env "BIBINPUTS" (ffap-reduce-path '( ;; a few wild guesses, need better "/usr/local/lib/tex/macros/bib" ; Solaris? "/usr/lib/texmf/bibtex/bib" ; Linux? )))) (defun ffap-bib (name) (ffap-locate-file name t ffap-bib-path)) (defun ffap-dired (name) (let ((pt (point)) try) (save-excursion (and (progn (beginning-of-line) (looking-at " *[-d]r[-w][-x][-r][-w][-x][-r][-w][-x] ")) (re-search-backward "^ *$" nil t) (re-search-forward "^ *\\([^ \t\n:]*\\):\n *total " pt t) (file-exists-p (setq try (expand-file-name name (buffer-substring (match-beginning 1) (match-end 1))))) try)))) ;; Maybe a "Lisp Code Directory" reference: (defun ffap-lcd (name) ;; FIXME: Is this still in use? (and (or ;; lisp-dir-apropos output buffer: (string-match "Lisp Code Dir" (buffer-name)) ;; Inside an LCD entry like |~/misc/ffap.el.Z|, ;; or maybe the holy LCD-Datafile itself: (member (ffap-string-around) '("||" "|\n"))) (concat ;; lispdir.el may not be loaded yet: (ffap-host-to-filename (ffap-symbol-value 'elisp-archive-host "archive.cis.ohio-state.edu")) (file-name-as-directory (ffap-symbol-value 'elisp-archive-directory "/pub/gnu/emacs/elisp-archive/")) (substring name 2)))) (defcustom ffap-rfc-path (concat (ffap-host-to-filename "ftp.rfc-editor.org") "/in-notes/rfc%s.txt") "A `format' string making a filename for RFC documents. This can be an ange-ftp or tramp remote filename to download, or a local filename if you have full set of RFCs locally. See also `ffap-rfc-directories'." :type 'string :version "23.1" :group 'ffap) (defcustom ffap-rfc-directories nil "A list of directories to look for RFC files. If a given RFC isn't in these then `ffap-rfc-path' is offered." :type '(repeat directory) :version "23.1" :group 'ffap) (defun ffap-rfc (name) (let ((num (match-string 1 name))) (or (ffap-locate-file (format "rfc%s.txt" num) t ffap-rfc-directories) (format ffap-rfc-path num)))) \f ;;; At-Point Functions: (defvar ffap-string-at-point-mode-alist '( ;; The default, used when the `major-mode' is not found. ;; Slightly controversial decisions: ;; * strip trailing "@" and ":" ;; * no commas (good for latex) (file "--:\\\\$+<>@-Z_[:alpha:]~*?" "<@" "@>;.,!:") ;; An url, or maybe a email/news message-id: (url "--:=&?$+@-Z_[:alpha:]~#,%;*" "^[:alnum:]" ":;.,!?") ;; Find a string that does *not* contain a colon: (nocolon "--9$+<>@-Z_[:alpha:]~" "<@" "@>;.,!?") ;; A machine: (machine "-[:alnum:]." "" ".") ;; Mathematica paths: allow backquotes (math-mode ",-:$+<>@-Z_[:lower:]~`" "<" "@>;.,!?`:") ) "Alist of \(MODE CHARS BEG END\), where MODE is a symbol, possibly a major-mode name, or one of the symbol `file', `url', `machine', and `nocolon'. `ffap-string-at-point' uses the data fields as follows: 1. find a maximal string of CHARS around point, 2. strip BEG chars before point from the beginning, 3. Strip END chars after point from the end.") (defvar ffap-string-at-point nil ;; Added at suggestion of RHOGEE (for ff-paths), 7/24/95. "Last string returned by `ffap-string-at-point'.") ;; Test cases: (let ((ffap-file-name-with-spaces-flag t)) (ffap-string-at-point)) ;; ;; c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program here.txt ;; c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program Files/Hummingbird/ ;; c:\Program Files\Open Text Evaluation Media\Open Text Exceed 14 x86\Program Files\Hummingbird\ ;; c:\Program Files\Freescale\CW for MPC55xx and MPC56xx 2.10\PowerPC_EABI_Tools\Command_Line_Tools\CLT_Usage_Notes.txt ;; C:\temp\program.log on Windows or /var/log/program.log on Unix. (defvar ffap-file-name-with-spaces-flag (memq system-type '(ms-dos windows-nt)) "If non-nil, enable looking for paths with spaces in `ffap-string-at-point'. Enabled in W32 by default.") (defun ffap-cygwin-path (path) "Convert \"<drive>:\" into \"/cygdrive/<drive>\"." (if (string-match "^\\([a-zA-Z]\\):[/\\\\]\\(.*\\)" path) (let ((drive (downcase (match-string 1 path))) (str (match-string 2 path))) (format "/cygdrive/%s/%s" drive (replace-regexp-in-string "[\\\\]" "/" str))) path)) (defun ffap-cygwin-convert (path) "If in Cygwin, convert \"<drive>:\" to \"/cygdrive/<drive>\"." (if (eq system-type 'cygwin) (ffap-cygwin-path path) path)) (defun ffap-search-backward-file-end (&optional path-separator end) "Search backward position point where file would probably end. Optional PATH-SEPARATOR defaults to \"/\". The search maximum is `line-end-position' or optional END point. Suppose the cursor is somewhere that might be near end of file, the guessing would position point before punctuation (like comma) after the file extension: C:\temp\file.log, which contain .... =============================== (before) ---------------- (after) C:\temp\file.log on Windows or /tmp/file.log on Unix =============================== (before) ---------------- (after) The strategy is to search backward until PATH-SEPARATOR which defaults to \"/\" and then take educated guesses. Move point and return point if an adjustment was done." (or path-separator (setq path-separator "/")) (let (point puct end whitespace-p) (when (re-search-backward (regexp-quote path-separator) (line-beginning-position) t) (forward-char 1) ;at the very beginning of match (when (looking-at ".*?\\([][<>()\"'`,.:;]\\)") ;until typical punctuation (setq end (match-end 0)) (setq punct (match-string 1)) (setq whitespace-p (looking-at "[ \t\r\n]\\|$")) (goto-char end) (cond ((and (string-equal punct ".") whitespace-p) ;end of sentence (setq point (1- (point)))) ((and (string-equal punct ".") (looking-at "[a-zA-Z0-9.]+")) ;possibly file extension (setq point (match-end 0))) (t (setq point (point))))) (when point (goto-char point) point)))) (defun ffap-search-forward-file-end (&optional path-separator) "Search PATH-SEPARATOR and position point at file's maximum ending (including spaces). Optional PATH-SEPARATOR defaults to \"/\". Call `ffap-search-backward-file-end' to refine the ending point." (or path-separator (setq path-separator "/")) (let* ((chars ;expected chars in file name (concat "[^][^<>()\"'`;,#*|" ;; exclude the opposite as we know the separator (if (string-equal path-separator "/") "\\\\" "/") "\t\r\n]")) (re (concat chars "*" (if path-separator (regexp-quote path-separator) "/") chars "*"))) (when (looking-at re) (goto-char (match-end 0))))) (defun ffap-path-separator-near-point () "Search backward and forward for closest slash or backlash in line. Return string slash or backslash. Point is moved to closest position." (let ((point (point)) str pos) (if (looking-at ".*?/") (setq str "/" pos (match-end 0))) (if (looking-at ".*?\\\\") (if (or (null pos) (< (match-end 0) pos)) (setq str "\\" pos (match-end 0)))) (goto-char point) (if (re-search-backward "/" (line-beginning-position) t) (if (or (null pos) (< (- point (point)) (- pos point))) (setq str "/" pos (1+ (point))))) ;1+ to keep cursor at the end of char (goto-char point) (if (re-search-backward "\\\\" (line-beginning-position) t) (if (or (null pos) (< (- point (point)) (- pos point))) (setq str "\\" pos (1+ (point))))) (if pos (goto-char pos)) str)) (defun ffap-string-at-point (&optional mode) "Return a string of characters from around point. MODE (defaults to value of `major-mode') is a symbol used to look up string syntax parameters in `ffap-string-at-point-mode-alist'. If MODE is not found, we use `file' instead of MODE. If the region is active, return a string from the region. Sets `ffap-string-at-point' and `ffap-string-at-point-region'." (let* ((cygwin-p (string-match "cygwin" (emacs-version))) path-separator beg end (args (cdr (or (assq (or mode major-mode) ffap-string-at-point-mode-alist) (assq 'file ffap-string-at-point-mode-alist)))) (pt (point)) (str (if (and transient-mark-mode mark-active) (buffer-substring (setcar ffap-string-at-point-region (region-beginning)) (setcar (cdr ffap-string-at-point-region) (region-end))) (buffer-substring (save-excursion (if (and ffap-file-name-with-spaces-flag (memq mode '(nil file))) (when (setq path-separator (ffap-path-separator-near-point)) (while (re-search-backward (regexp-quote path-separator) (line-beginning-position) t) (goto-char (match-beginning 0))))) (skip-chars-backward (car args)) (skip-chars-forward (nth 1 args) pt) (setcar ffap-string-at-point-region (point)) (setq beg (point))) (save-excursion (skip-chars-forward (car args)) (skip-chars-backward (nth 2 args) pt) (setq end (point)) (when (and ffap-file-name-with-spaces-flag (memq mode '(nil file))) (ffap-search-forward-file-end path-separator) (ffap-search-backward-file-end path-separator) (setq end (point))) (setcar (cdr ffap-string-at-point-region) end)))))) (set-text-properties 0 (length str) nil str) (setq str (ffap-cygwin-convert str)) (setq ffap-string-at-point str))) (defun ffap-string-around () ;; Sometimes useful to decide how to treat a string. "Return string of two chars around last `ffap-string-at-point'. Assumes the buffer has not changed." (save-excursion (format "%c%c" (progn (goto-char (car ffap-string-at-point-region)) (preceding-char)) ; maybe 0 (progn (goto-char (nth 1 ffap-string-at-point-region)) (following-char)) ; maybe 0 ))) (defun ffap-copy-string-as-kill (&optional mode) ;; Requested by MCOOK. Useful? "Call `ffap-string-at-point', and copy result to `kill-ring'." (interactive) (let ((str (ffap-string-at-point mode))) (if (equal "" str) (message "No string found around point.") (kill-new str) ;; Older: (apply 'copy-region-as-kill ffap-string-at-point-region) (message "Copied to kill ring: %s" str)))) ;; External. (declare-function w3-view-this-url "ext:w3" (&optional no-show)) (defun ffap-url-at-point () "Return URL from around point if it exists, or nil." ;; Could use w3's url-get-url-at-point instead. Both handle "URL:", ;; ignore non-relative links, trim punctuation. The other will ;; actually look back if point is in whitespace, but I would rather ;; ffap be less aggressive in such situations. (when ffap-url-regexp (or (and (eq major-mode 'w3-mode) ; In a w3 buffer button? (w3-view-this-url t)) ;; Is there a reason not to strip trailing colon? (let ((name (ffap-string-at-point 'url))) (cond ((string-match "^url:" name) (setq name (substring name 4))) ((and (string-match "\\`[^:</>@]+@[^:</>@]+[[:alnum:]]\\'" name) ;; "foo@bar": could be "mailto" or "news" (a Message-ID). ;; Without "<>" it must be "mailto". Otherwise could be ;; either, so consult `ffap-foo-at-bar-prefix'. (let ((prefix (if (and (equal (ffap-string-around) "<>") ;; Expect some odd characters: (string-match "[$.0-9].*[$.0-9].*@" name)) ;; Could be news: ffap-foo-at-bar-prefix "mailto"))) (and prefix (setq name (concat prefix ":" name)))))) ((ffap-newsgroup-p name) (setq name (concat "news:" name))) ((and (string-match "\\`[[:alnum:]]+\\'" name) ; <mic> <root> <nobody> (equal (ffap-string-around) "<>") ;; (ffap-user-p name): (not (string-match "~" (expand-file-name (concat "~" name))))) (setq name (concat "mailto:" name)))) (if (ffap-url-p name) name))))) (defvar ffap-gopher-regexp "^.*\\<\\(Type\\|Name\\|Path\\|Host\\|Port\\) *= *\\(.*\\) *$" "Regexp matching a line in a gopher bookmark (maybe indented). The two subexpressions are the KEY and VALUE.") (defun ffap-gopher-at-point () "If point is inside a gopher bookmark block, return its URL." ;; `gopher-parse-bookmark' from gopher.el is not so robust (save-excursion (beginning-of-line) (if (looking-at ffap-gopher-regexp) (progn (while (and (looking-at ffap-gopher-regexp) (not (bobp))) (forward-line -1)) (or (looking-at ffap-gopher-regexp) (forward-line 1)) (let ((type "1") path host (port "70")) (while (looking-at ffap-gopher-regexp) (let ((var (intern (downcase (buffer-substring (match-beginning 1) (match-end 1))))) (val (buffer-substring (match-beginning 2) (match-end 2)))) (set var val) (forward-line 1))) (if (and path (string-match "^ftp:.*@" path)) (concat "ftp://" (substring path 4 (1- (match-end 0))) (substring path (match-end 0))) (and (= (length type) 1) host;; (ffap-machine-p host) (concat "gopher://" host (if (equal port "70") "" (concat ":" port)) "/" type path)))))))) (defvar ffap-ftp-sans-slash-regexp (and ffap-ftp-regexp ;; Note: by now, we know it is not an url. ;; Icky regexp avoids: default: 123: foo::bar cs:pub ;; It does match on: mic@cs: cs:/pub mathcs.emory.edu: (point at end) "\\`\\([^:@]+@[^:@]+:\\|[^@.:]+\\.[^@:]+:\\|[^:]+:[~/]\\)\\([^:]\\|\\'\\)") "Strings matching this are coerced to ftp file names by ffap. That is, ffap just prepends \"/\". Set to nil to disable.") (defun ffap-file-at-point () "Return filename from around point if it exists, or nil. Existence test is skipped for names that look remote. If the filename is not obvious, it also tries `ffap-alist', which may actually result in an URL rather than a filename." ;; Note: this function does not need to look for url's, just ;; filenames. On the other hand, it is responsible for converting ;; a pseudo-url "site.com://dir" to an ftp file name (let* ((case-fold-search t) ; url prefixes are case-insensitive (data (match-data)) (string (ffap-string-at-point)) ; uses mode alist (name (or (condition-case nil (and (not (string-match "//" string)) ; foo.com://bar (substitute-in-file-name string)) (error nil)) string)) (abs (file-name-absolute-p name)) (default-directory default-directory) (oname name)) (unwind-protect (cond ;; Immediate rejects (/ and // and /* are too common in C/C++): ((member name '("" "/" "//" "/*" ".")) nil) ;; Immediately test local filenames. If default-directory is ;; remote, you probably already have a connection. ((and (not abs) (ffap-file-exists-string name))) ;; Try stripping off line numbers; good for compilation/grep output. ((and (not abs) (string-match ":[0-9]" name) (ffap-file-exists-string (substring name 0 (match-beginning 0))))) ;; Try stripping off prominent (non-root - #) shell prompts ;; if the ffap-shell-prompt-regexp is non-nil. ((and ffap-shell-prompt-regexp (not abs) (string-match ffap-shell-prompt-regexp name) (ffap-file-exists-string (substring name (match-end 0))))) ;; Accept remote names without actual checking (too slow): ((and abs (ffap-file-remote-p name))) ;; Ok, not remote, try the existence test even if it is absolute: ((and abs (ffap-file-exists-string name))) ;; Try stripping off line numbers. ((and abs (string-match ":[0-9]" name) (ffap-file-exists-string (substring name 0 (match-beginning 0))))) ;; If it contains a colon, get rid of it (and return if exists) ((and (string-match path-separator name) (setq name (ffap-string-at-point 'nocolon)) (ffap-file-exists-string name))) ;; File does not exist, try the alist: ((let ((alist ffap-alist) tem try case-fold-search) (while (and alist (not try)) (setq tem (car alist) alist (cdr alist)) (if (or (eq major-mode (car tem)) (and (stringp (car tem)) (string-match (car tem) name))) (and (setq try (condition-case nil (funcall (cdr tem) name) (error nil))) (setq try (or (ffap-url-p try) ; not a file! (ffap-file-remote-p try) (ffap-file-exists-string try)))))) try)) ;; Try adding a leading "/" (common omission in ftp file names). ;; Note that this uses oname, which still has any colon part. ;; This should have a lower priority than the alist stuff, ;; else it matches things like "ffap.el:1234:56:Warning". ((and (not abs) ffap-ftp-sans-slash-regexp (string-match ffap-ftp-sans-slash-regexp oname) (ffap-file-remote-p (concat "/" oname)))) ;; Alist failed? Try to guess an active remote connection ;; from buffer variables, and try once more, both as an ;; absolute and relative file name on that remote host. ((let* (ffap-rfs-regexp ; suppress (remote-dir (cond ((ffap-file-remote-p default-directory)) ((and (eq major-mode 'internal-ange-ftp-mode) (string-match "^\\*ftp \\(.*\\)@\\(.*\\)\\*$" (buffer-name))) (concat "/" (substring (buffer-name) 5 -1) ":")) ;; This is too often a bad idea: ;;((and (eq major-mode 'w3-mode) ;; (stringp url-current-server)) ;; (host-to-ange-path url-current-server)) ))) (and remote-dir (or (and (string-match "\\`\\(/?~?ftp\\)/" name) (ffap-file-exists-string (ffap-replace-file-component remote-dir (substring name (match-end 1))))) (ffap-file-exists-string (ffap-replace-file-component remote-dir name)))))) ((and ffap-dired-wildcards (string-match ffap-dired-wildcards name) abs (ffap-file-exists-string (file-name-directory (directory-file-name name))) name)) ;; Try all parent directories by deleting the trailing directory ;; name until existing directory is found or name stops changing ((let ((dir name)) (while (and dir (not (ffap-file-exists-string dir)) (not (equal dir (setq dir (file-name-directory (directory-file-name dir))))))) (ffap-file-exists-string dir))) ) (set-match-data data)))) \f ;;; Prompting (`ffap-read-file-or-url'): ;; ;; We want to complete filenames as in read-file-name, but also url's ;; which read-file-name-internal would truncate at the "//" string. ;; The solution here is to replace read-file-name-internal with ;; `ffap-read-file-or-url-internal', which checks the minibuffer ;; contents before attempting to complete filenames. (defun ffap-read-file-or-url (prompt guess) "Read file or URL from minibuffer, with PROMPT and initial GUESS." (or guess (setq guess default-directory)) (let (dir) ;; Tricky: guess may have or be a local directory, like "w3/w3.elc" ;; or "w3/" or "../el/ffap.el" or "../../../" (or (ffap-url-p guess) (progn (or (ffap-file-remote-p guess) (setq guess (abbreviate-file-name (expand-file-name guess)) )) (setq dir (file-name-directory guess)))) (let ((minibuffer-completing-file-name t) (completion-ignore-case read-file-name-completion-ignore-case) (fnh-elem (cons ffap-url-regexp 'url-file-handler))) ;; Explain to `rfn-eshadow' that we can use URLs here. (push fnh-elem file-name-handler-alist) (unwind-protect (setq guess (let ((default-directory (if dir (expand-file-name dir) default-directory))) (completing-read prompt 'ffap-read-file-or-url-internal nil nil (if dir (cons guess (length dir)) guess) (list 'file-name-history) (and buffer-file-name (abbreviate-file-name buffer-file-name))))) ;; Remove the special handler manually. We used to just let-bind ;; file-name-handler-alist to preserve its value, but that caused ;; other modifications to be lost (e.g. when Tramp gets loaded ;; during the completing-read call). (setq file-name-handler-alist (delq fnh-elem file-name-handler-alist)))) ;; Do file substitution like (interactive "F"), suggested by MCOOK. (or (ffap-url-p guess) (setq guess (substitute-in-file-name guess))) ;; Should not do it on url's, where $ is a common (VMS?) character. ;; Note: upcoming url.el package ought to handle this automatically. guess)) (defun ffap-read-url-internal (string pred action) "Complete URLs from history, treating given string as valid." (let ((hist (ffap-symbol-value 'url-global-history-hash-table))) (cond ((not action) (or (try-completion string hist pred) string)) ((eq action t) (or (all-completions string hist pred) (list string))) ;; action == lambda, documented where? Tests whether string is a ;; valid "match". Let us always say yes. (t t)))) (defun ffap-read-file-or-url-internal (string pred action) (unless string ;Why would this ever happen? (setq string default-directory)) (if (ffap-url-p string) (ffap-read-url-internal string pred action) (read-file-name-internal string pred action))) ;; The rest of this page is just to work with package complete.el. ;; This code assumes that you load ffap.el after complete.el. ;; ;; We must inform complete about whether our completion function ;; will do filename style completion. \f ;;; Highlighting (`ffap-highlight'): (defvar ffap-highlight t "If non-nil, ffap highlights the current buffer substring.") (defface ffap '((t :inherit highlight)) "Face used to highlight the current buffer substring." :group 'ffap :version "22.1") (defvar ffap-highlight-overlay nil "Overlay used by `ffap-highlight'.") (defun ffap-highlight (&optional remove) "If `ffap-highlight' is set, highlight the guess in this buffer. That is, the last buffer substring found by `ffap-string-at-point'. Optional argument REMOVE means to remove any such highlighting. Uses the face `ffap' if it is defined, or else `highlight'." (cond (remove (and ffap-highlight-overlay (delete-overlay ffap-highlight-overlay)) ) ((not ffap-highlight) nil) (ffap-highlight-overlay (move-overlay ffap-highlight-overlay (car ffap-string-at-point-region) (nth 1 ffap-string-at-point-region) (current-buffer))) (t (setq ffap-highlight-overlay (apply 'make-overlay ffap-string-at-point-region)) (overlay-put ffap-highlight-overlay 'face 'ffap)))) \f ;;; Main Entrance (`find-file-at-point' == `ffap'): (defun ffap-guesser () "Return file or URL or nil, guessed from text around point." (or (and ffap-url-regexp (ffap-fixup-url (or (ffap-url-at-point) (ffap-gopher-at-point)))) (ffap-file-at-point) ; may yield url! (ffap-fixup-machine (ffap-machine-at-point)))) (defun ffap-prompter (&optional guess) ;; Does guess and prompt step for find-file-at-point. ;; Extra complication for the temporary highlighting. (unwind-protect ;; This catch will let ffap-alist entries do their own prompting ;; and then maybe skip over this prompt (ff-paths, for example). (catch 'ffap-prompter (ffap-read-file-or-url (if ffap-url-regexp "Find file or URL: " "Find file: ") (prog1 (let ((mark-active nil)) ;; Don't use the region here, since it can be something ;; completely unwieldy. If the user wants that, she could ;; use M-w before and then C-y. --Stef (setq guess (or guess (ffap-guesser)))) ; using ffap-alist here (and guess (ffap-highlight)) ))) (ffap-highlight t))) ;;;###autoload (defun find-file-at-point (&optional filename) "Find FILENAME, guessing a default from text around point. If `ffap-url-regexp' is not nil, the FILENAME may also be an URL. With a prefix, this command behaves exactly like `ffap-file-finder'. If `ffap-require-prefix' is set, the prefix meaning is reversed. See also the variables `ffap-dired-wildcards', `ffap-newfile-prompt', and the functions `ffap-file-at-point' and `ffap-url-at-point'." (interactive) (if (and (called-interactively-p 'interactive) (if ffap-require-prefix (not current-prefix-arg) current-prefix-arg)) ;; Do exactly the ffap-file-finder command, even the prompting: (let (current-prefix-arg) ; we already interpreted it (call-interactively ffap-file-finder)) (or filename (setq filename (ffap-prompter))) (cond ((ffap-url-p filename) (let (current-prefix-arg) ; w3 2.3.25 bug, reported by KPC (funcall ffap-url-fetcher filename))) ((and ffap-pass-wildcards-to-dired ffap-dired-wildcards (string-match ffap-dired-wildcards filename)) (funcall ffap-directory-finder filename)) ((and ffap-dired-wildcards (string-match ffap-dired-wildcards filename) find-file-wildcards ;; Check if it's find-file that supports wildcards arg (memq ffap-file-finder '(find-file find-alternate-file))) (funcall ffap-file-finder (expand-file-name filename) t)) ((or (not ffap-newfile-prompt) (file-exists-p filename) (y-or-n-p "File does not exist, create buffer? ")) (funcall ffap-file-finder ;; expand-file-name fixes "~/~/.emacs" bug sent by CHUCKR. (expand-file-name filename))) ;; User does not want to find a non-existent file: ((signal 'file-error (list "Opening file buffer" "no such file or directory" filename)))))) ;; Shortcut: allow {M-x ffap} rather than {M-x find-file-at-point}. ;;;###autoload (defalias 'ffap 'find-file-at-point) \f ;;; Menu support (`ffap-menu'): (defcustom ffap-menu-regexp nil "If non-nil, regexp overriding `ffap-next-regexp' in `ffap-menu'. Make this more restrictive for faster menu building. For example, try \":/\" for URL (and some ftp) references." :type '(choice (const nil) regexp) :group 'ffap) (defvar ffap-menu-alist nil "Buffer local cache of menu presented by `ffap-menu'.") (make-variable-buffer-local 'ffap-menu-alist) (defvar ffap-menu-text-plist (cond ((display-mouse-p) '(face bold mouse-face highlight)) ; keymap <mousy-map> (t nil)) "Text properties applied to strings found by `ffap-menu-rescan'. These properties may be used to fontify the menu references.") ;;;###autoload (defun ffap-menu (&optional rescan) "Put up a menu of files and URLs mentioned in this buffer. Then set mark, jump to choice, and try to fetch it. The menu is cached in `ffap-menu-alist', and rebuilt by `ffap-menu-rescan'. The optional RESCAN argument \(a prefix, interactively\) forces a rebuild. Searches with `ffap-menu-regexp'." (interactive "P") ;; (require 'imenu) -- no longer used, but roughly emulated (if (or (not ffap-menu-alist) rescan ;; or if the first entry is wrong: (and ffap-menu-alist (let ((first (car ffap-menu-alist))) (save-excursion (goto-char (cdr first)) (not (equal (car first) (ffap-guesser))))))) (ffap-menu-rescan)) ;; Tail recursive: (ffap-menu-ask (if ffap-url-regexp "Find file or URL" "Find file") (cons (cons "*Rescan Buffer*" -1) ffap-menu-alist) 'ffap-menu-cont)) (defun ffap-menu-cont (choice) ; continuation of ffap-menu (if (< (cdr choice) 0) (ffap-menu t) ; *Rescan* (push-mark) (goto-char (cdr choice)) ;; Momentary highlight: (unwind-protect (progn (and ffap-highlight (ffap-guesser) (ffap-highlight)) (sit-for 0) ; display (find-file-at-point (car choice))) (ffap-highlight t)))) (defun ffap-menu-ask (title alist cont) "Prompt from a menu of choices, and then apply some action. Arguments are TITLE, ALIST, and CONT \(a continuation function\). This uses either a menu or the minibuffer depending on invocation. The TITLE string is used as either the prompt or menu title. Each ALIST entry looks like (STRING . DATA) and defines one choice. Function CONT is applied to the entry chosen by the user." ;; Note: this function is used with a different continuation ;; by the ffap-url add-on package. ;; Could try rewriting to use easymenu.el or lmenu.el. (let (choice) (cond ;; Emacs mouse: ((and (fboundp 'x-popup-menu) (ffap-mouse-event)) (setq choice (x-popup-menu t (list "" (cons title (mapcar (lambda (i) (cons (car i) i)) alist)))))) ;; minibuffer with completion buffer: (t (let ((minibuffer-setup-hook 'minibuffer-completion-help)) ;; Bug: prompting may assume unique strings, no "". (setq choice (completing-read (format "%s (default %s): " title (car (car alist))) alist nil t ;; (cons (car (car alist)) 0) nil))) (sit-for 0) ; redraw original screen ;; Convert string to its entry, or else the default: (setq choice (or (assoc choice alist) (car alist))))) (if choice (funcall cont choice) (message "No choice made!") ; possible with menus nil))) (defun ffap-menu-rescan () "Search buffer for `ffap-menu-regexp' to build `ffap-menu-alist'. Applies `ffap-menu-text-plist' text properties at all matches." (interactive) (let ((ffap-next-regexp (or ffap-menu-regexp ffap-next-regexp)) (range (- (point-max) (point-min))) (mod (buffer-modified-p)) ; was buffer modified? ;; inhibit-read-only works on read-only text properties ;; as well as read-only buffers. (inhibit-read-only t) ; to set text-properties item ;; Avoid repeated searches of the *mode-alist: (major-mode (if (assq major-mode ffap-string-at-point-mode-alist) major-mode 'file))) (setq ffap-menu-alist nil) (unwind-protect (save-excursion (goto-char (point-min)) (while (setq item (ffap-next-guess)) (setq ffap-menu-alist (cons (cons item (point)) ffap-menu-alist)) (add-text-properties (car ffap-string-at-point-region) (point) ffap-menu-text-plist) (message "Scanning...%2d%% <%s>" (/ (* 100 (- (point) (point-min))) range) item))) (or mod (restore-buffer-modified-p nil)))) (message "Scanning...done") ;; Remove duplicates. (setq ffap-menu-alist ; sort by item (sort ffap-menu-alist (function (lambda (a b) (string-lessp (car a) (car b)))))) (let ((ptr ffap-menu-alist)) ; remove duplicates (while (cdr ptr) (if (equal (car (car ptr)) (car (car (cdr ptr)))) (setcdr ptr (cdr (cdr ptr))) (setq ptr (cdr ptr))))) (setq ffap-menu-alist ; sort by position (sort ffap-menu-alist (function (lambda (a b) (< (cdr a) (cdr b))))))) \f ;;; Mouse Support (`ffap-at-mouse'): ;; ;; See the suggested binding in ffap-bindings (near eof). (defvar ffap-at-mouse-fallback nil ; ffap-menu? too time-consuming "Command invoked by `ffap-at-mouse' if nothing found at click, or nil. Ignored when `ffap-at-mouse' is called programmatically.") (put 'ffap-at-mouse-fallback 'risky-local-variable t) ;;;###autoload (defun ffap-at-mouse (e) "Find file or URL guessed from text around mouse click. Interactively, calls `ffap-at-mouse-fallback' if no guess is found. Return value: * if a guess string is found, return it (after finding it) * if the fallback is called, return whatever it returns * otherwise, nil" (interactive "e") (let ((guess ;; Maybe less surprising without the save-excursion? (save-excursion (mouse-set-point e) ;; Would prefer to do nothing unless click was *on* text. How ;; to tell that the click was beyond the end of current line? (ffap-guesser)))) (cond (guess (set-buffer (ffap-event-buffer e)) (ffap-highlight) (unwind-protect (progn (sit-for 0) ; display (message "Finding `%s'" guess) (find-file-at-point guess) guess) ; success: return non-nil (ffap-highlight t))) ((called-interactively-p 'interactive) (if ffap-at-mouse-fallback (call-interactively ffap-at-mouse-fallback) (message "No file or URL found at mouse click.") nil)) ; no fallback, return nil ;; failure: return nil ))) \f ;;; ffap-other-*, ffap-read-only-*, ffap-alternate-* commands: ;; There could be a real `ffap-noselect' function, but we would need ;; at least two new user variables, and there is no w3-fetch-noselect. ;; So instead, we just fake it with a slow save-window-excursion. (defun ffap-other-window () "Like `ffap', but put buffer in another window. Only intended for interactive use." (interactive) (let (value) (switch-to-buffer-other-window (save-window-excursion (setq value (call-interactively 'ffap)) (unless (or (bufferp value) (bufferp (car-safe value))) (setq value (current-buffer))) (current-buffer))) value)) (defun ffap-other-frame () "Like `ffap', but put buffer in another frame. Only intended for interactive use." (interactive) ;; Extra code works around dedicated windows (noted by JENS, 7/96): (let* ((win (selected-window)) (wdp (window-dedicated-p win)) value) (unwind-protect (progn (set-window-dedicated-p win nil) (switch-to-buffer-other-frame (save-window-excursion (setq value (call-interactively 'ffap)) (unless (or (bufferp value) (bufferp (car-safe value))) (setq value (current-buffer))) (current-buffer)))) (set-window-dedicated-p win wdp)) value)) (defun ffap--toggle-read-only (buffer-or-list) (dolist (buffer (if (listp buffer-or-list) buffer-or-list (list buffer-or-list))) (with-current-buffer buffer (read-only-mode 1)))) (defun ffap-read-only () "Like `ffap', but mark buffer as read-only. Only intended for interactive use." (interactive) (let ((value (call-interactively 'ffap))) (unless (or (bufferp value) (bufferp (car-safe value))) (setq value (current-buffer))) (ffap--toggle-read-only value) value)) (defun ffap-read-only-other-window () "Like `ffap', but put buffer in another window and mark as read-only. Only intended for interactive use." (interactive) (let ((value (ffap-other-window))) (ffap--toggle-read-only value) value)) (defun ffap-read-only-other-frame () "Like `ffap', but put buffer in another frame and mark as read-only. Only intended for interactive use." (interactive) (let ((value (ffap-other-frame))) (ffap--toggle-read-only value) value)) (defun ffap-alternate-file () "Like `ffap' and `find-alternate-file'. Only intended for interactive use." (interactive) (let ((ffap-file-finder 'find-alternate-file)) (call-interactively 'ffap))) (defun ffap-alternate-file-other-window () "Like `ffap' and `find-alternate-file-other-window'. Only intended for interactive use." (interactive) (let ((ffap-file-finder 'find-alternate-file-other-window)) (call-interactively 'ffap))) (defun ffap-literally () "Like `ffap' and `find-file-literally'. Only intended for interactive use." (interactive) (let ((ffap-file-finder 'find-file-literally)) (call-interactively 'ffap))) (defalias 'find-file-literally-at-point 'ffap-literally) \f ;;; Bug Reporter: (define-obsolete-function-alias 'ffap-bug 'report-emacs-bug "23.1") (define-obsolete-function-alias 'ffap-submit-bug 'report-emacs-bug "23.1") \f ;;; Hooks for Gnus, VM, Rmail: ;; ;; If you do not like these bindings, write versions with whatever ;; bindings you would prefer. (defun ffap-ro-mode-hook () "Bind `ffap-next' and `ffap-menu' to M-l and M-m, resp." (local-set-key "\M-l" 'ffap-next) (local-set-key "\M-m" 'ffap-menu)) (defun ffap-gnus-hook () "Bind `ffap-gnus-next' and `ffap-gnus-menu' to M-l and M-m, resp." (set (make-local-variable 'ffap-foo-at-bar-prefix) "news") ; message-id's ;; Note "l", "L", "m", "M" are taken: (local-set-key "\M-l" 'ffap-gnus-next) (local-set-key "\M-m" 'ffap-gnus-menu)) (defvar gnus-summary-buffer) (defvar gnus-article-buffer) ;; This code is called from gnus. (declare-function gnus-summary-select-article "gnus-sum" (&optional all-headers force pseudo article)) (declare-function gnus-configure-windows "gnus-win" (setting &optional force)) (defun ffap-gnus-wrapper (form) ; used by both commands below (and (eq (current-buffer) (get-buffer gnus-summary-buffer)) (gnus-summary-select-article)) ; get article of current line ;; Preserve selected buffer, but do not do save-window-excursion, ;; since we want to see any window created by the form. Temporarily ;; select the article buffer, so we can see any point movement. (let ((sb (window-buffer (selected-window)))) (gnus-configure-windows 'article) (pop-to-buffer gnus-article-buffer) (widen) ;; Skip headers for ffap-gnus-next (which will wrap around) (if (eq (point) (point-min)) (search-forward "\n\n" nil t)) (unwind-protect (eval form) (pop-to-buffer sb)))) (defun ffap-gnus-next () "Run `ffap-next' in the gnus article buffer." (interactive) (ffap-gnus-wrapper '(ffap-next nil t))) (defun ffap-gnus-menu () "Run `ffap-menu' in the gnus article buffer." (interactive) (ffap-gnus-wrapper '(ffap-menu))) \f ;;;###autoload (defun dired-at-point (&optional filename) "Start Dired, defaulting to file at point. See `ffap'. If `dired-at-point-require-prefix' is set, the prefix meaning is reversed." (interactive) (if (and (called-interactively-p 'interactive) (if dired-at-point-require-prefix (not current-prefix-arg) current-prefix-arg)) (let (current-prefix-arg) ; already interpreted (call-interactively ffap-directory-finder)) (or filename (setq filename (dired-at-point-prompter))) (cond ((ffap-url-p filename) (funcall ffap-url-fetcher filename)) ((and ffap-dired-wildcards (string-match ffap-dired-wildcards filename)) (funcall ffap-directory-finder filename)) ((file-exists-p filename) (if (file-directory-p filename) (funcall ffap-directory-finder (expand-file-name filename)) (funcall ffap-directory-finder (concat (expand-file-name filename) "*")))) ((and (file-writable-p (or (file-name-directory (directory-file-name filename)) filename)) (y-or-n-p "Directory does not exist, create it? ")) (make-directory filename) (funcall ffap-directory-finder filename)) ((error "No such file or directory `%s'" filename))))) (defun dired-at-point-prompter (&optional guess) ;; Does guess and prompt step for find-file-at-point. ;; Extra complication for the temporary highlighting. (unwind-protect (ffap-read-file-or-url (cond ((eq ffap-directory-finder 'list-directory) "List directory (brief): ") (ffap-url-regexp "Dired file or URL: ") (t "Dired file: ")) (prog1 (setq guess (or guess (let ((guess (ffap-guesser))) (if (or (not guess) (ffap-url-p guess) (ffap-file-remote-p guess)) guess (setq guess (abbreviate-file-name (expand-file-name guess))) (cond ;; Interpret local directory as a directory. ((file-directory-p guess) (file-name-as-directory guess)) ;; Get directory component from local files. ((file-regular-p guess) (file-name-directory guess)) (guess)))) )) (and guess (ffap-highlight)))) (ffap-highlight t))) \f ;;; ffap-dired-other-*, ffap-list-directory commands: (defun ffap-dired-other-window () "Like `dired-at-point', but put buffer in another window. Only intended for interactive use." (interactive) (let (value) (switch-to-buffer-other-window (save-window-excursion (setq value (call-interactively 'dired-at-point)) (current-buffer))) value)) (defun ffap-dired-other-frame () "Like `dired-at-point', but put buffer in another frame. Only intended for interactive use." (interactive) ;; Extra code works around dedicated windows (noted by JENS, 7/96): (let* ((win (selected-window)) (wdp (window-dedicated-p win)) value) (unwind-protect (progn (set-window-dedicated-p win nil) (switch-to-buffer-other-frame (save-window-excursion (setq value (call-interactively 'dired-at-point)) (current-buffer)))) (set-window-dedicated-p win wdp)) value)) (defun ffap-list-directory () "Like `dired-at-point' and `list-directory'. Only intended for interactive use." (interactive) (let ((ffap-directory-finder 'list-directory)) (call-interactively 'dired-at-point))) \f ;;; Hooks to put in `file-name-at-point-functions': ;;;###autoload (defun ffap-guess-file-name-at-point () "Try to get a file name at point. This hook is intended to be put in `file-name-at-point-functions'." (when (fboundp 'ffap-guesser) ;; Logic from `ffap-read-file-or-url' and `dired-at-point-prompter'. (let ((guess (ffap-guesser))) (setq guess (if (or (not guess) (and (fboundp 'ffap-url-p) (ffap-url-p guess)) (and (fboundp 'ffap-file-remote-p) (ffap-file-remote-p guess))) guess (abbreviate-file-name (expand-file-name guess)))) (when guess (if (file-directory-p guess) (file-name-as-directory guess) guess))))) \f ;;; Offer default global bindings (`ffap-bindings'): (defvar ffap-bindings '((global-set-key [S-mouse-3] 'ffap-at-mouse) (global-set-key [C-S-mouse-3] 'ffap-menu) (global-set-key "\C-x\C-f" 'find-file-at-point) (global-set-key "\C-x\C-r" 'ffap-read-only) (global-set-key "\C-x\C-v" 'ffap-alternate-file) (global-set-key "\C-x4f" 'ffap-other-window) (global-set-key "\C-x5f" 'ffap-other-frame) (global-set-key "\C-x4r" 'ffap-read-only-other-window) (global-set-key "\C-x5r" 'ffap-read-only-other-frame) (global-set-key "\C-xd" 'dired-at-point) (global-set-key "\C-x4d" 'ffap-dired-other-window) (global-set-key "\C-x5d" 'ffap-dired-other-frame) (global-set-key "\C-x\C-d" 'ffap-list-directory) (add-hook 'gnus-summary-mode-hook 'ffap-gnus-hook) (add-hook 'gnus-article-mode-hook 'ffap-gnus-hook) (add-hook 'vm-mode-hook 'ffap-ro-mode-hook) (add-hook 'rmail-mode-hook 'ffap-ro-mode-hook)) "List of binding forms evaluated by function `ffap-bindings'. A reasonable ffap installation needs just this one line: (ffap-bindings) Of course if you do not like these bindings, just roll your own!") ;;;###autoload (defun ffap-bindings () "Evaluate the forms in variable `ffap-bindings'." (interactive) (eval (cons 'progn ffap-bindings))) \f (provide 'ffap) ;;; ffap.el ends here ^ permalink raw reply related [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v4) 2012-10-20 7:56 ` bug#8439: [PATCH] ffap.el -- detect paths with spaces (v3) jari @ 2012-10-20 8:45 ` jari 2012-10-20 10:20 ` Eli Zaretskii ` (2 more replies) 0 siblings, 3 replies; 29+ messages in thread From: jari @ 2012-10-20 8:45 UTC (permalink / raw) To: 8439 [-- Attachment #1: Type: text/plain, Size: 738 bytes --] On 2012-10-20 10:11:56 Eli Zaretskii: | Someone said in another discussion that Cygwin already does accept | Windows-style file names. Cygwin Emacs 24.2.1: C-x C-f c:/test.txt => Use M-x make-directory RET RET to create the directory and its parents C-x C-f c:\test.txt => Use M-x make-directory RET RET to create the directory and its parents | On 2012-10-20 18:49:10 Daniel Colascione: | please use cygwin-convert-path-from-windows and In this patch (compared to previous v3): - remove functions related to Cygwin and use cygwin-convert-path-from-windows - obey END parameter in ffap-search-backward-file-end as originally intended - correct "path-separator" term into "dir-separator" everywhere Jari [-- Attachment #2: 0001-lisp-ffap.el-Detect-patchs-with-spaces-v4.patch --] [-- Type: text/x-diff, Size: 8313 bytes --] From 7b52dadb3c1901d3c19b0a75854648e660fa4ac8 Mon Sep 17 00:00:00 2001 From: Jari Aalto <jari.aalto@cante.net> Date: Sat, 20 Oct 2012 11:29:27 +0300 Subject: [PATCH] lisp/ffap.el: Detect patchs with spaces. Organization: Private Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: 8bit 2012-10-19 Fri Jari Aalto <jari.aalto@cante.net> * ffap.el (ffap-file-name-with-spaces-flag): New variable. (ffap-cygwin-convert): New function. (ffap-search-forward-file-end): New function. (ffap-search-backward-file-end): New function. (ffap-dir-separator-near-point): New function. (ffap-string-at-point): If `ffap-file-name-with-spaces-flag' is set, allow spaces in file names. Signed-off-by: Jari Aalto <jari.aalto@cante.net> --- lisp/ffap.el | 178 +++++++++++++++++++++++++++++++++++++++++++++++++++------- 1 file changed, 159 insertions(+), 19 deletions(-) diff --git a/lisp/ffap.el b/lisp/ffap.el index 4c75609..02dbab5 100644 --- a/lisp/ffap.el +++ b/lisp/ffap.el @@ -1036,6 +1036,125 @@ possibly a major-mode name, or one of the symbol ;; Added at suggestion of RHOGEE (for ff-paths), 7/24/95. "Last string returned by `ffap-string-at-point'.") +;; Test cases: (let ((ffap-file-name-with-spaces-flag t)) (ffap-string-at-point)) +;; +;; c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program here.txt +;; c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program Files/Hummingbird/ +;; c:\Program Files\Open Text Evaluation Media\Open Text Exceed 14 x86\Program Files\Hummingbird\ +;; c:\Program Files\Freescale\CW for MPC55xx and MPC56xx 2.10\PowerPC_EABI_Tools\Command_Line_Tools\CLT_Usage_Notes.txt +;; C:\temp\program.log on Windows or /var/log/program.log on Unix. + +(defvar ffap-file-name-with-spaces-flag (memq system-type '(ms-dos windows-nt)) + "If non-nil, enable looking for paths with spaces in `ffap-string-at-point'. +Enabled in W32 by default.") + +(defun ffap-search-backward-file-end (&optional dir-separator end) + "Search backward position point where file would probably end. +Optional DIR-SEPARATOR defaults to \"/\". The search maximum is +`line-end-position' or optional END point. + +Suppose the cursor is somewhere that might be near end of file, +the guessing would position point before punctuation (like comma) +after the file extension: + + C:\temp\file.log, which contain .... + =============================== (before) + ---------------- (after) + + + C:\temp\file.log on Windows or /tmp/file.log on Unix + =============================== (before) + ---------------- (after) + +The strategy is to search backward until DIR-SEPARATOR which defaults to +\"/\" and then take educated guesses. + +Move point and return point if an adjustment was done." + (or dir-separator + (setq dir-separator "/")) + (let ((opoint (point)) + point + puct + end + whitespace-p) + (when (re-search-backward + (regexp-quote dir-separator) (line-beginning-position) t) + (forward-char 1) ;move to the beginning of match + ;; until typical punctuation + (when (re-search-forward "\\([][<>()\"'`,.:;]\\)" + (or end + (line-end-position)) + t) + (setq end (match-end 0)) + (setq punct (match-string 1)) + (setq whitespace-p (looking-at "[ \t\r\n]\\|$")) + (goto-char end) + (cond + ((and (string-equal punct ".") + whitespace-p) ;end of sentence + (setq point (1- (point)))) + ((and (string-equal punct ".") + (looking-at "[a-zA-Z0-9.]+")) ;possibly file extensionl + (setq point (match-end 0))) + (t + (setq point (point))))) + (goto-char opoint) + (when point + (goto-char point) + point)))) + +(defun ffap-search-forward-file-end (&optional dir-separator) + "Search DIR-SEPARATOR and position point at file's maximum ending (including spaces). +Optional DIR-SEPARATOR defaults to \"/\". +Call `ffap-search-backward-file-end' to refine the ending point." + (or dir-separator + (setq dir-separator "/")) + (let* ((chars ;expected chars in file name + (concat "[^][^<>()\"'`;,#*|" + ;; exclude the opposite as we know the separator + (if (string-equal dir-separator "/") + "\\\\" + "/") + "\t\r\n]")) + (re (concat + chars "*" + (if dir-separator + (regexp-quote dir-separator) + "/") + chars "*"))) + (when (looking-at re) + (goto-char (match-end 0))))) + +(defun ffap-dir-separator-near-point () + "Search backward and forward for closest slash or backlash in line. +Return string slash or backslash. Point is moved to closest position." + (let ((point (point)) + str + pos) + (if (looking-at ".*?/") + (setq str "/" + pos (match-end 0))) + (if (looking-at ".*?\\\\") + (if (or (null pos) + (< (match-end 0) pos)) + (setq str "\\" + pos (match-end 0)))) + (goto-char point) + (if (re-search-backward "/" (line-beginning-position) t) + (if (or (null pos) + (< (- point (point)) (- pos point))) + (setq str "/" + pos (1+ (point))))) ;1+ to keep cursor at the end of char + (goto-char point) + (if (re-search-backward "\\\\" (line-beginning-position) t) + (if (or (null pos) + (< (- point (point)) (- pos point))) + (setq str "\\" + pos (1+ (point))))) + (if pos + (goto-char pos)) + str)) + (defun ffap-string-at-point (&optional mode) "Return a string of characters from around point. MODE (defaults to value of `major-mode') is a symbol used to look up string @@ -1043,26 +1162,47 @@ syntax parameters in `ffap-string-at-point-mode-alist'. If MODE is not found, we use `file' instead of MODE. If the region is active, return a string from the region. Sets `ffap-string-at-point' and `ffap-string-at-point-region'." - (let* ((args - (cdr - (or (assq (or mode major-mode) ffap-string-at-point-mode-alist) - (assq 'file ffap-string-at-point-mode-alist)))) - (pt (point)) - (str - (if (and transient-mark-mode mark-active) - (buffer-substring - (setcar ffap-string-at-point-region (region-beginning)) - (setcar (cdr ffap-string-at-point-region) (region-end))) - (buffer-substring - (save-excursion - (skip-chars-backward (car args)) - (skip-chars-forward (nth 1 args) pt) - (setcar ffap-string-at-point-region (point))) - (save-excursion - (skip-chars-forward (car args)) - (skip-chars-backward (nth 2 args) pt) - (setcar (cdr ffap-string-at-point-region) (point))))))) + (let* ((cygwin-p (string-match "cygwin" (emacs-version))) + dir-separator + beg + end + (args + (cdr + (or (assq (or mode major-mode) ffap-string-at-point-mode-alist) + (assq 'file ffap-string-at-point-mode-alist)))) + (pt (point)) + (str + (if (and transient-mark-mode mark-active) + (buffer-substring + (setcar ffap-string-at-point-region (region-beginning)) + (setcar (cdr ffap-string-at-point-region) (region-end))) + (buffer-substring + (save-excursion + (if (and ffap-file-name-with-spaces-flag + (memq mode '(nil file))) + (when (setq dir-separator (ffap-dir-separator-near-point)) + (while (re-search-backward + (regexp-quote dir-separator) + (line-beginning-position) t) + (goto-char (match-beginning 0))))) + (skip-chars-backward (car args)) + (skip-chars-forward (nth 1 args) pt) + (setcar ffap-string-at-point-region (point)) + (setq beg (point))) + (save-excursion + (skip-chars-forward (car args)) + (skip-chars-backward (nth 2 args) pt) + (setq end (point)) + (when (and ffap-file-name-with-spaces-flag + (memq mode '(nil file))) + (ffap-search-forward-file-end dir-separator) + (ffap-search-backward-file-end dir-separator) + (setq end (point))) + (setcar (cdr ffap-string-at-point-region) end)))))) (set-text-properties 0 (length str) nil str) + (if (and (eq system-type 'cygwin) + (fboundp 'cygwin-convert-path-from-windows)) + (setq str (cygwin-convert-path-from-windows str))) (setq ffap-string-at-point str))) (defun ffap-string-around () -- 1.7.10.4 [-- Attachment #3: ffap--jari-2012-10-20-1128-git-20d87fd.el --] [-- Type: text/plain, Size: 78376 bytes --] ;;; ffap.el --- find file (or url) at point ;; Copyright (C) 1995-1997, 2000-2012 Free Software Foundation, Inc. ;; Author: Michelangelo Grigni <mic@mathcs.emory.edu> ;; Maintainer: FSF ;; Created: 29 Mar 1993 ;; Keywords: files, hypermedia, matching, mouse, convenience ;; X-URL: ftp://ftp.mathcs.emory.edu/pub/mic/emacs/ ;; This file is part of GNU Emacs. ;; GNU Emacs is free software: you can redistribute it and/or modify ;; it under the terms of the GNU General Public License as published by ;; the Free Software Foundation, either version 3 of the License, or ;; (at your option) any later version. ;; GNU Emacs is distributed in the hope that it will be useful, ;; but WITHOUT ANY WARRANTY; without even the implied warranty of ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;; GNU General Public License for more details. ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. \f ;;; Commentary: ;; ;; Command find-file-at-point replaces find-file. With a prefix, it ;; behaves exactly like find-file. Without a prefix, it first tries ;; to guess a default file or URL from the text around the point ;; (`ffap-require-prefix' swaps these behaviors). This is useful for ;; following references in situations such as mail or news buffers, ;; README's, MANIFEST's, and so on. Submit bugs or suggestions with ;; M-x ffap-bug. ;; ;; For the default installation, add this line to your init file: ;; ;; (ffap-bindings) ; do default key bindings ;; ;; ffap-bindings makes the following global key bindings: ;; ;; C-x C-f find-file-at-point (abbreviated as ffap) ;; C-x C-r ffap-read-only ;; C-x C-v ffap-alternate-file ;; ;; C-x d dired-at-point ;; C-x C-d ffap-list-directory ;; ;; C-x 4 f ffap-other-window ;; C-x 4 r ffap-read-only-other-window ;; C-x 4 d ffap-dired-other-window ;; ;; C-x 5 f ffap-other-frame ;; C-x 5 r ffap-read-only-other-frame ;; C-x 5 d ffap-dired-other-frame ;; ;; S-mouse-3 ffap-at-mouse ;; C-S-mouse-3 ffap-menu ;; ;; ffap-bindings also adds hooks to make the following local bindings ;; in vm, gnus, and rmail: ;; ;; M-l ffap-next, or ffap-gnus-next in gnus (l == "link") ;; M-m ffap-menu, or ffap-gnus-menu in gnus (m == "menu") ;; ;; If you do not like these bindings, modify the variable ;; `ffap-bindings', or write your own. ;; ;; If you use ange-ftp, browse-url, complete, efs, or w3, it is best ;; to load or autoload them before ffap. If you use ff-paths, load it ;; afterwards. Try apropos {C-h a ffap RET} to get a list of the many ;; option variables. In particular, if ffap is slow, try these: ;; ;; (setq ffap-alist nil) ; faster, dumber prompting ;; (setq ffap-machine-p-known 'accept) ; no pinging ;; (setq ffap-url-regexp nil) ; disable URL features in ffap ;; (setq ffap-shell-prompt-regexp nil) ; disable shell prompt stripping ;; ;; ffap uses `browse-url' (if found, else `w3-fetch') to fetch URL's. ;; For a hairier `ffap-url-fetcher', try ffap-url.el (same ftp site). ;; Also, you can add `ffap-menu-rescan' to various hooks to fontify ;; the file and URL references within a buffer. \f ;;; Change Log: ;; ;; The History and Contributors moved to ffap.LOG (same ftp site), ;; which also has some old examples and commentary from ffap 1.5. \f ;;; Todo list: ;; * use kpsewhich ;; * let "/dir/file#key" jump to key (tag or regexp) in /dir/file ;; * find file of symbol if TAGS is loaded (like above) ;; * break long menus into multiple panes (like imenu?) ;; * notice node in "(dired)Virtual Dired" (quotes, parentheses, whitespace) ;; * notice "machine.dom blah blah blah dir/file" (how?) ;; * as w3 becomes standard, rewrite to rely more on its functions ;; * regexp options for ffap-string-at-point, like font-lock (MCOOK) ;; * v19: could replace `ffap-locate-file' with a quieter `locate-library' ;; * handle "$(VAR)" in Makefiles ;; * use the font-lock machinery \f ;;; Code: (require 'url-parse) (define-obsolete-variable-alias 'ffap-version 'emacs-version "23.2") (defgroup ffap nil "Find file or URL at point." ;; Dead 2009/07/05. ;; :link '(url-link :tag "URL" "ftp://ftp.mathcs.emory.edu/pub/mic/emacs/") :group 'matching :group 'convenience) ;; The code is organized in pages, separated by formfeed characters. ;; See the next two pages for standard customization ideas. \f ;;; User Variables: (defun ffap-symbol-value (sym &optional default) "Return value of symbol SYM, if bound, or DEFAULT otherwise." (if (boundp sym) (symbol-value sym) default)) (defcustom ffap-shell-prompt-regexp ;; This used to test for some shell prompts that don't have a space ;; after them. The common root shell prompt (#) is not listed since it ;; also doubles up as a valid URL character. "[$%><]*" "Paths matching this regexp are stripped off the shell prompt. If nil, ffap doesn't do shell prompt stripping." :type '(choice (const :tag "Disable" nil) (const :tag "Standard" "[$%><]*") regexp) :group 'ffap) (defcustom ffap-ftp-regexp "\\`/[^/:]+:" "File names matching this regexp are treated as remote ffap. If nil, ffap neither recognizes nor generates such names." :type '(choice (const :tag "Disable" nil) (const :tag "Standard" "\\`/[^/:]+:") regexp) :group 'ffap) (defcustom ffap-url-unwrap-local t "If non-nil, convert some URLs to local file names before prompting. Only \"file:\" and \"ftp:\" URLs are converted, and only if they do not specify a host, or the host is either \"localhost\" or equal to `system-name'." :type 'boolean :group 'ffap) (defcustom ffap-url-unwrap-remote '("ftp") "If non-nil, convert URLs to remote file names before prompting. If the value is a list of strings, that specifies a list of URL schemes (e.g. \"ftp\"); in that case, only convert those URLs." :type '(choice (repeat string) boolean) :group 'ffap :version "24.3") (defcustom ffap-ftp-default-user "anonymous" "User name in ftp file names generated by `ffap-host-to-path'. Note this name may be omitted if it equals the default \(either `efs-default-user' or `ange-ftp-default-user'\)." :type 'string :group 'ffap) (defcustom ffap-rfs-regexp ;; Remote file access built into file system? HP rfa or Andrew afs: "\\`/\\(afs\\|net\\)/." ;; afs only: (and (file-exists-p "/afs") "\\`/afs/.") "Matching file names are treated as remote. Use nil to disable." :type 'regexp :group 'ffap) (defvar ffap-url-regexp ;; Could just use `url-nonrelative-link' of w3, if loaded. ;; This regexp is not exhaustive, it just matches common cases. (concat "\\`\\(" "news\\(post\\)?:\\|mailto:\\|file:" ; no host ok "\\|" "\\(ftp\\|https?\\|telnet\\|gopher\\|www\\|wais\\)://" ; needs host "\\)." ; require one more character ) "Regexp matching URLs. Use nil to disable URL features in ffap.") (defcustom ffap-foo-at-bar-prefix "mailto" "Presumed URL prefix type of strings like \"<foo.9z@bar>\". Sensible values are nil, \"news\", or \"mailto\"." :type '(choice (const "mailto") (const "news") (const :tag "Disable" nil) ;; string -- possible, but not really useful ) :group 'ffap) \f ;;; Peanut Gallery (More User Variables): ;; ;; Users of ffap occasionally suggest new features. If I consider ;; those features interesting but not clear winners (a matter of ;; personal taste) I try to leave options to enable them. Read ;; through this section for features that you like, put an appropriate ;; enabler in your init file. (defcustom ffap-dired-wildcards "[*?][^/]*\\'" "A regexp matching filename wildcard characters, or nil. If `find-file-at-point' gets a filename matching this pattern, and `ffap-pass-wildcards-to-dired' is nil, it passes it on to `find-file' with non-nil WILDCARDS argument, which expands wildcards and visits multiple files. To visit a file whose name contains wildcard characters you can suppress wildcard expansion by setting `find-file-wildcards'. If `find-file-at-point' gets a filename matching this pattern and `ffap-pass-wildcards-to-dired' is non-nil, it passes it on to `dired'. If `dired-at-point' gets a filename matching this pattern, it passes it on to `dired'." :type '(choice (const :tag "Disable" nil) (const :tag "Enable" "[*?][^/]*\\'") ;; regexp -- probably not useful ) :group 'ffap) (defcustom ffap-pass-wildcards-to-dired nil "If non-nil, pass filenames matching `ffap-dired-wildcards' to dired." :type 'boolean :group 'ffap) (defcustom ffap-newfile-prompt nil ;; Suggestion from RHOGEE, 11 Jul 1994. Disabled, I think this is ;; better handled by `find-file-not-found-hooks'. "Whether `find-file-at-point' prompts about a nonexistent file." :type 'boolean :group 'ffap) (defcustom ffap-require-prefix nil ;; Suggestion from RHOGEE, 20 Oct 1994. "If set, reverses the prefix argument to `find-file-at-point'. This is nil so neophytes notice ffap. Experts may prefer to disable ffap most of the time." :type 'boolean :group 'ffap) (defcustom ffap-file-finder 'find-file "The command called by `find-file-at-point' to find a file." :type 'function :group 'ffap :risky t) (defcustom ffap-directory-finder 'dired "The command called by `dired-at-point' to find a directory." :type 'function :group 'ffap :risky t) (defcustom ffap-url-fetcher (if (fboundp 'browse-url) 'browse-url ; rely on browse-url-browser-function 'w3-fetch) ;; Remote control references: ;; http://www.ncsa.uiuc.edu/SDG/Software/XMosaic/remote-control.html ;; http://home.netscape.com/newsref/std/x-remote.html "A function of one argument, called by ffap to fetch an URL. Reasonable choices are `w3-fetch' or a `browse-url-*' function. For a fancy alternative, get `ffap-url.el'." :type '(choice (const w3-fetch) (const browse-url) ; in recent versions of browse-url (const browse-url-netscape) (const browse-url-mosaic) function) :group 'ffap :risky t) (defcustom ffap-next-regexp ;; If you want ffap-next to find URL's only, try this: ;; (and ffap-url-regexp (string-match "\\\\`" ffap-url-regexp) ;; (concat "\\<" (substring ffap-url-regexp 2)))) ;; ;; It pays to put a big fancy regexp here, since ffap-guesser is ;; much more time-consuming than regexp searching: "[/:.~[:alpha:]]/\\|@[[:alpha:]][-[:alnum:]]*\\." "Regular expression governing movements of `ffap-next'." :type 'regexp :group 'ffap) (defcustom dired-at-point-require-prefix nil "If non-nil, reverse the prefix argument to `dired-at-point'. This is nil so neophytes notice FFAP. Experts may prefer to disable FFAP most of the time." :type 'boolean :group 'ffap :version "20.3") \f ;;; Compatibility: ;; ;; This version of ffap supports only the Emacs it is distributed in. ;; See the ftp site for a more general version. The following ;; functions are necessary "leftovers" from the more general version. (defun ffap-mouse-event () ; current mouse event, or nil (and (listp last-nonmenu-event) last-nonmenu-event)) (defun ffap-event-buffer (event) (window-buffer (car (event-start event)))) \f ;;; Find Next Thing in buffer (`ffap-next'): ;; ;; Original ffap-next-url (URL's only) from RPECK 30 Mar 1995. Since ;; then, broke it up into ffap-next-guess (noninteractive) and ;; ffap-next (a command). It now work on files as well as url's. (defvar ffap-next-guess nil "Last value returned by `ffap-next-guess'.") (defvar ffap-string-at-point-region '(1 1) "List (BEG END), last region returned by `ffap-string-at-point'.") (defun ffap-next-guess (&optional back lim) "Move point to next file or URL, and return it as a string. If nothing is found, leave point at limit and return nil. Optional BACK argument makes search backwards. Optional LIM argument limits the search. Only considers strings that match `ffap-next-regexp'." (or lim (setq lim (if back (point-min) (point-max)))) (let (guess) (while (not (or guess (eq (point) lim))) (funcall (if back 're-search-backward 're-search-forward) ffap-next-regexp lim 'move) (setq guess (ffap-guesser))) ;; Go to end, so we do not get same guess twice: (goto-char (nth (if back 0 1) ffap-string-at-point-region)) (setq ffap-next-guess guess))) ;;;###autoload (defun ffap-next (&optional back wrap) "Search buffer for next file or URL, and run ffap. Optional argument BACK says to search backwards. Optional argument WRAP says to try wrapping around if necessary. Interactively: use a single prefix to search backwards, double prefix to wrap forward, triple to wrap backwards. Actual search is done by `ffap-next-guess'." (interactive (cdr (assq (prefix-numeric-value current-prefix-arg) '((1) (4 t) (16 nil t) (64 t t))))) (let ((pt (point)) (guess (ffap-next-guess back))) ;; Try wraparound if necessary: (and (not guess) wrap (goto-char (if back (point-max) (point-min))) (setq guess (ffap-next-guess back pt))) (if guess (progn (sit-for 0) ; display point movement (find-file-at-point (ffap-prompter guess))) (goto-char pt) ; restore point (message "No %sfiles or URL's found" (if wrap "" "more "))))) (defun ffap-next-url (&optional back wrap) "Like `ffap-next', but search with `ffap-url-regexp'." (interactive) (let ((ffap-next-regexp ffap-url-regexp)) (if (called-interactively-p 'interactive) (call-interactively 'ffap-next) (ffap-next back wrap)))) \f ;;; Machines (`ffap-machine-p'): ;; I cannot decide a "best" strategy here, so these are variables. In ;; particular, if `Pinging...' is broken or takes too long on your ;; machine, try setting these all to accept or reject. (defcustom ffap-machine-p-local 'reject ; this happens often "What `ffap-machine-p' does with hostnames that have no domain. Value should be a symbol, one of `ping', `accept', and `reject'." :type '(choice (const ping) (const accept) (const reject)) :group 'ffap) (defcustom ffap-machine-p-known 'ping ; `accept' for higher speed "What `ffap-machine-p' does with hostnames that have a known domain. Value should be a symbol, one of `ping', `accept', and `reject'. See `mail-extr.el' for the known domains." :type '(choice (const ping) (const accept) (const reject)) :group 'ffap) (defcustom ffap-machine-p-unknown 'reject "What `ffap-machine-p' does with hostnames that have an unknown domain. Value should be a symbol, one of `ping', `accept', and `reject'. See `mail-extr.el' for the known domains." :type '(choice (const ping) (const accept) (const reject)) :group 'ffap) (defun ffap-what-domain (domain) ;; Like what-domain in mail-extr.el, returns string or nil. (require 'mail-extr) (let ((ob (or (ffap-symbol-value 'mail-extr-all-top-level-domains) (ffap-symbol-value 'all-top-level-domains)))) ; XEmacs (and ob (get (intern-soft (downcase domain) ob) 'domain-name)))) (defun ffap-machine-p (host &optional service quiet strategy) "Decide whether HOST is the name of a real, reachable machine. Depending on the domain (none, known, or unknown), follow the strategy named by the variable `ffap-machine-p-local', `ffap-machine-p-known', or `ffap-machine-p-unknown'. Pinging uses `open-network-stream'. Optional SERVICE specifies the port used \(default \"discard\"\). Optional QUIET flag suppresses the \"Pinging...\" message. Optional STRATEGY overrides the three variables above. Returned values: t means that HOST answered. 'accept means the relevant variable told us to accept. \"mesg\" means HOST exists, but does not respond for some reason." ;; Try some (Emory local): ;; (ffap-machine-p "ftp" nil nil 'ping) ;; (ffap-machine-p "nonesuch" nil nil 'ping) ;; (ffap-machine-p "ftp.mathcs.emory.edu" nil nil 'ping) ;; (ffap-machine-p "mathcs" 5678 nil 'ping) ;; (ffap-machine-p "foo.bonk" nil nil 'ping) ;; (ffap-machine-p "foo.bonk.com" nil nil 'ping) (if (or (string-match "[^-[:alnum:].]" host) ; Invalid chars (?) (not (string-match "[^0-9]" host))) ; 1: a number? 2: quick reject nil (let* ((domain (and (string-match "\\.[^.]*$" host) (downcase (substring host (1+ (match-beginning 0)))))) (what-domain (if domain (ffap-what-domain domain) "Local"))) (or strategy (setq strategy (cond ((not domain) ffap-machine-p-local) ((not what-domain) ffap-machine-p-unknown) (t ffap-machine-p-known)))) (cond ((eq strategy 'accept) 'accept) ((eq strategy 'reject) nil) ((not (fboundp 'open-network-stream)) nil) ;; assume (eq strategy 'ping) (t (or quiet (if (stringp what-domain) (message "Pinging %s (%s)..." host what-domain) (message "Pinging %s ..." host))) (condition-case error (progn (delete-process (open-network-stream "ffap-machine-p" nil host (or service "discard"))) t) (error (let ((mesg (car (cdr error)))) (cond ;; v18: ((string-match "^Unknown host" mesg) nil) ((string-match "not responding$" mesg) mesg) ;; v19: ;; (file-error "connection failed" "permission denied" ;; "nonesuch" "ffap-machine-p") ;; (file-error "connection failed" "host is unreachable" ;; "gopher.house.gov" "ffap-machine-p") ;; (file-error "connection failed" "address already in use" ;; "ftp.uu.net" "ffap-machine-p") ((equal mesg "connection failed") (if (equal (nth 2 error) "permission denied") nil ; host does not exist ;; Other errors mean the host exists: (nth 2 error))) ;; Could be "Unknown service": (t (signal (car error) (cdr error)))))))))))) \f ;;; Possibly Remote Resources: (defun ffap-replace-file-component (fullname name) "In remote FULLNAME, replace path with NAME. May return nil." ;; Use efs if loaded, but do not load it otherwise. (if (fboundp 'efs-replace-path-component) (funcall efs-replace-path-component fullname name) (and (stringp fullname) (stringp name) (concat (file-remote-p fullname) name)))) ;; (ffap-replace-file-component "/who@foo.com:/whatever" "/new") (defun ffap-file-suffix (file) "Return trailing `.foo' suffix of FILE, or nil if none." (let ((pos (string-match "\\.[^./]*\\'" file))) (and pos (substring file pos nil)))) (defvar ffap-compression-suffixes '(".gz" ".Z") ; .z is mostly dead "List of suffixes tried by `ffap-file-exists-string'.") (defun ffap-file-exists-string (file &optional nomodify) ;; Early jka-compr versions modified file-exists-p to return the ;; filename, maybe modified by adding a suffix like ".gz". That ;; broke the interface of file-exists-p, so it was later dropped. ;; Here we document and simulate the old behavior. "Return FILE (maybe modified) if the file exists, else nil. When using jka-compr (a.k.a. `auto-compression-mode'), the returned name may have a suffix added from `ffap-compression-suffixes'. The optional NOMODIFY argument suppresses the extra search." (cond ((not file) nil) ; quietly reject nil ((file-exists-p file) file) ; try unmodified first ;; three reasons to suppress search: (nomodify nil) ((not (rassq 'jka-compr-handler file-name-handler-alist)) nil) ((member (ffap-file-suffix file) ffap-compression-suffixes) nil) (t ; ok, do the search (let ((list ffap-compression-suffixes) try ret) (while list (if (file-exists-p (setq try (concat file (car list)))) (setq ret try list nil) (setq list (cdr list)))) ret)))) (defun ffap-file-remote-p (filename) "If FILENAME looks remote, return it (maybe slightly improved)." ;; (ffap-file-remote-p "/user@foo.bar.com:/pub") ;; (ffap-file-remote-p "/cssun.mathcs.emory.edu://dir") ;; (ffap-file-remote-p "/ffap.el:80") (or (and ffap-ftp-regexp (string-match ffap-ftp-regexp filename) ;; Convert "/host.com://dir" to "/host:/dir", to handle a dying ;; practice of advertising ftp files as "host.dom://filename". (if (string-match "//" filename) ;; (replace-match "/" nil nil filename) (concat (substring filename 0 (1+ (match-beginning 0))) (substring filename (match-end 0))) filename)) (and ffap-rfs-regexp (string-match ffap-rfs-regexp filename) filename))) (defun ffap-machine-at-point () "Return machine name at point if it exists, or nil." (let ((mach (ffap-string-at-point 'machine))) (and (ffap-machine-p mach) mach))) (defsubst ffap-host-to-filename (host) "Convert HOST to something like \"/USER@HOST:\" or \"/HOST:\". Looks at `ffap-ftp-default-user', returns \"\" for \"localhost\"." (if (equal host "localhost") "" (let ((user ffap-ftp-default-user)) ;; Avoid including the user if it is same as default: (if (or (equal user (ffap-symbol-value 'ange-ftp-default-user)) (equal user (ffap-symbol-value 'efs-default-user))) (setq user nil)) (concat "/" user (and user "@") host ":")))) (defun ffap-fixup-machine (mach) ;; Convert a hostname into an url, an ftp file name, or nil. (cond ((not (and ffap-url-regexp (stringp mach))) nil) ;; gopher.well.com ((string-match "\\`gopher[-.]" mach) ; or "info"? (concat "gopher://" mach "/")) ;; www.ncsa.uiuc.edu ((and (string-match "\\`w\\(ww\\|eb\\)[-.]" mach)) (concat "http://" mach "/")) ;; More cases? Maybe "telnet:" for archie? (ffap-ftp-regexp (ffap-host-to-filename mach)) )) (defvar ffap-newsgroup-regexp "^[[:lower:]]+\\.[-+[:lower:]_0-9.]+$" "Strings not matching this fail `ffap-newsgroup-p'.") (defvar ffap-newsgroup-heads ; entirely inadequate '("alt" "comp" "gnu" "misc" "news" "sci" "soc" "talk") "Used by `ffap-newsgroup-p' if gnus is not running.") (defun ffap-newsgroup-p (string) "Return STRING if it looks like a newsgroup name, else nil." (and (string-match ffap-newsgroup-regexp string) (let ((htbs '(gnus-active-hashtb gnus-newsrc-hashtb gnus-killed-hashtb)) (heads ffap-newsgroup-heads) htb ret) (while htbs (setq htb (car htbs) htbs (cdr htbs)) (condition-case nil (progn ;; errs: htb symbol may be unbound, or not a hash-table. ;; gnus-gethash is just a macro for intern-soft. (and (symbol-value htb) (intern-soft string (symbol-value htb)) (setq ret string htbs nil)) ;; If we made it this far, gnus is running, so ignore "heads": (setq heads nil)) (error nil))) (or ret (not heads) (let ((head (string-match "\\`\\([[:lower:]]+\\)\\." string))) (and head (setq head (substring string 0 (match-end 1))) (member head heads) (setq ret string)))) ;; Is there ever a need to modify string as a newsgroup name? ret))) (defsubst ffap-url-p (string) "If STRING looks like an URL, return it (maybe improved), else nil." (let ((case-fold-search t)) (and ffap-url-regexp (string-match ffap-url-regexp string) ;; I lied, no improvement: string))) ;; Broke these out of ffap-fixup-url, for use of ffap-url package. (defun ffap-url-unwrap-local (url) "Return URL as a local file name, or nil." (let* ((obj (url-generic-parse-url url)) (host (url-host obj)) (filename (car (url-path-and-query obj)))) (when (and (member (url-type obj) '("ftp" "file")) (member host `("" "localhost" ,(system-name)))) ;; On Windows, "file:///C:/foo" should unwrap to "C:/foo" (if (and (memq system-type '(ms-dos windows-nt cygwin)) (string-match "\\`/[a-zA-Z]:" filename)) (substring filename 1) filename)))) (defun ffap-url-unwrap-remote (url) "Return URL as a remote file name, or nil." (let* ((obj (url-generic-parse-url url)) (scheme (url-type obj)) (valid-schemes (if (listp ffap-url-unwrap-remote) ffap-url-unwrap-remote '("ftp"))) (host (url-host obj)) (port (url-port-if-non-default obj)) (user (url-user obj)) (filename (car (url-path-and-query obj)))) (when (and (member scheme valid-schemes) (string-match "\\`[a-zA-Z][-a-zA-Z0-9+.]*\\'" scheme) (not (equal host ""))) (concat "/" scheme ":" (if user (concat user "@")) host (if port (concat "#" (number-to-string port))) ":" filename)))) (defun ffap-fixup-url (url) "Clean up URL and return it, maybe as a file name." (cond ((not (stringp url)) nil) ((and ffap-url-unwrap-local (ffap-url-unwrap-local url))) ((and ffap-url-unwrap-remote (ffap-url-unwrap-remote url))) (url))) \f ;;; File Name Handling: ;; ;; The upcoming ffap-alist actions need various utilities to prepare ;; and search directories. Too many features here. ;; (defun ffap-last (l) (while (cdr l) (setq l (cdr l))) l) ;; (defun ffap-splice (func inlist) ;; "Equivalent to (apply 'nconc (mapcar FUNC INLIST)), but less consing." ;; (let* ((head (cons 17 nil)) (last head)) ;; (while inlist ;; (setcdr last (funcall func (car inlist))) ;; (setq last (ffap-last last) inlist (cdr inlist))) ;; (cdr head))) (defun ffap-list-env (env &optional empty) "Return a list of strings parsed from environment variable ENV. Optional EMPTY is the default list if \(getenv ENV\) is undefined, and also is substituted for the first empty-string component, if there is one. Uses `path-separator' to separate the path into substrings." ;; We cannot use parse-colon-path (files.el), since it kills ;; "//" entries using file-name-as-directory. ;; Similar: dired-split, TeX-split-string, and RHOGEE's psg-list-env ;; in ff-paths and bib-cite. The EMPTY arg may help mimic kpathsea. (if (or empty (getenv env)) ; should return something (let ((start 0) match dir ret) (setq env (concat (getenv env) path-separator)) (while (setq match (string-match path-separator env start)) (setq dir (substring env start match) start (1+ match)) ;;(and (file-directory-p dir) (not (member dir ret)) ...) (setq ret (cons dir ret))) (setq ret (nreverse ret)) (and empty (setq match (member "" ret)) (progn ; allow string or list here (setcdr match (append (cdr-safe empty) (cdr match))) (setcar match (or (car-safe empty) empty)))) ret))) (defun ffap-reduce-path (path) "Remove duplicates and non-directories from PATH list." (let (ret tem) (while path (setq tem path path (cdr path)) (if (equal (car tem) ".") (setcar tem "")) (or (member (car tem) ret) (not (file-directory-p (car tem))) (progn (setcdr tem ret) (setq ret tem)))) (nreverse ret))) (defun ffap-all-subdirs (dir &optional depth) "Return list of all subdirectories under DIR, starting with itself. Directories beginning with \".\" are ignored, and directory symlinks are listed but never searched (to avoid loops). Optional DEPTH limits search depth." (and (file-exists-p dir) (ffap-all-subdirs-loop (expand-file-name dir) (or depth -1)))) (defun ffap-all-subdirs-loop (dir depth) ; internal (setq depth (1- depth)) (cons dir (and (not (eq depth -1)) (apply 'nconc (mapcar (function (lambda (d) (cond ((not (file-directory-p d)) nil) ((file-symlink-p d) (list d)) (t (ffap-all-subdirs-loop d depth))))) (directory-files dir t "\\`[^.]") ))))) (defvar ffap-kpathsea-depth 1 "Bound on depth of subdirectory search in `ffap-kpathsea-expand-path'. Set to 0 to avoid all searching, or nil for no limit.") (defun ffap-kpathsea-expand-path (path) "Replace each \"//\"-suffixed dir in PATH by a list of its subdirs. The subdirs begin with the original directory, and the depth of the search is bounded by `ffap-kpathsea-depth'. This is intended to mimic kpathsea, a library used by some versions of TeX." (apply 'nconc (mapcar (function (lambda (dir) (if (string-match "[^/]//\\'" dir) (ffap-all-subdirs (substring dir 0 -2) ffap-kpathsea-depth) (list dir)))) path))) (defun ffap-locate-file (file nosuffix path) ;; The current version of locate-library could almost replace this, ;; except it does not let us override the suffix list. The ;; compression-suffixes search moved to ffap-file-exists-string. "A generic path-searching function. Returns the name of file in PATH, or nil. Optional NOSUFFIX, if nil or t, is like the fourth argument for `load': whether to try the suffixes (\".elc\" \".el\" \"\"). If a nonempty list, it is a list of suffixes to try instead. PATH is a list of directories. This uses `ffap-file-exists-string', which may try adding suffixes from `ffap-compression-suffixes'." (if (file-name-absolute-p file) (setq path (list (file-name-directory file)) file (file-name-nondirectory file))) (let ((dir-ok (equal "" (file-name-nondirectory file))) (suffixes-to-try (cond ((consp nosuffix) nosuffix) (nosuffix '("")) (t '(".elc" ".el" "")))) suffixes try found) (while path (setq suffixes suffixes-to-try) (while suffixes (setq try (ffap-file-exists-string (expand-file-name (concat file (car suffixes)) (car path)))) (if (and try (or dir-ok (not (file-directory-p try)))) (setq found try suffixes nil path nil) (setq suffixes (cdr suffixes)))) (setq path (cdr path))) found)) \f ;;; Action List (`ffap-alist'): ;; ;; These search actions depend on the major-mode or regexps matching ;; the current name. The little functions and their variables are ;; deferred to the next section, at some loss of "code locality". A ;; good example of featuritis. Trim this list for speed. (defvar ffap-alist '( ("" . ffap-completable) ; completion, slow on some systems ("\\.info\\'" . ffap-info) ; gzip.info ("\\`info/" . ffap-info-2) ; info/emacs ("\\`[-[:lower:]]+\\'" . ffap-info-3) ; (emacs)Top [only in the parentheses] ("\\.elc?\\'" . ffap-el) ; simple.el, simple.elc (emacs-lisp-mode . ffap-el-mode) ; rmail, gnus, simple, custom ;; (lisp-interaction-mode . ffap-el-mode) ; maybe (finder-mode . ffap-el-mode) ; type {C-h p} and try it (help-mode . ffap-el-mode) ; maybe useful (c++-mode . ffap-c-mode) ; search ffap-c-path (cc-mode . ffap-c-mode) ; same ("\\.\\([chCH]\\|cc\\|hh\\)\\'" . ffap-c-mode) ; stdio.h (fortran-mode . ffap-fortran-mode) ; FORTRAN requested by MDB ("\\.[fF]\\'" . ffap-fortran-mode) (tex-mode . ffap-tex-mode) ; search ffap-tex-path (latex-mode . ffap-latex-mode) ; similar ("\\.\\(tex\\|sty\\|doc\\|cls\\)\\'" . ffap-tex) ("\\.bib\\'" . ffap-bib) ; search ffap-bib-path ("\\`\\." . ffap-home) ; .emacs, .bashrc, .profile ("\\`~/" . ffap-lcd) ; |~/misc/ffap.el.Z| ;; This used to have a blank, but ffap-string-at-point doesn't ;; handle blanks. ;; http://lists.gnu.org/archive/html/emacs-devel/2008-01/msg01058.html ("\\`[Rr][Ff][Cc][-#]?\\([0-9]+\\)" ; no $ . ffap-rfc) ; "100% RFC2100 compliant" (dired-mode . ffap-dired) ; maybe in a subdirectory ) "Alist of \(KEY . FUNCTION\) pairs parsed by `ffap-file-at-point'. If string NAME at point (maybe \"\") is not a file or URL, these pairs specify actions to try creating such a string. A pair matches if either KEY is a symbol, and it equals `major-mode', or KEY is a string, it should match NAME as a regexp. On a match, \(FUNCTION NAME\) is called and should return a file, an URL, or nil. If nil, search the alist for further matches.") (put 'ffap-alist 'risky-local-variable t) ;; Example `ffap-alist' modifications: ;; ;; (setq ffap-alist ; remove a feature in `ffap-alist' ;; (delete (assoc 'c-mode ffap-alist) ffap-alist)) ;; ;; (setq ffap-alist ; add something to `ffap-alist' ;; (cons ;; (cons "^YSN[0-9]+$" ;; (defun ffap-ysn (name) ;; (concat ;; "http://www.physics.uiuc.edu/" ;; "ysn/httpd/htdocs/ysnarchive/issuefiles/" ;; (substring name 3) ".html"))) ;; ffap-alist)) \f ;;; Action Definitions: ;; ;; Define various default members of `ffap-alist'. (defun ffap-completable (name) (let* ((dir (or (file-name-directory name) default-directory)) (cmp (file-name-completion (file-name-nondirectory name) dir))) (and cmp (concat dir cmp)))) (defun ffap-home (name) (ffap-locate-file name t '("~"))) (defun ffap-info (name) (ffap-locate-file name '("" ".info") (or (ffap-symbol-value 'Info-directory-list) (ffap-symbol-value 'Info-default-directory-list) ))) (defun ffap-info-2 (name) (ffap-info (substring name 5))) (defun ffap-info-3 (name) ;; This ignores the node! "(emacs)Top" same as "(emacs)Intro" (and (equal (ffap-string-around) "()") (ffap-info name))) (defun ffap-el (name) (ffap-locate-file name t load-path)) (defun ffap-el-mode (name) ;; If name == "foo.el" we will skip it, since ffap-el already ;; searched for it once. (This assumes the default ffap-alist.) (and (not (string-match "\\.el\\'" name)) (ffap-locate-file name '(".el") load-path))) ;; FIXME this duplicates the logic of Man-header-file-path. ;; There should be a single central variable or function for this. ;; See also (bug#10702): ;; cc-search-directories, semantic-c-dependency-system-include-path, ;; semantic-gcc-setup (defvar ffap-c-path (let ((arch (with-temp-buffer (when (eq 0 (ignore-errors (call-process "gcc" nil '(t nil) nil "-print-multiarch"))) (goto-char (point-min)) (buffer-substring (point) (line-end-position))))) (base '("/usr/include" "/usr/local/include"))) (if (zerop (length arch)) base (append base (list (expand-file-name arch "/usr/include"))))) "List of directories to search for include files.") (defun ffap-c-mode (name) (ffap-locate-file name t ffap-c-path)) (defvar ffap-fortran-path '("../include" "/usr/include")) (defun ffap-fortran-mode (name) (ffap-locate-file name t ffap-fortran-path)) (defvar ffap-tex-path t ; delayed initialization "Path where `ffap-tex-mode' looks for TeX files. If t, `ffap-tex-init' will initialize this when needed.") (defun ffap-tex-init () ;; Compute ffap-tex-path if it is now t. (and (eq t ffap-tex-path) ;; this may be slow, so say something (message "Initializing ffap-tex-path ...") (setq ffap-tex-path (ffap-reduce-path (cons "." (ffap-kpathsea-expand-path (append (ffap-list-env "TEXINPUTS") ;; (ffap-list-env "BIBINPUTS") (ffap-symbol-value 'TeX-macro-global ; AUCTeX '("/usr/local/lib/tex/macros" "/usr/local/lib/tex/inputs"))))))))) (defun ffap-tex-mode (name) (ffap-tex-init) (ffap-locate-file name '(".tex" "") ffap-tex-path)) (defun ffap-latex-mode (name) (ffap-tex-init) ;; only rare need for "" (ffap-locate-file name '(".cls" ".sty" ".tex" "") ffap-tex-path)) (defun ffap-tex (name) (ffap-tex-init) (ffap-locate-file name t ffap-tex-path)) (defvar ffap-bib-path (ffap-list-env "BIBINPUTS" (ffap-reduce-path '( ;; a few wild guesses, need better "/usr/local/lib/tex/macros/bib" ; Solaris? "/usr/lib/texmf/bibtex/bib" ; Linux? )))) (defun ffap-bib (name) (ffap-locate-file name t ffap-bib-path)) (defun ffap-dired (name) (let ((pt (point)) try) (save-excursion (and (progn (beginning-of-line) (looking-at " *[-d]r[-w][-x][-r][-w][-x][-r][-w][-x] ")) (re-search-backward "^ *$" nil t) (re-search-forward "^ *\\([^ \t\n:]*\\):\n *total " pt t) (file-exists-p (setq try (expand-file-name name (buffer-substring (match-beginning 1) (match-end 1))))) try)))) ;; Maybe a "Lisp Code Directory" reference: (defun ffap-lcd (name) ;; FIXME: Is this still in use? (and (or ;; lisp-dir-apropos output buffer: (string-match "Lisp Code Dir" (buffer-name)) ;; Inside an LCD entry like |~/misc/ffap.el.Z|, ;; or maybe the holy LCD-Datafile itself: (member (ffap-string-around) '("||" "|\n"))) (concat ;; lispdir.el may not be loaded yet: (ffap-host-to-filename (ffap-symbol-value 'elisp-archive-host "archive.cis.ohio-state.edu")) (file-name-as-directory (ffap-symbol-value 'elisp-archive-directory "/pub/gnu/emacs/elisp-archive/")) (substring name 2)))) (defcustom ffap-rfc-path (concat (ffap-host-to-filename "ftp.rfc-editor.org") "/in-notes/rfc%s.txt") "A `format' string making a filename for RFC documents. This can be an ange-ftp or tramp remote filename to download, or a local filename if you have full set of RFCs locally. See also `ffap-rfc-directories'." :type 'string :version "23.1" :group 'ffap) (defcustom ffap-rfc-directories nil "A list of directories to look for RFC files. If a given RFC isn't in these then `ffap-rfc-path' is offered." :type '(repeat directory) :version "23.1" :group 'ffap) (defun ffap-rfc (name) (let ((num (match-string 1 name))) (or (ffap-locate-file (format "rfc%s.txt" num) t ffap-rfc-directories) (format ffap-rfc-path num)))) \f ;;; At-Point Functions: (defvar ffap-string-at-point-mode-alist '( ;; The default, used when the `major-mode' is not found. ;; Slightly controversial decisions: ;; * strip trailing "@" and ":" ;; * no commas (good for latex) (file "--:\\\\$+<>@-Z_[:alpha:]~*?" "<@" "@>;.,!:") ;; An url, or maybe a email/news message-id: (url "--:=&?$+@-Z_[:alpha:]~#,%;*" "^[:alnum:]" ":;.,!?") ;; Find a string that does *not* contain a colon: (nocolon "--9$+<>@-Z_[:alpha:]~" "<@" "@>;.,!?") ;; A machine: (machine "-[:alnum:]." "" ".") ;; Mathematica paths: allow backquotes (math-mode ",-:$+<>@-Z_[:lower:]~`" "<" "@>;.,!?`:") ) "Alist of \(MODE CHARS BEG END\), where MODE is a symbol, possibly a major-mode name, or one of the symbol `file', `url', `machine', and `nocolon'. `ffap-string-at-point' uses the data fields as follows: 1. find a maximal string of CHARS around point, 2. strip BEG chars before point from the beginning, 3. Strip END chars after point from the end.") (defvar ffap-string-at-point nil ;; Added at suggestion of RHOGEE (for ff-paths), 7/24/95. "Last string returned by `ffap-string-at-point'.") ;; Test cases: (let ((ffap-file-name-with-spaces-flag t)) (ffap-string-at-point)) ;; ;; c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program here.txt ;; c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program Files/Hummingbird/ ;; c:\Program Files\Open Text Evaluation Media\Open Text Exceed 14 x86\Program Files\Hummingbird\ ;; c:\Program Files\Freescale\CW for MPC55xx and MPC56xx 2.10\PowerPC_EABI_Tools\Command_Line_Tools\CLT_Usage_Notes.txt ;; C:\temp\program.log on Windows or /var/log/program.log on Unix. (defvar ffap-file-name-with-spaces-flag (memq system-type '(ms-dos windows-nt)) "If non-nil, enable looking for paths with spaces in `ffap-string-at-point'. Enabled in W32 by default.") (defun ffap-search-backward-file-end (&optional dir-separator end) "Search backward position point where file would probably end. Optional DIR-SEPARATOR defaults to \"/\". The search maximum is `line-end-position' or optional END point. Suppose the cursor is somewhere that might be near end of file, the guessing would position point before punctuation (like comma) after the file extension: C:\temp\file.log, which contain .... =============================== (before) ---------------- (after) C:\temp\file.log on Windows or /tmp/file.log on Unix =============================== (before) ---------------- (after) The strategy is to search backward until DIR-SEPARATOR which defaults to \"/\" and then take educated guesses. Move point and return point if an adjustment was done." (or dir-separator (setq dir-separator "/")) (let ((opoint (point)) point puct end whitespace-p) (when (re-search-backward (regexp-quote dir-separator) (line-beginning-position) t) (forward-char 1) ;move to the beginning of match ;; until typical punctuation (when (re-search-forward "\\([][<>()\"'`,.:;]\\)" (or end (line-end-position)) t) (setq end (match-end 0)) (setq punct (match-string 1)) (setq whitespace-p (looking-at "[ \t\r\n]\\|$")) (goto-char end) (cond ((and (string-equal punct ".") whitespace-p) ;end of sentence (setq point (1- (point)))) ((and (string-equal punct ".") (looking-at "[a-zA-Z0-9.]+")) ;possibly file extensionl (setq point (match-end 0))) (t (setq point (point))))) (goto-char opoint) (when point (goto-char point) point)))) (defun ffap-search-forward-file-end (&optional dir-separator) "Search DIR-SEPARATOR and position point at file's maximum ending (including spaces). Optional DIR-SEPARATOR defaults to \"/\". Call `ffap-search-backward-file-end' to refine the ending point." (or dir-separator (setq dir-separator "/")) (let* ((chars ;expected chars in file name (concat "[^][^<>()\"'`;,#*|" ;; exclude the opposite as we know the separator (if (string-equal dir-separator "/") "\\\\" "/") "\t\r\n]")) (re (concat chars "*" (if dir-separator (regexp-quote dir-separator) "/") chars "*"))) (when (looking-at re) (goto-char (match-end 0))))) (defun ffap-dir-separator-near-point () "Search backward and forward for closest slash or backlash in line. Return string slash or backslash. Point is moved to closest position." (let ((point (point)) str pos) (if (looking-at ".*?/") (setq str "/" pos (match-end 0))) (if (looking-at ".*?\\\\") (if (or (null pos) (< (match-end 0) pos)) (setq str "\\" pos (match-end 0)))) (goto-char point) (if (re-search-backward "/" (line-beginning-position) t) (if (or (null pos) (< (- point (point)) (- pos point))) (setq str "/" pos (1+ (point))))) ;1+ to keep cursor at the end of char (goto-char point) (if (re-search-backward "\\\\" (line-beginning-position) t) (if (or (null pos) (< (- point (point)) (- pos point))) (setq str "\\" pos (1+ (point))))) (if pos (goto-char pos)) str)) (defun ffap-string-at-point (&optional mode) "Return a string of characters from around point. MODE (defaults to value of `major-mode') is a symbol used to look up string syntax parameters in `ffap-string-at-point-mode-alist'. If MODE is not found, we use `file' instead of MODE. If the region is active, return a string from the region. Sets `ffap-string-at-point' and `ffap-string-at-point-region'." (let* ((cygwin-p (string-match "cygwin" (emacs-version))) dir-separator beg end (args (cdr (or (assq (or mode major-mode) ffap-string-at-point-mode-alist) (assq 'file ffap-string-at-point-mode-alist)))) (pt (point)) (str (if (and transient-mark-mode mark-active) (buffer-substring (setcar ffap-string-at-point-region (region-beginning)) (setcar (cdr ffap-string-at-point-region) (region-end))) (buffer-substring (save-excursion (if (and ffap-file-name-with-spaces-flag (memq mode '(nil file))) (when (setq dir-separator (ffap-dir-separator-near-point)) (while (re-search-backward (regexp-quote dir-separator) (line-beginning-position) t) (goto-char (match-beginning 0))))) (skip-chars-backward (car args)) (skip-chars-forward (nth 1 args) pt) (setcar ffap-string-at-point-region (point)) (setq beg (point))) (save-excursion (skip-chars-forward (car args)) (skip-chars-backward (nth 2 args) pt) (setq end (point)) (when (and ffap-file-name-with-spaces-flag (memq mode '(nil file))) (ffap-search-forward-file-end dir-separator) (ffap-search-backward-file-end dir-separator) (setq end (point))) (setcar (cdr ffap-string-at-point-region) end)))))) (set-text-properties 0 (length str) nil str) (if (and (eq system-type 'cygwin) (fboundp 'cygwin-convert-path-from-windows)) (setq str (cygwin-convert-path-from-windows str))) (setq ffap-string-at-point str))) (defun ffap-string-around () ;; Sometimes useful to decide how to treat a string. "Return string of two chars around last `ffap-string-at-point'. Assumes the buffer has not changed." (save-excursion (format "%c%c" (progn (goto-char (car ffap-string-at-point-region)) (preceding-char)) ; maybe 0 (progn (goto-char (nth 1 ffap-string-at-point-region)) (following-char)) ; maybe 0 ))) (defun ffap-copy-string-as-kill (&optional mode) ;; Requested by MCOOK. Useful? "Call `ffap-string-at-point', and copy result to `kill-ring'." (interactive) (let ((str (ffap-string-at-point mode))) (if (equal "" str) (message "No string found around point.") (kill-new str) ;; Older: (apply 'copy-region-as-kill ffap-string-at-point-region) (message "Copied to kill ring: %s" str)))) ;; External. (declare-function w3-view-this-url "ext:w3" (&optional no-show)) (defun ffap-url-at-point () "Return URL from around point if it exists, or nil." ;; Could use w3's url-get-url-at-point instead. Both handle "URL:", ;; ignore non-relative links, trim punctuation. The other will ;; actually look back if point is in whitespace, but I would rather ;; ffap be less aggressive in such situations. (when ffap-url-regexp (or (and (eq major-mode 'w3-mode) ; In a w3 buffer button? (w3-view-this-url t)) ;; Is there a reason not to strip trailing colon? (let ((name (ffap-string-at-point 'url))) (cond ((string-match "^url:" name) (setq name (substring name 4))) ((and (string-match "\\`[^:</>@]+@[^:</>@]+[[:alnum:]]\\'" name) ;; "foo@bar": could be "mailto" or "news" (a Message-ID). ;; Without "<>" it must be "mailto". Otherwise could be ;; either, so consult `ffap-foo-at-bar-prefix'. (let ((prefix (if (and (equal (ffap-string-around) "<>") ;; Expect some odd characters: (string-match "[$.0-9].*[$.0-9].*@" name)) ;; Could be news: ffap-foo-at-bar-prefix "mailto"))) (and prefix (setq name (concat prefix ":" name)))))) ((ffap-newsgroup-p name) (setq name (concat "news:" name))) ((and (string-match "\\`[[:alnum:]]+\\'" name) ; <mic> <root> <nobody> (equal (ffap-string-around) "<>") ;; (ffap-user-p name): (not (string-match "~" (expand-file-name (concat "~" name))))) (setq name (concat "mailto:" name)))) (if (ffap-url-p name) name))))) (defvar ffap-gopher-regexp "^.*\\<\\(Type\\|Name\\|Path\\|Host\\|Port\\) *= *\\(.*\\) *$" "Regexp matching a line in a gopher bookmark (maybe indented). The two subexpressions are the KEY and VALUE.") (defun ffap-gopher-at-point () "If point is inside a gopher bookmark block, return its URL." ;; `gopher-parse-bookmark' from gopher.el is not so robust (save-excursion (beginning-of-line) (if (looking-at ffap-gopher-regexp) (progn (while (and (looking-at ffap-gopher-regexp) (not (bobp))) (forward-line -1)) (or (looking-at ffap-gopher-regexp) (forward-line 1)) (let ((type "1") path host (port "70")) (while (looking-at ffap-gopher-regexp) (let ((var (intern (downcase (buffer-substring (match-beginning 1) (match-end 1))))) (val (buffer-substring (match-beginning 2) (match-end 2)))) (set var val) (forward-line 1))) (if (and path (string-match "^ftp:.*@" path)) (concat "ftp://" (substring path 4 (1- (match-end 0))) (substring path (match-end 0))) (and (= (length type) 1) host;; (ffap-machine-p host) (concat "gopher://" host (if (equal port "70") "" (concat ":" port)) "/" type path)))))))) (defvar ffap-ftp-sans-slash-regexp (and ffap-ftp-regexp ;; Note: by now, we know it is not an url. ;; Icky regexp avoids: default: 123: foo::bar cs:pub ;; It does match on: mic@cs: cs:/pub mathcs.emory.edu: (point at end) "\\`\\([^:@]+@[^:@]+:\\|[^@.:]+\\.[^@:]+:\\|[^:]+:[~/]\\)\\([^:]\\|\\'\\)") "Strings matching this are coerced to ftp file names by ffap. That is, ffap just prepends \"/\". Set to nil to disable.") (defun ffap-file-at-point () "Return filename from around point if it exists, or nil. Existence test is skipped for names that look remote. If the filename is not obvious, it also tries `ffap-alist', which may actually result in an URL rather than a filename." ;; Note: this function does not need to look for url's, just ;; filenames. On the other hand, it is responsible for converting ;; a pseudo-url "site.com://dir" to an ftp file name (let* ((case-fold-search t) ; url prefixes are case-insensitive (data (match-data)) (string (ffap-string-at-point)) ; uses mode alist (name (or (condition-case nil (and (not (string-match "//" string)) ; foo.com://bar (substitute-in-file-name string)) (error nil)) string)) (abs (file-name-absolute-p name)) (default-directory default-directory) (oname name)) (unwind-protect (cond ;; Immediate rejects (/ and // and /* are too common in C/C++): ((member name '("" "/" "//" "/*" ".")) nil) ;; Immediately test local filenames. If default-directory is ;; remote, you probably already have a connection. ((and (not abs) (ffap-file-exists-string name))) ;; Try stripping off line numbers; good for compilation/grep output. ((and (not abs) (string-match ":[0-9]" name) (ffap-file-exists-string (substring name 0 (match-beginning 0))))) ;; Try stripping off prominent (non-root - #) shell prompts ;; if the ffap-shell-prompt-regexp is non-nil. ((and ffap-shell-prompt-regexp (not abs) (string-match ffap-shell-prompt-regexp name) (ffap-file-exists-string (substring name (match-end 0))))) ;; Accept remote names without actual checking (too slow): ((and abs (ffap-file-remote-p name))) ;; Ok, not remote, try the existence test even if it is absolute: ((and abs (ffap-file-exists-string name))) ;; Try stripping off line numbers. ((and abs (string-match ":[0-9]" name) (ffap-file-exists-string (substring name 0 (match-beginning 0))))) ;; If it contains a colon, get rid of it (and return if exists) ((and (string-match path-separator name) (setq name (ffap-string-at-point 'nocolon)) (ffap-file-exists-string name))) ;; File does not exist, try the alist: ((let ((alist ffap-alist) tem try case-fold-search) (while (and alist (not try)) (setq tem (car alist) alist (cdr alist)) (if (or (eq major-mode (car tem)) (and (stringp (car tem)) (string-match (car tem) name))) (and (setq try (condition-case nil (funcall (cdr tem) name) (error nil))) (setq try (or (ffap-url-p try) ; not a file! (ffap-file-remote-p try) (ffap-file-exists-string try)))))) try)) ;; Try adding a leading "/" (common omission in ftp file names). ;; Note that this uses oname, which still has any colon part. ;; This should have a lower priority than the alist stuff, ;; else it matches things like "ffap.el:1234:56:Warning". ((and (not abs) ffap-ftp-sans-slash-regexp (string-match ffap-ftp-sans-slash-regexp oname) (ffap-file-remote-p (concat "/" oname)))) ;; Alist failed? Try to guess an active remote connection ;; from buffer variables, and try once more, both as an ;; absolute and relative file name on that remote host. ((let* (ffap-rfs-regexp ; suppress (remote-dir (cond ((ffap-file-remote-p default-directory)) ((and (eq major-mode 'internal-ange-ftp-mode) (string-match "^\\*ftp \\(.*\\)@\\(.*\\)\\*$" (buffer-name))) (concat "/" (substring (buffer-name) 5 -1) ":")) ;; This is too often a bad idea: ;;((and (eq major-mode 'w3-mode) ;; (stringp url-current-server)) ;; (host-to-ange-path url-current-server)) ))) (and remote-dir (or (and (string-match "\\`\\(/?~?ftp\\)/" name) (ffap-file-exists-string (ffap-replace-file-component remote-dir (substring name (match-end 1))))) (ffap-file-exists-string (ffap-replace-file-component remote-dir name)))))) ((and ffap-dired-wildcards (string-match ffap-dired-wildcards name) abs (ffap-file-exists-string (file-name-directory (directory-file-name name))) name)) ;; Try all parent directories by deleting the trailing directory ;; name until existing directory is found or name stops changing ((let ((dir name)) (while (and dir (not (ffap-file-exists-string dir)) (not (equal dir (setq dir (file-name-directory (directory-file-name dir))))))) (ffap-file-exists-string dir))) ) (set-match-data data)))) \f ;;; Prompting (`ffap-read-file-or-url'): ;; ;; We want to complete filenames as in read-file-name, but also url's ;; which read-file-name-internal would truncate at the "//" string. ;; The solution here is to replace read-file-name-internal with ;; `ffap-read-file-or-url-internal', which checks the minibuffer ;; contents before attempting to complete filenames. (defun ffap-read-file-or-url (prompt guess) "Read file or URL from minibuffer, with PROMPT and initial GUESS." (or guess (setq guess default-directory)) (let (dir) ;; Tricky: guess may have or be a local directory, like "w3/w3.elc" ;; or "w3/" or "../el/ffap.el" or "../../../" (or (ffap-url-p guess) (progn (or (ffap-file-remote-p guess) (setq guess (abbreviate-file-name (expand-file-name guess)) )) (setq dir (file-name-directory guess)))) (let ((minibuffer-completing-file-name t) (completion-ignore-case read-file-name-completion-ignore-case) (fnh-elem (cons ffap-url-regexp 'url-file-handler))) ;; Explain to `rfn-eshadow' that we can use URLs here. (push fnh-elem file-name-handler-alist) (unwind-protect (setq guess (let ((default-directory (if dir (expand-file-name dir) default-directory))) (completing-read prompt 'ffap-read-file-or-url-internal nil nil (if dir (cons guess (length dir)) guess) (list 'file-name-history) (and buffer-file-name (abbreviate-file-name buffer-file-name))))) ;; Remove the special handler manually. We used to just let-bind ;; file-name-handler-alist to preserve its value, but that caused ;; other modifications to be lost (e.g. when Tramp gets loaded ;; during the completing-read call). (setq file-name-handler-alist (delq fnh-elem file-name-handler-alist)))) ;; Do file substitution like (interactive "F"), suggested by MCOOK. (or (ffap-url-p guess) (setq guess (substitute-in-file-name guess))) ;; Should not do it on url's, where $ is a common (VMS?) character. ;; Note: upcoming url.el package ought to handle this automatically. guess)) (defun ffap-read-url-internal (string pred action) "Complete URLs from history, treating given string as valid." (let ((hist (ffap-symbol-value 'url-global-history-hash-table))) (cond ((not action) (or (try-completion string hist pred) string)) ((eq action t) (or (all-completions string hist pred) (list string))) ;; action == lambda, documented where? Tests whether string is a ;; valid "match". Let us always say yes. (t t)))) (defun ffap-read-file-or-url-internal (string pred action) (unless string ;Why would this ever happen? (setq string default-directory)) (if (ffap-url-p string) (ffap-read-url-internal string pred action) (read-file-name-internal string pred action))) ;; The rest of this page is just to work with package complete.el. ;; This code assumes that you load ffap.el after complete.el. ;; ;; We must inform complete about whether our completion function ;; will do filename style completion. \f ;;; Highlighting (`ffap-highlight'): (defvar ffap-highlight t "If non-nil, ffap highlights the current buffer substring.") (defface ffap '((t :inherit highlight)) "Face used to highlight the current buffer substring." :group 'ffap :version "22.1") (defvar ffap-highlight-overlay nil "Overlay used by `ffap-highlight'.") (defun ffap-highlight (&optional remove) "If `ffap-highlight' is set, highlight the guess in this buffer. That is, the last buffer substring found by `ffap-string-at-point'. Optional argument REMOVE means to remove any such highlighting. Uses the face `ffap' if it is defined, or else `highlight'." (cond (remove (and ffap-highlight-overlay (delete-overlay ffap-highlight-overlay)) ) ((not ffap-highlight) nil) (ffap-highlight-overlay (move-overlay ffap-highlight-overlay (car ffap-string-at-point-region) (nth 1 ffap-string-at-point-region) (current-buffer))) (t (setq ffap-highlight-overlay (apply 'make-overlay ffap-string-at-point-region)) (overlay-put ffap-highlight-overlay 'face 'ffap)))) \f ;;; Main Entrance (`find-file-at-point' == `ffap'): (defun ffap-guesser () "Return file or URL or nil, guessed from text around point." (or (and ffap-url-regexp (ffap-fixup-url (or (ffap-url-at-point) (ffap-gopher-at-point)))) (ffap-file-at-point) ; may yield url! (ffap-fixup-machine (ffap-machine-at-point)))) (defun ffap-prompter (&optional guess) ;; Does guess and prompt step for find-file-at-point. ;; Extra complication for the temporary highlighting. (unwind-protect ;; This catch will let ffap-alist entries do their own prompting ;; and then maybe skip over this prompt (ff-paths, for example). (catch 'ffap-prompter (ffap-read-file-or-url (if ffap-url-regexp "Find file or URL: " "Find file: ") (prog1 (let ((mark-active nil)) ;; Don't use the region here, since it can be something ;; completely unwieldy. If the user wants that, she could ;; use M-w before and then C-y. --Stef (setq guess (or guess (ffap-guesser)))) ; using ffap-alist here (and guess (ffap-highlight)) ))) (ffap-highlight t))) ;;;###autoload (defun find-file-at-point (&optional filename) "Find FILENAME, guessing a default from text around point. If `ffap-url-regexp' is not nil, the FILENAME may also be an URL. With a prefix, this command behaves exactly like `ffap-file-finder'. If `ffap-require-prefix' is set, the prefix meaning is reversed. See also the variables `ffap-dired-wildcards', `ffap-newfile-prompt', and the functions `ffap-file-at-point' and `ffap-url-at-point'." (interactive) (if (and (called-interactively-p 'interactive) (if ffap-require-prefix (not current-prefix-arg) current-prefix-arg)) ;; Do exactly the ffap-file-finder command, even the prompting: (let (current-prefix-arg) ; we already interpreted it (call-interactively ffap-file-finder)) (or filename (setq filename (ffap-prompter))) (cond ((ffap-url-p filename) (let (current-prefix-arg) ; w3 2.3.25 bug, reported by KPC (funcall ffap-url-fetcher filename))) ((and ffap-pass-wildcards-to-dired ffap-dired-wildcards (string-match ffap-dired-wildcards filename)) (funcall ffap-directory-finder filename)) ((and ffap-dired-wildcards (string-match ffap-dired-wildcards filename) find-file-wildcards ;; Check if it's find-file that supports wildcards arg (memq ffap-file-finder '(find-file find-alternate-file))) (funcall ffap-file-finder (expand-file-name filename) t)) ((or (not ffap-newfile-prompt) (file-exists-p filename) (y-or-n-p "File does not exist, create buffer? ")) (funcall ffap-file-finder ;; expand-file-name fixes "~/~/.emacs" bug sent by CHUCKR. (expand-file-name filename))) ;; User does not want to find a non-existent file: ((signal 'file-error (list "Opening file buffer" "no such file or directory" filename)))))) ;; Shortcut: allow {M-x ffap} rather than {M-x find-file-at-point}. ;;;###autoload (defalias 'ffap 'find-file-at-point) \f ;;; Menu support (`ffap-menu'): (defcustom ffap-menu-regexp nil "If non-nil, regexp overriding `ffap-next-regexp' in `ffap-menu'. Make this more restrictive for faster menu building. For example, try \":/\" for URL (and some ftp) references." :type '(choice (const nil) regexp) :group 'ffap) (defvar ffap-menu-alist nil "Buffer local cache of menu presented by `ffap-menu'.") (make-variable-buffer-local 'ffap-menu-alist) (defvar ffap-menu-text-plist (cond ((display-mouse-p) '(face bold mouse-face highlight)) ; keymap <mousy-map> (t nil)) "Text properties applied to strings found by `ffap-menu-rescan'. These properties may be used to fontify the menu references.") ;;;###autoload (defun ffap-menu (&optional rescan) "Put up a menu of files and URLs mentioned in this buffer. Then set mark, jump to choice, and try to fetch it. The menu is cached in `ffap-menu-alist', and rebuilt by `ffap-menu-rescan'. The optional RESCAN argument \(a prefix, interactively\) forces a rebuild. Searches with `ffap-menu-regexp'." (interactive "P") ;; (require 'imenu) -- no longer used, but roughly emulated (if (or (not ffap-menu-alist) rescan ;; or if the first entry is wrong: (and ffap-menu-alist (let ((first (car ffap-menu-alist))) (save-excursion (goto-char (cdr first)) (not (equal (car first) (ffap-guesser))))))) (ffap-menu-rescan)) ;; Tail recursive: (ffap-menu-ask (if ffap-url-regexp "Find file or URL" "Find file") (cons (cons "*Rescan Buffer*" -1) ffap-menu-alist) 'ffap-menu-cont)) (defun ffap-menu-cont (choice) ; continuation of ffap-menu (if (< (cdr choice) 0) (ffap-menu t) ; *Rescan* (push-mark) (goto-char (cdr choice)) ;; Momentary highlight: (unwind-protect (progn (and ffap-highlight (ffap-guesser) (ffap-highlight)) (sit-for 0) ; display (find-file-at-point (car choice))) (ffap-highlight t)))) (defun ffap-menu-ask (title alist cont) "Prompt from a menu of choices, and then apply some action. Arguments are TITLE, ALIST, and CONT \(a continuation function\). This uses either a menu or the minibuffer depending on invocation. The TITLE string is used as either the prompt or menu title. Each ALIST entry looks like (STRING . DATA) and defines one choice. Function CONT is applied to the entry chosen by the user." ;; Note: this function is used with a different continuation ;; by the ffap-url add-on package. ;; Could try rewriting to use easymenu.el or lmenu.el. (let (choice) (cond ;; Emacs mouse: ((and (fboundp 'x-popup-menu) (ffap-mouse-event)) (setq choice (x-popup-menu t (list "" (cons title (mapcar (lambda (i) (cons (car i) i)) alist)))))) ;; minibuffer with completion buffer: (t (let ((minibuffer-setup-hook 'minibuffer-completion-help)) ;; Bug: prompting may assume unique strings, no "". (setq choice (completing-read (format "%s (default %s): " title (car (car alist))) alist nil t ;; (cons (car (car alist)) 0) nil))) (sit-for 0) ; redraw original screen ;; Convert string to its entry, or else the default: (setq choice (or (assoc choice alist) (car alist))))) (if choice (funcall cont choice) (message "No choice made!") ; possible with menus nil))) (defun ffap-menu-rescan () "Search buffer for `ffap-menu-regexp' to build `ffap-menu-alist'. Applies `ffap-menu-text-plist' text properties at all matches." (interactive) (let ((ffap-next-regexp (or ffap-menu-regexp ffap-next-regexp)) (range (- (point-max) (point-min))) (mod (buffer-modified-p)) ; was buffer modified? ;; inhibit-read-only works on read-only text properties ;; as well as read-only buffers. (inhibit-read-only t) ; to set text-properties item ;; Avoid repeated searches of the *mode-alist: (major-mode (if (assq major-mode ffap-string-at-point-mode-alist) major-mode 'file))) (setq ffap-menu-alist nil) (unwind-protect (save-excursion (goto-char (point-min)) (while (setq item (ffap-next-guess)) (setq ffap-menu-alist (cons (cons item (point)) ffap-menu-alist)) (add-text-properties (car ffap-string-at-point-region) (point) ffap-menu-text-plist) (message "Scanning...%2d%% <%s>" (/ (* 100 (- (point) (point-min))) range) item))) (or mod (restore-buffer-modified-p nil)))) (message "Scanning...done") ;; Remove duplicates. (setq ffap-menu-alist ; sort by item (sort ffap-menu-alist (function (lambda (a b) (string-lessp (car a) (car b)))))) (let ((ptr ffap-menu-alist)) ; remove duplicates (while (cdr ptr) (if (equal (car (car ptr)) (car (car (cdr ptr)))) (setcdr ptr (cdr (cdr ptr))) (setq ptr (cdr ptr))))) (setq ffap-menu-alist ; sort by position (sort ffap-menu-alist (function (lambda (a b) (< (cdr a) (cdr b))))))) \f ;;; Mouse Support (`ffap-at-mouse'): ;; ;; See the suggested binding in ffap-bindings (near eof). (defvar ffap-at-mouse-fallback nil ; ffap-menu? too time-consuming "Command invoked by `ffap-at-mouse' if nothing found at click, or nil. Ignored when `ffap-at-mouse' is called programmatically.") (put 'ffap-at-mouse-fallback 'risky-local-variable t) ;;;###autoload (defun ffap-at-mouse (e) "Find file or URL guessed from text around mouse click. Interactively, calls `ffap-at-mouse-fallback' if no guess is found. Return value: * if a guess string is found, return it (after finding it) * if the fallback is called, return whatever it returns * otherwise, nil" (interactive "e") (let ((guess ;; Maybe less surprising without the save-excursion? (save-excursion (mouse-set-point e) ;; Would prefer to do nothing unless click was *on* text. How ;; to tell that the click was beyond the end of current line? (ffap-guesser)))) (cond (guess (set-buffer (ffap-event-buffer e)) (ffap-highlight) (unwind-protect (progn (sit-for 0) ; display (message "Finding `%s'" guess) (find-file-at-point guess) guess) ; success: return non-nil (ffap-highlight t))) ((called-interactively-p 'interactive) (if ffap-at-mouse-fallback (call-interactively ffap-at-mouse-fallback) (message "No file or URL found at mouse click.") nil)) ; no fallback, return nil ;; failure: return nil ))) \f ;;; ffap-other-*, ffap-read-only-*, ffap-alternate-* commands: ;; There could be a real `ffap-noselect' function, but we would need ;; at least two new user variables, and there is no w3-fetch-noselect. ;; So instead, we just fake it with a slow save-window-excursion. (defun ffap-other-window () "Like `ffap', but put buffer in another window. Only intended for interactive use." (interactive) (let (value) (switch-to-buffer-other-window (save-window-excursion (setq value (call-interactively 'ffap)) (unless (or (bufferp value) (bufferp (car-safe value))) (setq value (current-buffer))) (current-buffer))) value)) (defun ffap-other-frame () "Like `ffap', but put buffer in another frame. Only intended for interactive use." (interactive) ;; Extra code works around dedicated windows (noted by JENS, 7/96): (let* ((win (selected-window)) (wdp (window-dedicated-p win)) value) (unwind-protect (progn (set-window-dedicated-p win nil) (switch-to-buffer-other-frame (save-window-excursion (setq value (call-interactively 'ffap)) (unless (or (bufferp value) (bufferp (car-safe value))) (setq value (current-buffer))) (current-buffer)))) (set-window-dedicated-p win wdp)) value)) (defun ffap--toggle-read-only (buffer-or-list) (dolist (buffer (if (listp buffer-or-list) buffer-or-list (list buffer-or-list))) (with-current-buffer buffer (read-only-mode 1)))) (defun ffap-read-only () "Like `ffap', but mark buffer as read-only. Only intended for interactive use." (interactive) (let ((value (call-interactively 'ffap))) (unless (or (bufferp value) (bufferp (car-safe value))) (setq value (current-buffer))) (ffap--toggle-read-only value) value)) (defun ffap-read-only-other-window () "Like `ffap', but put buffer in another window and mark as read-only. Only intended for interactive use." (interactive) (let ((value (ffap-other-window))) (ffap--toggle-read-only value) value)) (defun ffap-read-only-other-frame () "Like `ffap', but put buffer in another frame and mark as read-only. Only intended for interactive use." (interactive) (let ((value (ffap-other-frame))) (ffap--toggle-read-only value) value)) (defun ffap-alternate-file () "Like `ffap' and `find-alternate-file'. Only intended for interactive use." (interactive) (let ((ffap-file-finder 'find-alternate-file)) (call-interactively 'ffap))) (defun ffap-alternate-file-other-window () "Like `ffap' and `find-alternate-file-other-window'. Only intended for interactive use." (interactive) (let ((ffap-file-finder 'find-alternate-file-other-window)) (call-interactively 'ffap))) (defun ffap-literally () "Like `ffap' and `find-file-literally'. Only intended for interactive use." (interactive) (let ((ffap-file-finder 'find-file-literally)) (call-interactively 'ffap))) (defalias 'find-file-literally-at-point 'ffap-literally) \f ;;; Bug Reporter: (define-obsolete-function-alias 'ffap-bug 'report-emacs-bug "23.1") (define-obsolete-function-alias 'ffap-submit-bug 'report-emacs-bug "23.1") \f ;;; Hooks for Gnus, VM, Rmail: ;; ;; If you do not like these bindings, write versions with whatever ;; bindings you would prefer. (defun ffap-ro-mode-hook () "Bind `ffap-next' and `ffap-menu' to M-l and M-m, resp." (local-set-key "\M-l" 'ffap-next) (local-set-key "\M-m" 'ffap-menu)) (defun ffap-gnus-hook () "Bind `ffap-gnus-next' and `ffap-gnus-menu' to M-l and M-m, resp." (set (make-local-variable 'ffap-foo-at-bar-prefix) "news") ; message-id's ;; Note "l", "L", "m", "M" are taken: (local-set-key "\M-l" 'ffap-gnus-next) (local-set-key "\M-m" 'ffap-gnus-menu)) (defvar gnus-summary-buffer) (defvar gnus-article-buffer) ;; This code is called from gnus. (declare-function gnus-summary-select-article "gnus-sum" (&optional all-headers force pseudo article)) (declare-function gnus-configure-windows "gnus-win" (setting &optional force)) (defun ffap-gnus-wrapper (form) ; used by both commands below (and (eq (current-buffer) (get-buffer gnus-summary-buffer)) (gnus-summary-select-article)) ; get article of current line ;; Preserve selected buffer, but do not do save-window-excursion, ;; since we want to see any window created by the form. Temporarily ;; select the article buffer, so we can see any point movement. (let ((sb (window-buffer (selected-window)))) (gnus-configure-windows 'article) (pop-to-buffer gnus-article-buffer) (widen) ;; Skip headers for ffap-gnus-next (which will wrap around) (if (eq (point) (point-min)) (search-forward "\n\n" nil t)) (unwind-protect (eval form) (pop-to-buffer sb)))) (defun ffap-gnus-next () "Run `ffap-next' in the gnus article buffer." (interactive) (ffap-gnus-wrapper '(ffap-next nil t))) (defun ffap-gnus-menu () "Run `ffap-menu' in the gnus article buffer." (interactive) (ffap-gnus-wrapper '(ffap-menu))) \f ;;;###autoload (defun dired-at-point (&optional filename) "Start Dired, defaulting to file at point. See `ffap'. If `dired-at-point-require-prefix' is set, the prefix meaning is reversed." (interactive) (if (and (called-interactively-p 'interactive) (if dired-at-point-require-prefix (not current-prefix-arg) current-prefix-arg)) (let (current-prefix-arg) ; already interpreted (call-interactively ffap-directory-finder)) (or filename (setq filename (dired-at-point-prompter))) (cond ((ffap-url-p filename) (funcall ffap-url-fetcher filename)) ((and ffap-dired-wildcards (string-match ffap-dired-wildcards filename)) (funcall ffap-directory-finder filename)) ((file-exists-p filename) (if (file-directory-p filename) (funcall ffap-directory-finder (expand-file-name filename)) (funcall ffap-directory-finder (concat (expand-file-name filename) "*")))) ((and (file-writable-p (or (file-name-directory (directory-file-name filename)) filename)) (y-or-n-p "Directory does not exist, create it? ")) (make-directory filename) (funcall ffap-directory-finder filename)) ((error "No such file or directory `%s'" filename))))) (defun dired-at-point-prompter (&optional guess) ;; Does guess and prompt step for find-file-at-point. ;; Extra complication for the temporary highlighting. (unwind-protect (ffap-read-file-or-url (cond ((eq ffap-directory-finder 'list-directory) "List directory (brief): ") (ffap-url-regexp "Dired file or URL: ") (t "Dired file: ")) (prog1 (setq guess (or guess (let ((guess (ffap-guesser))) (if (or (not guess) (ffap-url-p guess) (ffap-file-remote-p guess)) guess (setq guess (abbreviate-file-name (expand-file-name guess))) (cond ;; Interpret local directory as a directory. ((file-directory-p guess) (file-name-as-directory guess)) ;; Get directory component from local files. ((file-regular-p guess) (file-name-directory guess)) (guess)))) )) (and guess (ffap-highlight)))) (ffap-highlight t))) \f ;;; ffap-dired-other-*, ffap-list-directory commands: (defun ffap-dired-other-window () "Like `dired-at-point', but put buffer in another window. Only intended for interactive use." (interactive) (let (value) (switch-to-buffer-other-window (save-window-excursion (setq value (call-interactively 'dired-at-point)) (current-buffer))) value)) (defun ffap-dired-other-frame () "Like `dired-at-point', but put buffer in another frame. Only intended for interactive use." (interactive) ;; Extra code works around dedicated windows (noted by JENS, 7/96): (let* ((win (selected-window)) (wdp (window-dedicated-p win)) value) (unwind-protect (progn (set-window-dedicated-p win nil) (switch-to-buffer-other-frame (save-window-excursion (setq value (call-interactively 'dired-at-point)) (current-buffer)))) (set-window-dedicated-p win wdp)) value)) (defun ffap-list-directory () "Like `dired-at-point' and `list-directory'. Only intended for interactive use." (interactive) (let ((ffap-directory-finder 'list-directory)) (call-interactively 'dired-at-point))) \f ;;; Hooks to put in `file-name-at-point-functions': ;;;###autoload (defun ffap-guess-file-name-at-point () "Try to get a file name at point. This hook is intended to be put in `file-name-at-point-functions'." (when (fboundp 'ffap-guesser) ;; Logic from `ffap-read-file-or-url' and `dired-at-point-prompter'. (let ((guess (ffap-guesser))) (setq guess (if (or (not guess) (and (fboundp 'ffap-url-p) (ffap-url-p guess)) (and (fboundp 'ffap-file-remote-p) (ffap-file-remote-p guess))) guess (abbreviate-file-name (expand-file-name guess)))) (when guess (if (file-directory-p guess) (file-name-as-directory guess) guess))))) \f ;;; Offer default global bindings (`ffap-bindings'): (defvar ffap-bindings '((global-set-key [S-mouse-3] 'ffap-at-mouse) (global-set-key [C-S-mouse-3] 'ffap-menu) (global-set-key "\C-x\C-f" 'find-file-at-point) (global-set-key "\C-x\C-r" 'ffap-read-only) (global-set-key "\C-x\C-v" 'ffap-alternate-file) (global-set-key "\C-x4f" 'ffap-other-window) (global-set-key "\C-x5f" 'ffap-other-frame) (global-set-key "\C-x4r" 'ffap-read-only-other-window) (global-set-key "\C-x5r" 'ffap-read-only-other-frame) (global-set-key "\C-xd" 'dired-at-point) (global-set-key "\C-x4d" 'ffap-dired-other-window) (global-set-key "\C-x5d" 'ffap-dired-other-frame) (global-set-key "\C-x\C-d" 'ffap-list-directory) (add-hook 'gnus-summary-mode-hook 'ffap-gnus-hook) (add-hook 'gnus-article-mode-hook 'ffap-gnus-hook) (add-hook 'vm-mode-hook 'ffap-ro-mode-hook) (add-hook 'rmail-mode-hook 'ffap-ro-mode-hook)) "List of binding forms evaluated by function `ffap-bindings'. A reasonable ffap installation needs just this one line: (ffap-bindings) Of course if you do not like these bindings, just roll your own!") ;;;###autoload (defun ffap-bindings () "Evaluate the forms in variable `ffap-bindings'." (interactive) (eval (cons 'progn ffap-bindings))) \f (provide 'ffap) ;;; ffap.el ends here ^ permalink raw reply related [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v4) 2012-10-20 8:45 ` bug#8439: [PATCH] ffap.el -- detect paths with spaces (v4) jari @ 2012-10-20 10:20 ` Eli Zaretskii 2012-10-21 0:18 ` Stefan Monnier 2019-11-23 13:31 ` bug#6695: " Lars Ingebrigtsen 2 siblings, 0 replies; 29+ messages in thread From: Eli Zaretskii @ 2012-10-20 10:20 UTC (permalink / raw) To: jari; +Cc: 8439 > Date: Sat, 20 Oct 2012 11:45:51 +0300 > From: jari <jari.aalto@cante.net> > Cc: Eli Zaretskii <eliz@gnu.org> > > On 2012-10-20 10:11:56 Eli Zaretskii: > | Someone said in another discussion that Cygwin already does accept > | Windows-style file names. > > Cygwin Emacs 24.2.1: > > C-x C-f c:/test.txt > => Use M-x make-directory RET RET to create the directory and its parents > > C-x C-f c:\test.txt > => Use M-x make-directory RET RET to create the directory and its parents I said nothing about "C-x C-f", and ffap doesn't go through it (AFAIK). ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v4) 2012-10-20 8:45 ` bug#8439: [PATCH] ffap.el -- detect paths with spaces (v4) jari 2012-10-20 10:20 ` Eli Zaretskii @ 2012-10-21 0:18 ` Stefan Monnier 2012-10-21 8:07 ` Jari Aalto 2019-11-23 13:31 ` bug#6695: " Lars Ingebrigtsen 2 siblings, 1 reply; 29+ messages in thread From: Stefan Monnier @ 2012-10-21 0:18 UTC (permalink / raw) To: jari; +Cc: 8439 > - remove functions related to Cygwin and use > cygwin-convert-path-from-windows Again, I don't think ffap should do this. If you want to use Windows file names in Cygwin Emacs, then make Cygwin Emacs understand those file names and not just in ffap. Stefan "Haven't had time to look at the patch yet" ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v4) 2012-10-21 0:18 ` Stefan Monnier @ 2012-10-21 8:07 ` Jari Aalto 0 siblings, 0 replies; 29+ messages in thread From: Jari Aalto @ 2012-10-21 8:07 UTC (permalink / raw) To: 8439 2012-10-21 03:18 Stefan Monnier <monnier@iro.umontreal.ca>: | > - remove functions related to Cygwin and use | > cygwin-convert-path-from-windows | | Again, I don't think ffap should do this. Files under Cygwin Emacs are opened e.g. in $HOME or //SHARE/ directories; those contain lines with windows style paths. | If you want to use Windows file names in Cygwin Emacs, then make Cygwin | Emacs understand those file names and not just in ffap. I have no expertise on that area. I'm sure someone can continue to generalize further. Speaking from a user's perpective, it would be nice to have an improved ffap in next release, as the common use is: * move point under file name * call ffap => it reads the file name, suitable for current environment (Cygwin). Jari ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#6695: bug#8439: [PATCH] ffap.el -- detect paths with spaces (v4) 2012-10-20 8:45 ` bug#8439: [PATCH] ffap.el -- detect paths with spaces (v4) jari 2012-10-20 10:20 ` Eli Zaretskii 2012-10-21 0:18 ` Stefan Monnier @ 2019-11-23 13:31 ` Lars Ingebrigtsen 2020-08-14 13:08 ` Lars Ingebrigtsen 2 siblings, 1 reply; 29+ messages in thread From: Lars Ingebrigtsen @ 2019-11-23 13:31 UTC (permalink / raw) To: jari; +Cc: 8439, 6695 jari <jari.aalto@cante.net> writes: > In this patch (compared to previous v3): > > - remove functions related to Cygwin and use cygwin-convert-path-from-windows > > - obey END parameter in ffap-search-backward-file-end as originally > intended > > - correct "path-separator" term into "dir-separator" everywhere This was seven years ago, and not surprisingly, the patch doesn't apply any more. But I think the approach here seemed good -- going back in the buffer and check whether you find something that matches a file on the file system (if I understood the patch correctly). Is there still interest in making this work, or has everybody given up on using ffap with file names with spaces? -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#6695: bug#8439: [PATCH] ffap.el -- detect paths with spaces (v4) 2019-11-23 13:31 ` bug#6695: " Lars Ingebrigtsen @ 2020-08-14 13:08 ` Lars Ingebrigtsen 2020-08-15 9:07 ` Eli Zaretskii 0 siblings, 1 reply; 29+ messages in thread From: Lars Ingebrigtsen @ 2020-08-14 13:08 UTC (permalink / raw) To: jari; +Cc: 8439, 6695 Lars Ingebrigtsen <larsi@gnus.org> writes: > This was seven years ago, and not surprisingly, the patch doesn't apply > any more. I've respun the patch so that it now applies to Emacs 28, and the test cases seem to kinda work? The c: isn't included, but is that to be expected? I removed the Cygwin char translation stuff, because there was some discussion about whether that was needed. So what do people think? Good or bad? Does this work in any way sensibly for people? diff --git a/lisp/ffap.el b/lisp/ffap.el index 4a506207d5..6d40fa8c45 100644 --- a/lisp/ffap.el +++ b/lisp/ffap.el @@ -1109,6 +1109,123 @@ ffap-string-at-point ;; Added at suggestion of RHOGEE (for ff-paths), 7/24/95. "Last string returned by the function `ffap-string-at-point'.") +;; Test cases: (let ((ffap-file-name-with-spaces-flag t)) (ffap-string-at-point)) +;; +;; c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program here.txt +;; c:/Program Files/Open Text Evaluation Media/Open Text Exceed 14 x86/Program Files/Hummingbird/ +;; c:\Program Files\Open Text Evaluation Media\Open Text Exceed 14 x86\Program Files\Hummingbird\ +;; c:\Program Files\Freescale\CW for MPC55xx and MPC56xx 2.10\PowerPC_EABI_Tools\Command_Line_Tools\CLT_Usage_Notes.txt +;; C:\temp\program.log on Windows or /var/log/program.log on Unix. + +(defvar ffap-file-name-with-spaces-flag (memq system-type '(ms-dos windows-nt)) + "If non-nil, enable looking for paths with spaces in `ffap-string-at-point'. +Enabled in W32 by default.") + +(defun ffap-search-backward-file-end (&optional dir-separator end) + "Search backward position point where file would probably end. +Optional DIR-SEPARATOR defaults to \"/\". The search maximum is +`line-end-position' or optional END point. + +Suppose the cursor is somewhere that might be near end of file, +the guessing would position point before punctuation (like comma) +after the file extension: + + C:\temp\file.log, which contain .... + =============================== (before) + ---------------- (after) + + + C:\temp\file.log on Windows or /tmp/file.log on Unix + =============================== (before) + ---------------- (after) + +The strategy is to search backward until DIR-SEPARATOR which defaults to +\"/\" and then take educated guesses. + +Move point and return point if an adjustment was done." + (unless dir-separator + (setq dir-separator "/")) + (let ((opoint (point)) + point punct end whitespace-p) + (when (re-search-backward + (regexp-quote dir-separator) (line-beginning-position) t) + ;; Move to the beginning of the match.. + (forward-char 1) + ;; ... until typical punctuation. + (when (re-search-forward "\\([][<>()\"'`,.:;]\\)" + (or end + (line-end-position)) + t) + (setq end (match-end 0)) + (setq punct (match-string 1)) + (setq whitespace-p (looking-at "[ \t\r\n]\\|$")) + (goto-char end) + (cond + ((and (string-equal punct ".") + whitespace-p) ;end of sentence + (setq point (1- (point)))) + ((and (string-equal punct ".") + (looking-at "[a-zA-Z0-9.]+")) ;possibly file extension + (setq point (match-end 0))) + (t + (setq point (point))))) + (goto-char opoint) + (when point + (goto-char point) + point)))) + +(defun ffap-search-forward-file-end (&optional dir-separator) + "Search DIR-SEPARATOR and position point at file's maximum ending. +This includes spaces. +Optional DIR-SEPARATOR defaults to \"/\". +Call `ffap-search-backward-file-end' to refine the ending point." + (unless dir-separator + (setq dir-separator "/")) + (let* ((chars ;expected chars in file name + (concat "[^][^<>()\"'`;,#*|" + ;; exclude the opposite as we know the separator + (if (string-equal dir-separator "/") + "\\\\" + "/") + "\t\r\n]")) + (re (concat + chars "*" + (if dir-separator + (regexp-quote dir-separator) + "/") + chars "*"))) + (when (looking-at re) + (goto-char (match-end 0))))) + +(defun ffap-dir-separator-near-point () + "Search backward and forward for closest slash or backlash in line. +Return string slash or backslash. Point is moved to closest position." + (let ((point (point)) + str pos) + (when (looking-at ".*?/") + (setq str "/" + pos (match-end 0))) + (when (and (looking-at ".*?\\\\") + (or (null pos) + (< (match-end 0) pos))) + (setq str "\\" + pos (match-end 0))) + (goto-char point) + (when (and (re-search-backward "/" (line-beginning-position) t) + (or (null pos) + (< (- point (point)) (- pos point)))) + (setq str "/" + pos (1+ (point)))) ;1+ to keep cursor at the end of char + (goto-char point) + (when (and (re-search-backward "\\\\" (line-beginning-position) t) + (or (null pos) + (< (- point (point)) (- pos point)))) + (setq str "\\" + pos (1+ (point)))) + (when pos + (goto-char pos)) + str)) + (defun ffap-string-at-point (&optional mode) "Return a string of characters from around point. @@ -1128,7 +1245,8 @@ ffap-string-at-point When the region is active and larger than `ffap-max-region-length', return an empty string, and set `ffap-string-at-point-region' to '(1 1)." - (let* ((args + (let* (dir-separator + (args (cdr (or (assq (or mode major-mode) ffap-string-at-point-mode-alist) (assq 'file ffap-string-at-point-mode-alist)))) @@ -1137,14 +1255,25 @@ ffap-string-at-point (beg (if region-selected (region-beginning) (save-excursion - (skip-chars-backward (car args)) - (skip-chars-forward (nth 1 args) pt) + (if (and ffap-file-name-with-spaces-flag + (memq mode '(nil file))) + (when (setq dir-separator (ffap-dir-separator-near-point)) + (while (re-search-backward + (regexp-quote dir-separator) + (line-beginning-position) t) + (goto-char (match-beginning 0)))) + (skip-chars-backward (car args)) + (skip-chars-forward (nth 1 args) pt)) (point)))) (end (if region-selected (region-end) (save-excursion (skip-chars-forward (car args)) (skip-chars-backward (nth 2 args) pt) + (when (and ffap-file-name-with-spaces-flag + (memq mode '(nil file))) + (ffap-search-forward-file-end dir-separator) + (ffap-search-backward-file-end dir-separator)) (point)))) (region-len (- (max beg end) (min beg end)))) -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no ^ permalink raw reply related [flat|nested] 29+ messages in thread
* bug#6695: bug#8439: [PATCH] ffap.el -- detect paths with spaces (v4) 2020-08-14 13:08 ` Lars Ingebrigtsen @ 2020-08-15 9:07 ` Eli Zaretskii 2020-08-15 10:13 ` Lars Ingebrigtsen 0 siblings, 1 reply; 29+ messages in thread From: Eli Zaretskii @ 2020-08-15 9:07 UTC (permalink / raw) To: Lars Ingebrigtsen; +Cc: 8439, 6695, jari.aalto > From: Lars Ingebrigtsen <larsi@gnus.org> > Cc: 8439@debbugs.gnu.org, 6695@debbugs.gnu.org, Eli Zaretskii <eliz@gnu.org> > Date: Fri, 14 Aug 2020 15:08:45 +0200 > > I've respun the patch so that it now applies to Emacs 28, and the test > cases seem to kinda work? Thanks. > The c: isn't included, but is that to be expected? Is it? I thought the intent was to include the full file name, which means the drive letter should be included. Otherwise the file will not be found. > So what do people think? Good or bad? Does this work in any way > sensibly for people? Since the heuristic only covers some use cases, I think we should have it off by default, and we should document its potential pitfalls in the doc string. With those qualifications, I'm okay with adding this optional feature. ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#6695: bug#8439: [PATCH] ffap.el -- detect paths with spaces (v4) 2020-08-15 9:07 ` Eli Zaretskii @ 2020-08-15 10:13 ` Lars Ingebrigtsen 0 siblings, 0 replies; 29+ messages in thread From: Lars Ingebrigtsen @ 2020-08-15 10:13 UTC (permalink / raw) To: Eli Zaretskii; +Cc: 8439, 6695, jari.aalto Eli Zaretskii <eliz@gnu.org> writes: >> The c: isn't included, but is that to be expected? > > Is it? I thought the intent was to include the full file name, which > means the drive letter should be included. Otherwise the file will > not be found. I don't have a Windows system to test with... it's possible that the functions return the file name including the c: on a Windows machine? >> So what do people think? Good or bad? Does this work in any way >> sensibly for people? > > Since the heuristic only covers some use cases, I think we should have > it off by default, and we should document its potential pitfalls in > the doc string. With those qualifications, I'm okay with adding this > optional feature. OK, I've added some tests and pushed it to the trunk. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) 2012-10-20 1:44 ` Stefan Monnier 2012-10-20 1:49 ` Daniel Colascione 2012-10-20 7:56 ` bug#8439: [PATCH] ffap.el -- detect paths with spaces (v3) jari @ 2012-10-20 8:11 ` Eli Zaretskii 2012-10-21 0:16 ` Stefan Monnier 2 siblings, 1 reply; 29+ messages in thread From: Eli Zaretskii @ 2012-10-20 8:11 UTC (permalink / raw) To: Stefan Monnier; +Cc: 8439, jari.aalto > From: Stefan Monnier <monnier@iro.umontreal.ca> > Date: Fri, 19 Oct 2012 21:44:02 -0400 > Cc: 8439@debbugs.gnu.org > > > + ;; Under Cygwin, convert drive letters in paths. > > + (when (and cygwin-p > > + (memq mode '(nil file)) > > + (string-match "^\\([a-zA-Z]\\):[/\\\\]\\(.*\\)" str)) > > + (let ((drive (downcase (match-string 1 str))) > > + (path (match-string 2 str))) > > + (setq str (format "/cygdrive/%s/%s" > > + drive > > + (replace-regexp-in-string "[\\\\]" "/" path))))) > > This shouldn't be here: the right way to do it is to make the Cygwin > Emacs accept Windows-style file name. Someone said in another discussion that Cygwin already does accept Windows-style file names. ^ permalink raw reply [flat|nested] 29+ messages in thread
* bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) 2012-10-20 8:11 ` bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) Eli Zaretskii @ 2012-10-21 0:16 ` Stefan Monnier 0 siblings, 0 replies; 29+ messages in thread From: Stefan Monnier @ 2012-10-21 0:16 UTC (permalink / raw) To: Eli Zaretskii; +Cc: 8439, jari.aalto > Someone said in another discussion that Cygwin already does accept > Windows-style file names. I think that was a misunderstanding. But Cygwin Emacs probably should understand Windows-style file names to some extent (probably via a file-name handler). Stefan ^ permalink raw reply [flat|nested] 29+ messages in thread
end of thread, other threads:[~2020-08-15 10:13 UTC | newest] Thread overview: 29+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2011-04-07 15:24 bug#8439: [PATCH] ffap.el -- detect paths with spaces Jari Aalto 2011-07-03 23:29 ` Lars Magne Ingebrigtsen 2012-10-19 7:39 ` bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) Jari Aalto 2012-10-19 9:49 ` Eli Zaretskii 2012-10-19 10:05 ` jari 2012-10-19 11:15 ` Yigal Hochberg 2012-10-19 11:22 ` Eli Zaretskii 2012-10-19 12:15 ` Nicolas Richard 2012-10-19 21:47 ` Andrew W. Nosenko 2012-10-19 22:23 ` Eli Zaretskii 2012-10-19 22:36 ` Yigal Hochberg 2012-10-19 22:57 ` Andrew W. Nosenko 2012-10-19 23:24 ` Yigal Hochberg 2012-10-20 1:45 ` Stefan Monnier 2012-10-20 11:01 ` Juri Linkov 2012-10-19 8:35 ` Jari Aalto 2012-10-20 1:44 ` Stefan Monnier 2012-10-20 1:49 ` Daniel Colascione 2012-10-20 7:56 ` bug#8439: [PATCH] ffap.el -- detect paths with spaces (v3) jari 2012-10-20 8:45 ` bug#8439: [PATCH] ffap.el -- detect paths with spaces (v4) jari 2012-10-20 10:20 ` Eli Zaretskii 2012-10-21 0:18 ` Stefan Monnier 2012-10-21 8:07 ` Jari Aalto 2019-11-23 13:31 ` bug#6695: " Lars Ingebrigtsen 2020-08-14 13:08 ` Lars Ingebrigtsen 2020-08-15 9:07 ` Eli Zaretskii 2020-08-15 10:13 ` Lars Ingebrigtsen 2012-10-20 8:11 ` bug#8439: [PATCH] ffap.el -- detect paths with spaces (v2) Eli Zaretskii 2012-10-21 0:16 ` Stefan Monnier
Code repositories for project(s) associated with this public inbox https://git.savannah.gnu.org/cgit/emacs.git This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).