Emacs中如何实现代码折叠效果？

Question

实现代码折叠或组织模式使用的循环类型等功能的最佳方法是什么？ elisp 中创建此类行为的最佳解决方案是什么？

编辑： 抱歉我没说清楚。 我想在 elisp 中编写一些东西，它的功能与代码折叠非常相似，或者实际上最像具有可扩展层次结构的 org-mode。 我想知道实现这种效果的最佳方法。 我想我听说 emacs 覆盖是一个很好的解决方案，但我不知道。

至于折叠，我只使用内置的设置选择性显示

编辑编号2：

感谢您的回答，但我认为我问了错误的问题，所以让我尝试更清楚地了解我想要做什么。 我想创建以下内容

当您将您的观点放在函数上并调用此 elisp 函数时，它将把函数定义从任何位置放置（我正在考虑为此使用 find-tag ）并将其展开在当前缓冲区中。 这个想法是，如果您必须跳转到不同的缓冲区来读取函数定义，我觉得它是到另一个文件的上下文切换。 所以我希望它的行为就像代码折叠一样，只是它从缓冲区外部提取代码。 这会带来一些问题，因为它实际上无法将代码粘贴到缓冲区中，或者如果有人保存，它将保存拉入的代码。 所以我想知道是否有一种方法可以在缓冲区内创建一个不属于缓冲区的区域。 我认为这是有道理的。

Answer 1

您可以使用隐藏-显示模式(hs-minor-mode)。 要仅针对当前缓冲区动态激活此模式，请输入 Mx hs-minor-mode RET

假设您有默认的键绑定：

• Cc @ CMh 将其全部折叠 ( hs-hide-all）。
• Cc @ Ch 隐藏当前块 (hs-hide-block)。 点（光标）必须位于块内。
• Cc @ Cs 显示当前块（hs-show-block）。 该点必须位于隐藏代码的 {...} 标记中。

Answer 2

emacs 通常不需要折叠，因为它有工具可以显式地实现人们在折叠代码时手动执行的操作。

大多数人通过简单的增量搜索就取得了巨大的成功。 看到某处提到的“foo”了吗？ 输入Csfoo，找到定义，按回车键，阅读它，然后按Cx Cx返回到你所在的地方。 简单而且非常有用。

大多数模式都支持 imenu。 Mximenu 将让您按名称跳转到函数定义（等）。 您还可以将其绑定到鼠标单击以获取功能菜单（或将其添加到菜单栏；有关更多详细信息，请参阅信息页面）。 它提供了哪个函数模式的数据，这将让您看到当前在模型行中的哪个函数。 （为什么你的函数这么长？）

还有speedbar，它以图形方式显示 imenu 信息（和其他内容）。

如果您想了解文件的概述，请尝试 Mxoccurr"。给定一个正则表达式，它将为当前缓冲区中的每个匹配项创建一个新缓冲区。您可以搜索“(defun”以获取当前文件实现的功能的概述。单击结果会将您移动到文件中的该位置。

所以无论如何，想想您真正想要实现的目标，Emacs 可能会实现它。不要与那些让你不断折叠和展开东西的不完美的工具作斗争。

Answer 3

另一种给猫剥皮的方法：

事实上，您不需要任何软件包或额外的配置
那。 只需转到任何源文件，输入

M-1 Cx $，奇迹就发生了！

和往常一样，这是白魔法：Cx $ 将带回您的代码。

我们可以使用 Emacs 的帮助系统来发现发生了什么：Ch k Cx $
告诉我们上面的组合键正在调用
set-selective-display，一种采用一个数字参数的函数
（M-1 前缀传递 1 作为该参数的值）并且，
毫不奇怪，将变量选择显示设置为值
那个论点。

来自 小型 emacs 魔法博客

只是为了完整性：M-3 Cx $会显示更深的嵌套代码等等。

FWIW我今天根据smth做了一个小帮手。 找到此处，以便 F5 根据当前光标位置切换代码折叠：

(global-set-key (kbd "<f5>") 'set-selective-display-dlw)

(defun set-selective-display-dlw (&optional level)
"Fold text indented same of more than the cursor.
If level is set, set the indent level to LEVEL.
If 'selective-display' is already set to LEVEL, clicking
F5 again will unset 'selective-display' by setting it to 0."
  (interactive "P")
  (if (eq selective-display (1+ (current-column)))
      (set-selective-display 0)
    (set-selective-display (or level (1+ (current-column))))))

Answer 4

我使用大纲次要模式来折叠我的 python 代码。 它不需要像折叠模式那样放置 {{{ 和 }}}，而是使用定义块的位置。

http://www.gnu.org/software/emacs/manual/html_node/emacs/Outline-模式.html
http://www.emacswiki.org/emacs/OutlineMinorMode

我很确定它是 emacs 附带的。 然后我将其添加到我的 .emacs 中

;;======= Code folding =======
(add-hook 'python-mode-hook 'my-python-outline-hook)
; this gets called by outline to deteremine the level. Just use the length of the whitespace
(defun py-outline-level ()
  (let (buffer-invisibility-spec)
    (save-excursion
      (skip-chars-forward "    ")
      (current-column))))
; this get called after python mode is enabled
(defun my-python-outline-hook ()
  ; outline uses this regexp to find headers. I match lines with no indent and indented "class"
  ; and "def" lines.
  (setq outline-regexp "[^ \t]\\|[ \t]*\\(def\\|class\\) ")
  ; enable our level computation
  (setq outline-level 'py-outline-level)
  ; do not use their \C-c@ prefix, too hard to type. Note this overides some bindings.
  (setq outline-minor-mode-prefix "\C-t")
  ; turn on outline mode
  (outline-minor-mode t)
  ; initially hide all but the headers
  ;(hide-body)
  ; make paren matches visible
  (show-paren-mode 1)
)

Answer 5

您还可以通过使用 CEDET 在 init 文件中使用以下代码来获得代码折叠：

(global-semantic-folding-mode t)

执行此代码后，小三角形将出现在边缘区域，因此您将能够折叠和折叠 使用它展开代码。 这种方法更精确，因为它使用从源代码中提取的语法信息

Answer 6

hs-minor-mode 工作得很好。

与 Fold-dwim 配合使用时，它的工作效果会更加出色（按照我的意思做）。 然后是fold-dwim-org，它为代码折叠提供类似组织模式的键绑定！ 两者都可以通过 marmalade 安装（我认为是 elpa）。

Answer 7

我很惊讶没有人提到缩小-扩大。 它超级棒，它还与 emacs 捆绑在一起。 只需选择您想要关注的代码并按 Cx n n，即可返回完整视图模式，只需执行 Cx n w。 我总是更喜欢使用内置的 emacs 功能，而不是用另一个包扰乱我的用户空间。 如果 emacs 可以使用内置功能来做到这一点，那么我会更喜欢它而不是某些第三方包，但这只是我，并不意味着或暗示任何其他东西，除了我喜欢简单的东西而不是复杂的长配置。

Answer 8

vimish-fold 也是一个很好且简单的解决方案。

https://github.com/mrkkrp/vimish-fold。

从主页：

这是一个像 Vim 一样执行文本折叠的包。 它具有以下特点：

• 折叠活动区域；
• 良好的视觉反馈：文本的哪一部分被折叠一目了然；
• 默认持久性：关闭文件时，折叠不会消失；
• 持久性可以很好地扩展，您可以处理数百个具有大量折叠的文件，而不会产生不利影响；
• 它不会破坏缩进或其他东西；
• 折叠可以轻松地从折叠状态切换到展开状态，然后再返回；
• 在现有折叠之间快速导航；
• 您可以使用鼠标展开折叠（不仅适合初学者，而且适合初学者）；
• 对于 avy 软件包的粉丝：您可以使用 avy 以最少的击键次数折叠文本！

使用优秀的 use-package 我在配置中使用此代码片段安装并激活它：

(use-package vimish-fold
  :ensure t
  :config (vimish-fold-global-mode t))

Answer 9

显然没有完美的解决方案，但我认为最好的解决方案是：

http://www.emacswiki.org /emacs/FoldingMode

Answer 10

我相信您将“项目”与折叠进行比较不太好，因为折叠是在保持缓冲区内容完整（文本）的同时改变外观。 您的项目将涉及显示额外的文本，同时保持缓冲区内容完整，AFAIU。 所以。 它不能作为文本插入和折叠的组合来实现（然后，缓冲区内容将被更改）。

但也许，确实可以使用与折叠相同的机制——“覆盖”...考虑“前字符串”和“后字符串”叠加属性; 也许，您可以将函数定义放入属于此时零长度覆盖的这些字符串中。 看看 outline-flag-region 函数来查看如何在轮廓模式下使用叠加。

Answer 11

emacs 带有 hs-minor-mode，它促进平衡表达式之间的代码折叠
http://www.emacswiki.org/emacs/HideShow

Answer 12

如果您使用 hs-minor-mode，最好还设置一个更方便的快捷方式，例如：

(eval-after-load 'hideshow
 '(progn
   (global-set-key (kbd "C-+") 'hs-toggle-hiding)))

Answer 13

受到 einSelbst 的回答的启发：

(advice-add 'set-selective-display
            :filter-args (lambda (args)
                           (if (or (car args) selective-display)
                               args
                             (list (1+ (current-column)))))
            '((name . set-selective-display-from-cursor-column)))

瞧，即使没有任何 ，Cx $ 也突然变得有用Cu 也不是 M-4 业务。

Answer 14

如果您正在执行一些 JavaScript 操作并使用 js2-mode.el，您可以：

Cc Cf：切换隐藏/显示全部

Cc Ce：隐藏element

Cc Cs：显示元素