feat: Find in Editor #295

tom-ludwig · 2025-03-13T18:02:55Z

Important

~~We need to merge CodeEditApp/CodeEditTextView#78 before merging this PR.~~

Description

This PR introduces the initial implementation of the “Find in Editor” feature for the source editor. Users can now search for text within the currently open file using ⌘ F. All matching results are visually emphasized, and users can navigate between matches using next/previous controls.

What’s Included

Text search across the current document
Match highlighting with emphasis on the currently selected match
Keyboard shortcut support: ⌘ F to activate the find bar
Looping navigation with HUD notifications:
- Reaching the end → loops to first result (arrow.triangle.capsulepath)
- Reaching the beginning → loops to last result (flipped arrow.triangle.capsulepath)
- No more matches → arrow.down.to.line HUD icon displayed

Related Issues

#ISSUE_NUMBER

Checklist

I read and understood the contributing guide as well as the code of conduct
The issues this PR addresses are related to each other
My changes generate no new warnings
My code builds and runs on my machine
My changes are all related to the related issue above
I documented my code

Screenshots

…ches and clear button. When text field loses focus, emphasis layers are removed. Styled example app.

…odeEditSourceEditor into feat/in-doc-search

…hen looping find results or submitting when there is no result. Commented emphasize logic back in.

…ne number text color.

- If the users cursor is in view, the highlighted item will be next to the cursor - If the users cursor is out of view, we'll highlight the closed item to the visibe area

…match cycle logic from EmphasisManager to FindViewController. Using EmphasisManager in bracket pair matching instead of custom implementation reducing duplicated code. Implemented flash find matches when clicking the next and previous buttons when the editor is in focus. `bracketPairHighlight` becomes `bracketPairEmphasis`. Fixed various find issues and cleaned up implementation.

…dings didnt work while find panel was in focus preventing it from being dismissed.

thecoolwinter · 2025-04-07T14:36:15Z

Found one more bug that I'm working on in CodeEdit, I'm finding that the find panel is being removed from the view hierarchy (but not stopping being drawn) sometimes when clicking out of the find panel, and only when a previous tab had the find panel opened. I'm investigating and will report back.

As well as the failing tests.

thecoolwinter · 2025-04-07T14:43:01Z

Fixed the aforementioned bug, ended up strongly referencing self in the monitor closure. Not too sure why it was losing the reference, as the view it turned out was perfectly fine in memory. I added a call to removeEventMonitor in the view's deinit to ensure we don't leak memory.

thecoolwinter · 2025-04-07T15:01:51Z

As I'm fixing the tests, I've realized that the emphasis manager is not correctly drawing the non-flash emphases. I'm going to go fix that and link the PR here.

thecoolwinter · 2025-04-07T17:14:53Z

Okay I have a few updates:

I've fixed the drawing issues by adding a specific code path for drawing underlines.
I also found a bug where the emphasis manager was leaking emphases due to an offset bug.
During that, I inadvertently fixed the drawing code for drawing emphases that span multiple line fragments, which causes the bug shown in the video below.
However, during that change I was able to drastically simplify the 'rounded rect' code.

Screen.Recording.2025-04-07.at.12.11.10.PM.mov

I'm going to open the PR for these changes, and I'm tempted to just merge the change so it functions correctly and come back around to fix the text layer bug.

### Description - Fixes an emphasis manager bug where it could leak layers without removing their `CALayer`s when replacing flash emphases with other emphases. - Updates the emphasis drawing code to correctly draw underlines. - Updates the `roundedPathForRange` to correctly handle emphases that span multiple line fragments. While fixing the last point, I discovered that the emphasis manager doesn't correctly draw the text on emphases that span multiple line fragments. This makes sense, as right now it's just using a CATextLayer that has no knowledge of line breaks. In the future, that text layer should be replaced by a custom layer that draws the text using knowledge of existing line fragments positions. However, I think the issues this PR fixes are too important to wait until that can be done. Also note that that change will be critical to drag and drop, so it will absolutely be done and I have a branch somewhere with some of that work already completed. ### Related Issues * CodeEditApp/CodeEditSourceEditor#295 ### Checklist - [x] I read and understood the [contributing guide](https://github.com/CodeEditApp/CodeEdit/blob/main/CONTRIBUTING.md) as well as the [code of conduct](https://github.com/CodeEditApp/CodeEdit/blob/main/CODE_OF_CONDUCT.md) - [x] The issues this PR addresses are related to each other - [x] My changes generate no new warnings - [x] My code builds and runs on my machine - [x] My changes are all related to the related issue above - [x] I documented my code ### Screenshots Screen recording showing the text layer bug mentioned above, as well as the fixed multi-fragment drawing, and the fixed leak. Prior to this, when switching from flash to any other emphasis type, there was a good chance one of the new emphases would be kept. This was due to the emphasis manager assuming that the emphasis being flashed was kept around after the animation delay. This has been fixed in this PR. https://github.com/user-attachments/assets/a29048e4-ab81-4376-abe0-e0499e448ea8

…Update Insets, Fix Tests

thecoolwinter · 2025-04-07T19:11:53Z

Alright this should be ready to go, I fixed a myriad of issues that only appeared when using multiple tabs, or the odd way we handle safe area in CodeEdit.

Specifically this patch now:

Correctly updates the scroll view offset every time it's updated.
Uses constants rather than string literals for emphasis group IDs.
Correctly draws underline and border bracket pair emphases.
Adds a new additionalInsets parameter that allows the text content to be inset by an additional amount than any decoration. Previously this was done on the CodeEdit side, but the lack of distinction led to the find panel having a transparent 2px above it. Moving it down here makes sense anyways.
Removed final references to 'highlight layers' from previous bracket emphasis method.
Added tests for the new parameter, and updated all broken tests.

austincondiff · 2025-04-08T06:03:14Z

Is the EmphasisGroup enum extendable? I want to think about the future when extensions use this API. That is why I initially used strings but an enum could be better here.

thecoolwinter · 2025-04-08T16:57:53Z

Is the EmphasisGroup enum extendable? I want to think about the future when extensions use this API. That is why I initially used strings but an enum could be better here.

It's not using enum cases, it's using static variables but enums can't be initialized, so there can't be any confusion by trying to 'create' one. So it's still using strings to identify groups.

I don't think an enum is the right decision here for the reason you mentioned.

thecoolwinter · 2025-04-08T16:59:55Z

It is extendable, but it's not public since I don't think there's really a point to exposing that API. Anyone using the package who wants to use the emphasis API will work directly with the EmphasisManager, not any methods in CESE. I created it so there's consistent use everywhere groups share IDs (like in tests).

…xes (#2020) ### Description Updates CodeEditSourceEditor. Includes: - Find in Editor feature. - Improved undo grouping. - Improved word detection when selecting words. - Improved overscroll behavior. - Added mouse drag selection modes. ### Related Issues * CodeEditApp/CodeEditTextView#1 * CodeEditApp/CodeEditSourceEditor#295 ### Checklist - [x] I read and understood the [contributing guide](https://github.com/CodeEditApp/CodeEdit/blob/main/CONTRIBUTING.md) as well as the [code of conduct](https://github.com/CodeEditApp/CodeEdit/blob/main/CODE_OF_CONDUCT.md) - [x] The issues this PR addresses are related to each other - [x] My changes generate no new warnings - [x] My code builds and runs on my machine - [x] My changes are all related to the related issue above - [x] I documented my code

@austincondiff

### Description @austincondiff has been building out the 'replace' functionality and realized the way we had structured the panel, controller, target, and model was extremely overcomplicating things. This PR is an attempt to fix that Changes: - Moves all 'business logic' into the `FindPanelViewModel` observable object. This includes clarified methods like `find`, `replace`, and `moveToNextMatch/moveToPreviousMatch`. All state has been moved to this object as well, out of a combination of both the SwiftUI view and the find view controller. - Removes the `FindPanelDelegate` type entirely. All that type was doing was passing method calls from the find panel to it's controller. Since all that logic is now in the shared view model, the controller & view can just call the necessary methods on the model. - Simplifies the `FindViewController` to only handle view/model setup and layout. - Changes the focus state variable to an enum instead of two `Bool`s. This fixes an issue where there was a moment of nothing being focused when switching between the find and replace text fields. - Removes the unnecessary `NSHostingView -> NSView -> SwiftUI View` structure, replacing it with an `NSHostingView` subclass `FindPanelHostingView` that hosts a `FindPanelView`. - Clarifies some view naming to reflect what each type does. - `FindPanel` -> `FindPanelHostingView` - `FindPanelView` search fields moved to: - `FindSearchField` - `ReplaceSearchField` ### Related Issues * #295 ### Checklist  - [x] I read and understood the [contributing guide](https://github.com/CodeEditApp/CodeEdit/blob/main/CONTRIBUTING.md) as well as the [code of conduct](https://github.com/CodeEditApp/CodeEdit/blob/main/CODE_OF_CONDUCT.md) - [x] The issues this PR addresses are related to each other - [x] My changes generate no new warnings - [x] My code builds and runs on my machine - [x] My changes are all related to the related issue above - [x] I documented my code ### Screenshots

tom-ludwig and others added 11 commits March 10, 2025 19:50

Add search manager and search field

a10ba6f

Add Search Container, Search Bar, Show/Hide Commands, Animations

d920eb6

Set Initial Search Bar Constraints Correctly

5800d05

Add search manager and search field

1488a86

Add Search Container, Search Bar, Show/Hide Commands, Animations

dc5e6d8

Set Initial Search Bar Constraints Correctly

5842295

Renamed SearchBar to FindPanel. Styled FindPanel. Added number of mat…

fd16af7

…ches and clear button. When text field loses focus, emphasis layers are removed. Styled example app.

Add dark theme to example app

d62a0c1

Fixed background

1f9beb6

Adjusted font in example app

ae89966

Simplified example app

41d7180

austincondiff changed the title ~~feat: Search in Document~~ feat: Find in Editor Mar 16, 2025

thecoolwinter and others added 11 commits March 16, 2025 11:11

Merge branch 'feat/in-doc-search' of https://github.com/CodeEditApp/C…

9ed65d6

…odeEditSourceEditor into feat/in-doc-search

Fix Text Scrolling Under Panel, Fix Resizing Bug, Fix Test

8a028a3

Addded Bezel Notification to editor and firing a bezel notification w…

66035bf

…hen looping find results or submitting when there is no result. Commented emphasize logic back in.

Enabled anti-aliasing and font smoothing for line numbers. Changed li…

66d8508

…ne number text color.

Highlight the closes element to the users cursor

deebe23

- If the users cursor is in view, the highlighted item will be next to the cursor - If the users cursor is out of view, we'll highlight the closed item to the visibe area

Add documentation

fb2c670

Fix linter

968a4e9

Fixed merge conflict issue.

0695d43

Unified keybinding observer logic which fixed a bug where find keybin…

9d493df

…dings didnt work while find panel was in focus preventing it from being dismissed.

Fixed issue where keybindings would apply to other windows editors.

813531e

austincondiff mentioned this pull request Mar 31, 2025

Emphasis Manager Enhancements CodeEditApp/CodeEditTextView#78

Merged

6 tasks

thecoolwinter and others added 6 commits March 31, 2025 08:20

Remove Unused Variable

114c6e9

Renamed find panel cancel actions to dismiss.

56f37c0

Fixed SwiftLint errors and split files up.

40b7660

Update tests.sh

0980ef0

Update tests.sh

3ec17ec

Update tests.sh

f74d2e8

austincondiff requested a review from KaiTheRedNinja April 6, 2025 19:15

thecoolwinter added 2 commits April 7, 2025 09:03

Replace Safe Area With Top Padding, Smoother Animations

1dc6c3b

Merge branch 'main' into feat/in-doc-search

56acf85

thecoolwinter added 4 commits April 7, 2025 09:41

Add Find Panel Height when Setting Up Scroll View

ed43078

Clean Up Animation Code

4099499

Rename

9ad415c

Strongly Reference Self in Monitor

08445ee

Update Package.resolved

909eabc

thecoolwinter mentioned this pull request Apr 7, 2025

Fix EmphasisAPI Leaking Layers, Fix Emphasis Drawing CodeEditApp/CodeEditTextView#79

Merged

6 tasks

thecoolwinter added 3 commits April 7, 2025 14:04

Use Constants For Emphasis Groups, Add additionalInsets, Correctly …

a7cb556

…Update Insets, Fix Tests

Lint Error

d89d6b8

Fixing the lint cause the lint to be mad 👎

168d278

thecoolwinter mentioned this pull request Apr 7, 2025

[chore:] Update CodeEditSourceEditor, add Find In Editor, Misc Bug Fixes CodeEditApp/CodeEdit#2020

Merged

6 tasks

Merge branch 'main' into feat/in-doc-search

0aba812

thecoolwinter mentioned this pull request Apr 8, 2025

🐞 Broken example #298

Closed

thecoolwinter merged commit f444927 into main Apr 8, 2025
2 checks passed

thecoolwinter deleted the feat/in-doc-search branch April 8, 2025 17:19

austincondiff mentioned this pull request Apr 10, 2025

Find: Replace and Match Case Toggle #301

Draft

6 tasks

thecoolwinter mentioned this pull request Apr 21, 2025

Find and Replace Refactor #311

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Find in Editor #295

feat: Find in Editor #295

tom-ludwig commented Mar 13, 2025 •

edited by thecoolwinter

Loading

thecoolwinter commented Apr 7, 2025 •

edited

Loading

thecoolwinter commented Apr 7, 2025

thecoolwinter commented Apr 7, 2025

thecoolwinter commented Apr 7, 2025

thecoolwinter commented Apr 7, 2025

austincondiff commented Apr 8, 2025

thecoolwinter commented Apr 8, 2025

thecoolwinter commented Apr 8, 2025

feat: Find in Editor #295

feat: Find in Editor #295

Conversation

tom-ludwig commented Mar 13, 2025 • edited by thecoolwinter Loading

Description

Related Issues

Checklist

Screenshots

thecoolwinter commented Apr 7, 2025 • edited Loading

thecoolwinter commented Apr 7, 2025

thecoolwinter commented Apr 7, 2025

thecoolwinter commented Apr 7, 2025

thecoolwinter commented Apr 7, 2025

austincondiff commented Apr 8, 2025

thecoolwinter commented Apr 8, 2025

thecoolwinter commented Apr 8, 2025

tom-ludwig commented Mar 13, 2025 •

edited by thecoolwinter

Loading

thecoolwinter commented Apr 7, 2025 •

edited

Loading