diff options
Diffstat (limited to 'libcaja-private/caja-file-private.h')
| -rw-r--r-- | libcaja-private/caja-file-private.h | 316 |
1 files changed, 316 insertions, 0 deletions
diff --git a/libcaja-private/caja-file-private.h b/libcaja-private/caja-file-private.h new file mode 100644 index 00000000..937121bd --- /dev/null +++ b/libcaja-private/caja-file-private.h @@ -0,0 +1,316 @@ +/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- + + caja-file-private.h: + + Copyright (C) 1999, 2000, 2001 Eazel, Inc. + + This program is free software; you can redistribute it and/or + modify it under the terms of the GNU General Public License as + published by the Free Software Foundation; either version 2 of the + License, or (at your option) any later version. + + This program 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 + General Public License for more details. + + You should have received a copy of the GNU General Public + License along with this program; if not, write to the + Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. + + Author: Darin Adler <[email protected]> +*/ + +#ifndef CAJA_FILE_PRIVATE_H +#define CAJA_FILE_PRIVATE_H + +#include <libcaja-private/caja-directory.h> +#include <libcaja-private/caja-file.h> +#include <libcaja-private/caja-monitor.h> +#include <eel/eel-glib-extensions.h> +#include <eel/eel-string.h> + +#define CAJA_FILE_LARGE_TOP_LEFT_TEXT_MAXIMUM_CHARACTERS_PER_LINE 80 +#define CAJA_FILE_LARGE_TOP_LEFT_TEXT_MAXIMUM_LINES 24 +#define CAJA_FILE_LARGE_TOP_LEFT_TEXT_MAXIMUM_BYTES 10000 + +#define CAJA_FILE_TOP_LEFT_TEXT_MAXIMUM_CHARACTERS_PER_LINE 10 +#define CAJA_FILE_TOP_LEFT_TEXT_MAXIMUM_LINES 5 +#define CAJA_FILE_TOP_LEFT_TEXT_MAXIMUM_BYTES 1024 + +#define CAJA_FILE_DEFAULT_ATTRIBUTES \ + "standard::*,access::*,mountable::*,time::*,unix::*,owner::*,selinux::*,thumbnail::*,id::filesystem,trash::orig-path,trash::deletion-date,metadata::*" + +/* These are in the typical sort order. Known things come first, then + * things where we can't know, finally things where we don't yet know. + */ +typedef enum +{ + KNOWN, + UNKNOWABLE, + UNKNOWN +} Knowledge; + +typedef struct +{ + char emblem_keywords[1]; +} CajaFileSortByEmblemCache; + +struct CajaFileDetails +{ + CajaDirectory *directory; + + eel_ref_str name; + + /* File info: */ + GFileType type; + + eel_ref_str display_name; + char *display_name_collation_key; + eel_ref_str edit_name; + + goffset size; /* -1 is unknown */ + + int sort_order; + + guint32 permissions; + int uid; /* -1 is none */ + int gid; /* -1 is none */ + + eel_ref_str owner; + eel_ref_str owner_real; + eel_ref_str group; + + time_t atime; /* 0 is unknown */ + time_t mtime; /* 0 is unknown */ + time_t ctime; /* 0 is unknown */ + + char *symlink_name; + + eel_ref_str mime_type; + + char *selinux_context; + char *description; + + GError *get_info_error; + + guint directory_count; + + guint deep_directory_count; + guint deep_file_count; + guint deep_unreadable_count; + goffset deep_size; + + GIcon *icon; + + char *thumbnail_path; + GdkPixbuf *thumbnail; + time_t thumbnail_mtime; + + GList *mime_list; /* If this is a directory, the list of MIME types in it. */ + char *top_left_text; + + /* Info you might get from a link (.desktop, .directory or caja link) */ + char *custom_icon; + char *activation_uri; + + /* used during DND, for checking whether source and destination are on + * the same file system. + */ + eel_ref_str filesystem_id; + + char *trash_orig_path; + + /* The following is for file operations in progress. Since + * there are normally only a few of these, we can move them to + * a separate hash table or something if required to keep the + * file objects small. + */ + GList *operations_in_progress; + + /* We use this to cache automatic emblems and emblem keywords + to speed up compare_by_emblems. */ + CajaFileSortByEmblemCache *compare_by_emblem_cache; + + /* CajaInfoProviders that need to be run for this file */ + GList *pending_info_providers; + + /* Emblems provided by extensions */ + GList *extension_emblems; + GList *pending_extension_emblems; + + /* Attributes provided by extensions */ + GHashTable *extension_attributes; + GHashTable *pending_extension_attributes; + + GHashTable *metadata; + + /* Mount for mountpoint or the references GMount for a "mountable" */ + GMount *mount; + + /* boolean fields: bitfield to save space, since there can be + many CajaFile objects. */ + + eel_boolean_bit unconfirmed : 1; + eel_boolean_bit is_gone : 1; + /* Set when emitting files_added on the directory to make sure we + add a file, and only once */ + eel_boolean_bit is_added : 1; + /* Set by the CajaDirectory while it's loading the file + * list so the file knows not to do redundant I/O. + */ + eel_boolean_bit loading_directory : 1; + eel_boolean_bit got_file_info : 1; + eel_boolean_bit get_info_failed : 1; + eel_boolean_bit file_info_is_up_to_date : 1; + + eel_boolean_bit got_directory_count : 1; + eel_boolean_bit directory_count_failed : 1; + eel_boolean_bit directory_count_is_up_to_date : 1; + + eel_boolean_bit deep_counts_status : 2; /* CajaRequestStatus */ + /* no deep_counts_are_up_to_date field; since we expose + intermediate values for this attribute, we do actually + forget it rather than invalidating. */ + + eel_boolean_bit got_mime_list : 1; + eel_boolean_bit mime_list_failed : 1; + eel_boolean_bit mime_list_is_up_to_date : 1; + + eel_boolean_bit mount_is_up_to_date : 1; + + eel_boolean_bit got_top_left_text : 1; + eel_boolean_bit got_large_top_left_text : 1; + eel_boolean_bit top_left_text_is_up_to_date : 1; + + eel_boolean_bit got_link_info : 1; + eel_boolean_bit link_info_is_up_to_date : 1; + eel_boolean_bit got_custom_display_name : 1; + eel_boolean_bit got_custom_activation_uri : 1; + + eel_boolean_bit thumbnail_is_up_to_date : 1; + eel_boolean_bit thumbnail_wants_original : 1; + eel_boolean_bit thumbnail_tried_original : 1; + eel_boolean_bit thumbnailing_failed : 1; + + eel_boolean_bit is_thumbnailing : 1; + + /* TRUE if the file is open in a spatial window */ + eel_boolean_bit has_open_window : 1; + + eel_boolean_bit is_launcher : 1; + eel_boolean_bit is_trusted_link : 1; + eel_boolean_bit is_foreign_link : 1; + eel_boolean_bit is_symlink : 1; + eel_boolean_bit is_mountpoint : 1; + eel_boolean_bit is_hidden : 1; + eel_boolean_bit is_backup : 1; + + eel_boolean_bit has_permissions : 1; + + eel_boolean_bit can_read : 1; + eel_boolean_bit can_write : 1; + eel_boolean_bit can_execute : 1; + eel_boolean_bit can_delete : 1; + eel_boolean_bit can_trash : 1; + eel_boolean_bit can_rename : 1; + eel_boolean_bit can_mount : 1; + eel_boolean_bit can_unmount : 1; + eel_boolean_bit can_eject : 1; + eel_boolean_bit can_start : 1; + eel_boolean_bit can_start_degraded : 1; + eel_boolean_bit can_stop : 1; + eel_boolean_bit start_stop_type : 3; /* GDriveStartStopType */ + eel_boolean_bit can_poll_for_media : 1; + eel_boolean_bit is_media_check_automatic : 1; + + eel_boolean_bit filesystem_readonly : 1; + eel_boolean_bit filesystem_use_preview : 2; /* GFilesystemPreviewType */ + eel_boolean_bit filesystem_info_is_up_to_date : 1; + + time_t trash_time; /* 0 is unknown */ +}; + +typedef struct +{ + CajaFile *file; + GCancellable *cancellable; + CajaFileOperationCallback callback; + gpointer callback_data; + gboolean is_rename; + + gpointer data; + GDestroyNotify free_data; +} CajaFileOperation; + + +CajaFile *caja_file_new_from_info (CajaDirectory *directory, + GFileInfo *info); +void caja_file_emit_changed (CajaFile *file); +void caja_file_mark_gone (CajaFile *file); +char * caja_extract_top_left_text (const char *text, + gboolean large, + int length); +void caja_file_set_directory (CajaFile *file, + CajaDirectory *directory); +gboolean caja_file_get_date (CajaFile *file, + CajaDateType date_type, + time_t *date); +void caja_file_updated_deep_count_in_progress (CajaFile *file); + + +void caja_file_clear_info (CajaFile *file); +/* Compare file's state with a fresh file info struct, return FALSE if + * no change, update file and return TRUE if the file info contains + * new state. */ +gboolean caja_file_update_info (CajaFile *file, + GFileInfo *info); +gboolean caja_file_update_name (CajaFile *file, + const char *name); +gboolean caja_file_update_metadata_from_info (CajaFile *file, + GFileInfo *info); + +gboolean caja_file_update_name_and_directory (CajaFile *file, + const char *name, + CajaDirectory *directory); + +gboolean caja_file_set_display_name (CajaFile *file, + const char *display_name, + const char *edit_name, + gboolean custom); +void caja_file_set_mount (CajaFile *file, + GMount *mount); + +/* Return true if the top lefts of files in this directory should be + * fetched, according to the preference settings. + */ +gboolean caja_file_should_get_top_left_text (CajaFile *file); + +/* Mark specified attributes for this file out of date without canceling current + * I/O or kicking off new I/O. + */ +void caja_file_invalidate_attributes_internal (CajaFile *file, + CajaFileAttributes file_attributes); +CajaFileAttributes caja_file_get_all_attributes (void); +gboolean caja_file_is_self_owned (CajaFile *file); +void caja_file_invalidate_count_and_mime_list (CajaFile *file); +gboolean caja_file_rename_in_progress (CajaFile *file); +void caja_file_invalidate_extension_info_internal (CajaFile *file); +void caja_file_info_providers_done (CajaFile *file); + + +/* Thumbnailing: */ +void caja_file_set_is_thumbnailing (CajaFile *file, + gboolean is_thumbnailing); + +CajaFileOperation *caja_file_operation_new (CajaFile *file, + CajaFileOperationCallback callback, + gpointer callback_data); +void caja_file_operation_free (CajaFileOperation *op); +void caja_file_operation_complete (CajaFileOperation *op, + GFile *result_location, + GError *error); +void caja_file_operation_cancel (CajaFileOperation *op); + +#endif |