Introduce content::PageState

content/public/common/page_state.h

Index: content/public/common/page_state.h
diff --git a/content/public/common/page_state.h b/content/public/common/page_state.h
new file mode 100644
index 0000000000000000000000000000000000000000..b4484b7a33ec8df811b3e5459284e7a4a8c96eb9
--- /dev/null
+++ b/content/public/common/page_state.h
@@ -0,0 +1,66 @@
+// Copyright (c) 2013 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef CONTENT_PUBLIC_COMMON_PAGE_STATE_H_
+#define CONTENT_PUBLIC_COMMON_PAGE_STATE_H_
+
+#include <string>
+#include <vector>
+
+#include "content/common/content_export.h"
+
+class GURL;
+
+namespace base {
+class FilePath;
+}
+
+namespace content {
+
+// The PageState class represents the information needed by the rendering
+// engine to reconstruct a web page (and its tree of frames), including for
+// example the URLs of the documents and the values of any form fields.  This
+// information is used when navigating back & forward through session history.
+//
+// The browser process only sees the encoded form of the data, which is
+// designed as an archival format.  The renderer process can decode the data

[Tom Sepez, 2013/05/24 17:46:49]

Is this true if the browser is going to crack this open and bless
ReferencedFiles?

+// using methods found in public/renderer/history_item_serialization.h.
+class CONTENT_EXPORT PageState {
+ public:
+  static PageState CreateFromEncodedData(const std::string& data);
+  static PageState CreateFromURL(const GURL& url);
+
+  static PageState CreateForTesting(
+      const GURL& url,
+      bool body_contains_password_data,
+      const char* optional_body_data,
+      const base::FilePath* optional_body_file_path);
+
+  PageState();
+
+  bool IsValid() const;
+  bool Equals(const PageState& page_state) const;

[brettw, 2013/05/23 23:38:39]

I guess I don't feel that strongly, but since we're supporting operator== on
this anyway, I'd just remove this function and make == and != class members

+  const std::string& ToEncodedData() const;
+
+  std::vector<base::FilePath> GetReferencedFiles() const;
+  PageState RemovePasswordData() const;
+  PageState RemoveScrollOffset() const;
+
+ private:
+  PageState(const std::string& data);
+
+  std::string data_;

[Tom Sepez, 2013/05/24 17:46:49]

I had imagined that in addition to the string, there would be a vector of file
paths here, and that the constructor(s) would take a string (for everything
else) + file path vector.  The then browser wouldn't hate to deal with the
opaque string at all, but would have access to the file paths.
That makes it harder to perserve state for session restore, since the the
browser now needs to wrap the opaque string + file vector in a format for
serialization (a double wrapping as it were). Is it worth it from a layering
perspective to keep the opaque parts opaque?

+};
+
+// Support DCHECK_EQ(a, b), etc.
+inline bool operator==(const PageState& a, const PageState& b) {
+  return a.Equals(b);
+}
+inline bool operator!=(const PageState& a, const PageState& b) {
+  return !(a == b);
+}
+
+}  // namespace content
+
+#endif  // CONTENT_PUBLIC_COMMON_PAGE_STATE_H_