Skip to content

Introduce Monitor Layout Manager #423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
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
15 changes: 15 additions & 0 deletions data/display.gschema.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<schemalist>
<schema id="io.elementary.settings.display" path="/io/elementary/settings/display/">

<key name="preferred-display-layouts" type="a{sa{sa{sv}}}">
<default>{}</default>
<summary>Preferred display layouts</summary>
<description>
Stores user-defined display layout profiles.
Each profile contains a unique identifier and a list of monitors, with their respective position (x, y) and other properties such as transformation (e.g., rotation).
This allows the system to restore or suggest preferred monitor arrangements and settings when displays are connected or configurations change.
</description>
</key>

</schema>
</schemalist>
6 changes: 6 additions & 0 deletions data/meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,9 @@ gresource = gnome.compile_resources(
'gresource',
'display.gresource.xml'
)

install_data(
'display.gschema.xml',
install_dir: datadir / 'glib-2.0' / 'schemas',
rename: 'io.elementary.settings.display.gschema.xml'
)
2 changes: 2 additions & 0 deletions meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,5 @@ config_file = configure_file(
subdir('data')
subdir('src')
subdir('po')

gnome.post_install(glib_compile_schemas: true)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

meson_version should be set to '>=0.57' so that it doesn't try to run the build script in a older version.

192 changes: 192 additions & 0 deletions src/Objects/MonitorLayoutManager.vala

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that this class isn't necessary at all. There's just the settings object, and with the code cleaned, what rest is arrange_windows, save_layout, and get_layout_key.

all would be better residing in the MonitorManager class.

Original file line number Diff line number Diff line change
@@ -0,0 +1,192 @@
/*
* SPDX-License-Identifier: GPL-2.0-or-later
* SPDX-FileCopyrightText: 2025 elementary, Inc. <https://elementary.io>
*
* Authored by: Leonardo Lemos <leonardolemos@live.com>
*/

public class Display.MonitorLayoutManager : GLib.Object {
private Settings settings;

private const string PREFERRED_MONITOR_LAYOUTS_KEY = "preferred-display-layouts";

public MonitorLayoutManager () {
Object ();
}

construct {
settings = new Settings ("io.elementary.settings.display");
}

public void arrange_monitors (Gee.LinkedList<VirtualMonitor> virtual_monitors) {
if (virtual_monitors.size == 1) {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cloned monitors have just one virtual monitor, so the checks bellow aren't necessary.

// If there's only one monitor, no need to arrange
return;
}

var layout_key = get_layout_key (virtual_monitors);
var layout = find_match_layout (layout_key);

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

find_match_layout should be inlined.

var is_cloned = is_virtual_monitors_cloned (virtual_monitors);
var has_update = false;

if (layout != null) {
foreach (var virtual_monitor in virtual_monitors) {
var monitor_position = layout
.find_position_by_id (virtual_monitor.monitors[0].hash.to_string ());

if (monitor_position != null) {
if ((virtual_monitor.x != monitor_position.x
|| virtual_monitor.y != monitor_position.y
|| virtual_monitor.transform != monitor_position.transform)
&& !is_cloned) {
has_update = true;
break;
}

virtual_monitor.x = monitor_position.x;
virtual_monitor.y = monitor_position.y;
virtual_monitor.transform = monitor_position.transform;
}
}
} else {
// If no layout found, we save the current layout to use later
save_layout (virtual_monitors);
}

if (has_update) {
// If the layout has been updated, save the new layout
save_layout (virtual_monitors);
}
Comment on lines +30 to +59

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With MonitorManager.get_monitor_config() calling save_layout, and MonitorManager.disable_clone_mode() calling arrange_monitors, there's no need for handling updating the layout here.

The suggestion is assuming the above and that we are receiving the monitors dictionary from find_match_layout.

Suggested change
var has_update = false;
if (layout != null) {
foreach (var virtual_monitor in virtual_monitors) {
var monitor_position = layout
.find_position_by_id (virtual_monitor.monitors[0].hash.to_string ());
if (monitor_position != null) {
if ((virtual_monitor.x != monitor_position.x
|| virtual_monitor.y != monitor_position.y
|| virtual_monitor.transform != monitor_position.transform)
&& !is_cloned) {
has_update = true;
break;
}
virtual_monitor.x = monitor_position.x;
virtual_monitor.y = monitor_position.y;
virtual_monitor.transform = monitor_position.transform;
}
}
} else {
// If no layout found, we save the current layout to use later
save_layout (virtual_monitors);
}
if (has_update) {
// If the layout has been updated, save the new layout
save_layout (virtual_monitors);
}
if (layout != null) {
foreach (var virtual_monitor in virtual_monitors) {
VariantDict monitor_position;
if (layout.lookup (virtual_monitor.id, "a{sv}", out monitor_position)) {
virtual_monitor.x = monitor_position.lookup_value ("x").get_int ();
virtual_monitor.y = monitor_position.lookup_value ("y").get_int ();
virtual_monitor.transform = monitor_position.lookup_value ("transform").get_uint ();
}
}
} else {
// If no layout found, we save the current layout to use later
save_layout (virtual_monitors);
}

or with "{s(iiu)}" instead of "{sv}"

Suggested change
var has_update = false;
if (layout != null) {
foreach (var virtual_monitor in virtual_monitors) {
var monitor_position = layout
.find_position_by_id (virtual_monitor.monitors[0].hash.to_string ());
if (monitor_position != null) {
if ((virtual_monitor.x != monitor_position.x
|| virtual_monitor.y != monitor_position.y
|| virtual_monitor.transform != monitor_position.transform)
&& !is_cloned) {
has_update = true;
break;
}
virtual_monitor.x = monitor_position.x;
virtual_monitor.y = monitor_position.y;
virtual_monitor.transform = monitor_position.transform;
}
}
} else {
// If no layout found, we save the current layout to use later
save_layout (virtual_monitors);
}
if (has_update) {
// If the layout has been updated, save the new layout
save_layout (virtual_monitors);
}
if (layout != null) {
foreach (var virtual_monitor in virtual_monitors) {
DisplayTransform transform;
int x, y;
if (layout.lookup (virtual_monitor.id, "(iiu)", out x, out y, out transform)) {
virtual_monitor.x = x;
virtual_monitor.y = y;
virtual_monitor.transform = transform;
}
}
} else {
// If no layout found, we save the current layout to use later
save_layout (virtual_monitors);
}

}

public void save_layout (Gee.LinkedList<VirtualMonitor> virtual_monitors) {
var key = get_layout_key (virtual_monitors);
var layout_variant = build_layout_variant (virtual_monitors);

var layouts = settings.get_value (PREFERRED_MONITOR_LAYOUTS_KEY);

add_or_update_layout (layouts, key, layout_variant);
}
Comment on lines +62 to +69

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

build_layout_variant and add_or_update_layout should be inlined here.


public MonitorLayoutProfile? find_match_layout (string key) {
// Layouts format are 'a{sa{sa{sv}}}'

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"a{sa{s(iiu)}}" should be simpler, we don't need the monitor properties be extensible, nor the extra boxing of using variant values.

var layouts = settings.get_value (PREFERRED_MONITOR_LAYOUTS_KEY);

if (layouts == null || layouts.n_children () == 0) {
return null; // No layouts saved
}

for (var i = 0; i < layouts.n_children (); i++) {
var layout = layouts.get_child_value (i);
var layout_key = layout.get_child_value (0).get_string ();
var monitors = layout.get_child_value (1);

if (layout_key != key) {
continue;
}

var virtual_monitor_position = new MonitorLayoutProfile (layout_key);

// Process the monitors in the layout
for (var j = 0; j < monitors.n_children (); j++) {
var monitor = monitors.get_child_value (j);
var monitor_props = monitor.get_child_value (1);

virtual_monitor_position.add_position (
monitor.get_child_value (0)
.get_string (), // id
monitor_props.get_child_value (0)
.get_child_value (1)
.get_child_value (0)
.get_int32 (), // x position
monitor_props.get_child_value (1)
.get_child_value (1)
.get_child_value (0)
.get_int32 (), // y position
monitor_props.get_child_value (2)
.get_child_value (1)
.get_child_value (0)
.get_int32 () // transform
);
}

return virtual_monitor_position;
}
Comment on lines +75 to +114

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need for the first check and returning the monitors dictionary should also remove the need of both iterations (and of the MonitorLayoutProfile class).

Suggested change
if (layouts == null || layouts.n_children () == 0) {
return null; // No layouts saved
}
for (var i = 0; i < layouts.n_children (); i++) {
var layout = layouts.get_child_value (i);
var layout_key = layout.get_child_value (0).get_string ();
var monitors = layout.get_child_value (1);
if (layout_key != key) {
continue;
}
var virtual_monitor_position = new MonitorLayoutProfile (layout_key);
// Process the monitors in the layout
for (var j = 0; j < monitors.n_children (); j++) {
var monitor = monitors.get_child_value (j);
var monitor_props = monitor.get_child_value (1);
virtual_monitor_position.add_position (
monitor.get_child_value (0)
.get_string (), // id
monitor_props.get_child_value (0)
.get_child_value (1)
.get_child_value (0)
.get_int32 (), // x position
monitor_props.get_child_value (1)
.get_child_value (1)
.get_child_value (0)
.get_int32 (), // y position
monitor_props.get_child_value (2)
.get_child_value (1)
.get_child_value (0)
.get_int32 () // transform
);
}
return virtual_monitor_position;
}
VariantDict monitors;
if (layouts.lookup (key, "a{sa{sv}}", out monitors)) {
return monitors;
}


return null;
}

private string get_layout_key (Gee.LinkedList<VirtualMonitor> virtual_monitors) {
// Generate a unique key based on the virtual monitors' monitors hashes
var key = new StringBuilder ();

foreach (var virtual_monitor in virtual_monitors) {
foreach (var monitor in virtual_monitor.monitors) {
key.append (monitor.hash.to_string ());
}
}

return key.str.hash ().to_string ();
Comment on lines +121 to +129

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be unique enough.

Suggested change
var key = new StringBuilder ();
foreach (var virtual_monitor in virtual_monitors) {
foreach (var monitor in virtual_monitor.monitors) {
key.append (monitor.hash.to_string ());
}
}
return key.str.hash ().to_string ();
var key = new StringBuilder ();
foreach (var virtual_monitor in virtual_monitors) {
key.append (virtual_monitor.id);
}
return key.str;

}

private GLib.Variant build_layout_variant (Gee.LinkedList<VirtualMonitor> virtual_monitors) {
var dict_builder = new VariantBuilder (VariantType.DICTIONARY);

foreach (var monitor in virtual_monitors) {
var props_builder = new VariantBuilder (VariantType.DICTIONARY);
var key = monitor.monitors.get (0).hash.to_string ();

var coordinate_x_variant = new Variant.variant (new Variant.int32 (monitor.x));
var coordinate_y_variant = new Variant.variant (new Variant.int32 (monitor.y));
var transform_variant = new Variant.variant (new Variant.int32 (monitor.transform));

props_builder.add_value (new Variant.dict_entry ("x", coordinate_x_variant));
props_builder.add_value (new Variant.dict_entry ("y", coordinate_y_variant));
props_builder.add_value (new Variant.dict_entry ("transform", transform_variant));

var props_variant = props_builder.end ();

warning (props_variant.print (true));

dict_builder.add_value (new Variant.dict_entry (key, props_variant));
}

return dict_builder.end ();
Comment on lines +133 to +154

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using VariantDict here make the code simple. Also, you can use monitor.id instead of getting the id of the first monitor only.

Suggested change
var dict_builder = new VariantBuilder (VariantType.DICTIONARY);
foreach (var monitor in virtual_monitors) {
var props_builder = new VariantBuilder (VariantType.DICTIONARY);
var key = monitor.monitors.get (0).hash.to_string ();
var coordinate_x_variant = new Variant.variant (new Variant.int32 (monitor.x));
var coordinate_y_variant = new Variant.variant (new Variant.int32 (monitor.y));
var transform_variant = new Variant.variant (new Variant.int32 (monitor.transform));
props_builder.add_value (new Variant.dict_entry ("x", coordinate_x_variant));
props_builder.add_value (new Variant.dict_entry ("y", coordinate_y_variant));
props_builder.add_value (new Variant.dict_entry ("transform", transform_variant));
var props_variant = props_builder.end ();
warning (props_variant.print (true));
dict_builder.add_value (new Variant.dict_entry (key, props_variant));
}
return dict_builder.end ();
var dict_builder = new VariantDict ();
foreach (var monitor in virtual_monitors) {
var props_builder = new VariantDict ();
props_builder.insert ("x", "v", new Variant.int32 (monitor.x));
props_builder.insert ("y", "v", new Variant.int32 (monitor.y));
props_builder.insert ("transform", "v", new Variant.uint32 (monitor.transform));
var props_variant = props_builder.end ();
debug (props_variant.print (true));
dict_builder.insert_value (monitor.id, props_variant));
}
return dict_builder.end ();

or using "{s(iiu)}" instead of "{sv}"

Suggested change
var dict_builder = new VariantBuilder (VariantType.DICTIONARY);
foreach (var monitor in virtual_monitors) {
var props_builder = new VariantBuilder (VariantType.DICTIONARY);
var key = monitor.monitors.get (0).hash.to_string ();
var coordinate_x_variant = new Variant.variant (new Variant.int32 (monitor.x));
var coordinate_y_variant = new Variant.variant (new Variant.int32 (monitor.y));
var transform_variant = new Variant.variant (new Variant.int32 (monitor.transform));
props_builder.add_value (new Variant.dict_entry ("x", coordinate_x_variant));
props_builder.add_value (new Variant.dict_entry ("y", coordinate_y_variant));
props_builder.add_value (new Variant.dict_entry ("transform", transform_variant));
var props_variant = props_builder.end ();
warning (props_variant.print (true));
dict_builder.add_value (new Variant.dict_entry (key, props_variant));
}
return dict_builder.end ();
var dict_builder = new VariantDict ();
foreach (var monitor in virtual_monitors) {
dict_builder.insert (monitor.id, "(iiu)", monitor.x, monitor.y, monitor.transform);
}
return dict_builder.end ();

}

private void add_or_update_layout (GLib.Variant layouts, string key, GLib.Variant layout_variant) {
var layout_builder = new VariantBuilder (VariantType.DICTIONARY);
bool found = false;

for (var i = 0; i < layouts.n_children (); i++) {
var layout = layouts.get_child_value (i);
var layout_key = layout.get_child_value (0).get_string ();

if (layout_key == key) {
// Update existing layout
layout_builder.add_value (new Variant.dict_entry (key, layout_variant));
found = true;
} else {
// Keep existing layout
layout_builder.add_value (new Variant.dict_entry (layout_key, layout));
}
}

if (!found) {
// Add new layout
layout_builder.add_value (new Variant.dict_entry (key, layout_variant));
}
Comment on lines +158 to +178

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here.

Suggested change
var layout_builder = new VariantBuilder (VariantType.DICTIONARY);
bool found = false;
for (var i = 0; i < layouts.n_children (); i++) {
var layout = layouts.get_child_value (i);
var layout_key = layout.get_child_value (0).get_string ();
if (layout_key == key) {
// Update existing layout
layout_builder.add_value (new Variant.dict_entry (key, layout_variant));
found = true;
} else {
// Keep existing layout
layout_builder.add_value (new Variant.dict_entry (layout_key, layout));
}
}
if (!found) {
// Add new layout
layout_builder.add_value (new Variant.dict_entry (key, layout_variant));
}
var layout_builder = new VariantDict (layouts);
layout_builder.insert_value (key, layout_variant);


settings.set_value (PREFERRED_MONITOR_LAYOUTS_KEY, layout_builder.end ());
}

private bool is_virtual_monitors_cloned (Gee.LinkedList<VirtualMonitor> virtual_monitors) {
foreach (var monitor in virtual_monitors) {
if (monitor.x != 0 || monitor.y != 0) {
return false;
}
}

return true;
}
}
49 changes: 49 additions & 0 deletions src/Objects/MonitorLayoutProfile.vala
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/*
* SPDX-License-Identifier: GPL-2.0-or-later
* SPDX-FileCopyrightText: 2025 elementary, Inc. <https://elementary.io>
*
* Authored by: Leonardo Lemos <leonardolemos@live.com>
*/

public class Display.MonitorLayoutProfile : GLib.Object {
public class MonitorPosition : GLib.Object {
public string id { get; set; }
public int x { get; set; }
public int y { get; set; }
public DisplayTransform transform { get; set; }

public MonitorPosition (string id, int x, int y, DisplayTransform transform) {
Object (id: id, x: x, y: y, transform: transform);
}
}

public string id { get; set; }
private List<MonitorPosition> _positions;

public unowned List<MonitorPosition> positions {
get {
return _positions;
}
}

public MonitorLayoutProfile (string id) {
Object (id: id);
}

construct {
_positions = new List<MonitorPosition> ();
}

public void add_position (string id, int x, int y, DisplayTransform transform) {
_positions.append (new MonitorPosition (id, x, y, transform));
}

public MonitorPosition? find_position_by_id (string id) {
foreach (var position in _positions) {
if (position.id == id) {
return position;
}
}
return null;
}
}
32 changes: 22 additions & 10 deletions src/Objects/MonitorManager.vala
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,11 @@ public class Display.MonitorManager : GLib.Object {
}
}

public signal void monitors_changed ();

private MutterDisplayConfigInterface iface;
private uint current_serial;
private MonitorLayoutManager layout_manager;

private static MonitorManager monitor_manager;
public static unowned MonitorManager get_default () {
Expand All @@ -65,9 +68,16 @@ public class Display.MonitorManager : GLib.Object {
construct {
monitors = new Gee.LinkedList<Display.Monitor> ();
virtual_monitors = new Gee.LinkedList<Display.VirtualMonitor> ();
layout_manager = new MonitorLayoutManager ();
try {
iface = Bus.get_proxy_sync (BusType.SESSION, "org.gnome.Mutter.DisplayConfig", "/org/gnome/Mutter/DisplayConfig");
iface.monitors_changed.connect (get_monitor_config);
iface = Bus.get_proxy_sync (
BusType.SESSION,
"org.gnome.Mutter.DisplayConfig",
"/org/gnome/Mutter/DisplayConfig");
iface.monitors_changed.connect (() => {
get_monitor_config ();
monitors_changed ();
});
} catch (Error e) {
critical (e.message);
}
Expand All @@ -78,7 +88,10 @@ public class Display.MonitorManager : GLib.Object {
MutterReadLogicalMonitor[] mutter_logical_monitors;
GLib.HashTable<string, GLib.Variant> properties;
try {
iface.get_current_state (out current_serial, out mutter_monitors, out mutter_logical_monitors, out properties);
iface.get_current_state (out current_serial,
out mutter_monitors,
out mutter_logical_monitors,
out properties);
} catch (Error e) {
critical (e.message);
}
Expand Down Expand Up @@ -217,7 +230,7 @@ public class Display.MonitorManager : GLib.Object {
virtual_monitor.scale = mutter_logical_monitor.scale;
virtual_monitor.transform = mutter_logical_monitor.transform;
virtual_monitor.primary = mutter_logical_monitor.primary;
add_virtual_monitor (virtual_monitor);
virtual_monitors.add (virtual_monitor);
}

// Look for any monitors that aren't part of a virtual monitor (hence disabled)
Expand All @@ -237,9 +250,11 @@ public class Display.MonitorManager : GLib.Object {
virtual_monitor.primary = false;
virtual_monitor.monitors.add (monitor);
virtual_monitor.scale = virtual_monitors[0].scale;
add_virtual_monitor (virtual_monitor);
virtual_monitors.add (virtual_monitor);
}
}

layout_manager.arrange_monitors (virtual_monitors);

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

disable_clone_mode is already re-arranging the monitors, so we only need to save it here.

Suggested change
layout_manager.arrange_monitors (virtual_monitors);
if (!is_mirrored) {
layout_manager.save_layouts (virtual_monitors);
}

}

public void set_monitor_config () throws Error {
Expand Down Expand Up @@ -402,13 +417,10 @@ public class Display.MonitorManager : GLib.Object {
virtual_monitors.clear ();
virtual_monitors.add_all (new_virtual_monitors);

notify_property ("virtual-monitor-number");
notify_property ("is-mirrored");
}
layout_manager.arrange_monitors (virtual_monitors);

private void add_virtual_monitor (Display.VirtualMonitor virtual_monitor) {
virtual_monitors.add (virtual_monitor);
notify_property ("virtual-monitor-number");
notify_property ("is-mirrored");
}

private VirtualMonitor? get_virtual_monitor_by_id (string id) {
Expand Down
7 changes: 2 additions & 5 deletions src/Widgets/DisplaysOverlay.vala
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ public class Display.DisplaysOverlay : Gtk.Box {
add_controller (drag_gesture);

monitor_manager = Display.MonitorManager.get_default ();
monitor_manager.notify["virtual-monitor-number"].connect (() => rescan_displays ());
monitor_manager.monitors_changed.connect (() => rescan_displays ());
rescan_displays ();

overlay.get_child_position.connect (get_child_position);
Expand Down Expand Up @@ -199,6 +199,7 @@ public class Display.DisplaysOverlay : Gtk.Box {
add_output (virtual_monitor);
}

show_windows ();
change_active_displays_sensitivity ();
calculate_ratio ();
scanning = false;
Expand Down Expand Up @@ -351,10 +352,6 @@ public class Display.DisplaysOverlay : Gtk.Box {
check_configuration_change ();
calculate_ratio ();
});

if (!monitor_manager.is_mirrored && virtual_monitor.is_active) {
show_windows ();
}
}

private void set_as_primary (Display.VirtualMonitor new_primary) {
Expand Down
2 changes: 2 additions & 0 deletions src/meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ plug_files = files(
'Objects/MonitorMode.vala',
'Objects/MonitorManager.vala',
'Objects/Monitor.vala',
'Objects/MonitorLayoutManager.vala',
'Objects/MonitorLayoutProfile.vala',
'Views/NightLightView.vala',
'Views/DisplaysView.vala',
'Views' / 'FiltersView.vala',
Expand Down