glib-2.0/gio/gapplicationcommandline.h

0001 /* GIO - GLib Input, Output and Streaming Library
0002  *
0003  * Copyright © 2010 Codethink Limited
0004  *
0005  * SPDX-License-Identifier: LGPL-2.1-or-later
0006  *
0007  * This library is free software; you can redistribute it and/or
0008  * modify it under the terms of the GNU Lesser General Public
0009  * License as published by the Free Software Foundation; either
0010  * version 2.1 of the License, or (at your option) any later version.
0011  *
0012  * This library is distributed in the hope that it will be useful,
0013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0015  * Lesser General Public License for more details.
0016  *
0017  * You should have received a copy of the GNU Lesser General
0018  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
0019  *
0020  * Authors: Ryan Lortie <desrt@desrt.ca>
0021  */
0022
0023 #ifndef __G_APPLICATION_COMMAND_LINE_H__
0024 #define __G_APPLICATION_COMMAND_LINE_H__
0025
0026 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
0027 #error "Only <gio/gio.h> can be included directly."
0028 #endif
0029
0030 #include <gio/giotypes.h>
0031
0032 G_BEGIN_DECLS
0033
0034 #define G_TYPE_APPLICATION_COMMAND_LINE                     (g_application_command_line_get_type ())
0035 #define G_APPLICATION_COMMAND_LINE(inst)                    (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
0036                                                              G_TYPE_APPLICATION_COMMAND_LINE,                        \
0037                                                              GApplicationCommandLine))
0038 #define G_APPLICATION_COMMAND_LINE_CLASS(class)             (G_TYPE_CHECK_CLASS_CAST ((class),                       \
0039                                                              G_TYPE_APPLICATION_COMMAND_LINE,                        \
0040                                                              GApplicationCommandLineClass))
0041 #define G_IS_APPLICATION_COMMAND_LINE(inst)                 (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
0042                                                              G_TYPE_APPLICATION_COMMAND_LINE))
0043 #define G_IS_APPLICATION_COMMAND_LINE_CLASS(class)          (G_TYPE_CHECK_CLASS_TYPE ((class),                       \
0044                                                              G_TYPE_APPLICATION_COMMAND_LINE))
0045 #define G_APPLICATION_COMMAND_LINE_GET_CLASS(inst)          (G_TYPE_INSTANCE_GET_CLASS ((inst),                      \
0046                                                              G_TYPE_APPLICATION_COMMAND_LINE,                        \
0047                                                              GApplicationCommandLineClass))
0048
0049 typedef struct _GApplicationCommandLinePrivate               GApplicationCommandLinePrivate;
0050 typedef struct _GApplicationCommandLineClass                 GApplicationCommandLineClass;
0051
0052 struct _GApplicationCommandLine
0053 {
0054   /*< private >*/
0055   GObject parent_instance;
0056
0057   GApplicationCommandLinePrivate *priv;
0058 };
0059
0060 struct _GApplicationCommandLineClass
0061 {
0062   /*< private >*/
0063   GObjectClass parent_class;
0064
0065   void                  (* print_literal)       (GApplicationCommandLine *cmdline,
0066                                                  const gchar             *message);
0067   void                  (* printerr_literal)    (GApplicationCommandLine *cmdline,
0068                                                  const gchar             *message);
0069   GInputStream *        (* get_stdin)           (GApplicationCommandLine *cmdline);
0070   void                  (* done)                (GApplicationCommandLine *cmdline);
0071
0072   gpointer padding[10];
0073 };
0074
0075 GIO_AVAILABLE_IN_ALL
0076 GType                   g_application_command_line_get_type             (void) G_GNUC_CONST;
0077
0078 GIO_AVAILABLE_IN_ALL
0079 gchar **                g_application_command_line_get_arguments        (GApplicationCommandLine   *cmdline,
0080                                                                          int                       *argc);
0081
0082 GIO_AVAILABLE_IN_2_40
0083 GVariantDict *          g_application_command_line_get_options_dict     (GApplicationCommandLine   *cmdline);
0084
0085 GIO_AVAILABLE_IN_2_36
0086 GInputStream *          g_application_command_line_get_stdin            (GApplicationCommandLine   *cmdline);
0087
0088 GIO_AVAILABLE_IN_ALL
0089 const gchar * const *   g_application_command_line_get_environ          (GApplicationCommandLine   *cmdline);
0090
0091 GIO_AVAILABLE_IN_ALL
0092 const gchar *           g_application_command_line_getenv               (GApplicationCommandLine   *cmdline,
0093                                                                          const gchar               *name);
0094
0095 GIO_AVAILABLE_IN_ALL
0096 const gchar *           g_application_command_line_get_cwd              (GApplicationCommandLine   *cmdline);
0097
0098 GIO_AVAILABLE_IN_ALL
0099 gboolean                g_application_command_line_get_is_remote        (GApplicationCommandLine   *cmdline);
0100
0101 GIO_AVAILABLE_IN_2_80
0102 void                    g_application_command_line_print_literal        (GApplicationCommandLine   *cmdline,
0103                                                                          const gchar               *message);
0104 GIO_AVAILABLE_IN_2_80
0105 void                    g_application_command_line_printerr_literal     (GApplicationCommandLine   *cmdline,
0106                                                                          const gchar               *message);
0107
0108 GIO_AVAILABLE_IN_ALL
0109 void                    g_application_command_line_print                (GApplicationCommandLine   *cmdline,
0110                                                                          const gchar               *format,
0111                                                                          ...) G_GNUC_PRINTF(2, 3);
0112 GIO_AVAILABLE_IN_ALL
0113 void                    g_application_command_line_printerr             (GApplicationCommandLine   *cmdline,
0114                                                                          const gchar               *format,
0115                                                                          ...) G_GNUC_PRINTF(2, 3);
0116
0117 GIO_AVAILABLE_IN_ALL
0118 int                     g_application_command_line_get_exit_status      (GApplicationCommandLine   *cmdline);
0119 GIO_AVAILABLE_IN_ALL
0120 void                    g_application_command_line_set_exit_status      (GApplicationCommandLine   *cmdline,
0121                                                                          int                        exit_status);
0122
0123 GIO_AVAILABLE_IN_ALL
0124 GVariant *              g_application_command_line_get_platform_data    (GApplicationCommandLine   *cmdline);
0125
0126 GIO_AVAILABLE_IN_2_36
0127 GFile *                 g_application_command_line_create_file_for_arg  (GApplicationCommandLine   *cmdline,
0128                                                                          const gchar               *arg);
0129
0130 GIO_AVAILABLE_IN_2_80
0131 void                    g_application_command_line_done                 (GApplicationCommandLine   *cmdline);
0132
0133 G_END_DECLS
0134
0135 #endif /* __G_APPLICATION_COMMAND_LINE_H__ */