feat: Add ability to hijack-cursor

[ghostbuster91]

This closes #604

TODO:

• docs
• config
• proper initialization

[ghostbuster91]

@cseickel Thanks for the quick review. I have addressed your comments. Is there anything left that I should do? Initially I was thinking also about mentioning it in the vim docs, but I see that not all of the flags are there, so I am not sure if I should put it there.

[cseickel]

As far as docs go, not everything is in the help file because I was just too lazy to write docs for every single option. The general rule is that anything that can easily be explained with an inline comment in the config doesn't need to be explicitly listed in the help file.

If you wanted to put in a doc entry, you could just start a new section that could someday contain all of the options that just need one-line explanations like this one. Or you can skip it.

[ghostbuster91]

Hi @cseickel, it seems that I can now get back to this one, though I still don't know where to subscribe for the events. Could you drop some hint? 🙏

[cseickel]

I'm not sure why, but it does not seem to work with position = "current".

[cseickel]

I would make this a pcall because it will throw an error if the variable is not set. Most likely that would only happen from a timing problem.

The important thing is that it would get real annoying if something did cause an error on every cursor moved event.

[ghostbuster91]

Good idea, done.

[ghostbuster91]

I'm not sure why, but it does not seem to work with position = "current".

I will look into that.

[ghostbuster91]

@cseickel I looked into that. It doesn't work because state.winid is nil. I thought that maybe this is some special case that needs to be handled.
I found this https://github.com/ghostbuster91/neo-tree.nvim/blob/11f6042509d8e4dc3ffbddf0bf1d8b7d01ac3d94/lua/neo-tree/ui/selector.lua#L254 and made a similar change. However after that change neotree failed because state.tree is also nil 👀 (in this line https://github.com/ghostbuster91/neo-tree.nvim/blob/11f6042509d8e4dc3ffbddf0bf1d8b7d01ac3d94/lua/neo-tree/sources/common/hijack_cursor.lua#L21)
Any idea what is happening here?

[cseickel]

Any idea what is happening here?

Yes. The problem is that if you call manager.get_state() without specifying a window id, you will get back the sidebar state for the tab. What you need to do is first check if the window was open in position = "current" or not, and if the position is "current" then you need to pass the winid as the third parameter to get_state(source, tabid, winid) to get the state for that window and not the tab.

You'd need something like this:

local winid = nil
local _, position = pcall(vim.api.nvim_buf_get_var, 0, "neo_tree_position")
if position == "current" then
  winid = vim.api.get_current_win()
end
local state = manager.get_state(source, nil, winid)

That block of logic should probably be a utility function, or maybe the get_state function itself should be checking if the currently focused window is a neo-tree window and doing that work for you.

[ghostbuster91]

I see, thanks for the explanation. For now I will just add this check here but I think that it would make sense to move it eventually to get_state. I can do that as a follow-up.

[cseickel]

Hey @ghostbuster91, sorry I think I dropped the ball on this. Is this good to go?

[ghostbuster91]

@cseickel Sorry, this is totally my fault. I used this ticket to get some hands-on experience with neotree codebase as this ticket seemed quite simple. However obstacles that I encountered caused my motivation to go away.

Having said that, I think that it would be a waste if I didn't finish it, so I will try to get that last mile done.

[ghostbuster91]

@cseickel I fixed the issue with position=current. Could you give it a try?

[cseickel]

Looks good and it works for me in all situations. Thanks!