TsfTextStore implementation.

ui/base/win/tsf_text_store.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 UI_BASE_WIN_TSF_TEXT_STORE_H_
 #define UI_BASE_WIN_TSF_TEXT_STORE_H_
 
 #include <msctf.h>
+#include <deque>
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
+#include "base/string16.h"
 #include "base/win/scoped_comptr.h"
+#include "ui/base/ime/composition_underline.h"
+#include "ui/base/range/range.h"
+#include "ui/base/ui_export.h"
 
 namespace ui {
+class TextInputClient;
 
 // TsfTextStore is used to interact with the system input method via TSF.

[cpu_(ooo_6.6-7.5), 2012/08/23 18:37:47]

can you please put an extended comment about what this class does and which is
the general flow of members called?

Also some basic explanation about the locking scheme that you implement would be
helpful.

[horo, 2012/08/24 11:42:23]

Done.

-class TsfTextStore : public ITextStoreACP,
-                     public ITfContextOwnerCompositionSink,
-                     public ITfTextEditSink {
+class UI_EXPORT TsfTextStore : public ITextStoreACP,
+                               public ITfContextOwnerCompositionSink,
+                               public ITfTextEditSink {
  public:
   TsfTextStore();
-  ~TsfTextStore();
+  virtual ~TsfTextStore();
 
   virtual ULONG STDMETHODCALLTYPE AddRef() OVERRIDE;
   virtual ULONG STDMETHODCALLTYPE Release() OVERRIDE;
 
   // Subclasses should extend this to return any interfaces they provide.
   virtual STDMETHODIMP QueryInterface(REFIID iid, void** ppv) OVERRIDE;
 
   // ITextStoreACP overrides.
   virtual STDMETHODIMP AdviseSink(REFIID iid, IUnknown* unknown,
                                   DWORD mask) OVERRIDE;
@@ skipping 104 matching lines @@
   virtual STDMETHODIMP OnUpdateComposition(ITfCompositionView* composition_view,
                                            ITfRange* range) OVERRIDE;
   virtual STDMETHODIMP OnEndComposition(
       ITfCompositionView* composition_view) OVERRIDE;
 
   // ITfTextEditSink overrides.
   virtual STDMETHODIMP OnEndEdit(ITfContext* context,
                                  TfEditCookie read_only_edit_cookie,
                                  ITfEditRecord* edit_record) OVERRIDE;
 
+  // Sets currently focused TextInputClient.
+  void SetFocusedTextInputClient(HWND focused_window,
+                                 TextInputClient* text_input_client);
+  // Removes currently focused TextInputClient.
+  void RemoveFocusedTextInputClient(TextInputClient* text_input_client);
+
+  // Sends OnLayoutChange() via |text_store_acp_sink_|.
+  void SendOnLayoutChange();
+
  private:
+  friend class TsfTextStoreTest;
+  friend class TsfTextStoreTestCallback;
+
+  // Checks if the document has a read-only lock.
+  bool HasReadLock() const;
+
+  // Checks if the document has a read and write lock.
+  bool HasReadWriteLock() const;
+
+  // Gets the display attribute structure.
+  bool GetDisplayAttribute(TfGuidAtom guid_atom,
+                           TF_DISPLAYATTRIBUTE* attribute);
+
+  // Gets the committed string size and underline information of the context.
+  bool GetCompositionStatus(ITfContext* context,
+                            const TfEditCookie read_only_edit_cookie,
+                            size_t* committed_size,
+                            CompositionUnderlines* undelines);
+
   // The refrence count of this instance.
   volatile LONG ref_count_;
 
   // A pointer of ITextStoreACPSink, this instance is given in AdviseSink.
   base::win::ScopedComPtr<ITextStoreACPSink> text_store_acp_sink_;
 
   // The current mask of |text_store_acp_sink_|.
   DWORD text_store_acp_sink_mask_;
 
+  // HWND of the current view window which is set in SetFocusedTextInputClient.
+  HWND window_handle_;
+
+  // Current TextInputClient which is set in SetFocusedTextInputClient.
+  TextInputClient* text_input_client_;
+
+  //  |string_buffer_| contains committed string and composition string.
+  //  example: "aoi" is committed, and "umi" is under composition.

[cpu_(ooo_6.6-7.5), 2012/08/23 18:37:47]

Example:

[horo, 2012/08/24 11:42:23]

Done.

+  //    |string_buffer_|: "aoiumi"
+  //    |committed_size_|: 3
+  string16 string_buffer_;
+  size_t committed_size_;
+
+  //  |selection_start_| and |selection_end_| indicates the selection range.
+  //  example: "iue" is selected

[cpu_(ooo_6.6-7.5), 2012/08/23 18:37:47]

Example:

[horo, 2012/08/24 11:42:23]

Done.

+  //    |string_buffer_|: "aiueo"
+  //    |selection_.start()|: 1
+  //    |selection_.end()|: 4
+  Range selection_;
+
+  //  |start_offset| and |end_offset| of |composition_undelines_| indicates
+  //  the offsets in |string_buffer_|.
+  //  example: "aoi" is committed. There are two underlines in "umi" and "no".
+  //    |string_buffer_|: "aoiumino"
+  //    |committed_size_|: 3
+  //    composition_undelines_.underlines[0].start_offset: 3
+  //    composition_undelines_.underlines[0].end_offset: 6
+  //    composition_undelines_.underlines[1].start_offset: 6
+  //    composition_undelines_.underlines[1].end_offset: 8
+  CompositionUnderlines composition_undelines_;
+
+  // |edit_flag_| indicates that the status is edited during
+  // ITextStoreACPSink::OnLockGranted().
+  bool edit_flag_;
+
+  // The type of current lock.
+  //   0: No lock.
+  //   TS_LF_READ: read-only lock.
+  //   TS_LF_READWRITE: read/write lock.
+  DWORD current_lock_type_;
+
+  // Queue of the lock request used in RequestLock().
+  std::deque<DWORD> lock_queue_;
+
+  // Category manager and Display attribute manager are used to obtain the
+  // attributes of the composition string.
+  base::win::ScopedComPtr<ITfCategoryMgr> category_manager_;
+  base::win::ScopedComPtr<ITfDisplayAttributeMgr> display_attribute_manager_;
+
   DISALLOW_COPY_AND_ASSIGN(TsfTextStore);
 };
 
 }  // namespace ui
 
-#endif  // UI_BASE_WIN_TSF_TEXT_STORE_H_
+#endif  // UI_BASE_WIN_TSF_TEXT_STORE_H_