Get surrounding math environment

[AliAhmad02]

Hello!

I have an application, where I need to be able to detect if I'm inside a math zone and if so, get the boundaries of that math zone. For the former, VimTeX provides vimtex#syntax#in_mathzone() and for the latter vimtex#env#get_surrounding('math').

This works for inline math (e.g. $$) and for the simplest cases of math TeX environments (e.g. \begin{equation}...\end{equation}). But consider, for example, the case where we have an equation as follows (this uses bmatrix from amsmath):

\begin{equation}
  2\begin{bmatrix}
  1 & 1\\
  1 & 1
  \end{bmatrix} =

  \begin{bmatrix}
      2 & 2\\
      2 & 2
  \end{bmatrix}

\end{equation}

In this case, vimtex#env#get_surrounding('math') returns nothing, if my cursor is inside one of the matrices. What I want to happen is that if I'm in a nested math environment, I want to be able to get the outermost delimiters that define that math environment. In the above case, I am interested in the \begin{equation} \end{equation} delimiters.

For this, vimtex does provide vimtex#env#get_outer(). And indeed, if I just put the above code into a simple document, this does work. However, I noticed that if I, for example, wrap the math environment in another non-math environment, it no longer works. For example, if my document has chapters and I introduce the delimiters \begin{chapter} \end{chapter}, then vimtex#env#get_outer() gives me the chapter delimiters.

My current best idea for how to implement this is (after checking that vimtex#syntax#in_mathzone() is true) to walk the cursor left/up (or right/down) and keep calling vimtex#env#get_surrounding('math') until it returns something. But I'd love to hear if anyone else has any better ideas for how to implement this.

Thanks :)

[lervag]

Hi! Thanks for opening this discussion. The vimtex#env#get_surrounding('math') unfortunately does not work perfectly here. I'm looking into improving it now.

Update: Please try the vimtex#env#get_surrounding('math') function now. I believe it should work as expected after b8503c0.

[AliAhmad02]

From what I can see, it seems to work great now. Thanks!

[lervag]

Great, glad to hear it!