1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
/*
* Open Chinese Convert
*
* Copyright 2010-2014 Carbo Kuo <byvoid@byvoid.com>
*
* 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.
*/
#include "Export.hpp"
#include <string>
#include <vector>
#ifndef __OPENCC_SIMPLECONVERTER_HPP_
#define __OPENCC_SIMPLECONVERTER_HPP_
#include "ConversionInspection.hpp"
/**
* @defgroup opencc_simple_api OpenCC C++ Simple API
*
* Simple API in C++ language
*/
namespace opencc {
/**
* A high level converter
* This interface does not require C++11 to compile.
* @ingroup opencc_simple_api
*/
class OPENCC_EXPORT SimpleConverter {
public:
/**
* Constructor of SimpleConverter
* @param configFileName File name of configuration.
*/
explicit SimpleConverter(const std::string& configFileName);
/**
* Constructor of SimpleConverter
* @param configFileName File name of configuration.
* @param paths Additional paths to locate configuration and dictionary files.
*/
SimpleConverter(const std::string& configFileName,
const std::vector<std::string>& paths);
/**
* Constructor of SimpleConverter
* @param configFileName File name of configuration.
* @param paths Additional paths to locate configuration and dictionary files.
* @param argv0 Path of the executable (argv[0]), in addition to additional
* paths.
*/
SimpleConverter(const std::string& configFileName,
const std::vector<std::string>& paths, const char* argv0);
~SimpleConverter();
/**
* Converts a text
* @param input Text to be converted.
*/
std::string Convert(const std::string& input) const;
/**
* Converts a text
* @param input A C-Style std::string (terminated by '\0') to be converted.
*/
std::string Convert(const char* input) const;
/**
* Converts a text
* @param input A C-Style std::string limited by a given length to be
* converted.
* @param length Maximal length in byte of the input std::string.
*/
std::string Convert(const char* input, size_t length) const;
/**
* Converts a text and writes to an allocated buffer
* Please make sure the buffer has sufficient space.
* @param input A C-Style std::string (terminated by '\0') to be converted.
* @param output Buffer to write the converted text.
* @return Length of converted text.
*/
size_t Convert(const char* input, char* output) const;
/**
* Converts a text and writes to an allocated buffer
* Please make sure the buffer has sufficient space.
* @param input A C-Style std::string limited by a given length to be
* converted.
* @param length Maximal length in byte of the input std::string.
* @param output Buffer to write the converted text.
* @return Length of converted text.
*/
size_t Convert(const char* input, size_t length, char* output) const;
/**
* Inspects the conversion process for a given text.
* Returns the segmentation result, per-stage conversion outputs, and final
* output string.
* @param input Text to be inspected.
*/
ConversionInspectionResult Inspect(const std::string& input) const;
private:
const void* internalData;
};
} // namespace opencc
#endif