jinzhongjia / znvim

neovim remote rpc client implementation with zig

znvim

znvim is a neovim remote rpc client implementation with zig.

This package is under developing!

Document

https://jinzhongjia.github.io/znvim/

Features

• Implementation of multiple remote calling methods
• Support all neovim rpc channels
• Completely thread safe
• Asynchronous

Getting Started

0.12.0 / 0.13.0

1. Add to build.zig.zon

zig fetch --save https://github.com/jinzhongjia/znvim/archive/{commit or branch}.tar.gz

2. Config build.zig

const znvim = b.dependency("znvim", .{
    .target = target,
    .optimize = optimize,
});

// add module
exe.root_module.addImport("znvim", znvim.module("znvim"));

To use this lib

You can find example on test fold!

Recommend to learn about what msgpack is (this lib uses zig-msgpack) and read neovim's API documentation.

znvim's Issues

Reflector

My previous implementation was a piece of shit
Now I have to implement this library completely from scratch

feat: Use object pools to reduce the overhead of memory allocation and release

Feature proposal: userdata in method callbacks

Wondering what you think of change the function signatures of ReqMethodType and NotifyMethodType from:

pub const ReqMethodType = *const fn (params: Payload, allocator: Allocator) ResultType;
pub const NotifyMethodType = *const fn (params: Payload, allocator: Allocator) void;

to:

pub const ReqMethodType = struct {
    userdata: ?*anyopaque = null,
    fn: *const fn (params: Payload, allocator: Allocator, userdata: ?*anyopaque) ResultType,
};
pub const NotifyMethodType = struct {
    userdata: ?*anyopaque = null,
    fn: *const fn (params: Payload, allocator: Allocator, userdata: ?*anyopaque) void,
};

This would allow embedders to pass along arbitrary userdata through each callback, preventing the need for global variables.

I can send in a PR if you are ok with this change.

[Feature]: Windows support, named pipe and stdio

Add named pipe support, for windows!

Can I send signal from Neovim to trigger action in Zig?

Hello, and thank you very much for creating this library.

I'm trying to create an application that can interact with a live Neovim instance (via unix pipe) both ways back and forth.
I saw in your test file that connecting and sending commands to a live Neovim instance via unix pipe from Zig is possible.

However, I wonder if it's possible to, let's say, I press a keymap in Neovim, and my application in Zig receives that signal, and shows up.

Is this possible? Thank you very much!

Adding LICENSE to the project

Hello and thank you for creating the library and make it open source.
I really want to start using your library but I can't find any LICENSE file in the repo.
Could you please add a LICENSE file to indicate how permissive the usage of the code in this repo is?
Thank you kindly.