[kdbus] KDBUS_ITEM_PAYLOAD_OFF items are (once again) relative to msg header
[platform/upstream/glib.git] / glib / gfileutils.h
index f6edd43..604c7fd 100644 (file)
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with GLib; see the file COPYING.LIB.  If not,
- * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- *   Boston, MA 02111-1307, USA.
+ * see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef __GFILEUTILS_H__
-#define __GFILEUTILS_H__
+#ifndef __G_FILEUTILS_H__
+#define __G_FILEUTILS_H__
 
-#ifdef __cplusplus
-extern "C"
-{
+#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
+#error "Only <glib.h> can be included directly."
 #endif
 
+#include <glib/gerror.h>
+
+G_BEGIN_DECLS
+
 #define G_FILE_ERROR g_file_error_quark ()
 
 typedef enum
@@ -53,10 +55,11 @@ typedef enum
   G_FILE_ERROR_INTR,
   G_FILE_ERROR_IO,
   G_FILE_ERROR_PERM,
+  G_FILE_ERROR_NOSYS,
   G_FILE_ERROR_FAILED
 } GFileError;
 
-/* For backward-compat reasons, these are synced to an old 
+/* For backward-compat reasons, these are synced to an old
  * anonymous enum in libgnome. But don't use that enum
  * in new code.
  */
@@ -66,26 +69,139 @@ typedef enum
   G_FILE_TEST_IS_SYMLINK    = 1 << 1,
   G_FILE_TEST_IS_DIR        = 1 << 2,
   G_FILE_TEST_IS_EXECUTABLE = 1 << 3,
-  G_FILE_TEST_EXISTS        = 1 << 4,
+  G_FILE_TEST_EXISTS        = 1 << 4
 } GFileTest;
 
+GLIB_AVAILABLE_IN_ALL
 GQuark     g_file_error_quark      (void);
 /* So other code can generate a GFileError */
+GLIB_AVAILABLE_IN_ALL
 GFileError g_file_error_from_errno (gint err_no);
 
+GLIB_AVAILABLE_IN_ALL
 gboolean g_file_test         (const gchar  *filename,
                               GFileTest     test);
+GLIB_AVAILABLE_IN_ALL
 gboolean g_file_get_contents (const gchar  *filename,
                               gchar       **contents,
-                              guint        *length,
+                              gsize        *length,
                               GError      **error);
+GLIB_AVAILABLE_IN_ALL
+gboolean g_file_set_contents (const gchar *filename,
+                              const gchar *contents,
+                              gssize         length,
+                              GError       **error);
+GLIB_AVAILABLE_IN_ALL
+gchar   *g_file_read_link    (const gchar  *filename,
+                              GError      **error);
+
+/* Wrapper / workalike for mkdtemp() */
+GLIB_AVAILABLE_IN_2_30
+gchar   *g_mkdtemp            (gchar        *tmpl);
+GLIB_AVAILABLE_IN_2_30
+gchar   *g_mkdtemp_full       (gchar        *tmpl,
+                               gint          mode);
+
+/* Wrapper / workalike for mkstemp() */
+GLIB_AVAILABLE_IN_ALL
+gint     g_mkstemp            (gchar        *tmpl);
+GLIB_AVAILABLE_IN_ALL
+gint     g_mkstemp_full       (gchar        *tmpl,
+                               gint          flags,
+                               gint          mode);
+
+/* Wrappers for g_mkstemp and g_mkdtemp() */
+GLIB_AVAILABLE_IN_ALL
+gint     g_file_open_tmp      (const gchar  *tmpl,
+                               gchar       **name_used,
+                               GError      **error);
+GLIB_AVAILABLE_IN_2_30
+gchar   *g_dir_make_tmp       (const gchar  *tmpl,
+                               GError      **error);
+
+GLIB_AVAILABLE_IN_ALL
+gchar   *g_build_path         (const gchar *separator,
+                               const gchar *first_element,
+                               ...) G_GNUC_MALLOC G_GNUC_NULL_TERMINATED;
+GLIB_AVAILABLE_IN_ALL
+gchar   *g_build_pathv        (const gchar  *separator,
+                               gchar       **args) G_GNUC_MALLOC;
+
+GLIB_AVAILABLE_IN_ALL
+gchar   *g_build_filename     (const gchar *first_element,
+                               ...) G_GNUC_MALLOC G_GNUC_NULL_TERMINATED;
+GLIB_AVAILABLE_IN_ALL
+gchar   *g_build_filenamev    (gchar      **args) G_GNUC_MALLOC;
 
+GLIB_AVAILABLE_IN_ALL
+gint     g_mkdir_with_parents (const gchar *pathname,
+                               gint         mode);
 
+#ifdef G_OS_WIN32
 
-#ifdef __cplusplus
-}
+/* On Win32, the canonical directory separator is the backslash, and
+ * the search path separator is the semicolon. Note that also the
+ * (forward) slash works as directory separator.
+ */
+#define G_DIR_SEPARATOR '\\'
+#define G_DIR_SEPARATOR_S "\\"
+#define G_IS_DIR_SEPARATOR(c) ((c) == G_DIR_SEPARATOR || (c) == '/')
+#define G_SEARCHPATH_SEPARATOR ';'
+#define G_SEARCHPATH_SEPARATOR_S ";"
+
+#else  /* !G_OS_WIN32 */
+
+#define G_DIR_SEPARATOR '/'
+#define G_DIR_SEPARATOR_S "/"
+#define G_IS_DIR_SEPARATOR(c) ((c) == G_DIR_SEPARATOR)
+#define G_SEARCHPATH_SEPARATOR ':'
+#define G_SEARCHPATH_SEPARATOR_S ":"
+
+#endif /* !G_OS_WIN32 */
+
+GLIB_AVAILABLE_IN_ALL
+gboolean     g_path_is_absolute (const gchar *file_name);
+GLIB_AVAILABLE_IN_ALL
+const gchar *g_path_skip_root   (const gchar *file_name);
+
+GLIB_DEPRECATED_FOR(g_path_get_basename)
+const gchar *g_basename         (const gchar *file_name);
+#ifndef G_DISABLE_DEPRECATED
+#define g_dirname g_path_get_dirname
 #endif
 
-#endif /* __GFILEUTILS_H__ */
+GLIB_AVAILABLE_IN_ALL
+gchar *g_get_current_dir   (void);
+GLIB_AVAILABLE_IN_ALL
+gchar *g_path_get_basename (const gchar *file_name) G_GNUC_MALLOC;
+GLIB_AVAILABLE_IN_ALL
+gchar *g_path_get_dirname  (const gchar *file_name) G_GNUC_MALLOC;
+
+#ifdef G_OS_WIN32
+#define g_file_test         g_file_test_utf8
+#define g_file_get_contents g_file_get_contents_utf8
+#define g_mkstemp           g_mkstemp_utf8
+#define g_file_open_tmp     g_file_open_tmp_utf8
+#define g_get_current_dir   g_get_current_dir_utf8
+
+GLIB_AVAILABLE_IN_ALL
+gboolean g_file_test_utf8         (const gchar  *filename,
+                                   GFileTest     test);
+GLIB_AVAILABLE_IN_ALL
+gboolean g_file_get_contents_utf8 (const gchar  *filename,
+                                   gchar       **contents,
+                                   gsize        *length,
+                                   GError      **error);
+GLIB_AVAILABLE_IN_ALL
+gint     g_mkstemp_utf8           (gchar        *tmpl);
+GLIB_AVAILABLE_IN_ALL
+gint     g_file_open_tmp_utf8     (const gchar  *tmpl,
+                                   gchar       **name_used,
+                                   GError      **error);
+GLIB_AVAILABLE_IN_ALL
+gchar   *g_get_current_dir_utf8   (void);
+#endif /* G_OS_WIN32 */
 
+G_END_DECLS
 
+#endif /* __G_FILEUTILS_H__ */