Highlight groups for the HTML Stmt file and tooltips to reveal types. #7887

mcourteaux · 2023-10-09T21:17:07Z

While I was investigating the buffer index datatypes for #7884 myself, I added tooltips to reveal the datatype of the IR node in the Stmt file.

Another feature I wanted much, to analyze variables (especially when there is too much code to fit on the screen and you have to start scrolling, which makes the highlight-on-hover impractical) is to color matching variables by clicking them. There are 7 colors slots which will automatically recycle if you un-highlight a variable.

Also minor bugfix in the printing: Reinterpret casts were printed as normal casts before.

mcourteaux · 2023-10-09T21:26:44Z

@antonysigma Feel free to run the linter over the new JS.

antonysigma · 2023-10-11T19:08:42Z

antonysigma Feel free to run the linter over the new JS.

@mcourteaux For sure. Here you are:

/home/antony/Projects/halide/src/irvisualizer/html_template_StmtToHTML.js
   29:9   error  'matchedElements' is already defined  no-redeclare
   44:21  error  'highlightIdx' is already defined     no-redeclare
   65:5   error  'makeCodeVisible' is not defined      no-undef
  100:39  error  'event' is defined but never used     no-unused-vars
  156:18  error  'i' is already defined                no-redeclare
  166:13  error  'resizer' is already defined          no-redeclare
  167:18  error  'i' is already defined                no-redeclare
  199:51  error  'device_code_Tab' is not defined      no-undef

✖ 8 problems (8 errors, 0 warnings)

Feel free to git cherry-pick this commit to reproduce the above eslint linter warnings.

https://github.com/antonysigma/halide/tree/javascript-scan-for-virus

mcourteaux · 2023-10-12T18:33:23Z

@antonysigma Amazing, thank you! I found this online "playground" for eslint. I managed to get the exact same report. That's super convenient to test in the future. Thanks for helping validate that this alternative is viable.

You can use: https://eslint.org/play/ with the browser environment to get the report.

I'll improve upon the eslint issues, after which I think this is ready to merge.

mcourteaux · 2023-10-12T18:58:58Z

Cleaned up the code, all warnings are gone. This was actually useful! I retested the result, and all looks fine. Ready to merge.

abadams · 2023-10-12T21:55:37Z

src/StmtToHTML.cpp

@@ -1070,11 +1080,17 @@ class HTMLCodePrinter : public IRVisitor {
        context_stack_tags.push_back(tag);
    }

-    void print_opening_tag(const std::string &tag, const std::string &cls, std::string id) {
-        stream << "<" << tag << " class='" << cls << "' id='" << id << "'>";
+    /*


Please delete commented-out code, or add a comment that explains why it is preserved.

abadams · 2023-10-12T21:55:50Z

src/StmtToHTML.cpp

        stream << body;
        print_closing_tag(tag);
    }

-    void print_html_element(const std::string &tag, const std::string &cls, const std::string &body, std::string id) {
-        print_opening_tag(tag, cls, id);
+    /*


Same comment here.

abadams · 2023-10-12T21:56:56Z

src/StmtToHTML.cpp

@@ -1542,10 +1574,15 @@ class HTMLCodePrinter : public IRVisitor {
    }

    void visit(const Call *op) override {
+        /*


More commented-out code here.

mcourteaux · 2023-10-13T08:43:34Z

Oh sorry about those. I should make a habit of checking and reviewing the overall changes when I open a PR.

mcourteaux · 2023-10-18T13:06:14Z

Just to be clear, this is ready to merge. 🙂

abadams · 2023-10-18T17:08:02Z

Could you do a merge with main? That will hopefully clear up most of the CI failures.

mcourteaux · 2023-10-19T09:13:15Z

Okay! Rebased on main. 😄

mcourteaux · 2023-10-20T19:25:26Z

Thanks for merging! 🥳

I'm looking forward to hearing feedback on the HTML Stmt IR, as opposed to the plaintext Stmt IR files. I'm using them for a long time now, and I generally really like it. If there are obvious shortcomings, please let me know. I would love to see people start using this and prefer it. So if there's anything bothering/blocking you from using it, I'd be happy to hear it.

Here is a demo file I hosted for quickly checking it out.

Quick start: generator emit types are stmt_html and conceptual_stmt_html. Works great on host, and host-cuda targets. I get the best performance with Chromium, Firefox is significantly slower at loading the page.

@steven-johnson Maybe you can introduce this at Google if you think it's worth it?
@abadams @vksnk @maaz139 @antonysigma You were involved at some point in the discussion as well.

vksnk · 2023-10-24T18:09:33Z

This looks really cool and is indeed a big improvement over IR files!

@steven-johnson Maybe you can introduce this at Google if you think it's worth it?

I've pulled in the latest Halide changes into Google code base, so this should be available for internal use. I think we will need to write a short how-to on how to use it with Google build environment and after that we can advertise it in local Halide user group (actually, just last week someone asked me if there is an easy way to see a generated assembly for inner loops and it seems to fit the bill perfectly).

mcourteaux · 2023-10-24T18:16:14Z

I think we will need to write a short how-to on how to use it with Google build environment

Just as a note, it's not available through the Func or Pipeline C++ API, only through the Generators, which might not be a situation that applies to everyone.

abadams · 2023-10-24T19:00:33Z

Unless things have changed since I was there, Google is 100% Generators

antonysigma · 2023-10-24T22:54:11Z

@mcourteaux I am still catching up... Currently struggling with the emit option -e conceptual_stmt_html that results in Unhandled exception: map::at. I will workaround issue with -e conceptual_stmt_html,html and then checkout the new features in this PR.

mcourteaux · 2023-10-25T07:36:38Z

@antonysigma Sorry, this is the second time you report a bug like this. I fixed this one again. Hopefully all cases are covered. PR in #7914.

…halide#7887) * Highlight groups for the HTML Stmt file and tooltips to reveal types. * Cleaned up JS using eslint. * Remove commented code.

abadams requested a review from halidebuildbots October 12, 2023 21:52

abadams reviewed Oct 12, 2023

View reviewed changes

mcourteaux added 3 commits October 19, 2023 11:12

Highlight groups for the HTML Stmt file and tooltips to reveal types.

1e63302

Cleaned up JS using eslint.

af24b59

Remove commented code.

b8f888e

mcourteaux force-pushed the stmt_html_highlighting_and_type_tooltips branch from 02984f8 to b8f888e Compare October 19, 2023 09:12

abadams approved these changes Oct 20, 2023

View reviewed changes

abadams merged commit 2918854 into halide:main Oct 20, 2023
16 of 19 checks passed

mcourteaux mentioned this pull request Oct 25, 2023

Fix bug mentioned by @antonysigma. #7916

Merged

BrewTestBot mentioned this pull request Feb 2, 2024

halide 17.0.0 Homebrew/homebrew-core#161602

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Highlight groups for the HTML Stmt file and tooltips to reveal types. #7887

Highlight groups for the HTML Stmt file and tooltips to reveal types. #7887

mcourteaux commented Oct 9, 2023 •

edited

Loading

mcourteaux commented Oct 9, 2023

antonysigma commented Oct 11, 2023 •

edited

Loading

mcourteaux commented Oct 12, 2023 •

edited

Loading

mcourteaux commented Oct 12, 2023

abadams Oct 12, 2023

abadams Oct 12, 2023

abadams Oct 12, 2023

mcourteaux commented Oct 13, 2023

mcourteaux commented Oct 18, 2023

abadams commented Oct 18, 2023

mcourteaux commented Oct 19, 2023

mcourteaux commented Oct 20, 2023

vksnk commented Oct 24, 2023

mcourteaux commented Oct 24, 2023

abadams commented Oct 24, 2023

antonysigma commented Oct 24, 2023

mcourteaux commented Oct 25, 2023

Highlight groups for the HTML Stmt file and tooltips to reveal types. #7887

Highlight groups for the HTML Stmt file and tooltips to reveal types. #7887

Conversation

mcourteaux commented Oct 9, 2023 • edited Loading

mcourteaux commented Oct 9, 2023

antonysigma commented Oct 11, 2023 • edited Loading

mcourteaux commented Oct 12, 2023 • edited Loading

mcourteaux commented Oct 12, 2023

abadams Oct 12, 2023

Choose a reason for hiding this comment

abadams Oct 12, 2023

Choose a reason for hiding this comment

abadams Oct 12, 2023

Choose a reason for hiding this comment

mcourteaux commented Oct 13, 2023

mcourteaux commented Oct 18, 2023

abadams commented Oct 18, 2023

mcourteaux commented Oct 19, 2023

mcourteaux commented Oct 20, 2023

vksnk commented Oct 24, 2023

mcourteaux commented Oct 24, 2023

abadams commented Oct 24, 2023

antonysigma commented Oct 24, 2023

mcourteaux commented Oct 25, 2023

mcourteaux commented Oct 9, 2023 •

edited

Loading

antonysigma commented Oct 11, 2023 •

edited

Loading

mcourteaux commented Oct 12, 2023 •

edited

Loading