From: Eli Barzilay <eli@barzilay.org>
To: 17507@debbugs.gnu.org
Subject: bug#17507: Documentation for `add-text-property' and relatives
Date: Fri, 16 May 2014 02:25:18 -0400 [thread overview]
Message-ID: <21365.44878.936634.958813@home.barzilay.org> (raw)
It was unclear to me how to use `add-text-property' and its relatives
(I actually started with `font-lock-append-text-property') with
strings, since they don't return the string. It also looks like it
won't be practical to ask for a change where they do return the string
(if given one) since `add-text-properties' actually has a specified
return value (which is arguably not as useful as getting back a
string...).
In any case, I eventually found out what I need to do, but it took me
a while because I was confused. This is a bit verbose, but please
bear with me...
What I was surprised to find out is that
(let ((s "foo")) (put-text-property 0 3 'foo 'bar s) s)
works. It's probably obvious for elisp hackers, but coming from
most other lisps/schemes, I kind of assumed that the #("foo" ...)
thing is made of the "foo" string in some vector-like container that
holds the properties. Given that unconscious assumption, I assumed
that it wouldn't work, and that I'll need some uglier hack like
(let ((s (propertize "foo" 'foo nil)))
(put-text-property 0 3 'foo 'bar s) s)
so that `s' points to an object that can be mutated inside.
So I think that it would be a good idea to add a comment in the docs
(of all of these functions) that notes that when given a string, they
mutate it, and it works even if the input is property-less. Or just
make it easier with showing a example as the above.
(Hopefully the above makes sense -- I wonder how many lispers who are
not native e-lispers have that assumption...)
--
((lambda (x) (x x)) (lambda (x) (x x))) Eli Barzilay:
http://barzilay.org/ Maze is Life!
next reply other threads:[~2014-05-16 6:25 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-05-16 6:25 Eli Barzilay [this message]
2019-08-14 23:57 ` bug#17507: Documentation for `add-text-property' and relatives Lars Ingebrigtsen
2019-08-15 3:41 ` Eli Barzilay
2019-08-15 14:30 ` Eli Zaretskii
2019-08-16 1:35 ` Eli Barzilay
2019-08-16 8:46 ` Eli Zaretskii
2019-08-16 20:04 ` Lars Ingebrigtsen
2019-08-17 6:47 ` Eli Zaretskii
2019-08-17 22:22 ` Richard Stallman
2019-08-16 23:49 ` Eli Barzilay
2019-08-17 6:41 ` Eli Zaretskii
2019-08-17 12:40 ` Eli Barzilay
2019-08-17 12:46 ` Eli Zaretskii
2019-08-16 1:20 ` Lars Ingebrigtsen
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.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=21365.44878.936634.958813@home.barzilay.org \
--to=eli@barzilay.org \
--cc=17507@debbugs.gnu.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.savannah.gnu.org/cgit/emacs.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).