1/* GLIB - Library of useful routines for C programming
2 * gmappedfile.h: Simplified wrapper around the mmap function
3 *
4 * Copyright 2005 Matthias Clasen
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
18 */
19
20#ifndef __G_MAPPED_FILE_H__
21#define __G_MAPPED_FILE_H__
22
23#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
24#error "Only <glib.h> can be included directly."
25#endif
26
27#include <glib/gbytes.h>
28#include <glib/gerror.h>
29
30G_BEGIN_DECLS
31
32typedef struct _GMappedFile GMappedFile;
33
34GLIB_AVAILABLE_IN_ALL
35GMappedFile *g_mapped_file_new (const gchar *filename,
36 gboolean writable,
37 GError **error) G_GNUC_MALLOC;
38GLIB_AVAILABLE_IN_ALL
39GMappedFile *g_mapped_file_new_from_fd (gint fd,
40 gboolean writable,
41 GError **error) G_GNUC_MALLOC;
42GLIB_AVAILABLE_IN_ALL
43gsize g_mapped_file_get_length (GMappedFile *file);
44GLIB_AVAILABLE_IN_ALL
45gchar *g_mapped_file_get_contents (GMappedFile *file);
46GLIB_AVAILABLE_IN_2_34
47GBytes * g_mapped_file_get_bytes (GMappedFile *file);
48GLIB_AVAILABLE_IN_ALL
49GMappedFile *g_mapped_file_ref (GMappedFile *file);
50GLIB_AVAILABLE_IN_ALL
51void g_mapped_file_unref (GMappedFile *file);
52
53GLIB_DEPRECATED_FOR(g_mapped_file_unref)
54void g_mapped_file_free (GMappedFile *file);
55
56G_END_DECLS
57
58#endif /* __G_MAPPED_FILE_H__ */
59