def main(argv):
with Display() as display:
signal.signal(signal.SIGINT, partial(sig_cb, display))
backend = Backend(display)
renderer = Renderer(backend, display)
compositor = Compositor(display, renderer) # noqa: F841
device_manager = DataDeviceManager(display) # noqa: F841
xdg_shell = XdgShell(display)
with OutputLayout() as output_layout, Cursor(
output_layout) as cursor, XCursorManager(
24) as xcursor_manager, Seat(display, "seat0") as seat:
tinywl_server = TinywlServer( # noqa: F841
display=display,
backend=backend,
renderer=renderer,
xdg_shell=xdg_shell,
cursor=cursor,
cursor_manager=xcursor_manager,
seat=seat,
output_layout=output_layout,
)
socket = display.add_socket()
print("socket:", socket.decode())
with backend:
display.run()
def main(argv) -> None:
with Display() as display:
compositor, allocator, renderer, backend = build_compositor(display)
device_manager = DataDeviceManager(display) # noqa: F841
xdg_shell = XdgShell(display)
with OutputLayout() as output_layout, Cursor(
output_layout
) as cursor, XCursorManager(24) as xcursor_manager, Seat(
display, "seat0"
) as seat:
scene = Scene(output_layout)
tinywl_server = TinywlServer( # noqa: F841
display=display,
backend=backend,
allocator=allocator,
renderer=renderer,
scene=scene,
xdg_shell=xdg_shell,
cursor=cursor,
cursor_manager=xcursor_manager,
seat=seat,
output_layout=output_layout,
)
socket = display.add_socket()
print("socket:", socket.decode())
with backend:
display.run()
def __init__(self):
"""Setup the Wayland core backend"""
self.qtile: Optional[Qtile] = None
self.desktops: int = 1
self.current_desktop: int = 0
self.display = Display()
self.event_loop = self.display.get_event_loop()
self.compositor, self.backend = wlroots_helper.build_compositor(
self.display)
self.renderer = self.backend.renderer
self.socket = self.display.add_socket()
self.fd = None
self._hovered_internal: Optional[window.Internal] = None
# These windows have not been mapped yet; they'll get managed when mapped
self.pending_windows: List[window.WindowType] = []
# mapped_windows contains just regular windows
self.mapped_windows: List[window.WindowType] = [] # Ascending in Z
# stacked_windows also contains layer_shell windows from the current output
self.stacked_windows: List[window.WindowType] = [] # Ascending in Z
self._current_output: Optional[Output] = None
# set up inputs
self.keyboards: List[keyboard.Keyboard] = []
self.grabbed_keys: List[Tuple[int, int]] = []
self.grabbed_buttons: List[Tuple[int, int]] = []
DataDeviceManager(self.display)
DataControlManagerV1(self.display)
self.seat = seat.Seat(self.display, "seat0")
self.add_listener(self.seat.request_set_selection_event,
self._on_request_set_selection)
self.add_listener(self.backend.new_input_event, self._on_new_input)
# set up outputs
self.outputs: List[Output] = []
self.add_listener(self.backend.new_output_event, self._on_new_output)
self.output_layout = OutputLayout()
self.add_listener(self.output_layout.change_event,
self._on_output_layout_change)
self.output_manager = OutputManagerV1(self.display)
self.add_listener(self.output_manager.apply_event,
self._on_output_manager_apply)
self.add_listener(self.output_manager.test_event,
self._on_output_manager_test)
# set up cursor
self.cursor = Cursor(self.output_layout)
self.cursor_manager = XCursorManager(24)
self.add_listener(self.seat.request_set_cursor_event,
self._on_request_cursor)
self.add_listener(self.cursor.axis_event, self._on_cursor_axis)
self.add_listener(self.cursor.frame_event, self._on_cursor_frame)
self.add_listener(self.cursor.button_event, self._on_cursor_button)
self.add_listener(self.cursor.motion_event, self._on_cursor_motion)
self.add_listener(self.cursor.motion_absolute_event,
self._on_cursor_motion_absolute)
# set up shell
self.xdg_shell = XdgShell(self.display)
self.add_listener(self.xdg_shell.new_surface_event,
self._on_new_xdg_surface)
self.layer_shell = LayerShellV1(self.display)
self.add_listener(self.layer_shell.new_surface_event,
self._on_new_layer_surface)
# Add support for additional protocols
XdgOutputManagerV1(self.display, self.output_layout)
ScreencopyManagerV1(self.display)
GammaControlManagerV1(self.display)
PrimarySelectionV1DeviceManager(self.display)
self._virtual_keyboard_manager_v1 = VirtualKeyboardManagerV1(
self.display)
self.add_listener(
self._virtual_keyboard_manager_v1.new_virtual_keyboard_event,
self._on_new_virtual_keyboard)
xdg_decoration_manager_v1 = xdg_decoration_v1.XdgDecorationManagerV1.create(
self.display)
self.add_listener(
xdg_decoration_manager_v1.new_toplevel_decoration_event,
self._on_new_toplevel_decoration,
)
# wlr_server_decoration will be removed in a future version of wlroots
server_decoration_manager = ServerDecorationManager.create(
self.display)
server_decoration_manager.set_default_mode(
ServerDecorationManagerMode.SERVER)
# start
os.environ["WAYLAND_DISPLAY"] = self.socket.decode()
logger.info("Starting core with WAYLAND_DISPLAY=" +
self.socket.decode())
self.backend.start()
class Core(base.Core, wlrq.HasListeners):
def __init__(self):
"""Setup the Wayland core backend"""
self.qtile: Optional[Qtile] = None
self.desktops: int = 1
self.current_desktop: int = 0
self.display = Display()
self.event_loop = self.display.get_event_loop()
self.compositor, self.backend = wlroots_helper.build_compositor(
self.display)
self.renderer = self.backend.renderer
self.socket = self.display.add_socket()
self.fd = None
self._hovered_internal: Optional[window.Internal] = None
# These windows have not been mapped yet; they'll get managed when mapped
self.pending_windows: List[window.WindowType] = []
# mapped_windows contains just regular windows
self.mapped_windows: List[window.WindowType] = [] # Ascending in Z
# stacked_windows also contains layer_shell windows from the current output
self.stacked_windows: List[window.WindowType] = [] # Ascending in Z
self._current_output: Optional[Output] = None
# set up inputs
self.keyboards: List[keyboard.Keyboard] = []
self.grabbed_keys: List[Tuple[int, int]] = []
self.grabbed_buttons: List[Tuple[int, int]] = []
DataDeviceManager(self.display)
DataControlManagerV1(self.display)
self.seat = seat.Seat(self.display, "seat0")
self.add_listener(self.seat.request_set_selection_event,
self._on_request_set_selection)
self.add_listener(self.backend.new_input_event, self._on_new_input)
# set up outputs
self.outputs: List[Output] = []
self.add_listener(self.backend.new_output_event, self._on_new_output)
self.output_layout = OutputLayout()
self.add_listener(self.output_layout.change_event,
self._on_output_layout_change)
self.output_manager = OutputManagerV1(self.display)
self.add_listener(self.output_manager.apply_event,
self._on_output_manager_apply)
self.add_listener(self.output_manager.test_event,
self._on_output_manager_test)
# set up cursor
self.cursor = Cursor(self.output_layout)
self.cursor_manager = XCursorManager(24)
self.add_listener(self.seat.request_set_cursor_event,
self._on_request_cursor)
self.add_listener(self.cursor.axis_event, self._on_cursor_axis)
self.add_listener(self.cursor.frame_event, self._on_cursor_frame)
self.add_listener(self.cursor.button_event, self._on_cursor_button)
self.add_listener(self.cursor.motion_event, self._on_cursor_motion)
self.add_listener(self.cursor.motion_absolute_event,
self._on_cursor_motion_absolute)
# set up shell
self.xdg_shell = XdgShell(self.display)
self.add_listener(self.xdg_shell.new_surface_event,
self._on_new_xdg_surface)
self.layer_shell = LayerShellV1(self.display)
self.add_listener(self.layer_shell.new_surface_event,
self._on_new_layer_surface)
# Add support for additional protocols
XdgOutputManagerV1(self.display, self.output_layout)
ScreencopyManagerV1(self.display)
GammaControlManagerV1(self.display)
PrimarySelectionV1DeviceManager(self.display)
self._virtual_keyboard_manager_v1 = VirtualKeyboardManagerV1(
self.display)
self.add_listener(
self._virtual_keyboard_manager_v1.new_virtual_keyboard_event,
self._on_new_virtual_keyboard)
xdg_decoration_manager_v1 = xdg_decoration_v1.XdgDecorationManagerV1.create(
self.display)
self.add_listener(
xdg_decoration_manager_v1.new_toplevel_decoration_event,
self._on_new_toplevel_decoration,
)
# wlr_server_decoration will be removed in a future version of wlroots
server_decoration_manager = ServerDecorationManager.create(
self.display)
server_decoration_manager.set_default_mode(
ServerDecorationManagerMode.SERVER)
# start
os.environ["WAYLAND_DISPLAY"] = self.socket.decode()
logger.info("Starting core with WAYLAND_DISPLAY=" +
self.socket.decode())
self.backend.start()
@property
def name(self):
return "wayland"
def finalize(self):
for kb in self.keyboards:
kb.finalize()
for out in self.outputs:
out.finalize()
self.finalize_listeners()
self.cursor_manager.destroy()
self.cursor.destroy()
self.output_layout.destroy()
self.seat.destroy()
self.backend.destroy()
self.display.destroy()
self.qtile = None
@property
def display_name(self) -> str:
return self.socket.decode()
def _on_request_set_selection(self, _listener,
event: seat.RequestSetSelectionEvent):
self.seat.set_selection(event._ptr.source, event.serial)
logger.debug("Signal: seat request_set_selection")
def _on_new_input(self, _listener, device: input_device.InputDevice):
logger.debug("Signal: backend new_input_event")
if device.device_type == input_device.InputDeviceType.POINTER:
self._add_new_pointer(device)
elif device.device_type == input_device.InputDeviceType.KEYBOARD:
self._add_new_keyboard(device)
capabilities = WlSeat.capability.pointer
if len(self.keyboards) > 0:
capabilities |= WlSeat.capability.keyboard
logger.info("New input: " + str(device.device_type))
logger.info("Input capabilities: " + str(capabilities))
self.seat.set_capabilities(capabilities)
def _on_new_output(self, _listener, wlr_output: wlrOutput):
logger.debug("Signal: backend new_output_event")
if wlr_output.modes != []:
mode = wlr_output.preferred_mode()
if mode is None:
logger.error("New output has no output mode")
return
wlr_output.set_mode(mode)
wlr_output.enable()
wlr_output.commit()
self.outputs.append(Output(self, wlr_output))
self.output_layout.add_auto(wlr_output)
if not self._current_output:
self._current_output = self.outputs[0]
def _on_output_layout_change(self, _listener, _data):
logger.debug("Signal: output_layout change_event")
config = OutputConfigurationV1()
for output in self.outputs:
box = self.output_layout.get_box(output.wlr_output)
head = OutputConfigurationHeadV1.create(config, output.wlr_output)
head.state.x = output.x = box.x
head.state.y = output.y = box.y
head.state.enabled = output.wlr_output.enabled
head.state.mode = output.wlr_output.current_mode
self.output_manager.set_configuration(config)
self.outputs.sort(key=lambda o: (o.x, o.y))
hook.fire("screen_change", None)
def _on_output_manager_apply(self, _listener,
config: OutputConfigurationV1):
logger.debug("Signal: output_manager apply_event")
self._output_manager_reconfigure(config, True)
def _on_output_manager_test(self, _listener,
config: OutputConfigurationV1):
logger.debug("Signal: output_manager test_event")
self._output_manager_reconfigure(config, False)
def _on_request_cursor(self, _listener,
event: seat.PointerRequestSetCursorEvent):
logger.debug("Signal: seat request_set_cursor_event")
self.cursor.set_surface(event.surface, event.hotspot)
def _on_new_xdg_surface(self, _listener, surface: XdgSurface):
logger.debug("Signal: xdg_shell new_surface_event")
if surface.role == XdgSurfaceRole.TOPLEVEL:
assert self.qtile is not None
win = window.Window(self, self.qtile, surface, self.new_wid())
self.pending_windows.append(win)
def _on_cursor_axis(self, _listener, event: pointer.PointerEventAxis):
self.seat.pointer_notify_axis(
event.time_msec,
event.orientation,
event.delta,
event.delta_discrete,
event.source,
)
if self._hovered_internal:
button = 5 if 0 < event.delta else 4
self._hovered_internal.process_button_click(
self.cursor.x,
self.cursor.y,
button,
)
def _on_cursor_frame(self, _listener, _data):
self.seat.pointer_notify_frame()
def _on_cursor_button(self, _listener, event: pointer.PointerEventButton):
assert self.qtile is not None
self.seat.pointer_notify_button(event.time_msec, event.button,
event.button_state)
state = self.seat.keyboard.modifier
button = wlrq.buttons_inv[event.button]
if event.button_state == input_device.ButtonState.PRESSED:
self._focus_by_click()
self.qtile.process_button_click(button, state, self.cursor.x,
self.cursor.y, event)
if self._hovered_internal:
self._hovered_internal.process_button_click(
self.cursor.x, self.cursor.y, button)
else:
self.qtile.process_button_release(button, state)
if self._hovered_internal:
self._hovered_internal.process_button_release(
self.cursor.x, self.cursor.y, button)
def _on_cursor_motion(self, _listener, event: pointer.PointerEventMotion):
assert self.qtile is not None
self.cursor.move(event.delta_x,
event.delta_y,
input_device=event.device)
self._process_cursor_motion(event.time_msec)
def _on_cursor_motion_absolute(self, _listener,
event: pointer.PointerEventMotionAbsolute):
assert self.qtile is not None
self.cursor.warp(
WarpMode.AbsoluteClosest,
event.x,
event.y,
input_device=event.device,
)
self._process_cursor_motion(event.time_msec)
def _on_new_virtual_keyboard(self, _listener,
virtual_keyboard: VirtualKeyboardV1):
self._add_new_keyboard(virtual_keyboard.input_device)
def _on_new_layer_surface(self, _listener, layer_surface: LayerSurfaceV1):
logger.debug("Signal: layer_shell new_surface_event")
assert self.qtile is not None
wid = self.new_wid()
win = window.Static(self, self.qtile, layer_surface, wid)
logger.info(f"Managing new layer_shell window with window ID: {wid}")
self.qtile.manage(win)
def _on_new_toplevel_decoration(
self, _listener,
decoration: xdg_decoration_v1.XdgToplevelDecorationV1):
logger.debug("Signal: xdg_decoration new_top_level_decoration")
decoration.set_mode(
xdg_decoration_v1.XdgToplevelDecorationV1Mode.SERVER_SIDE)
def _output_manager_reconfigure(self, config: OutputConfigurationV1,
apply: bool) -> None:
"""
See if an output configuration would be accepted by the backend, and apply it if
desired.
"""
ok = True
for head in config.heads:
state = head.state
wlr_output = state.output
if state.enabled:
wlr_output.enable()
if state.mode:
wlr_output.set_mode(state.mode)
else:
wlr_output.set_custom_mode(
state.custom_mode.width,
state.custom_mode.height,
state.custom_mode.refresh,
)
self.output_layout.move(wlr_output, state.x, state.y)
wlr_output.set_transform(state.transform)
wlr_output.set_scale(state.scale)
else:
wlr_output.enable(enable=False)
ok = wlr_output.test()
if not ok:
break
for head in config.heads:
if ok and apply:
head.state.output.commit()
else:
head.state.output.rollback()
if ok:
config.send_succeeded()
else:
config.send_failed()
config.destroy()
def _process_cursor_motion(self, time):
self.qtile.process_button_motion(self.cursor.x, self.cursor.y)
if len(self.outputs) > 1:
current_output = self.output_layout.output_at(
self.cursor.x, self.cursor.y).data
if self._current_output is not current_output:
self._current_output = current_output
self.stack_windows()
found = self._under_pointer()
if found:
win, surface, sx, sy = found
if isinstance(win, window.Internal):
if self._hovered_internal:
win.process_pointer_motion(self.cursor.x, self.cursor.y)
else:
self.seat.pointer_clear_focus()
win.process_pointer_enter(self.cursor.x, self.cursor.y)
self._hovered_internal = win
return
focus_changed = self.seat.pointer_state.focused_surface != surface
if surface is not None:
self.seat.pointer_notify_enter(surface, sx, sy)
if focus_changed:
if surface is None:
self.seat.pointer_clear_focus()
if win is not self.qtile.current_window:
hook.fire("client_mouse_enter", win)
if self.qtile.config.follow_mouse_focus:
if isinstance(win, window.Static):
self.qtile.focus_screen(win.screen.index, False)
else:
if win.group.current_window != win:
win.group.focus(win, False)
if win.group.screen and self.qtile.current_screen != win.group.screen:
self.qtile.focus_screen(
win.group.screen.index, False)
self.focus_window(win, surface)
else:
# The enter event contains coordinates, so we only need to
# notify on motion if the focus did not change
self.seat.pointer_notify_motion(time, sx, sy)
if self._hovered_internal:
self._hovered_internal = None
else:
self.cursor_manager.set_cursor_image("left_ptr", self.cursor)
self.seat.pointer_clear_focus()
if self._hovered_internal:
self._hovered_internal.process_pointer_leave(
self.cursor.x, self.cursor.y)
self._hovered_internal = None
def _add_new_pointer(self, device: input_device.InputDevice):
logger.info("Adding new pointer")
self.cursor.attach_input_device(device)
def _add_new_keyboard(self, device: input_device.InputDevice):
logger.info("Adding new keyboard")
self.keyboards.append(keyboard.Keyboard(self, device))
self.seat.set_keyboard(device)
def setup_listener(self, qtile: Qtile) -> None:
"""Setup a listener for the given qtile instance"""
logger.debug("Adding io watch")
self.qtile = qtile
self.fd = lib.wl_event_loop_get_fd(self.event_loop._ptr)
asyncio.get_running_loop().add_reader(self.fd, self._poll)
def remove_listener(self) -> None:
"""Remove the listener from the given event loop"""
if self.fd is not None:
logger.debug("Removing io watch")
loop = asyncio.get_running_loop()
loop.remove_reader(self.fd)
self.fd = None
def _poll(self) -> None:
if not self.display.destroyed:
self.display.flush_clients()
self.event_loop.dispatch(0)
self.display.flush_clients()
def new_wid(self) -> int:
"""Get a new unique window ID"""
assert self.qtile is not None
return max(self.qtile.windows_map.keys(), default=0) + 1
def focus_window(self, win: window.WindowType, surface: Surface = None):
if self.seat.destroyed:
return
if surface is None and win is not None:
surface = win.surface.surface
previous_surface = self.seat.keyboard_state.focused_surface
if previous_surface == surface:
return
if previous_surface is not None and previous_surface.is_xdg_surface:
# Deactivate the previously focused surface
previous_xdg_surface = XdgSurface.from_surface(previous_surface)
previous_xdg_surface.set_activated(False)
if not win:
self.seat.keyboard_clear_focus()
return
if isinstance(win.surface, LayerSurfaceV1):
if not win.surface.current.keyboard_interactive:
return
logger.debug("Focussing new window")
if surface.is_xdg_surface and isinstance(win.surface, XdgSurface):
win.surface.set_activated(True)
self.seat.keyboard_notify_enter(surface, self.seat.keyboard)
def _focus_by_click(self) -> None:
assert self.qtile is not None
found = self._under_pointer()
if found:
win, surface, _, _ = found
if self.qtile.config.bring_front_click:
if self.qtile.config.bring_front_click != "floating_only" or not win.floating:
win.cmd_bring_to_front()
if not isinstance(win, window.Internal):
if isinstance(win, window.Window):
if win.group and win.group.screen is not self.qtile.current_screen:
self.qtile.focus_screen(win.group.screen.index,
warp=False)
self.qtile.current_group.focus(win, False)
self.focus_window(win, surface=surface)
else:
screen = self.qtile.find_screen(self.cursor.x, self.cursor.y)
if screen:
self.qtile.focus_screen(screen.index, warp=False)
def _under_pointer(self):
assert self.qtile is not None
cx = self.cursor.x
cy = self.cursor.y
for win in reversed(self.stacked_windows):
if isinstance(win, window.Internal):
if win.x <= cx <= win.x + win.width and win.y <= cy <= win.y + win.height:
return win, None, 0, 0
else:
bw = win.borderwidth
surface, sx, sy = win.surface.surface_at(
cx - win.x - bw, cy - win.y - bw)
if surface:
return win, surface, sx, sy
if bw:
if win.x <= cx and win.y <= cy:
bw *= 2
if cx <= win.x + win.width + bw and cy <= win.y + win.height + bw:
return win, None, 0, 0
return None
def stack_windows(self) -> None:
"""Put all windows of all types in a Z-ordered list."""
if self._current_output:
layers = self._current_output.layers
self.stacked_windows = layers[LayerShellV1Layer.BACKGROUND] + \
layers[LayerShellV1Layer.BOTTOM] # type: ignore
self.stacked_windows += self.mapped_windows
self.stacked_windows += layers[LayerShellV1Layer.TOP] + layers[
LayerShellV1Layer.OVERLAY]
else:
self.stacked_windows = self.mapped_windows
def get_screen_info(self) -> List[Tuple[int, int, int, int]]:
"""Get the screen information"""
return [screen.get_geometry() for screen in self.outputs]
def grab_key(self, key: Union[config.Key,
config.KeyChord]) -> Tuple[int, int]:
"""Configure the backend to grab the key event"""
keysym = xkb.keysym_from_name(key.key, case_insensitive=True)
mask_key = wlrq.translate_masks(key.modifiers)
self.grabbed_keys.append((keysym, mask_key))
return keysym, mask_key
def ungrab_key(self, key: Union[config.Key,
config.KeyChord]) -> Tuple[int, int]:
"""Release the given key event"""
keysym = xkb.keysym_from_name(key.key, case_insensitive=True)
mask_key = wlrq.translate_masks(key.modifiers)
self.grabbed_keys.remove((keysym, mask_key))
return keysym, mask_key
def ungrab_keys(self) -> None:
"""Release the grabbed key events"""
self.grabbed_keys.clear()
def grab_button(self, mouse: config.Mouse) -> int:
"""Configure the backend to grab the mouse event"""
keysym = wlrq.buttons.get(mouse.button_code)
assert keysym is not None
mask_key = wlrq.translate_masks(mouse.modifiers)
self.grabbed_buttons.append((keysym, mask_key))
return mask_key
def ungrab_buttons(self) -> None:
"""Release the grabbed button events"""
self.grabbed_buttons.clear()
def grab_pointer(self) -> None:
"""Configure the backend to grab mouse events"""
def ungrab_pointer(self) -> None:
"""Release grabbed pointer events"""
def warp_pointer(self, x: int, y: int) -> None:
"""Warp the pointer to the coordinates in relative to the output layout"""
self.cursor.warp(WarpMode.LayoutClosest, x, y)
def flush(self) -> None:
self._poll()
def create_internal(self, x: int, y: int, width: int,
height: int) -> base.Internal:
assert self.qtile is not None
internal = window.Internal(self, self.qtile, x, y, width, height)
self.qtile.manage(internal)
return internal
def graceful_shutdown(self):
"""Try to close windows gracefully before exiting"""
assert self.qtile is not None
# Copy in case the dictionary changes during the loop
for win in self.qtile.windows_map.copy().values():
win.kill()
# give everyone a little time to exit and write their state. but don't
# sleep forever (1s).
end = time.time() + 1
while time.time() < end:
self._poll()
if not self.qtile.windows_map:
break
def change_vt(self, vt: int) -> bool:
"""Change virtual terminal to that specified"""
success = self.backend.get_session().change_vt(vt)
if not success:
logger.warning(f"Could not change VT to: {vt}")
return success
@property
def painter(self):
return wlrq.Painter(self)
def output_from_wlr_output(self, wlr_output: wlrOutput) -> Output:
matched = []
for output in self.outputs:
if output.wlr_output == wlr_output:
matched.append(output)
assert len(matched) == 1
return matched[0]
def set_keymap(self, layout: Optional[str],
options: Optional[str]) -> None:
"""
Set the keymap for the current keyboard.
"""
if self.keyboards:
self.keyboards[-1].set_keymap(layout, options)
else:
logger.warning("Could not set keymap: no keyboards set up.")
class Core(base.Core, wlrq.HasListeners):
supports_restarting: bool = False
def __init__(self):
"""Setup the Wayland core backend"""
self.qtile: Optional[Qtile] = None
self.desktops: int = 1
self.current_desktop: int = 0
self._hovered_internal: Optional[window.Internal] = None
self.focused_internal: Optional[window.Internal] = None
self.fd = None
self.display = Display()
self.event_loop = self.display.get_event_loop()
(
self.compositor,
self._allocator,
self.renderer,
self.backend,
) = wlroots_helper.build_compositor(self.display)
self.socket = self.display.add_socket()
os.environ["WAYLAND_DISPLAY"] = self.socket.decode()
logger.info("Starting core with WAYLAND_DISPLAY=" +
self.socket.decode())
# These windows have not been mapped yet; they'll get managed when mapped
self.pending_windows: List[window.WindowType] = []
# mapped_windows contains just regular windows
self.mapped_windows: List[window.WindowType] = [] # Ascending in Z
# stacked_windows also contains layer_shell windows from the current output
self.stacked_windows: Sequence[window.WindowType] = [
] # Ascending in Z
self._current_output: Optional[Output] = None
# set up inputs
self.keyboards: List[keyboard.Keyboard] = []
self.grabbed_keys: List[Tuple[int, int]] = []
self.grabbed_buttons: List[Tuple[int, int]] = []
DataDeviceManager(self.display)
self.live_dnd: Optional[wlrq.Dnd] = None
DataControlManagerV1(self.display)
self.seat = seat.Seat(self.display, "seat0")
self.add_listener(self.seat.request_set_selection_event,
self._on_request_set_selection)
self.add_listener(self.seat.request_start_drag_event,
self._on_request_start_drag)
self.add_listener(self.seat.start_drag_event, self._on_start_drag)
self.add_listener(self.backend.new_input_event, self._on_new_input)
# set up outputs
self.outputs: List[Output] = []
self.add_listener(self.backend.new_output_event, self._on_new_output)
self.output_layout = OutputLayout()
self.add_listener(self.output_layout.change_event,
self._on_output_layout_change)
self.output_manager = OutputManagerV1(self.display)
self.add_listener(self.output_manager.apply_event,
self._on_output_manager_apply)
self.add_listener(self.output_manager.test_event,
self._on_output_manager_test)
# set up cursor
self.cursor = Cursor(self.output_layout)
self.cursor_manager = XCursorManager(24)
self.add_listener(self.seat.request_set_cursor_event,
self._on_request_cursor)
self.add_listener(self.cursor.axis_event, self._on_cursor_axis)
self.add_listener(self.cursor.frame_event, self._on_cursor_frame)
self.add_listener(self.cursor.button_event, self._on_cursor_button)
self.add_listener(self.cursor.motion_event, self._on_cursor_motion)
self.add_listener(self.cursor.motion_absolute_event,
self._on_cursor_motion_absolute)
# set up shell
self.xdg_shell = XdgShell(self.display)
self.add_listener(self.xdg_shell.new_surface_event,
self._on_new_xdg_surface)
self.layer_shell = LayerShellV1(self.display)
self.add_listener(self.layer_shell.new_surface_event,
self._on_new_layer_surface)
# Add support for additional protocols
XdgOutputManagerV1(self.display, self.output_layout)
ScreencopyManagerV1(self.display)
GammaControlManagerV1(self.display)
PrimarySelectionV1DeviceManager(self.display)
self._virtual_keyboard_manager_v1 = VirtualKeyboardManagerV1(
self.display)
self.add_listener(
self._virtual_keyboard_manager_v1.new_virtual_keyboard_event,
self._on_new_virtual_keyboard,
)
xdg_decoration_manager_v1 = xdg_decoration_v1.XdgDecorationManagerV1.create(
self.display)
self.add_listener(
xdg_decoration_manager_v1.new_toplevel_decoration_event,
self._on_new_toplevel_decoration,
)
# wlr_server_decoration will be removed in a future version of wlroots
server_decoration_manager = ServerDecorationManager.create(
self.display)
server_decoration_manager.set_default_mode(
ServerDecorationManagerMode.SERVER)
pointer_constraints_v1 = PointerConstraintsV1(self.display)
self.add_listener(
pointer_constraints_v1.new_constraint_event,
self._on_new_pointer_constraint,
)
self.pointer_constraints: Set[wlrq.PointerConstraint] = set()
self.active_pointer_constraint: Optional[wlrq.PointerConstraint] = None
self._relative_pointer_manager_v1 = RelativePointerManagerV1(
self.display)
self.foreign_toplevel_manager_v1 = ForeignToplevelManagerV1.create(
self.display)
# Set up XWayland
self._xwayland = xwayland.XWayland(self.display, self.compositor, True)
if self._xwayland:
os.environ["DISPLAY"] = self._xwayland.display_name
logger.info("Set up XWayland with DISPLAY=" +
os.environ["DISPLAY"])
self.add_listener(self._xwayland.ready_event,
self._on_xwayland_ready)
self.add_listener(self._xwayland.new_surface_event,
self._on_xwayland_new_surface)
else:
logger.info("Failed to set up XWayland. Continuing without.")
# Start
self.backend.start()
@property
def name(self):
return "wayland"
def finalize(self):
for kb in self.keyboards:
kb.finalize()
for out in self.outputs:
out.finalize()
self.finalize_listeners()
if self._xwayland:
self._xwayland.destroy()
self.cursor_manager.destroy()
self.cursor.destroy()
self.output_layout.destroy()
self.seat.destroy()
self.backend.destroy()
self.display.destroy()
self.qtile = None
@property
def display_name(self) -> str:
return self.socket.decode()
def _on_request_set_selection(self, _listener,
event: seat.RequestSetSelectionEvent):
self.seat.set_selection(event._ptr.source, event.serial)
logger.debug("Signal: seat request_set_selection")
def _on_request_start_drag(self, _listener,
event: seat.RequestStartDragEvent):
logger.debug("Signal: seat request_start_drag")
if not self.live_dnd and self.seat.validate_pointer_grab_serial(
event.origin, event.serial):
self.seat.start_pointer_drag(event.drag, event.serial)
else:
event.drag.source.destroy()
def _on_start_drag(self, _listener, event: Drag):
logger.debug("Signal: seat start_drag")
self.live_dnd = wlrq.Dnd(self, event)
def _on_new_input(self, _listener, device: input_device.InputDevice):
logger.debug("Signal: backend new_input_event")
if device.device_type == input_device.InputDeviceType.POINTER:
self._add_new_pointer(device)
elif device.device_type == input_device.InputDeviceType.KEYBOARD:
self._add_new_keyboard(device)
capabilities = WlSeat.capability.pointer
if len(self.keyboards) > 0:
capabilities |= WlSeat.capability.keyboard
logger.info("New input: " + str(device.device_type))
logger.info("Input capabilities: " + str(capabilities))
self.seat.set_capabilities(capabilities)
def _on_new_output(self, _listener, wlr_output: wlrOutput):
logger.debug("Signal: backend new_output_event")
wlr_output.init_render(self._allocator, self.renderer)
if wlr_output.modes != []:
mode = wlr_output.preferred_mode()
if mode is None:
logger.error("New output has no output mode")
return
wlr_output.set_mode(mode)
wlr_output.enable()
wlr_output.commit()
self.outputs.append(Output(self, wlr_output))
# Put new output at far right
layout_geo = self.output_layout.get_box()
self.output_layout.add(wlr_output, layout_geo.width, 0)
if not self._current_output:
self._current_output = self.outputs[0]
def _on_output_layout_change(self, _listener, _data):
logger.debug("Signal: output_layout change_event")
config = OutputConfigurationV1()
for output in self.outputs:
box = self.output_layout.get_box(output.wlr_output)
head = OutputConfigurationHeadV1.create(config, output.wlr_output)
head.state.x = output.x = box.x
head.state.y = output.y = box.y
head.state.enabled = output.wlr_output.enabled
head.state.mode = output.wlr_output.current_mode
self.output_manager.set_configuration(config)
self.outputs.sort(key=lambda o: (o.x, o.y))
def _on_output_manager_apply(self, _listener,
config: OutputConfigurationV1):
logger.debug("Signal: output_manager apply_event")
self._output_manager_reconfigure(config, True)
def _on_output_manager_test(self, _listener,
config: OutputConfigurationV1):
logger.debug("Signal: output_manager test_event")
self._output_manager_reconfigure(config, False)
def _on_request_cursor(self, _listener,
event: seat.PointerRequestSetCursorEvent):
logger.debug("Signal: seat request_set_cursor_event")
self.cursor.set_surface(event.surface, event.hotspot)
def _on_new_xdg_surface(self, _listener, surface: XdgSurface):
logger.debug("Signal: xdg_shell new_surface_event")
if surface.role == XdgSurfaceRole.TOPLEVEL:
assert self.qtile is not None
win = window.Window(self, self.qtile, surface)
self.pending_windows.append(win)
def _on_cursor_axis(self, _listener, event: pointer.PointerEventAxis):
handled = False
if event.delta != 0:
if event.orientation == pointer.AxisOrientation.VERTICAL:
button = 5 if 0 < event.delta else 4
else:
button = 7 if 0 < event.delta else 6
handled = self._process_cursor_button(button, True)
if not handled:
self.seat.pointer_notify_axis(
event.time_msec,
event.orientation,
event.delta,
event.delta_discrete,
event.source,
)
def _on_cursor_frame(self, _listener, _data):
self.seat.pointer_notify_frame()
def _on_cursor_button(self, _listener, event: pointer.PointerEventButton):
assert self.qtile is not None
pressed = event.button_state == input_device.ButtonState.PRESSED
if pressed:
self._focus_by_click()
handled = False
if event.button in wlrq.buttons:
button = wlrq.buttons.index(event.button) + 1
handled = self._process_cursor_button(button, pressed)
if not handled:
self.seat.pointer_notify_button(event.time_msec, event.button,
event.button_state)
def _on_cursor_motion(self, _listener, event: pointer.PointerEventMotion):
assert self.qtile is not None
dx = event.delta_x
dy = event.delta_y
# Send relative pointer events to seat - used e.g. by games that have
# constrained cursor movement but want movement events
self._relative_pointer_manager_v1.send_relative_motion(
self.seat,
event.time_msec * 1000,
dx,
dy,
event.unaccel_delta_x,
event.unaccel_delta_y,
)
if self.active_pointer_constraint:
if not self.active_pointer_constraint.rect.contains_point(
self.cursor.x + dx, self.cursor.y + dy):
return
self.cursor.move(dx, dy, input_device=event.device)
self._process_cursor_motion(event.time_msec, self.cursor.x,
self.cursor.y)
def _on_cursor_motion_absolute(self, _listener,
event: pointer.PointerEventMotionAbsolute):
assert self.qtile is not None
self.cursor.warp(
WarpMode.AbsoluteClosest,
event.x,
event.y,
input_device=event.device,
)
self._process_cursor_motion(event.time_msec, self.cursor.x,
self.cursor.y)
def _on_new_pointer_constraint(self, _listener,
wlr_constraint: PointerConstraintV1):
logger.debug("Signal: pointer_constraints new_constraint")
constraint = wlrq.PointerConstraint(self, wlr_constraint)
self.pointer_constraints.add(constraint)
if self.seat.pointer_state.focused_surface == wlr_constraint.surface:
if self.active_pointer_constraint:
self.active_pointer_constraint.disable()
constraint.enable()
def _on_new_virtual_keyboard(self, _listener,
virtual_keyboard: VirtualKeyboardV1):
self._add_new_keyboard(virtual_keyboard.input_device)
def _on_new_layer_surface(self, _listener, layer_surface: LayerSurfaceV1):
logger.debug("Signal: layer_shell new_surface_event")
assert self.qtile is not None
wid = self.new_wid()
win = window.Static(self, self.qtile, layer_surface, wid)
logger.info(f"Managing new layer_shell window with window ID: {wid}")
self.qtile.manage(win)
def _on_new_toplevel_decoration(
self, _listener,
decoration: xdg_decoration_v1.XdgToplevelDecorationV1):
logger.debug("Signal: xdg_decoration new_top_level_decoration")
decoration.set_mode(
xdg_decoration_v1.XdgToplevelDecorationV1Mode.SERVER_SIDE)
def _on_xwayland_ready(self, _listener, _data):
logger.debug("Signal: xwayland ready")
assert self._xwayland is not None
self._xwayland.set_seat(self.seat)
self.xwayland_atoms: Dict[int, str] = wlrq.get_xwayland_atoms(
self._xwayland)
def _on_xwayland_new_surface(self, _listener, surface: xwayland.Surface):
logger.debug("Signal: xwayland new_surface")
assert self.qtile is not None
win = window.XWindow(self, self.qtile, surface)
self.pending_windows.append(win)
def _output_manager_reconfigure(self, config: OutputConfigurationV1,
apply: bool) -> None:
"""
See if an output configuration would be accepted by the backend, and apply it if
desired.
"""
ok = True
for head in config.heads:
state = head.state
wlr_output = state.output
if state.enabled:
wlr_output.enable()
if state.mode:
wlr_output.set_mode(state.mode)
else:
wlr_output.set_custom_mode(
state.custom_mode.width,
state.custom_mode.height,
state.custom_mode.refresh,
)
self.output_layout.move(wlr_output, state.x, state.y)
wlr_output.set_transform(state.transform)
wlr_output.set_scale(state.scale)
else:
wlr_output.enable(enable=False)
ok = wlr_output.test()
if not ok:
break
for head in config.heads:
if ok and apply:
head.state.output.commit()
else:
head.state.output.rollback()
if ok:
config.send_succeeded()
else:
config.send_failed()
config.destroy()
hook.fire("screen_change", None)
def _process_cursor_motion(self, time_msec: int, cx: float, cy: float):
assert self.qtile
cx_int = int(cx)
cy_int = int(cy)
self.qtile.process_button_motion(cx_int, cy_int)
if len(self.outputs) > 1:
current_output = self.output_layout.output_at(cx, cy).data
if self._current_output is not current_output:
self._current_output = current_output
self.stack_windows()
if self.live_dnd:
self.live_dnd.position(cx, cy)
found = self._under_pointer()
if found:
win, surface, sx, sy = found
if isinstance(win, window.Internal):
if self._hovered_internal is win:
win.process_pointer_motion(
cx_int - self._hovered_internal.x,
cy_int - self._hovered_internal.y,
)
else:
if self._hovered_internal:
self._hovered_internal.process_pointer_leave(
cx_int - self._hovered_internal.x,
cy_int - self._hovered_internal.y,
)
self.cursor_manager.set_cursor_image(
"left_ptr", self.cursor)
self.seat.pointer_notify_clear_focus()
win.process_pointer_enter(cx_int, cy_int)
self._hovered_internal = win
return
if surface:
self.seat.pointer_notify_enter(surface, sx, sy)
self.seat.pointer_notify_motion(time_msec, sx, sy)
else:
self.seat.pointer_notify_clear_focus()
if win is not self.qtile.current_window:
hook.fire("client_mouse_enter", win)
if self.qtile.config.follow_mouse_focus:
if isinstance(win, window.Static):
self.qtile.focus_screen(win.screen.index, False)
else:
if win.group.current_window != win:
win.group.focus(win, False)
if win.group.screen and self.qtile.current_screen != win.group.screen:
self.qtile.focus_screen(win.group.screen.index,
False)
if self._hovered_internal:
self._hovered_internal = None
else:
self.cursor_manager.set_cursor_image("left_ptr", self.cursor)
self.seat.pointer_notify_clear_focus()
if self._hovered_internal:
self._hovered_internal.process_pointer_leave(
cx_int - self._hovered_internal.x,
cy_int - self._hovered_internal.y,
)
self._hovered_internal = None
def _process_cursor_button(self, button: int, pressed: bool) -> bool:
assert self.qtile is not None
if pressed:
handled = self.qtile.process_button_click(
button, self.seat.keyboard.modifier, int(self.cursor.x),
int(self.cursor.y))
if self._hovered_internal:
self._hovered_internal.process_button_click(
self.cursor.x - self._hovered_internal.x,
self.cursor.y - self._hovered_internal.y,
button,
)
else:
handled = self.qtile.process_button_release(
button, self.seat.keyboard.modifier)
if self._hovered_internal:
self._hovered_internal.process_button_release(
self.cursor.x - self._hovered_internal.x,
self.cursor.y - self._hovered_internal.y,
button,
)
return handled
def _add_new_pointer(self, device: input_device.InputDevice):
logger.info("Adding new pointer")
self.cursor.attach_input_device(device)
def _add_new_keyboard(self, device: input_device.InputDevice):
logger.info("Adding new keyboard")
self.keyboards.append(keyboard.Keyboard(self, device))
self.seat.set_keyboard(device)
def setup_listener(self, qtile: Qtile) -> None:
"""Setup a listener for the given qtile instance"""
logger.debug("Adding io watch")
self.qtile = qtile
self.fd = lib.wl_event_loop_get_fd(self.event_loop._ptr)
asyncio.get_running_loop().add_reader(self.fd, self._poll)
def remove_listener(self) -> None:
"""Remove the listener from the given event loop"""
if self.fd is not None:
logger.debug("Removing io watch")
loop = asyncio.get_running_loop()
loop.remove_reader(self.fd)
self.fd = None
def _poll(self) -> None:
if not self.display.destroyed:
self.display.flush_clients()
self.event_loop.dispatch(0)
self.display.flush_clients()
def distribute_windows(self, initial: bool) -> None:
if initial:
# This backend does not support restarting
return
assert self.qtile is not None
for win in self.qtile.windows_map.values():
if isinstance(win, (window.Internal, window.Static)):
continue
group = None
assert isinstance(win, window.Window)
if win.group:
if win.group.name in self.qtile.groups_map:
# Put window on group with same name as its old group if one exists
group = self.qtile.groups_map[win.group.name]
else:
# Otherwise place it on the group at the same index
for i, old_group in self.qtile._state.groups: # type: ignore
if i < len(self.qtile.groups):
name = old_group[0]
if win.group.name == name:
group = self.qtile.groups[i]
if group is None:
# Falling back to current group if none found
group = self.qtile.current_group
if win.group and win in win.group.windows:
# It might not be in win.group.windows depending on how group state
# changed across a config reload
win.group.remove(win)
group.add(win)
if group == self.qtile.current_group:
win.unhide()
else:
win.hide()
def new_wid(self) -> int:
"""Get a new unique window ID"""
assert self.qtile is not None
return max(self.qtile.windows_map.keys(), default=0) + 1
def focus_window(self,
win: window.WindowType,
surface: Surface = None,
enter: bool = True) -> None:
if self.seat.destroyed:
return
if surface is None and win is not None:
if isinstance(win, base.Internal):
self.focused_internal = win
self.seat.keyboard_clear_focus()
return
surface = win.surface.surface
if self.focused_internal:
self.focused_internal = None
if isinstance(win.surface, LayerSurfaceV1):
if not win.surface.current.keyboard_interactive:
return
if isinstance(win.surface, xwayland.Surface):
if not win.surface.or_surface_wants_focus():
return
previous_surface = self.seat.keyboard_state.focused_surface
if previous_surface == surface:
return
if previous_surface is not None:
# Deactivate the previously focused surface
if previous_surface.is_xdg_surface:
previous_xdg_surface = XdgSurface.from_surface(
previous_surface)
if not win or win.surface != previous_xdg_surface:
previous_xdg_surface.set_activated(False)
if previous_xdg_surface.data:
previous_xdg_surface.data.set_activated(False)
elif previous_surface.is_xwayland_surface:
prev_xwayland_surface = xwayland.Surface.from_wlr_surface(
previous_surface)
if not win or win.surface != prev_xwayland_surface:
prev_xwayland_surface.activate(False)
if prev_xwayland_surface.data:
prev_xwayland_surface.data.set_activated(False)
if not win:
self.seat.keyboard_clear_focus()
return
logger.debug("Focussing new window")
if surface.is_xdg_surface and isinstance(win.surface, XdgSurface):
win.surface.set_activated(True)
win.ftm_handle.set_activated(True)
elif surface.is_xwayland_surface and isinstance(
win.surface, xwayland.Surface):
win.surface.activate(True)
win.ftm_handle.set_activated(True)
if enter and self.seat.keyboard._ptr: # This pointer is NULL when headless
self.seat.keyboard_notify_enter(surface, self.seat.keyboard)
def _focus_by_click(self) -> None:
assert self.qtile is not None
found = self._under_pointer()
if found:
win, surface, _, _ = found
if self.qtile.config.bring_front_click is True:
win.cmd_bring_to_front()
elif self.qtile.config.bring_front_click == "floating_only":
if not isinstance(win, base.Internal) and win.floating:
win.cmd_bring_to_front()
if not isinstance(win, base.Internal):
if isinstance(win, window.Static):
if win.screen is not self.qtile.current_screen:
self.qtile.focus_screen(win.screen.index, warp=False)
win.focus(False)
else:
if win.group and win.group.screen is not self.qtile.current_screen:
self.qtile.focus_screen(win.group.screen.index,
warp=False)
self.qtile.current_group.focus(win, False)
else:
screen = self.qtile.find_screen(self.cursor.x, self.cursor.y)
if screen:
self.qtile.focus_screen(screen.index, warp=False)
def _under_pointer(self):
assert self.qtile is not None
cx = self.cursor.x
cy = self.cursor.y
for win in reversed(self.stacked_windows):
if isinstance(win, window.Internal):
if win.x <= cx <= win.x + win.width and win.y <= cy <= win.y + win.height:
return win, None, 0, 0
else:
bw = win.borderwidth
surface, sx, sy = win.surface.surface_at(
cx - win.x - bw, cy - win.y - bw)
if surface:
return win, surface, sx, sy
if bw:
if win.x <= cx and win.y <= cy:
bw *= 2
if cx <= win.x + win.width + bw and cy <= win.y + win.height + bw:
return win, None, 0, 0
return None
def stack_windows(self) -> None:
"""Put all windows of all types in a Z-ordered list."""
if self._current_output:
layers = self._current_output.layers
self.stacked_windows = (
layers[LayerShellV1Layer.BACKGROUND] +
layers[LayerShellV1Layer.BOTTOM] +
self.mapped_windows # type: ignore
+ layers[LayerShellV1Layer.TOP] +
layers[LayerShellV1Layer.OVERLAY])
else:
self.stacked_windows = self.mapped_windows
def get_screen_info(self) -> List[Tuple[int, int, int, int]]:
"""Get the screen information"""
return [
screen.get_geometry() for screen in self.outputs
if screen.wlr_output.enabled
]
def grab_key(self, key: Union[config.Key,
config.KeyChord]) -> Tuple[int, int]:
"""Configure the backend to grab the key event"""
keysym = xkb.keysym_from_name(key.key, case_insensitive=True)
mask_key = wlrq.translate_masks(key.modifiers)
self.grabbed_keys.append((keysym, mask_key))
return keysym, mask_key
def ungrab_key(self, key: Union[config.Key,
config.KeyChord]) -> Tuple[int, int]:
"""Release the given key event"""
keysym = xkb.keysym_from_name(key.key, case_insensitive=True)
mask_key = wlrq.translate_masks(key.modifiers)
self.grabbed_keys.remove((keysym, mask_key))
return keysym, mask_key
def ungrab_keys(self) -> None:
"""Release the grabbed key events"""
self.grabbed_keys.clear()
def grab_button(self, mouse: config.Mouse) -> int:
"""Configure the backend to grab the mouse event"""
keysym = wlrq.buttons[mouse.button_code]
mask_key = wlrq.translate_masks(mouse.modifiers)
self.grabbed_buttons.append((keysym, mask_key))
return mask_key
def ungrab_buttons(self) -> None:
"""Release the grabbed button events"""
self.grabbed_buttons.clear()
def grab_pointer(self) -> None:
"""Configure the backend to grab mouse events"""
def ungrab_pointer(self) -> None:
"""Release grabbed pointer events"""
def warp_pointer(self, x: int, y: int) -> None:
"""Warp the pointer to the coordinates in relative to the output layout"""
self.cursor.warp(WarpMode.LayoutClosest, x, y)
def flush(self) -> None:
self._poll()
def create_internal(self, x: int, y: int, width: int,
height: int) -> base.Internal:
assert self.qtile is not None
internal = window.Internal(self, self.qtile, x, y, width, height)
self.qtile.manage(internal)
return internal
def graceful_shutdown(self):
"""Try to close windows gracefully before exiting"""
assert self.qtile is not None
# Copy in case the dictionary changes during the loop
for win in self.qtile.windows_map.copy().values():
win.kill()
# give everyone a little time to exit and write their state. but don't
# sleep forever (1s).
end = time.time() + 1
while time.time() < end:
self._poll()
if not self.qtile.windows_map:
break
@property
def painter(self):
return wlrq.Painter(self)
def output_from_wlr_output(self, wlr_output: wlrOutput) -> Output:
matched = []
for output in self.outputs:
if output.wlr_output == wlr_output:
matched.append(output)
assert len(matched) == 1
return matched[0]
def keysym_from_name(self, name: str) -> int:
"""Get the keysym for a key from its name"""
return xkb.keysym_from_name(name, case_insensitive=True)
def simulate_keypress(self, modifiers: List[str], key: str) -> None:
"""Simulates a keypress on the focused window."""
keysym = xkb.keysym_from_name(key, case_insensitive=True)
mods = wlrq.translate_masks(modifiers)
if (keysym, mods) in self.grabbed_keys:
assert self.qtile is not None
self.qtile.process_key_event(keysym, mods)
return
if self.focused_internal:
self.focused_internal.process_key_press(keysym)
def cmd_set_keymap(
self,
layout: Optional[str] = None,
options: Optional[str] = None,
variant: Optional[str] = None,
) -> None:
"""
Set the keymap for the current keyboard.
The options correspond to xkbcommon configuration environmental variables and if
not specified are taken from the environment. Acceptable values are strings
identical to those accepted by the env variables.
"""
if self.keyboards:
self.keyboards[-1].set_keymap(layout, options, variant)
else:
logger.warning("Could not set keymap: no keyboards set up.")
def cmd_change_vt(self, vt: int) -> bool:
"""Change virtual terminal to that specified"""
success = self.backend.get_session().change_vt(vt)
if not success:
logger.warning(f"Could not change VT to: {vt}")
return success
def __init__(self) -> None:
"""Setup the Wayland core backend"""
self.qtile: Qtile | None = None
self.desktops: int = 1
self.current_desktop: int = 0
self._hovered_internal: window.Internal | None = None
self.focused_internal: window.Internal | None = None
self.fd: int | None = None
self.display = Display()
self.event_loop = self.display.get_event_loop()
(
self.compositor,
self._allocator,
self.renderer,
self.backend,
) = wlroots_helper.build_compositor(self.display)
self.socket = self.display.add_socket()
os.environ["WAYLAND_DISPLAY"] = self.socket.decode()
logger.info("Starting core with WAYLAND_DISPLAY=" +
self.socket.decode())
# These windows have not been mapped yet; they'll get managed when mapped
self.pending_windows: set[window.WindowType] = set()
# mapped_windows contains just regular windows
self.mapped_windows: list[window.WindowType] = [] # Ascending in Z
# stacked_windows also contains layer_shell windows from the current output
self.stacked_windows: Sequence[window.WindowType] = [
] # Ascending in Z
self._current_output: Output | None = None
# set up inputs
self.keyboards: list[inputs.Keyboard] = []
self.grabbed_keys: list[tuple[int, int]] = []
self.grabbed_buttons: list[tuple[int, int]] = []
DataDeviceManager(self.display)
self.live_dnd: wlrq.Dnd | None = None
DataControlManagerV1(self.display)
self.seat = seat.Seat(self.display, "seat0")
self.add_listener(self.seat.request_set_selection_event,
self._on_request_set_selection)
self.add_listener(self.seat.request_start_drag_event,
self._on_request_start_drag)
self.add_listener(self.seat.start_drag_event, self._on_start_drag)
self.add_listener(self.backend.new_input_event, self._on_new_input)
# Some devices are added early, so we need to remember to configure them
self._pending_input_devices: list[input_device.InputDevice] = []
hook.subscribe.startup_complete(self._configure_pending_inputs)
# set up outputs
self.outputs: list[Output] = []
self.add_listener(self.backend.new_output_event, self._on_new_output)
self.output_layout = OutputLayout()
self.add_listener(self.output_layout.change_event,
self._on_output_layout_change)
self.output_manager = OutputManagerV1(self.display)
self.add_listener(self.output_manager.apply_event,
self._on_output_manager_apply)
self.add_listener(self.output_manager.test_event,
self._on_output_manager_test)
# set up cursor
self.cursor = Cursor(self.output_layout)
self.cursor_manager = XCursorManager(24)
self.add_listener(self.seat.request_set_cursor_event,
self._on_request_cursor)
self.add_listener(self.cursor.axis_event, self._on_cursor_axis)
self.add_listener(self.cursor.frame_event, self._on_cursor_frame)
self.add_listener(self.cursor.button_event, self._on_cursor_button)
self.add_listener(self.cursor.motion_event, self._on_cursor_motion)
self.add_listener(self.cursor.motion_absolute_event,
self._on_cursor_motion_absolute)
# set up shell
self.xdg_shell = XdgShell(self.display)
self.add_listener(self.xdg_shell.new_surface_event,
self._on_new_xdg_surface)
self.layer_shell = LayerShellV1(self.display)
self.add_listener(self.layer_shell.new_surface_event,
self._on_new_layer_surface)
# Add support for additional protocols
XdgOutputManagerV1(self.display, self.output_layout)
ScreencopyManagerV1(self.display)
GammaControlManagerV1(self.display)
output_power_manager = OutputPowerManagerV1(self.display)
self.add_listener(output_power_manager.set_mode_event,
self._on_output_power_manager_set_mode)
self.idle = Idle(self.display)
idle_ihibitor_manager = IdleInhibitorManagerV1(self.display)
self.add_listener(idle_ihibitor_manager.new_inhibitor_event,
self._on_new_inhibitor)
PrimarySelectionV1DeviceManager(self.display)
self._virtual_keyboard_manager_v1 = VirtualKeyboardManagerV1(
self.display)
self.add_listener(
self._virtual_keyboard_manager_v1.new_virtual_keyboard_event,
self._on_new_virtual_keyboard,
)
xdg_decoration_manager_v1 = xdg_decoration_v1.XdgDecorationManagerV1.create(
self.display)
self.add_listener(
xdg_decoration_manager_v1.new_toplevel_decoration_event,
self._on_new_toplevel_decoration,
)
# wlr_server_decoration will be removed in a future version of wlroots
server_decoration_manager = ServerDecorationManager.create(
self.display)
server_decoration_manager.set_default_mode(
ServerDecorationManagerMode.SERVER)
pointer_constraints_v1 = PointerConstraintsV1(self.display)
self.add_listener(
pointer_constraints_v1.new_constraint_event,
self._on_new_pointer_constraint,
)
self.pointer_constraints: set[window.PointerConstraint] = set()
self.active_pointer_constraint: window.PointerConstraint | None = None
self._relative_pointer_manager_v1 = RelativePointerManagerV1(
self.display)
self.foreign_toplevel_manager_v1 = ForeignToplevelManagerV1.create(
self.display)
# Set up XWayland
self._xwayland = xwayland.XWayland(self.display, self.compositor, True)
if self._xwayland:
os.environ["DISPLAY"] = self._xwayland.display_name or ""
logger.info("Set up XWayland with DISPLAY=" +
os.environ["DISPLAY"])
self.add_listener(self._xwayland.ready_event,
self._on_xwayland_ready)
self.add_listener(self._xwayland.new_surface_event,
self._on_xwayland_new_surface)
else:
logger.info("Failed to set up XWayland. Continuing without.")
# Start
self.backend.start()
def __init__(self):
"""Setup the Wayland core backend"""
self.qtile: Optional[Qtile] = None
self.desktops: int = 1
self.current_desktop: int = 0
self.display = Display()
self.event_loop = self.display.get_event_loop()
self.compositor, self.backend = wlroots_helper.build_compositor(
self.display)
self.renderer = self.backend.renderer
self.socket = self.display.add_socket()
self.fd = None
# set up inputs
self.keyboards: List[keyboard.Keyboard] = []
self.grabbed_keys: List[Tuple[int, int]] = []
self.grabbed_buttons: List[Tuple[int, int]] = []
self.device_manager = DataDeviceManager(self.display)
self.seat = seat.Seat(self.display, "seat0")
self._on_request_set_selection_listener = Listener(
self._on_request_set_selection)
self._on_new_input_listener = Listener(self._on_new_input)
self.seat.request_set_selection_event.add(
self._on_request_set_selection_listener)
self.backend.new_input_event.add(self._on_new_input_listener)
# set up outputs
self.output_layout = OutputLayout()
self.outputs: List[output.Output] = []
self._on_new_output_listener = Listener(self._on_new_output)
self.backend.new_output_event.add(self._on_new_output_listener)
# set up cursor
self.cursor = Cursor(self.output_layout)
self.cursor_manager = XCursorManager(24)
self._on_request_cursor_listener = Listener(self._on_request_cursor)
self.seat.request_set_cursor_event.add(
self._on_request_cursor_listener)
self._on_cursor_axis_listener = Listener(self._on_cursor_axis)
self._on_cursor_frame_listener = Listener(self._on_cursor_frame)
self._on_cursor_button_listener = Listener(self._on_cursor_button)
self._on_cursor_motion_listener = Listener(self._on_cursor_motion)
self._on_cursor_motion_absolute_listener = Listener(
self._on_cursor_motion_absolute)
self.cursor.axis_event.add(self._on_cursor_axis_listener)
self.cursor.frame_event.add(self._on_cursor_frame_listener)
self.cursor.button_event.add(self._on_cursor_button_listener)
self.cursor.motion_event.add(self._on_cursor_motion_listener)
self.cursor.motion_absolute_event.add(
self._on_cursor_motion_absolute_listener)
# set up shell
self.xdg_shell = xdg_shell.XdgShell(self.display)
self._on_new_xdg_surface_listener = Listener(self._on_new_xdg_surface)
self.xdg_shell.new_surface_event.add(self._on_new_xdg_surface_listener)
# Add support for additional protocols
XdgOutputManagerV1(self.display, self.output_layout)
ScreencopyManagerV1(self.display)
GammaControlManagerV1(self.display)
self._virtual_keyboard_manager_v1 = VirtualKeyboardManagerV1(
self.display)
self._on_new_virtual_keyboard_listener = Listener(
self._on_new_virtual_keyboard)
self._virtual_keyboard_manager_v1.new_virtual_keyboard_event.add(
self._on_new_virtual_keyboard_listener)
# start
os.environ["WAYLAND_DISPLAY"] = self.socket.decode()
logger.info("Starting core with WAYLAND_DISPLAY=" +
self.socket.decode())
self.backend.start()
class Core(base.Core):
def __init__(self):
"""Setup the Wayland core backend"""
self.qtile: Optional[Qtile] = None
self.desktops: int = 1
self.current_desktop: int = 0
self.display = Display()
self.event_loop = self.display.get_event_loop()
self.compositor, self.backend = wlroots_helper.build_compositor(
self.display)
self.renderer = self.backend.renderer
self.socket = self.display.add_socket()
self.fd = None
# set up inputs
self.keyboards: List[keyboard.Keyboard] = []
self.grabbed_keys: List[Tuple[int, int]] = []
self.grabbed_buttons: List[Tuple[int, int]] = []
self.device_manager = DataDeviceManager(self.display)
self.seat = seat.Seat(self.display, "seat0")
self._on_request_set_selection_listener = Listener(
self._on_request_set_selection)
self._on_new_input_listener = Listener(self._on_new_input)
self.seat.request_set_selection_event.add(
self._on_request_set_selection_listener)
self.backend.new_input_event.add(self._on_new_input_listener)
# set up outputs
self.output_layout = OutputLayout()
self.outputs: List[output.Output] = []
self._on_new_output_listener = Listener(self._on_new_output)
self.backend.new_output_event.add(self._on_new_output_listener)
# set up cursor
self.cursor = Cursor(self.output_layout)
self.cursor_manager = XCursorManager(24)
self._on_request_cursor_listener = Listener(self._on_request_cursor)
self.seat.request_set_cursor_event.add(
self._on_request_cursor_listener)
self._on_cursor_axis_listener = Listener(self._on_cursor_axis)
self._on_cursor_frame_listener = Listener(self._on_cursor_frame)
self._on_cursor_button_listener = Listener(self._on_cursor_button)
self._on_cursor_motion_listener = Listener(self._on_cursor_motion)
self._on_cursor_motion_absolute_listener = Listener(
self._on_cursor_motion_absolute)
self.cursor.axis_event.add(self._on_cursor_axis_listener)
self.cursor.frame_event.add(self._on_cursor_frame_listener)
self.cursor.button_event.add(self._on_cursor_button_listener)
self.cursor.motion_event.add(self._on_cursor_motion_listener)
self.cursor.motion_absolute_event.add(
self._on_cursor_motion_absolute_listener)
# set up shell
self.xdg_shell = xdg_shell.XdgShell(self.display)
self._on_new_xdg_surface_listener = Listener(self._on_new_xdg_surface)
self.xdg_shell.new_surface_event.add(self._on_new_xdg_surface_listener)
# Add support for additional protocols
XdgOutputManagerV1(self.display, self.output_layout)
ScreencopyManagerV1(self.display)
GammaControlManagerV1(self.display)
self._virtual_keyboard_manager_v1 = VirtualKeyboardManagerV1(
self.display)
self._on_new_virtual_keyboard_listener = Listener(
self._on_new_virtual_keyboard)
self._virtual_keyboard_manager_v1.new_virtual_keyboard_event.add(
self._on_new_virtual_keyboard_listener)
# start
os.environ["WAYLAND_DISPLAY"] = self.socket.decode()
logger.info("Starting core with WAYLAND_DISPLAY=" +
self.socket.decode())
self.backend.start()
def finalize(self):
self._on_new_xdg_surface_listener.remove()
self._on_request_cursor_listener.remove()
self._on_new_output_listener.remove()
self._on_new_input_listener.remove()
self._on_request_set_selection_listener.remove()
self._on_new_virtual_keyboard_listener.remove()
for kb in self.keyboards:
kb.finalize()
for out in self.outputs:
out.finalize()
self.cursor_manager.destroy()
self.cursor.destroy()
self.output_layout.destroy()
self.seat.destroy()
self.backend.destroy()
self.display.destroy()
self.qtile = None
@property
def display_name(self) -> str:
return self.socket.decode()
def _on_request_set_selection(self, _listener,
event: seat.RequestSetSelectionEvent):
self.seat.set_selection(event._ptr.source, event.serial)
logger.debug("Signal: seat request_set_selection")
def _on_new_input(self, _listener, device: input_device.InputDevice):
logger.debug("Signal: backend new_input_event")
if device.device_type == input_device.InputDeviceType.POINTER:
self._add_new_pointer(device)
elif device.device_type == input_device.InputDeviceType.KEYBOARD:
self._add_new_keyboard(device)
capabilities = WlSeat.capability.pointer
if len(self.keyboards) > 0:
capabilities |= WlSeat.capability.keyboard
logger.info("New input: " + str(device.device_type))
logger.info("Input capabilities: " + str(capabilities))
self.seat.set_capabilities(capabilities)
def _on_new_output(self, _listener, wlr_output: wlrOutput):
logger.debug("Signal: backend new_output_event")
if wlr_output.modes != []:
mode = wlr_output.preferred_mode()
if mode is None:
logger.error("New output has no output mode")
return
wlr_output.set_mode(mode)
wlr_output.enable()
wlr_output.commit()
self.outputs.append(output.Output(self, wlr_output))
self.output_layout.add_auto(wlr_output)
def _on_request_cursor(self, _listener,
event: seat.PointerRequestSetCursorEvent):
logger.debug("Signal: seat request_set_cursor_event")
# if self._seat.pointer_state.focused_surface == event.seat_client: # needs updating pywlroots first
self.cursor.set_surface(event.surface, event.hotspot)
def _on_new_xdg_surface(self, _listener, surface: xdg_shell.XdgSurface):
logger.debug("Signal: xdg_shell new_surface_event")
assert self.qtile is not None
if surface.role != xdg_shell.XdgSurfaceRole.TOPLEVEL:
return
wid = 0
wids = self.qtile.windows_map.keys()
while True:
if wid not in wids:
break
wid += 1
win = window.Window(self, self.qtile, surface, wid)
logger.info(f"Managing new top-level window with window ID: {wid}")
self.qtile.manage(win)
def _on_cursor_axis(self, _listener, event: pointer.PointerEventAxis):
logger.debug("Signal: cursor axis")
self.seat.pointer_notify_axis(
event.time_msec,
event.orientation,
event.delta,
event.delta_discrete,
event.source,
)
def _on_cursor_frame(self, _listener, _data):
logger.debug("Signal: cursor frame")
self.seat.pointer_notify_frame()
def _on_cursor_button(self, _listener, event: pointer.PointerEventButton):
assert self.qtile is not None
logger.debug("Signal: cursor button")
self.seat.pointer_notify_button(event.time_msec, event.button,
event.button_state)
state = self.seat.keyboard.modifier
button = wlrq.buttons_inv.get(event.button)
if event.button_state == input_device.ButtonState.PRESSED:
self.qtile.process_button_click(button, state, self.cursor.x,
self.cursor.y, event)
else:
self.qtile.process_button_release(button, state)
def _on_cursor_motion(self, _listener, event: pointer.PointerEventMotion):
assert self.qtile is not None
logger.debug("Signal: cursor motion")
self.cursor.move(event.delta_x,
event.delta_y,
input_device=event.device)
self._process_cursor_motion(event.time_msec)
def _on_cursor_motion_absolute(self, _listener,
event: pointer.PointerEventMotionAbsolute):
assert self.qtile is not None
logger.debug("Signal: cursor motion_absolute")
self.cursor.warp(
WarpMode.AbsoluteClosest,
event.x,
event.y,
input_device=event.device,
)
self._process_cursor_motion(event.time_msec)
def _on_new_virtual_keyboard(self, _listener,
virtual_keyboard: VirtualKeyboardV1):
self._add_new_keyboard(virtual_keyboard.input_device)
def _process_cursor_motion(self, time):
self.qtile.process_button_motion(self.cursor.x, self.cursor.y)
found = self._under_pointer()
if found:
win, surface, sx, sy = found
focus_changed = self.seat.pointer_state.focused_surface != surface
self.seat.pointer_notify_enter(surface, sx, sy)
if focus_changed:
hook.fire("client_mouse_enter", win)
if self.qtile.config.follow_mouse_focus:
if win.group.current_window != self:
win.group.focus(win, False)
if win.group.screen and self.qtile.current_screen != win.group.screen:
self.qtile.focus_screen(win.group.screen.index, False)
self.focus_window(win, surface)
else:
# The enter event contains coordinates, so we only need to
# notify on motion if the focus did not change
self.seat.pointer_notify_motion(time, sx, sy)
else:
self.cursor_manager.set_cursor_image("left_ptr", self.cursor)
self.seat.pointer_clear_focus()
def _add_new_pointer(self, device: input_device.InputDevice):
logger.info("Adding new pointer")
self.cursor.attach_input_device(device)
def _add_new_keyboard(self, device: input_device.InputDevice):
logger.info("Adding new keyboard")
self.keyboards.append(keyboard.Keyboard(self, device))
self.seat.set_keyboard(device)
def setup_listener(self, qtile: Qtile) -> None:
"""Setup a listener for the given qtile instance"""
logger.debug("Adding io watch")
self.qtile = qtile
self.fd = lib.wl_event_loop_get_fd(self.event_loop._ptr)
asyncio.get_running_loop().add_reader(self.fd, self._poll)
def remove_listener(self) -> None:
"""Remove the listener from the given event loop"""
if self.fd is not None:
logger.debug("Removing io watch")
loop = asyncio.get_running_loop()
loop.remove_reader(self.fd)
self.fd = None
def _poll(self) -> None:
if not self.display.destroyed:
self.display.flush_clients()
self.event_loop.dispatch(-1)
def focus_window(self, win: window.Window, surface: Surface = None):
if surface is None:
surface = win.surface.surface
previous_surface = self.seat.keyboard_state.focused_surface
if previous_surface == surface:
return
if previous_surface is not None and previous_surface.is_xdg_surface:
# Deactivate the previously focused surface
previous_xdg_surface = xdg_shell.XdgSurface.from_surface(
previous_surface)
previous_xdg_surface.set_activated(False)
# activate the new surface
win.surface.set_activated(True)
self.seat.keyboard_notify_enter(surface, self.seat.keyboard)
logger.debug("Focussed new window")
def focus_by_click(self, event) -> None:
found = self._under_pointer()
if found:
win, surface, _, _ = found
self.focus_window(win, surface)
def _under_pointer(self):
assert self.qtile is not None
cx = self.cursor.x
cy = self.cursor.y
for win in self.qtile.windows_map.values():
assert isinstance(win,
window.Window) # mypy is dumb and needs this
if win.mapped:
surface, sx, sy = win.surface.surface_at(
cx - win.x, cy - win.y)
if surface:
return win, surface, sx, sy
if win.borderwidth:
bw = win.borderwidth
if win.x - bw <= cx and win.y - bw <= cy:
if cx <= win.x + win.width + bw and cy <= win.y + win.height + bw:
return win, win.surface.surface, 0, 0
return None
def update_desktops(self, groups: List[group._Group], index: int) -> None:
"""Set the current desktops of the window manager
The list of desktops is given by the list of groups, with the current
desktop given by the index
"""
new_count = len(groups)
while new_count > self.desktops:
self.desktops += 1
while new_count < self.desktops:
self.desktops -= 1
self.current_desktop = index
def get_screen_info(self) -> List[Tuple[int, int, int, int]]:
"""Get the screen information"""
return [screen.get_geometry() for screen in self.outputs]
def grab_key(self, key: Union[config.Key,
config.KeyChord]) -> Tuple[int, int]:
"""Configure the backend to grab the key event"""
keysym = xkb.keysym_from_name(key.key, case_insensitive=True)
mask_key = wlrq.translate_masks(key.modifiers)
self.grabbed_keys.append((keysym, mask_key))
return keysym, mask_key
def ungrab_key(self, key: Union[config.Key,
config.KeyChord]) -> Tuple[int, int]:
"""Release the given key event"""
keysym = xkb.keysym_from_name(key.key, case_insensitive=True)
mask_key = wlrq.translate_masks(key.modifiers)
self.grabbed_keys.remove((keysym, mask_key))
return keysym, mask_key
def ungrab_keys(self) -> None:
"""Release the grabbed key events"""
self.grabbed_keys.clear()
def grab_button(self, mouse: config.Mouse) -> int:
"""Configure the backend to grab the mouse event"""
keysym = wlrq.buttons.get(mouse.button_code)
assert keysym is not None
mask_key = wlrq.translate_masks(mouse.modifiers)
self.grabbed_buttons.append((keysym, mask_key))
return mask_key
def ungrab_buttons(self) -> None:
"""Release the grabbed button events"""
self.grabbed_buttons.clear()
def grab_pointer(self) -> None:
"""Configure the backend to grab mouse events"""
def ungrab_pointer(self) -> None:
"""Release grabbed pointer events"""
def warp_pointer(self, x, y) -> None:
"""Warp the pointer to the coordinates in relative to the output layout"""
self.cursor.warp(WarpMode.LayoutClosest, x, y)
def flush(self) -> None:
self._poll()
def graceful_shutdown(self):
"""Try to close windows gracefully before exiting"""
assert self.qtile is not None
for win in self.qtile.windows_map.values():
win.kill()
# give everyone a little time to exit and write their state. but don't
# sleep forever (1s).
end = time.time() + 1
while time.time() < end:
self._poll()
if not self.qtile.windows_map:
break
def change_vt(self, vt: int) -> bool:
"""Change virtual terminal to that specified"""
success = self.backend.get_session().change_vt(vt)
if not success:
logger.warning(f"Could not change VT to: {vt}")
return success
@property
def painter(self):
return wlrq.Painter(self)