2 * Copyright © 2010 Codethink Limited
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU Lesser General Public License as
6 * published by the Free Software Foundation; either version 2 of the
7 * licence or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
17 * Authors: Ryan Lortie <desrt@desrt.ca>
22 #include "gapplicationcommandline.h"
31 #include "gunixinputstream.h"
37 #include "gwin32inputstream.h"
41 * SECTION:gapplicationcommandline
42 * @title: GApplicationCommandLine
43 * @short_description: A command-line invocation of an application
45 * @see_also: #GApplication
47 * #GApplicationCommandLine represents a command-line invocation of
48 * an application. It is created by #GApplication and emitted
49 * in the #GApplication::command-line signal and virtual function.
51 * The class contains the list of arguments that the program was invoked
52 * with. It is also possible to query if the commandline invocation was
53 * local (ie: the current process is running in direct response to the
54 * invocation) or remote (ie: some other process forwarded the
55 * commandline to this process).
57 * The GApplicationCommandLine object can provide the @argc and @argv
58 * parameters for use with the #GOptionContext command-line parsing API,
59 * with the g_application_command_line_get_arguments() function. See
60 * <xref linkend="gapplication-example-cmdline3"/> for an example.
62 * The exit status of the originally-invoked process may be set and
63 * messages can be printed to stdout or stderr of that process. The
64 * lifecycle of the originally-invoked process is tied to the lifecycle
65 * of this object (ie: the process exits when the last reference is
68 * The main use for #GApplicationCommandLine (and the
69 * #GApplication::command-line signal) is 'Emacs server' like use cases:
70 * You can set the `EDITOR` environment variable to have e.g. git use
71 * your favourite editor to edit commit messages, and if you already
72 * have an instance of the editor running, the editing will happen
73 * in the running instance, instead of opening a new one. An important
74 * aspect of this use case is that the process that gets started by git
75 * does not return until the editing is done.
77 * Normally, the commandline is completely handled in the
78 * #GApplication::command-line handler. The launching instance exits
79 * once the signal handler in the primary instance has returned, and
80 * the return value of the signal handler becomes the exit status
81 * of the launching instance.
82 * |[<!-- language="C" -->
84 * command_line (GApplication *application,
85 * GApplicationCommandLine *cmdline)
91 * argv = g_application_command_line_get_arguments (cmdline, &argc);
93 * g_application_command_line_print (cmdline,
94 * "This text is written back\n"
95 * "to stdout of the caller\n");
97 * for (i = 0; i < argc; i++)
98 * g_print ("argument %d: %s\n", i, argv[i]);
105 * The complete example can be found here:
106 * [gapplication-example-cmdline.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-cmdline.c)
108 * In more complicated cases, the handling of the comandline can be
109 * split between the launcher and the primary instance.
110 * |[<!-- language="C" -->
112 * test_local_cmdline (GApplication *application,
113 * gchar ***arguments,
124 * if (g_str_has_prefix (argv[i], "--local-"))
126 * g_print ("handling argument %s locally\n", argv[i]);
128 * for (j = i; argv[j]; j++)
129 * argv[j] = argv[j + 1];
133 * g_print ("not handling argument %s locally\n", argv[i]);
144 * test_application_class_init (TestApplicationClass *class)
146 * G_APPLICATION_CLASS (class)->local_command_line = test_local_cmdline;
151 * In this example of split commandline handling, options that start
152 * with <literal>--local-</literal> are handled locally, all other
153 * options are passed to the #GApplication::command-line handler
154 * which runs in the primary instance.
156 * The complete example can be found here:
157 * [gapplication-example-cmdline2.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-cmdline2.c)
159 * If handling the commandline requires a lot of work, it may
160 * be better to defer it.
161 * |[<!-- language="C" -->
163 * my_cmdline_handler (gpointer data)
165 * GApplicationCommandLine *cmdline = data;
167 * /* do the heavy lifting in an idle */
169 * g_application_command_line_set_exit_status (cmdline, 0);
170 * g_object_unref (cmdline); /* this releases the application */
172 * return G_SOURCE_REMOVE;
176 * command_line (GApplication *application,
177 * GApplicationCommandLine *cmdline)
179 * /* keep the application running until we are done with this commandline */
180 * g_application_hold (application);
182 * g_object_set_data_full (G_OBJECT (cmdline),
183 * "application", application,
184 * (GDestroyNotify)g_application_release);
186 * g_object_ref (cmdline);
187 * g_idle_add (my_cmdline_handler, cmdline);
192 * In this example the commandline is not completely handled before
193 * the #GApplication::command-line handler returns. Instead, we keep
194 * a reference to the #GApplicationCommandLine object and handle it
195 * later (in this example, in an idle). Note that it is necessary to
196 * hold the application until you are done with the commandline.
198 * The complete example can be found here:
199 * [gapplication-example-cmdline3.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-cmdline3.c)
203 * GApplicationCommandLineClass:
205 * The #GApplicationCommandLineClass-struct
206 * contains private data only.
219 struct _GApplicationCommandLinePrivate
221 GVariant *platform_data;
224 GVariantDict *options_dict;
231 G_DEFINE_TYPE_WITH_PRIVATE (GApplicationCommandLine, g_application_command_line, G_TYPE_OBJECT)
233 /* All subclasses represent remote invocations of some kind. */
234 #define IS_REMOTE(cmdline) (G_TYPE_FROM_INSTANCE (cmdline) != \
235 G_TYPE_APPLICATION_COMMAND_LINE)
238 grok_platform_data (GApplicationCommandLine *cmdline)
244 g_variant_iter_init (&iter, cmdline->priv->platform_data);
246 while (g_variant_iter_loop (&iter, "{&sv}", &key, &value))
247 if (strcmp (key, "cwd") == 0)
249 if (!cmdline->priv->cwd)
250 cmdline->priv->cwd = g_variant_dup_bytestring (value, NULL);
253 else if (strcmp (key, "environ") == 0)
255 if (!cmdline->priv->environ)
256 cmdline->priv->environ =
257 g_variant_dup_bytestring_array (value, NULL);
260 else if (strcmp (key, "options") == 0)
262 if (!cmdline->priv->options)
263 cmdline->priv->options = g_variant_ref (value);
268 g_application_command_line_real_print_literal (GApplicationCommandLine *cmdline,
269 const gchar *message)
271 g_print ("%s", message);
275 g_application_command_line_real_printerr_literal (GApplicationCommandLine *cmdline,
276 const gchar *message)
278 g_printerr ("%s", message);
281 static GInputStream *
282 g_application_command_line_real_get_stdin (GApplicationCommandLine *cmdline)
285 return g_unix_input_stream_new (0, FALSE);
287 return g_win32_input_stream_new (GetStdHandle (STD_INPUT_HANDLE), FALSE);
292 g_application_command_line_get_property (GObject *object,
297 GApplicationCommandLine *cmdline = G_APPLICATION_COMMAND_LINE (object);
302 g_value_set_variant (value, cmdline->priv->arguments);
305 case PROP_PLATFORM_DATA:
306 g_value_set_variant (value, cmdline->priv->platform_data);
310 g_value_set_boolean (value, IS_REMOTE (cmdline));
314 g_assert_not_reached ();
319 g_application_command_line_set_property (GObject *object,
324 GApplicationCommandLine *cmdline = G_APPLICATION_COMMAND_LINE (object);
329 g_assert (cmdline->priv->arguments == NULL);
330 cmdline->priv->arguments = g_value_dup_variant (value);
334 g_assert (cmdline->priv->options == NULL);
335 cmdline->priv->options = g_value_dup_variant (value);
338 case PROP_PLATFORM_DATA:
339 g_assert (cmdline->priv->platform_data == NULL);
340 cmdline->priv->platform_data = g_value_dup_variant (value);
341 if (cmdline->priv->platform_data != NULL)
342 grok_platform_data (cmdline);
346 g_assert_not_reached ();
351 g_application_command_line_finalize (GObject *object)
353 GApplicationCommandLine *cmdline = G_APPLICATION_COMMAND_LINE (object);
355 if (cmdline->priv->options_dict)
356 g_variant_dict_unref (cmdline->priv->options_dict);
358 if (cmdline->priv->options)
359 g_variant_unref (cmdline->priv->options);
361 if (cmdline->priv->platform_data)
362 g_variant_unref (cmdline->priv->platform_data);
363 if (cmdline->priv->arguments)
364 g_variant_unref (cmdline->priv->arguments);
366 g_free (cmdline->priv->cwd);
367 g_strfreev (cmdline->priv->environ);
369 G_OBJECT_CLASS (g_application_command_line_parent_class)
374 g_application_command_line_init (GApplicationCommandLine *cmdline)
376 cmdline->priv = g_application_command_line_get_instance_private (cmdline);
380 g_application_command_line_constructed (GObject *object)
382 GApplicationCommandLine *cmdline = G_APPLICATION_COMMAND_LINE (object);
384 if (IS_REMOTE (cmdline))
387 /* In the local case, set cmd and environ */
388 if (!cmdline->priv->cwd)
389 cmdline->priv->cwd = g_get_current_dir ();
391 if (!cmdline->priv->environ)
392 cmdline->priv->environ = g_get_environ ();
396 g_application_command_line_class_init (GApplicationCommandLineClass *class)
398 GObjectClass *object_class = G_OBJECT_CLASS (class);
400 object_class->get_property = g_application_command_line_get_property;
401 object_class->set_property = g_application_command_line_set_property;
402 object_class->finalize = g_application_command_line_finalize;
403 object_class->constructed = g_application_command_line_constructed;
405 class->printerr_literal = g_application_command_line_real_printerr_literal;
406 class->print_literal = g_application_command_line_real_print_literal;
407 class->get_stdin = g_application_command_line_real_get_stdin;
409 g_object_class_install_property (object_class, PROP_ARGUMENTS,
410 g_param_spec_variant ("arguments",
411 P_("Commandline arguments"),
412 P_("The commandline that caused this ::command-line signal emission"),
413 G_VARIANT_TYPE_BYTESTRING_ARRAY, NULL,
414 G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY |
415 G_PARAM_STATIC_STRINGS));
417 g_object_class_install_property (object_class, PROP_OPTIONS,
418 g_param_spec_variant ("options",
420 P_("The options sent along with the commandline"),
421 G_VARIANT_TYPE_VARDICT, NULL, G_PARAM_WRITABLE |
422 G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
424 g_object_class_install_property (object_class, PROP_PLATFORM_DATA,
425 g_param_spec_variant ("platform-data",
427 P_("Platform-specific data for the commandline"),
428 G_VARIANT_TYPE ("a{sv}"), NULL,
429 G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY |
430 G_PARAM_STATIC_STRINGS));
432 g_object_class_install_property (object_class, PROP_IS_REMOTE,
433 g_param_spec_boolean ("is-remote",
435 P_("TRUE if this is a remote commandline"),
437 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
442 * g_application_command_line_get_arguments:
443 * @cmdline: a #GApplicationCommandLine
444 * @argc: (out) (allow-none): the length of the arguments array, or %NULL
446 * Gets the list of arguments that was passed on the command line.
448 * The strings in the array may contain non-UTF-8 data on UNIX (such as
449 * filenames or arguments given in the system locale) but are always in
452 * If you wish to use the return value with #GOptionContext, you must
453 * use g_option_context_parse_strv().
455 * The return value is %NULL-terminated and should be freed using
458 * Returns: (array length=argc) (transfer full): the string array
459 * containing the arguments (the argv)
464 g_application_command_line_get_arguments (GApplicationCommandLine *cmdline,
470 g_return_val_if_fail (G_IS_APPLICATION_COMMAND_LINE (cmdline), NULL);
472 argv = g_variant_dup_bytestring_array (cmdline->priv->arguments, &len);
481 * g_application_command_line_get_options_dict:
482 * @cmdline: a #GApplicationCommandLine
484 * Gets the options there were passed to g_application_command_line().
486 * If you did not override local_command_line() then these are the same
487 * options that were parsed according to the #GOptionEntrys added to the
488 * application with g_application_add_main_option_entries() and possibly
489 * modified from your GApplication::handle-local-options handler.
491 * If no options were sent then an empty dictionary is returned so that
492 * you don't need to check for %NULL.
494 * Returns: (transfer none): a #GVariantDict with the options
499 g_application_command_line_get_options_dict (GApplicationCommandLine *cmdline)
501 g_return_val_if_fail (G_IS_APPLICATION_COMMAND_LINE (cmdline), NULL);
503 if (!cmdline->priv->options_dict)
504 cmdline->priv->options_dict = g_variant_dict_new (cmdline->priv->options);
506 return cmdline->priv->options_dict;
510 * g_application_command_line_get_stdin:
511 * @cmdline: a #GApplicationCommandLine
513 * Gets the stdin of the invoking process.
515 * The #GInputStream can be used to read data passed to the standard
516 * input of the invoking process.
517 * This doesn't work on all platforms. Presently, it is only available
518 * on UNIX when using a DBus daemon capable of passing file descriptors.
519 * If stdin is not available then %NULL will be returned. In the
520 * future, support may be expanded to other platforms.
522 * You must only call this function once per commandline invocation.
524 * Returns: (transfer full): a #GInputStream for stdin
529 g_application_command_line_get_stdin (GApplicationCommandLine *cmdline)
531 return G_APPLICATION_COMMAND_LINE_GET_CLASS (cmdline)->get_stdin (cmdline);
535 * g_application_command_line_get_cwd:
536 * @cmdline: a #GApplicationCommandLine
538 * Gets the working directory of the command line invocation.
539 * The string may contain non-utf8 data.
541 * It is possible that the remote application did not send a working
542 * directory, so this may be %NULL.
544 * The return value should not be modified or freed and is valid for as
545 * long as @cmdline exists.
547 * Returns: the current directory, or %NULL
552 g_application_command_line_get_cwd (GApplicationCommandLine *cmdline)
554 return cmdline->priv->cwd;
558 * g_application_command_line_get_environ:
559 * @cmdline: a #GApplicationCommandLine
561 * Gets the contents of the 'environ' variable of the command line
562 * invocation, as would be returned by g_get_environ(), ie as a
563 * %NULL-terminated list of strings in the form 'NAME=VALUE'.
564 * The strings may contain non-utf8 data.
566 * The remote application usually does not send an environment. Use
567 * %G_APPLICATION_SEND_ENVIRONMENT to affect that. Even with this flag
568 * set it is possible that the environment is still not available (due
569 * to invocation messages from other applications).
571 * The return value should not be modified or freed and is valid for as
572 * long as @cmdline exists.
574 * See g_application_command_line_getenv() if you are only interested
575 * in the value of a single environment variable.
577 * Returns: (array zero-terminated=1) (transfer none): the environment
578 * strings, or %NULL if they were not sent
582 const gchar * const *
583 g_application_command_line_get_environ (GApplicationCommandLine *cmdline)
585 return (const gchar **)cmdline->priv->environ;
589 * g_application_command_line_getenv:
590 * @cmdline: a #GApplicationCommandLine
591 * @name: the environment variable to get
593 * Gets the value of a particular environment variable of the command
594 * line invocation, as would be returned by g_getenv(). The strings may
595 * contain non-utf8 data.
597 * The remote application usually does not send an environment. Use
598 * %G_APPLICATION_SEND_ENVIRONMENT to affect that. Even with this flag
599 * set it is possible that the environment is still not available (due
600 * to invocation messages from other applications).
602 * The return value should not be modified or freed and is valid for as
603 * long as @cmdline exists.
605 * Returns: the value of the variable, or %NULL if unset or unsent
610 g_application_command_line_getenv (GApplicationCommandLine *cmdline,
613 gint length = strlen (name);
616 /* TODO: expand on windows */
617 if (cmdline->priv->environ)
618 for (i = 0; cmdline->priv->environ[i]; i++)
619 if (strncmp (cmdline->priv->environ[i], name, length) == 0 &&
620 cmdline->priv->environ[i][length] == '=')
621 return cmdline->priv->environ[i] + length + 1;
627 * g_application_command_line_get_is_remote:
628 * @cmdline: a #GApplicationCommandLine
630 * Determines if @cmdline represents a remote invocation.
632 * Returns: %TRUE if the invocation was remote
637 g_application_command_line_get_is_remote (GApplicationCommandLine *cmdline)
639 return IS_REMOTE (cmdline);
643 * g_application_command_line_print:
644 * @cmdline: a #GApplicationCommandLine
645 * @format: a printf-style format string
646 * @...: arguments, as per @format
648 * Formats a message and prints it using the stdout print handler in the
651 * If @cmdline is a local invocation then this is exactly equivalent to
652 * g_print(). If @cmdline is remote then this is equivalent to calling
653 * g_print() in the invoking process.
658 g_application_command_line_print (GApplicationCommandLine *cmdline,
665 g_return_if_fail (G_IS_APPLICATION_COMMAND_LINE (cmdline));
666 g_return_if_fail (format != NULL);
668 va_start (ap, format);
669 message = g_strdup_vprintf (format, ap);
672 G_APPLICATION_COMMAND_LINE_GET_CLASS (cmdline)
673 ->print_literal (cmdline, message);
678 * g_application_command_line_printerr:
679 * @cmdline: a #GApplicationCommandLine
680 * @format: a printf-style format string
681 * @...: arguments, as per @format
683 * Formats a message and prints it using the stderr print handler in the
686 * If @cmdline is a local invocation then this is exactly equivalent to
687 * g_printerr(). If @cmdline is remote then this is equivalent to
688 * calling g_printerr() in the invoking process.
693 g_application_command_line_printerr (GApplicationCommandLine *cmdline,
700 g_return_if_fail (G_IS_APPLICATION_COMMAND_LINE (cmdline));
701 g_return_if_fail (format != NULL);
703 va_start (ap, format);
704 message = g_strdup_vprintf (format, ap);
707 G_APPLICATION_COMMAND_LINE_GET_CLASS (cmdline)
708 ->printerr_literal (cmdline, message);
713 * g_application_command_line_set_exit_status:
714 * @cmdline: a #GApplicationCommandLine
715 * @exit_status: the exit status
717 * Sets the exit status that will be used when the invoking process
720 * The return value of the #GApplication::command-line signal is
721 * passed to this function when the handler returns. This is the usual
722 * way of setting the exit status.
724 * In the event that you want the remote invocation to continue running
725 * and want to decide on the exit status in the future, you can use this
726 * call. For the case of a remote invocation, the remote process will
727 * typically exit when the last reference is dropped on @cmdline. The
728 * exit status of the remote process will be equal to the last value
729 * that was set with this function.
731 * In the case that the commandline invocation is local, the situation
732 * is slightly more complicated. If the commandline invocation results
733 * in the mainloop running (ie: because the use-count of the application
734 * increased to a non-zero value) then the application is considered to
735 * have been 'successful' in a certain sense, and the exit status is
736 * always zero. If the application use count is zero, though, the exit
737 * status of the local #GApplicationCommandLine is used.
742 g_application_command_line_set_exit_status (GApplicationCommandLine *cmdline,
745 g_return_if_fail (G_IS_APPLICATION_COMMAND_LINE (cmdline));
747 cmdline->priv->exit_status = exit_status;
751 * g_application_command_line_get_exit_status:
752 * @cmdline: a #GApplicationCommandLine
754 * Gets the exit status of @cmdline. See
755 * g_application_command_line_set_exit_status() for more information.
757 * Returns: the exit status
762 g_application_command_line_get_exit_status (GApplicationCommandLine *cmdline)
764 g_return_val_if_fail (G_IS_APPLICATION_COMMAND_LINE (cmdline), -1);
766 return cmdline->priv->exit_status;
770 * g_application_command_line_get_platform_data:
771 * @cmdline: #GApplicationCommandLine
773 * Gets the platform data associated with the invocation of @cmdline.
775 * This is a #GVariant dictionary containing information about the
776 * context in which the invocation occurred. It typically contains
777 * information like the current working directory and the startup
780 * For local invocation, it will be %NULL.
782 * Returns: (allow-none): the platform data, or %NULL
787 g_application_command_line_get_platform_data (GApplicationCommandLine *cmdline)
789 g_return_val_if_fail (G_IS_APPLICATION_COMMAND_LINE (cmdline), NULL);
791 if (cmdline->priv->platform_data)
792 return g_variant_ref (cmdline->priv->platform_data);
798 * g_application_command_line_create_file_for_arg:
799 * @cmdline: a #GApplicationCommandLine
800 * @arg: an argument from @cmdline
802 * Creates a #GFile corresponding to a filename that was given as part
803 * of the invocation of @cmdline.
805 * This differs from g_file_new_for_commandline_arg() in that it
806 * resolves relative pathnames using the current working directory of
807 * the invoking process rather than the local process.
809 * Returns: (transfer full): a new #GFile
814 g_application_command_line_create_file_for_arg (GApplicationCommandLine *cmdline,
817 g_return_val_if_fail (arg != NULL, NULL);
819 if (cmdline->priv->cwd)
820 return g_file_new_for_commandline_arg_and_cwd (arg, cmdline->priv->cwd);
822 g_warning ("Requested creation of GFile for commandline invocation that did not send cwd. "
823 "Using cwd of local process to resolve relative path names.");
825 return g_file_new_for_commandline_arg (arg);