weird behaviour about indent delim

[Freed-Wu]

Description

I don't sure about this behaviour is a bug or a feature:(

in vimtex, default configuration of VimtexIndentExpr() will indent the following code

\command{
  a
  }{
  b
}

the original behaviour is weird, it looks like VimtexIndentExpr() treat }{ as same as a b

Expected behaviour:

\command{
  a
}{
  b
}

And behaviour:

\command{
  a
  }\command{
  b
}

Expected behaviour:

\command{
  a
}\command{
  b
}

Steps to reproduce

No response

Expected behavior

No response

Actual behavior

No response

Do you use a latexmkrc file?

No

VimtexInfo

System info:
  OS: Arch Linux
  Vim version: NVIM v0.6.1
  Has clientserver: true
  Servername: /tmp/nvimDLQ3rR/0

VimTeX project: .tikz
  base: .tikz
  root: /home/wzy/.config/nvim/template
  tex: /home/wzy/.config/nvim/template/.tikz
  main parser: current file
  document class: standalone
  packages: hyperref
  compiler: latexmk
    engine: -lualatex
    options:
      -verbose
      -synctex=1
      -interaction=nonstopmode
      -shell-escape
      -8bit
    callback: 1
    continuous: 1
    executable: latexmk
  viewer: Zathura
    xwin id: 0
  qf method: LaTeX logfile

[lervag]

Thanks. At first inspection I agree this is a bug. I'll look into it!

[lervag]

Well, the problem is simply that I can't figure out how to do this in a reliable way... perhaps you can help?

This is the relevant code:

https://github.com/lervag/vimtex/blob/master/indent/tex.vim#L240-L250

The challenge here is that indents are calculated separately on each line. It is hard to keep any "state". But I generally use the assumption that the previous line is correctly indented. So, the current method of indenting on delimiters is to count them in this and the previous line. I've found it to work well in almost all cases.

[lervag]

I believe it could be possible to implement this if we use a more complicated method of counting. Right now, the counting is very simple. An alternative could be to use a similar count, but:

• do not count "unmatched" open delimiters on the current line, and
• do not count "unmatched" close delimiters on the previous line.

This means that {...} would be zeroed in any count, but }...{ would be "-1" for current line and "+1" for previous line.

[lervag]

I've implemented my mentioned idea and it seems to work well. I'm pushing the fix now; please let me know if you notice any unintended side effects!

[Freed-Wu]

Now, the behaviour is

\command{
a}

Is it correct? Not

\command{
  a}

[Freed-Wu]

I think this behaviour is not correct:

{
    \graph[nodes={draw},
    ]
  }

the correct behaviour should be:

{
  \graph[nodes={draw},
  ]
}

with configuration:

  let g:vimtex_indent_delims = {
        \ 'open': ['{', '['],
        \ 'close': ['}', ']'],
        \ 'close_indented': 0,
        \ 'include_modified_math': 1,
        \ }

[lervag]

Now, the behaviour is

\command{
a}

Is it correct?

Yes, this is expected. If you use 'close_indented': 1 you will get

\command{
  a}

I think this behaviour is not correct: ...

I'll look into it when I get the time.

[lervag]

I believe the bug should be fixed now. Please test again!

[Freed-Wu]

I doubt it is a bug:

By default, g:vimtex_indent_ignored_envs is ['document']. It should make {document} don't indent, but I found {mydocument} will also not indent:

\begin{mydocument}
a
\end{mydocument}

Expected behaviour:

\begin{mydocument}
    a
\end{mydocument}

I think it can solve this bug:

index 10b88263..e7242448 100644
--- a/indent/tex.vim
+++ b/indent/tex.vim
@@ -206,7 +206,7 @@ endfunction
 
 let s:envs_begin = '\\begin{.*}\|\\\@<!\\\['
 let s:envs_end = '\\end{.*}\|\\\]'
-let s:envs_ignored = '\v' . join(g:vimtex_indent_ignored_envs, '|')
+let s:envs_ignored = '\v^' . join(g:vimtex_indent_ignored_envs, '|') . '$'
 
 " }}}1
 function! s:indent_items(line, lnum, prev_line, prev_lnum) abort " {{{1

[Freed-Wu]

I think it can solve this bug:

Not, it seems to bring another bug: {document} also indent.:(