Add spellcheck and word suggestion to the prediction service

third_party/prediction/suggest/policyimpl/dictionary/structure/v4/ver4_dict_buffers.h

+/*
+ * 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_VER4_DICT_BUFFER_H
+#define LATINIME_VER4_DICT_BUFFER_H
+
+#include <cstdio>
+#include <memory>
+
+#include "third_party/prediction/defines.h"
+#include "third_party/prediction/suggest/policyimpl/dictionary/header/header_policy.h"
+#include "third_party/prediction/suggest/policyimpl/dictionary/structure/v4/content/bigram_dict_content.h"
+#include "third_party/prediction/suggest/policyimpl/dictionary/structure/v4/content/language_model_dict_content.h"
+#include "third_party/prediction/suggest/policyimpl/dictionary/structure/v4/content/shortcut_dict_content.h"
+#include "third_party/prediction/suggest/policyimpl/dictionary/structure/v4/content/terminal_position_lookup_table.h"
+#include "third_party/prediction/suggest/policyimpl/dictionary/structure/v4/ver4_dict_constants.h"
+#include "third_party/prediction/suggest/policyimpl/dictionary/utils/buffer_with_extendable_buffer.h"
+#include "third_party/prediction/suggest/policyimpl/dictionary/utils/mmapped_buffer.h"
+
+namespace latinime {
+
+class Ver4DictBuffers {
+ public:
+  typedef std::unique_ptr<Ver4DictBuffers> Ver4DictBuffersPtr;
+
+  static Ver4DictBuffersPtr openVer4DictBuffers(
+      const char* const dictDirPath,
+      MmappedBuffer::MmappedBufferPtr&& headerBuffer,
+      const FormatUtils::FORMAT_VERSION formatVersion);
+
+  static AK_FORCE_INLINE Ver4DictBuffersPtr
+  createVer4DictBuffers(const HeaderPolicy* const headerPolicy,
+                        const int maxTrieSize) {
+    return Ver4DictBuffersPtr(new Ver4DictBuffers(headerPolicy, maxTrieSize));
+  }
+
+  AK_FORCE_INLINE bool isValid() const {
+    return mHeaderBuffer && mDictBuffer && mHeaderPolicy.isValid();
+  }
+
+  AK_FORCE_INLINE bool isNearSizeLimit() const {
+    return mExpandableTrieBuffer.isNearSizeLimit() ||
+           mTerminalPositionLookupTable.isNearSizeLimit() ||
+           mLanguageModelDictContent.isNearSizeLimit() ||
+           mBigramDictContent.isNearSizeLimit() ||
+           mShortcutDictContent.isNearSizeLimit();
+  }
+
+  AK_FORCE_INLINE const HeaderPolicy* getHeaderPolicy() const {
+    return &mHeaderPolicy;
+  }
+
+  AK_FORCE_INLINE BufferWithExtendableBuffer* getWritableHeaderBuffer() {
+    return &mExpandableHeaderBuffer;
+  }
+
+  AK_FORCE_INLINE BufferWithExtendableBuffer* getWritableTrieBuffer() {
+    return &mExpandableTrieBuffer;
+  }
+
+  AK_FORCE_INLINE const BufferWithExtendableBuffer* getTrieBuffer() const {
+    return &mExpandableTrieBuffer;
+  }
+
+  AK_FORCE_INLINE TerminalPositionLookupTable*
+  getMutableTerminalPositionLookupTable() {
+    return &mTerminalPositionLookupTable;
+  }
+
+  AK_FORCE_INLINE const TerminalPositionLookupTable*
+  getTerminalPositionLookupTable() const {
+    return &mTerminalPositionLookupTable;
+  }
+
+  AK_FORCE_INLINE LanguageModelDictContent*
+  getMutableLanguageModelDictContent() {
+    return &mLanguageModelDictContent;
+  }
+
+  AK_FORCE_INLINE const LanguageModelDictContent* getLanguageModelDictContent()
+      const {
+    return &mLanguageModelDictContent;
+  }
+
+  AK_FORCE_INLINE BigramDictContent* getMutableBigramDictContent() {
+    return &mBigramDictContent;
+  }
+
+  AK_FORCE_INLINE const BigramDictContent* getBigramDictContent() const {
+    return &mBigramDictContent;
+  }
+
+  AK_FORCE_INLINE ShortcutDictContent* getMutableShortcutDictContent() {
+    return &mShortcutDictContent;
+  }
+
+  AK_FORCE_INLINE const ShortcutDictContent* getShortcutDictContent() const {
+    return &mShortcutDictContent;
+  }
+
+  AK_FORCE_INLINE bool isUpdatable() const { return mIsUpdatable; }
+
+  bool flush(const char* const dictDirPath) const {
+    return flushHeaderAndDictBuffers(dictDirPath, &mExpandableHeaderBuffer);
+  }
+
+  bool flushHeaderAndDictBuffers(
+      const char* const dictDirPath,
+      const BufferWithExtendableBuffer* const headerBuffer) const;
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(Ver4DictBuffers);
+
+  Ver4DictBuffers(MmappedBuffer::MmappedBufferPtr&& headerBuffer,
+                  MmappedBuffer::MmappedBufferPtr&& bodyBuffer,
+                  const FormatUtils::FORMAT_VERSION formatVersion,
+                  const std::vector<uint8_t*>& contentBuffers,
+                  const std::vector<int>& contentBufferSizes);
+
+  Ver4DictBuffers(const HeaderPolicy* const headerPolicy,
+                  const int maxTrieSize);
+
+  bool flushDictBuffers(FILE* const file) const;
+
+  const MmappedBuffer::MmappedBufferPtr mHeaderBuffer;
+  const MmappedBuffer::MmappedBufferPtr mDictBuffer;
+  const HeaderPolicy mHeaderPolicy;
+  BufferWithExtendableBuffer mExpandableHeaderBuffer;
+  BufferWithExtendableBuffer mExpandableTrieBuffer;
+  TerminalPositionLookupTable mTerminalPositionLookupTable;
+  LanguageModelDictContent mLanguageModelDictContent;
+  BigramDictContent mBigramDictContent;
+  ShortcutDictContent mShortcutDictContent;
+  const int mIsUpdatable;
+};
+}  // namespace latinime
+#endif /* LATINIME_VER4_DICT_BUFFER_H */