Add spellcheck and word suggestion to the prediction service

third_party/prediction/suggest/policyimpl/dictionary/structure/pt_common/pt_node_writer.h

Index: third_party/prediction/suggest/policyimpl/dictionary/structure/pt_common/pt_node_writer.h
diff --git a/third_party/prediction/suggest/policyimpl/dictionary/structure/pt_common/pt_node_writer.h b/third_party/prediction/suggest/policyimpl/dictionary/structure/pt_common/pt_node_writer.h
new file mode 100644
index 0000000000000000000000000000000000000000..151335a31646fb6d1526d6bb3d0371b4bd1612fb
--- /dev/null
+++ b/third_party/prediction/suggest/policyimpl/dictionary/structure/pt_common/pt_node_writer.h
@@ -0,0 +1,111 @@
+/*
+ * 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.
+ */
+
+#ifndef LATINIME_PT_NODE_WRITER_H
+#define LATINIME_PT_NODE_WRITER_H
+
+#include <unordered_map>
+
+#include "third_party/prediction/defines.h"
+#include "third_party/prediction/suggest/policyimpl/dictionary/structure/pt_common/pt_node_params.h"
+#include "third_party/prediction/utils/int_array_view.h"
+
+namespace latinime {
+
+class BigramProperty;
+class UnigramProperty;
+
+// Interface class used to write PtNode information.
+class PtNodeWriter {
+ public:
+  typedef std::unordered_map<int, int> PtNodeArrayPositionRelocationMap;
+  typedef std::unordered_map<int, int> PtNodePositionRelocationMap;
+  struct DictPositionRelocationMap {
+   public:
+    DictPositionRelocationMap()
+        : mPtNodeArrayPositionRelocationMap(), mPtNodePositionRelocationMap() {}
+
+    PtNodeArrayPositionRelocationMap mPtNodeArrayPositionRelocationMap;
+    PtNodePositionRelocationMap mPtNodePositionRelocationMap;
+
+   private:
+    DISALLOW_COPY_AND_ASSIGN(DictPositionRelocationMap);
+  };
+
+  virtual ~PtNodeWriter() {}
+
+  virtual bool markPtNodeAsDeleted(
+      const PtNodeParams* const toBeUpdatedPtNodeParams) = 0;
+
+  virtual bool markPtNodeAsMoved(
+      const PtNodeParams* const toBeUpdatedPtNodeParams,
+      const int movedPos,
+      const int bigramLinkedNodePos) = 0;
+
+  virtual bool markPtNodeAsWillBecomeNonTerminal(
+      const PtNodeParams* const toBeUpdatedPtNodeParams) = 0;
+
+  virtual bool updatePtNodeUnigramProperty(
+      const PtNodeParams* const toBeUpdatedPtNodeParams,
+      const UnigramProperty* const unigramProperty) = 0;
+
+  virtual bool updatePtNodeProbabilityAndGetNeedsToKeepPtNodeAfterGC(
+      const PtNodeParams* const toBeUpdatedPtNodeParams,
+      bool* const outNeedsToKeepPtNode) = 0;
+
+  virtual bool updateChildrenPosition(
+      const PtNodeParams* const toBeUpdatedPtNodeParams,
+      const int newChildrenPosition) = 0;
+
+  virtual bool writePtNodeAndAdvancePosition(
+      const PtNodeParams* const ptNodeParams,
+      int* const ptNodeWritingPos) = 0;
+
+  virtual bool writeNewTerminalPtNodeAndAdvancePosition(
+      const PtNodeParams* const ptNodeParams,
+      const UnigramProperty* const unigramProperty,
+      int* const ptNodeWritingPos) = 0;
+
+  virtual bool addNgramEntry(const WordIdArrayView prevWordIds,
+                             const int wordId,
+                             const BigramProperty* const bigramProperty,
+                             bool* const outAddedNewEntry) = 0;
+
+  virtual bool removeNgramEntry(const WordIdArrayView prevWordIds,
+                                const int wordId) = 0;
+
+  virtual bool updateAllBigramEntriesAndDeleteUselessEntries(
+      const PtNodeParams* const sourcePtNodeParams,
+      int* const outBigramEntryCount) = 0;
+
+  virtual bool updateAllPositionFields(
+      const PtNodeParams* const toBeUpdatedPtNodeParams,
+      const DictPositionRelocationMap* const dictPositionRelocationMap,
+      int* const outBigramEntryCount) = 0;
+
+  virtual bool addShortcutTarget(const PtNodeParams* const ptNodeParams,
+                                 const int* const targetCodePoints,
+                                 const int targetCodePointCount,
+                                 const int shortcutProbability) = 0;
+
+ protected:
+  PtNodeWriter(){};
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(PtNodeWriter);
+};
+}  // namespace latinime
+#endif /* LATINIME_PT_NODE_WRITER_H */