1059663 - Input Management scripts: Don't interchangeably use |group| and |type| variable names

Status: RESOLVED FIXED

(Firefox OS Graveyard :: Gaia::System::Input Mgmt, defect)

Description

[John Lu [:mnjul][Please NI or I'll miss]]

In the current keyboard_manager.js (and probably those submodules it uses) we sometimes use variable name |type| when we actually mean |group|. While for most of the time the exact meaning of a |type| variable (whether it's the "type" attribute of an <input> or the group as a result of type-to-group mapping) can be deduced from the context, we want to avoid confusing ourselves in the future.

Comment 1

[John Lu [:mnjul][Please NI or I'll miss]]

Attachment: Patch (PR @ GitHub)

Tim,

This patch looks big but does tidy things quite up. This is probably my last big patch during my more focusing on input management refactoring, before I begin to focus more on bug 1044525 and see if Alive can have time to discuss with me KeyboardWindowManager (or whatever that name is gonna be).

Copy of my multi-line commit log:
- Move group-to-type reverse mapping generation to |InputLayouts| since it's used only there
- Move handling of mozChrome events into |handleEvent()|
- Extract |onTransitionStateChange|
- Eliminate use of |self|
- Rename |showAll| to |showImeMenu|
- Eliminate interchangeability between |type| and |group| to better reflect the idea in Input Management

Additionally the script should now be clean enough to make it out of jshint xfail list (I tried and only a few hiccups to fix). Shall I do it (in a follow-up bug)?

Thanks for your feedback & reviewing!

Comment 2

[Tim Guan-tin Chien [:timdream] (please needinfo)]

Comment on attachment 8484819 [details] [review]
Patch (PR @ GitHub)

Do a quick grep to make sure no one else is probing your properties?

Comment 3

[John Lu [:mnjul][Please NI or I'll miss]]

(In reply to Tim Guan-tin Chien [:timdream] (MoCo-TPE) (please ni?) from comment #2)
> Comment on attachment 8484819 [details] [review]
> Patch (PR @ GitHub)
> 
> Do a quick grep to make sure no one else is probing your properties?

Ah, I forgot to mention that. I had done the necessary greps and ensured things were good before I requested for review.

Well, on thinking about this, maybe we should underscore-prefix those private members of the script to make other developers more aware of their intended private-ness. I'll track it.

Comment 4

[John Lu [:mnjul][Please NI or I'll miss]]

Master: https://github.com/mozilla-b2g/gaia/commit/0216f758d4a7a573f2d1fe3ea89b14f73c29c7e3