| // Copyright 2010-2015, Google Inc. |
| // All rights reserved. |
| // |
| // Redistribution and use in source and binary forms, with or without |
| // modification, are permitted provided that the following conditions are |
| // met: |
| // |
| // * Redistributions of source code must retain the above copyright |
| // notice, this list of conditions and the following disclaimer. |
| // * Redistributions in binary form must reproduce the above |
| // copyright notice, this list of conditions and the following disclaimer |
| // in the documentation and/or other materials provided with the |
| // distribution. |
| // * Neither the name of Google Inc. nor the names of its |
| // contributors may be used to endorse or promote products derived from |
| // this software without specific prior written permission. |
| // |
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| |
| #ifndef MOZC_PREDICTION_PREDICTOR_INTERFACE_H_ |
| #define MOZC_PREDICTION_PREDICTOR_INTERFACE_H_ |
| |
| #include <string> |
| |
| namespace mozc { |
| |
| class ConversionRequest; |
| class Segments; |
| |
| class PredictorInterface { |
| public: |
| virtual ~PredictorInterface() {} |
| |
| // Returns suggestions. |
| // You may need to change the behavior according to the |
| // Segments::request_type flag |
| // SUGGESTION: automatic suggestions |
| // PREDICTION: invoked only when user pushes "tab" key. |
| // less aggressive than SUGGESTION mode. |
| virtual bool PredictForRequest(const ConversionRequest &request, |
| Segments *segments) const = 0; |
| |
| // Hook(s) for all mutable operations. |
| virtual void Finish(Segments *segments) {} |
| |
| // Reverts the last Finish operation. |
| virtual void Revert(Segments *segments) {} |
| |
| // Clears all history data of UserHistoryPredictor. |
| virtual bool ClearAllHistory() { return true; } |
| |
| // Clears unused history data of UserHistoryPredictor. |
| virtual bool ClearUnusedHistory() { return true; } |
| |
| // Clears a specific history data of UserHistoryPredictor. |
| virtual bool ClearHistoryEntry(const string &key, |
| const string &value) { return true; } |
| |
| // Syncs user history to local disk. |
| virtual bool Sync() { return true; } |
| |
| // Reloads user history data from local disk. |
| virtual bool Reload() { return true; } |
| |
| // Waits for syncer thread to complete. |
| virtual bool WaitForSyncerForTest() { return true; } |
| |
| virtual const string &GetPredictorName() const = 0; |
| |
| protected: |
| // Disable the construction. |
| PredictorInterface() {} |
| }; |
| |
| } // namespace mozc |
| |
| #endif // MOZC_PREDICTION_PREDICTOR_INTERFACE_H_ |