[ jEdit-devel ] [ jedit-Patches-2846169 ] IndentFoldHandler - allow blank lines after start of fold

[SourceForge.net <no...@so...>]

Patches item #2846169, was opened at 2009-08-28 13:43
Message generated for change (Settings changed) made by shlomy
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=300588&aid=2846169&group_id=588

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: texteditor
Group: None
>Status: Closed
>Resolution: Accepted
Priority: 5
Private: No
Submitted By: Suraj Kurapati (cyzsuraj)
>Assigned to: Shlomy Reinstein (shlomy)
Summary: IndentFoldHandler - allow blank lines after start of fold

Initial Comment:
This patch considers blank lines that come after the start of a fold as part of the fold itself.  This was a major annoyance for me for many years and I am finally glad to have fixed it!  :-)

Attached are two screencasts demonstrating the before & after of applying this patch.

Thanks for your consideration.

----------------------------------------------------------------------

>Comment By: Shlomy Reinstein (shlomy)
Date: 2009-08-31 02:07

Message:
Committed a modified version of this patch to SVN rev. 16129.
The modified version is identical in functionality, it just replaces the
recursion with a flat loop.

----------------------------------------------------------------------

Comment By: Shlomy Reinstein (shlomy)
Date: 2009-08-30 08:24

Message:
I just realized that whitespace-only lines may not preserve the amount of
whitespace used by the indentation of actual source lines. Even though
jEdit initially indents them as it would indent any source code line, you
can delete some of these whitespace characters or add to them, with no
visible effect, breaking the fold handler.
So, your patch makes sense.
I will see what I can do about the performance.

----------------------------------------------------------------------

Comment By: Suraj Kurapati (cyzsuraj)
Date: 2009-08-29 23:11

Message:
Also, this patch isn't perfect because I'm not an experienced jEdit
developer.  I just came upon the solution through trial and error.  If you
could suggest a more efficient way to implement this, I would be very
greatful.  Thanks for your consideration.

----------------------------------------------------------------------

Comment By: Suraj Kurapati (cyzsuraj)
Date: 2009-08-29 23:07

Message:
Correct, but a line containing only whitespace has no meaning in any
programming languages (except the "Whitespace" language, but nobody uses
that!  http://en.wikipedia.org/wiki/Whitespace_%28programming_language%29).
 Such lines should be ignored in fold level processing --- they should
neither increase nor decrease the current fold level.

Here is my use case:  I like to use indentation-based folding &
code-comments to manage the complexity of my code, and I like to add at
least one blank line after a "fold comment" to make the code readable in
non-folding editors:

// this is a fold comment
<blank line>
<indentation>code described by the fold comment

Without this patch, I was always forced (for 5 years now!) to remove the
blank line after the "fold comment"  and it makes my code look very ugly. 
Furthermore, you will notice in the "before screencast" how blank lines
after a "fold comment" break the fold guides (the vertical lines denoting
each indentation level).

Is this more clear?  Thanks for your consideration.

----------------------------------------------------------------------

Comment By: Shlomy Reinstein (shlomy)
Date: 2009-08-29 17:19

Message:
Your patch works as you expect it to, but I don't see the point. Why not
just regard whitespace-only lines the same as other lines? It's
indent-fold-handler - which means it should set fold levels according to
indentation.

----------------------------------------------------------------------

Comment By: Suraj Kurapati (cyzsuraj)
Date: 2009-08-28 13:45

Message:
I could not upload the screencasts due to SourceForge size limit, so they
are available here:

http://snk.tuxfamily.org/tmp/before-indent-fix.gif

http://snk.tuxfamily.org/tmp/after-indent-fix.gif

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=300588&aid=2846169&group_id=588