Merge lp:~elementary-apps/granite/about-dialog-commandline into lp:~elementary-pantheon/granite/granite

[Julián Unrrein]

[Granite.Application] Add "--about" command line parameter that shows the About dialog of the application.

[Granite.Application] Add "--about" command line parameter that shows the About dialog of the application.

This capacity will be needed to trigger showing the About dialog from the launcher menu of an application (see https://lists.launchpad.net/elementary-dev-community/msg02777.html).

That menu entry would be added in the .desktop file of each application that wants to have this feature. This would be the only app-specific change.

This works when the app isn't running, and only spawns the About dialog.

Showing the About dialog with this method happens early in the startup stage of the application, so Gtk needs to be explicitly initialized.

Here is an example .desktop file for Scratch: http://pastebin.com/jwaZZ09F

[Julián Unrrein (junrrein)]

I noticed that using this creates another instance of the application (instead of using a running one if it exists) using around 10 MB just for the about window.

It would be nice to avoid this if there is a running instance.

[lp:~elementary-apps/granite/about-dialog-commandline]

634. By Julián Unrrein on 2013-09-16

Use the unique instance.

635. By Julián Unrrein on 2013-09-16

Properly exit when doing this series of steps:
1) The app is invoked with the --about parameter.
2) The app was normally launched.
3) The About dialog was closed.
4) All windows of the app are closed.

636. By Julián Unrrein on 2013-09-16

Reuse the same dialog when the --about parameter is used many times.

637. By Julián Unrrein on 2013-09-16

Handle the register() exception.

638. By Julián Unrrein on 2013-09-16

Destroy the About dialog if all application windows are destroyed.

639. By Julián Unrrein on 2013-09-16

Code style improvements.

640. By Julián Unrrein on 2013-09-16

De-duplicate code. Comment a little more.

641. By Julián Unrrein on 2013-09-16

Comments.

[Julián Unrrein (junrrein)]

Now using this doesn't create an additional instance if the app is already running.

This is achieved using a SimpleAction. Actions are messages sent through Dbus, and they are always received by the primary application instance.

It gets ugly when the About dialog is opened, and the actual application is opened after. As the dialog is opened very early, it is needed to manually set the exit conditions for the app to work normally.

I also made it so that the dialog is closed if all windows of the app are also closed.

[lp:~elementary-apps/granite/about-dialog-commandline]

642. By Julián Unrrein on 2013-09-16

Improve a comment.

[David Gomes (davidgomes)]

Closing the dialog doesn't close the process, it seems. I tried it for the demo.

review: Needs Fixing

[Julián Unrrein (junrrein)]

This is due to issues in granite-demo. Hopefully https://code.launchpad.net/~elementary-apps/granite/demo-multiple-windows/+merge/185947 solves this.

[Julián Unrrein (junrrein)]

This still gets to be tested against an app that doesn't use an unique instance.

[David Gomes (davidgomes)]

But with the Demo's fixes shouldn't this work on it now?

[Julián Unrrein (junrrein)]

I tested this with an app that doesn't force an unique instance and it seems to not cause any trouble.

I now feel ok about this being merged. It still feels very hacky to me though.

[lp:~elementary-apps/granite/about-dialog-commandline]

643. By Julián Unrrein on 2013-12-02

Merge changes from trunk

[David Gomes (davidgomes)]

review: Approve

=== modified file 'lib/Application.vala'
--- lib/Application.vala	2013-08-19 09:23:04 +0000
+++ lib/Application.vala	2013-12-02 19:05:53 +0000
@@ -81,6 +81,8 @@
 
             Intl.bindtextdomain (exec_name, build_data_dir + "/locale");
 
+            add_actions ();
+
             // Deprecated
             Granite.app = this;
         }
@@ -109,13 +111,22 @@
 
             set_options ();
 
+            if (ABOUT) {
+                Gtk.init (ref args);
+                handle_about_parameter ();
+
+                return Posix.EXIT_SUCCESS;
+            }
+
             return base.run (args);
         }
 
         protected static bool DEBUG = false;
+        protected static bool ABOUT = false;
 
         protected const OptionEntry[] options = {
             { "debug", 'd', 0, OptionArg.NONE, out DEBUG, "Enable debug logging", null },
+            { "about", 'a', 0, OptionArg.NONE, out ABOUT, "Show About dialog", null },
             { null }
         };
 
@@ -151,7 +162,7 @@
             assert (parent is Gtk.Window);
 
             var developers_string = _("Developers");
-            
+
             Granite.Widgets.show_about_dialog ((Gtk.Window) parent,
                                                "program_name", program_name,
                                                "version", build_version,
@@ -173,5 +184,63 @@
                                                "translate", translate_url,
                                                "bug", bug_url);
         }
+
+        /* Allows reusing the About dialog */
+        private Gtk.Window about_dialog_parent = null;
+
+        private void add_actions () {
+            /* Actions are always executed in the primary instance, provided
+               that the application was registered.
+               Take advantage of this by showing the About dialog using the 
+               main instance, saving memory. */
+            var show_about_action = new SimpleAction ("show-about-dialog", null);
+
+            show_about_action.activate.connect (() => {
+                hold ();
+
+                debug ("The show-about-dialog action was activated");
+
+                if (this.about_dialog_parent == null)
+                    this.about_dialog_parent = new Gtk.Window ();
+
+                show_about (this.about_dialog_parent);
+
+                release ();
+            });
+
+            add_action (show_about_action);
+        }
+
+        private void handle_about_parameter () {
+            try {
+                register ();
+            } catch (Error error) {
+                warning ("Couldn't register application: %s", error.message);
+            }
+
+            activate_action ("show-about-dialog", null);
+
+            if (!this.is_remote) {
+                /* This means that the primary instance was created by running
+                   "app --about".
+                   Manually set up exit conditions and run the main loop of the
+                   application.
+                   This is needed to prevent weird stuff from happening if the
+                   actual application is opened while this is running. */
+                Gtk.Widget about_dialog = this.about_dialog_parent.get_data ("gtk-about-dialog");
+
+                about_dialog.hide.connect (() => {
+                    if (get_windows () == null)
+                        Gtk.main_quit ();
+                });
+
+                window_removed.connect (() => {
+                    if (get_windows () == null)
+                        Gtk.main_quit ();
+                });
+
+                Gtk.main ();
+            }
+        }
     }
 }

=== modified file 'lib/Widgets/AboutDialog.vala'
--- lib/Widgets/AboutDialog.vala	2013-03-20 15:42:25 +0000
+++ lib/Widgets/AboutDialog.vala	2013-12-02 19:05:53 +0000
@@ -10,7 +10,7 @@
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
     Lesser General Public License for more details.
- 
+
     You should have received a copy of the GNU Lesser General
     Public License along with this library; if not, write to the
     Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,