WebView add asynchronous RunScript variant: RunScriptAsync

[TcT2k]

Add RunScriptAsync() to wxWebView

My current implementation and proposal is this:

    virtual void RunScriptAsync(const wxString& javascript, void* clientData = NULL) const;

When running RunScriptAsync() a new event wxEVT_WEBVIEW_SCRIPT_RESULT is triggered on success or failure. It will contain the specified clientData via GetClientData(). IsError() will be false if the execution was successful and GetString() will contain the scripts output/return value. On error IsError() will be true and an error message is available via GetString().

I've simplified the current javascript wrapper code to a single javascript call. Which is especially useful for async operation but also reduces calls to the native API from 3 times per RunScript() call to once.

I've included a new generic wxWebView::RunScript() implementation which will use the backends wxWebView::RunScriptAsync() to enable synchronous calls. This should unifiy the different backends implementation as the native API is asynchronous anyway (except for IE, where I think async execution will not be implemented).

ToDo List:

• Complete documentation
• Integrate into sample
• Add unit tests?
• Add IsError() to wxWebViewEvent
• Simplify JavaScript Wrapper
  • Edge
  • IE
  • WKWebView
  • webkit2
• Implement RunScriptAsync()
  • Edge
  • WKWebView
  • webkit2

As always any ideas feedback is welcome.

I would also like to know how to test easily test the webkit1 backend.

[vadz]

It seems that it would be nice to merge this (see https://trac.wxwidgets.org/ticket/19293) and I don't think anybody cares about IE by now, so we could well leave this unimplemented for it, but we do need some documentation and showing this in the sample and testing it would be also very nice.

Would anybody have time to do this before 3.1.6?

[TcT2k]

Would anybody have time to do this before 3.1.6?

I meant coming back to this (actually use it in an application of mine).
My main problem were a few failing unit tests (regression) based on my simplification of the wrapper code. Having to do with type conversion. Hopefully I can get some work done on this in the coming week.

[TcT2k]

@vadz
This should be ready to review and merge now. I've addressed all open issues I wanted to tackle.

RunScriptAsync() is available for all backends apart from IE.
Internally they all already used async execution that was made synchronously in RunScript().
As already stated RunScript() is now a common method that calls the backends RunScriptAsync() internally.

[vadz]

Excellent, thanks a lot!

I'm fine with merging this as is (maybe after adding the possibly missing initialization), but please let me know if you want, or if I should, apply the minor style/wording comments.

I'll leave this here for at least a few days to give others time to review and maybe test it in any case.

Thanks again!

[TcT2k]

@vadz I've added your suggestions.
Some time in the future RunScript() should probably be deprecated, but no need to do this right now.

[vadz]

Great, thanks!

It looks 100% ready to me now, but, as I said, I'll leave it here for a few more days just in case others can/want to test it. I'll merge it next week if there are no comments.

[vadz]

No comments, so merging, thanks again!