" Tests for parsing the modeline.

func Test_modeline_invalid()
  " This was reading allocated memory in the past.
  call writefile(['vi:0', 'nothing'], 'Xmodeline', 'D')
  let modeline = &modeline
  set modeline
  call assert_fails('split Xmodeline', 'E518:')

  " Missing end colon (ignored).
  call writefile(['// vim: set ts=2'], 'Xmodeline')
  edit Xmodeline_version
  call assert_equal(8, &ts)
  bwipe!

  " Missing colon at beginning (ignored).
  call writefile(['// vim set ts=2:'], 'Xmodeline')
  edit Xmodeline_version
  call assert_equal(8, &ts)
  bwipe!

  " Missing space after vim (ignored).
  call writefile(['// vim:ts=2:'], 'Xmodeline')
  edit Xmodeline_version
  call assert_equal(8, &ts)
  bwipe!

  let &modeline = modeline
  bwipe!
endfunc

func Test_modeline_filetype()
  call writefile(['vim: set ft=c :', 'nothing'], 'Xmodeline_filetype', 'D')
  let modeline = &modeline
  set modeline
  filetype plugin on
  split Xmodeline_filetype
  call assert_equal("c", &filetype)
  call assert_equal(1, b:did_ftplugin)
  call assert_equal("ccomplete#Complete", &ofu)

  bwipe!
  let &modeline = modeline
  filetype plugin off
endfunc

func Test_modeline_syntax()
  call writefile(['vim: set syn=c :', 'nothing'], 'Xmodeline_syntax', 'D')
  let modeline = &modeline
  set modeline nomodelinestrict
  syntax enable
  split Xmodeline_syntax
  call assert_equal("c", &syntax)
  call assert_equal("c", b:current_syntax)

  bwipe!
  let &modeline = modeline
  set modelinestrict
  syntax off
endfunc

func Test_modeline_keymap()
  CheckFeature keymap
  call writefile(['vim: set keymap=greek :', 'nothing'], 'Xmodeline_keymap', 'D')
  let modeline = &modeline
  set modeline nomodelinestrict
  split Xmodeline_keymap
  call assert_equal("greek", &keymap)
  call assert_match('greek\|grk', b:keymap_name)

  bwipe!
  let &modeline = modeline
  set modelinestrict
  set keymap= iminsert=0 imsearch=-1
endfunc

func Test_modeline_version()
  let modeline = &modeline
  set modeline

  " Test with vim:{vers}: (version {vers} or later).
  call writefile(['// vim' .. v:version .. ': ts=2:'], 'Xmodeline_version', 'D')
  edit Xmodeline_version
  call assert_equal(2, &ts)
  bwipe!

  call writefile(['// vim' .. (v:version - 100) .. ': ts=2:'], 'Xmodeline_version')
  edit Xmodeline_version
  call assert_equal(2, &ts)
  bwipe!

  call writefile(['// vim' .. (v:version + 100) .. ': ts=2:'], 'Xmodeline_version')
  edit Xmodeline_version
  call assert_equal(8, &ts)
  bw!

  " Test with vim>{vers}: (version after {vers}).
  call writefile(['// vim>' .. v:version .. ': ts=2:'], 'Xmodeline_version')
  edit Xmodeline_version
  call assert_equal(8, &ts)
  bwipe!

  call writefile(['// vim>' .. (v:version - 100) .. ': ts=2:'], 'Xmodeline_version')
  edit Xmodeline_version
  call assert_equal(2, &ts)
  bwipe!

  call writefile(['// vim>' .. (v:version + 100) .. ': ts=2:'], 'Xmodeline_version')
  edit Xmodeline_version
  call assert_equal(8, &ts)
  bwipe!

  " Test with vim<{vers}: (version before {vers}).
  call writefile(['// vim<' .. v:version .. ': ts=2:'], 'Xmodeline_version')
  edit Xmodeline_version
  call assert_equal(8, &ts)
  bwipe!

  call writefile(['// vim<' .. (v:version - 100) .. ': ts=2:'], 'Xmodeline_version')
  edit Xmodeline_version
  call assert_equal(8, &ts)
  bwipe!

  call writefile(['// vim<' .. (v:version + 100) .. ': ts=2:'], 'Xmodeline_version')
  edit Xmodeline_version
  call assert_equal(2, &ts)
  bwipe!

  " Test with vim={vers}: (version {vers} only).
  call writefile(['// vim=' .. v:version .. ': ts=2:'], 'Xmodeline_version')
  edit Xmodeline_version
  call assert_equal(2, &ts)
  bwipe!

  call writefile(['// vim=' .. (v:version - 100) .. ': ts=2:'], 'Xmodeline_version')
  edit Xmodeline_version
  call assert_equal(8, &ts)
  bwipe!

  call writefile(['// vim=' .. (v:version + 100) .. ': ts=2:'], 'Xmodeline_version')
  edit Xmodeline_version
  call assert_equal(8, &ts)
  bwipe!

  let &modeline = modeline
endfunc

func Test_modeline_colon()
  let modeline = &modeline
  let modelinestrict = &modelinestrict
  set modeline nomodelinestrict

  call writefile(['// vim: set showbreak=\: ts=2: sw=2'], 'Xmodeline_colon', 'D')
  edit Xmodeline_colon

  " backlash colon should become colon.
  call assert_equal(':', &showbreak)

  " 'ts' should be set.
  " 'sw' should be ignored because it is after the end colon.
  call assert_equal(2, &ts)
  call assert_equal(8, &sw)

  let &modeline = modeline
  let &modelinestrict = modelinestrict
endfunc

func s:modeline_fails(what, text, error)
  " Don't use CheckOption(), it would skip the whole test
  " just for a single un-supported option
  if !exists('+' .. a:what)
    return
  endif
  let fname = "Xmodeline_fails_" . a:what
  call writefile(['vim: set ' . a:text . ' :', 'nothing'], fname, 'D')
  let modeline = &modeline
  let modelinestrict = &modelinestrict
  set modeline nomodelinestrict
  filetype plugin on
  syntax enable
  call assert_fails('split ' . fname, a:error)
  call assert_equal("", &filetype)
  call assert_equal("", &syntax)

  bwipe!
  let &modeline = modeline
  let &modelinestrict = modelinestrict
  filetype plugin off
  syntax off
endfunc

func Test_modeline_filetype_fails()
  call s:modeline_fails('filetype', 'ft=evil$CMD', 'E474:')
endfunc

func Test_modeline_syntax_fails()
  call s:modeline_fails('syntax', 'syn=evil$CMD', 'E474:')
endfunc

func Test_modeline_keymap_fails()
  call s:modeline_fails('keymap', 'keymap=evil$CMD', 'E474:')
endfunc

func Test_modeline_fails_always()
  call s:modeline_fails('backupdir', 'backupdir=Something()', 'E520:')
  call s:modeline_fails('cdpath', 'cdpath=Something()', 'E520:')
  call s:modeline_fails('charconvert', 'charconvert=Something()', 'E520:')
  call s:modeline_fails('completefunc', 'completefunc=Something()', 'E520:')
  call s:modeline_fails('cscopeprg', 'cscopeprg=Something()', 'E520:')
  call s:modeline_fails('diffexpr', 'diffexpr=Something()', 'E520:')
  call s:modeline_fails('directory', 'directory=Something()', 'E520:')
  call s:modeline_fails('equalprg', 'equalprg=Something()', 'E520:')
  call s:modeline_fails('errorfile', 'errorfile=Something()', 'E520:')
  call s:modeline_fails('exrc', 'exrc=Something()', 'E520:')
  call s:modeline_fails('findfunc', 'findfunc=Something', 'E520:')
  call s:modeline_fails('formatprg', 'formatprg=Something()', 'E520:')
  call s:modeline_fails('fsync', 'fsync=Something()', 'E520:')
  call s:modeline_fails('grepprg', 'grepprg=Something()', 'E520:')
  call s:modeline_fails('helpfile', 'helpfile=Something()', 'E520:')
  call s:modeline_fails('imactivatefunc', 'imactivatefunc=Something()', 'E520:')
  call s:modeline_fails('imstatusfunc', 'imstatusfunc=Something()', 'E520:')
  call s:modeline_fails('imstyle', 'imstyle=Something()', 'E520:')
  call s:modeline_fails('keywordprg', 'keywordprg=Something()', 'E520:')
  call s:modeline_fails('langmap', 'langmap=Something()', 'E520:')
  call s:modeline_fails('luadll', 'luadll=Something()', 'E520:')
  call s:modeline_fails('makeef', 'makeef=Something()', 'E520:')
  call s:modeline_fails('makeprg', 'makeprg=Something()', 'E520:')
  call s:modeline_fails('mkspellmem', 'mkspellmem=Something()', 'E520:')
  call s:modeline_fails('mzschemedll', 'mzschemedll=Something()', 'E520:')
  call s:modeline_fails('mzschemegcdll', 'mzschemegcdll=Something()', 'E520:')
  call s:modeline_fails('modelineexpr', 'modelineexpr', 'E520:')
  call s:modeline_fails('omnifunc', 'omnifunc=Something()', 'E520:')
  call s:modeline_fails('operatorfunc', 'operatorfunc=Something()', 'E520:')
  call s:modeline_fails('perldll', 'perldll=Something()', 'E520:')
  call s:modeline_fails('printdevice', 'printdevice=Something()', 'E520:')
  call s:modeline_fails('patchexpr', 'patchexpr=Something()', 'E520:')
  call s:modeline_fails('printexpr', 'printexpr=Something()', 'E520:')
  call s:modeline_fails('pythondll', 'pythondll=Something()', 'E520:')
  call s:modeline_fails('pythonhome', 'pythonhome=Something()', 'E520:')
  call s:modeline_fails('pythonthreedll', 'pythonthreedll=Something()', 'E520:')
  call s:modeline_fails('pythonthreehome', 'pythonthreehome=Something()', 'E520:')
  call s:modeline_fails('pyxversion', 'pyxversion=Something()', 'E520:')
  call s:modeline_fails('rubydll', 'rubydll=Something()', 'E520:')
  call s:modeline_fails('runtimepath', 'runtimepath=Something()', 'E520:')
  call s:modeline_fails('secure', 'secure=Something()', 'E520:')
  call s:modeline_fails('shell', 'shell=Something()', 'E520:')
  call s:modeline_fails('shellcmdflag', 'shellcmdflag=Something()', 'E520:')
  call s:modeline_fails('shellpipe', 'shellpipe=Something()', 'E520:')
  call s:modeline_fails('shellquote', 'shellquote=Something()', 'E520:')
  call s:modeline_fails('shellredir', 'shellredir=Something()', 'E520:')
  call s:modeline_fails('shellxquote', 'shellxquote=Something()', 'E520:')
  call s:modeline_fails('spellfile', 'spellfile=Something()', 'E520:')
  call s:modeline_fails('spellsuggest', 'spellsuggest=Something()', 'E520:')
  call s:modeline_fails('tcldll', 'tcldll=Something()', 'E520:')
  call s:modeline_fails('titleold', 'titleold=Something()', 'E520:')
  call s:modeline_fails('viewdir', 'viewdir=Something()', 'E520:')
  call s:modeline_fails('viminfo', 'viminfo=Something()', 'E520:')
  call s:modeline_fails('viminfofile', 'viminfofile=Something()', 'E520:')
  call s:modeline_fails('winptydll', 'winptydll=Something()', 'E520:')
  call s:modeline_fails('undodir', 'undodir=Something()', 'E520:')
  " only check a few terminal options
  call s:modeline_fails('t_AB', 't_AB=Something()', 'E520:')
  call s:modeline_fails('t_ce', 't_ce=Something()', 'E520:')
  call s:modeline_fails('t_sr', 't_sr=Something()', 'E520:')
  call s:modeline_fails('t_8b', 't_8b=Something()', 'E520:')
endfunc

func Test_modeline_fails_modelineexpr()
  call s:modeline_fails('balloonexpr', 'balloonexpr=Something()', 'E992:')
  call s:modeline_fails('complete', "complete=FSomething", 'E992:')
  call s:modeline_fails('foldexpr', 'foldexpr=Something()', 'E992:')
  call s:modeline_fails('foldtext', 'foldtext=Something()', 'E992:')
  call s:modeline_fails('formatexpr', 'formatexpr=Something()', 'E992:')
  call s:modeline_fails('guitablabel', 'guitablabel=Something()', 'E992:')
  call s:modeline_fails('guitabtooltip', 'guitabtooltip=Something()', 'E992:')
  call s:modeline_fails('iconstring', 'iconstring=Something()', 'E992:')
  call s:modeline_fails('includeexpr', 'includeexpr=Something()', 'E992:')
  call s:modeline_fails('indentexpr', 'indentexpr=Something()', 'E992:')
  call s:modeline_fails('printheader', 'printheader=Something()', 'E992:')
  call s:modeline_fails('rulerformat', 'rulerformat=Something()', 'E992:')
  call s:modeline_fails('statusline', 'statusline=Something()', 'E992:')
  call s:modeline_fails('tabline', 'tabline=Something()', 'E992:')
  call s:modeline_fails('titlestring', 'titlestring=Something()', 'E992:')
endfunc

func Test_modeline_setoption_verbose()
  let modeline = &modeline
  set modeline

  let lines =<< trim END
  1 vim:ts=2
  2 two
  3 three
  4 four
  5 five
  6 six
  7 seven
  8 eight
  END
  call writefile(lines, 'Xmodeline', 'D')
  edit Xmodeline
  let info = split(execute('verbose set tabstop?'), "\n")
  call assert_match('^\s*Last set from modeline line 1$', info[-1])
  bwipe!

  let lines =<< trim END
  1 one
  2 two
  3 three
  4 vim:ts=4
  5 five
  6 six
  7 seven
  8 eight
  END
  call writefile(lines, 'Xmodeline')
  edit Xmodeline
  let info = split(execute('verbose set tabstop?'), "\n")
  call assert_match('^\s*Last set from modeline line 4$', info[-1])
  bwipe!

  let lines =<< trim END
  1 one
  2 two
  3 three
  4 four
  5 five
  6 six
  7 seven
  8 vim:ts=8
  END
  call writefile(lines, 'Xmodeline')
  edit Xmodeline
  let info = split(execute('verbose set tabstop?'), "\n")
  call assert_match('^\s*Last set from modeline line 8$', info[-1])
  bwipe!

  let &modeline = modeline
endfunc

" Test for the 'modeline' default value in compatible and non-compatible modes
" for root and non-root accounts
func Test_modeline_default()
  set compatible
  call assert_false(&modeline)
  set nocompatible
  call assert_equal(IsRoot() ? 0 : 1, &modeline)
  set compatible&vi
  call assert_false(&modeline)
  set compatible&vim
  call assert_equal(IsRoot() ? 0 : 1, &modeline)
  set compatible& modeline&
endfunc

" Some options cannot be set from the modeline when 'diff' option is set
func Test_modeline_diff_buffer()
  set nomodelinestrict
  call writefile(['vim: diff foldmethod=marker wrap'], 'Xmdifile', 'D')
  set foldmethod& nowrap
  new Xmdifile
  call assert_equal('manual', &foldmethod)
  call assert_false(&wrap)
  set wrap&
  set modelinestrict
  bw
endfunc

func Test_modeline_disable()
  set modeline nomodelinestrict
  call writefile(['vim: sw=2', 'vim: nomodeline', 'vim: sw=3'], 'Xmodeline_disable', 'D')
  edit Xmodeline_disable
  call assert_equal(2, &sw)
  set modelinestrict
endfunc

" If 'nowrap' is set from a modeline, '>' is used forcibly as lcs-extends.
func Test_modeline_nowrap_lcs_extends()
  call writefile([
        \ 'aaa',
        \ 'bbb',
        \ 'ccc                    evil',
        \ 'ddd                    vim: nowrap',
        \ ], 'Xmodeline_nowrap', 'D')
  set noequalalways
  set nomodelinestrict
  11new | 20vsplit

  func Check_modeline_nowrap(expect_insecure, expect_secure, set_cmd)
    edit Xmodeline_nowrap
    call assert_equal(a:expect_insecure, ScreenLines([1, 5], 20))

    5split
    call assert_equal(a:expect_insecure, ScreenLines([1, 5], 20))
    call assert_equal(a:expect_insecure, ScreenLines([7, 11], 20))

    exe a:set_cmd 'nowrap'
    call assert_equal(a:expect_secure, ScreenLines([1, 5], 20))
    call assert_equal(a:expect_insecure, ScreenLines([7, 11], 20))

    close
    call assert_equal(a:expect_insecure, ScreenLines([1, 5], 20))

    setglobal nowrap
    call assert_equal(a:expect_insecure, ScreenLines([1, 5], 20))
    setglobal wrap
    call assert_equal(a:expect_insecure, ScreenLines([1, 5], 20))

    exe a:set_cmd 'nowrap'
    call assert_equal(a:expect_secure, ScreenLines([1, 5], 20))

    exe 'sandbox' a:set_cmd 'nowrap'
    call assert_equal(a:expect_insecure, ScreenLines([1, 5], 20))

    exe a:set_cmd 'nowrap'
    call assert_equal(a:expect_secure, ScreenLines([1, 5], 20))
  endfunc

  setlocal nolist listchars=
  let expect_insecure = [
        \ 'aaa                 ',
        \ 'bbb                 ',
        \ 'ccc                >',
        \ 'ddd                >',
        \ '~                   ',
        \ ]
  let expect_secure = [
        \ 'aaa                 ',
        \ 'bbb                 ',
        \ 'ccc                 ',
        \ 'ddd                 ',
        \ '~                   ',
        \ ]
  call Check_modeline_nowrap(expect_insecure, expect_secure, 'setlocal')
  call Check_modeline_nowrap(expect_insecure, expect_secure, 'set')

  setlocal list listchars=extends:+
  let expect_secure = [
        \ 'aaa                 ',
        \ 'bbb                 ',
        \ 'ccc                +',
        \ 'ddd                +',
        \ '~                   ',
        \ ]
  call assert_equal(expect_secure, ScreenLines([1, 5], 20))
  call Check_modeline_nowrap(expect_insecure, expect_secure, 'setlocal')
  call Check_modeline_nowrap(expect_insecure, expect_secure, 'set')

  " Other 'listchars' flags are not affected.
  call writefile([
        \ "aa\ta",
        \ "bb\tb",
        \ "cc\tc              evil",
        \ "dd\td              vim: nowrap lcs=tab\\:<->",
        \ ], 'Xmodeline_nowrap')
  let expect_insecure = [
        \ 'aa<---->a           ',
        \ 'bb<---->b           ',
        \ 'cc<---->c          >',
        \ 'dd<---->d          >',
        \ '~                   ',
        \ ]
  let expect_secure = [
        \ 'aa<---->a           ',
        \ 'bb<---->b           ',
        \ 'cc<---->c           ',
        \ 'dd<---->d           ',
        \ '~                   ',
        \ ]
  call Check_modeline_nowrap(expect_insecure, expect_secure, 'setlocal')
  call Check_modeline_nowrap(expect_insecure, expect_secure, 'set')

  " Same behavior even if modeline sets "extends" to a space.
  call writefile([
        \ "aa\ta",
        \ "bb\tb",
        \ "cc\tc              evil",
        \ "dd\td              vim: nowrap lcs=tab\\:<->",
        \ ], 'Xmodeline_nowrap')
  call Check_modeline_nowrap(expect_insecure, expect_secure, 'setlocal')
  call Check_modeline_nowrap(expect_insecure, expect_secure, 'set')

  sandbox setglobal nowrap
  setglobal list listchars=eol:$
  setlocal bufhidden=wipe
  enew!
  call setline(1, ['aaa                    bbb'])
  call assert_equal(['aaa                >'], ScreenLines(1, 20))
  setglobal nowrap
  call assert_equal(['aaa                >'], ScreenLines(1, 20))
  setlocal nowrap
  call assert_equal(['aaa                 '], ScreenLines(1, 20))
  normal! 20zl
  call assert_equal(['   bbb$             '], ScreenLines(1, 20))
  setlocal bufhidden=wipe
  enew!
  call setline(1, ['ccc                    ddd'])
  call assert_equal(['ccc                 '], ScreenLines(1, 20))
  normal! 20zl
  call assert_equal(['   ddd$             '], ScreenLines(1, 20))

  bwipe!
  delfunc Check_modeline_nowrap
  set equalalways&
endfunc

func Test_modeline_strict_allowed()
  let modeline = &modeline
  set modeline modelinestrict

  " Whitelisted options should work
  call writefile(['vim: set ts=2 sw=4 et :'], 'Xmodeline_strict', 'D')
  split Xmodeline_strict
  call assert_equal(2, &ts)
  call assert_equal(4, &sw)
  call assert_equal(1, &et)
  bwipe!

  " 'filetype' should work
  call writefile(['vim: set ft=python :'], 'Xmodeline_strict')
  filetype plugin on
  split Xmodeline_strict
  call assert_equal("python", &filetype)
  bwipe!
  filetype plugin off

  " 'spell' and 'spelllang' should work
  call writefile(['vim: set spell spelllang=de :'], 'Xmodeline_strict')
  split Xmodeline_strict
  call assert_equal(1, &spell)
  call assert_equal("de", &spelllang)
  bwipe!

  " 'foldmethod' should work
  call writefile(['vim: set fdm=marker :'], 'Xmodeline_strict')
  split Xmodeline_strict
  call assert_equal("marker", &foldmethod)
  bwipe!

  " 'autoindent' and 'cindent' should work
  call writefile(['vim: set ai cin :'], 'Xmodeline_strict')
  split Xmodeline_strict
  call assert_equal(1, &ai)
  call assert_equal(1, &cin)
  bwipe!

  " 'textwidth'
  call writefile(['vim: set tw=10 :'], 'Xmodeline_strict')
  split Xmodeline_strict
  call assert_equal(10, &textwidth)
  bwipe!

  let &modeline = modeline
  set modelinestrict
endfunc

func Test_modeline_strict_blocked()
  let modeline = &modeline
  set modeline modelinestrict

  " 'wrap' is not whitelisted, should be silently skipped
  set wrap
  call writefile(['vim: set nowrap :'], 'Xmodeline_strict_fail')
  split Xmodeline_strict_fail
  call assert_equal(1, &wrap)
  bwipe!

  " 'number' is not whitelisted, should be silently skipped
  set nonumber
  call writefile(['vim: set number :'], 'Xmodeline_strict_fail')
  split Xmodeline_strict_fail
  call assert_equal(0, &number)
  bwipe!

  " Whitelisted options still work alongside blocked ones
  set wrap nonumber
  call writefile(['vim: set nowrap ts=3 number :'], 'Xmodeline_strict_fail')
  split Xmodeline_strict_fail
  call assert_equal(1, &wrap)
  call assert_equal(3, &ts)
  call assert_equal(0, &number)
  bwipe!

  let &modeline = modeline
endfunc

func Test_modeline_strict_off()
  let modeline = &modeline
  set modeline nomodelinestrict

  " With modelinestrict off, non-whitelisted options should work
  call writefile(['vim: set number :'], 'Xmodeline_strict_off', 'D')
  split Xmodeline_strict_off
  call assert_equal(1, &number)
  bwipe!

  let &modeline = modeline
  set modelinestrict&
endfunc

func Test_modeline_strict_cannot_be_set_from_modeline()
  let modeline = &modeline
  set modeline modelinestrict

  " 'modelinestrict' itself cannot be set from a modeline (P_SECURE)
  call writefile(['vim: set nomodelinestrict :'], 'Xmodeline_strict_ml', 'D')
  call assert_fails('split Xmodeline_strict_ml', 'E520:')
  call assert_equal(1, &modelinestrict)
  bwipe!

  let &modeline = modeline
endfunc

" vim: shiftwidth=2 sts=2 expandtab
