Integrate monaco editor

[coolbreeze413]

Motivate of the pull request

• To address an existing issue. If so, please provide a link to the issue:
• Breaking new feature. If so, please describe details in the description part.

Describe the technical details

The Editor instance now uses the Monaco Editor (https://github.com/microsoft/monaco-editor) embedded into a HTML page, and loaded using QWebEngineView, in place of the QScintilla based editor.

What does this pull request change?

1. Integrate monaco-editor npm package download into the build process
2. Add HTML page to embed monaco-editor instance
3. MonacoEditor (monaco-editor based) class replaces Editor class (QScintilla based)
   This class implements QWebEngineView for the Editor instance, and uses QWebChannel to marshall signals and data between Qt C++ and monaco-editor JS code in the embedded HTML.
4. Add MONACO_EDITOR=1 as default for the Makefile, which controls switch between Monaco Editor based build vs the current QScintilla based build: make MONACO_EDITOR=1
5. Workflows updated to include QWebEngineWidgets and QWebChannel dependencies required for Monaco Editor
6. QWebEngineWidgets is not supported for MSYS2 MinGW64(Chromium build not supported), and hence Monaco Editor cannot be used here, and the CI is updated to use MONACO_EDITOR=0 for this platform build
7. Fixed a few issues with 'reload file when file changes externally' in TextEditorForm class (also applicable to QScintilla based editor build)

Which part of the code base require a change

• Library: TextEditor
• Plug-in:
• Engine: Changes to optimize 'flashing' issue on displaying the monaco editor QWebEngineView first time
• Documentation
• Regression tests
• Continous Integration (CI) scripts

Impact of the pull request

• Require a change on Quality of Results (QoR)
• Break back-compatibility. If so, please list who may be influenced.
  Use MONACO_EDITOR=0 with make to fallback to current QScintilla based editor, any build on MSYS2 MinGW64 for Windows will not work with monaco editor due to platform limitations

Known Issues/Limitations

1. Monaco Editor will not work on MSYS2 MinGW64 Windows build
2. Delay seen when opening editor instance first time
   Optimize the delay in waiting for the JS side of Monaco Editor to be initialized before returning from this ctor (seen on first editor instance open)
3. Delay seen in monaco editor resizing
   Optimize the delay seen in Automatic Resize of Monaco Editor w.r.t resize of the FOEDAG window which seems to be due to the GPU rendering of the JS code
4. Mouse Cursor not changing from 'Arrow' to 'Text' cursor sometimes
   On clicking outside the editor, cursor changes to 'Arrow' and on refocus on the editor, cursor changes to 'Text', however on doing this multiple times, sometimes, the 'Arrow' does not change to 'Text' even though editor is focused correctly (we can even select the text with the 'Arrow' cursor)

[coolbreeze413]

Requires installation of Qt6 WebEngine on the system (sudo apt install qt6-webengine-dev)

[ravic-rs]

Requires installation of Qt6 WebEngine on the system (sudo apt install qt6-webengine-dev)

Have you tried this for windows mingw compiler and under Ubuntu 2022 ? We seem to be having issues with it as @nadeemyaseen-rs and @KochynVolodymyr found out.

[codecov]

Codecov Report

Attention: 12 lines in your changes are missing coverage. Please review.

Comparison is base (4e3ebea) 12.79% compared to head (1a705ff) 12.78%.

Files	Patch %	Lines
src/TextEditor/text_editor_form.cpp	0.00%	11 Missing ⚠️
src/MainWindow/main_window.cpp	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1441      +/-   ##
==========================================
- Coverage   12.79%   12.78%   -0.01%     
==========================================
  Files         278      278              
  Lines       31390    31398       +8     
  Branches    17930    17932       +2     
==========================================
  Hits         4015     4015              
- Misses      26519    26527       +8     
  Partials      856      856              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[KochynVolodymyr]

Known issues:

1. Click on links doesn't open url in default browser
2. Mouse cursor doesn't change from arrow to text cursor in some cases.

[ravikiranchollangi]

@coolbreeze413 a conflict.

[coolbreeze413]

@ravikiranchollangi @KochynVolodymyr
I will fix the conflicts and push shortly.
Meanwhile, I have updated the description and details of the PR, please review.

[KochynVolodymyr]

Looks good to me

[ravic-rs]

@alain-rs keeping this on hold until @nadeemyaseen-rs adds qtwebengine in foedag_rs and raptor CI.

[coolbreeze413]

@ravikiranchollangi @KochynVolodymyr @alaindargelas
I have pushed fix for 'open links in editor' with default desktop opener as well.

[ravikiranchollangi]

@ravikiranchollangi @KochynVolodymyr @alaindargelas I have pushed fix for 'open links in editor' with default desktop opener as well.

Thank you!

[alain-rs]

@ravikiran ***@***.***> please PR all the way to Raptor Get Outlook for Android<https://aka.ms/AAb9ysg>

…

________________________________ From: Ravikiran Chollangi ***@***.***> Sent: Sunday, January 21, 2024 11:25:42 AM To: os-fpga/FOEDAG ***@***.***> Cc: Alain Dargelas ***@***.***>; Mention ***@***.***> Subject: Re: [os-fpga/FOEDAG] Integrate monaco editor (PR #1441) @ravikiranchollangi<https://github.com/ravikiranchollangi> @KochynVolodymyr<https://github.com/KochynVolodymyr> @alaindargelas<https://github.com/alaindargelas> I have pushed fix for 'open links in editor' with default desktop opener as well. Thank you! — Reply to this email directly, view it on GitHub<#1441 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AVTRKPLI4W6NBXHO6BSGHQDYPVTTNAVCNFSM6AAAAABBRFL5KWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSMBSG4ZTKMZXG4>. You are receiving this because you were mentioned.Message ID: ***@***.***>