diff --git a/ftdetect/drupal.vim b/ftdetect/drupal.vim index 76c4c2f..6f999e0 100644 --- a/ftdetect/drupal.vim +++ b/ftdetect/drupal.vim @@ -8,4 +8,4 @@ autocmd BufRead,BufNewFile *.theme set filetype=php autocmd BufRead,BufNewFile *.engine set filetype=php autocmd BufRead,BufNewFile *.test set filetype=php " info and make files use INI syntax. -autocmd BufRead,BufNewFile *.{info,make,build} set filetype=dosini +autocmd BufRead,BufNewFile *.{info,make,build} set filetype=drini diff --git a/ftplugin/drini.vim b/ftplugin/drini.vim new file mode 100644 index 0000000..f70c6eb --- /dev/null +++ b/ftplugin/drini.vim @@ -0,0 +1,20 @@ +setl autoindent "Auto indent based on previous line +setl smartindent "Smart autoindenting on new line +setl smarttab "Respect space/tab settings +setl expandtab "Tab key inserts spaces +setl tabstop=2 "Use two spaces for tabs +setl shiftwidth=2 "Use two spaces for auto-indent +setl textwidth=80 "Limit comment lines to 80 characters. +setl formatoptions-=t +setl formatoptions+=croql +" -t: Do not apply 'textwidth' to code. +" +c: Apply 'textwidth' to comments. +" +r: Continue comments after hitting in Insert mode. +" +o: Continue comments after when using 'O' or 'o' to open a new line. +" +q: Format comments using q. +" +l: Do not break a comment line if it is long before you start. +setl comments=b:;\ -,b:; +" Recognize '; ' at the start of a line as a comment and recognize one level +" of lists with '; - '. Not smart enough to require ';' in first column. +setl omnifunc=syntaxcomplete#Complete +" Complete keywords using . :help ft-syntax-omni diff --git a/syntax/drini.vim b/syntax/drini.vim new file mode 100644 index 0000000..3a9bc56 --- /dev/null +++ b/syntax/drini.vim @@ -0,0 +1,159 @@ +" Vim syntax file +" Language: Configuration File (ini file) for Drupal, Drush +" Author: Benji Fisher +" Based On: dosini.vim by Sean M. McKee +" Last Change: Sun Oct 30 04:00 PM 2011 EDT + +" TODO: strict checking for the name, description, core, dependencies lines. +" Note that dependencies can specify version (in)equalities. +" References: +" - modules (7.x): http://drupal.org/node/542202 +" modules (6.x): http://drupal.org/node/231036 +" themes (6.x, 7.x): http://drupal.org/node/171205 +" format (7.x): +" http://api.drupal.org/api/drupal/includes--common.inc/function/drupal_parse_info_format/7 +" format (6.x): +" http://api.drupal.org/api/drupal/includes--common.inc/function/drupal_parse_info_file/6 + +" For version 5.x: Clear all syntax items +" For version 6.x: Quit when a syntax file was already loaded +if version < 600 + syntax clear +elseif exists("b:current_syntax") + finish +endif + +syn case match +syn clear " TODO: remove this line. + +" Find the Drupal core version. +let s:save_cursor = getpos(".") +call cursor(1, 1) +let s:core_re = '^\s*core\s*=\s*\zs\d\+\ze\.x\s*$' +let s:core_line = search(s:core_re, 'cn', 500) +let s:core = matchstr(getline(s:core_line), s:core_re) +call setpos('.', s:save_cursor) + +" Is this a theme, a module, or a Drush make file? +" TODO: How do we recognize a Profiler ini file? For now, Profiler includes +" all syntax items, which may be the right thing to do anyway. +function! s:IniType() + let ext = expand('%:e') + if ext == 'make' || ext == 'build' + return 'make' + endif + " If the extension is not 'info' at this point, I do not know how we got + " here. + let path = expand('%:p') + let m_index = strridx(path, '/modules/') + let t_index = strridx(path, '/themes/') + if m_index == -1 && t_index == -1 + let m_index = strridx(path, '/modules/') + let t_index = strridx(path, '/themes/') + endif + if m_index > t_index + return 'module' + elseif m_index < t_index + return 'theme' + else " We are not inside a themes/ directory, nor a mudules/ directory. Do not guess. + return '' + endif +endfun + +syn match driniStart nextgroup=@driniRequired,@driniPackage,@driniOptional skipwhite /^/ +" The following clusters contain all the legal keywords. They all declare +" nextgroup=driniEquals or nextgroup=driniIndex +syn cluster driniRequired contains=driniName,driniDescr,driniCore +syn cluster driniOptional contains=driniScalar,driniArray +syn cluster driniPackage contains=driniDiscouraged,driniCore + +syn region driniIndex contained skipwhite skipempty + \ nextgroup=driniIndex,driniEquals matchgroup=driniBracket start=/\[/ end=/]/ +syn match driniEquals contained skipwhite skipempty nextgroup=@driniValue /=/ +syn cluster driniValue contains=driniString,driniRHS +syn region driniString contained start=/"/ skip=/\\"/ end=/"/ +syn region driniString contained start=/'/ skip=/\\'/ end=/'/ +syn match driniRHS contained /[^\t "';].*/ + +syn cluster driniScalar contains=driniProfiler +syn cluster driniArray contains=driniDep,driniProfilerArray + +" Keywords common to all file types. +syn keyword driniName nextgroup=driniEquals skipwhite skipempty name +syn keyword driniDescr nextgroup=driniEquals skipwhite skipempty description +syn keyword driniCore nextgroup=driniEquals skipwhite skipempty core +syn keyword driniDep nextgroup=driniIndex skipwhite skipempty dependencies +syn keyword driniDiscouraged nextgroup=driniEquals skipwhite skipempty datestamp project version + +" Profiler module. +syn match driniProfiler nextgroup=driniEquals skipwhite skipempty /\/ +syn keyword driniProfilerArray nextgroup=driniIndex skipwhite skipempty nodes terms users variables +syn match driniProfilerArray nextgroup=driniIndex skipwhite skipempty /\/ + +let s:initype = s:IniType() + +if s:initype == 'module' || s:initype == '' + syn cluster driniScalar add=driniModule + syn cluster driniArray add=driniModuleArray + if !s:core || s:core >= 6 + syn keyword driniModule nextgroup=driniEquals skipwhite skipempty hidden package php + endif + + if !s:core || s:core >= 7 + syn keyword driniModule nextgroup=driniEquals skipwhite skipempty configure required + syn keyword driniModuleArray nextgroup=driniIndex skipwhite skipempty files scripts stylesheets + endif + +elseif s:initype == 'theme' || s:initype == '' + syn cluster driniScalar add=driniTheme + syn cluster driniArray add=driniThemeArray + syn keyword driniTheme nextgroup=driniEquals skipwhite skipempty engine php screenshot + " Keywords cannot contain spaces. Make "base" and "theme" matches, too, or + " 'base theme' will not work. There is conflicting documentation ... + syn match driniTheme nextgroup=driniEquals skipwhite skipempty /\/ + syn keyword driniThemeArray nextgroup=driniIndex skipwhite skipempty features regions scripts stylesheets + syn clear driniDep +elseif s:initype == 'make' || s:initype == '' + syn cluster driniScalar add=driniMake + syn cluster driniArray add=driniMakeArray + syn keyword driniMake nextgroup=driniEquals skipwhite skipempty api + syn keyword driniMakeArray nextgroup=driniIndex skipwhite skipempty includes libraries projects +endif + +syn match driniComment /^;.*$/ contains=driniStart +syn match driniOverLength /\%81v.*/ containedin=driniComment contained + +" Define the default highlighting. The 'default' keyword requires vim 5.8+. + +" Link all groups to the cluster that contains them. +highlight default link driniName driniRequired +highlight default link driniDescr driniRequired +highlight default link driniCore driniRequired +highlight default link driniDiscouraged driniPackage +highlight default link driniModule driniScalar +highlight default link driniTheme driniScalar +highlight default link driniMake driniScalar +highlight default link driniProfiler driniScalar +highlight default link driniModuleArray driniArray +highlight default link driniDep driniArray +highlight default link driniThemeArray driniArray +highlight default link driniMakeArray driniArray +highlight default link driniProfilerArray driniArray +highlight default link driniScalar driniOptional +highlight default link driniArray driniOptional + +highlight default link driniRequired Keyword +highlight default link driniPackage Keyword +highlight default link driniOptional Keyword +highlight default link driniBracket Operator +highlight default link driniIndex String +highlight default link driniEquals Operator +highlight default link driniRHS String +highlight default link driniString String + +highlight default link driniComment Comment +highlight default link driniOverLength Error + +let b:current_syntax = "drini" + +" vim:ts=8