autoar_compressor_quark ()

GQuark
autoar_compressor_quark (void);

Gets the AutoarCompressor Error Quark.

autoar_compressor_new ()

AutoarCompressor *
autoar_compressor_new (GList *source_files,
                       GFile *output_file,
                       AutoarFormat format,
                       AutoarFilter filter,
                       gboolean create_top_level_directory);

Create a new AutoarCompressor object.

autoar_compressor_start ()

void
autoar_compressor_start (AutoarCompressor *self,
                         GCancellable *cancellable);

Runs the archive creating work. All callbacks will be called in the same thread as the caller of this functions.

autoar_compressor_start_async ()

void
autoar_compressor_start_async (AutoarCompressor *self,
                               GCancellable *cancellable);

Asynchronously runs the archive creating work. You should connect to “cancelled”, “error”, and “completed” signal to get notification when the work is terminated. All callbacks will be called in the main thread, so you can safely manipulate GTK+ widgets in the callbacks.

autoar_compressor_get_source_files ()

GList *
autoar_compressor_get_source_files (AutoarCompressor *self);

Gets the list of source files.

autoar_compressor_get_output_file ()

GFile *
autoar_compressor_get_output_file (AutoarCompressor *self);

If “output_is_dest” is FALSE, gets the directory which contains the new archive. Otherwise, gets the the new archive. See autoar_compressor_set_output_is_dest().

autoar_compressor_get_format ()

AutoarFormat
autoar_compressor_get_format (AutoarCompressor *self);

Gets the compression format

autoar_compressor_get_filter ()

AutoarFilter
autoar_compressor_get_filter (AutoarCompressor *self);

Gets the compression filter

autoar_compressor_get_create_top_level_directory ()

gboolean
autoar_compressor_get_create_top_level_directory
                               (AutoarCompressor *self);

Gets whether a top level directory will be created in the new archive.

autoar_compressor_get_size ()

guint64
autoar_compressor_get_size (AutoarCompressor *self);

Gets the size in bytes will be read when the operation is completed. This value is currently unset, so calling this function is useless.

autoar_compressor_get_completed_size ()

guint64
autoar_compressor_get_completed_size (AutoarCompressor *self);

Gets the size in bytes has been read from the source files and directories.

autoar_compressor_get_files ()

guint
autoar_compressor_get_files (AutoarCompressor *self);

Gets the number of files will be read when the operation is completed. This value is currently unset, so calling this function is useless.

autoar_compressor_get_completed_files ()

guint
autoar_compressor_get_completed_files (AutoarCompressor *self);

Gets the number of files has been read

autoar_compressor_get_output_is_dest ()

gboolean
autoar_compressor_get_output_is_dest (AutoarCompressor *self);

See autoar_compressor_set_output_is_dest().

autoar_compressor_get_notify_interval ()

gint64
autoar_compressor_get_notify_interval (AutoarCompressor *self);

See autoar_compressor_set_notify_interval().

autoar_compressor_set_output_is_dest ()

void
autoar_compressor_set_output_is_dest (AutoarCompressor *self,
                                      gboolean output_is_dest);

By default “output-is-dest” is set to FALSE, which means the new archive will be created as a regular file under “output” directory. The name of the new archive will be automatically generated and you will be notified via “decide-dest” when the name is decided. If you have already decided the location of the new archive, and you do not want AutoarCompressor to decide it for you, you can set “output-is-dest” to TRUE. AutoarCompressor will use “output” as the location of the new archive, and it will neither check whether the file exists nor create the necessary directories for you. This function should only be called before calling autoar_compressor_start() or autoar_compressor_start_async().

autoar_compressor_set_notify_interval ()

void
autoar_compressor_set_notify_interval (AutoarCompressor *self,
                                       gint64 notify_interval);

Sets the minimal interval between emission of “progress” signal. This prevent too frequent signal emission, which may cause performance impact. If you do not want this feature, you can set the interval to 0, so you will receive every progress update.

AUTOAR_TYPE_COMPRESSOR

#define AUTOAR_TYPE_COMPRESSOR autoar_compressor_get_type ()

AUTOAR_COMPRESSOR_ERROR

#define AUTOAR_COMPRESSOR_ERROR autoar_compressor_quark()

Error domain for AutoarCompressor. Not all error occurs in AutoarCompressor uses this domain. It is only used for error occurs in AutoarCompressor itself. See “error” signal for more information.

AutoarCompressor

typedef struct _AutoarCompressor AutoarCompressor;

The “completed-files” property

  “completed-files”          guint

Number of files has been read.

Flags: Read

Default value: 0

The “completed-size” property

  “completed-size”           guint64

Bytes has read from disk.

Flags: Read

Default value: 0

The “create-top-level-directory” property

  “create-top-level-directory” gboolean

Whether to create a top level directory.

Flags: Read / Write / Construct

Default value: FALSE

The “files” property

  “files”                    guint

Number of files will be compressed.

Flags: Read

Default value: 0

The “filter” property

  “filter”                   AutoarFilter

The compression filter that will be used.

Flags: Read / Write / Construct Only

Default value: AUTOAR_FILTER_NONE

The “format” property

  “format”                   AutoarFormat

The compression format that will be used.

Flags: Read / Write / Construct Only

Default value: AUTOAR_FORMAT_ZIP

The “notify-interval” property

  “notify-interval”          gint64

Minimal time interval between progress signal.

Flags: Read / Write / Construct

Allowed values: >= 0

Default value: 100000

The “output-file” property

  “output-file”              GFile *

Output directory (GFile) of created archive.

Flags: Read / Write / Construct Only

The “output-is-dest” property

  “output-is-dest”           gboolean

Whether output file is used as destination.

Flags: Read / Write / Construct

Default value: FALSE

The “size” property

  “size”                     guint64

Total bytes will be read from disk.

Flags: Read

Default value: 0

The “source-files” property

  “source-files”             gpointer

The list of GFiles to be archived.

Flags: Read / Write / Construct Only

The “cancelled” signal

void
user_function (AutoarCompressor *self,
               gpointer          user_data)

This signal is emitted after archive creating job is cancelled by the GCancellable.

Flags: Run Last

The “completed” signal

void
user_function (AutoarCompressor *self,
               gpointer          user_data)

This signal is emitted after the archive creating job is successfully completed.

Flags: Run Last

The “decide-dest” signal

void
user_function (AutoarCompressor *self,
               GFile            *destination,
               gpointer          user_data)

This signal is emitted when the location of the new archive is determined.

Flags: Run Last

The “error” signal

void
user_function (AutoarCompressor *self,
               GError           *error,
               gpointer          user_data)

This signal is emitted when error occurs and all jobs should be terminated. Possible error domains are AUTOAR_COMPRESSOR_ERROR, G_IO_ERROR, and AUTOAR_LIBARCHIVE_ERROR, which represent error occurs in AutoarCompressor, GIO, and libarchive, respectively. The GError is owned by AutoarCompressor and should not be freed.

Flags: Run Last

The “progress” signal

void
user_function (AutoarCompressor *self,
               guint64           completed_size,
               guint             completed_files,
               gpointer          user_data)

This signal is used to report progress of creating archives. The value of completed_size and completed_files are the same as the “completed_size” and “completed_files” properties, respectively.

Flags: Run Last