Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve wxJSScriptWrapper methods comments

Browse Source 
Explain more clearly what each of them does.
This commit is contained in:
Vadim Zeitlin
2017-10-22 17:39:29 +02:00
parent 6563f38496
commit eff7a2e07f
1 changed files with 16 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
include/wx/private/jsscriptwrapper.h
View File

@@ -13,9 +13,14 @@
#include "wx/regex.h" #include "wx/regex.h"
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
// JS Script Wrapper for wxWebView // Helper for wxWebView::RunScript()
// ---------------------------------------------------------------------------- // ----------------------------------------------------------------------------
// This class provides GetWrappedCode(), GetOutputCode() and GetCleanUpCode()
// functions that should be executed in the backend-appropriate way by each
// wxWebView implementation in order to actually execute the user-provided
// JavaScript code, retrieve its result (if it executed successfully) and
// perform the cleanup at the end.
class wxJSScriptWrapper class wxJSScriptWrapper
{ {
public: public:
@@ -37,14 +42,20 @@ public:
escapeDoubleQuotes.Replace(&m_escapedCode,"\\1\\1\\\\\\2"); escapeDoubleQuotes.Replace(&m_escapedCode,"\\1\\1\\\\\\2");
} }
// This method is used to add a double quote level into a JavaScript code // Get the code to execute, its returned value will be either boolean true,
// in order to get it working when eval is called programmatically. // if it executed successfully, or the exception message if an error
// occurred.
//
// Execute GetOutputCode() later to get the real output after successful
// execution of this code.
wxString GetWrappedCode() const wxString GetWrappedCode() const
{ {
return wxString::Format("try { var %s = eval(\"%s\"); true; } \ return wxString::Format("try { var %s = eval(\"%s\"); true; } \
catch (e) { e.name + \": \" + e.message; }", m_outputVarName, m_escapedCode); catch (e) { e.name + \": \" + e.message; }", m_outputVarName, m_escapedCode);
} }
// Get code returning the result of the last successful execution of the
// code returned by GetWrappedCode().
wxString GetOutputCode() const wxString GetOutputCode() const
{ {
#if wxUSE_WEBVIEW && wxUSE_WEBVIEW_WEBKIT && defined(__WXOSX__) #if wxUSE_WEBVIEW && wxUSE_WEBVIEW_WEBKIT && defined(__WXOSX__)
@@ -131,6 +142,8 @@ public:
#endif #endif
} }
// Execute the code returned by this function to let the output of the code
// we executed be garbage-collected.
wxString GetCleanUpCode() const wxString GetCleanUpCode() const
{ {
return wxString::Format("%s = undefined;", m_outputVarName); return wxString::Format("%s = undefined;", m_outputVarName);