Blame gio/gfileicon.c

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