bug#9356: `event-modifiers' documentation

bug#9356: `event-modifiers' documentation

[Jonathan Ganc]

The documentation for `event-modifiers' states:
"If EVENT is a symbol that has never been used in an event that has been 
read as input in the current Emacs session, then this function can 
return nil, even when EVENT actually has modifiers." However, looking in 
the `event-modifier' definition, the function 
`internal-event-symbol-parse-modifiers' seems to deal with this 
(potential) issue. Can someone give me an example where `event-modifier' 
would inappropriately return nil?

Thanks,
Jonathan


__________ Information from ESET Smart Security, version of virus signature database 6404 (20110823) __________

The message was checked by ESET Smart Security.

http://www.eset.com

bug#9356: `event-modifiers' documentation

[Stefan Monnier]

> The documentation for `event-modifiers' states:
> "If EVENT is a symbol that has never been used in an event that has been
> read as input in the current Emacs session, then this function can return
> nil, even when EVENT actually has modifiers." However, looking in the
> event-modifier' definition, the function
> internal-event-symbol-parse-modifiers' seems to deal with this (potential)
> issue. Can someone give me an example where `event-modifier' would
> inappropriately return nil?

   (event-modifiers 'mouse-1) => (click)
   (event-modifiers 'mouse-10) => nil

Not sure if other modifiers than `click' can be missing.


        Stefan

bug#9356: `event-modifiers' documentation

[Stefan Monnier]

> Does that qualify, though? I'm not sure what the desired behavior for
> mouse-10 would be but, for example,  (event-modifiers 'mouse-9) => (click)
> and I certainly don't have a mouse-9 button.

If you ever manage to get a mouse-10 event, it should (and will) be
labeled as a click.  I've slightly changed the docstring to reflect the
fact that only `click' may be missing (and that this can not only
result in a nil result, e.g. C-mouse-10 will only say (control) instead
of (control click)).


        Stefan


> On 08/24/2011 09:27 AM, Stefan Monnier wrote:
>>> The documentation for `event-modifiers' states:
>>> "If EVENT is a symbol that has never been used in an event that has been
>>> read as input in the current Emacs session, then this function can return
>>> nil, even when EVENT actually has modifiers." However, looking in the
>>> event-modifier' definition, the function
>>> internal-event-symbol-parse-modifiers' seems to deal with this (potential)
>>> issue. Can someone give me an example where `event-modifier' would
>>> inappropriately return nil?
>> (event-modifiers 'mouse-1) =>  (click)
>> (event-modifiers 'mouse-10) =>  nil
>> 
>> Not sure if other modifiers than `click' can be missing.
>> 
>> 
>> Stefan
>> 
>>