Bug: org-columns does not respect global-visual-line-mode for long text within headlines

Bug: org-columns does not respect global-visual-line-mode for long text within headlines

[Nick Savage]

Hello everyone,

I'm filing a bug in relation to org-columns and its interactions with 
global-visual-line-mode, which I do not think is expected behaviour.

1. Start `emacs -Q'
2. Create /tmp/test.org (or something like this)
3. Enable M-x global-visual-line-mode
4. Insert the following (or something like it, the purpose is to have a 
line that wraps on your screen with global-visual-line-mode enabled, you 
may need to add more characters if necessary)
* test headline
cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc

5. Collapse headline, activate org-columns (C-c C-x C-c) on the headline.
6. Toggle visibility of headline, note that the line no longer wraps and 
instead acts as if global-visual-line-mode was not enabled.

I am investigating now but I thought I would post this as a bug 
regardless. The trace below is for the release of org-mode with 28.0.50, 
but I can confirm that it is the same on the current master.

Emacs  : GNU Emacs 28.0.50 (build 2, x86_64-pc-linux-gnu, GTK+ Version 
3.24.5, cairo version 1.16.0)
  of 2021-01-15
Package: Org mode version 9.4.4 (release_9.4.4 @ 
/usr/local/share/emacs/28.0.50/lisp/org/)

current state:
==============
(setq
  org-confirm-elisp-link-function 'yes-or-no-p
  org-speed-command-hook '(org-speed-command-activate 
org-babel-speed-command-activate)
  org-occur-hook '(org-first-headline-recenter)
  org-babel-pre-tangle-hook '(save-buffer)
  org-cycle-hook '(org-cycle-hide-archived-subtrees 
org-cycle-hide-drawers org-cycle-show-empty-lines
           org-optimize-window-after-visibility-change)
  outline-isearch-open-invisible-function 'outline-isearch-open-invisible
  org-archive-hook '(org-attach-archive-delete-maybe)
  org-agenda-loop-over-headlines-in-active-region nil
  org-src-mode-hook '(org-src-babel-configure-edit-buffer 
org-src-mode-configure-edit-buffer)
  org-confirm-shell-link-function 'yes-or-no-p
  org-bibtex-headline-format-function #[257 "\300\x01\236A\207" [:title] 3 
"\n\n(fn ENTRY)"]
  org-metadown-hook '(org-babel-pop-to-session-maybe)
  org-mode-hook '(#[0 "\300\301\302\303\304$\207" [add-hook 
change-major-mode-hook org-show-all append local] 5]
          #[0 "\300\301\302\303\304$\207" [add-hook 
change-major-mode-hook org-babel-show-result-all append local] 5]
          org-babel-result-hide-spec org-babel-hide-all-hashes)
  org-metaup-hook '(org-babel-load-in-session-maybe)
  org-link-shell-confirm-function 'yes-or-no-p
  org-link-parameters '(("attachment" :follow org-attach-follow 
:complete org-attach-complete-link) ("id" :follow org-id-open)
                ("eww" :follow org-eww-open :store org-eww-store-link)
                ("rmail" :follow org-rmail-open :store org-rmail-store-link)
                ("mhe" :follow org-mhe-open :store org-mhe-store-link)
                ("irc" :follow org-irc-visit :store org-irc-store-link 
:export org-irc-export)
                ("info" :follow org-info-open :export org-info-export 
:store org-info-store-link)
                ("gnus" :follow org-gnus-open :store org-gnus-store-link)
                ("docview" :follow org-docview-open :export 
org-docview-export :store org-docview-store-link)
                ("bibtex" :follow org-bibtex-open :store 
org-bibtex-store-link)
                ("bbdb" :follow org-bbdb-open :export org-bbdb-export 
:complete org-bbdb-complete-link :store
             org-bbdb-store-link)
                ("w3m" :store org-w3m-store-link) ("file+sys") 
("file+emacs") ("shell" :follow org-link--open-shell)
                ("news" :follow #[514 "\301\300\302\x04Q\x02\"\207" ["news" 
browse-url ":"] 6 "\n\n(fn URL ARG)"])
                ("mailto" :follow #[514 "\301\300\302\x04Q\x02\"\207" 
["mailto" browse-url ":"] 6 "\n\n(fn URL ARG)"])
                ("https" :follow #[514 "\301\300\302\x04Q\x02\"\207" ["https" 
browse-url ":"] 6 "\n\n(fn URL ARG)"])
                ("http" :follow #[514 "\301\300\302\x04Q\x02\"\207" ["http" 
browse-url ":"] 6 "\n\n(fn URL ARG)"])
                ("ftp" :follow #[514 "\301\300\302\x04Q\x02\"\207" ["ftp" 
browse-url ":"] 6 "\n\n(fn URL ARG)"])
                ("help" :follow org-link--open-help) ("file" :complete 
org-link-complete-file)
                ("elisp" :follow org-link--open-elisp) ("doi" :follow 
org-link--open-doi))
  org-export-before-parsing-hook '(org-attach-expand-links)
  org-clock-out-hook '(org-clock-remove-empty-clock-drawer)
  org-agenda-before-write-hook '(org-agenda-add-entry-text)
  org-link-elisp-confirm-function 'yes-or-no-p
  org-tab-first-hook '(org-babel-hide-result-toggle-maybe 
org-babel-header-arg-expand)
  )

Re: Bug: org-columns does not respect global-visual-line-mode for long text within headlines

[Nicolas Goaziou]

Hello,

Nick Savage <nick@nicksavage.ca> writes:

> I'm filing a bug in relation to org-columns and its interactions with
> global-visual-line-mode, which I do not think is expected behaviour.
>
> 1. Start `emacs -Q'
> 2. Create /tmp/test.org (or something like this)
> 3. Enable M-x global-visual-line-mode
> 4. Insert the following (or something like it, the purpose is to have
> a line that wraps on your screen with global-visual-line-mode enabled,
> you may need to add more characters if necessary)
> * test headline
> cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc
>
> 5. Collapse headline, activate org-columns (C-c C-x C-c) on the headline.
> 6. Toggle visibility of headline, note that the line no longer wraps
> and instead acts as if global-visual-line-mode was not enabled.
>
> I am investigating now but I thought I would post this as a bug
> regardless. The trace below is for the release of org-mode with
> 28.0.50, but I can confirm that it is the same on the current master.

FWIW, I confirm this, too. This has bugged me for a long time now!

Regards,
-- 
Nicolas Goaziou

[PATCH]: org-columns does not respect global-visual-line-mode for long text within headlines

[Nick Savage]

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

I've done some more research on 
https://orgmode.org/list/875z02si3g.fsf@nicolasgoaziou.fr/, and I 
believe the issue is that `org-columns' is setting `truncate-lines' as 
t, while `global-visual-line-mode' is expecting it to be set to nil. The 
interaction between the two causes the wrapping to not occur. 
`org-columns; also cleans up after itself and replaces truncate-lines 
with the original value, which is why the problem only occurs when 
`org-columns' is enabled it.

The attached patch ensures the behaviour is correct when 
`global-visual-line-mode' is enabled and that there are no behaviour 
changes when it has not already been enabled.



[-- Attachment #2: 0001-lisp-org-colview.el-Update-org-columns-to-respect-gl.patch --]
[-- Type: text/x-patch, Size: 1453 bytes --]

From fbb91ddc2bc8b6f29651e3114754bcd8fcad30d0 Mon Sep 17 00:00:00 2001
From: Nicholas Savage <nick@nicksavage.ca>
Date: Sat, 1 May 2021 20:05:09 -0400
Subject: [PATCH] lisp/org-colview.el: Update org-columns to respect
 global-visual-line-mode

* lisp/org-colview.el (org-columns): Prevent enabling truncate-lines
when global-visual-line-mode is also enabled

Fixing a bug where org-column overlays were disabling wrapping of
lines when global-visual-line-mode was already activated, and so
therefore expectation was that the lines would continue wrapping. This
is because org-columns was setting truncate-lines to t, when
global-visual-line-mode requires it to be set to nil. The interaction
between the two caused the wrapping not to occur.
---
 lisp/org-colview.el | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lisp/org-colview.el b/lisp/org-colview.el
index 517bcdf1c..9dad8c7d9 100644
--- a/lisp/org-colview.el
+++ b/lisp/org-colview.el
@@ -879,7 +879,8 @@ When COLUMNS-FMT-STRING is non-nil, use it as the column format."
 	    (unless (local-variable-p 'org-colview-initial-truncate-line-value)
 	      (setq-local org-colview-initial-truncate-line-value
 			  truncate-lines))
-	    (setq truncate-lines t)
+            (if (not global-visual-line-mode)
+              (setq truncate-lines t))
 	    (dolist (entry cache)
 	      (goto-char (car entry))
 	      (org-columns--display-here (cdr entry)))))))))
-- 
2.20.1

Re: [PATCH]: org-columns does not respect global-visual-line-mode for long text within headlines

[Bastien]

Hi Nick,

Nick Savage <nick@nicksavage.ca> writes:

> The attached patch ensures the behaviour is correct when
> `global-visual-line-mode' is enabled and that there are no behaviour
> changes when it has not already been enabled.

Applied in maint with commit cb0ef1280.  Thanks!

-- 
 Bastien