gapplicationcommandline.h 6.02 KB
Newer Older
1 2 3 4
/* GIO - GLib Input, Output and Streaming Library
 *
 * Copyright © 2010 Codethink Limited
 *
5 6 7 8
 * 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 2.1 of the License, or (at your option) any later version.
9 10 11 12 13 14 15
 *
 * This library 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
16
 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
17 18 19 20
 *
 * Authors: Ryan Lortie <desrt@desrt.ca>
 */

21 22 23
#ifndef __G_APPLICATION_COMMAND_LINE_H__
#define __G_APPLICATION_COMMAND_LINE_H__

24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
#error "Only <gio/gio.h> can be included directly."
#endif

#include <gio/giotypes.h>

G_BEGIN_DECLS

#define G_TYPE_APPLICATION_COMMAND_LINE                     (g_application_command_line_get_type ())
#define G_APPLICATION_COMMAND_LINE(inst)                    (G_TYPE_CHECK_INSTANCE_CAST ((inst),                     \
                                                             G_TYPE_APPLICATION_COMMAND_LINE,                        \
                                                             GApplicationCommandLine))
#define G_APPLICATION_COMMAND_LINE_CLASS(class)             (G_TYPE_CHECK_CLASS_CAST ((class),                       \
                                                             G_TYPE_APPLICATION_COMMAND_LINE,                        \
                                                             GApplicationCommandLineClass))
#define G_IS_APPLICATION_COMMAND_LINE(inst)                 (G_TYPE_CHECK_INSTANCE_TYPE ((inst),                     \
                                                             G_TYPE_APPLICATION_COMMAND_LINE))
#define G_IS_APPLICATION_COMMAND_LINE_CLASS(class)          (G_TYPE_CHECK_CLASS_TYPE ((class),                       \
                                                             G_TYPE_APPLICATION_COMMAND_LINE))
#define G_APPLICATION_COMMAND_LINE_GET_CLASS(inst)          (G_TYPE_INSTANCE_GET_CLASS ((inst),                      \
                                                             G_TYPE_APPLICATION_COMMAND_LINE,                        \
                                                             GApplicationCommandLineClass))

typedef struct _GApplicationCommandLinePrivate               GApplicationCommandLinePrivate;
typedef struct _GApplicationCommandLineClass                 GApplicationCommandLineClass;

struct _GApplicationCommandLine
{
  /*< private >*/
  GObject parent_instance;

  GApplicationCommandLinePrivate *priv;
};

struct _GApplicationCommandLineClass
{
  /*< private >*/
  GObjectClass parent_class;

63 64 65 66 67
  void                  (* print_literal)       (GApplicationCommandLine *cmdline,
                                                 const gchar             *message);
  void                  (* printerr_literal)    (GApplicationCommandLine *cmdline,
                                                 const gchar             *message);
  GInputStream *        (* get_stdin)           (GApplicationCommandLine *cmdline);
68

69
  gpointer padding[11];
70 71
};

72
GLIB_AVAILABLE_IN_ALL
73 74
GType                   g_application_command_line_get_type             (void) G_GNUC_CONST;

75
GLIB_AVAILABLE_IN_ALL
76 77
gchar **                g_application_command_line_get_arguments        (GApplicationCommandLine   *cmdline,
                                                                         int                       *argc);
78

79 80 81
GLIB_AVAILABLE_IN_2_40
GVariantDict *          g_application_command_line_get_options_dict     (GApplicationCommandLine   *cmdline);

82
GLIB_AVAILABLE_IN_2_36
83 84
GInputStream *          g_application_command_line_get_stdin            (GApplicationCommandLine   *cmdline);

85
GLIB_AVAILABLE_IN_ALL
86 87
const gchar * const *   g_application_command_line_get_environ          (GApplicationCommandLine   *cmdline);

88
GLIB_AVAILABLE_IN_ALL
89 90 91
const gchar *           g_application_command_line_getenv               (GApplicationCommandLine   *cmdline,
                                                                         const gchar               *name);

92
GLIB_AVAILABLE_IN_ALL
93
const gchar *           g_application_command_line_get_cwd              (GApplicationCommandLine   *cmdline);
94

95
GLIB_AVAILABLE_IN_ALL
96
gboolean                g_application_command_line_get_is_remote        (GApplicationCommandLine   *cmdline);
97

98
GLIB_AVAILABLE_IN_ALL
99
void                    g_application_command_line_print                (GApplicationCommandLine   *cmdline,
100
                                                                         const gchar               *format,
101
                                                                         ...) G_GNUC_PRINTF(2, 3);
102
GLIB_AVAILABLE_IN_ALL
103
void                    g_application_command_line_printerr             (GApplicationCommandLine   *cmdline,
104
                                                                         const gchar               *format,
105
                                                                         ...) G_GNUC_PRINTF(2, 3);
106

107
GLIB_AVAILABLE_IN_ALL
108
int                     g_application_command_line_get_exit_status      (GApplicationCommandLine   *cmdline);
109
GLIB_AVAILABLE_IN_ALL
110
void                    g_application_command_line_set_exit_status      (GApplicationCommandLine   *cmdline,
111 112
                                                                         int                        exit_status);

113
GLIB_AVAILABLE_IN_ALL
114
GVariant *              g_application_command_line_get_platform_data    (GApplicationCommandLine   *cmdline);
115

116 117 118 119
GLIB_AVAILABLE_IN_2_36
GFile *                 g_application_command_line_create_file_for_arg  (GApplicationCommandLine   *cmdline,
                                                                         const gchar               *arg);

120 121 122
G_END_DECLS

#endif /* __G_APPLICATION_COMMAND_LINE_H__ */