From: Ihor Radchenko <yantar92@posteo.net>
To: Nathaniel Nicandro <nathanielnicandro@gmail.com>
Cc: emacs-orgmode <emacs-orgmode@gnu.org>
Subject: Re: [PATCH] Highlight ANSI sequences in the whole buffer (was [PATCH] ANSI color on example blocks and fixed width elements)
Date: Wed, 17 Jan 2024 12:36:43 +0000 [thread overview]
Message-ID: <875xzsjfvo.fsf@localhost> (raw)
In-Reply-To: <8734uwhlhj.fsf@gmail.com>
Nathaniel Nicandro <nathanielnicandro@gmail.com> writes:
> Hello, attached is another updated patch with the following changes:
Thanks!
> - To tackle the issue discussed previously about highlights spanning
> multiple lines (or elements) being removed when a line is modified I
> went ahead and used the font-lock-multiline property (see
> font-lock-extend-region-multiline and
> font-lock-extend-region-functions) across those regions so that on
> any edit of one of the lines, the region including all of the ANSI
> sequences that affect that line will be re-fontified. This was the
> easier solution, but the downside is that it can cause large regions
> to be re-fontified when really all we want to do is apply the
> highlighting face to a small line change, for example.
This is fine.
> - To tackle the issue of editing around the invisible ANSI sequences I
> left it up to the font-lock process to catch the invisible edits.
> Whenever an edit deletes a character of the sequence that renders
> the sequence invalid, the font-lock process will reveal the partial
> sequence. But I had to limit what was considered a valid ANSI
> sequence to get it working in a somewhat acceptable way.
>
> The problem that I found was that if the buffer contains something
> like
>
> ^[[43mfoo
>
> (where ^[ is the ESC character and can be inserted with "C-q ESC" and
> the whole sequence ^[[43m is the ANSI sequence) what was happening was
> that deleting into the hidden sequence would leave the region in the
> state
>
> ^[[43foo
>
> and because the end byte of the ANSI sequence can be any character
> in the ASCII range [@A-Z[\]^_`a–z{|}~], ^[[43f would still be a
> valid ANSI sequence and would be hidden during the fontification
> process after the edit. Since `ansi-color-apply-on-region' only
> really handles the sequences that end in an m byte, just rendering
> all other ones invisible, I limited the ANSI sequences handled by
> this patch to be only those sequences that end in m. This way,
> after deleting into the sequence like in the above example the
> fontification process would not recognize the region as containing
> any sequence. The downside to this solution is that sequences that
> end in any other end byte won't get conveniently hidden and the
> problem still persists if you have text that starts with an m and
> you delete into a hidden sequence.
Makes sense. We may also make hiding ^[[43foo as customization disabled
by default.
> An alternative solution that doesn't constrain the end byte could be
> to add in some extra invisible character like a zero width space and
> then use something like the `modification-hooks' text property on
> the character to signify that a deletion at the boundary between the
> sequence and the text should really delete part of the sequence
> instead of the zero width space. I haven't really worked out the
> details of this, for example how would it be detected which
> direction a deletion is coming from, the front or behind, but I'm
> throwing it out there to see if there are any other solutions other
> people might be aware of for a similar problem.
If you want to go in this direction, check out
`org-fold-check-before-invisible-edit'. We can unfontify the escape
sequence from there and font-lock will re-apply only during the next
editing cycle, making the sequence visible temporarily.
Not mandatory though.
>> P.S. I am not yet commenting on the details in the code.
>
> Please let me know what you think of this patch and where I should be
> focusing my efforts moving forward to get this submitted to Org.
I tried to test your newest patch with the example file you provided and
I notice two things that would be nice:
1. It is a bit confusing to understand why one or other text is colored
without seeing the escape characters. Some customization like
`org-link-descriptive' and a command like `org-toggle-link-display'
would be nice. I can see some users prefer seeing the escape codes.
2. Using overlays for fontification is problematic. In your example
file, table alignment becomes broken when escape sequences are hidden
inside overlays:
| [31mcell 1 | cell 2 |
| cell 3 | cell 4 |
looks like
| cell 1 | cell 2 |
| cell 3 | cell 4 |
Using text properties would make table alignment work without
adjustments in the org-table.el code.
> One thing I would like to start doing is writing some tests for this
> feature. It would be great if someone could point me to some tests
> that I can peruse so that I can get an idea of how I can go about
> writing some of my own. Also, are there any procedures or things I
> should be aware of when trying to write my own tests?
Check out testing/README file in the Org repository.
Unfortunately, we do not yet have any existing tests for font-locking in
Org tests. You may still refer to the files in testing/lisp/ to see some
example tests.
Also, Emacs has built-in library to help writing font-lock tests -
faceup.el. You may consider using it. Its top comment also contains a
number of references to various tools that could be useful to diagnose
font-locking code.
--
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>
next prev parent reply other threads:[~2024-01-17 13:31 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-04-05 12:03 [PATCH] ANSI color on example blocks and fixed width elements Nathaniel Nicandro
2023-04-05 13:43 ` Ihor Radchenko
2023-04-13 20:18 ` [PATCH] Highlight ANSI sequences in the whole buffer (was [PATCH] ANSI color on example blocks and fixed width elements) Nathaniel Nicandro
2023-04-14 8:49 ` Ihor Radchenko
2023-04-25 20:33 ` Nathaniel Nicandro
2023-05-10 10:27 ` Ihor Radchenko
2023-05-15 0:18 ` Nathaniel Nicandro
2023-05-18 19:45 ` Ihor Radchenko
2023-05-23 0:55 ` Nathaniel Nicandro
2023-08-08 11:02 ` Ihor Radchenko
2023-11-08 9:56 ` Ihor Radchenko
2023-11-08 15:35 ` Nathaniel Nicandro
2023-11-10 10:25 ` Ihor Radchenko
2023-11-17 21:18 ` Nathaniel Nicandro
2023-12-14 14:34 ` Ihor Radchenko
2023-12-24 12:49 ` Nathaniel Nicandro
2024-01-17 0:02 ` Nathaniel Nicandro
2024-01-17 12:36 ` Ihor Radchenko [this message]
2024-03-26 14:02 ` Nathaniel Nicandro
2024-03-28 8:52 ` Ihor Radchenko
2023-12-14 14:37 ` Ihor Radchenko
2023-12-15 12:50 ` Matt
2023-12-25 2:20 ` Nathaniel Nicandro
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=875xzsjfvo.fsf@localhost \
--to=yantar92@posteo.net \
--cc=emacs-orgmode@gnu.org \
--cc=nathanielnicandro@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).