Add spellcheck and word suggestion to the prediction service

third_party/prediction/suggest/policyimpl/dictionary/structure/backward/v402/ver4_patricia_trie_node_writer.h

Index: third_party/prediction/suggest/policyimpl/dictionary/structure/backward/v402/ver4_patricia_trie_node_writer.h
diff --git a/third_party/prediction/suggest/policyimpl/dictionary/structure/backward/v402/ver4_patricia_trie_node_writer.h b/third_party/prediction/suggest/policyimpl/dictionary/structure/backward/v402/ver4_patricia_trie_node_writer.h
new file mode 100644
index 0000000000000000000000000000000000000000..d6b9fbdcdd6404e6537061a2d7337021eb17f6ce
--- /dev/null
+++ b/third_party/prediction/suggest/policyimpl/dictionary/structure/backward/v402/ver4_patricia_trie_node_writer.h
@@ -0,0 +1,170 @@
+/*
+ * Copyright (C) 2013, The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/*
+ * !!!!! DO NOT EDIT THIS FILE !!!!!
+ *
+ * This file was generated from
+ *   third_party/prediction/suggest/policyimpl/dictionary/structure/v4/ver4_patricia_trie_node_writer.h
+ */
+
+#ifndef LATINIME_BACKWARD_V402_VER4_PATRICIA_TRIE_NODE_WRITER_H
+#define LATINIME_BACKWARD_V402_VER4_PATRICIA_TRIE_NODE_WRITER_H
+
+#include "third_party/prediction/defines.h"
+#include "third_party/prediction/suggest/policyimpl/dictionary/structure/pt_common/dynamic_pt_reading_helper.h"
+#include "third_party/prediction/suggest/policyimpl/dictionary/structure/pt_common/pt_node_params.h"
+#include "third_party/prediction/suggest/policyimpl/dictionary/structure/pt_common/pt_node_writer.h"
+#include "third_party/prediction/suggest/policyimpl/dictionary/structure/backward/v402/content/probability_entry.h"
+#include "third_party/prediction/utils/int_array_view.h"
+
+namespace latinime {
+namespace backward {
+namespace v402 {}  // namespace v402
+}  // namespace backward
+class BufferWithExtendableBuffer;
+namespace backward {
+namespace v402 {}  // namespace v402
+}  // namespace backward
+class HeaderPolicy;
+namespace backward {
+namespace v402 {
+class Ver4BigramListPolicy;
+class Ver4DictBuffers;
+class Ver4PatriciaTrieNodeReader;
+class Ver4PtNodeArrayReader;
+class Ver4ShortcutListPolicy;
+
+/*
+ * This class is used for helping to writes nodes of ver4 patricia trie.
+ */
+class Ver4PatriciaTrieNodeWriter : public PtNodeWriter {
+ public:
+  Ver4PatriciaTrieNodeWriter(BufferWithExtendableBuffer* const trieBuffer,
+                             Ver4DictBuffers* const buffers,
+                             const HeaderPolicy* const headerPolicy,
+                             const PtNodeReader* const ptNodeReader,
+                             const PtNodeArrayReader* const ptNodeArrayReader,
+                             Ver4BigramListPolicy* const bigramPolicy,
+                             Ver4ShortcutListPolicy* const shortcutPolicy)
+      : mTrieBuffer(trieBuffer),
+        mBuffers(buffers),
+        mHeaderPolicy(headerPolicy),
+        mPtNodeReader(ptNodeReader),
+        mReadingHelper(ptNodeReader, ptNodeArrayReader),
+        mBigramPolicy(bigramPolicy),
+        mShortcutPolicy(shortcutPolicy) {}
+
+  virtual ~Ver4PatriciaTrieNodeWriter() {}
+
+  virtual bool markPtNodeAsDeleted(
+      const PtNodeParams* const toBeUpdatedPtNodeParams);
+
+  virtual bool markPtNodeAsMoved(
+      const PtNodeParams* const toBeUpdatedPtNodeParams,
+      const int movedPos,
+      const int bigramLinkedNodePos);
+
+  virtual bool markPtNodeAsWillBecomeNonTerminal(
+      const PtNodeParams* const toBeUpdatedPtNodeParams);
+
+  virtual bool updatePtNodeUnigramProperty(
+      const PtNodeParams* const toBeUpdatedPtNodeParams,
+      const UnigramProperty* const unigramProperty);
+
+  virtual bool updatePtNodeProbabilityAndGetNeedsToKeepPtNodeAfterGC(
+      const PtNodeParams* const toBeUpdatedPtNodeParams,
+      bool* const outNeedsToKeepPtNode);
+
+  virtual bool updateChildrenPosition(
+      const PtNodeParams* const toBeUpdatedPtNodeParams,
+      const int newChildrenPosition);
+
+  bool updateTerminalId(const PtNodeParams* const toBeUpdatedPtNodeParams,
+                        const int newTerminalId);
+
+  virtual bool writePtNodeAndAdvancePosition(
+      const PtNodeParams* const ptNodeParams,
+      int* const ptNodeWritingPos);
+
+  virtual bool writeNewTerminalPtNodeAndAdvancePosition(
+      const PtNodeParams* const ptNodeParams,
+      const UnigramProperty* const unigramProperty,
+      int* const ptNodeWritingPos);
+
+  virtual bool addNgramEntry(const WordIdArrayView prevWordIds,
+                             const int wordId,
+                             const BigramProperty* const bigramProperty,
+                             bool* const outAddedNewEntry);
+
+  virtual bool removeNgramEntry(const WordIdArrayView prevWordIds,
+                                const int wordId);
+
+  virtual bool updateAllBigramEntriesAndDeleteUselessEntries(
+      const PtNodeParams* const sourcePtNodeParams,
+      int* const outBigramEntryCount);
+
+  virtual bool updateAllPositionFields(
+      const PtNodeParams* const toBeUpdatedPtNodeParams,
+      const DictPositionRelocationMap* const dictPositionRelocationMap,
+      int* const outBigramEntryCount);
+
+  virtual bool addShortcutTarget(const PtNodeParams* const ptNodeParams,
+                                 const int* const targetCodePoints,
+                                 const int targetCodePointCount,
+                                 const int shortcutProbability);
+
+  bool updatePtNodeHasBigramsAndShortcutTargetsFlags(
+      const PtNodeParams* const ptNodeParams);
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(Ver4PatriciaTrieNodeWriter);
+
+  bool writePtNodeAndGetTerminalIdAndAdvancePosition(
+      const PtNodeParams* const ptNodeParams,
+      int* const outTerminalId,
+      int* const ptNodeWritingPos);
+
+  // Create updated probability entry using given unigram property. In addition
+  // to the
+  // probability, this method updates historical information if needed.
+  // TODO: Update flags belonging to the unigram property.
+  const ProbabilityEntry createUpdatedEntryFrom(
+      const ProbabilityEntry* const originalProbabilityEntry,
+      const UnigramProperty* const unigramProperty) const;
+
+  bool updatePtNodeFlags(const int ptNodePos,
+                         const bool isBlacklisted,
+                         const bool isNotAWord,
+                         const bool isTerminal,
+                         const bool hasShortcutTargets,
+                         const bool hasBigrams,
+                         const bool hasMultipleChars);
+
+  static const int CHILDREN_POSITION_FIELD_SIZE;
+
+  BufferWithExtendableBuffer* const mTrieBuffer;
+  Ver4DictBuffers* const mBuffers;
+  const HeaderPolicy* const mHeaderPolicy;
+  const PtNodeReader* const mPtNodeReader;
+  DynamicPtReadingHelper mReadingHelper;
+  Ver4BigramListPolicy* const mBigramPolicy;
+  Ver4ShortcutListPolicy* const mShortcutPolicy;
+};
+}  // namespace v402
+}  // namespace backward
+}  // namespace latinime
+#endif /* LATINIME_BACKWARD_V402_VER4_PATRICIA_TRIE_NODE_WRITER_H */