Merge pull request #11 from hexedtech/add-version

feat: add version function to the client.

.gitignore

@@ -33,3 +33,4 @@ dist/java/bin/
 dist/java/gradle/
 dist/java/gradlew
 dist/java/gradlew.bat
+dist/java/.factorypath

dist/java/src/mp/code/Extensions.java

@@ -12,7 +12,13 @@ public final class Extensions {
 	static final Cleaner CLEANER = Cleaner.create();
 
 	/**
-	 * Hashes the given {@link String} using CodeMP's hashing algorithm (xxh3).
+	 * Returns the version of the Rust crate as a String.
+	 * @return the current version
+	 */
+	public static native String version();
+
+	/**
+	 * Hashes the given String using CodeMP's hashing algorithm (xxh3).
 	 * @param input the string to hash
 	 * @return the hash
 	 */

dist/java/src/mp/code/Workspace.java

@@ -80,6 +80,16 @@ public final class Workspace {
 		return active_buffers(this.ptr);
 	}
 
+	private static native String[] user_list(long self);
+
+	/**
+	 * Returns the users currently in the workspace.
+	 * @return an array containing the names of the users in the workspace
+	 */
+	public String[] userList() {
+		return user_list(this.ptr);
+	}
+
 	private static native void create_buffer(long self, String path) throws ConnectionRemoteException;
 
 	/**

dist/lua/annotations.lua

@@ -222,7 +222,7 @@ function Workspace:get_buffer(path) end
 function Workspace:attach(path) end
 
 ---@param path string relative path ("name") of buffer to detach from
----@return boolean
+---@return boolean success
 ---detach from an active buffer, closing all streams. returns false if buffer was no longer active
 function Workspace:detach(path) end
 
@@ -297,7 +297,7 @@ function BufferController:recv() end
 ---block until next text change without returning it
 function BufferController:poll() end
 
----@return boolean
+---@return boolean success
 ---stop buffer worker and disconnect, returns false if was already stopped
 function BufferController:stop() end
 
@@ -354,7 +354,7 @@ function CursorController:recv() end
 ---block until next cursor event without returning it
 function CursorController:poll() end
 
----@return boolean
+---@return boolean success
 ---stop cursor worker and disconnect, returns false if was already stopped
 function CursorController:stop() end
 
@@ -396,6 +396,10 @@ function Codemp.poll_callback() end
 ---use xxh3 hash, returns an i64 from any string
 function Codemp.hash(data) end
 
+---@return string
+---get current library version as string, in semver format
+function Codemp.version() end
+
 ---@class (exact) RuntimeDriver
 local RuntimeDriver = {}
 
@@ -411,6 +415,6 @@ function Codemp.setup_driver(block) end
 
 ---@param printer? string | fun(string) | nil log sink used for printing, if string will go to file, otherwise use given function
 ---@param debug? boolean show more verbose debug logs, default false
----@return boolean true if logger was setup correctly, false otherwise
+---@return boolean success if logger was setup correctly, false otherwise
 ---setup a global logger for codemp, note that can only be done once
 function Codemp.setup_tracing(printer, debug) end

dist/lua/codemp-0.7.0-1.rockspec

@@ -31,6 +31,6 @@ build = {
 	modules = { "codemp" },
 	target_path = "../..",
 	include = {
-		["codemp-annotations.lua"] = "dist/lua/annotations.lua",
+		["dist/lua/annotations.lua"] = "codemp-annotations.lua",
 	}
 }

src/ffi/java/ext.rs

@@ -1,5 +1,12 @@
 use jni_toolbox::jni;
 
+/// Gets the current version of the Rust crate.
+#[allow(non_snake_case)]
+#[jni(package = "mp.code", class = "Extensions")]
+fn version() -> String {
+	crate::version()	
+}
+
 /// Calculate the XXH3 hash for a given String.
 #[jni(package = "mp.code", class = "Extensions")]
 fn hash(content: String) -> i64 {

src/ffi/java/workspace.rs

@@ -31,6 +31,12 @@ fn active_buffers(workspace: &mut Workspace) -> Vec<String> {
 	workspace.buffer_list()
 }
 
+/// Gets a list of the active buffers.
+#[jni(package = "mp.code", class = "Workspace")]
+fn user_list(workspace: &mut Workspace) -> Vec<String> {
+	workspace.user_list()
+}
+
 /// Create a new buffer.
 #[jni(package = "mp.code", class = "Workspace")]
 fn create_buffer(workspace: &mut Workspace, path: String) -> Result<(), RemoteError> {

src/ffi/js/ext.rs

@@ -1,8 +1,12 @@
 use napi_derive::napi;
-use crate::ext::hash;
 
 
 #[napi(js_name = "hash")]
 pub fn js_hash(str : String) -> napi::Result<i64>{
-    Ok(hash(str))
+    Ok(crate::ext::hash(str))
 }
+
+#[napi(js_name = "version")]
+pub fn js_version(str : String) -> napi::Result<String>{
+    Ok(crate::version())
+}

src/ffi/lua/mod.rs

@@ -27,6 +27,10 @@ fn entrypoint(lua: &Lua) -> LuaResult<LuaTable> {
 		Ok(crate::ext::hash(txt))
 	)?)?;
 
+	exports.set("version", lua.create_function(|_, ()|
+		Ok(crate::version())
+	)?)?;
+
 	// runtime
 	exports.set("setup_driver", lua.create_function(ext::a_sync::setup_driver)?)?;
 	exports.set("poll_callback", lua.create_function(|lua, ()| {

src/ffi/python/mod.rs

@@ -132,6 +132,11 @@ impl Driver {
 	}
 }
 
+#[pyfunction]
+fn version() -> String {
+	crate::version()
+}
+
 #[pyfunction]
 fn init() -> PyResult<Driver> {
 	let (rt_stop_tx, mut rt_stop_rx) = oneshot::channel::<()>();
@@ -257,6 +262,7 @@ impl IntoPy<PyObject> for crate::api::User {
 
 #[pymodule]
 fn codemp(m: &Bound<'_, PyModule>) -> PyResult<()> {
+	m.add_function(wrap_pyfunction!(version, m)?)?;
 	m.add_function(wrap_pyfunction!(init, m)?)?;
 	m.add_function(wrap_pyfunction!(get_default_config, m)?)?;
 	m.add_function(wrap_pyfunction!(connect, m)?)?;

src/lib.rs

@@ -14,7 +14,7 @@
 //! The library also provides ready-to-use bindings in a growing number of other programming languages,
 //! to support a potentially infinite number of editors.
 //!
-//! # Overview 
+//! # Overview
 //! The main entrypoint is [`Client::connect`], which establishes an authenticated connection with
 //! a supported remote server and returns a [`Client`] handle to interact with it.
 //!
@@ -75,7 +75,7 @@
 //! # };
 //! ```
 //!
-//! ## FFI 
+//! ## FFI
 //! As mentioned, we provide bindings in various programming languages. To obtain them, you can
 //! compile with the appropriate feature flag. Currently, the following are supported:
 //! * `lua`
@@ -121,3 +121,8 @@ pub mod ffi;
 
 /// internal network services and interceptors
 pub(crate) mod network;
+
+/// Get the current version of the client
+pub fn version() -> String {
+	env!("CARGO_PKG_VERSION").to_owned()
+}