medit/moo/mooutils/moofileview/moofile.h

208 lines
7.6 KiB
C

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4; coding: utf-8 -*-
* moofile.h
*
* Copyright (C) 2004-2005 by Yevgen Muntyan <muntyan@math.tamu.edu>
*
* 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.
*
* See COPYING file that comes with this distribution.
*/
#ifndef __MOO_FILE_H__
#define __MOO_FILE_H__
#include <gtk/gtkwidget.h>
#ifdef MOO_FILE_SYSTEM_COMPILATION
#include <sys/stat.h>
#endif
G_BEGIN_DECLS
#define MOO_FILE_ERROR (moo_file_error_quark ())
typedef enum
{
MOO_FILE_ERROR_NONEXISTENT,
MOO_FILE_ERROR_NOT_FOLDER,
MOO_FILE_ERROR_BAD_FILENAME,
MOO_FILE_ERROR_FAILED,
MOO_FILE_ERROR_ALREADY_EXISTS,
MOO_FILE_ERROR_ACCESS_DENIED,
MOO_FILE_ERROR_READONLY,
MOO_FILE_ERROR_DIFFERENT_FS,
MOO_FILE_ERROR_NOT_IMPLEMENTED
} MooFileError;
GQuark moo_file_error_quark (void);
#define MOO_TYPE_FILE (moo_file_get_type ())
#define MOO_TYPE_FILE_INFO (moo_file_info_get_type ())
#define MOO_TYPE_FILE_FLAGS (moo_file_flags_get_type ())
#define MOO_TYPE_FOLDER (moo_folder_get_type ())
#define MOO_FOLDER(object) (G_TYPE_CHECK_INSTANCE_CAST ((object), MOO_TYPE_FOLDER, MooFolder))
#define MOO_FOLDER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), MOO_TYPE_FOLDER, MooFolderClass))
#define MOO_IS_FOLDER(object) (G_TYPE_CHECK_INSTANCE_TYPE ((object), MOO_TYPE_FOLDER))
#define MOO_IS_FOLDER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), MOO_TYPE_FOLDER))
#define MOO_FOLDER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), MOO_TYPE_FOLDER, MooFolderClass))
#ifdef __WIN32__
/* FILETIME */
typedef guint64 MooFileTime;
#else
/* time_t */
typedef GTime MooFileTime;
#endif
typedef gint64 MooFileSize;
typedef struct _MooFile MooFile;
typedef struct _MooFolder MooFolder;
typedef struct _MooFolderPrivate MooFolderPrivate;
typedef struct _MooFolderClass MooFolderClass;
typedef struct _MooFileSystem MooFileSystem;
typedef enum {
MOO_FILE_INFO_EXISTS = 1 << 0,
MOO_FILE_INFO_IS_DIR = 1 << 1,
MOO_FILE_INFO_IS_HIDDEN = 1 << 2,
MOO_FILE_INFO_IS_LINK = 1 << 3,
MOO_FILE_INFO_IS_BLOCK_DEV = 1 << 4,
MOO_FILE_INFO_IS_CHAR_DEV = 1 << 5,
MOO_FILE_INFO_IS_FIFO = 1 << 6,
MOO_FILE_INFO_IS_SOCKET = 1 << 7,
MOO_FILE_INFO_IS_LOCKED = 1 << 8 /* no read premissions */
} MooFileInfo;
#define MOO_FILE_INFO_IS_SPECIAL (MOO_FILE_INFO_IS_LINK | MOO_FILE_INFO_IS_BLOCK_DEV | \
MOO_FILE_INFO_IS_CHAR_DEV | MOO_FILE_INFO_IS_FIFO | \
MOO_FILE_INFO_IS_SOCKET)
#define MOO_FILE_EXISTS(file) (moo_file_test (file, MOO_FILE_INFO_EXISTS))
#define MOO_FILE_IS_DIR(file) (moo_file_test (file, MOO_FILE_INFO_IS_DIR))
#define MOO_FILE_IS_SPECIAL(file) (moo_file_test (file, MOO_FILE_INFO_IS_SPECIAL))
#define MOO_FILE_IS_LINK(file) (moo_file_test (file, MOO_FILE_INFO_IS_LINK))
#define MOO_FILE_IS_BROKEN_LINK(file) (!MOO_FILE_EXISTS (file) && MOO_FILE_IS_LINK (file))
#define MOO_FILE_IS_LOCKED(file) (moo_file_test (file, MOO_FILE_INFO_IS_LOCKED))
#define MOO_FILE_IS_HIDDEN(file) (moo_file_test (file, MOO_FILE_INFO_IS_HIDDEN))
/* should be ordered TODO why? */
typedef enum {
MOO_FILE_HAS_STAT = 1 << 1,
MOO_FILE_HAS_MIME_TYPE = 1 << 2,
MOO_FILE_HAS_ICON = 1 << 3,
MOO_FILE_ALL_FLAGS = (1 << 4) - 1
} MooFileFlags;
struct _MooFolder
{
GObject parent;
MooFolderPrivate *priv;
};
struct _MooFolderClass
{
GObjectClass parent_class;
void (*deleted) (MooFolder *folder);
void (*files_added) (MooFolder *folder,
GSList *files);
void (*files_changed) (MooFolder *folder,
GSList *files);
void (*files_removed) (MooFolder *folder,
GSList *files);
};
#ifdef MOO_FILE_SYSTEM_COMPILATION
struct _MooFile
{
char *name;
char *link_target;
char *display_name; /* normalized */
char *case_display_name;
char *collation_key;
MooFileInfo info;
MooFileFlags flags;
guint8 icon;
const char *mime_type;
int ref_count;
/* TODO: who needs whole structure? */
struct stat statbuf;
};
#endif /* MOO_FILE_SYSTEM_COMPILATION */
GType moo_file_get_type (void) G_GNUC_CONST;
GType moo_file_flags_get_type (void) G_GNUC_CONST;
GType moo_file_info_get_type (void) G_GNUC_CONST;
GType moo_folder_get_type (void) G_GNUC_CONST;
MooFile *moo_file_ref (MooFile *file);
void moo_file_unref (MooFile *file);
MooFileTime moo_file_get_mtime (const MooFile *file);
MooFileSize moo_file_get_size (const MooFile *file);
MooFileInfo moo_file_get_info (const MooFile *file);
gboolean moo_file_test (const MooFile *file,
MooFileInfo test);
const char *moo_file_name (const MooFile *file);
const char *moo_file_get_mime_type (const MooFile *file);
/* returned pixbuf is owned by icon cache */
GdkPixbuf *moo_file_get_icon (const MooFile *file,
GtkWidget *widget,
GtkIconSize size);
GdkPixbuf *moo_get_icon_for_path (const char *path,
GtkWidget *widget,
GtkIconSize size);
const char *moo_file_display_name (const MooFile *file);
const char *moo_file_collation_key (const MooFile *file);
const char *moo_file_case_display_name (const MooFile *file);
#ifndef __WIN32__
gconstpointer moo_file_get_stat (const MooFile *file);
const char *moo_file_link_get_target (const MooFile *file);
#endif
const char *moo_folder_get_path (MooFolder *folder);
/* list should be freed and elements unref'ed */
GSList *moo_folder_list_files (MooFolder *folder);
MooFile *moo_folder_get_file (MooFolder *folder,
const char *basename);
char *moo_folder_get_file_path (MooFolder *folder,
MooFile *file);
char *moo_folder_get_file_uri (MooFolder *folder,
MooFile *file);
/* result should be unref'ed */
MooFolder *moo_folder_get_parent (MooFolder *folder,
MooFileFlags wanted);
char *moo_folder_get_parent_path (MooFolder *folder);
char **moo_folder_get_file_info (MooFolder *folder,
MooFile *file);
#ifdef MOO_FILE_SYSTEM_COMPILATION
MooFolder *moo_folder_new (MooFileSystem *fs,
const char *path,
MooFileFlags wanted,
GError **error);
void moo_folder_set_wanted (MooFolder *folder,
MooFileFlags wanted,
gboolean bit_now);
#endif /* MOO_FILE_SYSTEM_COMPILATION */
G_END_DECLS
#endif /* __MOO_FILE_H__ */