Ignore extra/unknown SDL_Keymod bits (mod_) #882
Conversation
| @@ -1619,13 +1619,6 @@ impl Event { | |||
| }} // close unsafe & match | |||
| } | |||
|
|
|||
| pub fn unwrap_keymod(keymod_option: Option<keyboard::Mod>) -> keyboard::Mod { | |||
There was a problem hiding this comment.
It's pub, so I'm not sure if it can be removed without causing breaking change. It might be not intended as pub, however, or might be not visible from outside of crate.
There was a problem hiding this comment.
It is currently visible as you can see here: https://docs.rs/sdl2/0.32.2/sdl2/event/enum.Event.html#method.unwrap_keymod
However I don't see why it was made public since nothing returns an Option<Mod> anymore to my knowledge. Maybe keep it, but annotate it with #[deprecate]? See https://github.com/rust-lang/rfcs/blob/master/text/1270-deprecation.md
Also, can you put a note of the deprecation in the changelog? That would be helpful.
There was a problem hiding this comment.
Restored this method, added deprecation, added an entry to changelog (I didn't mark deprecation with bold font because probably no one is using this API, so it's low importance deprecation).
Tried to build an app against modified version, at least keyboard input works, including detection of pressed shift and control keys (not tested all modifiers).
Also added tests for unknown bits.
kolen
force-pushed
the
ignore-extra-sdl-keymod-bits
branch
from
1c5c36b to
45a00ca
Compare
kolen
force-pushed
the
ignore-extra-sdl-keymod-bits
branch
from
45a00ca to
da4269d
Compare
Ignore extra/unknown SDL_Keymod bits (mod_)
#881
Changed behavior of handling "key modifier" bits unknown to us in
event.key.keysym.mod(SDL_Keymod). Current behavior, before this change, is:After this change, any extraneous bits are ignored.
I created this PR for illustrative purposes for discussion in #881,I don't know if it's a right way to handlemod_bits, and if it's ready to merge.I didn't test it (however tests pass)Superficially tested by building an app against modified version, keyboard input works, including some modifier keys (not tested all modifier keys).