Open Chinese Convert  1.1.2
A project for conversion between Traditional and Simplified Chinese
Dict.hpp
1 /*
2  * Open Chinese Convert
3  *
4  * Copyright 2010-2020 Carbo Kuo <byvoid@byvoid.com>
5  *
6  * Licensed under the Apache License, Version 2.0 (the "License");
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 
19 #pragma once
20 
21 #include "Common.hpp"
22 #include "DictEntry.hpp"
23 
24 namespace opencc {
29 class OPENCC_EXPORT Dict {
30 public:
34  virtual Optional<const DictEntry*> Match(const char* word,
35  size_t len) const = 0;
36 
40  Optional<const DictEntry*> Match(const std::string& word) const {
41  return Match(word.c_str(), word.length());
42  }
43 
49  virtual Optional<const DictEntry*> MatchPrefix(const char* word,
50  size_t len) const;
51 
55  Optional<const DictEntry*> MatchPrefix(const char* word) const {
56  return MatchPrefix(word, KeyMaxLength());
57  }
58 
62  Optional<const DictEntry*> MatchPrefix(const std::string& word) const {
63  return MatchPrefix(word.c_str(), word.length());
64  }
65 
71  virtual std::vector<const DictEntry*> MatchAllPrefixes(const char* word,
72  size_t len) const;
73 
77  std::vector<const DictEntry*>
78  MatchAllPrefixes(const std::string& word) const {
79  return MatchAllPrefixes(word.c_str(), word.length());
80  }
81 
85  virtual size_t KeyMaxLength() const = 0;
86 
90  virtual LexiconPtr GetLexicon() const = 0;
91 };
92 } // namespace opencc
Abstract class of dictionary.
Definition: Dict.hpp:29
Optional< const DictEntry * > MatchPrefix(const char *word) const
Matches the longest matched prefix of a word.
Definition: Dict.hpp:55
virtual size_t KeyMaxLength() const =0
Returns the length of the longest key in the dictionary.
Optional< const DictEntry * > MatchPrefix(const std::string &word) const
Matches the longest matched prefix of a word.
Definition: Dict.hpp:62
virtual LexiconPtr GetLexicon() const =0
Returns all entries in the dictionary.
std::vector< const DictEntry * > MatchAllPrefixes(const std::string &word) const
Returns all matched prefixes of a word, sorted by the length (desc).
Definition: Dict.hpp:78
virtual Optional< const DictEntry * > Match(const char *word, size_t len) const =0
Matches a word exactly and returns the DictEntry or Optional::Null().
Optional< const DictEntry * > Match(const std::string &word) const
Matches a word exactly and returns the DictEntry or Optional::Null().
Definition: Dict.hpp:40
A class that wraps type T into a nullable type.
Definition: Optional.hpp:26