GNU bug report logs - #3863
23.1.50; possible save-match-data in copyright.el

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 3863 in the body.
You can then email your comments to 3863 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Kevin Ryde <user42 <at> zip.com.au>
To: emacs-pretest-bug <at> gnu.org
Subject: 23.1.50; possible save-match-data in copyright.el
Date: Thu, 16 Jul 2009 10:05:39 +1000

[Message part 1 (text/plain, inline)]

In recent copyright.el I noticed copyright-update using the match data
after a y-or-n-p query.  Is that a good idea?

When running it in emacs 22 I seemed to sometimes get the match data
clobbered by y-or-n-p.  I never tracked down the circumstances, but
wondered if copyright.el shouldn't rely on what an input func like
y-or-n-p could do, per diff below.


In GNU Emacs 23.1.50.1 (i586-pc-linux-gnu, GTK+ Version 2.16.4)
 of 2009-07-12 on blah.blah
configured using `configure  'CFLAGS=-O -g' '--prefix=/down/emacs/b/inst' '--with-x-toolkit=gtk''

Important settings:
  value of $LC_ALL: nil
  value of $LC_COLLATE: nil
  value of $LC_CTYPE: nil
  value of $LC_MESSAGES: nil
  value of $LC_MONETARY: nil
  value of $LC_NUMERIC: nil
  value of $LC_TIME: nil
  value of $LANG: en_AU
  value of $XMODIFIERS: nil
  locale-coding-system: iso-latin-1-unix
  default-enable-multibyte-characters: t


2009-07-16  Kevin Ryde  <user42 <at> zip.com.au>

	* emacs-lisp/copyright.el (copyright-update): save-match-data across
	y-or-n-p, for safety.

[copyright.el.save-match-data.diff (text/x-diff, inline)]

*** copyright.el	16 Jul 2009 09:44:20 +1000	1.81
--- copyright.el	16 Jul 2009 09:55:57 +1000	
***************
*** 223,230 ****
                 (< (string-to-number (match-string 3))
                    (string-to-number copyright-current-gpl-version))
  	       (or noquery
! 		   (y-or-n-p (format "Replace GPL version by %s? "
! 				     copyright-current-gpl-version)))
  	       (progn
  		 (if (match-end 2)
  		     ;; Esperanto bilingual comment in two-column.el
--- 223,231 ----
                 (< (string-to-number (match-string 3))
                    (string-to-number copyright-current-gpl-version))
  	       (or noquery
!                    (save-match-data
!                      (y-or-n-p (format "Replace GPL version by %s? "
!                                        copyright-current-gpl-version))))
  	       (progn
  		 (if (match-end 2)
  		     ;; Esperanto bilingual comment in two-column.el

Message #10 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Kevin Ryde <user42 <at> zip.com.au>
Cc: 3863 <at> debbugs.gnu.org, emacs-pretest-bug <at> gnu.org
Subject: Re: bug#3863: 23.1.50; possible save-match-data in copyright.el
Date: Wed, 15 Jul 2009 22:01:47 -0400

> 2009-07-16  Kevin Ryde  <user42 <at> zip.com.au>

> 	* emacs-lisp/copyright.el (copyright-update): save-match-data across
> 	y-or-n-p, for safety.

Thanks, installed,


        Stefan

Message #20 received at 3863 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Chong Yidong <cyd <at> stupidchicken.com>
To: Kevin Ryde <user42 <at> zip.com.au>
Cc: 3863 <at> debbugs.gnu.org
Subject: Re: 23.1.50; possible save-match-data in copyright.el
Date: Thu, 16 Jul 2009 10:33:39 -0400

> In recent copyright.el I noticed copyright-update using the match data
> after a y-or-n-p query.  Is that a good idea?
>
> When running it in emacs 22 I seemed to sometimes get the match data
> clobbered by y-or-n-p.

If so, we should change y-or-n-p to save the match data.  Could you
provide a reproducible test-case for the clobbering of the match data?

Message #25 received at 3863 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Chong Yidong <cyd <at> stupidchicken.com>
Cc: 3863 <at> debbugs.gnu.org, Kevin Ryde <user42 <at> zip.com.au>
Subject: Re: bug#3863: 23.1.50; possible save-match-data in copyright.el
Date: Thu, 16 Jul 2009 13:24:15 -0400

> If so, we should change y-or-n-p to save the match data.

Why?  y-or-n-p will yield waiting for user input, so it's basically
a point where any other code can run.  It's one of the prime examples of
a function which you can't expect to preserve the match-data.


        Stefan

Message #30 received at 3863 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Lennart Borgman <lennart.borgman <at> gmail.com>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>, 3863 <at> debbugs.gnu.org
Cc: Chong Yidong <cyd <at> stupidchicken.com>, Kevin Ryde <user42 <at> zip.com.au>
Subject: Re: bug#3863: 23.1.50; possible save-match-data in copyright.el
Date: Thu, 16 Jul 2009 20:42:42 +0200

On Thu, Jul 16, 2009 at 7:24 PM, Stefan Monnier<monnier <at> iro.umontreal.ca> wrote:
>> If so, we should change y-or-n-p to save the match data.
>
> Why?  y-or-n-p will yield waiting for user input, so it's basically
> a point where any other code can run.  It's one of the prime examples of
> a function which you can't expect to preserve the match-data.

I don't think I understand, but it sounds like this is a reason why
y-or-n-p should save match-data...

Is there any reason not to let y-or-n-p save match data? I mean the
function needing match data possibly want yield until it has used it,
or?

Message #35 received at 3863 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Chong Yidong <cyd <at> stupidchicken.com>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 3863 <at> debbugs.gnu.org, Kevin Ryde <user42 <at> zip.com.au>
Subject: Re: bug#3863: 23.1.50; possible save-match-data in copyright.el
Date: Thu, 16 Jul 2009 14:54:59 -0400

Stefan Monnier <monnier <at> iro.umontreal.ca> writes:

> Why?  y-or-n-p will yield waiting for user input, so it's basically
> a point where any other code can run.  It's one of the prime examples of
> a function which you can't expect to preserve the match-data.

I'm not sure what you're referring to.  What other code runs during
y-or-n-p (excluding timers, which are supposed to save the match data)?

Message #40 received at 3863 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Lennart Borgman <lennart.borgman <at> gmail.com>
Cc: 3863 <at> debbugs.gnu.org, Chong Yidong <cyd <at> stupidchicken.com>,
        Kevin Ryde <user42 <at> zip.com.au>
Subject: Re: bug#3863: 23.1.50; possible save-match-data in copyright.el
Date: Thu, 16 Jul 2009 23:23:29 -0400

> I don't think I understand, but it sounds like this is a reason why
> y-or-n-p should save match-data...

Here we go again:

All functions destroy the match-data except for a few rare exceptions,
which are simple functions doing little work.

> Is there any reason not to let y-or-n-p save match data?

If you think y-or-n-p deserves saving the match-data then pretty much
all other functions deserve that change as well.  And since
save-match-data is somewhat costly, it would imply a singificant
performance impact.


        Stefan


PS: Worse yet: during y-or-n-p, the buffer might be completely changed
by the code run asynchronously, so the "saved" match data may not even
have any meaning any more.

Message #45 received at 3863 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Chong Yidong <cyd <at> stupidchicken.com>
Cc: 3863 <at> debbugs.gnu.org, Kevin Ryde <user42 <at> zip.com.au>
Subject: Re: bug#3863: 23.1.50; possible save-match-data in copyright.el
Date: Thu, 16 Jul 2009 23:24:25 -0400

> I'm not sure what you're referring to.  What other code runs during
> y-or-n-p (excluding timers, which are supposed to save the match data)?

Timers,


        Stefan

Message #50 received at 3863 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Lennart Borgman <lennart.borgman <at> gmail.com>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 3863 <at> debbugs.gnu.org, Chong Yidong <cyd <at> stupidchicken.com>,
        Kevin Ryde <user42 <at> zip.com.au>
Subject: Re: bug#3863: 23.1.50; possible save-match-data in copyright.el
Date: Fri, 17 Jul 2009 06:00:39 +0200

On Fri, Jul 17, 2009 at 5:23 AM, Stefan Monnier<monnier <at> iro.umontreal.ca> wrote:
>> I don't think I understand, but it sounds like this is a reason why
>> y-or-n-p should save match-data...
>
> Here we go again:
>
> All functions destroy the match-data except for a few rare exceptions,
> which are simple functions doing little work.
>
>> Is there any reason not to let y-or-n-p save match data?
>
> If you think y-or-n-p deserves saving the match-data then pretty much
> all other functions deserve that change as well.  And since
> save-match-data is somewhat costly, it would imply a singificant
> performance impact.

Sorry, I just meant that since the functions that prompts the user
can't really impact performance if we just add save-match-data to them
we could do that just to get some more protection.

It does not cure the problem that some functions running in timers
forgets to save match data, but perhaps it catches some actually
occuring problem cases.

Message #55 received at 3863 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: martin rudalics <rudalics <at> gmx.at>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 3863 <at> debbugs.gnu.org
Subject: Re: bug#3863: 23.1.50; possible save-match-data in copyright.el
Date: Fri, 17 Jul 2009 09:57:33 +0200

> If you think y-or-n-p deserves saving the match-data then pretty much
> all other functions deserve that change as well.  And since
> save-match-data is somewhat costly, it would imply a singificant
> performance impact.

You're obviously right and I meanwhile also learned to share your
earlier reservations wrt `looking-at-p' and `string-match-p'.  However,
the underlying problem deserves a profound explanation in the Elisp
manual in oder to avoid such discussions in the future.  So please,
pretty please, write one.

martin

Message #60 received at 3863 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Chong Yidong <cyd <at> stupidchicken.com>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 3863 <at> debbugs.gnu.org, Kevin Ryde <user42 <at> zip.com.au>
Subject: Re: bug#3863: 23.1.50; possible save-match-data in copyright.el
Date: Thu, 16 Jul 2009 23:54:55 -0400

Stefan Monnier <monnier <at> iro.umontreal.ca> writes:

>> I'm not sure what you're referring to.  What other code runs during
>> y-or-n-p (excluding timers, which are supposed to save the match data)?
>
> Timers,

As the Lisp manual states,

     If a timer function calls functions that can change the match data,
  it should save and restore the match data.

If a timer fails to do this, it's a bug, and should be fixed.

Message #65 received at 3863 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Stefan Monnier <monnier <at> IRO.UMontreal.CA>
To: Chong Yidong <cyd <at> stupidchicken.com>
Cc: 3863 <at> debbugs.gnu.org, Kevin Ryde <user42 <at> zip.com.au>
Subject: Re: bug#3863: 23.1.50; possible save-match-data in copyright.el
Date: Fri, 17 Jul 2009 12:00:36 -0400

>>> I'm not sure what you're referring to.  What other code runs during
>>> y-or-n-p (excluding timers, which are supposed to save the match data)?
>> 
>> Timers,

> As the Lisp manual states,

>      If a timer function calls functions that can change the match data,
>   it should save and restore the match data.

> If a timer fails to do this, it's a bug, and should be fixed.

Wonderful, so we all agree there's no need to make y-or-n-p save the
match-data.


        Stefan

Message #70 received at 3863 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Kevin Ryde <user42 <at> zip.com.au>
To: Chong Yidong <cyd <at> stupidchicken.com>
Cc: 3863 <at> debbugs.gnu.org
Subject: Re: 23.1.50; possible save-match-data in copyright.el
Date: Thu, 06 Aug 2009 10:56:43 +1000

Chong Yidong <cyd <at> stupidchicken.com> writes:
>
> Could you
> provide a reproducible test-case for the clobbering of the match data?

When I struck it, which is a while ago now, it was intermittent.  It
could even have been some of my own input defadvice stuff, though I
thought it wasn't.

Message #75 received at 3863-done <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Kevin Ryde <user42 <at> zip.com.au>
To: 3863-done <at> debbugs.gnu.org
Subject: Re: bug#3863: 23.1.50; possible save-match-data in copyright.el
Date: Fri, 02 Oct 2009 10:14:07 +1000

Closing for,

Stefan Monnier <monnier <at> iro.umontreal.ca> writes:
>
> installed,

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.