Skip to content

Commit 0252831

Browse files
frankslinfrankslin
committed
Initial version of opencc-wasm library with a demo site (#1)
* Add WASM demo scaffold and project notes * Add OpenCC WASM demo with converter UI and test runner - 补充 WASM 编译结果在前端 JS 中的用法 * Polish WASM demo UI and paths, run tests, and streamline converter export * Add wasm-based OpenCC package and update demo to consume it * Add wasm-based OpenCC package, static demo bundle, and benchmarking page * Add copyright notice and LICENSE
1 parent 52488b8 commit 0252831

79 files changed

Lines changed: 2391 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎wasm-lib/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.emcache

‎wasm-lib/LICENSE‎

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

‎wasm-lib/NOTICE‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Modifications and additional code
2+
Copyright © 2025 Frank Lin.

‎wasm-lib/README.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# opencc-wasm
2+
3+
This package provides a WebAssembly backend for OpenCC, fully compatible with the `opencc-js` public API. It bundles the OpenCC C++ core (plus marisa) compiled via Emscripten, plus the official OpenCC configs and prebuilt `.ocd2` dictionaries (placed under `dist/data/` at build time).
4+
License: Apache-2.0 (see LICENSE).
5+
6+
## Features
7+
- Same API surface as `opencc-js`: `OpenCC.Converter`, `CustomConverter`, `ConverterFactory`, and locale presets.
8+
- No native bindings required; runs in Node.js and modern browsers (ESM), with a CommonJS build for legacy `require`.
9+
- On-demand loading of configs and dictionaries from the package’s `data/` directory into the Emscripten FS; each config/dict is cached after first use.
10+
11+
## Installation
12+
```bash
13+
npm install opencc-wasm
14+
```
15+
16+
## Usage
17+
```js
18+
import OpenCC from "opencc-wasm";
19+
20+
// Convert Traditional Chinese (HK) to Simplified (CN)
21+
const converter = OpenCC.Converter({ from: "hk", to: "cn" });
22+
console.log(await converter("漢語")); // => 汉语
23+
24+
// Custom dictionary
25+
const custom = OpenCC.CustomConverter([
26+
["“", "「"],
27+
["”", "」"],
28+
["‘", "『"],
29+
["’", "』"],
30+
]);
31+
console.log(custom("悟空道：“师父又来了。怎么叫做‘水中捞月’？”"));
32+
// => 悟空道：「師父又來了。怎麼叫做『水中撈月』？」
33+
```
34+
35+
### Node (CommonJS)
36+
```js
37+
const OpenCC = require("opencc-wasm").default;
38+
```
39+
40+
## Files and entry points
41+
- ESM: `dist/opencc-wasm.js`
42+
- CJS: `dist/opencc-wasm.cjs`
43+
- Data: `dist/data/config/*.json`, `dist/data/dict/*.ocd2` (copied during `npm run build`)
44+
45+
The package `exports` map is set so bundlers and Node can pick the right build automatically.
46+
47+
## Testing
48+
```bash
49+
cd wasm-lib
50+
npm test
51+
```
52+
Runs the upstream OpenCC testcases (converted to JSON) against the WASM build.
53+
54+
## Notes
55+
- Internally uses persistent OpenCC handles (`opencc_create/convert/destroy`) to avoid reloading configs.
56+
- Dictionaries are written under `/data/dict/` in the virtual FS; configs under `/data/config/`. Paths inside configs are rewritten automatically.
57+
- Memory grows on demand (`ALLOW_MEMORY_GROWTH=1`); no native dependencies needed.
58+
- Performance note: opencc-wasm focuses on fidelity and compatibility (uses official configs and `.ocd2`, matches Node OpenCC output 1:1). Raw throughput can be slower than pure JS implementations like `opencc-js`, but the WASM version guarantees full OpenCC behavior and config coverage.

‎wasm-lib/build.sh‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
#!/usr/bin/env bash
2+
set -euo pipefail
3+
4+
# 输出目录
5+
OUT_DIR="dist"
6+
mkdir -p "${OUT_DIR}"
7+
8+
# 单独的 emcc 缓存目录，避免权限问题
9+
export EM_CACHE="$(pwd)/.emcache"
10+
mkdir -p "${EM_CACHE}"
11+
12+
# OpenCC 源码路径（相对仓库根）
13+
OPENCC_SRC_DIR=".."
14+
15+
# 最小依赖的 OpenCC 源文件
16+
OPENCC_SRCS=(
17+
${OPENCC_SRC_DIR}/src/BinaryDict.cpp
18+
${OPENCC_SRC_DIR}/src/Config.cpp
19+
${OPENCC_SRC_DIR}/src/Conversion.cpp
20+
${OPENCC_SRC_DIR}/src/ConversionChain.cpp
21+
${OPENCC_SRC_DIR}/src/Converter.cpp
22+
${OPENCC_SRC_DIR}/src/Dict.cpp
23+
${OPENCC_SRC_DIR}/src/DictEntry.cpp
24+
${OPENCC_SRC_DIR}/src/DictGroup.cpp
25+
${OPENCC_SRC_DIR}/src/Lexicon.cpp
26+
${OPENCC_SRC_DIR}/src/MarisaDict.cpp
27+
${OPENCC_SRC_DIR}/src/MaxMatchSegmentation.cpp
28+
${OPENCC_SRC_DIR}/src/SerializedValues.cpp
29+
${OPENCC_SRC_DIR}/src/SimpleConverter.cpp
30+
${OPENCC_SRC_DIR}/src/TextDict.cpp
31+
${OPENCC_SRC_DIR}/src/UTF8StringSlice.cpp
32+
${OPENCC_SRC_DIR}/src/UTF8Util.cpp
33+
)
34+
35+
# marisa trie 源文件
36+
MARISA_DIR="${OPENCC_SRC_DIR}/deps/marisa-0.2.6"
37+
MARISA_SRCS=(
38+
${MARISA_DIR}/lib/marisa/agent.cc
39+
${MARISA_DIR}/lib/marisa/keyset.cc
40+
${MARISA_DIR}/lib/marisa/trie.cc
41+
${MARISA_DIR}/lib/marisa/grimoire/io/reader.cc
42+
${MARISA_DIR}/lib/marisa/grimoire/io/writer.cc
43+
${MARISA_DIR}/lib/marisa/grimoire/io/mapper.cc
44+
${MARISA_DIR}/lib/marisa/grimoire/trie/louds-trie.cc
45+
${MARISA_DIR}/lib/marisa/grimoire/trie/tail.cc
46+
${MARISA_DIR}/lib/marisa/grimoire/vector/bit-vector.cc
47+
)
48+
49+
# 头文件搜索路径
50+
INCLUDE_FLAGS=(
51+
-I${OPENCC_SRC_DIR}/src
52+
-I${MARISA_DIR}/include
53+
-I${MARISA_DIR}/lib
54+
-I${OPENCC_SRC_DIR}/deps/rapidjson-1.1.0
55+
)
56+
57+
# 编译选项：
58+
# -DOPENCC_WASM_WITH_OPENCC: 启用真实 OpenCC 逻辑
59+
# -s MODULARIZE=1: 生成可按需加载的模块工厂函数
60+
# -s EXPORT_NAME: 自定义工厂函数名，便于前端调用
61+
# -s EXPORTED_FUNCTIONS: 导出 C 接口（需要前缀下划线）
62+
# -s EXPORTED_RUNTIME_METHODS: 暴露 cwrap/FS/ccall，便于 JS 侧调用
63+
# -O2: 体积/性能权衡
64+
COMMON_FLAGS=(
65+
-DOPENCC_WASM_WITH_OPENCC
66+
"${OPENCC_SRCS[@]}"
67+
"${MARISA_SRCS[@]}"
68+
src/main.cpp
69+
"${INCLUDE_FLAGS[@]}"
70+
-fexceptions
71+
-sDISABLE_EXCEPTION_CATCHING=0
72+
-O2
73+
-s WASM=1
74+
-s MODULARIZE=1
75+
-s FORCE_FILESYSTEM=1
76+
-s ALLOW_MEMORY_GROWTH=1
77+
-s EXPORT_NAME="createOpenCCWasm"
78+
-s EXPORTED_FUNCTIONS="['_opencc_create','_opencc_convert','_opencc_destroy']"
79+
-s EXPORTED_RUNTIME_METHODS="['cwrap','FS','ccall']"
80+
)
81+
82+
# ES module（适合浏览器 / 现代 bundler）
83+
em++ \
84+
"${COMMON_FLAGS[@]}" \
85+
-s EXPORT_ES6=1 \
86+
-o "${OUT_DIR}/opencc-wasm.js"
87+
88+
# CommonJS（适合 Node.js require）
89+
em++ \
90+
"${COMMON_FLAGS[@]}" \
91+
-s EXPORT_ES6=0 \
92+
-s ENVIRONMENT='node' \
93+
-o "${OUT_DIR}/opencc-wasm.cjs"
94+
95+
echo "Build complete. Files in ${OUT_DIR}/"

‎wasm-lib/data/config/hk2s.json‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"name": "Traditional Chinese (Hong Kong variant) to Simplified Chinese",
3+
"segmentation": {
4+
"type": "mmseg",
5+
"dict": {
6+
"type": "ocd2",
7+
"file": "TSPhrases.ocd2"
8+
}
9+
},
10+
"conversion_chain": [{
11+
"dict": {
12+
"type": "group",
13+
"dicts": [{
14+
"type": "ocd2",
15+
"file": "HKVariantsRevPhrases.ocd2"
16+
}, {
17+
"type": "ocd2",
18+
"file": "HKVariantsRev.ocd2"
19+
}]
20+
}
21+
}, {
22+
"dict": {
23+
"type": "group",
24+
"dicts": [{
25+
"type": "ocd2",
26+
"file": "TSPhrases.ocd2"
27+
}, {
28+
"type": "ocd2",
29+
"file": "TSCharacters.ocd2"
30+
}]
31+
}
32+
}]
33+
}

‎wasm-lib/data/config/hk2t.json‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"name": "Traditional Chinese (Hong Kong variant) to Traditional Chinese",
3+
"segmentation": {
4+
"type": "mmseg",
5+
"dict": {
6+
"type": "ocd2",
7+
"file": "HKVariantsRevPhrases.ocd2"
8+
}
9+
},
10+
"conversion_chain": [{
11+
"dict": {
12+
"type": "group",
13+
"dicts": [{
14+
"type": "ocd2",
15+
"file": "HKVariantsRevPhrases.ocd2"
16+
}, {
17+
"type": "ocd2",
18+
"file": "HKVariantsRev.ocd2"
19+
}]
20+
}
21+
}]
22+
}

0 commit comments

Comments
 (0)