GOffice Reference Manual: File utilities

File utilities

Functions

char *	go_basename_from_uri ()
char *	go_dirname_from_uri ()
gint	go_file_access ()
GsfOutput *	go_file_create ()
time_t	go_file_get_date_accessed ()
time_t	go_file_get_date_changed ()
time_t	go_file_get_date_modified ()
gchar *	go_file_get_group_name ()
gchar *	go_file_get_owner_name ()
GsfInput *	go_file_open ()
GSList *	go_file_split_urls ()
char *	go_filename_from_uri ()
char *	go_filename_simplify ()
char *	go_filename_to_uri ()
GOFilePermissions *	go_get_file_permissions ()
gchar *	go_get_mime_type ()
gchar *	go_get_mime_type_for_data ()
gchar *	go_mime_type_get_description ()
void	go_set_file_permissions ()
char *	go_shell_arg_to_uri ()
gchar const **	go_shell_argv_to_glib_encoding ()
void	go_shell_argv_to_glib_encoding_free ()

Types and Values

#define	GO_F_OK
enum	GODotDot
struct	GOFilePermissions
#define	GO_R_OK
#define	GO_W_OK
#define	GO_X_OK

Object Hierarchy

    GBoxed
    ╰── GOFilePermissions

Description

Functions

go_basename_from_uri ()

char *
go_basename_from_uri (const char *uri);

Decode the final path component. Returns as UTF-8 encoded suitable for display.

Parameters

uri

The uri

Returns

a string that the caller is responsible for freeing.

go_dirname_from_uri ()

char *
go_dirname_from_uri (const char *uri,
                     gboolean brief);

Decode the all but the final path component. Returns as UTF-8 encoded suitable for display.

Parameters

uri	target
brief	if TRUE, hide "file://" if present.

Returns

dirname which the caller is responsible for freeing.

go_file_access ()

gint
go_file_access (char const *uri,
                gint mode);

Returns

go_file_create ()

GsfOutput *
go_file_create (char const *uri,
                GError **err);

Creates a file or return an error. If the file already exists, it is replaced.

Parameters

uri	target uri
err	GError

Returns

non-NULL on success.

[transfer full]

go_file_get_date_accessed ()

time_t
go_file_get_date_accessed (char const *uri);

Returns

go_file_get_date_changed ()

time_t
go_file_get_date_changed (char const *uri);

Returns

go_file_get_date_modified ()

time_t
go_file_get_date_modified (char const *uri);

Returns

go_file_get_group_name ()

gchar *
go_file_get_group_name (char const *uri);

Returns

go_file_get_owner_name ()

gchar *
go_file_get_owner_name (char const *uri);

Returns

go_file_open ()

GsfInput *
go_file_open (char const *uri,
              GError **err);

Try all available methods to open a file or return an error

Parameters

uri	target uri
err	GError

Returns

non-NULL on success.

[transfer full]

go_file_split_urls ()

GSList *
go_file_split_urls (char const *data);

Splits the chain into a list of URIs. Lines starting with '#' are ignored.

Parameters

data

a string filled with a list of URIs separated by new lines.

Returns

the URIs list.

[element-type char][transfer full]

go_filename_from_uri ()

char *
go_filename_from_uri (const char *uri);

Returns

go_filename_simplify ()

char *
go_filename_simplify (const char *filename,
                      GODotDot dotdot,
                      gboolean make_absolute);

Returns

go_filename_to_uri ()

char *
go_filename_to_uri (const char *filename);

Returns

go_get_file_permissions ()

GOFilePermissions *
go_get_file_permissions (char const *uri);

Returns

go_get_mime_type ()

gchar *
go_get_mime_type (gchar const *uri);

Parameters

uri

the uri.

Returns

the mime type for the file as a newly allocated string. Needs to be freed with g_free().

go_get_mime_type_for_data ()

gchar *
go_get_mime_type_for_data (gconstpointer data,
                           int data_size);

Parameters

data	the data.
data_size	the data size

Returns

the mime type for the data as a newly allocated string. Needs to be freed with g_free().

go_mime_type_get_description ()

gchar *
go_mime_type_get_description (gchar const *mime_type);

Parameters

mime_type

the mime type to describe.

Returns

the description for the mime type as a newly allocated string. Needs to be freed with g_free(). If the description is not found, the mime type itself will be returned.

go_set_file_permissions ()

void
go_set_file_permissions (char const *uri,
                         GOFilePermissions *file_permissions);

go_shell_arg_to_uri ()

char *
go_shell_arg_to_uri (const char *arg);

Returns

go_shell_argv_to_glib_encoding ()

gchar const **
go_shell_argv_to_glib_encoding (gint argc,
                                gchar const **argv);

Transform arguments to UTF-8 when needed.

Parameters

argc	arguments number
argv	command line arguments

Returns

the arguments in UTF-8 locale.

[transfer none]

go_shell_argv_to_glib_encoding_free ()

void
go_shell_argv_to_glib_encoding_free (void);

Types and Values

GO_F_OK

#  define GO_F_OK F_OK

enum GODotDot

Members

GO_DOTDOT_SYNTACTIC	assume no symlinks.
GO_DOTDOT_TEST	check.
GO_DOTDOT_LEAVE	leave alone.

struct GOFilePermissions

struct GOFilePermissions {
	gboolean owner_read;
	gboolean owner_write;
	gboolean owner_execute;

	gboolean group_read;
	gboolean group_write;
	gboolean group_execute;

	gboolean others_read;
	gboolean others_write;
	gboolean others_execute;
};

Members

gboolean `owner_read`;	owner can read.
gboolean `owner_write`;	owner can write.
gboolean `owner_execute`;	owner can execute.
gboolean `group_read`;	group can read.
gboolean `group_write`;	group can write.
gboolean `group_execute`;	group can execute.
gboolean `others_read`;	everybody can read.
gboolean `others_write`;	everybody can write.
gboolean `others_execute`;	everybody can execute.

GO_R_OK

#  define GO_R_OK R_OK

GO_W_OK

#  define GO_W_OK W_OK

GO_X_OK

#  define GO_X_OK X_OK