1 ;;; semantic/complete.el --- Routines for performing tag completion
3 ;; Copyright (C) 2003, 2004, 2005, 2007, 2008, 2009
4 ;; Free Software Foundation, Inc.
6 ;; Author: Eric M. Ludlam <zappo@gnu.org>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;; Completion of tags by name using tables of semantic generated tags.
28 ;; While it would be a simple matter of flattening all tag known
29 ;; tables to perform completion across them using `all-completions',
30 ;; or `try-completion', that process would be slow. In particular,
31 ;; when a system database is included in the mix, the potential for a
32 ;; ludicrous number of options becomes apparent.
34 ;; As such, dynamically searching across tables using a prefix,
35 ;; regular expression, or other feature is needed to help find symbols
36 ;; quickly without resorting to "show me every possible option now".
38 ;; In addition, some symbol names will appear in multiple locations.
39 ;; If it is important to distinguish, then a way to provide a choice
40 ;; over these locations is important as well.
42 ;; Beyond brute force offers for completion of plain strings,
43 ;; using the smarts of semantic-analyze to provide reduced lists of
44 ;; symbols, or fancy tabbing to zoom into files to show multiple hits
45 ;; of the same name can be provided.
49 ;; There are several parts of any completion engine. They are:
51 ;; A. Collection of possible hits
52 ;; B. Typing or selecting an option
53 ;; C. Displaying possible unique completions
54 ;; D. Using the result
56 ;; Here, we will treat each section separately (excluding D)
57 ;; They can then be strung together in user-visible commands to
58 ;; fulfil specific needs.
62 ;; A collector is an object which represents the means by which tags
63 ;; to complete on are collected. It's first job is to find all the
64 ;; tags which are to be completed against. It can also rename
65 ;; some tags if needed so long as `semantic-tag-clone' is used.
67 ;; Some collectors will gather all tags to complete against first
68 ;; (for in buffer queries, or other small list situations). It may
69 ;; choose to do a broad search on each completion request. Built in
70 ;; functionality automatically focuses the cache in as the user types.
72 ;; A collector choosing to create and rename tags could choose a
73 ;; plain name format, a postfix name such as method:class, or a
74 ;; prefix name such as class.method.
78 ;; A displayor is in charge if showing the user interesting things
79 ;; about available completions, and can optionally provide a focus.
80 ;; The simplest display just lists all available names in a separate
81 ;; window. It may even choose to show short names when there are
82 ;; many to choose from, or long names when there are fewer.
84 ;; A complex displayor could opt to help the user 'focus' on some
85 ;; range. For example, if 4 tags all have the same name, subsequent
86 ;; calls to the displayor may opt to show each tag one at a time in
87 ;; the buffer. When the user likes one, selection would cause the
88 ;; 'focus' item to be selected.
92 ;; The format of the tag lists used to perform the completions are in
93 ;; semanticdb "find" format, like this:
95 ;; ( ( DBTABLE1 TAG1 TAG2 ...)
96 ;; ( DBTABLE2 TAG1 TAG2 ...)
99 ;; INLINE vs MINIBUFFER
101 ;; Two major ways completion is used in Emacs is either through a
102 ;; minibuffer query, or via completion in a normal editing buffer,
103 ;; encompassing some small range of characters.
105 ;; Structure for both types of completion are provided here.
106 ;; `semantic-complete-read-tag-engine' will use the minibuffer.
107 ;; `semantic-complete-inline-tag-engine' will complete text in
110 (eval-when-compile (require 'cl
))
113 (require 'semantic
/analyze
)
114 (require 'semantic
/ctxt
)
115 (require 'semantic
/decorate
)
116 (require 'semantic
/format
)
119 ;; For the semantic-find-tags-for-completion macro.
120 (require 'semantic
/find
))
124 (defvar semantic-complete-inline-overlay nil
125 "The overlay currently active while completing inline.")
127 (defun semantic-completion-inline-active-p ()
128 "Non-nil if inline completion is active."
129 (when (and semantic-complete-inline-overlay
130 (not (semantic-overlay-live-p semantic-complete-inline-overlay
)))
131 (semantic-overlay-delete semantic-complete-inline-overlay
)
132 (setq semantic-complete-inline-overlay nil
))
133 semantic-complete-inline-overlay
)
135 ;;; ------------------------------------------------------------
136 ;;; MINIBUFFER or INLINE utils
138 (defun semantic-completion-text ()
139 "Return the text that is currently in the completion buffer.
140 For a minibuffer prompt, this is the minibuffer text.
141 For inline completion, this is the text wrapped in the inline completion
143 (if semantic-complete-inline-overlay
144 (semantic-complete-inline-text)
145 (minibuffer-contents)))
147 (defun semantic-completion-delete-text ()
148 "Delete the text that is actively being completed.
149 Presumably if you call this you will insert something new there."
150 (if semantic-complete-inline-overlay
151 (semantic-complete-inline-delete-text)
152 (delete-minibuffer-contents)))
154 (defun semantic-completion-message (fmt &rest args
)
155 "Display the string FMT formatted with ARGS at the end of the minibuffer."
156 (if semantic-complete-inline-overlay
157 (apply 'message fmt args
)
158 (message (concat (buffer-string) (apply 'format fmt args
)))))
160 ;;; ------------------------------------------------------------
161 ;;; MINIBUFFER: Option Selection harnesses
163 (defvar semantic-completion-collector-engine nil
164 "The tag collector for the current completion operation.
165 Value should be an object of a subclass of
166 `semantic-completion-engine-abstract'.")
168 (defvar semantic-completion-display-engine nil
169 "The tag display engine for the current completion operation.
170 Value should be a ... what?")
172 (defvar semantic-complete-key-map
173 (let ((km (make-sparse-keymap)))
174 (define-key km
" " 'semantic-complete-complete-space
)
175 (define-key km
"\t" 'semantic-complete-complete-tab
)
176 (define-key km
"\C-m" 'semantic-complete-done
)
177 (define-key km
"\C-g" 'abort-recursive-edit
)
178 (define-key km
"\M-n" 'next-history-element
)
179 (define-key km
"\M-p" 'previous-history-element
)
180 (define-key km
"\C-n" 'next-history-element
)
181 (define-key km
"\C-p" 'previous-history-element
)
182 ;; Add history navigation
184 "Keymap used while completing across a list of tags.")
186 (defvar semantic-completion-default-history nil
187 "Default history variable for any unhistoried prompt.
188 Keeps STRINGS only in the history.")
191 (defun semantic-complete-read-tag-engine (collector displayor prompt
192 default-tag initial-input
194 "Read a semantic tag, and return a tag for the selection.
195 Argument COLLECTOR is an object which can be used to to calculate
196 a list of possible hits. See `semantic-completion-collector-engine'
197 for details on COLLECTOR.
198 Argument DISPLAYOR is an object used to display a list of possible
199 completions for a given prefix. See`semantic-completion-display-engine'
200 for details on DISPLAYOR.
201 PROMPT is a string to prompt with.
202 DEFAULT-TAG is a semantic tag or string to use as the default value.
203 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.
204 HISTORY is a symbol representing a variable to story the history in."
205 (let* ((semantic-completion-collector-engine collector
)
206 (semantic-completion-display-engine displayor
)
207 (semantic-complete-active-default nil
)
208 (semantic-complete-current-matched-tag nil
)
209 (default-as-tag (semantic-complete-default-to-tag default-tag
))
210 (default-as-string (when (semantic-tag-p default-as-tag
)
211 (semantic-tag-name default-as-tag
)))
214 (when default-as-string
215 ;; Add this to the prompt.
217 ;; I really want to add a lookup of the symbol in those
218 ;; tags available to the collector and only add it if it
219 ;; is available as a possibility, but I'm too lazy right
223 ;; @todo - move from () to into the editable area
224 (if (string-match ":" prompt
)
226 (substring prompt
0 (match-beginning 0))
227 " (" default-as-string
")"
228 (substring prompt
(match-beginning 0))))
229 (setq prompt
(concat prompt
" (" default-as-string
"): "))))
231 ;; Perform the Completion
234 (read-from-minibuffer prompt
236 semantic-complete-key-map
239 'semantic-completion-default-history
)
241 (semantic-collector-cleanup semantic-completion-collector-engine
)
242 (semantic-displayor-cleanup semantic-completion-display-engine
)
245 ;; Extract the tag from the completion machinery.
247 semantic-complete-current-matched-tag
251 ;;; Util for basic completion prompts
254 (defvar semantic-complete-active-default nil
255 "The current default tag calculated for this prompt.")
257 (defun semantic-complete-default-to-tag (default)
258 "Convert a calculated or passed in DEFAULT into a tag."
259 (if (semantic-tag-p default
)
260 ;; Just return what was passed in.
261 (setq semantic-complete-active-default default
)
262 ;; If none was passed in, guess.
264 (setq default
(semantic-ctxt-current-thing)))
268 ;; Turn default into something useful.
271 ;; Semantic-ctxt-current-symbol will return a list of
272 ;; strings. Technically, we should use the analyzer to
273 ;; fully extract what we need, but for now, just grab the
275 ((and (listp default
) (stringp (car default
)))
280 (symbol-name default
))
282 (signal 'wrong-type-argument
283 (list default
'semantic-tag-p
)))))
285 ;; Now that we have that symbol string, look it up using the active
286 ;; collector. If we get a match, use it.
288 (semantic-collector-calculate-completions
289 semantic-completion-collector-engine
291 ;; Do we have the perfect match???
292 (let ((ml (semantic-collector-current-exact-match
293 semantic-completion-collector-engine
)))
295 ;; We don't care about uniqueness. Just guess for convenience
296 (setq tag
(semanticdb-find-result-nth-in-buffer ml
0))))
298 (setq semantic-complete-active-default tag
)
299 ;; Return it.. .whatever it may be
303 ;;; Prompt Return Value
305 ;; Getting a return value out of this completion prompt is a bit
306 ;; challenging. The read command returns the string typed in.
307 ;; We need to convert this into a valid tag. We can exit the minibuffer
308 ;; for different reasons. If we purposely exit, we must make sure
309 ;; the focused tag is calculated... preferably once.
310 (defvar semantic-complete-current-matched-tag nil
311 "Variable used to pass the tags being matched to the prompt.")
313 ;; semantic-displayor-focus-abstract-child-p is part of the
314 ;; semantic-displayor-focus-abstract class, defined later in this
316 (declare-function semantic-displayor-focus-abstract-child-p
"semantic/complete"
319 (defun semantic-complete-current-match ()
320 "Calculate a match from the current completion environment.
321 Save this in our completion variable. Make sure that variable
322 is cleared if any other keypress is made.
324 tag - a single tag that has been matched.
325 string - a message to show in the minibuffer."
326 ;; Query the environment for an active completion.
327 (let ((collector semantic-completion-collector-engine
)
328 (displayor semantic-completion-display-engine
)
329 (contents (semantic-completion-text))
332 (if (string= contents
"")
333 ;; The user wants the defaults!
334 (setq answer semantic-complete-active-default
)
335 ;; This forces a full calculation of completion on CR.
337 (semantic-collector-calculate-completions collector contents nil
))
338 (semantic-complete-try-completion)
340 ;; Input match displayor focus entry
341 ((setq answer
(semantic-displayor-current-focus displayor
))
342 ;; We have answer, continue
344 ;; One match from the collector
345 ((setq matchlist
(semantic-collector-current-exact-match collector
))
346 (if (= (semanticdb-find-result-length matchlist
) 1)
347 (setq answer
(semanticdb-find-result-nth-in-buffer matchlist
0))
348 (if (semantic-displayor-focus-abstract-child-p displayor
)
349 ;; For focusing displayors, we can claim this is
350 ;; not unique. Multiple focuses can choose the correct
352 (setq answer
"Not Unique")
353 ;; If we don't have a focusing displayor, we need to do something
354 ;; graceful. First, see if all the matches have the same name.
356 (firstname (semantic-tag-name
358 (semanticdb-find-result-nth matchlist
0)))
361 (max (semanticdb-find-result-length matchlist
)))
362 (while (and allsame
(< cnt max
))
367 (semanticdb-find-result-nth matchlist cnt
)))))
371 ;; Now we know if they are all the same. If they are, just
372 ;; accept the first, otherwise complain.
374 (setq answer
(semanticdb-find-result-nth-in-buffer
376 (setq answer
"Not Unique"))
380 (setq answer
"No Match")))
382 ;; Set it into our completion target.
383 (when (semantic-tag-p answer
)
384 (setq semantic-complete-current-matched-tag answer
)
385 ;; Make sure it is up to date by clearing it if the user dares
386 ;; to touch the keyboard.
387 (add-hook 'pre-command-hook
388 (lambda () (setq semantic-complete-current-matched-tag nil
)))
397 ;; Keys are bound to to perform completion using our mechanisms.
398 ;; Do that work here.
399 (defun semantic-complete-done ()
400 "Accept the current input."
402 (let ((ans (semantic-complete-current-match)))
404 (semantic-completion-message (concat " [" ans
"]"))
408 (defun semantic-complete-complete-space ()
409 "Complete the partial input in the minibuffer."
411 (semantic-complete-do-completion t
))
413 (defun semantic-complete-complete-tab ()
414 "Complete the partial input in the minibuffer as far as possible."
416 (semantic-complete-do-completion))
418 ;;; Completion Functions
420 ;; Thees routines are functional entry points to performing completion.
422 (defun semantic-complete-hack-word-boundaries (original new
)
423 "Return a string to use for completion.
424 ORIGINAL is the text in the minibuffer.
425 NEW is the new text to insert into the minibuffer.
426 Within the difference bounds of ORIGINAL and NEW, shorten NEW
427 to the nearest word boundary, and return that."
429 (let* ((diff (substring new
(length original
)))
430 (end (string-match "\\>" diff
))
431 (start (string-match "\\<" diff
)))
433 ((and start
(> start
0))
434 ;; If start is greater than 0, include only the new
436 (concat original
(substring diff
0 start
)))
438 (concat original
(substring diff
0 end
)))
441 (defun semantic-complete-try-completion (&optional partial
)
442 "Try a completion for the current minibuffer.
443 If PARTIAL, do partial completion stopping at spaces."
444 (let ((comp (semantic-collector-try-completion
445 semantic-completion-collector-engine
446 (semantic-completion-text))))
449 (semantic-completion-message " [No Match]")
453 (if (string= (semantic-completion-text) comp
)
455 ;; Minibuffer isn't changing AND the text is not unique.
456 ;; Test for partial completion over a word separator character.
457 ;; If there is one available, use that so that SPC can
458 ;; act like a SPC insert key.
459 (let ((newcomp (semantic-collector-current-whitespace-completion
460 semantic-completion-collector-engine
)))
462 (semantic-completion-delete-text)
466 (let ((orig (semantic-completion-text)))
467 ;; For partial completion, we stop and step over
468 ;; word boundaries. Use this nifty function to do
469 ;; that calculation for us.
471 (semantic-complete-hack-word-boundaries orig comp
))))
472 ;; Do the replacement.
473 (semantic-completion-delete-text)
476 ((and (listp comp
) (semantic-tag-p (car comp
)))
477 (unless (string= (semantic-completion-text)
478 (semantic-tag-name (car comp
)))
479 ;; A fully unique completion was available.
480 (semantic-completion-delete-text)
481 (insert (semantic-tag-name (car comp
))))
482 ;; The match is complete
483 (if (= (length comp
) 1)
484 (semantic-completion-message " [Complete]")
485 (semantic-completion-message " [Complete, but not unique]"))
489 (defun semantic-complete-do-completion (&optional partial inline
)
490 "Do a completion for the current minibuffer.
491 If PARTIAL, do partial completion stopping at spaces.
492 if INLINE, then completion is happening inline in a buffer."
493 (let* ((collector semantic-completion-collector-engine
)
494 (displayor semantic-completion-display-engine
)
495 (contents (semantic-completion-text))
499 (semantic-collector-calculate-completions collector contents partial
))
500 (let* ((na (semantic-complete-next-action partial
)))
502 ;; We're all done, but only from a very specific
503 ;; area of completion.
505 (semantic-completion-message " [Complete]")
507 ;; Perform completion
508 ((or (eq na
'complete
)
509 (eq na
'complete-whitespace
))
510 (semantic-complete-try-completion partial
)
511 (setq ans
'complete
))
512 ;; We need to display the completions.
513 ;; Set the completions into the display engine
514 ((or (eq na
'display
) (eq na
'displayend
))
515 (semantic-displayor-set-completions
518 (and (not (eq na
'displayend
))
519 (semantic-collector-current-exact-match collector
))
520 (semantic-collector-all-completions collector contents
))
522 ;; Ask the displayor to display them.
523 (semantic-displayor-show-request displayor
))
525 (semantic-displayor-scroll-request displayor
)
528 (semantic-displayor-focus-next displayor
)
529 (semantic-displayor-focus-request displayor
)
532 (semantic-completion-message " [No Match]"))
537 ;;; ------------------------------------------------------------
538 ;;; INLINE: tag completion harness
540 ;; Unlike the minibuffer, there is no mode nor other traditional
541 ;; means of reading user commands in completion mode. Instead
542 ;; we use a pre-command-hook to inset in our commands, and to
543 ;; push ourselves out of this mode on alternate keypresses.
544 (defvar semantic-complete-inline-map
545 (let ((km (make-sparse-keymap)))
546 (define-key km
"\C-i" 'semantic-complete-inline-TAB
)
547 (define-key km
"\M-p" 'semantic-complete-inline-up
)
548 (define-key km
"\M-n" 'semantic-complete-inline-down
)
549 (define-key km
"\C-m" 'semantic-complete-inline-done
)
550 (define-key km
"\C-\M-c" 'semantic-complete-inline-exit
)
551 (define-key km
"\C-g" 'semantic-complete-inline-quit
)
553 (lambda () (interactive)
554 (describe-variable 'semantic-complete-inline-map
)))
556 "Keymap used while performing Semantic inline completion.")
558 (defface semantic-complete-inline-face
559 '((((class color
) (background dark
))
560 (:underline
"yellow"))
561 (((class color
) (background light
))
562 (:underline
"brown")))
563 "*Face used to show the region being completed inline.
564 The face is used in `semantic-complete-inline-tag-engine'."
565 :group
'semantic-faces
)
567 (defun semantic-complete-inline-text ()
568 "Return the text that is being completed inline.
569 Similar to `minibuffer-contents' when completing in the minibuffer."
570 (let ((s (semantic-overlay-start semantic-complete-inline-overlay
))
571 (e (semantic-overlay-end semantic-complete-inline-overlay
)))
574 (buffer-substring-no-properties s e
))))
576 (defun semantic-complete-inline-delete-text ()
577 "Delete the text currently being completed in the current buffer."
579 (semantic-overlay-start semantic-complete-inline-overlay
)
580 (semantic-overlay-end semantic-complete-inline-overlay
)))
582 (defun semantic-complete-inline-done ()
583 "This completion thing is DONE, OR, insert a newline."
585 (let* ((displayor semantic-completion-display-engine
)
586 (tag (semantic-displayor-current-focus displayor
)))
588 (let ((txt (semantic-completion-text)))
589 (insert (substring (semantic-tag-name tag
)
591 (semantic-complete-inline-exit))
593 ;; Get whatever binding RET usually has.
596 (lookup-key (current-active-maps) (this-command-keys))
598 ;; I don't know why, but for some reason the above
599 ;; throws an error sometimes.
600 (lookup-key (current-global-map) (this-command-keys))
606 (defun semantic-complete-inline-quit ()
607 "Quit an inline edit."
609 (semantic-complete-inline-exit)
612 (defun semantic-complete-inline-exit ()
613 "Exit inline completion mode."
615 ;; Remove this hook FIRST!
616 (remove-hook 'pre-command-hook
'semantic-complete-pre-command-hook
)
620 (when semantic-completion-collector-engine
621 (semantic-collector-cleanup semantic-completion-collector-engine
))
622 (when semantic-completion-display-engine
623 (semantic-displayor-cleanup semantic-completion-display-engine
))
625 (when semantic-complete-inline-overlay
626 (let ((wc (semantic-overlay-get semantic-complete-inline-overlay
627 'window-config-start
))
628 (buf (semantic-overlay-buffer semantic-complete-inline-overlay
))
630 (semantic-overlay-delete semantic-complete-inline-overlay
)
631 (setq semantic-complete-inline-overlay nil
)
632 ;; DONT restore the window configuration if we just
634 (when (eq buf
(current-buffer))
635 (set-window-configuration wc
))
638 (setq semantic-completion-collector-engine nil
639 semantic-completion-display-engine nil
))
642 ;; Remove this hook LAST!!!
643 ;; This will force us back through this function if there was
644 ;; some sort of error above.
645 (remove-hook 'post-command-hook
'semantic-complete-post-command-hook
)
647 ;;(message "Exiting inline completion.")
650 (defun semantic-complete-pre-command-hook ()
651 "Used to redefine what commands are being run while completing.
652 When installed as a `pre-command-hook' the special keymap
653 `semantic-complete-inline-map' is queried to replace commands normally run.
654 Commands which edit what is in the region of interest operate normally.
655 Commands which would take us out of the region of interest, or our
656 quit hook, will exit this completion mode."
657 (let ((fcn (lookup-key semantic-complete-inline-map
658 (this-command-keys) nil
)))
659 (cond ((commandp fcn
)
660 (setq this-command fcn
))
664 (defun semantic-complete-post-command-hook ()
665 "Used to determine if we need to exit inline completion mode.
666 If completion mode is active, check to see if we are within
667 the bounds of `semantic-complete-inline-overlay', or within
668 a reasonable distance."
670 ;; Exit if something bad happened.
671 (if (not semantic-complete-inline-overlay
)
673 ;;(message "Inline Hook installed, but overlay deleted.")
674 (semantic-complete-inline-exit))
675 ;; Exit if commands caused us to exit the area of interest
676 (let ((s (semantic-overlay-start semantic-complete-inline-overlay
))
677 (e (semantic-overlay-end semantic-complete-inline-overlay
))
678 (b (semantic-overlay-buffer semantic-complete-inline-overlay
))
682 ;; EXIT when we are no longer in a good place.
683 ((or (not (eq b
(current-buffer)))
686 ;;(message "Exit: %S %S %S" s e (point))
687 (semantic-complete-inline-exit)
689 ;; Exit if the user typed in a character that is not part
690 ;; of the symbol being completed.
691 ((and (setq txt
(semantic-completion-text))
692 (not (string= txt
""))
696 (not (looking-at "\\(\\w\\|\\s_\\)")))))
697 ;;(message "Non symbol character.")
698 (semantic-complete-inline-exit))
699 ((lookup-key semantic-complete-inline-map
700 (this-command-keys) nil
)
701 ;; If the last command was one of our completion commands,
706 ;; Else, show completions now
707 (semantic-complete-inline-force-display)
710 ;; If something goes terribly wrong, clean up after ourselves.
711 (error (semantic-complete-inline-exit))))
713 (defun semantic-complete-inline-force-display ()
714 "Force the display of whatever the current completions are.
715 DO NOT CALL THIS IF THE INLINE COMPLETION ENGINE IS NOT ACTIVE."
718 (let ((collector semantic-completion-collector-engine
)
719 (displayor semantic-completion-display-engine
)
720 (contents (semantic-completion-text)))
722 (semantic-collector-calculate-completions
723 collector contents nil
)
724 (semantic-displayor-set-completions
726 (semantic-collector-all-completions collector contents
)
728 ;; Ask the displayor to display them.
729 (semantic-displayor-show-request displayor
))
731 (error (message "Bug Showing Completions: %S" e
))))
733 (defun semantic-complete-inline-tag-engine
734 (collector displayor buffer start end
)
735 "Perform completion based on semantic tags in a buffer.
736 Argument COLLECTOR is an object which can be used to to calculate
737 a list of possible hits. See `semantic-completion-collector-engine'
738 for details on COLLECTOR.
739 Argument DISPLAYOR is an object used to display a list of possible
740 completions for a given prefix. See`semantic-completion-display-engine'
741 for details on DISPLAYOR.
742 BUFFER is the buffer in which completion will take place.
743 START is a location for the start of the full symbol.
744 If the symbol being completed is \"foo.ba\", then START
745 is on the \"f\" character.
746 END is at the end of the current symbol being completed."
747 ;; Set us up for doing completion
748 (setq semantic-completion-collector-engine collector
749 semantic-completion-display-engine displayor
)
751 (setq semantic-complete-inline-overlay
752 (semantic-make-overlay start end buffer nil t
))
753 (semantic-overlay-put semantic-complete-inline-overlay
755 'semantic-complete-inline-face
)
756 (semantic-overlay-put semantic-complete-inline-overlay
758 (current-window-configuration))
759 ;; Install our command hooks
760 (add-hook 'pre-command-hook
'semantic-complete-pre-command-hook
)
761 (add-hook 'post-command-hook
'semantic-complete-post-command-hook
)
763 (semantic-complete-inline-force-display)
766 ;;; Inline Completion Keymap Functions
768 (defun semantic-complete-inline-TAB ()
769 "Perform inline completion."
771 (let ((cmpl (semantic-complete-do-completion nil t
)))
774 (semantic-complete-inline-force-display))
776 (semantic-complete-inline-done))
780 (defun semantic-complete-inline-down()
781 "Focus forwards through the displayor."
783 (let ((displayor semantic-completion-display-engine
))
784 (semantic-displayor-focus-next displayor
)
785 (semantic-displayor-focus-request displayor
)
788 (defun semantic-complete-inline-up ()
789 "Focus backwards through the displayor."
791 (let ((displayor semantic-completion-display-engine
))
792 (semantic-displayor-focus-previous displayor
)
793 (semantic-displayor-focus-request displayor
)
797 ;;; ------------------------------------------------------------
798 ;;; Interactions between collection and displaying
800 ;; Functional routines used to help collectors communicate with
801 ;; the current displayor, or for the previous section.
803 (defun semantic-complete-next-action (partial)
804 "Determine what the next completion action should be.
805 PARTIAL is non-nil if we are doing partial completion.
806 First, the collector can determine if we should perform a completion or not.
807 If there is nothing to complete, then the displayor determines if we are
808 to show a completion list, scroll, or perhaps do a focus (if it is capable.)
809 Expected return values are:
810 done -> We have a singular match
811 empty -> There are no matches to the current text
812 complete -> Perform a completion action
813 complete-whitespace -> Complete next whitespace type character.
814 display -> Show the list of completions
815 scroll -> The completions have been shown, and the user keeps hitting
816 the complete button. If possible, scroll the completions
817 focus -> The displayor knows how to shift focus among possible completions.
819 displayend -> Whatever options the displayor had for repeating options, there
820 are none left. Try something new."
821 (let ((ans1 (semantic-collector-next-action
822 semantic-completion-collector-engine
824 (ans2 (semantic-displayor-next-action
825 semantic-completion-display-engine
))
828 ;; No collector answer, use displayor answer.
831 ;; Displayor selection of 'scroll, 'display, or 'focus trumps
833 ((and (eq ans1
'done
) ans2
)
835 ;; Use ans1 when we have it.
841 ;;; ------------------------------------------------------------
842 ;;; Collection Engines
844 ;; Collection engines can scan tags from the current environment and
845 ;; provide lists of possible completions.
847 ;; General features of the abstract collector:
848 ;; * Cache completion lists between uses
849 ;; * Cache itself per buffer. Handle reparse hooks
851 ;; Key Interface Functions to implement:
852 ;; * semantic-collector-next-action
853 ;; * semantic-collector-calculate-completions
854 ;; * semantic-collector-try-completion
855 ;; * semantic-collector-all-completions
857 (defvar semantic-collector-per-buffer-list nil
858 "List of collectors active in this buffer.")
859 (make-variable-buffer-local 'semantic-collector-per-buffer-list
)
861 (defvar semantic-collector-list nil
862 "List of global collectors active this session.")
864 (defclass semantic-collector-abstract
()
865 ((buffer :initarg
:buffer
867 :documentation
"Originating buffer for this collector.
868 Some collectors use a given buffer as a starting place while looking up
871 :type
(or null semanticdb-find-result-with-nil
)
872 :documentation
"Cache of tags.
873 These tags are re-used during a completion session.
874 Sometimes these tags are cached between completion sessions.")
875 (last-all-completions :initarg nil
876 :type semanticdb-find-result-with-nil
877 :documentation
"Last result of `all-completions'.
878 This result can be used for refined completions as `last-prefix' gets
879 closer to a specific result.")
880 (last-prefix :type string
881 :protection
:protected
882 :documentation
"The last queried prefix.
883 This prefix can be used to cache intermediate completion offers.
884 making the action of homing in on a token faster.")
885 (last-completion :type
(or null string
)
886 :documentation
"The last calculated completion.
887 This completion is calculated and saved for future use.")
888 (last-whitespace-completion :type
(or null string
)
889 :documentation
"The last whitespace completion.
890 For partial completion, SPC will disabiguate over whitespace type
891 characters. This is the last calculated version.")
892 (current-exact-match :type list
893 :protection
:protected
894 :documentation
"The list of matched tags.
895 When tokens are matched, they are added to this list.")
897 "Root class for completion engines.
898 The baseclass provides basic functionality for interacting with
899 a completion displayor object, and tracking the current progress
903 (defmethod semantic-collector-cleanup ((obj semantic-collector-abstract
))
904 "Clean up any mess this collector may have."
907 (defmethod semantic-collector-next-action
908 ((obj semantic-collector-abstract
) partial
)
909 "What should we do next? OBJ can predict a next good action.
910 PARTIAL indicates if we are doing a partial completion."
911 (if (and (slot-boundp obj
'last-completion
)
912 (string= (semantic-completion-text) (oref obj last-completion
)))
913 (let* ((cem (semantic-collector-current-exact-match obj
))
914 (cemlen (semanticdb-find-result-length cem
))
915 (cac (semantic-collector-all-completions
916 obj
(semantic-completion-text)))
917 (caclen (semanticdb-find-result-length cac
)))
918 (cond ((and cem
(= cemlen
1)
920 (eq last-command this-command
))
921 ;; Defer to the displayor...
923 ((and cem
(= cemlen
1))
925 ((and (not cem
) (not cac
))
927 ((and partial
(semantic-collector-try-completion-whitespace
928 obj
(semantic-completion-text)))
929 'complete-whitespace
)))
932 (defmethod semantic-collector-last-prefix= ((obj semantic-collector-abstract
)
934 "Return non-nil if OBJ's prefix matches PREFIX."
935 (and (slot-boundp obj
'last-prefix
)
936 (string= (oref obj last-prefix
) last-prefix
)))
938 (defmethod semantic-collector-get-cache ((obj semantic-collector-abstract
))
939 "Get the raw cache of tags for completion.
940 Calculate the cache if there isn't one."
942 (semantic-collector-calculate-cache obj
)))
944 (defmethod semantic-collector-calculate-completions-raw
945 ((obj semantic-collector-abstract
) prefix completionlist
)
946 "Calculate the completions for prefix from completionlist.
947 Output must be in semanticdb Find result format."
948 ;; Must output in semanticdb format
949 (let ((table (with-current-buffer (oref obj buffer
)
950 semanticdb-current-table
))
951 (result (semantic-find-tags-for-completion
953 ;; To do this kind of search with a pre-built completion
954 ;; list, we need to strip it first.
955 (semanticdb-strip-find-results completionlist
)))
958 (list (cons table result
)))))
960 (defmethod semantic-collector-calculate-completions
961 ((obj semantic-collector-abstract
) prefix partial
)
962 "Calculate completions for prefix as setup for other queries."
963 (let* ((case-fold-search semantic-case-fold
)
964 (same-prefix-p (semantic-collector-last-prefix= obj prefix
))
966 (if (or same-prefix-p
967 (and (slot-boundp obj
'last-prefix
)
968 (eq (compare-strings (oref obj last-prefix
) 0 nil
969 prefix
0 (length prefix
))
971 ;; New prefix is subset of old prefix
972 (oref obj last-all-completions
)
973 (semantic-collector-get-cache obj
)))
975 (answer (if same-prefix-p
977 (semantic-collector-calculate-completions-raw
978 obj prefix completionlist
))
981 (complete-not-uniq nil
)
983 ;;(semanticdb-find-result-test answer)
984 (when (not same-prefix-p
)
985 ;; Save results if it is interesting and beneficial
986 (oset obj last-prefix prefix
)
987 (oset obj last-all-completions answer
))
988 ;; Now calculate the completion.
989 (setq completion
(try-completion
991 (semanticdb-strip-find-results answer
)))
992 (oset obj last-whitespace-completion nil
)
993 (oset obj current-exact-match nil
)
994 ;; Only do this if a completion was found. Letting a nil in
995 ;; could cause a full semanticdb search by accident.
997 (oset obj last-completion
999 ;; Unique match in AC. Last completion is a match.
1000 ;; Also set the current-exact-match.
1002 (oset obj current-exact-match answer
)
1004 ;; It may be complete (a symbol) but still not unique.
1005 ;; We can capture a match
1006 ((setq complete-not-uniq
1007 (semanticdb-find-tags-by-name
1010 (oset obj current-exact-match
1014 ;; Non unique match, return the string that handles
1016 (t (or completion prefix
))
1020 (defmethod semantic-collector-try-completion-whitespace
1021 ((obj semantic-collector-abstract
) prefix
)
1022 "For OBJ, do whatepsace completion based on PREFIX.
1023 This implies that if there are two completions, one matching
1024 the test \"preifx\\>\", and one not, the one matching the full
1025 word version of PREFIX will be chosen, and that text returned.
1026 This function requires that `semantic-collector-calculate-completions'
1027 has been run first."
1028 (let* ((ac (semantic-collector-all-completions obj prefix
))
1029 (matchme (concat "^" prefix
"\\>"))
1030 (compare (semanticdb-find-tags-by-name-regexp matchme ac
))
1031 (numtag (semanticdb-find-result-length compare
))
1035 (cutlen (1+ (length prefix
)))
1036 (twws (semanticdb-find-result-nth compare idx
)))
1037 ;; Is our tag with whitespace a match that has whitespace
1038 ;; after it, or just an already complete symbol?
1039 (while (and (< idx numtag
)
1040 (< (length (semantic-tag-name (car twws
))) cutlen
))
1042 twws
(semanticdb-find-result-nth compare idx
)))
1043 (when (and twws
(car-safe twws
))
1044 ;; If COMPARE has succeeded, then we should take the very
1045 ;; first match, and extend prefix by one character.
1046 (oset obj last-whitespace-completion
1047 (substring (semantic-tag-name (car twws
))
1052 (defmethod semantic-collector-current-exact-match ((obj semantic-collector-abstract
))
1053 "Return the active valid MATCH from the semantic collector.
1054 For now, just return the first element from our list of available
1055 matches. For semanticdb based results, make sure the file is loaded
1057 (when (slot-boundp obj
'current-exact-match
)
1058 (oref obj current-exact-match
)))
1060 (defmethod semantic-collector-current-whitespace-completion ((obj semantic-collector-abstract
))
1061 "Return the active whitespace completion value."
1062 (when (slot-boundp obj
'last-whitespace-completion
)
1063 (oref obj last-whitespace-completion
)))
1065 (defmethod semantic-collector-get-match ((obj semantic-collector-abstract
))
1066 "Return the active valid MATCH from the semantic collector.
1067 For now, just return the first element from our list of available
1068 matches. For semanticdb based results, make sure the file is loaded
1070 (when (slot-boundp obj
'current-exact-match
)
1071 (semanticdb-find-result-nth-in-buffer (oref obj current-exact-match
) 0)))
1073 (defmethod semantic-collector-all-completions
1074 ((obj semantic-collector-abstract
) prefix
)
1075 "For OBJ, retrieve all completions matching PREFIX.
1076 The returned list consists of all the tags currently
1078 (when (slot-boundp obj
'last-all-completions
)
1079 (oref obj last-all-completions
)))
1081 (defmethod semantic-collector-try-completion
1082 ((obj semantic-collector-abstract
) prefix
)
1083 "For OBJ, attempt to match PREFIX.
1084 See `try-completion' for details on how this works.
1085 Return nil for no match.
1086 Return a string for a partial match.
1087 For a unique match of PREFIX, return the list of all tags
1089 (if (slot-boundp obj
'last-completion
)
1090 (oref obj last-completion
)))
1092 (defmethod semantic-collector-calculate-cache
1093 ((obj semantic-collector-abstract
))
1094 "Calculate the completion cache for OBJ."
1098 (defmethod semantic-collector-flush ((this semantic-collector-abstract
))
1099 "Flush THIS collector object, clearing any caches and prefix."
1100 (oset this cache nil
)
1101 (slot-makeunbound this
'last-prefix
)
1102 (slot-makeunbound this
'last-completion
)
1103 (slot-makeunbound this
'last-all-completions
)
1104 (slot-makeunbound this
'current-exact-match
)
1109 (defclass semantic-collector-buffer-abstract
(semantic-collector-abstract)
1111 "Root class for per-buffer completion engines.
1112 These collectors track themselves on a per-buffer basis."
1115 (defmethod constructor :STATIC
((this semantic-collector-buffer-abstract
)
1116 newname
&rest fields
)
1117 "Reuse previously created objects of this type in buffer."
1119 (bl semantic-collector-per-buffer-list
))
1120 (while (and bl
(null old
))
1121 (if (eq (object-class (car bl
)) this
)
1122 (setq old
(car bl
))))
1124 (let ((new (call-next-method)))
1125 (add-to-list 'semantic-collector-per-buffer-list new
)
1127 (slot-makeunbound old
'last-completion
)
1128 (slot-makeunbound old
'last-prefix
)
1129 (slot-makeunbound old
'current-exact-match
)
1132 ;; Buffer specific collectors should flush themselves
1133 (defun semantic-collector-buffer-flush (newcache)
1134 "Flush all buffer collector objects.
1135 NEWCACHE is the new tag table, but we ignore it."
1137 (let ((l semantic-collector-per-buffer-list
))
1139 (if (car l
) (semantic-collector-flush (car l
)))
1143 (add-hook 'semantic-after-toplevel-cache-change-hook
1144 'semantic-collector-buffer-flush
)
1146 ;;; DEEP BUFFER SPECIFIC COMPLETION
1148 (defclass semantic-collector-buffer-deep
1149 (semantic-collector-buffer-abstract)
1151 "Completion engine for tags in the current buffer.
1152 When searching for a tag, uses semantic deep searche functions.
1153 Basics search only in the current buffer.")
1155 (defmethod semantic-collector-calculate-cache
1156 ((obj semantic-collector-buffer-deep
))
1157 "Calculate the completion cache for OBJ.
1158 Uses `semantic-flatten-tags-table'"
1160 ;; Must create it in SEMANTICDB find format.
1161 ;; ( ( DBTABLE TAG TAG ... ) ... )
1163 (cons semanticdb-current-table
1164 (semantic-flatten-tags-table (oref obj buffer
))))))
1166 ;;; PROJECT SPECIFIC COMPLETION
1168 (defclass semantic-collector-project-abstract
(semantic-collector-abstract)
1169 ((path :initarg
:path
1171 :documentation
"List of database tables to search.
1172 At creation time, it can be anything accepted by
1173 `semanticdb-find-translate-path' as a PATH argument.")
1175 "Root class for project wide completion engines.
1176 Uses semanticdb for searching all tags in the current project."
1180 (defclass semantic-collector-project
(semantic-collector-project-abstract)
1182 "Completion engine for tags in a project.")
1185 (defmethod semantic-collector-calculate-completions-raw
1186 ((obj semantic-collector-project
) prefix completionlist
)
1187 "Calculate the completions for prefix from completionlist."
1188 (semanticdb-find-tags-for-completion prefix
(oref obj path
)))
1190 ;;; Brutish Project search
1191 (defclass semantic-collector-project-brutish
(semantic-collector-project-abstract)
1193 "Completion engine for tags in a project.")
1195 (declare-function semanticdb-brute-deep-find-tags-for-completion
1198 (defmethod semantic-collector-calculate-completions-raw
1199 ((obj semantic-collector-project-brutish
) prefix completionlist
)
1200 "Calculate the completions for prefix from completionlist."
1201 (require 'semantic
/db-find
)
1202 (semanticdb-brute-deep-find-tags-for-completion prefix
(oref obj path
)))
1204 (defclass semantic-collector-analyze-completions
(semantic-collector-abstract)
1205 ((context :initarg
:context
1206 :type semantic-analyze-context
1207 :documentation
"An analysis context.
1208 Specifies some context location from whence completion lists will be drawn."
1210 (first-pass-completions :type list
1211 :documentation
"List of valid completion tags.
1212 This list of tags is generated when completion starts. All searches
1213 derive from this list.")
1215 "Completion engine that uses the context analyzer to provide options.
1216 The only options available for completion are those which can be logically
1217 inserted into the current context.")
1219 (defmethod semantic-collector-calculate-completions-raw
1220 ((obj semantic-collector-analyze-completions
) prefix completionlist
)
1221 "calculate the completions for prefix from completionlist."
1222 ;; if there are no completions yet, calculate them.
1223 (if (not (slot-boundp obj
'first-pass-completions
))
1224 (oset obj first-pass-completions
1225 (semantic-analyze-possible-completions (oref obj context
))))
1226 ;; search our cached completion list. make it look like a semanticdb
1228 (list (cons (with-current-buffer (oref (oref obj context
) buffer
)
1229 semanticdb-current-table
)
1230 (semantic-find-tags-for-completion
1232 (oref obj first-pass-completions
)))))
1235 ;;; ------------------------------------------------------------
1236 ;;; Tag List Display Engines
1238 ;; A typical displayor accepts a pre-determined list of completions
1239 ;; generated by a collector. This format is in semanticdb search
1240 ;; form. This vaguely standard form is a bit challenging to navigate
1241 ;; because the tags do not contain buffer info, but the file assocated
1242 ;; with the tags preceed the tag in the list.
1244 ;; Basic displayors don't care, and can strip the results.
1245 ;; Advanced highlighting displayors need to know when they need
1246 ;; to load a file so that the tag in question can be highlighted.
1248 ;; Key interface methods to a displayor are:
1249 ;; * semantic-displayor-next-action
1250 ;; * semantic-displayor-set-completions
1251 ;; * semantic-displayor-current-focus
1252 ;; * semantic-displayor-show-request
1253 ;; * semantic-displayor-scroll-request
1254 ;; * semantic-displayor-focus-request
1256 (defclass semantic-displayor-abstract
()
1257 ((table :type
(or null semanticdb-find-result-with-nil
)
1259 :protection
:protected
1260 :documentation
"List of tags this displayor is showing.")
1261 (last-prefix :type string
1262 :protection
:protected
1263 :documentation
"Prefix associated with slot `table'")
1265 "Abstract displayor baseclass.
1266 Manages the display of some number of tags.
1267 Provides the basics for a displayor, including interacting with
1268 a collector, and tracking tables of completion to display."
1271 (defmethod semantic-displayor-cleanup ((obj semantic-displayor-abstract
))
1272 "Clean up any mess this displayor may have."
1275 (defmethod semantic-displayor-next-action ((obj semantic-displayor-abstract
))
1276 "The next action to take on the minibuffer related to display."
1277 (if (and (slot-boundp obj
'last-prefix
)
1278 (string= (oref obj last-prefix
) (semantic-completion-text))
1279 (eq last-command this-command
))
1283 (defmethod semantic-displayor-set-completions ((obj semantic-displayor-abstract
)
1285 "Set the list of tags to be completed over to TABLE."
1286 (oset obj table table
)
1287 (oset obj last-prefix prefix
))
1289 (defmethod semantic-displayor-show-request ((obj semantic-displayor-abstract
))
1290 "A request to show the current tags table."
1293 (defmethod semantic-displayor-focus-request ((obj semantic-displayor-abstract
))
1294 "A request to for the displayor to focus on some tag option."
1297 (defmethod semantic-displayor-scroll-request ((obj semantic-displayor-abstract
))
1298 "A request to for the displayor to scroll the completion list (if needed)."
1299 (scroll-other-window))
1301 (defmethod semantic-displayor-focus-previous ((obj semantic-displayor-abstract
))
1302 "Set the current focus to the previous item."
1305 (defmethod semantic-displayor-focus-next ((obj semantic-displayor-abstract
))
1306 "Set the current focus to the next item."
1309 (defmethod semantic-displayor-current-focus ((obj semantic-displayor-abstract
))
1310 "Return a single tag currently in focus.
1311 This object type doesn't do focus, so will never have a focus object."
1314 ;; Traditional displayor
1315 (defcustom semantic-completion-displayor-format-tag-function
1316 #'semantic-format-tag-name
1317 "*A Tag format function to use when showing completions."
1319 :type semantic-format-tag-custom-list
)
1321 (defclass semantic-displayor-traditional
(semantic-displayor-abstract)
1323 "Display options in *Completions* buffer.
1324 Traditional display mechanism for a list of possible completions.
1325 Completions are showin in a new buffer and listed with the ability
1326 to click on the items to aid in completion.")
1328 (defmethod semantic-displayor-show-request ((obj semantic-displayor-traditional
))
1329 "A request to show the current tags table."
1331 ;; NOTE TO SELF. Find the character to type next, and emphesize it.
1333 (with-output-to-temp-buffer "*Completions*"
1334 (display-completion-list
1335 (mapcar semantic-completion-displayor-format-tag-function
1336 (semanticdb-strip-find-results (oref obj table
))))
1340 ;;; Abstract baseclass for any displayor which supports focus
1341 (defclass semantic-displayor-focus-abstract
(semantic-displayor-abstract)
1342 ((focus :type number
1343 :protection
:protected
1344 :documentation
"A tag index from `table' which has focus.
1345 Multiple calls to the display function can choose to focus on a
1346 given tag, by highlighting its location.")
1351 "Non-nil if focusing requires a tag's buffer be in memory.")
1353 "Abstract displayor supporting `focus'.
1354 A displayor which has the ability to focus in on one tag.
1355 Focusing is a way of differentiationg between multiple tags
1356 which have the same name."
1359 (defmethod semantic-displayor-next-action ((obj semantic-displayor-focus-abstract
))
1360 "The next action to take on the minibuffer related to display."
1361 (if (and (slot-boundp obj
'last-prefix
)
1362 (string= (oref obj last-prefix
) (semantic-completion-text))
1363 (eq last-command this-command
))
1365 (slot-boundp obj
'focus
)
1366 (slot-boundp obj
'table
)
1367 (<= (semanticdb-find-result-length (oref obj table
))
1368 (1+ (oref obj focus
))))
1369 ;; We are at the end of the focus road.
1371 ;; Focus on some item.
1375 (defmethod semantic-displayor-set-completions ((obj semantic-displayor-focus-abstract
)
1377 "Set the list of tags to be completed over to TABLE."
1379 (slot-makeunbound obj
'focus
))
1381 (defmethod semantic-displayor-focus-previous ((obj semantic-displayor-focus-abstract
))
1382 "Set the current focus to the previous item.
1383 Not meaningful return value."
1384 (when (and (slot-boundp obj
'table
) (oref obj table
))
1385 (with-slots (table) obj
1386 (if (or (not (slot-boundp obj
'focus
))
1387 (<= (oref obj focus
) 0))
1388 (oset obj focus
(1- (semanticdb-find-result-length table
)))
1389 (oset obj focus
(1- (oref obj focus
)))
1393 (defmethod semantic-displayor-focus-next ((obj semantic-displayor-focus-abstract
))
1394 "Set the current focus to the next item.
1395 Not meaningful return value."
1396 (when (and (slot-boundp obj
'table
) (oref obj table
))
1397 (with-slots (table) obj
1398 (if (not (slot-boundp obj
'focus
))
1400 (oset obj focus
(1+ (oref obj focus
)))
1402 (if (<= (semanticdb-find-result-length table
) (oref obj focus
))
1406 (defmethod semantic-displayor-focus-tag ((obj semantic-displayor-focus-abstract
))
1407 "Return the next tag OBJ should focus on."
1408 (when (and (slot-boundp obj
'table
) (oref obj table
))
1409 (with-slots (table) obj
1410 (semanticdb-find-result-nth table
(oref obj focus
)))))
1412 (defmethod semantic-displayor-current-focus ((obj semantic-displayor-focus-abstract
))
1413 "Return the tag currently in focus, or call parent method."
1414 (if (and (slot-boundp obj
'focus
)
1415 (slot-boundp obj
'table
)
1416 ;; Only return the current focus IFF the minibuffer reflects
1417 ;; the list this focus was derived from.
1418 (slot-boundp obj
'last-prefix
)
1419 (string= (semantic-completion-text) (oref obj last-prefix
))
1422 (if (oref obj find-file-focus
)
1423 (semanticdb-find-result-nth-in-buffer (oref obj table
) (oref obj focus
))
1424 ;; result-nth returns a cons with car being the tag, and cdr the
1426 (car (semanticdb-find-result-nth (oref obj table
) (oref obj focus
))))
1428 (call-next-method)))
1430 ;;; Simple displayor which performs traditional display completion,
1431 ;; and also focuses with highlighting.
1432 (defclass semantic-displayor-traditional-with-focus-highlight
1433 (semantic-displayor-focus-abstract semantic-displayor-traditional
)
1434 ((find-file-focus :initform t
))
1435 "Display completions in *Completions* buffer, with focus highlight.
1436 A traditional displayor which can focus on a tag by showing it.
1437 Same as `semantic-displayor-traditional', but with selection between
1438 multiple tags with the same name done by 'focusing' on the source
1439 location of the different tags to differentiate them.")
1441 (defmethod semantic-displayor-focus-request
1442 ((obj semantic-displayor-traditional-with-focus-highlight
))
1443 "Focus in on possible tag completions.
1444 Focus is performed by cycling through the tags and highlighting
1445 one in the source buffer."
1446 (let* ((tablelength (semanticdb-find-result-length (oref obj table
)))
1447 (focus (semantic-displayor-focus-tag obj
))
1450 (rtable (cdr focus
))
1452 (nt (semanticdb-normalize-one-tag rtable rtag
))
1456 ;; If we fail to normalize, resete.
1457 (when (not tag
) (setq table rtable tag rtag
))
1459 (let ((buf (or (semantic-tag-buffer tag
)
1460 (and table
(semanticdb-get-buffer table
)))))
1461 ;; If no buffer is provided, then we can make up a summary buffer.
1463 (with-current-buffer (get-buffer-create "*Completion Focus*")
1465 (insert "Focus on tag: \n")
1466 (insert (semantic-format-tag-summarize tag nil t
) "\n\n")
1468 (insert "From table: \n")
1469 (insert (object-name table
) "\n\n"))
1471 (insert "In buffer: \n\n")
1472 (insert (format "%S" buf
)))
1473 (setq buf
(current-buffer))))
1474 ;; Show the tag in the buffer.
1475 (if (get-buffer-window buf
)
1476 (select-window (get-buffer-window buf
))
1477 (switch-to-buffer-other-window buf t
)
1478 (select-window (get-buffer-window buf
)))
1479 ;; Now do some positioning
1481 (if (semantic-tag-with-position-p tag
)
1482 ;; Full tag positional information available
1484 (goto-char (semantic-tag-start tag
))
1485 ;; This avoids a dangerous problem if we just loaded a tag
1486 ;; from a file, but the original position was not updated
1487 ;; in the TAG variable we are currently using.
1488 (semantic-momentary-highlight-tag (semantic-current-tag))
1490 (select-window (minibuffer-window)))
1491 ;; Calculate text difference between contents and the focus item.
1492 (let* ((mbc (semantic-completion-text))
1493 (ftn (semantic-tag-name tag
))
1494 (diff (substring ftn
(length mbc
))))
1495 (semantic-completion-message
1496 (format "%s [%d of %d matches]" diff
(1+ (oref obj focus
)) tablelength
)))
1500 ;;; Tooltip completion lister
1502 ;; Written and contributed by Masatake YAMATO <jet@gyve.org>
1504 ;; Modified by Eric Ludlam for
1505 ;; * Safe compatibility for tooltip free systems.
1506 ;; * Don't use 'avoid package for tooltip positioning.
1508 (defclass semantic-displayor-tooltip
(semantic-displayor-traditional)
1509 ((max-tags :type integer
1514 "Max number of tags displayed on tooltip at once.
1515 If `force-show' is 1, this value is ignored with typing tab or space twice continuously.
1516 if `force-show' is 0, this value is always ignored.")
1517 (force-show :type integer
1518 :initarg
:force-show
1520 :custom
(choice (const
1521 :tag
"Show when double typing"
1527 :tag
"Show if the number of tags is less than `max-tags'."
1530 "Control the behavior of the number of tags is greater than `max-tags'.
1531 -1 means tags are never shown.
1532 0 means the tags are always shown.
1533 1 means tags are shown if space or tab is typed twice continuously.")
1534 (typing-count :type integer
1537 "Counter holding how many times the user types space or tab continuously before showing tags.")
1538 (shown :type boolean
1541 "Flag representing whether tags is shown once or not.")
1543 "Display completions options in a tooltip.
1544 Display mechanism using tooltip for a list of possible completions.")
1546 (defmethod initialize-instance :AFTER
((obj semantic-displayor-tooltip
) &rest args
)
1547 "Make sure we have tooltips required."
1553 (defmethod semantic-displayor-show-request ((obj semantic-displayor-tooltip
))
1554 "A request to show the current tags table."
1555 (if (or (not (featurep 'tooltip
)) (not tooltip-mode
))
1556 ;; If we cannot use tooltips, then go to the normal mode with
1557 ;; a traditional completion buffer.
1559 (let* ((tablelong (semanticdb-strip-find-results (oref obj table
)))
1560 (table (semantic-unique-tag-table-by-name tablelong
))
1561 (l (mapcar semantic-completion-displayor-format-tag-function table
))
1563 (typing-count (oref obj typing-count
))
1564 (force-show (oref obj force-show
))
1565 (matchtxt (semantic-completion-text))
1567 (if (or (oref obj shown
)
1568 (< ll
(oref obj max-tags
))
1569 (and (<= 0 force-show
)
1570 (< (1- force-show
) typing-count
)))
1572 (oset obj typing-count
0)
1575 ;; We Have only one possible match. There could be two cases.
1576 ;; 1) input text != single match.
1578 ;; 2) input text == single match.
1579 ;; --> Complain about it, but still show the match.
1580 (if (string= matchtxt
(semantic-tag-name (car table
)))
1581 (setq msg
(concat "[COMPLETE]\n" (car l
)))
1583 ;; Create the long message.
1584 (setq msg
(mapconcat 'identity l
"\n"))
1585 ;; If there is nothing, say so!
1586 (if (eq 0 (length msg
))
1587 (setq msg
"[NO MATCH]")))
1588 (semantic-displayor-tooltip-show msg
))
1589 ;; The typing count determines if the user REALLY REALLY
1590 ;; wanted to show that much stuff. Only increment
1591 ;; if the current command is a completion command.
1592 (if (and (stringp (this-command-keys))
1593 (string= (this-command-keys) "\C-i"))
1594 (oset obj typing-count
(1+ typing-count
)))
1595 ;; At this point, we know we have too many items.
1596 ;; Lets be brave, and truncate l
1597 (setcdr (nthcdr (oref obj max-tags
) l
) nil
)
1598 (setq msg
(mapconcat 'identity l
"\n"))
1601 (semantic-displayor-tooltip-show (concat msg
"\n...")))
1603 (semantic-displayor-tooltip-show (concat msg
"\n(TAB for more)")))
1609 (if (fboundp 'window-inside-edges
)
1611 (defalias 'semantic-displayor-window-edges
1612 'window-inside-edges
)
1614 (defalias 'semantic-displayor-window-edges
1618 (defun semantic-displayor-point-position ()
1619 "Return the location of POINT as positioned on the selected frame.
1620 Return a cons cell (X . Y)"
1621 (let* ((frame (selected-frame))
1622 (left (frame-parameter frame
'left
))
1623 (top (frame-parameter frame
'top
))
1624 (point-pix-pos (posn-x-y (posn-at-point)))
1625 (edges (window-inside-pixel-edges (selected-window))))
1626 (cons (+ (car point-pix-pos
) (car edges
) left
)
1627 (+ (cdr point-pix-pos
) (cadr edges
) top
))))
1630 (defun semantic-displayor-tooltip-show (text)
1631 "Display a tooltip with TEXT near cursor."
1632 (let ((point-pix-pos (semantic-displayor-point-position))
1633 (tooltip-frame-parameters
1634 (append tooltip-frame-parameters nil
)))
1636 (cons 'left
(+ (car point-pix-pos
) (frame-char-width)))
1637 tooltip-frame-parameters
)
1639 (cons 'top
(+ (cdr point-pix-pos
) (frame-char-height)))
1640 tooltip-frame-parameters
)
1641 (tooltip-show text
)))
1643 (defmethod semantic-displayor-scroll-request ((obj semantic-displayor-tooltip
))
1644 "A request to for the displayor to scroll the completion list (if needed)."
1645 ;; Do scrolling in the tooltip.
1646 (oset obj max-tags
30)
1647 (semantic-displayor-show-request obj
)
1650 ;; End code contributed by Masatake YAMATO <jet@gyve.org>
1653 ;;; Ghost Text displayor
1655 (defclass semantic-displayor-ghost
(semantic-displayor-focus-abstract)
1657 ((ghostoverlay :type overlay
1659 "The overlay the ghost text is displayed in.")
1660 (first-show :initform t
1662 "Non nil if we have not seen our first show request.")
1664 "Cycle completions inline with ghost text.
1665 Completion displayor using ghost chars after point for focus options.
1666 Whichever completion is currently in focus will be displayed as ghost
1667 text using overlay options.")
1669 (defmethod semantic-displayor-next-action ((obj semantic-displayor-ghost
))
1670 "The next action to take on the inline completion related to display."
1671 (let ((ans (call-next-method))
1672 (table (when (slot-boundp obj
'table
)
1674 (if (and (eq ans
'displayend
)
1676 (= (semanticdb-find-result-length table
) 1)
1681 (defmethod semantic-displayor-cleanup ((obj semantic-displayor-ghost
))
1682 "Clean up any mess this displayor may have."
1683 (when (slot-boundp obj
'ghostoverlay
)
1684 (semantic-overlay-delete (oref obj ghostoverlay
)))
1687 (defmethod semantic-displayor-set-completions ((obj semantic-displayor-ghost
)
1689 "Set the list of tags to be completed over to TABLE."
1692 (semantic-displayor-cleanup obj
)
1696 (defmethod semantic-displayor-show-request ((obj semantic-displayor-ghost
))
1697 "A request to show the current tags table."
1698 ; (if (oref obj first-show)
1700 ; (oset obj first-show nil)
1701 (semantic-displayor-focus-next obj
)
1702 (semantic-displayor-focus-request obj
)
1704 ;; Only do the traditional thing if the first show request
1705 ;; has been seen. Use the first one to start doing the ghost
1707 ; (call-next-method)
1711 (defmethod semantic-displayor-focus-request
1712 ((obj semantic-displayor-ghost
))
1713 "Focus in on possible tag completions.
1714 Focus is performed by cycling through the tags and showing a possible
1715 completion text in ghost text."
1716 (let* ((tablelength (semanticdb-find-result-length (oref obj table
)))
1717 (focus (semantic-displayor-focus-tag obj
))
1721 (semantic-completion-message "No tags to focus on.")
1722 ;; Display the focus completion as ghost text after the current
1724 (when (or (not (slot-boundp obj
'ghostoverlay
))
1725 (not (semantic-overlay-live-p (oref obj ghostoverlay
))))
1726 (oset obj ghostoverlay
1727 (semantic-make-overlay (point) (1+ (point)) (current-buffer) t
)))
1729 (let* ((lp (semantic-completion-text))
1730 (os (substring (semantic-tag-name tag
) (length lp
)))
1731 (ol (oref obj ghostoverlay
))
1734 (put-text-property 0 (length os
) 'face
'region os
)
1736 (semantic-overlay-put
1737 ol
'display
(concat os
(buffer-substring (point) (1+ (point)))))
1739 ;; Calculate text difference between contents and the focus item.
1740 (let* ((mbc (semantic-completion-text))
1741 (ftn (concat (semantic-tag-name tag
)))
1743 (put-text-property (length mbc
) (length ftn
) 'face
1745 (semantic-completion-message
1746 (format "%s [%d of %d matches]" ftn
(1+ (oref obj focus
)) tablelength
)))
1750 ;;; ------------------------------------------------------------
1751 ;;; Specific queries
1753 (defvar semantic-complete-inline-custom-type
1757 (let* ((C (intern (car class
)))
1758 (doc (documentation-property C
'variable-documentation
))
1759 (doc1 (car (split-string doc
"\n")))
1764 (eieio-build-class-alist semantic-displayor-abstract t
))
1766 "Possible options for inline completion displayors.
1767 Use this to enable custom editing.")
1769 (defcustom semantic-complete-inline-analyzer-displayor-class
1770 'semantic-displayor-traditional
1771 "*Class for displayor to use with inline completion."
1773 :type semantic-complete-inline-custom-type
1776 (defun semantic-complete-read-tag-buffer-deep (prompt &optional
1780 "Ask for a tag by name from the current buffer.
1781 Available tags are from the current buffer, at any level.
1782 Completion options are presented in a traditional way, with highlighting
1783 to resolve same-name collisions.
1784 PROMPT is a string to prompt with.
1785 DEFAULT-TAG is a semantic tag or string to use as the default value.
1786 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.
1787 HISTORY is a symbol representing a variable to store the history in."
1788 (semantic-complete-read-tag-engine
1789 (semantic-collector-buffer-deep prompt
:buffer
(current-buffer))
1790 (semantic-displayor-traditional-with-focus-highlight "simple")
1791 ;;(semantic-displayor-tooltip "simple")
1798 (defun semantic-complete-read-tag-project (prompt &optional
1802 "Ask for a tag by name from the current project.
1803 Available tags are from the current project, at the top level.
1804 Completion options are presented in a traditional way, with highlighting
1805 to resolve same-name collisions.
1806 PROMPT is a string to prompt with.
1807 DEFAULT-TAG is a semantic tag or string to use as the default value.
1808 If INITIAL-INPUT is non-nil, insert it in the minibuffer initially.
1809 HISTORY is a symbol representing a variable to store the history in."
1810 (semantic-complete-read-tag-engine
1811 (semantic-collector-project-brutish prompt
1812 :buffer
(current-buffer)
1813 :path
(current-buffer)
1815 (semantic-displayor-traditional-with-focus-highlight "simple")
1822 (defun semantic-complete-inline-tag-project ()
1823 "Complete a symbol name by name from within the current project.
1824 This is similar to `semantic-complete-read-tag-project', except
1825 that the completion interaction is in the buffer where the context
1826 was calculated from.
1827 Customize `semantic-complete-inline-analyzer-displayor-class'
1828 to control how completion options are displayed.
1829 See `semantic-complete-inline-tag-engine' for details on how
1831 (let* ((collector (semantic-collector-project-brutish
1833 :buffer
(current-buffer)
1834 :path
(current-buffer)))
1835 (sbounds (semantic-ctxt-current-symbol-and-bounds))
1836 (syms (car sbounds
))
1837 (start (car (nth 2 sbounds
)))
1838 (end (cdr (nth 2 sbounds
)))
1839 (rsym (reverse syms
))
1840 (thissym (nth 1 sbounds
))
1841 (nextsym (car-safe (cdr rsym
)))
1843 (when (and thissym
(or (not (string= thissym
""))
1845 ;; Do a quick calcuation of completions.
1846 (semantic-collector-calculate-completions
1847 collector thissym nil
)
1848 ;; Get the master list
1849 (setq complst
(semanticdb-strip-find-results
1850 (semantic-collector-all-completions collector thissym
)))
1852 (setq complst
(semantic-unique-tag-table-by-name complst
))
1853 (if (or (and (= (length complst
) 1)
1854 ;; Check to see if it is the same as what is there.
1855 ;; if so, we can offer to complete.
1856 (let ((compname (semantic-tag-name (car complst
))))
1857 (not (string= compname thissym
))))
1858 (> (length complst
) 1))
1859 ;; There are several options. Do the completion.
1860 (semantic-complete-inline-tag-engine
1862 (funcall semantic-complete-inline-analyzer-displayor-class
1864 ;;(semantic-displayor-tooltip "simple")
1869 (defun semantic-complete-read-tag-analyzer (prompt &optional
1872 "Ask for a tag by name based on the current context.
1873 The function `semantic-analyze-current-context' is used to
1874 calculate the context. `semantic-analyze-possible-completions' is used
1875 to generate the list of possible completions.
1876 PROMPT is the first part of the prompt. Additional prompt
1877 is added based on the contexts full prefix.
1878 CONTEXT is the semantic analyzer context to start with.
1879 HISTORY is a symbol representing a variable to store the history in.
1880 usually a default-tag and initial-input are available for completion
1881 prompts. these are calculated from the CONTEXT variable passed in."
1882 (if (not context
) (setq context
(semantic-analyze-current-context (point))))
1883 (let* ((syms (semantic-ctxt-current-symbol (point)))
1884 (inp (car (reverse syms
))))
1885 (setq syms
(nreverse (cdr (nreverse syms
))))
1886 (semantic-complete-read-tag-engine
1887 (semantic-collector-analyze-completions
1889 :buffer
(oref context buffer
)
1891 (semantic-displayor-traditional-with-focus-highlight "simple")
1892 (with-current-buffer (oref context buffer
)
1893 (goto-char (cdr (oref context bounds
)))
1894 (concat prompt
(mapconcat 'identity syms
".")
1901 (defun semantic-complete-inline-analyzer (context)
1902 "Complete a symbol name by name based on the current context.
1903 This is similar to `semantic-complete-read-tag-analyze', except
1904 that the completion interaction is in the buffer where the context
1905 was calculated from.
1906 CONTEXT is the semantic analyzer context to start with.
1907 Customize `semantic-complete-inline-analyzer-displayor-class'
1908 to control how completion options are displayed.
1910 See `semantic-complete-inline-tag-engine' for details on how
1912 (if (not context
) (setq context
(semantic-analyze-current-context (point))))
1913 (if (not context
) (error "Nothing to complete on here"))
1914 (let* ((collector (semantic-collector-analyze-completions
1916 :buffer
(oref context buffer
)
1918 (syms (semantic-ctxt-current-symbol (point)))
1919 (rsym (reverse syms
))
1920 (thissym (car rsym
))
1921 (nextsym (car-safe (cdr rsym
)))
1923 (when (and thissym
(or (not (string= thissym
""))
1925 ;; Do a quick calcuation of completions.
1926 (semantic-collector-calculate-completions
1927 collector thissym nil
)
1928 ;; Get the master list
1929 (setq complst
(semanticdb-strip-find-results
1930 (semantic-collector-all-completions collector thissym
)))
1932 (setq complst
(semantic-unique-tag-table-by-name complst
))
1933 (if (or (and (= (length complst
) 1)
1934 ;; Check to see if it is the same as what is there.
1935 ;; if so, we can offer to complete.
1936 (let ((compname (semantic-tag-name (car complst
))))
1937 (not (string= compname thissym
))))
1938 (> (length complst
) 1))
1939 ;; There are several options. Do the completion.
1940 (semantic-complete-inline-tag-engine
1942 (funcall semantic-complete-inline-analyzer-displayor-class
1944 ;;(semantic-displayor-tooltip "simple")
1945 (oref context buffer
)
1946 (car (oref context bounds
))
1947 (cdr (oref context bounds
))
1951 (defcustom semantic-complete-inline-analyzer-idle-displayor-class
1952 'semantic-displayor-ghost
1953 "*Class for displayor to use with inline completion at idle time."
1955 :type semantic-complete-inline-custom-type
1958 (defun semantic-complete-inline-analyzer-idle (context)
1959 "Complete a symbol name by name based on the current context for idle time.
1960 CONTEXT is the semantic analyzer context to start with.
1961 This function is used from `semantic-idle-completions-mode'.
1963 This is the same as `semantic-complete-inline-analyzer', except that
1964 it uses `semantic-complete-inline-analyzer-idle-displayor-class'
1965 to control how completions are displayed.
1967 See `semantic-complete-inline-tag-engine' for details on how
1969 (let ((semantic-complete-inline-analyzer-displayor-class
1970 semantic-complete-inline-analyzer-idle-displayor-class
))
1971 (semantic-complete-inline-analyzer context
)
1976 (defun semantic-complete-jump-local ()
1977 "Jump to a semantic symbol."
1979 (let ((tag (semantic-complete-read-tag-buffer-deep "Symbol: ")))
1980 (when (semantic-tag-p tag
)
1982 (goto-char (semantic-tag-start tag
))
1983 (semantic-momentary-highlight-tag tag
)
1985 (semantic-tag-class tag
)
1986 (semantic-tag-name tag
)))))
1989 (defun semantic-complete-jump ()
1990 "Jump to a semantic symbol."
1992 (let* ((tag (semantic-complete-read-tag-project "Symbol: ")))
1993 (when (semantic-tag-p tag
)
1995 (semantic-go-to-tag tag
)
1996 (switch-to-buffer (current-buffer))
1997 (semantic-momentary-highlight-tag tag
)
1999 (semantic-tag-class tag
)
2000 (semantic-tag-name tag
)))))
2003 (defun semantic-complete-analyze-and-replace ()
2004 "Perform prompt completion to do in buffer completion.
2005 `semantic-analyze-possible-completions' is used to determine the
2007 The minibuffer is used to perform the completion.
2008 The result is inserted as a replacement of the text that was there."
2010 (let* ((c (semantic-analyze-current-context (point)))
2011 (tag (save-excursion (semantic-complete-read-tag-analyzer "" c
))))
2012 ;; Take tag, and replace context bound with its name.
2013 (goto-char (car (oref c bounds
)))
2014 (delete-region (point) (cdr (oref c bounds
)))
2015 (insert (semantic-tag-name tag
))
2016 (message "%S" (semantic-format-tag-summarize tag
))))
2019 (defun semantic-complete-analyze-inline ()
2020 "Perform prompt completion to do in buffer completion.
2021 `semantic-analyze-possible-completions' is used to determine the
2023 The function returns immediately, leaving the buffer in a mode that
2024 will perform the completion.
2025 Configure `semantic-complete-inline-analyzer-displayor-class' to change
2026 how completion options are displayed."
2028 ;; Only do this if we are not already completing something.
2029 (if (not (semantic-completion-inline-active-p))
2030 (semantic-complete-inline-analyzer
2031 (semantic-analyze-current-context (point))))
2032 ;; Report a message if things didn't startup.
2033 (if (and (interactive-p)
2034 (not (semantic-completion-inline-active-p)))
2035 (message "Inline completion not needed.")
2036 ;; Since this is most likely bound to something, and not used
2037 ;; at idle time, throw in a TAB for good measure.
2038 (semantic-complete-inline-TAB)
2042 (defun semantic-complete-analyze-inline-idle ()
2043 "Perform prompt completion to do in buffer completion.
2044 `semantic-analyze-possible-completions' is used to determine the
2046 The function returns immediately, leaving the buffer in a mode that
2047 will perform the completion.
2048 Configure `semantic-complete-inline-analyzer-idle-displayor-class'
2049 to change how completion options are displayed."
2051 ;; Only do this if we are not already completing something.
2052 (if (not (semantic-completion-inline-active-p))
2053 (semantic-complete-inline-analyzer-idle
2054 (semantic-analyze-current-context (point))))
2055 ;; Report a message if things didn't startup.
2056 (if (and (interactive-p)
2057 (not (semantic-completion-inline-active-p)))
2058 (message "Inline completion not needed."))
2062 (defun semantic-complete-self-insert (arg)
2063 "Like `self-insert-command', but does completion afterwards.
2064 ARG is passed to `self-insert-command'. If ARG is nil,
2065 use `semantic-complete-analyze-inline' to complete."
2067 ;; If we are already in a completion scenario, exit now, and then start over.
2068 (semantic-complete-inline-exit)
2071 (self-insert-command arg
)
2073 ;; Prepare for doing completion, but exit quickly if there is keyboard
2075 (when (and (not (semantic-exit-on-input 'csi
2076 (semantic-fetch-tags)
2077 (semantic-throw-on-input 'csi
)
2080 (not (semantic-exit-on-input 'csi
2081 (semantic-analyze-current-context)
2082 (semantic-throw-on-input 'csi
)
2085 (semantic-complete-analyze-inline)
2086 ;; Ignore errors. Seems likely that we'll get some once in a while.
2090 (provide 'semantic
/complete
)
2093 ;; generated-autoload-file: "loaddefs.el"
2094 ;; generated-autoload-load-name: "semantic/complete"
2097 ;; arch-tag: a07c8f71-e53b-416e-9704-3a99ef101b09
2098 ;;; semantic/complete.el ends here