Make single includes mandatory
[platform/upstream/glib.git] / glib / gmappedfile.h
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, write to the
18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19  * Boston, MA 02111-1307, USA.
20  */
21
22 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
23 #error "Only <glib.h> can be included directly."
24 #endif
25
26 #ifndef __G_MAPPED_FILE_H__
27 #define __G_MAPPED_FILE_H__
28
29 #include <glib/gerror.h>
30
31 G_BEGIN_DECLS
32
33 typedef struct _GMappedFile GMappedFile;
34
35 GMappedFile *g_mapped_file_new          (const gchar  *filename,
36                                          gboolean      writable,
37                                          GError      **error) G_GNUC_MALLOC;
38 GMappedFile *g_mapped_file_new_from_fd  (gint          fd,
39                                          gboolean      writable,
40                                          GError      **error) G_GNUC_MALLOC;
41 gsize        g_mapped_file_get_length   (GMappedFile  *file);
42 gchar       *g_mapped_file_get_contents (GMappedFile  *file);
43 GMappedFile *g_mapped_file_ref          (GMappedFile  *file);
44 void         g_mapped_file_unref        (GMappedFile  *file);
45
46 #ifndef G_DISABLE_DEPRECATED
47 GLIB_DEPRECATED_FOR(g_mapped_file_unref)
48 void         g_mapped_file_free         (GMappedFile  *file);
49 #endif
50
51 G_END_DECLS
52
53 #endif /* __G_MAPPED_FILE_H__ */