content/common/content_param_traits.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 // This file is used to define IPC::ParamTraits<> specializations for a number
   6 // of types so that they can be serialized over IPC.  IPC::ParamTraits<>
   7 // specializations for basic types (like int and std::string) and types in the
   8 // 'base' project can be found in ipc/ipc_message_utils.h.  This file contains
   9 // specializations for types that are used by the content code, and which need
  10 // manual serialization code.  This is usually because they're not structs with
  11 // public members, or because the same type is being used in multiple
  12 // *_messages.h headers.
  13
  14 #ifndef CONTENT_COMMON_CONTENT_PARAM_TRAITS_H_
  15 #define CONTENT_COMMON_CONTENT_PARAM_TRAITS_H_
  16
  17 #include "content/common/content_param_traits_macros.h"
  18 #include "third_party/WebKit/public/web/WebInputEvent.h"
  19 #include "webkit/common/cursors/webcursor.h"
  20
  21 namespace net {
  22 class IPEndPoint;
  23 }
  24
  25 namespace ui {
  26 class Range;
  27 }
  28
  29 namespace IPC {
  30
  31 template <>
  32 struct ParamTraits<net::IPEndPoint> {
  33   typedef net::IPEndPoint param_type;
  34   static void Write(Message* m, const param_type& p);
  35   static bool Read(const Message* m, PickleIterator* iter, param_type* p);
  36   static void Log(const param_type& p, std::string* l);
  37 };
  38
  39 template <>
  40 struct ParamTraits<ui::Range> {
  41   typedef ui::Range param_type;
  42   static void Write(Message* m, const param_type& p);
  43   static bool Read(const Message* m, PickleIterator* iter, param_type* r);
  44   static void Log(const param_type& p, std::string* l);
  45 };
  46
  47 template <>
  48 struct ParamTraits<WebCursor> {
  49   typedef WebCursor param_type;
  50   static void Write(Message* m, const param_type& p) {
  51     p.Serialize(m);
  52   }
  53   static bool Read(const Message* m, PickleIterator* iter, param_type* r)  {
  54     return r->Deserialize(iter);
  55   }
  56   static void Log(const param_type& p, std::string* l) {
  57     l->append("<WebCursor>");
  58   }
  59 };
  60
  61 typedef const WebKit::WebInputEvent* WebInputEventPointer;
  62 template <>
  63 struct ParamTraits<WebInputEventPointer> {
  64   typedef WebInputEventPointer param_type;
  65   static void Write(Message* m, const param_type& p);
  66   // Note: upon read, the event has the lifetime of the message.
  67   static bool Read(const Message* m, PickleIterator* iter, param_type* r);
  68   static void Log(const param_type& p, std::string* l);
  69 };
  70
  71 }  // namespace IPC
  72
  73 #endif  // CONTENT_COMMON_CONTENT_PARAM_TRAITS_H_