Include <stdarg.h> in public header.
[libguestfs.git] / src / guestfs.h
index cbe2c82..0f4f9fd 100644 (file)
@@ -1,5 +1,5 @@
 /* libguestfs
- * Copyright (C) 2009 Red Hat Inc. 
+ * Copyright (C) 2009-2010 Red Hat Inc.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
+/* IMPORTANT NOTE:
+ *
+ * All API documentation is in the manpage, 'guestfs(3)'.
+ * To read it, type:
+ *   man 3 guestfs
+ * Or read it online here:
+ *   http://libguestfs.org/guestfs.3.html
+ *
+ * Go and read it now, I'll wait for you to come back.
+ */
+
 #ifndef GUESTFS_H_
 #define GUESTFS_H_
 
-/* IMPORTANT NOTE!
- * All API documentation is in the manual page --> guestfs(3) <--
- * Go and read it now, I'll wait.
- */
+#ifdef __cplusplus
+extern "C" {
+#endif
 
-#include <rpc/xdr.h>
+#include <stdint.h>
+#include <stdarg.h>
 
 typedef struct guestfs_h guestfs_h;
 
-/* Connection management. */
+/*--- Connection management ---*/
 extern guestfs_h *guestfs_create (void);
 extern void guestfs_close (guestfs_h *g);
-extern int guestfs_launch (guestfs_h *g);
-extern int guestfs_wait_ready (guestfs_h *g);
-extern int guestfs_kill_subprocess (guestfs_h *g);
 
-/* Configuration management. */
-extern int guestfs_config (guestfs_h *g,
-                          const char *qemu_param, const char *qemu_value);
-extern int guestfs_add_drive (guestfs_h *g, const char *filename);
-extern int guestfs_add_cdrom (guestfs_h *g, const char *filename);
+/*--- Error handling ---*/
+extern const char *guestfs_last_error (guestfs_h *g);
+#define LIBGUESTFS_HAVE_LAST_ERRNO 1
+extern int guestfs_last_errno (guestfs_h *g);
 
-/* Error handling. */
-typedef void (*guestfs_error_handler_cb) (guestfs_h *g, void *data, const char *msg);
-typedef void (*guestfs_abort_cb) (void);
+typedef void (*guestfs_error_handler_cb) (guestfs_h *g, void *opaque, const char *msg);
+typedef void (*guestfs_abort_cb) (void) __attribute__((__noreturn__));
 
-extern void guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *data);
-extern guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g, void **data_rtn);
+extern void guestfs_set_error_handler (guestfs_h *g, guestfs_error_handler_cb cb, void *opaque);
+extern guestfs_error_handler_cb guestfs_get_error_handler (guestfs_h *g, void **opaque_rtn);
 
 extern void guestfs_set_out_of_memory_handler (guestfs_h *g, guestfs_abort_cb);
 extern guestfs_abort_cb guestfs_get_out_of_memory_handler (guestfs_h *g);
 
-/* Misc. */
-extern void guestfs_set_verbose (guestfs_h *g, int verbose);
-extern int guestfs_get_verbose (guestfs_h *g);
-extern void guestfs_set_autosync (guestfs_h *g, int a);
-extern int guestfs_get_autosync (guestfs_h *g);
-extern void guestfs_set_path (guestfs_h *g, const char *path);
-extern const char *guestfs_get_path (guestfs_h *g);
-
-#include <guestfs-structs.h>
-#include <guestfs-actions.h>
-
-extern void guestfs_free_lvm_pv_list (struct guestfs_lvm_pv_list *);
-extern void guestfs_free_lvm_vg_list (struct guestfs_lvm_vg_list *);
-extern void guestfs_free_lvm_lv_list (struct guestfs_lvm_lv_list *);
+/*--- Events ---*/
+typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *opaque, char *buf, int len);
+typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *opaque);
+typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *opaque);
+typedef void (*guestfs_close_cb) (guestfs_h *g, void *opaque);
+typedef void (*guestfs_progress_cb) (guestfs_h *g, void *opaque, int proc_nr, int serial, uint64_t position, uint64_t total);
 
-/* Low-level event API. */
-typedef void (*guestfs_reply_cb) (guestfs_h *g, void *data, XDR *xdr);
-typedef void (*guestfs_log_message_cb) (guestfs_h *g, void *data, char *buf, int len);
-typedef void (*guestfs_subprocess_quit_cb) (guestfs_h *g, void *data);
-typedef void (*guestfs_launch_done_cb) (guestfs_h *g, void *data);
-
-extern void guestfs_set_reply_callback (guestfs_h *g, guestfs_reply_cb cb, void *opaque);
 extern void guestfs_set_log_message_callback (guestfs_h *g, guestfs_log_message_cb cb, void *opaque);
 extern void guestfs_set_subprocess_quit_callback (guestfs_h *g, guestfs_subprocess_quit_cb cb, void *opaque);
 extern void guestfs_set_launch_done_callback (guestfs_h *g, guestfs_launch_done_cb cb, void *opaque);
+#define LIBGUESTFS_HAVE_SET_CLOSE_CALLBACK 1
+extern void guestfs_set_close_callback (guestfs_h *g, guestfs_close_cb cb, void *opaque);
+#define LIBGUESTFS_HAVE_SET_PROGRESS_CALLBACK 1
+extern void guestfs_set_progress_callback (guestfs_h *g, guestfs_progress_cb cb, void *opaque);
+
+/*--- Private data area ---*/
+#define LIBGUESTFS_HAVE_SET_PRIVATE 1
+extern void guestfs_set_private (guestfs_h *g, const char *key, void *data);
+#define LIBGUESTFS_HAVE_GET_PRIVATE 1
+extern void *guestfs_get_private (guestfs_h *g, const char *key);
+
+/*--- Structures and actions ---*/
+#include <rpc/types.h>
+#include <rpc/xdr.h>
+#include <guestfs-structs.h>
+#include <guestfs-actions.h>
 
-/* Main loop. */
-#define GUESTFS_HANDLE_READABLE 0x1
-#define GUESTFS_HANDLE_WRITABLE 0x2
-#define GUESTFS_HANDLE_HANGUP   0x4
-#define GUESTFS_HANDLE_ERROR    0x8
-
-typedef void (*guestfs_handle_event_cb) (void *data, int watch, int fd, int events);
-typedef int (*guestfs_add_handle_cb) (guestfs_h *g, int fd, int events, guestfs_handle_event_cb cb, void *data);
-typedef int (*guestfs_remove_handle_cb) (guestfs_h *g, int watch);
-typedef void (*guestfs_handle_timeout_cb) (void *data, int timer);
-typedef int (*guestfs_add_timeout_cb) (guestfs_h *g, int interval, guestfs_handle_timeout_cb cb, void *data);
-typedef int (*guestfs_remove_timeout_cb) (guestfs_h *g, int timer);
-typedef void (*guestfs_main_loop_run_cb) (guestfs_h *g);
-typedef void (*guestfs_main_loop_quit_cb) (guestfs_h *g);
-
-struct guestfs_main_loop {
-  guestfs_add_handle_cb add_handle;
-  guestfs_remove_handle_cb remove_handle;
-  guestfs_add_timeout_cb add_timeout;
-  guestfs_remove_timeout_cb remove_timeout;
-  guestfs_main_loop_run_cb main_loop_run;
-  guestfs_main_loop_quit_cb main_loop_quit;
-};
-typedef struct guestfs_main_loop guestfs_main_loop;
-
-extern void guestfs_set_main_loop (guestfs_main_loop *);
-extern void guestfs_main_loop_run (void);
-extern void guestfs_main_loop_quit (void);
+/*--- Private ---
+ *
+ * These are NOT part of the public, stable API, and can change at any
+ * time!  We export them because they are used by some of the language
+ * bindings.
+ */
+extern void *guestfs_safe_malloc (guestfs_h *g, size_t nbytes);
+extern void *guestfs_safe_calloc (guestfs_h *g, size_t n, size_t s);
+extern const char *guestfs_tmpdir (void);
+/* End of private functions. */
+
+#ifdef __cplusplus
+}
+#endif
 
 #endif /* GUESTFS_H_ */