diff lisp/obsolete/sym-comp.el @ 106482:806e9f7990d8

* minibuffer.el (completion-at-point-functions): New var. (completion-at-point): New command. * indent.el (indent-for-tab-command): Handle the new `complete' behavior. * progmodes/python.el (python-mode-map): Use completion-at-point. (python-completion-at-point): Rename from python-partial-symbol and adjust for use in completion-at-point-functions. (python-mode): Setup completion-at-point for Python completion. * emacs-lisp/lisp.el (lisp-completion-at-point): New function extracted from lisp-complete-symbol. (lisp-complete-symbol): Use it. * emacs-lisp/lisp-mode.el (emacs-lisp-mode): Use define-derived-mode, setup completion-at-point for Elisp completion. (emacs-lisp-mode-map, lisp-interaction-mode-map): Use completion-at-point. * ielm.el (ielm-map): Use completion-at-point. (inferior-emacs-lisp-mode): Setup completion-at-point for Elisp completion. * progmodes/sym-comp.el: Move to... * obsolete/sym-comp.el: Move from progmodes.
author Stefan Monnier <monnier@iro.umontreal.ca>
date Mon, 07 Dec 2009 20:06:26 +0000
parents
children 1d1d5d9bd884
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/lisp/obsolete/sym-comp.el	Mon Dec 07 20:06:26 2009 +0000
@@ -0,0 +1,231 @@
+;;; sym-comp.el --- mode-dependent symbol completion
+
+;; Copyright (C) 2004, 2008, 2009  Free Software Foundation, Inc.
+
+;; Author: Dave Love <fx@gnu.org>
+;; Keywords: extensions
+;; URL: http://www.loveshack.ukfsn.org/emacs
+;; Obsolete-since: 23.2
+
+;; 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/>.
+
+;;; Commentary:
+
+;; This defines `symbol-complete', which is a generalization of the
+;; old `lisp-complete-symbol'.  It provides the following hooks to
+;; allow major modes to set up completion appropriate for the mode:
+;; `symbol-completion-symbol-function',
+;; `symbol-completion-completions-function',
+;; `symbol-completion-predicate-function',
+;; `symbol-completion-transform-function'.  Typically it is only
+;; necessary for a mode to set
+;; `symbol-completion-completions-function' locally and to bind
+;; `symbol-complete' appropriately.
+
+;; It's unfortunate that there doesn't seem to be a good way of
+;; combining this with `complete-symbol'.
+
+;; There is also `symbol-completion-try-complete', for use with
+;; Hippie-exp.
+
+;;; Code:
+
+;;;; Mode-dependent symbol completion.
+
+(defun symbol-completion-symbol ()
+  "Default `symbol-completion-symbol-function'.
+Uses `current-word' with the buffer narrowed to the part before
+point."
+  (save-restriction
+    ;; Narrow in case point is in the middle of a symbol -- we want
+    ;; just the preceeding part.
+    (narrow-to-region (point-min) (point))
+    (current-word)))
+
+(defvar symbol-completion-symbol-function 'symbol-completion-symbol
+  "Function to return a partial symbol before point for completion.
+The value it returns should be a string (or nil).
+Major modes may set this locally if the default isn't appropriate.
+
+Beware: the length of the string STR returned need to be equal to the length
+of text before point that's subject to completion.  Typically, this amounts
+to saying that STR is equal to
+\(buffer-substring (- (point) (length STR)) (point)).")
+
+(defvar symbol-completion-completions-function nil
+  "Function to return possible symbol completions.
+It takes an argument which is the string to be completed and
+returns a value suitable for the second argument of
+`try-completion'.  This value need not use the argument, i.e. it
+may be all possible completions, such as `obarray' in the case of
+Emacs Lisp.
+
+Major modes may set this locally to allow them to support
+`symbol-complete'.  See also `symbol-completion-symbol-function',
+`symbol-completion-predicate-function' and
+`symbol-completion-transform-function'.")
+
+(defvar symbol-completion-predicate-function nil
+  "If non-nil, function to return a predicate for selecting symbol completions.
+The function gets two args, the positions of the beginning and
+end of the symbol to be completed.
+
+Major modes may set this locally if the default isn't
+appropriate.  This is a function returning a predicate so that
+the predicate can be context-dependent, e.g. to select only
+function names if point is at a function call position.  The
+function's args may be useful for determining the context.")
+
+(defvar symbol-completion-transform-function nil
+  "If non-nil, function to transform symbols in the symbol-completion buffer.
+E.g., for Lisp, it may annotate the symbol as being a function,
+not a variable.
+
+The function takes the symbol name as argument.  If it needs to
+annotate this, it should return a value suitable as an element of
+the list passed to `display-completion-list'.
+
+The predicate being used for selecting completions (from
+`symbol-completion-predicate-function') is available
+dynamically-bound as `symbol-completion-predicate' in case the
+transform needs it.")
+
+(defvar symbol-completion-predicate)
+
+;;;###autoload
+(defun symbol-complete (&optional predicate)
+  "Perform completion of the symbol preceding point.
+This is done in a way appropriate to the current major mode,
+perhaps by interrogating an inferior interpreter.  Compare
+`complete-symbol'.
+If no characters can be completed, display a list of possible completions.
+Repeating the command at that point scrolls the list.
+
+When called from a program, optional arg PREDICATE is a predicate
+determining which symbols are considered.
+
+This function requires `symbol-completion-completions-function'
+to be set buffer-locally.  Variables `symbol-completion-symbol-function',
+`symbol-completion-predicate-function' and
+`symbol-completion-transform-function' are also consulted."
+  (interactive)
+  ;; Fixme: Punt to `complete-symbol' in this case?
+  (unless (functionp symbol-completion-completions-function)
+    (error "symbol-completion-completions-function not defined"))
+  (let* ((pattern (or (funcall symbol-completion-symbol-function)
+                      (error "No preceding symbol to complete")))
+         ;; FIXME: We assume below that `pattern' holds the text just
+         ;; before point.  This is a problem in the way
+         ;; symbol-completion-symbol-function was defined.
+         (predicate (or predicate
+                        (if symbol-completion-predicate-function
+                            (funcall symbol-completion-predicate-function
+                                     (- (point) (length pattern))
+                                     (point)))))
+         (completions (funcall symbol-completion-completions-function
+                               pattern))
+         ;; In case the transform needs to access it.
+         (symbol-completion-predicate predicate)
+         (completion-annotate-function
+          (if (functionp symbol-completion-transform-function)
+              (lambda (str)
+                (car-safe (cdr-safe
+                           (funcall symbol-completion-transform-function
+                                    str)))))))
+    (completion-in-region (- (point) (length pattern)) (point)
+                          completions predicate)))
+
+(eval-when-compile (require 'hippie-exp))
+
+;;;###autoload
+(defun symbol-completion-try-complete (old)
+  "Completion function for use with `hippie-expand'.
+Uses `symbol-completion-symbol-function' and
+`symbol-completion-completions-function'.  It is intended to be
+used something like this in a major mode which provides symbol
+completion:
+
+  (if (featurep 'hippie-exp)
+      (set (make-local-variable 'hippie-expand-try-functions-list)
+	   (cons 'symbol-completion-try-complete
+                 hippie-expand-try-functions-list)))"
+  (when (and symbol-completion-symbol-function
+	     symbol-completion-completions-function)
+    (unless old
+      (let ((symbol (funcall symbol-completion-symbol-function)))
+	(he-init-string (- (point) (length symbol)) (point))
+	(if (not (he-string-member he-search-string he-tried-table))
+	    (push he-search-string he-tried-table))
+	(setq he-expand-list
+	      (and symbol
+		   (funcall symbol-completion-completions-function symbol)))))
+    (while (and he-expand-list
+		(he-string-member (car he-expand-list) he-tried-table))
+      (pop he-expand-list))
+    (if he-expand-list
+	(progn
+	  (he-substitute-string (pop he-expand-list))
+	  t)
+      (if old (he-reset-string))
+      nil)))
+
+;;; Emacs Lisp symbol completion.
+
+(defun lisp-completion-symbol ()
+  "`symbol-completion-symbol-function' for Lisp."
+  (let ((end (point))
+	(beg (with-syntax-table emacs-lisp-mode-syntax-table
+	       (save-excursion
+		 (backward-sexp 1)
+		 (while (= (char-syntax (following-char)) ?\')
+		   (forward-char 1))
+		 (point)))))
+    (buffer-substring-no-properties beg end)))
+
+(defun lisp-completion-predicate (beg end)
+  "`symbol-completion-predicate-function' for Lisp."
+  (save-excursion
+    (goto-char beg)
+    (if (not (eq (char-before) ?\())
+	(lambda (sym)			;why not just nil ?   -sm
+					;To avoid interned symbols with
+					;no slots.  -- fx
+	  (or (boundp sym) (fboundp sym)
+	      (symbol-plist sym)))
+      ;; Looks like a funcall position.  Let's double check.
+      (if (condition-case nil
+	      (progn (up-list -2) (forward-char 1)
+		     (eq (char-after) ?\())
+	    (error nil))
+	  ;; If the first element of the parent list is an open
+	  ;; parenthesis we are probably not in a funcall position.
+	  ;; Maybe a `let' varlist or something.
+	  nil
+	;; Else, we assume that a function name is expected.
+	'fboundp))))
+
+(defun lisp-symbol-completion-transform ()
+  "`symbol-completion-transform-function' for Lisp."
+  (lambda (elt)
+    (if (and (not (eq 'fboundp symbol-completion-predicate))
+	     (fboundp (intern elt)))
+	(list elt " <f>")
+      elt)))
+
+(provide 'sym-comp)
+
+;; arch-tag: 6fcce616-f3c4-4751-94b4-710e83144124
+;;; sym-comp.el ends here