gmappedfile.h 2.0 KB

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