Slightly cleaner C-API for V1 interpreters

Signed-off-by: Matthew Johnson <matjoh@microsoft.com>
microsoft · Sep 26, 2024 · fc99e92 · fc99e92
1 parent 99836d8
commit fc99e92
Show file tree

Hide file tree

Showing 8 changed files with 28 additions and 15 deletions.
diff --git a/examples/c/example.c b/examples/c/example.c
@@ -7,7 +7,7 @@ int main(void)
   regoEnum err;
   int rc = EXIT_SUCCESS;
   regoOutput* output = NULL;
-  regoInterpreter* rego = regoNew(false);
+  regoInterpreter* rego = regoNew();
 
   err = regoAddModuleFile(rego, "examples/objects.rego");
   if (err != REGO_OK)

diff --git a/examples/c/main.c b/examples/c/main.c
@@ -252,7 +252,7 @@ int main(int argc, char** argv)
     }
   }
 
-  rego = regoNew(false);
+  rego = regoNew();
 
   for (data_index = 0; data_index < config.data_files_count; data_index++)
   {

diff --git a/include/rego/rego_c.h b/include/rego/rego_c.h
@@ -114,10 +114,18 @@ extern "C"
    *
    * The caller is responsible for freeing the interpreter with regoFree.
    *
-   * @param v1_compatible Whether the interpreter should be v1 compatible.
    * @return A pointer to the new interpreter.
    */
-  regoInterpreter* regoNew(regoBoolean v1_compatible);
+  regoInterpreter* regoNew();
+
+  /**
+   * Allocates and initializes a new V1 Rego interpreter.
+   *
+   * The caller is responsible for freeing the interpreter with regoFree.
+   *
+   * @return A pointer to the new interpreter.
+   */
+  regoInterpreter* regoNewV1();
 
   /**
    * Frees a Rego interpreter.

diff --git a/src/rego_c.cc b/src/rego_c.cc
@@ -88,14 +88,20 @@ extern "C"
     }
   }
 
-  regoInterpreter* regoNew(regoBoolean v1_compatible)
+  regoInterpreter* regoNew()
   {
-    auto ptr =
-      reinterpret_cast<regoInterpreter*>(new rego::Interpreter(v1_compatible));
+    auto ptr = reinterpret_cast<regoInterpreter*>(new rego::Interpreter(false));
     logging::Debug() << "regoNew: " << ptr;
     return ptr;
   }
 
+  regoInterpreter* regoNewV1()
+  {
+    auto ptr = reinterpret_cast<regoInterpreter*>(new rego::Interpreter(true));
+    logging::Debug() << "regoNewV1: " << ptr;
+    return ptr;
+  }
+
   void regoFree(regoInterpreter* rego)
   {
     logging::Debug() << "regoFree: " << rego;

diff --git a/tests/c_api.cc b/tests/c_api.cc
@@ -63,7 +63,7 @@ int main()
   int rc = REGO_OK;
   regoOutput* output = NULL;
   regoNode* node = NULL;
-  regoInterpreter* rego = regoNew(false);
+  regoInterpreter* rego = regoNew();
   regoSize size = 0;
   char* buf = NULL;
 

diff --git a/wrappers/python/src/_regopy.cc b/wrappers/python/src/_regopy.cc
@@ -92,11 +92,9 @@ PYBIND11_MODULE(_regopy, m)
     "level"_a);
   m.def(
     "regoSetTZDataPath", &regoSetTZDataPath, "Sets the TZData path.", "path"_a);
+  m.def("regoNew", &regoNew, "Returns a pointer to a new rego instance.");
   m.def(
-    "regoNew",
-    &regoNew,
-    "Returns a pointer to a new rego instance.",
-    "v1_compatible"_a);
+    "regoNewV1", &regoNewV1, "Returns a pointer to a new V1 rego instance.");
   m.def("regoFree", &regoFree, "Deletes a rego instance.");
   m.def(
     "regoAddModuleFile",

diff --git a/wrappers/python/src/regopy/interpreter.py b/wrappers/python/src/regopy/interpreter.py
@@ -13,6 +13,7 @@
     regoGetStrictBuiltInErrors,
     regoGetWellFormedChecksEnabled,
     regoNew,
+    regoNewV1,
     regoQuery,
     regoSetDebugEnabled,
     regoSetDebugPath,
@@ -106,7 +107,7 @@ class Interpreter:
 
     def __init__(self, v1_compatible=False):
         """Initializer."""
-        self._impl = regoNew(v1_compatible)
+        self._impl = regoNewV1() if v1_compatible else regoNew()
 
     def __del__(self):
         """Destructor."""

diff --git a/wrappers/rust/regorust/src/lib.rs b/wrappers/rust/regorust/src/lib.rs
@@ -475,14 +475,14 @@ pub fn set_tzdata_path(path: &str, download: bool) -> Result<(), &'static str> {
 impl Interpreter {
     /// Creates a new Rego interpreter.
     pub fn new() -> Self {
-        let interpreter_ptr = unsafe { regoNew(0) };
+        let interpreter_ptr = unsafe { regoNew() };
         Self {
             c_ptr: interpreter_ptr,
         }
     }
 
     pub fn new_v1() -> Self {
-        let interpreter_ptr = unsafe { regoNew(1) };
+        let interpreter_ptr = unsafe { regoNewV1() };
         Self {
             c_ptr: interpreter_ptr,
         }