Code Folding

Code Folding

[Adam H]

Is there a way to fold code in Emacs?

Re: Code Folding

[Tuukka Toivonen]

In article <mailman.6772.1053945790.21513.help-gnu-emacs@gnu.org>, Adam H wrote:
> Is there a way to fold code in Emacs?

Search for folding.el:
http://user.it.uu.se/~andersl/emacs.shtml

Re: Code Folding

[Kai Großjohann]

Adam H <amh@crm-114.net> writes:

> Is there a way to fold code in Emacs?

M-x hs-minor-mode RET

Then see the Hide and Show menus.
-- 
This line is not blank.

Re: Code Folding

[Stefan Monnier]

>>>>> "Adam" == Adam H <amh@crm-114.net> writes:
> Is there a way to fold code in Emacs?

...there's also M-x outline-minor-mode RET


        Stefan

code folding

[Michael Powe]

Hello,

I'm looking for folding.el or its current equivalent to do
code/comment folding.  I can get by with just comment folding because
hide-show doesn't work for comments.  It would be nice to have
everything rolled up into a single package, though.

All of the google references for folding.el are to either discussions
only or to expired pages and I can't find a download location.  I
can't find any indication that it has been superceded by a new,
improved item, either.

Thanks.

mp

-- 
Michael Powe		michael@trollope.org		Naugatuck CT USA

"He speaks well, he's well-read, but he's an idiot."
  -- N.D. Kalu, describing Rush Limbaugh

Re: code folding

[Colin S. Miller]

Michael Powe wrote:
> Hello,
> 
> I'm looking for folding.el or its current equivalent to do
> code/comment folding.  I can get by with just comment folding because
> hide-show doesn't work for comments.  It would be nice to have
> everything rolled up into a single package, though.
> 
> All of the google references for folding.el are to either discussions
> only or to expired pages and I can't find a download location.  I
> can't find any indication that it has been superceded by a new,
> improved item, either.
> 
> Thanks.
> 
> mp
> 

Michael,

hs-minor-mode (hide-show) can fold comments in C, C++ and elisp, and
probably other languages. You didn't state which language you are using,
perhaps the parser isn't set up correctly for you language.

However, I use XEmacs rather than GNU Emacs, which might make a difference.

HTH,
Colin S. Miller


-- 
Replace the obvious in my email address with the first three letters of the hostname to reply.

code folding

[Jose E. Marchesi]

    All of the google references for folding.el are to either discussions
    only or to expired pages and I can't find a download location.  I
    can't find any indication that it has been superceded by a new,
    improved item, either.

See http://www.emacswiki.org/cgi-bin/wiki/FoldingMode


-- 
José E. Marchesi  <jemarch@gnu.org>
                  <jemarch@es.gnu.org>

GNUs Not Unix!    http://www.gnu.org
GNU Spain         http://es.gnu.org

Re: code folding

[Robert Marshall]

On 29 Jan 2006, Michael Powe wrote:

> Hello,
> 
> I'm looking for folding.el or its current equivalent to do
> code/comment folding.  I can get by with just comment folding
> because hide-show doesn't work for comments.  It would be nice to
> have everything rolled up into a single package, though.
> 
> All of the google references for folding.el are to either
> discussions only or to expired pages and I can't find a download
> location.  I can't find any indication that it has been superceded
> by a new, improved item, either.
> 

I have a version that attempted to move folding.el (orig of Lokier and
Aalto) from selective display to overlays though recently I've rather
swapped over to 

http://uuid.com/~marcus/computing/fold-mode.html 

which is another WIP.

hide-show looks good too

Robert
-- 
La grenouille songe..dans son château d'eau

Re: code folding

[Michael Powe]

>>>>> "Jose" == Jose E Marchesi <jemarch@gnu.org> writes:

    Jose>     All of the google references for folding.el are to
    Jose> either discussions only or to expired pages and I can't find
    Jose> a download location.  I can't find any indication that it
    Jose> has been superceded by a new, improved item, either.

    Jose> See http://www.emacswiki.org/cgi-bin/wiki/FoldingMode

Great, thanks.  It seems odd that page doesn't come up when I search
for 'folding.el.'  Yet, i get all other kinds of stuff like
'cyrillic-folding.el.'  

Thanks.

mp

-- 
Michael Powe		michael@trollope.org		Naugatuck CT USA
War is a sociological safety valve that cleverly diverts popular
hatred for the ruling classes into a happy occasion to mutilate or
kill foreign enemies. - Ernest Becker

Re: code folding

[Michael Powe]

>>>>> "Colin" == Colin S Miller <no-spam-thank-you@csmiller.demon.co.uk> writes:

    Colin> Michael Powe wrote:
    >> Hello, I'm looking for folding.el or its current equivalent to
    >> do code/comment folding.  I can get by with just comment
    >> folding because hide-show doesn't work for comments.  It would
    >> be nice to have everything rolled up into a single package,
    >> though.  All of the google references for folding.el are to
    >> either discussions only or to expired pages and I can't find a
    >> download location.  I can't find any indication that it has
    >> been superceded by a new, improved item, either.  Thanks.  mp
    >> 

    Colin> Michael,

    Colin> hs-minor-mode (hide-show) can fold comments in C, C++ and
    Colin> elisp, and probably other languages. You didn't state which
    Colin> language you are using, perhaps the parser isn't set up
    Colin> correctly for you language.

It does hide the functions but not the C-style comments.  The language
is Javascript.  When the point is inside a comment block, nothing
happens when 'hide block' is invoked.  I didn't try it on C++ style
comments, which I only ever use for 1 or 2 line comments, anyway.

You could be right, though, and maybe it is just set up for that style
of comment.

Thanks.

mp

-- 
Michael Powe		michael@trollope.org		Naugatuck CT USA
It could have been an organically based disturbance of the brain --
perhaps a tumor or a metabolic deficiency -- but after a thorough
neurological exam it was determined that Byron was simply a jerk.  
-- Jeff Jahnke, runner-up, Bulwer-Lytton contest

Re: code folding

[Michael Powe]

>>>>> "Robert" == Robert Marshall <spam@chezmarshall.freeserve.co.uk> writes:

    Robert> On 29 Jan 2006, Michael Powe wrote:

    >> I'm looking for folding.el or its current equivalent to do
    >> code/comment folding.  I can get by with just comment folding
    >> because hide-show doesn't work for comments.  It would be nice
    >> to have everything rolled up into a single package, though.

    Robert> I have a version that attempted to move folding.el (orig
    Robert> of Lokier and Aalto) from selective display to overlays
    Robert> though recently I've rather swapped over to

    Robert> http://uuid.com/~marcus/computing/fold-mode.html

Thank you, I shall try it.

mp

-- 
Michael Powe		michael@trollope.org		Naugatuck CT USA
"As an adolescent I aspired to lasting fame, I craved factual
certainty, and I thirsted for a meaningful vision of human life -- so
I became a scientist.  This is like becoming an archbishop so you can
meet girls."  -- Matt Cartmill

Re: code folding

[Colin S. Miller]

Michael Powe wrote:

> It does hide the functions but not the C-style comments.  The language
> is Javascript.  When the point is inside a comment block, nothing
> happens when 'hide block' is invoked.  I didn't try it on C++ style
> comments, which I only ever use for 1 or 2 line comments, anyway.
> 
> You could be right, though, and maybe it is just set up for that style
> of comment.
> 
> Thanks.
> 
> mp
> 
Micheal,

I did a quick test, and it worked for me.
However, the cursor must be inside the comment, or hs-hide-block will fold
the code level containing the comment.

hs-hide-level folds control blocks, but not comments within the current indent level.

However, this might be an XEmacs/GNU Emacs difference. I'll try it on GNU Emacs
when I get access to a machine with it installed.

Code used was

/*
  * test
  */

// 1
// 2


foo(i)
{
     var i;
     var k;

     if (1)
     {

         /*
            Test

         */
     }

     /*
       test
     */

}

HTH,
Colin S. Miller

-- 
Replace the obvious in my email address with the first three letters of the hostname to reply.

Re: code folding

[Thien-Thi Nguyen]

"Colin S. Miller" <no-spam-thank-you@csmiller.demon.co.uk> writes:

> However, this might be an XEmacs/GNU Emacs difference. I'll try
> it on GNU Emacs when I get access to a machine with it
> installed.

i am always interested in hideshow (mis)behavior (although usually
i don't do anything constructive about it for years at a time).
anyway, a small bunch of files i use to play w/ hideshow are at:

http://www.glug.org/people/ttn/software/hideshow/hideshow-testing.tar.gz

there is no test harness; just move point to various positions
trying various hideshow commands until bored.  good for hours of
fun...

thi

Re: code folding

[Tim X]

Michael Powe <michael+gnus@trollope.org> writes:

> Hello,
> 
> I'm looking for folding.el or its current equivalent to do
> code/comment folding.  I can get by with just comment folding because
> hide-show doesn't work for comments.  It would be nice to have
> everything rolled up into a single package, though.
> 
> All of the google references for folding.el are to either discussions
> only or to expired pages and I can't find a download location.  I
> can't find any indication that it has been superceded by a new,
> improved item, either.
> 
> Thanks.

Try http://www.emacswiki.org - it had a few items on a couple of
different folding modes. 

Just FYI - the newer folding modes take advantage of emacs overlays
and have the potential of being better, but the last time I looked,
the mode was still pretty much beta. The older folding mode was quite
good, but then it was 'enhanced' and I found it wasn't as stable. Last
time I looked, the wiki pages had information about both newer and
older folding modes. 

HTH

Tim


 
-- 
Tim Cross
The e-mail address on this message is FALSE (obviously!). My real e-mail is
to a company in Australia called rapttech and my login is tcross - if you 
really need to send mail, you should be able to work it out!

code folding

[Jai Dayal]

[-- Attachment #1: Type: text/plain, Size: 213 bytes --]

Hi all,
  I was wondering if anyone had any preferences on some decent code folding
extentions for emacs that I could check out?  It should be noted that I use
ECB, but I think the two should be independent.

Jai

[-- Attachment #2: Type: text/html, Size: 229 bytes --]

Re: code folding

[Jambunathan K]

Jai Dayal <dayalsoap@gmail.com> writes:

> Hi all,
>   I was wondering if anyone had any preferences on some decent code
> folding extentions for emacs that I could check out?  It should be
> noted that I use ECB, but I think the two should be independent.

Experienced users use outline-minor-mode - It takes time to getting used
to it (or any other such mode).

Hint: Search for "outline" or "fold" in emacswiki and try out the first
few modes that show up. You can also search for narrowing and "indirect
buffers" to explore other related things.

I have never used cedet plus company. So I cannot comment on them.

IMO you will be better off NOT using any outlining to begin with.

>
> Jai
>
>

-- 

Re: code folding

[Andreas Röhler]

Am 01.08.2011 23:52, schrieb Jambunathan K:
> Jai Dayal<dayalsoap@gmail.com>  writes:
>
>> Hi all,
>>    I was wondering if anyone had any preferences on some decent code
>> folding extentions for emacs that I could check out?  It should be
>> noted that I use ECB, but I think the two should be independent.
>
> Experienced users use outline-minor-mode - It takes time to getting used
> to it (or any other such mode).
>

lets mention hide-show mode --M-x hs-minor-mode-- too, which is slightly 
more advanced in such, as it's able to hide constructs defined by 
beginning- and end-regexp, whilst outline-modes are restricted to 
address the beginning of the line - IIRC


Andreas

--
https://launchpad.net/python-mode
https://launchpad.net/s-x-emacs-werkstatt/

Re: code folding

[Le Wang]

On Tue, Aug 2, 2011 at 5:52 AM, Jambunathan K <kjambunathan@gmail.com> wrote:
> IMO you will be better off NOT using any outlining to begin with.

why?


-- 
Le

Re: code folding

[Teemu Likonen]

* 2011-08-02T03:22:07+05:30 * Jambunathan K. wrote:

> IMO you will be better off NOT using any outlining to begin with.

Such code outlining/folding is only developer's personal configuration.
I think there is no much point in ruling or suggesting that this kind of
personal configurations are good or bad. They don't matter because they
have no effect on the code that is made public.

I happen to use outline-minor-mode (with extension [1]) mostly with
LaTeX files but sometimes with programming languages too.

---------------
 1. http://www.emacswiki.org/emacs/OutlineMinorMode#toc5

Re: code folding

[Bastien]

Jambunathan K <kjambunathan@gmail.com> writes:

> Experienced users use outline-minor-mode - It takes time to getting used
> to it (or any other such mode).

You can also use orgstruct-mode, a minor mode that comes with org-mode.

Global cycling is broken in Org 7.7 but I'm working on fixing this.

> IMO you will be better off NOT using any outlining to begin with.

I use code folding quite often and I find it useful to navigate through
the code and concentrate on the part I want to edit.

My 2 cents,

-- 
 Bastien

Re: code folding

[Le Wang]

On Fri, Aug 12, 2011 at 3:34 PM, Bastien <bzg@altern.org> wrote:
> You can also use orgstruct-mode, a minor mode that comes with org-mode.

How?  The orgmode manual doesn't address code folding in the context
of orgstruct, and my google-fu has failed me so far.

I currently use outline-magic, which Carsten wrote, I guess before he
made orgmode.

>
> --
>  Bastien
>
>



-- 
Le

Re: code folding

[Jambunathan K]

Le Wang <l26wang@gmail.com> writes:

> On Fri, Aug 12, 2011 at 3:34 PM, Bastien <bzg@altern.org> wrote:
>> You can also use orgstruct-mode, a minor mode that comes with org-mode.
>
> How?  The orgmode manual doesn't address code folding in the context
> of orgstruct, and my google-fu has failed me so far.

Look at bindings effective while in orgstruct(++)-mode.

Do a C-h b and search for orgstruct.

> I currently use outline-magic, which Carsten wrote, I guess before he
> made orgmode.

Also see
http://lists.gnu.org/archive/html/emacs-orgmode/2011-08/msg00382.html
which makes references to org-global-cycle in Auctex.

The above post also makes reference to this Org FAQ entry
http://orgmode.org/worg/org-faq.html#use-visibility-cycling-in-outline-mode

Jambunathan K.

>
>>
>> --
>>  Bastien
>>
>>

Re: code folding

[Bastien]

Bastien <bzg@altern.org> writes:

> Global cycling is broken in Org 7.7 but I'm working on fixing this.

This is now fixed in Org git repository.

Regards,

-- 
 Bastien

Re: code folding

[Le Wang]

On Sun, Aug 14, 2011 at 4:12 AM, Jambunathan K <kjambunathan@gmail.com> wrote:
> Look at bindings effective while in orgstruct(++)-mode.
>
> Do a C-h b and search for orgstruct.
>

I have the following code in my ruby-mode-hook to enable code folding
using outline-minor-mode + outline-magic.

(outline-minor-mode 1)
(set (make-local-variable 'outline-regexp) "^[ \t]*\\(?:def
\\|class\\|module\\)\\|^[ \t]*###==")

What's the equivalent in orgstruct?  org-outline-regexp seems
interesting but isn't documented.

-- 
Le

Re: code folding

[Jambunathan K]

Le Wang <l26wang@gmail.com> writes:

> On Sun, Aug 14, 2011 at 4:12 AM, Jambunathan K <kjambunathan@gmail.com> wrote:
>> Look at bindings effective while in orgstruct(++)-mode.
>>
>> Do a C-h b and search for orgstruct.
>>
>
> I have the following code in my ruby-mode-hook to enable code folding
> using outline-minor-mode + outline-magic.
>
> (outline-minor-mode 1)
> (set (make-local-variable 'outline-regexp) "^[ \t]*\\(?:def
> \\|class\\|module\\)\\|^[ \t]*###==")

Did you try the suggestion in the FAQ that I pointed to?

While in emacs-lisp-mode + outline-minor-mode + below mentioned-hook,,
C-TAB and S-TAB fold and unfold the defuns as expected. Note that for
C-TAB to work, the cursor needs to be on a headline (the line where the
ellipsis shows)

You don't have to do any additional settings for code folding to work.

,----
| Can I get the visibility-cycling features in outline-mode and
| outline-minor-mode?
| 
| Yes, these functions are written in a way that they are independent of
| the outline setup. The following setup provides standard Org-mode
| functionality in outline-mode on TAB and S-TAB. For outline-minor-mode,
| we use C-TAB instead of TAB, because TAB usually has mode-specific
| tasks.
| 
| (add-hook 'outline-minor-mode-hook
|   (lambda ()
|     (define-key outline-minor-mode-map [(control tab)] 'org-cycle)
|     (define-key outline-minor-mode-map [(shift tab)] 'org-global-cycle)))
| 
| (add-hook 'outline-mode-hook
|   (lambda ()
|     (define-key outline-mode-map [(tab)] 'org-cycle)
|     (define-key outline-mode-map [(shift tab)] 'org-global-cycle)))
| 
| Or check out outline-magic.el, which does this and also provides
| promotion and demotion functionality. outline-magic.el is available at
| Outline Magic.
`----

> What's the equivalent in orgstruct?  org-outline-regexp seems
> interesting but isn't documented.

orgstruct mode is for editing org-like text in other modes - like
message mode etc. It has NOTHING to do with folding of code as
such. 

In summary, in a ruby buffer,

1. Add the above hook for folding and unfolding ruby functions.
2. Turn orgstruct++-mode for editing comments that look like a org-like
   plain-text tree.

-- 

Re: code folding

[Bastien]

Le Wang <l26wang@gmail.com> writes:

> What's the equivalent in orgstruct?  org-outline-regexp seems
> interesting but isn't documented.

I just added a docstring to ̀org-outline-regexp' but I'm afraid 
this will not really help you.

,----
| org-outline-regexp is a variable defined in `org.el'.
| Its value is "\\*+ "
| 
| Documentation:
| Regexp to match Org headlines.
`----

Jambunathan's directions are worth following.

Best,

-- 
 Bastien