summaryrefslogtreecommitdiffstats
path: root/tools/frr.vim
blob: 19ac3fc99b315e20e26265b56590885282e4d2c0 (plain)
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
" SPDX-License-Identifier: NONE
" settings & syntax hilighting for FRR codebase
" 2019 by David Lamparter, placed in public domain

let c_gnu=1

function! CStyleFRR()
	syn clear	cFormat
	syn match	cFormat		display "%\(\d\+\$\)\=[-+' #0*]*\(\d*\|\*\|\*\d\+\$\)\(\.\(\d*\|\*\|\*\d\+\$\)\)\=\([hlLjzt]\|ll\|hh\)\=\([aAbiuoxXDOUfFeEgGcCsSn]\|[pd]\([A-Z][A-Z0-9]*[a-z]*\|\)\|\[\^\=.[^]]*\]\)" contained
	syn match	cFormat		display "%%" contained

	syn keyword	cIterator	frr_each frr_each_safe frr_each_from
	syn keyword	cMacroOp	offsetof container_of container_of_null array_size

	syn keyword	cStorageClass	atomic
	syn keyword	cFormatConst	PRId64	PRIu64	PRIx64
	syn keyword	cFormatConst	PRId32	PRIu32	PRIx32
	syn keyword	cFormatConst	PRId16	PRIu16	PRIx16
	syn keyword	cFormatConst	PRId8	PRIu8	PRIx8

	" you can unlink these by just giving them their own hilighting / color
	hi link cFormatConst	cFormat
	hi link cIterator	cRepeat
	hi link cMacroOp	cOperator

	" indentation
	setlocal cindent
	setlocal cinoptions=:0,(0,u4,w1,W8
	setlocal shiftwidth=8
	setlocal softtabstop=0
	setlocal textwidth=0
	setlocal fo=croql
	setlocal noet
endfunction

" auto-apply the above based on path rules
"autocmd BufRead,BufNewFile /home/.../frr/*.[ch] call CStyleFRR()

" only load xref file once, remember on script-scope
let s:xrefjson = ""
let s:xrefpath = ""

" call directly to force reload with :call FRRLoadXrefJson()
function! FRRLoadXrefJson() abort
	let s:xrefpath = findfile("frr.xref", ".;")
	if empty(s:xrefpath)
		throw "frr.xref JSON file not found in current or parent directories"
	endif
	let xreflines = readfile(s:xrefpath)
	let s:xrefjson = json_decode(join(xreflines, "\n"))
endfunction

function! FRRXrefJson() abort
	if empty(s:xrefjson)
		call FRRLoadXrefJson()
	endif
	return s:xrefjson
endfunction

function! FRRGotoXref(ident) abort
	let refs = FRRXrefJson()["refs"]
	if has_key(refs, a:ident)
		" TODO: in rare cases, one ID may occur in multiple places.
		" Add some UI for that.  (This happens if the exact same
		" format string is logged in multiple places in the same
		" file.)
		let loc = refs[a:ident][0]
		let basepath = fnamemodify(s:xrefpath, ":p:h")
		let path = fnamemodify(basepath . "/" . loc["file"], ":.")
		execute "e ".fnameescape(path)
		execute ":".loc["line"]
	else
		echoerr printf("cannot find xref with ID %s", a:ident)
	endif
endfunction

" invoke as :GotoXref 23456-ABCDE
command! -bang -nargs=1 GotoXref :call FRRGotoXref(<q-args>)