Consistent use of 'void *opaque' to refer to opaque pointer in C API.

[libguestfs.git] / src / guestfs.h

diff --git a/src/guestfs.h b/src/guestfs.h
index 35f995d..9fc6ca5 100644 (file)
--- a/src/guestfs.h
+++ b/src/guestfs.h
@@ -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
@@ -16,68 +16,76 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  */
 
-#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.
+/* 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.
  */
 
-#include <rpc/xdr.h>
+#ifndef GUESTFS_H_
+#define GUESTFS_H_
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
+#include <stdint.h>
+
 typedef struct guestfs_h guestfs_h;
 
-/* Connection management. */
+/*--- Connection management ---*/
 extern guestfs_h *guestfs_create (void);
 extern void guestfs_close (guestfs_h *g);
 
-/* Error handling. */
+/*--- Error handling ---*/
 extern const char *guestfs_last_error (guestfs_h *g);
 
-typedef void (*guestfs_error_handler_cb) (guestfs_h *g, void *data, const char *msg);
+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);
 
-#include <guestfs-structs.h>
-#include <guestfs-actions.h>
-
-/* Events. */
-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);
+/*--- 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);
 
 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);
+extern void guestfs_set_close_callback (guestfs_h *g, guestfs_close_cb cb, void *opaque);
+extern void guestfs_set_progress_callback (guestfs_h *g, guestfs_progress_cb cb, void *opaque);
+
+/*--- Private data area ---*/
+extern void guestfs_set_private (guestfs_h *g, const char *key, void *data);
+extern void *guestfs_get_private (guestfs_h *g, const char *key);
 
-/* Private, for use only by the actions. */
-struct guestfs_message_header;
-struct guestfs_message_error;
-extern void guestfs_error (guestfs_h *g, const char *fs, ...)
-  __attribute__((format (printf,2,3)));
-extern void guestfs_perrorf (guestfs_h *g, const char *fs, ...)
-  __attribute__((format (printf,2,3)));
+/*--- Structures and actions ---*/
+#include <rpc/types.h>
+#include <rpc/xdr.h>
+#include <guestfs-structs.h>
+#include <guestfs-actions.h>
+
+/*--- 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 void *guestfs_safe_realloc (guestfs_h *g, void *ptr, int nbytes);
-extern char *guestfs_safe_strdup (guestfs_h *g, const char *str);
-extern void *guestfs_safe_memdup (guestfs_h *g, void *ptr, size_t size);
-extern int guestfs___set_busy (guestfs_h *g);
-extern int guestfs___end_busy (guestfs_h *g);
-extern int guestfs___send (guestfs_h *g, int proc_nr, xdrproc_t xdrp, char *args);
-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);
-extern int guestfs___send_file (guestfs_h *g, const char *filename);
-extern int guestfs___recv_file (guestfs_h *g, const char *filename);
+/* End of private functions. */
 
 #ifdef __cplusplus
 }