emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Aaron Ecay <aaronecay@gmail.com>
To: Nicolas Goaziou <mail@nicolasgoaziou.fr>,
	orgmode <emacs-orgmode@gnu.org>
Subject: Re: [RFC] [PATCH] Automatically quote the arguments to an eval	macro
Date: Thu, 05 Nov 2015 14:29:08 +0000	[thread overview]
Message-ID: <87pozov7t7.fsf@gmail.com> (raw)
In-Reply-To: <874mh0q1of.fsf@nicolasgoaziou.fr>

Hi Nicolas,

Thanks for your feedback.

2015ko azaroak 5an, Nicolas Goaziou-ek idatzi zuen:

[...]

>> This means:
>> 1. Users need to remember to put quotes around $n all the time
>> 2. It’s impossible to pass arguments with a " character to a macro
> 
> This can be fixed by removing the `literal' optional argument from
> `replace-regexp-in-string' call in `org-macro-expand'.

I’ve actually managed to make it work with the code as-is, by escaping
the quote with a single backslash.  I must have been confused about
single- vs. double-escaping.

The inconsistency that remains is that quotes need to be backslash-escaped
for eval macros, but not regular macros.

Here’s a test case (works with current master):

,----
| #+macro: foo $1
| 
| {{{foo(xyz\"abc)}}}
| 
| #+macro: bar (eval "$1")
| 
| {{{bar(xyz\"abc)}}}
`----

Ascii export yields:

,----
| Foo is: xyz\"abc
| 
| Bar is: xyz"abc
`----

> 
>> The attached patch changes the behavior of eval macro arguments so that
>> $1 etc. expand to the argument with quotation marks.  That is, the
>> following is now the correct way to write a macro (note lack of "s):
>> 
>> #+macro: identity (eval $1)
> 
> I'm not totally opposed to it but it introduces a limitation: all
> arguments must be strings. This is not strictly required, actually. As
> a consequence, I slightly prefer fixing the current situation instead.
> 
> Is there any strong reason to force string?

I’d say the reason is that (AIUI) macros are for string manipulation
during export.  I’m hard-pressed to come up with a good usage of a macro
that treats its arguments as non-strings.  But maybe that’s just a
function of my limited creativity. :)

> 
>> * lisp/org-macro.el (org-macro-expand): Automatically quote the
>> arguments to an eval macro.
> 
> You would also need to update `org-macro-initialize-templates' and
> `org-export-as'.
> 
>> +			(cond
>> +			 (evalp (format "%S" arg-val))
>> +			 (arg-val arg-val)
> 
> Nitpick: this is equivalent to (arg-val)

I didn’t know this usage of cond....

Thanks again,

-- 
Aaron Ecay

      reply	other threads:[~2015-11-05 14:29 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-11-04 14:30 [RFC] [PATCH] Automatically quote the arguments to an eval macro Aaron Ecay
2015-11-05  8:40 ` Nicolas Goaziou
2015-11-05 14:29   ` Aaron Ecay [this message]

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=87pozov7t7.fsf@gmail.com \
    --to=aaronecay@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=mail@nicolasgoaziou.fr \
    /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).