Add strings module

[delphinus]

ref #95
ref nvim-telescope/telescope.nvim#464

TODO

• need to transfer another funcs from telescope.nvim?
• doc

[elianiva]

could probably add this to align multibyte string as well. The lua string.format("%-5s", some_string) freaks out when it receives a multibyte character.

https://github.com/nvim-telescope/telescope.nvim/blob/c8cc024ebf86d58dc37913e1e9ec7e465d687d68/lua/telescope/utils.lua#L334

[Conni2461]

Thanks for porting this :)

Do you mind also adding border title truncate?
Should happen here:

plenary.nvim/lua/plenary/window/border.lua

Line 36 in abdc34a

local title_len = string.len(title)

Max width is: content_win_options.width

[Conni2461]

Do you also wanna add this dedent function? We use it in telescope (docs) and tree-sitter-lua docgen (tests) and its easier if it would be part of plenary.

local dedent = function(str, leave_indent)
  -- find minimum common indent across lines
  local indent = nil
  for line in str:gmatch('[^\n]+') do
    local line_indent = line:match('^%s+') or ''
    if indent == nil or #line_indent < #indent then
      indent = line_indent
    end
  end
  if indent == nil or #indent == 0 then
    -- no minimum common indent
    return str
  end
  local left_indent = (' '):rep(leave_indent or 0)
  -- create a pattern for the indent
  indent = indent:gsub('%s', '[ \t]')
  -- strip it from the first line
  str = str:gsub('^'..indent, left_indent)
  -- strip it from the remaining lines
  str = str:gsub('[\n]'..indent, '\n' .. left_indent)
  return str
end

[delphinus]

@Conni2461 I added dedent(). The original logic cannot deal with 'tabstop', so I rewrote all with using strdisplaywidth().

[Conni2461]

Can we not use goto breaks lua 5.1 (and some people build neovim with it)

[delphinus]

Fixed on a90e9b0

[delphinus]

Applied again 8931abd

[Conni2461]

The original logic cannot deal with 'tabstop', so I rewrote all with using strdisplaywidth()

The original was just some hacky thing tj wrote so we can write tests like this:
https://github.com/tjdevries/tree-sitter-lua/blob/ca38705ab4551db996428ebce6bed9bdc9b77780/lua/tests/docgen/renderer_spec.lua#L124-L146

Its not really used in production but thanks anyways :)

[tjdevries]

One other thing as well is that if there are any string functions that exist within neovim that would be useful but just aren't exposed, we can expose them over the vim.str_* functions via the C api in neovim core. I haven't looked much at the code here yet to know if that's true (and also I don't know anything about non-ascii characters 😆 )(

[delphinus]

@Conni2461
I tested the case for it. ( d46e342 ) I think the current implementaation can deal with the one you pointed. How do you think?

@tjdevries
I looked into the code for vim.str_* and it seems possible for strdisplaywidth() because the logic exists in charset.c (here). But the logic for strcharpart() exists in func.c (here) and I cannot find the method to call it from executor.c. How can I do this?

static int nlua_str_charpart(lua_State *const lstate) FUNC_ATTR_NONNULL_ALL
{
  f_strcharpart(...); // What should be here for arguments?
  return 1;
}

[tjdevries]

Hey @delphinus , are you asking what code you would need to add to neovim core to be able to do this?

If so, I can guide you through the PR that you'd probably want to be able to do that.

[Conni2461]

@delphinus Whats the progress here? Some people are waiting for a telescope PR nvim-telescope/telescope.nvim#528 (comment) that is already done but requires the truncating border titles.

I would be fine with merging a not done version here. (for example everything besides dedent if you have trouble with removing the goto)

[delphinus]

@tjdevries @Conni2461

Sorry for too large delay! I have been too busy to write code here, so I (or some person) will improve in the future when I have time ;( Can you merge this current code?

[Conni2461]

Somehow the goto is back. I have no idea why 🤣

Can you also rebase nvim-telescope/telescope.nvim#690 so i can test it in combination? After that i think we can merge.

Thanks :)

[delphinus]

Fixed again. and nvim-telescope/telescope.nvim#690 is also ready.

[VVKot]

@tjdevries @Conni2461 any chance you can take a look at this PR? As far as I can tell it is blocking nvim-telescope/telescope.nvim#528 which I quite fancy.

[Conni2461]

This looks good to me. I ask tj if i can merge it :)

[maxxnino]

Some how i got error when using :Telescope find_files with this commit
NVIM v0.5.0-dev+1362-g3cd688ff7

[Conni2461]

Sorry there was a "typo" i missed. Should be fixed

[maxxnino]

Thank that fixed the problem