Include latest Polish translations (Piotr Drąg, RHBZ#502533).
[libguestfs.git] / src / guestfs.h
1 /* libguestfs
2  * Copyright (C) 2009 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 #ifndef GUESTFS_H_
20 #define GUESTFS_H_
21
22 /* IMPORTANT NOTE!
23  * All API documentation is in the manual page --> guestfs(3) <--
24  * Go and read it now, I'll wait.
25  */
26
27 #include <rpc/xdr.h>
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32
33 typedef struct guestfs_h guestfs_h;
34
35 /* Connection management. */
36 extern guestfs_h *guestfs_create (void);
37 extern void guestfs_close (guestfs_h *g);
38
39 /* Error handling. */
40 extern const char *guestfs_last_error (guestfs_h *g);
41
42 typedef void (*guestfs_error_handler_cb) (guestfs_h *g, void *data, const char *msg);
43 typedef void (*guestfs_abort_cb) (void) __attribute__((__noreturn__));
44
45 extern void guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data);
46 extern guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g, void **data_rtn);
47
48 extern void guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb);
49 extern guestfs_abort_cb guestfs_get_out_of_memory_handler (guestfs_h *g);
50
51 #include <guestfs-structs.h>
52 #include <guestfs-actions.h>
53
54 /* Events. */
55 typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *data, char *buf, int len);
56 typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *data);
57 typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *data);
58
59 extern void guestfs_set_log_message_callback (guestfs_h *g, guestfs_log_message_cb cb, void *opaque);
60 extern void guestfs_set_subprocess_quit_callback (guestfs_h *g, guestfs_subprocess_quit_cb cb, void *opaque);
61 extern void guestfs_set_launch_done_callback (guestfs_h *g, guestfs_launch_done_cb cb, void *opaque);
62
63 /* Private, for use only by the actions. */
64 struct guestfs_message_header;
65 struct guestfs_message_error;
66 extern void guestfs_error (guestfs_h *g, const char *fs, ...)
67   __attribute__((format (printf,2,3)));
68 extern void guestfs_perrorf (guestfs_h *g, const char *fs, ...)
69   __attribute__((format (printf,2,3)));
70 extern void *guestfs_safe_malloc (guestfs_h *g, size_t nbytes);
71 extern void *guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s);
72 extern void *guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes);
73 extern char *guestfs_safe_strdup (guestfs_h *g, const char *str);
74 extern void *guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size);
75 extern int guestfs___set_busy (guestfs_h *g);
76 extern int guestfs___end_busy (guestfs_h *g);
77 extern int guestfs___send (guestfs_h *g, int proc_nr, xdrproc_t xdrp, char *args);
78 extern int guestfs___recv (guestfs_h *g, const char *fn, struct guestfs_message_header *hdr, struct guestfs_message_error *err, xdrproc_t xdrp, char *ret);
79 extern int guestfs___send_file (guestfs_h *g, const char *filename);
80 extern int guestfs___recv_file (guestfs_h *g, const char *filename);
81
82 #ifdef __cplusplus
83 }
84 #endif
85
86 #endif /* GUESTFS_H_ */