FBTF: Reapplies r55259, the first new IPC definition patch.

ipc/ipc_message_utils.h

 // Copyright (c) 2010 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 IPC_IPC_MESSAGE_UTILS_H_
 #define IPC_IPC_MESSAGE_UTILS_H_
 #pragma once
 
 #include <algorithm>
 #include <string>
 #include <vector>
 #include <map>
 #include <set>
 
 #include "base/file_path.h"
 #include "base/format_macros.h"
 #include "base/nullable_string16.h"
 #include "base/string16.h"
 #include "base/string_number_conversions.h"
 #include "base/string_util.h"
-#include "base/time.h"
+#include "base/utf_string_conversions.h"
 #include "base/tuple.h"
 #include "base/utf_string_conversions.h"
 #include "base/values.h"
 #if defined(OS_POSIX)
 #include "ipc/file_descriptor_set_posix.h"
 #endif
 #include "ipc/ipc_channel_handle.h"
 #include "ipc/ipc_sync_message.h"
 
 // Used by IPC_BEGIN_MESSAGES so that each message class starts from a unique
@@ skipping 26 matching lines @@
   GpuMsgStart,
   GpuHostMsgStart,
   GpuChannelMsgStart,
   ServiceMsgStart,
   ServiceHostMsgStart,
   // NOTE: When you add a new message class, also update
   // IPCStatusView::IPCStatusView to ensure logging works.
   LastMsgIndex
 };
 
+class DictionaryValue;
+class ListValue;
+
+namespace base {
+class Time;
+}
+
 namespace IPC {
 
 //-----------------------------------------------------------------------------
 // An iterator class for reading the fields contained within a Message.
 
 class MessageIterator {
  public:
   explicit MessageIterator(const Message& m) : msg_(m), iter_(NULL) {
   }
   int NextInt() const {
@@ skipping 219 matching lines @@
     return result;
   }
   static void Log(const param_type& p, std::wstring* l) {
     l->append(StringPrintf(L"%lc", p));
   }
 };
 
 template <>
 struct ParamTraits<base::Time> {
   typedef base::Time param_type;
-  static void Write(Message* m, const param_type& p) {
-    ParamTraits<int64>::Write(m, p.ToInternalValue());
-  }
-  static bool Read(const Message* m, void** iter, param_type* r) {
-    int64 value;
-    if (!ParamTraits<int64>::Read(m, iter, &value))
-      return false;
-    *r = base::Time::FromInternalValue(value);
-    return true;
-  }
-  static void Log(const param_type& p, std::wstring* l) {
-    ParamTraits<int64>::Log(p.ToInternalValue(), l);
-  }
+  static void Write(Message* m, const param_type& p);
+  static bool Read(const Message* m, void** iter, param_type* r);
+  static void Log(const param_type& p, std::wstring* l);
 };
 
 #if defined(OS_WIN)
 template <>
 struct ParamTraits<LOGFONT> {
   typedef LOGFONT param_type;
   static void Write(Message* m, const param_type& p) {
     m->WriteData(reinterpret_cast<const char*>(&p), sizeof(LOGFONT));
   }
   static bool Read(const Message* m, void** iter, param_type* r) {
@@ skipping 26 matching lines @@
     bool result = m->ReadData(iter, &data, &data_size);
     if (result && data_size == sizeof(MSG)) {
       memcpy(r, data, sizeof(MSG));
     } else {
       result = false;
       NOTREACHED();
     }
 
     return result;
   }
+  static void Log(const param_type& p, std::wstring* l) {
+    l->append(L"<MSG>");
+  }
 };
 #endif  // defined(OS_WIN)
 
 template <>
 struct ParamTraits<DictionaryValue> {
   typedef DictionaryValue param_type;
   static void Write(Message* m, const param_type& p);
   static bool Read(const Message* m, void** iter, param_type* r);
   static void Log(const param_type& p, std::wstring* l);
 };
@@ skipping 641 matching lines @@
 };
 
 //-----------------------------------------------------------------------------
 // Generic message subclasses
 
 // Used for asynchronous messages.
 template <class ParamType>
 class MessageWithTuple : public Message {
  public:
   typedef ParamType Param;
-  typedef typename ParamType::ParamTuple RefParam;
+  typedef typename TupleTypes<ParamType>::ParamTuple RefParam;
 
-  MessageWithTuple(int32 routing_id, uint32 type, const RefParam& p)
-      : Message(routing_id, type, PRIORITY_NORMAL) {
-    WriteParam(this, p);
-  }
+  // The constructor and the Read() method's templated implementations are in
+  // ipc_message_utils_impl.h. The subclass constructor and Log() methods call
+  // the templated versions of these and make sure there are instantiations in
+  // those translation units.
+  MessageWithTuple(int32 routing_id, uint32 type, const RefParam& p);
 
+  // TODO(erg): Migrate this method into ipc_message_utils_impl.h once I figure
+  // out why just having the template in that file and the forward declaration
+  // here breaks the release build.
   static bool Read(const Message* msg, Param* p) {

[Matt Perry, 2010/08/09 20:56:28]

Interesting, it still compiles with the forward declarations when this method is
defined here?

[Elliot Glaysher, 2010/08/09 21:04:04]

Correct. Since it is a reference type (and we don't dereference it), the
compiler doesn't need to know the size of Param, only that the type exists and
that ReadParam<Param>() exists.

     void* iter = NULL;
     if (ReadParam(msg, &iter, p))
       return true;
     NOTREACHED() << "Error deserializing message " << msg->type();
     return false;
   }
 
   // Generic dispatcher.  Should cover most cases.
   template<class T, class Method>
   static bool Dispatch(const Message* msg, T* obj, Method func) {
@@ skipping 57 matching lines @@
   static bool Dispatch(const Message* msg, T* obj,
                        void (T::*func)(const Message&, TA, TB, TC, TD, TE)) {
     Param p;
     if (Read(msg, &p)) {
       (obj->*func)(*msg, p.a, p.b, p.c, p.d, p.e);
       return true;
     }
     return false;
   }
 
-  static void Log(const Message* msg, std::wstring* l) {
-    Param p;
-    if (Read(msg, &p))
-      LogParam(p, l);
-  }
-
   // Functions used to do manual unpacking.  Only used by the automation code,
   // these should go away once that code uses SyncChannel.
   template<typename TA, typename TB>
   static bool Read(const IPC::Message* msg, TA* a, TB* b) {
     ParamType params;
     if (!Read(msg, &params))
       return false;
     *a = params.a;
     *b = params.b;
     return true;
@@ skipping 52 matching lines @@
 
 // defined in ipc_logging.cc
 void GenerateLogData(const std::string& channel, const Message& message,
                      LogData* data);
 
 // Used for synchronous messages.
 template <class SendParamType, class ReplyParamType>
 class MessageWithReply : public SyncMessage {
  public:
   typedef SendParamType SendParam;
-  typedef typename SendParam::ParamTuple RefSendParam;
+  typedef typename TupleTypes<SendParam>::ParamTuple RefSendParam;
   typedef ReplyParamType ReplyParam;
 
   MessageWithReply(int32 routing_id, uint32 type,
                    const RefSendParam& send, const ReplyParam& reply)
       : SyncMessage(routing_id, type, PRIORITY_NORMAL,
                     new ParamDeserializer<ReplyParam>(reply)) {
     WriteParam(this, send);
   }
 
   static void Log(const Message* msg, std::wstring* l) {
     if (msg->is_sync()) {
       SendParam p;
       void* iter = SyncMessage::GetDataIterator(msg);
       if (ReadParam(msg, &iter, &p))
         LogParam(p, l);
 
 #if defined(IPC_MESSAGE_LOG_ENABLED)
       const std::wstring& output_params = msg->output_params();
       if (!l->empty() && !output_params.empty())
         l->append(L", ");
 
       l->append(output_params);
 #endif
     } else {
       // This is an outgoing reply.  Now that we have the output parameters, we
       // can finally log the message.
-      typename ReplyParam::ValueTuple p;
+      typename TupleTypes<ReplyParam>::ValueTuple p;
       void* iter = SyncMessage::GetDataIterator(msg);
       if (ReadParam(msg, &iter, &p))
         LogParam(p, l);
     }
   }
 
   template<class T, class Method>
   static bool Dispatch(const Message* msg, T* obj, Method func) {
     SendParam send_params;
     void* iter = GetDataIterator(msg);
     Message* reply = GenerateReply(msg);
     bool error;
     if (ReadParam(msg, &iter, &send_params)) {
-      typename ReplyParam::ValueTuple reply_params;
+      typename TupleTypes<ReplyParam>::ValueTuple reply_params;
       DispatchToMethod(obj, func, send_params, &reply_params);
       WriteParam(reply, reply_params);
       error = false;
 #ifdef IPC_MESSAGE_LOG_ENABLED
       if (msg->received_time() != 0) {
         std::wstring output_params;
         LogParam(reply_params, &output_params);
         msg->set_output_params(output_params);
       }
 #endif
@@ skipping 67 matching lines @@
     ReplyParam p(a, b, c, d, e);
     WriteParam(reply, p);
   }
 };
 
 //-----------------------------------------------------------------------------
 
 }  // namespace IPC
 
 #endif  // IPC_IPC_MESSAGE_UTILS_H_