Add spellcheck and word suggestion to the prediction service

third_party/prediction/suggest/core/policy/dictionary_structure_with_buffer_policy.h

Index: third_party/prediction/suggest/core/policy/dictionary_structure_with_buffer_policy.h
diff --git a/third_party/prediction/suggest/core/policy/dictionary_structure_with_buffer_policy.h b/third_party/prediction/suggest/core/policy/dictionary_structure_with_buffer_policy.h
new file mode 100644
index 0000000000000000000000000000000000000000..2d3c31a133365f19e103c434166282cea239eb4a
--- /dev/null
+++ b/third_party/prediction/suggest/core/policy/dictionary_structure_with_buffer_policy.h
@@ -0,0 +1,136 @@
+/*
+ * 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_DICTIONARY_STRUCTURE_POLICY_H
+#define LATINIME_DICTIONARY_STRUCTURE_POLICY_H
+
+#include <memory>
+
+#include "third_party/prediction/defines.h"
+#include "third_party/prediction/suggest/core/dictionary/property/word_property.h"
+
+namespace latinime {
+
+class DicNode;
+class DicNodeVector;
+class DictionaryHeaderStructurePolicy;
+class DictionaryShortcutsStructurePolicy;
+class NgramListener;
+class PrevWordsInfo;
+class UnigramProperty;
+
+/*
+ * This class abstracts the structure of dictionaries.
+ * Implement this policy to support additional dictionaries.
+ */
+class DictionaryStructureWithBufferPolicy {
+ public:
+  typedef std::unique_ptr<DictionaryStructureWithBufferPolicy>
+      StructurePolicyPtr;
+
+  virtual ~DictionaryStructureWithBufferPolicy() {}
+
+  virtual int getRootPosition() const = 0;
+
+  virtual void createAndGetAllChildDicNodes(
+      const DicNode* const dicNode,
+      DicNodeVector* const childDicNodes) const = 0;
+
+  virtual int getCodePointsAndProbabilityAndReturnCodePointCount(
+      const int nodePos,
+      const int maxCodePointCount,
+      int* const outCodePoints,
+      int* const outUnigramProbability) const = 0;
+
+  virtual int getTerminalPtNodePositionOfWord(
+      const int* const inWord,
+      const int length,
+      const bool forceLowerCaseSearch) const = 0;
+
+  virtual int getProbability(const int unigramProbability,
+                             const int bigramProbability) const = 0;
+
+  virtual int getProbabilityOfPtNode(const int* const prevWordsPtNodePos,
+                                     const int nodePos) const = 0;
+
+  virtual void iterateNgramEntries(const int* const prevWordsPtNodePos,
+                                   NgramListener* const listener) const = 0;
+
+  virtual int getShortcutPositionOfPtNode(const int nodePos) const = 0;
+
+  virtual const DictionaryHeaderStructurePolicy* getHeaderStructurePolicy()
+      const = 0;
+
+  virtual const DictionaryShortcutsStructurePolicy*
+  getShortcutsStructurePolicy() const = 0;
+
+  // Returns whether the update was success or not.
+  virtual bool addUnigramEntry(
+      const int* const word,
+      const int length,
+      const UnigramProperty* const unigramProperty) = 0;
+
+  // Returns whether the update was success or not.
+  virtual bool removeUnigramEntry(const int* const word, const int length) = 0;
+
+  // Returns whether the update was success or not.
+  virtual bool addNgramEntry(const PrevWordsInfo* const prevWordsInfo,
+                             const BigramProperty* const bigramProperty) = 0;
+
+  // Returns whether the update was success or not.
+  virtual bool removeNgramEntry(const PrevWordsInfo* const prevWordsInfo,
+                                const int* const word,
+                                const int length) = 0;
+
+  // Returns whether the flush was success or not.
+  virtual bool flush(const char* const filePath) = 0;
+
+  // Returns whether the GC and flush were success or not.
+  virtual bool flushWithGC(const char* const filePath) = 0;
+
+  virtual bool needsToRunGC(const bool mindsBlockByGC) const = 0;
+
+  // Currently, this method is used only for testing. You may want to consider
+  // creating new
+  // dedicated method instead of this if you want to use this in the production.
+  virtual void getProperty(const char* const query,
+                           const int queryLength,
+                           char* const outResult,
+                           const int maxResultLength) = 0;
+
+  // Used for testing.
+  virtual const WordProperty getWordProperty(
+      const int* const codePonts,
+      const int codePointCount) const = 0;
+
+  // Method to iterate all words in the dictionary.
+  // The returned token has to be used to get the next word. If token is 0, this
+  // method newly
+  // starts iterating the dictionary.
+  virtual int getNextWordAndNextToken(const int token,
+                                      int* const outCodePoints,
+                                      int* const outCodePointCount) = 0;
+
+  virtual bool isCorrupted() const = 0;
+
+ protected:
+  DictionaryStructureWithBufferPolicy() {}
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(DictionaryStructureWithBufferPolicy);
+};
+}  // namespace latinime
+#endif /* LATINIME_DICTIONARY_STRUCTURE_POLICY_H */