Typo in 'org-without-partial-completion'

Typo in 'org-without-partial-completion'

[Paul Sexton]

I think there's an error in 'org-without-partial-completion' in org-macs.el.
The variable pc-mode gets bound to the value of partial-completion-mode - but 
this is a VARIABLE (t if that mode is enabled). Funcalling the value of 
the variable produces an error, unsurprisingly. This breaks insertion of 
properties with 'org-set-property'. 

Fixing it involves quoting the the symbol as shown below:


(defmacro org-without-partial-completion (&rest body)
   `(let ((pc-mode (and (boundp 'partial-completion-mode)
                        'partial-completion-mode)))   ; <-- quote added
      (unwind-protect
          (progn
            (when pc-mode (funcall pc-mode -1))
            ,@body)
        (when pc-mode (funcall pc-mode 1)))))

Re: Typo in 'org-without-partial-completion'

[Bastien]

Hi Paul,

Paul Sexton <psexton@xnet.co.nz> writes:

> I think there's an error in 'org-without-partial-completion' in org-macs.el.
> The variable pc-mode gets bound to the value of partial-completion-mode - but 
> this is a VARIABLE (t if that mode is enabled). Funcalling the value of 
> the variable produces an error, unsurprisingly. This breaks insertion of 
> properties with 'org-set-property'. 
>
> Fixing it involves quoting the the symbol as shown below:
>
>
> (defmacro org-without-partial-completion (&rest body)
>    `(let ((pc-mode (and (boundp 'partial-completion-mode)
>                         'partial-completion-mode)))   ; <-- quote added
>       (unwind-protect
>           (progn
>             (when pc-mode (funcall pc-mode -1))
>             ,@body)
>         (when pc-mode (funcall pc-mode 1)))))

You're right -- thanks for spotting this, and for the clear analysis.

I've committed a patch.

-- 
 Bastien

Re: Typo in 'org-without-partial-completion'

[Bastien]

Hi Paul,

Paul Sexton <psexton@xnet.co.nz> writes:

> I think there's an error in 'org-without-partial-completion' in org-macs.el.
> The variable pc-mode gets bound to the value of partial-completion-mode - but 
> this is a VARIABLE (t if that mode is enabled). Funcalling the value of 
> the variable produces an error, unsurprisingly. This breaks insertion of 
> properties with 'org-set-property'. 
>
> Fixing it involves quoting the the symbol as shown below:
>
>
> (defmacro org-without-partial-completion (&rest body)
>    `(let ((pc-mode (and (boundp 'partial-completion-mode)
>                         'partial-completion-mode)))   ; <-- quote added
>       (unwind-protect
>           (progn
>             (when pc-mode (funcall pc-mode -1))
>             ,@body)
>         (when pc-mode (funcall pc-mode 1)))))

I've just reverted this modification, per Sebastian report.

Can you be more precise about the problem it creates with
org-set-property?

Can you check if this version fixes the problems, if any?

#+begin_src emacs-lisp
(defmacro org-without-partial-completion (&rest body)
  `(let ((pc-mode ,(and (boundp 'partial-completion-mode)
			'partial-completion-mode)))
     (unwind-protect
	 (progn
	   (when pc-mode (funcall pc-mode -1))
	   ,@body)
       (when pc-mode (funcall pc-mode 1)))))
#+end_src emacs-lisp

Thanks!

-- 
 Bastien

Re: Typo in 'org-without-partial-completion'

[David Maus]

[-- Attachment #1: Type: text/plain, Size: 3188 bytes --]

At Thu, 30 Jun 2011 11:12:15 +0200,
Bastien wrote:
> 
> Hi Paul,
> 
> Paul Sexton <psexton@xnet.co.nz> writes:
> 
> > I think there's an error in 'org-without-partial-completion' in org-macs.el.
> > The variable pc-mode gets bound to the value of partial-completion-mode - but 
> > this is a VARIABLE (t if that mode is enabled). Funcalling the value of 
> > the variable produces an error, unsurprisingly. This breaks insertion of 
> > properties with 'org-set-property'. 
> >
> > Fixing it involves quoting the the symbol as shown below:
> >
> >
> > (defmacro org-without-partial-completion (&rest body)
> >    `(let ((pc-mode (and (boundp 'partial-completion-mode)
> >                         'partial-completion-mode)))   ; <-- quote added
> >       (unwind-protect
> >           (progn
> >             (when pc-mode (funcall pc-mode -1))
> >             ,@body)
> >         (when pc-mode (funcall pc-mode 1)))))
> 
> I've just reverted this modification, per Sebastian report.
> 
> Can you be more precise about the problem it creates with
> org-set-property?
> 
> Can you check if this version fixes the problems, if any?
> 
> #+begin_src emacs-lisp
> (defmacro org-without-partial-completion (&rest body)
>   `(let ((pc-mode ,(and (boundp 'partial-completion-mode)
> 			'partial-completion-mode)))
>      (unwind-protect
> 	 (progn
> 	   (when pc-mode (funcall pc-mode -1))
> 	   ,@body)
>        (when pc-mode (funcall pc-mode 1)))))
> #+end_src emacs-lisp

No, I think this won't work. On compile time the byte compiler will
expand the macro and place the expansion in the byte compiled
lisp. Thus it will evaluate the ,(and ...) condition at compile time.

http://www.gnu.org/software/emacs/elisp/html_node/Compiling-Macros.html#Compiling-Macros

#+begin_quote
When a macro call appears in a Lisp program being compiled, the Lisp
compiler calls the macro definition just as the interpreter would, and
receives an expansion. But instead of evaluating this expansion, it
compiles the expansion as if it had appeared directly in the
program. As a result, the compiled code produces the value and side
effects intended for the macro, but executes at full compiled
speed. This would not work if the macro body computed the value and
side effects itself—they would be computed at compile time, which is
not useful.
#+end_quote

What about this:

#+begin_src emacs-lisp
  (defmacro org-without-partial-completion (&rest body)
    `(let ((pc-mode-p (and (boundp 'partial-completion-mode)
                           (fboundp 'partial-completion-mode))))
       (when pc-mode-p
         (unwind-protect
             (progn
               (partial-completion-mode -1)
               ,@body)
           (partial-completion-mode 1)))))
#+end_src

This will turn off partial-completion-mode if the symbol is non-nil
and callable.

For Sebastien's problem: Strange thing. Looks like the symbol
partial-completion-mode is non-nil but not callable. 

Maybe an Emacs 24 development version issue?

Best,
  -- David
-- 
OpenPGP... 0x99ADB83B5A4478E6
Jabber.... dmjena@jabber.org
Email..... dmaus@ictsoc.de

[-- Attachment #2: Type: application/pgp-signature, Size: 230 bytes --]

Re: Typo in 'org-without-partial-completion'

[David Maus]

[-- Attachment #1: Type: text/plain, Size: 3695 bytes --]

At Thu, 30 Jun 2011 21:28:08 +0200,
David Maus wrote:
> 
> At Thu, 30 Jun 2011 11:12:15 +0200,
> Bastien wrote:
> > 
> > Hi Paul,
> > 
> > Paul Sexton <psexton@xnet.co.nz> writes:
> > 
> > > I think there's an error in 'org-without-partial-completion' in org-macs.el.
> > > The variable pc-mode gets bound to the value of partial-completion-mode - but 
> > > this is a VARIABLE (t if that mode is enabled). Funcalling the value of 
> > > the variable produces an error, unsurprisingly. This breaks insertion of 
> > > properties with 'org-set-property'. 
> > >
> > > Fixing it involves quoting the the symbol as shown below:
> > >
> > >
> > > (defmacro org-without-partial-completion (&rest body)
> > >    `(let ((pc-mode (and (boundp 'partial-completion-mode)
> > >                         'partial-completion-mode)))   ; <-- quote added
> > >       (unwind-protect
> > >           (progn
> > >             (when pc-mode (funcall pc-mode -1))
> > >             ,@body)
> > >         (when pc-mode (funcall pc-mode 1)))))
> > 
> > I've just reverted this modification, per Sebastian report.
> > 
> > Can you be more precise about the problem it creates with
> > org-set-property?
> > 
> > Can you check if this version fixes the problems, if any?
> > 
> > #+begin_src emacs-lisp
> > (defmacro org-without-partial-completion (&rest body)
> >   `(let ((pc-mode ,(and (boundp 'partial-completion-mode)
> > 			'partial-completion-mode)))
> >      (unwind-protect
> > 	 (progn
> > 	   (when pc-mode (funcall pc-mode -1))
> > 	   ,@body)
> >        (when pc-mode (funcall pc-mode 1)))))
> > #+end_src emacs-lisp
> 
> No, I think this won't work. On compile time the byte compiler will
> expand the macro and place the expansion in the byte compiled
> lisp. Thus it will evaluate the ,(and ...) condition at compile time.
> 
> http://www.gnu.org/software/emacs/elisp/html_node/Compiling-Macros.html#Compiling-Macros
> 
> #+begin_quote
> When a macro call appears in a Lisp program being compiled, the Lisp
> compiler calls the macro definition just as the interpreter would, and
> receives an expansion. But instead of evaluating this expansion, it
> compiles the expansion as if it had appeared directly in the
> program. As a result, the compiled code produces the value and side
> effects intended for the macro, but executes at full compiled
> speed. This would not work if the macro body computed the value and
> side effects itself—they would be computed at compile time, which is
> not useful.
> #+end_quote
> 
> What about this:
> 
> #+begin_src emacs-lisp
>   (defmacro org-without-partial-completion (&rest body)
>     `(let ((pc-mode-p (and (boundp 'partial-completion-mode)
>                            (fboundp 'partial-completion-mode))))
>        (when pc-mode-p
>          (unwind-protect
>              (progn
>                (partial-completion-mode -1)
>                ,@body)
>            (partial-completion-mode 1)))))
> #+end_src
> 
> This will turn off partial-completion-mode if the symbol is non-nil
> and callable.


Or even better:

#+begin_src emacs-lisp
  (defmacro org-without-partial-completion (&rest body)
    `(when (and (boundp 'partial-completion-mode)
                (fboundp 'partial-completion-mode))
       (unwind-protect
           (progn
             (partial-completion-mode -1)
             ,@body)
         (partial-completion-mode 1))))
#+end_src

This avoids leaking if 'body happens to uses a symbol 'pc-mode-p in a
different context.

Best,
  -- David
-- 
OpenPGP... 0x99ADB83B5A4478E6
Jabber.... dmjena@jabber.org
Email..... dmaus@ictsoc.de

[-- Attachment #2: Type: application/pgp-signature, Size: 230 bytes --]

Re: Typo in 'org-without-partial-completion'

[Bastien]

Hi David and Paul,

David Maus <dmaus@ictsoc.de> writes:

> #+begin_src emacs-lisp
>   (defmacro org-without-partial-completion (&rest body)
>     `(when (and (boundp 'partial-completion-mode)
>                 (fboundp 'partial-completion-mode))
>        (unwind-protect
>            (progn
>              (partial-completion-mode -1)
>              ,@body)
>          (partial-completion-mode 1))))
> #+end_src

That's clearly better -- thanks for this.  I applied this change, 
thanks for this improvement!

Paul, please let me know if things don't behave as expected.

-- 
 Bastien

Re: Typo in 'org-without-partial-completion'

[David Maus]

[-- Attachment #1: Type: text/plain, Size: 819 bytes --]

At Sat, 02 Jul 2011 11:26:59 +0200,
Bastien wrote:
>
> Hi David and Paul,
>
> David Maus <dmaus@ictsoc.de> writes:
>
> > #+begin_src emacs-lisp
> >   (defmacro org-without-partial-completion (&rest body)
> >     `(when (and (boundp 'partial-completion-mode)
> >                 (fboundp 'partial-completion-mode))
> >        (unwind-protect
> >            (progn
> >              (partial-completion-mode -1)
> >              ,@body)
> >          (partial-completion-mode 1))))
> > #+end_src
>
> That's clearly better -- thanks for this.  I applied this change,
> thanks for this improvement!
>
> Paul, please let me know if things don't behave as expected.

da086f9606d1875b5270dd367d7f5326b7ed8e9a ;)

david > (sloppy-mode -1)

--
OpenPGP... 0x99ADB83B5A4478E6
Jabber.... dmjena@jabber.org
Email..... dmaus@ictsoc.de

[-- Attachment #2: Type: application/pgp-signature, Size: 230 bytes --]

Re: Typo in 'org-without-partial-completion'

[Nick Dokos]

David Maus <dmaus@ictsoc.de> wrote:


> #+begin_src emacs-lisp
>   (defmacro org-without-partial-completion (&rest body)
>     `(when (and (boundp 'partial-completion-mode)
>                 (fboundp 'partial-completion-mode))
>        (unwind-protect
>            (progn
>              (partial-completion-mode -1)
>              ,@body)
>          (partial-completion-mode 1))))
> #+end_src
> 
> This avoids leaking if 'body happens to uses a symbol 'pc-mode-p in a
> different context.
> 

Won't this turn on the mode even if it was off before the macro ws called?
And if so, isn't that a problem?

Nick

Re: Typo in 'org-without-partial-completion'

[David Maus]

[-- Attachment #1: Type: text/plain, Size: 1019 bytes --]

At Sat, 02 Jul 2011 10:40:31 -0400,
Nick Dokos wrote:
>
> David Maus <dmaus@ictsoc.de> wrote:
>
>
> > #+begin_src emacs-lisp
> >   (defmacro org-without-partial-completion (&rest body)
> >     `(when (and (boundp 'partial-completion-mode)
> >                 (fboundp 'partial-completion-mode))
> >        (unwind-protect
> >            (progn
> >              (partial-completion-mode -1)
> >              ,@body)
> >          (partial-completion-mode 1))))
> > #+end_src
> >
> > This avoids leaking if 'body happens to uses a symbol 'pc-mode-p in a
> > different context.
> >
>
> Won't this turn on the mode even if it was off before the macro ws called?
> And if so, isn't that a problem?

Yes and yes.

(and (boundp 'partial-completion-mode)
     partial-completion-mode
     (fboundp 'partial-completion-mode))

Is the right condition. Bound, non-nil and callable.

@Bastien: Pushed fix for this to master.

Best,
  -- David
--
OpenPGP... 0x99ADB83B5A4478E6
Jabber.... dmjena@jabber.org
Email..... dmaus@ictsoc.de

[-- Attachment #2: Type: application/pgp-signature, Size: 230 bytes --]

Re: Typo in 'org-without-partial-completion'

[Bastien]

Hi Nick, David,

David Maus <dmaus@ictsoc.de> writes:

> Yes and yes.
>
> (and (boundp 'partial-completion-mode)
>      partial-completion-mode
>      (fboundp 'partial-completion-mode))
>
> Is the right condition. Bound, non-nil and callable.
>
> @Bastien: Pushed fix for this to master.

Thanks!

-- 
 Bastien