* anything-config.el (anything-c-arrange-type-attribute): Bugfix: do not override...
[anything-config.git] / anything.el
blob0a47ada749908af592f50288975344de5a7fe3d5
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'
57 ;;
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 ;; Debugging command
789 (define-key map "\C-c\C-x\C-d" 'anything-debug-output)
790 (define-key map "\C-c\C-x\C-m" 'anything-display-all-visible-marks)
791 (define-key map "\C-c\C-x\C-b" 'anything-send-bug-report-from-anything)
792 ;; Use `describe-mode' key in `global-map'.
793 (define-key map [f1] nil) ; Allow to eval keymap whithout errors.
794 (dolist (k (where-is-internal 'describe-mode global-map))
795 (define-key map k 'anything-help))
796 map)
797 "Keymap for anything.")
800 (defgroup anything nil
801 "Open anything."
802 :prefix "anything-" :group 'convenience)
804 (defface anything-header
805 '((t (:inherit header-line)))
806 "Face for header lines in the anything buffer."
807 :group 'anything)
809 (defvar anything-header-face 'anything-header
810 "*Face for header lines in the anything buffer.")
812 (defface anything-candidate-number
813 '((t (:background "Yellow" :foreground "black")))
814 "Face for candidate number in mode-line." :group 'anything)
816 (defvar anything-selection-face 'highlight
817 "*Face for currently selected item.")
819 (defvar anything-buffer "*anything*"
820 "Buffer showing completions.")
822 (defvar anything-action-buffer "*anything action*"
823 "Buffer showing actions.")
825 (defvar anything-selection-overlay nil
826 "Overlay used to highlight the currently selected item.")
828 (defvar anything-digit-overlays nil
829 "Overlays for digit shortcuts. See `anything-enable-shortcuts'.")
831 (defvar anything-candidate-cache nil
832 "Holds the available candidate withing a single anything invocation.")
834 (defvar anything-pattern
835 "The input pattern used to update the anything buffer.")
837 (defvar anything-input
838 "The input typed in the candidates panel.")
840 (defvar anything-async-processes nil
841 "List of information about asynchronous processes managed by anything.")
843 (defvar anything-digit-shortcut-count 0
844 "Number of digit shortcuts shown in the anything buffer.")
846 (defvar anything-before-initialize-hook nil
847 "Run before anything initialization.
848 This hook is run before init functions in `anything-sources'.")
850 (defvar anything-after-initialize-hook nil
851 "Run after anything initialization.
852 Global variables are initialized and the anything buffer is created.
853 But the anything buffer has no contents.")
855 (defvar anything-update-hook nil
856 "Run after the anything buffer was updated according the new input pattern.
857 This hook is run at the beginning of buffer.
858 The first candidate is selected after running this hook.
859 See also `anything-after-update-hook'.")
861 (defvar anything-after-update-hook nil
862 "Run after the anything buffer was updated according the new input pattern.
863 This is very similar to `anything-update-hook' but selection is not moved.
864 It is useful to select a particular object instead of the first one.")
866 (defvar anything-cleanup-hook nil
867 "Run after anything minibuffer is closed.
868 IOW this hook is executed BEFORE performing action.")
870 (defvar anything-select-action-hook nil
871 "Run when opening the action buffer.")
873 (defvar anything-before-action-hook nil
874 "Run before executing action.
875 Contrarily to `anything-cleanup-hook',
876 this hook run before anything minibuffer is closed
877 and before performing action.")
879 (defvar anything-after-action-hook nil
880 "Run after executing action.")
882 (defvar anything-after-persistent-action-hook nil
883 "Run after executing persistent action.")
885 (defvar anything-move-selection-before-hook nil
886 "Run before moving selection in `anything-buffer'.")
888 (defvar anything-move-selection-after-hook nil
889 "Run after moving selection in `anything-buffer'.")
891 (defvar anything-restored-variables
892 '(anything-candidate-number-limit
893 anything-source-filter
894 anything-source-in-each-line-flag
895 anything-map
896 anything-sources)
897 "Variables which are restored after `anything' invocation.")
899 (defvar anything-saved-selection nil
900 "Value of the currently selected object when the action list is shown.")
902 (defvar anything-current-prefix-arg nil
903 "Record `current-prefix-arg' when exiting minibuffer.")
905 (defvar anything-candidate-separator
906 "--------------------"
907 "Candidates separator of `multiline' source.")
909 (defvar anything-current-buffer nil
910 "Current buffer when `anything' is invoked.")
912 (defvar anything-buffer-file-name nil
913 "Variable `buffer-file-name' when `anything' is invoked.")
915 (defvar anything-saved-action nil
916 "Saved value of the currently selected action by key.")
918 (defvar anything-last-sources nil
919 "OBSOLETE!! Sources of previously invoked `anything'.")
921 (defvar anything-saved-current-source nil
922 "Value of the current source when the action list is shown.")
924 (defvar anything-compiled-sources nil
925 "Compiled version of `anything-sources'.")
927 (defvar anything-in-persistent-action nil
928 "Flag whether in persistent-action or not.")
930 (defvar anything-quick-update nil
931 "If non-nil, suppress displaying sources which are out of screen at first.
932 They are treated as delayed sources at this input.
933 This flag makes `anything' a bit faster with many sources.")
935 (defvar anything-last-sources-local nil
936 "Buffer local value of `anything-sources'.")
938 (defvar anything-last-buffer nil
939 "`anything-buffer' of previously `anything' session.")
941 (defvar anything-save-configuration-functions
942 '(set-window-configuration . current-window-configuration)
943 "The functions used to restore/save window or frame configurations.
944 It is a pair where the car is the function to restore window or frame config,
945 and the cdr is the function to save the window or frame config.
947 If you want to save and restore frame configuration, set this variable to
948 '\(set-frame-configuration . current-frame-configuration\)
950 Older version saves/restores frame configuration, but the default is changed now
951 because flickering can occur in some environment. ")
953 (defvar anything-persistent-action-use-special-display nil
954 "If non-nil, use `special-display-function' in persistent action.")
956 (defvar anything-execute-action-at-once-if-one nil
957 "Execute default action and exit when only one candidate is remaining.
958 It is useful for `anything' applications.")
960 (defvar anything-quit-if-no-candidate nil
961 "Quit when there is no candidates when non--nil.
962 This variable accepts a function, which is executed if no candidate.
964 It is useful for `anything' applications.")
966 (defvar anything-scroll-amount nil
967 "Scroll amount when scrolling other window in an anything session.
968 It is used by `anything-scroll-other-window'
969 and `anything-scroll-other-window-down'.
971 If you prefer scrolling line by line, set this value to 1.")
973 (defvar anything-display-function 'anything-default-display-buffer
974 "Function to display *anything* buffer.
975 It is `anything-default-display-buffer' by default,
976 which affects `anything-samewindow'.")
978 (defvar anything-delayed-init-executed nil)
980 (defvar anything-mode-line-string nil
981 "Help string displayed in mode-line in `anything'.
982 It can be a string or a list of two args, in this case,
983 first arg is a string that will be used as name for candidates number,
984 second arg any string to display in mode line.
985 If nil, use default `mode-line-format'.")
987 (defvar anything-help-message
988 "\\<anything-map>The keys that are defined for `anything' are:
989 \\{anything-map}"
990 "Detailed help message string for `anything'.
991 It also accepts function or variable symbol.")
993 (defvar anything-source-in-each-line-flag nil
994 "Non-nil means add anything-source text-property in each candidate.
995 experimental feature.")
997 (defvaralias 'anything-debug-variables 'anything-debug-forms)
999 (defvar anything-debug-forms nil
1000 "Forms to show in `anything-debug-output'.
1001 Otherwise all variables started with `anything-' are shown.
1002 It is useful for debug.")
1004 (defvar anything-debug nil
1005 "If non-nil, write log message into *Anything Log* buffer.
1006 If `debug-on-error' is non-nil, write log message regardless of this variable.
1007 It is disabled by default because *Anything Log* grows quickly.")
1009 (defcustom anything-local-map-override-anything-map t
1010 "Override `anything-map' keys with the corresponding ones in source local map.
1011 When non--nil keys in source local map will override same keys in `anything-map'
1012 otherwise same keys in `anything-map' will take precedence."
1013 :group 'anything
1014 :type 'boolean)
1017 ;; (@* "Internal Variables")
1018 (defvar anything-test-candidate-list nil)
1019 (defvar anything-test-mode nil)
1020 (defvar anything-source-name nil)
1021 (defvar anything-candidate-buffer-alist nil)
1022 (defvar anything-check-minibuffer-input-timer nil)
1023 (defvar anything-match-hash (make-hash-table :test 'equal))
1024 (defvar anything-cib-hash (make-hash-table :test 'equal))
1025 (defvar anything-tick-hash (make-hash-table :test 'equal))
1026 (defvar anything-issued-errors nil)
1027 (defvar anything-shortcut-keys nil)
1028 (defvar anything-once-called-functions nil)
1029 (defvar anything-follow-mode nil)
1030 (defvar anything-let-variables nil)
1031 (defvar anything-split-window-state nil)
1032 (defvar anything-selection-point nil)
1033 (defvar anything-alive-p nil)
1036 ;; (@* "Utility: logging")
1037 (defun anything-log (format-string &rest args)
1038 "Log message if `debug-on-error' or `anything-debug' is non-nil.
1039 Messages are written to the *Anything Log* buffer.
1041 Argument FORMAT-STRING is a string to use with `format'.
1042 Use optional arguments ARGS like in `format'."
1043 (when (or debug-on-error anything-debug)
1044 (with-current-buffer (get-buffer-create "*Anything Log*")
1045 (buffer-disable-undo)
1046 (set (make-local-variable 'inhibit-read-only) t)
1047 (goto-char (point-max))
1048 (insert (let ((tm (current-time)))
1049 (format "%s.%06d (%s) %s\n"
1050 (format-time-string "%H:%M:%S" tm)
1051 (nth 2 tm)
1052 (anything-log-get-current-function)
1053 (apply #'format (cons format-string args))))))))
1055 (defmacro anything-log-eval (&rest exprs)
1056 "Write each EXPRS evaluation result to the *Anything Log* buffer."
1057 `(anything-log-eval-internal ',exprs))
1059 (defun anything-log-run-hook (hook)
1060 "Run HOOK like `run-hooks' but write these actions to anything log buffer."
1061 (anything-log "executing %s" hook)
1062 (when (boundp hook)
1063 (anything-log-eval (symbol-value hook))
1064 (anything-log-eval (default-value hook)))
1065 (run-hooks hook)
1066 (anything-log "executed %s" hook))
1068 (defun anything-log-eval-internal (exprs)
1069 "Eval EXPRS and write results to anything log buffer."
1070 (dolist (expr exprs)
1071 (condition-case err
1072 (anything-log "%S = %S" expr (eval expr))
1073 (error (anything-log "%S = ERROR!" expr)))))
1075 (defun anything-log-get-current-function ()
1076 "Get function name calling `anything-log'.
1077 The original idea is from `tramp-debug-message'."
1078 (loop with exclude-func-re = "^anything-\\(?:interpret\\|log\\|.*funcall\\)"
1079 for btn from 1 to 40 ;avoid inf-loop
1080 for btf = (second (backtrace-frame btn))
1081 for fn = (if (symbolp btf) (symbol-name btf) "")
1082 if (and (string-match "^anything" fn)
1083 (not (string-match exclude-func-re fn)))
1084 return fn))
1086 (defun anything-log-error (&rest args)
1087 "Accumulate error messages into `anything-issued-errors'.
1088 ARGS are args given to `format'."
1089 (apply 'anything-log (concat "ERROR: " (car args)) (cdr args))
1090 (let ((msg (apply 'format args)))
1091 (unless (member msg anything-issued-errors)
1092 (add-to-list 'anything-issued-errors msg))))
1094 (defvar anything-last-log-file nil)
1095 (defun anything-log-save-maybe ()
1096 "May be save log buffer to `anything-last-log-file'."
1097 (when (stringp anything-debug)
1098 (let ((logdir (expand-file-name (format-time-string "%Y%m%d")
1099 anything-debug)))
1100 (make-directory logdir t)
1101 (with-current-buffer (get-buffer-create "*Anything Log*")
1102 (write-region (point-min) (point-max)
1103 (setq anything-last-log-file
1104 (expand-file-name (format-time-string "%Y%m%d-%H%M%S")
1105 logdir))
1106 nil 'silent)
1107 (erase-buffer)))))
1109 (defun anything-open-last-log ()
1110 "Open anything log file of last anything session."
1111 (interactive)
1112 (if anything-last-log-file
1113 (view-file anything-last-log-file)
1114 (switch-to-buffer "*Anything Log*")))
1116 (defun anything-print-error-messages ()
1117 "Print error messages in `anything-issued-errors'."
1118 (message "%s" (mapconcat 'identity (reverse anything-issued-errors) "\n")))
1120 ;; (anything-log "test")
1121 ;; (switch-to-buffer-other-window "*Anything Log*")
1124 ;; (@* "Programming Tools")
1125 (defmacro anything-aif (test-form then-form &rest else-forms)
1126 "Like `if' but set the result of TEST-FORM in a temprary variable called `it'.
1127 THEN-FORM and ELSE-FORMS are then excuted just like in `if'."
1128 (declare (indent 2) (debug t))
1129 `(let ((it ,test-form))
1130 (if it ,then-form ,@else-forms)))
1132 (defun anything-mklist (obj)
1133 "If OBJ is a list \(but not lambda\), return itself.
1134 Otherwise make a list with one element."
1135 (if (and (listp obj) (not (functionp obj)))
1137 (list obj)))
1140 ;; (@* "Anything API")
1142 (defun anything-buffer-get ()
1143 "Return `anything-action-buffer' if shown otherwise `anything-buffer'."
1144 (if (anything-action-window)
1145 anything-action-buffer
1146 anything-buffer))
1148 (defun anything-window ()
1149 "Window of `anything-buffer'."
1150 (get-buffer-window (anything-buffer-get) 'visible))
1152 (defun anything-action-window ()
1153 "Window of `anything-action-buffer'."
1154 (get-buffer-window anything-action-buffer 'visible))
1156 (defmacro with-anything-window (&rest body)
1157 "Be sure BODY is excuted in the anything window."
1158 (declare (indent 0) (debug t))
1159 `(if anything-test-mode
1160 (with-current-buffer (anything-buffer-get)
1161 ,@body)
1162 (with-selected-window (anything-window)
1163 ,@body)))
1165 (defmacro with-anything-current-buffer (&rest body)
1166 "Eval BODY inside `anything-current-buffer'."
1167 (declare (indent 0) (debug t))
1168 `(with-current-buffer anything-current-buffer
1169 ,@body))
1171 (defmacro with-anything-restore-variables(&rest body)
1172 "Restore `anything-restored-variables' after executing BODY.
1173 `post-command-hook' is handled specially."
1174 (declare (indent 0) (debug t))
1175 `(let ((--orig-vars (mapcar (lambda (v)
1176 (cons v (symbol-value v)))
1177 anything-restored-variables))
1178 (--post-command-hook-pair (cons post-command-hook
1179 (default-value 'post-command-hook))))
1180 (setq post-command-hook '(t))
1181 (setq-default post-command-hook nil)
1182 (unwind-protect (progn ,@body)
1183 (loop for (var . value) in --orig-vars
1184 do (set var value))
1185 (setq post-command-hook (car --post-command-hook-pair))
1186 (setq-default post-command-hook (cdr --post-command-hook-pair))
1187 (anything-log "restore variables"))))
1189 (defun* anything-attr (attribute-name &optional
1190 (src (anything-get-current-source)))
1191 "Get the value of ATTRIBUTE-NAME of SRC.
1192 if SRC is omitted, use current source.
1193 It is useful to write your sources."
1194 (anything-aif (assq attribute-name src)
1195 (cdr it)))
1197 (defun* anything-attr* (attribute-name
1198 &optional (src (anything-get-current-source)))
1199 "Pass the value of ATTRIBUTE-NAME of SRC to `anything-interpret-value'.
1200 if SRC is omitted, use current source.
1201 It is useful to write your sources."
1202 (anything-interpret-value (anything-attr attribute-name src)))
1204 (defun* anything-attr-defined (attribute-name
1205 &optional (src (anything-get-current-source)))
1206 "Return non-nil if ATTRIBUTE-NAME of SRC is defined.
1207 if SRC is omitted, use current source.
1208 It is useful to write your sources."
1209 (and (assq attribute-name src) t))
1211 (defun* anything-attrset (attribute-name value
1212 &optional
1213 (src (anything-get-current-source)))
1214 "Set the value of ATTRIBUTE-NAME of SRC to VALUE.
1215 if SRC is omitted, use current source.
1216 It is useful to write your sources."
1217 (anything-aif (assq attribute-name src)
1218 (setcdr it value)
1219 (setcdr src (cons (cons attribute-name value) (cdr src))))
1220 value)
1222 (defun anything-set-source-filter (sources)
1223 "Set the value of `anything-source-filter' to SOURCES and update.
1225 This function sets a filter for anything sources and it may be
1226 called while anything is running. It can be used to toggle
1227 displaying of sources dinamically. For example, additional keys
1228 can be bound into `anything-map' to display only the file-related
1229 results if there are too many matches from other sources and
1230 you're after files only:
1232 Shift+F shows only file results from some sources:
1234 \(define-key anything-map \"F\" 'anything-my-show-files-only)
1236 \(defun anything-my-show-files-only ()
1237 (interactive)
1238 (anything-set-source-filter '(\"File Name History\"
1239 \"Files from Current Directory\")))
1241 Shift+A shows all results:
1243 \(define-key anything-map \"A\" 'anything-my-show-all)
1245 \(defun anything-my-show-all ()
1246 (interactive)
1247 (anything-set-source-filter nil))
1249 Note that you have to prefix the functions with anything- prefix,
1250 otherwise they won't be bound when Anything is used under
1251 Iswitchb. The -my- part is added to avoid collisions with
1252 existing Anything function names."
1253 (unless (and (listp sources)
1254 (loop for name in sources always (stringp name)))
1255 (error "Invalid data in `anything-set-source-filter': %S" sources))
1256 (setq anything-source-filter sources)
1257 (anything-log-eval anything-source-filter)
1258 (anything-update))
1260 (defun anything-set-sources (sources &optional no-init no-update)
1261 "Set SOURCES during `anything' invocation.
1262 If NO-INIT is non-nil, skip executing init functions of SOURCES.
1263 If NO-UPDATE is non-nil, skip executing `anything-update'."
1264 (with-current-buffer anything-buffer
1265 (setq anything-compiled-sources nil
1266 anything-sources sources
1267 anything-last-sources-local sources)
1268 (anything-log-eval anything-compiled-sources anything-sources))
1269 (unless no-init (anything-funcall-foreach 'init))
1270 (unless no-update (anything-update)))
1272 (defvar anything-compile-source-functions
1273 '(anything-compile-source--type
1274 anything-compile-source--dummy
1275 anything-compile-source--disable-shortcuts
1276 anything-compile-source--candidates-in-buffer)
1277 "Functions to compile elements of `anything-sources' (plug-in).")
1279 (defun anything-get-sources ()
1280 "Return compiled `anything-sources', which is memoized.
1282 Attributes:
1284 - type
1285 `anything-type-attributes' are merged in.
1286 - candidates-buffer
1287 candidates, volatile and match attribute are created."
1288 (cond
1289 ;; action
1290 ((anything-action-window)
1291 anything-sources)
1292 ;; memoized
1293 (anything-compiled-sources)
1294 ;; first time
1296 (prog1
1297 (setq anything-compiled-sources
1298 (anything-compile-sources
1299 anything-sources anything-compile-source-functions))
1300 (anything-log-eval anything-compiled-sources)))))
1302 (defun* anything-get-selection (&optional (buffer nil buffer-s)
1303 force-display-part)
1304 "Return the currently selected item or nil.
1305 if BUFFER is nil or unspecified, use anything-buffer as default value.
1306 If FORCE-DISPLAY-PART is non-nil, return the display string.
1307 If FORCE-DISPLAY-PART value is 'withprop the display string is returned
1308 with its properties."
1309 (setq buffer (if (and buffer buffer-s) buffer anything-buffer))
1310 (unless (anything-empty-buffer-p buffer)
1311 (with-current-buffer buffer
1312 (let* ((disp-fn (if (eq force-display-part 'withprop)
1313 'buffer-substring
1314 'buffer-substring-no-properties))
1315 (selection
1316 (or (and (not force-display-part)
1317 (get-text-property (overlay-start
1318 anything-selection-overlay)
1319 'anything-realvalue))
1320 ;; It is needed to return properties of DISP in some case,
1321 ;; e.g for `anything-confirm-and-exit-minibuffer',
1322 ;; so use `buffer-substring' here when 'withprop is specified.
1323 (let ((disp (funcall disp-fn
1324 (overlay-start anything-selection-overlay)
1325 (1- (overlay-end anything-selection-overlay))))
1326 (source (anything-get-current-source)))
1327 (anything-aif (and (not force-display-part)
1328 (assoc-default 'display-to-real source))
1329 (anything-funcall-with-source source it disp)
1330 disp)))))
1331 (unless (equal selection "")
1332 (anything-log-eval selection)
1333 selection)))))
1335 (defun anything-get-action ()
1336 "Return the associated action for the selected candidate.
1337 It is a function symbol \(sole action\) or list
1338 of \(action-display . function\)."
1339 (unless (anything-empty-buffer-p (anything-buffer-get))
1340 (anything-aif (anything-attr 'action-transformer)
1341 (anything-composed-funcall-with-source
1342 (anything-get-current-source) it
1343 (anything-attr 'action) (anything-get-selection))
1344 (anything-attr 'action))))
1346 (defun anything-get-current-source ()
1347 "Return the source for the current selection.
1348 Use it in init, candidates, action, candidate-transformer,
1349 filtered-candidate-transformer functions."
1350 (declare (special source))
1351 ;; The name `anything-get-current-source' should be used in init function etc.
1352 (if (and (boundp 'anything-source-name) (stringp anything-source-name))
1353 source
1354 (with-current-buffer (anything-buffer-get)
1356 ;; This happen only when `anything-source-in-each-line-flag'
1357 ;; is non--nil and there is candidates in buffer.
1358 (get-text-property (point) 'anything-source)
1359 ;; Return nil when no--candidates.
1360 (block exit
1361 ;; This goto-char shouldn't be necessary, but point is moved to
1362 ;; point-min somewhere else which shouldn't happen.
1363 (goto-char (overlay-start anything-selection-overlay))
1364 (let* ((header-pos (or (anything-get-previous-header-pos)
1365 (anything-get-next-header-pos)))
1366 (source-name
1367 (save-excursion
1368 (unless header-pos
1369 (return-from exit nil))
1370 (goto-char header-pos)
1371 (anything-current-line-contents))))
1372 (loop for source in (anything-get-sources) thereis
1373 (and (equal (assoc-default 'name source) source-name)
1374 source))))))))
1376 (defun anything-buffer-is-modified (buffer)
1377 "Return non-nil when BUFFER is modified since `anything' was invoked."
1378 (let* ((b (get-buffer buffer))
1379 (key (concat (buffer-name b) "/" (anything-attr 'name)))
1380 (source-tick (or (gethash key anything-tick-hash) 0))
1381 (buffer-tick (buffer-chars-modified-tick b))
1382 (modifiedp (/= source-tick buffer-tick)))
1383 (puthash key buffer-tick anything-tick-hash)
1384 (anything-log-eval buffer modifiedp)
1385 modifiedp))
1387 (defun anything-current-buffer-is-modified ()
1388 "Check if `anything-current-buffer' is modified since `anything' was invoked."
1389 (anything-buffer-is-modified anything-current-buffer))
1391 (defvar anything-quit nil)
1392 (defun anything-run-after-quit (function &rest args)
1393 "Perform an action after quitting `anything'.
1394 The action is to call FUNCTION with arguments ARGS."
1395 (setq anything-quit t)
1396 (anything-kill-async-processes)
1397 (anything-log-eval function args)
1398 (apply 'run-with-idle-timer 0 nil function args)
1399 (anything-exit-minibuffer))
1402 (defun define-anything-type-attribute (type definition &optional doc)
1403 "Register type attribute of TYPE as DEFINITION with DOC.
1404 DOC is displayed in `anything-type-attributes' docstring.
1406 Use this function is better than setting `anything-type-attributes' directly."
1407 (loop for i in definition do
1408 ;; without `ignore-errors', error at emacs22
1409 (ignore-errors (setf i (delete nil i))))
1410 (anything-add-type-attribute type definition)
1411 (and doc (anything-document-type-attribute type doc))
1412 nil)
1414 (defvaralias 'anything-attributes 'anything-additional-attributes)
1415 (defvar anything-additional-attributes nil
1416 "List of all `anything' attributes.")
1418 (defun anything-document-attribute (attribute short-doc &optional long-doc)
1419 "Register ATTRIBUTE documentation introduced by plug-in.
1420 SHORT-DOC is displayed beside attribute name.
1421 LONG-DOC is displayed below attribute name and short documentation."
1422 (if long-doc
1423 (setq short-doc (concat "(" short-doc ")"))
1424 (setq long-doc short-doc
1425 short-doc ""))
1426 (add-to-list 'anything-additional-attributes attribute t)
1427 (put attribute 'anything-attrdoc
1428 (concat "- " (symbol-name attribute)
1429 " " short-doc "\n\n" long-doc "\n")))
1431 (put 'anything-document-attribute 'lisp-indent-function 2)
1433 (defun anything-interpret-value (value &optional source)
1434 "Interpret VALUE as variable, function or literal.
1435 If VALUE is a function, call it with no arguments and return the value.
1436 If SOURCE is `anything' source, `anything-source-name' is source name.
1438 If VALUE is a variable, return the value.
1440 If VALUE is a symbol, but it is not a function or a variable, cause an error.
1442 Otherwise, return VALUE itself."
1443 (cond ((and source (functionp value))
1444 (anything-funcall-with-source source value))
1445 ((functionp value)
1446 (funcall value))
1447 ((and (symbolp value) (boundp value))
1448 (symbol-value value))
1449 ((symbolp value)
1450 (error "anything-interpret-value: Symbol must be a function or a variable"))
1452 value)))
1454 (defun anything-once (function &rest args)
1455 "Ensure FUNCTION with ARGS to be called once in `anything' session."
1456 (let ((spec (cons function args)))
1457 (unless (member spec anything-once-called-functions)
1458 (apply function args)
1459 (push spec anything-once-called-functions))))
1462 ;; (@* "Core: API helper")
1463 (defun* anything-empty-buffer-p (&optional (buffer anything-buffer))
1464 "Check if BUFFER have candidates.
1465 Default value for BUFFER is `anything-buffer'."
1466 (zerop (buffer-size (and buffer (get-buffer buffer)))))
1468 (defun anything-let-eval-varlist (varlist)
1469 "Return the list of pairs VARLIST with each cdr of pair evaluated.
1470 If VARLIST contain single elements, those are returned
1471 as a list of one element."
1472 (mapcar (lambda (pair)
1473 (if (listp pair)
1474 (cons (car pair) (eval (cadr pair)))
1475 (cons pair nil)))
1476 varlist))
1478 ;; [NOT USED]
1479 ;; (defun anything-let*-eval-varlist (varlist)
1480 ;; (let ((vars (mapcar (lambda (pair)
1481 ;; (or (car-safe pair) pair))
1482 ;; varlist)))
1483 ;; (eval `(let ,vars
1484 ;; ,@(mapcar (lambda (pair)
1485 ;; (if (listp pair)
1486 ;; `(setq ,(car pair) ,(cadr pair))
1487 ;; `(setq ,pair nil)))
1488 ;; varlist)
1489 ;; (mapcar (lambda (v)
1490 ;; (cons v (symbol-value v)))
1491 ;; ',vars)))))
1493 (defun anything-let-internal (binding bodyfunc)
1494 "Set BINDING to anything buffer-local variables and Evaluate BODYFUNC.
1495 BINDING is a list of \(VARNAME . VALUE\) pair."
1496 (setq anything-let-variables binding)
1497 (unwind-protect
1498 (funcall bodyfunc)
1499 (setq anything-let-variables nil)))
1502 ;; (@* "Core: tools")
1503 (defun anything-current-line-contents ()
1504 "Current line string without properties."
1505 (buffer-substring-no-properties (point-at-bol) (point-at-eol)))
1507 (defun anything-funcall-with-source (source func &rest args)
1508 "Call from SOURCE FUNC list or single function FUNC with ARGS.
1509 FUNC can be a symbol or a list of functions.
1510 Return the result of last function call."
1511 (let ((anything-source-name (assoc-default 'name source))
1512 result)
1513 (anything-log-eval anything-source-name func args)
1514 (dolist (func (if (functionp func) (list func) func) result)
1515 (setq result (apply func args)))))
1517 (defun anything-funcall-foreach (sym)
1518 "Call the function SYM for each source if any."
1519 (dolist (source (anything-get-sources))
1520 (anything-aif (assoc-default sym source)
1521 (anything-funcall-with-source source it))))
1523 (defun anything-normalize-sources (sources)
1524 "If SOURCES is only one source, make a list of one element."
1525 (cond ((or (and sources
1526 (symbolp sources))
1527 (and (listp sources) (assq 'name sources)))
1528 (list sources))
1529 (sources)
1530 (t anything-sources)))
1532 (defun anything-approximate-candidate-number (&optional in-current-source)
1533 "Return approximate number of candidates in `anything-buffer'.
1534 If IN-CURRENT-SOURCE is provided return number of candidates
1535 in the source where point is.
1536 It is used to check if candidate number is 0, 1, or 2+."
1537 (with-current-buffer anything-buffer
1538 (save-excursion
1539 (if in-current-source
1540 (goto-char (anything-get-previous-header-pos))
1541 (goto-char (point-min)))
1542 (forward-line 1)
1543 (let ((count-multi 1))
1544 (if (anything-pos-multiline-p)
1545 (save-excursion
1546 (loop while (and (not (if in-current-source
1547 (save-excursion
1548 (forward-line 2)
1549 (or (anything-pos-header-line-p) (eobp)))
1550 (eobp)))
1551 (search-forward anything-candidate-separator nil t))
1552 do (incf count-multi)
1553 finally return count-multi))
1554 (save-excursion
1555 (loop with ln = 0
1556 while (not (if in-current-source
1557 (or (anything-pos-header-line-p) (eobp))
1558 (eobp)))
1559 unless (anything-pos-header-line-p)
1560 do (incf ln)
1561 do (forward-line 1) finally return ln)))))))
1563 (defmacro with-anything-quittable (&rest body)
1564 "If an error occur in execution of BODY, quit anything safely."
1565 (declare (indent 0) (debug t))
1566 `(let (inhibit-quit)
1567 (condition-case v
1568 (progn ,@body)
1569 (quit (setq anything-quit t)
1570 (exit-minibuffer)
1571 (keyboard-quit)))))
1573 (defun anything-compose (arg-lst func-lst)
1574 "Apply arguments specified in ARG-LST with each function of FUNC-LST.
1575 The result of each function will be the new `car' of ARG-LST.
1577 This function allows easy sequencing of transformer functions."
1578 (dolist (func func-lst)
1579 (setcar arg-lst (apply func arg-lst)))
1580 (car arg-lst))
1582 (defun anything-composed-funcall-with-source (source funcs &rest args)
1583 "With SOURCE apply `anything-funcall-with-source' with each FUNCS and ARGS.
1584 This is used in transformers to modify candidates list."
1585 (if (functionp funcs)
1586 (apply 'anything-funcall-with-source source funcs args)
1587 (apply 'anything-funcall-with-source source
1588 (lambda (&rest args)
1589 (anything-compose args funcs))
1590 args)))
1592 (defun anything-new-timer (variable timer)
1593 "Give VARIABLE value to TIMER and cancel old timer."
1594 (anything-aif (symbol-value variable)
1595 (cancel-timer it))
1596 (set variable timer))
1599 ;; (@* "Core: entry point")
1600 (defconst anything-argument-keys
1601 '(:sources :input :prompt :resume :preselect :buffer :keymap :default :history))
1603 ;;;###autoload
1604 (defun anything (&rest plist)
1605 "Main function to execute anything sources.
1607 Keywords supported:
1608 :sources :input :prompt :resume :preselect :buffer :keymap :default :history
1609 Extra keywords are supported and can be added, see below.
1611 When call interactively with no arguments deprecated `anything-sources'
1612 will be used if non--nil.
1614 PLIST is a list like \(:key1 val1 :key2 val2 ...\) or
1615 \(&optional sources input prompt resume preselect buffer keymap default history\).
1617 Basic keywords are the following:
1619 \:sources
1621 Temporary value of `anything-sources'. It also accepts a
1622 symbol, interpreted as a variable of an anything source. It
1623 also accepts an alist representing an anything source, which is
1624 detected by \(assq 'name ANY-SOURCES\)
1626 \:input
1628 Temporary value of `anything-pattern', ie. initial input of minibuffer.
1630 \:prompt
1632 Prompt other than \"pattern: \".
1634 \:resume
1636 If t, Resurrect previously instance of `anything'. Skip the initialization.
1637 If 'noresume, this instance of `anything' cannot be resumed.
1639 \:preselect
1641 Initially selected candidate. Specified by exact candidate or a regexp.
1643 \:buffer
1645 `anything-buffer' instead of *anything*.
1647 \:keymap
1649 `anything-map' for current `anything' session.
1651 \:default
1653 A default argument that will be inserted in minibuffer \
1654 with \\<minibuffer-local-map>\\[next-history-element].
1655 When nil of not present `thing-at-point' will be used instead.
1657 \:history
1659 By default all minibuffer input is pushed to `minibuffer-history',
1660 if an argument HISTORY is provided, input will be pushed to HISTORY.
1661 History element should be a symbol.
1663 Of course, conventional arguments are supported, the two are same.
1665 \(anything :sources sources :input input :prompt prompt :resume resume
1666 :preselect preselect :buffer buffer :keymap keymap :default default
1667 :history history\)
1668 \(anything sources input prompt resume preselect buffer keymap default history\)
1670 Other keywords are interpreted as local variables of this anything session.
1671 The `anything-' prefix can be omitted. For example,
1673 \(anything :sources 'anything-c-source-buffers
1674 :buffer \"*buffers*\" :candidate-number-limit 10\)
1676 means starting anything session with `anything-c-source-buffers'
1677 source in *buffers* buffer and set variable `anything-candidate-number-limit'
1678 to 10 as session local variable."
1679 (interactive)
1680 (if (keywordp (car plist))
1681 (anything-let-internal
1682 (anything-parse-keys plist)
1683 (lambda ()
1684 (apply 'anything
1685 (mapcar (lambda (key) (plist-get plist key))
1686 anything-argument-keys))))
1687 (apply 'anything-internal plist)))
1689 (defun anything-parse-keys (keys)
1690 "Parse the KEYS arguments of `anything'.
1691 Return only the keys that are not in `anything-argument-keys'.
1692 It is used to set local variables via `anything-let-internal'.
1693 This allow to add arguments that are not part of `anything-argument-keys',
1694 but are valid anything attributes.
1695 i.e :candidate-number-limit will be bound to `anything-candidate-number-limit'
1696 in source."
1697 ;; (anything-parse-keys '(:sources ((name . "test")
1698 ;; (candidates . (a b c)))
1699 ;; :buffer "toto"
1700 ;; :candidate-number-limit 4))
1701 ;; ==> ((anything-candidate-number-limit . 4))
1702 (loop for (key value) on keys by #'cddr
1703 for symname = (substring (symbol-name key) 1)
1704 for sym = (intern (if (string-match "^anything-" symname)
1705 symname
1706 (concat "anything-" symname)))
1707 unless (memq key anything-argument-keys)
1708 collect (cons sym value)))
1710 ;;; (@* "Core: entry point helper")
1711 (defun anything-internal (&optional
1712 any-sources any-input
1713 any-prompt any-resume
1714 any-preselect any-buffer
1715 any-keymap any-default any-history)
1716 "The internal anything function called by `anything'.
1717 For ANY-SOURCES ANY-INPUT ANY-PROMPT ANY-RESUME ANY-PRESELECT ANY-BUFFER and
1718 ANY-KEYMAP ANY-DEFAULT ANY-HISTORY See `anything'."
1719 (anything-log (concat "[Start session] " (make-string 41 ?+)))
1720 (anything-log-eval any-prompt any-preselect
1721 any-buffer any-keymap any-default)
1722 (let ((old-overridding-local-map overriding-local-map))
1723 (unwind-protect
1724 (condition-case v
1725 (let ( ;; It is needed because `anything-source-name' is non-nil
1726 ;; when `anything' is invoked by action. Awful global scope.
1727 anything-source-name
1728 anything-in-persistent-action
1729 anything-quit
1730 ;; [2012-10-16] move to `anything-update' to show right value of `case-fold-search'
1731 ;; (case-fold-search t)
1732 (anything-buffer (or any-buffer anything-buffer))
1733 ;; cua-mode ; avoid error when region is selected
1735 (with-anything-restore-variables
1736 (anything-initialize any-resume any-input any-sources)
1737 (anything-display-buffer anything-buffer)
1738 (anything-log "show prompt")
1739 (unwind-protect
1740 (anything-read-pattern-maybe
1741 any-prompt any-input any-preselect
1742 any-resume any-keymap any-default
1743 (when (and any-history (symbolp any-history)) any-history))
1744 (anything-cleanup)))
1745 (prog1 (unless anything-quit
1746 (anything-execute-selection-action-1))
1747 (anything-log (concat "[End session] " (make-string 41 ?-)))))
1748 (quit
1749 (anything-restore-position-on-quit)
1750 (anything-log (concat "[End session (quit)] " (make-string 34 ?-)))
1751 nil))
1752 (setq overriding-local-map old-overridding-local-map)
1753 (anything-log-save-maybe))))
1756 ;;; Anything resume
1759 (defun* anything-resume (&optional
1760 (any-buffer anything-last-buffer)
1761 buffer-pattern (any-resume t))
1762 "Resurrect previously invoked `anything'.
1763 Called with a prefix arg, allow choosing among all existing
1764 anything buffers. i.e choose among various anything sessions."
1765 (interactive)
1766 (when (or current-prefix-arg buffer-pattern)
1767 (setq any-buffer (anything-resume-select-buffer buffer-pattern)))
1768 (setq anything-compiled-sources nil)
1769 (anything
1770 :sources (or (buffer-local-value 'anything-last-sources-local (get-buffer any-buffer))
1771 anything-last-sources anything-sources)
1772 :input (buffer-local-value 'anything-input-local (get-buffer any-buffer))
1773 :resume any-resume
1774 :buffer any-buffer))
1776 ;;; rubikitch: experimental
1777 ;;; I use this and check it whether I am convenient.
1778 ;;; I may introduce an option to control the behavior.
1779 (defun* anything-resume-window-only (&optional
1780 (any-buffer anything-last-buffer)
1781 buffer-pattern)
1782 (interactive)
1783 (anything-resume any-buffer buffer-pattern 'window-only))
1785 (defun anything-resume-p (any-resume)
1786 "Whether current anything session is resumed or not.
1787 Just check if ANY-RESUME value is t or window-only."
1788 (memq any-resume '(t window-only)))
1790 (defun anything-resume-select-buffer (input)
1791 "Resume precedent anything session with initial input INPUT."
1792 (or (anything :sources '(((name . "Resume anything buffer")
1793 (candidates . anything-buffers)
1794 (action . identity)))
1795 :input input
1796 :resume 'noresume
1797 :buffer "*anything resume*")
1798 (keyboard-quit)))
1801 ;;;###autoload
1802 (defun anything-at-point (&optional
1803 any-sources any-input
1804 any-prompt any-resume
1805 any-preselect any-buffer)
1806 "Call anything with symbol at point as initial input.
1807 ANY-SOURCES ANY-INPUT ANY-PROMPT ANY-RESUME ANY-PRESELECT and ANY-BUFFER
1808 are same args as in `anything'."
1809 (interactive)
1810 (anything :sources any-sources
1811 :input (if current-prefix-arg
1812 (concat "\\b" (thing-at-point 'symbol) "\\b"
1813 (if (featurep 'anything-match-plugin) " " ""))
1814 any-input)
1815 :prompt any-prompt
1816 :resume any-resume
1817 :preselect any-preselect
1818 :buffer any-buffer))
1820 ;;;###autoload
1821 (defun anything-other-buffer (any-sources any-buffer)
1822 "Simplified interface of `anything' with other `anything-buffer'.
1823 Call `anything' with only ANY-SOURCES and ANY-BUFFER as args."
1824 (anything :sources any-sources :buffer any-buffer))
1826 (defun anything-nest (&rest same-as-anything)
1827 "Allow calling `anything' whithin a running anything session."
1828 (with-anything-window
1829 (let (anything-current-position
1830 anything-current-buffer
1831 (orig-anything-current-buffer anything-current-buffer)
1832 (orig-anything-buffer anything-buffer)
1833 (orig-anything-last-frame-or-window-configuration
1834 anything-last-frame-or-window-configuration)
1835 anything-pattern
1836 (anything-buffer (or (getf same-as-anything :buffer)
1837 (nth 5 same-as-anything)
1838 "*Anything*"))
1839 anything-sources
1840 anything-compiled-sources
1841 (anything-samewindow t)
1842 (enable-recursive-minibuffers t))
1843 (unwind-protect
1844 (apply #'anything same-as-anything)
1845 (with-current-buffer orig-anything-buffer
1846 (anything-initialize-overlays orig-anything-buffer)
1847 (setq anything-buffer (current-buffer))
1848 (anything-mark-current-line)
1849 (setq anything-last-frame-or-window-configuration
1850 orig-anything-last-frame-or-window-configuration)
1851 (setq cursor-type t)
1852 (setq anything-current-buffer orig-anything-current-buffer))))))
1855 ;;; Initialize
1858 (defvar anything-buffers nil
1859 "All of `anything-buffer' in most recently used order.")
1860 (defun anything-initialize (any-resume any-input any-sources)
1861 "Start initialization of `anything' session.
1862 For ANY-RESUME ANY-INPUT and ANY-SOURCES See `anything'."
1863 (anything-log "start initialization: any-resume=%S any-input=%S" any-resume any-input)
1864 (anything-frame-or-window-configuration 'save)
1865 (setq anything-sources (anything-normalize-sources any-sources))
1866 (anything-log "sources = %S" anything-sources)
1867 (anything-hooks 'setup)
1868 (anything-current-position 'save)
1869 (if (anything-resume-p any-resume)
1870 (anything-initialize-overlays (anything-buffer-get))
1871 (anything-initial-setup))
1872 (unless (eq any-resume 'noresume)
1873 (anything-recent-push anything-buffer 'anything-buffers)
1874 (setq anything-last-buffer anything-buffer))
1875 (when any-input (setq anything-input any-input anything-pattern any-input))
1876 (and (anything-resume-p any-resume) (anything-funcall-foreach 'resume))
1877 (anything-log "end initialization"))
1879 (defun anything-execute-selection-action-1 ()
1880 "Execute current action."
1881 (anything-log-run-hook 'anything-before-action-hook)
1882 (unwind-protect
1883 (anything-execute-selection-action)
1884 (anything-aif (get-buffer anything-action-buffer)
1885 (kill-buffer it))
1886 (anything-log-run-hook 'anything-after-action-hook)))
1888 (defun anything-restore-position-on-quit ()
1889 "Restore position in `anything-current-buffer' when quitting."
1890 (anything-current-position 'restore))
1892 (defun anything-recent-push (elt list-var)
1893 "Add ELT to the value of LIST-VAR as most recently used value."
1894 (let ((m (member elt (symbol-value list-var))))
1895 (and m (set list-var (delq (car m) (symbol-value list-var))))
1896 (push elt (symbol-value list-var))))
1899 ;;; (@* "Core: Accessors")
1900 ;;; rubikitch: I love to create functions to control variables.
1901 (defvar anything-current-position nil
1902 "Cons of \(point . window-start\) when `anything' is invoked.
1903 It is needed to restore position in `anything-current-buffer'
1904 when `anything' is keyboard-quitted.")
1905 (defun anything-current-position (save-or-restore)
1906 "Restore or save current position in `anything-current-buffer'.
1907 Argument SAVE-OR-RESTORE is one of save or restore."
1908 (case save-or-restore
1909 (save
1910 (anything-log "Save position at %S" (cons (point) (window-start)))
1911 (setq anything-current-position (cons (point) (window-start))))
1912 (restore
1913 (anything-log "Restore position at %S in buffer %s"
1914 anything-current-position
1915 (buffer-name (current-buffer)))
1916 (goto-char (car anything-current-position))
1917 ;; Fix this position with the NOFORCE arg of `set-window-start'
1918 ;; otherwise, if there is some other buffer than `anything-current-buffer'
1919 ;; one, position will be lost.
1920 (set-window-start (selected-window) (cdr anything-current-position) t))))
1923 ;; Internal.
1924 (defvar anything-last-frame-or-window-configuration nil
1925 "Used to store window or frame configuration when anything start.")
1926 (defun anything-frame-or-window-configuration (save-or-restore)
1927 "Save or restore last frame or window configuration.
1928 Possible value of SAVE-OR-RESTORE are 'save and 'restore.
1929 window or frame configuration is saved/restored according to values of
1930 `anything-save-configuration-functions'."
1931 (anything-log-eval anything-save-configuration-functions)
1932 (case save-or-restore
1933 (save (setq anything-last-frame-or-window-configuration
1934 (funcall (cdr anything-save-configuration-functions))))
1935 (restore (funcall (car anything-save-configuration-functions)
1936 anything-last-frame-or-window-configuration)
1937 ;; Restore frame focus.
1938 (let ((frame (and (listp anything-last-frame-or-window-configuration)
1939 (caadr anything-last-frame-or-window-configuration))))
1940 ;; If `anything-save-configuration-functions' are window functions
1941 ;; frame should be nil, use current frame.
1942 (unless (framep frame)
1943 (setq frame (selected-frame)))
1944 (select-frame-set-input-focus frame)))))
1947 ;; (@* "Core: Display *anything* buffer")
1948 (defun anything-display-buffer (buf)
1949 "Display *anything* buffer BUF."
1950 (let (pop-up-frames)
1951 (funcall (with-current-buffer buf anything-display-function) buf)))
1953 (defun anything-default-display-buffer (buf)
1954 "Default function to display BUF.
1955 Where BUF is generally `anything-buffer'.
1956 It use `switch-to-buffer' or `pop-to-buffer' depending of value of
1957 `anything-samewindow'."
1958 (funcall (if anything-samewindow 'switch-to-buffer 'pop-to-buffer) buf))
1961 ;; (@* "Core: initialize")
1962 (defun anything-initial-setup ()
1963 "Initialize anything settings and set up the anything buffer."
1964 (anything-log-run-hook 'anything-before-initialize-hook)
1965 (setq anything-current-prefix-arg nil)
1966 (setq anything-once-called-functions nil)
1967 (setq anything-delayed-init-executed nil)
1968 (setq anything-alive-p t)
1969 (setq anything-current-buffer
1970 (if (minibuffer-window-active-p (minibuffer-window))
1971 ;; If minibuffer is active be sure to use it's buffer
1972 ;; as `anything-current-buffer'.
1973 (window-buffer (active-minibuffer-window))
1974 (current-buffer)))
1975 (setq anything-buffer-file-name buffer-file-name)
1976 (setq anything-issued-errors nil)
1977 (setq anything-compiled-sources nil)
1978 (setq anything-saved-current-source nil)
1979 (if (or (not (boundp 'split-width-threshold))
1980 (not split-width-threshold)
1981 (and (integerp split-width-threshold)
1982 (>= split-width-threshold (+ (frame-width) 4))))
1983 (setq anything-split-window-state 'vertical)
1984 (setq anything-split-window-state 'horizontal))
1985 ;; Call the init function for sources where appropriate
1986 (anything-funcall-foreach 'init)
1987 (setq anything-pattern "")
1988 (setq anything-input "")
1989 (setq anything-candidate-cache nil)
1990 (setq anything-last-sources anything-sources)
1991 (anything-create-anything-buffer)
1992 (anything-log-run-hook 'anything-after-initialize-hook))
1994 (defvar anything-reading-pattern nil
1995 "Whether in `read-string' in anything or not.")
1997 (defun anything-read-pattern-maybe (any-prompt any-input
1998 any-preselect any-resume any-keymap
1999 any-default any-history)
2000 "Read pattern with prompt ANY-PROMPT and initial input ANY-INPUT.
2001 For ANY-PRESELECT ANY-RESUME ANY-KEYMAP, See `anything'."
2002 (if (anything-resume-p any-resume)
2003 (anything-mark-current-line t)
2004 (anything-update any-preselect))
2005 (with-current-buffer (anything-buffer-get)
2006 (let ((src-keymap (assoc-default 'keymap (anything-get-current-source))))
2007 ;; Startup with the first keymap found either in current source
2008 ;; or anything arg, otherwise use global value of `anything-map'.
2009 ;; This map will be used as a `minibuffer-local-map'.
2010 ;; Maybe it will be overriden when changing source
2011 ;; by `anything-maybe-update-keymap'.
2012 (unless anything-local-map-override-anything-map
2013 (anything-aif (or src-keymap any-keymap)
2014 (ignore-errors
2015 (set-keymap-parent it anything-map))))
2016 (set (make-local-variable 'anything-map)
2017 (or src-keymap any-keymap anything-map))
2018 (anything-log-eval (anything-approximate-candidate-number)
2019 anything-execute-action-at-once-if-one
2020 anything-quit-if-no-candidate)
2021 (cond ((and anything-execute-action-at-once-if-one
2022 (= (anything-approximate-candidate-number) 1))
2023 (ignore))
2024 ((and anything-quit-if-no-candidate
2025 (= (anything-approximate-candidate-number) 0))
2026 (setq anything-quit t)
2027 (and (functionp anything-quit-if-no-candidate)
2028 (funcall anything-quit-if-no-candidate)))
2030 (let ((anything-reading-pattern t)
2031 (tap (or any-default
2032 (with-anything-current-buffer
2033 (thing-at-point 'symbol)))))
2034 (read-from-minibuffer (or any-prompt "pattern: ")
2035 any-input anything-map
2036 nil any-history tap)))))))
2038 (defun anything-maybe-update-keymap ()
2039 "Handle differents keymaps in multiples sources.
2040 This function is meant to be run in `anything-move-selection-after-hook'.
2041 It will override `anything-map' with the keymap attribute of current source
2042 if some when multiples sources are present."
2043 (with-anything-window
2044 (let ((kmap (assoc-default 'keymap (anything-get-current-source))))
2045 (when kmap
2046 (and (not anything-local-map-override-anything-map)
2047 (ignore-errors (set-keymap-parent kmap (default-value 'anything-map))))
2048 (setq overriding-local-map kmap)))))
2049 (add-hook 'anything-move-selection-after-hook 'anything-maybe-update-keymap)
2051 (defun anything-create-anything-buffer (&optional test-mode)
2052 "Create newly created `anything-buffer'.
2053 If TEST-MODE is non-nil, clear `anything-candidate-cache'."
2054 (when test-mode
2055 (setq anything-candidate-cache nil))
2056 (with-current-buffer (get-buffer-create anything-buffer)
2057 (anything-log "kill local variables: %S" (buffer-local-variables))
2058 (kill-all-local-variables)
2059 (set (make-local-variable 'inhibit-read-only) t)
2060 (buffer-disable-undo)
2061 (erase-buffer)
2062 (set (make-local-variable 'inhibit-read-only) t)
2063 (set (make-local-variable 'anything-last-sources-local) anything-sources)
2064 (set (make-local-variable 'anything-follow-mode) nil)
2065 (set (make-local-variable 'anything-display-function) anything-display-function)
2066 (set (make-local-variable 'anything-selection-point) nil)
2067 (anything-initialize-persistent-action)
2068 (anything-log-eval anything-display-function anything-let-variables)
2069 (loop for (var . val) in anything-let-variables
2070 do (set (make-local-variable var) val))
2071 (setq cursor-type nil)
2072 (setq mode-name "Anything"))
2073 (anything-initialize-overlays anything-buffer)
2074 (get-buffer anything-buffer))
2076 (defun anything-initialize-overlays (buffer)
2077 "Initialize anything overlays in BUFFER."
2078 (anything-log "overlay setup")
2079 (if anything-selection-overlay
2080 ;; make sure the overlay belongs to the anything buffer if
2081 ;; it's newly created
2082 (move-overlay anything-selection-overlay (point-min) (point-min)
2083 (get-buffer buffer))
2085 (setq anything-selection-overlay
2086 (make-overlay (point-min) (point-min) (get-buffer buffer)))
2087 (overlay-put anything-selection-overlay 'face anything-selection-face))
2089 (cond (anything-enable-shortcuts
2090 (setq anything-shortcut-keys
2091 (assoc-default anything-enable-shortcuts anything-shortcut-keys-alist))
2092 (unless anything-digit-overlays
2093 (setq anything-digit-overlays
2094 (loop for key across anything-shortcut-keys
2095 for overlay = (make-overlay (point-min) (point-min)
2096 (get-buffer buffer))
2097 do (overlay-put overlay 'before-string
2098 (format "%s - " (upcase (make-string 1 key))))
2099 collect overlay))))
2100 (anything-digit-overlays
2101 (mapc 'delete-overlay anything-digit-overlays)
2102 (setq anything-digit-overlays nil))))
2104 (defun anything-hooks (setup-or-cleanup)
2105 "Add or remove hooks according to SETUP-OR-CLEANUP value.
2106 if SETUP-OR-CLEANUP value is setup add hooks, any other value
2107 will remove hooks.
2108 hooks concerned are `post-command-hook' and `minibuffer-setup-hook'."
2109 (let ((hooks '((post-command-hook anything-check-minibuffer-input)
2110 (minibuffer-setup-hook anything-print-error-messages))))
2111 (if (eq setup-or-cleanup 'setup)
2112 (dolist (args hooks) (apply 'add-hook args))
2113 (dolist (args (reverse hooks)) (apply 'remove-hook args)))))
2116 ;; (@* "Core: clean up")
2117 ;;; TODO move
2118 (defun anything-cleanup ()
2119 "Clean up the mess when anything exit or quit."
2120 (anything-log "start cleanup")
2121 (with-current-buffer anything-buffer
2122 ;; rubikitch: I think it is not needed.
2123 ;; thierry: If you end up for any reasons (error etc...)
2124 ;; with an anything-buffer staying around (visible),
2125 ;; You will have no cursor in this buffer when switching to it,
2126 ;; so I think this is needed.
2127 (setq cursor-type t)
2128 ;; Call burry-buffer whithout arg
2129 ;; to be sure anything-buffer is removed from window.
2130 (bury-buffer)
2131 ;; Be sure we call this from anything-buffer.
2132 (anything-funcall-foreach 'cleanup))
2133 (anything-new-timer 'anything-check-minibuffer-input-timer nil)
2134 (anything-kill-async-processes)
2135 (anything-log-run-hook 'anything-cleanup-hook)
2136 (anything-hooks 'cleanup)
2137 (anything-frame-or-window-configuration 'restore)
2138 (setq anything-alive-p nil)
2139 ;; This is needed in some cases where last input
2140 ;; is yielded infinitely in minibuffer after anything session.
2141 (anything-clean-up-minibuffer))
2143 (defun anything-clean-up-minibuffer ()
2144 "Remove contents of minibuffer."
2145 (let ((miniwin (minibuffer-window)))
2146 ;; Clean only current minibuffer used by anything.
2147 ;; i.e The precedent one is active.
2148 (unless (minibuffer-window-active-p miniwin)
2149 (with-current-buffer (window-buffer miniwin)
2150 (delete-minibuffer-contents)))))
2153 ;; (@* "Core: input handling")
2154 (defun anything-check-minibuffer-input ()
2155 "Extract input string from the minibuffer and check if it needs to be handled."
2156 (let ((delay (with-current-buffer anything-buffer
2157 (and anything-input-idle-delay
2158 (max anything-input-idle-delay 0.1)))))
2159 (if (or (not delay) (anything-action-window))
2160 (anything-check-minibuffer-input-1)
2161 (anything-new-timer
2162 'anything-check-minibuffer-input-timer
2163 (run-with-idle-timer delay nil 'anything-check-minibuffer-input-1)))))
2165 (defun anything-check-minibuffer-input-1 ()
2166 "Check minibuffer content."
2167 (with-anything-quittable
2168 (with-selected-window (or (active-minibuffer-window) (minibuffer-window))
2169 (anything-check-new-input (minibuffer-contents)))))
2171 (defun anything-check-new-input (input)
2172 "Check INPUT string and update the anything buffer if necessary."
2173 (unless (equal input anything-pattern)
2174 (setq anything-pattern input)
2175 (unless (anything-action-window)
2176 (setq anything-input anything-pattern))
2177 (anything-log-eval anything-pattern anything-input)
2178 (anything-update)))
2181 ;; (@* "Core: source compiler")
2182 (defvar anything-compile-source-functions-default anything-compile-source-functions
2183 "Plug-ins this file provides.")
2184 (defun anything-compile-sources (sources funcs)
2185 "Compile SOURCES with FUNCS.
2186 See `anything-compile-source-functions'.
2187 Anything plug-ins are realized by this function."
2188 (mapcar
2189 (lambda (source)
2190 (loop with source = (if (listp source) source (symbol-value source))
2191 for f in funcs
2192 do (setq source (funcall f source))
2193 finally (return source)))
2194 sources))
2197 ;; (@* "Core: plug-in attribute documentation hack")
2199 ;; `anything-document-attribute' is public API.
2200 (defadvice documentation-property (after anything-document-attribute activate)
2201 "Display plug-in attributes' documentation as `anything-sources' docstring."
2202 (when (eq (ad-get-arg 0) 'anything-sources)
2203 (setq ad-return-value
2204 (concat ad-return-value "\n"
2205 (mapconcat (lambda (sym) (get sym 'anything-attrdoc))
2206 anything-additional-attributes
2207 "\n")))))
2208 ;; (describe-variable 'anything-sources)
2209 ;; (documentation-property 'anything-sources 'variable-documentation)
2210 ;; (progn (ad-disable-advice 'documentation-property 'after 'anything-document-attribute) (ad-update 'documentation-property))
2213 ;; (@* "Core: all candidates")
2214 (defun anything-process-delayed-init (source)
2215 "Initialize delayed SOURCE."
2216 (let ((name (assoc-default 'name source)))
2217 (unless (member name anything-delayed-init-executed)
2218 (anything-aif (assoc-default 'delayed-init source)
2219 (with-current-buffer anything-current-buffer
2220 (anything-funcall-with-source source it)
2221 (dolist (f (if (functionp it) (list it) it))
2222 (add-to-list 'anything-delayed-init-executed name)))))))
2224 (defun anything-get-candidates (source)
2225 "Retrieve and return the list of candidates from SOURCE."
2226 (anything-process-delayed-init source)
2227 (let* ((candidate-source (assoc-default 'candidates source))
2228 (type-error (lambda ()
2229 (error (concat "Candidates must either be a function, "
2230 " a variable or a list: %s")
2231 candidate-source)))
2232 (candidates (condition-case err
2233 (anything-interpret-value candidate-source source)
2234 (error (funcall type-error)))))
2235 (cond ((processp candidates) candidates)
2236 ((listp candidates) (anything-transform-candidates candidates source))
2237 (t (funcall type-error)))))
2240 (defun anything-get-cached-candidates (source)
2241 "Return the cached value of candidates for SOURCE.
2242 Cache the candidates if there is not yet a cached value."
2243 (let* ((name (assoc-default 'name source))
2244 (candidate-cache (assoc name anything-candidate-cache)))
2245 (cond (candidate-cache
2246 (anything-log "use cached candidates")
2247 (cdr candidate-cache))
2249 (anything-log "calculate candidates")
2250 (let ((candidates (anything-get-candidates source)))
2251 (cond ((processp candidates)
2252 (push (cons candidates
2253 (append source
2254 (list (cons 'item-count 0)
2255 (cons 'incomplete-line ""))))
2256 anything-async-processes)
2257 (set-process-filter candidates 'anything-output-filter)
2258 (setq candidates nil))
2259 ((not (assoc 'volatile source))
2260 (setq candidate-cache (cons name candidates))
2261 (push candidate-cache anything-candidate-cache)))
2262 candidates)))))
2265 ;;; (@* "Core: candidate transformers")
2266 (defun anything-transform-mapcar (function args)
2267 "`mapcar' for candidate-transformer.
2269 ARGS is (cand1 cand2 ...) or ((disp1 . real1) (disp2 . real2) ...)
2271 \(anything-transform-mapcar 'upcase '(\"foo\" \"bar\"))
2272 => (\"FOO\" \"BAR\")
2273 \(anything-transform-mapcar 'upcase '((\"1st\" . \"foo\") (\"2nd\" . \"bar\")))
2274 => ((\"1st\" . \"FOO\") (\"2nd\" . \"BAR\"))
2276 (loop for arg in args
2277 if (consp arg)
2278 collect (cons (car arg) (funcall function (cdr arg)))
2279 else
2280 collect (funcall function arg)))
2282 (defun anything-process-candidate-transformer (candidates source)
2283 "Execute candidate-transformer function on all CANDIDATES of SOURCE."
2284 (anything-aif (assoc-default 'candidate-transformer source)
2285 (anything-composed-funcall-with-source source it candidates)
2286 candidates))
2288 (defun anything-process-filtered-candidate-transformer (candidates source)
2289 "Execute filtered-candidate-transformer function on all CANDIDATES of SOURCE."
2290 (anything-aif (assoc-default 'filtered-candidate-transformer source)
2291 (anything-composed-funcall-with-source source it candidates source)
2292 candidates))
2294 (defun anything-process-filtered-candidate-transformer-maybe (candidates source process-p)
2295 "Execute filtered-candidate-transformer function on all CANDIDATES of SOURCE.
2296 This happen if PROCESS-P is non-nil."
2297 (if process-p
2298 (anything-process-filtered-candidate-transformer candidates source)
2299 candidates))
2301 (defun anything-process-real-to-display (candidates source)
2302 "Execute real-to-display function on all CANDIDATES of SOURCE."
2303 (anything-aif (assoc-default 'real-to-display source)
2304 (setq candidates (anything-funcall-with-source
2305 source 'mapcar
2306 (lambda (cand_)
2307 (if (consp cand_)
2308 ;; override DISPLAY from candidate-transformer
2309 (cons (funcall it (cdr cand_)) (cdr cand_))
2310 (cons (funcall it cand_) cand_)))
2311 candidates))
2312 candidates))
2314 (defun anything-transform-candidates (candidates source &optional process-p)
2315 "Transform CANDIDATES of SOURCE according to candidate transformers.
2316 This happen if PROCESS-P is non-nil."
2317 (anything-process-real-to-display
2318 (anything-process-filtered-candidate-transformer-maybe
2319 (anything-process-candidate-transformer candidates source) source process-p)
2320 source))
2323 ;; (@* "Core: narrowing candidates")
2324 (defun anything-candidate-number-limit (source)
2325 "Apply candidate-number-limit attribute value.
2326 This overhide variable `anything-candidate-number-limit'.
2328 e.g:
2329 If \(candidate-number-limit\) is in SOURCE, show all candidates in SOURCE.
2330 If \(candidate-number-limit . 123\) is in SOURCE limit candidate to 123."
2331 (anything-aif (assq 'candidate-number-limit source)
2332 (or (cdr it) 99999999)
2333 (or anything-candidate-number-limit 99999999)))
2335 ;; FIXME: Why a defconst here
2336 (defconst anything-default-match-functions
2337 (list (lambda (candidate)
2338 (string-match anything-pattern candidate)))
2339 "Default functions to match candidates according to `anything-pattern'.")
2341 (defun anything-compute-matches (source)
2342 "Compute matched results from SOURCE according to its settings."
2343 (if debug-on-error
2344 (anything-compute-matches-internal source)
2345 (condition-case v
2346 (anything-compute-matches-internal source)
2347 (error (anything-log-error
2348 "anything-compute-matches: error when processing source: %s"
2349 (assoc-default 'name source))
2350 nil))))
2352 (defun anything-candidate-get-display (candidate)
2353 "Get searched display part from CANDIDATE.
2354 CANDIDATE is a string, a symbol, or \(DISPLAY . REAL\) cons cell."
2355 (format "%s" (or (car-safe candidate) candidate)))
2357 (defun anything-process-pattern-transformer (pattern source)
2358 "Execute pattern-transformer attribute PATTERN function in SOURCE."
2359 (anything-aif (assoc-default 'pattern-transformer source)
2360 (anything-composed-funcall-with-source source it pattern)
2361 pattern))
2363 (defun anything-match-functions (source)
2364 (or (assoc-default 'match source)
2365 anything-default-match-functions))
2367 (defmacro anything-accumulate-candidates-internal (cand newmatches
2368 hash item-count limit)
2369 "Internal, add CAND into NEWMATCHES.
2370 Use HASH to uniq NEWMATCHES.
2371 Argument ITEM-COUNT count the matches.
2372 if ITEM-COUNT reaches LIMIT, exit from inner loop."
2373 `(unless (gethash ,cand ,hash)
2374 (puthash ,cand t ,hash)
2375 (push ,cand ,newmatches)
2376 (incf ,item-count)
2377 (when (= ,item-count ,limit)
2378 (setq exit t)
2379 (return))))
2381 (defun anything-take-first-elements (seq n)
2382 (if (> (length seq) n)
2383 (setq seq (subseq seq 0 n))
2384 seq))
2386 (defun anything-match-from-candidates (cands matchfns limit)
2387 (let (matches)
2388 (condition-case nil
2389 (let ((item-count 0) exit)
2390 (clrhash anything-match-hash)
2391 (dolist (match matchfns)
2392 (let (newmatches)
2393 (dolist (candidate cands)
2394 (when (funcall match (anything-candidate-get-display candidate))
2395 (anything-accumulate-candidates-internal
2396 candidate newmatches anything-match-hash item-count limit)))
2397 (setq matches (append matches (reverse newmatches)))
2398 (if exit (return)))))
2399 (invalid-regexp (setq matches nil)))
2400 matches))
2402 (defun anything-compute-matches-internal (source)
2403 (save-current-buffer
2404 (let ((matchfns (anything-match-functions source))
2405 (anything-source-name (assoc-default 'name source))
2406 (limit (anything-candidate-number-limit source))
2407 (anything-pattern (anything-process-pattern-transformer
2408 anything-pattern source)))
2409 (anything-process-filtered-candidate-transformer
2410 (if (or (equal anything-pattern "") (equal matchfns '(identity)))
2411 (anything-take-first-elements
2412 (anything-get-cached-candidates source) limit)
2413 (anything-match-from-candidates
2414 (anything-get-cached-candidates source) matchfns limit))
2415 source))))
2417 ;; (anything '(((name . "error")(candidates . (lambda () (hage))) (action . identity))))
2419 (defun anything-process-source (source)
2420 "Display matched results from SOURCE according to its settings."
2421 (anything-log-eval (assoc-default 'name source))
2422 (if (assq 'direct-insert-match source) ;experimental
2423 (anything-process-source--direct-insert-match source)
2424 (let ((matches (anything-compute-matches source)))
2425 (when matches
2426 (when anything-test-mode
2427 (setq anything-test-candidate-list
2428 `(,@anything-test-candidate-list
2429 (,(assoc-default 'name source)
2430 ,matches))))
2431 (anything-insert-header-from-source source)
2432 (if (not (assq 'multiline source))
2433 (mapc 'anything-insert-match-with-digit-overlay matches)
2434 (let ((start (point)) separate)
2435 (dolist (match matches)
2436 (if separate
2437 (anything-insert-candidate-separator)
2438 (setq separate t))
2439 (anything-insert-match-with-digit-overlay match))
2440 (put-text-property start (point) 'anything-multiline t)))))))
2442 (defun anything-insert-match-with-digit-overlay (match)
2443 (declare (special source))
2444 (anything-put-digit-overlay-maybe)
2445 (anything-insert-match match 'insert source))
2447 (defun anything-put-digit-overlay-maybe ()
2448 (when (and anything-enable-shortcuts
2449 (not (eq anything-digit-shortcut-count
2450 (length anything-digit-overlays))))
2451 (move-overlay (nth anything-digit-shortcut-count
2452 anything-digit-overlays)
2453 (point-at-bol)
2454 (point-at-bol))
2455 (incf anything-digit-shortcut-count)))
2457 (defun anything-process-source--direct-insert-match (source)
2458 "[EXPERIMENTAL] Insert candidates from `anything-candidate-buffer' in SOURCE."
2459 (anything-log-eval (assoc-default 'name source))
2460 (let ((anything-source-name (assoc-default 'name source))
2461 content-buf)
2462 (funcall (assoc-default 'candidates source))
2463 (setq content-buf (anything-candidate-buffer))
2464 (unless (anything-empty-buffer-p content-buf)
2465 (anything-insert-header-from-source source)
2466 (insert-buffer-substring content-buf)
2467 ;; TODO call anything-put-digit-overlay-maybe with loop
2470 (defun anything-process-delayed-sources (delayed-sources &optional preselect)
2471 "Process anything DELAYED-SOURCES.
2472 Move selection to string or regexp PRESELECT if non--nil.
2473 This function is called in `anything-process-delayed-sources-timer'
2474 when emacs is idle for `anything-idle-delay'."
2475 (with-anything-quittable
2476 (anything-log-eval (mapcar (lambda (s) (assoc-default 'name s)) delayed-sources))
2477 (with-current-buffer anything-buffer
2478 (save-excursion
2479 (goto-char (point-max))
2480 (mapc 'anything-process-source delayed-sources)
2481 (when (and (not (anything-empty-buffer-p))
2482 ;; No selection yet.
2483 (= (overlay-start anything-selection-overlay)
2484 (overlay-end anything-selection-overlay)))
2485 (anything-update-move-first-line 'without-hook)))
2486 (when preselect (anything-preselect preselect))
2487 (save-excursion
2488 (goto-char (point-min))
2489 (anything-log-run-hook 'anything-update-hook))
2490 (anything-log-run-hook 'anything-after-update-hook))))
2493 ;; (@* "Core: *anything* buffer contents")
2494 (defvar anything-input-local nil)
2495 (defvar anything-process-delayed-sources-timer nil)
2496 (defun anything-update (&optional preselect)
2497 "Update candidates list in `anything-buffer' according to `anything-pattern'.
2498 Argument PRESELECT is a string or regexp used to move selection to a particular
2499 place once updating is done. It should be used on single source because search
2500 is done on whole `anything-buffer' and not on current source."
2501 (anything-log "start update")
2502 (setq anything-digit-shortcut-count 0)
2503 (anything-kill-async-processes)
2504 (with-current-buffer (anything-buffer-get)
2505 (set (make-local-variable 'anything-input-local) anything-pattern)
2506 (erase-buffer)
2507 (when anything-enable-shortcuts
2508 (mapc 'delete-overlay anything-digit-overlays))
2509 (let (delayed-sources
2510 (case-fold-search t)
2511 normal-sources)
2512 (unwind-protect ; Process normal sources and store delayed one's.
2513 (setq delayed-sources
2514 (loop for source in (remove-if-not 'anything-update-source-p
2515 (anything-get-sources))
2516 if (anything-delayed-source-p source)
2517 collect source
2518 else do (progn (push source normal-sources)
2519 (anything-process-source source))))
2520 (anything-log-eval
2521 (mapcar (lambda (s) (assoc-default 'name s)) delayed-sources))
2522 (if anything-test-mode ; Need only to process sources.
2523 (mapc 'anything-process-source delayed-sources)
2524 (cond ((and preselect delayed-sources normal-sources)
2525 ;; Preselection run here when there is
2526 ;; normal AND delayed sources.
2527 (anything-log "Update preselect candidate %s" preselect)
2528 (anything-preselect preselect))
2529 (delayed-sources ; Preselection and hooks will run later.
2530 (anything-update-move-first-line 'without-hook))
2531 (t ; No delayed sources, run the hooks now.
2532 (anything-update-move-first-line)
2533 (anything-log-run-hook 'anything-after-update-hook)
2534 (when preselect
2535 (anything-log "Update preselect candidate %s" preselect)
2536 (anything-preselect preselect))))
2537 (when delayed-sources
2538 (anything-new-timer
2539 'anything-process-delayed-sources-timer
2540 (run-with-idle-timer
2541 ;; Be sure anything-idle-delay is >
2542 ;; to anything-input-idle-delay
2543 ;; otherwise use value of anything-input-idle-delay
2544 ;; or 0.1 if == to 0.
2545 (max anything-idle-delay anything-input-idle-delay 0.1) nil
2546 'anything-process-delayed-sources delayed-sources preselect))))
2547 (anything-log "end update")))))
2549 (defun anything-update-source-p (source)
2550 "Wheter SOURCE need updating or not."
2551 (and (or (not anything-source-filter)
2552 (member (assoc-default 'name source) anything-source-filter))
2553 (>= (length anything-pattern)
2554 (anything-aif (assoc 'requires-pattern source)
2555 (or (cdr it) 1)
2556 0))))
2558 (defun anything-delayed-source-p (source)
2559 "Wheter SOURCE is a delayed source or not."
2560 (or (assoc 'delayed source)
2561 (and anything-quick-update
2562 (< (window-height (get-buffer-window (current-buffer)))
2563 (line-number-at-pos (point-max))))))
2565 (defun anything-update-move-first-line (&optional without-hook)
2566 "Goto first line of `anything-buffer'."
2567 (goto-char (point-min))
2568 (unless without-hook
2569 (save-excursion (anything-log-run-hook 'anything-update-hook)))
2570 (anything-next-line))
2572 (defun anything-force-update (&optional preselect)
2573 "Force recalculation and update of candidates.
2574 If current source has `update' attribute, a function without argument,
2575 call it before update."
2576 (interactive)
2577 (let ((source (anything-get-current-source))
2578 (selection (anything-get-selection nil t)))
2579 (when source
2580 (mapc 'anything-force-update--reinit
2581 (anything-get-sources)))
2582 (anything-update preselect)
2583 ;; If preselect arg exists, `anything-update' should
2584 ;; have moved to selection, otherwise do it now.
2585 (unless preselect
2586 (anything-keep-selection (assoc-default 'name source) selection))
2587 (with-anything-window (recenter))))
2589 (defun anything-force-update--reinit (source)
2590 "Reinit SOURCE by calling his update and/or init functions."
2591 (anything-aif (anything-funcall-with-source
2592 source 'anything-candidate-buffer)
2593 (kill-buffer it))
2594 (dolist (attr '(update init))
2595 (anything-aif (assoc-default attr source)
2596 (anything-funcall-with-source source it)))
2597 (anything-remove-candidate-cache source))
2599 (defun anything-keep-selection (source selection)
2600 "Switch to SOURCE and goto SELECTION."
2601 (when (and source selection)
2602 (with-anything-window
2603 (anything-goto-source source)
2604 (forward-char -1)
2605 (if (search-forward selection nil t)
2606 (forward-line 0)
2607 (goto-char (point-min))
2608 (forward-line 1))
2609 (anything-mark-current-line))))
2611 (defun anything-remove-candidate-cache (source)
2612 "Remove SOURCE from `anything-candidate-cache'."
2613 (setq anything-candidate-cache
2614 (delete (assoc (assoc-default 'name source)
2615 anything-candidate-cache)
2616 anything-candidate-cache)))
2618 (defun anything-insert-match (match insert-function source)
2619 "Insert MATCH into `anything-buffer' with INSERT-FUNCTION for SOURCE.
2620 If MATCH is a list then insert the string intended to appear on the display
2621 and store the real value in a text property."
2622 (let ((start (point-at-bol (point)))
2623 (dispvalue (or (car-safe match) match))
2624 (realvalue (cdr-safe match)))
2625 (setq dispvalue
2626 (cond ((symbolp dispvalue) (symbol-name dispvalue))
2627 ((numberp dispvalue) (number-to-string dispvalue))
2628 (t dispvalue)))
2629 (when (stringp dispvalue)
2630 (funcall insert-function dispvalue)
2631 ;; Some sources with candidates-in-buffer have already added
2632 ;; 'anything-realvalue property when creating candidate buffer.
2633 (unless (get-text-property start 'anything-realvalue)
2634 (and realvalue
2635 (put-text-property start (point-at-eol)
2636 'anything-realvalue realvalue)))
2637 (when anything-source-in-each-line-flag
2638 (put-text-property start (point-at-eol) 'anything-source source))
2639 (funcall insert-function "\n"))))
2641 (defun anything-insert-header-from-source (source)
2642 "Insert SOURCE name in `anything-buffer' header.
2643 Maybe insert by overlay additional info after source name if SOURCE have
2644 header-name attribute."
2645 (let ((name (assoc-default 'name source)))
2646 (anything-insert-header
2647 name
2648 (anything-aif (assoc-default 'header-name source)
2649 (anything-funcall-with-source source it name)))))
2651 (defun anything-insert-header (name &optional display-string)
2652 "Insert header of source NAME into the anything buffer.
2653 If DISPLAY-STRING is non--nil and a string, display this additional info
2654 after the source name by overlay."
2655 (unless (bobp)
2656 (let ((start (point)))
2657 (insert "\n")
2658 (put-text-property start (point) 'anything-header-separator t)))
2659 (let ((start (point)))
2660 (insert name)
2661 (put-text-property (point-at-bol)
2662 (point-at-eol) 'anything-header t)
2663 (when display-string
2664 (overlay-put (make-overlay (point-at-bol) (point-at-eol))
2665 'display display-string))
2666 (insert "\n")
2667 (put-text-property start (point) 'face anything-header-face)))
2669 (defun anything-insert-candidate-separator ()
2670 "Insert separator of candidates into the anything buffer."
2671 (insert anything-candidate-separator)
2672 (put-text-property (point-at-bol)
2673 (point-at-eol) 'anything-candidate-separator t)
2674 (insert "\n"))
2677 ;; (@* "Core: async process")
2678 (defun anything-output-filter (process string)
2679 "From PROCESS process output STRING."
2680 (anything-output-filter-1 (assoc process anything-async-processes) string))
2682 (defun anything-output-filter-1 (process-assoc string)
2683 (anything-log-eval string)
2684 (with-current-buffer anything-buffer
2685 (let ((source (cdr process-assoc)))
2686 (save-excursion
2687 (anything-aif (assoc-default 'insertion-marker source)
2688 (goto-char it)
2689 (goto-char (point-max))
2690 (anything-insert-header-from-source source)
2691 (setcdr process-assoc
2692 (append source `((insertion-marker . ,(point-marker))))))
2693 (anything-output-filter--process-source
2694 (car process-assoc) string source
2695 (anything-candidate-number-limit source))))
2696 (anything-output-filter--post-process)))
2698 (defun anything-output-filter--process-source (process string source limit)
2699 (dolist (candidate (anything-transform-candidates
2700 (anything-output-filter--collect-candidates
2701 (split-string string "\n")
2702 (assoc 'incomplete-line source))
2703 source t))
2704 (if (not (assq 'multiline source))
2705 (anything-insert-match candidate 'insert-before-markers source)
2706 (let ((start (point)))
2707 (anything-insert-candidate-separator)
2708 (anything-insert-match candidate 'insert-before-markers source)
2709 (put-text-property start (point) 'anything-multiline t)))
2710 (incf (cdr (assoc 'item-count source)))
2711 (when (>= (assoc-default 'item-count source) limit)
2712 (anything-kill-async-process process)
2713 (return))))
2715 (defun anything-output-filter--collect-candidates (lines incomplete-line-info)
2716 (anything-log-eval (cdr incomplete-line-info))
2717 (butlast
2718 (loop for line in lines collect
2719 (if (cdr incomplete-line-info)
2720 (prog1
2721 (concat (cdr incomplete-line-info) line)
2722 (setcdr incomplete-line-info nil))
2723 line)
2724 finally (setcdr incomplete-line-info line))))
2726 (defun anything-output-filter--post-process ()
2727 (anything-log-run-hook 'anything-update-hook)
2728 (anything-aif (get-buffer-window anything-buffer 'visible)
2729 (save-selected-window
2730 (select-window it)
2731 (anything-skip-noncandidate-line 'next)
2732 (anything-mark-current-line))))
2734 (defun anything-kill-async-processes ()
2735 "Kill all known asynchronous processes of `anything-async-processes'."
2736 (mapc 'anything-kill-async-process (mapcar 'car anything-async-processes))
2737 (setq anything-async-processes nil))
2739 (defun anything-kill-async-process (process)
2740 "Kill PROCESS and detach the associated functions."
2741 (set-process-filter process nil)
2742 (delete-process process))
2745 ;; (@* "Core: action")
2746 (defun anything-execute-selection-action (&optional
2747 selection action
2748 preserve-saved-action)
2749 "If a candidate SELECTION is present then perform the associated ACTION on it.
2750 If PRESERVE-SAVED-ACTION is non-nil don't save action."
2751 (anything-log "executing action")
2752 (setq action (anything-get-default-action
2753 (or action
2754 anything-saved-action
2755 (if (get-buffer anything-action-buffer)
2756 (anything-get-selection anything-action-buffer)
2757 (anything-get-action)))))
2758 (let ((source (or anything-saved-current-source
2759 (anything-get-current-source))))
2760 (setq selection (or selection
2761 (anything-get-selection)
2762 (and (assoc 'accept-empty source) "")))
2763 (unless preserve-saved-action (setq anything-saved-action nil))
2764 (if (and selection action)
2765 (anything-funcall-with-source
2766 source action
2767 (anything-coerce-selection selection source)))))
2769 (defun anything-coerce-selection (selection source)
2770 "Apply coerce attribute function to SELECTION in SOURCE.
2771 Coerce source with coerce function."
2772 (anything-aif (assoc-default 'coerce source)
2773 (anything-funcall-with-source source it selection)
2774 selection))
2776 (defun anything-get-default-action (action)
2777 "Get the first ACTION value of action list in source."
2778 (if (and (listp action) (not (functionp action)))
2779 (cdar action)
2780 action))
2782 (defun anything-select-action ()
2783 "Select an action for the currently selected candidate.
2784 If action buffer is selected, back to the anything buffer."
2785 (interactive)
2786 (anything-log-run-hook 'anything-select-action-hook)
2787 (cond ((get-buffer-window anything-action-buffer 'visible)
2788 (set-window-buffer (get-buffer-window anything-action-buffer)
2789 anything-buffer)
2790 (kill-buffer anything-action-buffer)
2791 (anything-set-pattern anything-input 'noupdate))
2793 (setq anything-saved-selection (anything-get-selection))
2794 (unless anything-saved-selection
2795 (error "Nothing is selected"))
2796 (setq anything-saved-current-source (anything-get-current-source))
2797 (let ((actions (anything-get-action)))
2798 (if (functionp actions)
2799 (message "Sole action: %s" actions)
2800 (anything-show-action-buffer actions)
2801 (anything-delete-minibuffer-contents)
2802 (setq anything-pattern 'dummy) ; so that it differs from the previous one
2803 (anything-check-minibuffer-input))))))
2805 (defun anything-show-action-buffer (actions)
2806 (with-current-buffer (get-buffer-create anything-action-buffer)
2807 (erase-buffer)
2808 (buffer-disable-undo)
2809 (set-window-buffer (get-buffer-window anything-buffer) anything-action-buffer)
2810 (set (make-local-variable 'anything-sources)
2811 `(((name . "Actions")
2812 (volatile)
2813 (candidates . ,actions)
2814 (candidate-number-limit))))
2815 (set (make-local-variable 'anything-source-filter) nil)
2816 (set (make-local-variable 'anything-selection-overlay) nil)
2817 (set (make-local-variable 'anything-digit-overlays) nil)
2818 (anything-initialize-overlays anything-action-buffer)))
2821 ;; (@* "Core: selection")
2822 (defun anything-move-selection-common (move-func unit direction)
2823 "Move the selection marker to a new position wit function MOVE-FUNC.
2824 It is determined by UNIT and DIRECTION."
2825 (unless (or (anything-empty-buffer-p (anything-buffer-get))
2826 (not (anything-window)))
2827 (with-anything-window
2828 (anything-log-run-hook 'anything-move-selection-before-hook)
2829 (funcall move-func)
2830 (anything-skip-noncandidate-line direction)
2831 (anything-display-source-at-screen-top-maybe unit)
2832 (when (anything-get-previous-header-pos)
2833 (anything-mark-current-line))
2834 (anything-display-mode-line (anything-get-current-source))
2835 (anything-log-run-hook 'anything-move-selection-after-hook))))
2837 (defun anything-display-source-at-screen-top-maybe (unit)
2838 (when (and anything-display-source-at-screen-top (eq unit 'source))
2839 (set-window-start (selected-window)
2840 (save-excursion (forward-line -1) (point)))))
2842 (defun anything-skip-noncandidate-line (direction)
2843 (anything-skip-header-and-separator-line direction)
2844 (and (bobp) (forward-line 1)) ;skip first header
2845 (and (eobp) (forward-line -1))) ;avoid last empty line
2848 (defun anything-skip-header-and-separator-line (direction)
2849 (while (and (not (bobp))
2850 (or (anything-pos-header-line-p)
2851 (anything-pos-candidate-separator-p)))
2852 (forward-line (if (and (eq direction 'previous)
2853 (not (eq (point-at-bol) (point-min))))
2854 -1 1))))
2856 (defvar anything-mode-line-string-real nil)
2857 (defun anything-display-mode-line (source)
2858 (set (make-local-variable 'anything-mode-line-string)
2859 (anything-interpret-value (or (assoc-default 'mode-line source)
2860 (default-value 'anything-mode-line-string))
2861 source))
2862 (if anything-mode-line-string
2863 (setq mode-line-format
2864 '(" " mode-line-buffer-identification " "
2865 (line-number-mode "L%l") " " (anything-follow-mode "(F) ")
2866 (:eval (anything-show-candidate-number
2867 (when (listp anything-mode-line-string)
2868 (car anything-mode-line-string))))
2869 " " anything-mode-line-string-real "-%-")
2870 anything-mode-line-string-real
2871 (substitute-command-keys (if (listp anything-mode-line-string)
2872 (cadr anything-mode-line-string)
2873 anything-mode-line-string)))
2874 (setq mode-line-format
2875 (default-value 'mode-line-format)))
2876 (setq header-line-format
2877 (anything-interpret-value (assoc-default 'header-line source) source)))
2879 (defun anything-show-candidate-number (&optional name)
2880 "Used to display candidate number in mode-line.
2881 You can specify NAME of candidates e.g \"Buffers\" otherwise
2882 it is \"Candidate\(s\)\" by default."
2883 (propertize
2884 (format "[%s %s]"
2885 (anything-approximate-candidate-number 'in-current-source)
2886 (or name "Candidate(s)"))
2887 'face 'anything-candidate-number))
2889 (defun anything-previous-line ()
2890 "Move selection to the previous line."
2891 (interactive)
2892 (anything-move-selection-common
2893 (lambda ()
2894 (if (not (anything-pos-multiline-p))
2895 (forward-line -1) ;double forward-line is meaningful
2896 (forward-line -1) ;because evaluation order is important
2897 (anything-skip-header-and-separator-line 'previous)
2898 (let ((header-pos (anything-get-previous-header-pos))
2899 (separator-pos (anything-get-previous-candidate-separator-pos)))
2900 (when header-pos
2901 (goto-char (if (or (null separator-pos) (< separator-pos header-pos))
2902 header-pos ; first candidate
2903 separator-pos))
2904 (forward-line 1)))))
2905 'line 'previous))
2907 (defun anything-next-line ()
2908 "Move selection to the next line."
2909 (interactive)
2910 (anything-move-selection-common
2911 (lambda ()
2912 (if (not (anything-pos-multiline-p))
2913 (forward-line 1)
2914 (let ((header-pos (anything-get-next-header-pos))
2915 (separator-pos (anything-get-next-candidate-separator-pos)))
2916 (cond ((and separator-pos
2917 (or (null header-pos) (< separator-pos header-pos)))
2918 (goto-char separator-pos))
2919 (header-pos
2920 (goto-char header-pos))))))
2921 'line 'next))
2923 (defun anything-previous-page ()
2924 "Move selection back with a pageful."
2925 (interactive)
2926 (anything-move-selection-common
2927 (lambda ()
2928 (condition-case nil
2929 (scroll-down)
2930 (beginning-of-buffer (goto-char (point-min)))))
2931 'page 'previous))
2933 (defun anything-next-page ()
2934 "Move selection forward with a pageful."
2935 (interactive)
2936 (anything-move-selection-common
2937 (lambda ()
2938 (condition-case nil
2939 (scroll-up)
2940 (end-of-buffer (goto-char (point-max)))))
2941 'page 'next))
2943 (defun anything-beginning-of-buffer ()
2944 "Move selection at the top."
2945 (interactive)
2946 (anything-move-selection-common
2947 (lambda () (goto-char (point-min)))
2948 'edge 'previous))
2950 (defun anything-end-of-buffer ()
2951 "Move selection at the bottom."
2952 (interactive)
2953 (anything-move-selection-common
2954 (lambda () (goto-char (point-max)))
2955 'edge 'next))
2957 (defun anything-previous-source ()
2958 "Move selection to the previous source."
2959 (interactive)
2960 (anything-move-selection-common
2961 (lambda ()
2962 (forward-line -1)
2963 (if (bobp)
2964 (goto-char (point-max))
2965 (anything-skip-header-and-separator-line 'previous))
2966 (goto-char (anything-get-previous-header-pos))
2967 (forward-line 1))
2968 'source 'previous))
2970 (defun anything-next-source ()
2971 "Move selection to the next source."
2972 (interactive)
2973 (anything-move-selection-common
2974 (lambda ()
2975 (goto-char (or (anything-get-next-header-pos) (point-min))))
2976 'source 'next))
2978 (defun anything-goto-source (source-or-name)
2979 "Move the selection to the source SOURCE-OR-NAME."
2980 (anything-move-selection-common
2981 (lambda ()
2982 (goto-char (point-min))
2983 (let ((name (if (stringp source-or-name) source-or-name
2984 (assoc-default 'name source-or-name))))
2985 (condition-case err
2986 (while (not (string= name (anything-current-line-contents)))
2987 (goto-char (anything-get-next-header-pos)))
2988 (error (message "")))))
2989 'source 'next))
2991 (defun anything-mark-current-line (&optional resumep)
2992 "Move `anything-selection-overlay' to current line.
2993 Note that this is not related with visibles marks, which are used
2994 to mark candidates."
2995 (with-anything-window
2996 (when resumep
2997 (goto-char anything-selection-point))
2998 (move-overlay
2999 anything-selection-overlay (point-at-bol)
3000 (if (anything-pos-multiline-p)
3001 (let ((header-pos (anything-get-next-header-pos))
3002 (separator-pos (anything-get-next-candidate-separator-pos)))
3003 (or (and (null header-pos) separator-pos)
3004 (and header-pos separator-pos (< separator-pos header-pos)
3005 separator-pos)
3006 header-pos
3007 (point-max)))
3008 (1+ (point-at-eol))))
3009 (setq anything-selection-point (overlay-start anything-selection-overlay)))
3010 (anything-follow-execute-persistent-action-maybe))
3012 (defun anything-this-command-key ()
3013 (event-basic-type (elt (this-command-keys-vector) 0)))
3014 ;; (progn (read-key-sequence "Key: ") (p (anything-this-command-key)))
3016 (defun anything-select-with-shortcut-internal (types get-key-func)
3017 (if (memq anything-enable-shortcuts types)
3018 (save-selected-window
3019 (select-window (anything-window))
3020 (let* ((key (funcall get-key-func))
3021 (overlay (ignore-errors (nth (position key anything-shortcut-keys)
3022 anything-digit-overlays))))
3023 (if (not (and overlay (overlay-buffer overlay)))
3024 (when (numberp key)
3025 (select-window (minibuffer-window))
3026 (self-insert-command 1))
3027 (goto-char (overlay-start overlay))
3028 (anything-mark-current-line)
3029 (anything-exit-minibuffer))))
3030 (self-insert-command 1)))
3032 (defun anything-select-with-prefix-shortcut ()
3033 "Invoke default action with prefix shortcut."
3034 (interactive)
3035 (anything-select-with-shortcut-internal
3036 '(prefix)
3037 (lambda () (read-event "Select shortcut key: "))))
3039 (defun anything-select-with-digit-shortcut ()
3040 "Invoke default action with digit/alphabet shortcut."
3041 (interactive)
3042 (anything-select-with-shortcut-internal
3043 '(alphabet t) 'anything-this-command-key))
3045 ;; (setq anything-enable-shortcuts 'prefix)
3046 ;; (define-key anything-map "@" 'anything-select-with-prefix-shortcut)
3047 ;; (define-key anything-map (kbd "<f18>") 'anything-select-with-prefix-shortcut)
3049 (defvar anything-exit-status 0
3050 "Flag to inform whether anything have exited or quitted.
3051 Exit with 0 mean anything have exited executing an action.
3052 Exit with 1 mean anything have quitted with \\[keyboard-quit]
3053 It is useful for example to restore a window config if anything abort
3054 in special cases.
3055 See `anything-exit-minibuffer' and `anything-keyboard-quit'.")
3057 (defvar anything-minibuffer-confirm-state nil)
3058 (defun anything-confirm-and-exit-minibuffer ()
3059 "Maybe ask for confirmation when exiting anything.
3060 It is similar to `minibuffer-complete-and-exit' adapted to anything.
3061 If `minibuffer-completion-confirm' value is 'confirm,
3062 send in minibuffer confirm message and exit on next hit.
3063 If `minibuffer-completion-confirm' value is t,
3064 don't exit and send message 'no match'."
3065 (interactive)
3066 (let ((empty-buffer-p (with-current-buffer anything-buffer
3067 (eq (point-min) (point-max))))
3068 (unknow (string= (get-text-property
3069 0 'display (anything-get-selection nil 'withprop))
3070 "[?]")))
3071 (cond ((and (or empty-buffer-p unknow)
3072 (eq minibuffer-completion-confirm 'confirm))
3073 (setq anything-minibuffer-confirm-state
3074 'confirm)
3075 (setq minibuffer-completion-confirm nil)
3076 (minibuffer-message " [confirm]"))
3077 ((and (or empty-buffer-p unknow)
3078 (eq minibuffer-completion-confirm t))
3079 (minibuffer-message " [No match]"))
3081 (setq anything-minibuffer-confirm-state nil)
3082 (anything-exit-minibuffer)))))
3083 (add-hook 'anything-after-update-hook 'anything-confirm-and-exit-hook)
3085 (defun anything-confirm-and-exit-hook ()
3086 "Restore `minibuffer-completion-confirm' when anything update."
3087 (unless (or (eq minibuffer-completion-confirm t)
3088 (not anything-minibuffer-confirm-state))
3089 (setq minibuffer-completion-confirm
3090 anything-minibuffer-confirm-state)))
3092 (defun anything-exit-minibuffer ()
3093 "Select the current candidate by exiting the minibuffer."
3094 (interactive)
3095 (unless anything-current-prefix-arg
3096 (setq anything-current-prefix-arg current-prefix-arg))
3097 (setq anything-exit-status 0)
3098 (exit-minibuffer))
3100 (defun anything-keyboard-quit ()
3101 "Quit minibuffer in anything.
3102 If action buffer is displayed, kill it."
3103 (interactive)
3104 (when (get-buffer-window anything-action-buffer 'visible)
3105 (kill-buffer anything-action-buffer))
3106 (setq anything-exit-status 1)
3107 (abort-recursive-edit))
3109 (defun anything-get-next-header-pos ()
3110 "Return the position of the next header from point."
3111 (next-single-property-change (point) 'anything-header))
3113 (defun anything-get-previous-header-pos ()
3114 "Return the position of the previous header from point."
3115 (previous-single-property-change (point) 'anything-header))
3117 (defun anything-pos-multiline-p ()
3118 "Return non-nil if the current position is in the multiline source region."
3119 (get-text-property (point) 'anything-multiline))
3121 (defun anything-get-next-candidate-separator-pos ()
3122 "Return the position of the next candidate separator from point."
3123 (next-single-property-change (point) 'anything-candidate-separator))
3125 (defun anything-get-previous-candidate-separator-pos ()
3126 "Return the position of the previous candidate separator from point."
3127 (previous-single-property-change (point) 'anything-candidate-separator))
3129 (defun anything-pos-header-line-p ()
3130 "Return t if the current line is a header line."
3131 (or (get-text-property (point-at-bol) 'anything-header)
3132 (get-text-property (point-at-bol) 'anything-header-separator)))
3134 (defun anything-pos-candidate-separator-p ()
3135 "Return t if the current line is a candidate separator."
3136 (get-text-property (point-at-bol) 'anything-candidate-separator))
3139 ;; (@* "Core: help")
3140 (defun anything-help-internal (bufname insert-content-fn)
3141 "Show long message during `anything' session in BUFNAME.
3142 INSERT-CONTENT-FN is the text to be displayed in BUFNAME."
3143 (save-window-excursion
3144 (select-window (anything-window))
3145 (delete-other-windows)
3146 (switch-to-buffer (get-buffer-create bufname))
3147 (erase-buffer)
3148 (funcall insert-content-fn)
3149 (setq mode-line-format "%b (SPC,C-v:NextPage b,M-v:PrevPage other:Exit)")
3150 (setq cursor-type nil)
3151 (goto-char 1)
3152 (anything-help-event-loop)))
3154 (defun anything-help-event-loop ()
3155 (ignore-errors
3156 (loop for event = (read-event) do
3157 (case event
3158 ((?\C-v ? ) (scroll-up))
3159 ((?\M-v ?b) (scroll-down))
3160 (t (return))))))
3162 (defun anything-help ()
3163 "Help of `anything'."
3164 (interactive)
3165 (anything-help-internal
3166 " *Anything Help*"
3167 (lambda ()
3168 (insert (substitute-command-keys
3169 (anything-interpret-value (or (assoc-default
3170 'help-message
3171 (anything-get-current-source))
3172 anything-help-message))))
3173 (org-mode))))
3175 (defun anything-debug-output ()
3176 "Show all anything-related variables at this time."
3177 (interactive)
3178 (anything-help-internal " *Anything Debug*" 'anything-debug-output-function))
3180 (defun anything-debug-output-function (&optional vars)
3181 (message "Calculating all anything-related values...")
3182 (insert "If you debug some variables or forms, set `anything-debug-forms'
3183 to a list of forms.\n\n")
3184 (dolist (v (or vars
3185 anything-debug-forms
3186 (apropos-internal "^anything-" 'boundp)))
3187 (insert "** "
3188 (pp-to-string v) "\n"
3189 (pp-to-string (with-current-buffer anything-buffer (eval v))) "\n"))
3190 (message "Calculating all anything-related values...Done"))
3193 ;; (@* "Core: misc")
3194 (defun anything-kill-buffer-hook ()
3195 "Remove tick entry from `anything-tick-hash' when killing a buffer."
3196 (loop for key being the hash-keys in anything-tick-hash
3197 if (string-match (format "^%s/" (regexp-quote (buffer-name))) key)
3198 do (remhash key anything-tick-hash)))
3199 (add-hook 'kill-buffer-hook 'anything-kill-buffer-hook)
3201 (defun anything-preselect (candidate-or-regexp)
3202 "Move `anything-selection-overlay' to CANDIDATE-OR-REGEXP on startup."
3203 (with-anything-window
3204 (when candidate-or-regexp
3205 (goto-char (point-min))
3206 ;; go to first candidate of first source
3207 (forward-line 1)
3208 (let ((start (point)))
3209 (or (re-search-forward
3210 (concat "^" (regexp-quote candidate-or-regexp) "$") nil t)
3211 (re-search-forward candidate-or-regexp nil t)
3212 (search-forward candidate-or-regexp nil t)
3213 (goto-char start))))
3214 (anything-mark-current-line)))
3216 (defun anything-delete-current-selection ()
3217 "Delete the currently selected item."
3218 (interactive)
3219 (with-anything-window
3220 (cond ((anything-pos-multiline-p)
3221 (anything-aif (anything-get-next-candidate-separator-pos)
3222 (delete-region (point-at-bol)
3223 (1+ (progn (goto-char it) (point-at-eol))))
3224 ;; last candidate
3225 (goto-char (anything-get-previous-candidate-separator-pos))
3226 (delete-region (point-at-bol) (point-max)))
3227 (when (anything-end-of-source-p)
3228 (goto-char (or (anything-get-previous-candidate-separator-pos)
3229 (point-min)))
3230 (forward-line 1)))
3232 (delete-region (point-at-bol) (1+ (point-at-eol)))
3233 (when (anything-end-of-source-p) (forward-line -1))))
3234 (anything-mark-current-line)))
3236 (defun anything-end-of-source-p ()
3237 "Return non--nil if we are at eob or end of source."
3238 (save-excursion
3239 (forward-line 1)
3240 (or (eq (point-at-bol) (point-at-eol))
3241 (anything-pos-header-line-p)
3242 (eobp))))
3244 (defun anything-edit-current-selection-internal (func)
3245 (with-anything-window
3246 (beginning-of-line)
3247 (let ((realvalue (get-text-property (point) 'anything-realvalue)))
3248 (funcall func)
3249 (beginning-of-line)
3250 (and realvalue
3251 (put-text-property (point) (point-at-eol)
3252 'anything-realvalue realvalue))
3253 (anything-mark-current-line))))
3255 (defmacro anything-edit-current-selection (&rest forms)
3256 "Evaluate FORMS at current selection in the anything buffer.
3257 You can edit the line."
3258 (declare (indent 0) (debug t))
3259 `(anything-edit-current-selection-internal
3260 (lambda () ,@forms)))
3262 (defun anything-set-pattern (pattern &optional noupdate)
3263 "Set minibuffer contents to PATTERN.
3264 if optional NOUPDATE is non-nil, anything buffer is not changed."
3265 (with-selected-window (or (active-minibuffer-window) (minibuffer-window))
3266 (delete-minibuffer-contents)
3267 (insert pattern))
3268 (when noupdate
3269 (setq anything-pattern pattern)
3270 (anything-hooks 'cleanup)
3271 (run-with-idle-timer 0 nil 'anything-hooks 'setup)))
3273 (defun anything-delete-minibuffer-contents ()
3274 "Same as `delete-minibuffer-contents' but this is a command."
3275 (interactive)
3276 (anything-set-pattern ""))
3277 (defalias 'anything-delete-minibuffer-content 'anything-delete-minibuffer-contents)
3280 ;;; Plugins
3282 ;; (@* "Built-in plug-in: type")
3283 (defun anything-compile-source--type (source)
3284 (anything-aif (assoc-default 'type source)
3285 (append source (assoc-default it anything-type-attributes) nil)
3286 source))
3288 ;; `define-anything-type-attribute' is public API.
3290 (defun anything-add-type-attribute (type definition)
3291 (anything-aif (assq type anything-type-attributes)
3292 (setq anything-type-attributes (delete it anything-type-attributes)))
3293 (push (cons type definition) anything-type-attributes))
3295 (defvar anything-types nil)
3296 (defun anything-document-type-attribute (type doc)
3297 (add-to-list 'anything-types type t)
3298 (put type 'anything-typeattrdoc
3299 (concat "- " (symbol-name type) "\n\n" doc "\n")))
3301 (defadvice documentation-property (after anything-document-type-attribute activate)
3302 "Display type attributes' documentation as `anything-type-attributes' docstring."
3303 (when (eq (ad-get-arg 0) 'anything-type-attributes)
3304 (setq ad-return-value
3305 (concat ad-return-value "\n\n++++ Types currently defined ++++\n"
3306 (mapconcat (lambda (sym) (get sym 'anything-typeattrdoc))
3307 anything-types "\n")))))
3309 ;; (@* "Built-in plug-in: dummy")
3310 (defun anything-dummy-candidate (candidate source)
3311 "Use `anything-pattern' as CANDIDATE in SOURCE."
3312 ;; `source' is defined in filtered-candidate-transformer
3313 (list anything-pattern))
3315 (defun anything-compile-source--dummy (source)
3316 (if (assoc 'dummy source)
3317 (append source
3318 '((candidates "dummy")
3319 (accept-empty)
3320 (match identity)
3321 (filtered-candidate-transformer . anything-dummy-candidate)
3322 (disable-shortcuts)
3323 (volatile)))
3324 source))
3326 ;; (@* "Built-in plug-in: disable-shortcuts")
3327 (defvar anything-orig-enable-shortcuts nil)
3328 (defun anything-save-enable-shortcuts ()
3329 (anything-once
3330 (lambda ()
3331 (setq anything-orig-enable-shortcuts anything-enable-shortcuts
3332 anything-enable-shortcuts nil))))
3334 (defun anything-compile-source--disable-shortcuts (source)
3335 (if (assoc 'disable-shortcuts source)
3336 (append `((init ,@(anything-mklist (assoc-default 'init source))
3337 anything-save-enable-shortcuts)
3338 (resume ,@(anything-mklist (assoc-default 'resume source))
3339 anything-save-enable-shortcuts)
3340 (cleanup ,@(anything-mklist (assoc-default 'cleanup source))
3341 (lambda () (setq anything-enable-shortcuts
3342 anything-orig-enable-shortcuts))))
3343 source)
3344 source))
3346 ;; (@* "Built-in plug-in: candidates-in-buffer")
3347 (defun anything-candidates-in-buffer ()
3348 "Get candidates from the candidates buffer according to `anything-pattern'.
3350 BUFFER is `anything-candidate-buffer' by default. Each
3351 candidate must be placed in one line. This function is meant to
3352 be used in candidates-in-buffer or candidates attribute of an
3353 anything source. Especially fast for many (1000+) candidates.
3356 '((name . \"many files\")
3357 (init . (lambda () (with-current-buffer (anything-candidate-buffer 'local)
3358 (insert-many-filenames))))
3359 (search re-search-forward) ; optional
3360 (candidates-in-buffer)
3361 (type . file))
3363 +===============================================================+
3364 | The new way of making and narrowing candidates: Using buffers |
3365 +===============================================================+
3367 By default, `anything' makes candidates by evaluating the
3368 candidates function, then narrows them by `string-match' for each
3369 candidate.
3371 But this way is very slow for many candidates. The new way is
3372 storing all candidates in a buffer and narrowing them by
3373 `re-search-forward'. Search function is customizable by search
3374 attribute. The important point is that buffer processing is MUCH
3375 FASTER than string list processing and is the Emacs way.
3377 The init function writes all candidates to a newly-created
3378 candidate buffer. The candidates buffer is created or specified
3379 by `anything-candidate-buffer'. Candidates are stored in a line.
3381 The candidates function narrows all candidates, IOW creates a
3382 subset of candidates dynamically. It is the task of
3383 `anything-candidates-in-buffer'. As long as
3384 `anything-candidate-buffer' is used,`(candidates-in-buffer)' is
3385 sufficient in most cases.
3387 Note that `(candidates-in-buffer)' is shortcut of three attributes:
3388 (candidates . anything-candidates-in-buffer)
3389 (volatile)
3390 (match identity)
3391 And `(candidates-in-buffer . func)' is shortcut of three attributes:
3392 (candidates . func)
3393 (volatile)
3394 (match identity)
3395 The expansion is performed in `anything-get-sources'.
3397 The candidates-in-buffer attribute implies the volatile attribute.
3398 The volatile attribute is needed because `anything-candidates-in-buffer'
3399 creates candidates dynamically and need to be called everytime
3400 `anything-pattern' changes.
3402 Because `anything-candidates-in-buffer' plays the role of `match' attribute
3403 function, specifying `(match identity)' makes the source slightly faster.
3405 To customize `anything-candidates-in-buffer' behavior, use search,
3406 get-line and search-from-end attributes. See also `anything-sources' docstring."
3407 (declare (special source))
3408 (anything-candidates-in-buffer-1
3409 (anything-candidate-buffer)
3410 anything-pattern
3411 (or (assoc-default 'get-line source)
3412 #'buffer-substring-no-properties)
3413 ;; use external variable `source'.
3414 (or (assoc-default 'search source)
3415 (if (assoc 'search-from-end source)
3416 '(anything-candidates-in-buffer-search-from-end)
3417 '(anything-candidates-in-buffer-search-from-start)))
3418 (anything-candidate-number-limit source)
3419 (assoc 'search-from-end source)))
3421 (defun anything-candidates-in-buffer-search-from-start (pattern)
3422 "Search PATTERN with `re-search-forward' with bound and noerror args."
3423 (re-search-forward pattern nil t))
3425 (defun anything-candidates-in-buffer-search-from-end (pattern)
3426 "Search PATTERN with `re-search-backward' with bound and noerror args."
3427 (re-search-backward pattern nil t))
3429 (defun anything-candidates-in-buffer-1 (buffer pattern get-line-fn
3430 search-fns limit search-from-end)
3431 ;; buffer == nil when candidates buffer does not exist.
3432 (when buffer
3433 (with-current-buffer buffer
3434 (let ((start-point (if search-from-end (point-max) (point-min)))
3435 (endp (if search-from-end #'bobp #'eobp)))
3436 (goto-char (1- start-point))
3437 (if (string= pattern "")
3438 (anything-initial-candidates-from-candidate-buffer
3439 endp get-line-fn limit search-from-end)
3440 (anything-search-from-candidate-buffer
3441 pattern get-line-fn search-fns limit search-from-end
3442 start-point endp))))))
3444 (defun anything-point-is-moved (proc)
3445 "If point is moved after executing PROC, return t, otherwise nil."
3446 (/= (point) (progn (funcall proc) (point))))
3448 (defun anything-search-from-candidate-buffer (pattern get-line-fn search-fns
3449 limit search-from-end
3450 start-point endp)
3451 (let (buffer-read-only
3452 matches exit newmatches)
3453 (anything-search-from-candidate-buffer-internal
3454 (lambda ()
3455 (clrhash anything-cib-hash)
3456 (dolist (searcher search-fns)
3457 (goto-char start-point)
3458 (setq newmatches nil)
3459 (loop with item-count = 0
3460 while (funcall searcher pattern)
3461 for cand = (funcall get-line-fn (point-at-bol) (point-at-eol))
3462 do (anything-accumulate-candidates-internal
3463 cand newmatches anything-cib-hash item-count limit)
3464 unless (anything-point-is-moved
3465 (lambda ()
3466 (if search-from-end
3467 (goto-char (1- (point-at-bol)))
3468 (forward-line 1))))
3469 return nil)
3470 (setq matches (append matches (nreverse newmatches)))
3471 (if exit (return)))
3472 (delq nil matches)))))
3474 (defun anything-initial-candidates-from-candidate-buffer (endp get-line-fn limit search-from-end)
3475 (delq nil (loop with next-line-fn =
3476 (if search-from-end
3477 (lambda (x) (goto-char (max (1- (point-at-bol)) 1)))
3478 #'forward-line)
3479 until (funcall endp)
3480 for i from 1 to limit
3481 collect (funcall get-line-fn (point-at-bol) (point-at-eol))
3482 do (funcall next-line-fn 1))))
3484 (defun anything-search-from-candidate-buffer-internal (search-fn)
3485 (goto-char (point-min))
3486 (insert "\n")
3487 (goto-char (point-max))
3488 (insert "\n")
3489 (unwind-protect
3490 (funcall search-fn)
3491 (goto-char (point-min))
3492 (delete-char 1)
3493 (goto-char (1- (point-max)))
3494 (delete-char 1)
3496 (set-buffer-modified-p nil)))
3498 (defun anything-candidate-buffer (&optional create-or-buffer)
3499 "Register and return a buffer containing candidates of current source.
3500 `anything-candidate-buffer' searches buffer-local candidates buffer first,
3501 then global candidates buffer.
3503 Acceptable values of CREATE-OR-BUFFER:
3505 - nil (omit)
3506 Only return the candidates buffer.
3507 - a buffer
3508 Register a buffer as a candidates buffer.
3509 - 'global
3510 Create a new global candidates buffer,
3511 named \" *anything candidates:SOURCE*\".
3512 - other non-nil value
3513 Create a new local candidates buffer,
3514 named \" *anything candidates:SOURCE*ANYTHING-CURRENT-BUFFER\"."
3515 (let* ((global-bname (format " *anything candidates:%s*"
3516 anything-source-name))
3517 (local-bname (format " *anything candidates:%s*%s"
3518 anything-source-name
3519 (buffer-name anything-current-buffer))))
3520 (flet ((register-func ()
3521 (setq anything-candidate-buffer-alist
3522 (cons (cons anything-source-name create-or-buffer)
3523 (delete (assoc anything-source-name
3524 anything-candidate-buffer-alist)
3525 anything-candidate-buffer-alist))))
3526 (kill-buffers-func ()
3527 (loop for b in (buffer-list)
3528 if (string-match (format "^%s" (regexp-quote global-bname))
3529 (buffer-name b))
3530 do (kill-buffer b)))
3531 (create-func ()
3532 (with-current-buffer
3533 (get-buffer-create (if (eq create-or-buffer 'global)
3534 global-bname
3535 local-bname))
3536 (buffer-disable-undo)
3537 (erase-buffer)
3538 (font-lock-mode -1)))
3539 (return-func ()
3540 (or (get-buffer local-bname)
3541 (get-buffer global-bname)
3542 (anything-aif (assoc-default anything-source-name
3543 anything-candidate-buffer-alist)
3544 (and (buffer-live-p it) it)))))
3545 (when create-or-buffer
3546 (register-func)
3547 (unless (bufferp create-or-buffer)
3548 (and (eq create-or-buffer 'global) (kill-buffers-func))
3549 (create-func)))
3550 (return-func))))
3552 (defun anything-compile-source--candidates-in-buffer (source)
3553 (anything-aif (assoc 'candidates-in-buffer source)
3554 (append source
3555 `((candidates . ,(or (cdr it) 'anything-candidates-in-buffer))
3556 (volatile) (match identity)))
3557 source))
3560 ;; (@* "Utility: resplit anything window")
3561 (defun anything-toggle-resplit-window ()
3562 "Toggle resplit anything window, vertically or horizontally."
3563 (interactive)
3564 (with-anything-window
3565 (let ((before-height (window-height)))
3566 (delete-window)
3567 (set-window-buffer
3568 (select-window (if (= (window-height) before-height)
3569 (prog1
3570 (split-window-vertically)
3571 (setq anything-split-window-state 'vertical))
3572 (setq anything-split-window-state 'horizontal)
3573 (split-window-horizontally)))
3574 anything-buffer))))
3576 ;; (@* "Utility: Resize anything window.")
3577 (defun anything-enlarge-window-1 (n)
3578 "Enlarge or narrow anything window.
3579 If N is positive enlarge, if negative narrow."
3580 (unless anything-samewindow
3581 (let ((horizontal-p (eq anything-split-window-state 'horizontal)))
3582 (with-anything-window
3583 (enlarge-window n horizontal-p)))))
3585 (defun anything-narrow-window ()
3586 "Narrow anything window."
3587 (interactive)
3588 (anything-enlarge-window-1 -1))
3590 (defun anything-enlarge-window ()
3591 "Enlarge anything window."
3592 (interactive)
3593 (anything-enlarge-window-1 1))
3595 ;; (@* "Utility: select another action by key")
3596 (defun anything-select-nth-action (n)
3597 "Select the N nth action for the currently selected candidate."
3598 (setq anything-saved-selection (anything-get-selection))
3599 (unless anything-saved-selection
3600 (error "Nothing is selected"))
3601 (setq anything-saved-action (anything-get-nth-action n (anything-get-action)))
3602 (anything-exit-minibuffer))
3604 (defun anything-get-nth-action (n action)
3605 (cond ((and (zerop n) (functionp action))
3606 action)
3607 ((listp action)
3608 (or (cdr (elt action n))
3609 (error "No such action")))
3610 ((and (functionp action) (< 0 n))
3611 (error "Sole action"))
3613 (error "Error in `anything-select-nth-action'"))))
3615 (defun anything-select-2nd-action ()
3616 "Select the 2nd action for the currently selected candidate."
3617 (interactive)
3618 (anything-select-nth-action 1))
3620 (defun anything-select-3rd-action ()
3621 "Select the 3rd action for the currently selected candidate."
3622 (interactive)
3623 (anything-select-nth-action 2))
3625 (defun anything-select-4th-action ()
3626 "Select the 4th action for the currently selected candidate."
3627 (interactive)
3628 (anything-select-nth-action 3))
3630 (defun anything-select-2nd-action-or-end-of-line ()
3631 "Select the 2nd action for the currently selected candidate.
3632 This happen when point is at the end of minibuffer.
3633 Otherwise goto the end of minibuffer."
3634 (interactive)
3635 (if (eolp)
3636 (anything-select-nth-action 1)
3637 (end-of-line)))
3639 ;; (@* "Utility: Persistent Action")
3640 (defmacro with-anything-display-same-window (&rest body)
3641 "Execute BODY in the window used for persistent action.
3642 Make `pop-to-buffer' and `display-buffer' display in the same window."
3643 (declare (indent 0) (debug t))
3644 `(let ((display-buffer-function 'anything-persistent-action-display-buffer))
3645 ,@body))
3647 (defvar anything-persistent-action-display-window nil)
3648 (defun anything-initialize-persistent-action ()
3649 (set (make-local-variable 'anything-persistent-action-display-window) nil))
3651 (defun* anything-execute-persistent-action (&optional (attr 'persistent-action) onewindow)
3652 "Perform the associated action ATTR without quitting anything.
3653 ATTR default is 'persistent-action', but it can be anything else.
3654 In this case you have to add this new attribute to your source.
3655 When `anything-samewindow' and ONEWINDOW are non--nil,
3656 the anything window is never split in persistent action."
3657 (interactive)
3658 (anything-log "executing persistent-action")
3659 (with-anything-window
3660 (save-selected-window
3661 (anything-select-persistent-action-window onewindow)
3662 (anything-log-eval (current-buffer))
3663 (let ((anything-in-persistent-action t))
3664 (with-anything-display-same-window
3665 (anything-execute-selection-action
3667 (or (assoc-default attr (anything-get-current-source))
3668 (anything-get-action))
3670 (anything-log-run-hook 'anything-after-persistent-action-hook))))))
3673 (defun anything-persistent-action-display-window (&optional onewindow)
3674 "Return the window that will be used for presistent action.
3675 If ONEWINDOW is non--nil window will not be splitted in persistent action
3676 if `anything-samewindow' is non--nil also."
3677 (with-anything-window
3678 (setq anything-persistent-action-display-window
3679 (cond ((window-live-p anything-persistent-action-display-window)
3680 anything-persistent-action-display-window)
3681 ((and anything-samewindow (one-window-p t) (not onewindow))
3682 (split-window))
3683 ((get-buffer-window anything-current-buffer))
3685 (next-window (selected-window) 1))))))
3687 (defun anything-select-persistent-action-window (&optional onewindow)
3688 "Select the window that will be used for persistent action.
3689 See `anything-persistent-action-display-window' for how to use ONEWINDOW."
3690 (select-window (get-buffer-window (anything-buffer-get)))
3691 (select-window
3692 (setq minibuffer-scroll-window
3693 (anything-persistent-action-display-window onewindow))))
3695 (defun anything-persistent-action-display-buffer (buf &optional not-this-window)
3696 "Make `pop-to-buffer' and `display-buffer' display in the same window.
3697 If `anything-persistent-action-use-special-display' is non-nil and
3698 BUF is to be displayed by `special-display-function', use it.
3699 Otherwise ignores `special-display-buffer-names' and `special-display-regexps'.
3700 Argument NOT-THIS-WINDOW if present will be used as
3701 second argument of `display-buffer'."
3702 (let* ((name (buffer-name buf))
3703 display-buffer-function pop-up-windows pop-up-frames
3704 (same-window-regexps
3705 (unless (and anything-persistent-action-use-special-display
3706 (or (member name
3707 (mapcar (lambda (x) (or (car-safe x) x))
3708 special-display-buffer-names))
3709 (remove-if-not
3710 (lambda (x) (string-match (or (car-safe x) x) name))
3711 special-display-regexps)))
3712 '("."))))
3713 (display-buffer buf not-this-window)))
3715 ;; scroll-other-window(-down)? for persistent-action
3716 (defun anything-scroll-other-window-base (command)
3717 (with-selected-window (anything-persistent-action-display-window)
3718 (funcall command anything-scroll-amount)))
3720 (defun anything-scroll-other-window ()
3721 "Scroll other window (not *Anything* window) upward."
3722 (interactive)
3723 (anything-scroll-other-window-base 'scroll-up))
3725 (defun anything-scroll-other-window-down ()
3726 "Scroll other window (not *Anything* window) downward."
3727 (interactive)
3728 (anything-scroll-other-window-base 'scroll-down))
3731 ;; (@* "Utility: Visible Mark")
3732 (defface anything-visible-mark
3733 '((((min-colors 88) (background dark))
3734 (:background "green1" :foreground "black"))
3735 (((background dark)) (:background "green" :foreground "black"))
3736 (((min-colors 88)) (:background "green1"))
3737 (t (:background "green")))
3738 "Face for visible mark."
3739 :group 'anything)
3741 (defvar anything-visible-mark-face 'anything-visible-mark)
3742 (defvar anything-visible-mark-overlays nil)
3744 (defun anything-clear-visible-mark ()
3745 (with-current-buffer (anything-buffer-get)
3746 (mapc 'delete-overlay anything-visible-mark-overlays)
3747 (set (make-local-variable 'anything-visible-mark-overlays) nil)))
3748 (add-hook 'anything-after-initialize-hook 'anything-clear-visible-mark)
3750 (defvar anything-marked-candidates nil
3751 "Marked candadates. List of \(source . real\) pair.")
3753 (defun anything-this-visible-mark ()
3754 (loop for o in anything-visible-mark-overlays
3755 when (equal (point-at-bol) (overlay-start o))
3756 return o))
3758 (defun anything-delete-visible-mark (overlay)
3759 (setq anything-marked-candidates
3760 (remove
3761 (cons (anything-get-current-source) (anything-get-selection))
3762 anything-marked-candidates))
3763 (delete-overlay overlay)
3764 (setq anything-visible-mark-overlays
3765 (delq overlay anything-visible-mark-overlays)))
3767 (defun anything-make-visible-mark ()
3768 (let ((o (make-overlay (point-at-bol) (1+ (point-at-eol)))))
3769 (overlay-put o 'face anything-visible-mark-face)
3770 (overlay-put o 'source (assoc-default 'name (anything-get-current-source)))
3771 (overlay-put o 'string (buffer-substring (overlay-start o) (overlay-end o)))
3772 (overlay-put o 'real (anything-get-selection))
3773 (add-to-list 'anything-visible-mark-overlays o))
3774 (push (cons (anything-get-current-source) (anything-get-selection))
3775 anything-marked-candidates))
3777 (defun anything-toggle-visible-mark ()
3778 "Toggle anything visible mark at point."
3779 (interactive)
3780 (with-anything-window
3781 (anything-aif (anything-this-visible-mark)
3782 (anything-delete-visible-mark it)
3783 (anything-make-visible-mark))
3784 (anything-next-line)))
3786 (defun anything-display-all-visible-marks ()
3787 "Show all `anything' visible marks strings."
3788 (interactive)
3789 (with-anything-window
3790 (lexical-let ((overlays (reverse anything-visible-mark-overlays)))
3791 (anything-run-after-quit
3792 (lambda ()
3793 (with-output-to-temp-buffer "*anything visible marks*"
3794 (dolist (o overlays) (princ (overlay-get o 'string)))))))))
3796 (defun anything-marked-candidates ()
3797 "Return marked candidates of current source if any.
3798 Otherwise one element list of current selection.
3800 It is analogous to `dired-get-marked-files'."
3801 (with-current-buffer (anything-buffer-get)
3802 (let ((cands
3803 (if anything-marked-candidates
3804 (loop with current-src = (anything-get-current-source)
3805 for (source . real) in (reverse anything-marked-candidates)
3806 when (equal current-src source)
3807 collect (anything-coerce-selection real source))
3808 (list (anything-get-selection)))))
3809 (anything-log-eval cands)
3810 cands)))
3812 (defun anything-reset-marked-candidates ()
3813 (with-current-buffer (anything-buffer-get)
3814 (set (make-local-variable 'anything-marked-candidates) nil)))
3816 (add-hook 'anything-after-initialize-hook 'anything-reset-marked-candidates)
3817 ;; (add-hook 'anything-after-action-hook 'anything-reset-marked-candidates)
3819 (defun anything-current-source-name= (name)
3820 (save-excursion
3821 (goto-char (anything-get-previous-header-pos))
3822 (equal name (anything-current-line-contents))))
3824 (defun anything-revive-visible-mark ()
3825 "Restore marked candidates when anything update display."
3826 (with-current-buffer anything-buffer
3827 (dolist (o anything-visible-mark-overlays)
3828 (goto-char (point-min))
3829 (while (and (search-forward (overlay-get o 'string) nil t)
3830 (anything-current-source-name= (overlay-get o 'source)))
3831 ;; Calculate real value of candidate.
3832 ;; It can be nil if candidate have only a display value.
3833 (let ((real (get-text-property (point-at-bol 0) 'anything-realvalue)))
3834 (if real
3835 ;; Check if real value of current candidate is the same
3836 ;; that the one stored in overlay.
3837 (and (string= (overlay-get o 'real) real)
3838 (move-overlay o (point-at-bol 0) (1+ (point-at-eol 0))))
3839 (move-overlay o (point-at-bol 0) (1+ (point-at-eol 0)))))))))
3840 (add-hook 'anything-update-hook 'anything-revive-visible-mark)
3842 (defun anything-next-point-in-list (curpos points &optional prev)
3843 (cond
3844 ;; rule out special cases
3845 ((null points) curpos)
3846 ((and prev (< curpos (car points))) curpos)
3847 ((< (car (last points)) curpos)
3848 (if prev (car (last points)) curpos))
3850 (nth (if prev
3851 (loop for pt in points
3852 for i from 0
3853 if (<= curpos pt)
3854 return (1- i))
3855 (loop for pt in points
3856 for i from 0
3857 if (< curpos pt)
3858 return i))
3859 points))))
3861 (defun anything-next-visible-mark (&optional prev)
3862 "Move next anything visible mark.
3863 If PREV is non-nil move to precedent."
3864 (interactive)
3865 (with-anything-window
3866 (ignore-errors
3867 (goto-char (anything-next-point-in-list
3868 (point)
3869 (sort (mapcar 'overlay-start anything-visible-mark-overlays) '<)
3870 prev)))
3871 (anything-mark-current-line)))
3873 (defun anything-prev-visible-mark ()
3874 "Move previous anything visible mark."
3875 (interactive)
3876 (anything-next-visible-mark t))
3878 ;; (@* "Utility: Selection Paste")
3879 (defun anything-yank-selection ()
3880 "Set minibuffer contents to current selection."
3881 (interactive)
3882 (anything-set-pattern (anything-get-selection nil t)))
3884 (defun anything-kill-selection-and-quit ()
3885 "Store current selection to kill ring.
3886 You can paste it by typing \\[yank]."
3887 (interactive)
3888 (anything-run-after-quit
3889 (lambda (sel)
3890 (kill-new sel)
3891 (message "Killed: %s" sel))
3892 (anything-get-selection nil t)))
3895 ;; (@* "Utility: Automatical execution of persistent-action")
3896 (add-to-list 'minor-mode-alist '(anything-follow-mode " AFollow"))
3897 (defun anything-follow-mode ()
3898 "If this mode is on, persistent action is executed everytime the cursor is moved."
3899 (interactive)
3900 (with-current-buffer anything-buffer
3901 (setq anything-follow-mode (not anything-follow-mode))
3902 (message "anything-follow-mode is %s"
3903 (if anything-follow-mode "enabled" "disabled"))))
3905 (defun anything-follow-execute-persistent-action-maybe ()
3906 "Execute persistent action in mode `anything-follow-mode'.
3907 This happen after `anything-input-idle-delay' secs."
3908 (and (not (get-buffer-window anything-action-buffer 'visible))
3909 (buffer-local-value 'anything-follow-mode
3910 (get-buffer-create anything-buffer))
3911 (sit-for (and anything-input-idle-delay
3912 (max anything-input-idle-delay 0.1)))
3913 (anything-window)
3914 (anything-get-selection)
3915 (save-excursion
3916 (anything-execute-persistent-action))))
3919 ;; (@* "Utility: Migrate `anything-sources' to my-anything command")
3920 (defun anything-migrate-sources ()
3921 "Help to migrate to new `anything' way."
3922 (interactive)
3923 (with-current-buffer (get-buffer-create "*anything migrate*")
3924 (erase-buffer)
3925 (insert (format "\
3926 Setting `anything-sources' directly is not good because
3927 `anything' is not for one command. For now, interactive use of
3928 `anything' (M-x anything) is only for demonstration purpose.
3929 So you should define commands calling `anything'.
3930 I help you to migrate to the new way.
3932 The code below is automatically generated from current
3933 `anything-sources' value. You can use the `my-anything' command
3934 now!
3936 Copy and paste it to your .emacs. Then substitute `my-anything'
3937 for `anything' bindings in all `define-key', `local-set-key' and
3938 `global-set-key' calls.
3940 \(defun my-anything ()
3941 \"Anything command for you.
3943 It is automatically generated by `anything-migrate-sources'.\"
3944 (interactive)
3945 (anything-other-buffer
3947 \"*my-anything*\"))
3948 " anything-sources))
3949 (eval-last-sexp nil)
3950 (substitute-key-definition 'anything 'my-anything global-map)
3951 (pop-to-buffer (current-buffer))))
3954 ;; (@* "Compatibility")
3956 ;; Copied assoc-default from XEmacs version 21.5.12
3957 (unless (fboundp 'assoc-default)
3958 (defun assoc-default (key alist &optional test default)
3959 "Find object KEY in a pseudo-alist ALIST.
3960 ALIST is a list of conses or objects. Each element (or the element's car,
3961 if it is a cons) is compared with KEY by evaluating (TEST (car elt) KEY).
3962 If that is non-nil, the element matches;
3963 then `assoc-default' returns the element's cdr, if it is a cons,
3964 or DEFAULT if the element is not a cons.
3966 If no element matches, the value is nil.
3967 If TEST is omitted or nil, `equal' is used."
3968 (let (found (tail alist) value)
3969 (while (and tail (not found))
3970 (let ((elt (car tail)))
3971 (when (funcall (or test 'equal) (if (consp elt) (car elt) elt) key)
3972 (setq found t value (if (consp elt) (cdr elt) default))))
3973 (setq tail (cdr tail)))
3974 value)))
3976 ;; Function not available in XEmacs,
3977 (unless (fboundp 'minibuffer-contents)
3978 (defun minibuffer-contents ()
3979 "Return the user input in a minbuffer as a string.
3980 The current buffer must be a minibuffer."
3981 (field-string (point-max)))
3983 (defun delete-minibuffer-contents ()
3984 "Delete all user input in a minibuffer.
3985 The current buffer must be a minibuffer."
3986 (delete-field (point-max))))
3988 ;; Function not available in older Emacs (<= 22.1).
3989 (unless (fboundp 'buffer-chars-modified-tick)
3990 (defun buffer-chars-modified-tick (&optional buffer)
3991 "Return BUFFER's character-change tick counter.
3992 Each buffer has a character-change tick counter, which is set to the
3993 value of the buffer's tick counter (see `buffer-modified-tick'), each
3994 time text in that buffer is inserted or deleted. By comparing the
3995 values returned by two individual calls of `buffer-chars-modified-tick',
3996 you can tell whether a character change occurred in that buffer in
3997 between these calls. No argument or nil as argument means use current
3998 buffer as BUFFER."
3999 (with-current-buffer (or buffer (current-buffer))
4000 (if (listp buffer-undo-list)
4001 (length buffer-undo-list)
4002 (buffer-modified-tick)))))
4005 ;; (@* "CUA workaround")
4006 (defadvice cua-delete-region (around anything-avoid-cua activate)
4007 (ignore-errors ad-do-it))
4009 (defadvice copy-region-as-kill (around anything-avoid-cua activate)
4010 (if cua-mode
4011 (ignore-errors ad-do-it)
4012 ad-do-it))
4014 ;;(@* "Attribute Documentation")
4015 (defun anything-describe-anything-attribute (anything-attribute)
4016 "Display the full documentation of ANYTHING-ATTRIBUTE.
4017 ANYTHING-ATTRIBUTE should be a symbol."
4018 (interactive (list (intern
4019 (completing-read
4020 "Describe anything attribute: "
4021 (mapcar 'symbol-name anything-additional-attributes)
4022 nil t))))
4023 (with-output-to-temp-buffer "*Help*"
4024 (princ (get anything-attribute 'anything-attrdoc))))
4026 (anything-document-attribute 'name "mandatory"
4027 " The name of the source. It is also the heading which appears
4028 above the list of matches from the source. Must be unique.")
4030 (anything-document-attribute 'header-name "optional"
4031 " A function returning the display string of the header. Its
4032 argument is the name of the source. This attribute is useful to
4033 add an additional information with the source name.")
4035 (anything-document-attribute 'candidates "mandatory if candidates-in-buffer attribute is not provided"
4036 " Specifies how to retrieve candidates from the source. It can
4037 either be a variable name, a function called with no parameters
4038 or the actual list of candidates.
4040 The list must be a list whose members are strings, symbols
4041 or (DISPLAY . REAL) pairs.
4043 In case of (DISPLAY . REAL) pairs, the DISPLAY string is shown
4044 in the Anything buffer, but the REAL one is used as action
4045 argument when the candidate is selected. This allows a more
4046 readable presentation for candidates which would otherwise be,
4047 for example, too long or have a common part shared with other
4048 candidates which can be safely replaced with an abbreviated
4049 string for display purposes.
4051 Note that if the (DISPLAY . REAL) form is used then pattern
4052 matching is done on the displayed string, not on the real
4053 value.
4055 If the candidates have to be retrieved asynchronously (for
4056 example, by an external command which takes a while to run)
4057 then the function should start the external command
4058 asynchronously and return the associated process object.
4059 Anything will take care of managing the process (receiving the
4060 output from it, killing it if necessary, etc.). The process
4061 should return candidates matching the current pattern (see
4062 variable `anything-pattern'.)
4064 Note that currently results from asynchronous sources appear
4065 last in the anything buffer regardless of their position in
4066 `anything-sources'.")
4068 (anything-document-attribute 'action "mandatory if type attribute is not provided"
4069 " It is a list of (DISPLAY . FUNCTION) pairs or FUNCTION.
4070 FUNCTION is called with one parameter: the selected candidate.
4072 An action other than the default can be chosen from this list
4073 of actions for the currently selected candidate (by default
4074 with TAB). The DISPLAY string is shown in the completions
4075 buffer and the FUNCTION is invoked when an action is
4076 selected. The first action of the list is the default.")
4078 (anything-document-attribute 'coerce "optional"
4079 " It's a function called with one argument: the selected candidate.
4081 This function is intended for type convertion.
4082 In normal case, the selected candidate (string) is passed to action function.
4083 If coerce function is specified, it is called just before action function.
4085 Example: converting string to symbol
4086 (coerce . intern)")
4088 (anything-document-attribute 'type "optional if action attribute is provided"
4089 " Indicates the type of the items the source returns.
4091 Merge attributes not specified in the source itself from
4092 `anything-type-attributes'.
4094 This attribute is implemented by plug-in.")
4096 (anything-document-attribute 'init "optional"
4097 " Function called with no parameters when anything is started. It
4098 is useful for collecting current state information which can be
4099 used to create the list of candidates later.
4101 For example, if a source needs to work with the current
4102 directory then it can store its value here, because later
4103 anything does its job in the minibuffer and in the
4104 `anything-buffer' and the current directory can be different
4105 there.")
4107 (anything-document-attribute 'delayed-init "optional"
4108 " Function called with no parameters before candidate function is
4109 called. It is similar with `init' attribute, but its
4110 evaluation is deferred. It is useful to combine with ")
4112 (anything-document-attribute 'match "optional"
4113 " List of functions called with one parameter: a candidate. The
4114 function should return non-nil if the candidate matches the
4115 current pattern (see variable `anything-pattern').
4117 This attribute allows the source to override the default
4118 pattern matching based on `string-match'. It can be used, for
4119 example, to implement a source for file names and do the
4120 pattern matching on the basename of files, since it's more
4121 likely one is typing part of the basename when searching for a
4122 file, instead of some string anywhere else in its path.
4124 If the list contains more than one function then the list of
4125 matching candidates from the source is constructed by appending
4126 the results after invoking the first function on all the
4127 potential candidates, then the next function, and so on. The
4128 matching candidates supplied by the first function appear first
4129 in the list of results and then results from the other
4130 functions, respectively.
4132 This attribute has no effect for asynchronous sources (see
4133 attribute `candidates'), since they perform pattern matching
4134 themselves.")
4136 (anything-document-attribute 'candidate-transformer "optional"
4137 " It's a function or a list of functions called with one argument
4138 when the completion list from the source is built. The argument
4139 is the list of candidates retrieved from the source. The
4140 function should return a transformed list of candidates which
4141 will be used for the actual completion. If it is a list of
4142 functions, it calls each function sequentially.
4144 This can be used to transform or remove items from the list of
4145 candidates.
4147 Note that `candidates' is run already, so the given transformer
4148 function should also be able to handle candidates with (DISPLAY
4149 . REAL) format.")
4151 (anything-document-attribute 'filtered-candidate-transformer "optional"
4152 " It has the same format as `candidate-transformer', except the
4153 function is called with two parameters: the candidate list and
4154 the source.
4156 This transformer is run on the candidate list which is already
4157 filtered by the current pattern. While `candidate-transformer'
4158 is run only once, it is run every time the input pattern is
4159 changed.
4161 It can be used to transform the candidate list dynamically, for
4162 example, based on the current pattern.
4164 In some cases it may also be more efficent to perform candidate
4165 transformation here, instead of with `candidate-transformer'
4166 even if this transformation is done every time the pattern is
4167 changed. For example, if a candidate set is very large then
4168 `candidate-transformer' transforms every candidate while only
4169 some of them will actually be dislpayed due to the limit
4170 imposed by `anything-candidate-number-limit'.
4172 Note that `candidates' and `candidate-transformer' is run
4173 already, so the given transformer function should also be able
4174 to handle candidates with (DISPLAY . REAL) format.
4176 This option has no effect for asynchronous sources. (Not yet,
4177 at least.")
4179 (anything-document-attribute 'action-transformer "optional"
4180 " It's a function or a list of functions called with two
4181 arguments when the action list from the source is
4182 assembled. The first argument is the list of actions, the
4183 second is the current selection. If it is a list of functions,
4184 it calls each function sequentially.
4186 The function should return a transformed action list.
4188 This can be used to customize the list of actions based on the
4189 currently selected candidate.")
4191 (anything-document-attribute 'pattern-transformer "optional"
4192 " It's a function or a list of functions called with one argument
4193 before computing matches. Its argument is `anything-pattern'.
4194 Functions should return transformed `anything-pattern'.
4196 It is useful to change interpretation of `anything-pattern'.")
4198 (anything-document-attribute 'delayed "optional"
4199 " Candidates from the source are shown only if the user stops
4200 typing and is idle for `anything-idle-delay' seconds.")
4202 (anything-document-attribute 'volatile "optional"
4203 " Indicates the source assembles the candidate list dynamically,
4204 so it shouldn't be cached within a single Anything
4205 invocation. It is only applicable to synchronous sources,
4206 because asynchronous sources are not cached.")
4208 (anything-document-attribute 'requires-pattern "optional"
4209 " If present matches from the source are shown only if the
4210 pattern is not empty. Optionally, it can have an integer
4211 parameter specifying the required length of input which is
4212 useful in case of sources with lots of candidates.")
4214 (anything-document-attribute 'persistent-action "optional"
4215 " Function called with one parameter; the selected candidate.
4217 An action performed by `anything-execute-persistent-action'.
4218 If none, use the default action.")
4220 (anything-document-attribute 'candidates-in-buffer "optional"
4221 " Shortcut attribute for making and narrowing candidates using
4222 buffers. This newly-introduced attribute prevents us from
4223 forgetting to add volatile and match attributes.
4225 See docstring of `anything-candidates-in-buffer'.
4227 (candidates-in-buffer) is equivalent of three attributes:
4228 (candidates . anything-candidates-in-buffer)
4229 (volatile)
4230 (match identity)
4232 (candidates-in-buffer . candidates-function) is equivalent of:
4233 (candidates . candidates-function)
4234 (volatile)
4235 (match identity)
4237 This attribute is implemented by plug-in.")
4239 (anything-document-attribute 'search "optional"
4240 " List of functions like `re-search-forward' or `search-forward'.
4241 Buffer search function used by `anything-candidates-in-buffer'.
4242 By default, `anything-candidates-in-buffer' uses `re-search-forward'.
4243 This attribute is meant to be used with
4244 (candidates . anything-candidates-in-buffer) or
4245 (candidates-in-buffer) in short.")
4247 (anything-document-attribute 'search-from-end "optional"
4248 " Make `anything-candidates-in-buffer' search from the end of buffer.
4249 If this attribute is specified, `anything-candidates-in-buffer' uses
4250 `re-search-backward' instead.")
4252 (anything-document-attribute 'get-line "optional"
4253 " A function like `buffer-substring-no-properties' or `buffer-substring'.
4254 This function converts point of line-beginning and point of line-end,
4255 which represents a candidate computed by `anything-candidates-in-buffer'.
4256 By default, `anything-candidates-in-buffer' uses
4257 `buffer-substring-no-properties'.")
4259 (anything-document-attribute 'display-to-real "optional"
4260 " Function called with one parameter; the selected candidate.
4262 The function transforms the selected candidate, and the result
4263 is passed to the action function. The display-to-real
4264 attribute provides another way to pass other string than one
4265 shown in Anything buffer.
4267 Traditionally, it is possible to make candidates,
4268 candidate-transformer or filtered-candidate-transformer
4269 function return a list with (DISPLAY . REAL) pairs. But if REAL
4270 can be generated from DISPLAY, display-to-real is more
4271 convenient and faster.")
4273 (anything-document-attribute 'real-to-display "optional"
4274 " Function called with one parameter; the selected candidate.
4276 The inverse of display-to-real attribute.
4278 The function transforms the selected candidate, which is passed
4279 to the action function, for display. The real-to-display
4280 attribute provides the other way to pass other string than one
4281 shown in Anything buffer.
4283 Traditionally, it is possible to make candidates,
4284 candidate-transformer or filtered-candidate-transformer
4285 function return a list with (DISPLAY . REAL) pairs. But if
4286 DISPLAY can be generated from REAL, real-to-display is more
4287 convenient.
4289 Note that DISPLAY parts returned from candidates /
4290 candidate-transformer are IGNORED as the name `display-to-real'
4291 says.")
4293 (anything-document-attribute 'cleanup "optional"
4294 " Function called with no parameters when *anything* buffer is closed. It
4295 is useful for killing unneeded candidates buffer.
4297 Note that the function is executed BEFORE performing action.")
4299 (anything-document-attribute 'candidate-number-limit "optional"
4300 " Override `anything-candidate-number-limit' only for this source.")
4302 (anything-document-attribute 'accept-empty "optional"
4303 " Pass empty string \"\" to action function.")
4305 (anything-document-attribute 'disable-shortcuts "optional"
4306 " Disable `anything-enable-shortcuts' in current `anything' session.
4308 This attribute is implemented by plug-in.")
4310 (anything-document-attribute 'dummy "optional"
4311 " Set `anything-pattern' to candidate. If this attribute is
4312 specified, The candidates attribute is ignored.
4314 This attribute is implemented by plug-in.
4315 This plug-in implies disable-shortcuts plug-in.")
4317 (anything-document-attribute 'multiline "optional"
4318 " Enable to selection multiline candidates.")
4320 (anything-document-attribute 'update "optional"
4321 (substitute-command-keys
4322 " Function called with no parameters when \
4323 \\<anything-map>\\[anything-force-update] is pressed."))
4325 (anything-document-attribute 'mode-line "optional"
4326 " source local `anything-mode-line-string'. (included in `mode-line-format')
4327 It accepts also variable/function name.")
4329 (anything-document-attribute 'header-line "optional"
4330 " source local `header-line-format'.
4331 It accepts also variable/function name. ")
4333 (anything-document-attribute
4334 'resume "optional"
4335 " Function called with no parameters when `anything-resume' is started.")
4337 (anything-document-attribute 'keymap "optional"
4338 " Specific keymap for this source.
4339 It is useful to have a keymap per source when using more than one source.
4340 Otherwise, a keymap can be set per command with `anything' argument KEYMAP.
4341 NOTE: when a source have `anything-map' as keymap attr,
4342 the global value of `anything-map' will override the actual local one.")
4344 (anything-document-attribute 'help-message "optional"
4345 " Help message for this source.
4346 If not present, `anything-help-message' value will be used.")
4349 ;; (@* "Bug Report")
4350 (defvar anything-maintainer-mail-address "emacs-anything@googlegroups.com")
4352 (defvar anything-bug-report-salutation
4353 "Describe bug below, using a precise recipe.
4355 When I executed M-x ...
4357 How to send a bug report:
4358 1) Be sure to use the LATEST version of anything.el.
4359 2) Enable debugger. M-x toggle-debug-on-error or (setq debug-on-error t)
4360 3) Use Lisp version instead of compiled one: (load \"anything.el\")
4361 4) If you got an error, please paste *Backtrace* buffer.
4362 5) Type C-c C-c to send.")
4364 (defvar anything-no-dump-variables
4365 '(anything-candidate-buffer-alist
4366 anything-digit-overlays
4367 anything-help-message
4368 anything-candidate-cache
4370 "Variables not to dump in bug report.")
4372 (defun anything-dumped-variables-in-bug-report ()
4373 (let ((hash (make-hash-table)))
4374 (loop for var in (apropos-internal "anything-" 'boundp)
4375 for vname = (symbol-name var)
4376 unless (or (string-match "-map$" vname)
4377 (string-match "^anything-c-source-" vname)
4378 (string-match "-hash$" vname)
4379 (string-match "-face$" vname)
4380 (memq var anything-no-dump-variables))
4381 collect var)))
4383 (defun anything-send-bug-report ()
4384 "Send a bug report of anything.el."
4385 (interactive)
4386 (with-current-buffer (or anything-last-buffer
4387 (current-buffer))
4388 (reporter-submit-bug-report
4389 anything-maintainer-mail-address
4390 "anything.el"
4391 (anything-dumped-variables-in-bug-report)
4392 nil nil
4393 anything-bug-report-salutation)))
4395 (defun anything-send-bug-report-from-anything ()
4396 "Send a bug report of anything.el in anything session."
4397 (interactive)
4398 (anything-run-after-quit 'anything-send-bug-report))
4400 ;; Debugging function.
4401 (defun* anything-test-candidates
4402 (sources &optional (input "")
4403 (compile-source-functions
4404 anything-compile-source-functions-default))
4405 "Test helper function for anything.
4406 Given pseudo `anything-sources' and `anything-pattern', returns list like
4407 ((\"source name1\" (\"candidate1\" \"candidate2\"))
4408 (\"source name2\" (\"candidate3\" \"candidate4\")))"
4409 (let ((anything-test-mode t)
4410 anything-enable-shortcuts
4411 anything-candidate-cache
4412 (anything-compile-source-functions compile-source-functions)
4413 anything-before-initialize-hook
4414 anything-after-initialize-hook
4415 anything-update-hook
4416 anything-test-candidate-list)
4417 (get-buffer-create anything-buffer)
4418 (anything-initialize nil input sources)
4419 (anything-update)
4420 ;; test-mode spec: select 1st candidate!
4421 (with-current-buffer anything-buffer
4422 (forward-line 1)
4423 (anything-mark-current-line))
4424 (prog1
4425 anything-test-candidate-list
4426 (anything-cleanup))))
4429 ;; (@* "Unit Tests")
4430 ;; See developer-tools/unit-test-anything.el
4432 (provide 'anything)
4434 ;; Local Variables:
4435 ;; coding: utf-8
4436 ;; End:
4438 ;;; anything.el ends here