Merge branch '976-disable-assert-checks' into 'master'
[glib.git] / glib / gmappedfile.h
blob1a06f7c56138c4388375bb493eee1dc31adb1728
1 /* GLIB - Library of useful routines for C programming
2 * gmappedfile.h: Simplified wrapper around the mmap function
4 * Copyright 2005 Matthias Clasen
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.1 of the License, or (at your option) any later version.
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.
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/>.
20 #ifndef __G_MAPPED_FILE_H__
21 #define __G_MAPPED_FILE_H__
23 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
24 #error "Only <glib.h> can be included directly."
25 #endif
27 #include <glib/gbytes.h>
28 #include <glib/gerror.h>
30 G_BEGIN_DECLS
32 typedef struct _GMappedFile GMappedFile;
34 GLIB_AVAILABLE_IN_ALL
35 GMappedFile *g_mapped_file_new (const gchar *filename,
36 gboolean writable,
37 GError **error) G_GNUC_MALLOC;
38 GLIB_AVAILABLE_IN_ALL
39 GMappedFile *g_mapped_file_new_from_fd (gint fd,
40 gboolean writable,
41 GError **error) G_GNUC_MALLOC;
42 GLIB_AVAILABLE_IN_ALL
43 gsize g_mapped_file_get_length (GMappedFile *file);
44 GLIB_AVAILABLE_IN_ALL
45 gchar *g_mapped_file_get_contents (GMappedFile *file);
46 GLIB_AVAILABLE_IN_2_34
47 GBytes * g_mapped_file_get_bytes (GMappedFile *file);
48 GLIB_AVAILABLE_IN_ALL
49 GMappedFile *g_mapped_file_ref (GMappedFile *file);
50 GLIB_AVAILABLE_IN_ALL
51 void g_mapped_file_unref (GMappedFile *file);
53 GLIB_DEPRECATED_FOR(g_mapped_file_unref)
54 void g_mapped_file_free (GMappedFile *file);
56 G_END_DECLS
58 #endif /* __G_MAPPED_FILE_H__ */