Bug 80789 – Web Inspector: TypeBuilder: Introduce OptOutput class for optional output parameters

• Status: RESOLVED
• Resolution: FIXED
• Component: Web Inspector (Deprecated)

[Peter Rybin]

Currently there is not proper support for optional output parameters.
It only works with RefPtr-based types (they can contain null values) and with boolean type (false is incorrectly treated as "not set" value).

A dedicated OptOutput class should be provided to support all types values plus "not set" state.

[Peter Rybin]

Created attachment 131257 [details]
Patch

[WebKit Review Bot]

Attachment 131257 [details] did not pass style-queue:

Failed to run "['Tools/Scripts/check-webkit-style', '--diff-files', u'Source/WebCore/ChangeLog', u'Source/WebCor..." exit_code: 1
Source/WebCore/inspector/InjectedScript.cpp:65:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Source/WebCore/inspector/InjectedScript.cpp:75:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Source/WebCore/inspector/InjectedScript.cpp:85:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Source/WebCore/inspector/InjectedScript.cpp:261:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Source/WebCore/inspector/InjectedScript.h:108:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Total errors found: 5 in 12 files


If any of these errors are false positives, please file a bug against check-webkit-style.

[Yury Semikhatsky]

Comment on attachment 131257 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=131257&action=review

> Source/WebCore/inspector/CodeGeneratorInspector.py:2244
> +class OptOutput {

Please make this class non-copyable to avoid passing it by value.

> Source/WebCore/inspector/InspectorDOMDebuggerAgent.cpp:67
> +static const InspectorFrontend::Debugger::Reason::Enum domNativeBreakpointType = InspectorFrontend::Debugger::Reason::DOM;

Is there a reason for not inlining the new constant values?

> Source/WebCore/inspector/InspectorPageAgent.cpp:508
> +        *cookiesString = "";

The protocol description says it should contain result of document.cookies even if the cookies array is present. Please file a bug on this and put FIXME here.

> Source/WebCore/inspector/InspectorPageAgent.cpp:839
> +    frameObject->setSecurityOrigin(frame->document()->securityOrigin()->toString());

Should this parameter be required if it is always present anyway? The type is still hidden anyway so I think we may want to fix this.

[Peter Rybin]

> > Source/WebCore/inspector/CodeGeneratorInspector.py:2244
> > +class OptOutput {

> Please make this class non-copyable to avoid passing it by value.

Done

> > Source/WebCore/inspector/InspectorDOMDebuggerAgent.cpp:67
> > +static const InspectorFrontend::Debugger::Reason::Enum domNativeBreakpointType = InspectorFrontend::Debugger::Reason::DOM;

> Is there a reason for not inlining the new constant values?

Done

> > Source/WebCore/inspector/InspectorPageAgent.cpp:508
> > +        *cookiesString = "";
> 
> The protocol description says it should contain result of document.cookies even if the cookies array is present. Please file a bug on this and put FIXME here.

Done

> > Source/WebCore/inspector/InspectorPageAgent.cpp:839
> > +    frameObject->setSecurityOrigin(frame->document()->securityOrigin()->toString());
> 
> Should this parameter be required if it is always present anyway? The type is still hidden anyway so I think we may want to fix this.

Done

[Peter Rybin]

Created attachment 131354 [details]
Patch

[WebKit Review Bot]

Attachment 131354 [details] did not pass style-queue:

Failed to run "['Tools/Scripts/check-webkit-style', '--diff-files', u'Source/WebCore/ChangeLog', u'Source/WebCor..." exit_code: 1
Source/WebCore/inspector/InjectedScript.cpp:65:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Source/WebCore/inspector/InjectedScript.cpp:75:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Source/WebCore/inspector/InjectedScript.cpp:85:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Source/WebCore/inspector/InjectedScript.cpp:261:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Source/WebCore/inspector/InjectedScript.h:108:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Total errors found: 5 in 12 files


If any of these errors are false positives, please file a bug against check-webkit-style.

[Build Bot]

Comment on attachment 131354 [details]
Patch

Attachment 131354 [details] did not pass win-ews (win):
Output: http://queues.webkit.org/results/11945302

[Yury Semikhatsky]

Comment on attachment 131354 [details]
Patch

The change appears to break Windows build, r- for this. Please fix.

[Yury Semikhatsky]

(In reply to comment #8)
> (From update of attachment 131354 [details])
> The change appears to break Windows build, r- for this. Please fix.

4>Generating Code...
4>c:\cygwin\home\buildbot\webkit\webkitbuild\debug\obj\webcore\derivedsources\inspectorbackenddispatcher.cpp(827) : error C2220: warning treated as error - no 'object' file generated
4>c:\cygwin\home\buildbot\webkit\webkitbuild\debug\obj\webcore\derivedsources\inspectorbackenddispatcher.cpp(827) : warning C4701: potentially uninitialized local variable 'out_base64Encoded' used
4>c:\cygwin\home\buildbot\webkit\webkitbuild\debug\obj\webcore\derivedsources\inspectorbackenddispatcher.cpp(3039) : warning C4701: potentially uninitialized local variable 'out_result' used
4>c:\cygwin\home\buildbot\webkit\webkitbuild\debug\obj\webcore\derivedsources\inspectorbackenddispatcher.cpp(3060) : warning C4701: potentially uninitialized local variable 'out_result' used
4>c:\cygwin\home\buildbot\webkit\webkitbuild\debug\obj\webcore\derivedsources\inspectorbackenddispatcher.cpp(3354) : warning C4701: potentially uninitialized local variable 'out_result' used

[Peter Rybin]

Created attachment 131740 [details]
Patch

[WebKit Review Bot]

Attachment 131740 [details] did not pass style-queue:

Failed to run "['Tools/Scripts/check-webkit-style', '--diff-files', u'Source/WebCore/ChangeLog', u'Source/WebCor..." exit_code: 1
Source/WebCore/inspector/InjectedScript.cpp:65:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Source/WebCore/inspector/InjectedScript.cpp:75:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Source/WebCore/inspector/InjectedScript.cpp:85:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Source/WebCore/inspector/InjectedScript.cpp:261:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Source/WebCore/inspector/InjectedScript.h:108:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Total errors found: 5 in 12 files


If any of these errors are false positives, please file a bug against check-webkit-style.

[WebKit Review Bot]

Comment on attachment 131740 [details]
Patch

Clearing flags on attachment: 131740

Committed r110673: <http://trac.webkit.org/changeset/110673>

[WebKit Review Bot]

All reviewed patches have been landed.  Closing bug.

[Csaba Osztrogonác]

Reopen, because it broke the Qt minimal bot, I think all !ENABLE(INSPECTOR) build.

[Yury Semikhatsky]

From the IRC channel:
<Ossy>: yurys,  benjaminp said:" for the Inspector build, it looks like ContentSearchUtils.h needs #if ENABLE(INSPECTOR)"

[Peter Rybin]

Created attachment 131963 [details]
Only merge. Do not commit before 81132

[WebKit Review Bot]

Attachment 131963 [details] did not pass style-queue:

Failed to run "['Tools/Scripts/check-webkit-style', '--diff-files', u'Source/WebCore/ChangeLog', u'Source/WebCor..." exit_code: 1
Source/WebCore/inspector/InjectedScript.cpp:65:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Source/WebCore/inspector/InjectedScript.cpp:75:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Source/WebCore/inspector/InjectedScript.cpp:85:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Source/WebCore/inspector/InjectedScript.cpp:261:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Source/WebCore/inspector/InjectedScript.h:108:  The parameter type should use PassRefPtr instead of RefPtr.  [readability/pass_ptr] [5]
Total errors found: 5 in 12 files


If any of these errors are false positives, please file a bug against check-webkit-style.

[Yury Semikhatsky]

Comment on attachment 131963 [details]
Only merge. Do not commit before 81132

Clearing flags on attachment: 131963

Committed r111005: <http://trac.webkit.org/changeset/111005>

[Yury Semikhatsky]

All reviewed patches have been landed.  Closing bug.