Add spellcheck and word suggestion to the prediction service

third_party/prediction/suggest/core/suggest.h

+/*
+ * Copyright (C) 2012 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_SUGGEST_IMPL_H
+#define LATINIME_SUGGEST_IMPL_H
+
+#include "third_party/prediction/defines.h"
+#include "third_party/prediction/suggest/core/suggest_interface.h"
+#include "third_party/prediction/suggest/core/policy/suggest_policy.h"
+
+namespace latinime {
+
+// Naming convention
+// - Distance: "Weighted" edit distance -- used both for spatial and language.
+// - Compound Distance: Spatial Distance + Language Distance -- used for pruning
+// and scoring
+// - Cost: delta/diff for Distance -- used both for spatial and language
+// - Length: "Non-weighted" -- used only for spatial
+// - Probability: "Non-weighted" -- used only for language
+// - Score: Final calibrated score based on the compound distance, which is sent
+// to java as the
+//       priority of a suggested word
+
+class DicNode;
+class DicTraverseSession;
+class ProximityInfo;
+class Scoring;
+class SuggestionResults;
+class Traversal;
+class Weighting;
+
+class Suggest : public SuggestInterface {
+ public:
+  AK_FORCE_INLINE Suggest(const SuggestPolicy* const suggestPolicy)
+      : TRAVERSAL(suggestPolicy ? suggestPolicy->getTraversal() : nullptr),
+        SCORING(suggestPolicy ? suggestPolicy->getScoring() : nullptr),
+        WEIGHTING(suggestPolicy ? suggestPolicy->getWeighting() : nullptr) {}
+  AK_FORCE_INLINE virtual ~Suggest() {}
+  void getSuggestions(ProximityInfo* pInfo,
+                      void* traverseSession,
+                      int* inputXs,
+                      int* inputYs,
+                      int* times,
+                      int* pointerIds,
+                      int* inputCodePoints,
+                      int inputSize,
+                      const float languageWeight,
+                      SuggestionResults* const outSuggestionResults) const;
+
+ private:
+  DISALLOW_IMPLICIT_CONSTRUCTORS(Suggest);
+  void createNextWordDicNode(DicTraverseSession* traverseSession,
+                             DicNode* dicNode,
+                             const bool spaceSubstitution) const;
+  void initializeSearch(DicTraverseSession* traverseSession) const;
+  void expandCurrentDicNodes(DicTraverseSession* traverseSession) const;
+  void processTerminalDicNode(DicTraverseSession* traverseSession,
+                              DicNode* dicNode) const;
+  void processExpandedDicNode(DicTraverseSession* traverseSession,
+                              DicNode* dicNode) const;
+  void weightChildNode(DicTraverseSession* traverseSession,
+                       DicNode* dicNode) const;
+  void processDicNodeAsOmission(DicTraverseSession* traverseSession,
+                                DicNode* dicNode) const;
+  void processDicNodeAsDigraph(DicTraverseSession* traverseSession,
+                               DicNode* dicNode) const;
+  void processDicNodeAsTransposition(DicTraverseSession* traverseSession,
+                                     DicNode* dicNode) const;
+  void processDicNodeAsInsertion(DicTraverseSession* traverseSession,
+                                 DicNode* dicNode) const;
+  void processDicNodeAsAdditionalProximityChar(
+      DicTraverseSession* traverseSession,
+      DicNode* dicNode,
+      DicNode* childDicNode) const;
+  void processDicNodeAsSubstitution(DicTraverseSession* traverseSession,
+                                    DicNode* dicNode,
+                                    DicNode* childDicNode) const;
+  void processDicNodeAsMatch(DicTraverseSession* traverseSession,
+                             DicNode* childDicNode) const;
+
+  static const int MIN_CONTINUOUS_SUGGESTION_INPUT_SIZE;
+
+  const Traversal* const TRAVERSAL;
+  const Scoring* const SCORING;
+  const Weighting* const WEIGHTING;
+};
+}  // namespace latinime
+#endif  // LATINIME_SUGGEST_IMPL_H