More specific functions for vimtex API

[L1szt]

The vimtex api is great so far but I would like to have the possibility to find out whether my cursor is currently in a x section where x is just a placeholder for any possible section, e.g.

\begin{x}
...
\end{x}

and I would like to be able to call some API function to tell me whether my cursor currently is in an x-block.

[lervag]

E.g. something like vimtex#syntax#in?

[lervag]

I.e., if you have the following source

\begin{x}
  cursor here
\end{x}

with the cursor where indicated, then vimtex#syntax#in('x') should return a true value.

[clason]

Wouldn't it be easier to have in() return 'x' and let the caller do the checking?

[lervag]

Sorry, I was wrong. ...#in(...) does not check specifically for environment x. It checks for syntax item x, which is generally not the same.

Wouldn't it be easier to have in() return 'x' and let the caller do the checking?

No, not quite - it would have to return the syntax stack.

---

However, we have vimtex#env#is_inside(env), which I think should work as expected. And your question is the same - it could be relevant to add a function like vimtex#env#get_current which returns the current outermost innermost environment. Or perhaps the full stack of surrounding environments?

[clason]

I think a concrete use case would go a long way here...

which returns the current outermost environment

I'd expect the _inner_most environment to be more useful in most cases? (The outermost environment tends to be document ;P)

So I guess you'd either need two functions (get_inner and get_outer), or indeed the full stack (so get_env()[0] can be a shortcut for the former).

[lervag]

I'd expect the _inner_most environment to be more useful in most cases? (The outermost environment tends to be document ;P)

hah, my mistake... in any case, I'll add the functions more or less as described here:

vimtex#env#get_inner()
  Get innermost environment name.
vimtex#env#get_outer()
  Get outermost environment name (ignore "document").
vimtex#env#get_all()
  Get list of all surrounding environments ([innermost, ..., outermost]).

[clason]

I don't see how anybody could complain about that :)

[L1szt]

@lervag thanks a lot for the quick response! Apparently the documentation I read contained only a subset of the commands.

[L1szt]

@lervag An of topic question: Whenever I start the continuous compile mode the preview application on my OS opens and shows the rendered pdf. How can I disable this (that vimtex automatically causes this application to open)/change the application?

[lervag]

I don't see how anybody could complain about that :)

Right? :) I've pushed the first version of this. A "simple" and straightforward implementation, but I believe it should do the trick. Let me know what you think.

thanks a lot for the quick response! Apparently the documentation I read contained only a subset of the commands.

Yes, I assume you refer to :help vimtex-code-api? It is a work-in-progress that I am not really devoting much time to. I'll try to improve it with time, but it is not a priority.

An of topic question: Whenever I start the continuous compile mode the preview application on my OS opens and shows the rendered pdf. How can I disable this (that vimtex automatically causes this application to open)/change the application?

First, it is not really VimTeX that does this; it is the standard behaviour of latexmk. But VimTeX does configure latexmk to use the same viewer as specified in VimTeX. And yes, VimTeX does have an option to prevent the automatic viewer. Just add let g:vimtex_view_automatic = 0 to your vimrc.

[L1szt]

@lervag again, thanks a lot for your help (it's very rare that the creator of an extension is so quick in helping its users).

[lervag]

Glad to help, and thanks for the kind words :)