websocket-bridge

Background

This project is inspired by deno-bridge. Deno-bridge provides a great idea to create a WebSocket connection between emacs and deno, making emacs communicate with deno.

But when I write emacs plugins, I need a python package to provide some ability. So I try to transplant deno-bridge to python.

When I try to implement python-bridge, I think I could make it more general as websocket-bridge.

Theory

Emacs uses emacs-websocket to create a WebSocket server; other language extensions make WebSocket clients connect to the emacs server. So emacs can communicate with other languages’ programs.

Install

Download websocket-bridge

git clone --depth=1 -b main https://github.com/ginqi7/websocket-bridge ~/.emacs.d/site-lisp/websocket-bridge/

Install Dependences

emacs-websocket

Add to ~/.emacs

From here on, you can add the full path to the websocket-bridge installation directory to your Emacs load-path, then add the following to init.el:

(add-to-list 'load-path "~/.emacs.d/site-lisp/websocket-bridge/")
(require 'websocket-bridge)

Example

I write a demo to show you how simple write app base on websocket-brige:

Elisp (websocket-bridge-demo.el)

(require 'websocket-bridge)
(setq websocket-bridge-demo-py-path (concat (file-name-directory load-file-name) "websocket-bridge-demo.py"))
(websocket-bridge-start "demo" "python" websocket-bridge-demo-py-path)
(websocket-bridge-call "demo" "ping" "Hello from Emacs.")

Start client process: (websocket-bridge-app-start "demo" "python" deno-bridge-demo-py-path) Call TypeScript function from Emacs: (websocket-bridge-call "demo" "ping" "Hello from Emacs.") Clean Deno process: execute command websocket-bridge-app-exit and select application name

Python (websocket-bridge-demo.py)

import websocket_bridge_python

async def on_message(message): 
    info = json.loads(message)
    [func_name, func_args] = info[1]
    if (func_name == "ping"): 
        print("Emacs message: ", func_args)
        emacsVar = await bridge.get_emacs_var("websocket-bridge-app-list")
        print("Emacs var 'websocket-bridge-app-list': ", emacs_var)
        bridge.message_to_emacs("Hi from Python")
        bridge.eval_in_emacs('(message \"Eval from Python\")')

bridge = websocket_bridge_python.bridge_app_regist(on_message) # regist message handle function
asyncio.run(bridge.start()))

Deno (websocket-bridge-demo.ts)

import { bridgeAppRegist } from "https://deno.land/x/websocket_bridge@0.0.1/mod.ts";

  const bridge = bridgeAppRegist(onMessage)

  async function onMessage(message) {
      console.log(message)
      const [funcName, funcArgs] = JSON.parse(message)[1]

      if (funcName == "ping") {
          console.log("Emacs message: ", funcArgs)

          const emacsVar = await bridge.getEmacsVar("deno-bridge-app-list")
          console.log("Emacs var 'deno-bridge-app-list': ", emacsVar)

          bridge.messageToEmacs("Hi from TypeScript")

          bridge.evalInEmacs('(message \"Eval from TypeScript\")')
      }
  }

Other