redrawhook issues

[danielshahaf]

The following issues should be fixed by the zsh redrawhook branch (#154 (comment)):
#90 #150 #154 #183 #203 #377

(confirmed for #90 and #150; the rest are known to be widget-wrapping-related issues, and the branch does away with widget wrapping)

The following issue probably won't be:
#40

edit: Upstream committed a patch that, in in conjunction with this issue, fixes #40, q.v.

The following issues might be fixed by using the zle -f yank / zle -f kill feature already in upstream zsh:
#150 #183

edit: #375 is also reported to be fixed by redrawhook branch, and #500 is suspected to be (not tested).

[danielshahaf]

The zsh redrawhook branch was merged upstream in zsh-users/zsh@c3ea3ff, to appear in zsh-5.2.1 zsh-5.3.

[danielshahaf]

Note potential issue with print -zr: workers/38499

[danielshahaf]

Upstream is considering introducing an add-zsh-hook-like API for hooking to zle-line-pre-redraw: workers/38499

[danielshahaf]

Upstream is considering introducing an add-zsh-hook-like API for hooking to zle-line-pre-redraw: workers/38499

Done: workers/38670

[danielshahaf]

I have drafted a patch that uses workers/38670 here: master...danielshahaf:mikachu-redrawhook/v3 At the moment it requires zsh master + two patches from workers@, but I expect both of these patches will be applied to zsh master soon enough.

See also #261 and #261 (comment) for two implementations that precede add-zle-hook-widget.

edit: see users/21671 and its thread for context.

edit: This branch is now #356.

[danielshahaf]

Status update:

There are two candidate implementations:

• The one from my last comment.

  Uses add-zle-hook-widget.

• @m0vie's use zle-line-pre-redraw hook if available #261; a part of it had been factored out into fixes for zle handling #288.

  Predates add-zle-hook-widget, uses generic wrapping instead. These two PRs also have some improvements of independent interest (e.g., use of zle-line-finish)

  Update: [These branches conflict, so I've merged them onto a temporary head and resolved conflicts: https://github.com/zsh-users/zsh-syntax-highlighting/compare/master...danielshahaf:tmp/for-i245-merge-i288-and-i261-v1]

So: need to merge one or the other. (#288 needs to be merged in either case.) Acceptance criteria [compare https://github.com//pull/288#issuecomment-223329830]:

Checklist last updated for da60234 (master) + eb506b5 (#356) using zsh zsh-users/zsh@5b4cbcc

• Passes make test
• Interactive usage works
• Wraps zle-line-pre-redraw
• Wraps zle-line-finish (like _zsh_highlight_bind_widgets does today)
• Wraps zle-isearch-update (like _zsh_highlight_bind_widgets does today) — not needed due to zsh-users/zsh@5cf6ae0
• Fixes all(?) the various issues mentioned in the first comment on this issue
  • highlighting not triggered on command queue pop #40 - not fixed, wasn't expected to be fixed with latest zsh master; see highlighting not triggered on command queue pop #40 for details
  • Unsuccessful completion removes highlighting #90 - fixed, but see below
  • Consecutive delete-words do not get yanked consecutively #150 - fixed
  • breaks tab expansion of xsel -o -b #154 - fixed
  • Wrap 'yank' (was: Unbreak yank-pop) #183 - fixed
  • strange behavior when using 'setopt ignoreeof' and zsh-syntax-highlighting #377 - fixed
• Doesn't reintroduce Do not highlight in isearch widgets #257 (comment)
• Doesn't reintroduce treat zle-isearch-exit like an accept-* widget #259 (comment)
• Check : /usr/loca<accept-line> removes highlighting
• Document that due to Unsuccessful completion removes highlighting #90 having been fixed, an alternative is to set the format style for the :completion:…:warnings context; the value can include %d or %D.) - done in a75935a
• Update Why must zsh-syntax-highlighting.zsh be sourced at the end of the .zshrc file? FAQ entry - done in 29c6834 + 89bf578
  • Do we need to be the last pre-redraw hook? Does add-zle-hook-widget enable/promise that? - it now promises that; see Use add-zle-hook-widget zle-line-pre-redraw #356

[danielshahaf]

Note #261 was just updated: #261 (comment)

[danielshahaf]

Subtotal: 89bf578 addresses all known issues. Review the history, squash if necessary, merge to master, solicit testing on zsh-workers@ (since zsh features from master are used).

[danielshahaf]

Re-milestoned: 0.5.0 will be released as master minus zsh-5.3 features.

[danielshahaf]

Re-milestoned: We're going to release a quick 0.6.0 so this will be deferred to 0.7.0.

[danielshahaf]

(As this is the umbrella redrawhook issue:)

I just pushed the following:

To github.com:zsh-users/zsh-syntax-highlighting
b08d508..59cb9a5 feature/redrawhook -> feature/redrawhook
d9a7963..8a1bd7c master -> master

Some stats about the first of these:

% git diff --stat b08d508..59cb9a5  | grep -v …
 HACKING.md                                         |   74 +-
 INSTALL.md                                         |   40 +-
 Makefile                                           |    2 +-
 README.md                                          |    5 +
 changelog.md                                       |  364 +++++--
 docs/highlighters.md                               |   53 +-
 docs/highlighters/brackets.md                      |   12 +-
 docs/highlighters/cursor.md                        |    4 +-
 docs/highlighters/line.md                          |    4 +-
 docs/highlighters/main.md                          |   39 +-
 docs/highlighters/pattern.md                       |    9 +-
 docs/highlighters/regexp.md                        |    5 +-
 docs/highlighters/root.md                          |    4 +-
 highlighters/main/main-highlighter.zsh             | 1140 ++++++++++++++------
 highlighters/pattern/pattern-highlighter.zsh       |    2 +-
 highlighters/regexp/regexp-highlighter.zsh         |    2 +-
 zsh-syntax-highlighting.zsh                        |  149 ++-
 172 files changed, 6325 insertions(+), 621 deletions(-)
% git rev-list --count b08d508..59cb9a5 
310
% git show --pretty=fuller $(git rev-list b08d508..59cb9a5 | tail -1) | grep Date:
AuthorDate: Sat Oct 13 08:14:42 2018 -0500
CommitDate: Sat Oct 13 09:37:09 2018 -0500

In other words, this merged to the feature/redrawhook branch some 21 months' worth of changes to master.

Therefore:

• If we start to get bug reports about sudden regressions from users of feature/redrawhook, that'll be the likely reason.

• Such bug reports would also be good to know about before we merge feature/redrawhook into master, where they'd affect many more people.