]> code.delx.au - gnu-emacs/blobdiff - lisp/thingatpt.el
(compilation-directory-matcher): Improve previous doc fix.
[gnu-emacs] / lisp / thingatpt.el
index 88a2807538bb37a6d99667eb3d52fe4e77c4bb53..e2618bca8fd919709b9ba6bc8aefcea76173075d 100644 (file)
@@ -1,8 +1,10 @@
-;;; thingatpt.el --- Get the `thing' at point
+;;; thingatpt.el --- get the `thing' at point
 
-;; Copyright (C) 1991,92,93,94,95,96,1997 Free Software Foundation, Inc.
+;; Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2000
+;;   2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
 
 ;; Author: Mike Williams <mikew@gopher.dosli.govt.nz>
+;; Maintainer: FSF
 ;; Keywords: extensions, matching, mouse
 ;; Created: Thu Mar 28 13:48:23 1991
 
 ;; forward-"thing" operator (eg. forward-word, forward-line).
 ;;
 ;; Special cases are allowed for using properties associated with the named
-;; "thing": 
+;; "thing":
 ;;
 ;;   forward-op                Function to call to skip forward over a "thing" (or
 ;;                      with a negative argument, backward).
-;;                      
+;;
 ;;   beginning-op      Function to call to skip to the beginning of a "thing".
 ;;   end-op            Function to call to skip to the end of a "thing".
 ;;
 
 ;;;###autoload
 (defun forward-thing (thing &optional n)
-  "Move forward to the end of the next THING."
+  "Move forward to the end of the Nth next THING."
   (let ((forward-op (or (get thing 'forward-op)
                        (intern-soft (format "forward-%s" thing)))))
-    (if (fboundp forward-op)
+    (if (functionp forward-op)
        (funcall forward-op (or n 1))
       (error "Can't determine how to move over a %s" thing))))
 
@@ -78,46 +80,40 @@ of the textual entity that was found."
       (condition-case nil
          (save-excursion
            ;; Try moving forward, then back.
-           (let ((end (progn 
-                        (funcall 
-                         (or (get thing 'end-op) 
-                             (function (lambda () (forward-thing thing 1)))))
-                        (point)))
-                 (beg (progn 
-                        (funcall 
-                         (or (get thing 'beginning-op) 
-                             (function (lambda () (forward-thing thing -1)))))
-                        (point))))
+            (funcall ;; First move to end.
+             (or (get thing 'end-op)
+                 (lambda () (forward-thing thing 1))))
+            (funcall ;; Then move to beg.
+             (or (get thing 'beginning-op)
+                 (lambda () (forward-thing thing -1))))
+           (let ((beg (point)))
              (if (not (and beg (> beg orig)))
                  ;; If that brings us all the way back to ORIG,
                  ;; it worked.  But END may not be the real end.
                  ;; So find the real end that corresponds to BEG.
                  (let ((real-end
-                        (progn 
-                          (funcall 
-                           (or (get thing 'end-op) 
-                               (function (lambda () (forward-thing thing 1)))))
+                        (progn
+                          (funcall
+                           (or (get thing 'end-op)
+                                (lambda () (forward-thing thing 1))))
                           (point))))
                    (if (and beg real-end (<= beg orig) (<= orig real-end))
                        (cons beg real-end)))
                (goto-char orig)
                ;; Try a second time, moving backward first and then forward,
                ;; so that we can find a thing that ends at ORIG.
-               (let ((beg (progn 
-                            (funcall 
-                             (or (get thing 'beginning-op) 
-                                 (function (lambda () (forward-thing thing -1)))))
-                            (point)))
-                     (end (progn 
-                            (funcall 
-                             (or (get thing 'end-op) 
-                                 (function (lambda () (forward-thing thing 1)))))
-                            (point)))
-                     (real-beg
-                      (progn 
-                        (funcall 
-                         (or (get thing 'beginning-op) 
-                             (function (lambda () (forward-thing thing -1)))))
+                (funcall ;; First, move to beg.
+                 (or (get thing 'beginning-op)
+                     (lambda () (forward-thing thing -1))))
+                (funcall ;; Then move to end.
+                 (or (get thing 'end-op)
+                     (lambda () (forward-thing thing 1))))
+               (let ((end (point))
+                      (real-beg
+                      (progn
+                        (funcall
+                         (or (get thing 'beginning-op)
+                              (lambda () (forward-thing thing -1))))
                         (point))))
                  (if (and real-beg end (<= real-beg orig) (<= orig end))
                      (cons real-beg end))))))
@@ -135,7 +131,7 @@ a symbol as a valid THING."
   (if (get thing 'thing-at-point)
       (funcall (get thing 'thing-at-point))
     (let ((bounds (bounds-of-thing-at-point thing)))
-      (if bounds 
+      (if bounds
          (buffer-substring (car bounds) (cdr bounds))))))
 
 ;; Go to beginning/end
@@ -150,17 +146,17 @@ a symbol as a valid THING."
     (or bounds (error "No %s here" thing))
     (goto-char (cdr bounds))))
 
-;;  Special cases 
+;;  Special cases
 
-;;  Lines 
+;;  Lines
 
 ;; bolp will be false when you click on the last line in the buffer
 ;; and it has no final newline.
 
 (put 'line 'beginning-op
-     (function (lambda () (if (bolp) (forward-line -1) (beginning-of-line)))))
+     (lambda () (if (bolp) (forward-line -1) (beginning-of-line))))
 
-;;  Sexps 
+;;  Sexps
 
 (defun in-string-p ()
   (let ((orig (point)))
@@ -186,24 +182,30 @@ a symbol as a valid THING."
 
 (put 'sexp 'beginning-op 'beginning-of-sexp)
 
-;;  Lists 
+;;  Lists
 
-(put 'list 'end-op (function (lambda () (up-list 1))))
+(put 'list 'end-op (lambda () (up-list 1)))
 (put 'list 'beginning-op 'backward-sexp)
 
-;;  Filenames and URLs
+;;  Filenames and URLs  www.com/foo%32bar
 
-(defvar thing-at-point-file-name-chars "~/A-Za-z0-9---_.${}#%,:"
+(defvar thing-at-point-file-name-chars "-~/[:alnum:]_.${}#%,:"
   "Characters allowable in filenames.")
 
-(put 'filename 'end-op    
-     '(lambda () (skip-chars-forward thing-at-point-file-name-chars)))
+(put 'filename 'end-op
+     (lambda ()
+       (re-search-forward (concat "\\=[" thing-at-point-file-name-chars "]*")
+                         nil t)))
 (put 'filename 'beginning-op
-     '(lambda () (skip-chars-backward thing-at-point-file-name-chars)))
+     (lambda ()
+       (if (re-search-backward (concat "[^" thing-at-point-file-name-chars "]")
+                              nil t)
+          (forward-char)
+        (goto-char (point-min)))))
 
 (defvar thing-at-point-url-path-regexp
   "[^]\t\n \"'()<>[^`{}]*[^]\t\n \"'()<>[^`{}.,;]+"
-  "A regular expression probably matching the host, path or e-mail part of a URL.")
+  "A regular expression probably matching the host and filename or e-mail part of a URL.")
 
 (defvar thing-at-point-short-url-regexp
   (concat "[-A-Za-z0-9.]+" thing-at-point-url-path-regexp)
@@ -211,10 +213,21 @@ a symbol as a valid THING."
 Hostname matching is stricter in this case than for
 ``thing-at-point-url-regexp''.")
 
+(defvar thing-at-point-uri-schemes
+  ;; Officials from http://www.iana.org/assignments/uri-schemes
+  '("ftp://" "http://" "gopher://" "mailto:" "news:" "nntp:"
+    "telnet://" "wais://" "file:/" "prospero:" "z39.50s:" "z39.50r:"
+    "cid:" "mid:" "vemmi:" "service:" "imap:" "nfs:" "acap:" "rtsp:"
+    "tip:" "pop:" "data:" "dav:" "opaquelocktoken:" "sip:" "tel:" "fax:"
+    "modem:" "ldap:" "https://" "soap.beep:" "soap.beeps:" "urn:" "go:"
+    "afs:" "tn3270:" "mailserver:"
+  ;; Compatibility
+    "snews:")
+  "Uniform Resource Identifier (URI) Schemes.")
+
 (defvar thing-at-point-url-regexp
-  (concat
-   "\\(https?://\\|ftp://\\|gopher://\\|telnet://\\|wais://\\|file:/\\|s?news:\\|mailto:\\)"
-   thing-at-point-url-path-regexp)
+  (concat "\\<\\(" (mapconcat 'identity thing-at-point-uri-schemes "\\|") "\\)"
+          thing-at-point-url-path-regexp)
   "A regular expression probably matching a complete URL.")
 
 (defvar thing-at-point-markedup-url-regexp
@@ -224,26 +237,30 @@ This may contain whitespace (including newlines) .")
 
 (put 'url 'bounds-of-thing-at-point 'thing-at-point-bounds-of-url-at-point)
 (defun thing-at-point-bounds-of-url-at-point ()
-  (let ((url "") short strip)
-    (if (or (setq strip (thing-at-point-looking-at
-                        thing-at-point-markedup-url-regexp))
+  (let ((strip (thing-at-point-looking-at
+                        thing-at-point-markedup-url-regexp))) ;; (url "") short
+    (if (or strip
            (thing-at-point-looking-at thing-at-point-url-regexp)
            ;; Access scheme omitted?
-           (setq short (thing-at-point-looking-at
-                        thing-at-point-short-url-regexp)))
+           ;; (setq short (thing-at-point-looking-at
+           ;;           thing-at-point-short-url-regexp))
+            )
        (let ((beginning (match-beginning 0))
              (end (match-end 0)))
-         (cond (strip
-                (setq beginning (+ beginning 5))
-                (setq end (- end 1))))
+         (when strip
+            (setq beginning (+ beginning 5))
+            (setq end (- end 1)))
          (cons beginning end)))))
 
 (put 'url 'thing-at-point 'thing-at-point-url-at-point)
 (defun thing-at-point-url-at-point ()
   "Return the URL around or before point.
-Search backwards for the start of a URL ending at or after 
-point.  If no URL found, return nil.  The access scheme, `http://'
-will be prepended if absent."
+
+Search backwards for the start of a URL ending at or after point.  If
+no URL found, return nil.  The access scheme will be prepended if
+absent: \"mailto:\" if the string contains \"@\", \"ftp://\" if it
+starts with \"ftp\" and not \"ftp:/\", or \"http://\" by default."
+
   (let ((url "") short strip)
     (if (or (setq strip (thing-at-point-looking-at
                         thing-at-point-markedup-url-regexp))
@@ -256,10 +273,15 @@ will be prepended if absent."
                                                    (match-end 0)))
          (and strip (setq url (substring url 5 -1))) ; Drop "<URL:" & ">"
          ;; strip whitespace
-         (while (string-match "\\s +\\|\n+" url)
+         (while (string-match "[ \t\n\r]+" url)
            (setq url (replace-match "" t t url)))
-         (and short (setq url (concat (if (string-match "@" url)
-                                          "mailto:" "http://") url)))
+         (and short (setq url (concat (cond ((string-match "@" url)
+                                              "mailto:")
+                                            ;; e.g. ftp.swiss... or ftp-swiss...
+                                             ((string-match "^ftp" url)
+                                              "ftp://")
+                                             (t "http://"))
+                                       url)))
          (if (string-equal "" url)
              nil
            url)))))
@@ -300,23 +322,23 @@ point."
        (looking-at regexp)))))
 
 (put 'url 'end-op
-     (function (lambda ()
-                (let ((bounds (thing-at-point-bounds-of-url-at-point)))
-                  (if bounds
-                      (goto-char (cdr bounds))
-                    (error "No URL here"))))))
+     (lambda ()
+       (let ((bounds (thing-at-point-bounds-of-url-at-point)))
+         (if bounds
+             (goto-char (cdr bounds))
+           (error "No URL here")))))
 (put 'url 'beginning-op
-     (function (lambda ()
-                (let ((bounds (thing-at-point-bounds-of-url-at-point)))
-                  (if bounds
-                      (goto-char (car bounds))
-                    (error "No URL here"))))))
+     (lambda ()
+       (let ((bounds (thing-at-point-bounds-of-url-at-point)))
+         (if bounds
+             (goto-char (car bounds))
+           (error "No URL here")))))
 
-;;  Whitespace 
+;;  Whitespace
 
 (defun forward-whitespace (arg)
   (interactive "p")
-  (if (natnump arg) 
+  (if (natnump arg)
       (re-search-forward "[ \t]+\\|\n" nil 'move arg)
     (while (< arg 0)
       (if (re-search-backward "[ \t]+\\|\n" nil 'move)
@@ -324,61 +346,69 @@ point."
              (skip-chars-backward " \t")))
       (setq arg (1+ arg)))))
 
-;;  Buffer 
+;;  Buffer
 
-(put 'buffer 'end-op '(lambda () (goto-char (point-max))))
-(put 'buffer 'beginning-op '(lambda () (goto-char (point-min))))
+(put 'buffer 'end-op (lambda () (goto-char (point-max))))
+(put 'buffer 'beginning-op (lambda () (goto-char (point-min))))
 
-;;  Symbols 
+;;  Symbols
 
 (defun forward-symbol (arg)
   (interactive "p")
-  (if (natnump arg) 
+  (if (natnump arg)
       (re-search-forward "\\(\\sw\\|\\s_\\)+" nil 'move arg)
     (while (< arg 0)
       (if (re-search-backward "\\(\\sw\\|\\s_\\)+" nil 'move)
          (skip-syntax-backward "w_"))
       (setq arg (1+ arg)))))
 
-;;  Syntax blocks 
+;;  Syntax blocks
 
 (defun forward-same-syntax (&optional arg)
   (interactive "p")
   (while (< arg 0)
-    (skip-syntax-backward 
+    (skip-syntax-backward
      (char-to-string (char-syntax (char-after (1- (point))))))
     (setq arg (1+ arg)))
   (while (> arg 0)
     (skip-syntax-forward (char-to-string (char-syntax (char-after (point)))))
     (setq arg (1- arg))))
 
-;;  Aliases 
+;;  Aliases
 
 (defun word-at-point () (thing-at-point 'word))
 (defun sentence-at-point () (thing-at-point 'sentence))
 
 (defun read-from-whole-string (str)
-  "Read a lisp expression from STR.
+  "Read a Lisp expression from STR.
 Signal an error if the entire string was not used."
   (let* ((read-data (read-from-string str))
-        (more-left 
+        (more-left
          (condition-case nil
-             (progn (read-from-string (substring str (cdr read-data)))
+             ;; The call to `ignore' suppresses a compiler warning.
+             (progn (ignore (read-from-string (substring str (cdr read-data))))
                     t)
            (end-of-file nil))))
     (if more-left
        (error "Can't read whole string")
       (car read-data))))
 
-(defun form-at-point (&optional thing pred) 
-  (let ((sexp (condition-case nil 
+(defun form-at-point (&optional thing pred)
+  (let ((sexp (condition-case nil
                  (read-from-whole-string (thing-at-point (or thing 'sexp)))
                (error nil))))
     (if (or (not pred) (funcall pred sexp)) sexp)))
 
+;;;###autoload
 (defun sexp-at-point ()   (form-at-point 'sexp))
-(defun symbol-at-point () (form-at-point 'sexp 'symbolp))
+;;;###autoload
+(defun symbol-at-point ()
+  (let ((thing (thing-at-point 'symbol)))
+    (if thing (intern thing))))
+;;;###autoload
 (defun number-at-point () (form-at-point 'sexp 'numberp))
+;;;###autoload
 (defun list-at-point ()   (form-at-point 'list 'listp))
 
-;; thingatpt.el ends here.
+;; arch-tag: bb65a163-dae2-4055-aedc-fe11f497f698
+;;; thingatpt.el ends here