Version the API. (#80)

Introduce QUO_VADIS_API_VERSION to start versioning the API. Signed-off-by: Samuel K. Gutierrez <samuel@lanl.gov>
hpc · Mar 8, 2024 · 6fe588b · 6fe588b
1 parent 6d70320
commit 6fe588b
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/include/quo-vadis.h b/include/quo-vadis.h
@@ -30,6 +30,14 @@ extern "C" {
 /** Convenience definition. */
 #define QUO_VADIS 1
 
+/**
+ * This number is updated to (X<<16)+(Y<<8)+Z
+ * when a release X.Y.Z modifies the API.
+ *
+ * In python: print(f'{(X<<16)+(Y<<8)+Z:#010x}')
+ */
+#define QUO_VADIS_API_VERSION 0x00000001
+
 /** Opaque quo-vadis context. */
 struct qv_context_s;
 typedef struct qv_context_s qv_context_t;