Class: Gio::ApplicationCommandLine

Inherits:
Object
  • Object
show all
Defined in:
lib/gio2/application-command-line.rb

Overview

The GApplication::CommandLineClass-struct
contains private data only.

Instance Method Summary collapse

Constructor Details

#initialize(properties = nil) ⇒ ApplicationCommandLine

Returns a new instance of ApplicationCommandLine.



19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/gio2/application-command-line.rb', line 19

def initialize(properties=nil)
  if properties
    arguments = properties[:arguments]
    if arguments and !arguments.is_a?(GLib::Variant)
      arguments = GLib::Variant.new(arguments,
                                    GLib::VariantType::BYTESTRING_ARRAY)
      properties = properties.merge(:arguments => arguments)
    end
  end
  super(properties)
end

Instance Method Details

#arguments=(arguments) ⇒ GLib::Variant

The commandline that caused this [signalGio.Application::command-line]
signal emission.

Parameters:

  • arguments (GLib::Variant)

Returns:

  • (GLib::Variant) —

    arguments

#create_file_for_arg(arg) ⇒ Gio::File

Creates a #GFile corresponding to a filename that was given as part
of the invocation of cmdline.

This differs from g_file_new_for_commandline_arg() in that it
resolves relative pathnames using the current working directory of
the invoking process rather than the local process.

Parameters:

  • arg (Gio::filename) —

    an argument from cmdline

Returns:

#cwd ⇒ Gio::filename

Gets the working directory of the command line invocation.
The string may contain non-utf8 data.

It is possible that the remote application did not send a working
directory, so this may be nil.

The return value should not be modified or freed and is valid for as
long as cmdline exists.

Returns:

  • (Gio::filename) —

    the current directory, or nil

#done ⇒ nil

Signals that command line processing is completed.

For remote invocation, it causes the invoking process to terminate.

For local invocation, it does nothing.

This method should be called in the [signalGio.Application::command-line]
handler, after the exit status is set and all messages are printed.

After this call, g_application_command_line_set_exit_status() has no effect.
Subsequent calls to this method are no-ops.

This method is automatically called when the GApplication::CommandLine
object is disposed — so you can omit the call in non-garbage collected
languages.

Returns:

  • (nil)

#environ ⇒ Array<Gio::filename>

Gets the contents of the 'environ' variable of the command line
invocation, as would be returned by g_get_environ(), ie as a
nil-terminated list of strings in the form 'NAME=VALUE'.
The strings may contain non-utf8 data.

The remote application usually does not send an environment. Use
%G_APPLICATION_SEND_ENVIRONMENT to affect that. Even with this flag
set it is possible that the environment is still not available (due
to invocation messages from other applications).

The return value should not be modified or freed and is valid for as
long as cmdline exists.

See g_application_command_line_getenv() if you are only interested
in the value of a single environment variable.

Returns:

  • (Array<Gio::filename>) —

    the environment strings, or nil if they were not sent

#exit_status ⇒ Integer

Gets the exit status of cmdline. See
g_application_command_line_set_exit_status() for more information.

Returns:

  • (Integer) —

    the exit status

#exit_status=(exit_status) ⇒ nil

Sets the exit status that will be used when the invoking process
exits.

The return value of the #GApplication::command-line signal is
passed to this function when the handler returns. This is the usual
way of setting the exit status.

In the event that you want the remote invocation to continue running
and want to decide on the exit status in the future, you can use this
call. For the case of a remote invocation, the remote process will
typically exit when the last reference is dropped on cmdline. The
exit status of the remote process will be equal to the last value
that was set with this function.

In the case that the commandline invocation is local, the situation
is slightly more complicated. If the commandline invocation results
in the mainloop running (ie: because the use-count of the application
increased to a non-zero value) then the application is considered to
have been 'successful' in a certain sense, and the exit status is
always zero. If the application use count is zero, though, the exit
status of the local GApplication::CommandLine is used.

This method is a no-op if g_application_command_line_done() has
been called.

Parameters:

  • exit_status (Integer) —

    the exit status

Returns:

  • (nil)

#get_arguments(argc) ⇒ Array<Gio::filename>

Gets the list of arguments that was passed on the command line.

The strings in the array may contain non-UTF-8 data on UNIX (such as
filenames or arguments given in the system locale) but are always in
UTF-8 on Windows.

If you wish to use the return value with GOption::Context, you must
use g_option_context_parse_strv().

The return value is nil-terminated and should be freed using
g_strfreev().

Parameters:

  • argc (Integer) —

    the length of the arguments array, or nil

Returns:

  • (Array<Gio::filename>) —

    the string array containing the arguments (the argv)

#getenv(name) ⇒ String

Gets the value of a particular environment variable of the command
line invocation, as would be returned by g_getenv(). The strings may
contain non-utf8 data.

The remote application usually does not send an environment. Use
%G_APPLICATION_SEND_ENVIRONMENT to affect that. Even with this flag
set it is possible that the environment is still not available (due
to invocation messages from other applications).

The return value should not be modified or freed and is valid for as
long as cmdline exists.

Parameters:

  • name (Gio::filename) —

    the environment variable to get

Returns:

  • (String) —

    the value of the variable, or nil if unset or unsent

#is_remote ⇒ Boolean

Determines if cmdline represents a remote invocation.

Returns:

  • (Boolean) —

    true if the invocation was remote

#is_remote=(is_remote) ⇒ Boolean

Whether this is a remote commandline.

Parameters:

  • is_remote (Boolean)

Returns:

  • (Boolean) —

    is-remote

  • (Boolean) —

    is-remote

#is_remote? ⇒ Boolean

Whether this is a remote commandline.

Returns:

  • (Boolean) —

    is-remote

#options=(options) ⇒ GLib::Variant

The options sent along with the commandline.

Parameters:

  • options (GLib::Variant)

Returns:

  • (GLib::Variant) —

    options

#options_dict ⇒ GLib::VariantDict

Gets the options that were passed to g_application_command_line().

If you did not override local_command_line() then these are the same
options that were parsed according to the GOption::Entrys added to the
application with g_application_add_main_option_entries() and possibly
modified from your GApplication::handle-local-options handler.

If no options were sent then an empty dictionary is returned so that
you don't need to check for nil.

The data has been passed via an untrusted external process, so the types of
all values must be checked before being used.

Returns:

  • (GLib::VariantDict) —

    a GVariant::Dict with the options

#platform_data ⇒ GLib::Variant

Gets the platform data associated with the invocation of cmdline.

This is a #GVariant dictionary containing information about the
context in which the invocation occurred. It typically contains
information like the current working directory and the startup
notification ID.

It comes from an untrusted external process and hence the types of all
values must be validated before being used.

For local invocation, it will be nil.

Returns:

  • (GLib::Variant) —

    the platform data, or nil

#platform_data=(platform_data) ⇒ GLib::Variant

Platform-specific data for the commandline.

Parameters:

  • platform_data (GLib::Variant)

Returns:

  • (GLib::Variant) —

    platform-data

#print(format, array) ⇒ nil

Formats a message and prints it using the stdout print handler in the
invoking process.

If cmdline is a local invocation then this is exactly equivalent to
g_print(). If cmdline is remote then this is equivalent to calling
g_print() in the invoking process.

Parameters:

  • format (String) —

    a printf-style format string

  • array (Array) —

    arguments, as per format

Returns:

  • (nil)

#print_literal(message) ⇒ nil

Prints a message using the stdout print handler in the invoking process.

Unlike g_application_command_line_print(), message is not a printf()-style
format string. Use this function if message contains text you don't have
control over, that could include printf() escape sequences.

Parameters:

  • message (String) —

    the message

Returns:

  • (nil)

#printerr(format, array) ⇒ nil

Formats a message and prints it using the stderr print handler in the
invoking process.

If cmdline is a local invocation then this is exactly equivalent to
g_printerr(). If cmdline is remote then this is equivalent to
calling g_printerr() in the invoking process.

Parameters:

  • format (String) —

    a printf-style format string

  • array (Array) —

    arguments, as per format

Returns:

  • (nil)

#printerr_literal(message) ⇒ nil

Prints a message using the stderr print handler in the invoking process.

Unlike g_application_command_line_printerr(), message is not
a printf()-style format string. Use this function if message contains text
you don't have control over, that could include printf() escape sequences.

Parameters:

  • message (String) —

    the message

Returns:

  • (nil)

#stdin ⇒ Gio::InputStream

Gets the stdin of the invoking process.

The GInput::Stream can be used to read data passed to the standard
input of the invoking process.
This doesn't work on all platforms. Presently, it is only available
on UNIX when using a D-Bus daemon capable of passing file descriptors.
If stdin is not available then nil will be returned. In the
future, support may be expanded to other platforms.

You must only call this function once per commandline invocation.

Returns: