Merge lp:~roryj/gala/maskcorners-plugin into lp:gala

[Rory]

Implement Mask Corners plugin.

Implement Mask Corners plugin.

By default, corners are masked on all monitors and are disabled when an app goes fullscreen.

[Danielle Foré (danrabbit)]

So this is pretty pimp. Very subtle. Some things I noticed:

* The little nudge feedback when attempting to move past the last workspace is not masked.
* When you zoom back in from multi-tasking view, you can see the workspace preview is not masked.
* Any radius over 4 is broken

Another question though: Does this plugin need to be shipped with Gala? There's currently no mechanism for enabling and disabling plugins in Gala. Maybe it would be better to ship as a separate package and let the package manager be the plugin manager through the "enhances" attribute.

review: Needs Fixing

[Danielle Foré (danrabbit)]

I think a sane upper limit should be set on the radius. Currently you can set ridiculous sizes like 800. I think after 32 you start having some issues with like not being able to click DE elements.

[Rory (roryj)]

I will have a look into the multitasking view issues, but that will require making changes in MultitaskingView, not this plugin (for which I may need Tom Beckmann's help!).

With the latest commit, changing the radius should work.

I have mainly been following what Tom did with his alternate-alt-tab plugin, but the way gala plugins are currently implemented, gala must be built with the plugin so the plugin cannot be packaged separately.

[Danielle Foré (danrabbit)]

Been using this with 6px radius. Very cool. I like it a lot

review: Approve

[Rico Tzschichholz (ricotz)]

Make the codestyle match gala's source.

review: Needs Fixing

[Rory (roryj)]

Have change the codestyle to match gala's source.

I would be interested to know why gala has a different codestyle to other elementary projects and the official codestyle doc.

[Rico Tzschichholz (ricotz)]

Avoid doing the same operation/thing multiple times in a method.

Cache external objects in "unowned local vars" if possible and reuse them. (e.g. wm.get_screen())

Cache local values and reuse them. (e.g. *.to_string())

I would prefer printf syntax to enforce type-safety. (e.g. "bla %i-%s".printf (int, string))

Tranforming "if COND { LOGIC } ... return" into "if !COND return; LOGIC" often avoids to indent.

Keep code itself sorted if possible (CONST, STATIC, CTOR, construct, DTOR, public methods, private methods) (quite often reasonable to do)

Lists in Makefiles are usually sorted alphabetically. (configure.ac and plugins/Makefile.am)

Be consistent with your coding paradigms.

In the end squash your branch into one commit.

review: Needs Fixing

[Rico Tzschichholz (ricotz)]

I am also not a fan of explicitly using "private" just omit it. This make it even more distinguishable from public ones, imo.

[Rico Tzschichholz (ricotz)]

Instead of creating 4 separate actors for every corner. Better create one and use rotated ClutterClones of it.

review: Needs Fixing

[Rico Tzschichholz (ricotz)]

Also there is the one-class-per-file convention.

[Rory (roryj)]

I think I've implemented everything you stated. Thank you very much for the help! :D

[lp:~roryj/gala/maskcorners-plugin]

430. By Rory on 2015-02-05

Implement Mask Corners plugin

[Rico Tzschichholz (ricotz)]

review: Approve

=== modified file 'configure.ac'
--- configure.ac	2015-01-03 19:55:40 +0000
+++ configure.ac	2015-02-05 20:16:27 +0000
@@ -257,6 +257,7 @@
 data/icons/Makefile
 vapi/Makefile
 plugins/Makefile
+plugins/maskcorners/Makefile
 plugins/notify/Makefile
 plugins/zoom/Makefile
 po/Makefile.in

=== modified file 'data/org.pantheon.desktop.gala.gschema.xml.in.in'
--- data/org.pantheon.desktop.gala.gschema.xml.in.in	2015-01-04 09:37:05 +0000
+++ data/org.pantheon.desktop.gala.gschema.xml.in.in	2015-02-05 20:16:27 +0000
@@ -237,4 +237,25 @@
 			<_description>Structure: ['{APP-NAME}:{PRIORITY (show/hide)},{SOUNDS on/off}', ...]</_description>
 		</key>
 	</schema>
+	
+	<schema path="/org/pantheon/desktop/gala/mask-corners/" id="org.pantheon.desktop.gala.mask-corners" gettext-domain="@GETTEXT_PACKAGE@">
+		<key type="b" name="enable">
+			<default>true</default>
+			<_summary>Enable rounded corner mask</_summary>
+		</key>
+		<key type="i" name="corner-radius">
+			<default>4</default>
+			<range min="1" max="32"/>
+			<_summary>Corner radius</_summary>
+		</key>
+		<key type="b" name="disable-on-fullscreen">
+			<default>true</default>
+			<_summary>Disable corner mask on fullscreen</_summary>
+			<description>If enabled, when an application is fullscreen (fills the monitor), the corner masks will be disabled on that monitor.</description>
+		</key>
+		<key type="b" name="only-on-primary">
+			<default>false</default>
+			<_summary>Only show corner masks on primary monitor</_summary>
+		</key>
+	</schema>
 </schemalist>

=== modified file 'plugins/Makefile.am'
--- plugins/Makefile.am	2014-07-18 08:24:26 +0000
+++ plugins/Makefile.am	2015-02-05 20:16:27 +0000
@@ -1,4 +1,5 @@
 SUBDIRS = \
+	maskcorners \
 	notify \
 	zoom \
 	$(NULL)

=== added directory 'plugins/maskcorners'
=== added file 'plugins/maskcorners/Main.vala'
--- plugins/maskcorners/Main.vala	1970-01-01 00:00:00 +0000
+++ plugins/maskcorners/Main.vala	2015-02-05 20:16:27 +0000
@@ -0,0 +1,171 @@
+//
+//  Copyright (C) 2015 Rory J Sanderson
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+using Clutter;
+using Meta;
+
+namespace Gala.Plugins.MaskCorners
+{
+	public class Main : Gala.Plugin
+	{
+		Gala.WindowManager? wm = null;
+		Screen screen;
+		Settings settings;
+
+		List<Actor>[] cornermasks;
+		int corner_radius = 4;
+
+		public override void initialize (Gala.WindowManager wm)
+		{
+			this.wm = wm;
+			screen = wm.get_screen ();
+			settings = Settings.get_default ();
+
+			setup_cornermasks ();
+
+			settings.changed.connect (resetup_cornermasks);
+		}
+
+		public override void destroy ()
+		{
+			destroy_cornermasks ();
+		}
+
+		void setup_cornermasks ()
+		{
+			if (!settings.enable)
+				return;
+
+			int n_monitors = screen.get_n_monitors ();
+			cornermasks = new List<Actor>[n_monitors];
+			corner_radius = settings.corner_radius;
+
+			if (settings.only_on_primary) {
+				add_cornermasks (screen.get_primary_monitor ());
+			} else {
+				for (int m = 0; m < n_monitors; m++)
+					add_cornermasks (m);
+			}
+
+			if (settings.disable_on_fullscreen)
+				screen.in_fullscreen_changed.connect (fullscreen_changed);
+
+			screen.monitors_changed.connect (resetup_cornermasks);
+		}
+
+		void destroy_cornermasks ()
+		{
+			screen.monitors_changed.disconnect (resetup_cornermasks);
+			screen.in_fullscreen_changed.disconnect (fullscreen_changed);
+
+			foreach (unowned List<Actor> list in cornermasks) {
+				foreach (Actor actor in list)
+					actor.destroy ();
+			}
+		}
+
+		void resetup_cornermasks ()
+		{
+			destroy_cornermasks ();
+			setup_cornermasks ();
+		}
+
+		void fullscreen_changed ()
+		{
+			for (int i = 0; i < screen.get_n_monitors (); i++) {
+				foreach (Actor actor in cornermasks[i]) {
+					if (screen.get_monitor_in_fullscreen (i))
+						actor.hide ();
+					else
+						actor.show ();
+				}
+	 		}
+		}
+
+		void add_cornermasks (int monitor_no)
+		{
+			var monitor_geometry = screen.get_monitor_geometry (monitor_no);
+
+			Canvas canvas = new Canvas ();
+			canvas.set_size (corner_radius, corner_radius);
+			canvas.draw.connect (draw_cornermask);
+			canvas.invalidate ();
+
+			Actor actor = new Actor ();
+			actor.set_content (canvas);
+			actor.set_size (corner_radius, corner_radius);
+			actor.set_position (monitor_geometry.x, monitor_geometry.y);
+			actor.set_pivot_point ((float) 0.5, (float) 0.5);
+
+			cornermasks[monitor_no].append (actor);
+			wm.stage.add_child (actor);
+
+			for (int p = 1; p < 4; p++) {
+				Clone clone = new Clone (actor);
+				clone.rotation_angle_z = p * 90;
+
+				switch (p) {
+					case 1:
+						clone.set_position (monitor_geometry.x + monitor_geometry.width, monitor_geometry.y);
+						break;
+					case 2:
+						clone.set_position (monitor_geometry.x + monitor_geometry.width, monitor_geometry.y + monitor_geometry.height);
+						break;
+					case 3:
+						clone.set_position (monitor_geometry.x, monitor_geometry.y + monitor_geometry.height);
+						break;
+				}
+
+				cornermasks[monitor_no].append (clone);
+				wm.stage.add_child (clone);
+			}
+		}
+
+		bool draw_cornermask (Cairo.Context context)
+		{
+			var buffer = new Granite.Drawing.BufferSurface (corner_radius, corner_radius);
+			var buffer_context = buffer.context;
+
+			buffer_context.arc (corner_radius, corner_radius, corner_radius, Math.PI, 1.5 * Math.PI);
+			buffer_context.line_to (0, 0);
+			buffer_context.line_to (0, corner_radius);
+			buffer_context.set_source_rgb (0, 0, 0);
+			buffer_context.fill ();
+
+			context.set_operator (Cairo.Operator.CLEAR);
+			context.paint ();
+			context.set_operator (Cairo.Operator.OVER);
+			context.set_source_surface (buffer.surface, 0, 0);
+			context.paint ();
+
+			return true;
+		}
+	}
+}
+
+public Gala.PluginInfo register_plugin ()
+{
+	return
+	{
+		"Mask Corners",
+		"Gala Developers",
+		typeof (Gala.Plugins.MaskCorners.Main),
+		Gala.PluginFunction.ADDITION,
+		Gala.LoadPriority.IMMEDIATE
+	};
+}
+

=== added file 'plugins/maskcorners/Makefile.am'
--- plugins/maskcorners/Makefile.am	1970-01-01 00:00:00 +0000
+++ plugins/maskcorners/Makefile.am	2015-02-05 20:16:27 +0000
@@ -0,0 +1,59 @@
+include $(top_srcdir)/Makefile.common
+
+VAPIDIR = $(top_srcdir)/vapi
+
+BUILT_SOURCES = libgala_maskcorners_la_vala.stamp
+
+libgala_maskcorners_la_LTLIBRARIES = libgala-maskcorners.la
+
+libgala_maskcorners_ladir = $(pkglibdir)/plugins
+
+libgala_maskcorners_la_LDFLAGS = \
+	$(PLUGIN_LDFLAGS) \
+	$(GALA_CORE_LDFLAGS) \
+	$(top_builddir)/lib/libgala.la \
+	$(NULL)
+
+libgala_maskcorners_la_CFLAGS = \
+	$(GALA_CORE_CFLAGS) \
+	-include config.h \
+	-w \
+	-I$(top_builddir)/lib \
+	$(NULL)
+
+libgala_maskcorners_la_VALAFLAGS = \
+	$(GALA_CORE_VALAFLAGS) \
+	$(top_builddir)/lib/gala.vapi \
+	--vapidir $(VAPIDIR) \
+	$(VAPIDIR)/config.vapi \
+	$(NULL)
+
+libgala_maskcorners_la_LIBADD = \
+	$(GALA_CORE_LIBS) \
+	$(NULL)
+
+libgala_maskcorners_la_VALASOURCES = \
+	Main.vala \
+	Settings.vala \
+	$(NULL)
+
+nodist_libgala_maskcorners_la_SOURCES = \
+	$(BUILT_SOURCES) \
+	$(libgala_maskcorners_la_VALASOURCES:.vala=.c) \
+	$(NULL)
+
+libgala_maskcorners_la_vala.stamp: $(libgala_maskcorners_la_VALASOURCES)
+	$(AM_V_VALA)$(VALAC) \
+		$(libgala_maskcorners_la_VALAFLAGS) \
+		-C \
+		$(filter %.vala %.c,$^)
+	$(AM_V_at)touch $@
+
+CLEANFILES = \
+	$(nodist_libgala_maskcorners_la_SOURCES) \
+	$(NULL)
+
+EXTRA_DIST = \
+	$(libgala_maskcorners_la_VALASOURCES) \
+	$(NULL)
+

=== added file 'plugins/maskcorners/Settings.vala'
--- plugins/maskcorners/Settings.vala	1970-01-01 00:00:00 +0000
+++ plugins/maskcorners/Settings.vala	2015-02-05 20:16:27 +0000
@@ -0,0 +1,25 @@
+namespace Gala.Plugins.MaskCorners
+{
+	class Settings : Granite.Services.Settings
+	{
+		static Settings? instance = null;
+
+		public static Settings get_default ()
+		{
+			if (instance == null)
+				instance = new Settings ();
+
+			return instance;
+		}
+
+		public bool enable { get; set; default = true; }
+		public int corner_radius { get; set; default = 4; }
+		public bool disable_on_fullscreen { get; set; default = true; }
+		public bool only_on_primary { get; set; default = false; }
+
+		Settings ()
+		{
+			base (Config.SCHEMA + ".mask-corners");
+		}
+	}
+}