1 /* gfileutils.h - File utility functions
3 * Copyright 2000 Red Hat, Inc.
5 * GLib is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU Lesser General Public License as
7 * published by the Free Software Foundation; either version 2 of the
8 * License, or (at your option) any later version.
10 * GLib is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with GLib; see the file COPYING.LIB. If not,
17 * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
21 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
22 #error "Only <glib.h> can be included directly."
25 #ifndef __G_FILEUTILS_H__
26 #define __G_FILEUTILS_H__
28 #include <glib/gerror.h>
32 #define G_FILE_ERROR g_file_error_quark ()
39 G_FILE_ERROR_NAMETOOLONG
,
63 /* For backward-compat reasons, these are synced to an old
64 * anonymous enum in libgnome. But don't use that enum
69 G_FILE_TEST_IS_REGULAR
= 1 << 0,
70 G_FILE_TEST_IS_SYMLINK
= 1 << 1,
71 G_FILE_TEST_IS_DIR
= 1 << 2,
72 G_FILE_TEST_IS_EXECUTABLE
= 1 << 3,
73 G_FILE_TEST_EXISTS
= 1 << 4
76 GQuark
g_file_error_quark (void);
77 /* So other code can generate a GFileError */
78 GFileError
g_file_error_from_errno (gint err_no
);
80 #ifndef __GTK_DOC_IGNORE__
82 #define g_file_test g_file_test_utf8
83 #define g_file_get_contents g_file_get_contents_utf8
84 #define g_mkstemp g_mkstemp_utf8
85 #define g_file_open_tmp g_file_open_tmp_utf8
89 gboolean
g_file_test (const gchar
*filename
,
91 gboolean
g_file_get_contents (const gchar
*filename
,
95 gboolean
g_file_set_contents (const gchar
*filename
,
96 const gchar
*contents
,
99 gchar
*g_file_read_link (const gchar
*filename
,
102 /* Wrapper / workalike for mkdtemp() */
103 GLIB_AVAILABLE_IN_2_30
104 gchar
*g_mkdtemp (gchar
*tmpl
);
105 GLIB_AVAILABLE_IN_2_30
106 gchar
*g_mkdtemp_full (gchar
*tmpl
,
109 /* Wrapper / workalike for mkstemp() */
110 gint
g_mkstemp (gchar
*tmpl
);
111 gint
g_mkstemp_full (gchar
*tmpl
,
115 /* Wrappers for g_mkstemp and g_mkdtemp() */
116 gint
g_file_open_tmp (const gchar
*tmpl
,
119 GLIB_AVAILABLE_IN_2_30
120 gchar
*g_dir_make_tmp (const gchar
*tmpl
,
123 gchar
*g_build_path (const gchar
*separator
,
124 const gchar
*first_element
,
125 ...) G_GNUC_MALLOC G_GNUC_NULL_TERMINATED
;
126 gchar
*g_build_pathv (const gchar
*separator
,
127 gchar
**args
) G_GNUC_MALLOC
;
129 gchar
*g_build_filename (const gchar
*first_element
,
130 ...) G_GNUC_MALLOC G_GNUC_NULL_TERMINATED
;
131 gchar
*g_build_filenamev (gchar
**args
) G_GNUC_MALLOC
;
133 gint
g_mkdir_with_parents (const gchar
*pathname
,
138 /* On Win32, the canonical directory separator is the backslash, and
139 * the search path separator is the semicolon. Note that also the
140 * (forward) slash works as directory separator.
142 #define G_DIR_SEPARATOR '\\'
143 #define G_DIR_SEPARATOR_S "\\"
144 #define G_IS_DIR_SEPARATOR(c) ((c) == G_DIR_SEPARATOR || (c) == '/')
145 #define G_SEARCHPATH_SEPARATOR ';'
146 #define G_SEARCHPATH_SEPARATOR_S ";"
148 #else /* !G_OS_WIN32 */
150 #define G_DIR_SEPARATOR '/'
151 #define G_DIR_SEPARATOR_S "/"
152 #define G_IS_DIR_SEPARATOR(c) ((c) == G_DIR_SEPARATOR)
153 #define G_SEARCHPATH_SEPARATOR ':'
154 #define G_SEARCHPATH_SEPARATOR_S ":"
156 #endif /* !G_OS_WIN32 */
158 gboolean
g_path_is_absolute (const gchar
*file_name
);
159 const gchar
*g_path_skip_root (const gchar
*file_name
);
161 GLIB_DEPRECATED_FOR(g_path_get_basename
)
162 const gchar
*g_basename (const gchar
*file_name
);
163 #ifndef G_DISABLE_DEPRECATED
164 #define g_dirname g_path_get_dirname
167 #ifndef __GTK_DOC_IGNORE__
169 #define g_get_current_dir g_get_current_dir_utf8
173 gchar
*g_get_current_dir (void);
174 gchar
*g_path_get_basename (const gchar
*file_name
) G_GNUC_MALLOC
;
175 gchar
*g_path_get_dirname (const gchar
*file_name
) G_GNUC_MALLOC
;
179 #endif /* __G_FILEUTILS_H__ */