From: Carsten Dominik <carsten.dominik@gmail.com>
To: Bastien <bzg@altern.org>
Cc: emacs-orgmode@gnu.org, Kelly Dean <kellydeanch@yahoo.com>
Subject: Re: Outline and org-mode don't insert text into folded sections logically
Date: Wed, 2 Nov 2011 08:12:05 +0100 [thread overview]
Message-ID: <F02240E1-9104-4204-91F6-E5A48FE8667B@gmail.com> (raw)
In-Reply-To: <87ehxuzw80.fsf@gnu.org>
[-- Attachment #1: Type: text/plain, Size: 430 bytes --]
Hi Bastien,
please find enclosed a patch which is my proposal for rounding
off this feature.
It introduces a variable, applies the check to org-delete-char
and org-delete-backward-char, and removes the (sit-for 1),
and it never moves the cursor.
I have been unsing it for a day or two, and I like the `smart'
setting of the variable. Even though, I do agree with your
earlier post that the default should be nil.
- Carsten
[-- Attachment #2: checking-for-invisible-edits.patch --]
[-- Type: application/octet-stream, Size: 6145 bytes --]
diff --git a/lisp/org.el b/lisp/org.el
index 318ccfd..28b9f1c 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -1065,6 +1065,28 @@ OK to kill that hidden subtree. When nil, kill without remorse."
(const :tag "Protect hidden subtrees with a security query" t)
(const :tag "Never kill a hidden subtree with C-k" error)))
+(defcustom org-catch-invisible-edits nil
+ "Check if in invisible region before inserting or deleting a character.
+Valid values are:
+
+nil Do not check, so just do invisible edits.
+error Throw an error and do nothing.
+show Make point visible, and do the requested edit.
+show-and-error Make point visible, then throw an error and abort the edit.
+smart Make point visible, and do insertion/deletion if it is
+ adjacent to visible text and the change feels predictable.
+ Never delete a previously invisible character or add in the
+ middle or right after an invisible region. Basically, this
+ allows insertion and backward-delete right before ellipses.
+ FIXME: maybe in this case we should not even show?"
+ :group 'org-edit-structure
+ :type '(choice
+ (const :tag "Do not check" nil)
+ (const :tag "Throw error when trying to edit" error)
+ (const :tag "Unhide, but do not do the edit" show-and-error)
+ (const :tag "Show invisible part and do the edit" show)
+ (const :tag "Be smart and do the right thing" smart)))
+
(defcustom org-yank-folded-subtrees t
"Non-nil means when yanking subtrees, fold them.
If the kill is a single subtree, or a sequence of subtrees, i.e. if
@@ -17401,24 +17423,7 @@ hook. The default setting is `org-speed-command-default-hook'."
If the cursor is in a table looking at whitespace, the whitespace is
overwritten, and the table is not marked as requiring realignment."
(interactive "p")
- (let ((invisible-at-point
- (car (get-char-property-and-overlay (point) 'invisible)))
- (invisible-before-point
- (or (bobp) (car (get-char-property-and-overlay
- (1- (point)) 'invisible)))))
- (when (or (eq invisible-at-point 'outline)
- (eq invisible-at-point 'org-hide-block)
- (eq invisible-before-point 'outline)
- (eq invisible-before-point 'org-hide-block))
- (if (or (eq invisible-before-point 'outline)
- (eq invisible-before-point 'org-hide-block))
- (goto-char (previous-overlay-change (point))))
- (org-cycle)
- (if (or (eq invisible-before-point 'outline)
- (eq invisible-before-point 'org-hide-block))
- (forward-char 1))
- (message "Unfolding invisible region around point before editing")
- (sit-for 1)))
+ (org-check-before-invisible-edit 'insert)
(cond
((and org-use-speed-commands
(setq org-speed-command
@@ -17470,6 +17475,53 @@ overwritten, and the table is not marked as requiring realignment."
(setq org-self-insert-command-undo-counter
(1+ org-self-insert-command-undo-counter))))))))
+(defun org-check-before-invisible-edit (kind)
+ "Check is editing if kind KIND would be dangerous with invisible text around.
+The detailed reaction depends on the user option `org-catch-invisible-edits'."
+ ;; First, try to get out of here as quickly as possible, to reduce overhead
+ (if (and org-catch-invisible-edits
+ (or (not (boundp 'visible-mode)) (not visible-mode))
+ (or (get-char-property (point) 'invisible)
+ (get-char-property (max (point-min) (1- (point))) 'invisible)))
+ ;; OK, we need to take a closer look
+ (let ((invisible-at-point (get-char-property (point) 'invisible))
+ (invisible-before-point (if (bobp) nil (get-char-property
+ (1- (point)) 'invisible)))
+ (border-and-ok-direction
+ (or
+ ;; Check if we are acting predictably before invisible text
+ (and invisible-at-point (not invisible-before-point)
+ (memq kind '(insert delete-backward)))
+ ;; Check if we are acting predictably after invisible text
+ ;; This works not well, and I have turned it off. It seems
+ ;; better to always show and stop after invisible text.
+ ;; (and (not invisible-at-point) invisible-before-point
+ ;; (memq kind '(insert delete)))
+ )))
+
+ (when (or (memq invisible-at-point '(outline org-hide-block))
+ (memq invisible-before-point '(outline org-hide-block)))
+ (if (eq org-catch-invisible-edits 'error)
+ (error "Editing in invisible areas is prohibited - make visible first"))
+ ;; Make the area visible
+ (save-excursion
+ (if invisible-before-point
+ (goto-char (previous-single-char-property-change
+ (point) 'invisible)))
+ (org-cycle))
+ (cond
+ ((eq org-catch-invisible-edits 'show)
+ ;; That's it, we do the edit after showing
+ (message
+ "Unfolding invisible region around point before editing")
+ (sit-for 1))
+ ((and (eq org-catch-invisible-edits 'smart)
+ border-and-ok-direction)
+ (message "Unfolding invisible region around point before editing"))
+ (t
+ ;; Don't do the edit, make the user repeat it in full visibility
+ (error "Edit in invisible region aborted, repeat to confirm with text visible")))))))
+
(defun org-fix-tags-on-the-fly ()
(when (and (equal (char-after (point-at-bol)) ?*)
(org-on-heading-p))
@@ -17482,6 +17534,7 @@ front of the next \"|\" separator, to keep the table aligned. The table will
still be marked for re-alignment if the field did fill the entire column,
because, in this case the deletion might narrow the column."
(interactive "p")
+ (org-check-before-invisible-edit 'delete-backward)
(if (and (org-table-p)
(eq N 1)
(string-match "|" (buffer-substring (point-at-bol) (point)))
@@ -17508,6 +17561,7 @@ front of the next \"|\" separator, to keep the table aligned. The table will
still be marked for re-alignment if the field did fill the entire column,
because, in this case the deletion might narrow the column."
(interactive "p")
+ (org-check-before-invisible-edit 'delete)
(if (and (org-table-p)
(not (bolp))
(not (= (char-after) ?|))
[-- Attachment #3: Type: text/plain, Size: 2840 bytes --]
On 30.10.2011, at 10:04, Bastien wrote:
> Hi Carsten,
>
> Carsten Dominik <carsten.dominik@gmail.com> writes:
>
>> - This patch covers only one of many ways to make unwanted changes
>> in an invisible area. Others would be delete, backspace,
>> kill-region, yank, kill-line, and an arbitrarily long list of
>> less obvious other commands. Full protection could only be
>> done with pre-change-hooks or so, but would then prevent
>> also programmed changes - something that would not be useful.
>
> Yes, I don't want programmed changes to be affected by this feature.
>
> But having such a warning for `org-delete' would also be useful IMHO.
>
>> `org-self-insert-command' is probably only ever used in an
>> interactive way, so the patch as you have written it may very
>> well function correctly.
>>
>> - All the code in org-self-insert-command is executed for each
>> keypress, so one needs to be careful to have this function
>> carry as little overhead as possible.
>
> I actually think there should be a user option
> `org-edit-invisible-send-warning' defaulting to nil.
>
> The request "don't let me shoot in my foot" is a common
> one, and this option would let people set this to `t'.
>
>> - Currently this chokes at the beginning of the buffer because
>> the invisibility test is also run at (1- (point)).
>
> Fixed, thanks.
>
>> - I am not sure if I understand the positioning code:
>>> (if (or (eq invisible-before-point 'outline)
>>> (eq invisible-before-point 'org-hide-block))
>>> (goto-char (previous-overlay-change (point))))
>>> (org-cycle)
>>> (if (or (eq invisible-before-point 'outline)
>>> (eq invisible-before-point 'org-hide-block))
>>> (forward-char 1))
>>
>> So when I happen to be somewhere in the middle of invisible
>> text and press a character, it seems to me that the character
>> will be inserted at the beginning of the invisible text, and
>> not where the cursor was.
>>
>> Maybe a better solution would be to save point, unfold,
>> go back to point, throw and error and not insert the pressed
>> character. I am not sure, though.
>
> Throwing an error and not inserting the text was what my first
> patch did. I thought it was too restrictive, though.
>
> With an option `org-edit-invisible-send-warning', we could have both:
> `t' would just throw a warning, 'prevent would throw an error.
>
>> Maybe you can explain your reasoning?
>
> My reasoning is that, when in the "middle" of an invisible region,
> the user does not know where the point is, hence he doesn't really
> know where he wants to insert characters. In this case, I assume
> insert at the beginning of the invisible region is a reasonable
> default.
>
> Thanks for the feedback -- let's continue brainstorming, I think
> this feature is important.
>
> Best,
>
> --
> Bastien
next prev parent reply other threads:[~2011-11-02 7:12 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-09-03 19:14 Outline and org-mode don't insert text into folded sections logically Kelly Dean
2011-09-05 7:52 ` Giovanni Ridolfi
2011-09-05 8:01 ` suvayu ali
2011-10-22 10:13 ` Bastien
2011-10-22 10:17 ` suvayu ali
2011-10-22 10:21 ` Jambunathan K
2011-10-22 13:53 ` Bastien
2011-10-23 2:18 ` suvayu ali
2011-10-29 14:10 ` Bastien
2011-10-29 14:57 ` suvayu ali
2011-10-29 15:40 ` Bastien
2011-10-29 15:53 ` suvayu ali
2011-10-29 16:15 ` Bastien
2011-10-29 16:22 ` suvayu ali
2011-10-30 1:07 ` Bastien
2011-10-30 6:28 ` Carsten Dominik
2011-10-30 7:30 ` Jambunathan K
2011-10-30 7:47 ` Carsten Dominik
2011-10-30 9:04 ` Bastien
2011-10-30 15:37 ` Carsten Dominik
2011-10-31 20:58 ` Carsten Dominik
2011-11-02 7:12 ` Carsten Dominik [this message]
2011-11-02 10:10 ` Bastien
2011-11-02 12:53 ` Carsten Dominik
2011-11-03 1:30 ` Bastien
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=F02240E1-9104-4204-91F6-E5A48FE8667B@gmail.com \
--to=carsten.dominik@gmail.com \
--cc=bzg@altern.org \
--cc=emacs-orgmode@gnu.org \
--cc=kellydeanch@yahoo.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).