inspect: Ignore Pardus "/.swap" swapfile.
[libguestfs.git] / src / guestfs.h
1 /* libguestfs
2  * Copyright (C) 2009-2010 Red Hat Inc.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 /* IMPORTANT NOTE:
20  *
21  * All API documentation is in the manpage, 'guestfs(3)'.
22  * To read it, type:
23  *   man 3 guestfs
24  * Or read it online here:
25  *   http://libguestfs.org/guestfs.3.html
26  *
27  * Go and read it now, I'll wait for you to come back.
28  */
29
30 #ifndef GUESTFS_H_
31 #define GUESTFS_H_
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 #include <stdint.h>
38
39 typedef struct guestfs_h guestfs_h;
40
41 /*--- Connection management ---*/
42 extern guestfs_h *guestfs_create (void);
43 extern void guestfs_close (guestfs_h *g);
44
45 /*--- Error handling ---*/
46 extern const char *guestfs_last_error (guestfs_h *g);
47
48 typedef void (*guestfs_error_handler_cb) (guestfs_h *g, void *opaque, const char *msg);
49 typedef void (*guestfs_abort_cb) (void) __attribute__((__noreturn__));
50
51 extern void guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *opaque);
52 extern guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g, void **opaque_rtn);
53
54 extern void guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb);
55 extern guestfs_abort_cb guestfs_get_out_of_memory_handler (guestfs_h *g);
56
57 /*--- Events ---*/
58 typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque, char *buf, int len);
59 typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);
60 typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);
61 typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);
62 typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque, int proc_nr, int serial, uint64_t position, uint64_t total);
63
64 extern void guestfs_set_log_message_callback (guestfs_h *g, guestfs_log_message_cb cb, void *opaque);
65 extern void guestfs_set_subprocess_quit_callback (guestfs_h *g, guestfs_subprocess_quit_cb cb, void *opaque);
66 extern void guestfs_set_launch_done_callback (guestfs_h *g, guestfs_launch_done_cb cb, void *opaque);
67 #define LIBGUESTFS_HAVE_SET_CLOSE_CALLBACK 1
68 extern void guestfs_set_close_callback (guestfs_h *g, guestfs_close_cb cb, void *opaque);
69 #define LIBGUESTFS_HAVE_SET_PROGRESS_CALLBACK 1
70 extern void guestfs_set_progress_callback (guestfs_h *g, guestfs_progress_cb cb, void *opaque);
71
72 /*--- Private data area ---*/
73 #define LIBGUESTFS_HAVE_SET_PRIVATE 1
74 extern void guestfs_set_private (guestfs_h *g, const char *key, void *data);
75 #define LIBGUESTFS_HAVE_GET_PRIVATE 1
76 extern void *guestfs_get_private (guestfs_h *g, const char *key);
77
78 /*--- Structures and actions ---*/
79 #include <rpc/types.h>
80 #include <rpc/xdr.h>
81 #include <guestfs-structs.h>
82 #include <guestfs-actions.h>
83
84 /*--- Private ---
85  *
86  * These are NOT part of the public, stable API, and can change at any
87  * time!  We export them because they are used by some of the language
88  * bindings.
89  */
90 extern void *guestfs_safe_malloc (guestfs_h *g, size_t nbytes);
91 extern void *guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s);
92 extern const char *guestfs_tmpdir (void);
93 /* End of private functions. */
94
95 #ifdef __cplusplus
96 }
97 #endif
98
99 #endif /* GUESTFS_H_ */