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 #ifndef __G_MAPPED_FILE_H__
  23 #define __G_MAPPED_FILE_H__
  24
  25 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  26 #error "Only <glib.h> can be included directly."
  27 #endif
  28
  29 #include <glib/gbytes.h>
  30 #include <glib/gerror.h>
  31
  32 G_BEGIN_DECLS
  33
  34 typedef struct _GMappedFile GMappedFile;
  35
  36 GLIB_AVAILABLE_IN_ALL
  37 GMappedFile *g_mapped_file_new          (const gchar  *filename,
  38                                          gboolean      writable,
  39                                          GError      **error) G_GNUC_MALLOC;
  40 GLIB_AVAILABLE_IN_ALL
  41 GMappedFile *g_mapped_file_new_from_fd  (gint          fd,
  42                                          gboolean      writable,
  43                                          GError      **error) G_GNUC_MALLOC;
  44 GLIB_AVAILABLE_IN_ALL
  45 gsize        g_mapped_file_get_length   (GMappedFile  *file);
  46 GLIB_AVAILABLE_IN_ALL
  47 gchar       *g_mapped_file_get_contents (GMappedFile  *file);
  48 GLIB_AVAILABLE_IN_2_34
  49 GBytes *     g_mapped_file_get_bytes    (GMappedFile  *file);
  50 GLIB_AVAILABLE_IN_ALL
  51 GMappedFile *g_mapped_file_ref          (GMappedFile  *file);
  52 GLIB_AVAILABLE_IN_ALL
  53 void         g_mapped_file_unref        (GMappedFile  *file);
  54
  55 GLIB_DEPRECATED_FOR(g_mapped_file_unref)
  56 void         g_mapped_file_free         (GMappedFile  *file);
  57
  58 G_END_DECLS
  59
  60 #endif /* __G_MAPPED_FILE_H__ */