Plugin UI architecture - minsuk-jang/teamproject GitHub Wiki

구형 Vim의 거대한 코드베이스에 기여하는 요소는 GUI 인터페이스를 위한 수십 개의 widget toolkit을 분명하게 지원한다는 것입니다. Neovim은 외부 클라이언트에 GUI 구현을 위임함으로써 이를 방지합니다. 클라이언트는 Neovim`nvim '을 제어합니다. 프로세스는 msgpack-rpc API를 통해 다음과 같이 할 수 있습니다.

• Vim 명령 실행
• Vimscript 표현식 평가
• 버퍼, 윈도우 및 탭 조작
• 편집기 이벤트 수신 / 처리

게다가 원격 API는 쉽게 확장 할 수 있도록 설계 되었으므로 항상 새로운 가능성이 존재합니다.

**Neovim * remote plugin * (rplugin)은 nvim과 대화하는 프로그램입니다. 원격 API ** (임의의 전송 메커니즘을 통해 도달 할 수 있습니다 : TCP 주소, 명명 된 파이프, stdin / stdout ...).

파이썬 REPL과 client library를 사용하여 대화식으로 현재 API를 테스트 할 수는 있지만 편집기를 확장하는 데는 그리 유용하지 않습니다. 일반적인 Neovim 플러그인은 다음의 의사 코드를 실행합니다 :

while true
    handle(next_vim_event())

생각해 보면 legacy Vim 플러그인이 현재 어떻게 작동하는는 꽤 많이 있습니다. 흥미있는 일이 발생할 때마다 자동 명령을 등록하여 실행합니다. 차이점은 Neovim이 이벤트를 다른 프로세스로 전파하고 비동기 적으로 명령을 수신 할 수 있다는 점입니다. 그러면 플러그인에 대한 흥미로운 가능성이 열립니다.

• 그들은 어떤 프로그래밍 언어로도 작성 될 수 있습니다.
  • 운영 체제와 더 잘 통합되는 고급 언어로 작성된 최신 GUI (예 : Windows의 C # / WPF 또는 OS X의 Ruby / Cocoa).
• 버그가 있어 편집기(서버)가 충돌 할 가능성이 적어 보안 처리됩니다.
• 편집기를 차단하지 않고 배경 작업을 수행 할 수 있습니다.
• GUI로 직접 처리 할 수있는 ** 맞춤 이벤트 **를 내보낼 수 있습니다. (Sublime의 minimap과 같은 고급 기능 구현 가능)
• 여러 원격 GUI를 연결 / 분리하여 편집 세션을 공유 할 수 있습니다.
• headless 테스트 간소화.
• 편집기를 다른 프로그램에 포함하기. 사실, GUI는 네비게이션을 내장한 프로그램으로 볼 수 있습니다.

UI 프로그램

UI는 사용자와 편집기 사이의 다리 역할을 하는 플러그인입니다. 다음은 UI 프로그램의 의사 코드입니다.

while true
    handle(next_vim_or_user_event())

사용자 이벤트 (키 누름, 마우스 클릭 등)를 청취하고, 이를 연결된 Neovim 장치로 변환 한 다음 사용자에게 * 다시 그리기 * 이벤트를 반환해야 한다는 점을 제외하고는 UI가 아닌 플러그인과 거의 동일합니다.

다음은 샘플 process tree입니다.

Neovim ------> GUI 1 (attach/detach to running instance)
  |  |
  |   `------> GUI 2 (communicating on a different socket or transport 
  |                   mechanism, but sharing the same session with GUI 1)
   `--> Plugin 1
  |
   `--> Plugin 2
  |
   `--> Plugin 3

다음은 nvim 시작 프로세스의 개요입니다 :

1. 소켓 또는 TCP 주소에서 수신 대기 (무시하지 않는 한 무작위)
   • UI는 nvim에 대한 명령 행 인자로 지정 될 수 있습니다.
2. ~ / .config / nvim / init.vim을 읽으십시오.
   • 플러그인 발견 (UI 포함)
3. 청취 주소를 전달하여 UI 프로그램을 시작하십시오.
4. 모든 플러그인으로 양방향 의사 소통 채널을 엽니다.

다음은 가상 GUI 부분입니다.

gui -> vim: {"id": 1, "method": "initClient", 
             "params": {"size": {"rows": 20, "columns": 25}}}
vim -> gui: {"id": 1, "result": {"clientId": 1}}
vim -> gui: {"method": "redraw", 
             "params": {"clientId": 1, "lines": {"5": "Welcome to neovim!"}}}
gui -> vim: {"id": 2, "method": "keyPress", 
             "params": {"keys": ["H", "e", "l", "l", "o"]}}
vim -> gui: {"method": "redraw", 
             "params": {"clientId": 1, "lines": {"1": "Hello", "5": ""}}}