Mir

input/event.h & MirEvent have confused purposes

Bug #1110117 reported by Daniel van Vugt
12
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Mir
Fix Released
Medium
Daniel van Vugt

Bug Description

input/event.h & MirEvent have confused purposes.

On one hand, they are used exclusively for input right now so "input/event.h" is accurate. On the other handle, the type "MirEvent" is a generic name in a file that is specifically about input.

There is similar confusion in: include/shared/mir_toolkit/c_types.h
All the comments and some identifiers say MirEvent is only for input. But the name "MirEvent" suggests it could be for any event type.

This is a source of confusion that we need to resolve because I am presently developing generic "events" that are not "input" at all.

Related branches

Changed in mir:
importance: Undecided → Medium
Revision history for this message
Daniel van Vugt (vanvugt) wrote :

Sorry, I mean the generic definition of MirEvent and event.h should not be in input/. However the input event definitions should probably stay under input/ somehow.

summary: - event.h needs to be moved out of "input/"
+ event.h needs to be moved/split out of "input/"
information type: Proprietary → Public
Robert Carr (robertcarr)
Changed in mir:
status: New → Fix Committed
Revision history for this message
Daniel van Vugt (vanvugt) wrote : Re: event.h needs to be moved/split out of "input/"

Not fixed at all...

$ find . -name event.h
./include/shared/mir_toolkit/input/event.h

Changed in mir:
status: Fix Committed → Triaged
Revision history for this message
Thomas Voß (thomas-voss) wrote :

Agreed, what would be a sensible new location for the header file?

Revision history for this message
Daniel van Vugt (vanvugt) wrote :

I think this bug is now invalid. It was based on the assumption that input and surface events would use the same transport/channel, but that's not true now.

event.h will ONLY represent input events for the foreseeable future. So it is correct to live in input/event.h

What might still need fixing is the name "MirEvent". It should probably be clarified and renamed to "MirInputEvent". But that's off-topic for this bug.

Changed in mir:
status: Triaged → Invalid
Revision history for this message
Daniel van Vugt (vanvugt) wrote :

Changed my mind. Lets keep this bug. I have updated the title and description.

summary: - event.h needs to be moved/split out of "input/"
+ input/event.h & MirEvent have confused purposes
description: updated
Changed in mir:
status: Invalid → Confirmed
Changed in mir:
assignee: nobody → Daniel van Vugt (vanvugt)
milestone: none → 0.0.3
Changed in mir:
status: Confirmed → In Progress
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :

Fix committed into lp:mir at revision None, scheduled for release in mir, milestone 0.0.3

Changed in mir:
status: In Progress → Fix Committed
Changed in mir:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.