zsh-users
 help / color / mirror / code / Atom feed
From: Zach Riggle <zachriggle@gmail.com>
To: Zsh Users <zsh-users@zsh.org>
Subject: Odd behavior with various (q) array modifiers and non-printable characters (backspace, newline)
Date: Wed, 11 Aug 2021 15:29:07 -0500	[thread overview]
Message-ID: <CAMP9c5k=MRwfuR_xNzJjUAMO8ds7Kr=OpM2QMD9+A9hLKHu3iw@mail.gmail.com> (raw)

Hello all!  It's me again, hopefully with a useful question.

TLDR: (q-) behaves unexpectedly for \010 aka "\b", and there are other
corner cases that may be unintended.

I love the (q-) modifier for array expansion, since it allows printing
out e.g. a command and then running it.

    run() {
        echo '$' "${(q-)@}"
        "$@"
    }

The docs (https://zsh.sourceforge.io/Doc/Release/Expansion.html,
search for "q-" to jump to the right area) state:

> If a q- is given (only a single q may appear), a minimal form of single quoting is used that only quotes the string if needed to protect special characters. Typically this form gives the most readable output.
> If a q+ is given, an extended form of minimal quoting is used that causes unprintable characters to be rendered using $’...’. This quoting is similar to that used by the output of values by the typeset family of commands.

However, it appears that half of the q modifiers handle 0x08 / \010 /
"\b" aka "backspace" in an unexpected manner.  Notably, (q) is
incorrect, (qq) (q+) and (q-) embed a literal backspace, which causes
unexpected output (it's there if you pipe to e.g. xxd, but it should
be escaped).

    $ mysed=( gsed "s/\ba\b/x/" )

    $ echo "aaaa a aaa" | "${mysed[@]}"
    aaaa x aaa

    $ echo ${(q)mysed}
    gsed s/\ba\b/x/

    $ echo ${(qq)mysed}
    'gsed' 's/x/'

    $ echo ${(qqq)mysed}
    "gsed" "s/\ba\b/x/"

    $ echo ${(qqqq)mysed}
    $'gsed' $'s/\ba\b/x/'

    $ echo ${(q+)mysed}
    gsed 's/x/'

    $ echo ${(q-)mysed}
    gsed 's/x/'

This issue also appears with newlines, but for these one could argue
it's entirely legitimate to have a *literal* newline that breaks the
quoted statement onto multiple lines.  Once again, the same culprits
are (qq), (q-), and (q+).  Interestingly, bare (q) is actually
incorrect.

    $ newline=( aa "b\nb" cc )

    $ echo ${(q)newline}
    aa b\nb cc

    $ echo ${(qq)newline}
    'aa' 'b
    b' 'cc'

    $ echo ${(qqq)newline}
    "aa" "b\nb" "cc"

    $ echo ${(qqqq)newline}
    $'aa' $'b\nb' $'cc'

    $ echo ${(q-)newline}
    aa 'b
    b' cc

    $ echo ${(q+)newline}
    aa 'b
    b' cc

IMHO both newline and backspace should be escaped at LEAST for (q-)
and (q+), and newline behavior for (q) is incorrect.  What's your
opinion?

Zach Riggle


             reply	other threads:[~2021-08-11 20:30 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-11 20:29 Zach Riggle [this message]
2021-08-11 21:16 ` Bart Schaefer
2021-08-11 21:42   ` Lawrence Velázquez
2021-08-11 23:25     ` Zach Riggle
2021-08-12  0:22       ` Bart Schaefer
2021-08-12  0:34         ` Lawrence Velázquez
2021-08-12 13:34         ` Ray Andrews
2021-08-12  0:36       ` Lawrence Velázquez
2021-08-14 15:52     ` Daniel Shahaf
2021-10-19 19:17       ` Zach Riggle
2021-10-21 14:24         ` Daniel Shahaf
2021-10-21 15:23           ` Bart Schaefer
2021-08-11 21:27 ` Bart Schaefer

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CAMP9c5k=MRwfuR_xNzJjUAMO8ds7Kr=OpM2QMD9+A9hLKHu3iw@mail.gmail.com' \
    --to=zachriggle@gmail.com \
    --cc=zsh-users@zsh.org \
    /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.vuxu.org/mirror/zsh/

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 NNTP newsgroup(s).