source: appstream-generator/build/girepo/gio/Application.d

/*
 * Licensed under the GNU Lesser General Public License Version 3
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the license, or
 * (at your option) any later version.
 *
 * This software 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 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, see <http://www.gnu.org/licenses/>.
 */

// generated automatically - do not change


module gio.Application;

private import gi.gio;
public  import gi.giotypes;
private import gio.ActionGroupIF;
private import gio.ActionGroupT;
private import gio.ActionMapIF;
private import gio.ActionMapT;
private import gio.ApplicationCommandLine;
private import gio.Cancellable;
private import gio.DBusConnection;
private import gio.File;
private import gio.FileIF;
private import gio.Notification;
private import glib.ConstructionException;
private import glib.ErrorG;
private import glib.GException;
private import glib.OptionGroup;
private import glib.Str;
private import glib.VariantDict;
private import gobject.ObjectG;
private import gobject.Signals;
private import std.algorithm;


/**
 * A #GApplication is the foundation of an application.  It wraps some
 * low-level platform-specific services and is intended to act as the
 * foundation for higher-level application classes such as
 * #GtkApplication or #MxApplication.  In general, you should not use
 * this class outside of a higher level framework.
 * 
 * GApplication provides convenient life cycle management by maintaining
 * a "use count" for the primary application instance. The use count can
 * be changed using g_application_hold() and g_application_release(). If
 * it drops to zero, the application exits. Higher-level classes such as
 * #GtkApplication employ the use count to ensure that the application
 * stays alive as long as it has any opened windows.
 * 
 * Another feature that GApplication (optionally) provides is process
 * uniqueness. Applications can make use of this functionality by
 * providing a unique application ID. If given, only one application
 * with this ID can be running at a time per session. The session
 * concept is platform-dependent, but corresponds roughly to a graphical
 * desktop login. When your application is launched again, its
 * arguments are passed through platform communication to the already
 * running program. The already running instance of the program is
 * called the "primary instance"; for non-unique applications this is
 * the always the current instance. On Linux, the D-Bus session bus
 * is used for communication.
 * 
 * The use of #GApplication differs from some other commonly-used
 * uniqueness libraries (such as libunique) in important ways. The
 * application is not expected to manually register itself and check
 * if it is the primary instance. Instead, the main() function of a
 * #GApplication should do very little more than instantiating the
 * application instance, possibly connecting signal handlers, then
 * calling g_application_run(). All checks for uniqueness are done
 * internally. If the application is the primary instance then the
 * startup signal is emitted and the mainloop runs. If the application
 * is not the primary instance then a signal is sent to the primary
 * instance and g_application_run() promptly returns. See the code
 * examples below.
 * 
 * If used, the expected form of an application identifier is very close
 * to that of of a
 * [DBus bus name](http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-interface).
 * Examples include: "com.example.MyApp", "org.example.internal-apps.Calculator".
 * For details on valid application identifiers, see g_application_id_is_valid().
 * 
 * On Linux, the application identifier is claimed as a well-known bus name
 * on the user's session bus.  This means that the uniqueness of your
 * application is scoped to the current session.  It also means that your
 * application may provide additional services (through registration of other
 * object paths) at that bus name.  The registration of these object paths
 * should be done with the shared GDBus session bus.  Note that due to the
 * internal architecture of GDBus, method calls can be dispatched at any time
 * (even if a main loop is not running).  For this reason, you must ensure that
 * any object paths that you wish to register are registered before #GApplication
 * attempts to acquire the bus name of your application (which happens in
 * g_application_register()).  Unfortunately, this means that you cannot use
 * g_application_get_is_remote() to decide if you want to register object paths.
 * 
 * GApplication also implements the #GActionGroup and #GActionMap
 * interfaces and lets you easily export actions by adding them with
 * g_action_map_add_action(). When invoking an action by calling
 * g_action_group_activate_action() on the application, it is always
 * invoked in the primary instance. The actions are also exported on
 * the session bus, and GIO provides the #GDBusActionGroup wrapper to
 * conveniently access them remotely. GIO provides a #GDBusMenuModel wrapper
 * for remote access to exported #GMenuModels.
 * 
 * There is a number of different entry points into a GApplication:
 * 
 * - via 'Activate' (i.e. just starting the application)
 * 
 * - via 'Open' (i.e. opening some files)
 * 
 * - by handling a command-line
 * 
 * - via activating an action
 * 
 * The #GApplication::startup signal lets you handle the application
 * initialization for all of these in a single place.
 * 
 * Regardless of which of these entry points is used to start the
 * application, GApplication passes some "platform data from the
 * launching instance to the primary instance, in the form of a
 * #GVariant dictionary mapping strings to variants. To use platform
 * data, override the @before_emit or @after_emit virtual functions
 * in your #GApplication subclass. When dealing with
 * #GApplicationCommandLine objects, the platform data is
 * directly available via g_application_command_line_get_cwd(),
 * g_application_command_line_get_environ() and
 * g_application_command_line_get_platform_data().
 * 
 * As the name indicates, the platform data may vary depending on the
 * operating system, but it always includes the current directory (key
 * "cwd"), and optionally the environment (ie the set of environment
 * variables and their values) of the calling process (key "environ").
 * The environment is only added to the platform data if the
 * %G_APPLICATION_SEND_ENVIRONMENT flag is set. #GApplication subclasses
 * can add their own platform data by overriding the @add_platform_data
 * virtual function. For instance, #GtkApplication adds startup notification
 * data in this way.
 * 
 * To parse commandline arguments you may handle the
 * #GApplication::command-line signal or override the local_command_line()
 * vfunc, to parse them in either the primary instance or the local instance,
 * respectively.
 * 
 * For an example of opening files with a GApplication, see
 * [gapplication-example-open.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-open.c).
 * 
 * For an example of using actions with GApplication, see
 * [gapplication-example-actions.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-actions.c).
 * 
 * For an example of using extra D-Bus hooks with GApplication, see
 * [gapplication-example-dbushooks.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-dbushooks.c).
 *
 * Since: 2.28
 */
public class Application : ObjectG, ActionGroupIF, ActionMapIF
{
        /** the main Gtk struct */
        protected GApplication* gApplication;

        /** Get the main Gtk struct */
        public GApplication* getApplicationStruct()
        {
                return gApplication;
        }

        /** the main Gtk struct as a void* */
        protected override void* getStruct()
        {
                return cast(void*)gApplication;
        }

        protected override void setStruct(GObject* obj)
        {
                gApplication = cast(GApplication*)obj;
                super.setStruct(obj);
        }

        /**
         * Sets our main struct and passes it to the parent class.
         */
        public this (GApplication* gApplication, bool ownedRef = false)
        {
                this.gApplication = gApplication;
                super(cast(GObject*)gApplication, ownedRef);
        }

        // add the ActionGroup capabilities
        mixin ActionGroupT!(GApplication);

        // add the ActionMap capabilities
        mixin ActionMapT!(GApplication);

        protected class ScopedOnCommandLineDelegateWrapper
        {
                static ScopedOnCommandLineDelegateWrapper[] listeners;
                int delegate(Scoped!ApplicationCommandLine, Application) dlg;
                gulong handlerId;
                
                this(int delegate(Scoped!ApplicationCommandLine, Application) dlg)
                {
                        this.dlg = dlg;
                        this.listeners ~= this;
                }
                
                void remove(ScopedOnCommandLineDelegateWrapper source)
                {
                        foreach(index, wrapper; listeners)
                        {
                                if (wrapper.handlerId == source.handlerId)
                                {
                                        listeners[index] = null;
                                        listeners = std.algorithm.remove(listeners, index);
                                        break;
                                }
                        }
                }
        }
        
        /**
         * The ::command-line signal is emitted on the primary instance when
         * a commandline is not handled locally. See g_application_run() and
         * the #GApplicationCommandLine documentation for more information.
         *
         * Params:
         *     commandLine = a #GApplicationCommandLine representing the
         *         passed commandline
         *
         * Return: An integer that is set as the exit status for the calling
         *     process. See g_application_command_line_set_exit_status().
         */
        gulong addOnCommandLine(int delegate(Scoped!ApplicationCommandLine, Application) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
        {
                auto wrapper = new ScopedOnCommandLineDelegateWrapper(dlg);
                wrapper.handlerId = Signals.connectData(
                        this,
                        "command-line",
                        cast(GCallback)&callBackScopedCommandLine,
                        cast(void*)wrapper,
                        cast(GClosureNotify)&callBackScopedCommandLineDestroy,
                        connectFlags);
                return wrapper.handlerId;
        }
        
        extern(C) static int callBackScopedCommandLine(GApplication* applicationStruct, GApplicationCommandLine* commandLine, ScopedOnCommandLineDelegateWrapper wrapper)
        {
                return wrapper.dlg(scoped!ApplicationCommandLine(commandLine), wrapper.outer);
        }
        
        extern(C) static void callBackScopedCommandLineDestroy(ScopedOnCommandLineDelegateWrapper wrapper, GClosure* closure)
        {
                wrapper.remove(wrapper);
        }

        /**
         */

        /** */
        public static GType getType()
        {
                return g_application_get_type();
        }

        /**
         * Creates a new #GApplication instance.
         *
         * If non-%NULL, the application id must be valid.  See
         * g_application_id_is_valid().
         *
         * If no application ID is given then some features of #GApplication
         * (most notably application uniqueness) will be disabled.
         *
         * Params:
         *     applicationId = the application id
         *     flags = the application flags
         *
         * Returns: a new #GApplication instance
         *
         * Throws: ConstructionException GTK+ fails to create the object.
         */
        public this(string applicationId, GApplicationFlags flags)
        {
                auto p = g_application_new(Str.toStringz(applicationId), flags);
                
                if(p is null)
                {
                        throw new ConstructionException("null returned by new");
                }
                
                this(cast(GApplication*) p, true);
        }

        /**
         * Returns the default #GApplication instance for this process.
         *
         * Normally there is only one #GApplication per process and it becomes
         * the default when it is created.  You can exercise more control over
         * this by using g_application_set_default().
         *
         * If there is no default application then %NULL is returned.
         *
         * Returns: the default application for this process, or %NULL
         *
         * Since: 2.32
         */
        public static Application getDefault()
        {
                auto p = g_application_get_default();
                
                if(p is null)
                {
                        return null;
                }
                
                return ObjectG.getDObject!(Application)(cast(GApplication*) p);
        }

        /**
         * Checks if @application_id is a valid application identifier.
         *
         * A valid ID is required for calls to g_application_new() and
         * g_application_set_application_id().
         *
         * For convenience, the restrictions on application identifiers are
         * reproduced here:
         *
         * - Application identifiers must contain only the ASCII characters
         * "[A-Z][a-z][0-9]_-." and must not begin with a digit.
         *
         * - Application identifiers must contain at least one '.' (period)
         * character (and thus at least three elements).
         *
         * - Application identifiers must not begin or end with a '.' (period)
         * character.
         *
         * - Application identifiers must not contain consecutive '.' (period)
         * characters.
         *
         * - Application identifiers must not exceed 255 characters.
         *
         * Params:
         *     applicationId = a potential application identifier
         *
         * Returns: %TRUE if @application_id is valid
         */
        public static bool idIsValid(string applicationId)
        {
                return g_application_id_is_valid(Str.toStringz(applicationId)) != 0;
        }

        /**
         * Activates the application.
         *
         * In essence, this results in the #GApplication::activate signal being
         * emitted in the primary instance.
         *
         * The application must be registered before calling this function.
         *
         * Since: 2.28
         */
        public void activate()
        {
                g_application_activate(gApplication);
        }

        /**
         * Add an option to be handled by @application.
         *
         * Calling this function is the equivalent of calling
         * g_application_add_main_option_entries() with a single #GOptionEntry
         * that has its arg_data member set to %NULL.
         *
         * The parsed arguments will be packed into a #GVariantDict which
         * is passed to #GApplication::handle-local-options. If
         * %G_APPLICATION_HANDLES_COMMAND_LINE is set, then it will also
         * be sent to the primary instance. See
         * g_application_add_main_option_entries() for more details.
         *
         * See #GOptionEntry for more documentation of the arguments.
         *
         * Params:
         *     longName = the long name of an option used to specify it in a commandline
         *     shortName = the short name of an option
         *     flags = flags from #GOptionFlags
         *     arg = the type of the option, as a #GOptionArg
         *     description = the description for the option in `--help` output
         *     argDescription = the placeholder to use for the extra argument
         *         parsed by the option in `--help` output
         *
         * Since: 2.42
         */
        public void addMainOption(string longName, char shortName, GOptionFlags flags, GOptionArg arg, string description, string argDescription)
        {
                g_application_add_main_option(gApplication, Str.toStringz(longName), shortName, flags, arg, Str.toStringz(description), Str.toStringz(argDescription));
        }

        /**
         * Adds main option entries to be handled by @application.
         *
         * This function is comparable to g_option_context_add_main_entries().
         *
         * After the commandline arguments are parsed, the
         * #GApplication::handle-local-options signal will be emitted.  At this
         * point, the application can inspect the values pointed to by @arg_data
         * in the given #GOptionEntrys.
         *
         * Unlike #GOptionContext, #GApplication supports giving a %NULL
         * @arg_data for a non-callback #GOptionEntry.  This results in the
         * argument in question being packed into a #GVariantDict which is also
         * passed to #GApplication::handle-local-options, where it can be
         * inspected and modified.  If %G_APPLICATION_HANDLES_COMMAND_LINE is
         * set, then the resulting dictionary is sent to the primary instance,
         * where g_application_command_line_get_options_dict() will return it.
         * This "packing" is done according to the type of the argument --
         * booleans for normal flags, strings for strings, bytestrings for
         * filenames, etc.  The packing only occurs if the flag is given (ie: we
         * do not pack a "false" #GVariant in the case that a flag is missing).
         *
         * In general, it is recommended that all commandline arguments are
         * parsed locally.  The options dictionary should then be used to
         * transmit the result of the parsing to the primary instance, where
         * g_variant_dict_lookup() can be used.  For local options, it is
         * possible to either use @arg_data in the usual way, or to consult (and
         * potentially remove) the option from the options dictionary.
         *
         * This function is new in GLib 2.40.  Before then, the only real choice
         * was to send all of the commandline arguments (options and all) to the
         * primary instance for handling.  #GApplication ignored them completely
         * on the local side.  Calling this function "opts in" to the new
         * behaviour, and in particular, means that unrecognised options will be
         * treated as errors.  Unrecognised options have never been ignored when
         * %G_APPLICATION_HANDLES_COMMAND_LINE is unset.
         *
         * If #GApplication::handle-local-options needs to see the list of
         * filenames, then the use of %G_OPTION_REMAINING is recommended.  If
         * @arg_data is %NULL then %G_OPTION_REMAINING can be used as a key into
         * the options dictionary.  If you do use %G_OPTION_REMAINING then you
         * need to handle these arguments for yourself because once they are
         * consumed, they will no longer be visible to the default handling
         * (which treats them as filenames to be opened).
         *
         * Params:
         *     entries = a
         *         %NULL-terminated list of #GOptionEntrys
         *
         * Since: 2.40
         */
        public void addMainOptionEntries(GOptionEntry[] entries)
        {
                g_application_add_main_option_entries(gApplication, entries.ptr);
        }

        /**
         * Adds a #GOptionGroup to the commandline handling of @application.
         *
         * This function is comparable to g_option_context_add_group().
         *
         * Unlike g_application_add_main_option_entries(), this function does
         * not deal with %NULL @arg_data and never transmits options to the
         * primary instance.
         *
         * The reason for that is because, by the time the options arrive at the
         * primary instance, it is typically too late to do anything with them.
         * Taking the GTK option group as an example: GTK will already have been
         * initialised by the time the #GApplication::command-line handler runs.
         * In the case that this is not the first-running instance of the
         * application, the existing instance may already have been running for
         * a very long time.
         *
         * This means that the options from #GOptionGroup are only really usable
         * in the case that the instance of the application being run is the
         * first instance.  Passing options like `--display=` or `--gdk-debug=`
         * on future runs will have no effect on the existing primary instance.
         *
         * Calling this function will cause the options in the supplied option
         * group to be parsed, but it does not cause you to be "opted in" to the
         * new functionality whereby unrecognised options are rejected even if
         * %G_APPLICATION_HANDLES_COMMAND_LINE was given.
         *
         * Params:
         *     group = a #GOptionGroup
         *
         * Since: 2.40
         */
        public void addOptionGroup(OptionGroup group)
        {
                g_application_add_option_group(gApplication, (group is null) ? null : group.getOptionGroupStruct());
        }

        /**
         * Marks @application as busy (see g_application_mark_busy()) while
         * @property on @object is %TRUE.
         *
         * The binding holds a reference to @application while it is active, but
         * not to @object. Instead, the binding is destroyed when @object is
         * finalized.
         *
         * Params:
         *     object = a #GObject
         *     property = the name of a boolean property of @object
         *
         * Since: 2.44
         */
        public void bindBusyProperty(ObjectG object, string property)
        {
                g_application_bind_busy_property(gApplication, (object is null) ? null : object.getObjectGStruct(), Str.toStringz(property));
        }

        /**
         * Gets the unique identifier for @application.
         *
         * Returns: the identifier for @application, owned by @application
         *
         * Since: 2.28
         */
        public string getApplicationId()
        {
                return Str.toString(g_application_get_application_id(gApplication));
        }

        /**
         * Gets the #GDBusConnection being used by the application, or %NULL.
         *
         * If #GApplication is using its D-Bus backend then this function will
         * return the #GDBusConnection being used for uniqueness and
         * communication with the desktop environment and other instances of the
         * application.
         *
         * If #GApplication is not using D-Bus then this function will return
         * %NULL.  This includes the situation where the D-Bus backend would
         * normally be in use but we were unable to connect to the bus.
         *
         * This function must not be called before the application has been
         * registered.  See g_application_get_is_registered().
         *
         * Returns: a #GDBusConnection, or %NULL
         *
         * Since: 2.34
         */
        public DBusConnection getDbusConnection()
        {
                auto p = g_application_get_dbus_connection(gApplication);
                
                if(p is null)
                {
                        return null;
                }
                
                return ObjectG.getDObject!(DBusConnection)(cast(GDBusConnection*) p);
        }

        /**
         * Gets the D-Bus object path being used by the application, or %NULL.
         *
         * If #GApplication is using its D-Bus backend then this function will
         * return the D-Bus object path that #GApplication is using.  If the
         * application is the primary instance then there is an object published
         * at this path.  If the application is not the primary instance then
         * the result of this function is undefined.
         *
         * If #GApplication is not using D-Bus then this function will return
         * %NULL.  This includes the situation where the D-Bus backend would
         * normally be in use but we were unable to connect to the bus.
         *
         * This function must not be called before the application has been
         * registered.  See g_application_get_is_registered().
         *
         * Returns: the object path, or %NULL
         *
         * Since: 2.34
         */
        public string getDbusObjectPath()
        {
                return Str.toString(g_application_get_dbus_object_path(gApplication));
        }

        /**
         * Gets the flags for @application.
         *
         * See #GApplicationFlags.
         *
         * Returns: the flags for @application
         *
         * Since: 2.28
         */
        public GApplicationFlags getFlags()
        {
                return g_application_get_flags(gApplication);
        }

        /**
         * Gets the current inactivity timeout for the application.
         *
         * This is the amount of time (in milliseconds) after the last call to
         * g_application_release() before the application stops running.
         *
         * Returns: the timeout, in milliseconds
         *
         * Since: 2.28
         */
        public uint getInactivityTimeout()
        {
                return g_application_get_inactivity_timeout(gApplication);
        }

        /**
         * Gets the application's current busy state, as set through
         * g_application_mark_busy() or g_application_bind_busy_property().
         *
         * Returns: %TRUE if @application is currenty marked as busy
         *
         * Since: 2.44
         */
        public bool getIsBusy()
        {
                return g_application_get_is_busy(gApplication) != 0;
        }

        /**
         * Checks if @application is registered.
         *
         * An application is registered if g_application_register() has been
         * successfully called.
         *
         * Returns: %TRUE if @application is registered
         *
         * Since: 2.28
         */
        public bool getIsRegistered()
        {
                return g_application_get_is_registered(gApplication) != 0;
        }

        /**
         * Checks if @application is remote.
         *
         * If @application is remote then it means that another instance of
         * application already exists (the 'primary' instance).  Calls to
         * perform actions on @application will result in the actions being
         * performed by the primary instance.
         *
         * The value of this property cannot be accessed before
         * g_application_register() has been called.  See
         * g_application_get_is_registered().
         *
         * Returns: %TRUE if @application is remote
         *
         * Since: 2.28
         */
        public bool getIsRemote()
        {
                return g_application_get_is_remote(gApplication) != 0;
        }

        /**
         * Gets the resource base path of @application.
         *
         * See g_application_set_resource_base_path() for more information.
         *
         * Returns: the base resource path, if one is set
         *
         * Since: 2.42
         */
        public string getResourceBasePath()
        {
                return Str.toString(g_application_get_resource_base_path(gApplication));
        }

        /**
         * Increases the use count of @application.
         *
         * Use this function to indicate that the application has a reason to
         * continue to run.  For example, g_application_hold() is called by GTK+
         * when a toplevel window is on the screen.
         *
         * To cancel the hold, call g_application_release().
         */
        public void hold()
        {
                g_application_hold(gApplication);
        }

        /**
         * Increases the busy count of @application.
         *
         * Use this function to indicate that the application is busy, for instance
         * while a long running operation is pending.
         *
         * The busy state will be exposed to other processes, so a session shell will
         * use that information to indicate the state to the user (e.g. with a
         * spinner).
         *
         * To cancel the busy indication, use g_application_unmark_busy().
         *
         * Since: 2.38
         */
        public void markBusy()
        {
                g_application_mark_busy(gApplication);
        }

        /**
         * Opens the given files.
         *
         * In essence, this results in the #GApplication::open signal being emitted
         * in the primary instance.
         *
         * @n_files must be greater than zero.
         *
         * @hint is simply passed through to the ::open signal.  It is
         * intended to be used by applications that have multiple modes for
         * opening files (eg: "view" vs "edit", etc).  Unless you have a need
         * for this functionality, you should use "".
         *
         * The application must be registered before calling this function
         * and it must have the %G_APPLICATION_HANDLES_OPEN flag set.
         *
         * Params:
         *     files = an array of #GFiles to open
         *     nFiles = the length of the @files array
         *     hint = a hint (or ""), but never %NULL
         *
         * Since: 2.28
         */
        public void open(FileIF[] files, string hint)
        {
                GFile*[] filesArray = new GFile*[files.length];
                for ( int i = 0; i < files.length; i++ )
                {
                        filesArray[i] = files[i].getFileStruct();
                }
                
                g_application_open(gApplication, filesArray.ptr, cast(int)files.length, Str.toStringz(hint));
        }

        /**
         * Immediately quits the application.
         *
         * Upon return to the mainloop, g_application_run() will return,
         * calling only the 'shutdown' function before doing so.
         *
         * The hold count is ignored.
         *
         * The result of calling g_application_run() again after it returns is
         * unspecified.
         *
         * Since: 2.32
         */
        public void quit()
        {
                g_application_quit(gApplication);
        }

        /**
         * Attempts registration of the application.
         *
         * This is the point at which the application discovers if it is the
         * primary instance or merely acting as a remote for an already-existing
         * primary instance.  This is implemented by attempting to acquire the
         * application identifier as a unique bus name on the session bus using
         * GDBus.
         *
         * If there is no application ID or if %G_APPLICATION_NON_UNIQUE was
         * given, then this process will always become the primary instance.
         *
         * Due to the internal architecture of GDBus, method calls can be
         * dispatched at any time (even if a main loop is not running).  For
         * this reason, you must ensure that any object paths that you wish to
         * register are registered before calling this function.
         *
         * If the application has already been registered then %TRUE is
         * returned with no work performed.
         *
         * The #GApplication::startup signal is emitted if registration succeeds
         * and @application is the primary instance (including the non-unique
         * case).
         *
         * In the event of an error (such as @cancellable being cancelled, or a
         * failure to connect to the session bus), %FALSE is returned and @error
         * is set appropriately.
         *
         * Note: the return value of this function is not an indicator that this
         * instance is or is not the primary instance of the application.  See
         * g_application_get_is_remote() for that.
         *
         * Params:
         *     cancellable = a #GCancellable, or %NULL
         *
         * Returns: %TRUE if registration succeeded
         *
         * Since: 2.28
         *
         * Throws: GException on failure.
         */
        public bool register(Cancellable cancellable)
        {
                GError* err = null;
                
                auto p = g_application_register(gApplication, (cancellable is null) ? null : cancellable.getCancellableStruct(), &err) != 0;
                
                if (err !is null)
                {
                        throw new GException( new ErrorG(err) );
                }
                
                return p;
        }

        /**
         * Decrease the use count of @application.
         *
         * When the use count reaches zero, the application will stop running.
         *
         * Never call this function except to cancel the effect of a previous
         * call to g_application_hold().
         */
        public void release()
        {
                g_application_release(gApplication);
        }

        /**
         * Runs the application.
         *
         * This function is intended to be run from main() and its return value
         * is intended to be returned by main(). Although you are expected to pass
         * the @argc, @argv parameters from main() to this function, it is possible
         * to pass %NULL if @argv is not available or commandline handling is not
         * required.  Note that on Windows, @argc and @argv are ignored, and
         * g_win32_get_command_line() is called internally (for proper support
         * of Unicode commandline arguments).
         *
         * #GApplication will attempt to parse the commandline arguments.  You
         * can add commandline flags to the list of recognised options by way of
         * g_application_add_main_option_entries().  After this, the
         * #GApplication::handle-local-options signal is emitted, from which the
         * application can inspect the values of its #GOptionEntrys.
         *
         * #GApplication::handle-local-options is a good place to handle options
         * such as `--version`, where an immediate reply from the local process is
         * desired (instead of communicating with an already-running instance).
         * A #GApplication::handle-local-options handler can stop further processing
         * by returning a non-negative value, which then becomes the exit status of
         * the process.
         *
         * What happens next depends on the flags: if
         * %G_APPLICATION_HANDLES_COMMAND_LINE was specified then the remaining
         * commandline arguments are sent to the primary instance, where a
         * #GApplication::command-line signal is emitted.  Otherwise, the
         * remaining commandline arguments are assumed to be a list of files.
         * If there are no files listed, the application is activated via the
         * #GApplication::activate signal.  If there are one or more files, and
         * %G_APPLICATION_HANDLES_OPEN was specified then the files are opened
         * via the #GApplication::open signal.
         *
         * If you are interested in doing more complicated local handling of the
         * commandline then you should implement your own #GApplication subclass
         * and override local_command_line(). In this case, you most likely want
         * to return %TRUE from your local_command_line() implementation to
         * suppress the default handling. See
         * [gapplication-example-cmdline2.c][gapplication-example-cmdline2]
         * for an example.
         *
         * If, after the above is done, the use count of the application is zero
         * then the exit status is returned immediately.  If the use count is
         * non-zero then the default main context is iterated until the use count
         * falls to zero, at which point 0 is returned.
         *
         * If the %G_APPLICATION_IS_SERVICE flag is set, then the service will
         * run for as much as 10 seconds with a use count of zero while waiting
         * for the message that caused the activation to arrive.  After that,
         * if the use count falls to zero the application will exit immediately,
         * except in the case that g_application_set_inactivity_timeout() is in
         * use.
         *
         * This function sets the prgname (g_set_prgname()), if not already set,
         * to the basename of argv[0].
         *
         * Since 2.40, applications that are not explicitly flagged as services
         * or launchers (ie: neither %G_APPLICATION_IS_SERVICE or
         * %G_APPLICATION_IS_LAUNCHER are given as flags) will check (from the
         * default handler for local_command_line) if "--gapplication-service"
         * was given in the command line.  If this flag is present then normal
         * commandline processing is interrupted and the
         * %G_APPLICATION_IS_SERVICE flag is set.  This provides a "compromise"
         * solution whereby running an application directly from the commandline
         * will invoke it in the normal way (which can be useful for debugging)
         * while still allowing applications to be D-Bus activated in service
         * mode.  The D-Bus service file should invoke the executable with
         * "--gapplication-service" as the sole commandline argument.  This
         * approach is suitable for use by most graphical applications but
         * should not be used from applications like editors that need precise
         * control over when processes invoked via the commandline will exit and
         * what their exit status will be.
         *
         * Params:
         *     argc = the argc from main() (or 0 if @argv is %NULL)
         *     argv = the argv from main(), or %NULL
         *
         * Returns: the exit status
         *
         * Since: 2.28
         */
        public int run(string[] argv)
        {
                return g_application_run(gApplication, cast(int)argv.length, Str.toStringzArray(argv));
        }

        /**
         * Sends a notification on behalf of @application to the desktop shell.
         * There is no guarantee that the notification is displayed immediately,
         * or even at all.
         *
         * Notifications may persist after the application exits. It will be
         * D-Bus-activated when the notification or one of its actions is
         * activated.
         *
         * Modifying @notification after this call has no effect. However, the
         * object can be reused for a later call to this function.
         *
         * @id may be any string that uniquely identifies the event for the
         * application. It does not need to be in any special format. For
         * example, "new-message" might be appropriate for a notification about
         * new messages.
         *
         * If a previous notification was sent with the same @id, it will be
         * replaced with @notification and shown again as if it was a new
         * notification. This works even for notifications sent from a previous
         * execution of the application, as long as @id is the same string.
         *
         * @id may be %NULL, but it is impossible to replace or withdraw
         * notifications without an id.
         *
         * If @notification is no longer relevant, it can be withdrawn with
         * g_application_withdraw_notification().
         *
         * Params:
         *     id = id of the notification, or %NULL
         *     notification = the #GNotification to send
         *
         * Since: 2.40
         */
        public void sendNotification(string id, Notification notification)
        {
                g_application_send_notification(gApplication, Str.toStringz(id), (notification is null) ? null : notification.getNotificationStruct());
        }

        /**
         * This used to be how actions were associated with a #GApplication.
         * Now there is #GActionMap for that.
         *
         * Deprecated: Use the #GActionMap interface instead.  Never ever
         * mix use of this API with use of #GActionMap on the same @application
         * or things will go very badly wrong.  This function is known to
         * introduce buggy behaviour (ie: signals not emitted on changes to the
         * action group), so you should really use #GActionMap instead.
         *
         * Params:
         *     actionGroup = a #GActionGroup, or %NULL
         *
         * Since: 2.28
         */
        public void setActionGroup(ActionGroupIF actionGroup)
        {
                g_application_set_action_group(gApplication, (actionGroup is null) ? null : actionGroup.getActionGroupStruct());
        }

        /**
         * Sets the unique identifier for @application.
         *
         * The application id can only be modified if @application has not yet
         * been registered.
         *
         * If non-%NULL, the application id must be valid.  See
         * g_application_id_is_valid().
         *
         * Params:
         *     applicationId = the identifier for @application
         *
         * Since: 2.28
         */
        public void setApplicationId(string applicationId)
        {
                g_application_set_application_id(gApplication, Str.toStringz(applicationId));
        }

        /**
         * Sets or unsets the default application for the process, as returned
         * by g_application_get_default().
         *
         * This function does not take its own reference on @application.  If
         * @application is destroyed then the default application will revert
         * back to %NULL.
         *
         * Since: 2.32
         */
        public void setDefault()
        {
                g_application_set_default(gApplication);
        }

        /**
         * Sets the flags for @application.
         *
         * The flags can only be modified if @application has not yet been
         * registered.
         *
         * See #GApplicationFlags.
         *
         * Params:
         *     flags = the flags for @application
         *
         * Since: 2.28
         */
        public void setFlags(GApplicationFlags flags)
        {
                g_application_set_flags(gApplication, flags);
        }

        /**
         * Sets the current inactivity timeout for the application.
         *
         * This is the amount of time (in milliseconds) after the last call to
         * g_application_release() before the application stops running.
         *
         * This call has no side effects of its own.  The value set here is only
         * used for next time g_application_release() drops the use count to
         * zero.  Any timeouts currently in progress are not impacted.
         *
         * Params:
         *     inactivityTimeout = the timeout, in milliseconds
         *
         * Since: 2.28
         */
        public void setInactivityTimeout(uint inactivityTimeout)
        {
                g_application_set_inactivity_timeout(gApplication, inactivityTimeout);
        }

        /**
         * Sets (or unsets) the base resource path of @application.
         *
         * The path is used to automatically load various [application
         * resources][gresource] such as menu layouts and action descriptions.
         * The various types of resources will be found at fixed names relative
         * to the given base path.
         *
         * By default, the resource base path is determined from the application
         * ID by prefixing '/' and replacing each '.' with '/'.  This is done at
         * the time that the #GApplication object is constructed.  Changes to
         * the application ID after that point will not have an impact on the
         * resource base path.
         *
         * As an example, if the application has an ID of "org.example.app" then
         * the default resource base path will be "/org/example/app".  If this
         * is a #GtkApplication (and you have not manually changed the path)
         * then Gtk will then search for the menus of the application at
         * "/org/example/app/gtk/menus.ui".
         *
         * See #GResource for more information about adding resources to your
         * application.
         *
         * You can disable automatic resource loading functionality by setting
         * the path to %NULL.
         *
         * Changing the resource base path once the application is running is
         * not recommended.  The point at which the resource path is consulted
         * for forming paths for various purposes is unspecified.
         *
         * Params:
         *     resourcePath = the resource path to use
         *
         * Since: 2.42
         */
        public void setResourceBasePath(string resourcePath)
        {
                g_application_set_resource_base_path(gApplication, Str.toStringz(resourcePath));
        }

        /**
         * Destroys a binding between @property and the busy state of
         * @application that was previously created with
         * g_application_bind_busy_property().
         *
         * Params:
         *     object = a #GObject
         *     property = the name of a boolean property of @object
         *
         * Since: 2.44
         */
        public void unbindBusyProperty(ObjectG object, string property)
        {
                g_application_unbind_busy_property(gApplication, (object is null) ? null : object.getObjectGStruct(), Str.toStringz(property));
        }

        /**
         * Decreases the busy count of @application.
         *
         * When the busy count reaches zero, the new state will be propagated
         * to other processes.
         *
         * This function must only be called to cancel the effect of a previous
         * call to g_application_mark_busy().
         *
         * Since: 2.38
         */
        public void unmarkBusy()
        {
                g_application_unmark_busy(gApplication);
        }

        /**
         * Withdraws a notification that was sent with
         * g_application_send_notification().
         *
         * This call does nothing if a notification with @id doesn't exist or
         * the notification was never sent.
         *
         * This function works even for notifications sent in previous
         * executions of this application, as long @id is the same as it was for
         * the sent notification.
         *
         * Note that notifications are dismissed when the user clicks on one
         * of the buttons in a notification or triggers its default action, so
         * there is no need to explicitly withdraw the notification in that case.
         *
         * Params:
         *     id = id of a previously sent notification
         *
         * Since: 2.40
         */
        public void withdrawNotification(string id)
        {
                g_application_withdraw_notification(gApplication, Str.toStringz(id));
        }

        protected class OnActivateDelegateWrapper
        {
                static OnActivateDelegateWrapper[] listeners;
                void delegate(Application) dlg;
                gulong handlerId;
                
                this(void delegate(Application) dlg)
                {
                        this.dlg = dlg;
                        this.listeners ~= this;
                }
                
                void remove(OnActivateDelegateWrapper source)
                {
                        foreach(index, wrapper; listeners)
                        {
                                if (wrapper.handlerId == source.handlerId)
                                {
                                        listeners[index] = null;
                                        listeners = std.algorithm.remove(listeners, index);
                                        break;
                                }
                        }
                }
        }

        /**
         * The ::activate signal is emitted on the primary instance when an
         * activation occurs. See g_application_activate().
         */
        gulong addOnActivate(void delegate(Application) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
        {
                auto wrapper = new OnActivateDelegateWrapper(dlg);
                wrapper.handlerId = Signals.connectData(
                        this,
                        "activate",
                        cast(GCallback)&callBackActivate,
                        cast(void*)wrapper,
                        cast(GClosureNotify)&callBackActivateDestroy,
                        connectFlags);
                return wrapper.handlerId;
        }
        
        extern(C) static void callBackActivate(GApplication* applicationStruct, OnActivateDelegateWrapper wrapper)
        {
                wrapper.dlg(wrapper.outer);
        }
        
        extern(C) static void callBackActivateDestroy(OnActivateDelegateWrapper wrapper, GClosure* closure)
        {
                wrapper.remove(wrapper);
        }

        protected class OnCommandLineDelegateWrapper
        {
                static OnCommandLineDelegateWrapper[] listeners;
                int delegate(ApplicationCommandLine, Application) dlg;
                gulong handlerId;
                
                this(int delegate(ApplicationCommandLine, Application) dlg)
                {
                        this.dlg = dlg;
                        this.listeners ~= this;
                }
                
                void remove(OnCommandLineDelegateWrapper source)
                {
                        foreach(index, wrapper; listeners)
                        {
                                if (wrapper.handlerId == source.handlerId)
                                {
                                        listeners[index] = null;
                                        listeners = std.algorithm.remove(listeners, index);
                                        break;
                                }
                        }
                }
        }

        /**
         * The ::command-line signal is emitted on the primary instance when
         * a commandline is not handled locally. See g_application_run() and
         * the #GApplicationCommandLine documentation for more information.
         *
         * Params:
         *     commandLine = a #GApplicationCommandLine representing the
         *         passed commandline
         *
         * Returns: An integer that is set as the exit status for the calling
         *     process. See g_application_command_line_set_exit_status().
         */
        gulong addOnCommandLine(int delegate(ApplicationCommandLine, Application) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
        {
                auto wrapper = new OnCommandLineDelegateWrapper(dlg);
                wrapper.handlerId = Signals.connectData(
                        this,
                        "command-line",
                        cast(GCallback)&callBackCommandLine,
                        cast(void*)wrapper,
                        cast(GClosureNotify)&callBackCommandLineDestroy,
                        connectFlags);
                return wrapper.handlerId;
        }
        
        extern(C) static int callBackCommandLine(GApplication* applicationStruct, GApplicationCommandLine* commandLine, OnCommandLineDelegateWrapper wrapper)
        {
                return wrapper.dlg(ObjectG.getDObject!(ApplicationCommandLine)(commandLine), wrapper.outer);
        }
        
        extern(C) static void callBackCommandLineDestroy(OnCommandLineDelegateWrapper wrapper, GClosure* closure)
        {
                wrapper.remove(wrapper);
        }

        protected class OnHandleLocalOptionsDelegateWrapper
        {
                static OnHandleLocalOptionsDelegateWrapper[] listeners;
                int delegate(VariantDict, Application) dlg;
                gulong handlerId;
                
                this(int delegate(VariantDict, Application) dlg)
                {
                        this.dlg = dlg;
                        this.listeners ~= this;
                }
                
                void remove(OnHandleLocalOptionsDelegateWrapper source)
                {
                        foreach(index, wrapper; listeners)
                        {
                                if (wrapper.handlerId == source.handlerId)
                                {
                                        listeners[index] = null;
                                        listeners = std.algorithm.remove(listeners, index);
                                        break;
                                }
                        }
                }
        }

        /**
         * The ::handle-local-options signal is emitted on the local instance
         * after the parsing of the commandline options has occurred.
         *
         * You can add options to be recognised during commandline option
         * parsing using g_application_add_main_option_entries() and
         * g_application_add_option_group().
         *
         * Signal handlers can inspect @options (along with values pointed to
         * from the @arg_data of an installed #GOptionEntrys) in order to
         * decide to perform certain actions, including direct local handling
         * (which may be useful for options like --version).
         *
         * In the event that the application is marked
         * %G_APPLICATION_HANDLES_COMMAND_LINE the "normal processing" will
         * send the @options dictionary to the primary instance where it can be
         * read with g_application_command_line_get_options_dict().  The signal
         * handler can modify the dictionary before returning, and the
         * modified dictionary will be sent.
         *
         * In the event that %G_APPLICATION_HANDLES_COMMAND_LINE is not set,
         * "normal processing" will treat the remaining uncollected command
         * line arguments as filenames or URIs.  If there are no arguments,
         * the application is activated by g_application_activate().  One or
         * more arguments results in a call to g_application_open().
         *
         * If you want to handle the local commandline arguments for yourself
         * by converting them to calls to g_application_open() or
         * g_action_group_activate_action() then you must be sure to register
         * the application first.  You should probably not call
         * g_application_activate() for yourself, however: just return -1 and
         * allow the default handler to do it for you.  This will ensure that
         * the `--gapplication-service` switch works properly (i.e. no activation
         * in that case).
         *
         * Note that this signal is emitted from the default implementation of
         * local_command_line().  If you override that function and don't
         * chain up then this signal will never be emitted.
         *
         * You can override local_command_line() if you need more powerful
         * capabilities than what is provided here, but this should not
         * normally be required.
         *
         * Params:
         *     options = the options dictionary
         *
         * Returns: an exit code. If you have handled your options and want
         *     to exit the process, return a non-negative option, 0 for success,
         *     and a positive value for failure. To continue, return -1 to let
         *     the default option processing continue.
         *
         * Since: 2.40
         */
        gulong addOnHandleLocalOptions(int delegate(VariantDict, Application) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
        {
                auto wrapper = new OnHandleLocalOptionsDelegateWrapper(dlg);
                wrapper.handlerId = Signals.connectData(
                        this,
                        "handle-local-options",
                        cast(GCallback)&callBackHandleLocalOptions,
                        cast(void*)wrapper,
                        cast(GClosureNotify)&callBackHandleLocalOptionsDestroy,
                        connectFlags);
                return wrapper.handlerId;
        }
        
        extern(C) static int callBackHandleLocalOptions(GApplication* applicationStruct, GVariantDict* options, OnHandleLocalOptionsDelegateWrapper wrapper)
        {
                return wrapper.dlg(new VariantDict(options), wrapper.outer);
        }
        
        extern(C) static void callBackHandleLocalOptionsDestroy(OnHandleLocalOptionsDelegateWrapper wrapper, GClosure* closure)
        {
                wrapper.remove(wrapper);
        }

        protected class OnOpenDelegateWrapper
        {
                static OnOpenDelegateWrapper[] listeners;
                void delegate(void*, int, string, Application) dlg;
                gulong handlerId;
                
                this(void delegate(void*, int, string, Application) dlg)
                {
                        this.dlg = dlg;
                        this.listeners ~= this;
                }
                
                void remove(OnOpenDelegateWrapper source)
                {
                        foreach(index, wrapper; listeners)
                        {
                                if (wrapper.handlerId == source.handlerId)
                                {
                                        listeners[index] = null;
                                        listeners = std.algorithm.remove(listeners, index);
                                        break;
                                }
                        }
                }
        }

        /**
         * The ::open signal is emitted on the primary instance when there are
         * files to open. See g_application_open() for more information.
         *
         * Params:
         *     files = an array of #GFiles
         *     nFiles = the length of @files
         *     hint = a hint provided by the calling instance
         */
        gulong addOnOpen(void delegate(void*, int, string, Application) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
        {
                auto wrapper = new OnOpenDelegateWrapper(dlg);
                wrapper.handlerId = Signals.connectData(
                        this,
                        "open",
                        cast(GCallback)&callBackOpen,
                        cast(void*)wrapper,
                        cast(GClosureNotify)&callBackOpenDestroy,
                        connectFlags);
                return wrapper.handlerId;
        }
        
        extern(C) static void callBackOpen(GApplication* applicationStruct, void* files, int nFiles, char* hint, OnOpenDelegateWrapper wrapper)
        {
                wrapper.dlg(files, nFiles, Str.toString(hint), wrapper.outer);
        }
        
        extern(C) static void callBackOpenDestroy(OnOpenDelegateWrapper wrapper, GClosure* closure)
        {
                wrapper.remove(wrapper);
        }

        protected class OnShutdownDelegateWrapper
        {
                static OnShutdownDelegateWrapper[] listeners;
                void delegate(Application) dlg;
                gulong handlerId;
                
                this(void delegate(Application) dlg)
                {
                        this.dlg = dlg;
                        this.listeners ~= this;
                }
                
                void remove(OnShutdownDelegateWrapper source)
                {
                        foreach(index, wrapper; listeners)
                        {
                                if (wrapper.handlerId == source.handlerId)
                                {
                                        listeners[index] = null;
                                        listeners = std.algorithm.remove(listeners, index);
                                        break;
                                }
                        }
                }
        }

        /**
         * The ::shutdown signal is emitted only on the registered primary instance
         * immediately after the main loop terminates.
         */
        gulong addOnShutdown(void delegate(Application) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
        {
                auto wrapper = new OnShutdownDelegateWrapper(dlg);
                wrapper.handlerId = Signals.connectData(
                        this,
                        "shutdown",
                        cast(GCallback)&callBackShutdown,
                        cast(void*)wrapper,
                        cast(GClosureNotify)&callBackShutdownDestroy,
                        connectFlags);
                return wrapper.handlerId;
        }
        
        extern(C) static void callBackShutdown(GApplication* applicationStruct, OnShutdownDelegateWrapper wrapper)
        {
                wrapper.dlg(wrapper.outer);
        }
        
        extern(C) static void callBackShutdownDestroy(OnShutdownDelegateWrapper wrapper, GClosure* closure)
        {
                wrapper.remove(wrapper);
        }

        protected class OnStartupDelegateWrapper
        {
                static OnStartupDelegateWrapper[] listeners;
                void delegate(Application) dlg;
                gulong handlerId;
                
                this(void delegate(Application) dlg)
                {
                        this.dlg = dlg;
                        this.listeners ~= this;
                }
                
                void remove(OnStartupDelegateWrapper source)
                {
                        foreach(index, wrapper; listeners)
                        {
                                if (wrapper.handlerId == source.handlerId)
                                {
                                        listeners[index] = null;
                                        listeners = std.algorithm.remove(listeners, index);
                                        break;
                                }
                        }
                }
        }

        /**
         * The ::startup signal is emitted on the primary instance immediately
         * after registration. See g_application_register().
         */
        gulong addOnStartup(void delegate(Application) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
        {
                auto wrapper = new OnStartupDelegateWrapper(dlg);
                wrapper.handlerId = Signals.connectData(
                        this,
                        "startup",
                        cast(GCallback)&callBackStartup,
                        cast(void*)wrapper,
                        cast(GClosureNotify)&callBackStartupDestroy,
                        connectFlags);
                return wrapper.handlerId;
        }
        
        extern(C) static void callBackStartup(GApplication* applicationStruct, OnStartupDelegateWrapper wrapper)
        {
                wrapper.dlg(wrapper.outer);
        }
        
        extern(C) static void callBackStartupDestroy(OnStartupDelegateWrapper wrapper, GClosure* closure)
        {
                wrapper.remove(wrapper);
        }
}