blob: 10dde7810e91475b7da27e8af5b8c8c64e4e08a7 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
Lua LPeg lexers for vis
=======================
Vis reuses the [Lua](http://www.lua.org/) [LPeg](http://www.inf.puc-rio.br/~roberto/lpeg/)
based lexers from the [Scintillua](http://foicica.com/scintillua/) project.
# Vis integration
Vis searches the lexers in the following locations (check the end of the
`:help` output for the exact paths used by your binary):
* `$VIS_PATH/lexers`
* `./lua/lexers` relative to the binary location (using `/proc/self/exe`)
* `$XDG_CONFIG_HOME/vis/lexers` where `$XDG_CONFIG_HOME` refers to
`$HOME/.config` if unset.
* `/usr/local/share/vis/lexers` or `/usr/share/vis/lexers` depending on
the build configuration
* `package.path` (standard lua search path)
At runtime a specific lexer can be loded by means of `:set syntax <name>`
where `<name>` corresponds to the filename without the `.lua` extension.
# Adding new lexers
To add a new lexer, start with the template quoted below or a lexer of a
similiar language. Read the
[lexer module documentation](http://foicica.com/scintillua/api.html#lexer).
The [LPeg](http://www.inf.puc-rio.br/~roberto/lpeg/) introduction might also
be useful.
For development purposes it is recommended to test the lexers from a lua
script as described in the
[Scintillua manual](http://foicica.com/scintillua/manual.html#Using.Scintillua.as.a.Lua.Library).
To enable auto syntax highlighting when opening a file you can associate your
new lexer with a set of file extensions by adding a corresponding entry into
the table found in [`plugins/filetype.lua`](../plugins/filetype.lua) file.
Changes to existing lexers should also be sent upstream for consideration.
A template for new lexers:
```
-- ? LPeg lexer.
local l = require('lexer')
local token, word_match = l.token, l.word_match
local P, R, S = lpeg.P, lpeg.R, lpeg.S
local M = {_NAME = '?'}
-- Whitespace.
local ws = token(l.WHITESPACE, l.space^1)
M._rules = {
{'whitespace', ws},
}
M._tokenstyles = {
}
return M
```
# Color Themes
The `../themes` directory contains the color schemes. Depending on the
number of colors supported by your terminal, vis will start with either
the `default-16` or `default-256` theme. Symlink it to your prefered
style or add a command like the following one to your `visrc.lua`:
```
vis:command("set theme solarized")
```
# Dependencies
* [Lua](http://www.lua.org/) 5.1 or greater
* [LPeg](http://www.inf.puc-rio.br/~roberto/lpeg/) 0.12 or greater
|
