Android WebView save/restoreState and backForardList Part 1

android_webview/native/state_serializer.h

+// Copyright (c) 2012 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 ANDROID_WEBVIEW_NATIVE_STATE_SERIALIZER_H_
+#define ANDROID_WEBVIEW_NATIVE_STATE_SERIALIZER_H_
+
+#include "base/compiler_specific.h"
+
+class Pickle;
+class PickleIterator;
+
+namespace content {
+
+class NavigationEntry;
+class WebContents;
+
+}  // namespace content
+
+namespace android_webview {
+
+// Write and restore a WebContents to and from a pickle. Return true on
+// success. Note that no promise is made that the output variable is not

[joth, 2012/11/20 23:06:48]

nit: Functions to write and restore...

(i read this as comment for the function only, then wondered why you're
repeating yourself about output)


nit: output variable => output parameter.

[boliu, 2012/11/20 23:21:12]

This is not true anymore since NavigationController::Restore as written cannot
fail, so if RestoreFromPickle returns false, then web_contents is indeed not
modified. Removed this comment.

+// changed if false is returned.
+
+// Note that |pickle| may be changed even if function returns false.
+bool WriteToPickle(const content::WebContents& web_contents,
+                   Pickle* pickle) WARN_UNUSED_RESULT;
+
+// |web_contents| will not be modified if function returns false.
+bool RestoreFromPickle(PickleIterator* iterator,
+                       content::WebContents* web_contents) WARN_UNUSED_RESULT;
+
+
+namespace internal {
+// Functions below are individual helper functiosn called by functions above.
+// They are broken up for unit testing, and should not be called out side of
+// tests.
+bool WriteHeaderToPickle(Pickle* pickle) WARN_UNUSED_RESULT;
+bool RestoreHeaderFromPickle(PickleIterator* iterator) WARN_UNUSED_RESULT;
+bool WriteNavigationEntryToPickle(const content::NavigationEntry& entry,
+                                  Pickle* pickle) WARN_UNUSED_RESULT;
+bool RestoreNavigationEntryFromPickle(
+    PickleIterator* iterator,
+    content::NavigationEntry* entry) WARN_UNUSED_RESULT;
+
+}  // namespace interanl
+
+}  // namespace android_webview
+
+#endif  // ANDROID_WEBVIEW_NATIVE_STATE_SERIALIZER_H_