* anything.el: anything-map: M-a: anything-mark-all
[anything-config.git] / anything.el
blobe3ae4852023e00c83035e26a871b747f67f28e4c
1 ;;; anything.el --- open anything / QuickSilver-like candidate-selection framework
3 ;; Copyright (C) 2007 Tamas Patrovics
4 ;; 2008 ~ 2012 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 (mapcar (lambda (v)
1177 (cons v (symbol-value v)))
1178 anything-restored-variables))
1179 (--post-command-hook-pair (cons post-command-hook
1180 (default-value 'post-command-hook))))
1181 (setq post-command-hook '(t))
1182 (setq-default post-command-hook nil)
1183 (unwind-protect (progn ,@body)
1184 (loop for (var . value) in --orig-vars
1185 do (set var value))
1186 (setq post-command-hook (car --post-command-hook-pair))
1187 (setq-default post-command-hook (cdr --post-command-hook-pair))
1188 (anything-log "restore variables"))))
1190 (defun* anything-attr (attribute-name &optional
1191 (src (anything-get-current-source)))
1192 "Get the value of ATTRIBUTE-NAME of SRC.
1193 if SRC is omitted, use current source.
1194 It is useful to write your sources."
1195 (anything-aif (assq attribute-name src)
1196 (cdr it)))
1198 (defun* anything-attr* (attribute-name
1199 &optional (src (anything-get-current-source)))
1200 "Pass the value of ATTRIBUTE-NAME of SRC to `anything-interpret-value'.
1201 if SRC is omitted, use current source.
1202 It is useful to write your sources."
1203 (anything-interpret-value (anything-attr attribute-name src)))
1205 (defun* anything-attr-defined (attribute-name
1206 &optional (src (anything-get-current-source)))
1207 "Return non-nil if ATTRIBUTE-NAME of SRC is defined.
1208 if SRC is omitted, use current source.
1209 It is useful to write your sources."
1210 (and (assq attribute-name src) t))
1212 (defun* anything-attrset (attribute-name value
1213 &optional
1214 (src (anything-get-current-source)))
1215 "Set the value of ATTRIBUTE-NAME of SRC to VALUE.
1216 if SRC is omitted, use current source.
1217 It is useful to write your sources."
1218 (anything-aif (assq attribute-name src)
1219 (setcdr it value)
1220 (setcdr src (cons (cons attribute-name value) (cdr src))))
1221 value)
1223 (defun anything-set-source-filter (sources)
1224 "Set the value of `anything-source-filter' to SOURCES and update.
1226 This function sets a filter for anything sources and it may be
1227 called while anything is running. It can be used to toggle
1228 displaying of sources dinamically. For example, additional keys
1229 can be bound into `anything-map' to display only the file-related
1230 results if there are too many matches from other sources and
1231 you're after files only:
1233 Shift+F shows only file results from some sources:
1235 \(define-key anything-map \"F\" 'anything-my-show-files-only)
1237 \(defun anything-my-show-files-only ()
1238 (interactive)
1239 (anything-set-source-filter '(\"File Name History\"
1240 \"Files from Current Directory\")))
1242 Shift+A shows all results:
1244 \(define-key anything-map \"A\" 'anything-my-show-all)
1246 \(defun anything-my-show-all ()
1247 (interactive)
1248 (anything-set-source-filter nil))
1250 Note that you have to prefix the functions with anything- prefix,
1251 otherwise they won't be bound when Anything is used under
1252 Iswitchb. The -my- part is added to avoid collisions with
1253 existing Anything function names."
1254 (unless (and (listp sources)
1255 (loop for name in sources always (stringp name)))
1256 (error "Invalid data in `anything-set-source-filter': %S" sources))
1257 (setq anything-source-filter sources)
1258 (anything-log-eval anything-source-filter)
1259 (anything-update))
1261 (defun anything-set-sources (sources &optional no-init no-update)
1262 "Set SOURCES during `anything' invocation.
1263 If NO-INIT is non-nil, skip executing init functions of SOURCES.
1264 If NO-UPDATE is non-nil, skip executing `anything-update'."
1265 (with-current-buffer anything-buffer
1266 (setq anything-compiled-sources nil
1267 anything-sources sources
1268 anything-last-sources-local sources)
1269 (anything-log-eval anything-compiled-sources anything-sources))
1270 (unless no-init (anything-funcall-foreach 'init))
1271 (unless no-update (anything-update)))
1273 (defvar anything-compile-source-functions
1274 '(anything-compile-source--type
1275 anything-compile-source--dummy
1276 anything-compile-source--disable-shortcuts
1277 anything-compile-source--candidates-in-buffer)
1278 "Functions to compile elements of `anything-sources' (plug-in).")
1280 (defun anything-get-sources ()
1281 "Return compiled `anything-sources', which is memoized.
1283 Attributes:
1285 - type
1286 `anything-type-attributes' are merged in.
1287 - candidates-buffer
1288 candidates, volatile and match attribute are created."
1289 (cond
1290 ;; action
1291 ((anything-action-window)
1292 anything-sources)
1293 ;; memoized
1294 (anything-compiled-sources)
1295 ;; first time
1297 (prog1
1298 (setq anything-compiled-sources
1299 (anything-compile-sources
1300 anything-sources anything-compile-source-functions))
1301 (anything-log-eval anything-compiled-sources)))))
1303 (defun* anything-get-selection (&optional (buffer nil buffer-s)
1304 force-display-part)
1305 "Return the currently selected item or nil.
1306 if BUFFER is nil or unspecified, use anything-buffer as default value.
1307 If FORCE-DISPLAY-PART is non-nil, return the display string.
1308 If FORCE-DISPLAY-PART value is 'withprop the display string is returned
1309 with its properties."
1310 (setq buffer (if (and buffer buffer-s) buffer anything-buffer))
1311 (unless (anything-empty-buffer-p buffer)
1312 (with-current-buffer buffer
1313 (let* ((disp-fn (if (eq force-display-part 'withprop)
1314 'buffer-substring
1315 'buffer-substring-no-properties))
1316 (selection
1317 (or (and (not force-display-part)
1318 (get-text-property (overlay-start
1319 anything-selection-overlay)
1320 'anything-realvalue))
1321 ;; It is needed to return properties of DISP in some case,
1322 ;; e.g for `anything-confirm-and-exit-minibuffer',
1323 ;; so use `buffer-substring' here when 'withprop is specified.
1324 (let ((disp (funcall disp-fn
1325 (overlay-start anything-selection-overlay)
1326 (1- (overlay-end anything-selection-overlay))))
1327 (source (anything-get-current-source)))
1328 (anything-aif (and (not force-display-part)
1329 (assoc-default 'display-to-real source))
1330 (anything-funcall-with-source source it disp)
1331 disp)))))
1332 (unless (equal selection "")
1333 (anything-log-eval selection)
1334 selection)))))
1336 (defun anything-get-action ()
1337 "Return the associated action for the selected candidate.
1338 It is a function symbol \(sole action\) or list
1339 of \(action-display . function\)."
1340 (unless (anything-empty-buffer-p (anything-buffer-get))
1341 (anything-aif (anything-attr 'action-transformer)
1342 (anything-composed-funcall-with-source
1343 (anything-get-current-source) it
1344 (anything-attr 'action) (anything-get-selection))
1345 (anything-attr 'action))))
1347 (defun anything-get-current-source ()
1348 "Return the source for the current selection.
1349 Use it in init, candidates, action, candidate-transformer,
1350 filtered-candidate-transformer functions."
1351 (declare (special source))
1352 ;; The name `anything-get-current-source' should be used in init function etc.
1353 (cond ((and (boundp 'anything-source-name) (stringp anything-source-name))
1354 source)
1355 ((get-buffer (anything-buffer-get))
1356 (with-current-buffer (anything-buffer-get)
1358 ;; This happen only when `anything-source-in-each-line-flag'
1359 ;; is non--nil and there is candidates in buffer.
1360 (get-text-property (point) 'anything-source)
1361 ;; Return nil when no--candidates.
1362 (block exit
1363 ;; This goto-char shouldn't be necessary, but point is moved to
1364 ;; point-min somewhere else which shouldn't happen.
1365 (goto-char (overlay-start anything-selection-overlay))
1366 (let* ((header-pos (or (anything-get-previous-header-pos)
1367 (anything-get-next-header-pos)))
1368 (source-name
1369 (save-excursion
1370 (unless header-pos
1371 (return-from exit nil))
1372 (goto-char header-pos)
1373 (anything-current-line-contents))))
1374 (loop for source in (anything-get-sources) thereis
1375 (and (equal (assoc-default 'name source) source-name)
1376 source)))))))))
1378 (defun anything-buffer-is-modified (buffer)
1379 "Return non-nil when BUFFER is modified since `anything' was invoked."
1380 (let* ((b (get-buffer buffer))
1381 (key (concat (buffer-name b) "/" (anything-attr 'name)))
1382 (source-tick (or (gethash key anything-tick-hash) 0))
1383 (buffer-tick (buffer-chars-modified-tick b))
1384 (modifiedp (/= source-tick buffer-tick)))
1385 (puthash key buffer-tick anything-tick-hash)
1386 (anything-log-eval buffer modifiedp)
1387 modifiedp))
1389 (defun anything-current-buffer-is-modified ()
1390 "Check if `anything-current-buffer' is modified since `anything' was invoked."
1391 (anything-buffer-is-modified anything-current-buffer))
1393 (defvar anything-quit nil)
1394 (defun anything-run-after-quit (function &rest args)
1395 "Perform an action after quitting `anything'.
1396 The action is to call FUNCTION with arguments ARGS."
1397 (setq anything-quit t)
1398 (anything-kill-async-processes)
1399 (anything-log-eval function args)
1400 (apply 'run-with-idle-timer 0 nil function args)
1401 (anything-exit-minibuffer))
1404 (defun define-anything-type-attribute (type definition &optional doc)
1405 "Register type attribute of TYPE as DEFINITION with DOC.
1406 DOC is displayed in `anything-type-attributes' docstring.
1408 Use this function is better than setting `anything-type-attributes' directly."
1409 (loop for i in definition do
1410 ;; without `ignore-errors', error at emacs22
1411 (ignore-errors (setf i (delete nil i))))
1412 (anything-add-type-attribute type definition)
1413 (and doc (anything-document-type-attribute type doc))
1414 nil)
1416 (defvaralias 'anything-attributes 'anything-additional-attributes)
1417 (defvar anything-additional-attributes nil
1418 "List of all `anything' attributes.")
1420 (defun anything-document-attribute (attribute short-doc &optional long-doc)
1421 "Register ATTRIBUTE documentation introduced by plug-in.
1422 SHORT-DOC is displayed beside attribute name.
1423 LONG-DOC is displayed below attribute name and short documentation."
1424 (if long-doc
1425 (setq short-doc (concat "(" short-doc ")"))
1426 (setq long-doc short-doc
1427 short-doc ""))
1428 (add-to-list 'anything-additional-attributes attribute t)
1429 (put attribute 'anything-attrdoc
1430 (concat "- " (symbol-name attribute)
1431 " " short-doc "\n\n" long-doc "\n")))
1433 (put 'anything-document-attribute 'lisp-indent-function 2)
1435 (defun anything-interpret-value (value &optional source)
1436 "Interpret VALUE as variable, function or literal.
1437 If VALUE is a function, call it with no arguments and return the value.
1438 If SOURCE is `anything' source, `anything-source-name' is source name.
1440 If VALUE is a variable, return the value.
1442 If VALUE is a symbol, but it is not a function or a variable, cause an error.
1444 Otherwise, return VALUE itself."
1445 (cond ((and source (functionp value))
1446 (anything-funcall-with-source source value))
1447 ((functionp value)
1448 (funcall value))
1449 ((and (symbolp value) (boundp value))
1450 (symbol-value value))
1451 ((symbolp value)
1452 (error "anything-interpret-value: Symbol must be a function or a variable"))
1454 value)))
1456 (defun anything-once (function &rest args)
1457 "Ensure FUNCTION with ARGS to be called once in `anything' session."
1458 (let ((spec (cons function args)))
1459 (unless (member spec anything-once-called-functions)
1460 (apply function args)
1461 (push spec anything-once-called-functions))))
1464 ;; (@* "Core: API helper")
1465 (defun* anything-empty-buffer-p (&optional (buffer anything-buffer))
1466 "Check if BUFFER have candidates.
1467 Default value for BUFFER is `anything-buffer'."
1468 (zerop (buffer-size (and buffer (get-buffer buffer)))))
1470 (defun anything-let-eval-varlist (varlist)
1471 "Return the list of pairs VARLIST with each cdr of pair evaluated.
1472 If VARLIST contain single elements, those are returned
1473 as a list of one element."
1474 (mapcar (lambda (pair)
1475 (if (listp pair)
1476 (cons (car pair) (eval (cadr pair)))
1477 (cons pair nil)))
1478 varlist))
1480 ;; [NOT USED]
1481 ;; (defun anything-let*-eval-varlist (varlist)
1482 ;; (let ((vars (mapcar (lambda (pair)
1483 ;; (or (car-safe pair) pair))
1484 ;; varlist)))
1485 ;; (eval `(let ,vars
1486 ;; ,@(mapcar (lambda (pair)
1487 ;; (if (listp pair)
1488 ;; `(setq ,(car pair) ,(cadr pair))
1489 ;; `(setq ,pair nil)))
1490 ;; varlist)
1491 ;; (mapcar (lambda (v)
1492 ;; (cons v (symbol-value v)))
1493 ;; ',vars)))))
1495 (defun anything-let-internal (binding bodyfunc)
1496 "Set BINDING to anything buffer-local variables and Evaluate BODYFUNC.
1497 BINDING is a list of \(VARNAME . VALUE\) pair."
1498 (setq anything-let-variables binding)
1499 (unwind-protect
1500 (funcall bodyfunc)
1501 (setq anything-let-variables nil)))
1504 ;; (@* "Core: tools")
1505 (defun anything-current-line-contents ()
1506 "Current line string without properties."
1507 (buffer-substring-no-properties (point-at-bol) (point-at-eol)))
1509 (defun anything-funcall-with-source (source func &rest args)
1510 "Call from SOURCE FUNC list or single function FUNC with ARGS.
1511 FUNC can be a symbol or a list of functions.
1512 Return the result of last function call."
1513 (let ((anything-source-name (assoc-default 'name source))
1514 result)
1515 (anything-log-eval anything-source-name func args)
1516 (dolist (func (if (functionp func) (list func) func) result)
1517 (setq result (apply func args)))))
1519 (defun anything-funcall-foreach (sym)
1520 "Call the function SYM for each source if any."
1521 (dolist (source (anything-get-sources))
1522 (anything-aif (assoc-default sym source)
1523 (anything-funcall-with-source source it))))
1525 (defun anything-normalize-sources (sources)
1526 "If SOURCES is only one source, make a list of one element."
1527 (cond ((or (and sources
1528 (symbolp sources))
1529 (and (listp sources) (assq 'name sources)))
1530 (list sources))
1531 (sources)
1532 (t anything-sources)))
1534 (defun anything-approximate-candidate-number (&optional in-current-source)
1535 "Return approximate number of candidates in `anything-buffer'.
1536 If IN-CURRENT-SOURCE is provided return number of candidates
1537 in the source where point is.
1538 It is used to check if candidate number is 0, 1, or 2+."
1539 (with-current-buffer anything-buffer
1540 (save-excursion
1541 (if in-current-source
1542 (goto-char (anything-get-previous-header-pos))
1543 (goto-char (point-min)))
1544 (forward-line 1)
1545 (let ((count-multi 1))
1546 (if (anything-pos-multiline-p)
1547 (save-excursion
1548 (loop while (and (not (if in-current-source
1549 (save-excursion
1550 (forward-line 2)
1551 (or (anything-pos-header-line-p) (eobp)))
1552 (eobp)))
1553 (search-forward anything-candidate-separator nil t))
1554 do (incf count-multi)
1555 finally return count-multi))
1556 (save-excursion
1557 (loop with ln = 0
1558 while (not (if in-current-source
1559 (or (anything-pos-header-line-p) (eobp))
1560 (eobp)))
1561 unless (anything-pos-header-line-p)
1562 do (incf ln)
1563 do (forward-line 1) finally return ln)))))))
1565 (defmacro with-anything-quittable (&rest body)
1566 "If an error occur in execution of BODY, quit anything safely."
1567 (declare (indent 0) (debug t))
1568 `(let (inhibit-quit)
1569 (condition-case v
1570 (progn ,@body)
1571 (quit (setq anything-quit t)
1572 (exit-minibuffer)
1573 (keyboard-quit)))))
1575 (defun anything-compose (arg-lst func-lst)
1576 "Apply arguments specified in ARG-LST with each function of FUNC-LST.
1577 The result of each function will be the new `car' of ARG-LST.
1579 This function allows easy sequencing of transformer functions."
1580 (dolist (func func-lst)
1581 (setcar arg-lst (apply func arg-lst)))
1582 (car arg-lst))
1584 (defun anything-composed-funcall-with-source (source funcs &rest args)
1585 "With SOURCE apply `anything-funcall-with-source' with each FUNCS and ARGS.
1586 This is used in transformers to modify candidates list."
1587 (if (functionp funcs)
1588 (apply 'anything-funcall-with-source source funcs args)
1589 (apply 'anything-funcall-with-source source
1590 (lambda (&rest args)
1591 (anything-compose args funcs))
1592 args)))
1594 (defun anything-new-timer (variable timer)
1595 "Give VARIABLE value to TIMER and cancel old timer."
1596 (anything-aif (symbol-value variable)
1597 (cancel-timer it))
1598 (set variable timer))
1601 ;; (@* "Core: entry point")
1602 (defconst anything-argument-keys
1603 '(:sources :input :prompt :resume :preselect :buffer :keymap :default :history))
1605 ;;;###autoload
1606 (defun anything (&rest plist)
1607 "Main function to execute anything sources.
1609 Keywords supported:
1610 :sources :input :prompt :resume :preselect :buffer :keymap :default :history
1611 Extra keywords are supported and can be added, see below.
1613 When call interactively with no arguments deprecated `anything-sources'
1614 will be used if non--nil.
1616 PLIST is a list like \(:key1 val1 :key2 val2 ...\) or
1617 \(&optional sources input prompt resume preselect buffer keymap default history\).
1619 Basic keywords are the following:
1621 \:sources
1623 Temporary value of `anything-sources'. It also accepts a
1624 symbol, interpreted as a variable of an anything source. It
1625 also accepts an alist representing an anything source, which is
1626 detected by \(assq 'name ANY-SOURCES\)
1628 \:input
1630 Temporary value of `anything-pattern', ie. initial input of minibuffer.
1632 \:prompt
1634 Prompt other than \"pattern: \".
1636 \:resume
1638 If t, Resurrect previously instance of `anything'. Skip the initialization.
1639 If 'noresume, this instance of `anything' cannot be resumed.
1641 \:preselect
1643 Initially selected candidate. Specified by exact candidate or a regexp.
1645 \:buffer
1647 `anything-buffer' instead of *anything*.
1649 \:keymap
1651 `anything-map' for current `anything' session.
1653 \:default
1655 A default argument that will be inserted in minibuffer \
1656 with \\<minibuffer-local-map>\\[next-history-element].
1657 When nil of not present `thing-at-point' will be used instead.
1659 \:history
1661 By default all minibuffer input is pushed to `minibuffer-history',
1662 if an argument HISTORY is provided, input will be pushed to HISTORY.
1663 History element should be a symbol.
1665 Of course, conventional arguments are supported, the two are same.
1667 \(anything :sources sources :input input :prompt prompt :resume resume
1668 :preselect preselect :buffer buffer :keymap keymap :default default
1669 :history history\)
1670 \(anything sources input prompt resume preselect buffer keymap default history\)
1672 Other keywords are interpreted as local variables of this anything session.
1673 The `anything-' prefix can be omitted. For example,
1675 \(anything :sources 'anything-c-source-buffers
1676 :buffer \"*buffers*\" :candidate-number-limit 10\)
1678 means starting anything session with `anything-c-source-buffers'
1679 source in *buffers* buffer and set variable `anything-candidate-number-limit'
1680 to 10 as session local variable."
1681 (interactive)
1682 (if (keywordp (car plist))
1683 (anything-let-internal
1684 (anything-parse-keys plist)
1685 (lambda ()
1686 (apply 'anything
1687 (mapcar (lambda (key) (plist-get plist key))
1688 anything-argument-keys))))
1689 (apply 'anything-internal plist)))
1691 (defun anything-parse-keys (keys)
1692 "Parse the KEYS arguments of `anything'.
1693 Return only the keys that are not in `anything-argument-keys'.
1694 It is used to set local variables via `anything-let-internal'.
1695 This allow to add arguments that are not part of `anything-argument-keys',
1696 but are valid anything attributes.
1697 i.e :candidate-number-limit will be bound to `anything-candidate-number-limit'
1698 in source."
1699 ;; (anything-parse-keys '(:sources ((name . "test")
1700 ;; (candidates . (a b c)))
1701 ;; :buffer "toto"
1702 ;; :candidate-number-limit 4))
1703 ;; ==> ((anything-candidate-number-limit . 4))
1704 (loop for (key value) on keys by #'cddr
1705 for symname = (substring (symbol-name key) 1)
1706 for sym = (intern (if (string-match "^anything-" symname)
1707 symname
1708 (concat "anything-" symname)))
1709 unless (memq key anything-argument-keys)
1710 collect (cons sym value)))
1712 ;;; (@* "Core: entry point helper")
1713 (defun anything-internal (&optional
1714 any-sources any-input
1715 any-prompt any-resume
1716 any-preselect any-buffer
1717 any-keymap any-default any-history)
1718 "The internal anything function called by `anything'.
1719 For ANY-SOURCES ANY-INPUT ANY-PROMPT ANY-RESUME ANY-PRESELECT ANY-BUFFER and
1720 ANY-KEYMAP ANY-DEFAULT ANY-HISTORY See `anything'."
1721 (anything-log (concat "[Start session] " (make-string 41 ?+)))
1722 (anything-log-eval any-prompt any-preselect
1723 any-buffer any-keymap any-default)
1724 (let ((old-overridding-local-map overriding-local-map))
1725 (unwind-protect
1726 (condition-case v
1727 (let ( ;; It is needed because `anything-source-name' is non-nil
1728 ;; when `anything' is invoked by action. Awful global scope.
1729 anything-source-name
1730 anything-in-persistent-action
1731 anything-quit
1732 ;; [2012-10-16] move to `anything-update' to show right value of `case-fold-search'
1733 ;; (case-fold-search t)
1734 (anything-buffer (or any-buffer anything-buffer))
1735 ;; cua-mode ; avoid error when region is selected
1737 (with-anything-restore-variables
1738 (anything-initialize any-resume any-input any-sources)
1739 (anything-display-buffer anything-buffer)
1740 (anything-log "show prompt")
1741 (unwind-protect
1742 (anything-read-pattern-maybe
1743 any-prompt any-input any-preselect
1744 any-resume any-keymap any-default
1745 (when (and any-history (symbolp any-history)) any-history))
1746 (anything-cleanup)))
1747 (prog1 (unless anything-quit
1748 (anything-execute-selection-action-1))
1749 (anything-log (concat "[End session] " (make-string 41 ?-)))))
1750 (quit
1751 (anything-restore-position-on-quit)
1752 (anything-log (concat "[End session (quit)] " (make-string 34 ?-)))
1753 nil))
1754 (setq overriding-local-map old-overridding-local-map)
1755 (anything-log-save-maybe))))
1758 ;;; Anything resume
1761 (defun* anything-resume (&optional
1762 (any-buffer anything-last-buffer)
1763 buffer-pattern (any-resume t))
1764 "Resurrect previously invoked `anything'.
1765 Called with a prefix arg, allow choosing among all existing
1766 anything buffers. i.e choose among various anything sessions."
1767 (interactive)
1768 (when (or current-prefix-arg buffer-pattern)
1769 (setq any-buffer (anything-resume-select-buffer buffer-pattern)))
1770 (setq anything-compiled-sources nil)
1771 (anything
1772 :sources (or (buffer-local-value 'anything-last-sources-local (get-buffer any-buffer))
1773 anything-last-sources anything-sources)
1774 :input (buffer-local-value 'anything-input-local (get-buffer any-buffer))
1775 :resume any-resume
1776 :buffer any-buffer))
1778 ;;; rubikitch: experimental
1779 ;;; I use this and check it whether I am convenient.
1780 ;;; I may introduce an option to control the behavior.
1781 (defun* anything-resume-window-only (&optional
1782 (any-buffer anything-last-buffer)
1783 buffer-pattern)
1784 (interactive)
1785 (anything-resume any-buffer buffer-pattern 'window-only))
1787 (defun anything-resume-p (any-resume)
1788 "Whether current anything session is resumed or not.
1789 Just check if ANY-RESUME value is t or window-only."
1790 (memq any-resume '(t window-only)))
1792 (defun anything-resume-select-buffer (input)
1793 "Resume precedent anything session with initial input INPUT."
1794 (or (anything :sources '(((name . "Resume anything buffer")
1795 (candidates . anything-buffers)
1796 (action . identity)))
1797 :input input
1798 :resume 'noresume
1799 :buffer "*anything resume*")
1800 (keyboard-quit)))
1803 ;;;###autoload
1804 (defun anything-at-point (&optional
1805 any-sources any-input
1806 any-prompt any-resume
1807 any-preselect any-buffer)
1808 "Call anything with symbol at point as initial input.
1809 ANY-SOURCES ANY-INPUT ANY-PROMPT ANY-RESUME ANY-PRESELECT and ANY-BUFFER
1810 are same args as in `anything'."
1811 (interactive)
1812 (anything :sources any-sources
1813 :input (if current-prefix-arg
1814 (concat "\\b" (thing-at-point 'symbol) "\\b"
1815 (if (featurep 'anything-match-plugin) " " ""))
1816 any-input)
1817 :prompt any-prompt
1818 :resume any-resume
1819 :preselect any-preselect
1820 :buffer any-buffer))
1822 ;;;###autoload
1823 (defun anything-other-buffer (any-sources any-buffer)
1824 "Simplified interface of `anything' with other `anything-buffer'.
1825 Call `anything' with only ANY-SOURCES and ANY-BUFFER as args."
1826 (anything :sources any-sources :buffer any-buffer))
1828 (defun anything-nest (&rest same-as-anything)
1829 "Allow calling `anything' whithin a running anything session."
1830 (with-anything-window
1831 (let (anything-current-position
1832 anything-current-buffer
1833 (orig-anything-current-buffer anything-current-buffer)
1834 (orig-anything-buffer anything-buffer)
1835 (orig-anything-last-frame-or-window-configuration
1836 anything-last-frame-or-window-configuration)
1837 anything-pattern
1838 (anything-buffer (or (getf same-as-anything :buffer)
1839 (nth 5 same-as-anything)
1840 "*Anything*"))
1841 anything-sources
1842 anything-compiled-sources
1843 (anything-samewindow t)
1844 (enable-recursive-minibuffers t))
1845 (unwind-protect
1846 (apply #'anything same-as-anything)
1847 (with-current-buffer orig-anything-buffer
1848 (anything-initialize-overlays orig-anything-buffer)
1849 (setq anything-buffer (current-buffer))
1850 (anything-mark-current-line)
1851 (setq anything-last-frame-or-window-configuration
1852 orig-anything-last-frame-or-window-configuration)
1853 (setq cursor-type t)
1854 (setq anything-current-buffer orig-anything-current-buffer))))))
1857 ;;; Initialize
1860 (defvar anything-buffers nil
1861 "All of `anything-buffer' in most recently used order.")
1862 (defun anything-initialize (any-resume any-input any-sources)
1863 "Start initialization of `anything' session.
1864 For ANY-RESUME ANY-INPUT and ANY-SOURCES See `anything'."
1865 (anything-log "start initialization: any-resume=%S any-input=%S" any-resume any-input)
1866 (anything-frame-or-window-configuration 'save)
1867 (setq anything-sources (anything-normalize-sources any-sources))
1868 (anything-log "sources = %S" anything-sources)
1869 (anything-hooks 'setup)
1870 (anything-current-position 'save)
1871 (if (anything-resume-p any-resume)
1872 (anything-initialize-overlays (anything-buffer-get))
1873 (anything-initial-setup))
1874 (unless (eq any-resume 'noresume)
1875 (anything-recent-push anything-buffer 'anything-buffers)
1876 (setq anything-last-buffer anything-buffer))
1877 (when any-input (setq anything-input any-input anything-pattern any-input))
1878 (and (anything-resume-p any-resume) (anything-funcall-foreach 'resume))
1879 (anything-log "end initialization"))
1881 (defun anything-execute-selection-action-1 ()
1882 "Execute current action."
1883 (anything-log-run-hook 'anything-before-action-hook)
1884 (unwind-protect
1885 (anything-execute-selection-action)
1886 (anything-aif (get-buffer anything-action-buffer)
1887 (kill-buffer it))
1888 (anything-log-run-hook 'anything-after-action-hook)))
1890 (defun anything-restore-position-on-quit ()
1891 "Restore position in `anything-current-buffer' when quitting."
1892 (anything-current-position 'restore))
1894 (defun anything-recent-push (elt list-var)
1895 "Add ELT to the value of LIST-VAR as most recently used value."
1896 (let ((m (member elt (symbol-value list-var))))
1897 (and m (set list-var (delq (car m) (symbol-value list-var))))
1898 (push elt (symbol-value list-var))))
1901 ;;; (@* "Core: Accessors")
1902 ;;; rubikitch: I love to create functions to control variables.
1903 (defvar anything-current-position nil
1904 "Cons of \(point . window-start\) when `anything' is invoked.
1905 It is needed to restore position in `anything-current-buffer'
1906 when `anything' is keyboard-quitted.")
1907 (defun anything-current-position (save-or-restore)
1908 "Restore or save current position in `anything-current-buffer'.
1909 Argument SAVE-OR-RESTORE is one of save or restore."
1910 (case save-or-restore
1911 (save
1912 (anything-log "Save position at %S" (cons (point) (window-start)))
1913 (setq anything-current-position (cons (point) (window-start))))
1914 (restore
1915 (anything-log "Restore position at %S in buffer %s"
1916 anything-current-position
1917 (buffer-name (current-buffer)))
1918 (goto-char (car anything-current-position))
1919 ;; Fix this position with the NOFORCE arg of `set-window-start'
1920 ;; otherwise, if there is some other buffer than `anything-current-buffer'
1921 ;; one, position will be lost.
1922 (set-window-start (selected-window) (cdr anything-current-position) t))))
1925 ;; Internal.
1926 (defvar anything-last-frame-or-window-configuration nil
1927 "Used to store window or frame configuration when anything start.")
1928 (defun anything-frame-or-window-configuration (save-or-restore)
1929 "Save or restore last frame or window configuration.
1930 Possible value of SAVE-OR-RESTORE are 'save and 'restore.
1931 window or frame configuration is saved/restored according to values of
1932 `anything-save-configuration-functions'."
1933 (anything-log-eval anything-save-configuration-functions)
1934 (case save-or-restore
1935 (save (setq anything-last-frame-or-window-configuration
1936 (funcall (cdr anything-save-configuration-functions))))
1937 (restore (funcall (car anything-save-configuration-functions)
1938 anything-last-frame-or-window-configuration)
1939 ;; Restore frame focus.
1940 (let ((frame (and (listp anything-last-frame-or-window-configuration)
1941 (caadr anything-last-frame-or-window-configuration))))
1942 ;; If `anything-save-configuration-functions' are window functions
1943 ;; frame should be nil, use current frame.
1944 (unless (framep frame)
1945 (setq frame (selected-frame)))
1946 (select-frame-set-input-focus frame)))))
1949 ;; (@* "Core: Display *anything* buffer")
1950 (defun anything-display-buffer (buf)
1951 "Display *anything* buffer BUF."
1952 (let (pop-up-frames)
1953 (funcall (with-current-buffer buf anything-display-function) buf)))
1955 (defun anything-default-display-buffer (buf)
1956 "Default function to display BUF.
1957 Where BUF is generally `anything-buffer'.
1958 It use `switch-to-buffer' or `pop-to-buffer' depending of value of
1959 `anything-samewindow'."
1960 (funcall (if anything-samewindow 'switch-to-buffer 'pop-to-buffer) buf))
1963 ;; (@* "Core: initialize")
1964 (defun anything-initial-setup ()
1965 "Initialize anything settings and set up the anything buffer."
1966 (anything-log-run-hook 'anything-before-initialize-hook)
1967 (setq anything-current-prefix-arg nil)
1968 (setq anything-once-called-functions nil)
1969 (setq anything-delayed-init-executed nil)
1970 (setq anything-alive-p t)
1971 (setq anything-current-buffer
1972 (if (minibuffer-window-active-p (minibuffer-window))
1973 ;; If minibuffer is active be sure to use it's buffer
1974 ;; as `anything-current-buffer'.
1975 (window-buffer (active-minibuffer-window))
1976 (current-buffer)))
1977 (setq anything-buffer-file-name buffer-file-name)
1978 (setq anything-issued-errors nil)
1979 (setq anything-compiled-sources nil)
1980 (setq anything-saved-current-source nil)
1981 (if (or (not (boundp 'split-width-threshold))
1982 (not split-width-threshold)
1983 (and (integerp split-width-threshold)
1984 (>= split-width-threshold (+ (frame-width) 4))))
1985 (setq anything-split-window-state 'vertical)
1986 (setq anything-split-window-state 'horizontal))
1987 ;; Call the init function for sources where appropriate
1988 (anything-funcall-foreach 'init)
1989 (setq anything-pattern "")
1990 (setq anything-input "")
1991 (setq anything-candidate-cache nil)
1992 (setq anything-last-sources anything-sources)
1993 (anything-create-anything-buffer)
1994 (anything-log-run-hook 'anything-after-initialize-hook))
1996 (defvar anything-reading-pattern nil
1997 "Whether in `read-string' in anything or not.")
1999 (defun anything-read-pattern-maybe (any-prompt any-input
2000 any-preselect any-resume any-keymap
2001 any-default any-history)
2002 "Read pattern with prompt ANY-PROMPT and initial input ANY-INPUT.
2003 For ANY-PRESELECT ANY-RESUME ANY-KEYMAP, See `anything'."
2004 (if (anything-resume-p any-resume)
2005 (anything-mark-current-line t)
2006 (anything-update any-preselect))
2007 (with-current-buffer (anything-buffer-get)
2008 (let ((src-keymap (assoc-default 'keymap (anything-get-current-source))))
2009 ;; Startup with the first keymap found either in current source
2010 ;; or anything arg, otherwise use global value of `anything-map'.
2011 ;; This map will be used as a `minibuffer-local-map'.
2012 ;; Maybe it will be overriden when changing source
2013 ;; by `anything-maybe-update-keymap'.
2014 (unless anything-local-map-override-anything-map
2015 (anything-aif (or src-keymap any-keymap)
2016 (ignore-errors
2017 (set-keymap-parent it anything-map))))
2018 (set (make-local-variable 'anything-map)
2019 (or src-keymap any-keymap anything-map))
2020 (anything-log-eval (anything-approximate-candidate-number)
2021 anything-execute-action-at-once-if-one
2022 anything-quit-if-no-candidate)
2023 (cond ((and anything-execute-action-at-once-if-one
2024 (= (anything-approximate-candidate-number) 1))
2025 (ignore))
2026 ((and anything-quit-if-no-candidate
2027 (= (anything-approximate-candidate-number) 0))
2028 (setq anything-quit t)
2029 (and (functionp anything-quit-if-no-candidate)
2030 (funcall anything-quit-if-no-candidate)))
2032 (let ((anything-reading-pattern t)
2033 (tap (or any-default
2034 (with-anything-current-buffer
2035 (thing-at-point 'symbol)))))
2036 (read-from-minibuffer (or any-prompt "pattern: ")
2037 any-input anything-map
2038 nil any-history tap)))))))
2040 (defun anything-maybe-update-keymap ()
2041 "Handle differents keymaps in multiples sources.
2042 This function is meant to be run in `anything-move-selection-after-hook'.
2043 It will override `anything-map' with the keymap attribute of current source
2044 if some when multiples sources are present."
2045 (with-anything-window
2046 (let ((kmap (assoc-default 'keymap (anything-get-current-source))))
2047 (when kmap
2048 (and (not anything-local-map-override-anything-map)
2049 (ignore-errors (set-keymap-parent kmap (default-value 'anything-map))))
2050 (setq overriding-local-map kmap)))))
2051 (add-hook 'anything-move-selection-after-hook 'anything-maybe-update-keymap)
2053 (defun anything-create-anything-buffer (&optional test-mode)
2054 "Create newly created `anything-buffer'.
2055 If TEST-MODE is non-nil, clear `anything-candidate-cache'."
2056 (when test-mode
2057 (setq anything-candidate-cache nil))
2058 (with-current-buffer (get-buffer-create anything-buffer)
2059 (anything-log "kill local variables: %S" (buffer-local-variables))
2060 (kill-all-local-variables)
2061 (set (make-local-variable 'inhibit-read-only) t)
2062 (buffer-disable-undo)
2063 (erase-buffer)
2064 (set (make-local-variable 'inhibit-read-only) t)
2065 (set (make-local-variable 'anything-last-sources-local) anything-sources)
2066 (set (make-local-variable 'anything-follow-mode) nil)
2067 (set (make-local-variable 'anything-display-function) anything-display-function)
2068 (set (make-local-variable 'anything-selection-point) nil)
2069 (anything-initialize-persistent-action)
2070 (anything-log-eval anything-display-function anything-let-variables)
2071 (loop for (var . val) in anything-let-variables
2072 do (set (make-local-variable var) val))
2073 (setq cursor-type nil)
2074 (setq mode-name "Anything"))
2075 (anything-initialize-overlays anything-buffer)
2076 (get-buffer anything-buffer))
2078 (defun anything-initialize-overlays (buffer)
2079 "Initialize anything overlays in BUFFER."
2080 (anything-log "overlay setup")
2081 (if anything-selection-overlay
2082 ;; make sure the overlay belongs to the anything buffer if
2083 ;; it's newly created
2084 (move-overlay anything-selection-overlay (point-min) (point-min)
2085 (get-buffer buffer))
2087 (setq anything-selection-overlay
2088 (make-overlay (point-min) (point-min) (get-buffer buffer)))
2089 (overlay-put anything-selection-overlay 'face anything-selection-face))
2091 (cond (anything-enable-shortcuts
2092 (setq anything-shortcut-keys
2093 (assoc-default anything-enable-shortcuts anything-shortcut-keys-alist))
2094 (unless anything-digit-overlays
2095 (setq anything-digit-overlays
2096 (loop for key across anything-shortcut-keys
2097 for overlay = (make-overlay (point-min) (point-min)
2098 (get-buffer buffer))
2099 do (overlay-put overlay 'before-string
2100 (format "%s - " (upcase (make-string 1 key))))
2101 collect overlay))))
2102 (anything-digit-overlays
2103 (mapc 'delete-overlay anything-digit-overlays)
2104 (setq anything-digit-overlays nil))))
2106 (defun anything-hooks (setup-or-cleanup)
2107 "Add or remove hooks according to SETUP-OR-CLEANUP value.
2108 if SETUP-OR-CLEANUP value is setup add hooks, any other value
2109 will remove hooks.
2110 hooks concerned are `post-command-hook' and `minibuffer-setup-hook'."
2111 (let ((hooks '((post-command-hook anything-check-minibuffer-input)
2112 (minibuffer-setup-hook anything-print-error-messages))))
2113 (if (eq setup-or-cleanup 'setup)
2114 (dolist (args hooks) (apply 'add-hook args))
2115 (dolist (args (reverse hooks)) (apply 'remove-hook args)))))
2118 ;; (@* "Core: clean up")
2119 ;;; TODO move
2120 (defun anything-cleanup ()
2121 "Clean up the mess when anything exit or quit."
2122 (anything-log "start cleanup")
2123 (with-current-buffer anything-buffer
2124 ;; rubikitch: I think it is not needed.
2125 ;; thierry: If you end up for any reasons (error etc...)
2126 ;; with an anything-buffer staying around (visible),
2127 ;; You will have no cursor in this buffer when switching to it,
2128 ;; so I think this is needed.
2129 (setq cursor-type t)
2130 ;; Call burry-buffer whithout arg
2131 ;; to be sure anything-buffer is removed from window.
2132 (bury-buffer)
2133 ;; Be sure we call this from anything-buffer.
2134 (anything-funcall-foreach 'cleanup))
2135 (anything-new-timer 'anything-check-minibuffer-input-timer nil)
2136 (anything-kill-async-processes)
2137 (anything-log-run-hook 'anything-cleanup-hook)
2138 (anything-hooks 'cleanup)
2139 (anything-frame-or-window-configuration 'restore)
2140 (setq anything-alive-p nil)
2141 ;; This is needed in some cases where last input
2142 ;; is yielded infinitely in minibuffer after anything session.
2143 (anything-clean-up-minibuffer))
2145 (defun anything-clean-up-minibuffer ()
2146 "Remove contents of minibuffer."
2147 (let ((miniwin (minibuffer-window)))
2148 ;; Clean only current minibuffer used by anything.
2149 ;; i.e The precedent one is active.
2150 (unless (minibuffer-window-active-p miniwin)
2151 (with-current-buffer (window-buffer miniwin)
2152 (delete-minibuffer-contents)))))
2155 ;; (@* "Core: input handling")
2156 (defun anything-check-minibuffer-input ()
2157 "Extract input string from the minibuffer and check if it needs to be handled."
2158 (let ((delay (with-current-buffer anything-buffer
2159 (and anything-input-idle-delay
2160 (max anything-input-idle-delay 0.1)))))
2161 (if (or (not delay) (anything-action-window))
2162 (anything-check-minibuffer-input-1)
2163 (anything-new-timer
2164 'anything-check-minibuffer-input-timer
2165 (run-with-idle-timer delay nil 'anything-check-minibuffer-input-1)))))
2167 (defun anything-check-minibuffer-input-1 ()
2168 "Check minibuffer content."
2169 (with-anything-quittable
2170 (with-selected-window (or (active-minibuffer-window) (minibuffer-window))
2171 (anything-check-new-input (minibuffer-contents)))))
2173 (defun anything-check-new-input (input)
2174 "Check INPUT string and update the anything buffer if necessary."
2175 (unless (equal input anything-pattern)
2176 (setq anything-pattern input)
2177 (unless (anything-action-window)
2178 (setq anything-input anything-pattern))
2179 (anything-log-eval anything-pattern anything-input)
2180 (anything-update)))
2183 ;; (@* "Core: source compiler")
2184 (defvar anything-compile-source-functions-default anything-compile-source-functions
2185 "Plug-ins this file provides.")
2186 (defun anything-compile-sources (sources funcs)
2187 "Compile SOURCES with FUNCS.
2188 See `anything-compile-source-functions'.
2189 Anything plug-ins are realized by this function."
2190 (mapcar
2191 (lambda (source)
2192 (loop with source = (if (listp source) source (symbol-value source))
2193 for f in funcs
2194 do (setq source (funcall f source))
2195 finally (return source)))
2196 sources))
2199 ;; (@* "Core: plug-in attribute documentation hack")
2201 ;; `anything-document-attribute' is public API.
2202 (defadvice documentation-property (after anything-document-attribute activate)
2203 "Display plug-in attributes' documentation as `anything-sources' docstring."
2204 (when (eq (ad-get-arg 0) 'anything-sources)
2205 (setq ad-return-value
2206 (concat ad-return-value "\n"
2207 (mapconcat (lambda (sym) (get sym 'anything-attrdoc))
2208 anything-additional-attributes
2209 "\n")))))
2210 ;; (describe-variable 'anything-sources)
2211 ;; (documentation-property 'anything-sources 'variable-documentation)
2212 ;; (progn (ad-disable-advice 'documentation-property 'after 'anything-document-attribute) (ad-update 'documentation-property))
2215 ;; (@* "Core: all candidates")
2216 (defun anything-process-delayed-init (source)
2217 "Initialize delayed SOURCE."
2218 (let ((name (assoc-default 'name source)))
2219 (unless (member name anything-delayed-init-executed)
2220 (anything-aif (assoc-default 'delayed-init source)
2221 (with-current-buffer anything-current-buffer
2222 (anything-funcall-with-source source it)
2223 (dolist (f (if (functionp it) (list it) it))
2224 (add-to-list 'anything-delayed-init-executed name)))))))
2226 (defun anything-get-candidates (source)
2227 "Retrieve and return the list of candidates from SOURCE."
2228 (anything-process-delayed-init source)
2229 (let* ((candidate-source (assoc-default 'candidates source))
2230 (type-error (lambda ()
2231 (error (concat "Candidates must either be a function, "
2232 " a variable or a list: %s")
2233 candidate-source)))
2234 (candidates (condition-case err
2235 (anything-interpret-value candidate-source source)
2236 (error (funcall type-error)))))
2237 (cond ((processp candidates) candidates)
2238 ((listp candidates) (anything-transform-candidates candidates source))
2239 (t (funcall type-error)))))
2242 (defun anything-get-cached-candidates (source)
2243 "Return the cached value of candidates for SOURCE.
2244 Cache the candidates if there is not yet a cached value."
2245 (let* ((name (assoc-default 'name source))
2246 (candidate-cache (assoc name anything-candidate-cache)))
2247 (cond (candidate-cache
2248 (anything-log "use cached candidates")
2249 (cdr candidate-cache))
2251 (anything-log "calculate candidates")
2252 (let ((candidates (anything-get-candidates source)))
2253 (cond ((processp candidates)
2254 (push (cons candidates
2255 (append source
2256 (list (cons 'item-count 0)
2257 (cons 'incomplete-line ""))))
2258 anything-async-processes)
2259 (set-process-filter candidates 'anything-output-filter)
2260 (setq candidates nil))
2261 ((not (assoc 'volatile source))
2262 (setq candidate-cache (cons name candidates))
2263 (push candidate-cache anything-candidate-cache)))
2264 candidates)))))
2267 ;;; (@* "Core: candidate transformers")
2268 (defun anything-transform-mapcar (function args)
2269 "`mapcar' for candidate-transformer.
2271 ARGS is (cand1 cand2 ...) or ((disp1 . real1) (disp2 . real2) ...)
2273 \(anything-transform-mapcar 'upcase '(\"foo\" \"bar\"))
2274 => (\"FOO\" \"BAR\")
2275 \(anything-transform-mapcar 'upcase '((\"1st\" . \"foo\") (\"2nd\" . \"bar\")))
2276 => ((\"1st\" . \"FOO\") (\"2nd\" . \"BAR\"))
2278 (loop for arg in args
2279 if (consp arg)
2280 collect (cons (car arg) (funcall function (cdr arg)))
2281 else
2282 collect (funcall function arg)))
2284 (defun anything-process-candidate-transformer (candidates source)
2285 "Execute candidate-transformer function on all CANDIDATES of SOURCE."
2286 (anything-aif (assoc-default 'candidate-transformer source)
2287 (anything-composed-funcall-with-source source it candidates)
2288 candidates))
2290 (defun anything-process-filtered-candidate-transformer (candidates source)
2291 "Execute filtered-candidate-transformer function on all CANDIDATES of SOURCE."
2292 (anything-aif (assoc-default 'filtered-candidate-transformer source)
2293 (anything-composed-funcall-with-source source it candidates source)
2294 candidates))
2296 (defun anything-process-filtered-candidate-transformer-maybe (candidates source process-p)
2297 "Execute filtered-candidate-transformer function on all CANDIDATES of SOURCE.
2298 This happen if PROCESS-P is non-nil."
2299 (if process-p
2300 (anything-process-filtered-candidate-transformer candidates source)
2301 candidates))
2303 (defun anything-process-real-to-display (candidates source)
2304 "Execute real-to-display function on all CANDIDATES of SOURCE."
2305 (anything-aif (assoc-default 'real-to-display source)
2306 (setq candidates (anything-funcall-with-source
2307 source 'mapcar
2308 (lambda (cand_)
2309 (if (consp cand_)
2310 ;; override DISPLAY from candidate-transformer
2311 (cons (funcall it (cdr cand_)) (cdr cand_))
2312 (cons (funcall it cand_) cand_)))
2313 candidates))
2314 candidates))
2316 (defun anything-transform-candidates (candidates source &optional process-p)
2317 "Transform CANDIDATES of SOURCE according to candidate transformers.
2318 This happen if PROCESS-P is non-nil."
2319 (anything-process-real-to-display
2320 (anything-process-filtered-candidate-transformer-maybe
2321 (anything-process-candidate-transformer candidates source) source process-p)
2322 source))
2325 ;; (@* "Core: narrowing candidates")
2326 (defun anything-candidate-number-limit (source)
2327 "Apply candidate-number-limit attribute value.
2328 This overhide variable `anything-candidate-number-limit'.
2330 e.g:
2331 If \(candidate-number-limit\) is in SOURCE, show all candidates in SOURCE.
2332 If \(candidate-number-limit . 123\) is in SOURCE limit candidate to 123."
2333 (anything-aif (assq 'candidate-number-limit source)
2334 (or (cdr it) 99999999)
2335 (or anything-candidate-number-limit 99999999)))
2337 ;; FIXME: Why a defconst here
2338 (defconst anything-default-match-functions
2339 (list (lambda (candidate)
2340 (string-match anything-pattern candidate)))
2341 "Default functions to match candidates according to `anything-pattern'.")
2343 (defun anything-compute-matches (source)
2344 "Compute matched results from SOURCE according to its settings."
2345 (if debug-on-error
2346 (anything-compute-matches-internal source)
2347 (condition-case v
2348 (anything-compute-matches-internal source)
2349 (error (anything-log-error
2350 "anything-compute-matches: error when processing source: %s"
2351 (assoc-default 'name source))
2352 nil))))
2354 (defun anything-candidate-get-display (candidate)
2355 "Get searched display part from CANDIDATE.
2356 CANDIDATE is a string, a symbol, or \(DISPLAY . REAL\) cons cell."
2357 (format "%s" (or (car-safe candidate) candidate)))
2359 (defun anything-process-pattern-transformer (pattern source)
2360 "Execute pattern-transformer attribute PATTERN function in SOURCE."
2361 (anything-aif (assoc-default 'pattern-transformer source)
2362 (anything-composed-funcall-with-source source it pattern)
2363 pattern))
2365 (defun anything-match-functions (source)
2366 (or (assoc-default 'match source)
2367 anything-default-match-functions))
2369 (defmacro anything-accumulate-candidates-internal (cand newmatches
2370 hash item-count limit)
2371 "Internal, add CAND into NEWMATCHES.
2372 Use HASH to uniq NEWMATCHES.
2373 Argument ITEM-COUNT count the matches.
2374 if ITEM-COUNT reaches LIMIT, exit from inner loop."
2375 `(unless (gethash ,cand ,hash)
2376 (puthash ,cand t ,hash)
2377 (push ,cand ,newmatches)
2378 (incf ,item-count)
2379 (when (= ,item-count ,limit)
2380 (setq exit t)
2381 (return))))
2383 (defun anything-take-first-elements (seq n)
2384 (if (> (length seq) n)
2385 (setq seq (subseq seq 0 n))
2386 seq))
2388 (defun anything-match-from-candidates (cands matchfns limit)
2389 (let (matches)
2390 (condition-case nil
2391 (let ((item-count 0) exit)
2392 (clrhash anything-match-hash)
2393 (dolist (match matchfns)
2394 (let (newmatches)
2395 (dolist (candidate cands)
2396 (when (funcall match (anything-candidate-get-display candidate))
2397 (anything-accumulate-candidates-internal
2398 candidate newmatches anything-match-hash item-count limit)))
2399 (setq matches (append matches (reverse newmatches)))
2400 (if exit (return)))))
2401 (invalid-regexp (setq matches nil)))
2402 matches))
2404 (defun anything-compute-matches-internal (source)
2405 (save-current-buffer
2406 (let ((matchfns (anything-match-functions source))
2407 (anything-source-name (assoc-default 'name source))
2408 (limit (anything-candidate-number-limit source))
2409 (anything-pattern (anything-process-pattern-transformer
2410 anything-pattern source)))
2411 (anything-process-filtered-candidate-transformer
2412 (if (or (equal anything-pattern "") (equal matchfns '(identity)))
2413 (anything-take-first-elements
2414 (anything-get-cached-candidates source) limit)
2415 (anything-match-from-candidates
2416 (anything-get-cached-candidates source) matchfns limit))
2417 source))))
2419 ;; (anything '(((name . "error")(candidates . (lambda () (hage))) (action . identity))))
2421 (defun anything-process-source (source)
2422 "Display matched results from SOURCE according to its settings."
2423 (anything-log-eval (assoc-default 'name source))
2424 (if (assq 'direct-insert-match source) ;experimental
2425 (anything-process-source--direct-insert-match source)
2426 (let ((matches (anything-compute-matches source)))
2427 (when matches
2428 (when anything-test-mode
2429 (setq anything-test-candidate-list
2430 `(,@anything-test-candidate-list
2431 (,(assoc-default 'name source)
2432 ,matches))))
2433 (anything-insert-header-from-source source)
2434 (if (not (assq 'multiline source))
2435 (mapc 'anything-insert-match-with-digit-overlay matches)
2436 (let ((start (point)) separate)
2437 (dolist (match matches)
2438 (if separate
2439 (anything-insert-candidate-separator)
2440 (setq separate t))
2441 (anything-insert-match-with-digit-overlay match))
2442 (put-text-property start (point) 'anything-multiline t)))))))
2444 (defun anything-insert-match-with-digit-overlay (match)
2445 (declare (special source))
2446 (anything-put-digit-overlay-maybe)
2447 (anything-insert-match match 'insert source))
2449 (defun anything-put-digit-overlay-maybe ()
2450 (when (and anything-enable-shortcuts
2451 (not (eq anything-digit-shortcut-count
2452 (length anything-digit-overlays))))
2453 (move-overlay (nth anything-digit-shortcut-count
2454 anything-digit-overlays)
2455 (point-at-bol)
2456 (point-at-bol))
2457 (incf anything-digit-shortcut-count)))
2459 (defun anything-process-source--direct-insert-match (source)
2460 "[EXPERIMENTAL] Insert candidates from `anything-candidate-buffer' in SOURCE."
2461 (anything-log-eval (assoc-default 'name source))
2462 (let ((anything-source-name (assoc-default 'name source))
2463 content-buf)
2464 (funcall (assoc-default 'candidates source))
2465 (setq content-buf (anything-candidate-buffer))
2466 (unless (anything-empty-buffer-p content-buf)
2467 (anything-insert-header-from-source source)
2468 (insert-buffer-substring content-buf)
2469 ;; TODO call anything-put-digit-overlay-maybe with loop
2472 (defun anything-process-delayed-sources (delayed-sources &optional preselect)
2473 "Process anything DELAYED-SOURCES.
2474 Move selection to string or regexp PRESELECT if non--nil.
2475 This function is called in `anything-process-delayed-sources-timer'
2476 when emacs is idle for `anything-idle-delay'."
2477 (with-anything-quittable
2478 (anything-log-eval (mapcar (lambda (s) (assoc-default 'name s)) delayed-sources))
2479 (with-current-buffer anything-buffer
2480 (save-excursion
2481 (goto-char (point-max))
2482 (mapc 'anything-process-source delayed-sources)
2483 (when (and (not (anything-empty-buffer-p))
2484 ;; No selection yet.
2485 (= (overlay-start anything-selection-overlay)
2486 (overlay-end anything-selection-overlay)))
2487 (anything-update-move-first-line 'without-hook)))
2488 (when preselect (anything-preselect preselect))
2489 (save-excursion
2490 (goto-char (point-min))
2491 (anything-log-run-hook 'anything-update-hook))
2492 (anything-log-run-hook 'anything-after-update-hook))))
2495 ;; (@* "Core: *anything* buffer contents")
2496 (defvar anything-input-local nil)
2497 (defvar anything-process-delayed-sources-timer nil)
2498 (defun anything-update (&optional preselect)
2499 "Update candidates list in `anything-buffer' according to `anything-pattern'.
2500 Argument PRESELECT is a string or regexp used to move selection to a particular
2501 place once updating is done. It should be used on single source because search
2502 is done on whole `anything-buffer' and not on current source."
2503 (anything-log "start update")
2504 (setq anything-digit-shortcut-count 0)
2505 (anything-kill-async-processes)
2506 (with-current-buffer (anything-buffer-get)
2507 (set (make-local-variable 'anything-input-local) anything-pattern)
2508 (erase-buffer)
2509 (when anything-enable-shortcuts
2510 (mapc 'delete-overlay anything-digit-overlays))
2511 (let (delayed-sources
2512 (case-fold-search t)
2513 normal-sources)
2514 (unwind-protect ; Process normal sources and store delayed one's.
2515 (setq delayed-sources
2516 (loop for source in (remove-if-not 'anything-update-source-p
2517 (anything-get-sources))
2518 if (anything-delayed-source-p source)
2519 collect source
2520 else do (progn (push source normal-sources)
2521 (anything-process-source source))))
2522 (anything-log-eval
2523 (mapcar (lambda (s) (assoc-default 'name s)) delayed-sources))
2524 (if anything-test-mode ; Need only to process sources.
2525 (mapc 'anything-process-source delayed-sources)
2526 (cond ((and preselect delayed-sources normal-sources)
2527 ;; Preselection run here when there is
2528 ;; normal AND delayed sources.
2529 (anything-log "Update preselect candidate %s" preselect)
2530 (anything-preselect preselect))
2531 (delayed-sources ; Preselection and hooks will run later.
2532 (anything-update-move-first-line 'without-hook)
2534 (t ; No delayed sources, run the hooks now.
2535 (anything-update-move-first-line)
2536 (anything-log-run-hook 'anything-after-update-hook)
2537 (when preselect
2538 (anything-log "Update preselect candidate %s" preselect)
2539 (anything-preselect preselect))))
2540 (when delayed-sources
2541 (anything-new-timer
2542 'anything-process-delayed-sources-timer
2543 (run-with-idle-timer
2544 ;; Be sure anything-idle-delay is >
2545 ;; to anything-input-idle-delay
2546 ;; otherwise use value of anything-input-idle-delay
2547 ;; or 0.1 if == to 0.
2548 (max anything-idle-delay anything-input-idle-delay 0.1) nil
2549 'anything-process-delayed-sources delayed-sources preselect))))
2550 (anything-log "end update")))))
2552 (defun anything-update-source-p (source)
2553 "Wheter SOURCE need updating or not."
2554 (and (or (not anything-source-filter)
2555 (member (assoc-default 'name source) anything-source-filter))
2556 (>= (length anything-pattern)
2557 (anything-aif (assoc 'requires-pattern source)
2558 (or (cdr it) 1)
2559 0))))
2561 (defun anything-delayed-source-p (source)
2562 "Wheter SOURCE is a delayed source or not."
2563 (or (assoc 'delayed source)
2564 (and anything-quick-update
2565 (< (window-height (get-buffer-window (current-buffer)))
2566 (line-number-at-pos (point-max))))))
2568 (defun anything-update-move-first-line (&optional without-hook)
2569 "Goto first line of `anything-buffer'."
2570 (goto-char (point-min))
2571 (unless without-hook
2572 (save-excursion (anything-log-run-hook 'anything-update-hook)))
2573 (anything-next-line))
2575 (defun anything-force-update (&optional preselect)
2576 "Force recalculation and update of candidates.
2577 If current source has `update' attribute, a function without argument,
2578 call it before update."
2579 (interactive)
2580 (let ((source (anything-get-current-source))
2581 (selection (anything-get-selection nil t)))
2582 (when source
2583 (mapc 'anything-force-update--reinit
2584 (anything-get-sources)))
2585 (anything-update preselect)
2586 ;; If preselect arg exists, `anything-update' should
2587 ;; have moved to selection, otherwise do it now.
2588 (unless preselect
2589 (anything-keep-selection (assoc-default 'name source) selection))
2590 (with-anything-window (recenter))))
2592 (defun anything-force-update--reinit (source)
2593 "Reinit SOURCE by calling his update and/or init functions."
2594 (anything-aif (anything-funcall-with-source
2595 source 'anything-candidate-buffer)
2596 (kill-buffer it))
2597 (dolist (attr '(update init))
2598 (anything-aif (assoc-default attr source)
2599 (anything-funcall-with-source source it)))
2600 (anything-remove-candidate-cache source))
2602 (defun anything-keep-selection (source selection)
2603 "Switch to SOURCE and goto SELECTION."
2604 (when (and source selection)
2605 (with-anything-window
2606 (anything-goto-source source)
2607 (forward-char -1)
2608 (if (search-forward selection nil t)
2609 (forward-line 0)
2610 (goto-char (point-min))
2611 (forward-line 1))
2612 (anything-mark-current-line))))
2614 (defun anything-remove-candidate-cache (source)
2615 "Remove SOURCE from `anything-candidate-cache'."
2616 (setq anything-candidate-cache
2617 (delete (assoc (assoc-default 'name source)
2618 anything-candidate-cache)
2619 anything-candidate-cache)))
2621 (defun anything-insert-match (match insert-function source)
2622 "Insert MATCH into `anything-buffer' with INSERT-FUNCTION for SOURCE.
2623 If MATCH is a list then insert the string intended to appear on the display
2624 and store the real value in a text property."
2625 (let ((start (point-at-bol (point)))
2626 (dispvalue (or (car-safe match) match))
2627 (realvalue (cdr-safe match)))
2628 (setq dispvalue
2629 (cond ((symbolp dispvalue) (symbol-name dispvalue))
2630 ((numberp dispvalue) (number-to-string dispvalue))
2631 (t dispvalue)))
2632 (when (stringp dispvalue)
2633 (funcall insert-function dispvalue)
2634 ;; Some sources with candidates-in-buffer have already added
2635 ;; 'anything-realvalue property when creating candidate buffer.
2636 (unless (get-text-property start 'anything-realvalue)
2637 (and realvalue
2638 (put-text-property start (point-at-eol)
2639 'anything-realvalue realvalue)))
2640 (when anything-source-in-each-line-flag
2641 (put-text-property start (point-at-eol) 'anything-source source))
2642 (funcall insert-function "\n"))))
2644 (defun anything-insert-header-from-source (source)
2645 "Insert SOURCE name in `anything-buffer' header.
2646 Maybe insert by overlay additional info after source name if SOURCE have
2647 header-name attribute."
2648 (let ((name (assoc-default 'name source)))
2649 (anything-insert-header
2650 name
2651 (anything-aif (assoc-default 'header-name source)
2652 (anything-funcall-with-source source it name)))))
2654 (defun anything-insert-header (name &optional display-string)
2655 "Insert header of source NAME into the anything buffer.
2656 If DISPLAY-STRING is non--nil and a string, display this additional info
2657 after the source name by overlay."
2658 (unless (bobp)
2659 (let ((start (point)))
2660 (insert "\n")
2661 (put-text-property start (point) 'anything-header-separator t)))
2662 (let ((start (point)))
2663 (insert name)
2664 (put-text-property (point-at-bol)
2665 (point-at-eol) 'anything-header t)
2666 (when display-string
2667 (overlay-put (make-overlay (point-at-bol) (point-at-eol))
2668 'display display-string))
2669 (insert "\n")
2670 (put-text-property start (point) 'face anything-header-face)))
2672 (defun anything-insert-candidate-separator ()
2673 "Insert separator of candidates into the anything buffer."
2674 (insert anything-candidate-separator)
2675 (put-text-property (point-at-bol)
2676 (point-at-eol) 'anything-candidate-separator t)
2677 (insert "\n"))
2680 ;; (@* "Core: async process")
2681 (defun anything-output-filter (process string)
2682 "From PROCESS process output STRING."
2683 (anything-output-filter-1 (assoc process anything-async-processes) string))
2685 (defun anything-output-filter-1 (process-assoc string)
2686 (anything-log-eval string)
2687 (with-current-buffer anything-buffer
2688 (let ((source (cdr process-assoc)))
2689 (save-excursion
2690 (anything-aif (assoc-default 'insertion-marker source)
2691 (goto-char it)
2692 (goto-char (point-max))
2693 (anything-insert-header-from-source source)
2694 (setcdr process-assoc
2695 (append source `((insertion-marker . ,(point-marker))))))
2696 (anything-output-filter--process-source
2697 (car process-assoc) string source
2698 (anything-candidate-number-limit source))))
2699 (anything-output-filter--post-process)))
2701 (defun anything-output-filter--process-source (process string source limit)
2702 (dolist (candidate (anything-transform-candidates
2703 (anything-output-filter--collect-candidates
2704 (split-string string "\n")
2705 (assoc 'incomplete-line source))
2706 source t))
2707 (if (not (assq 'multiline source))
2708 (anything-insert-match candidate 'insert-before-markers source)
2709 (let ((start (point)))
2710 (anything-insert-candidate-separator)
2711 (anything-insert-match candidate 'insert-before-markers source)
2712 (put-text-property start (point) 'anything-multiline t)))
2713 (incf (cdr (assoc 'item-count source)))
2714 (when (>= (assoc-default 'item-count source) limit)
2715 (anything-kill-async-process process)
2716 (return))))
2718 (defun anything-output-filter--collect-candidates (lines incomplete-line-info)
2719 (anything-log-eval (cdr incomplete-line-info))
2720 (butlast
2721 (loop for line in lines collect
2722 (if (cdr incomplete-line-info)
2723 (prog1
2724 (concat (cdr incomplete-line-info) line)
2725 (setcdr incomplete-line-info nil))
2726 line)
2727 finally (setcdr incomplete-line-info line))))
2729 (defun anything-output-filter--post-process ()
2730 (anything-log-run-hook 'anything-update-hook)
2731 (anything-aif (get-buffer-window anything-buffer 'visible)
2732 (save-selected-window
2733 (select-window it)
2734 (anything-skip-noncandidate-line 'next)
2735 (anything-mark-current-line))))
2737 (defun anything-kill-async-processes ()
2738 "Kill all known asynchronous processes of `anything-async-processes'."
2739 (mapc 'anything-kill-async-process (mapcar 'car anything-async-processes))
2740 (setq anything-async-processes nil))
2742 (defun anything-kill-async-process (process)
2743 "Kill PROCESS and detach the associated functions."
2744 (set-process-filter process nil)
2745 (delete-process process))
2748 ;; (@* "Core: action")
2749 (defun anything-execute-selection-action (&optional
2750 selection action
2751 preserve-saved-action)
2752 "If a candidate SELECTION is present then perform the associated ACTION on it.
2753 If PRESERVE-SAVED-ACTION is non-nil don't save action."
2754 (anything-log "executing action")
2755 (setq action (anything-get-default-action
2756 (or action
2757 anything-saved-action
2758 (if (get-buffer anything-action-buffer)
2759 (anything-get-selection anything-action-buffer)
2760 (anything-get-action)))))
2761 (let ((source (or anything-saved-current-source
2762 (anything-get-current-source))))
2763 (setq selection (or selection
2764 (anything-get-selection)
2765 (and (assoc 'accept-empty source) "")))
2766 (unless preserve-saved-action (setq anything-saved-action nil))
2767 (if (and selection action)
2768 (anything-funcall-with-source
2769 source action
2770 (anything-coerce-selection selection source)))))
2772 (defun anything-coerce-selection (selection source)
2773 "Apply coerce attribute function to SELECTION in SOURCE.
2774 Coerce source with coerce function."
2775 (anything-aif (assoc-default 'coerce source)
2776 (anything-funcall-with-source source it selection)
2777 selection))
2779 (defun anything-get-default-action (action)
2780 "Get the first ACTION value of action list in source."
2781 (if (and (listp action) (not (functionp action)))
2782 (cdar action)
2783 action))
2785 (defun anything-select-action ()
2786 "Select an action for the currently selected candidate.
2787 If action buffer is selected, back to the anything buffer."
2788 (interactive)
2789 (anything-log-run-hook 'anything-select-action-hook)
2790 (cond ((get-buffer-window anything-action-buffer 'visible)
2791 (set-window-buffer (get-buffer-window anything-action-buffer)
2792 anything-buffer)
2793 (kill-buffer anything-action-buffer)
2794 (anything-set-pattern anything-input 'noupdate))
2796 (setq anything-saved-selection (anything-get-selection))
2797 (unless anything-saved-selection
2798 (error "Nothing is selected"))
2799 (setq anything-saved-current-source (anything-get-current-source))
2800 (let ((actions (anything-get-action)))
2801 (if (functionp actions)
2802 (message "Sole action: %s" actions)
2803 (anything-show-action-buffer actions)
2804 (anything-delete-minibuffer-contents)
2805 (setq anything-pattern 'dummy) ; so that it differs from the previous one
2806 (anything-check-minibuffer-input))))))
2808 (defun anything-show-action-buffer (actions)
2809 (with-current-buffer (get-buffer-create anything-action-buffer)
2810 (erase-buffer)
2811 (buffer-disable-undo)
2812 (set-window-buffer (get-buffer-window anything-buffer) anything-action-buffer)
2813 (set (make-local-variable 'anything-sources)
2814 `(((name . "Actions")
2815 (volatile)
2816 (candidates . ,actions)
2817 (candidate-number-limit))))
2818 (set (make-local-variable 'anything-source-filter) nil)
2819 (set (make-local-variable 'anything-selection-overlay) nil)
2820 (set (make-local-variable 'anything-digit-overlays) nil)
2821 (anything-initialize-overlays anything-action-buffer)))
2824 ;; (@* "Core: selection")
2825 (defun anything-move-selection-common (move-func unit direction)
2826 "Move the selection marker to a new position wit function MOVE-FUNC.
2827 It is determined by UNIT and DIRECTION."
2828 (unless (or (anything-empty-buffer-p (anything-buffer-get))
2829 (not (anything-window)))
2830 (with-anything-window
2831 (anything-log-run-hook 'anything-move-selection-before-hook)
2832 (funcall move-func)
2833 (anything-skip-noncandidate-line direction)
2834 (anything-display-source-at-screen-top-maybe unit)
2835 (when (anything-get-previous-header-pos)
2836 (anything-mark-current-line))
2837 (anything-display-mode-line (anything-get-current-source))
2838 (anything-log-run-hook 'anything-move-selection-after-hook))))
2840 (defun anything-display-source-at-screen-top-maybe (unit)
2841 (when (and anything-display-source-at-screen-top (eq unit 'source))
2842 (set-window-start (selected-window)
2843 (save-excursion (forward-line -1) (point)))))
2845 (defun anything-skip-noncandidate-line (direction)
2846 (anything-skip-header-and-separator-line direction)
2847 (and (bobp) (forward-line 1)) ;skip first header
2848 (and (eobp) (forward-line -1))) ;avoid last empty line
2851 (defun anything-skip-header-and-separator-line (direction)
2852 (while (and (not (bobp))
2853 (or (anything-pos-header-line-p)
2854 (anything-pos-candidate-separator-p)))
2855 (forward-line (if (and (eq direction 'previous)
2856 (not (eq (point-at-bol) (point-min))))
2857 -1 1))))
2859 (defvar anything-mode-line-string-real nil)
2860 (defun anything-display-mode-line (source)
2861 (set (make-local-variable 'anything-mode-line-string)
2862 (anything-interpret-value (or (assoc-default 'mode-line source)
2863 (default-value 'anything-mode-line-string))
2864 source))
2865 (if anything-mode-line-string
2866 (setq mode-line-format
2867 '(" " mode-line-buffer-identification " "
2868 (line-number-mode "L%l") " " (anything-follow-mode "(F) ")
2869 (:eval (anything-show-candidate-number
2870 (when (listp anything-mode-line-string)
2871 (car anything-mode-line-string))))
2872 " " anything-mode-line-string-real "-%-")
2873 anything-mode-line-string-real
2874 (substitute-command-keys (if (listp anything-mode-line-string)
2875 (cadr anything-mode-line-string)
2876 anything-mode-line-string)))
2877 (setq mode-line-format
2878 (default-value 'mode-line-format)))
2879 (setq header-line-format
2880 (anything-interpret-value (assoc-default 'header-line source) source)))
2882 (defun anything-show-candidate-number (&optional name)
2883 "Used to display candidate number in mode-line.
2884 You can specify NAME of candidates e.g \"Buffers\" otherwise
2885 it is \"Candidate\(s\)\" by default."
2886 (propertize
2887 (format "[%s %s]"
2888 (anything-approximate-candidate-number 'in-current-source)
2889 (or name "Candidate(s)"))
2890 'face 'anything-candidate-number))
2892 (defun anything-previous-line ()
2893 "Move selection to the previous line."
2894 (interactive)
2895 (anything-move-selection-common
2896 (lambda ()
2897 (if (not (anything-pos-multiline-p))
2898 (forward-line -1) ;double forward-line is meaningful
2899 (forward-line -1) ;because evaluation order is important
2900 (anything-skip-header-and-separator-line 'previous)
2901 (let ((header-pos (anything-get-previous-header-pos))
2902 (separator-pos (anything-get-previous-candidate-separator-pos)))
2903 (when header-pos
2904 (goto-char (if (or (null separator-pos) (< separator-pos header-pos))
2905 header-pos ; first candidate
2906 separator-pos))
2907 (forward-line 1)))))
2908 'line 'previous))
2910 (defun anything-next-line ()
2911 "Move selection to the next line."
2912 (interactive)
2913 (anything-move-selection-common
2914 (lambda ()
2915 (if (not (anything-pos-multiline-p))
2916 (forward-line 1)
2917 (let ((header-pos (anything-get-next-header-pos))
2918 (separator-pos (anything-get-next-candidate-separator-pos)))
2919 (cond ((and separator-pos
2920 (or (null header-pos) (< separator-pos header-pos)))
2921 (goto-char separator-pos))
2922 (header-pos
2923 (goto-char header-pos))))))
2924 'line 'next))
2926 (defun anything-previous-page ()
2927 "Move selection back with a pageful."
2928 (interactive)
2929 (anything-move-selection-common
2930 (lambda ()
2931 (condition-case nil
2932 (scroll-down)
2933 (beginning-of-buffer (goto-char (point-min)))))
2934 'page 'previous))
2936 (defun anything-next-page ()
2937 "Move selection forward with a pageful."
2938 (interactive)
2939 (anything-move-selection-common
2940 (lambda ()
2941 (condition-case nil
2942 (scroll-up)
2943 (end-of-buffer (goto-char (point-max)))))
2944 'page 'next))
2946 (defun anything-beginning-of-buffer ()
2947 "Move selection at the top."
2948 (interactive)
2949 (anything-move-selection-common
2950 (lambda () (goto-char (point-min)))
2951 'edge 'previous))
2953 (defun anything-end-of-buffer ()
2954 "Move selection at the bottom."
2955 (interactive)
2956 (anything-move-selection-common
2957 (lambda () (goto-char (point-max)))
2958 'edge 'next))
2960 (defun anything-previous-source ()
2961 "Move selection to the previous source."
2962 (interactive)
2963 (anything-move-selection-common
2964 (lambda ()
2965 (forward-line -1)
2966 (if (bobp)
2967 (goto-char (point-max))
2968 (anything-skip-header-and-separator-line 'previous))
2969 (goto-char (anything-get-previous-header-pos))
2970 (forward-line 1))
2971 'source 'previous))
2973 (defun anything-next-source ()
2974 "Move selection to the next source."
2975 (interactive)
2976 (anything-move-selection-common
2977 (lambda ()
2978 (goto-char (or (anything-get-next-header-pos) (point-min))))
2979 'source 'next))
2981 (defun anything-goto-source (source-or-name)
2982 "Move the selection to the source SOURCE-OR-NAME."
2983 (anything-move-selection-common
2984 (lambda ()
2985 (goto-char (point-min))
2986 (let ((name (if (stringp source-or-name) source-or-name
2987 (assoc-default 'name source-or-name))))
2988 (condition-case err
2989 (while (not (string= name (anything-current-line-contents)))
2990 (goto-char (anything-get-next-header-pos)))
2991 (error (message "")))))
2992 'source 'next))
2994 (defun anything-mark-current-line (&optional resumep)
2995 "Move `anything-selection-overlay' to current line.
2996 Note that this is not related with visibles marks, which are used
2997 to mark candidates."
2998 (with-anything-window
2999 (when resumep
3000 (goto-char anything-selection-point))
3001 (move-overlay
3002 anything-selection-overlay (point-at-bol)
3003 (if (anything-pos-multiline-p)
3004 (let ((header-pos (anything-get-next-header-pos))
3005 (separator-pos (anything-get-next-candidate-separator-pos)))
3006 (or (and (null header-pos) separator-pos)
3007 (and header-pos separator-pos (< separator-pos header-pos)
3008 separator-pos)
3009 header-pos
3010 (point-max)))
3011 (1+ (point-at-eol))))
3012 (setq anything-selection-point (overlay-start anything-selection-overlay)))
3013 (anything-follow-execute-persistent-action-maybe))
3015 (defun anything-this-command-key ()
3016 (event-basic-type (elt (this-command-keys-vector) 0)))
3017 ;; (progn (read-key-sequence "Key: ") (p (anything-this-command-key)))
3019 (defun anything-select-with-shortcut-internal (types get-key-func)
3020 (if (memq anything-enable-shortcuts types)
3021 (save-selected-window
3022 (select-window (anything-window))
3023 (let* ((key (funcall get-key-func))
3024 (overlay (ignore-errors (nth (position key anything-shortcut-keys)
3025 anything-digit-overlays))))
3026 (if (not (and overlay (overlay-buffer overlay)))
3027 (when (numberp key)
3028 (select-window (minibuffer-window))
3029 (self-insert-command 1))
3030 (goto-char (overlay-start overlay))
3031 (anything-mark-current-line)
3032 (anything-exit-minibuffer))))
3033 (self-insert-command 1)))
3035 (defun anything-select-with-prefix-shortcut ()
3036 "Invoke default action with prefix shortcut."
3037 (interactive)
3038 (anything-select-with-shortcut-internal
3039 '(prefix)
3040 (lambda () (read-event "Select shortcut key: "))))
3042 (defun anything-select-with-digit-shortcut ()
3043 "Invoke default action with digit/alphabet shortcut."
3044 (interactive)
3045 (anything-select-with-shortcut-internal
3046 '(alphabet t) 'anything-this-command-key))
3048 ;; (setq anything-enable-shortcuts 'prefix)
3049 ;; (define-key anything-map "@" 'anything-select-with-prefix-shortcut)
3050 ;; (define-key anything-map (kbd "<f18>") 'anything-select-with-prefix-shortcut)
3052 (defvar anything-exit-status 0
3053 "Flag to inform whether anything have exited or quitted.
3054 Exit with 0 mean anything have exited executing an action.
3055 Exit with 1 mean anything have quitted with \\[keyboard-quit]
3056 It is useful for example to restore a window config if anything abort
3057 in special cases.
3058 See `anything-exit-minibuffer' and `anything-keyboard-quit'.")
3060 (defvar anything-minibuffer-confirm-state nil)
3061 (defun anything-confirm-and-exit-minibuffer ()
3062 "Maybe ask for confirmation when exiting anything.
3063 It is similar to `minibuffer-complete-and-exit' adapted to anything.
3064 If `minibuffer-completion-confirm' value is 'confirm,
3065 send in minibuffer confirm message and exit on next hit.
3066 If `minibuffer-completion-confirm' value is t,
3067 don't exit and send message 'no match'."
3068 (interactive)
3069 (let ((empty-buffer-p (with-current-buffer anything-buffer
3070 (eq (point-min) (point-max))))
3071 (unknow (string= (get-text-property
3072 0 'display (anything-get-selection nil 'withprop))
3073 "[?]")))
3074 (cond ((and (or empty-buffer-p unknow)
3075 (eq minibuffer-completion-confirm 'confirm))
3076 (setq anything-minibuffer-confirm-state
3077 'confirm)
3078 (setq minibuffer-completion-confirm nil)
3079 (minibuffer-message " [confirm]"))
3080 ((and (or empty-buffer-p unknow)
3081 (eq minibuffer-completion-confirm t))
3082 (minibuffer-message " [No match]"))
3084 (setq anything-minibuffer-confirm-state nil)
3085 (anything-exit-minibuffer)))))
3086 (add-hook 'anything-after-update-hook 'anything-confirm-and-exit-hook)
3088 (defun anything-confirm-and-exit-hook ()
3089 "Restore `minibuffer-completion-confirm' when anything update."
3090 (unless (or (eq minibuffer-completion-confirm t)
3091 (not anything-minibuffer-confirm-state))
3092 (setq minibuffer-completion-confirm
3093 anything-minibuffer-confirm-state)))
3095 (defun anything-exit-minibuffer ()
3096 "Select the current candidate by exiting the minibuffer."
3097 (interactive)
3098 (unless anything-current-prefix-arg
3099 (setq anything-current-prefix-arg current-prefix-arg))
3100 (setq anything-exit-status 0)
3101 (exit-minibuffer))
3103 (defun anything-keyboard-quit ()
3104 "Quit minibuffer in anything.
3105 If action buffer is displayed, kill it."
3106 (interactive)
3107 (when (get-buffer-window anything-action-buffer 'visible)
3108 (kill-buffer anything-action-buffer))
3109 (setq anything-exit-status 1)
3110 (abort-recursive-edit))
3112 (defun anything-get-next-header-pos ()
3113 "Return the position of the next header from point."
3114 (next-single-property-change (point) 'anything-header))
3116 (defun anything-get-previous-header-pos ()
3117 "Return the position of the previous header from point."
3118 (previous-single-property-change (point) 'anything-header))
3120 (defun anything-pos-multiline-p ()
3121 "Return non-nil if the current position is in the multiline source region."
3122 (get-text-property (point) 'anything-multiline))
3124 (defun anything-get-next-candidate-separator-pos ()
3125 "Return the position of the next candidate separator from point."
3126 (next-single-property-change (point) 'anything-candidate-separator))
3128 (defun anything-get-previous-candidate-separator-pos ()
3129 "Return the position of the previous candidate separator from point."
3130 (previous-single-property-change (point) 'anything-candidate-separator))
3132 (defun anything-pos-header-line-p ()
3133 "Return t if the current line is a header line."
3134 (or (get-text-property (point-at-bol) 'anything-header)
3135 (get-text-property (point-at-bol) 'anything-header-separator)))
3137 (defun anything-pos-candidate-separator-p ()
3138 "Return t if the current line is a candidate separator."
3139 (get-text-property (point-at-bol) 'anything-candidate-separator))
3142 ;; (@* "Core: help")
3143 (defun anything-help-internal (bufname insert-content-fn)
3144 "Show long message during `anything' session in BUFNAME.
3145 INSERT-CONTENT-FN is the text to be displayed in BUFNAME."
3146 (save-window-excursion
3147 (select-window (anything-window))
3148 (delete-other-windows)
3149 (switch-to-buffer (get-buffer-create bufname))
3150 (erase-buffer)
3151 (funcall insert-content-fn)
3152 (setq mode-line-format "%b (SPC,C-v:NextPage b,M-v:PrevPage other:Exit)")
3153 (setq cursor-type nil)
3154 (goto-char 1)
3155 (anything-help-event-loop)))
3157 (defun anything-help-event-loop ()
3158 (ignore-errors
3159 (loop for event = (read-event) do
3160 (case event
3161 ((?\C-v ? ) (scroll-up))
3162 ((?\M-v ?b) (scroll-down))
3163 (t (return))))))
3165 (defun anything-help ()
3166 "Help of `anything'."
3167 (interactive)
3168 (anything-help-internal
3169 " *Anything Help*"
3170 (lambda ()
3171 (insert (substitute-command-keys
3172 (anything-interpret-value (or (assoc-default
3173 'help-message
3174 (anything-get-current-source))
3175 anything-help-message))))
3176 (org-mode))))
3178 (defun anything-debug-output ()
3179 "Show all anything-related variables at this time."
3180 (interactive)
3181 (anything-help-internal " *Anything Debug*" 'anything-debug-output-function))
3183 (defun anything-debug-output-function (&optional vars)
3184 (message "Calculating all anything-related values...")
3185 (insert "If you debug some variables or forms, set `anything-debug-forms'
3186 to a list of forms.\n\n")
3187 (dolist (v (or vars
3188 anything-debug-forms
3189 (apropos-internal "^anything-" 'boundp)))
3190 (insert "** "
3191 (pp-to-string v) "\n"
3192 (pp-to-string (with-current-buffer anything-buffer (eval v))) "\n"))
3193 (message "Calculating all anything-related values...Done"))
3196 ;; (@* "Core: misc")
3197 (defun anything-kill-buffer-hook ()
3198 "Remove tick entry from `anything-tick-hash' when killing a buffer."
3199 (loop for key being the hash-keys in anything-tick-hash
3200 if (string-match (format "^%s/" (regexp-quote (buffer-name))) key)
3201 do (remhash key anything-tick-hash)))
3202 (add-hook 'kill-buffer-hook 'anything-kill-buffer-hook)
3204 (defun anything-preselect (candidate-or-regexp)
3205 "Move `anything-selection-overlay' to CANDIDATE-OR-REGEXP on startup."
3206 (with-anything-window
3207 (when candidate-or-regexp
3208 (goto-char (point-min))
3209 ;; go to first candidate of first source
3210 (forward-line 1)
3211 (let ((start (point)))
3212 (or (re-search-forward
3213 (concat "^" (regexp-quote candidate-or-regexp) "$") nil t)
3214 (re-search-forward candidate-or-regexp nil t)
3215 (search-forward candidate-or-regexp nil t)
3216 (goto-char start))))
3217 (anything-mark-current-line)))
3219 (defun anything-delete-current-selection ()
3220 "Delete the currently selected item."
3221 (interactive)
3222 (with-anything-window
3223 (cond ((anything-pos-multiline-p)
3224 (anything-aif (anything-get-next-candidate-separator-pos)
3225 (delete-region (point-at-bol)
3226 (1+ (progn (goto-char it) (point-at-eol))))
3227 ;; last candidate
3228 (goto-char (anything-get-previous-candidate-separator-pos))
3229 (delete-region (point-at-bol) (point-max)))
3230 (when (anything-end-of-source-p)
3231 (goto-char (or (anything-get-previous-candidate-separator-pos)
3232 (point-min)))
3233 (forward-line 1)))
3235 (delete-region (point-at-bol) (1+ (point-at-eol)))
3236 (when (anything-end-of-source-p) (forward-line -1))))
3237 (anything-mark-current-line)))
3239 (defun anything-end-of-source-p ()
3240 "Return non--nil if we are at eob or end of source."
3241 (save-excursion
3242 (forward-line 1)
3243 (or (eq (point-at-bol) (point-at-eol))
3244 (anything-pos-header-line-p)
3245 (eobp))))
3247 (defun anything-edit-current-selection-internal (func)
3248 (with-anything-window
3249 (beginning-of-line)
3250 (let ((realvalue (get-text-property (point) 'anything-realvalue)))
3251 (funcall func)
3252 (beginning-of-line)
3253 (and realvalue
3254 (put-text-property (point) (point-at-eol)
3255 'anything-realvalue realvalue))
3256 (anything-mark-current-line))))
3258 (defmacro anything-edit-current-selection (&rest forms)
3259 "Evaluate FORMS at current selection in the anything buffer.
3260 You can edit the line."
3261 (declare (indent 0) (debug t))
3262 `(anything-edit-current-selection-internal
3263 (lambda () ,@forms)))
3265 (defun anything-set-pattern (pattern &optional noupdate)
3266 "Set minibuffer contents to PATTERN.
3267 if optional NOUPDATE is non-nil, anything buffer is not changed."
3268 (with-selected-window (or (active-minibuffer-window) (minibuffer-window))
3269 (delete-minibuffer-contents)
3270 (insert pattern))
3271 (when noupdate
3272 (setq anything-pattern pattern)
3273 (anything-hooks 'cleanup)
3274 (run-with-idle-timer 0 nil 'anything-hooks 'setup)))
3276 (defun anything-delete-minibuffer-contents ()
3277 "Same as `delete-minibuffer-contents' but this is a command."
3278 (interactive)
3279 (anything-set-pattern ""))
3280 (defalias 'anything-delete-minibuffer-content 'anything-delete-minibuffer-contents)
3283 ;;; Plugins
3285 ;; (@* "Built-in plug-in: type")
3286 (defun anything-compile-source--type (source)
3287 (anything-aif (assoc-default 'type source)
3288 (append source (assoc-default it anything-type-attributes) nil)
3289 source))
3291 ;; `define-anything-type-attribute' is public API.
3293 (defun anything-add-type-attribute (type definition)
3294 (anything-aif (assq type anything-type-attributes)
3295 (setq anything-type-attributes (delete it anything-type-attributes)))
3296 (push (cons type definition) anything-type-attributes))
3298 (defvar anything-types nil)
3299 (defun anything-document-type-attribute (type doc)
3300 (add-to-list 'anything-types type t)
3301 (put type 'anything-typeattrdoc
3302 (concat "- " (symbol-name type) "\n\n" doc "\n")))
3304 (defadvice documentation-property (after anything-document-type-attribute activate)
3305 "Display type attributes' documentation as `anything-type-attributes' docstring."
3306 (when (eq (ad-get-arg 0) 'anything-type-attributes)
3307 (setq ad-return-value
3308 (concat ad-return-value "\n\n++++ Types currently defined ++++\n"
3309 (mapconcat (lambda (sym) (get sym 'anything-typeattrdoc))
3310 anything-types "\n")))))
3312 ;; (@* "Built-in plug-in: dummy")
3313 (defun anything-dummy-candidate (candidate source)
3314 "Use `anything-pattern' as CANDIDATE in SOURCE."
3315 ;; `source' is defined in filtered-candidate-transformer
3316 (list anything-pattern))
3318 (defun anything-compile-source--dummy (source)
3319 (if (assoc 'dummy source)
3320 (append source
3321 '((candidates "dummy")
3322 (accept-empty)
3323 (match identity)
3324 (filtered-candidate-transformer . anything-dummy-candidate)
3325 ;;(disable-shortcuts)
3326 (volatile)))
3327 source))
3329 ;; (@* "Built-in plug-in: disable-shortcuts")
3330 (defvar anything-orig-enable-shortcuts nil)
3331 (defun anything-save-enable-shortcuts ()
3332 (anything-once
3333 (lambda ()
3334 (setq anything-orig-enable-shortcuts anything-enable-shortcuts
3335 anything-enable-shortcuts nil))))
3337 (defun anything-compile-source--disable-shortcuts (source)
3338 (if (assoc 'disable-shortcuts source)
3339 (append `((init ,@(anything-mklist (assoc-default 'init source))
3340 anything-save-enable-shortcuts)
3341 (resume ,@(anything-mklist (assoc-default 'resume source))
3342 anything-save-enable-shortcuts)
3343 (cleanup ,@(anything-mklist (assoc-default 'cleanup source))
3344 (lambda () (setq anything-enable-shortcuts
3345 anything-orig-enable-shortcuts))))
3346 source)
3347 source))
3349 ;; (@* "Built-in plug-in: candidates-in-buffer")
3350 (defun anything-candidates-in-buffer ()
3351 "Get candidates from the candidates buffer according to `anything-pattern'.
3353 BUFFER is `anything-candidate-buffer' by default. Each
3354 candidate must be placed in one line. This function is meant to
3355 be used in candidates-in-buffer or candidates attribute of an
3356 anything source. Especially fast for many (1000+) candidates.
3359 '((name . \"many files\")
3360 (init . (lambda () (with-current-buffer (anything-candidate-buffer 'local)
3361 (insert-many-filenames))))
3362 (search re-search-forward) ; optional
3363 (candidates-in-buffer)
3364 (type . file))
3366 +===============================================================+
3367 | The new way of making and narrowing candidates: Using buffers |
3368 +===============================================================+
3370 By default, `anything' makes candidates by evaluating the
3371 candidates function, then narrows them by `string-match' for each
3372 candidate.
3374 But this way is very slow for many candidates. The new way is
3375 storing all candidates in a buffer and narrowing them by
3376 `re-search-forward'. Search function is customizable by search
3377 attribute. The important point is that buffer processing is MUCH
3378 FASTER than string list processing and is the Emacs way.
3380 The init function writes all candidates to a newly-created
3381 candidate buffer. The candidates buffer is created or specified
3382 by `anything-candidate-buffer'. Candidates are stored in a line.
3384 The candidates function narrows all candidates, IOW creates a
3385 subset of candidates dynamically. It is the task of
3386 `anything-candidates-in-buffer'. As long as
3387 `anything-candidate-buffer' is used,`(candidates-in-buffer)' is
3388 sufficient in most cases.
3390 Note that `(candidates-in-buffer)' is shortcut of three attributes:
3391 (candidates . anything-candidates-in-buffer)
3392 (volatile)
3393 (match identity)
3394 And `(candidates-in-buffer . func)' is shortcut of three attributes:
3395 (candidates . func)
3396 (volatile)
3397 (match identity)
3398 The expansion is performed in `anything-get-sources'.
3400 The candidates-in-buffer attribute implies the volatile attribute.
3401 The volatile attribute is needed because `anything-candidates-in-buffer'
3402 creates candidates dynamically and need to be called everytime
3403 `anything-pattern' changes.
3405 Because `anything-candidates-in-buffer' plays the role of `match' attribute
3406 function, specifying `(match identity)' makes the source slightly faster.
3408 To customize `anything-candidates-in-buffer' behavior, use search,
3409 get-line and search-from-end attributes. See also `anything-sources' docstring."
3410 (declare (special source))
3411 (anything-candidates-in-buffer-1
3412 (anything-candidate-buffer)
3413 anything-pattern
3414 (or (assoc-default 'get-line source)
3415 #'buffer-substring-no-properties)
3416 ;; use external variable `source'.
3417 (or (assoc-default 'search source)
3418 (if (assoc 'search-from-end source)
3419 '(anything-candidates-in-buffer-search-from-end)
3420 '(anything-candidates-in-buffer-search-from-start)))
3421 (anything-candidate-number-limit source)
3422 (assoc 'search-from-end source)))
3424 (defun anything-candidates-in-buffer-search-from-start (pattern)
3425 "Search PATTERN with `re-search-forward' with bound and noerror args."
3426 (re-search-forward pattern nil t))
3428 (defun anything-candidates-in-buffer-search-from-end (pattern)
3429 "Search PATTERN with `re-search-backward' with bound and noerror args."
3430 (re-search-backward pattern nil t))
3432 (defun anything-candidates-in-buffer-1 (buffer pattern get-line-fn
3433 search-fns limit search-from-end)
3434 ;; buffer == nil when candidates buffer does not exist.
3435 (when buffer
3436 (with-current-buffer buffer
3437 (let ((start-point (if search-from-end (point-max) (point-min)))
3438 (endp (if search-from-end #'bobp #'eobp)))
3439 (goto-char (1- start-point))
3440 (if (string= pattern "")
3441 (anything-initial-candidates-from-candidate-buffer
3442 endp get-line-fn limit search-from-end)
3443 (anything-search-from-candidate-buffer
3444 pattern get-line-fn search-fns limit search-from-end
3445 start-point endp))))))
3447 (defun anything-point-is-moved (proc)
3448 "If point is moved after executing PROC, return t, otherwise nil."
3449 (/= (point) (progn (funcall proc) (point))))
3451 (defun anything-search-from-candidate-buffer (pattern get-line-fn search-fns
3452 limit search-from-end
3453 start-point endp)
3454 (let (buffer-read-only
3455 matches exit newmatches)
3456 (anything-search-from-candidate-buffer-internal
3457 (lambda ()
3458 (clrhash anything-cib-hash)
3459 (dolist (searcher search-fns)
3460 (goto-char start-point)
3461 (setq newmatches nil)
3462 (loop with item-count = 0
3463 while (funcall searcher pattern)
3464 for cand = (funcall get-line-fn (point-at-bol) (point-at-eol))
3465 do (anything-accumulate-candidates-internal
3466 cand newmatches anything-cib-hash item-count limit)
3467 unless (anything-point-is-moved
3468 (lambda ()
3469 (if search-from-end
3470 (goto-char (1- (point-at-bol)))
3471 (forward-line 1))))
3472 return nil)
3473 (setq matches (append matches (nreverse newmatches)))
3474 (if exit (return)))
3475 (delq nil matches)))))
3477 (defun anything-initial-candidates-from-candidate-buffer (endp get-line-fn limit search-from-end)
3478 (delq nil (loop with next-line-fn =
3479 (if search-from-end
3480 (lambda (x) (goto-char (max (1- (point-at-bol)) 1)))
3481 #'forward-line)
3482 until (funcall endp)
3483 for i from 1 to limit
3484 collect (funcall get-line-fn (point-at-bol) (point-at-eol))
3485 do (funcall next-line-fn 1))))
3487 (defun anything-search-from-candidate-buffer-internal (search-fn)
3488 (goto-char (point-min))
3489 (insert "\n")
3490 (goto-char (point-max))
3491 (insert "\n")
3492 (unwind-protect
3493 (funcall search-fn)
3494 (goto-char (point-min))
3495 (delete-char 1)
3496 (goto-char (1- (point-max)))
3497 (delete-char 1)
3499 (set-buffer-modified-p nil)))
3501 (defun anything-candidate-buffer (&optional create-or-buffer)
3502 "Register and return a buffer containing candidates of current source.
3503 `anything-candidate-buffer' searches buffer-local candidates buffer first,
3504 then global candidates buffer.
3506 Acceptable values of CREATE-OR-BUFFER:
3508 - nil (omit)
3509 Only return the candidates buffer.
3510 - a buffer
3511 Register a buffer as a candidates buffer.
3512 - 'global
3513 Create a new global candidates buffer,
3514 named \" *anything candidates:SOURCE*\".
3515 - other non-nil value
3516 Create a new local candidates buffer,
3517 named \" *anything candidates:SOURCE*ANYTHING-CURRENT-BUFFER\"."
3518 (let* ((global-bname (format " *anything candidates:%s*"
3519 anything-source-name))
3520 (local-bname (format " *anything candidates:%s*%s"
3521 anything-source-name
3522 (buffer-name anything-current-buffer))))
3523 (flet ((register-func ()
3524 (setq anything-candidate-buffer-alist
3525 (cons (cons anything-source-name create-or-buffer)
3526 (delete (assoc anything-source-name
3527 anything-candidate-buffer-alist)
3528 anything-candidate-buffer-alist))))
3529 (kill-buffers-func ()
3530 (loop for b in (buffer-list)
3531 if (string-match (format "^%s" (regexp-quote global-bname))
3532 (buffer-name b))
3533 do (kill-buffer b)))
3534 (create-func ()
3535 (with-current-buffer
3536 (get-buffer-create (if (eq create-or-buffer 'global)
3537 global-bname
3538 local-bname))
3539 (buffer-disable-undo)
3540 (erase-buffer)
3541 (font-lock-mode -1)))
3542 (return-func ()
3543 (or (get-buffer local-bname)
3544 (get-buffer global-bname)
3545 (anything-aif (assoc-default anything-source-name
3546 anything-candidate-buffer-alist)
3547 (and (buffer-live-p it) it)))))
3548 (when create-or-buffer
3549 (register-func)
3550 (unless (bufferp create-or-buffer)
3551 (and (eq create-or-buffer 'global) (kill-buffers-func))
3552 (create-func)))
3553 (return-func))))
3555 (defun anything-compile-source--candidates-in-buffer (source)
3556 (anything-aif (assoc 'candidates-in-buffer source)
3557 (append source
3558 `((candidates . ,(or (cdr it) 'anything-candidates-in-buffer))
3559 (volatile) (match identity)))
3560 source))
3563 ;; (@* "Utility: resplit anything window")
3564 (defun anything-toggle-resplit-window ()
3565 "Toggle resplit anything window, vertically or horizontally."
3566 (interactive)
3567 (with-anything-window
3568 (let ((before-height (window-height)))
3569 (delete-window)
3570 (set-window-buffer
3571 (select-window (if (= (window-height) before-height)
3572 (prog1
3573 (split-window-vertically)
3574 (setq anything-split-window-state 'vertical))
3575 (setq anything-split-window-state 'horizontal)
3576 (split-window-horizontally)))
3577 anything-buffer))))
3579 ;; (@* "Utility: Resize anything window.")
3580 (defun anything-enlarge-window-1 (n)
3581 "Enlarge or narrow anything window.
3582 If N is positive enlarge, if negative narrow."
3583 (unless anything-samewindow
3584 (let ((horizontal-p (eq anything-split-window-state 'horizontal)))
3585 (with-anything-window
3586 (enlarge-window n horizontal-p)))))
3588 (defun anything-narrow-window ()
3589 "Narrow anything window."
3590 (interactive)
3591 (anything-enlarge-window-1 -1))
3593 (defun anything-enlarge-window ()
3594 "Enlarge anything window."
3595 (interactive)
3596 (anything-enlarge-window-1 1))
3598 ;; (@* "Utility: select another action by key")
3599 (defun anything-select-nth-action (n)
3600 "Select the N nth action for the currently selected candidate."
3601 (setq anything-saved-selection (anything-get-selection))
3602 (unless anything-saved-selection
3603 (error "Nothing is selected"))
3604 (setq anything-saved-action (anything-get-nth-action n (anything-get-action)))
3605 (anything-exit-minibuffer))
3607 (defun anything-get-nth-action (n action)
3608 (cond ((and (zerop n) (functionp action))
3609 action)
3610 ((listp action)
3611 (or (cdr (elt action n))
3612 (error "No such action")))
3613 ((and (functionp action) (< 0 n))
3614 (error "Sole action"))
3616 (error "Error in `anything-select-nth-action'"))))
3618 (defun anything-select-2nd-action ()
3619 "Select the 2nd action for the currently selected candidate."
3620 (interactive)
3621 (anything-select-nth-action 1))
3623 (defun anything-select-3rd-action ()
3624 "Select the 3rd action for the currently selected candidate."
3625 (interactive)
3626 (anything-select-nth-action 2))
3628 (defun anything-select-4th-action ()
3629 "Select the 4th action for the currently selected candidate."
3630 (interactive)
3631 (anything-select-nth-action 3))
3633 (defun anything-select-2nd-action-or-end-of-line ()
3634 "Select the 2nd action for the currently selected candidate.
3635 This happen when point is at the end of minibuffer.
3636 Otherwise goto the end of minibuffer."
3637 (interactive)
3638 (if (eolp)
3639 (anything-select-nth-action 1)
3640 (end-of-line)))
3642 ;; (@* "Utility: Persistent Action")
3643 (defmacro with-anything-display-same-window (&rest body)
3644 "Execute BODY in the window used for persistent action.
3645 Make `pop-to-buffer' and `display-buffer' display in the same window."
3646 (declare (indent 0) (debug t))
3647 `(let ((display-buffer-function 'anything-persistent-action-display-buffer))
3648 ,@body))
3650 (defvar anything-persistent-action-display-window nil)
3651 (defun anything-initialize-persistent-action ()
3652 (set (make-local-variable 'anything-persistent-action-display-window) nil))
3654 (defun* anything-execute-persistent-action (&optional (attr 'persistent-action) onewindow)
3655 "Perform the associated action ATTR without quitting anything.
3656 ATTR default is 'persistent-action', but it can be anything else.
3657 In this case you have to add this new attribute to your source.
3658 When `anything-samewindow' and ONEWINDOW are non--nil,
3659 the anything window is never split in persistent action."
3660 (interactive)
3661 (anything-log "executing persistent-action")
3662 (with-anything-window
3663 (save-selected-window
3664 (anything-select-persistent-action-window onewindow)
3665 (anything-log-eval (current-buffer))
3666 (let ((anything-in-persistent-action t))
3667 (with-anything-display-same-window
3668 (anything-execute-selection-action
3670 (or (assoc-default attr (anything-get-current-source))
3671 (anything-get-action))
3673 (anything-log-run-hook 'anything-after-persistent-action-hook))))))
3676 (defun anything-persistent-action-display-window (&optional onewindow)
3677 "Return the window that will be used for presistent action.
3678 If ONEWINDOW is non--nil window will not be splitted in persistent action
3679 if `anything-samewindow' is non--nil also."
3680 (with-anything-window
3681 (setq anything-persistent-action-display-window
3682 (cond ((window-live-p anything-persistent-action-display-window)
3683 anything-persistent-action-display-window)
3684 ((and anything-samewindow (one-window-p t) (not onewindow))
3685 (split-window))
3686 ((get-buffer-window anything-current-buffer))
3688 (next-window (selected-window) 1))))))
3690 (defun anything-select-persistent-action-window (&optional onewindow)
3691 "Select the window that will be used for persistent action.
3692 See `anything-persistent-action-display-window' for how to use ONEWINDOW."
3693 (select-window (get-buffer-window (anything-buffer-get)))
3694 (select-window
3695 (setq minibuffer-scroll-window
3696 (anything-persistent-action-display-window onewindow))))
3698 (defun anything-persistent-action-display-buffer (buf &optional not-this-window)
3699 "Make `pop-to-buffer' and `display-buffer' display in the same window.
3700 If `anything-persistent-action-use-special-display' is non-nil and
3701 BUF is to be displayed by `special-display-function', use it.
3702 Otherwise ignores `special-display-buffer-names' and `special-display-regexps'.
3703 Argument NOT-THIS-WINDOW if present will be used as
3704 second argument of `display-buffer'."
3705 (let* ((name (buffer-name buf))
3706 display-buffer-function pop-up-windows pop-up-frames
3707 (same-window-regexps
3708 (unless (and anything-persistent-action-use-special-display
3709 (or (member name
3710 (mapcar (lambda (x) (or (car-safe x) x))
3711 special-display-buffer-names))
3712 (remove-if-not
3713 (lambda (x) (string-match (or (car-safe x) x) name))
3714 special-display-regexps)))
3715 '("."))))
3716 (display-buffer buf not-this-window)))
3718 ;; scroll-other-window(-down)? for persistent-action
3719 (defun anything-scroll-other-window-base (command)
3720 (with-selected-window (anything-persistent-action-display-window)
3721 (funcall command anything-scroll-amount)))
3723 (defun anything-scroll-other-window ()
3724 "Scroll other window (not *Anything* window) upward."
3725 (interactive)
3726 (anything-scroll-other-window-base 'scroll-up))
3728 (defun anything-scroll-other-window-down ()
3729 "Scroll other window (not *Anything* window) downward."
3730 (interactive)
3731 (anything-scroll-other-window-base 'scroll-down))
3734 ;; (@* "Utility: Visible Mark")
3735 (defface anything-visible-mark
3736 '((((min-colors 88) (background dark))
3737 (:background "green1" :foreground "black"))
3738 (((background dark)) (:background "green" :foreground "black"))
3739 (((min-colors 88)) (:background "green1"))
3740 (t (:background "green")))
3741 "Face for visible mark."
3742 :group 'anything)
3744 (defvar anything-visible-mark-face 'anything-visible-mark)
3745 (defvar anything-visible-mark-overlays nil)
3747 (defun anything-clear-visible-mark ()
3748 (with-current-buffer (anything-buffer-get)
3749 (mapc 'delete-overlay anything-visible-mark-overlays)
3750 (set (make-local-variable 'anything-visible-mark-overlays) nil)))
3751 (add-hook 'anything-after-initialize-hook 'anything-clear-visible-mark)
3753 (defvar anything-marked-candidates nil
3754 "Marked candadates. List of \(source . real\) pair.")
3756 (defun anything-this-visible-mark ()
3757 (loop for o in anything-visible-mark-overlays
3758 when (equal (point-at-bol) (overlay-start o))
3759 return o))
3761 (defun anything-delete-visible-mark (overlay)
3762 (setq anything-marked-candidates
3763 (remove
3764 (cons (anything-get-current-source) (anything-get-selection))
3765 anything-marked-candidates))
3766 (delete-overlay overlay)
3767 (setq anything-visible-mark-overlays
3768 (delq overlay anything-visible-mark-overlays)))
3770 (defun anything-make-visible-mark ()
3771 (let ((o (make-overlay (point-at-bol) (1+ (point-at-eol)))))
3772 (overlay-put o 'face anything-visible-mark-face)
3773 (overlay-put o 'source (assoc-default 'name (anything-get-current-source)))
3774 (overlay-put o 'string (buffer-substring (overlay-start o) (overlay-end o)))
3775 (overlay-put o 'real (anything-get-selection))
3776 (add-to-list 'anything-visible-mark-overlays o))
3777 (push (cons (anything-get-current-source) (anything-get-selection))
3778 anything-marked-candidates))
3780 (defun anything-toggle-visible-mark ()
3781 "Toggle anything visible mark at point."
3782 (interactive)
3783 (with-anything-window
3784 (anything-aif (anything-this-visible-mark)
3785 (anything-delete-visible-mark it)
3786 (anything-make-visible-mark))
3787 (anything-next-line)))
3789 (defun anything-display-all-visible-marks ()
3790 "Show all `anything' visible marks strings."
3791 (interactive)
3792 (with-anything-window
3793 (lexical-let ((overlays (reverse anything-visible-mark-overlays)))
3794 (anything-run-after-quit
3795 (lambda ()
3796 (with-output-to-temp-buffer "*anything visible marks*"
3797 (dolist (o overlays) (princ (overlay-get o 'string)))))))))
3799 (defun anything-marked-candidates ()
3800 "Return marked candidates of current source if any.
3801 Otherwise one element list of current selection.
3803 It is analogous to `dired-get-marked-files'."
3804 (with-current-buffer (anything-buffer-get)
3805 (let ((cands
3806 (if anything-marked-candidates
3807 (loop with current-src = (anything-get-current-source)
3808 for (source . real) in (reverse anything-marked-candidates)
3809 when (equal current-src source)
3810 collect (anything-coerce-selection real source))
3811 (list (anything-get-selection)))))
3812 (anything-log-eval cands)
3813 cands)))
3815 (defun anything-reset-marked-candidates ()
3816 (with-current-buffer (anything-buffer-get)
3817 (set (make-local-variable 'anything-marked-candidates) nil)))
3819 (add-hook 'anything-after-initialize-hook 'anything-reset-marked-candidates)
3820 ;; (add-hook 'anything-after-action-hook 'anything-reset-marked-candidates)
3822 (defun anything-current-source-name= (name)
3823 (save-excursion
3824 (goto-char (anything-get-previous-header-pos))
3825 (equal name (anything-current-line-contents))))
3827 (defun anything-revive-visible-mark ()
3828 "Restore marked candidates when anything update display."
3829 (with-current-buffer anything-buffer
3830 (dolist (o anything-visible-mark-overlays)
3831 (goto-char (point-min))
3832 (while (and (search-forward (overlay-get o 'string) nil t)
3833 (anything-current-source-name= (overlay-get o 'source)))
3834 ;; Calculate real value of candidate.
3835 ;; It can be nil if candidate have only a display value.
3836 (let ((real (get-text-property (point-at-bol 0) 'anything-realvalue)))
3837 (if real
3838 ;; Check if real value of current candidate is the same
3839 ;; that the one stored in overlay.
3840 (and (string= (overlay-get o 'real) real)
3841 (move-overlay o (point-at-bol 0) (1+ (point-at-eol 0))))
3842 (move-overlay o (point-at-bol 0) (1+ (point-at-eol 0)))))))))
3843 (add-hook 'anything-update-hook 'anything-revive-visible-mark)
3845 (defun anything-next-point-in-list (curpos points &optional prev)
3846 (cond
3847 ;; rule out special cases
3848 ((null points) curpos)
3849 ((and prev (< curpos (car points))) curpos)
3850 ((< (car (last points)) curpos)
3851 (if prev (car (last points)) curpos))
3853 (nth (if prev
3854 (loop for pt in points
3855 for i from 0
3856 if (<= curpos pt)
3857 return (1- i))
3858 (loop for pt in points
3859 for i from 0
3860 if (< curpos pt)
3861 return i))
3862 points))))
3864 (defun anything-next-visible-mark (&optional prev)
3865 "Move next anything visible mark.
3866 If PREV is non-nil move to precedent."
3867 (interactive)
3868 (with-anything-window
3869 (ignore-errors
3870 (goto-char (anything-next-point-in-list
3871 (point)
3872 (sort (mapcar 'overlay-start anything-visible-mark-overlays) '<)
3873 prev)))
3874 (anything-mark-current-line)))
3876 (defun anything-prev-visible-mark ()
3877 "Move previous anything visible mark."
3878 (interactive)
3879 (anything-next-visible-mark t))
3881 ;; (@* "Utility: Selection Paste")
3882 (defun anything-yank-selection ()
3883 "Set minibuffer contents to current selection."
3884 (interactive)
3885 (anything-set-pattern (anything-get-selection nil t)))
3887 (defun anything-kill-selection-and-quit ()
3888 "Store current selection to kill ring.
3889 You can paste it by typing \\[yank]."
3890 (interactive)
3891 (anything-run-after-quit
3892 (lambda (sel)
3893 (kill-new sel)
3894 (message "Killed: %s" sel))
3895 (anything-get-selection nil t)))
3898 ;; (@* "Utility: Automatical execution of persistent-action")
3899 (add-to-list 'minor-mode-alist '(anything-follow-mode " AFollow"))
3900 (defun anything-follow-mode ()
3901 "If this mode is on, persistent action is executed everytime the cursor is moved."
3902 (interactive)
3903 (with-current-buffer anything-buffer
3904 (setq anything-follow-mode (not anything-follow-mode))
3905 (message "anything-follow-mode is %s"
3906 (if anything-follow-mode "enabled" "disabled"))))
3908 (defun anything-follow-execute-persistent-action-maybe ()
3909 "Execute persistent action in mode `anything-follow-mode'.
3910 This happen after `anything-input-idle-delay' secs."
3911 (and (not (get-buffer-window anything-action-buffer 'visible))
3912 (buffer-local-value 'anything-follow-mode
3913 (get-buffer-create anything-buffer))
3914 (sit-for (and anything-input-idle-delay
3915 (max anything-input-idle-delay 0.1)))
3916 (anything-window)
3917 (anything-get-selection)
3918 (save-excursion
3919 (anything-execute-persistent-action))))
3922 ;; (@* "Utility: Migrate `anything-sources' to my-anything command")
3923 (defun anything-migrate-sources ()
3924 "Help to migrate to new `anything' way."
3925 (interactive)
3926 (with-current-buffer (get-buffer-create "*anything migrate*")
3927 (erase-buffer)
3928 (insert (format "\
3929 Setting `anything-sources' directly is not good because
3930 `anything' is not for one command. For now, interactive use of
3931 `anything' (M-x anything) is only for demonstration purpose.
3932 So you should define commands calling `anything'.
3933 I help you to migrate to the new way.
3935 The code below is automatically generated from current
3936 `anything-sources' value. You can use the `my-anything' command
3937 now!
3939 Copy and paste it to your .emacs. Then substitute `my-anything'
3940 for `anything' bindings in all `define-key', `local-set-key' and
3941 `global-set-key' calls.
3943 \(defun my-anything ()
3944 \"Anything command for you.
3946 It is automatically generated by `anything-migrate-sources'.\"
3947 (interactive)
3948 (anything-other-buffer
3950 \"*my-anything*\"))
3951 " anything-sources))
3952 (eval-last-sexp nil)
3953 (substitute-key-definition 'anything 'my-anything global-map)
3954 (pop-to-buffer (current-buffer))))
3957 ;; (@* "Compatibility")
3959 ;; Copied assoc-default from XEmacs version 21.5.12
3960 (unless (fboundp 'assoc-default)
3961 (defun assoc-default (key alist &optional test default)
3962 "Find object KEY in a pseudo-alist ALIST.
3963 ALIST is a list of conses or objects. Each element (or the element's car,
3964 if it is a cons) is compared with KEY by evaluating (TEST (car elt) KEY).
3965 If that is non-nil, the element matches;
3966 then `assoc-default' returns the element's cdr, if it is a cons,
3967 or DEFAULT if the element is not a cons.
3969 If no element matches, the value is nil.
3970 If TEST is omitted or nil, `equal' is used."
3971 (let (found (tail alist) value)
3972 (while (and tail (not found))
3973 (let ((elt (car tail)))
3974 (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key)
3975 (setq found t value (if (consp elt) (cdr elt) default))))
3976 (setq tail (cdr tail)))
3977 value)))
3979 ;; Function not available in XEmacs,
3980 (unless (fboundp 'minibuffer-contents)
3981 (defun minibuffer-contents ()
3982 "Return the user input in a minbuffer as a string.
3983 The current buffer must be a minibuffer."
3984 (field-string (point-max)))
3986 (defun delete-minibuffer-contents ()
3987 "Delete all user input in a minibuffer.
3988 The current buffer must be a minibuffer."
3989 (delete-field (point-max))))
3991 ;; Function not available in older Emacs (<= 22.1).
3992 (unless (fboundp 'buffer-chars-modified-tick)
3993 (defun buffer-chars-modified-tick (&optional buffer)
3994 "Return BUFFER's character-change tick counter.
3995 Each buffer has a character-change tick counter, which is set to the
3996 value of the buffer's tick counter (see `buffer-modified-tick'), each
3997 time text in that buffer is inserted or deleted. By comparing the
3998 values returned by two individual calls of `buffer-chars-modified-tick',
3999 you can tell whether a character change occurred in that buffer in
4000 between these calls. No argument or nil as argument means use current
4001 buffer as BUFFER."
4002 (with-current-buffer (or buffer (current-buffer))
4003 (if (listp buffer-undo-list)
4004 (length buffer-undo-list)
4005 (buffer-modified-tick)))))
4008 ;; (@* "CUA workaround")
4009 (defadvice cua-delete-region (around anything-avoid-cua activate)
4010 (ignore-errors ad-do-it))
4012 (defadvice copy-region-as-kill (around anything-avoid-cua activate)
4013 (if cua-mode
4014 (ignore-errors ad-do-it)
4015 ad-do-it))
4017 ;;(@* "Attribute Documentation")
4018 (defun anything-describe-anything-attribute (anything-attribute)
4019 "Display the full documentation of ANYTHING-ATTRIBUTE.
4020 ANYTHING-ATTRIBUTE should be a symbol."
4021 (interactive (list (intern
4022 (completing-read
4023 "Describe anything attribute: "
4024 (mapcar 'symbol-name anything-additional-attributes)
4025 nil t))))
4026 (with-output-to-temp-buffer "*Help*"
4027 (princ (get anything-attribute 'anything-attrdoc))))
4029 (anything-document-attribute 'name "mandatory"
4030 " The name of the source. It is also the heading which appears
4031 above the list of matches from the source. Must be unique.")
4033 (anything-document-attribute 'header-name "optional"
4034 " A function returning the display string of the header. Its
4035 argument is the name of the source. This attribute is useful to
4036 add an additional information with the source name.")
4038 (anything-document-attribute 'candidates "mandatory if candidates-in-buffer attribute is not provided"
4039 " Specifies how to retrieve candidates from the source. It can
4040 either be a variable name, a function called with no parameters
4041 or the actual list of candidates.
4043 The list must be a list whose members are strings, symbols
4044 or (DISPLAY . REAL) pairs.
4046 In case of (DISPLAY . REAL) pairs, the DISPLAY string is shown
4047 in the Anything buffer, but the REAL one is used as action
4048 argument when the candidate is selected. This allows a more
4049 readable presentation for candidates which would otherwise be,
4050 for example, too long or have a common part shared with other
4051 candidates which can be safely replaced with an abbreviated
4052 string for display purposes.
4054 Note that if the (DISPLAY . REAL) form is used then pattern
4055 matching is done on the displayed string, not on the real
4056 value.
4058 If the candidates have to be retrieved asynchronously (for
4059 example, by an external command which takes a while to run)
4060 then the function should start the external command
4061 asynchronously and return the associated process object.
4062 Anything will take care of managing the process (receiving the
4063 output from it, killing it if necessary, etc.). The process
4064 should return candidates matching the current pattern (see
4065 variable `anything-pattern'.)
4067 Note that currently results from asynchronous sources appear
4068 last in the anything buffer regardless of their position in
4069 `anything-sources'.")
4071 (anything-document-attribute 'action "mandatory if type attribute is not provided"
4072 " It is a list of (DISPLAY . FUNCTION) pairs or FUNCTION.
4073 FUNCTION is called with one parameter: the selected candidate.
4075 An action other than the default can be chosen from this list
4076 of actions for the currently selected candidate (by default
4077 with TAB). The DISPLAY string is shown in the completions
4078 buffer and the FUNCTION is invoked when an action is
4079 selected. The first action of the list is the default.")
4081 (anything-document-attribute 'coerce "optional"
4082 " It's a function called with one argument: the selected candidate.
4084 This function is intended for type convertion.
4085 In normal case, the selected candidate (string) is passed to action function.
4086 If coerce function is specified, it is called just before action function.
4088 Example: converting string to symbol
4089 (coerce . intern)")
4091 (anything-document-attribute 'type "optional if action attribute is provided"
4092 " Indicates the type of the items the source returns.
4094 Merge attributes not specified in the source itself from
4095 `anything-type-attributes'.
4097 This attribute is implemented by plug-in.")
4099 (anything-document-attribute 'init "optional"
4100 " Function called with no parameters when anything is started. It
4101 is useful for collecting current state information which can be
4102 used to create the list of candidates later.
4104 For example, if a source needs to work with the current
4105 directory then it can store its value here, because later
4106 anything does its job in the minibuffer and in the
4107 `anything-buffer' and the current directory can be different
4108 there.")
4110 (anything-document-attribute 'delayed-init "optional"
4111 " Function called with no parameters before candidate function is
4112 called. It is similar with `init' attribute, but its
4113 evaluation is deferred. It is useful to combine with ")
4115 (anything-document-attribute 'match "optional"
4116 " List of functions called with one parameter: a candidate. The
4117 function should return non-nil if the candidate matches the
4118 current pattern (see variable `anything-pattern').
4120 This attribute allows the source to override the default
4121 pattern matching based on `string-match'. It can be used, for
4122 example, to implement a source for file names and do the
4123 pattern matching on the basename of files, since it's more
4124 likely one is typing part of the basename when searching for a
4125 file, instead of some string anywhere else in its path.
4127 If the list contains more than one function then the list of
4128 matching candidates from the source is constructed by appending
4129 the results after invoking the first function on all the
4130 potential candidates, then the next function, and so on. The
4131 matching candidates supplied by the first function appear first
4132 in the list of results and then results from the other
4133 functions, respectively.
4135 This attribute has no effect for asynchronous sources (see
4136 attribute `candidates'), since they perform pattern matching
4137 themselves.")
4139 (anything-document-attribute 'candidate-transformer "optional"
4140 " It's a function or a list of functions called with one argument
4141 when the completion list from the source is built. The argument
4142 is the list of candidates retrieved from the source. The
4143 function should return a transformed list of candidates which
4144 will be used for the actual completion. If it is a list of
4145 functions, it calls each function sequentially.
4147 This can be used to transform or remove items from the list of
4148 candidates.
4150 Note that `candidates' is run already, so the given transformer
4151 function should also be able to handle candidates with (DISPLAY
4152 . REAL) format.")
4154 (anything-document-attribute 'filtered-candidate-transformer "optional"
4155 " It has the same format as `candidate-transformer', except the
4156 function is called with two parameters: the candidate list and
4157 the source.
4159 This transformer is run on the candidate list which is already
4160 filtered by the current pattern. While `candidate-transformer'
4161 is run only once, it is run every time the input pattern is
4162 changed.
4164 It can be used to transform the candidate list dynamically, for
4165 example, based on the current pattern.
4167 In some cases it may also be more efficent to perform candidate
4168 transformation here, instead of with `candidate-transformer'
4169 even if this transformation is done every time the pattern is
4170 changed. For example, if a candidate set is very large then
4171 `candidate-transformer' transforms every candidate while only
4172 some of them will actually be dislpayed due to the limit
4173 imposed by `anything-candidate-number-limit'.
4175 Note that `candidates' and `candidate-transformer' is run
4176 already, so the given transformer function should also be able
4177 to handle candidates with (DISPLAY . REAL) format.
4179 This option has no effect for asynchronous sources. (Not yet,
4180 at least.")
4182 (anything-document-attribute 'action-transformer "optional"
4183 " It's a function or a list of functions called with two
4184 arguments when the action list from the source is
4185 assembled. The first argument is the list of actions, the
4186 second is the current selection. If it is a list of functions,
4187 it calls each function sequentially.
4189 The function should return a transformed action list.
4191 This can be used to customize the list of actions based on the
4192 currently selected candidate.")
4194 (anything-document-attribute 'pattern-transformer "optional"
4195 " It's a function or a list of functions called with one argument
4196 before computing matches. Its argument is `anything-pattern'.
4197 Functions should return transformed `anything-pattern'.
4199 It is useful to change interpretation of `anything-pattern'.")
4201 (anything-document-attribute 'delayed "optional"
4202 " Candidates from the source are shown only if the user stops
4203 typing and is idle for `anything-idle-delay' seconds.")
4205 (anything-document-attribute 'volatile "optional"
4206 " Indicates the source assembles the candidate list dynamically,
4207 so it shouldn't be cached within a single Anything
4208 invocation. It is only applicable to synchronous sources,
4209 because asynchronous sources are not cached.")
4211 (anything-document-attribute 'requires-pattern "optional"
4212 " If present matches from the source are shown only if the
4213 pattern is not empty. Optionally, it can have an integer
4214 parameter specifying the required length of input which is
4215 useful in case of sources with lots of candidates.")
4217 (anything-document-attribute 'persistent-action "optional"
4218 " Function called with one parameter; the selected candidate.
4220 An action performed by `anything-execute-persistent-action'.
4221 If none, use the default action.")
4223 (anything-document-attribute 'candidates-in-buffer "optional"
4224 " Shortcut attribute for making and narrowing candidates using
4225 buffers. This newly-introduced attribute prevents us from
4226 forgetting to add volatile and match attributes.
4228 See docstring of `anything-candidates-in-buffer'.
4230 (candidates-in-buffer) is equivalent of three attributes:
4231 (candidates . anything-candidates-in-buffer)
4232 (volatile)
4233 (match identity)
4235 (candidates-in-buffer . candidates-function) is equivalent of:
4236 (candidates . candidates-function)
4237 (volatile)
4238 (match identity)
4240 This attribute is implemented by plug-in.")
4242 (anything-document-attribute 'search "optional"
4243 " List of functions like `re-search-forward' or `search-forward'.
4244 Buffer search function used by `anything-candidates-in-buffer'.
4245 By default, `anything-candidates-in-buffer' uses `re-search-forward'.
4246 This attribute is meant to be used with
4247 (candidates . anything-candidates-in-buffer) or
4248 (candidates-in-buffer) in short.")
4250 (anything-document-attribute 'search-from-end "optional"
4251 " Make `anything-candidates-in-buffer' search from the end of buffer.
4252 If this attribute is specified, `anything-candidates-in-buffer' uses
4253 `re-search-backward' instead.")
4255 (anything-document-attribute 'get-line "optional"
4256 " A function like `buffer-substring-no-properties' or `buffer-substring'.
4257 This function converts point of line-beginning and point of line-end,
4258 which represents a candidate computed by `anything-candidates-in-buffer'.
4259 By default, `anything-candidates-in-buffer' uses
4260 `buffer-substring-no-properties'.")
4262 (anything-document-attribute 'display-to-real "optional"
4263 " Function called with one parameter; the selected candidate.
4265 The function transforms the selected candidate, and the result
4266 is passed to the action function. The display-to-real
4267 attribute provides another way to pass other string than one
4268 shown in Anything buffer.
4270 Traditionally, it is possible to make candidates,
4271 candidate-transformer or filtered-candidate-transformer
4272 function return a list with (DISPLAY . REAL) pairs. But if REAL
4273 can be generated from DISPLAY, display-to-real is more
4274 convenient and faster.")
4276 (anything-document-attribute 'real-to-display "optional"
4277 " Function called with one parameter; the selected candidate.
4279 The inverse of display-to-real attribute.
4281 The function transforms the selected candidate, which is passed
4282 to the action function, for display. The real-to-display
4283 attribute provides the other way to pass other string than one
4284 shown in Anything buffer.
4286 Traditionally, it is possible to make candidates,
4287 candidate-transformer or filtered-candidate-transformer
4288 function return a list with (DISPLAY . REAL) pairs. But if
4289 DISPLAY can be generated from REAL, real-to-display is more
4290 convenient.
4292 Note that DISPLAY parts returned from candidates /
4293 candidate-transformer are IGNORED as the name `display-to-real'
4294 says.")
4296 (anything-document-attribute 'cleanup "optional"
4297 " Function called with no parameters when *anything* buffer is closed. It
4298 is useful for killing unneeded candidates buffer.
4300 Note that the function is executed BEFORE performing action.")
4302 (anything-document-attribute 'candidate-number-limit "optional"
4303 " Override `anything-candidate-number-limit' only for this source.")
4305 (anything-document-attribute 'accept-empty "optional"
4306 " Pass empty string \"\" to action function.")
4308 (anything-document-attribute 'disable-shortcuts "optional"
4309 " Disable `anything-enable-shortcuts' in current `anything' session.
4311 This attribute is implemented by plug-in.")
4313 (anything-document-attribute 'dummy "optional"
4314 " Set `anything-pattern' to candidate. If this attribute is
4315 specified, The candidates attribute is ignored.
4317 This attribute is implemented by plug-in.
4318 This plug-in implies disable-shortcuts plug-in.")
4320 (anything-document-attribute 'multiline "optional"
4321 " Enable to selection multiline candidates.")
4323 (anything-document-attribute 'update "optional"
4324 (substitute-command-keys
4325 " Function called with no parameters when \
4326 \\<anything-map>\\[anything-force-update] is pressed."))
4328 (anything-document-attribute 'mode-line "optional"
4329 " source local `anything-mode-line-string'. (included in `mode-line-format')
4330 It accepts also variable/function name.")
4332 (anything-document-attribute 'header-line "optional"
4333 " source local `header-line-format'.
4334 It accepts also variable/function name. ")
4336 (anything-document-attribute
4337 'resume "optional"
4338 " Function called with no parameters when `anything-resume' is started.")
4340 (anything-document-attribute 'keymap "optional"
4341 " Specific keymap for this source.
4342 It is useful to have a keymap per source when using more than one source.
4343 Otherwise, a keymap can be set per command with `anything' argument KEYMAP.
4344 NOTE: when a source have `anything-map' as keymap attr,
4345 the global value of `anything-map' will override the actual local one.")
4347 (anything-document-attribute 'help-message "optional"
4348 " Help message for this source.
4349 If not present, `anything-help-message' value will be used.")
4352 ;; (@* "Bug Report")
4353 (defvar anything-maintainer-mail-address "emacs-anything@googlegroups.com")
4355 (defvar anything-bug-report-salutation
4356 "Describe bug below, using a precise recipe.
4358 When I executed M-x ...
4360 How to send a bug report:
4361 1) Be sure to use the LATEST version of anything.el.
4362 2) Enable debugger. M-x toggle-debug-on-error or (setq debug-on-error t)
4363 3) Use Lisp version instead of compiled one: (load \"anything.el\")
4364 4) If you got an error, please paste *Backtrace* buffer.
4365 5) Type C-c C-c to send.")
4367 (defvar anything-no-dump-variables
4368 '(anything-candidate-buffer-alist
4369 anything-digit-overlays
4370 anything-help-message
4371 anything-candidate-cache
4373 "Variables not to dump in bug report.")
4375 (defun anything-dumped-variables-in-bug-report ()
4376 (let ((hash (make-hash-table)))
4377 (loop for var in (apropos-internal "anything-" 'boundp)
4378 for vname = (symbol-name var)
4379 unless (or (string-match "-map$" vname)
4380 (string-match "^anything-c-source-" vname)
4381 (string-match "-hash$" vname)
4382 (string-match "-face$" vname)
4383 (memq var anything-no-dump-variables))
4384 collect var)))
4386 (defun anything-send-bug-report ()
4387 "Send a bug report of anything.el."
4388 (interactive)
4389 (with-current-buffer (or anything-last-buffer
4390 (current-buffer))
4391 (reporter-submit-bug-report
4392 anything-maintainer-mail-address
4393 "anything.el"
4394 (anything-dumped-variables-in-bug-report)
4395 nil nil
4396 anything-bug-report-salutation)))
4398 (defun anything-send-bug-report-from-anything ()
4399 "Send a bug report of anything.el in anything session."
4400 (interactive)
4401 (anything-run-after-quit 'anything-send-bug-report))
4403 ;; Debugging function.
4404 (defun* anything-test-candidates
4405 (sources &optional (input "")
4406 (compile-source-functions
4407 anything-compile-source-functions-default))
4408 "Test helper function for anything.
4409 Given pseudo `anything-sources' and `anything-pattern', returns list like
4410 ((\"source name1\" (\"candidate1\" \"candidate2\"))
4411 (\"source name2\" (\"candidate3\" \"candidate4\")))"
4412 (let ((anything-test-mode t)
4413 anything-enable-shortcuts
4414 anything-candidate-cache
4415 (anything-compile-source-functions compile-source-functions)
4416 anything-before-initialize-hook
4417 anything-after-initialize-hook
4418 anything-update-hook
4419 anything-test-candidate-list)
4420 (get-buffer-create anything-buffer)
4421 (anything-initialize nil input sources)
4422 (anything-update)
4423 ;; test-mode spec: select 1st candidate!
4424 (with-current-buffer anything-buffer
4425 (forward-line 1)
4426 (anything-mark-current-line))
4427 (prog1
4428 anything-test-candidate-list
4429 (anything-cleanup))))
4432 ;; (@* "Unit Tests")
4433 ;; See developer-tools/unit-test-anything.el
4435 (provide 'anything)
4437 ;; Local Variables:
4438 ;; coding: utf-8
4439 ;; End:
4441 ;;; anything.el ends here