Extends IBusObject.

chromeos/dbus/ibus/ibus_object.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 CHROMEOS_DBUS_IBUS_IBUS_OBJECT_H_
 #define CHROMEOS_DBUS_IBUS_IBUS_OBJECT_H_
 
 #include <string>
 #include "base/basictypes.h"
 #include "base/memory/scoped_ptr.h"
 #include "chromeos/chromeos_export.h"
 
 namespace dbus {
 class MessageReader;
 class MessageWriter;
 }  // dbus
 
 namespace chromeos {
 
 // The data structure of IBusObject is represented as variant in "(sav...)"
 // signatur. The IBusObject is constructed with two sections, header and
 // contents. The header section is represent as "sav" which contains type name
 // and attachement array. The contents section is corresponding to "..." in
 // above signature, which can store arbitary type values including IBusObject.
 //
 // DATA STRUCTURE OVERVIEW:
 //
-// variant  struct {
+// variant  // Handle with top_variant_writer_/top_variant_reader_.
+//   struct {  // Handle with contents_writer_/contents_reader_.
 //     // Header section
 //     string typename  // The type name of object, like "IBusText"
 //     array []  // attachement array.
 //
 //     // Contents section
 //     ...  // The contents area.
 //   }
 //
 // EXAMPLE: IBusText
 //
@@ skipping 45 matching lines @@
   // Reads IBusOBject with |reader| and checks if the type name is valid.
   bool InitWithParentReader(dbus::MessageReader* reader);
 
   // Returns true if the IBusObject is valid.
   bool IsValid() const;
 
   // The following functions delegate dbus::MessageReader's functions.
   bool PopString(std::string* out);
   bool PopUint32(uint32* out);
   bool PopArray(dbus::MessageReader* reader);
+  bool PopBool(bool* out);
+  bool PopInt32(int32* out);
+  bool HasMoreData();
+
+  // Sets up |reader| for reading an IBusObject entry.
   bool PopIBusObject(IBusObjectReader* reader);
-  bool HasMoreData();
+
+  // Returns main reader if the specified IBusObject is valid, otherwise returns
+  // NULL. This reader corresponds to second depth struct field(see above

[satorux1, 2012/05/18 01:23:36]

please add a space before (

[Seigo Nonaka, 2012/05/18 01:41:52]

Done.

+  // description). This function is useful in the case of adding other
+  // IBusObjects.
+  dbus::MessageReader* GetContentsReader();

[satorux1, 2012/05/18 01:23:36]

I'm confused. Why do we need to expose this? Cannot clients just use
PopIBusObject()?

[Seigo Nonaka, 2012/05/18 01:41:52]

If I want to add IBusText into some IBusObject, AppendIBusText takes a pointer
of dbus::MessageWriter.
One solution of this is introduce AppendIBusText into IBusObject. Is it clearer
than this CL's approach?

On 2012/05/18 01:23:36, satorux1 wrote:

[satorux1, 2012/05/18 04:54:46]

Where is the IBusObject class? Is there such a class?

Generally, exposing a member as a mutable pointer is not preferable.

[Seigo Nonaka, 2012/05/18 17:01:47]

Sorry not IBusObject, IBusObjectWriter is correct.

I upload not exposing solution for adding IBusText into IBusObject.

On 2012/05/18 04:54:46, satorux1 wrote:

 
  private:
   enum CheckResult {
     IBUS_OBJECT_VALID,  // Already checked and valid type.
     IBUS_OBJECT_INVALID,  // Already checked but invalid type.
     IBUS_OBJECT_NOT_CHECKED,  // Not checked yet.
   };
 
   std::string type_name_;
   dbus::MessageReader* original_reader_;
@@ skipping 28 matching lines @@
                    const std::string& signature,
                    dbus::MessageWriter* writer);
   virtual ~IBusObjectWriter();
 
   // Appends IBusObject headers with |writer|, should be called once.
   void InitWithParentWriter(dbus::MessageWriter* writer);
 
   // The following functions delegate dbus::MessageReader's functions.
   void AppendString(const std::string& input);
   void AppendUint32(uint32 value);
+  void AppendInt32(int32 value);
+  void AppendBool(bool value);
   void OpenArray(const std::string& signature,
                  dbus::MessageWriter* writer);
   void CloseContainer(dbus::MessageWriter* writer);
 
   // Sets up |writer| for writing new IBusObject entry.
   void AppendIBusObject(IBusObjectWriter* writer);
 
   // Closes all opened containers.
   void CloseAll();
 
   // Returns true if writer is initialized.
   bool IsInitialized() const;
 
+  // Returns main contents writer if it is initialized, otherwise returns NULL.
+  // this writer corresponds to second depth struct(see above description). This
+  // function is useful in the case of appeding other IBusObjects.
+  dbus::MessageWriter* GetContentsWriter();
+
  private:
   friend class TestableIBusObjectWriter;
   // Appends IBusObject headers, should be called once.
   void Init();
 
   std::string type_name_;
   std::string signature_;
   dbus::MessageWriter* original_writer_;
   scoped_ptr<dbus::MessageWriter> top_variant_writer_;
   scoped_ptr<dbus::MessageWriter> contents_writer_;
 
   DISALLOW_COPY_AND_ASSIGN(IBusObjectWriter);
 };
 
 }  // namespace chromeos
 
 #endif  // CHROMEOS_DBUS_IBUS_IBUS_OBJECT_H_