android_webview/native/state_serializer.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4 //
   5 #ifndef ANDROID_WEBVIEW_NATIVE_STATE_SERIALIZER_H_
   6 #define ANDROID_WEBVIEW_NATIVE_STATE_SERIALIZER_H_
   7
   8 #include "base/compiler_specific.h"
   9
  10 namespace base {
  11
  12 class Pickle;
  13 class PickleIterator;
  14
  15 }  // namespace base
  16
  17 namespace content {
  18
  19 class NavigationEntry;
  20 class WebContents;
  21
  22 }  // namespace content
  23
  24 namespace android_webview {
  25
  26 // Write and restore a WebContents to and from a pickle. Return true on
  27 // success.
  28
  29 // Note that |pickle| may be changed even if function returns false.
  30 bool WriteToPickle(const content::WebContents& web_contents,
  31                    base::Pickle* pickle) WARN_UNUSED_RESULT;
  32
  33 // |web_contents| will not be modified if function returns false.
  34 bool RestoreFromPickle(base::PickleIterator* iterator,
  35                        content::WebContents* web_contents) WARN_UNUSED_RESULT;
  36
  37
  38 namespace internal {
  39
  40 // Functions below are individual helper functiosn called by functions above.
  41 // They are broken up for unit testing, and should not be called out side of
  42 // tests.
  43 bool WriteHeaderToPickle(base::Pickle* pickle) WARN_UNUSED_RESULT;
  44 bool RestoreHeaderFromPickle(base::PickleIterator* iterator) WARN_UNUSED_RESULT;
  45 bool WriteNavigationEntryToPickle(const content::NavigationEntry& entry,
  46                                   base::Pickle* pickle) WARN_UNUSED_RESULT;
  47 bool RestoreNavigationEntryFromPickle(
  48     base::PickleIterator* iterator,
  49     content::NavigationEntry* entry) WARN_UNUSED_RESULT;
  50
  51 }  // namespace interanl
  52
  53 }  // namespace android_webview
  54
  55 #endif  // ANDROID_WEBVIEW_NATIVE_STATE_SERIALIZER_H_