Blame gio/gfileicon.c

Packit ae235b
/* GIO - GLib Input, Output and Streaming Library
Packit ae235b
 * 
Packit ae235b
 * Copyright (C) 2006-2007 Red Hat, Inc.
Packit ae235b
 *
Packit ae235b
 * This library is free software; you can redistribute it and/or
Packit ae235b
 * modify it under the terms of the GNU Lesser General Public
Packit ae235b
 * License as published by the Free Software Foundation; either
Packit ae235b
 * version 2.1 of the License, or (at your option) any later version.
Packit ae235b
 *
Packit ae235b
 * This library is distributed in the hope that it will be useful,
Packit ae235b
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit ae235b
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit ae235b
 * Lesser General Public License for more details.
Packit ae235b
 *
Packit ae235b
 * You should have received a copy of the GNU Lesser General
Packit ae235b
 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
Packit ae235b
 *
Packit ae235b
 * Author: Alexander Larsson <alexl@redhat.com>
Packit ae235b
 */
Packit ae235b
Packit ae235b
#include "config.h"
Packit ae235b
Packit ae235b
#include "gfileicon.h"
Packit ae235b
#include "gfile.h"
Packit ae235b
#include "gicon.h"
Packit ae235b
#include "glibintl.h"
Packit ae235b
#include "gloadableicon.h"
Packit ae235b
#include "ginputstream.h"
Packit ae235b
#include "gtask.h"
Packit ae235b
#include "gioerror.h"
Packit ae235b
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * SECTION:gfileicon
Packit ae235b
 * @short_description: Icons pointing to an image file
Packit ae235b
 * @include: gio/gio.h
Packit ae235b
 * @see_also: #GIcon, #GLoadableIcon
Packit ae235b
 * 
Packit ae235b
 * #GFileIcon specifies an icon by pointing to an image file
Packit ae235b
 * to be used as icon.
Packit ae235b
 * 
Packit ae235b
 **/
Packit ae235b
Packit ae235b
static void g_file_icon_icon_iface_init          (GIconIface          *iface);
Packit ae235b
static void g_file_icon_loadable_icon_iface_init (GLoadableIconIface  *iface);
Packit ae235b
static void g_file_icon_load_async               (GLoadableIcon       *icon,
Packit ae235b
						  int                  size,
Packit ae235b
						  GCancellable        *cancellable,
Packit ae235b
						  GAsyncReadyCallback  callback,
Packit ae235b
						  gpointer             user_data);
Packit ae235b
Packit ae235b
struct _GFileIcon
Packit ae235b
{
Packit ae235b
  GObject parent_instance;
Packit ae235b
Packit ae235b
  GFile *file;
Packit ae235b
};
Packit ae235b
Packit ae235b
struct _GFileIconClass
Packit ae235b
{
Packit ae235b
  GObjectClass parent_class;
Packit ae235b
};
Packit ae235b
Packit ae235b
enum
Packit ae235b
{
Packit ae235b
  PROP_0,
Packit ae235b
  PROP_FILE
Packit ae235b
};
Packit ae235b
Packit ae235b
G_DEFINE_TYPE_WITH_CODE (GFileIcon, g_file_icon, G_TYPE_OBJECT,
Packit ae235b
                         G_IMPLEMENT_INTERFACE (G_TYPE_ICON,
Packit ae235b
                                                g_file_icon_icon_iface_init)
Packit ae235b
                         G_IMPLEMENT_INTERFACE (G_TYPE_LOADABLE_ICON,
Packit ae235b
                                                g_file_icon_loadable_icon_iface_init))
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_file_icon_get_property (GObject    *object,
Packit ae235b
                          guint       prop_id,
Packit ae235b
                          GValue     *value,
Packit ae235b
                          GParamSpec *pspec)
Packit ae235b
{
Packit ae235b
  GFileIcon *icon = G_FILE_ICON (object);
Packit ae235b
Packit ae235b
  switch (prop_id)
Packit ae235b
    {
Packit ae235b
      case PROP_FILE:
Packit ae235b
        g_value_set_object (value, icon->file);
Packit ae235b
        break;
Packit ae235b
Packit ae235b
      default:
Packit ae235b
        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_file_icon_set_property (GObject      *object,
Packit ae235b
                          guint         prop_id,
Packit ae235b
                          const GValue *value,
Packit ae235b
                          GParamSpec   *pspec)
Packit ae235b
{
Packit ae235b
  GFileIcon *icon = G_FILE_ICON (object);
Packit ae235b
Packit ae235b
  switch (prop_id)
Packit ae235b
    {
Packit ae235b
      case PROP_FILE:
Packit ae235b
        icon->file = G_FILE (g_value_dup_object (value));
Packit ae235b
        break;
Packit ae235b
Packit ae235b
      default:
Packit ae235b
        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
Packit ae235b
    }
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_file_icon_finalize (GObject *object)
Packit ae235b
{
Packit ae235b
  GFileIcon *icon;
Packit ae235b
Packit ae235b
  icon = G_FILE_ICON (object);
Packit ae235b
Packit ae235b
  if (icon->file)
Packit ae235b
    g_object_unref (icon->file);
Packit ae235b
Packit ae235b
  G_OBJECT_CLASS (g_file_icon_parent_class)->finalize (object);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_file_icon_class_init (GFileIconClass *klass)
Packit ae235b
{
Packit ae235b
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
Packit ae235b
  
Packit ae235b
  gobject_class->get_property = g_file_icon_get_property;
Packit ae235b
  gobject_class->set_property = g_file_icon_set_property;
Packit ae235b
  gobject_class->finalize = g_file_icon_finalize;
Packit ae235b
Packit ae235b
  /**
Packit ae235b
   * GFileIcon:file:
Packit ae235b
   *
Packit ae235b
   * The file containing the icon.
Packit ae235b
   */
Packit ae235b
  g_object_class_install_property (gobject_class, PROP_FILE,
Packit ae235b
                                   g_param_spec_object ("file",
Packit ae235b
                                                        P_("file"),
Packit ae235b
                                                        P_("The file containing the icon"),
Packit ae235b
                                                        G_TYPE_FILE,
Packit ae235b
                                                        G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_BLURB | G_PARAM_STATIC_NICK));
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_file_icon_init (GFileIcon *file)
Packit ae235b
{
Packit ae235b
}
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * g_file_icon_new:
Packit ae235b
 * @file: a #GFile.
Packit ae235b
 * 
Packit ae235b
 * Creates a new icon for a file.
Packit ae235b
 * 
Packit ae235b
 * Returns: (transfer full) (type GFileIcon): a #GIcon for the given
Packit ae235b
 *   @file, or %NULL on error.
Packit ae235b
 **/
Packit ae235b
GIcon *
Packit ae235b
g_file_icon_new (GFile *file)
Packit ae235b
{
Packit ae235b
  g_return_val_if_fail (G_IS_FILE (file), NULL);
Packit ae235b
Packit ae235b
  return G_ICON (g_object_new (G_TYPE_FILE_ICON, "file", file, NULL));
Packit ae235b
}
Packit ae235b
Packit ae235b
/**
Packit ae235b
 * g_file_icon_get_file:
Packit ae235b
 * @icon: a #GIcon.
Packit ae235b
 * 
Packit ae235b
 * Gets the #GFile associated with the given @icon.
Packit ae235b
 * 
Packit ae235b
 * Returns: (transfer none): a #GFile, or %NULL.
Packit ae235b
 **/
Packit ae235b
GFile *
Packit ae235b
g_file_icon_get_file (GFileIcon *icon)
Packit ae235b
{
Packit ae235b
  g_return_val_if_fail (G_IS_FILE_ICON (icon), NULL);
Packit ae235b
Packit ae235b
  return icon->file;
Packit ae235b
}
Packit ae235b
Packit ae235b
static guint
Packit ae235b
g_file_icon_hash (GIcon *icon)
Packit ae235b
{
Packit ae235b
  GFileIcon *file_icon = G_FILE_ICON (icon);
Packit ae235b
Packit ae235b
  return g_file_hash (file_icon->file);
Packit ae235b
}
Packit ae235b
Packit ae235b
static gboolean
Packit ae235b
g_file_icon_equal (GIcon *icon1,
Packit ae235b
		   GIcon *icon2)
Packit ae235b
{
Packit ae235b
  GFileIcon *file1 = G_FILE_ICON (icon1);
Packit ae235b
  GFileIcon *file2 = G_FILE_ICON (icon2);
Packit ae235b
  
Packit ae235b
  return g_file_equal (file1->file, file2->file);
Packit ae235b
}
Packit ae235b
Packit ae235b
static gboolean
Packit ae235b
g_file_icon_to_tokens (GIcon *icon,
Packit ae235b
		       GPtrArray *tokens,
Packit ae235b
                       gint  *out_version)
Packit ae235b
{
Packit ae235b
  GFileIcon *file_icon = G_FILE_ICON (icon);
Packit ae235b
Packit ae235b
  g_return_val_if_fail (out_version != NULL, FALSE);
Packit ae235b
Packit ae235b
  *out_version = 0;
Packit ae235b
Packit ae235b
  g_ptr_array_add (tokens, g_file_get_uri (file_icon->file));
Packit ae235b
  return TRUE;
Packit ae235b
}
Packit ae235b
Packit ae235b
static GIcon *
Packit ae235b
g_file_icon_from_tokens (gchar  **tokens,
Packit ae235b
                         gint     num_tokens,
Packit ae235b
                         gint     version,
Packit ae235b
                         GError **error)
Packit ae235b
{
Packit ae235b
  GIcon *icon;
Packit ae235b
  GFile *file;
Packit ae235b
Packit ae235b
  icon = NULL;
Packit ae235b
Packit ae235b
  if (version != 0)
Packit ae235b
    {
Packit ae235b
      g_set_error (error,
Packit ae235b
                   G_IO_ERROR,
Packit ae235b
                   G_IO_ERROR_INVALID_ARGUMENT,
Packit ae235b
                   _("Can’t handle version %d of GFileIcon encoding"),
Packit ae235b
                   version);
Packit ae235b
      goto out;
Packit ae235b
    }
Packit ae235b
Packit ae235b
  if (num_tokens != 1)
Packit ae235b
    {
Packit ae235b
      g_set_error_literal (error,
Packit ae235b
                           G_IO_ERROR,
Packit ae235b
                           G_IO_ERROR_INVALID_ARGUMENT,
Packit ae235b
                           _("Malformed input data for GFileIcon"));
Packit ae235b
      goto out;
Packit ae235b
    }
Packit ae235b
Packit ae235b
  file = g_file_new_for_uri (tokens[0]);
Packit ae235b
  icon = g_file_icon_new (file);
Packit ae235b
  g_object_unref (file);
Packit ae235b
Packit ae235b
 out:
Packit ae235b
  return icon;
Packit ae235b
}
Packit ae235b
Packit ae235b
static GVariant *
Packit ae235b
g_file_icon_serialize (GIcon *icon)
Packit ae235b
{
Packit ae235b
  GFileIcon *file_icon = G_FILE_ICON (icon);
Packit ae235b
Packit ae235b
  return g_variant_new ("(sv)", "file", g_variant_new_take_string (g_file_get_uri (file_icon->file)));
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_file_icon_icon_iface_init (GIconIface *iface)
Packit ae235b
{
Packit ae235b
  iface->hash = g_file_icon_hash;
Packit ae235b
  iface->equal = g_file_icon_equal;
Packit ae235b
  iface->to_tokens = g_file_icon_to_tokens;
Packit ae235b
  iface->from_tokens = g_file_icon_from_tokens;
Packit ae235b
  iface->serialize = g_file_icon_serialize;
Packit ae235b
}
Packit ae235b
Packit ae235b
Packit ae235b
static GInputStream *
Packit ae235b
g_file_icon_load (GLoadableIcon  *icon,
Packit ae235b
		  int            size,
Packit ae235b
		  char          **type,
Packit ae235b
		  GCancellable   *cancellable,
Packit ae235b
		  GError        **error)
Packit ae235b
{
Packit ae235b
  GFileInputStream *stream;
Packit ae235b
  GFileIcon *file_icon = G_FILE_ICON (icon);
Packit ae235b
Packit ae235b
  stream = g_file_read (file_icon->file,
Packit ae235b
			cancellable,
Packit ae235b
			error);
Packit ae235b
Packit ae235b
  if (stream && type)
Packit ae235b
    *type = NULL;
Packit ae235b
  
Packit ae235b
  return G_INPUT_STREAM (stream);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
load_async_callback (GObject      *source_object,
Packit ae235b
		     GAsyncResult *res,
Packit ae235b
		     gpointer      user_data)
Packit ae235b
{
Packit ae235b
  GFileInputStream *stream;
Packit ae235b
  GError *error = NULL;
Packit ae235b
  GTask *task = user_data;
Packit ae235b
Packit ae235b
  stream = g_file_read_finish (G_FILE (source_object), res, &error);
Packit ae235b
  if (stream == NULL)
Packit ae235b
    g_task_return_error (task, error);
Packit ae235b
  else
Packit ae235b
    g_task_return_pointer (task, stream, g_object_unref);
Packit ae235b
  g_object_unref (task);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_file_icon_load_async (GLoadableIcon       *icon,
Packit ae235b
                        int                  size,
Packit ae235b
                        GCancellable        *cancellable,
Packit ae235b
                        GAsyncReadyCallback  callback,
Packit ae235b
                        gpointer             user_data)
Packit ae235b
{
Packit ae235b
  GFileIcon *file_icon = G_FILE_ICON (icon);
Packit ae235b
  GTask *task;
Packit ae235b
Packit ae235b
  task = g_task_new (icon, cancellable, callback, user_data);
Packit ae235b
  g_task_set_source_tag (task, g_file_icon_load_async);
Packit ae235b
  
Packit ae235b
  g_file_read_async (file_icon->file, 0,
Packit ae235b
                     cancellable,
Packit ae235b
                     load_async_callback, task);
Packit ae235b
}
Packit ae235b
Packit ae235b
static GInputStream *
Packit ae235b
g_file_icon_load_finish (GLoadableIcon  *icon,
Packit ae235b
			 GAsyncResult   *res,
Packit ae235b
			 char          **type,
Packit ae235b
			 GError        **error)
Packit ae235b
{
Packit ae235b
  g_return_val_if_fail (g_task_is_valid (res, icon), NULL);
Packit ae235b
Packit ae235b
  if (type)
Packit ae235b
    *type = NULL;
Packit ae235b
  
Packit ae235b
  return g_task_propagate_pointer (G_TASK (res), error);
Packit ae235b
}
Packit ae235b
Packit ae235b
static void
Packit ae235b
g_file_icon_loadable_icon_iface_init (GLoadableIconIface *iface)
Packit ae235b
{
Packit ae235b
  iface->load = g_file_icon_load;
Packit ae235b
  iface->load_async = g_file_icon_load_async;
Packit ae235b
  iface->load_finish = g_file_icon_load_finish;
Packit ae235b
}