blob: 69c136d5b98fd30002b5e9493347c21b6b3e570e (
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
|
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:
* `$VIS_PATH/lexers`
* `./lua/lexers` relative to the binary location (using `/proc/self/exe`)
* `$XDG_CONFIG_HOME/vis/lexers`
* `/usr/local/share/vis/lexers`
* `/usr/share/vis/lexers`
* `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.txt` found in this directory
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 at the end of the [vis.lua](/vis.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. At startup the
`default.lua` theme which should be a symlink to your prefered style is
used. Themes can be changed at runtime via the `:set theme <name>`
command where `<name>` does not include the `.lua` file extension.
# Dependencies
* [Lua](http://www.lua.org/) 5.1 or greater
* [LPeg](http://www.inf.puc-rio.br/~roberto/lpeg/) 0.12 or greater
|
