anything.el: anything-cleanup: use anything-new-timer, not cancel-timer
[anything-config.git] / anything.el
blob7eda85f48f34aaec7a6192de48e60b8efc2a909f
1 ;;; anything.el --- open anything / QuickSilver-like candidate-selection framework
3 ;; Copyright (C) 2007 Tamas Patrovics
4 ;; 2008 ~ 2016 rubikitch <rubikitch@ruby-lang.org>
5 ;; 2011 ~ 2012 Thierry Volpiatto <thierry.volpiatto@gmail.com>
7 ;; Author: Tamas Patrovics
9 ;; Maintainers: rubikitch <rubikitch@ruby-lang.org>
10 ;; Thierry Volpiatto <thierry.volpiatto@gmail.com>
12 ;; Keywords: files, frames, help, matching, outlines,
13 ;; processes, tools, convenience, anything
15 ;; X-URL: <http://repo.or.cz/w/anything-config.git>
17 ;; Site: <http://www.emacswiki.org/cgi-bin/emacs/Anything>
19 ;; MailingList: <https://groups.google.com/group/emacs-anything?hl=en>
22 ;;; This file is NOT part of GNU Emacs
24 ;;; License
26 ;; This file is free software; you can redistribute it and/or modify
27 ;; it under the terms of the GNU General Public License as published by
28 ;; the Free Software Foundation; either version 2, or (at your option)
29 ;; any later version.
31 ;; This file is distributed in the hope that it will be useful,
32 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
33 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
35 ;; GNU General Public License for more details.
37 ;; You should have received a copy of the GNU General Public License
38 ;; along with GNU Emacs; see the file COPYING. If not, write to the
39 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
40 ;; Boston, MA 02110-1301, USA.
43 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
45 ;;; Autodoc documentation:
46 ;; ---------------------
48 ;; * Commands defined here are:
49 ;; [EVAL] (autodoc-document-lisp-buffer :type 'command :prefix "anything" :docstring t)
50 ;; `anything-open-last-log'
51 ;; Open anything log file of last anything session.
52 ;; `anything'
53 ;; Main function to execute anything sources.
54 ;; `anything-resume'
55 ;; Resurrect previously invoked `anything'.
56 ;; `anything-resume-window-only'
58 ;; `anything-at-point'
59 ;; Call anything with symbol at point as initial input.
60 ;; `anything-force-update'
61 ;; Force recalculation and update of candidates.
62 ;; `anything-select-action'
63 ;; Select an action for the currently selected candidate.
64 ;; `anything-previous-line'
65 ;; Move selection to the previous line.
66 ;; `anything-next-line'
67 ;; Move selection to the next line.
68 ;; `anything-previous-page'
69 ;; Move selection back with a pageful.
70 ;; `anything-next-page'
71 ;; Move selection forward with a pageful.
72 ;; `anything-beginning-of-buffer'
73 ;; Move selection at the top.
74 ;; `anything-end-of-buffer'
75 ;; Move selection at the bottom.
76 ;; `anything-previous-source'
77 ;; Move selection to the previous source.
78 ;; `anything-next-source'
79 ;; Move selection to the next source.
80 ;; `anything-select-with-prefix-shortcut'
81 ;; Invoke default action with prefix shortcut.
82 ;; `anything-select-with-digit-shortcut'
83 ;; Invoke default action with digit/alphabet shortcut.
84 ;; `anything-confirm-and-exit-minibuffer'
85 ;; Maybe ask for confirmation when exiting anything.
86 ;; `anything-exit-minibuffer'
87 ;; Select the current candidate by exiting the minibuffer.
88 ;; `anything-keyboard-quit'
89 ;; Quit minibuffer in anything.
90 ;; `anything-help'
91 ;; Help of `anything'.
92 ;; `anything-debug-output'
93 ;; Show all anything-related variables at this time.
94 ;; `anything-delete-current-selection'
95 ;; Delete the currently selected item.
96 ;; `anything-delete-minibuffer-contents'
97 ;; Same as `delete-minibuffer-contents' but this is a command.
98 ;; `anything-toggle-resplit-window'
99 ;; Toggle resplit anything window, vertically or horizontally.
100 ;; `anything-narrow-window'
101 ;; Narrow anything window.
102 ;; `anything-enlarge-window'
103 ;; Enlarge anything window.
104 ;; `anything-select-2nd-action'
105 ;; Select the 2nd action for the currently selected candidate.
106 ;; `anything-select-3rd-action'
107 ;; Select the 3rd action for the currently selected candidate.
108 ;; `anything-select-4th-action'
109 ;; Select the 4th action for the currently selected candidate.
110 ;; `anything-select-2nd-action-or-end-of-line'
111 ;; Select the 2nd action for the currently selected candidate.
112 ;; `anything-execute-persistent-action'
113 ;; Perform the associated action ATTR without quitting anything.
114 ;; `anything-scroll-other-window'
115 ;; Scroll other window (not *Anything* window) upward.
116 ;; `anything-scroll-other-window-down'
117 ;; Scroll other window (not *Anything* window) downward.
118 ;; `anything-toggle-visible-mark'
119 ;; Toggle anything visible mark at point.
120 ;; `anything-display-all-visible-marks'
121 ;; Show all `anything' visible marks strings.
122 ;; `anything-next-visible-mark'
123 ;; Move next anything visible mark.
124 ;; `anything-prev-visible-mark'
125 ;; Move previous anything visible mark.
126 ;; `anything-yank-selection'
127 ;; Set minibuffer contents to current selection.
128 ;; `anything-kill-selection-and-quit'
129 ;; Store current selection to kill ring.
130 ;; `anything-follow-mode'
131 ;; If this mode is on, persistent action is executed everytime the cursor is moved.
132 ;; `anything-migrate-sources'
133 ;; Help to migrate to new `anything' way.
134 ;; `anything-describe-anything-attribute'
135 ;; Display the full documentation of ANYTHING-ATTRIBUTE.
136 ;; `anything-send-bug-report'
137 ;; Send a bug report of anything.el.
138 ;; `anything-send-bug-report-from-anything'
139 ;; Send a bug report of anything.el in anything session.
141 ;; * Variables defined here are:
142 ;; [EVAL] (autodoc-document-lisp-buffer :type 'internal-variable :prefix "anything-" :docstring t)
143 ;; `anything-version'
144 ;; Not documented.
145 ;; `anything-sources'
146 ;; A list of sources to use with `anything'.
147 ;; `anything-type-attributes'
148 ;; It's a list of (TYPE ATTRIBUTES ...).
149 ;; `anything-enable-shortcuts'
150 ;; *Whether to use digit/alphabet shortcut to select the first nine matches.
151 ;; `anything-shortcut-keys-alist'
152 ;; Not documented.
153 ;; `anything-display-source-at-screen-top'
154 ;; *Display candidates at the top of screen.
155 ;; `anything-candidate-number-limit'
156 ;; Apply candidate-number-limit attribute value.
157 ;; `anything-idle-delay'
158 ;; *Be idle for this many seconds, before updating in delayed sources.
159 ;; `anything-input-idle-delay'
160 ;; Be idle for this many seconds, before updating.
161 ;; `anything-samewindow'
162 ;; Use current window to show the candidates.
163 ;; `anything-source-filter'
164 ;; A list of source names to be displayed.
165 ;; `anything-map'
166 ;; Keymap for anything.
167 ;; `anything-header-face'
168 ;; *Face for header lines in the anything buffer.
169 ;; `anything-selection-face'
170 ;; *Face for currently selected item.
171 ;; `anything-buffer'
172 ;; Buffer showing completions.
173 ;; `anything-action-buffer'
174 ;; Buffer showing actions.
175 ;; `anything-selection-overlay'
176 ;; Overlay used to highlight the currently selected item.
177 ;; `anything-digit-overlays'
178 ;; Overlays for digit shortcuts. See `anything-enable-shortcuts'.
179 ;; `anything-candidate-cache'
180 ;; Holds the available candidate withing a single anything invocation.
181 ;; `anything-pattern'
182 ;; Not documented.
183 ;; `anything-input'
184 ;; Not documented.
185 ;; `anything-async-processes'
186 ;; List of information about asynchronous processes managed by anything.
187 ;; `anything-digit-shortcut-count'
188 ;; Number of digit shortcuts shown in the anything buffer.
189 ;; `anything-before-initialize-hook'
190 ;; Run before anything initialization.
191 ;; `anything-after-initialize-hook'
192 ;; Run after anything initialization.
193 ;; `anything-update-hook'
194 ;; Run after the anything buffer was updated according the new input pattern.
195 ;; `anything-after-update-hook'
196 ;; Run after the anything buffer was updated according the new input pattern.
197 ;; `anything-cleanup-hook'
198 ;; Run after anything minibuffer is closed.
199 ;; `anything-select-action-hook'
200 ;; Run when opening the action buffer.
201 ;; `anything-before-action-hook'
202 ;; Run before executing action.
203 ;; `anything-after-action-hook'
204 ;; Run after executing action.
205 ;; `anything-after-persistent-action-hook'
206 ;; Run after executing persistent action.
207 ;; `anything-move-selection-before-hook'
208 ;; Run before moving selection in `anything-buffer'.
209 ;; `anything-move-selection-after-hook'
210 ;; Run after moving selection in `anything-buffer'.
211 ;; `anything-restored-variables'
212 ;; Variables which are restored after `anything' invocation.
213 ;; `anything-saved-selection'
214 ;; Value of the currently selected object when the action list is shown.
215 ;; `anything-current-prefix-arg'
216 ;; Record `current-prefix-arg' when exiting minibuffer.
217 ;; `anything-candidate-separator'
218 ;; Candidates separator of `multiline' source.
219 ;; `anything-current-buffer'
220 ;; Current buffer when `anything' is invoked.
221 ;; `anything-buffer-file-name'
222 ;; Variable `buffer-file-name' when `anything' is invoked.
223 ;; `anything-saved-action'
224 ;; Saved value of the currently selected action by key.
225 ;; `anything-last-sources'
226 ;; OBSOLETE!! Sources of previously invoked `anything'.
227 ;; `anything-saved-current-source'
228 ;; Value of the current source when the action list is shown.
229 ;; `anything-compiled-sources'
230 ;; Compiled version of `anything-sources'.
231 ;; `anything-in-persistent-action'
232 ;; Flag whether in persistent-action or not.
233 ;; `anything-quick-update'
234 ;; If non-nil, suppress displaying sources which are out of screen at first.
235 ;; `anything-last-sources-local'
236 ;; Buffer local value of `anything-sources'.
237 ;; `anything-last-buffer'
238 ;; `anything-buffer' of previously `anything' session.
239 ;; `anything-save-configuration-functions'
240 ;; The functions used to restore/save window or frame configurations.
241 ;; `anything-persistent-action-use-special-display'
242 ;; If non-nil, use `special-display-function' in persistent action.
243 ;; `anything-execute-action-at-once-if-one'
244 ;; Execute default action and exit when only one candidate is remaining.
245 ;; `anything-quit-if-no-candidate'
246 ;; Quit when there is no candidates when non--nil.
247 ;; `anything-scroll-amount'
248 ;; Scroll amount when scrolling other window in an anything session.
249 ;; `anything-display-function'
250 ;; Function to display *anything* buffer.
251 ;; `anything-delayed-init-executed'
252 ;; Not documented.
253 ;; `anything-mode-line-string'
254 ;; Help string displayed in mode-line in `anything'.
255 ;; `anything-help-message'
256 ;; Detailed help message string for `anything'.
257 ;; `anything-source-in-each-line-flag'
258 ;; Non-nil means add anything-source text-property in each candidate.
259 ;; `anything-debug-forms'
260 ;; Forms to show in `anything-debug-output'.
261 ;; `anything-debug'
262 ;; If non-nil, write log message into *Anything Log* buffer.
263 ;; `anything-test-candidate-list'
264 ;; Not documented.
265 ;; `anything-test-mode'
266 ;; Not documented.
267 ;; `anything-source-name'
268 ;; Not documented.
269 ;; `anything-candidate-buffer-alist'
270 ;; Not documented.
271 ;; `anything-check-minibuffer-input-timer'
272 ;; Not documented.
273 ;; `anything-match-hash'
274 ;; Not documented.
275 ;; `anything-cib-hash'
276 ;; Not documented.
277 ;; `anything-tick-hash'
278 ;; Not documented.
279 ;; `anything-issued-errors'
280 ;; Not documented.
281 ;; `anything-shortcut-keys'
282 ;; Not documented.
283 ;; `anything-once-called-functions'
284 ;; Not documented.
285 ;; `anything-follow-mode'
286 ;; If this mode is on, persistent action is executed everytime the cursor is moved.
287 ;; `anything-let-variables'
288 ;; Not documented.
289 ;; `anything-split-window-state'
290 ;; Not documented.
291 ;; `anything-selection-point'
292 ;; Not documented.
293 ;; `anything-last-log-file'
294 ;; Not documented.
295 ;; `anything-compile-source-functions'
296 ;; Functions to compile elements of `anything-sources' (plug-in).
297 ;; `anything-quit'
298 ;; Not documented.
299 ;; `anything-additional-attributes'
300 ;; List of all `anything' attributes.
301 ;; `anything-buffers'
302 ;; All of `anything-buffer' in most recently used order.
303 ;; `anything-current-position'
304 ;; Restore or save current position in `anything-current-buffer'.
305 ;; `anything-last-frame-or-window-configuration'
306 ;; Used to store window or frame configuration when anything start.
307 ;; `anything-reading-pattern'
308 ;; Whether in `read-string' in anything or not.
309 ;; `anything-compile-source-functions-default'
310 ;; Plug-ins this file provides.
311 ;; `anything-input-local'
312 ;; Not documented.
313 ;; `anything-process-delayed-sources-timer'
314 ;; Not documented.
315 ;; `anything-mode-line-string-real'
316 ;; Not documented.
317 ;; `anything-exit-status'
318 ;; Flag to inform whether anything have exited or quitted.
319 ;; `anything-minibuffer-confirm-state'
320 ;; Not documented.
321 ;; `anything-types'
322 ;; Not documented.
323 ;; `anything-orig-enable-shortcuts'
324 ;; Not documented.
325 ;; `anything-persistent-action-display-window'
326 ;; Return the window that will be used for presistent action.
327 ;; `anything-visible-mark-face'
328 ;; Not documented.
329 ;; `anything-visible-mark-overlays'
330 ;; Not documented.
331 ;; `anything-marked-candidates'
332 ;; Return marked candidates of current source if any.
333 ;; `anything-maintainer-mail-address'
334 ;; Not documented.
335 ;; `anything-bug-report-salutation'
336 ;; Not documented.
337 ;; `anything-no-dump-variables'
338 ;; Variables not to dump in bug report.
340 ;; *** END auto-documentation
342 ;; [EVAL] (autodoc-update-all)
345 ;;; Commentary:
348 ;; Start with M-x anything, narrow the list by typing some pattern,
349 ;; select with up/down/pgup/pgdown/C-p/C-n/C-v/M-v, choose with enter,
350 ;; left/right moves between sources. With TAB actions can be selected
351 ;; if the selected candidate has more than one possible action.
353 ;; Note that anything.el provides only the framework and some example
354 ;; configurations for demonstration purposes. See anything-config.el
355 ;; for practical, polished, easy to use configurations which can be
356 ;; used to assemble a custom personalized configuration.
358 ;; NOTE: What you find on Emacswiki is mostly deprecated and not maintained,
359 ;; don't complain if you use such code or configuration and something
360 ;; doesn't work.
362 ;; Here is Japanese translation of `anything-sources' attributes. Thanks.
363 ;; http://d.hatena.ne.jp/sirocco634/20091012/1255336649
366 ;;; Bug Report:
368 ;; If you have problems, send a bug report via C-c C-x C-b in anything session (best)
369 ;; or M-x anything-send-bug-report outside anything session.
370 ;; I implemented bug report feature because I want to know your current state.
371 ;; It helps me to solve problems easily.
372 ;; The step is:
373 ;; 0) Setup mail in Emacs, the easiest way is:
374 ;; (setq user-mail-address "your@mail.address")
375 ;; (setq user-full-name "Your Full Name")
376 ;; (setq smtpmail-smtp-server "your.smtp.server.jp")
377 ;; (setq mail-user-agent 'message-user-agent)
378 ;; (setq message-send-mail-function 'message-smtpmail-send-it)
379 ;; 1) Be sure to use the LATEST version of anything.el.
380 ;; 2) Enable debugger. M-x toggle-debug-on-error or (setq debug-on-error t)
381 ;; 3) Use Lisp version instead of compiled one: (load "anything.el")
382 ;; 4) Do it!
383 ;; 5) If you got an error, please do not close *Backtrace* buffer.
384 ;; 6) Type C-c C-x C-b (anything session, best!)
385 ;; or M-x anything-send-bug-report (outside)
386 ;; then M-x insert-buffer *Backtrace* (if you got error)
387 ;; 7) Describe the bug using a precise recipe.
388 ;; 8) Type C-c C-c to send.
390 ;; You can also just report bug to:
391 ;; https://groups.google.com/group/emacs-anything?hl=en
394 ;; You can extend `anything' by writing plug-ins. As soon as
395 ;; `anything' is invoked, `anything-sources' is compiled into basic
396 ;; attributes, then compiled one is used during invocation.
398 ;; The oldest built-in plug-in is `type' attribute: appends
399 ;; appropriate element of `anything-type-attributes'. Second built-in
400 ;; plug-in is `candidates-in-buffer': selecting a line from candidates
401 ;; buffer.
403 ;; To write a plug-in:
404 ;; 1. Define a compiler: anything-compile-source--*
405 ;; 2. Add compier function to `anything-compile-source-functions'.
406 ;; 3. (optional) Write helper functions.
408 ;; Tested on Emacs 22/23/24.
411 ;; Thanks to Vagn Johansen for ideas.
412 ;; Thanks to Stefan Kamphausen for fixes and XEmacs support.
413 ;; Thanks to Tassilo Horn for fixes.
414 ;; Thanks to Drew Adams for various fixes
415 ;; Thanks to IMAKADO for candidates-in-buffer idea.
416 ;; Thanks to Tomohiro MATSUYAMA for multiline patch.
419 ;;; (@* "Index")
421 ;; If you have library `linkd.el', load
422 ;; `linkd.el' and turn on `linkd-mode' now. It lets you easily
423 ;; navigate around the sections Linkd mode will
424 ;; highlight this Index. You can get `linkd.el' here:
425 ;; http://www.emacswiki.org/cgi-bin/wiki/download/linkd.el
429 ;;; (@* "Tips")
432 ;; `anything' accepts keyword arguments. See docstring.
433 ;; [EVAL IT] (describe-function 'anything)
436 ;; `anything-enable-shortcuts' enables us to select candidate easily.
437 ;; If 'prefix then they can be selected using <prefix-key> <alnum>.
438 ;; The prefix key is `anything-select-with-prefix-shortcut'.
439 ;; If the <prefix-key> is a letter, pressing twice inputs the letter itself.
440 ;; e.g.
441 ;; (setq anything-enable-shortcuts 'prefix)
442 ;; (define-key anything-map \"@\" 'anything-select-with-prefix-shortcut)
445 ;; You can edit current selection using `anything-edit-current-selection'.
446 ;; It is useful after persistent-action.
449 ;; For `anything' users, setting `anything-sources' directly and
450 ;; invoke M-x anything is obsolete way for now. Try M-x
451 ;; `anything-migrate-sources'!
454 ;; If you want to create anything sources, yasnippet would help you.
455 ;; http://yasnippet.googlecode.com/
457 ;; Then get the snippet from
458 ;; http://www.emacswiki.org/cgi-bin/wiki/download/anything-source.yasnippet
460 ;; Put it in ~/.emacs.d/plugins/yasnippet/snippets/text-mode/emacs-lisp-mode/
464 ;; `anything-interpret-value' is useful function to interpret value
465 ;; like `candidates' attribute.
467 ;; (anything-interpret-value "literal") ; => "literal"
468 ;; (anything-interpret-value (lambda () "lambda")) ; => "lambda"
469 ;; (let ((source '((name . "lambda with source name"))))
470 ;; (anything-interpret-value
471 ;; (lambda () anything-source-name)
472 ;; source)) ; => "lambda with source name"
473 ;; (flet ((f () "function symbol"))
474 ;; (anything-interpret-value 'f)) ; => "function symbol"
475 ;; (let ((v "variable symbol"))
476 ;; (anything-interpret-value 'v)) ; => "variable symbol"
477 ;; (anything-interpret-value 'unbounded-1) ; error
480 ;; Now symbols are acceptable as candidates. So you do not have to use
481 ;; `symbol-name' function. The source is much simpler. For example,
482 ;; `apropos-internal' returns a list of symbols.
484 ;; (anything
485 ;; '(((name . "Commands")
486 ;; (candidates . (lambda () (apropos-internal anything-pattern 'commandp)))
487 ;; (volatile)
488 ;; (action . describe-function))))
491 ;; To mark a candidate, press C-SPC as normal Emacs marking. To go to
492 ;; marked candidate, press M-[ or M-].
495 ;; `anything-map' is now Emacs-standard key bindings by default.
497 ;; There are many `anything' applications, using `anything' for
498 ;; selecting candidate. In this case, if there is one candidate or no
499 ;; candidate, popping up *anything* buffer is irritating. If one
500 ;; candidate, you want to select it at once. If no candidate, you want
501 ;; to quit `anything'. Set `anything-execute-action-at-once-if-one'
502 ;; and `anything-quit-if-no-candidate' to non-nil to remedy it. Note
503 ;; that setting these variables GLOBALLY is bad idea because of
504 ;; delayed sources. These are meant to be let-binded.
506 ;; ex.
507 ;; (let ((anything-execute-action-at-once-if-one t)
508 ;; (anything-quit-if-no-candidate (lambda () (message "No candidate"))))
509 ;; (anything temporary-sources input))
512 ;; `set-frame-configuration' arises flickering. If you hate
513 ;; flickering, eval:
514 ;; (setq anything-save-configuration-functions
515 ;; '(set-window-configuration . current-window-configuration))
516 ;; at the cost of restoring frame configuration (only window configuration).
519 ;; `anything-delete-current-selection' deletes the current line.
520 ;; It is useful when deleting a candidate in persistent action.
521 ;; eg. `kill-buffer'.
523 ;; [EVAL IT] (describe-function 'anything-delete-current-selection)
526 ;; `anything-attr' gets the attribute. `anything-attrset' sets the
527 ;; attribute. `anything-attr-defined' tests whether the attribute is
528 ;; defined. They handles source-local variables.
530 ;; [EVAL IT] (describe-function 'anything-attr)
531 ;; [EVAL IT] (describe-function 'anything-attrset)
532 ;; [EVAL IT] (describe-function 'anything-attr-defined)
535 ;; `anything-sources' accepts many attributes to make your life easier.
536 ;; Now `anything-sources' accepts a list of symbols.
538 ;; [EVAL IT] (describe-variable 'anything-sources)
541 ;; `anything' has optional arguments. Now you do not have to let-bind
542 ;; `anything-sources'.
544 ;; [EVAL IT] (describe-function 'anything)
547 ;; `anything-resume' resumes last `anything' session. Now you do not
548 ;; have to retype pattern.
550 ;; [EVAL IT] (describe-function 'anything-resume)
553 ;; `anything-execute-persistent-action' executes action without
554 ;; quitting `anything'. When popping up a buffer in other window by
555 ;; persistent action, you can scroll with `anything-scroll-other-window' and
556 ;; `anything-scroll-other-window-down'. See also `anything-sources' docstring.
558 ;; [EVAL IT] (describe-function 'anything-execute-persistent-action)
559 ;; [EVAL IT] (describe-variable 'anything-sources)
562 ;; `anything-select-2nd-action', `anything-select-3rd-action' and
563 ;; `anything-select-4th-action' select other than default action
564 ;; without pressing Tab.
567 ;; Using `anything-candidate-buffer' and the candidates-in-buffer
568 ;; attribute is much faster than traditional "candidates and match"
569 ;; way. And `anything-current-buffer-is-modified' avoids to
570 ;; recalculate candidates for unmodified buffer. See docstring of
571 ;; them.
573 ;; [EVAL IT] (describe-function 'anything-candidate-buffer)
574 ;; [EVAL IT] (describe-function 'anything-candidates-in-buffer)
575 ;; [EVAL IT] (describe-function 'anything-current-buffer-is-modified)
578 ;; `anything-current-buffer' and `anything-buffer-file-name' stores
579 ;; `(current-buffer)' and `buffer-file-name' in the buffer `anything'
580 ;; is invoked. Use them freely.
582 ;; [EVAL IT] (describe-variable 'anything-current-buffer)
583 ;; [EVAL IT] (describe-variable 'anything-buffer-file-name)
586 ;; `anything-completing-read' and `anything-read-file-name' are
587 ;; experimental implementation. If you are curious, type M-x
588 ;; anything-read-string-mode. It is a minor mode and toggles on/off.
591 ;; Use `anything-test-candidates' to test your handmade anything
592 ;; sources. It simulates contents of *anything* buffer with pseudo
593 ;; `anything-sources' and `anything-pattern', without side-effect. So
594 ;; you can unit-test your anything sources! Let's TDD!
596 ;; [EVAL IT] (describe-function 'anything-test-candidates)
598 ;; For anything developpers:
600 ;; There are many unit-testing framework in Emacs Lisp. See the EmacsWiki.
601 ;; http://www.emacswiki.org/cgi-bin/emacs/UnitTesting
602 ;; There is an unit-test by Emacs Lisp Expectations in developper-tools directory.
603 ;; http://www.emacswiki.org/cgi-bin/wiki/download/el-expectations.el
604 ;; http://www.emacswiki.org/cgi-bin/wiki/download/el-mock.el
607 ;; If you want to create anything sources, see anything-config.el.
608 ;; It is huge collection of sources. You can learn from examples.
611 ;; (@* "TODO")
613 ;; - process status indication
615 ;; - async sources doesn't honor digit-shortcut-count
617 ;; - anything-candidate-number-limit can't be nil everywhere
619 ;; (@* "HISTORY")
621 ;; Change log of this file is found at
622 ;; http://repo.or.cz/w/anything-config.git/history/master:/anything.el
624 ;; Change log of this project is found at
625 ;; http://repo.or.cz/w/anything-config.git?a=shortlog
627 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
630 ;;; Code:
632 (require 'cl)
634 (defvar anything-version "1.3.9")
636 ;; (@* "User Configuration")
639 ;;; Variables
642 ;; [DEPRECATED]
643 ;; A default value is provided in anything-config.el
644 (defvar anything-sources nil
645 "A list of sources to use with `anything'.
646 It is deprecated, you should not use this.
647 Use instead individual sources or list of sources of your choice.")
649 ;; Default values are provided in anything-config.el.
650 (defvar anything-type-attributes nil
651 "It's a list of \(TYPE ATTRIBUTES ...\).
652 ATTRIBUTES are the same as attributes for `anything-sources'.
653 TYPE connects the value to the appropriate sources.
654 Don't set this directly, use instead `define-anything-type-attribute'.
656 This allows specifying common attributes for several sources.
657 For example, sources which provide files can specify
658 common attributes with a `file' type.")
660 (defvaralias 'anything-enable-digit-shortcuts 'anything-enable-shortcuts
661 "Same as `anything-enable-shortcuts'.
662 Alphabet shortcuts are available now in `anything-enable-shortcuts'.
663 `anything-enable-digit-shortcuts' is retained for compatibility.")
665 (defvar anything-enable-shortcuts nil
666 "*Whether to use digit/alphabet shortcut to select the first nine matches.
667 If t then they can be selected using Ctrl+<number>.
669 If 'prefix then they can be selected using <prefix-key> <alnum>.
670 The prefix key is `anything-select-with-prefix-shortcut'.
671 If the <prefix-key> is a letter, pressing twice inputs the letter itself.
672 e.g.
673 (setq anything-enable-shortcuts 'prefix)
674 (define-key anything-map \"@\" 'anything-select-with-prefix-shortcut)
676 If 'alphabet then they can be selected using Shift+<alphabet> (deprecated).
677 It is not recommended because you cannot input capital letters in pattern.
679 Keys (digit/alphabet) are listed in `anything-shortcut-keys-alist'.")
681 (defvar anything-shortcut-keys-alist
682 '((alphabet . "asdfghjklzxcvbnmqwertyuiop")
683 (prefix . "asdfghjklzxcvbnmqwertyuiop1234567890")
684 (t . "123456789")))
686 (defvar anything-display-source-at-screen-top t
687 "*Display candidates at the top of screen.
688 This happen when using `anything-next-source' and `anything-previous-source'.")
690 (defvar anything-candidate-number-limit 50
691 "*Limit candidate number globally.
692 Do not show more candidates than this limit from individual sources.
693 It is usually pointless to show hundreds of matches
694 when the pattern is empty, because it is much simpler to type a
695 few characters to narrow down the list of potential candidates.
697 Set it to nil if you don't want this limit.")
699 (defvar anything-idle-delay 0.3
700 "*Be idle for this many seconds, before updating in delayed sources.
701 This is useful for sources involving heavy operations
702 \(like launching external programs\), so that candidates
703 from the source are not retrieved unnecessarily if the user keeps typing.
705 It also can be used to declutter the results anything displays,
706 so that results from certain sources are not shown with every
707 character typed, only if the user hesitates a bit.")
709 (defvar anything-input-idle-delay 0.3
710 "Be idle for this many seconds, before updating.
712 Unlike `anything-idle-delay', it is also effective for non-delayed sources.
713 If nil, candidates are collected immediately.
715 Note: If this value is too low compared to `anything-idle-delay',
716 you may have duplicated sources when using multiples sources.
717 Safe value is always >= `anything-idle-delay'.
718 Default settings are equal value for both.")
720 (defvar anything-samewindow nil
721 "Use current window to show the candidates.
722 If t then Anything doesn't pop up a new window.")
724 (defvar anything-source-filter nil
725 "A list of source names to be displayed.
726 Other sources won't appear in the search results.
727 If nil then there is no filtering.
728 See also `anything-set-source-filter'.")
731 (defvar anything-map
732 (let ((map (copy-keymap minibuffer-local-map)))
733 (define-key map (kbd "<down>") 'anything-next-line)
734 (define-key map (kbd "<up>") 'anything-previous-line)
735 (define-key map (kbd "C-n") 'anything-next-line)
736 (define-key map (kbd "C-p") 'anything-previous-line)
737 (define-key map (kbd "<prior>") 'anything-previous-page)
738 (define-key map (kbd "<next>") 'anything-next-page)
739 (define-key map (kbd "M-v") 'anything-previous-page)
740 (define-key map (kbd "C-v") 'anything-next-page)
741 (define-key map (kbd "M-<") 'anything-beginning-of-buffer)
742 (define-key map (kbd "M->") 'anything-end-of-buffer)
743 (define-key map (kbd "C-g") 'anything-keyboard-quit)
744 (define-key map (kbd "<right>") 'anything-next-source)
745 (define-key map (kbd "<left>") 'anything-previous-source)
746 (define-key map (kbd "<RET>") 'anything-exit-minibuffer)
747 (define-key map (kbd "C-1") 'anything-select-with-digit-shortcut)
748 (define-key map (kbd "C-2") 'anything-select-with-digit-shortcut)
749 (define-key map (kbd "C-3") 'anything-select-with-digit-shortcut)
750 (define-key map (kbd "C-4") 'anything-select-with-digit-shortcut)
751 (define-key map (kbd "C-5") 'anything-select-with-digit-shortcut)
752 (define-key map (kbd "C-6") 'anything-select-with-digit-shortcut)
753 (define-key map (kbd "C-7") 'anything-select-with-digit-shortcut)
754 (define-key map (kbd "C-8") 'anything-select-with-digit-shortcut)
755 (define-key map (kbd "C-9") 'anything-select-with-digit-shortcut)
756 (loop for c from ?A to ?Z do
757 (define-key map (make-string 1 c) 'anything-select-with-digit-shortcut))
758 (define-key map (kbd "C-i") 'anything-select-action)
759 (define-key map (kbd "C-z") 'anything-execute-persistent-action)
760 (define-key map (kbd "C-e") 'anything-select-2nd-action-or-end-of-line)
761 (define-key map (kbd "C-j") 'anything-select-3rd-action)
762 (define-key map (kbd "C-o") 'anything-next-source)
763 (define-key map (kbd "C-M-v") 'anything-scroll-other-window)
764 (define-key map (kbd "M-<next>") 'anything-scroll-other-window)
765 (define-key map (kbd "C-M-y") 'anything-scroll-other-window-down)
766 (define-key map (kbd "C-M-S-v") 'anything-scroll-other-window-down)
767 (define-key map (kbd "M-<prior>") 'anything-scroll-other-window-down)
768 (define-key map (kbd "<C-M-down>") 'anything-scroll-other-window)
769 (define-key map (kbd "<C-M-up>") 'anything-scroll-other-window-down)
770 (define-key map (kbd "C-SPC") 'anything-toggle-visible-mark)
771 (define-key map (kbd "M-SPC") 'anything-toggle-visible-mark)
772 (define-key map (kbd "M-[") 'anything-prev-visible-mark)
773 (define-key map (kbd "M-]") 'anything-next-visible-mark)
774 (define-key map (kbd "C-k") 'anything-delete-minibuffer-contents)
776 (define-key map (kbd "C-r") 'undefined)
777 (define-key map (kbd "C-t") 'anything-toggle-resplit-window)
778 (define-key map (kbd "C-}") 'anything-narrow-window)
779 (define-key map (kbd "C-{") 'anything-enlarge-window)
781 (define-key map (kbd "C-c C-d") 'anything-delete-current-selection)
782 (define-key map (kbd "C-c C-y") 'anything-yank-selection)
783 (define-key map (kbd "C-c C-k") 'anything-kill-selection-and-quit)
784 (define-key map (kbd "C-c C-f") 'anything-follow-mode)
785 (define-key map (kbd "C-c C-u") 'anything-force-update)
786 (define-key map (kbd "M-p") 'previous-history-element)
787 (define-key map (kbd "M-n") 'next-history-element)
788 (define-key map (kbd "M-a") 'anything-mark-all)
789 ;; Debugging command
790 (define-key map "\C-c\C-x\C-d" 'anything-debug-output)
791 (define-key map "\C-c\C-x\C-m" 'anything-display-all-visible-marks)
792 (define-key map "\C-c\C-x\C-b" 'anything-send-bug-report-from-anything)
793 ;; Use `describe-mode' key in `global-map'.
794 (define-key map [f1] nil) ; Allow to eval keymap whithout errors.
795 (dolist (k (where-is-internal 'describe-mode global-map))
796 (define-key map k 'anything-help))
797 map)
798 "Keymap for anything.")
801 (defgroup anything nil
802 "Open anything."
803 :prefix "anything-" :group 'convenience)
805 (defface anything-header
806 '((t (:inherit header-line)))
807 "Face for header lines in the anything buffer."
808 :group 'anything)
810 (defvar anything-header-face 'anything-header
811 "*Face for header lines in the anything buffer.")
813 (defface anything-candidate-number
814 '((t (:background "Yellow" :foreground "black")))
815 "Face for candidate number in mode-line." :group 'anything)
817 (defvar anything-selection-face 'highlight
818 "*Face for currently selected item.")
820 (defvar anything-buffer "*anything*"
821 "Buffer showing completions.")
823 (defvar anything-action-buffer "*anything action*"
824 "Buffer showing actions.")
826 (defvar anything-selection-overlay nil
827 "Overlay used to highlight the currently selected item.")
829 (defvar anything-digit-overlays nil
830 "Overlays for digit shortcuts. See `anything-enable-shortcuts'.")
832 (defvar anything-candidate-cache nil
833 "Holds the available candidate withing a single anything invocation.")
835 (defvar anything-pattern
836 "The input pattern used to update the anything buffer.")
838 (defvar anything-input
839 "The input typed in the candidates panel.")
841 (defvar anything-async-processes nil
842 "List of information about asynchronous processes managed by anything.")
844 (defvar anything-digit-shortcut-count 0
845 "Number of digit shortcuts shown in the anything buffer.")
847 (defvar anything-before-initialize-hook nil
848 "Run before anything initialization.
849 This hook is run before init functions in `anything-sources'.")
851 (defvar anything-after-initialize-hook nil
852 "Run after anything initialization.
853 Global variables are initialized and the anything buffer is created.
854 But the anything buffer has no contents.")
856 (defvar anything-update-hook nil
857 "Run after the anything buffer was updated according the new input pattern.
858 This hook is run at the beginning of buffer.
859 The first candidate is selected after running this hook.
860 See also `anything-after-update-hook'.")
862 (defvar anything-after-update-hook nil
863 "Run after the anything buffer was updated according the new input pattern.
864 This is very similar to `anything-update-hook' but selection is not moved.
865 It is useful to select a particular object instead of the first one.")
867 (defvar anything-cleanup-hook nil
868 "Run after anything minibuffer is closed.
869 IOW this hook is executed BEFORE performing action.")
871 (defvar anything-select-action-hook nil
872 "Run when opening the action buffer.")
874 (defvar anything-before-action-hook nil
875 "Run before executing action.
876 Contrarily to `anything-cleanup-hook',
877 this hook run before anything minibuffer is closed
878 and before performing action.")
880 (defvar anything-after-action-hook nil
881 "Run after executing action.")
883 (defvar anything-after-persistent-action-hook nil
884 "Run after executing persistent action.")
886 (defvar anything-move-selection-before-hook nil
887 "Run before moving selection in `anything-buffer'.")
889 (defvar anything-move-selection-after-hook nil
890 "Run after moving selection in `anything-buffer'.")
892 (defvar anything-restored-variables
893 '(anything-candidate-number-limit
894 anything-source-filter
895 anything-source-in-each-line-flag
896 anything-map
897 anything-sources)
898 "Variables which are restored after `anything' invocation.")
900 (defvar anything-saved-selection nil
901 "Value of the currently selected object when the action list is shown.")
903 (defvar anything-current-prefix-arg nil
904 "Record `current-prefix-arg' when exiting minibuffer.")
906 (defvar anything-candidate-separator
907 "--------------------"
908 "Candidates separator of `multiline' source.")
910 (defvar anything-current-buffer nil
911 "Current buffer when `anything' is invoked.")
913 (defvar anything-buffer-file-name nil
914 "Variable `buffer-file-name' when `anything' is invoked.")
916 (defvar anything-saved-action nil
917 "Saved value of the currently selected action by key.")
919 (defvar anything-last-sources nil
920 "OBSOLETE!! Sources of previously invoked `anything'.")
922 (defvar anything-saved-current-source nil
923 "Value of the current source when the action list is shown.")
925 (defvar anything-compiled-sources nil
926 "Compiled version of `anything-sources'.")
928 (defvar anything-in-persistent-action nil
929 "Flag whether in persistent-action or not.")
931 (defvar anything-quick-update nil
932 "If non-nil, suppress displaying sources which are out of screen at first.
933 They are treated as delayed sources at this input.
934 This flag makes `anything' a bit faster with many sources.")
936 (defvar anything-last-sources-local nil
937 "Buffer local value of `anything-sources'.")
939 (defvar anything-last-buffer nil
940 "`anything-buffer' of previously `anything' session.")
942 (defvar anything-save-configuration-functions
943 '(set-window-configuration . current-window-configuration)
944 "The functions used to restore/save window or frame configurations.
945 It is a pair where the car is the function to restore window or frame config,
946 and the cdr is the function to save the window or frame config.
948 If you want to save and restore frame configuration, set this variable to
949 '\(set-frame-configuration . current-frame-configuration\)
951 Older version saves/restores frame configuration, but the default is changed now
952 because flickering can occur in some environment. ")
954 (defvar anything-persistent-action-use-special-display nil
955 "If non-nil, use `special-display-function' in persistent action.")
957 (defvar anything-execute-action-at-once-if-one nil
958 "Execute default action and exit when only one candidate is remaining.
959 It is useful for `anything' applications.")
961 (defvar anything-quit-if-no-candidate nil
962 "Quit when there is no candidates when non--nil.
963 This variable accepts a function, which is executed if no candidate.
965 It is useful for `anything' applications.")
967 (defvar anything-scroll-amount nil
968 "Scroll amount when scrolling other window in an anything session.
969 It is used by `anything-scroll-other-window'
970 and `anything-scroll-other-window-down'.
972 If you prefer scrolling line by line, set this value to 1.")
974 (defvar anything-display-function 'anything-default-display-buffer
975 "Function to display *anything* buffer.
976 It is `anything-default-display-buffer' by default,
977 which affects `anything-samewindow'.")
979 (defvar anything-delayed-init-executed nil)
981 (defvar anything-mode-line-string nil
982 "Help string displayed in mode-line in `anything'.
983 It can be a string or a list of two args, in this case,
984 first arg is a string that will be used as name for candidates number,
985 second arg any string to display in mode line.
986 If nil, use default `mode-line-format'.")
988 (defvar anything-help-message
989 "\\<anything-map>The keys that are defined for `anything' are:
990 \\{anything-map}"
991 "Detailed help message string for `anything'.
992 It also accepts function or variable symbol.")
994 (defvar anything-source-in-each-line-flag nil
995 "Non-nil means add anything-source text-property in each candidate.
996 experimental feature.")
998 (defvaralias 'anything-debug-variables 'anything-debug-forms)
1000 (defvar anything-debug-forms nil
1001 "Forms to show in `anything-debug-output'.
1002 Otherwise all variables started with `anything-' are shown.
1003 It is useful for debug.")
1005 (defvar anything-debug nil
1006 "If non-nil, write log message into *Anything Log* buffer.
1007 If `debug-on-error' is non-nil, write log message regardless of this variable.
1008 It is disabled by default because *Anything Log* grows quickly.")
1010 (defcustom anything-local-map-override-anything-map t
1011 "Override `anything-map' keys with the corresponding ones in source local map.
1012 When non--nil keys in source local map will override same keys in `anything-map'
1013 otherwise same keys in `anything-map' will take precedence."
1014 :group 'anything
1015 :type 'boolean)
1018 ;; (@* "Internal Variables")
1019 (defvar anything-test-candidate-list nil)
1020 (defvar anything-test-mode nil)
1021 (defvar anything-source-name nil)
1022 (defvar anything-candidate-buffer-alist nil)
1023 (defvar anything-check-minibuffer-input-timer nil)
1024 (defvar anything-match-hash (make-hash-table :test 'equal))
1025 (defvar anything-cib-hash (make-hash-table :test 'equal))
1026 (defvar anything-tick-hash (make-hash-table :test 'equal))
1027 (defvar anything-issued-errors nil)
1028 (defvar anything-shortcut-keys nil)
1029 (defvar anything-once-called-functions nil)
1030 (defvar anything-follow-mode nil)
1031 (defvar anything-let-variables nil)
1032 (defvar anything-split-window-state nil)
1033 (defvar anything-selection-point nil)
1034 (defvar anything-alive-p nil)
1037 ;; (@* "Utility: logging")
1038 (defun anything-log (format-string &rest args)
1039 "Log message if `debug-on-error' or `anything-debug' is non-nil.
1040 Messages are written to the *Anything Log* buffer.
1042 Argument FORMAT-STRING is a string to use with `format'.
1043 Use optional arguments ARGS like in `format'."
1044 (when (or debug-on-error anything-debug)
1045 (with-current-buffer (get-buffer-create "*Anything Log*")
1046 (buffer-disable-undo)
1047 (set (make-local-variable 'inhibit-read-only) t)
1048 (goto-char (point-max))
1049 (insert (let ((tm (current-time)))
1050 (format "%s.%06d (%s) %s\n"
1051 (format-time-string "%H:%M:%S" tm)
1052 (nth 2 tm)
1053 (anything-log-get-current-function)
1054 (apply #'format (cons format-string args))))))))
1056 (defmacro anything-log-eval (&rest exprs)
1057 "Write each EXPRS evaluation result to the *Anything Log* buffer."
1058 `(anything-log-eval-internal ',exprs))
1060 (defun anything-log-run-hook (hook)
1061 "Run HOOK like `run-hooks' but write these actions to anything log buffer."
1062 (anything-log "executing %s" hook)
1063 (when (boundp hook)
1064 (anything-log-eval (symbol-value hook))
1065 (anything-log-eval (default-value hook)))
1066 (run-hooks hook)
1067 (anything-log "executed %s" hook))
1069 (defun anything-log-eval-internal (exprs)
1070 "Eval EXPRS and write results to anything log buffer."
1071 (dolist (expr exprs)
1072 (condition-case err
1073 (anything-log "%S = %S" expr (eval expr))
1074 (error (anything-log "%S = ERROR!" expr)))))
1076 (defun anything-log-get-current-function ()
1077 "Get function name calling `anything-log'.
1078 The original idea is from `tramp-debug-message'."
1079 (loop with exclude-func-re = "^anything-\\(?:interpret\\|log\\|.*funcall\\)"
1080 for btn from 1 to 40 ;avoid inf-loop
1081 for btf = (second (backtrace-frame btn))
1082 for fn = (if (symbolp btf) (symbol-name btf) "")
1083 if (and (string-match "^anything" fn)
1084 (not (string-match exclude-func-re fn)))
1085 return fn))
1087 (defun anything-log-error (&rest args)
1088 "Accumulate error messages into `anything-issued-errors'.
1089 ARGS are args given to `format'."
1090 (apply 'anything-log (concat "ERROR: " (car args)) (cdr args))
1091 (let ((msg (apply 'format args)))
1092 (unless (member msg anything-issued-errors)
1093 (add-to-list 'anything-issued-errors msg))))
1095 (defvar anything-last-log-file nil)
1096 (defun anything-log-save-maybe ()
1097 "May be save log buffer to `anything-last-log-file'."
1098 (when (stringp anything-debug)
1099 (let ((logdir (expand-file-name (format-time-string "%Y%m%d")
1100 anything-debug)))
1101 (make-directory logdir t)
1102 (with-current-buffer (get-buffer-create "*Anything Log*")
1103 (write-region (point-min) (point-max)
1104 (setq anything-last-log-file
1105 (expand-file-name (format-time-string "%Y%m%d-%H%M%S")
1106 logdir))
1107 nil 'silent)
1108 (erase-buffer)))))
1110 (defun anything-open-last-log ()
1111 "Open anything log file of last anything session."
1112 (interactive)
1113 (if anything-last-log-file
1114 (view-file anything-last-log-file)
1115 (switch-to-buffer "*Anything Log*")))
1117 (defun anything-print-error-messages ()
1118 "Print error messages in `anything-issued-errors'."
1119 (message "%s" (mapconcat 'identity (reverse anything-issued-errors) "\n")))
1121 ;; (anything-log "test")
1122 ;; (switch-to-buffer-other-window "*Anything Log*")
1125 ;; (@* "Programming Tools")
1126 (defmacro anything-aif (test-form then-form &rest else-forms)
1127 "Like `if' but set the result of TEST-FORM in a temprary variable called `it'.
1128 THEN-FORM and ELSE-FORMS are then excuted just like in `if'."
1129 (declare (indent 2) (debug t))
1130 `(let ((it ,test-form))
1131 (if it ,then-form ,@else-forms)))
1133 (defun anything-mklist (obj)
1134 "If OBJ is a list \(but not lambda\), return itself.
1135 Otherwise make a list with one element."
1136 (if (and (listp obj) (not (functionp obj)))
1138 (list obj)))
1141 ;; (@* "Anything API")
1143 (defun anything-buffer-get ()
1144 "Return `anything-action-buffer' if shown otherwise `anything-buffer'."
1145 (if (anything-action-window)
1146 anything-action-buffer
1147 anything-buffer))
1149 (defun anything-window ()
1150 "Window of `anything-buffer'."
1151 (get-buffer-window (anything-buffer-get) 'visible))
1153 (defun anything-action-window ()
1154 "Window of `anything-action-buffer'."
1155 (get-buffer-window anything-action-buffer 'visible))
1157 (defmacro with-anything-window (&rest body)
1158 "Be sure BODY is excuted in the anything window."
1159 (declare (indent 0) (debug t))
1160 `(if anything-test-mode
1161 (with-current-buffer (anything-buffer-get)
1162 ,@body)
1163 (with-selected-window (anything-window)
1164 ,@body)))
1166 (defmacro with-anything-current-buffer (&rest body)
1167 "Eval BODY inside `anything-current-buffer'."
1168 (declare (indent 0) (debug t))
1169 `(with-current-buffer anything-current-buffer
1170 ,@body))
1172 (defmacro with-anything-restore-variables(&rest body)
1173 "Restore `anything-restored-variables' after executing BODY.
1174 `post-command-hook' is handled specially."
1175 (declare (indent 0) (debug t))
1176 `(let ((--orig-vars (delq nil
1177 (mapcar (lambda (v)
1178 (and (boundp v) (cons v (symbol-value v))))
1179 (append (mapcar 'car anything-let-variables)
1180 anything-restored-variables))))
1181 (--post-command-hook-pair (cons post-command-hook
1182 (default-value 'post-command-hook))))
1183 (setq post-command-hook '(t))
1184 (setq-default post-command-hook nil)
1185 (unwind-protect (progn ,@body)
1186 (loop for (var . value) in --orig-vars
1187 do (set var value))
1188 (setq post-command-hook (car --post-command-hook-pair))
1189 (setq-default post-command-hook (cdr --post-command-hook-pair))
1190 (anything-log "restore variables"))))
1192 (defun* anything-attr (attribute-name &optional
1193 (src (anything-get-current-source)))
1194 "Get the value of ATTRIBUTE-NAME of SRC.
1195 if SRC is omitted, use current source.
1196 It is useful to write your sources."
1197 (anything-aif (assq attribute-name src)
1198 (cdr it)))
1200 (defun* anything-attr* (attribute-name
1201 &optional (src (anything-get-current-source)))
1202 "Pass the value of ATTRIBUTE-NAME of SRC to `anything-interpret-value'.
1203 if SRC is omitted, use current source.
1204 It is useful to write your sources."
1205 (anything-interpret-value (anything-attr attribute-name src)))
1207 (defun* anything-attr-defined (attribute-name
1208 &optional (src (anything-get-current-source)))
1209 "Return non-nil if ATTRIBUTE-NAME of SRC is defined.
1210 if SRC is omitted, use current source.
1211 It is useful to write your sources."
1212 (and (assq attribute-name src) t))
1214 (defun* anything-attrset (attribute-name value
1215 &optional
1216 (src (anything-get-current-source)))
1217 "Set the value of ATTRIBUTE-NAME of SRC to VALUE.
1218 if SRC is omitted, use current source.
1219 It is useful to write your sources."
1220 (anything-aif (assq attribute-name src)
1221 (setcdr it value)
1222 (setcdr src (cons (cons attribute-name value) (cdr src))))
1223 value)
1225 (defun anything-set-source-filter (sources)
1226 "Set the value of `anything-source-filter' to SOURCES and update.
1228 This function sets a filter for anything sources and it may be
1229 called while anything is running. It can be used to toggle
1230 displaying of sources dinamically. For example, additional keys
1231 can be bound into `anything-map' to display only the file-related
1232 results if there are too many matches from other sources and
1233 you're after files only:
1235 Shift+F shows only file results from some sources:
1237 \(define-key anything-map \"F\" 'anything-my-show-files-only)
1239 \(defun anything-my-show-files-only ()
1240 (interactive)
1241 (anything-set-source-filter '(\"File Name History\"
1242 \"Files from Current Directory\")))
1244 Shift+A shows all results:
1246 \(define-key anything-map \"A\" 'anything-my-show-all)
1248 \(defun anything-my-show-all ()
1249 (interactive)
1250 (anything-set-source-filter nil))
1252 Note that you have to prefix the functions with anything- prefix,
1253 otherwise they won't be bound when Anything is used under
1254 Iswitchb. The -my- part is added to avoid collisions with
1255 existing Anything function names."
1256 (unless (and (listp sources)
1257 (loop for name in sources always (stringp name)))
1258 (error "Invalid data in `anything-set-source-filter': %S" sources))
1259 (setq anything-source-filter sources)
1260 (anything-log-eval anything-source-filter)
1261 (anything-update))
1263 (defun anything-set-sources (sources &optional no-init no-update)
1264 "Set SOURCES during `anything' invocation.
1265 If NO-INIT is non-nil, skip executing init functions of SOURCES.
1266 If NO-UPDATE is non-nil, skip executing `anything-update'."
1267 (with-current-buffer anything-buffer
1268 (setq anything-compiled-sources nil
1269 anything-sources sources
1270 anything-last-sources-local sources)
1271 (anything-log-eval anything-compiled-sources anything-sources))
1272 (unless no-init (anything-funcall-foreach 'init))
1273 (unless no-update (anything-update)))
1275 (defvar anything-compile-source-functions
1276 '(anything-compile-source--type
1277 anything-compile-source--dummy
1278 anything-compile-source--disable-shortcuts
1279 anything-compile-source--candidates-in-buffer)
1280 "Functions to compile elements of `anything-sources' (plug-in).")
1282 (defun anything-get-sources ()
1283 "Return compiled `anything-sources', which is memoized.
1285 Attributes:
1287 - type
1288 `anything-type-attributes' are merged in.
1289 - candidates-buffer
1290 candidates, volatile and match attribute are created."
1291 (cond
1292 ;; action
1293 ((anything-action-window)
1294 anything-sources)
1295 ;; memoized
1296 (anything-compiled-sources)
1297 ;; first time
1299 (prog1
1300 (setq anything-compiled-sources
1301 (anything-compile-sources
1302 anything-sources anything-compile-source-functions))
1303 (anything-log-eval anything-compiled-sources)))))
1305 (defun* anything-get-selection (&optional (buffer nil buffer-s)
1306 force-display-part)
1307 "Return the currently selected item or nil.
1308 if BUFFER is nil or unspecified, use anything-buffer as default value.
1309 If FORCE-DISPLAY-PART is non-nil, return the display string.
1310 If FORCE-DISPLAY-PART value is 'withprop the display string is returned
1311 with its properties."
1312 (setq buffer (if (and buffer buffer-s) buffer anything-buffer))
1313 (unless (anything-empty-buffer-p buffer)
1314 (with-current-buffer buffer
1315 (let* ((disp-fn (if (eq force-display-part 'withprop)
1316 'buffer-substring
1317 'buffer-substring-no-properties))
1318 (selection
1319 (or (and (not force-display-part)
1320 (get-text-property (overlay-start
1321 anything-selection-overlay)
1322 'anything-realvalue))
1323 ;; It is needed to return properties of DISP in some case,
1324 ;; e.g for `anything-confirm-and-exit-minibuffer',
1325 ;; so use `buffer-substring' here when 'withprop is specified.
1326 (let ((disp (funcall disp-fn
1327 (overlay-start anything-selection-overlay)
1328 (1- (overlay-end anything-selection-overlay))))
1329 (source (anything-get-current-source)))
1330 (anything-aif (and (not force-display-part)
1331 (assoc-default 'display-to-real source))
1332 (anything-funcall-with-source source it disp)
1333 disp)))))
1334 (unless (equal selection "")
1335 (anything-log-eval selection)
1336 selection)))))
1338 (defun anything-get-action ()
1339 "Return the associated action for the selected candidate.
1340 It is a function symbol \(sole action\) or list
1341 of \(action-display . function\)."
1342 (unless (anything-empty-buffer-p (anything-buffer-get))
1343 (anything-aif (anything-attr 'action-transformer)
1344 (anything-composed-funcall-with-source
1345 (anything-get-current-source) it
1346 (anything-attr 'action) (anything-get-selection))
1347 (anything-attr 'action))))
1349 (defun anything-get-current-source ()
1350 "Return the source for the current selection.
1351 Use it in init, candidates, action, candidate-transformer,
1352 filtered-candidate-transformer functions."
1353 (declare (special source))
1354 ;; The name `anything-get-current-source' should be used in init function etc.
1355 (cond ((and (boundp 'anything-source-name) (stringp anything-source-name))
1356 source)
1357 ((get-buffer (anything-buffer-get))
1358 (with-current-buffer (anything-buffer-get)
1360 ;; This happen only when `anything-source-in-each-line-flag'
1361 ;; is non--nil and there is candidates in buffer.
1362 (get-text-property (point) 'anything-source)
1363 ;; Return nil when no--candidates.
1364 (block exit
1365 ;; This goto-char shouldn't be necessary, but point is moved to
1366 ;; point-min somewhere else which shouldn't happen.
1367 (goto-char (overlay-start anything-selection-overlay))
1368 (let* ((header-pos (or (anything-get-previous-header-pos)
1369 (anything-get-next-header-pos)))
1370 (source-name
1371 (save-excursion
1372 (unless header-pos
1373 (return-from exit nil))
1374 (goto-char header-pos)
1375 (anything-current-line-contents))))
1376 (loop for source in (anything-get-sources) thereis
1377 (and (equal (assoc-default 'name source) source-name)
1378 source)))))))))
1380 (defun anything-buffer-is-modified (buffer)
1381 "Return non-nil when BUFFER is modified since `anything' was invoked."
1382 (let* ((b (get-buffer buffer))
1383 (key (concat (buffer-name b) "/" (anything-attr 'name)))
1384 (source-tick (or (gethash key anything-tick-hash) 0))
1385 (buffer-tick (buffer-chars-modified-tick b))
1386 (modifiedp (/= source-tick buffer-tick)))
1387 (puthash key buffer-tick anything-tick-hash)
1388 (anything-log-eval buffer modifiedp)
1389 modifiedp))
1391 (defun anything-current-buffer-is-modified ()
1392 "Check if `anything-current-buffer' is modified since `anything' was invoked."
1393 (anything-buffer-is-modified anything-current-buffer))
1395 (defvar anything-quit nil)
1396 (defun anything-run-after-quit (function &rest args)
1397 "Perform an action after quitting `anything'.
1398 The action is to call FUNCTION with arguments ARGS."
1399 (setq anything-quit t)
1400 (anything-kill-async-processes)
1401 (anything-log-eval function args)
1402 (apply 'run-with-idle-timer 0 nil function args)
1403 (anything-exit-minibuffer))
1406 (defun define-anything-type-attribute (type definition &optional doc)
1407 "Register type attribute of TYPE as DEFINITION with DOC.
1408 DOC is displayed in `anything-type-attributes' docstring.
1410 Use this function is better than setting `anything-type-attributes' directly."
1411 (loop for i in definition do
1412 ;; without `ignore-errors', error at emacs22
1413 (ignore-errors (setf i (delete nil i))))
1414 (anything-add-type-attribute type definition)
1415 (and doc (anything-document-type-attribute type doc))
1416 nil)
1418 (defvaralias 'anything-attributes 'anything-additional-attributes)
1419 (defvar anything-additional-attributes nil
1420 "List of all `anything' attributes.")
1422 (defun anything-document-attribute (attribute short-doc &optional long-doc)
1423 "Register ATTRIBUTE documentation introduced by plug-in.
1424 SHORT-DOC is displayed beside attribute name.
1425 LONG-DOC is displayed below attribute name and short documentation."
1426 (if long-doc
1427 (setq short-doc (concat "(" short-doc ")"))
1428 (setq long-doc short-doc
1429 short-doc ""))
1430 (add-to-list 'anything-additional-attributes attribute t)
1431 (put attribute 'anything-attrdoc
1432 (concat "- " (symbol-name attribute)
1433 " " short-doc "\n\n" long-doc "\n")))
1435 (put 'anything-document-attribute 'lisp-indent-function 2)
1437 (defun anything-interpret-value (value &optional source)
1438 "Interpret VALUE as variable, function or literal.
1439 If VALUE is a function, call it with no arguments and return the value.
1440 If SOURCE is `anything' source, `anything-source-name' is source name.
1442 If VALUE is a variable, return the value.
1444 If VALUE is a symbol, but it is not a function or a variable, cause an error.
1446 Otherwise, return VALUE itself."
1447 (cond ((and source (functionp value))
1448 (anything-funcall-with-source source value))
1449 ((functionp value)
1450 (funcall value))
1451 ((and (symbolp value) (boundp value))
1452 (symbol-value value))
1453 ((symbolp value)
1454 (error "anything-interpret-value: Symbol must be a function or a variable"))
1456 value)))
1458 (defun anything-once (function &rest args)
1459 "Ensure FUNCTION with ARGS to be called once in `anything' session."
1460 (let ((spec (cons function args)))
1461 (unless (member spec anything-once-called-functions)
1462 (apply function args)
1463 (push spec anything-once-called-functions))))
1466 ;; (@* "Core: API helper")
1467 (defun* anything-empty-buffer-p (&optional (buffer anything-buffer))
1468 "Check if BUFFER have candidates.
1469 Default value for BUFFER is `anything-buffer'."
1470 (zerop (buffer-size (and buffer (get-buffer buffer)))))
1472 (defun anything-let-eval-varlist (varlist)
1473 "Return the list of pairs VARLIST with each cdr of pair evaluated.
1474 If VARLIST contain single elements, those are returned
1475 as a list of one element."
1476 (mapcar (lambda (pair)
1477 (if (listp pair)
1478 (cons (car pair) (eval (cadr pair)))
1479 (cons pair nil)))
1480 varlist))
1482 ;; [NOT USED]
1483 ;; (defun anything-let*-eval-varlist (varlist)
1484 ;; (let ((vars (mapcar (lambda (pair)
1485 ;; (or (car-safe pair) pair))
1486 ;; varlist)))
1487 ;; (eval `(let ,vars
1488 ;; ,@(mapcar (lambda (pair)
1489 ;; (if (listp pair)
1490 ;; `(setq ,(car pair) ,(cadr pair))
1491 ;; `(setq ,pair nil)))
1492 ;; varlist)
1493 ;; (mapcar (lambda (v)
1494 ;; (cons v (symbol-value v)))
1495 ;; ',vars)))))
1497 (defun anything-let-internal (binding bodyfunc)
1498 "Set BINDING to anything buffer-local variables and Evaluate BODYFUNC.
1499 BINDING is a list of \(VARNAME . VALUE\) pair."
1500 (setq anything-let-variables binding)
1501 (unwind-protect
1502 (funcall bodyfunc)
1503 (setq anything-let-variables nil)))
1506 ;; (@* "Core: tools")
1507 (defun anything-current-line-contents ()
1508 "Current line string without properties."
1509 (buffer-substring-no-properties (point-at-bol) (point-at-eol)))
1511 (defun anything-funcall-with-source (source func &rest args)
1512 "Call from SOURCE FUNC list or single function FUNC with ARGS.
1513 FUNC can be a symbol or a list of functions.
1514 Return the result of last function call."
1515 (let ((anything-source-name (assoc-default 'name source))
1516 result)
1517 (anything-log-eval anything-source-name func args)
1518 (dolist (func (if (functionp func) (list func) func) result)
1519 (setq result (apply func args)))))
1521 (defun anything-funcall-foreach (sym)
1522 "Call the function SYM for each source if any."
1523 (dolist (source (anything-get-sources))
1524 (anything-aif (assoc-default sym source)
1525 (anything-funcall-with-source source it))))
1527 (defun anything-normalize-sources (sources)
1528 "If SOURCES is only one source, make a list of one element."
1529 (cond ((or (and sources
1530 (symbolp sources))
1531 (and (listp sources) (assq 'name sources)))
1532 (list sources))
1533 (sources)
1534 (t anything-sources)))
1536 (defun anything-approximate-candidate-number (&optional in-current-source)
1537 "Return approximate number of candidates in `anything-buffer'.
1538 If IN-CURRENT-SOURCE is provided return number of candidates
1539 in the source where point is.
1540 It is used to check if candidate number is 0, 1, or 2+."
1541 (with-current-buffer anything-buffer
1542 (save-excursion
1543 (if in-current-source
1544 (goto-char (anything-get-previous-header-pos))
1545 (goto-char (point-min)))
1546 (forward-line 1)
1547 (let ((count-multi 1))
1548 (if (anything-pos-multiline-p)
1549 (save-excursion
1550 (loop while (and (not (if in-current-source
1551 (save-excursion
1552 (forward-line 2)
1553 (or (anything-pos-header-line-p) (eobp)))
1554 (eobp)))
1555 (search-forward anything-candidate-separator nil t))
1556 do (incf count-multi)
1557 finally return count-multi))
1558 (save-excursion
1559 (loop with ln = 0
1560 while (not (if in-current-source
1561 (or (anything-pos-header-line-p) (eobp))
1562 (eobp)))
1563 unless (anything-pos-header-line-p)
1564 do (incf ln)
1565 do (forward-line 1) finally return ln)))))))
1567 (defmacro with-anything-quittable (&rest body)
1568 "If an error occur in execution of BODY, quit anything safely."
1569 (declare (indent 0) (debug t))
1570 `(let (inhibit-quit)
1571 (condition-case v
1572 (progn ,@body)
1573 (quit (setq anything-quit t)
1574 (exit-minibuffer)
1575 (keyboard-quit)))))
1577 (defun anything-compose (arg-lst func-lst)
1578 "Apply arguments specified in ARG-LST with each function of FUNC-LST.
1579 The result of each function will be the new `car' of ARG-LST.
1581 This function allows easy sequencing of transformer functions."
1582 (dolist (func func-lst)
1583 (setcar arg-lst (apply func arg-lst)))
1584 (car arg-lst))
1586 (defun anything-composed-funcall-with-source (source funcs &rest args)
1587 "With SOURCE apply `anything-funcall-with-source' with each FUNCS and ARGS.
1588 This is used in transformers to modify candidates list."
1589 (if (functionp funcs)
1590 (apply 'anything-funcall-with-source source funcs args)
1591 (apply 'anything-funcall-with-source source
1592 (lambda (&rest args)
1593 (anything-compose args funcs))
1594 args)))
1596 (defun anything-new-timer (variable timer)
1597 "Give VARIABLE value to TIMER and cancel old timer."
1598 (anything-aif (symbol-value variable)
1599 (cancel-timer it))
1600 (set variable timer))
1603 ;; (@* "Core: entry point")
1604 (defconst anything-argument-keys
1605 '(:sources :input :prompt :resume :preselect :buffer :keymap :default :history))
1607 ;;;###autoload
1608 (defun anything (&rest plist)
1609 "Main function to execute anything sources.
1611 Keywords supported:
1612 :sources :input :prompt :resume :preselect :buffer :keymap :default :history
1613 Extra keywords are supported and can be added, see below.
1615 When call interactively with no arguments deprecated `anything-sources'
1616 will be used if non--nil.
1618 PLIST is a list like \(:key1 val1 :key2 val2 ...\) or
1619 \(&optional sources input prompt resume preselect buffer keymap default history\).
1621 Basic keywords are the following:
1623 \:sources
1625 Temporary value of `anything-sources'. It also accepts a
1626 symbol, interpreted as a variable of an anything source. It
1627 also accepts an alist representing an anything source, which is
1628 detected by \(assq 'name ANY-SOURCES\)
1630 \:input
1632 Temporary value of `anything-pattern', ie. initial input of minibuffer.
1634 \:prompt
1636 Prompt other than \"pattern: \".
1638 \:resume
1640 If t, Resurrect previously instance of `anything'. Skip the initialization.
1641 If 'noresume, this instance of `anything' cannot be resumed.
1643 \:preselect
1645 Initially selected candidate. Specified by exact candidate or a regexp.
1647 \:buffer
1649 `anything-buffer' instead of *anything*.
1651 \:keymap
1653 `anything-map' for current `anything' session.
1655 \:default
1657 A default argument that will be inserted in minibuffer \
1658 with \\<minibuffer-local-map>\\[next-history-element].
1659 When nil of not present `thing-at-point' will be used instead.
1661 \:history
1663 By default all minibuffer input is pushed to `minibuffer-history',
1664 if an argument HISTORY is provided, input will be pushed to HISTORY.
1665 History element should be a symbol.
1667 Of course, conventional arguments are supported, the two are same.
1669 \(anything :sources sources :input input :prompt prompt :resume resume
1670 :preselect preselect :buffer buffer :keymap keymap :default default
1671 :history history\)
1672 \(anything sources input prompt resume preselect buffer keymap default history\)
1674 Other keywords are interpreted as local variables of this anything session.
1675 The `anything-' prefix can be omitted. For example,
1677 \(anything :sources 'anything-c-source-buffers
1678 :buffer \"*buffers*\" :candidate-number-limit 10\)
1680 means starting anything session with `anything-c-source-buffers'
1681 source in *buffers* buffer and set variable `anything-candidate-number-limit'
1682 to 10 as session local variable."
1683 (interactive)
1684 (if (keywordp (car plist))
1685 (anything-let-internal
1686 (anything-parse-keys plist)
1687 (lambda ()
1688 (apply 'anything
1689 (mapcar (lambda (key) (plist-get plist key))
1690 anything-argument-keys))))
1691 (apply 'anything-internal plist)))
1693 (defun anything-parse-keys (keys)
1694 "Parse the KEYS arguments of `anything'.
1695 Return only the keys that are not in `anything-argument-keys'.
1696 It is used to set local variables via `anything-let-internal'.
1697 This allow to add arguments that are not part of `anything-argument-keys',
1698 but are valid anything attributes.
1699 i.e :candidate-number-limit will be bound to `anything-candidate-number-limit'
1700 in source.
1701 But the variable is bound, use it.
1703 (anything-parse-keys '(:sources ((name . \"test\")
1704 (candidates . (a b c)))
1705 :buffer \"toto\"
1706 :truncate-lines t
1707 :anything-enable-shortcuts t
1708 :candidate-number-limit 4))
1709 => ((truncate-lines . t)
1710 (anything-enable-shortcuts . t)
1711 (anything-candidate-number-limit . 4))
1713 (loop for (key value) on keys by #'cddr
1714 for symname = (substring (symbol-name key) 1)
1715 for origsym = (intern symname)
1716 for sym = (if (boundp origsym)
1717 origsym
1718 (intern (if (string-match "^anything-" symname)
1719 symname
1720 (concat "anything-" symname))))
1721 unless (memq key anything-argument-keys)
1722 collect (cons sym value)))
1724 ;;; (@* "Core: entry point helper")
1725 (defun anything-internal (&optional
1726 any-sources any-input
1727 any-prompt any-resume
1728 any-preselect any-buffer
1729 any-keymap any-default any-history)
1730 "The internal anything function called by `anything'.
1731 For ANY-SOURCES ANY-INPUT ANY-PROMPT ANY-RESUME ANY-PRESELECT ANY-BUFFER and
1732 ANY-KEYMAP ANY-DEFAULT ANY-HISTORY See `anything'."
1733 (anything-log (concat "[Start session] " (make-string 41 ?+)))
1734 (anything-log-eval any-prompt any-preselect
1735 any-buffer any-keymap any-default)
1736 (let ((old-overridding-local-map overriding-local-map))
1737 (unwind-protect
1738 (condition-case v
1739 (let ( ;; It is needed because `anything-source-name' is non-nil
1740 ;; when `anything' is invoked by action. Awful global scope.
1741 anything-source-name
1742 anything-in-persistent-action
1743 anything-quit
1744 ;; [2012-10-16] move to `anything-update' to show right value of `case-fold-search'
1745 ;; (case-fold-search t)
1746 (anything-buffer (or any-buffer anything-buffer))
1747 ;; cua-mode ; avoid error when region is selected
1749 (with-anything-restore-variables
1750 (anything-initialize any-resume any-input any-sources)
1751 (anything-display-buffer anything-buffer)
1752 (anything-set-margin)
1753 (anything-log "show prompt")
1754 (unwind-protect
1755 (anything-read-pattern-maybe
1756 any-prompt any-input any-preselect
1757 any-resume any-keymap any-default
1758 (when (and any-history (symbolp any-history)) any-history))
1759 (anything-cleanup)))
1760 (prog1 (unless anything-quit
1761 (anything-execute-selection-action-1))
1762 (anything-log (concat "[End session] " (make-string 41 ?-)))))
1763 (quit
1764 (anything-restore-position-on-quit)
1765 (anything-log (concat "[End session (quit)] " (make-string 34 ?-)))
1766 nil))
1767 (setq overriding-local-map old-overridding-local-map)
1768 (anything-log-save-maybe))))
1771 ;;; Anything resume
1774 (defun* anything-resume (&optional
1775 (any-buffer anything-last-buffer)
1776 buffer-pattern (any-resume t))
1777 "Resurrect previously invoked `anything'.
1778 Called with a prefix arg, allow choosing among all existing
1779 anything buffers. i.e choose among various anything sessions."
1780 (interactive)
1781 (when (or current-prefix-arg buffer-pattern)
1782 (setq any-buffer (anything-resume-select-buffer buffer-pattern)))
1783 (setq anything-compiled-sources nil)
1784 (anything
1785 :sources (or (buffer-local-value 'anything-last-sources-local (get-buffer any-buffer))
1786 anything-last-sources anything-sources)
1787 :input (buffer-local-value 'anything-input-local (get-buffer any-buffer))
1788 :resume any-resume
1789 :buffer any-buffer))
1791 ;;; rubikitch: experimental
1792 ;;; I use this and check it whether I am convenient.
1793 ;;; I may introduce an option to control the behavior.
1794 (defun* anything-resume-window-only (&optional
1795 (any-buffer anything-last-buffer)
1796 buffer-pattern)
1797 (interactive)
1798 (anything-resume any-buffer buffer-pattern 'window-only))
1800 (defun anything-resume-p (any-resume)
1801 "Whether current anything session is resumed or not.
1802 Just check if ANY-RESUME value is t or window-only."
1803 (memq any-resume '(t window-only)))
1805 (defun anything-resume-select-buffer (input)
1806 "Resume precedent anything session with initial input INPUT."
1807 (or (anything :sources '(((name . "Resume anything buffer")
1808 (candidates . anything-buffers)
1809 (action . identity)))
1810 :input input
1811 :resume 'noresume
1812 :buffer "*anything resume*")
1813 (keyboard-quit)))
1816 ;;;###autoload
1817 (defun anything-at-point (&optional
1818 any-sources any-input
1819 any-prompt any-resume
1820 any-preselect any-buffer)
1821 "Call anything with symbol at point as initial input.
1822 ANY-SOURCES ANY-INPUT ANY-PROMPT ANY-RESUME ANY-PRESELECT and ANY-BUFFER
1823 are same args as in `anything'."
1824 (interactive)
1825 (anything :sources any-sources
1826 :input (if current-prefix-arg
1827 (concat "\\b" (thing-at-point 'symbol) "\\b"
1828 (if (featurep 'anything-match-plugin) " " ""))
1829 any-input)
1830 :prompt any-prompt
1831 :resume any-resume
1832 :preselect any-preselect
1833 :buffer any-buffer))
1835 ;;;###autoload
1836 (defun anything-other-buffer (any-sources any-buffer)
1837 "Simplified interface of `anything' with other `anything-buffer'.
1838 Call `anything' with only ANY-SOURCES and ANY-BUFFER as args."
1839 (anything :sources any-sources :buffer any-buffer))
1841 (defvar anything-last-frame-or-window-configuration nil)
1843 (defun anything-nest (&rest same-as-anything)
1844 "Allow calling `anything' whithin a running anything session."
1845 (with-anything-window
1846 (let (anything-current-position
1847 anything-current-buffer
1848 (orig-anything-current-buffer anything-current-buffer)
1849 (orig-anything-buffer anything-buffer)
1850 (orig-anything-last-frame-or-window-configuration
1851 anything-last-frame-or-window-configuration)
1852 anything-pattern
1853 (anything-buffer (or (getf same-as-anything :buffer)
1854 (nth 5 same-as-anything)
1855 "*Anything*"))
1856 anything-sources
1857 anything-compiled-sources
1858 (anything-samewindow t)
1859 (enable-recursive-minibuffers t))
1860 (unwind-protect
1861 (apply #'anything same-as-anything)
1862 (with-current-buffer orig-anything-buffer
1863 (anything-initialize-overlays orig-anything-buffer)
1864 (setq anything-buffer (current-buffer))
1865 (anything-mark-current-line)
1866 (setq anything-last-frame-or-window-configuration
1867 orig-anything-last-frame-or-window-configuration)
1868 (setq cursor-type t)
1869 (setq anything-current-buffer orig-anything-current-buffer))))))
1872 ;;; Initialize
1875 (defvar anything-buffers nil
1876 "All of `anything-buffer' in most recently used order.")
1877 (defvar anything-shortcut-update-timer nil)
1879 (defun anything-initialize (any-resume any-input any-sources)
1880 "Start initialization of `anything' session.
1881 For ANY-RESUME ANY-INPUT and ANY-SOURCES See `anything'."
1882 (anything-log "start initialization: any-resume=%S any-input=%S" any-resume any-input)
1883 (when anything-enable-shortcuts
1884 (anything-new-timer
1885 'anything-shortcut-update-timer
1886 (run-with-idle-timer 0.03 0.03 'anything-move-digit-overlay-maybe)))
1887 (loop for (var . val) in anything-let-variables
1888 do (set var val))
1889 (anything-frame-or-window-configuration 'save)
1890 (setq anything-sources (anything-normalize-sources any-sources))
1891 (anything-log "sources = %S" anything-sources)
1892 (anything-hooks 'setup)
1893 (anything-current-position 'save)
1894 (if (anything-resume-p any-resume)
1895 (anything-initialize-overlays (anything-buffer-get))
1896 (anything-initial-setup))
1897 (unless (eq any-resume 'noresume)
1898 (anything-recent-push anything-buffer 'anything-buffers)
1899 (setq anything-last-buffer anything-buffer))
1900 (when any-input (setq anything-input any-input anything-pattern any-input))
1901 (and (anything-resume-p any-resume) (anything-funcall-foreach 'resume))
1902 (anything-log "end initialization"))
1904 (defun anything-execute-selection-action-1 ()
1905 "Execute current action."
1906 (anything-log-run-hook 'anything-before-action-hook)
1907 (unwind-protect
1908 (anything-execute-selection-action)
1909 (anything-aif (get-buffer anything-action-buffer)
1910 (kill-buffer it))
1911 (anything-log-run-hook 'anything-after-action-hook)))
1913 (defun anything-restore-position-on-quit ()
1914 "Restore position in `anything-current-buffer' when quitting."
1915 (anything-current-position 'restore))
1917 (defun anything-recent-push (elt list-var)
1918 "Add ELT to the value of LIST-VAR as most recently used value."
1919 (let ((m (member elt (symbol-value list-var))))
1920 (and m (set list-var (delq (car m) (symbol-value list-var))))
1921 (push elt (symbol-value list-var))))
1924 ;;; (@* "Core: Accessors")
1925 ;;; rubikitch: I love to create functions to control variables.
1926 (defvar anything-current-position nil
1927 "Cons of \(point . window-start\) when `anything' is invoked.
1928 It is needed to restore position in `anything-current-buffer'
1929 when `anything' is keyboard-quitted.")
1930 (defun anything-current-position (save-or-restore)
1931 "Restore or save current position in `anything-current-buffer'.
1932 Argument SAVE-OR-RESTORE is one of save or restore."
1933 (case save-or-restore
1934 (save
1935 (anything-log "Save position at %S" (cons (point) (window-start)))
1936 (setq anything-current-position (cons (point) (window-start))))
1937 (restore
1938 (anything-log "Restore position at %S in buffer %s"
1939 anything-current-position
1940 (buffer-name (current-buffer)))
1941 (goto-char (car anything-current-position))
1942 ;; Fix this position with the NOFORCE arg of `set-window-start'
1943 ;; otherwise, if there is some other buffer than `anything-current-buffer'
1944 ;; one, position will be lost.
1945 (set-window-start (selected-window) (cdr anything-current-position) t))))
1948 ;; Internal.
1949 (defvar anything-last-frame-or-window-configuration nil
1950 "Used to store window or frame configuration when anything start.")
1951 (defun anything-frame-or-window-configuration (save-or-restore)
1952 "Save or restore last frame or window configuration.
1953 Possible value of SAVE-OR-RESTORE are 'save and 'restore.
1954 window or frame configuration is saved/restored according to values of
1955 `anything-save-configuration-functions'."
1956 (anything-log-eval anything-save-configuration-functions)
1957 (case save-or-restore
1958 (save (setq anything-last-frame-or-window-configuration
1959 (funcall (cdr anything-save-configuration-functions))))
1960 (restore (funcall (car anything-save-configuration-functions)
1961 anything-last-frame-or-window-configuration)
1962 ;; Restore frame focus.
1963 (let ((frame (and (listp anything-last-frame-or-window-configuration)
1964 (caadr anything-last-frame-or-window-configuration))))
1965 ;; If `anything-save-configuration-functions' are window functions
1966 ;; frame should be nil, use current frame.
1967 (unless (framep frame)
1968 (setq frame (selected-frame)))
1969 (select-frame-set-input-focus frame)))))
1972 ;; (@* "Core: Display *anything* buffer")
1973 (defun anything-display-buffer (buf)
1974 "Display *anything* buffer BUF."
1975 (let (pop-up-frames)
1976 (funcall (with-current-buffer buf anything-display-function) buf)))
1978 (defun anything-default-display-buffer (buf)
1979 "Default function to display BUF.
1980 Where BUF is generally `anything-buffer'.
1981 It use `switch-to-buffer' or `pop-to-buffer' depending of value of
1982 `anything-samewindow'."
1983 (funcall (if anything-samewindow 'switch-to-buffer 'pop-to-buffer) buf))
1986 ;; (@* "Core: initialize")
1987 (defun anything-initial-setup ()
1988 "Initialize anything settings and set up the anything buffer."
1989 (anything-log-run-hook 'anything-before-initialize-hook)
1990 (setq anything-current-prefix-arg nil)
1991 (setq anything-once-called-functions nil)
1992 (setq anything-delayed-init-executed nil)
1993 (setq anything-alive-p t)
1994 (setq anything-current-buffer
1995 (if (minibuffer-window-active-p (minibuffer-window))
1996 ;; If minibuffer is active be sure to use it's buffer
1997 ;; as `anything-current-buffer'.
1998 (window-buffer (active-minibuffer-window))
1999 (current-buffer)))
2000 (setq anything-buffer-file-name buffer-file-name)
2001 (setq anything-issued-errors nil)
2002 (setq anything-compiled-sources nil)
2003 (setq anything-saved-current-source nil)
2004 (if (or (not (boundp 'split-width-threshold))
2005 (not split-width-threshold)
2006 (and (integerp split-width-threshold)
2007 (>= split-width-threshold (+ (frame-width) 4))))
2008 (setq anything-split-window-state 'vertical)
2009 (setq anything-split-window-state 'horizontal))
2010 ;; Call the init function for sources where appropriate
2011 (anything-funcall-foreach 'init)
2012 (setq anything-pattern "")
2013 (setq anything-input "")
2014 (setq anything-candidate-cache nil)
2015 (setq anything-last-sources anything-sources)
2016 (anything-create-anything-buffer)
2017 (anything-log-run-hook 'anything-after-initialize-hook))
2019 (defvar anything-reading-pattern nil
2020 "Whether in `read-string' in anything or not.")
2022 (defun anything-read-pattern-maybe (any-prompt any-input
2023 any-preselect any-resume any-keymap
2024 any-default any-history)
2025 "Read pattern with prompt ANY-PROMPT and initial input ANY-INPUT.
2026 For ANY-PRESELECT ANY-RESUME ANY-KEYMAP, See `anything'."
2027 (if (anything-resume-p any-resume)
2028 (anything-mark-current-line t)
2029 (anything-update any-preselect))
2030 (with-current-buffer (anything-buffer-get)
2031 (let ((src-keymap (assoc-default 'keymap (anything-get-current-source))))
2032 ;; Startup with the first keymap found either in current source
2033 ;; or anything arg, otherwise use global value of `anything-map'.
2034 ;; This map will be used as a `minibuffer-local-map'.
2035 ;; Maybe it will be overriden when changing source
2036 ;; by `anything-maybe-update-keymap'.
2037 (unless anything-local-map-override-anything-map
2038 (anything-aif (or src-keymap any-keymap)
2039 (ignore-errors
2040 (set-keymap-parent it anything-map))))
2041 (set (make-local-variable 'anything-map)
2042 (or src-keymap any-keymap anything-map))
2043 (anything-log-eval (anything-approximate-candidate-number)
2044 anything-execute-action-at-once-if-one
2045 anything-quit-if-no-candidate)
2046 (cond ((and anything-execute-action-at-once-if-one
2047 (= (anything-approximate-candidate-number) 1))
2048 (ignore))
2049 ((and anything-quit-if-no-candidate
2050 (= (anything-approximate-candidate-number) 0))
2051 (setq anything-quit t)
2052 (and (functionp anything-quit-if-no-candidate)
2053 (funcall anything-quit-if-no-candidate)))
2055 (let ((anything-reading-pattern t)
2056 (tap (or any-default
2057 (with-anything-current-buffer
2058 (thing-at-point 'symbol)))))
2059 (read-from-minibuffer (or any-prompt "pattern: ")
2060 any-input anything-map
2061 nil any-history tap)))))))
2063 (defun anything-maybe-update-keymap ()
2064 "Handle differents keymaps in multiples sources.
2065 This function is meant to be run in `anything-move-selection-after-hook'.
2066 It will override `anything-map' with the keymap attribute of current source
2067 if some when multiples sources are present."
2068 (with-anything-window
2069 (let ((kmap (assoc-default 'keymap (anything-get-current-source))))
2070 (when kmap
2071 (and (not anything-local-map-override-anything-map)
2072 (ignore-errors (set-keymap-parent kmap (default-value 'anything-map))))
2073 (setq overriding-local-map kmap)))))
2074 (add-hook 'anything-move-selection-after-hook 'anything-maybe-update-keymap)
2076 (defun anything-create-anything-buffer (&optional test-mode)
2077 "Create newly created `anything-buffer'.
2078 If TEST-MODE is non-nil, clear `anything-candidate-cache'."
2079 (when test-mode
2080 (setq anything-candidate-cache nil))
2081 (with-current-buffer (get-buffer-create anything-buffer)
2082 (anything-log "kill local variables: %S" (buffer-local-variables))
2083 (kill-all-local-variables)
2084 (set (make-local-variable 'inhibit-read-only) t)
2085 (buffer-disable-undo)
2086 (erase-buffer)
2087 (set (make-local-variable 'inhibit-read-only) t)
2088 (set (make-local-variable 'anything-last-sources-local) anything-sources)
2089 (set (make-local-variable 'anything-follow-mode) nil)
2090 (set (make-local-variable 'anything-display-function) anything-display-function)
2091 (set (make-local-variable 'anything-selection-point) nil)
2092 (anything-initialize-persistent-action)
2093 (anything-log-eval anything-display-function anything-let-variables)
2094 (loop for (var . val) in anything-let-variables
2095 do (set (make-local-variable var) val))
2096 (setq cursor-type nil)
2097 (setq mode-name "Anything"))
2098 (anything-initialize-overlays anything-buffer)
2099 (get-buffer anything-buffer))
2101 (defun anything-initialize-overlays (buffer)
2102 "Initialize anything overlays in BUFFER."
2103 (anything-log "overlay setup")
2104 (if anything-selection-overlay
2105 ;; make sure the overlay belongs to the anything buffer if
2106 ;; it's newly created
2107 (move-overlay anything-selection-overlay (point-min) (point-min)
2108 (get-buffer buffer))
2110 (setq anything-selection-overlay
2111 (make-overlay (point-min) (point-min) (get-buffer buffer)))
2112 (overlay-put anything-selection-overlay 'face anything-selection-face))
2114 (cond (anything-enable-shortcuts
2115 (setq anything-shortcut-keys
2116 (assoc-default anything-enable-shortcuts anything-shortcut-keys-alist))
2117 (unless anything-digit-overlays
2118 (setq anything-digit-overlays
2119 (loop for key across anything-shortcut-keys
2120 for overlay = (make-overlay (point-min) (point-min)
2121 (get-buffer buffer))
2122 do (overlay-put overlay 'before-string
2123 (propertize " " 'display
2124 `((margin left-margin) ,(upcase (make-string 1 key)))))
2125 collect overlay)))
2127 (anything-digit-overlays
2128 (mapc 'delete-overlay anything-digit-overlays)
2129 (setq anything-digit-overlays nil))))
2131 (defun anything-set-margin ()
2132 (when anything-enable-shortcuts
2133 (set-window-margins (get-buffer-window anything-buffer) 1)))
2135 (defun anything-hooks (setup-or-cleanup)
2136 "Add or remove hooks according to SETUP-OR-CLEANUP value.
2137 if SETUP-OR-CLEANUP value is setup add hooks, any other value
2138 will remove hooks.
2139 hooks concerned are `post-command-hook' and `minibuffer-setup-hook'."
2140 (let ((hooks '((post-command-hook anything-check-minibuffer-input)
2141 (minibuffer-setup-hook anything-print-error-messages))))
2142 (if (eq setup-or-cleanup 'setup)
2143 (dolist (args hooks) (apply 'add-hook args))
2144 (dolist (args (reverse hooks)) (apply 'remove-hook args)))))
2147 ;; (@* "Core: clean up")
2148 ;;; TODO move
2149 (defun anything-cleanup ()
2150 "Clean up the mess when anything exit or quit."
2151 (anything-log "start cleanup")
2152 (with-current-buffer anything-buffer
2153 ;; rubikitch: I think it is not needed.
2154 ;; thierry: If you end up for any reasons (error etc...)
2155 ;; with an anything-buffer staying around (visible),
2156 ;; You will have no cursor in this buffer when switching to it,
2157 ;; so I think this is needed.
2158 (setq cursor-type t)
2159 ;; Call burry-buffer whithout arg
2160 ;; to be sure anything-buffer is removed from window.
2161 (bury-buffer)
2162 ;; Be sure we call this from anything-buffer.
2163 (anything-funcall-foreach 'cleanup))
2164 (anything-new-timer 'anything-shortcut-update-timer nil)
2165 (anything-new-timer 'anything-check-minibuffer-input-timer nil)
2166 (anything-kill-async-processes)
2167 (anything-log-run-hook 'anything-cleanup-hook)
2168 (anything-hooks 'cleanup)
2169 (anything-frame-or-window-configuration 'restore)
2170 (setq anything-alive-p nil)
2171 ;; This is needed in some cases where last input
2172 ;; is yielded infinitely in minibuffer after anything session.
2173 (anything-clean-up-minibuffer))
2175 (defun anything-clean-up-minibuffer ()
2176 "Remove contents of minibuffer."
2177 (let ((miniwin (minibuffer-window)))
2178 ;; Clean only current minibuffer used by anything.
2179 ;; i.e The precedent one is active.
2180 (unless (minibuffer-window-active-p miniwin)
2181 (with-current-buffer (window-buffer miniwin)
2182 (delete-minibuffer-contents)))))
2185 ;; (@* "Core: input handling")
2186 (defun anything-check-minibuffer-input ()
2187 "Extract input string from the minibuffer and check if it needs to be handled."
2188 (when anything-reading-pattern
2189 (let ((delay (with-current-buffer anything-buffer
2190 (and anything-input-idle-delay
2191 (max anything-input-idle-delay 0.1)))))
2192 (if (or (not delay) (anything-action-window))
2193 (anything-check-minibuffer-input-1)
2194 (anything-new-timer
2195 'anything-check-minibuffer-input-timer
2196 (run-with-idle-timer delay nil 'anything-check-minibuffer-input-1))))))
2198 (defun anything-check-minibuffer-input-1 ()
2199 "Check minibuffer content."
2200 (with-anything-quittable
2201 (with-selected-window (or (active-minibuffer-window) (minibuffer-window))
2202 (anything-check-new-input (minibuffer-contents)))))
2204 (defun anything-check-new-input (input)
2205 "Check INPUT string and update the anything buffer if necessary."
2206 (unless (equal input anything-pattern)
2207 (setq anything-pattern input)
2208 (unless (anything-action-window)
2209 (setq anything-input anything-pattern))
2210 (anything-log-eval anything-pattern anything-input)
2211 (anything-update)))
2214 ;; (@* "Core: source compiler")
2215 (defvar anything-compile-source-functions-default anything-compile-source-functions
2216 "Plug-ins this file provides.")
2217 (defun anything-compile-sources (sources funcs)
2218 "Compile SOURCES with FUNCS.
2219 See `anything-compile-source-functions'.
2220 Anything plug-ins are realized by this function."
2221 (mapcar
2222 (lambda (source)
2223 (loop with source = (if (listp source) source (symbol-value source))
2224 for f in funcs
2225 do (setq source (funcall f source))
2226 finally (return source)))
2227 sources))
2230 ;; (@* "Core: plug-in attribute documentation hack")
2232 ;; `anything-document-attribute' is public API.
2233 (defadvice documentation-property (after anything-document-attribute activate)
2234 "Display plug-in attributes' documentation as `anything-sources' docstring."
2235 (when (eq (ad-get-arg 0) 'anything-sources)
2236 (setq ad-return-value
2237 (concat ad-return-value "\n"
2238 (mapconcat (lambda (sym) (get sym 'anything-attrdoc))
2239 anything-additional-attributes
2240 "\n")))))
2241 ;; (describe-variable 'anything-sources)
2242 ;; (documentation-property 'anything-sources 'variable-documentation)
2243 ;; (progn (ad-disable-advice 'documentation-property 'after 'anything-document-attribute) (ad-update 'documentation-property))
2246 ;; (@* "Core: all candidates")
2247 (defun anything-process-delayed-init (source)
2248 "Initialize delayed SOURCE."
2249 (let ((name (assoc-default 'name source)))
2250 (unless (member name anything-delayed-init-executed)
2251 (anything-aif (assoc-default 'delayed-init source)
2252 (with-current-buffer anything-current-buffer
2253 (anything-funcall-with-source source it)
2254 (dolist (f (if (functionp it) (list it) it))
2255 (add-to-list 'anything-delayed-init-executed name)))))))
2257 (defun anything-get-candidates (source)
2258 "Retrieve and return the list of candidates from SOURCE."
2259 (anything-process-delayed-init source)
2260 (let* ((candidate-source (assoc-default 'candidates source))
2261 (type-error (lambda ()
2262 (error (concat "Candidates must either be a function, "
2263 " a variable or a list: %s")
2264 candidate-source)))
2265 (candidates (condition-case err
2266 (anything-interpret-value candidate-source source)
2267 (error (funcall type-error)))))
2268 (cond ((processp candidates) candidates)
2269 ((listp candidates) (anything-transform-candidates candidates source))
2270 (t (funcall type-error)))))
2273 (defun anything-get-cached-candidates (source)
2274 "Return the cached value of candidates for SOURCE.
2275 Cache the candidates if there is not yet a cached value."
2276 (let* ((name (assoc-default 'name source))
2277 (candidate-cache (assoc name anything-candidate-cache)))
2278 (cond (candidate-cache
2279 (anything-log "use cached candidates")
2280 (cdr candidate-cache))
2282 (anything-log "calculate candidates")
2283 (let ((candidates (anything-get-candidates source)))
2284 (cond ((processp candidates)
2285 (push (cons candidates
2286 (append source
2287 (list (cons 'item-count 0)
2288 (cons 'incomplete-line ""))))
2289 anything-async-processes)
2290 (set-process-filter candidates 'anything-output-filter)
2291 (setq candidates nil))
2292 ((not (assoc 'volatile source))
2293 (setq candidate-cache (cons name candidates))
2294 (push candidate-cache anything-candidate-cache)))
2295 candidates)))))
2298 ;;; (@* "Core: candidate transformers")
2299 (defun anything-transform-mapcar (function args)
2300 "`mapcar' for candidate-transformer.
2302 ARGS is (cand1 cand2 ...) or ((disp1 . real1) (disp2 . real2) ...)
2304 \(anything-transform-mapcar 'upcase '(\"foo\" \"bar\"))
2305 => (\"FOO\" \"BAR\")
2306 \(anything-transform-mapcar 'upcase '((\"1st\" . \"foo\") (\"2nd\" . \"bar\")))
2307 => ((\"1st\" . \"FOO\") (\"2nd\" . \"BAR\"))
2309 (loop for arg in args
2310 if (consp arg)
2311 collect (cons (car arg) (funcall function (cdr arg)))
2312 else
2313 collect (funcall function arg)))
2315 (defun anything-process-candidate-transformer (candidates source)
2316 "Execute candidate-transformer function on all CANDIDATES of SOURCE."
2317 (anything-aif (assoc-default 'candidate-transformer source)
2318 (anything-composed-funcall-with-source source it candidates)
2319 candidates))
2321 (defun anything-process-filtered-candidate-transformer (candidates source)
2322 "Execute filtered-candidate-transformer function on all CANDIDATES of SOURCE."
2323 (anything-aif (assoc-default 'filtered-candidate-transformer source)
2324 (anything-composed-funcall-with-source source it candidates source)
2325 candidates))
2327 (defun anything-process-filtered-candidate-transformer-maybe (candidates source process-p)
2328 "Execute filtered-candidate-transformer function on all CANDIDATES of SOURCE.
2329 This happen if PROCESS-P is non-nil."
2330 (if process-p
2331 (anything-process-filtered-candidate-transformer candidates source)
2332 candidates))
2334 (defun anything-process-real-to-display (candidates source)
2335 "Execute real-to-display function on all CANDIDATES of SOURCE."
2336 (anything-aif (assoc-default 'real-to-display source)
2337 (setq candidates (anything-funcall-with-source
2338 source 'mapcar
2339 (lambda (cand_)
2340 (if (consp cand_)
2341 ;; override DISPLAY from candidate-transformer
2342 (cons (funcall it (cdr cand_)) (cdr cand_))
2343 (cons (funcall it cand_) cand_)))
2344 candidates))
2345 candidates))
2347 (defun anything-transform-candidates (candidates source &optional process-p)
2348 "Transform CANDIDATES of SOURCE according to candidate transformers.
2349 This happen if PROCESS-P is non-nil."
2350 (anything-process-real-to-display
2351 (anything-process-filtered-candidate-transformer-maybe
2352 (anything-process-candidate-transformer candidates source) source process-p)
2353 source))
2356 ;; (@* "Core: narrowing candidates")
2357 (defun anything-candidate-number-limit (source)
2358 "Apply candidate-number-limit attribute value.
2359 This overhide variable `anything-candidate-number-limit'.
2361 e.g:
2362 If \(candidate-number-limit\) is in SOURCE, show all candidates in SOURCE.
2363 If \(candidate-number-limit . 123\) is in SOURCE limit candidate to 123."
2364 (anything-aif (assq 'candidate-number-limit source)
2365 (or (cdr it) 99999999)
2366 (or anything-candidate-number-limit 99999999)))
2368 ;; FIXME: Why a defconst here
2369 (defconst anything-default-match-functions
2370 (list (lambda (candidate)
2371 (string-match anything-pattern candidate)))
2372 "Default functions to match candidates according to `anything-pattern'.")
2374 (defun anything-compute-matches (source)
2375 "Compute matched results from SOURCE according to its settings."
2376 (if debug-on-error
2377 (anything-compute-matches-internal source)
2378 (condition-case v
2379 (anything-compute-matches-internal source)
2380 (error (anything-log-error
2381 "anything-compute-matches: error when processing source: %s"
2382 (assoc-default 'name source))
2383 nil))))
2385 (defun anything-candidate-get-display (candidate)
2386 "Get searched display part from CANDIDATE.
2387 CANDIDATE is a string, a symbol, or \(DISPLAY . REAL\) cons cell."
2388 (format "%s" (or (car-safe candidate) candidate)))
2390 (defun anything-process-pattern-transformer (pattern source)
2391 "Execute pattern-transformer attribute PATTERN function in SOURCE."
2392 (anything-aif (assoc-default 'pattern-transformer source)
2393 (anything-composed-funcall-with-source source it pattern)
2394 pattern))
2396 (defun anything-match-functions (source)
2397 (or (assoc-default 'match source)
2398 anything-default-match-functions))
2400 (defmacro anything-accumulate-candidates-internal (cand newmatches
2401 hash item-count limit)
2402 "Internal, add CAND into NEWMATCHES.
2403 Use HASH to uniq NEWMATCHES.
2404 Argument ITEM-COUNT count the matches.
2405 if ITEM-COUNT reaches LIMIT, exit from inner loop."
2406 `(unless (gethash ,cand ,hash)
2407 (puthash ,cand t ,hash)
2408 (push ,cand ,newmatches)
2409 (incf ,item-count)
2410 (when (= ,item-count ,limit)
2411 (setq exit t)
2412 (return))))
2414 (defun anything-take-first-elements (seq n)
2415 (if (> (length seq) n)
2416 (setq seq (subseq seq 0 n))
2417 seq))
2419 (defun anything-match-from-candidates (cands matchfns limit)
2420 (let (matches)
2421 (condition-case nil
2422 (let ((item-count 0) exit)
2423 (clrhash anything-match-hash)
2424 (dolist (match matchfns)
2425 (let (newmatches)
2426 (dolist (candidate cands)
2427 (when (funcall match (anything-candidate-get-display candidate))
2428 (anything-accumulate-candidates-internal
2429 candidate newmatches anything-match-hash item-count limit)))
2430 (setq matches (append matches (reverse newmatches)))
2431 (if exit (return)))))
2432 (invalid-regexp (setq matches nil)))
2433 matches))
2435 (defun anything-compute-matches-internal (source)
2436 (save-current-buffer
2437 (let ((matchfns (anything-match-functions source))
2438 (anything-source-name (assoc-default 'name source))
2439 (limit (anything-candidate-number-limit source))
2440 (anything-pattern (anything-process-pattern-transformer
2441 anything-pattern source)))
2442 (anything-process-filtered-candidate-transformer
2443 (if (or (equal anything-pattern "") (equal matchfns '(identity)))
2444 (anything-take-first-elements
2445 (anything-get-cached-candidates source) limit)
2446 (anything-match-from-candidates
2447 (anything-get-cached-candidates source) matchfns limit))
2448 source))))
2450 ;; (anything '(((name . "error")(candidates . (lambda () (hage))) (action . identity))))
2452 (defun anything-process-source (source)
2453 "Display matched results from SOURCE according to its settings."
2454 (anything-log-eval (assoc-default 'name source))
2455 (if (assq 'direct-insert-match source) ;experimental
2456 (anything-process-source--direct-insert-match source)
2457 (let ((matches (anything-compute-matches source)))
2458 (when matches
2459 (when anything-test-mode
2460 (setq anything-test-candidate-list
2461 `(,@anything-test-candidate-list
2462 (,(assoc-default 'name source)
2463 ,matches))))
2464 (anything-insert-header-from-source source)
2465 (if (not (assq 'multiline source))
2466 (mapc 'anything-insert-match-with-digit-overlay matches)
2467 (let ((start (point)) separate)
2468 (dolist (match matches)
2469 (if separate
2470 (anything-insert-candidate-separator)
2471 (setq separate t))
2472 (anything-insert-match-with-digit-overlay match))
2473 (put-text-property start (point) 'anything-multiline t)))))))
2475 (defun anything-insert-match-with-digit-overlay (match)
2476 (declare (special source))
2477 (anything-insert-match match 'insert source))
2479 (defun anything-put-digit-overlay-maybe ()
2480 (when (and anything-enable-shortcuts
2481 (not (eq anything-digit-shortcut-count
2482 (length anything-digit-overlays))))
2483 (move-overlay (nth anything-digit-shortcut-count
2484 anything-digit-overlays)
2485 (point-at-bol)
2486 (point-at-bol))
2487 (incf anything-digit-shortcut-count)))
2489 (defun anything-move-digit-overlay-maybe ()
2490 (with-anything-window
2491 (save-excursion
2492 (goto-char (window-start))
2493 (loop for overlay in anything-digit-overlays
2494 unless (eobp)
2496 (anything-skip-noncandidate-line 'forward)
2497 (move-overlay overlay (point-at-bol) (point-at-bol))
2498 (forward-line 1)))))
2500 (defun anything-process-source--direct-insert-match (source)
2501 "[EXPERIMENTAL] Insert candidates from `anything-candidate-buffer' in SOURCE."
2502 (anything-log-eval (assoc-default 'name source))
2503 (let ((anything-source-name (assoc-default 'name source))
2504 content-buf)
2505 (funcall (assoc-default 'candidates source))
2506 (setq content-buf (anything-candidate-buffer))
2507 (unless (anything-empty-buffer-p content-buf)
2508 (anything-insert-header-from-source source)
2509 (insert-buffer-substring content-buf)
2510 ;; TODO call anything-put-digit-overlay-maybe with loop
2513 (defun anything-process-delayed-sources (delayed-sources &optional preselect)
2514 "Process anything DELAYED-SOURCES.
2515 Move selection to string or regexp PRESELECT if non--nil.
2516 This function is called in `anything-process-delayed-sources-timer'
2517 when emacs is idle for `anything-idle-delay'."
2518 (with-anything-quittable
2519 (anything-log-eval (mapcar (lambda (s) (assoc-default 'name s)) delayed-sources))
2520 (with-current-buffer anything-buffer
2521 (save-excursion
2522 (goto-char (point-max))
2523 (mapc 'anything-process-source delayed-sources)
2524 (when (and (not (anything-empty-buffer-p))
2525 ;; No selection yet.
2526 (= (overlay-start anything-selection-overlay)
2527 (overlay-end anything-selection-overlay)))
2528 (anything-update-move-first-line 'without-hook)))
2529 (when preselect (anything-preselect preselect))
2530 (save-excursion
2531 (goto-char (point-min))
2532 (anything-log-run-hook 'anything-update-hook))
2533 (anything-log-run-hook 'anything-after-update-hook))))
2536 ;; (@* "Core: *anything* buffer contents")
2537 (defvar anything-input-local nil)
2538 (defvar anything-process-delayed-sources-timer nil)
2539 (defun anything-update (&optional preselect)
2540 "Update candidates list in `anything-buffer' according to `anything-pattern'.
2541 Argument PRESELECT is a string or regexp used to move selection to a particular
2542 place once updating is done. It should be used on single source because search
2543 is done on whole `anything-buffer' and not on current source."
2544 (anything-log "start update")
2545 (setq anything-digit-shortcut-count 0)
2546 (anything-kill-async-processes)
2547 (with-current-buffer (anything-buffer-get)
2548 (set (make-local-variable 'anything-input-local) anything-pattern)
2549 (erase-buffer)
2550 (when anything-enable-shortcuts
2551 (mapc 'delete-overlay anything-digit-overlays))
2552 (let (delayed-sources
2553 (case-fold-search t)
2554 normal-sources)
2555 (unwind-protect ; Process normal sources and store delayed one's.
2556 (setq delayed-sources
2557 (loop for source in (remove-if-not 'anything-update-source-p
2558 (anything-get-sources))
2559 if (anything-delayed-source-p source)
2560 collect source
2561 else do (progn (push source normal-sources)
2562 (anything-process-source source))))
2563 (anything-log-eval
2564 (mapcar (lambda (s) (assoc-default 'name s)) delayed-sources))
2565 (if anything-test-mode ; Need only to process sources.
2566 (mapc 'anything-process-source delayed-sources)
2567 (cond ((and preselect delayed-sources normal-sources)
2568 ;; Preselection run here when there is
2569 ;; normal AND delayed sources.
2570 (anything-log "Update preselect candidate %s" preselect)
2571 (anything-preselect preselect))
2572 (delayed-sources ; Preselection and hooks will run later.
2573 (anything-update-move-first-line 'without-hook)
2575 (t ; No delayed sources, run the hooks now.
2576 (anything-update-move-first-line)
2577 (anything-log-run-hook 'anything-after-update-hook)
2578 (when preselect
2579 (anything-log "Update preselect candidate %s" preselect)
2580 (anything-preselect preselect))))
2581 (when delayed-sources
2582 (anything-new-timer
2583 'anything-process-delayed-sources-timer
2584 (run-with-idle-timer
2585 ;; Be sure anything-idle-delay is >
2586 ;; to anything-input-idle-delay
2587 ;; otherwise use value of anything-input-idle-delay
2588 ;; or 0.1 if == to 0.
2589 (max anything-idle-delay anything-input-idle-delay 0.1) nil
2590 'anything-process-delayed-sources delayed-sources preselect))))
2591 (anything-log "end update"))))
2592 (anything-move-digit-overlay-maybe))
2594 (defun anything-update-source-p (source)
2595 "Wheter SOURCE need updating or not."
2596 (and (or (not anything-source-filter)
2597 (member (assoc-default 'name source) anything-source-filter))
2598 (>= (length anything-pattern)
2599 (anything-aif (assoc 'requires-pattern source)
2600 (or (cdr it) 1)
2601 0))))
2603 (defun anything-delayed-source-p (source)
2604 "Wheter SOURCE is a delayed source or not."
2605 (or (assoc 'delayed source)
2606 (and anything-quick-update
2607 (< (window-height (get-buffer-window (current-buffer)))
2608 (line-number-at-pos (point-max))))))
2610 (defun anything-update-move-first-line (&optional without-hook)
2611 "Goto first line of `anything-buffer'."
2612 (goto-char (point-min))
2613 (unless without-hook
2614 (save-excursion (anything-log-run-hook 'anything-update-hook)))
2615 (anything-next-line))
2617 (defun anything-force-update (&optional preselect)
2618 "Force recalculation and update of candidates.
2619 If current source has `update' attribute, a function without argument,
2620 call it before update."
2621 (interactive)
2622 (let ((source (anything-get-current-source))
2623 (selection (anything-get-selection nil t)))
2624 (when source
2625 (mapc 'anything-force-update--reinit
2626 (anything-get-sources)))
2627 (anything-update preselect)
2628 ;; If preselect arg exists, `anything-update' should
2629 ;; have moved to selection, otherwise do it now.
2630 (unless preselect
2631 (anything-keep-selection (assoc-default 'name source) selection))
2632 (with-anything-window (recenter))))
2634 (defun anything-force-update--reinit (source)
2635 "Reinit SOURCE by calling his update and/or init functions."
2636 (anything-aif (anything-funcall-with-source
2637 source 'anything-candidate-buffer)
2638 (kill-buffer it))
2639 (dolist (attr '(update init))
2640 (anything-aif (assoc-default attr source)
2641 (anything-funcall-with-source source it)))
2642 (anything-remove-candidate-cache source))
2644 (defun anything-keep-selection (source selection)
2645 "Switch to SOURCE and goto SELECTION."
2646 (when (and source selection)
2647 (with-anything-window
2648 (anything-goto-source source)
2649 (forward-char -1)
2650 (if (search-forward selection nil t)
2651 (forward-line 0)
2652 (goto-char (point-min))
2653 (forward-line 1))
2654 (anything-mark-current-line))))
2656 (defun anything-remove-candidate-cache (source)
2657 "Remove SOURCE from `anything-candidate-cache'."
2658 (setq anything-candidate-cache
2659 (delete (assoc (assoc-default 'name source)
2660 anything-candidate-cache)
2661 anything-candidate-cache)))
2663 (defun anything-insert-match (match insert-function source)
2664 "Insert MATCH into `anything-buffer' with INSERT-FUNCTION for SOURCE.
2665 If MATCH is a list then insert the string intended to appear on the display
2666 and store the real value in a text property."
2667 (let ((start (point-at-bol (point)))
2668 (dispvalue (or (car-safe match) match))
2669 (realvalue (cdr-safe match)))
2670 (setq dispvalue
2671 (cond ((symbolp dispvalue) (symbol-name dispvalue))
2672 ((numberp dispvalue) (number-to-string dispvalue))
2673 (t dispvalue)))
2674 (when (stringp dispvalue)
2675 (funcall insert-function dispvalue)
2676 ;; Some sources with candidates-in-buffer have already added
2677 ;; 'anything-realvalue property when creating candidate buffer.
2678 (unless (get-text-property start 'anything-realvalue)
2679 (and realvalue
2680 (put-text-property start (point-at-eol)
2681 'anything-realvalue realvalue)))
2682 (when anything-source-in-each-line-flag
2683 (put-text-property start (point-at-eol) 'anything-source source))
2684 (funcall insert-function "\n"))))
2686 (defun anything-insert-header-from-source (source)
2687 "Insert SOURCE name in `anything-buffer' header.
2688 Maybe insert by overlay additional info after source name if SOURCE have
2689 header-name attribute."
2690 (let ((name (assoc-default 'name source)))
2691 (anything-insert-header
2692 name
2693 (anything-aif (assoc-default 'header-name source)
2694 (anything-funcall-with-source source it name)))))
2696 (defun anything-insert-header (name &optional display-string)
2697 "Insert header of source NAME into the anything buffer.
2698 If DISPLAY-STRING is non--nil and a string, display this additional info
2699 after the source name by overlay."
2700 (unless (bobp)
2701 (let ((start (point)))
2702 (insert "\n")
2703 (put-text-property start (point) 'anything-header-separator t)))
2704 (let ((start (point)))
2705 (insert name)
2706 (put-text-property (point-at-bol)
2707 (point-at-eol) 'anything-header t)
2708 (when display-string
2709 (overlay-put (make-overlay (point-at-bol) (point-at-eol))
2710 'display display-string))
2711 (insert "\n")
2712 (put-text-property start (point) 'face anything-header-face)))
2714 (defun anything-insert-candidate-separator ()
2715 "Insert separator of candidates into the anything buffer."
2716 (insert anything-candidate-separator)
2717 (put-text-property (point-at-bol)
2718 (point-at-eol) 'anything-candidate-separator t)
2719 (insert "\n"))
2722 ;; (@* "Core: async process")
2723 (defun anything-output-filter (process string)
2724 "From PROCESS process output STRING."
2725 (anything-output-filter-1 (assoc process anything-async-processes) string))
2727 (defun anything-output-filter-1 (process-assoc string)
2728 (anything-log-eval string)
2729 (with-current-buffer anything-buffer
2730 (let ((source (cdr process-assoc)))
2731 (save-excursion
2732 (anything-aif (assoc-default 'insertion-marker source)
2733 (goto-char it)
2734 (goto-char (point-max))
2735 (anything-insert-header-from-source source)
2736 (setcdr process-assoc
2737 (append source `((insertion-marker . ,(point-marker))))))
2738 (anything-output-filter--process-source
2739 (car process-assoc) string source
2740 (anything-candidate-number-limit source))))
2741 (anything-output-filter--post-process)))
2743 (defun anything-output-filter--process-source (process string source limit)
2744 (dolist (candidate (anything-transform-candidates
2745 (anything-output-filter--collect-candidates
2746 (split-string string "\n")
2747 (assoc 'incomplete-line source))
2748 source t))
2749 (if (not (assq 'multiline source))
2750 (anything-insert-match candidate 'insert-before-markers source)
2751 (let ((start (point)))
2752 (anything-insert-candidate-separator)
2753 (anything-insert-match candidate 'insert-before-markers source)
2754 (put-text-property start (point) 'anything-multiline t)))
2755 (incf (cdr (assoc 'item-count source)))
2756 (when (>= (assoc-default 'item-count source) limit)
2757 (anything-kill-async-process process)
2758 (return))))
2760 (defun anything-output-filter--collect-candidates (lines incomplete-line-info)
2761 (anything-log-eval (cdr incomplete-line-info))
2762 (butlast
2763 (loop for line in lines collect
2764 (if (cdr incomplete-line-info)
2765 (prog1
2766 (concat (cdr incomplete-line-info) line)
2767 (setcdr incomplete-line-info nil))
2768 line)
2769 finally (setcdr incomplete-line-info line))))
2771 (defun anything-output-filter--post-process ()
2772 (anything-log-run-hook 'anything-update-hook)
2773 (anything-aif (get-buffer-window anything-buffer 'visible)
2774 (save-selected-window
2775 (select-window it)
2776 (anything-skip-noncandidate-line 'next)
2777 (anything-mark-current-line))))
2779 (defun anything-kill-async-processes ()
2780 "Kill all known asynchronous processes of `anything-async-processes'."
2781 (mapc 'anything-kill-async-process (mapcar 'car anything-async-processes))
2782 (setq anything-async-processes nil))
2784 (defun anything-kill-async-process (process)
2785 "Kill PROCESS and detach the associated functions."
2786 (set-process-filter process nil)
2787 (delete-process process))
2790 ;; (@* "Core: action")
2791 (defun anything-execute-selection-action (&optional
2792 selection action
2793 preserve-saved-action)
2794 "If a candidate SELECTION is present then perform the associated ACTION on it.
2795 If PRESERVE-SAVED-ACTION is non-nil don't save action."
2796 (anything-log "executing action")
2797 (setq action (anything-get-default-action
2798 (or action
2799 anything-saved-action
2800 (if (get-buffer anything-action-buffer)
2801 (anything-get-selection anything-action-buffer)
2802 (anything-get-action)))))
2803 (let ((source (or anything-saved-current-source
2804 (anything-get-current-source))))
2805 (setq selection (or selection
2806 (anything-get-selection)
2807 (and (assoc 'accept-empty source) "")))
2808 (unless preserve-saved-action (setq anything-saved-action nil))
2809 (if (and selection action)
2810 (anything-funcall-with-source
2811 source action
2812 (anything-coerce-selection selection source)))))
2814 (defun anything-coerce-selection (selection source)
2815 "Apply coerce attribute function to SELECTION in SOURCE.
2816 Coerce source with coerce function."
2817 (anything-aif (assoc-default 'coerce source)
2818 (anything-funcall-with-source source it selection)
2819 selection))
2821 (defun anything-get-default-action (action)
2822 "Get the first ACTION value of action list in source."
2823 (if (and (listp action) (not (functionp action)))
2824 (cdar action)
2825 action))
2827 (defun anything-select-action ()
2828 "Select an action for the currently selected candidate.
2829 If action buffer is selected, back to the anything buffer."
2830 (interactive)
2831 (anything-log-run-hook 'anything-select-action-hook)
2832 (cond ((get-buffer-window anything-action-buffer 'visible)
2833 (set-window-buffer (get-buffer-window anything-action-buffer)
2834 anything-buffer)
2835 (kill-buffer anything-action-buffer)
2836 (anything-set-pattern anything-input 'noupdate))
2838 (setq anything-saved-selection (anything-get-selection))
2839 (unless anything-saved-selection
2840 (error "Nothing is selected"))
2841 (setq anything-saved-current-source (anything-get-current-source))
2842 (let ((actions (anything-get-action)))
2843 (if (functionp actions)
2844 (message "Sole action: %s" actions)
2845 (anything-show-action-buffer actions)
2846 (anything-delete-minibuffer-contents)
2847 (setq anything-pattern 'dummy) ; so that it differs from the previous one
2848 (anything-check-minibuffer-input))))))
2850 (defun anything-show-action-buffer (actions)
2851 (with-current-buffer (get-buffer-create anything-action-buffer)
2852 (erase-buffer)
2853 (buffer-disable-undo)
2854 (set-window-buffer (get-buffer-window anything-buffer) anything-action-buffer)
2855 (set (make-local-variable 'anything-sources)
2856 `(((name . "Actions")
2857 (volatile)
2858 (candidates . ,actions)
2859 (candidate-number-limit))))
2860 (set (make-local-variable 'anything-source-filter) nil)
2861 (set (make-local-variable 'anything-selection-overlay) nil)
2862 (set (make-local-variable 'anything-digit-overlays) nil)
2863 (anything-initialize-overlays anything-action-buffer)))
2866 ;; (@* "Core: selection")
2867 (defun anything-move-selection-common (move-func unit direction)
2868 "Move the selection marker to a new position wit function MOVE-FUNC.
2869 It is determined by UNIT and DIRECTION."
2870 (unless (or (anything-empty-buffer-p (anything-buffer-get))
2871 (not (anything-window)))
2872 (with-anything-window
2873 (anything-log-run-hook 'anything-move-selection-before-hook)
2874 (funcall move-func)
2875 (anything-skip-noncandidate-line direction)
2876 (anything-display-source-at-screen-top-maybe unit)
2877 (when (anything-get-previous-header-pos)
2878 (anything-mark-current-line))
2879 (anything-display-mode-line (anything-get-current-source))
2880 (anything-log-run-hook 'anything-move-selection-after-hook))))
2882 (defun anything-display-source-at-screen-top-maybe (unit)
2883 (when (and anything-display-source-at-screen-top (eq unit 'source))
2884 (set-window-start (selected-window)
2885 (save-excursion (forward-line -1) (point)))))
2887 (defun anything-skip-noncandidate-line (direction)
2888 (anything-skip-header-and-separator-line direction)
2889 (and (bobp) (forward-line 1)) ;skip first header
2890 (and (eobp) (forward-line -1))) ;avoid last empty line
2893 (defun anything-skip-header-and-separator-line (direction)
2894 (while (and (not (bobp))
2895 (or (anything-pos-header-line-p)
2896 (anything-pos-candidate-separator-p)))
2897 (forward-line (if (and (eq direction 'previous)
2898 (not (eq (point-at-bol) (point-min))))
2899 -1 1))))
2901 (defvar anything-mode-line-string-real nil)
2902 (defun anything-display-mode-line (source)
2903 (set (make-local-variable 'anything-mode-line-string)
2904 (anything-interpret-value (or (assoc-default 'mode-line source)
2905 (default-value 'anything-mode-line-string))
2906 source))
2907 (if anything-mode-line-string
2908 (setq mode-line-format
2909 '(" " mode-line-buffer-identification " "
2910 (line-number-mode "L%l") " " (anything-follow-mode "(F) ")
2911 (:eval (anything-show-candidate-number
2912 (when (listp anything-mode-line-string)
2913 (car anything-mode-line-string))))
2914 " " anything-mode-line-string-real "-%-")
2915 anything-mode-line-string-real
2916 (substitute-command-keys (if (listp anything-mode-line-string)
2917 (cadr anything-mode-line-string)
2918 anything-mode-line-string)))
2919 (setq mode-line-format
2920 (default-value 'mode-line-format)))
2921 (setq header-line-format
2922 (anything-interpret-value (assoc-default 'header-line source) source)))
2924 (defun anything-show-candidate-number (&optional name)
2925 "Used to display candidate number in mode-line.
2926 You can specify NAME of candidates e.g \"Buffers\" otherwise
2927 it is \"Candidate\(s\)\" by default."
2928 (propertize
2929 (format "[%s %s]"
2930 (anything-approximate-candidate-number 'in-current-source)
2931 (or name "Candidate(s)"))
2932 'face 'anything-candidate-number))
2934 (defun anything-previous-line ()
2935 "Move selection to the previous line."
2936 (interactive)
2937 (anything-move-selection-common
2938 (lambda ()
2939 (if (not (anything-pos-multiline-p))
2940 (forward-line -1) ;double forward-line is meaningful
2941 (forward-line -1) ;because evaluation order is important
2942 (anything-skip-header-and-separator-line 'previous)
2943 (let ((header-pos (anything-get-previous-header-pos))
2944 (separator-pos (anything-get-previous-candidate-separator-pos)))
2945 (when header-pos
2946 (goto-char (if (or (null separator-pos) (< separator-pos header-pos))
2947 header-pos ; first candidate
2948 separator-pos))
2949 (forward-line 1)))))
2950 'line 'previous))
2952 (defun anything-next-line ()
2953 "Move selection to the next line."
2954 (interactive)
2955 (anything-move-selection-common
2956 (lambda ()
2957 (if (not (anything-pos-multiline-p))
2958 (forward-line 1)
2959 (let ((header-pos (anything-get-next-header-pos))
2960 (separator-pos (anything-get-next-candidate-separator-pos)))
2961 (cond ((and separator-pos
2962 (or (null header-pos) (< separator-pos header-pos)))
2963 (goto-char separator-pos))
2964 (header-pos
2965 (goto-char header-pos))))))
2966 'line 'next))
2968 (defun anything-previous-page ()
2969 "Move selection back with a pageful."
2970 (interactive)
2971 (anything-move-selection-common
2972 (lambda ()
2973 (condition-case nil
2974 (scroll-down)
2975 (beginning-of-buffer (goto-char (point-min)))))
2976 'page 'previous))
2978 (defun anything-next-page ()
2979 "Move selection forward with a pageful."
2980 (interactive)
2981 (anything-move-selection-common
2982 (lambda ()
2983 (condition-case nil
2984 (scroll-up)
2985 (end-of-buffer (goto-char (point-max)))))
2986 'page 'next))
2988 (defun anything-beginning-of-buffer ()
2989 "Move selection at the top."
2990 (interactive)
2991 (anything-move-selection-common
2992 (lambda () (goto-char (point-min)))
2993 'edge 'previous))
2995 (defun anything-end-of-buffer ()
2996 "Move selection at the bottom."
2997 (interactive)
2998 (anything-move-selection-common
2999 (lambda () (goto-char (point-max)))
3000 'edge 'next))
3002 (defun anything-previous-source ()
3003 "Move selection to the previous source."
3004 (interactive)
3005 (anything-move-selection-common
3006 (lambda ()
3007 (forward-line -1)
3008 (if (bobp)
3009 (goto-char (point-max))
3010 (anything-skip-header-and-separator-line 'previous))
3011 (goto-char (anything-get-previous-header-pos))
3012 (forward-line 1))
3013 'source 'previous))
3015 (defun anything-next-source ()
3016 "Move selection to the next source."
3017 (interactive)
3018 (anything-move-selection-common
3019 (lambda ()
3020 (goto-char (or (anything-get-next-header-pos) (point-min))))
3021 'source 'next))
3023 (defun anything-goto-source (source-or-name)
3024 "Move the selection to the source SOURCE-OR-NAME."
3025 (anything-move-selection-common
3026 (lambda ()
3027 (goto-char (point-min))
3028 (let ((name (if (stringp source-or-name) source-or-name
3029 (assoc-default 'name source-or-name))))
3030 (condition-case err
3031 (while (not (string= name (anything-current-line-contents)))
3032 (goto-char (anything-get-next-header-pos)))
3033 (error (message "")))))
3034 'source 'next))
3036 (defun anything-mark-current-line (&optional resumep)
3037 "Move `anything-selection-overlay' to current line.
3038 Note that this is not related with visibles marks, which are used
3039 to mark candidates."
3040 (with-anything-window
3041 (when resumep
3042 (goto-char anything-selection-point))
3043 (move-overlay
3044 anything-selection-overlay (point-at-bol)
3045 (if (anything-pos-multiline-p)
3046 (let ((header-pos (anything-get-next-header-pos))
3047 (separator-pos (anything-get-next-candidate-separator-pos)))
3048 (or (and (null header-pos) separator-pos)
3049 (and header-pos separator-pos (< separator-pos header-pos)
3050 separator-pos)
3051 header-pos
3052 (point-max)))
3053 (1+ (point-at-eol))))
3054 (setq anything-selection-point (overlay-start anything-selection-overlay)))
3055 (anything-follow-execute-persistent-action-maybe))
3057 (defun anything-this-command-key ()
3058 (cons (event-basic-type (elt (this-command-keys-vector) 0)) 0))
3059 ;; (progn (read-key-sequence "Key: ") (p (anything-this-command-key)))
3061 (defun anything-read-prefix-shortcut ()
3062 (let ((key0 (read-event "Select shortcut key (1-9 for action): ")))
3063 (if (<= ?1 key0 ?9)
3064 (cons (read-event "Select shortcut key (candidate): ") (- key0 ?1))
3065 (cons key0 0))))
3067 (defun anything-select-with-shortcut-internal (types get-key-func)
3068 (if (memq anything-enable-shortcuts types)
3069 (save-selected-window
3070 (select-window (anything-window))
3071 (let* ((pair (funcall get-key-func))
3072 (key (car pair))
3073 (action-index (cdr pair))
3074 (overlay (ignore-errors (nth (position key anything-shortcut-keys)
3075 anything-digit-overlays))))
3076 (if (not (and overlay (overlay-buffer overlay)))
3077 (when (numberp key)
3078 (select-window (minibuffer-window))
3079 (self-insert-command 1))
3080 (goto-char (overlay-start overlay))
3081 (anything-mark-current-line)
3082 (anything-select-nth-action action-index))))
3083 (self-insert-command 1)))
3085 (defun anything-select-with-prefix-shortcut ()
3086 "Invoke default action with prefix shortcut."
3087 (interactive)
3088 (anything-select-with-shortcut-internal
3089 '(prefix) 'anything-read-prefix-shortcut))
3091 (defun anything-select-with-digit-shortcut ()
3092 "Invoke default action with digit/alphabet shortcut."
3093 (interactive)
3094 (anything-select-with-shortcut-internal
3095 '(alphabet t) 'anything-this-command-key))
3097 ;; (setq anything-enable-shortcuts 'prefix)
3098 ;; (define-key anything-map "@" 'anything-select-with-prefix-shortcut)
3099 ;; (define-key anything-map (kbd "<f18>") 'anything-select-with-prefix-shortcut)
3101 (defvar anything-exit-status 0
3102 "Flag to inform whether anything have exited or quitted.
3103 Exit with 0 mean anything have exited executing an action.
3104 Exit with 1 mean anything have quitted with \\[keyboard-quit]
3105 It is useful for example to restore a window config if anything abort
3106 in special cases.
3107 See `anything-exit-minibuffer' and `anything-keyboard-quit'.")
3109 (defvar anything-minibuffer-confirm-state nil)
3110 (defun anything-confirm-and-exit-minibuffer ()
3111 "Maybe ask for confirmation when exiting anything.
3112 It is similar to `minibuffer-complete-and-exit' adapted to anything.
3113 If `minibuffer-completion-confirm' value is 'confirm,
3114 send in minibuffer confirm message and exit on next hit.
3115 If `minibuffer-completion-confirm' value is t,
3116 don't exit and send message 'no match'."
3117 (interactive)
3118 (let ((empty-buffer-p (with-current-buffer anything-buffer
3119 (eq (point-min) (point-max))))
3120 (unknow (string= (get-text-property
3121 0 'display (anything-get-selection nil 'withprop))
3122 "[?]")))
3123 (cond ((and (or empty-buffer-p unknow)
3124 (eq minibuffer-completion-confirm 'confirm))
3125 (setq anything-minibuffer-confirm-state
3126 'confirm)
3127 (setq minibuffer-completion-confirm nil)
3128 (minibuffer-message " [confirm]"))
3129 ((and (or empty-buffer-p unknow)
3130 (eq minibuffer-completion-confirm t))
3131 (minibuffer-message " [No match]"))
3133 (setq anything-minibuffer-confirm-state nil)
3134 (anything-exit-minibuffer)))))
3135 (add-hook 'anything-after-update-hook 'anything-confirm-and-exit-hook)
3137 (defun anything-confirm-and-exit-hook ()
3138 "Restore `minibuffer-completion-confirm' when anything update."
3139 (unless (or (eq minibuffer-completion-confirm t)
3140 (not anything-minibuffer-confirm-state))
3141 (setq minibuffer-completion-confirm
3142 anything-minibuffer-confirm-state)))
3144 (defun anything-exit-minibuffer ()
3145 "Select the current candidate by exiting the minibuffer."
3146 (interactive)
3147 (unless anything-current-prefix-arg
3148 (setq anything-current-prefix-arg current-prefix-arg))
3149 (setq anything-exit-status 0)
3150 (exit-minibuffer))
3152 (defun anything-keyboard-quit ()
3153 "Quit minibuffer in anything.
3154 If action buffer is displayed, kill it."
3155 (interactive)
3156 (when (get-buffer-window anything-action-buffer 'visible)
3157 (kill-buffer anything-action-buffer))
3158 (setq anything-exit-status 1)
3159 (abort-recursive-edit))
3161 (defun anything-get-next-header-pos ()
3162 "Return the position of the next header from point."
3163 (next-single-property-change (point) 'anything-header))
3165 (defun anything-get-previous-header-pos ()
3166 "Return the position of the previous header from point."
3167 (previous-single-property-change (point) 'anything-header))
3169 (defun anything-pos-multiline-p ()
3170 "Return non-nil if the current position is in the multiline source region."
3171 (get-text-property (point) 'anything-multiline))
3173 (defun anything-get-next-candidate-separator-pos ()
3174 "Return the position of the next candidate separator from point."
3175 (next-single-property-change (point) 'anything-candidate-separator))
3177 (defun anything-get-previous-candidate-separator-pos ()
3178 "Return the position of the previous candidate separator from point."
3179 (previous-single-property-change (point) 'anything-candidate-separator))
3181 (defun anything-pos-header-line-p ()
3182 "Return t if the current line is a header line."
3183 (or (get-text-property (point-at-bol) 'anything-header)
3184 (get-text-property (point-at-bol) 'anything-header-separator)))
3186 (defun anything-pos-candidate-separator-p ()
3187 "Return t if the current line is a candidate separator."
3188 (get-text-property (point-at-bol) 'anything-candidate-separator))
3191 ;; (@* "Core: help")
3192 (defun anything-help-internal (bufname insert-content-fn)
3193 "Show long message during `anything' session in BUFNAME.
3194 INSERT-CONTENT-FN is the text to be displayed in BUFNAME."
3195 (save-window-excursion
3196 (select-window (anything-window))
3197 (delete-other-windows)
3198 (switch-to-buffer (get-buffer-create bufname))
3199 (erase-buffer)
3200 (funcall insert-content-fn)
3201 (setq mode-line-format "%b (SPC,C-v:NextPage b,M-v:PrevPage other:Exit)")
3202 (setq cursor-type nil)
3203 (goto-char 1)
3204 (anything-help-event-loop)))
3206 (defun anything-help-event-loop ()
3207 (ignore-errors
3208 (loop for event = (read-event) do
3209 (case event
3210 ((?\C-v ? ) (scroll-up))
3211 ((?\M-v ?b) (scroll-down))
3212 (t (return))))))
3214 (defun anything-help ()
3215 "Help of `anything'."
3216 (interactive)
3217 (anything-help-internal
3218 " *Anything Help*"
3219 (lambda ()
3220 (insert (substitute-command-keys
3221 (anything-interpret-value (or (assoc-default
3222 'help-message
3223 (anything-get-current-source))
3224 anything-help-message))))
3225 (org-mode))))
3227 (defun anything-debug-output ()
3228 "Show all anything-related variables at this time."
3229 (interactive)
3230 (anything-help-internal " *Anything Debug*" 'anything-debug-output-function))
3232 (defun anything-debug-output-function (&optional vars)
3233 (message "Calculating all anything-related values...")
3234 (insert "If you debug some variables or forms, set `anything-debug-forms'
3235 to a list of forms.\n\n")
3236 (dolist (v (or vars
3237 anything-debug-forms
3238 (apropos-internal "^anything-" 'boundp)))
3239 (insert "** "
3240 (pp-to-string v) "\n"
3241 (pp-to-string (with-current-buffer anything-buffer (eval v))) "\n"))
3242 (message "Calculating all anything-related values...Done"))
3245 ;; (@* "Core: misc")
3246 (defun anything-kill-buffer-hook ()
3247 "Remove tick entry from `anything-tick-hash' when killing a buffer."
3248 (loop for key being the hash-keys in anything-tick-hash
3249 if (string-match (format "^%s/" (regexp-quote (buffer-name))) key)
3250 do (remhash key anything-tick-hash)))
3251 (add-hook 'kill-buffer-hook 'anything-kill-buffer-hook)
3253 (defun anything-preselect (candidate-or-regexp)
3254 "Move `anything-selection-overlay' to CANDIDATE-OR-REGEXP on startup."
3255 (with-anything-window
3256 (when candidate-or-regexp
3257 (goto-char (point-min))
3258 ;; go to first candidate of first source
3259 (forward-line 1)
3260 (let ((start (point)))
3261 (or (re-search-forward
3262 (concat "^" (regexp-quote candidate-or-regexp) "$") nil t)
3263 (re-search-forward candidate-or-regexp nil t)
3264 (search-forward candidate-or-regexp nil t)
3265 (goto-char start))))
3266 (anything-mark-current-line)))
3268 (defun anything-delete-current-selection ()
3269 "Delete the currently selected item."
3270 (interactive)
3271 (with-anything-window
3272 (cond ((anything-pos-multiline-p)
3273 (anything-aif (anything-get-next-candidate-separator-pos)
3274 (delete-region (point-at-bol)
3275 (1+ (progn (goto-char it) (point-at-eol))))
3276 ;; last candidate
3277 (goto-char (anything-get-previous-candidate-separator-pos))
3278 (delete-region (point-at-bol) (point-max)))
3279 (when (anything-end-of-source-p)
3280 (goto-char (or (anything-get-previous-candidate-separator-pos)
3281 (point-min)))
3282 (forward-line 1)))
3284 (delete-region (point-at-bol) (1+ (point-at-eol)))
3285 (when (anything-end-of-source-p) (forward-line -1))))
3286 (anything-mark-current-line)))
3288 (defun anything-end-of-source-p ()
3289 "Return non--nil if we are at eob or end of source."
3290 (save-excursion
3291 (forward-line 1)
3292 (or (eq (point-at-bol) (point-at-eol))
3293 (anything-pos-header-line-p)
3294 (eobp))))
3296 (defun anything-edit-current-selection-internal (func)
3297 (with-anything-window
3298 (beginning-of-line)
3299 (let ((realvalue (get-text-property (point) 'anything-realvalue)))
3300 (funcall func)
3301 (beginning-of-line)
3302 (and realvalue
3303 (put-text-property (point) (point-at-eol)
3304 'anything-realvalue realvalue))
3305 (anything-mark-current-line))))
3307 (defmacro anything-edit-current-selection (&rest forms)
3308 "Evaluate FORMS at current selection in the anything buffer.
3309 You can edit the line."
3310 (declare (indent 0) (debug t))
3311 `(anything-edit-current-selection-internal
3312 (lambda () ,@forms)))
3314 (defun anything-set-pattern (pattern &optional noupdate)
3315 "Set minibuffer contents to PATTERN.
3316 if optional NOUPDATE is non-nil, anything buffer is not changed."
3317 (with-selected-window (or (active-minibuffer-window) (minibuffer-window))
3318 (delete-minibuffer-contents)
3319 (insert pattern))
3320 (when noupdate
3321 (setq anything-pattern pattern)
3322 (anything-hooks 'cleanup)
3323 (run-with-idle-timer 0 nil 'anything-hooks 'setup)))
3325 (defun anything-delete-minibuffer-contents ()
3326 "Same as `delete-minibuffer-contents' but this is a command."
3327 (interactive)
3328 (anything-set-pattern ""))
3329 (defalias 'anything-delete-minibuffer-content 'anything-delete-minibuffer-contents)
3332 ;;; Plugins
3334 ;; (@* "Built-in plug-in: type")
3335 (defun anything-compile-source--type (source)
3336 (anything-aif (assoc-default 'type source)
3337 (append source (assoc-default it anything-type-attributes) nil)
3338 source))
3340 ;; `define-anything-type-attribute' is public API.
3342 (defun anything-add-type-attribute (type definition)
3343 (anything-aif (assq type anything-type-attributes)
3344 (setq anything-type-attributes (delete it anything-type-attributes)))
3345 (push (cons type definition) anything-type-attributes))
3347 (defvar anything-types nil)
3348 (defun anything-document-type-attribute (type doc)
3349 (add-to-list 'anything-types type t)
3350 (put type 'anything-typeattrdoc
3351 (concat "- " (symbol-name type) "\n\n" doc "\n")))
3353 (defadvice documentation-property (after anything-document-type-attribute activate)
3354 "Display type attributes' documentation as `anything-type-attributes' docstring."
3355 (when (eq (ad-get-arg 0) 'anything-type-attributes)
3356 (setq ad-return-value
3357 (concat ad-return-value "\n\n++++ Types currently defined ++++\n"
3358 (mapconcat (lambda (sym) (get sym 'anything-typeattrdoc))
3359 anything-types "\n")))))
3361 ;; (@* "Built-in plug-in: dummy")
3362 (defun anything-dummy-candidate (candidate source)
3363 "Use `anything-pattern' as CANDIDATE in SOURCE."
3364 ;; `source' is defined in filtered-candidate-transformer
3365 (list anything-pattern))
3367 (defun anything-compile-source--dummy (source)
3368 (if (assoc 'dummy source)
3369 (append source
3370 '((candidates "dummy")
3371 (accept-empty)
3372 (match identity)
3373 (filtered-candidate-transformer . anything-dummy-candidate)
3374 ;;(disable-shortcuts)
3375 (volatile)))
3376 source))
3378 ;; (@* "Built-in plug-in: disable-shortcuts")
3379 (defvar anything-orig-enable-shortcuts nil)
3380 (defun anything-save-enable-shortcuts ()
3381 (anything-once
3382 (lambda ()
3383 (setq anything-orig-enable-shortcuts anything-enable-shortcuts
3384 anything-enable-shortcuts nil))))
3386 (defun anything-compile-source--disable-shortcuts (source)
3387 (if (assoc 'disable-shortcuts source)
3388 (append `((init ,@(anything-mklist (assoc-default 'init source))
3389 anything-save-enable-shortcuts)
3390 (resume ,@(anything-mklist (assoc-default 'resume source))
3391 anything-save-enable-shortcuts)
3392 (cleanup ,@(anything-mklist (assoc-default 'cleanup source))
3393 (lambda () (setq anything-enable-shortcuts
3394 anything-orig-enable-shortcuts))))
3395 source)
3396 source))
3398 ;; (@* "Built-in plug-in: candidates-in-buffer")
3399 (defun anything-candidates-in-buffer ()
3400 "Get candidates from the candidates buffer according to `anything-pattern'.
3402 BUFFER is `anything-candidate-buffer' by default. Each
3403 candidate must be placed in one line. This function is meant to
3404 be used in candidates-in-buffer or candidates attribute of an
3405 anything source. Especially fast for many (1000+) candidates.
3408 '((name . \"many files\")
3409 (init . (lambda () (with-current-buffer (anything-candidate-buffer 'local)
3410 (insert-many-filenames))))
3411 (search re-search-forward) ; optional
3412 (candidates-in-buffer)
3413 (type . file))
3415 +===============================================================+
3416 | The new way of making and narrowing candidates: Using buffers |
3417 +===============================================================+
3419 By default, `anything' makes candidates by evaluating the
3420 candidates function, then narrows them by `string-match' for each
3421 candidate.
3423 But this way is very slow for many candidates. The new way is
3424 storing all candidates in a buffer and narrowing them by
3425 `re-search-forward'. Search function is customizable by search
3426 attribute. The important point is that buffer processing is MUCH
3427 FASTER than string list processing and is the Emacs way.
3429 The init function writes all candidates to a newly-created
3430 candidate buffer. The candidates buffer is created or specified
3431 by `anything-candidate-buffer'. Candidates are stored in a line.
3433 The candidates function narrows all candidates, IOW creates a
3434 subset of candidates dynamically. It is the task of
3435 `anything-candidates-in-buffer'. As long as
3436 `anything-candidate-buffer' is used,`(candidates-in-buffer)' is
3437 sufficient in most cases.
3439 Note that `(candidates-in-buffer)' is shortcut of three attributes:
3440 (candidates . anything-candidates-in-buffer)
3441 (volatile)
3442 (match identity)
3443 And `(candidates-in-buffer . func)' is shortcut of three attributes:
3444 (candidates . func)
3445 (volatile)
3446 (match identity)
3447 The expansion is performed in `anything-get-sources'.
3449 The candidates-in-buffer attribute implies the volatile attribute.
3450 The volatile attribute is needed because `anything-candidates-in-buffer'
3451 creates candidates dynamically and need to be called everytime
3452 `anything-pattern' changes.
3454 Because `anything-candidates-in-buffer' plays the role of `match' attribute
3455 function, specifying `(match identity)' makes the source slightly faster.
3457 To customize `anything-candidates-in-buffer' behavior, use search,
3458 get-line and search-from-end attributes. See also `anything-sources' docstring."
3459 (declare (special source))
3460 (anything-candidates-in-buffer-1
3461 (anything-candidate-buffer)
3462 anything-pattern
3463 (or (assoc-default 'get-line source)
3464 #'buffer-substring-no-properties)
3465 ;; use external variable `source'.
3466 (or (assoc-default 'search source)
3467 (if (assoc 'search-from-end source)
3468 '(anything-candidates-in-buffer-search-from-end)
3469 '(anything-candidates-in-buffer-search-from-start)))
3470 (anything-candidate-number-limit source)
3471 (assoc 'search-from-end source)))
3473 (defun anything-candidates-in-buffer-search-from-start (pattern)
3474 "Search PATTERN with `re-search-forward' with bound and noerror args."
3475 (re-search-forward pattern nil t))
3477 (defun anything-candidates-in-buffer-search-from-end (pattern)
3478 "Search PATTERN with `re-search-backward' with bound and noerror args."
3479 (re-search-backward pattern nil t))
3481 (defun anything-candidates-in-buffer-1 (buffer pattern get-line-fn
3482 search-fns limit search-from-end)
3483 ;; buffer == nil when candidates buffer does not exist.
3484 (when buffer
3485 (with-current-buffer buffer
3486 (let ((start-point (if search-from-end (point-max) (point-min)))
3487 (endp (if search-from-end #'bobp #'eobp)))
3488 (goto-char (1- start-point))
3489 (if (string= pattern "")
3490 (anything-initial-candidates-from-candidate-buffer
3491 endp get-line-fn limit search-from-end)
3492 (anything-search-from-candidate-buffer
3493 pattern get-line-fn search-fns limit search-from-end
3494 start-point endp))))))
3496 (defun anything-point-is-moved (proc)
3497 "If point is moved after executing PROC, return t, otherwise nil."
3498 (/= (point) (progn (funcall proc) (point))))
3500 (defun anything-search-from-candidate-buffer (pattern get-line-fn search-fns
3501 limit search-from-end
3502 start-point endp)
3503 (let (buffer-read-only
3504 matches exit newmatches)
3505 (anything-search-from-candidate-buffer-internal
3506 (lambda ()
3507 (clrhash anything-cib-hash)
3508 (dolist (searcher search-fns)
3509 (goto-char start-point)
3510 (setq newmatches nil)
3511 (loop with item-count = 0
3512 while (funcall searcher pattern)
3513 for cand = (funcall get-line-fn (point-at-bol) (point-at-eol))
3514 do (anything-accumulate-candidates-internal
3515 cand newmatches anything-cib-hash item-count limit)
3516 unless (anything-point-is-moved
3517 (lambda ()
3518 (if search-from-end
3519 (goto-char (1- (point-at-bol)))
3520 (forward-line 1))))
3521 return nil)
3522 (setq matches (append matches (nreverse newmatches)))
3523 (if exit (return)))
3524 (delq nil matches)))))
3526 (defun anything-initial-candidates-from-candidate-buffer (endp get-line-fn limit search-from-end)
3527 (delq nil (loop with next-line-fn =
3528 (if search-from-end
3529 (lambda (x) (goto-char (max (1- (point-at-bol)) 1)))
3530 #'forward-line)
3531 until (funcall endp)
3532 for i from 1 to limit
3533 collect (funcall get-line-fn (point-at-bol) (point-at-eol))
3534 do (funcall next-line-fn 1))))
3536 (defun anything-search-from-candidate-buffer-internal (search-fn)
3537 (goto-char (point-min))
3538 (insert "\n")
3539 (goto-char (point-max))
3540 (insert "\n")
3541 (unwind-protect
3542 (funcall search-fn)
3543 (goto-char (point-min))
3544 (delete-char 1)
3545 (goto-char (1- (point-max)))
3546 (delete-char 1)
3548 (set-buffer-modified-p nil)))
3550 (defun anything-candidate-buffer (&optional create-or-buffer)
3551 "Register and return a buffer containing candidates of current source.
3552 `anything-candidate-buffer' searches buffer-local candidates buffer first,
3553 then global candidates buffer.
3555 Acceptable values of CREATE-OR-BUFFER:
3557 - nil (omit)
3558 Only return the candidates buffer.
3559 - a buffer
3560 Register a buffer as a candidates buffer.
3561 - 'global
3562 Create a new global candidates buffer,
3563 named \" *anything candidates:SOURCE*\".
3564 - other non-nil value
3565 Create a new local candidates buffer,
3566 named \" *anything candidates:SOURCE*ANYTHING-CURRENT-BUFFER\"."
3567 (let* ((global-bname (format " *anything candidates:%s*"
3568 anything-source-name))
3569 (local-bname (format " *anything candidates:%s*%s"
3570 anything-source-name
3571 (buffer-name anything-current-buffer))))
3572 (cl-flet ((register-func ()
3573 (setq anything-candidate-buffer-alist
3574 (cons (cons anything-source-name create-or-buffer)
3575 (delete (assoc anything-source-name
3576 anything-candidate-buffer-alist)
3577 anything-candidate-buffer-alist))))
3578 (kill-buffers-func ()
3579 (loop for b in (buffer-list)
3580 if (string-match (format "^%s" (regexp-quote global-bname))
3581 (buffer-name b))
3582 do (kill-buffer b)))
3583 (create-func ()
3584 (with-current-buffer
3585 (get-buffer-create (if (eq create-or-buffer 'global)
3586 global-bname
3587 local-bname))
3588 (buffer-disable-undo)
3589 (erase-buffer)
3590 (font-lock-mode -1)))
3591 (return-func ()
3592 (or (get-buffer local-bname)
3593 (get-buffer global-bname)
3594 (anything-aif (assoc-default anything-source-name
3595 anything-candidate-buffer-alist)
3596 (and (buffer-live-p it) it)))))
3597 (when create-or-buffer
3598 (register-func)
3599 (unless (bufferp create-or-buffer)
3600 (and (eq create-or-buffer 'global) (kill-buffers-func))
3601 (create-func)))
3602 (return-func))))
3604 (defun anything-compile-source--candidates-in-buffer (source)
3605 (anything-aif (assoc 'candidates-in-buffer source)
3606 (append source
3607 `((candidates . ,(or (cdr it) 'anything-candidates-in-buffer))
3608 (volatile) (match identity)))
3609 source))
3612 ;; (@* "Utility: resplit anything window")
3613 (defun anything-toggle-resplit-window ()
3614 "Toggle resplit anything window, vertically or horizontally."
3615 (interactive)
3616 (with-anything-window
3617 (let ((before-height (window-height)))
3618 (delete-window)
3619 (set-window-buffer
3620 (select-window (if (= (window-height) before-height)
3621 (prog1
3622 (split-window-vertically)
3623 (setq anything-split-window-state 'vertical))
3624 (setq anything-split-window-state 'horizontal)
3625 (split-window-horizontally)))
3626 anything-buffer))))
3628 ;; (@* "Utility: Resize anything window.")
3629 (defun anything-enlarge-window-1 (n)
3630 "Enlarge or narrow anything window.
3631 If N is positive enlarge, if negative narrow."
3632 (unless anything-samewindow
3633 (let ((horizontal-p (eq anything-split-window-state 'horizontal)))
3634 (with-anything-window
3635 (enlarge-window n horizontal-p)))))
3637 (defun anything-narrow-window ()
3638 "Narrow anything window."
3639 (interactive)
3640 (anything-enlarge-window-1 -1))
3642 (defun anything-enlarge-window ()
3643 "Enlarge anything window."
3644 (interactive)
3645 (anything-enlarge-window-1 1))
3647 ;; (@* "Utility: select another action by key")
3648 (defun anything-select-nth-action (n)
3649 "Select the N nth action for the currently selected candidate."
3650 (setq anything-saved-selection (anything-get-selection))
3651 (unless anything-saved-selection
3652 (error "Nothing is selected"))
3653 (setq anything-saved-action (anything-get-nth-action n (anything-get-action)))
3654 (anything-exit-minibuffer))
3656 (defun anything-get-nth-action (n action)
3657 (cond ((and (zerop n) (functionp action))
3658 action)
3659 ((listp action)
3660 (or (cdr (elt action n))
3661 (error "No such action")))
3662 ((and (functionp action) (< 0 n))
3663 (error "Sole action"))
3665 (error "Error in `anything-select-nth-action'"))))
3667 (defun anything-select-2nd-action ()
3668 "Select the 2nd action for the currently selected candidate."
3669 (interactive)
3670 (anything-select-nth-action 1))
3672 (defun anything-select-3rd-action ()
3673 "Select the 3rd action for the currently selected candidate."
3674 (interactive)
3675 (anything-select-nth-action 2))
3677 (defun anything-select-4th-action ()
3678 "Select the 4th action for the currently selected candidate."
3679 (interactive)
3680 (anything-select-nth-action 3))
3682 (defun anything-select-2nd-action-or-end-of-line ()
3683 "Select the 2nd action for the currently selected candidate.
3684 This happen when point is at the end of minibuffer.
3685 Otherwise goto the end of minibuffer."
3686 (interactive)
3687 (if (eolp)
3688 (anything-select-nth-action 1)
3689 (end-of-line)))
3691 ;; (@* "Utility: Persistent Action")
3692 (defmacro with-anything-display-same-window (&rest body)
3693 "Execute BODY in the window used for persistent action.
3694 Make `pop-to-buffer' and `display-buffer' display in the same window."
3695 (declare (indent 0) (debug t))
3696 `(let ((display-buffer-function 'anything-persistent-action-display-buffer))
3697 ,@body))
3699 (defvar anything-persistent-action-display-window nil)
3700 (defun anything-initialize-persistent-action ()
3701 (set (make-local-variable 'anything-persistent-action-display-window) nil))
3703 (defun* anything-execute-persistent-action (&optional (attr 'persistent-action) onewindow)
3704 "Perform the associated action ATTR without quitting anything.
3705 ATTR default is 'persistent-action', but it can be anything else.
3706 In this case you have to add this new attribute to your source.
3707 When `anything-samewindow' and ONEWINDOW are non--nil,
3708 the anything window is never split in persistent action."
3709 (interactive)
3710 (anything-log "executing persistent-action")
3711 (with-anything-window
3712 (save-selected-window
3713 (anything-select-persistent-action-window onewindow)
3714 (anything-log-eval (current-buffer))
3715 (let ((anything-in-persistent-action t))
3716 (with-anything-display-same-window
3717 (anything-execute-selection-action
3719 (or (assoc-default attr (anything-get-current-source))
3720 (anything-get-action))
3722 (anything-log-run-hook 'anything-after-persistent-action-hook))))))
3725 (defun anything-persistent-action-display-window (&optional onewindow)
3726 "Return the window that will be used for presistent action.
3727 If ONEWINDOW is non--nil window will not be splitted in persistent action
3728 if `anything-samewindow' is non--nil also."
3729 (with-anything-window
3730 (setq anything-persistent-action-display-window
3731 (cond ((window-live-p anything-persistent-action-display-window)
3732 anything-persistent-action-display-window)
3733 ((and anything-samewindow (one-window-p t) (not onewindow))
3734 (split-window))
3735 ((get-buffer-window anything-current-buffer))
3737 (next-window (selected-window) 1))))))
3739 (defun anything-select-persistent-action-window (&optional onewindow)
3740 "Select the window that will be used for persistent action.
3741 See `anything-persistent-action-display-window' for how to use ONEWINDOW."
3742 (select-window (get-buffer-window (anything-buffer-get)))
3743 (select-window
3744 (setq minibuffer-scroll-window
3745 (anything-persistent-action-display-window onewindow))))
3747 (defun anything-persistent-action-display-buffer (buf &optional not-this-window)
3748 "Make `pop-to-buffer' and `display-buffer' display in the same window.
3749 If `anything-persistent-action-use-special-display' is non-nil and
3750 BUF is to be displayed by `special-display-function', use it.
3751 Otherwise ignores `special-display-buffer-names' and `special-display-regexps'.
3752 Argument NOT-THIS-WINDOW if present will be used as
3753 second argument of `display-buffer'."
3754 (let* ((name (buffer-name buf))
3755 display-buffer-function pop-up-windows pop-up-frames
3756 (same-window-regexps
3757 (unless (and anything-persistent-action-use-special-display
3758 (or (member name
3759 (mapcar (lambda (x) (or (car-safe x) x))
3760 special-display-buffer-names))
3761 (remove-if-not
3762 (lambda (x) (string-match (or (car-safe x) x) name))
3763 special-display-regexps)))
3764 '("."))))
3765 (display-buffer buf not-this-window)))
3767 ;; scroll-other-window(-down)? for persistent-action
3768 (defun anything-scroll-other-window-base (command)
3769 (with-selected-window (anything-persistent-action-display-window)
3770 (funcall command anything-scroll-amount)))
3772 (defun anything-scroll-other-window ()
3773 "Scroll other window (not *Anything* window) upward."
3774 (interactive)
3775 (anything-scroll-other-window-base 'scroll-up))
3777 (defun anything-scroll-other-window-down ()
3778 "Scroll other window (not *Anything* window) downward."
3779 (interactive)
3780 (anything-scroll-other-window-base 'scroll-down))
3783 ;; (@* "Utility: Visible Mark")
3784 (defface anything-visible-mark
3785 '((((min-colors 88) (background dark))
3786 (:background "green1" :foreground "black"))
3787 (((background dark)) (:background "green" :foreground "black"))
3788 (((min-colors 88)) (:background "green1"))
3789 (t (:background "green")))
3790 "Face for visible mark."
3791 :group 'anything)
3793 (defvar anything-visible-mark-face 'anything-visible-mark)
3794 (defvar anything-visible-mark-overlays nil)
3796 (defun anything-clear-visible-mark ()
3797 (with-current-buffer (anything-buffer-get)
3798 (mapc 'delete-overlay anything-visible-mark-overlays)
3799 (set (make-local-variable 'anything-visible-mark-overlays) nil)))
3800 (add-hook 'anything-after-initialize-hook 'anything-clear-visible-mark)
3802 (defvar anything-marked-candidates nil
3803 "Marked candadates. List of \(source . real\) pair.")
3805 (defun anything-this-visible-mark ()
3806 (loop for o in anything-visible-mark-overlays
3807 when (equal (point-at-bol) (overlay-start o))
3808 return o))
3810 (defun anything-delete-visible-mark (overlay)
3811 (setq anything-marked-candidates
3812 (remove
3813 (cons (anything-get-current-source) (anything-get-selection))
3814 anything-marked-candidates))
3815 (delete-overlay overlay)
3816 (setq anything-visible-mark-overlays
3817 (delq overlay anything-visible-mark-overlays)))
3819 (defun anything-make-visible-mark ()
3820 (let ((o (make-overlay (point-at-bol) (1+ (point-at-eol)))))
3821 (overlay-put o 'face anything-visible-mark-face)
3822 (overlay-put o 'source (assoc-default 'name (anything-get-current-source)))
3823 (overlay-put o 'string (buffer-substring (overlay-start o) (overlay-end o)))
3824 (overlay-put o 'real (anything-get-selection))
3825 (add-to-list 'anything-visible-mark-overlays o))
3826 (push (cons (anything-get-current-source) (anything-get-selection))
3827 anything-marked-candidates))
3829 (defun anything-toggle-visible-mark ()
3830 "Toggle anything visible mark at point."
3831 (interactive)
3832 (with-anything-window
3833 (anything-aif (anything-this-visible-mark)
3834 (anything-delete-visible-mark it)
3835 (anything-make-visible-mark))
3836 (anything-next-line)))
3838 (defun anything-display-all-visible-marks ()
3839 "Show all `anything' visible marks strings."
3840 (interactive)
3841 (with-anything-window
3842 (lexical-let ((overlays (reverse anything-visible-mark-overlays)))
3843 (anything-run-after-quit
3844 (lambda ()
3845 (with-output-to-temp-buffer "*anything visible marks*"
3846 (dolist (o overlays) (princ (overlay-get o 'string)))))))))
3848 (defun anything-marked-candidates ()
3849 "Return marked candidates of current source if any.
3850 Otherwise one element list of current selection.
3852 It is analogous to `dired-get-marked-files'."
3853 (with-current-buffer (anything-buffer-get)
3854 (let ((cands
3855 (if anything-marked-candidates
3856 (loop with current-src = (anything-get-current-source)
3857 for (source . real) in (reverse anything-marked-candidates)
3858 when (equal current-src source)
3859 collect (anything-coerce-selection real source))
3860 (list (anything-get-selection)))))
3861 (anything-log-eval cands)
3862 cands)))
3864 (defun anything-reset-marked-candidates ()
3865 (with-current-buffer (anything-buffer-get)
3866 (set (make-local-variable 'anything-marked-candidates) nil)))
3868 (add-hook 'anything-after-initialize-hook 'anything-reset-marked-candidates)
3869 ;; (add-hook 'anything-after-action-hook 'anything-reset-marked-candidates)
3871 (defun anything-current-source-name= (name)
3872 (save-excursion
3873 (goto-char (anything-get-previous-header-pos))
3874 (equal name (anything-current-line-contents))))
3876 (defun anything-revive-visible-mark ()
3877 "Restore marked candidates when anything update display."
3878 (with-current-buffer anything-buffer
3879 (dolist (o anything-visible-mark-overlays)
3880 (goto-char (point-min))
3881 (while (and (search-forward (overlay-get o 'string) nil t)
3882 (anything-current-source-name= (overlay-get o 'source)))
3883 ;; Calculate real value of candidate.
3884 ;; It can be nil if candidate have only a display value.
3885 (let ((real (get-text-property (point-at-bol 0) 'anything-realvalue)))
3886 (if real
3887 ;; Check if real value of current candidate is the same
3888 ;; that the one stored in overlay.
3889 (and (string= (overlay-get o 'real) real)
3890 (move-overlay o (point-at-bol 0) (1+ (point-at-eol 0))))
3891 (move-overlay o (point-at-bol 0) (1+ (point-at-eol 0)))))))))
3892 (add-hook 'anything-update-hook 'anything-revive-visible-mark)
3894 (defun anything-next-point-in-list (curpos points &optional prev)
3895 (cond
3896 ;; rule out special cases
3897 ((null points) curpos)
3898 ((and prev (< curpos (car points))) curpos)
3899 ((< (car (last points)) curpos)
3900 (if prev (car (last points)) curpos))
3902 (nth (if prev
3903 (loop for pt in points
3904 for i from 0
3905 if (<= curpos pt)
3906 return (1- i))
3907 (loop for pt in points
3908 for i from 0
3909 if (< curpos pt)
3910 return i))
3911 points))))
3913 (defun anything-next-visible-mark (&optional prev)
3914 "Move next anything visible mark.
3915 If PREV is non-nil move to precedent."
3916 (interactive)
3917 (with-anything-window
3918 (ignore-errors
3919 (goto-char (anything-next-point-in-list
3920 (point)
3921 (sort (mapcar 'overlay-start anything-visible-mark-overlays) '<)
3922 prev)))
3923 (anything-mark-current-line)))
3925 (defun anything-prev-visible-mark ()
3926 "Move previous anything visible mark."
3927 (interactive)
3928 (anything-next-visible-mark t))
3930 ;; (@* "Utility: Selection Paste")
3931 (defun anything-yank-selection ()
3932 "Set minibuffer contents to current selection."
3933 (interactive)
3934 (anything-set-pattern (anything-get-selection nil t)))
3936 (defun anything-kill-selection-and-quit ()
3937 "Store current selection to kill ring.
3938 You can paste it by typing \\[yank]."
3939 (interactive)
3940 (anything-run-after-quit
3941 (lambda (sel)
3942 (kill-new sel)
3943 (message "Killed: %s" sel))
3944 (anything-get-selection nil t)))
3947 ;; (@* "Utility: Automatical execution of persistent-action")
3948 (add-to-list 'minor-mode-alist '(anything-follow-mode " AFollow"))
3949 (defun anything-follow-mode ()
3950 "If this mode is on, persistent action is executed everytime the cursor is moved."
3951 (interactive)
3952 (with-current-buffer anything-buffer
3953 (setq anything-follow-mode (not anything-follow-mode))
3954 (message "anything-follow-mode is %s"
3955 (if anything-follow-mode "enabled" "disabled"))))
3957 (defun anything-follow-execute-persistent-action-maybe ()
3958 "Execute persistent action in mode `anything-follow-mode'.
3959 This happen after `anything-input-idle-delay' secs."
3960 (and (not (get-buffer-window anything-action-buffer 'visible))
3961 (buffer-local-value 'anything-follow-mode
3962 (get-buffer-create anything-buffer))
3963 (sit-for (and anything-input-idle-delay
3964 (max anything-input-idle-delay 0.1)))
3965 (anything-window)
3966 (anything-get-selection)
3967 (save-excursion
3968 (anything-execute-persistent-action))))
3971 ;; (@* "Utility: Migrate `anything-sources' to my-anything command")
3972 (defun anything-migrate-sources ()
3973 "Help to migrate to new `anything' way."
3974 (interactive)
3975 (with-current-buffer (get-buffer-create "*anything migrate*")
3976 (erase-buffer)
3977 (insert (format "\
3978 Setting `anything-sources' directly is not good because
3979 `anything' is not for one command. For now, interactive use of
3980 `anything' (M-x anything) is only for demonstration purpose.
3981 So you should define commands calling `anything'.
3982 I help you to migrate to the new way.
3984 The code below is automatically generated from current
3985 `anything-sources' value. You can use the `my-anything' command
3986 now!
3988 Copy and paste it to your .emacs. Then substitute `my-anything'
3989 for `anything' bindings in all `define-key', `local-set-key' and
3990 `global-set-key' calls.
3992 \(defun my-anything ()
3993 \"Anything command for you.
3995 It is automatically generated by `anything-migrate-sources'.\"
3996 (interactive)
3997 (anything-other-buffer
3999 \"*my-anything*\"))
4000 " anything-sources))
4001 (eval-last-sexp nil)
4002 (substitute-key-definition 'anything 'my-anything global-map)
4003 (pop-to-buffer (current-buffer))))
4006 ;; (@* "Compatibility")
4008 ;; Copied assoc-default from XEmacs version 21.5.12
4009 (unless (fboundp 'assoc-default)
4010 (defun assoc-default (key alist &optional test default)
4011 "Find object KEY in a pseudo-alist ALIST.
4012 ALIST is a list of conses or objects. Each element (or the element's car,
4013 if it is a cons) is compared with KEY by evaluating (TEST (car elt) KEY).
4014 If that is non-nil, the element matches;
4015 then `assoc-default' returns the element's cdr, if it is a cons,
4016 or DEFAULT if the element is not a cons.
4018 If no element matches, the value is nil.
4019 If TEST is omitted or nil, `equal' is used."
4020 (let (found (tail alist) value)
4021 (while (and tail (not found))
4022 (let ((elt (car tail)))
4023 (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key)
4024 (setq found t value (if (consp elt) (cdr elt) default))))
4025 (setq tail (cdr tail)))
4026 value)))
4028 ;; Function not available in XEmacs,
4029 (unless (fboundp 'minibuffer-contents)
4030 (defun minibuffer-contents ()
4031 "Return the user input in a minbuffer as a string.
4032 The current buffer must be a minibuffer."
4033 (field-string (point-max)))
4035 (defun delete-minibuffer-contents ()
4036 "Delete all user input in a minibuffer.
4037 The current buffer must be a minibuffer."
4038 (delete-field (point-max))))
4040 ;; Function not available in older Emacs (<= 22.1).
4041 (unless (fboundp 'buffer-chars-modified-tick)
4042 (defun buffer-chars-modified-tick (&optional buffer)
4043 "Return BUFFER's character-change tick counter.
4044 Each buffer has a character-change tick counter, which is set to the
4045 value of the buffer's tick counter (see `buffer-modified-tick'), each
4046 time text in that buffer is inserted or deleted. By comparing the
4047 values returned by two individual calls of `buffer-chars-modified-tick',
4048 you can tell whether a character change occurred in that buffer in
4049 between these calls. No argument or nil as argument means use current
4050 buffer as BUFFER."
4051 (with-current-buffer (or buffer (current-buffer))
4052 (if (listp buffer-undo-list)
4053 (length buffer-undo-list)
4054 (buffer-modified-tick)))))
4057 ;; (@* "CUA workaround")
4058 (defadvice cua-delete-region (around anything-avoid-cua activate)
4059 (ignore-errors ad-do-it))
4061 (defadvice copy-region-as-kill (around anything-avoid-cua activate)
4062 (if cua-mode
4063 (ignore-errors ad-do-it)
4064 ad-do-it))
4066 ;;(@* "Attribute Documentation")
4067 (defun anything-describe-anything-attribute (anything-attribute)
4068 "Display the full documentation of ANYTHING-ATTRIBUTE.
4069 ANYTHING-ATTRIBUTE should be a symbol."
4070 (interactive (list (intern
4071 (completing-read
4072 "Describe anything attribute: "
4073 (mapcar 'symbol-name anything-additional-attributes)
4074 nil t))))
4075 (with-output-to-temp-buffer "*Help*"
4076 (princ (get anything-attribute 'anything-attrdoc))))
4078 (anything-document-attribute 'name "mandatory"
4079 " The name of the source. It is also the heading which appears
4080 above the list of matches from the source. Must be unique.")
4082 (anything-document-attribute 'header-name "optional"
4083 " A function returning the display string of the header. Its
4084 argument is the name of the source. This attribute is useful to
4085 add an additional information with the source name.")
4087 (anything-document-attribute 'candidates "mandatory if candidates-in-buffer attribute is not provided"
4088 " Specifies how to retrieve candidates from the source. It can
4089 either be a variable name, a function called with no parameters
4090 or the actual list of candidates.
4092 The list must be a list whose members are strings, symbols
4093 or (DISPLAY . REAL) pairs.
4095 In case of (DISPLAY . REAL) pairs, the DISPLAY string is shown
4096 in the Anything buffer, but the REAL one is used as action
4097 argument when the candidate is selected. This allows a more
4098 readable presentation for candidates which would otherwise be,
4099 for example, too long or have a common part shared with other
4100 candidates which can be safely replaced with an abbreviated
4101 string for display purposes.
4103 Note that if the (DISPLAY . REAL) form is used then pattern
4104 matching is done on the displayed string, not on the real
4105 value.
4107 If the candidates have to be retrieved asynchronously (for
4108 example, by an external command which takes a while to run)
4109 then the function should start the external command
4110 asynchronously and return the associated process object.
4111 Anything will take care of managing the process (receiving the
4112 output from it, killing it if necessary, etc.). The process
4113 should return candidates matching the current pattern (see
4114 variable `anything-pattern'.)
4116 Note that currently results from asynchronous sources appear
4117 last in the anything buffer regardless of their position in
4118 `anything-sources'.")
4120 (anything-document-attribute 'action "mandatory if type attribute is not provided"
4121 " It is a list of (DISPLAY . FUNCTION) pairs or FUNCTION.
4122 FUNCTION is called with one parameter: the selected candidate.
4124 An action other than the default can be chosen from this list
4125 of actions for the currently selected candidate (by default
4126 with TAB). The DISPLAY string is shown in the completions
4127 buffer and the FUNCTION is invoked when an action is
4128 selected. The first action of the list is the default.")
4130 (anything-document-attribute 'coerce "optional"
4131 " It's a function called with one argument: the selected candidate.
4133 This function is intended for type convertion.
4134 In normal case, the selected candidate (string) is passed to action function.
4135 If coerce function is specified, it is called just before action function.
4137 Example: converting string to symbol
4138 (coerce . intern)")
4140 (anything-document-attribute 'type "optional if action attribute is provided"
4141 " Indicates the type of the items the source returns.
4143 Merge attributes not specified in the source itself from
4144 `anything-type-attributes'.
4146 This attribute is implemented by plug-in.")
4148 (anything-document-attribute 'init "optional"
4149 " Function called with no parameters when anything is started. It
4150 is useful for collecting current state information which can be
4151 used to create the list of candidates later.
4153 For example, if a source needs to work with the current
4154 directory then it can store its value here, because later
4155 anything does its job in the minibuffer and in the
4156 `anything-buffer' and the current directory can be different
4157 there.")
4159 (anything-document-attribute 'delayed-init "optional"
4160 " Function called with no parameters before candidate function is
4161 called. It is similar with `init' attribute, but its
4162 evaluation is deferred. It is useful to combine with ")
4164 (anything-document-attribute 'match "optional"
4165 " List of functions called with one parameter: a candidate. The
4166 function should return non-nil if the candidate matches the
4167 current pattern (see variable `anything-pattern').
4169 This attribute allows the source to override the default
4170 pattern matching based on `string-match'. It can be used, for
4171 example, to implement a source for file names and do the
4172 pattern matching on the basename of files, since it's more
4173 likely one is typing part of the basename when searching for a
4174 file, instead of some string anywhere else in its path.
4176 If the list contains more than one function then the list of
4177 matching candidates from the source is constructed by appending
4178 the results after invoking the first function on all the
4179 potential candidates, then the next function, and so on. The
4180 matching candidates supplied by the first function appear first
4181 in the list of results and then results from the other
4182 functions, respectively.
4184 This attribute has no effect for asynchronous sources (see
4185 attribute `candidates'), since they perform pattern matching
4186 themselves.")
4188 (anything-document-attribute 'candidate-transformer "optional"
4189 " It's a function or a list of functions called with one argument
4190 when the completion list from the source is built. The argument
4191 is the list of candidates retrieved from the source. The
4192 function should return a transformed list of candidates which
4193 will be used for the actual completion. If it is a list of
4194 functions, it calls each function sequentially.
4196 This can be used to transform or remove items from the list of
4197 candidates.
4199 Note that `candidates' is run already, so the given transformer
4200 function should also be able to handle candidates with (DISPLAY
4201 . REAL) format.")
4203 (anything-document-attribute 'filtered-candidate-transformer "optional"
4204 " It has the same format as `candidate-transformer', except the
4205 function is called with two parameters: the candidate list and
4206 the source.
4208 This transformer is run on the candidate list which is already
4209 filtered by the current pattern. While `candidate-transformer'
4210 is run only once, it is run every time the input pattern is
4211 changed.
4213 It can be used to transform the candidate list dynamically, for
4214 example, based on the current pattern.
4216 In some cases it may also be more efficent to perform candidate
4217 transformation here, instead of with `candidate-transformer'
4218 even if this transformation is done every time the pattern is
4219 changed. For example, if a candidate set is very large then
4220 `candidate-transformer' transforms every candidate while only
4221 some of them will actually be dislpayed due to the limit
4222 imposed by `anything-candidate-number-limit'.
4224 Note that `candidates' and `candidate-transformer' is run
4225 already, so the given transformer function should also be able
4226 to handle candidates with (DISPLAY . REAL) format.
4228 This option has no effect for asynchronous sources. (Not yet,
4229 at least.")
4231 (anything-document-attribute 'action-transformer "optional"
4232 " It's a function or a list of functions called with two
4233 arguments when the action list from the source is
4234 assembled. The first argument is the list of actions, the
4235 second is the current selection. If it is a list of functions,
4236 it calls each function sequentially.
4238 The function should return a transformed action list.
4240 This can be used to customize the list of actions based on the
4241 currently selected candidate.")
4243 (anything-document-attribute 'pattern-transformer "optional"
4244 " It's a function or a list of functions called with one argument
4245 before computing matches. Its argument is `anything-pattern'.
4246 Functions should return transformed `anything-pattern'.
4248 It is useful to change interpretation of `anything-pattern'.")
4250 (anything-document-attribute 'delayed "optional"
4251 " Candidates from the source are shown only if the user stops
4252 typing and is idle for `anything-idle-delay' seconds.")
4254 (anything-document-attribute 'volatile "optional"
4255 " Indicates the source assembles the candidate list dynamically,
4256 so it shouldn't be cached within a single Anything
4257 invocation. It is only applicable to synchronous sources,
4258 because asynchronous sources are not cached.")
4260 (anything-document-attribute 'requires-pattern "optional"
4261 " If present matches from the source are shown only if the
4262 pattern is not empty. Optionally, it can have an integer
4263 parameter specifying the required length of input which is
4264 useful in case of sources with lots of candidates.")
4266 (anything-document-attribute 'persistent-action "optional"
4267 " Function called with one parameter; the selected candidate.
4269 An action performed by `anything-execute-persistent-action'.
4270 If none, use the default action.")
4272 (anything-document-attribute 'candidates-in-buffer "optional"
4273 " Shortcut attribute for making and narrowing candidates using
4274 buffers. This newly-introduced attribute prevents us from
4275 forgetting to add volatile and match attributes.
4277 See docstring of `anything-candidates-in-buffer'.
4279 (candidates-in-buffer) is equivalent of three attributes:
4280 (candidates . anything-candidates-in-buffer)
4281 (volatile)
4282 (match identity)
4284 (candidates-in-buffer . candidates-function) is equivalent of:
4285 (candidates . candidates-function)
4286 (volatile)
4287 (match identity)
4289 This attribute is implemented by plug-in.")
4291 (anything-document-attribute 'search "optional"
4292 " List of functions like `re-search-forward' or `search-forward'.
4293 Buffer search function used by `anything-candidates-in-buffer'.
4294 By default, `anything-candidates-in-buffer' uses `re-search-forward'.
4295 This attribute is meant to be used with
4296 (candidates . anything-candidates-in-buffer) or
4297 (candidates-in-buffer) in short.")
4299 (anything-document-attribute 'search-from-end "optional"
4300 " Make `anything-candidates-in-buffer' search from the end of buffer.
4301 If this attribute is specified, `anything-candidates-in-buffer' uses
4302 `re-search-backward' instead.")
4304 (anything-document-attribute 'get-line "optional"
4305 " A function like `buffer-substring-no-properties' or `buffer-substring'.
4306 This function converts point of line-beginning and point of line-end,
4307 which represents a candidate computed by `anything-candidates-in-buffer'.
4308 By default, `anything-candidates-in-buffer' uses
4309 `buffer-substring-no-properties'.")
4311 (anything-document-attribute 'display-to-real "optional"
4312 " Function called with one parameter; the selected candidate.
4314 The function transforms the selected candidate, and the result
4315 is passed to the action function. The display-to-real
4316 attribute provides another way to pass other string than one
4317 shown in Anything buffer.
4319 Traditionally, it is possible to make candidates,
4320 candidate-transformer or filtered-candidate-transformer
4321 function return a list with (DISPLAY . REAL) pairs. But if REAL
4322 can be generated from DISPLAY, display-to-real is more
4323 convenient and faster.")
4325 (anything-document-attribute 'real-to-display "optional"
4326 " Function called with one parameter; the selected candidate.
4328 The inverse of display-to-real attribute.
4330 The function transforms the selected candidate, which is passed
4331 to the action function, for display. The real-to-display
4332 attribute provides the other way to pass other string than one
4333 shown in Anything buffer.
4335 Traditionally, it is possible to make candidates,
4336 candidate-transformer or filtered-candidate-transformer
4337 function return a list with (DISPLAY . REAL) pairs. But if
4338 DISPLAY can be generated from REAL, real-to-display is more
4339 convenient.
4341 Note that DISPLAY parts returned from candidates /
4342 candidate-transformer are IGNORED as the name `display-to-real'
4343 says.")
4345 (anything-document-attribute 'cleanup "optional"
4346 " Function called with no parameters when *anything* buffer is closed. It
4347 is useful for killing unneeded candidates buffer.
4349 Note that the function is executed BEFORE performing action.")
4351 (anything-document-attribute 'candidate-number-limit "optional"
4352 " Override `anything-candidate-number-limit' only for this source.")
4354 (anything-document-attribute 'accept-empty "optional"
4355 " Pass empty string \"\" to action function.")
4357 (anything-document-attribute 'disable-shortcuts "optional"
4358 " Disable `anything-enable-shortcuts' in current `anything' session.
4360 This attribute is implemented by plug-in.")
4362 (anything-document-attribute 'dummy "optional"
4363 " Set `anything-pattern' to candidate. If this attribute is
4364 specified, The candidates attribute is ignored.
4366 This attribute is implemented by plug-in.
4367 This plug-in implies disable-shortcuts plug-in.")
4369 (anything-document-attribute 'multiline "optional"
4370 " Enable to selection multiline candidates.")
4372 (anything-document-attribute 'update "optional"
4373 (substitute-command-keys
4374 " Function called with no parameters when \
4375 \\<anything-map>\\[anything-force-update] is pressed."))
4377 (anything-document-attribute 'mode-line "optional"
4378 " source local `anything-mode-line-string'. (included in `mode-line-format')
4379 It accepts also variable/function name.")
4381 (anything-document-attribute 'header-line "optional"
4382 " source local `header-line-format'.
4383 It accepts also variable/function name. ")
4385 (anything-document-attribute
4386 'resume "optional"
4387 " Function called with no parameters when `anything-resume' is started.")
4389 (anything-document-attribute 'keymap "optional"
4390 " Specific keymap for this source.
4391 It is useful to have a keymap per source when using more than one source.
4392 Otherwise, a keymap can be set per command with `anything' argument KEYMAP.
4393 NOTE: when a source have `anything-map' as keymap attr,
4394 the global value of `anything-map' will override the actual local one.")
4396 (anything-document-attribute 'help-message "optional"
4397 " Help message for this source.
4398 If not present, `anything-help-message' value will be used.")
4401 ;; (@* "Bug Report")
4402 (defvar anything-maintainer-mail-address "emacs-anything@googlegroups.com")
4404 (defvar anything-bug-report-salutation
4405 "Describe bug below, using a precise recipe.
4407 When I executed M-x ...
4409 How to send a bug report:
4410 1) Be sure to use the LATEST version of anything.el.
4411 2) Enable debugger. M-x toggle-debug-on-error or (setq debug-on-error t)
4412 3) Use Lisp version instead of compiled one: (load \"anything.el\")
4413 4) If you got an error, please paste *Backtrace* buffer.
4414 5) Type C-c C-c to send.")
4416 (defvar anything-no-dump-variables
4417 '(anything-candidate-buffer-alist
4418 anything-digit-overlays
4419 anything-help-message
4420 anything-candidate-cache
4422 "Variables not to dump in bug report.")
4424 (defun anything-dumped-variables-in-bug-report ()
4425 (let ((hash (make-hash-table)))
4426 (loop for var in (apropos-internal "anything-" 'boundp)
4427 for vname = (symbol-name var)
4428 unless (or (string-match "-map$" vname)
4429 (string-match "^anything-c-source-" vname)
4430 (string-match "-hash$" vname)
4431 (string-match "-face$" vname)
4432 (memq var anything-no-dump-variables))
4433 collect var)))
4435 (defun anything-send-bug-report ()
4436 "Send a bug report of anything.el."
4437 (interactive)
4438 (with-current-buffer (or anything-last-buffer
4439 (current-buffer))
4440 (reporter-submit-bug-report
4441 anything-maintainer-mail-address
4442 "anything.el"
4443 (anything-dumped-variables-in-bug-report)
4444 nil nil
4445 anything-bug-report-salutation)))
4447 (defun anything-send-bug-report-from-anything ()
4448 "Send a bug report of anything.el in anything session."
4449 (interactive)
4450 (anything-run-after-quit 'anything-send-bug-report))
4452 ;; Debugging function.
4453 (defun* anything-test-candidates
4454 (sources &optional (input "")
4455 (compile-source-functions
4456 anything-compile-source-functions-default))
4457 "Test helper function for anything.
4458 Given pseudo `anything-sources' and `anything-pattern', returns list like
4459 ((\"source name1\" (\"candidate1\" \"candidate2\"))
4460 (\"source name2\" (\"candidate3\" \"candidate4\")))"
4461 (let ((anything-test-mode t)
4462 anything-enable-shortcuts
4463 anything-candidate-cache
4464 (anything-compile-source-functions compile-source-functions)
4465 anything-before-initialize-hook
4466 anything-after-initialize-hook
4467 anything-update-hook
4468 anything-test-candidate-list)
4469 (get-buffer-create anything-buffer)
4470 (anything-initialize nil input sources)
4471 (anything-update)
4472 ;; test-mode spec: select 1st candidate!
4473 (with-current-buffer anything-buffer
4474 (forward-line 1)
4475 (anything-mark-current-line))
4476 (prog1
4477 anything-test-candidate-list
4478 (anything-cleanup))))
4481 ;; (@* "Unit Tests")
4482 ;; See developer-tools/unit-test-anything.el
4484 (provide 'anything)
4486 ;; Local Variables:
4487 ;; byte-compile-warnings: (not cl-functions obsolete)
4488 ;; coding: utf-8
4489 ;; End:
4491 ;;; anything.el ends here