Summary of the Pull Request

This pull request probably doesn't make sense to merge, but I found an open ticket for it and I had built a version for my personal build, so it felt like it was at least worth posting. If you do decide to implement something like this I would love to help work on it.

https://github.com/microsoft/terminal/issues/5314

The fuzzy search implementation is from fzf-native. https://github.com/nvim-telescope/telescope-fzf-native.nvim

• Adapted to work with ICU/UText

Searching Terminal Repository

Searching .net memory dump

References and Relevant Issues

https://github.com/microsoft/terminal/issues/5314

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

PR Checklist

• [ ] Closes #xxx
• [ ] Tests added/passed
• [ ] Documentation updated
  • If checked, please file a pull request on our docs repo and link it here: #xxx
• [ ] Schema updated (if necessary)

Jan 22 '24 03:01 e82eric

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

conni
eidx
Extention
fzf
Initalized
MAXASCII
pchar
pidx
sidx
stdbool
stddef
stdint
strdup
uidx

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.22/apply.pl' |
perl - 'https://github.com/microsoft/terminal/actions/runs/7606272651/attempts/1'

      with:
        extra_dictionaries:
          cspell:k8s/dict/k8s.txt
          cspell:swift/src/swift.txt
          cspell:gaming-terms/dict/gaming-terms.txt
          cspell:monkeyc/src/monkeyc_keywords.txt
          cspell:cryptocurrencies/cryptocurrencies.txt

check_extra_dictionaries: ''

Jan 22 '24 04:01 github-actions[bot]

but also, we're still wrapping up a couple internal commitments before we loop back to button up 1.20. I'm guessing just based on the scope of this delta that we may need to wait a bit before we can give this the review it very rightly deserves. Thanks for the patience here!

Jan 22 '24 15:01 zadjii-msft

Holy s***!

Jan 22 '24 16:01 DHowett

Thanks! Totally understand, no rush on my end.

Jan 22 '24 22:01 e82eric

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

aed
bbf
caedf
conni
ecab
efaca
efcabf
eidx
Extention
fbef
fca
fcc
fce
fzf
Initalized
MAXASCII
mimport
mnamespace
mstatic
pchar
pidx
sidx
stdbool
stddef
stdint
strdup
uidx

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.22/apply.pl' |
perl - 'https://github.com/microsoft/terminal/actions/runs/7677039365/attempts/1'

      with:
        extra_dictionaries:
          cspell:k8s/dict/k8s.txt
          cspell:swift/src/swift.txt
          cspell:gaming-terms/dict/gaming-terms.txt
          cspell:monkeyc/src/monkeyc_keywords.txt
          cspell:cryptocurrencies/cryptocurrencies.txt

check_extra_dictionaries: ''

# Automatically suggested patterns
# hit-count: 9 file-count: 1
# git index header
index (?:[0-9a-z]{7,40},|)[0-9a-z]{7,40}\.\.[0-9a-z]{7,40}

Jan 27 '24 06:01 github-actions[bot]

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

conni
eidx
Extention
fzf
Initalized
MAXASCII
pchar
pidx
sidx
stdbool
stddef
stdint
strdup
uidx

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.22/apply.pl' |
perl - 'https://github.com/microsoft/terminal/actions/runs/7677072539/attempts/1'

      with:
        extra_dictionaries:
          cspell:k8s/dict/k8s.txt
          cspell:swift/src/swift.txt
          cspell:gaming-terms/dict/gaming-terms.txt
          cspell:monkeyc/src/monkeyc_keywords.txt
          cspell:cryptocurrencies/cryptocurrencies.txt

check_extra_dictionaries: ''

Jan 27 '24 07:01 github-actions[bot]

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

conni
eidx
Extention
fzf
Initalized
MAXASCII
pchar
pidx
sidx
stdbool
stddef
stdint
strdup
uidx

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.22/apply.pl' |
perl - 'https://github.com/microsoft/terminal/actions/runs/7677159519/attempts/1'

      with:
        extra_dictionaries:
          cspell:k8s/dict/k8s.txt
          cspell:swift/src/swift.txt
          cspell:gaming-terms/dict/gaming-terms.txt
          cspell:monkeyc/src/monkeyc_keywords.txt
          cspell:cryptocurrencies/cryptocurrencies.txt

check_extra_dictionaries: ''

Jan 27 '24 07:01 github-actions[bot]

@check-spelling-bot Report

:red_circle: Please review

See the :open_file_folder: files view, the :scroll:action log, or :memo: job summary for details.

Automator
Barbazz
CFdanco
CFnco
CFSo
CFsodc
conni
danco
eidx
Extention
fbb
foob
fzf
fzfunittests
icns
Ingnore
Initalized
MAXASCII
Mfc
noooo
obz
pchar
pidx
previewer
rdoc
samb
sidx
sodc
stdbool
stddef
stdint
strdup
Sufix
uappend
uascii
ubonus
ucalculate
UCALL
udelim
ufzf
uhas
uidx
uindex
uis
uleading
unormalize
ustr
ustrtok
utrailing
utrim
utry
UWhite
Wrappable
zshc
zshcompctl

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/v0.0.22/apply.pl' |
perl - 'https://github.com/microsoft/terminal/actions/runs/8152048091/attempts/1'

      with:
        extra_dictionaries:
          cspell:k8s/dict/k8s.txt
          cspell:swift/src/swift.txt
          cspell:gaming-terms/dict/gaming-terms.txt
          cspell:monkeyc/src/monkeyc_keywords.txt
          cspell:cryptocurrencies/cryptocurrencies.txt

check_extra_dictionaries: ''

Mar 05 '24 06:03 github-actions[bot]

okay so what if we did this as a type of pane content, instead of as a part of the control itself? It could be like, the "Find All" pane or something (which is usually different in VsCode / sublime compared to the usual Find UI)

this has been shower thoughts with mike

Apr 29 '24 12:04 zadjii-msft

okay so what if we did this as a type of pane content, instead of as a part of the control itself? It could be like, the "Find All" pane or something (which is usually different in VsCode / sublime compared to the usual Find UI)

this has been shower thoughts with mike

Trying to get my head around this, by pane do you mean something like the docked areas in visual studio?

Apr 29 '24 13:04 e82eric

by pane do you mean something like the docked areas in visual studio

Sorta, yea. In the chain of PRs that terminated in #16914, we added support for the Terminal to have panes that included things that weren't just TermControl's - they could be anything.

So like, we could totally make a FuzzyFindPaneContent in the same manner. I'm sure there's some way we could like, stick a TermControl as a preview into that pane too.

(i cannot stress enough, this was a half baked shower thought)

Apr 29 '24 14:04 zadjii-msft

by pane do you mean something like the docked areas in visual studio

Sorta, yea. In the chain of PRs that terminated in #16914, we added support for the Terminal to have panes that included things that weren't just TermControl's - they could be anything.

So like, we could totally make a FuzzyFindPaneContent in the same manner. I'm sure there's some way we could like, stick a TermControl as a preview into that pane too.

(i cannot stress enough, this was a half baked shower thought)

got it, it should work, that is similar to how I had it implemented at first, it was a xaml row below the swap panel control, and I was scrolling the swap panel to see the selected match (the scrolling wasn't necessary it was just nice to see the context rows around the selected match while in the list box).

the main downside was that when I was done with the fuzzy search I wanted the screen space back so I was hiding the row after the search, which mostly worked but cdb and a few other TUI applications would do weird things with the cursor with all the reflows (The reflows wouldn't be an issue if the pane doesn't auto hide).

having it in another pane would would make the code a lot simpler (mostly not having the extra renderer/swap panel for the previewer).

Apr 29 '24 15:04 e82eric

@zadjii-msft not sure if it helps, this is what it looked like when I had the search control below the swap panel. I think visually that would be similar to a pane (without the auto show/hide stuff)

Apr 30 '24 03:04 e82eric

Honestly yea that looks almost exactly like what I was thinking. It's probably a lot of plumbing to get it up and into a separate Pane, but I'm thinking that might be a bit cleaner architecture-wise

Apr 30 '24 10:04 zadjii-msft

Makes sense, I think the main thing is that the pane would need a reference to the Terminal instance (or some proxy/interface) to read the contents of the buffer, set the selected char and optionally perform scrolling to show the current item from the list box in the swap panel.

I think selecting the char had a dependency on the Renderer also.

Apr 30 '24 13:04 e82eric

I don't think I'd be opposed to some winrt API's on TermControl.idl (and probably ControlCore.idl) to proxy through something like

struct SelectionRange {
  Windows.Foundation.Point Start;
  Windows.Foundation.Point End;
}

runtimeclass TermControl {
  // ...
  Vector<SelectionRange> GetPatternMatches(String pattern);

  void SelectRange(SelectionRange range); // basically just a projection of ControlCore::_selectSpan
}

Apr 30 '24 21:04 zadjii-msft

@zadjii-msft

I can give it a try and see how it goes. Its probably a long shot that it would be something you would want to merge but it feels like the exercise would be worth while to test the Pane abstraction.

• I would use ScratchPad as an example right?

Will this work for TermControl?

//HighlightedTextSegment is from the file below.  I am not sure if I would have access to it, if not I could create a similar set of clasess.
//I need the text spans to show the parts of the row that make up the fuzzy match
//https://github.com/microsoft/terminal/blob/32fbb16d43ddfcdd039a61c5af051a16b972faeb/src/cascadia/TerminalApp/HighlightedText.h#L11
struct FuzzySearchMetch {
  HighlightedTextSegment Text;
  //I think the start is the only part of match that is useful for selection since it is n number of spans across the row.  Selecting the first char in the match seems to get me where I want to go.  (This looked like how fzf and Telescope work)
  Windows.Foundation.Point Start;
}

runtimeclass TermControl {
  Vector<FuzzySearchMatch> GetPatternMatches(String pattern);
  void SelectPoint(SelectionPoint point);
}

For Vector<FuzzySearchMatch> GetPatternMatches(String pattern) These are the parts that I think I would need. (Would this work or would it be too invasive?)

• Somewhere that has access to GetTextBuffer(). I think this would be ControlCore?
• This iterates over all of the rows in the textbuffer and scores them. https://github.com/microsoft/terminal/blob/ae97bbd1819e5fa183125d30185a3d51dd343384/src/buffer/out/search.cpp#L37
• I needed this additional function in UTextAdapter to be able to support unicode, (before I was converting from wchar to char, I think this also keeps from copying the rows during the search) https://github.com/microsoft/terminal/blob/ae97bbd1819e5fa183125d30185a3d51dd343384/src/buffer/out/UTextAdapter.cpp#L331
• This is the library that I used for the native implementation of FZF, this may be a non starter for merging. I think pretty much everyone that uses neovim ends using this, so it should be battle tested, but I don't know how it would fit with Microsoft's security policies etc. https://github.com/nvim-telescope/telescope-fzf-native.nvim (I adapted it to work with ICU/UText) https://github.com/microsoft/terminal/blob/ae97bbd1819e5fa183125d30185a3d51dd343384/src/buffer/fzf/fzf.c#L596

May 01 '24 02:05 e82eric

@zadjii-msft I was able to get a really basic version of the fuzzy search working in the pane.

I forgot to ask, was the idea that the fuzzy search would search across all TermControls?

This is what the diff looked like. https://github.com/e82eric/terminal/commit/89a4e14661c747bafafaf40f98caf656634c2610

May 07 '24 07:05 e82eric

I forgot to ask, was the idea that the fuzzy search would search across all TermControls

Let's save that for a v2? Cause this is already awesome

May 07 '24 12:05 zadjii-msft

@zadjii-msft Any chance you guys are thinking about adding the ability to float a pane? I was trying it out this weekend and it seemed pretty nice, for the fuzzy search it got out of the way after the search without having to reflow, for the TermControl it was nice to be able to do something temporary and have it get out the way (I actually think I found this more useful than the fuzzy search).

Fuzzy Search pane as float.

TermControl pane as float.

May 13 '24 06:05 e82eric

Ha you've figured out my plan! I was absolutely planning that (in a bit longer term).

We've got this QueryPalette element we're using currently for Terminal Chat:

and part of my eventual goal is to unify that floating "pane" with the rest of our Pane code, s.t. arbitrary panes could "float" like that too, or start as a floating pane, then get pinned as one in the tree, or.... who knows what yet. We still need to better sort out how some of those UI flows would work, but it's definitely something I've been thinking about.

May 14 '24 13:05 zadjii-msft

Awesome! I was surprised how nice it was having the termcontrol in a float windows.

I'm sure there's some way we could like, stick a TermControl as a preview into that pane too.

I was going to attempt adding a preview window using a TermControl just to see if it is possible or not, do I have it right that I would use the same instance of the ControlCore from main TermControl to create the preview TermControl?

May 14 '24 16:05 e82eric

do I have it right that I would use the same instance of the ControlCore from main TermControl to create the preview TermControl

Yes, ish. Having multiple different TermControl's attached to the same ControlCore at the same time is not something the codebase is super well suited for right now. I actually experimented with something like this just a couple months ago. I left my very haphazard notes over in https://github.com/microsoft/terminal/issues/16495#issuecomment-1984745678. I'd warn that those notes are very rough and likely stale. But I think the basic idea - having a bunch of TermControl's that can all connect to the same ControlCore - is probably pretty similar.

(it's also probably way past overkill for a v0 of this PR, but something you could play with)

I'll probably have more thoughts to share on this PR in like two weeks (after Build is done next week). Sorry for the delays!

May 14 '24 18:05 zadjii-msft

Thanks! That gets me pointed in the right direction.

No rush on reviewing the PR.

May 14 '24 21:05 e82eric

That worked. (Adding the screenshot for reference, agree that it is overkill for v0)

May 29 '24 07:05 e82eric

I was able to get a really basic version of the fuzzy search working in the pane.

I forgot to ask, was the idea that the fuzzy search would search across all TermControls?

This is what the diff looked like. e82eric@89a4e14

Looping back around - was there a reason this Pane version wasn't pushed as the tip of this PR? I think that's probably a lot closer to merging than all this IRenderData stuff.

(I'm collecting up other notes too, but I wanted to make sure that question was answered first)

Jun 03 '24 10:06 zadjii-msft

I was able to get a really basic version of the fuzzy search working in the pane. I forgot to ask, was the idea that the fuzzy search would search across all TermControls? This is what the diff looked like. e82eric@89a4e14

Looping back around - was there a reason this Pane version wasn't pushed as the tip of this PR? I think that's probably a lot closer to merging than all this IRenderData stuff.

(I'm collecting up other notes too, but I wanted to make sure that question was answered first)

@zadjii-msft sorry, I got distracted by the float plane and preview window stuff. Will update the PR to use https://github.com/e82eric/terminal/commit/89a4e14661c747bafafaf40f98caf656634c2610 tonight.

Jun 03 '24 15:06 e82eric

sorry, I got distracted by the float plane and preview window stuff. Will update the PR to use e82eric@89a4e14 tonight.

No worries! Just wanted to make sure there wasn't something else I was missing.

I'll write up the rest of our notes in the meantime ☺️

Jun 03 '24 15:06 zadjii-msft

sorry, I got distracted by the float plane and preview window stuff. Will update the PR to use e82eric@89a4e14 tonight.

No worries! Just wanted to make sure there wasn't something else I was missing.

I'll write up the rest of our notes in the meantime ☺️

Should be updated now.

Jun 04 '24 06:06 e82eric