Implement IBusLookupTable.

chromeos/dbus/ibus/ibus_lookup_table.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_LOOKUP_TABLE_H_
+#define CHROMEOS_DBUS_IBUS_IBUS_LOOKUP_TABLE_H_
+
+#include <string>
+#include <vector>
+#include "base/basictypes.h"
+#include "chromeos/chromeos_export.h"
+
+namespace dbus {
+class MessageWriter;
+class MessageReader;
+}  // namespace dbus
+
+namespace chromeos {
+// TODO(nona): Remove ibus namespace after complete libibus removal.
+namespace ibus {
+
+// The IBusLookupTable is one of IBusObjects. IBusLookupTable contains IBusTexts
+// but all of them are used as plain string. The overview of each data
+// strucutres is as follows:
+//
+// DATA STRUCTURE OVERVIEW:
+//  variant  struct {
+//   string "IBusLookupTable"
+//   array [
+//   ]
+//   uint32 9  // Page size
+//   uint32 1  // Cursor position
+//   boolean true  // Cursor visibility.
+//   boolean true  // Round lookup table or not. Not used in Chrome.
+//   int32 1  // Orientation
+//   array [  // Array of candidate text.
+//    variant struct {
+//      string "IBusText"
+//      array []
+//      string "Candidate Text"
+//      variant struct {
+//       string "IBusAttrList"
+//       array []
+//       array []
+//       }
+//     }
+//     ... more IBusTexts
+//   ]
+//   array [  // Array of label text
+//    variant struct {
+//      string "IBusText"
+//      array []
+//      string "1"
+//      variant struct {
+//       string "IBusAttrList"
+//       array []
+//       array []
+//       }
+//     }
+//     ... more IBusTexts
+//   ]
+//  }
+class IBusLookupTable;
+
+// Pops a IBusLookupTable from |reader|.
+// Returns false if an error occures.
+bool CHROMEOS_EXPORT PopIBusLookupTable(dbus::MessageReader* reader,
+                                        IBusLookupTable* table);
+// Appends a IBusLookupTable to |writer|.
+void CHROMEOS_EXPORT AppendIBusLookupTable(const IBusLookupTable& table,
+                                           dbus::MessageWriter* writer);
+
+// An representation of IBusLookupTable object which is used in dbus
+// communication with ibus-daemon.
+class CHROMEOS_EXPORT IBusLookupTable {
+ public:
+  enum Orientation {
+    IBUS_LOOKUP_TABLE_ORIENTATION_HORIZONTAL = 0,
+    IBUS_LOOKUP_TABLE_ORIENTATION_VERTICAL = 1,
+  };
+
+  // Represents a candidate entry. In dbus communication, each
+  // field is represented as IBusText, but attributes are not used in Chrome.
+  // So just simple string is sufficient in this case.
+  struct Entry {
+    std::string value;
+    std::string label;
+  };
+
+  IBusLookupTable();
+  virtual ~IBusLookupTable();
+
+  // Accessors.

[satorux1, 2012/05/21 20:59:35]

Please document the members.

[Seigo Nonaka, 2012/05/21 21:16:47]

Done, wrote in member variable filed.

+  uint32 page_size() const {
+    return page_size_;
+  }
+
+  void set_page_size(uint32 page_size) {
+    page_size_ = page_size;
+  }
+
+  uint32 cursor_position() const {
+    return cursor_position_;
+  }
+
+  void set_cursor_position(uint32 cursor_position) {
+    cursor_position_ = cursor_position;
+  }
+
+  bool is_cursor_visible() const {
+    return is_cursor_visible_;
+  }
+
+  void set_is_cursor_visible(bool is_cursor_visible) {
+    is_cursor_visible_ = is_cursor_visible;
+  }
+
+  Orientation orientation() const {
+    return orientation_;
+  }
+
+  void set_orientation(Orientation orientation) {
+    orientation_ = orientation;
+  }
+
+  const std::vector<Entry>& candidates() const {
+    return candidates_;
+  }
+
+  std::vector<Entry>* mutable_candidates() {
+    return &candidates_;
+  }
+
+ private:
+  // The number of candidate in one page.
+  uint32 page_size_;
+  uint32 cursor_position_;
+  bool is_cursor_visible_;
+  Orientation orientation_;
+  std::vector<Entry> candidates_;
+
+  DISALLOW_COPY_AND_ASSIGN(IBusLookupTable);
+};
+
+}  // namespace ibus
+}  // namespace chromeos
+
+#endif  // CHROMEOS_DBUS_IBUS_IBUS_LOOKUP_TABLE_H_