深入探究Emacs中的imenu功能

一、什麼是imenu

imenu是Emacs中非常實用的一個功能，它可以根據不同模式下的語法規則，將當前打開的文件中的所有函數、變數、類等實體列出來，提供了一個快速跳轉的方式，使得開發者可以更加高效地瀏覽代碼。

具體來說，IMenu是Emacs編輯器預設的功能之一，它可以將當前編輯的程序代碼中所定義的函數、變數、Macro 和對應位置都列成一個選單，方便用戶選擇需要瀏覽的標記。

二、如何使用imenu

imenu可以通過M-x imenu快捷鍵來進入。在編寫程序時，可以隨時使用該快捷鍵，打開IMenu菜單，選擇需要進入的函數等實體，就可以直接跳轉到相應代碼的位置。如果在某個特定的模式下需要更改快捷鍵，可以使用以下代碼來進行更改：

(add-hook 'c-mode-common-hook
          (lambda ()
            (define-key c-mode-base-map (kbd "M-i") 'imenu)))

三、imenu的擴展功能

imenu並不僅僅只限於上面提到的基本功能。通過一些額外的設置，可以使imenu更加方便、實用。

1. 設置imenu默認支持的語言

(add-hook 'prog-mode-hook #'imenu-add-menubar-index)

這個設置會自動將當前編程模式下支持IMenu的功能加入到下拉菜單中。

2. imenu支持org-mode中的標題跳轉

(add-hook 'org-mode-hook #'org-imenu-setup)

這個設置會使得imenu支持跳轉org-mode中的標題。

3. 使用ivy-imenu增強imenu的搜索功能

(use-package ivy
  :ensure t
  :config
  (use-package swiper
    :ensure t
    :bind (("C-s" . swiper)
           ("C-r" . swiper)))
  :bind (("C-c C-r" . ivy-resume)
         ("" . ivy-resume))
  :config
  (setq ivy-use-virtual-buffers t
        ivy-count-format "%d/%d ")
  (ivy-mode 1))

(use-package ivy-hydra
  :ensure t)

(use-package counsel
  :ensure t
  :bind (("M-y" . counsel-yank-pop)
         ("C-x b" . counsel-switch-buffer)
         ("C-x C-f" . counsel-find-file)
         :map minibuffer-local-map
         ("C-r" . counsel-minibuffer-history)))
(use-package swiper
  :ensure t
  :bind (("C-s" . swiper)
         ("C-r" . swiper)))

(use-package ivy-rich
  :ensure t
  :config
  (ivy-rich-mode 1))
 
(use-package ivy-prescient
  :ensure t
  :config
  (ivy-prescient-mode 1)

(ivy-set-display-transformer 'ivy-switch-buffer 'ivy-rich-switch-buffer-transformer)
(ivy-set-display-transformer 'counsel-M-x 'ivy-rich-counsel-function-transformer)
(setq ivy-rich-path-style 'abbrev)
(setq ivy-rich-switch-buffer-align-virtual-buffer t)

這裡使用了ivy、counsel和swiper等包，通過這些包的引入，可以增加imenu中搜索功能的效率和靈活性。具體來說，ivy-imenu可以通過輸入關鍵字來進行快速的搜索，並且可以在搜索結果中即時預覽代碼。

四、常用的imenu命令

除了基本使用和一些擴展功能之外，imenu還有一些非常實用的命令，可以大大提高編程效率。下面列出一些常用的命令：

1. imenu-list-display

使用這個命令可以打開一個新的buffer，顯示當前文件中的所有變數、函數、類等實體。同時也支持通過快捷鍵選擇實體直接跳轉到對應代碼。

2. imenu-list-goto-entry

這個命令可以跳轉到imenu-list-buffer中當前游標所在的條目。

3. imenu-list-minor-mode

使用這個命令可以在模式欄中啟用/禁用imenu-list-mode，即將文件中的所有導航條目顯示在一個彈出窗口中，以方便侯選跳轉。

4. imenu-list-smart-toggle