xref: /dports/x11-fm/caja/caja-1.26.0/libcaja-extension/caja-file-info.c

/*
 *  caja-file-info.c - Information about a file
 *
 *  Copyright (C) 2003 Novell, Inc.
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public
 *  License along with this library; if not, write to the Free
 *  Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */

#include <config.h>
#include "caja-file-info.h"
#include "caja-extension-private.h"

CajaFileInfo *(*caja_file_info_getter) (GFile *location, gboolean create);

/**
 * SECTION:caja-file-info
 * @title: CajaFileInfo
 * @short_description: File interface for caja extensions
 * @include: libcaja-extension/caja-file-info.h
 *
 * #CajaFileInfo provides methods to get and modify information
 * about file objects in the file manager.
 */

/**
 * caja_file_info_list_copy:
 * @files: (element-type CajaFileInfo): the files to copy
 *
 * Returns: (element-type CajaFileInfo) (transfer full): a copy of @files.
 *  Use #caja_file_info_list_free to free the list and unref its contents.
 */
GList *
caja_file_info_list_copy (GList *files)
{
    GList *ret;
    GList *l;

    ret = g_list_copy (files);
    for (l = ret; l != NULL; l = l->next)
    {
        g_object_ref (G_OBJECT (l->data));
    }

    return ret;
}

/**
 * caja_file_info_list_free:
 * @files: (element-type CajaFileInfo): a list created with
 *   #caja_file_info_list_copy
 *
 */
void
caja_file_info_list_free (GList *files)
{
    GList *l;

    for (l = files; l != NULL; l = l->next)
    {
        g_object_unref (G_OBJECT (l->data));
    }

    g_list_free (files);
}

static void
caja_file_info_base_init (gpointer g_class)
{
}

GType
caja_file_info_get_type (void)
{
    static GType type = 0;

    if (!type) {
        const GTypeInfo info = {
            sizeof (CajaFileInfoIface),
            caja_file_info_base_init,
            NULL,
            NULL,
            NULL,
            NULL,
            0,
            0,
            NULL
        };

        type = g_type_register_static (G_TYPE_INTERFACE,
                                       "CajaFileInfo",
                                       &info, 0);
        g_type_interface_add_prerequisite (type, G_TYPE_OBJECT);
    }

    return type;
}

gboolean
caja_file_info_is_gone (CajaFileInfo *file)
{
    g_return_val_if_fail (CAJA_IS_FILE_INFO (file), FALSE);
    g_return_val_if_fail (CAJA_FILE_INFO_GET_IFACE (file)->is_gone != NULL, FALSE);

    return CAJA_FILE_INFO_GET_IFACE (file)->is_gone (file);
}

GFileType
caja_file_info_get_file_type (CajaFileInfo *file)
{
    g_return_val_if_fail (CAJA_IS_FILE_INFO (file), G_FILE_TYPE_UNKNOWN);
    g_return_val_if_fail (CAJA_FILE_INFO_GET_IFACE (file)->get_file_type != NULL, G_FILE_TYPE_UNKNOWN);

    return CAJA_FILE_INFO_GET_IFACE (file)->get_file_type (file);
}

char *
caja_file_info_get_name (CajaFileInfo *file)
{
    g_return_val_if_fail (CAJA_IS_FILE_INFO (file), NULL);
    g_return_val_if_fail (CAJA_FILE_INFO_GET_IFACE (file)->get_name != NULL, NULL);

    return CAJA_FILE_INFO_GET_IFACE (file)->get_name (file);
}

/**
 * caja_file_info_get_location:
 * @file: a #CajaFileInfo
 *
 * Returns: (transfer full): a #GFile for the location of @file
 */
GFile *
caja_file_info_get_location (CajaFileInfo *file)
{
    g_return_val_if_fail (CAJA_IS_FILE_INFO (file), NULL);
    g_return_val_if_fail (CAJA_FILE_INFO_GET_IFACE (file)->get_location != NULL, NULL);

    return CAJA_FILE_INFO_GET_IFACE (file)->get_location (file);
}

char *
caja_file_info_get_uri (CajaFileInfo *file)
{
    g_return_val_if_fail (CAJA_IS_FILE_INFO (file), NULL);
    g_return_val_if_fail (CAJA_FILE_INFO_GET_IFACE (file)->get_uri != NULL, NULL);

    return CAJA_FILE_INFO_GET_IFACE (file)->get_uri (file);
}

char *
caja_file_info_get_activation_uri (CajaFileInfo *file)
{
    g_return_val_if_fail (CAJA_IS_FILE_INFO (file), NULL);
    g_return_val_if_fail (CAJA_FILE_INFO_GET_IFACE (file)->get_activation_uri != NULL, NULL);

    return CAJA_FILE_INFO_GET_IFACE (file)->get_activation_uri (file);
}

/**
 * caja_file_info_get_parent_location:
 * @file: a #CajaFileInfo
 *
 * Returns: (allow-none) (transfer full): a #GFile for the parent location of @file,
 *   or %NULL if @file has no parent
 */
GFile *
caja_file_info_get_parent_location (CajaFileInfo *file)
{
    g_return_val_if_fail (CAJA_IS_FILE_INFO (file), NULL);
    g_return_val_if_fail (CAJA_FILE_INFO_GET_IFACE (file)->get_parent_location != NULL, NULL);

    return CAJA_FILE_INFO_GET_IFACE (file)->get_parent_location (file);
}

char *
caja_file_info_get_parent_uri (CajaFileInfo *file)
{
    g_return_val_if_fail (CAJA_IS_FILE_INFO (file), NULL);
    g_return_val_if_fail (CAJA_FILE_INFO_GET_IFACE (file)->get_parent_uri != NULL, NULL);

    return CAJA_FILE_INFO_GET_IFACE (file)->get_parent_uri (file);
}

/**
 * caja_file_info_get_parent_info:
 * @file: a #CajaFileInfo
 *
 * Returns: (allow-none) (transfer full): a #CajaFileInfo for the parent of @file,
 *   or %NULL if @file has no parent
 */
CajaFileInfo *
caja_file_info_get_parent_info (CajaFileInfo *file)
{
    g_return_val_if_fail (CAJA_IS_FILE_INFO (file), NULL);
    g_return_val_if_fail (CAJA_FILE_INFO_GET_IFACE (file)->get_parent_info != NULL, NULL);

    return CAJA_FILE_INFO_GET_IFACE (file)->get_parent_info (file);
}

/**
 * caja_file_info_get_mount:
 * @file: a #CajaFileInfo
 *
 * Returns: (allow-none) (transfer full): a #GMount for the mount of @file,
 *   or %NULL if @file has no mount
 */
GMount *
caja_file_info_get_mount (CajaFileInfo *file)
{
    g_return_val_if_fail (CAJA_IS_FILE_INFO (file), NULL);
    g_return_val_if_fail (CAJA_FILE_INFO_GET_IFACE (file)->get_mount != NULL, NULL);

    return CAJA_FILE_INFO_GET_IFACE (file)->get_mount (file);
}

char *
caja_file_info_get_uri_scheme (CajaFileInfo *file)
{
    g_return_val_if_fail (CAJA_IS_FILE_INFO (file), NULL);
    g_return_val_if_fail (CAJA_FILE_INFO_GET_IFACE (file)->get_uri_scheme != NULL, NULL);

    return CAJA_FILE_INFO_GET_IFACE (file)->get_uri_scheme (file);
}

char *
caja_file_info_get_mime_type (CajaFileInfo *file)
{
    g_return_val_if_fail (CAJA_IS_FILE_INFO (file), NULL);
    g_return_val_if_fail (CAJA_FILE_INFO_GET_IFACE (file)->get_mime_type != NULL, NULL);

    return CAJA_FILE_INFO_GET_IFACE (file)->get_mime_type (file);
}

gboolean
caja_file_info_is_mime_type (CajaFileInfo *file,
                             const char *mime_type)
{
    g_return_val_if_fail (CAJA_IS_FILE_INFO (file), FALSE);
    g_return_val_if_fail (mime_type != NULL, FALSE);
    g_return_val_if_fail (CAJA_FILE_INFO_GET_IFACE (file)->is_mime_type != NULL, FALSE);

    return CAJA_FILE_INFO_GET_IFACE (file)->is_mime_type (file,
           mime_type);
}

gboolean
caja_file_info_is_directory (CajaFileInfo *file)
{
    g_return_val_if_fail (CAJA_IS_FILE_INFO (file), FALSE);
    g_return_val_if_fail (CAJA_FILE_INFO_GET_IFACE (file)->is_directory != NULL, FALSE);

    return CAJA_FILE_INFO_GET_IFACE (file)->is_directory (file);
}

gboolean
caja_file_info_can_write (CajaFileInfo *file)
{
    g_return_val_if_fail (CAJA_IS_FILE_INFO (file), FALSE);
    g_return_val_if_fail (CAJA_FILE_INFO_GET_IFACE (file)->can_write != NULL, FALSE);

    return CAJA_FILE_INFO_GET_IFACE (file)->can_write (file);
}

void
caja_file_info_add_emblem (CajaFileInfo *file,
                           const char *emblem_name)
{
    g_return_if_fail (CAJA_IS_FILE_INFO (file));
    g_return_if_fail (CAJA_FILE_INFO_GET_IFACE (file)->add_emblem != NULL);

    CAJA_FILE_INFO_GET_IFACE (file)->add_emblem (file, emblem_name);
}

char *
caja_file_info_get_string_attribute (CajaFileInfo *file,
                                     const char *attribute_name)
{
    g_return_val_if_fail (CAJA_IS_FILE_INFO (file), NULL);
    g_return_val_if_fail (CAJA_FILE_INFO_GET_IFACE (file)->get_string_attribute != NULL, NULL);
    g_return_val_if_fail (attribute_name != NULL, NULL);

    return CAJA_FILE_INFO_GET_IFACE (file)->get_string_attribute
           (file, attribute_name);
}

void
caja_file_info_add_string_attribute (CajaFileInfo *file,
                                     const char *attribute_name,
                                     const char *value)
{
    g_return_if_fail (CAJA_IS_FILE_INFO (file));
    g_return_if_fail (CAJA_FILE_INFO_GET_IFACE (file)->add_string_attribute != NULL);
    g_return_if_fail (attribute_name != NULL);
    g_return_if_fail (value != NULL);

    CAJA_FILE_INFO_GET_IFACE (file)->add_string_attribute
        (file, attribute_name, value);
}

void
caja_file_info_invalidate_extension_info (CajaFileInfo *file)
{
    g_return_if_fail (CAJA_IS_FILE_INFO (file));
    g_return_if_fail (CAJA_FILE_INFO_GET_IFACE (file)->invalidate_extension_info != NULL);

    CAJA_FILE_INFO_GET_IFACE (file)->invalidate_extension_info (file);
}

/**
 * caja_file_info_lookup:
 * @location: the location to lookup the file info for
 *
 * Returns: (transfer full): a #CajaFileInfo
 */
CajaFileInfo *
caja_file_info_lookup (GFile *location)
{
    return caja_file_info_getter (location, FALSE);
}

/**
 * caja_file_info_create:
 * @location: the location to create the file info for
 *
 * Returns: (transfer full): a #CajaFileInfo
 */
CajaFileInfo *
caja_file_info_create (GFile *location)
{
    return caja_file_info_getter (location, TRUE);
}

/**
 * caja_file_info_lookup_for_uri:
 * @uri: the URI to lookup the file info for
 *
 * Returns: (transfer full): a #CajaFileInfo
 */
CajaFileInfo *
caja_file_info_lookup_for_uri (const char *uri)
{
    GFile *location;
    CajaFile *file;

    location = g_file_new_for_uri (uri);
    file = caja_file_info_lookup (location);
    g_object_unref (location);

    return file;
}

/**
 * caja_file_info_create_for_uri:
 * @uri: the URI to lookup the file info for
 *
 * Returns: (transfer full): a #CajaFileInfo
 */
CajaFileInfo *
caja_file_info_create_for_uri (const char *uri)
{
    GFile *location;
    CajaFile *file;

    location = g_file_new_for_uri (uri);
    file = caja_file_info_create (location);
    g_object_unref (location);

    return file;
}