-
-
Notifications
You must be signed in to change notification settings - Fork 827
/
pickers.lua
1728 lines (1459 loc) · 56.6 KB
/
pickers.lua
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
require "telescope"
local a = vim.api
local async = require "plenary.async"
local await_schedule = async.util.scheduler
local channel = require("plenary.async.control").channel
local popup = require "plenary.popup"
local actions = require "telescope.actions"
local config = require "telescope.config"
local debounce = require "telescope.debounce"
local deprecated = require "telescope.deprecated"
local log = require "telescope.log"
local mappings = require "telescope.mappings"
local state = require "telescope.state"
local utils = require "telescope.utils"
local entry_display = require "telescope.pickers.entry_display"
local p_highlighter = require "telescope.pickers.highlights"
local p_scroller = require "telescope.pickers.scroller"
local p_window = require "telescope.pickers.window"
local Layout = require "telescope.pickers.layout"
local EntryManager = require "telescope.entry_manager"
local MultiSelect = require "telescope.pickers.multi"
local truncate = require("plenary.strings").truncate
local strdisplaywidth = require("plenary.strings").strdisplaywidth
local ns_telescope_matching = a.nvim_create_namespace "telescope_matching"
local ns_telescope_prompt = a.nvim_create_namespace "telescope_prompt"
local ns_telescope_prompt_prefix = a.nvim_create_namespace "telescope_prompt_prefix"
---@class telescope_popup_options
---@field border table<1|2|3|4, integer>
---@field borderchars table<1|2|3|4|5|6|7|8, string>
---@field borderhighlight string
---@field col integer
---@field enter boolean
---@field height integer
---@field highlight string
---@field line integer
---@field minheight integer
---@field title integer
---@field titlehighlight integer
---@field width integer
-- Create three windows:
-- 1. Prompt window
-- 2. Options window
-- 3. Preview window
--
---@param picker Picker
local function default_create_layout(picker)
local function make_border(border)
if not border then
return nil
end
border.winid = border.win_id
return border
end
local layout = Layout {
picker = picker,
---@param self TelescopeLayout
mount = function(self)
local line_count = vim.o.lines - vim.o.cmdheight
if vim.o.laststatus ~= 0 then
line_count = line_count - 1
end
local popup_opts = picker:get_window_options(vim.o.columns, line_count)
-- `popup.nvim` massaging so people don't have to remember minheight shenanigans
popup_opts.results.focusable = true
popup_opts.results.minheight = popup_opts.results.height
popup_opts.results.highlight = "TelescopeResultsNormal"
popup_opts.results.borderhighlight = "TelescopeResultsBorder"
popup_opts.results.titlehighlight = "TelescopeResultsTitle"
popup_opts.prompt.minheight = popup_opts.prompt.height
popup_opts.prompt.highlight = "TelescopePromptNormal"
popup_opts.prompt.borderhighlight = "TelescopePromptBorder"
popup_opts.prompt.titlehighlight = "TelescopePromptTitle"
if popup_opts.preview then
popup_opts.preview.focusable = true
popup_opts.preview.minheight = popup_opts.preview.height
popup_opts.preview.highlight = "TelescopePreviewNormal"
popup_opts.preview.borderhighlight = "TelescopePreviewBorder"
popup_opts.preview.titlehighlight = "TelescopePreviewTitle"
end
local results_win, results_opts = picker:_create_window("", popup_opts.results)
local results_bufnr = a.nvim_win_get_buf(results_win)
self.results = Layout.Window {
winid = results_win,
bufnr = results_bufnr,
border = make_border(results_opts.border),
}
if popup_opts.preview then
local preview_win, preview_opts = picker:_create_window("", popup_opts.preview)
local preview_bufnr = a.nvim_win_get_buf(preview_win)
self.preview = Layout.Window {
winid = preview_win,
bufnr = preview_bufnr,
border = make_border(preview_opts.border),
}
end
local prompt_win, prompt_opts = picker:_create_window("", popup_opts.prompt)
local prompt_bufnr = a.nvim_win_get_buf(prompt_win)
self.prompt = Layout.Window {
winid = prompt_win,
bufnr = prompt_bufnr,
border = make_border(prompt_opts.border),
}
end,
---@param self TelescopeLayout
unmount = function(self)
utils.win_delete("results_win", self.results.winid, true, true)
if self.preview then
utils.win_delete("preview_win", self.preview.winid, true, true)
end
utils.win_delete("prompt_border_win", self.prompt.border.winid, true, true)
utils.win_delete("results_border_win", self.results.border.winid, true, true)
if self.preview then
utils.win_delete("preview_border_win", self.preview.border.winid, true, true)
end
-- we cant use win_delete. We first need to close and then delete the buffer
if vim.api.nvim_win_is_valid(self.prompt.winid) then
vim.api.nvim_win_close(self.prompt.winid, true)
end
vim.schedule(function()
utils.buf_delete(self.prompt.bufnr)
end)
end,
---@param self TelescopeLayout
update = function(self)
local line_count = vim.o.lines - vim.o.cmdheight
if vim.o.laststatus ~= 0 then
line_count = line_count - 1
end
local popup_opts = picker:get_window_options(vim.o.columns, line_count)
-- `popup.nvim` massaging so people don't have to remember minheight shenanigans
popup_opts.results.minheight = popup_opts.results.height
popup_opts.prompt.minheight = popup_opts.prompt.height
if popup_opts.preview then
popup_opts.preview.minheight = popup_opts.preview.height
end
local prompt_win = self.prompt.winid
local results_win = self.results.winid
local preview_win = self.preview and self.preview.winid
local preview_opts
if popup_opts.preview then
if preview_win ~= nil then
-- Move all popups at the same time
popup.move(prompt_win, popup_opts.prompt)
popup.move(results_win, popup_opts.results)
popup.move(preview_win, popup_opts.preview)
else
popup_opts.preview.focusable = true
popup_opts.preview.highlight = "TelescopePreviewNormal"
popup_opts.preview.borderhighlight = "TelescopePreviewBorder"
popup_opts.preview.titlehighlight = "TelescopePreviewTitle"
local preview_bufnr = (self.preview and self.preview.bufnr ~= nil)
and vim.api.nvim_buf_is_valid(self.preview.bufnr)
and self.preview.bufnr
or ""
preview_win, preview_opts = picker:_create_window(preview_bufnr, popup_opts.preview)
if preview_bufnr == "" then
preview_bufnr = a.nvim_win_get_buf(preview_win)
end
self.preview = Layout.Window {
winid = preview_win,
bufnr = preview_bufnr,
border = make_border(preview_opts.border),
}
if picker.previewer and picker.previewer.state and picker.previewer.state.winid then
picker.previewer.state.winid = preview_win
end
-- Move prompt and results after preview created
vim.defer_fn(function()
popup.move(prompt_win, popup_opts.prompt)
popup.move(results_win, popup_opts.results)
end, 0)
end
elseif preview_win ~= nil then
popup.move(prompt_win, popup_opts.prompt)
popup.move(results_win, popup_opts.results)
-- Remove preview after the prompt and results are moved
vim.defer_fn(function()
utils.win_delete("preview_win", preview_win, true)
utils.win_delete("preview_win", self.preview.border.winid, true)
self.preview = nil
end, 0)
else
popup.move(prompt_win, popup_opts.prompt)
popup.move(results_win, popup_opts.results)
end
end,
}
return layout
end
local pickers = {}
-- TODO: Add overscroll option for results buffer
---@class Picker
--- Picker is the main UI that shows up to interact w/ your results.
-- Takes a filter & a previewer
local Picker = {}
Picker.__index = Picker
--- Create new picker
function Picker:new(opts)
opts = opts or {}
if opts.layout_strategy and opts.get_window_options then
error "layout_strategy and get_window_options are not compatible keys"
end
if vim.fn.win_gettype() == "command" then
error "Can't open telescope from command-line window. See E11"
end
deprecated.options(opts)
-- We need to clear at the beginning not on close because after close we can still have select:post
-- etc ...
require("telescope.actions.mt").clear_all()
-- TODO(conni2461): This seems like the better solution but it won't clear actions that were never mapped
-- for _, v in ipairs(keymap_store[prompt_bufnr]) do
-- pcall(v.clear)
-- end
local layout_strategy = vim.F.if_nil(opts.layout_strategy, config.values.layout_strategy)
local winblend =
vim.F.if_nil(opts.winblend, type(opts.window) == "table" and opts.window.winblend or config.values.winblend)
if type(winblend) == "function" then
winblend = winblend()
end
local obj = setmetatable({
prompt_title = vim.F.if_nil(opts.prompt_title, config.values.prompt_title),
results_title = vim.F.if_nil(opts.results_title, config.values.results_title),
-- either whats passed in by the user or whats defined by the previewer
preview_title = opts.preview_title,
prompt_prefix = vim.F.if_nil(opts.prompt_prefix, config.values.prompt_prefix),
wrap_results = vim.F.if_nil(opts.wrap_results, config.values.wrap_results),
selection_caret = vim.F.if_nil(opts.selection_caret, config.values.selection_caret),
entry_prefix = vim.F.if_nil(opts.entry_prefix, config.values.entry_prefix),
multi_icon = vim.F.if_nil(opts.multi_icon, config.values.multi_icon),
initial_mode = vim.F.if_nil(opts.initial_mode, config.values.initial_mode),
_original_mode = vim.api.nvim_get_mode().mode,
debounce = vim.F.if_nil(tonumber(opts.debounce), nil),
_finder_attached = true,
default_text = opts.default_text,
get_status_text = vim.F.if_nil(opts.get_status_text, config.values.get_status_text),
_on_input_filter_cb = opts.on_input_filter_cb or function() end,
finder = assert(opts.finder, "Finder is required."),
sorter = opts.sorter or require("telescope.sorters").empty(),
all_previewers = opts.previewer,
current_previewer_index = opts.current_previewer_index or 1,
default_selection_index = opts.default_selection_index,
get_selection_window = vim.F.if_nil(opts.get_selection_window, config.values.get_selection_window),
cwd = opts.cwd,
_find_id = 0,
_completion_callbacks = type(opts._completion_callbacks) == "table" and opts._completion_callbacks or {},
manager = (type(opts.manager) == "table" and getmetatable(opts.manager) == EntryManager) and opts.manager,
_multi = (type(opts._multi) == "table" and getmetatable(opts._multi) == getmetatable(MultiSelect:new()))
and opts._multi
or MultiSelect:new(),
track = vim.F.if_nil(opts.track, false),
stats = {},
attach_mappings = opts.attach_mappings,
file_ignore_patterns = vim.F.if_nil(opts.file_ignore_patterns, config.values.file_ignore_patterns),
scroll_strategy = vim.F.if_nil(opts.scroll_strategy, config.values.scroll_strategy),
sorting_strategy = vim.F.if_nil(opts.sorting_strategy, config.values.sorting_strategy),
tiebreak = vim.F.if_nil(opts.tiebreak, config.values.tiebreak),
selection_strategy = vim.F.if_nil(opts.selection_strategy, config.values.selection_strategy),
push_cursor_on_edit = vim.F.if_nil(opts.push_cursor_on_edit, false),
push_tagstack_on_edit = vim.F.if_nil(opts.push_tagstack_on_edit, false),
layout_strategy = layout_strategy,
layout_config = config.smarter_depth_2_extend(opts.layout_config or {}, config.values.layout_config or {}),
__cycle_layout_list = vim.F.if_nil(opts.cycle_layout_list, config.values.cycle_layout_list),
window = {
winblend = winblend,
border = vim.F.if_nil(opts.border, type(opts.window) == "table" and opts.window.border or config.values.border),
borderchars = vim.F.if_nil(
opts.borderchars,
type(opts.window) == "table" and opts.window.borderchars or config.values.borderchars
),
},
cache_picker = config.resolve_table_opts(opts.cache_picker, vim.deepcopy(config.values.cache_picker)),
__scrolling_limit = tonumber(vim.F.if_nil(opts.temp__scrolling_limit, 250)),
__locations_input = vim.F.if_nil(opts.__locations_input, false),
}, self)
obj.create_layout = opts.create_layout or config.values.create_layout or default_create_layout
obj.get_window_options = opts.get_window_options or p_window.get_window_options
if obj.all_previewers ~= nil and obj.all_previewers ~= false then
if obj.all_previewers[1] == nil then
obj.all_previewers = { obj.all_previewers }
end
obj.previewer = obj.all_previewers[obj.current_previewer_index]
if
obj.preview_title == nil
or #obj.all_previewers > 1
or opts.resumed_picker and opts.fix_preview_title ~= true
then
obj.preview_title = obj.previewer:title(nil, config.values.dynamic_preview_title)
else
obj.fix_preview_title = true
end
else
obj.previewer = false
end
local __hide_previewer = opts.__hide_previewer
if __hide_previewer then
obj.hidden_previewer = obj.previewer
obj.previewer = nil
else
obj.hidden_previewer = nil
end
-- TODO: It's annoying that this is create and everything else is "new"
obj.scroller = p_scroller.create(obj.scroll_strategy, obj.sorting_strategy)
obj.highlighter = p_highlighter.new(obj)
if opts.on_complete then
for _, on_complete_item in ipairs(opts.on_complete) do
obj:register_completion_callback(on_complete_item)
end
end
return obj
end
--- Take an index and get a row.
---@note: Rows are 0-indexed, and `index` is 1 indexed (table index)
---@param index number: the index in line_manager
---@return number: the row for the picker to display in
function Picker:get_row(index)
if self.sorting_strategy == "ascending" then
return index - 1
else
return self.max_results - index
end
end
--- Take a row and get an index
---@note: Rows are 0-indexed, and `index` is 1 indexed (table index)
---@param row number: The row being displayed
---@return number: The index in line_manager
function Picker:get_index(row)
if self.sorting_strategy == "ascending" then
return row + 1
else
return self.max_results - row
end
end
--- Get the row number of the "best" entry
---@return number: the number of the "reset" row
function Picker:get_reset_row()
if self.sorting_strategy == "ascending" then
return 0
else
return self.max_results - 1
end
end
--- Check if the picker is no longer in use
---@return boolean|nil: `true` if picker is closed, `nil` otherwise
function Picker:is_done()
if not self.manager then
return true
end
end
--- Clear rows that are after the final remaining entry
---@note: useful when number of remaining results is narrowed down
---@param results_bufnr number: the buffer number of the results buffer
function Picker:clear_extra_rows(results_bufnr)
if self:is_done() then
log.trace "Not clearing due to being already complete"
return
end
if not vim.api.nvim_buf_is_valid(results_bufnr) then
log.debug("Invalid results_bufnr for clearing:", results_bufnr)
return
end
local worst_line, ok, msg
if self.sorting_strategy == "ascending" then
local num_results = self.manager:num_results()
worst_line = self.max_results - num_results
if worst_line <= 0 then
return
end
ok, msg = pcall(vim.api.nvim_buf_set_lines, results_bufnr, num_results, -1, false, {})
else
worst_line = self:get_row(self.manager:num_results())
if worst_line <= 0 then
return
end
local empty_lines = utils.repeated_table(worst_line, "")
ok, msg = pcall(vim.api.nvim_buf_set_lines, results_bufnr, 0, worst_line, false, empty_lines)
end
if not ok then
log.debug("Failed to set lines:", msg)
end
log.trace("Clearing:", worst_line)
end
--- Highlight the entry corresponding to the given row
---@param results_bufnr number: the buffer number of the results buffer
---@param prompt table: table with information about the prompt buffer
---@param display string: the text corresponding to the given row
---@param row number: the number of the chosen row
function Picker:highlight_one_row(results_bufnr, prompt, display, row)
if not self.sorter.highlighter then
return
end
local highlights = self.sorter:highlighter(prompt, display)
if highlights then
for _, hl in ipairs(highlights) do
local highlight, start, finish
if type(hl) == "table" then
highlight = hl.highlight or "TelescopeMatching"
start = hl.start
finish = hl.finish or hl.start
elseif type(hl) == "number" then
highlight = "TelescopeMatching"
start = hl
finish = hl
else
error "Invalid higlighter fn"
end
self:_increment "highlights"
vim.api.nvim_buf_add_highlight(results_bufnr, ns_telescope_matching, highlight, row, start - 1, finish)
end
end
local entry = self.manager:get_entry(self:get_index(row))
self.highlighter:hi_multiselect(row, self:is_multi_selected(entry))
end
--- Check if the given row number can be selected
---@param row number: the number of the chosen row in the results buffer
---@return boolean
function Picker:can_select_row(row)
if self.sorting_strategy == "ascending" then
return row <= self.manager:num_results() and row < self.max_results
else
return row >= 0 and row <= self.max_results and row >= self.max_results - self.manager:num_results()
end
end
--TODO: document what `find_id` is for
function Picker:_next_find_id()
local find_id = self._find_id + 1
self._find_id = find_id
return find_id
end
--- A helper function for creating each of the windows in a picker
---@param bufnr number: the buffer number to be used in the window
---@param popup_opts table: options to pass to `popup.create`
function Picker:_create_window(bufnr, popup_opts)
local what = bufnr or ""
local win, opts = popup.create(what, popup_opts)
a.nvim_win_set_option(win, "winblend", self.window.winblend)
local border_win = opts and opts.border and opts.border.win_id
if border_win then
a.nvim_win_set_option(border_win, "winblend", self.window.winblend)
end
return win, opts, border_win
end
--- Opens the given picker for the user to interact with
---@note: this is the main function for pickers, as it actually creates the interface for users
function Picker:find()
self:close_existing_pickers()
self:reset_selection()
self.__original_mousemoveevent = vim.o.mousemoveevent
vim.o.mousemoveevent = true
self.original_win_id = a.nvim_get_current_win()
_, self.original_cword = pcall(vim.fn.expand, "<cword>")
-- User autocmd run it before create Telescope window
vim.api.nvim_exec_autocmds("User", { pattern = "TelescopeFindPre" })
local layout = self:create_layout()
layout:mount()
self.layout = layout
self.prompt_win, self.prompt_bufnr, self.prompt_border =
layout.prompt.winid, layout.prompt.bufnr, layout.prompt.border
self.results_win, self.results_bufnr, self.results_border =
layout.results.winid, layout.results.bufnr, layout.results.border
if layout.preview then
self.preview_win, self.preview_bufnr, self.preview_border =
layout.preview.winid, layout.preview.bufnr, layout.preview.border
else
self.preview_win, self.preview_bufnr, self.preview_border = nil, nil, nil
end
pcall(a.nvim_buf_set_option, self.results_bufnr, "tabstop", 1) -- #1834
pcall(a.nvim_buf_set_option, self.prompt_bufnr, "tabstop", 1) -- #1834
a.nvim_buf_set_option(self.prompt_bufnr, "buftype", "prompt")
a.nvim_win_set_option(self.results_win, "wrap", self.wrap_results)
a.nvim_win_set_option(self.prompt_win, "wrap", true)
if self.preview_win then
a.nvim_win_set_option(self.preview_win, "wrap", true)
end
-- Prompt prefix
local prompt_prefix = self.prompt_prefix
vim.fn.prompt_setprompt(self.prompt_bufnr, prompt_prefix)
self:_reset_prefix_color()
-- TODO: This could be configurable in the future, but I don't know why you would
-- want to scroll through more than 10,000 items.
--
-- This just lets us stop doing stuff after tons of things.
self.max_results = self.__scrolling_limit
vim.api.nvim_buf_set_lines(self.results_bufnr, 0, self.max_results, false, utils.repeated_table(self.max_results, ""))
local status_updater = self:get_status_updater(self.prompt_win, self.prompt_bufnr)
local debounced_status = debounce.throttle_leading(status_updater, 50)
local tx, rx = channel.mpsc()
self._on_lines = tx.send
local find_id = self:_next_find_id()
if self.default_text then
self:set_prompt(self.default_text)
end
if vim.tbl_contains({ "insert", "normal" }, self.initial_mode) then
local mode = vim.fn.mode()
local keys
if self.initial_mode == "normal" then
-- n: A<ESC> makes sure cursor is at always at end of prompt w/o default_text
keys = mode ~= "n" and "<ESC>A<ESC>" or "A<ESC>"
else
-- always fully retrigger insert mode: required for going from one picker to next
keys = mode ~= "n" and "<ESC>A" or "A"
end
a.nvim_feedkeys(a.nvim_replace_termcodes(keys, true, false, true), "ni", true)
else
utils.notify("pickers.find", {
msg = "`initial_mode` should be one of ['normal', 'insert'] but passed " .. self.initial_mode,
level = "ERROR",
})
end
local main_loop = async.void(function()
self.sorter:_init()
-- Do filetype last, so that users can register at the last second.
pcall(a.nvim_buf_set_option, self.prompt_bufnr, "filetype", "TelescopePrompt")
pcall(a.nvim_buf_set_option, self.results_bufnr, "filetype", "TelescopeResults")
await_schedule()
while true do
-- Wait for the next input
rx.last()
await_schedule()
self:_reset_track()
if not vim.api.nvim_buf_is_valid(self.prompt_bufnr) then
log.debug("ON_LINES: Invalid prompt_bufnr", self.prompt_bufnr)
return
end
-- we kinda always wanna reset the color, because of `cc` and `dd` commands,
-- which also delete the prefix and after prefix deletion we need to reapply highlighting
self:_reset_prefix_color()
local start_time = vim.loop.hrtime()
local prompt = self:_get_next_filtered_prompt()
state.set_global_key("current_line", prompt)
if self.__locations_input == true then
local filename, line_number, column_number = utils.__separate_file_path_location(prompt)
if line_number or column_number then
state.set_global_key("prompt_location", { row = line_number, col = column_number })
elseif state.get_global_key "prompt_location" then
state.set_global_key("prompt_location", nil)
end
-- it is important to continue behaving as if there is no location in prompt
prompt = filename
elseif state.get_global_key "prompt_location" then
-- in case new picker that does not support locations is opened clear the location
state.set_global_key("prompt_location", nil)
end
-- TODO: Entry manager should have a "bulk" setter. This can prevent a lot of redraws from display
if self.cache_picker == false or self.cache_picker.is_cached ~= true then
self.sorter:_start(prompt)
self.manager = EntryManager:new(self.max_results, self.entry_adder, self.stats)
self:_reset_highlights()
local process_result = self:get_result_processor(find_id, prompt, debounced_status)
local process_complete = self:get_result_completor(self.results_bufnr, find_id, prompt, status_updater)
local ok, msg = pcall(function()
self.finder(prompt, process_result, process_complete)
end)
if not ok then
log.warn("Finder failed with msg: ", msg)
end
local diff_time = (vim.loop.hrtime() - start_time) / 1e6
if self.debounce and diff_time < self.debounce then
async.util.sleep(self.debounce - diff_time)
end
else
-- TODO(scroll): This can only happen once, I don't like where it is.
self:_resume_picker()
end
end
end)
-- Register attach
vim.api.nvim_buf_attach(self.prompt_bufnr, false, {
on_lines = function(...)
if self._finder_attached then
find_id = self:_next_find_id()
status_updater { completed = false }
self._on_lines(...)
end
end,
on_detach = function()
self:_detach()
end,
})
vim.api.nvim_create_augroup("PickerInsert", {})
-- TODO: Use WinLeave as well?
vim.api.nvim_create_autocmd("BufLeave", {
buffer = self.prompt_bufnr,
group = "PickerInsert",
nested = true,
once = true,
callback = function()
require("telescope.pickers").on_close_prompt(self.prompt_bufnr)
end,
})
vim.api.nvim_create_autocmd("VimResized", {
buffer = self.prompt_bufnr,
group = "PickerInsert",
nested = true,
callback = function()
require("telescope.pickers").on_resize_window(self.prompt_bufnr)
end,
})
state.set_status(
self.prompt_bufnr,
setmetatable({
layout = layout,
picker = self,
-- compatibility
prompt_bufnr = self.prompt_bufnr,
prompt_win = self.prompt_win,
prompt_border_win = self.prompt_border.winid,
results_bufnr = self.results_bufnr,
results_win = self.results_win,
results_border_win = self.results_border.winid,
preview_bufnr = self.preview_bufnr,
preview_win = self.preview_win,
preview_border_win = self.preview_border and self.preview_border.winid,
}, {
__mode = "kv",
})
)
mappings.apply_keymap(self.prompt_bufnr, self.attach_mappings, config.values.mappings)
tx.send()
main_loop()
end
--- A helper function to update picker windows when layout options are changed
function Picker:recalculate_layout()
local status = state.get_status(self.prompt_bufnr)
status.layout:update()
local layout = status.layout
self.prompt_win, self.prompt_bufnr, self.prompt_border =
layout.prompt.winid, layout.prompt.bufnr, layout.prompt.border
self.results_win, self.results_bufnr, self.results_border =
layout.results.winid, layout.results.bufnr, layout.results.border
if layout.preview then
self.preview_win, self.preview_bufnr, self.preview_border =
layout.preview.winid, layout.preview.bufnr, layout.preview.border
else
self.preview_win, self.preview_bufnr, self.preview_border = nil, nil, nil
end
-- Temporarily disabled: Draw the screen ASAP. This makes things feel speedier.
-- vim.cmd [[redraw]]
-- self.max_results = popup_opts.results.height
end
local update_scroll = function(win, oldinfo, oldcursor, strategy, buf_maxline)
if strategy == "ascending" then
vim.api.nvim_win_set_cursor(win, { buf_maxline, 0 })
vim.api.nvim_win_set_cursor(win, { oldinfo.topline, 0 })
vim.api.nvim_win_set_cursor(win, oldcursor)
elseif strategy == "descending" then
vim.api.nvim_win_set_cursor(win, { 1, 0 })
vim.api.nvim_win_set_cursor(win, { oldinfo.botline, 0 })
vim.api.nvim_win_set_cursor(win, oldcursor)
else
error(debug.traceback("Unknown sorting strategy: " .. (strategy or "")))
end
end
--- A wrapper for `Picker:recalculate_layout()` that also handles maintaining cursor position
function Picker:full_layout_update()
local oldinfo = vim.fn.getwininfo(self.results_win)[1]
local oldcursor = vim.api.nvim_win_get_cursor(self.results_win)
self:recalculate_layout()
self:refresh_previewer()
-- update scrolled position
local buf_maxline = #vim.api.nvim_buf_get_lines(self.results_bufnr, 0, -1, false)
update_scroll(self.results_win, oldinfo, oldcursor, self.sorting_strategy, buf_maxline)
end
-- TODO: update multi-select with the correct tag name when available
--- A simple interface to remove an entry from the results window without
--- closing telescope. This either deletes the current selection or all the
--- selections made using multi-select. It can be used to define actions
--- such as deleting buffers or files.
---
--- Example usage:
--- <code>
--- actions.delete_something = function(prompt_bufnr)
--- local current_picker = action_state.get_current_picker(prompt_bufnr)
--- current_picker:delete_selection(function(selection)
--- -- delete the selection outside of telescope
--- end)
--- end
--- </code>
---
--- Example usage in telescope:
--- - `actions.delete_buffer()`
---@param delete_cb function: called for each selection fn(s) -> bool|nil (true|nil removes the entry from the results)
function Picker:delete_selection(delete_cb)
vim.validate { delete_cb = { delete_cb, "f" } }
local original_selection_strategy = self.selection_strategy
self.selection_strategy = "row"
local delete_selections = self._multi:get()
local used_multi_select = true
if vim.tbl_isempty(delete_selections) then
table.insert(delete_selections, self:get_selection())
used_multi_select = false
end
local selection_index = {}
for result_index, result_entry in ipairs(self.finder.results) do
if vim.tbl_contains(delete_selections, result_entry) then
table.insert(selection_index, result_index)
end
end
-- Sort in reverse order as removing an entry from the table shifts down the
-- other elements to close the hole.
table.sort(selection_index, function(x, y)
return x > y
end)
for _, index in ipairs(selection_index) do
local delete_cb_return = delete_cb(self.finder.results[index])
if delete_cb_return == nil or delete_cb_return == true then
table.remove(self.finder.results, index)
end
end
if used_multi_select then
self._multi = MultiSelect:new()
end
self:refresh()
vim.defer_fn(function()
self.selection_strategy = original_selection_strategy
end, 50)
end
---@param text string text to set as prompt
---@param reset boolean? whether to replace prompt with text entirely or just append
function Picker:set_prompt(text, reset)
reset = vim.F.if_nil(reset, true)
if not reset then
text = self:_get_prompt() .. text
end
self:reset_prompt(text)
end
--- Closes the windows for the prompt, results and preview
---@param status table: table containing information on the picker
--- and associated windows. Generally obtained from `state.get_status`
function Picker.close_windows(status)
local prompt_bufnr = status.layout.prompt.bufnr
status.layout:unmount()
state.clear_status(prompt_bufnr)
end
--- Get the entry table of the current selection
---@return table
function Picker:get_selection()
return self._selection_entry
end
--- Get the row number of the current selection
---@return number
function Picker:get_selection_row()
if self._selection_row then
-- If the current row is no longer selectable than reduce it to num_results - 1, so the next selectable row.
-- This makes selection_strategy `row` work much better if the selected row is no longer part of the output.
--TODO(conni2461): Maybe this can be moved to scroller. (currently in a hotfix so not viable)
if self.selection_strategy == "row" then
local num_results = self.manager:num_results()
if self.sorting_strategy == "ascending" then
if self._selection_row >= num_results then
return num_results - 1
end
else
local max = self.max_results - num_results
if self._selection_row < max then
return self.max_results - num_results
end
end
end
return self._selection_row
end
return self:get_reset_row()
end
--- Move the current selection by `change` steps
---@param change number
function Picker:move_selection(change)
self:set_selection(self:get_selection_row() + change)
end
--- Add the entry of the given row to the multi-select object
---@param row number: the number of the chosen row
function Picker:add_selection(row)
local entry = self.manager:get_entry(self:get_index(row))
self._multi:add(entry)
self:update_prefix(entry, row)
self:get_status_updater(self.prompt_win, self.prompt_bufnr)()
self.highlighter:hi_multiselect(row, true)
end
--- Remove the entry of the given row to the multi-select object
---@param row number: the number of the chosen row
function Picker:remove_selection(row)
local entry = self.manager:get_entry(self:get_index(row))
self._multi:drop(entry)
self:update_prefix(entry, row)
self:get_status_updater(self.prompt_win, self.prompt_bufnr)()
self.highlighter:hi_multiselect(row, false)
end
--- Check if the given row is in the multi-select object
---@param entry table: table with information about the chosen entry
---@return number: the "count" associated to the entry in the multi-select
--- object (if present), `nil` otherwise
function Picker:is_multi_selected(entry)
return self._multi:is_selected(entry)
end
--- Get a table containing all of the currently selected entries
---@return table: an integer indexed table of selected entries
function Picker:get_multi_selection()
return self._multi:get()
end
--- Toggle the given row in and out of the multi-select object.
--- Also updates the highlighting for the given entry
---@param row number: the number of the chosen row
function Picker:toggle_selection(row)
local entry = self.manager:get_entry(self:get_index(row))
if entry == nil then
return
end
self._multi:toggle(entry)
self:update_prefix(entry, row)
self:get_status_updater(self.prompt_win, self.prompt_bufnr)()
self.highlighter:hi_multiselect(row, self._multi:is_selected(entry))
end
--- Set the current selection to `nil`
---@note: generally used when a picker is first activated with `find()`
function Picker:reset_selection()
self._selection_entry = nil
self._selection_row = nil
end
function Picker:_reset_prefix_color(hl_group)
self._current_prefix_hl_group = hl_group or nil
if self.prompt_prefix ~= "" and a.nvim_buf_is_valid(self.prompt_bufnr) then
vim.api.nvim_buf_add_highlight(
self.prompt_bufnr,
ns_telescope_prompt_prefix,
self._current_prefix_hl_group or "TelescopePromptPrefix",
0,
0,
#self.prompt_prefix
)
end
end
-- TODO(conni2461): Maybe _ prefix these next two functions
-- TODO(conni2461): Next two functions only work together otherwise color doesn't work
-- Probably a issue with prompt buffers
--- Change the prefix in the prompt to be `new_prefix` and apply `hl_group`
---@param new_prefix string: the string to be used as the new prefix
---@param hl_group string: the name of the chosen highlight
function Picker:change_prompt_prefix(new_prefix, hl_group)
if not new_prefix then
return
end
if new_prefix ~= "" then
vim.fn.prompt_setprompt(self.prompt_bufnr, new_prefix)
else