mattduck / hideshow-orgmode

Orgmode-like folding for sideshow

hideshow-orgmode.el

Hideshow-orgmode.el provides an org-mode like interface to the hideshow minor mode.

Org-mode provides an elegant means of interacting with outlines that one can toggle with TAB and S-TAB. Hideshow-orgmode.el attempts to replicate the outline behavior of org-mode by providing two functions: hs-cycle and hs-cycle-all.

Download

$ git clone [e-mail]:logangrado/hideshow-orgmode.git

Installation

(add-to-list 'load-path "/path/to/hideshow-orgmode-directory")
(require 'hideshow-orgmode)

Hideshow Cycling

This package is designed to allow for the cycling of hidden code blocks much like org-mode. Each time hs-cycle is executed, it un-hides one additional block. When all blocks are shown, executing hs-cycle again hides all code blocks.

Functions

This package provides two functions:

1. hs-cycle - Cycles the current block

2. hs-cycle-all - Cycles all blocks

3. hs-fold-all - Folds all blocks. This function differes from hideshow's hs-hide-all in that it also folds child blocks. This function is complimentary to hs-show-all, which unfolds all blocks.

Keymaps & Tips

I set this as my global keymaps in my init file. You of course are free to bind whatever you want.

(global-set-key (kbd "C-c c") 'hs-cycle)
(global-set-key (kbd "C-c C") 'hs-cycle-all)
(global-set-key (kdb "C-c h") 'hs-fold-all)
(global-set-key (kdb "C-c s") 'hs-show-all)

I also added the following line to my init file, which automatically folds all blocks when opening a document, much like org-mode:

(add-hook 'hs-minor-mode-hook 'hs-fold-all)

Languages

I've only really tested this package in python major mode. However, since the package leverages hideshow's definition of foldable blocks, it *should* work anywhere hideshow minor mode works.

Notes

This package tries to replicate the successive unfolding of code blocks like org mode. Unlike org-mode, which leverages TAB, this package relies on binding a separate key. Hideshow-org.el attempts to replicate the smart TAB functionality of org-mode. It would not be difficult combine hideshow-orgmode.el and hideshow-org.el to achieve true org-mode like code folding. However, for code without opening/closing brackets (I'm looking at you, Python), when the TAB key is pressed, emacs will cycle through possible indentations.

TODO

• Currently, hs-cycle does not work when the cursor is within a blockstart regexp (i.e. for class ClassName(object)..., it doesn't detect that it is in a block if the cursor is on lass of class, but anywhere else is fine). This appears to be related to hs-find-block-beginning.