summaryrefslogtreecommitdiffstats
path: root/docshell/base/SerializedLoadContext.h
diff options
context:
space:
mode:
Diffstat (limited to 'docshell/base/SerializedLoadContext.h')
-rw-r--r--docshell/base/SerializedLoadContext.h97
1 files changed, 97 insertions, 0 deletions
diff --git a/docshell/base/SerializedLoadContext.h b/docshell/base/SerializedLoadContext.h
new file mode 100644
index 0000000000..689934f714
--- /dev/null
+++ b/docshell/base/SerializedLoadContext.h
@@ -0,0 +1,97 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
+/* 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/. */
+
+#ifndef SerializedLoadContext_h
+#define SerializedLoadContext_h
+
+#include "base/basictypes.h"
+#include "ipc/IPCMessageUtils.h"
+#include "ipc/IPCMessageUtilsSpecializations.h"
+#include "mozilla/BasePrincipal.h"
+
+class nsILoadContext;
+
+/*
+ * This file contains the IPC::SerializedLoadContext class, which is used to
+ * copy data across IPDL from Child process contexts so it is available in the
+ * Parent.
+ */
+
+class nsIChannel;
+class nsIWebSocketChannel;
+
+namespace IPC {
+
+class SerializedLoadContext {
+ public:
+ SerializedLoadContext()
+ : mIsNotNull(false),
+ mIsPrivateBitValid(false),
+ mIsContent(false),
+ mUseRemoteTabs(false),
+ mUseRemoteSubframes(false),
+ mUseTrackingProtection(false) {
+ Init(nullptr);
+ }
+
+ explicit SerializedLoadContext(nsILoadContext* aLoadContext);
+ explicit SerializedLoadContext(nsIChannel* aChannel);
+ explicit SerializedLoadContext(nsIWebSocketChannel* aChannel);
+
+ void Init(nsILoadContext* aLoadContext);
+
+ bool IsNotNull() const { return mIsNotNull; }
+ bool IsPrivateBitValid() const { return mIsPrivateBitValid; }
+
+ // used to indicate if child-side LoadContext * was null.
+ bool mIsNotNull;
+ // used to indicate if child-side mUsePrivateBrowsing flag is valid, even if
+ // mIsNotNull is false, i.e., child LoadContext was null.
+ bool mIsPrivateBitValid;
+ bool mIsContent;
+ bool mUseRemoteTabs;
+ bool mUseRemoteSubframes;
+ bool mUseTrackingProtection;
+ mozilla::OriginAttributes mOriginAttributes;
+};
+
+// Function to serialize over IPDL
+template <>
+struct ParamTraits<SerializedLoadContext> {
+ typedef SerializedLoadContext paramType;
+
+ static void Write(Message* aMsg, const paramType& aParam) {
+ nsAutoCString suffix;
+ aParam.mOriginAttributes.CreateSuffix(suffix);
+
+ WriteParam(aMsg, aParam.mIsNotNull);
+ WriteParam(aMsg, aParam.mIsContent);
+ WriteParam(aMsg, aParam.mIsPrivateBitValid);
+ WriteParam(aMsg, aParam.mUseRemoteTabs);
+ WriteParam(aMsg, aParam.mUseRemoteSubframes);
+ WriteParam(aMsg, aParam.mUseTrackingProtection);
+ WriteParam(aMsg, suffix);
+ }
+
+ static bool Read(const Message* aMsg, PickleIterator* aIter,
+ paramType* aResult) {
+ nsAutoCString suffix;
+ if (!ReadParam(aMsg, aIter, &aResult->mIsNotNull) ||
+ !ReadParam(aMsg, aIter, &aResult->mIsContent) ||
+ !ReadParam(aMsg, aIter, &aResult->mIsPrivateBitValid) ||
+ !ReadParam(aMsg, aIter, &aResult->mUseRemoteTabs) ||
+ !ReadParam(aMsg, aIter, &aResult->mUseRemoteSubframes) ||
+ !ReadParam(aMsg, aIter, &aResult->mUseTrackingProtection) ||
+ !ReadParam(aMsg, aIter, &suffix)) {
+ return false;
+ }
+ return aResult->mOriginAttributes.PopulateFromSuffix(suffix);
+ }
+};
+
+} // namespace IPC
+
+#endif // SerializedLoadContext_h