Open Chinese Convert: Dict.hpp Source File

Open Chinese Convert 1.3.1+g1a12f2dc6.dirty A project for conversion between Traditional and Simplified Chinese

Loading...
Searching...
No Matches
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 <list>
22
23#include "Common.hpp"
24#include "DictEntry.hpp"
25
26namespace opencc {
31 class OPENCC_EXPORT Dict {
32public:
36 virtual Optional<const DictEntry*> Match(const char* word,
37 size_t len) const = 0;
38
42 Optional<const DictEntry*> Match(const std::string& word) const {
43 return Match(word.c_str(), word.length());
44 }
45
51 virtual Optional<const DictEntry*> MatchPrefix(const char* word,
52 size_t len) const;
53
57 Optional<const DictEntry*> MatchPrefix(const char* word) const {
58 return MatchPrefix(word, KeyMaxLength());
59 }
60
64 Optional<const DictEntry*> MatchPrefix(const std::string& word) const {
65 return MatchPrefix(word.c_str(), word.length());
66 }
67
73 virtual std::vector<const DictEntry*> MatchAllPrefixes(const char* word,
74 size_t len) const;
75
79 std::vector<const DictEntry*>
80 MatchAllPrefixes(const std::string& word) const {
81 return MatchAllPrefixes(word.c_str(), word.length());
82 }
83
87 virtual size_t KeyMaxLength() const = 0;
88
92 virtual LexiconPtr GetLexicon() const = 0;
93
97 virtual const std::list<DictPtr>* GetDictGroupItems() const {
98 return nullptr;
99 }
100};
101} // namespace opencc
opencc::Dict
Abstract class of dictionary.
Definition Dict.hpp:31
opencc::Dict::KeyMaxLength
virtual size_t KeyMaxLength() const =0
Returns the length of the longest key in the dictionary.
opencc::Dict::Match
virtual Optional< const DictEntry * > Match(const char *word, size_t len) const =0
Matches a word exactly and returns the DictEntry or Optional::Null().
opencc::Dict::GetLexicon
virtual LexiconPtr GetLexicon() const =0
Returns all entries in the dictionary.
opencc::Dict::MatchPrefix
Optional< const DictEntry * > MatchPrefix(const std::string &word) const
Matches the longest matched prefix of a word.
Definition Dict.hpp:64
opencc::Dict::Match
Optional< const DictEntry * > Match(const std::string &word) const
Matches a word exactly and returns the DictEntry or Optional::Null().
Definition Dict.hpp:42
opencc::Dict::MatchPrefix
Optional< const DictEntry * > MatchPrefix(const char *word) const
Matches the longest matched prefix of a word.
Definition Dict.hpp:57
opencc::Dict::GetDictGroupItems
virtual const std::list< DictPtr > * GetDictGroupItems() const
Returns child dictionaries when this dictionary is a group.
Definition Dict.hpp:97
opencc::Dict::MatchPrefix
virtual Optional< const DictEntry * > MatchPrefix(const char *word, size_t len) const
Matches the longest matched prefix of a word.
Definition Dict.cpp:25
opencc::Dict::MatchAllPrefixes
virtual std::vector< const DictEntry * > MatchAllPrefixes(const char *word, size_t len) const
Returns all matched prefixes of a word, sorted by the length (desc).
Definition Dict.cpp:42
opencc::Dict::MatchAllPrefixes
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:80
opencc::Optional
A class that wraps type T into a nullable type.
Definition Optional.hpp:26