Documentation
¶
Overview ¶
Package highlighting contains provides NeoVim RPC client for syntax highlighting.
Index ¶
- Variables
- func AttachToBuffer(v *nvim.Nvim, buf *nvim.Buffer) error
- func DetachFromBuffer(v *nvim.Nvim, buf *nvim.Buffer) error
- func GenManifest(host string) []byte
- func RunPlugin() error
- func SetVirtualText(b *nvim.Batch, buf *nvim.Buffer, nsID int, line int, chunks []Chunk, ...)
- type Chunk
- type Document
- type Highlighter
- func (h *Highlighter) HandleBufChangedTickEvent(buf nvim.Buffer, changedTick int)
- func (p *Highlighter) HandleBufDetachEvent(buf *nvim.Buffer)
- func (h *Highlighter) HandleBufLinesEvent(buf *nvim.Buffer, changedTick int, firstLine, lastLine int, data [][]byte, ...)
- func (h *Highlighter) HandleBufReadEvent(buf nvim.Buffer, filename string)
- func (h *Highlighter) Serve() error
Constants ¶
This section is empty.
Variables ¶
var DocIndex = make(map[nvim.Buffer]*Document)
var NoOpts = make(map[string]interface{})
NoOpts is a value which could be passed in NeoVim RPC.
Functions ¶
func AttachToBuffer ¶
AttachToBuffer attaches plugin to buffer's updates. This method is temporary until it is supported in official Golang client.
func DetachFromBuffer ¶
DetachFromBuffer detaches plugin from buffer's updates. This method is temporary until it is supported in official Golang client.
func GenManifest ¶
GenManifest generates a remote plugin manifest. It is parametrized with plugin host name. In this particular case host name is name of plugin binary.
Types ¶
type Document ¶
type Document struct {
Lines [][]byte
// contains filtered or unexported fields
}
Document is a mirrored content of NeoVim buffer. This object provides human-readable interface for document management, hightlighting and versioning.
func (*Document) Hightlight ¶
Hightlight adds hightlight to buffer for an entire document.
func (*Document) HightlightHunk ¶
HightlightHunk adds hightlight to a chunk of lines of a buffer.
type Highlighter ¶
type Highlighter struct {
// contains filtered or unexported fields
}
Highlighter is an implementation of semantic hightlighting for BNF. It manages all RPC request and response between NeoVim instance and BNF parser.
func (*Highlighter) HandleBufChangedTickEvent ¶
func (h *Highlighter) HandleBufChangedTickEvent( buf nvim.Buffer, changedTick int, )
func (*Highlighter) HandleBufDetachEvent ¶
func (p *Highlighter) HandleBufDetachEvent(buf *nvim.Buffer)
func (*Highlighter) HandleBufLinesEvent ¶
func (*Highlighter) HandleBufReadEvent ¶
func (h *Highlighter) HandleBufReadEvent(buf nvim.Buffer, filename string)
func (*Highlighter) Serve ¶
func (h *Highlighter) Serve() error
Source Files