Span inspector #1296
Span inspector #1296
Conversation
This highlights all output tokens that share the same span as the text cursor is hovering over.
Expansion erros are now shown directly in the output textfield.
- Fix incorrect calculation of target span - Fix false highlighting caused by Pretty Please code manipulation
- Prevents issues with special characters like '<' and '>' breaking the output HTML
These tokens are now ignored during parsing because prettyplease inserts them automatically in certain situations.
…fresh bug - Make output text area scrollable - Adjust text color to match the theme - Fix edge case where text change did not trigger refresh if cursor position stayed the same
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1296 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 75 75
Lines 12772 12772
=========================================
Hits 12772 12772 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
- Before tests were failing due to an outdated Cargo.lock
- Tests were failing due to an outdated Cargo.lock
| [dependencies] | ||
| cxx.workspace = true | ||
| cxx-qt.workspace = true | ||
| cxx-qt-lib = { workspace = true, features = ["full"] } |
There was a problem hiding this comment.
Please take a look at which features of cxx-qt-lib you really need, as compiling cxx-qt-lib fully can take a lot of time.
| @@ -24,7 +24,7 @@ members = [ | |||
|
|
|||
| "tests/basic_cxx_only/rust", | |||
| "tests/basic_cxx_qt/rust", | |||
| "tests/qt_types_standalone/rust", | |||
| "tests/qt_types_standalone/rust", "examples/span-inspector", | |||
There was a problem hiding this comment.
Move this line up to the other examples.
|
|
||
| fn main() { | ||
| let qml_module: QmlModule<'static, &str, &str> = QmlModule { | ||
| uri: "com.kdab.cxx_qt.demo", |
There was a problem hiding this comment.
| uri: "com.kdab.cxx_qt.demo", | |
| uri: "com.kdab.cxx_qt.span_inspector", |
I copied this from our demos, but this could actually use a useful name (remember to update the according QML import).
| qt_thread | ||
| .queue(|this| { | ||
| unsafe { this.output_document() } | ||
| .set_html(&QString::from(String::from("expanding..."))) | ||
| }) | ||
| .ok(); |
There was a problem hiding this comment.
I don't think this needs to use a qt_thread.
Can't this just call set_html directly?
|
|
||
| let text = unsafe { Pin::new_unchecked(&mut *input.text_document()) } | ||
| .to_plain_text() | ||
| .to_string(); |
There was a problem hiding this comment.
This last to_string() call does a UTF-16 to UTF-8 conversion.
Please move this conversion into the background thread as well.
| let string = token.to_string(); | ||
| !matches!(string.as_str(), "," | "}" | "{") |
There was a problem hiding this comment.
This check is implemented twice in build_html, please factor it out into a common method.
There was a problem hiding this comment.
By the way, I think pretty-please can also insert , so that may need to be added to the list.
| ( | ||
| target_span | ||
| .map(|s| s.byte_range().eq(token.span().byte_range())) | ||
| .unwrap_or_else(|| false), |
There was a problem hiding this comment.
| .unwrap_or_else(|| false), | |
| .unwrap_or_default(), |
| } | ||
|
|
||
| // Expand input code as #[cxxqt_qt::bridge] would do | ||
| fn expand(input: &str, cursor_position: usize) -> Result<(String, Vec<(bool, bool)>), String> { |
There was a problem hiding this comment.
It is pretty unclear what the two bool instances in Vec<(bool, bool)> actually represent.
Please create a new struct with named fields for this.
| background-color: #ff00ff; | ||
| padding: 2px 6px; | ||
| border-radius: 6px; | ||
| } | ||
| .generated { | ||
| color: rgba(255, 255, 255, 100); | ||
| padding: 2px 6px; | ||
| border-radius: 6px; |
There was a problem hiding this comment.
These colors are hard-coded, and can be hard to read, depending on the color scheme (light/dark mode).
Ideally these would be chosen based on the current palette of the widget, but this may be hard to fix at the moment, so it's something to note for a follow-up PR.
| }; | ||
| qt_thread | ||
| .queue(move |this| { | ||
| unsafe { this.output_document() }.set_html(&QString::from(output)) |
There was a problem hiding this comment.
If you do multiple subsequent edits to the input string, they all race to set their result as the output_string. If a later edit finishes faster, it will be overwritten by an edit that happened beforehand, leaving the app in an inconsistent state.
The easiest way to fix this is to add a request_token (just an i32) that is incremented every time a background thread is started.
Only the background thread with the matching request_token is then allowed to set its result.
This PR introduces a tool called span-inspector that helps analyze and visualize the spans of tokens generated from the input to a cxx-qt-bridge macro.
Details