gio/gapplicationcommandline.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright © 2010 Codethink Limited
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU Lesser General Public License as published
   7  * by the Free Software Foundation; either version 2 of the licence or (at
   8  * your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Authors: Ryan Lortie <desrt@desrt.ca>
  21  */
  22
  23 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  24 #error "Only <gio/gio.h> can be included directly."
  25 #endif
  26
  27 #ifndef __G_APPLICATION_COMMAND_LINE_H__
  28 #define __G_APPLICATION_COMMAND_LINE_H__
  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 /**
  53  * GApplicationCommandLine:
  54  *
  55  * The <structname>GApplicationCommandLine</structname> structure contains private
  56  * data and should only be accessed using the provided API
  57  *
  58  * Since: 2.28
  59  */
  60 struct _GApplicationCommandLine
  61 {
  62   /*< private >*/
  63   GObject parent_instance;
  64
  65   GApplicationCommandLinePrivate *priv;
  66 };
  67
  68 /**
  69  * GApplicationCommandLineClass:
  70  *
  71  * The <structname>GApplicationCommandLineClass</structname> structure contains
  72  * private data only
  73  *
  74  * Since: 2.28
  75  */
  76 struct _GApplicationCommandLineClass
  77 {
  78   /*< private >*/
  79   GObjectClass parent_class;
  80
  81   void (* print_literal)    (GApplicationCommandLine *cmdline,
  82                              const gchar             *message);
  83   void (* printerr_literal) (GApplicationCommandLine *cmdline,
  84                              const gchar             *message);
  85
  86   gpointer padding[12];
  87 };
  88
  89 GType                   g_application_command_line_get_type             (void) G_GNUC_CONST;
  90
  91 gchar **                g_application_command_line_get_arguments        (GApplicationCommandLine   *cmdline,
  92                                                                          int                       *argc);
  93
  94 const gchar * const *   g_application_command_line_get_environ          (GApplicationCommandLine   *cmdline);
  95
  96 const gchar *           g_application_command_line_getenv               (GApplicationCommandLine   *cmdline,
  97                                                                          const gchar               *name);
  98
  99 const gchar *           g_application_command_line_get_cwd              (GApplicationCommandLine   *cmdline);
 100
 101 gboolean                g_application_command_line_get_is_remote        (GApplicationCommandLine   *cmdline);
 102
 103 void                    g_application_command_line_print                (GApplicationCommandLine   *cmdline,
 104                                                                          const gchar               *format,
 105                                                                          ...) G_GNUC_PRINTF(2, 3);
 106 void                    g_application_command_line_printerr             (GApplicationCommandLine   *cmdline,
 107                                                                          const gchar               *format,
 108                                                                          ...) G_GNUC_PRINTF(2, 3);
 109
 110 int                     g_application_command_line_get_exit_status      (GApplicationCommandLine   *cmdline);
 111 void                    g_application_command_line_set_exit_status      (GApplicationCommandLine   *cmdline,
 112                                                                          int                        exit_status);
 113
 114 GVariant *              g_application_command_line_get_platform_data    (GApplicationCommandLine   *cmdline);
 115
 116 G_END_DECLS
 117
 118 #endif /* __G_APPLICATION_COMMAND_LINE_H__ */