third_party/WebKit/public/web/WebDataSource.h

   1 /*
   2  * Copyright (C) 2009 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebDataSource_h
  32 #define WebDataSource_h
  33
  34 #include "../platform/WebCommon.h"
  35 #include "WebNavigationType.h"
  36 #include "WebTextDirection.h"
  37
  38 namespace blink {
  39
  40 class WebURL;
  41 class WebURLRequest;
  42 class WebURLResponse;
  43 template <typename T> class WebVector;
  44
  45 class WebDataSource {
  46 public:
  47     class ExtraData {
  48     public:
  49         virtual ~ExtraData() { }
  50     };
  51
  52     // Returns the original request that resulted in this datasource.
  53     virtual const WebURLRequest& originalRequest() const = 0;
  54
  55     // Returns the request corresponding to this datasource.  It may
  56     // include additional request headers added by WebKit that were not
  57     // present in the original request.  This request may also correspond
  58     // to a location specified by a redirect that was followed.
  59     virtual const WebURLRequest& request() const = 0;
  60
  61     // Returns the response associated with this datasource.
  62     virtual const WebURLResponse& response() const = 0;
  63
  64     // When this datasource was created as a result of WebFrame::loadData,
  65     // there may be an associated unreachableURL.
  66     virtual bool hasUnreachableURL() const = 0;
  67     virtual WebURL unreachableURL() const = 0;
  68
  69     // Allows the embedder to append redirects to the chain as a navigation
  70     // is starting, in case it is being transferred from another process.
  71     virtual void appendRedirect(const WebURL&) = 0;
  72
  73     // Returns all redirects that occurred (both client and server) before
  74     // at last committing the current page.  This will contain one entry
  75     // for each intermediate URL, and one entry for the last URL (so if
  76     // there are no redirects, it will contain exactly the current URL, and
  77     // if there is one redirect, it will contain the source and destination
  78     // URL).
  79     virtual void redirectChain(WebVector<WebURL>&) const = 0;
  80
  81     // Returns whether the navigation associated with this datasource is a
  82     // client redirect.
  83     virtual bool isClientRedirect() const = 0;
  84
  85     // Returns whether the navigation associated with this datasource should
  86     // replace the current history item.
  87     virtual bool replacesCurrentHistoryItem() const = 0;
  88
  89     // The type of navigation that triggered the creation of this datasource.
  90     virtual WebNavigationType navigationType() const = 0;
  91
  92     // Extra data associated with this datasource.  If non-null, the extra
  93     // data pointer will be deleted when the datasource is destroyed.
  94     // Setting the extra data pointer will cause any existing non-null
  95     // extra data pointer to be deleted.
  96     virtual ExtraData* extraData() const = 0;
  97     virtual void setExtraData(ExtraData*) = 0;
  98
  99     // Sets the navigation start time for this datasource. Ordinarily,
 100     // navigation start is determined in WebCore. But, in some situations,
 101     // the embedder might have a better value and can override it here. This
 102     // should be called before WebFrameClient::didCommitProvisionalLoad.
 103     // Calling it later may confuse users, because JavaScript may have run and
 104     // the user may have already recorded the original value.
 105     virtual void setNavigationStartTime(double) = 0;
 106
 107 protected:
 108     ~WebDataSource() { }
 109 };
 110
 111 } // namespace blink
 112
 113 #endif