Add setcmdline() by Shougo · Pull Request #10869 · vim/vim

Shougo · 2022-08-09T00:55:22Z

It is useful to create plugins for command line.

brammool · 2022-08-09T10:46:36Z

I wonder what happens when calling setcmdline() while in custom completion. Should have a test for that.
There might be other situations where changing the command line unexpectedly might cause trouble.

Shougo · 2022-08-11T09:59:48Z

I wonder what happens when calling setcmdline() while in custom completion.

What means the custom completion?
It is command custom completion? To add tests, I need to understand it.

brammool · 2022-08-11T16:04:32Z

> I wonder what happens when calling setcmdline() while in custom completion. What means the `custom completion`? It is command custom completion? To add tests, I need to understand it.

For a user command custom completion can be defined with: -complete=custom,{func} See ":help :command-completion-custom". In the function used here, if you would call setcmdline(), I wonder if something breaks (using freed memory, for example). Perhaps a :cmap using <expr> might also cause trouble.

…

-- GALAHAD: No look, really, this isn't nescess ... PIGLET: We must examine you. GALAHAD: There's nothing wrong with ... that. "Monty Python and the Holy Grail" PYTHON (MONTY) PICTURES LTD /// Bram Moolenaar -- ***@***.*** -- http://www.Moolenaar.net \\\ /// \\\ \\\ sponsor Vim, vote for features -- http://www.Vim.org/sponsor/ /// \\\ help me help AIDS victims -- http://ICCF-Holland.org ///

Shougo · 2022-08-14T06:13:41Z

I have added tests.

Shougo · 2022-08-14T08:59:42Z

Failures: 
	From test_cmdline.vim:
	Found errors in Test_setcmdline():
	command line..script /home/runner/work/vim/vim/src/testdir/runtest.vim[468]..function RunTheTest[44]..Test_setcmdline line 33: Expected 'let foo=0' but got '"DoCmd January February Mars'

I don't know why it is failed in gvim only.
It works for me...

Shougo · 2022-08-14T09:14:54Z

I have changed the map character. It is passed.

vimpostor · 2022-08-14T15:22:09Z

Do you have an example usecase for this function? I don't quite get where this is useful.

bfrg · 2022-08-14T19:48:25Z

Do you have an example usecase for this function? I don't quite get where this is useful.

Custom command-line popup window (the popup callback function calls setcmdline() to set the command-line after user made selection and hit ENTER)
If someone has a user command with a command-completion function that obtains its list of candidates asynchronously the job callback function needs a way to set the command-line once the list of candidates are obtained.

runtime/doc/builtin.txt

habamax · 2022-08-15T05:37:31Z

Custom command-line popup window (the popup callback function calls setcmdline() to set the command-line after user made selection and hit ENTER)

I for now use feedkeys(":Command") to have it, I guess proper function would be better.

brammool · 2022-08-26T19:50:37Z

A few review comments (sorry it took a while):

please use the same formatting as for other functions (function return type goes on a separate line)
help says returning FALSE or TRUE, but it looks like it's returning one and zero
use a better error than e_invalid_argument
a negative position is rejected without any error
All declarations go at the start of the block (ANSI C)

Shougo · 2022-08-27T03:23:17Z

help says returning FALSE or TRUE, but it looks like it's returning one and zero

yes, but it is the same behavior with setcmdpos(). The documentation is wrong??

Shougo · 2022-08-27T03:31:52Z

please use the same formatting as for other functions (function return type goes on a separate line)

Fixed.

a negative position is rejected without any error

Fixed.

All declarations go at the start of the block (ANSI C)

Fixed.

codecov · 2022-08-27T04:40:11Z

Codecov Report

Merging #10869 (35d8b0f) into master (5ff595d) will increase coverage by 0.08%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master   #10869      +/-   ##
==========================================
+ Coverage   82.40%   82.49%   +0.08%     
==========================================
  Files         152      152              
  Lines      177500   177529      +29     
  Branches    40279    40283       +4     
==========================================
+ Hits       146272   146455     +183     
+ Misses      19043    18906     -137     
+ Partials    12185    12168      -17

Flag	Coverage Δ
huge-clang-none	`82.70% <100.00%> (+<0.01%)`	⬆️
huge-gcc-none	`55.58% <100.00%> (+<0.01%)`	⬆️
huge-gcc-testgui	`54.01% <100.00%> (?)`
huge-gcc-unittests	`0.30% <0.00%> (-0.01%)`	⬇️
linux	`82.49% <100.00%> (+0.08%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
src/evalfunc.c	`90.73% <ø> (+0.53%)`	⬆️
src/ex_getln.c	`83.75% <100.00%> (+0.21%)`	⬆️
src/if_xcmdsrv.c	`77.40% <0.00%> (-0.18%)`	⬇️
src/channel.c	`83.43% <0.00%> (-0.14%)`	⬇️
src/gui.c	`69.72% <0.00%> (-0.05%)`	⬇️
src/quickfix.c	`90.92% <0.00%> (+0.02%)`	⬆️
src/window.c	`86.54% <0.00%> (+0.03%)`	⬆️
src/diff.c	`83.31% <0.00%> (+0.06%)`	⬆️
src/ex_docmd.c	`91.79% <0.00%> (+0.07%)`	⬆️
src/vim9cmds.c	`86.64% <0.00%> (+0.08%)`	⬆️
... and 21 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

brammool · 2022-08-27T09:49:49Z

> help says returning FALSE or TRUE, but it looks like it's returning > one and zero yes, but it is the same behavior with `setcmdpos()`. The documentation is wrong??

Ah, you took it from there, and there it's confusing as well. FALSE and TRUE are used for argument values, where zero and v:false are accepted as FALSE and 1 or v:true are accepted as TRUE. But when returning a value we know what we are returning, thus we can just use zero and one. Othewise users may expect v:false or v:true, which matters when using Vim9 script.

…

-- It is illegal to take more than three sips of beer at a time while standing. [real standing law in Texas, United States of America] /// Bram Moolenaar -- ***@***.*** -- http://www.Moolenaar.net \\\ /// \\\ \\\ sponsor Vim, vote for features -- http://www.Vim.org/sponsor/ /// \\\ help me help AIDS victims -- http://ICCF-Holland.org ///

Shougo · 2022-08-28T05:55:58Z

Thank you for the merge.

…plugin Problem: It is not easy to change the command line from a plugin. Solution: Add setcmdline(). (Shougo Matsushita, closes vim/vim#10869) vim/vim@07ea5f1

…plugin (#19979) vim-patch:9.0.0285: it is not easy to change the command line from a plugin Problem: It is not easy to change the command line from a plugin. Solution: Add setcmdline(). (Shougo Matsushita, closes vim/vim#10869) vim/vim@07ea5f1

…plugin (neovim#19979) vim-patch:9.0.0285: it is not easy to change the command line from a plugin Problem: It is not easy to change the command line from a plugin. Solution: Add setcmdline(). (Shougo Matsushita, closes vim/vim#10869) vim/vim@07ea5f1

Shougo mentioned this pull request Aug 9, 2022

Add setcmdline() neovim/neovim#19622

Closed

Shougo force-pushed the setcmdline branch from 6f2670e to eec389e Compare August 14, 2022 06:13

bfrg reviewed Aug 14, 2022

View reviewed changes

runtime/doc/builtin.txt Outdated Show resolved Hide resolved

Shougo added 10 commits August 27, 2022 12:18

Add setcmdline()

44438eb

Fix the indentation

dbf1b5b

Fix build errors

441c8b4

Fix function list

3d630de

Add tests

24e721a

Add tests

d01ef39

Fix tests

61e10b9

Change map

419b427

Improve the example

1a76591

Fix formats

5fddec2

Fix for reviews

385ed9c

Shougo force-pushed the setcmdline branch from 3346fd4 to 385ed9c Compare August 27, 2022 03:30

Shougo added 2 commits August 27, 2022 12:56

Fix tests

31fbf3f

Fix tests

a82de45

Shougo added 2 commits August 27, 2022 13:50

Add tests

8d57208

Fix tests

35d8b0f

brammool closed this in 07ea5f1 Aug 27, 2022

Shougo deleted the setcmdline branch August 28, 2022 05:55

Uh oh!

Conversation

Shougo commented Aug 9, 2022

Uh oh!

brammool commented Aug 9, 2022

Uh oh!

Shougo commented Aug 11, 2022

Uh oh!

brammool commented Aug 11, 2022 via email

Uh oh!

Shougo commented Aug 14, 2022

Uh oh!

Shougo commented Aug 14, 2022

Uh oh!

Shougo commented Aug 14, 2022

Uh oh!

vimpostor commented Aug 14, 2022

Uh oh!

bfrg commented Aug 14, 2022

Uh oh!

Uh oh!

habamax commented Aug 15, 2022

Uh oh!

brammool commented Aug 26, 2022

Uh oh!

Shougo commented Aug 27, 2022

Uh oh!

Shougo commented Aug 27, 2022

Uh oh!

codecov bot commented Aug 27, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

brammool commented Aug 27, 2022 via email

Uh oh!

Shougo commented Aug 28, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov bot commented Aug 27, 2022 •

edited

Loading