PSHEntry.ipdl 5.61 KB
Newer Older
1
2
3
4
5
6
7
8
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/. */

include protocol PContent;
include protocol PSHistory;

include DOMTypes;
9
include PresState;
10

11
using refcounted class mozilla::dom::CrossProcessSHEntry from "mozilla/dom/MaybeNewPSHEntry.h";
12
using refcounted class nsDocShellLoadState from "mozilla/dom/DocShellMessageUtils.h";
13
14
15
16
17
18
19
using struct nsID from "nsID.h";
using nsIntRect from "nsRect.h";

namespace mozilla {
namespace dom {

sync protocol PSHEntry {
20
21
  // IPDLParamTraits<dom::CrossProcessSHEntry*>::Write relies on PContent being
  // the manager.
22
23
24
25
  manager PContent;

parent:
  sync GetURI() returns (nsIURI uri);
26
  async SetURI(nsIURI uri);
27
  sync GetOriginalURI() returns (nsIURI originalUri);
28
  async SetOriginalURI(nsIURI originalUri);
29
  sync GetResultPrincipalURI() returns (nsIURI resultPrincipalUri);
30
  async SetResultPrincipalURI(nsIURI resultPrincipalUri);
31
  sync GetLoadReplace() returns (bool loadReplace);
32
  async SetLoadReplace(bool loadReplace);
33
  sync GetTitle() returns (nsString title);
34
  async SetTitle(nsString title);
35
  sync GetIsSubFrame() returns (bool isSubFrame);
36
  async SetIsSubFrame(bool isSubFrame);
37
  sync GetReferrerInfo() returns (nsIReferrerInfo referrerInfo);
38
  async SetReferrerInfo(nsIReferrerInfo referrerInfo);
39
  sync GetSticky() returns (bool sticky);
40
  async SetSticky(bool sticky);
41
  sync GetPostData() returns (nsIInputStream postData);
42
  async SetPostData(nsIInputStream postData);
43
  sync GetParent() returns (CrossProcessSHEntry parentEntry);
44
  async SetParent(nullable PSHEntry parentEntry);
45
  sync GetLoadType() returns (uint32_t loadType);
46
  async SetLoadType(uint32_t loadType);
47
  sync GetID() returns (uint32_t id);
48
  async SetID(uint32_t id);
49
  sync GetCacheKey() returns (uint32_t cacheKey);
50
  async SetCacheKey(uint32_t cacheKey);
51
  sync GetExpirationStatus() returns (bool expirationStatus);
52
  async SetExpirationStatus(bool expirationStatus);
53
  sync GetContentType() returns (nsCString contentType);
54
  async SetContentType(nsCString contentType);
55
  sync GetURIWasModified() returns (bool uriWasModified);
56
  async SetURIWasModified(bool uriWasModified);
57
  sync GetTriggeringPrincipal() returns (nsIPrincipal triggeringPrincipal);
58
  async SetTriggeringPrincipal(nsIPrincipal triggeringPrincipal);
59
  sync GetPrincipalToInherit() returns (nsIPrincipal principalToInherit);
60
  async SetPrincipalToInherit(nsIPrincipal principalToInherit);
61
62
  sync GetStoragePrincipalToInherit()
    returns (nsIPrincipal storagePrincipalToInherit);
63
  async SetStoragePrincipalToInherit(nsIPrincipal storagePrincipalToInherit);
64
  sync GetCsp() returns (nsIContentSecurityPolicy csp);
65
  async SetCsp(nsIContentSecurityPolicy csp);
66
  sync GetStateData() returns (ClonedMessageData stateData);
67
  async SetStateData(ClonedMessageData stateData);
68
  sync GetDocshellID() returns (nsID docshellId);
69
  async SetDocshellID(nsID docshellId);
70
71
  sync GetIsSrcdocEntry() returns (bool isSrcdocEntry);
  sync GetSrcdocData() returns (nsString srcdocData);
72
  async SetSrcdocData(nsString srcdocData);
73
  sync GetBaseURI() returns (nsIURI baseUri);
74
  async SetBaseURI(nsIURI baseUri);
75
  sync GetScrollRestorationIsManual() returns (bool scrollRestorationIsManual);
76
  async SetScrollRestorationIsManual(bool scrollRestorationIsManual);
77
78
  sync GetLoadedInThisProcess() returns (bool loadedInThisProcess);
  sync GetLastTouched() returns (uint32_t lastTouched);
79
  async SetLastTouched(uint32_t lastTouched);
80
81
  sync GetChildCount() returns (int32_t childCount);
  sync GetPersist() returns (bool persist);
82
83
  async SetPersist(bool persist);
  async SetScrollPosition(int32_t x, int32_t y);
84
85
  sync GetScrollPosition() returns (int32_t x, int32_t y);
  sync GetViewerBounds() returns (nsIntRect bounds);
86
87
88
89
90
91
92
93
94
95
  async SetViewerBounds(nsIntRect bounds);
  async Create(nsIURI URI, nsString title, nsIInputStream inputStream,
               uint32_t cacheKey, nsCString contentType,
               nsIPrincipal triggeringPrincipal, nsIPrincipal principalToInherit,
               nsIPrincipal storagePrincipalToInherit,
               nsIContentSecurityPolicy csp, nsID docshellID,
               bool dynamicCreation, nsIURI originalUri, nsIURI resultPrincipalURI,
               bool loadReplace, nsIReferrerInfo referrerInfo,
               nsString srcdoc, bool srcdocEntry, nsIURI baseURI,
               bool saveLayoutState, bool expired);
96
97
98
99
  sync HasDetachedEditor() returns (bool hasDetachedEditor);
  sync IsDynamicallyAdded() returns (bool isDynamicallyAdded);
  sync HasDynamicallyAddedChild() returns (bool hasDynamicallyAddedChild);
  sync AdoptBFCacheEntry(PSHEntry entry) returns (nsresult result);
100
  async AbandonBFCacheEntry(uint64_t aNewSharedID);
101
102
  sync SharesDocumentWith(PSHEntry entry) returns (bool sharesDocumentWith,
                                                   nsresult result);
103
  async SetLoadTypeAsHistory();
104
105
  sync AddChild(nullable PSHEntry childEntry, int32_t offset, bool useRemoteSubframes) returns (nsresult result);
  sync RemoveChild(PSHEntry childEntry) returns (nsresult result);
106
107
  sync GetChildAt(int32_t index) returns (CrossProcessSHEntry childEntry);
  sync GetChildSHEntryIfHasNoDynamicallyAddedChild(int32_t childOffset) returns (CrossProcessSHEntry childEntry);
108
  sync ReplaceChild(PSHEntry newChildEntry) returns (nsresult result);
109
  async ClearEntry(uint64_t aNewSharedID);
110
  sync CreateLoadInfo() returns (nsDocShellLoadState loadState);
111

112
113
114
  async UpdateLayoutHistoryState(bool scrollPositionOnly,
                                 nsCString[] keys, PresState[] states);

115
116
117
118
119
  sync __delete__();
};

} // namespace dom
} // namespace mozilla