1 /* GIO - GLib Input, Output and Streaming Library
2 *
3 * Copyright © 2010 Codethink Limited
4 *
5 * SPDX-License-Identifier: LGPL-2.1-or-later
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General
18 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
19 *
20 * Authors: Ryan Lortie <desrt@desrt.ca>
21 */
22
23 #ifndef __G_APPLICATION_COMMAND_LINE_H__
24 #define __G_APPLICATION_COMMAND_LINE_H__
25
26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
27 #error "Only <gio/gio.h> can be included directly."
28 #endif
29
30 #include <gio/giotypes.h>
31
32 G_BEGIN_DECLS
33
34 #define G_TYPE_APPLICATION_COMMAND_LINE (g_application_command_line_get_type ())
35 #define G_APPLICATION_COMMAND_LINE(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
36 G_TYPE_APPLICATION_COMMAND_LINE, \
37 GApplicationCommandLine))
38 #define G_APPLICATION_COMMAND_LINE_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), \
39 G_TYPE_APPLICATION_COMMAND_LINE, \
40 GApplicationCommandLineClass))
41 #define G_IS_APPLICATION_COMMAND_LINE(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), \
42 G_TYPE_APPLICATION_COMMAND_LINE))
43 #define G_IS_APPLICATION_COMMAND_LINE_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), \
44 G_TYPE_APPLICATION_COMMAND_LINE))
45 #define G_APPLICATION_COMMAND_LINE_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), \
46 G_TYPE_APPLICATION_COMMAND_LINE, \
47 GApplicationCommandLineClass))
48
49 typedef struct _GApplicationCommandLinePrivate GApplicationCommandLinePrivate;
50 typedef struct _GApplicationCommandLineClass GApplicationCommandLineClass;
51
52 struct _GApplicationCommandLine
53 {
54 /*< private >*/
55 GObject parent_instance;
56
57 GApplicationCommandLinePrivate *priv;
58 };
59
60 struct _GApplicationCommandLineClass
61 {
62 /*< private >*/
63 GObjectClass parent_class;
64
65 void (* print_literal) (GApplicationCommandLine *cmdline,
66 const gchar *message);
67 void (* printerr_literal) (GApplicationCommandLine *cmdline,
68 const gchar *message);
69 GInputStream * (* get_stdin) (GApplicationCommandLine *cmdline);
70 void (* done) (GApplicationCommandLine *cmdline);
71
72 gpointer padding[10];
73 };
74
75 GIO_AVAILABLE_IN_ALL
76 GType g_application_command_line_get_type (void) G_GNUC_CONST;
77
78 GIO_AVAILABLE_IN_ALL
79 gchar ** g_application_command_line_get_arguments (GApplicationCommandLine *cmdline,
80 int *argc);
81
82 GIO_AVAILABLE_IN_2_40
83 GVariantDict * g_application_command_line_get_options_dict (GApplicationCommandLine *cmdline);
84
85 GIO_AVAILABLE_IN_2_36
86 GInputStream * g_application_command_line_get_stdin (GApplicationCommandLine *cmdline);
87
88 GIO_AVAILABLE_IN_ALL
89 const gchar * const * g_application_command_line_get_environ (GApplicationCommandLine *cmdline);
90
91 GIO_AVAILABLE_IN_ALL
92 const gchar * g_application_command_line_getenv (GApplicationCommandLine *cmdline,
93 const gchar *name);
94
95 GIO_AVAILABLE_IN_ALL
96 const gchar * g_application_command_line_get_cwd (GApplicationCommandLine *cmdline);
97
98 GIO_AVAILABLE_IN_ALL
99 gboolean g_application_command_line_get_is_remote (GApplicationCommandLine *cmdline);
100
101 GIO_AVAILABLE_IN_2_80
102 void g_application_command_line_print_literal (GApplicationCommandLine *cmdline,
103 const gchar *message);
104 GIO_AVAILABLE_IN_2_80
105 void g_application_command_line_printerr_literal (GApplicationCommandLine *cmdline,
106 const gchar *message);
107
108 GIO_AVAILABLE_IN_ALL
109 void g_application_command_line_print (GApplicationCommandLine *cmdline,
110 const gchar *format,
111 ...) G_GNUC_PRINTF(2, 3);
112 GIO_AVAILABLE_IN_ALL
113 void g_application_command_line_printerr (GApplicationCommandLine *cmdline,
114 const gchar *format,
115 ...) G_GNUC_PRINTF(2, 3);
116
117 GIO_AVAILABLE_IN_ALL
118 int g_application_command_line_get_exit_status (GApplicationCommandLine *cmdline);
119 GIO_AVAILABLE_IN_ALL
120 void g_application_command_line_set_exit_status (GApplicationCommandLine *cmdline,
121 int exit_status);
122
123 GIO_AVAILABLE_IN_ALL
124 GVariant * g_application_command_line_get_platform_data (GApplicationCommandLine *cmdline);
125
126 GIO_AVAILABLE_IN_2_36
127 GFile * g_application_command_line_create_file_for_arg (GApplicationCommandLine *cmdline,
128 const gchar *arg);
129
130 GIO_AVAILABLE_IN_2_80
131 void g_application_command_line_done (GApplicationCommandLine *cmdline);
132
133 G_END_DECLS
134
135 #endif /* __G_APPLICATION_COMMAND_LINE_H__ */