search

tam17aki / ace-isearch

A seamless bridge between isearch, ace-jump-mode, avy, and helm-swoop.
103 stars 10 forks source link

readme

ace-isearch MELPA MELPA Stable

Introduction

ace-isearch.el provides a minor mode that combines isearch, ace-jump-mode or avy and helm-swoop, swiper or consult-line.

The "default" behavior (ace-isearch-jump-based-on-one-char t) can be summarized as:

where L is the input string length during isearch. When L is 1, after a few seconds specified by ace-isearch-jump-delay, ace-jump-mode or avy will be invoked. Of course you can customize the above behaviour.

If (ace-isearch-jump-based-on-one-char nil), L=2 characters are required to invoke ace-jump-mode or avy after ace-isearch-jump-delay. This has the effect of doing regular isearch for L=1 and L=3 to 6, with the ability to switch to 2-character avy or ace-jump-mode (not yet supported) once ace-isearch-jump-delay has passed. Much easier to do than to write about :-)

Requirements

You must install these packages manually.

Installation

You can install ace-isearch.el from MELPA with package.el

 M-x package-install ace-isearch

Otherwise you can install it by el-get.

Basic Usage

ace-isearch-mode

Enable ace-isearch minor mode:

(ace-isearch-mode +1)

global-ace-isearch-mode

Enable global ace-isearch mode:

(global-ace-isearch-mode +1)

Customization

ace-isearch-function (Default:ace-jump-word-mode)

Specify the function name utilized in invoking ace-jump-mode or avy when 1-character jumping is enabled (ace-isearch-jump-based-on-one-char = t). You should specify ace-jump-word-mode, ace-jump-char-mode, avy-goto-word-1, avy-goto-subword-1, or avy-goto-char.

ace-isearch-2-function (Default:avy-goto-char-2)

Specify the function name utilized in invoking ace-jump-mode or avy when 2-character jumping is enabled (ace-isearch-jump-based-on-one-char = nil). Currently, only avy functions avy-goto-char-2, avy-goto-char-2-above and avy-goto-char-2-below are available.

ace-isearch-switch-function or ace-isearch-2-switch-function

You can switch the value of ace-isearch-function or ace-isearch-2-function interactively.

ace-isearch-use-jump (Default:t)

If this variable is set to nil, ace-jump-mode or avy are never invoked.

If set to t, it is always invoked if the length of isearch-string is equal to 1.

If set to printing-char, it is invoked only if you hit a printing character to search for as a first input. This prevents it from being invoked when repeating a one character search, yanking a character or calling isearch-delete-char leaving only one character.

ace-isearch-jump-based-on-one-char (Default:t)

If this variable is set to nil, 2-character jumping is used, with L=2 invoking ace-jump-mode or avy instead of L=1.

ace-isearch-jump-delay (Default：0.3)

Delay seconds for invoking ace-jump-mode or avy during isearch.

ace-isearch-func-delay (Default：0.0)

Delay seconds for invoking ace-isearch-function-from-isearch during isearch, which is described below.

ace-isearch-input-length (Default：6)

As default behaviour, when the input string length during isearch exceeds ace-isearch-input-length, the function specified by ace-isearch-function-from-isearch will be invoked.

ace-isearch-function-from-isearch (Default:helm-swoop-from-isearch)

Specify the function name invoked when the input string length during isearch exceeds ace-isearch-input-length. If swoop has been installed, swoop can be invoked:

(setq ace-isearch-function-from-isearch 'swoop-from-isearch)

In this case, the following setting would be better.

(define-key swoop-map (kbd "C-s") 'swoop-action-goto-line-next)
(define-key swoop-map (kbd "C-r") 'swoop-action-goto-line-prev)

Of course you can set this variable to helm-occur-from-isearch.

(setq ace-isearch-function-from-isearch 'helm-occur-from-isearch)

You can also set this variable to use swiper.

(setq ace-isearch-function-from-isearch 'ace-isearch-swiper-from-isearch)

Or you can set it to use consult-line.

(setq ace-isearch-function-from-isearch 'ace-isearch-consult-line-from-isearch)

ace-isearch-use-function-from-isearch (Default:t)

If you don't want to invoke ace-isearch-function-from-isearch, set this variable to nil.

ace-isearch-disable-isearch-function-from-isearch-message (Default:nil)

In the event that none of the supported libraries are available for ace-isearch-function-from-isearch, a message will issue explaining the situtation.

In order to disable the message, set this variable to t.

ace-isearch-fallback-function (Default:ace-isearch-helm-swoop-from-isearch)

This functionality is optional. When isearch fails and ace-isearch-use-fallback-function is non-nil, ace-isearch-fallback-function will be invoked as a fallback function.

You should specify the symbol name of function which uses isearch-string, the query string during isearch. For a trivial example, you can specify it as follows:

(defun my-fallback-function ()
  (message "Your isearch string is %s", isearch-string))

(setq ace-isearch-use-function-from-isearch t)
(setq ace-isearch-fallback-function 'my-fallback-function)

ace-isearch-use-fallback-function (Default:nil)

If this variable is set to non-nil, ace-isearch-fallback-function will be invoked when isearch fails.

ace-isearch-jump-during-isearch

With this function, ace-jump-mode will be invoked further during isearch, which enables to jump to the one of the isearch candidates. This helps to reduce many key repeats of C-s or C-r.

ace-isearch-pop-mark

You can invoke ace-jump-mode-pop-mark or avy-pop-mark in accordance with the current ace-isearch-function or ace-isearch-2-function. With this function, you can jump back to the last location of ace-jump-mode or avy.

ace-isearch-on-evil-mode (Default:nil)

If this variable is set to non-nil, you can invoke ace-jump-mode or avy even on evil-mode.

Sample Configuration

(require 'ace-isearch)
(global-ace-isearch-mode +1)

(custom-set-variables
 '(ace-isearch-input-length 7)
 '(ace-isearch-jump-delay 0.25)
 '(ace-isearch-function 'avy-goto-char)
 '(ace-isearch-use-jump 'printing-char))

(define-key isearch-mode-map (kbd "C-'") 'ace-isearch-jump-during-isearch)