Add hasCommittedRealDocument API to WebFrame.

Add hasCommittedRealDocument API to WebFrame.

Expose through the Web API whether the frame has commited a real document or not. This is used to decide whether a navigation should add a session history entry or not.

The Chromium side CL for this bug is https://codereview.chromium.org/15294012/.

BUG=178380

[nasko, 2013-09-20 21:06:45]

Hey Darin,
Can you review this API addition for me? I need to expose this state, so I can
properly set the AUTO_SUBFRAME bit in RenderView.
Thanks,
Nasko

[darin (slow to review), 2013-09-20 21:57:13]

Is there a Chromium side to this change that I could also review?

-Darin


On Fri, Sep 20, 2013 at 2:06 PM, <nasko@chromium.org> wrote:

> Reviewers: darin,
>
> Message:
> Hey Darin,
> Can you review this API addition for me? I need to expose this state, so I
> can
> properly set the AUTO_SUBFRAME bit in RenderView.
> Thanks,
> Nasko
>
> Description:
> Add hasCommittedRealDocument API to WebFrame.
>
> Expose through the Web API whether the frame has commited a real document
> or
> not. This is used to decide whether a navigation should add a session
> history
> entry or not.
>
> BUG=178380
>
> Please review this at
https://codereview.chromium.**org/24286007/<https://codereview.chromium.org/2...
>
> SVN Base:
svn://svn.chromium.org/blink/**trunk<http://svn.chromium.org/blink/trunk>
>
> Affected files (+11, -0 lines):
>   M Source/web/WebFrameImpl.h
>   M Source/web/WebFrameImpl.cpp
>   M public/web/WebFrame.h
>
>
> Index: Source/web/WebFrameImpl.cpp
> diff --git a/Source/web/WebFrameImpl.cpp b/Source/web/WebFrameImpl.cpp
> index 6cfb39d7ab9b68c61ccfe700216627**a9f822023a..**
> 589ffd92112feeea173f692374e1d2**dcbdec48aa 100644
> --- a/Source/web/WebFrameImpl.cpp
> +++ b/Source/web/WebFrameImpl.cpp
> @@ -982,6 +982,13 @@ void WebFrameImpl::stopLoading()
>      frame()->loader()->**stopAllLoaders();
>  }
>
> +bool WebFrameImpl::**hasCommittedRealDocument() const
> +{
> +    if (!frame())
> +        return false;
> +    return frame()->loader()->**stateMachine()->**
> committedFirstRealDocumentLoad**();
> +}
> +
>  WebDataSource* WebFrameImpl::**provisionalDataSource() const
>  {
>      ASSERT(frame());
> Index: Source/web/WebFrameImpl.h
> diff --git a/Source/web/WebFrameImpl.h b/Source/web/WebFrameImpl.h
> index 104f8497aa3281da92443b7c2d7f0a**33399a3d2f..**
> 530a0de794142ffe39d41ec173ce91**3a4541dd91 100644
> --- a/Source/web/WebFrameImpl.h
> +++ b/Source/web/WebFrameImpl.h
> @@ -151,6 +151,7 @@ public:
>          bool replace);
>      virtual bool isLoading() const;
>      virtual void stopLoading();
> +    virtual bool hasCommittedRealDocument() const;
>      virtual WebDataSource* provisionalDataSource() const;
>      virtual WebDataSource* dataSource() const;
>      virtual WebHistoryItem previousHistoryItem() const;
> Index: public/web/WebFrame.h
> diff --git a/public/web/WebFrame.h b/public/web/WebFrame.h
> index 211def68aed06bc968232765d3d6b6**d4962f7ed1..**
> 0fe5b1f941693b46a4d7c27afb17b4**fac9dd5fd5 100644
> --- a/public/web/WebFrame.h
> +++ b/public/web/WebFrame.h
> @@ -349,6 +349,9 @@ public:
>      // Stops any pending loads on the frame and its children.
>      virtual void stopLoading() = 0;
>
> +    // Returns true if the current frame has committed the first real
> document.
> +    virtual bool hasCommittedRealDocument() const = 0;
> +
>      // Returns the data source that is currently loading.  May be null.
>      virtual WebDataSource* provisionalDataSource() const = 0;
>
>
>
>

To unsubscribe from this group and stop receiving emails from it, send an email
to blink-reviews+unsubscribe@chromium.org.

[nasko, 2013-09-20 21:57:58]

On 2013/09/20 21:57:13, darin wrote:
> Is there a Chromium side to this change that I could also review?
> 
> -Darin
> 
> 
> On Fri, Sep 20, 2013 at 2:06 PM, <mailto:nasko@chromium.org> wrote:
> 
> > Reviewers: darin,
> >
> > Message:
> > Hey Darin,
> > Can you review this API addition for me? I need to expose this state, so I
> > can
> > properly set the AUTO_SUBFRAME bit in RenderView.
> > Thanks,
> > Nasko
> >
> > Description:
> > Add hasCommittedRealDocument API to WebFrame.
> >
> > Expose through the Web API whether the frame has commited a real document
> > or
> > not. This is used to decide whether a navigation should add a session
> > history
> > entry or not.
> >
> > BUG=178380
> >
> > Please review this at
>
https://codereview.chromium.**org/24286007/%3Chttps://codereview.chromium.org...>
> >
> > SVN Base:
> svn://svn.chromium.org/blink/**trunk<http://svn.chromium.org/blink/trunk>
> >
> > Affected files (+11, -0 lines):
> >   M Source/web/WebFrameImpl.h
> >   M Source/web/WebFrameImpl.cpp
> >   M public/web/WebFrame.h
> >
> >
> > Index: Source/web/WebFrameImpl.cpp
> > diff --git a/Source/web/WebFrameImpl.cpp b/Source/web/WebFrameImpl.cpp
> > index 6cfb39d7ab9b68c61ccfe700216627**a9f822023a..**
> > 589ffd92112feeea173f692374e1d2**dcbdec48aa 100644
> > --- a/Source/web/WebFrameImpl.cpp
> > +++ b/Source/web/WebFrameImpl.cpp
> > @@ -982,6 +982,13 @@ void WebFrameImpl::stopLoading()
> >      frame()->loader()->**stopAllLoaders();
> >  }
> >
> > +bool WebFrameImpl::**hasCommittedRealDocument() const
> > +{
> > +    if (!frame())
> > +        return false;
> > +    return frame()->loader()->**stateMachine()->**
> > committedFirstRealDocumentLoad**();
> > +}
> > +
> >  WebDataSource* WebFrameImpl::**provisionalDataSource() const
> >  {
> >      ASSERT(frame());
> > Index: Source/web/WebFrameImpl.h
> > diff --git a/Source/web/WebFrameImpl.h b/Source/web/WebFrameImpl.h
> > index 104f8497aa3281da92443b7c2d7f0a**33399a3d2f..**
> > 530a0de794142ffe39d41ec173ce91**3a4541dd91 100644
> > --- a/Source/web/WebFrameImpl.h
> > +++ b/Source/web/WebFrameImpl.h
> > @@ -151,6 +151,7 @@ public:
> >          bool replace);
> >      virtual bool isLoading() const;
> >      virtual void stopLoading();
> > +    virtual bool hasCommittedRealDocument() const;
> >      virtual WebDataSource* provisionalDataSource() const;
> >      virtual WebDataSource* dataSource() const;
> >      virtual WebHistoryItem previousHistoryItem() const;
> > Index: public/web/WebFrame.h
> > diff --git a/public/web/WebFrame.h b/public/web/WebFrame.h
> > index 211def68aed06bc968232765d3d6b6**d4962f7ed1..**
> > 0fe5b1f941693b46a4d7c27afb17b4**fac9dd5fd5 100644
> > --- a/public/web/WebFrame.h
> > +++ b/public/web/WebFrame.h
> > @@ -349,6 +349,9 @@ public:
> >      // Stops any pending loads on the frame and its children.
> >      virtual void stopLoading() = 0;
> >
> > +    // Returns true if the current frame has committed the first real
> > document.
> > +    virtual bool hasCommittedRealDocument() const = 0;
> > +
> >      // Returns the data source that is currently loading.  May be null.
> >      virtual WebDataSource* provisionalDataSource() const = 0;
> >
> >
> >
> >
> 
> To unsubscribe from this group and stop receiving emails from it, send an
email
> to mailto:blink-reviews+unsubscribe@chromium.org.

Yes, I added it to the issue description after I sent the initial email. The
link is  https://codereview.chromium.org/15294012/.

[darin (slow to review), 2013-09-20 22:03:04]

https://codereview.chromium.org/24286007/diff/1/public/web/WebFrame.h
File public/web/WebFrame.h (right):

https://codereview.chromium.org/24286007/diff/1/public/web/WebFrame.h#newcode353
public/web/WebFrame.h:353: virtual bool hasCommittedRealDocument() const = 0;
Note: On the Chromium side, you could also just keep track of whether or not you
ever received a DidCommitProvisionalLoad for this WebFrame. That is not sent
when we load the initial empty document.

See the implementation of FrameLoader::receivedFirstData().