Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion guake/data/org.guake.gschema.xml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,12 @@
<key name="display-n" type="i">
<default>0</default>
<summary>Display to appear on.</summary>
<description>Display to appear on if the mouse_display option is not set. If this is set to an invalid value (as in the case of removing a screen from a system), the invalid value is automatically updated to the current primary screen.</description>
<description>Display to appear on if mouse-display is not set. A value of -1 follows the primary display. For a fixed display, display-name takes precedence over this index. If the selected display is unavailable, use the primary display without changing the saved choice.</description>
</key>
<key name="display-name" type="s">
<default>''</default>
<summary>Name of the selected display.</summary>
<description>GDK monitor model identifying the selected display, usually the output connector name on X11. Keeps the selected display when monitor indices change. Empty if unavailable or ambiguous, in which case display-n is used.</description>
</key>
<key name="default-shell" type="s">
<default>''</default>
Expand Down
91 changes: 44 additions & 47 deletions guake/prefs.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@
from guake.terminal import GuakeTerminal
from guake.theme import list_all_themes
from guake.theme import select_gtk_theme
from guake.utils import get_display_index
from guake.utils import get_monitor_name

# pylint: disable=unsubscriptable-object

Expand Down Expand Up @@ -436,19 +438,14 @@ def on_bottom_align_toggled(self, chk):

def on_display_n_changed(self, combo):
"""Set the destination display in dconf."""

i = combo.get_active_iter()
if not i:
if self.prefDlg.loading_display_settings:
return

model = combo.get_model()
first_item_path = model.get_path(model.get_iter_first())

if model.get_path(i) == first_item_path:
val_int = ALWAYS_ON_PRIMARY
else:
val = model.get_value(i, 0)
val_int = int(val.split()[0]) # extracts 1 from '1' or from '1 (primary)'
value = combo.get_active_id()
if value is None or value == "unavailable":
return
val_int = int(value)
display = self.prefDlg.window.get_display()
self.settings.general.set_string("display-name", get_monitor_name(display, val_int))
self.settings.general.set_int("display-n", val_int)

def on_window_height_value_changed(self, hscale):
Expand Down Expand Up @@ -665,6 +662,7 @@ def __init__(self, settings):
"""
self.hotkey_alread_used = False
self.store = None
self.loading_display_settings = False

super().__init__(gladefile("prefs.glade"), root="config-window")
style_provider = Gtk.CssProvider()
Expand Down Expand Up @@ -751,9 +749,11 @@ class fake_guake:

self.populate_shell_combo()
self.populate_keys_tree()
self.populate_display_n()
self.populate_gtk_theme_names()
self.load_configs()
self.monitors_changed_handler = self.window.get_screen().connect(
"monitors-changed", self._load_screen_settings
)
self.get_widget("config-window").hide()

def spawn_sync_pid(self, directory=None, terminal=None):
Expand Down Expand Up @@ -808,6 +808,7 @@ def hide(self):
self.get_widget("config-window").hide()

def on_destroy(self, window):
self.window.get_screen().disconnect(self.monitors_changed_handler)
self.demo_terminal.kill()
self.demo_terminal.destroy()

Expand Down Expand Up @@ -1016,32 +1017,27 @@ def _load_default_shell_settings(self):
combo.set_active_iter(i.iter)
break

def _load_screen_settings(self):
def _load_screen_settings(self, *_args):
"""Load screen settings"""
# display number / use primary display
combo = self.get_widget("display_n")
dest_screen = self.settings.general.get_int("display-n")
# If Guake is configured to use a screen that is not currently attached,
# default to 'primary display' option.
screen = self.get_widget("config-window").get_screen()
n_screens = screen.get_n_monitors()
if dest_screen > n_screens - 1:
self.settings.general.set_boolean("mouse-display", False)
dest_screen = screen.get_primary_monitor()
self.settings.general.set_int("display-n", dest_screen)

if dest_screen == ALWAYS_ON_PRIMARY:
first_item = combo.get_model().get_iter_first()
combo.set_active_iter(first_item)
else:
seen_first = False # first item "always on primary" is special
for i in combo.get_model():
if seen_first:
i_int = int(i[0].split()[0]) # extracts 1 from '1' or from '1 (primary)'
if i_int == dest_screen:
combo.set_active_iter(i.iter)
else:
seen_first = True
display = self.window.get_display()
dest_screen = get_display_index(self.settings, display)
self.loading_display_settings = True
try:
self.populate_display_n()
if (
dest_screen == ALWAYS_ON_PRIMARY
and self.settings.general.get_int("display-n") != ALWAYS_ON_PRIMARY
):
name = self.settings.general.get_string("display-name") or str(
self.settings.general.get_int("display-n")
)
combo.append("unavailable", _("Unavailable display: %s") % name)
combo.set_active_id("unavailable")
else:
combo.set_active_id(str(dest_screen))
finally:
self.loading_display_settings = False

def load_configs(self):
"""Load configurations for all widgets in General, Scrolling
Expand Down Expand Up @@ -1401,16 +1397,17 @@ def populate_display_n(self):
with them all. Prepend the "always on primary" option.
"""
cb = self.get_widget("display_n")
screen = self.get_widget("config-window").get_screen()

cb.append_text("always on primary")

for m in range(0, int(screen.get_n_monitors())):
if m == int(screen.get_primary_monitor()):
# TODO l10n
cb.append_text(str(m) + " " + "(primary)")
else:
cb.append_text(str(m))
display = self.window.get_display()
cb.remove_all()
cb.append(str(ALWAYS_ON_PRIMARY), "always on primary")
for m in range(display.get_n_monitors()):
monitor = display.get_monitor(m)
label = str(m)
if monitor.get_model():
label += " - " + monitor.get_model()
if monitor.is_primary():
label += " (primary)"
cb.append(str(m), label)

# -- key handling --

Expand Down
166 changes: 166 additions & 0 deletions guake/tests/test_monitor_selection.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
# -*- coding: utf-8 -*-
# pylint: disable=redefined-outer-name,protected-access
from types import SimpleNamespace

import pytest

import gi

gi.require_version("Gtk", "3.0")
from gi.repository import Gtk
from guake.globals import ALWAYS_ON_PRIMARY
from guake.prefs import PrefsCallbacks
from guake.prefs import PrefsDialog
from guake.utils import RectCalculator
from guake.utils import get_display_index
from guake.utils import get_monitor_name


@pytest.fixture
def settings(mocker):
values = {"display-n": 1, "display-name": "", "mouse-display": False}
general = mocker.Mock()
general.get_int.side_effect = values.__getitem__
general.get_string.side_effect = values.__getitem__
general.get_boolean.side_effect = values.__getitem__
general.set_int.side_effect = values.__setitem__
general.set_string.side_effect = values.__setitem__
general.set_boolean.side_effect = values.__setitem__
return SimpleNamespace(general=general)


@pytest.fixture
def display(mocker):
display = mocker.Mock()
primary = mocker.Mock()
primary.get_model.return_value = "eDP-1"
primary.is_primary.return_value = True
external = mocker.Mock()
external.get_model.return_value = "DP-1"
external.is_primary.return_value = False
display.monitors = [primary, external]
display.get_n_monitors.side_effect = lambda: len(display.monitors)
display.get_monitor.side_effect = lambda i: display.monitors[i]
display.get_primary_monitor.return_value = primary
return display


def test_numeric_selection_is_migrated_and_survives_reordering(settings, display, mocker):
window = mocker.Mock()
window.get_display.return_value = display
selected = display.monitors[1]
assert RectCalculator.get_final_window_monitor(settings, window) is selected
assert settings.general.get_string("display-name") == "DP-1"

display.monitors.reverse()
assert settings.general.get_int("display-n") == 1
assert RectCalculator.get_final_window_monitor(settings, window) is selected


def test_saved_name_survives_restart(settings, display, mocker):
settings.general.set_string("display-name", "DP-1")
# New GDK monitor objects, in a different order from the previous process.
selected = mocker.Mock()
selected.get_model.return_value = "DP-1"
display.monitors = [selected, display.monitors[0]]
assert get_display_index(settings, display) == 0


def test_disconnected_display_is_retained_until_reconnected(settings, display, mocker):
window = mocker.Mock()
window.get_display.return_value = display
selected = display.monitors[1]
get_display_index(settings, display)
display.monitors = [display.monitors[0]]
assert RectCalculator.get_final_window_monitor(settings, window) is display.monitors[0]
assert settings.general.get_string("display-name") == "DP-1"
assert settings.general.get_int("display-n") == 1

display.monitors.insert(0, selected)
assert RectCalculator.get_final_window_monitor(settings, window) is selected


def test_primary_selection_ignores_saved_name(settings, display, mocker):
settings.general.set_int("display-n", ALWAYS_ON_PRIMARY)
settings.general.set_string("display-name", "DP-1")
window = mocker.Mock()
window.get_display.return_value = display
assert RectCalculator.get_final_window_monitor(settings, window) is display.monitors[0]


@pytest.mark.parametrize("pointer_available", [True, False])
def test_mouse_selection_still_takes_precedence(settings, display, mocker, pointer_available):
settings.general.set_boolean("mouse-display", True)
settings.general.set_string("display-name", "disconnected")
window = mocker.Mock()
window.get_display.return_value = display
pointer = mocker.Mock() if pointer_available else None
display.get_default_seat.return_value.get_pointer.return_value = pointer
if pointer:
pointer.get_position.return_value = (None, 2000, 100)
display.get_monitor_at_point.return_value = display.monitors[1]
expected = display.monitors[1 if pointer_available else 0]
assert RectCalculator.get_final_window_monitor(settings, window) is expected


@pytest.mark.parametrize("name", [None, "", "eDP-1"])
def test_missing_or_ambiguous_name_keeps_numeric_fallback(settings, display, name):
display.monitors[1].get_model.return_value = name
assert get_monitor_name(display, 1) == ""
assert get_display_index(settings, display) == 1
assert settings.general.get_string("display-name") == ""


@pytest.mark.parametrize("index", [-2, 2, 100])
def test_invalid_legacy_index_falls_back_without_changing_settings(settings, display, index):
settings.general.set_int("display-n", index)
assert get_display_index(settings, display) == ALWAYS_ON_PRIMARY
assert settings.general.get_int("display-n") == index


@pytest.fixture
def dialog(settings, display, mocker):
dialog = PrefsDialog.__new__(PrefsDialog)
dialog.settings = settings
dialog.window = mocker.Mock()
dialog.window.get_display.return_value = display
dialog.loading_display_settings = False
combo = Gtk.ComboBoxText()
mocker.patch.object(dialog, "get_widget", return_value=combo)
combo.connect("changed", PrefsCallbacks(dialog).on_display_n_changed)
return dialog


def test_preferences_reordering_does_not_overwrite_selected_name(dialog, display):
dialog._load_screen_settings()
display.monitors.reverse()
dialog._load_screen_settings()
assert dialog.get_widget("display_n").get_active_id() == "0"
assert dialog.settings.general.get_string("display-name") == "DP-1"
assert dialog.settings.general.get_int("display-n") == 1


def test_preferences_keep_missing_display_and_mouse_mode(dialog, display):
dialog._load_screen_settings()
dialog.settings.general.set_boolean("mouse-display", True)
selected = display.monitors.pop()
dialog._load_screen_settings()
assert dialog.get_widget("display_n").get_active_id() == "unavailable"
assert dialog.settings.general.get_string("display-name") == "DP-1"
assert dialog.settings.general.get_int("display-n") == 1
assert dialog.settings.general.get_boolean("mouse-display")

display.monitors.insert(0, selected)
dialog._load_screen_settings()
assert dialog.get_widget("display_n").get_active_id() == "0"


def test_preferences_can_choose_another_display_or_primary(dialog):
dialog._load_screen_settings()
combo = dialog.get_widget("display_n")
combo.set_active_id("0")
assert dialog.settings.general.get_string("display-name") == "eDP-1"
assert dialog.settings.general.get_int("display-n") == 0
combo.set_active_id(str(ALWAYS_ON_PRIMARY))
assert dialog.settings.general.get_string("display-name") == ""
assert dialog.settings.general.get_int("display-n") == ALWAYS_ON_PRIMARY
38 changes: 36 additions & 2 deletions guake/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
from guake.globals import ALIGN_LEFT
from guake.globals import ALIGN_RIGHT
from guake.globals import ALIGN_TOP
from guake.globals import ALWAYS_ON_PRIMARY

try:
from gi.repository import GdkX11
Expand Down Expand Up @@ -247,6 +248,39 @@ def toggle_fullscreen_hide_tabbar(self):
self.guake.notebook_manager.set_notebooks_tabbar_visible(v)


def get_monitor_name(display, index):
"""Return a monitor name only when it uniquely identifies an attached output."""
if not 0 <= index < display.get_n_monitors():
return ""
name = display.get_monitor(index).get_model() or ""
names = [display.get_monitor(i).get_model() for i in range(display.get_n_monitors())]
return name if names.count(name) == 1 else ""


def get_display_index(settings, display):
"""Resolve a saved display name, retaining the numeric setting for older configs."""
index = settings.general.get_int("display-n")
if index == ALWAYS_ON_PRIMARY:
return ALWAYS_ON_PRIMARY

name = settings.general.get_string("display-name")
if name:
matches = [
i for i in range(display.get_n_monitors()) if display.get_monitor(i).get_model() == name
]
if len(matches) == 1:
return matches[0]
if not matches:
# A temporarily disconnected display must not erase the saved choice.
return ALWAYS_ON_PRIMARY
else:
name = get_monitor_name(display, index)
if name:
settings.general.set_string("display-name", name)

return index if 0 <= index < display.get_n_monitors() else ALWAYS_ON_PRIMARY


class RectCalculator:
@classmethod
def set_final_window_rect(cls, settings, window):
Expand Down Expand Up @@ -331,7 +365,6 @@ def get_final_window_monitor(cls, settings, window):

# fetch settings
use_mouse = settings.general.get_boolean("mouse-display")
num_monitor = settings.general.get_int("display-n")

if use_mouse:
pointer = display.get_default_seat().get_pointer()
Expand All @@ -341,7 +374,8 @@ def get_final_window_monitor(cls, settings, window):
_, x, y = pointer.get_position()
monitor = display.get_monitor_at_point(x, y)
else:
monitor = display.get_monitor(num_monitor)
num_monitor = get_display_index(settings, display)
monitor = display.get_monitor(num_monitor) if num_monitor >= 0 else None
if monitor is None:
# monitor not found or num_monitor is wrong
# by default we use the primary monitor
Expand Down
6 changes: 6 additions & 0 deletions releasenotes/notes/bugfix-86fe9177f3b6310d.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
fixes:
- |
Keep Guake on the selected display when monitor indices change after suspend
or reconnecting a screen. Remember the GDK monitor name alongside the numeric
selection, and retain it while the display is disconnected. The display list
in Preferences now includes monitor names and refreshes when displays change.