generator: Create a separate type for optional arguments
[libguestfs.git] / generator / generator_python.ml
index f3a2a94..98b54a8 100644 (file)
@@ -28,12 +28,15 @@ open Generator_optgroups
 open Generator_actions
 open Generator_structs
 open Generator_c
+open Generator_events
 
 (* Generate Python C module. *)
 let rec generate_python_c () =
   generate_header CStyle LGPLv2plus;
 
   pr "\
+#include <config.h>
+
 #include <stdio.h>
 #include <stdlib.h>
 #include <assert.h>
@@ -46,6 +49,9 @@ get_string_list (PyObject *obj)
 {
   size_t i, len;
   char **r;
+#ifndef HAVE_PYSTRING_ASSTRING
+  PyObject *bytes;
+#endif
 
   assert (obj);
 
@@ -66,8 +72,14 @@ get_string_list (PyObject *obj)
     return NULL;
   }
 
-  for (i = 0; i < len; ++i)
+  for (i = 0; i < len; ++i) {
+#ifdef HAVE_PYSTRING_ASSTRING
     r[i] = PyString_AsString (PyList_GetItem (obj, i));
+#else
+    bytes = PyUnicode_AsUTF8String (PyList_GetItem (obj, i));
+    r[i] = PyBytes_AS_STRING (bytes);
+#endif
+  }
   r[len] = NULL;
 
   return r;
@@ -83,8 +95,13 @@ put_string_list (char * const * const argv)
     ;
 
   list = PyList_New (argc);
-  for (i = 0; i < argc; ++i)
+  for (i = 0; i < argc; ++i) {
+#ifdef HAVE_PYSTRING_ASSTRING
     PyList_SetItem (list, i, PyString_FromString (argv[i]));
+#else
+    PyList_SetItem (list, i, PyUnicode_FromString (argv[i]));
+#endif
+  }
 
   return list;
 }
@@ -101,8 +118,13 @@ put_table (char * const * const argv)
   list = PyList_New (argc >> 1);
   for (i = 0; i < argc; i += 2) {
     item = PyTuple_New (2);
+#ifdef HAVE_PYSTRING_ASSTRING
     PyTuple_SetItem (item, 0, PyString_FromString (argv[i]));
     PyTuple_SetItem (item, 1, PyString_FromString (argv[i+1]));
+#else
+    PyTuple_SetItem (item, 0, PyUnicode_FromString (argv[i]));
+    PyTuple_SetItem (item, 1, PyUnicode_FromString (argv[i+1]));
+#endif
     PyList_SetItem (list, i >> 1, item);
   }
 
@@ -149,16 +171,31 @@ free_strings (char **argv)
         function
         | name, FString ->
             pr "  PyDict_SetItemString (dict, \"%s\",\n" name;
+            pr "#ifdef HAVE_PYSTRING_ASSTRING\n";
             pr "                        PyString_FromString (%s->%s));\n"
-              typ name
+              typ name;
+            pr "#else\n";
+            pr "                        PyUnicode_FromString (%s->%s));\n"
+              typ name;
+            pr "#endif\n"
         | name, FBuffer ->
             pr "  PyDict_SetItemString (dict, \"%s\",\n" name;
+            pr "#ifdef HAVE_PYSTRING_ASSTRING\n";
             pr "                        PyString_FromStringAndSize (%s->%s, %s->%s_len));\n"
-              typ name typ name
+              typ name typ name;
+            pr "#else\n";
+            pr "                        PyBytes_FromStringAndSize (%s->%s, %s->%s_len));\n"
+              typ name typ name;
+            pr "#endif\n"
         | name, FUUID ->
             pr "  PyDict_SetItemString (dict, \"%s\",\n" name;
+            pr "#ifdef HAVE_PYSTRING_ASSTRING\n";
             pr "                        PyString_FromStringAndSize (%s->%s, 32));\n"
-              typ name
+              typ name;
+            pr "#else\n";
+            pr "                        PyBytes_FromStringAndSize (%s->%s, 32));\n"
+              typ name;
+            pr "#endif\n"
         | name, (FBytes|FUInt64) ->
             pr "  PyDict_SetItemString (dict, \"%s\",\n" name;
             pr "                        PyLong_FromUnsignedLongLong (%s->%s));\n"
@@ -185,8 +222,13 @@ free_strings (char **argv)
             pr "    PyDict_SetItemString (dict, \"%s\", Py_None);\n" name;
             pr "  }\n"
         | name, FChar ->
+            pr "#ifdef HAVE_PYSTRING_ASSTRING\n";
             pr "  PyDict_SetItemString (dict, \"%s\",\n" name;
-            pr "                        PyString_FromStringAndSize (&dirent->%s, 1));\n" name
+            pr "                        PyString_FromStringAndSize (&dirent->%s, 1));\n" name;
+            pr "#else\n";
+            pr "  PyDict_SetItemString (dict, \"%s\",\n" name;
+            pr "                        PyUnicode_FromStringAndSize (&dirent->%s, 1));\n" name;
+            pr "#endif\n"
       ) cols;
       pr "  return dict;\n";
       pr "};\n";
@@ -264,11 +306,10 @@ free_strings (char **argv)
          *)
         List.iter (
           function
-          | Bool n
-          | Int n -> pr "  int optargs_t_%s = -1;\n" n
-          | Int64 n -> pr "  long long optargs_t_%s = -1;\n" n
-          | String n -> pr "  const char *optargs_t_%s = NULL;\n" n
-          | _ -> assert false
+          | OBool n
+          | OInt n -> pr "  int optargs_t_%s = -1;\n" n
+          | OInt64 n -> pr "  long long optargs_t_%s = -1;\n" n
+          | OString n -> pr "  const char *optargs_t_%s = NULL;\n" n
         ) optargs
       );
 
@@ -301,10 +342,9 @@ free_strings (char **argv)
       if optargs <> [] then (
         List.iter (
           function
-          | Bool _ | Int _ -> pr "i"
-          | Int64 _ -> pr "L"
-          | String _ -> pr "z" (* because we use None to mean not set *)
-          | _ -> assert false
+          | OBool _ | OInt _ -> pr "i"
+          | OInt64 _ -> pr "L"
+          | OString _ -> pr "z" (* because we use None to mean not set *)
         ) optargs;
       );
 
@@ -325,8 +365,7 @@ free_strings (char **argv)
 
       List.iter (
         function
-        | Bool n | Int n | Int64 n | String n -> pr ", &optargs_t_%s" n
-        | _ -> assert false
+        | OBool n | OInt n | OInt64 n | OString n -> pr ", &optargs_t_%s" n
       ) optargs;
 
       pr "))\n";
@@ -351,13 +390,12 @@ free_strings (char **argv)
         let uc_name = String.uppercase name in
         List.iter (
           fun argt ->
-            let n = name_of_argt argt in
+            let n = name_of_optargt argt in
             let uc_n = String.uppercase n in
             pr "  if (optargs_t_%s != " n;
             (match argt with
-             | Bool _ | Int _ | Int64 _ -> pr "-1"
-             | String _ -> pr "NULL"
-             | _ -> assert false
+             | OBool _ | OInt _ | OInt64 _ -> pr "-1"
+             | OString _ -> pr "NULL"
             );
             pr ") {\n";
             pr "    optargs_s.%s = optargs_t_%s;\n" n n;
@@ -416,18 +454,31 @@ free_strings (char **argv)
            pr "  Py_INCREF (Py_None);\n";
            pr "  py_r = Py_None;\n"
        | RInt _
-       | RBool _ -> pr "  py_r = PyInt_FromLong ((long) r);\n"
+       | RBool _ -> pr "  py_r = PyLong_FromLong ((long) r);\n"
        | RInt64 _ -> pr "  py_r = PyLong_FromLongLong (r);\n"
-       | RConstString _ -> pr "  py_r = PyString_FromString (r);\n"
+       | RConstString _ ->
+           pr "#ifdef HAVE_PYSTRING_ASSTRING\n";
+           pr "  py_r = PyString_FromString (r);\n";
+           pr "#else\n";
+           pr "  py_r = PyUnicode_FromString (r);\n";
+           pr "#endif\n"
        | RConstOptString _ ->
-           pr "  if (r)\n";
+           pr "  if (r) {\n";
+           pr "#ifdef HAVE_PYSTRING_ASSTRING\n";
            pr "    py_r = PyString_FromString (r);\n";
-           pr "  else {\n";
+           pr "#else\n";
+           pr "    py_r = PyUnicode_FromString (r);\n";
+           pr "#endif\n";
+           pr "  } else {\n";
            pr "    Py_INCREF (Py_None);\n";
            pr "    py_r = Py_None;\n";
            pr "  }\n"
        | RString _ ->
+           pr "#ifdef HAVE_PYSTRING_ASSTRING\n";
            pr "  py_r = PyString_FromString (r);\n";
+           pr "#else\n";
+           pr "  py_r = PyUnicode_FromString (r);\n";
+           pr "#endif\n";
            pr "  free (r);\n"
        | RStringList _ ->
            pr "  py_r = put_string_list (r);\n";
@@ -442,7 +493,11 @@ free_strings (char **argv)
            pr "  py_r = put_table (r);\n";
            pr "  free_strings (r);\n"
        | RBufferOut _ ->
+           pr "#ifdef HAVE_PYSTRING_ASSTRING\n";
            pr "  py_r = PyString_FromStringAndSize (r, size);\n";
+           pr "#else\n";
+           pr "  py_r = PyBytes_FromStringAndSize (r, size);\n";
+           pr "#endif\n";
            pr "  free (r);\n"
       );
 
@@ -455,6 +510,10 @@ free_strings (char **argv)
   pr "static PyMethodDef methods[] = {\n";
   pr "  { (char *) \"create\", py_guestfs_create, METH_VARARGS, NULL },\n";
   pr "  { (char *) \"close\", py_guestfs_close, METH_VARARGS, NULL },\n";
+  pr "  { (char *) \"set_event_callback\",\n";
+  pr "    py_guestfs_set_event_callback, METH_VARARGS, NULL },\n";
+  pr "  { (char *) \"delete_event_callback\",\n";
+  pr "    py_guestfs_delete_event_callback, METH_VARARGS, NULL },\n";
   List.iter (
     fun (name, _, _, _, _, _, _) ->
       pr "  { (char *) \"%s\", py_guestfs_%s, METH_VARARGS, NULL },\n"
@@ -466,15 +525,47 @@ free_strings (char **argv)
 
   (* Init function. *)
   pr "\
+#if PY_MAJOR_VERSION >= 3
+static struct PyModuleDef moduledef = {
+  PyModuleDef_HEAD_INIT,
+  \"libguestfsmod\",     /* m_name */
+  \"libguestfs module\",   /* m_doc */
+  -1,                    /* m_size */
+  methods,               /* m_methods */
+  NULL,                  /* m_reload */
+  NULL,                  /* m_traverse */
+  NULL,                  /* m_clear */
+  NULL,                  /* m_free */
+};
+#endif
+
+static PyObject *
+moduleinit (void)
+{
+  PyObject *m;
+
+#if PY_MAJOR_VERSION >= 3
+  m = PyModule_Create (&moduledef);
+#else
+  m = Py_InitModule ((char *) \"libguestfsmod\", methods);
+#endif
+
+  return m; /* m might be NULL if module init failed */
+}
+
+#if PY_MAJOR_VERSION >= 3
+PyMODINIT_FUNC
+PyInit_libguestfsmod (void)
+{
+  return moduleinit ();
+}
+#else
 void
 initlibguestfsmod (void)
 {
-  static int initialized = 0;
-
-  if (initialized) return;
-  Py_InitModule ((char *) \"libguestfsmod\", methods);
-  initialized = 1;
+  (void) moduleinit ();
 }
+#endif
 "
 
 (* Generate Python module. *)
@@ -482,7 +573,7 @@ and generate_python_py () =
   generate_header HashStyle LGPLv2plus;
 
   pr "\
-u\"\"\"Python bindings for libguestfs
+\"\"\"Python bindings for libguestfs
 
 import guestfs
 g = guestfs.GuestFS ()
@@ -531,6 +622,18 @@ logvols = g.lvs ()
 
 import libguestfsmod
 
+";
+
+  List.iter (
+    fun (name, bitmask) ->
+      pr "EVENT_%s = 0x%x\n" (String.uppercase name) bitmask
+  ) events;
+  pr "\n";
+
+  pr "\
+class ClosedHandle(ValueError):
+    pass
+
 class GuestFS:
     \"\"\"Instances of this class are libguestfs API handles.\"\"\"
 
@@ -539,7 +642,57 @@ class GuestFS:
         self._o = libguestfsmod.create ()
 
     def __del__ (self):
+        if self._o:
+            libguestfsmod.close (self._o)
+
+    def _check_not_closed (self):
+        if not self._o:
+            raise ClosedHandle (\"GuestFS: method called on closed handle\")
+
+    def close (self):
+        \"\"\"Explicitly close the guestfs handle.
+
+        The handle is closed implicitly when its reference count goes
+        to zero (eg. when it goes out of scope or the program ends).
+
+        This call is only needed if you want to force the handle to
+        close now.  After calling this, the program must not call
+        any method on the handle (except the implicit call to
+        __del__ which happens when the final reference is cleaned up).
+        \"\"\"
+        self._check_not_closed ()
         libguestfsmod.close (self._o)
+        self._o = None
+
+    def set_event_callback (self, cb, event_bitmask):
+        \"\"\"Register an event callback.
+
+        Register \"cb\" as a callback function for all of the
+        events in \"event_bitmask\".  \"event_bitmask\" should be
+        one or more \"guestfs.EVENT_*\" flags logically or'd together.
+
+        This function returns an event handle which can be used
+        to delete the callback (see \"delete_event_callback\").
+
+        The callback function receives 4 parameters:
+
+        cb (event, event_handle, buf, array)
+
+        \"event\" is one of the \"EVENT_*\" flags.  \"buf\" is a
+        message buffer (only for some types of events).  \"array\"
+        is an array of integers (only for some types of events).
+
+        You should read the documentation for
+        \"guestfs_set_event_callback\" in guestfs(3) before using
+        this function.
+        \"\"\"
+        self._check_not_closed ()
+        return libguestfsmod.set_event_callback (self._o, cb, event_bitmask)
+
+    def delete_event_callback (self, event_handle):
+        \"\"\"Delete an event callback.\"\"\"
+        self._check_not_closed ()
+        libguestfsmod.delete_event_callback (self._o, event_handle)
 
 ";
 
@@ -549,9 +702,8 @@ class GuestFS:
       List.iter (fun arg -> pr ", %s" (name_of_argt arg)) args;
       List.iter (
         function
-        | Bool n | Int n | Int64 n -> pr ", %s=-1" n
-        | String n -> pr ", %s=None" n
-        | _ -> assert false
+        | OBool n | OInt n | OInt64 n -> pr ", %s=-1" n
+        | OString n -> pr ", %s=None" n
       ) optargs;
       pr "):\n";
 
@@ -575,17 +727,13 @@ class GuestFS:
             doc ^ "\n\n" ^ protocol_limit_warning
           else doc in
         let doc =
-          if List.mem DangerWillRobinson flags then
-            doc ^ "\n\n" ^ danger_will_robinson
-          else doc in
-        let doc =
           match deprecation_notice flags with
           | None -> doc
           | Some txt -> doc ^ "\n\n" ^ txt in
         let doc = pod2text ~width:60 name doc in
         let doc = List.map (fun line -> replace_str line "\\" "\\\\") doc in
         let doc = String.concat "\n        " doc in
-        pr "        u\"\"\"%s\"\"\"\n" doc;
+        pr "        \"\"\"%s\"\"\"\n" doc;
       );
       (* Callers might pass in iterables instead of plain lists;
        * convert those to plain lists because the C side of things
@@ -599,7 +747,9 @@ class GuestFS:
         | StringList n | DeviceList n ->
             pr "        %s = list (%s)\n" n n
       ) args;
+      pr "        self._check_not_closed ()\n";
       pr "        return libguestfsmod.%s (self._o" name;
-      List.iter (fun arg -> pr ", %s" (name_of_argt arg)) (args@optargs);
+      List.iter (fun arg -> pr ", %s" (name_of_argt arg))
+        (args @ args_of_optargs optargs);
       pr ")\n\n";
   ) all_functions