├── .github ├── FUNDING.yml ├── dependabot.yml └── workflows │ ├── periodic.yml │ ├── regression.yml │ └── release.yml ├── .gitignore ├── Cargo.toml ├── LICENSE ├── Makefile ├── README.md ├── benches └── bench.rs ├── cbindgen.toml ├── example.env ├── resources ├── cc-cedict_simple.csv ├── ipadic_simple.csv ├── ko-dic_simple.csv ├── lindera.yml └── unidic_simple.csv └── src ├── common.rs ├── extension.rs └── lib.rs /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: [ mosuka ] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 13 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # To get started with Dependabot version updates, you'll need to specify which 2 | # package ecosystems to update and where the package manifests are located. 3 | # Please see the documentation for all configuration options: 4 | # https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates 5 | 6 | version: 2 7 | updates: 8 | - package-ecosystem: cargo 9 | directory: / 10 | schedule: 11 | interval: daily 12 | - package-ecosystem: github-actions 13 | directory: / 14 | schedule: 15 | interval: daily 16 | -------------------------------------------------------------------------------- /.github/workflows/periodic.yml: -------------------------------------------------------------------------------- 1 | name: Periodic 2 | 3 | on: 4 | workflow_dispatch: 5 | schedule: 6 | - cron: 0 0 * * SUN 7 | 8 | jobs: 9 | format: 10 | name: Format 11 | strategy: 12 | matrix: 13 | platform: 14 | - runner: ubuntu-latest 15 | target: x86_64 16 | toolchain: [stable] 17 | features: ["cjk"] 18 | runs-on: ${{ matrix.platform.runner }} 19 | steps: 20 | - name: Run checkout 21 | uses: actions/checkout@v4 22 | 23 | - name: Install toolchain 24 | uses: dtolnay/rust-toolchain@v1 25 | with: 26 | toolchain: ${{ matrix.toolchain }} 27 | components: rustfmt, clippy 28 | 29 | - name: Check format 30 | run: cargo fmt --all -- --check 31 | 32 | test: 33 | name: Test 34 | needs: [format] 35 | strategy: 36 | matrix: 37 | platform: 38 | - runner: ubuntu-latest 39 | target: x86_64-unknown-linux-gnu 40 | - runner: macOS-latest 41 | target: x86_64-apple-darwin 42 | - runner: macOS-latest 43 | target: aarch64-apple-darwin 44 | - runner: windows-latest 45 | target: x86_64-pc-windows-msvc 46 | toolchain: [stable, beta, nightly] 47 | features: ["cjk"] 48 | runs-on: ${{ matrix.platform.runner }} 49 | env: 50 | LINDERA_CONFIG_PATH: "./resources/lindera.yml" 51 | steps: 52 | - name: Run checkout 53 | uses: actions/checkout@v4 54 | 55 | - name: Install toolchain 56 | uses: dtolnay/rust-toolchain@v1 57 | with: 58 | toolchain: ${{ matrix.toolchain }} 59 | target: ${{ matrix.platform.target }} 60 | components: rustfmt, clippy 61 | 62 | - name: Run test 63 | run: cargo test --target "${{ matrix.platform.target }}" --features "${{ matrix.features }}" 64 | -------------------------------------------------------------------------------- /.github/workflows/regression.yml: -------------------------------------------------------------------------------- 1 | name: Regression 2 | 3 | on: 4 | workflow_dispatch: 5 | push: 6 | branches: 7 | - main 8 | pull_request: 9 | types: [opened, synchronize] 10 | 11 | jobs: 12 | format: 13 | name: Format 14 | strategy: 15 | matrix: 16 | platform: 17 | - runner: ubuntu-latest 18 | target: x86_64 19 | toolchain: [stable] 20 | features: ["cjk"] 21 | runs-on: ${{ matrix.platform.runner }} 22 | steps: 23 | - name: Run checkout 24 | uses: actions/checkout@v4 25 | 26 | - name: Install toolchain 27 | uses: dtolnay/rust-toolchain@v1 28 | with: 29 | toolchain: ${{ matrix.toolchain }} 30 | components: rustfmt, clippy 31 | 32 | - name: Check format 33 | run: cargo fmt --all -- --check 34 | 35 | test: 36 | name: Test 37 | needs: [format] 38 | strategy: 39 | matrix: 40 | platform: 41 | - runner: ubuntu-latest 42 | target: x86_64-unknown-linux-gnu 43 | - runner: macOS-latest 44 | target: x86_64-apple-darwin 45 | - runner: macOS-latest 46 | target: aarch64-apple-darwin 47 | - runner: windows-latest 48 | target: x86_64-pc-windows-msvc 49 | toolchain: [stable] 50 | features: ["cjk"] 51 | runs-on: ${{ matrix.platform.runner }} 52 | env: 53 | LINDERA_CONFIG_PATH: "./resources/lindera.yml" 54 | steps: 55 | - name: Run checkout 56 | uses: actions/checkout@v4 57 | 58 | - name: Install toolchain 59 | uses: dtolnay/rust-toolchain@v1 60 | with: 61 | toolchain: ${{ matrix.toolchain }} 62 | target: ${{ matrix.platform.target }} 63 | components: rustfmt, clippy 64 | 65 | - name: Run test 66 | run: cargo test --target "${{ matrix.platform.target }}" --features "${{ matrix.features }}" 67 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: Release 2 | 3 | on: 4 | workflow_dispatch: 5 | 6 | push: 7 | tags: 8 | - "v*.*.*" 9 | 10 | permissions: 11 | contents: read 12 | 13 | jobs: 14 | format: 15 | name: Format 16 | strategy: 17 | matrix: 18 | platform: 19 | - runner: ubuntu-latest 20 | target: x86_64 21 | toolchain: [stable] 22 | features: ["cjk"] 23 | runs-on: ${{ matrix.platform.runner }} 24 | steps: 25 | - name: Run checkout 26 | uses: actions/checkout@v4 27 | 28 | - name: Install toolchain 29 | uses: dtolnay/rust-toolchain@v1 30 | with: 31 | toolchain: ${{ matrix.toolchain }} 32 | components: rustfmt, clippy 33 | 34 | - name: Check format 35 | run: cargo fmt --all -- --check 36 | 37 | test: 38 | name: Test 39 | needs: [format] 40 | strategy: 41 | matrix: 42 | platform: 43 | - runner: ubuntu-latest 44 | target: x86_64-unknown-linux-gnu 45 | - runner: macOS-latest 46 | target: x86_64-apple-darwin 47 | - runner: macOS-latest 48 | target: aarch64-apple-darwin 49 | - runner: windows-latest 50 | target: x86_64-pc-windows-msvc 51 | toolchain: [stable] 52 | features: ["cjk"] 53 | runs-on: ${{ matrix.platform.runner }} 54 | env: 55 | LINDERA_CONFIG_PATH: "./resources/lindera.yml" 56 | steps: 57 | - name: Run checkout 58 | uses: actions/checkout@v4 59 | 60 | - name: Install toolchain 61 | uses: dtolnay/rust-toolchain@v1 62 | with: 63 | toolchain: ${{ matrix.toolchain }} 64 | target: ${{ matrix.platform.target }} 65 | components: rustfmt, clippy 66 | 67 | - name: Run test 68 | run: cargo test --target "${{ matrix.platform.target }}" --features "${{ matrix.features }}" 69 | 70 | build: 71 | name: Build 72 | needs: [test] 73 | strategy: 74 | matrix: 75 | platform: 76 | - runner: ubuntu-latest 77 | target: x86_64-unknown-linux-gnu 78 | archive: .zip 79 | extension: ".so" 80 | - runner: macOS-latest 81 | target: x86_64-apple-darwin 82 | archive: .zip 83 | extension: ".dylib" 84 | - runner: macOS-latest 85 | target: aarch64-apple-darwin 86 | archive: .zip 87 | extension: ".dylib" 88 | - runner: windows-latest 89 | target: x86_64-pc-windows-msvc 90 | archive: .zip 91 | extension: ".dll" 92 | toolchain: [stable] 93 | features: ["cjk"] 94 | runs-on: ${{ matrix.platform.runner }} 95 | env: 96 | LINDERA_CONFIG_PATH: "./resources/lindera.json" 97 | permissions: 98 | contents: write 99 | steps: 100 | - name: Run checkout 101 | uses: actions/checkout@v4 102 | 103 | - name: Install toolchain 104 | uses: dtolnay/rust-toolchain@v1 105 | with: 106 | toolchain: ${{ matrix.toolchain }} 107 | target: ${{ matrix.platform.target }} 108 | components: rustfmt, clippy 109 | 110 | - name: Add msbuild to PATH 111 | if: matrix.platform.target == 'windows-latest' 112 | uses: microsoft/setup-msbuild@v2 113 | 114 | - name: Compile 115 | run: cargo build --release --features=${{ matrix.features }} --target=${{ matrix.platform.target }} --target-dir=target/${{ matrix.features }} 116 | 117 | - name: Create artifact for Linux 118 | if: matrix.platform.runner == 'ubuntu-latest' 119 | run: zip --junk-paths lindera-${{ matrix.features }}-${{ matrix.platform.target }}-${{ github.ref_name }}${{ matrix.platform.archive }} target/${{ matrix.features }}/${{ matrix.platform.target }}/release/liblindera_sqlite${{ matrix.platform.extension }} 120 | 121 | - name: Create artifact for Windows 122 | if: matrix.platform.runner == 'windows-latest' 123 | run: powershell Compress-Archive -DestinationPath lindera-${{ matrix.features }}-${{ matrix.platform.target }}-${{ github.ref_name }}${{ matrix.platform.archive }} -Path target/${{ matrix.features }}/${{ matrix.platform.target }}/release/lindera_sqlite${{ matrix.platform.extension }} 124 | 125 | - name: Create artifact for OSX 126 | if: matrix.platform.runner == 'macos-latest' 127 | run: zip --junk-paths lindera-${{ matrix.features }}-${{ matrix.platform.target }}-${{ github.ref_name }}${{ matrix.platform.archive }} target/${{ matrix.features }}/${{ matrix.platform.target }}/release/liblindera_sqlite${{ matrix.platform.extension }} 128 | 129 | - name: Upload artifact 130 | uses: softprops/action-gh-release@v2 131 | env: 132 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 133 | with: 134 | files: lindera-${{ matrix.features }}-${{ matrix.platform.target }}-${{ github.ref_name }}${{ matrix.platform.archive }} 135 | name: Release ${{ github.ref_name }} 136 | tag_name: ${{ github.ref_name }} 137 | draft: false 138 | prerelease: false 139 | generate_release_notes: true 140 | 141 | publish-crates: 142 | name: Publish crate 143 | needs: [build] 144 | strategy: 145 | matrix: 146 | platform: 147 | - runner: ubuntu-latest 148 | target: x86_64-unknown-linux-gnu 149 | toolchain: [stable] 150 | runs-on: ${{ matrix.platform.runner }} 151 | env: 152 | LINDERA_CONFIG_PATH: "./resources/lindera.yml" 153 | steps: 154 | - name: Checkout 155 | uses: actions/checkout@v4 156 | 157 | - name: Install toolchain 158 | uses: dtolnay/rust-toolchain@v1 159 | with: 160 | toolchain: ${{ matrix.toolchain }} 161 | target: ${{ matrix.platform.target }} 162 | components: rustfmt, clippy 163 | 164 | - name: Publish lindera-sqlite 165 | run: | 166 | LINDERA_SQLITE_VERSION=$(cargo metadata --no-deps --format-version=1 | jq -r '.packages[] | select(.name=="lindera-sqlite") | .version') 167 | LINDERA_SQLITE_VERSIONS=$(curl -s -XGET https://crates.io/api/v1/crates/lindera-sqlite | jq -r 'select(.versions != null) | .versions[].num') 168 | if echo ${LINDERA_SQLITE_VERSIONS} | grep ${LINDERA_SQLITE_VERSION} >/dev/null; then 169 | echo "lindera-sqlite ${LINDERA_SQLITE_VERSION} has already published" 170 | else 171 | cargo publish --token ${{ secrets.CRATES_TOKEN }} 172 | fi 173 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .vscode 2 | .idea 3 | .DS_Store 4 | 5 | .env 6 | 7 | target 8 | 9 | Cargo.lock 10 | 11 | *.db 12 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "lindera-sqlite" 3 | version = "0.43.1" 4 | edition = "2021" 5 | description = "Lindera tokenizer for SQLite FTS5 extention" 6 | documentation = "https://docs.rs/lindera-sqlite" 7 | homepage = "https://github.com/lindera/lindera-sqlite" 8 | repository = "https://github.com/lindera/lindera-sqlite" 9 | readme = "README.md" 10 | keywords = ["morphological", "analysis", "library", "sqlite"] 11 | categories = ["text-processing"] 12 | license = "AGPL-3.0-only" 13 | 14 | [features] 15 | default = [] # No directories included 16 | ipadic = ["lindera/ipadic"] # Include IPADIC dictionary (Japanese) 17 | ipadic-neologd = [ 18 | "lindera/ipadic-neologd", 19 | ] # Include IPADIC NEologd dictionary (Japanese) 20 | unidic = ["lindera/unidic"] # Include UniDic dictionary (Japanese) 21 | ko-dic = ["lindera/ko-dic"] # Include ko-dic dictionary (Korean) 22 | cc-cedict = ["lindera/cc-cedict"] # Include CC-CEDICT dictionary (Chinese) 23 | compress = ["lindera/compress"] # Compress dictionaries 24 | extension = [] 25 | cjk = [ 26 | "cc-cedict", 27 | "ipadic", 28 | "ko-dic", 29 | "compress", 30 | "extension", 31 | ] # Include CJK dictionary (Chinese, Japanese, Korean) 32 | 33 | [lib] 34 | name = "lindera_sqlite" 35 | path = "src/lib.rs" 36 | crate-type = ["cdylib", "rlib"] 37 | 38 | [profile.release] 39 | lto = true 40 | 41 | [dependencies] 42 | # libc without `std` 43 | libc = { version = "0.2.172", "default-features" = false, features = [] } 44 | serde_json = "1.0.140" 45 | unicode-segmentation = "1.12.0" 46 | unicode-normalization = "0.1.22" 47 | 48 | lindera = "0.43.1" 49 | 50 | [dev-dependencies] 51 | criterion = "0.6.0" 52 | 53 | [[bench]] 54 | name = "bench" 55 | harness = false 56 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | LINDERA_SQLITE_VERSION ?= $(shell cargo metadata --no-deps --format-version=1 | jq -r '.packages[] | select(.name=="lindera-sqlite") | .version') 2 | 3 | .DEFAULT_GOAL := help 4 | 5 | clean: ## Clean the project 6 | cargo clean 7 | 8 | format: ## Format the code 9 | cargo fmt 10 | 11 | lint: ## Run linter 12 | cargo clippy --features=cjk 13 | 14 | build: ## Build the project 15 | cargo build --release --features=cjk 16 | 17 | test: ## Run tests 18 | LINDERA_CONFIG_PATH=./resources/lindera.yml cargo test --features=cjk 19 | 20 | bench: ## Run benchmarks 21 | LINDERA_CONFIG_PATH=./resources/lindera.yml cargo bench --features=cjk 22 | 23 | tag: ## Make a new tag for the current version 24 | git tag v$(LINDERA_SQLITE_VERSION) 25 | git push origin v$(LINDERA_SQLITE_VERSION) 26 | 27 | publish: ## Publish the crate to crates.io 28 | ifeq ($(shell curl -s -XGET https://crates.io/api/v1/crates/lindera-sqlite | jq -r '.versions[].num' | grep $(LINDERA_SQLITE_VERSION)),) 29 | (cargo package && cargo publish) 30 | endif 31 | 32 | help: ## Show help 33 | @echo "Available targets:" 34 | @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf " %-15s %s\n", $$1, $$2}' 35 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Overview 2 | 3 | lindera-sqlite is a C ABI library which exposes a [FTS5](https://www.sqlite.org/fts5.html) tokenizer function. 4 | 5 | When used as a custom FTS5 tokenizer this enables application to support Chinese, Japanese and Korean in full-text search. 6 | 7 | ## Build extension 8 | 9 | ```sh 10 | % cargo build --features=ipadic,ko-dic,cc-cedict,compress,extension 11 | ``` 12 | 13 | ## Set enviromment variable for Lindera configuration 14 | 15 | ```sh 16 | % export LINDERA_CONFIG_PATH=./resources/lindera.yml 17 | ``` 18 | 19 | ## Then start SQLite 20 | 21 | ```sh 22 | % sqlite3 example.db 23 | ``` 24 | 25 | ## Load extension 26 | 27 | ```sql 28 | sqlite> .load ./target/debug/liblindera_sqlite lindera_fts5_tokenizer_init 29 | ``` 30 | 31 | ## Create table using FTS5 with Lindera tokenizer 32 | 33 | ```sql 34 | sqlite> CREATE VIRTUAL TABLE example USING fts5(content, tokenize='lindera_tokenizer'); 35 | ``` 36 | 37 | ## Insert data 38 | 39 | ```sql 40 | sqlite> INSERT INTO example(content) VALUES ("Ｌｉｎｄｅｒａは形態素解析ｴﾝｼﾞﾝです。ユーザー辞書も利用可能です。"); 41 | ``` 42 | 43 | ## Search data 44 | 45 | ```sql 46 | sqlite> SELECT * FROM example WHERE content MATCH "Lindera" ORDER BY bm25(example) LIMIT 10; 47 | ``` 48 | -------------------------------------------------------------------------------- /benches/bench.rs: -------------------------------------------------------------------------------- 1 | use core::ptr::null_mut; 2 | use criterion::{black_box, criterion_group, criterion_main, Criterion}; 3 | use libc::{c_char, c_int, c_void}; 4 | 5 | use lindera_sqlite::{lindera_fts5_tokenize, load_tokenizer, Fts5Tokenizer, SQLITE_OK}; 6 | 7 | extern "C" fn noop_callback( 8 | _ctx: *mut c_void, 9 | _flags: c_int, 10 | _token: *const c_char, 11 | _token_len: c_int, 12 | _start: c_int, 13 | _end: c_int, 14 | ) -> c_int { 15 | return SQLITE_OK; 16 | } 17 | 18 | fn tokenize(input: &str) { 19 | lindera_fts5_tokenize( 20 | &mut Fts5Tokenizer { 21 | tokenizer: load_tokenizer().expect("Failed to load tokenizer"), 22 | }, 23 | null_mut(), 24 | 0, 25 | input.as_bytes().as_ptr() as *const c_char, 26 | input.len() as i32, 27 | noop_callback, 28 | ); 29 | } 30 | 31 | fn fts5_benchmark(c: &mut Criterion) { 32 | let latin_lower_60kb = "hello ".repeat(10 * 1024); 33 | let latin_upper_60kb = "HELLO ".repeat(10 * 1024); 34 | let diacritics_60kb = "öplö ".repeat(10 * 1024); 35 | let cjk_60kb = "你好".repeat(10 * 1024); 36 | 37 | c.bench_function("tokenize latin lowercase 60kb", |b| { 38 | return b.iter(|| tokenize(black_box(&latin_lower_60kb))); 39 | }); 40 | 41 | c.bench_function("tokenize latin uppercase 60kb", |b| { 42 | return b.iter(|| tokenize(black_box(&latin_upper_60kb))); 43 | }); 44 | 45 | c.bench_function("tokenize diacritics 60kb", |b| { 46 | return b.iter(|| tokenize(black_box(&diacritics_60kb))); 47 | }); 48 | 49 | c.bench_function("tokenize cjk 60kb", |b| { 50 | return b.iter(|| tokenize(black_box(&cjk_60kb))); 51 | }); 52 | } 53 | 54 | criterion_group!(benches, fts5_benchmark); 55 | criterion_main!(benches); 56 | -------------------------------------------------------------------------------- /cbindgen.toml: -------------------------------------------------------------------------------- 1 | language = "C" 2 | 3 | header = "/*\nCopyright (C) 2025 Lindera.\nSPDX-License-Identifier: AGPL-3.0-only\n*/\n" 4 | 5 | include_guard = "LINDERA_FTS5_TOKENIZER_H_" 6 | 7 | autogen_warning = "/* This file was automatically generated by cbindgen */" 8 | 9 | style = "type" 10 | 11 | cpp_compat = true 12 | 13 | [enum] 14 | prefix_with_name = true 15 | 16 | [export] 17 | item_types = ["functions", "opaque", "structs", "typedefs"] 18 | 19 | [export.rename] 20 | "Sqlite3" = "sqlite3" 21 | "Sqlite3APIRoutines" = "sqlite3_api_routines" 22 | "TokenFunction" = "sqlite3__fts5_token_fn" 23 | 24 | [defines] 25 | "feature = extension" = "LINDERA_FTS5_TOKENIZER_EXTENSION_H_" 26 | -------------------------------------------------------------------------------- /example.env: -------------------------------------------------------------------------------- 1 | LINDERA_CONFIG_PATH=./resources/lindera.json 2 | -------------------------------------------------------------------------------- /resources/cc-cedict_simple.csv: -------------------------------------------------------------------------------- 1 | 羽田机场,*,Yu3 tian2 ji1 chang3 2 | -------------------------------------------------------------------------------- /resources/ipadic_simple.csv: -------------------------------------------------------------------------------- 1 | 東京スカイツリー,カスタム名詞,トウキョウスカイツリー 2 | 東武スカイツリーライン,カスタム名詞,トウブスカイツリーライン 3 | とうきょうスカイツリー駅,カスタム名詞,トウキョウスカイツリーエキ 4 | -------------------------------------------------------------------------------- /resources/ko-dic_simple.csv: -------------------------------------------------------------------------------- 1 | 하네다공항,NNP,하네다공항 2 | -------------------------------------------------------------------------------- /resources/lindera.yml: -------------------------------------------------------------------------------- 1 | segmenter: 2 | mode: "normal" 3 | dictionary: 4 | kind: "ipadic" 5 | # user_dictionary: 6 | # path: "./resources/ipadic_simple.csv" 7 | # kind: "ipadic" 8 | 9 | character_filters: 10 | - kind: "unicode_normalize" 11 | args: 12 | kind: "nfkc" 13 | - kind: "japanese_iteration_mark" 14 | args: 15 | normalize_kanji: true 16 | normalize_kana: true 17 | - kind: mapping 18 | args: 19 | mapping: 20 | リンデラ: Lindera 21 | 22 | token_filters: 23 | - kind: "japanese_compound_word" 24 | args: 25 | kind: "ipadic" 26 | tags: 27 | - "名詞,数" 28 | - "名詞,接尾,助数詞" 29 | new_tag: "名詞,数" 30 | - kind: "japanese_number" 31 | args: 32 | tags: 33 | - "名詞,数" 34 | - kind: "japanese_stop_tags" 35 | args: 36 | tags: 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 | - kind: "japanese_katakana_stem" 63 | args: 64 | min: 3 65 | - kind: "remove_diacritical_mark" 66 | args: 67 | japanese: false 68 | -------------------------------------------------------------------------------- /resources/unidic_simple.csv: -------------------------------------------------------------------------------- 1 | 東京スカイツリー,カスタム名詞,トウキョウスカイツリー 2 | 東武スカイツリーライン,カスタム名詞,トウブスカイツリーライン 3 | とうきょうスカイツリー駅,カスタム名詞,トウキョウスカイツリーエキ 4 | -------------------------------------------------------------------------------- /src/common.rs: -------------------------------------------------------------------------------- 1 | use libc::{c_char, c_int, c_void}; 2 | 3 | use lindera::tokenizer::Tokenizer; 4 | 5 | // sqlite3.h 6 | pub const SQLITE_OK: c_int = 0; 7 | pub const SQLITE_INTERNAL: c_int = 2; 8 | pub const SQLITE_MISUSE: c_int = 21; 9 | 10 | pub struct Fts5Tokenizer { 11 | pub tokenizer: Tokenizer, 12 | } 13 | 14 | pub type TokenFunction = extern "C" fn( 15 | p_ctx: *mut c_void, 16 | t_flags: c_int, 17 | p_token: *const c_char, 18 | n_token: c_int, 19 | i_start: c_int, 20 | i_end: c_int, 21 | ) -> c_int; 22 | -------------------------------------------------------------------------------- /src/extension.rs: -------------------------------------------------------------------------------- 1 | use core::ptr::null_mut; 2 | use libc::{c_char, c_int, c_uchar, c_void}; 3 | 4 | use crate::common::*; 5 | use crate::lindera_fts5_tokenize; 6 | use crate::load_tokenizer; 7 | 8 | pub const FTS5_API_VERSION: c_int = 2; 9 | 10 | pub struct Sqlite3 {} 11 | struct Sqlite3Stmt {} 12 | 13 | // fts5.h 14 | #[repr(C)] 15 | struct Fts5TokenizerApi { 16 | x_create: extern "C" fn( 17 | p_context: *mut c_void, 18 | az_arg: *const *const c_uchar, 19 | n_arg: c_int, 20 | fts5_tokenizer: *mut *mut Fts5Tokenizer, 21 | ) -> c_int, 22 | x_delete: extern "C" fn(fts5_tokenizer: *mut Fts5Tokenizer), 23 | x_tokenize: extern "C" fn( 24 | tokenizer: *mut Fts5Tokenizer, 25 | p_ctx: *mut c_void, 26 | flags: c_int, 27 | p_text: *const c_char, 28 | n_text: c_int, 29 | x_token: TokenFunction, 30 | ) -> c_int, 31 | } 32 | 33 | #[repr(C)] 34 | struct FTS5API { 35 | i_version: c_int, // Currently always set to 2 36 | 37 | /* Create a new tokenizer */ 38 | x_create_tokenizer: extern "C" fn( 39 | fts5_api: *const FTS5API, 40 | z_name: *const c_uchar, 41 | p_context: *mut c_void, 42 | fts5_tokenizer: *mut Fts5TokenizerApi, 43 | x_destroy: extern "C" fn(module: *mut c_void), 44 | ) -> c_int, 45 | } 46 | 47 | // sqlite3ext.h 48 | #[repr(C)] 49 | pub struct Sqlite3APIRoutines { 50 | _aggregate_context: extern "C" fn(), 51 | _aggregate_count: extern "C" fn(), 52 | _bind_blob: extern "C" fn(), 53 | _bind_double: extern "C" fn(), 54 | _bind_int: extern "C" fn(), 55 | _bind_int64: extern "C" fn(), 56 | _bind_null: extern "C" fn(), 57 | _bind_parameter_count: extern "C" fn(), 58 | _bind_parameter_index: extern "C" fn(), 59 | _bind_parameter_name: extern "C" fn(), 60 | _bind_text: extern "C" fn(), 61 | _bind_text16: extern "C" fn(), 62 | _bind_value: extern "C" fn(), 63 | _busy_handler: extern "C" fn(), 64 | _busy_timeout: extern "C" fn(), 65 | _changes: extern "C" fn(), 66 | _close: extern "C" fn(), 67 | _collation_needed: extern "C" fn(), 68 | _collation_needed16: extern "C" fn(), 69 | _column_blob: extern "C" fn(), 70 | _column_bytes: extern "C" fn(), 71 | _column_bytes16: extern "C" fn(), 72 | _column_count: extern "C" fn(), 73 | _column_database_name: extern "C" fn(), 74 | _column_database_name16: extern "C" fn(), 75 | _column_decltype: extern "C" fn(), 76 | _column_decltype16: extern "C" fn(), 77 | _column_double: extern "C" fn(), 78 | _column_int: extern "C" fn(), 79 | _column_int64: extern "C" fn(), 80 | _column_name: extern "C" fn(), 81 | _column_name16: extern "C" fn(), 82 | _column_origin_name: extern "C" fn(), 83 | _column_origin_name16: extern "C" fn(), 84 | _column_table_name: extern "C" fn(), 85 | _column_table_name16: extern "C" fn(), 86 | _column_text: extern "C" fn(), 87 | _column_text16: extern "C" fn(), 88 | _column_type: extern "C" fn(), 89 | _column_value: extern "C" fn(), 90 | _commit_hook: extern "C" fn(), 91 | _complete: extern "C" fn(), 92 | _complete16: extern "C" fn(), 93 | _create_collation: extern "C" fn(), 94 | _create_collation16: extern "C" fn(), 95 | _create_function: extern "C" fn(), 96 | _create_function16: extern "C" fn(), 97 | _create_module: extern "C" fn(), 98 | _data_count: extern "C" fn(), 99 | _db_handle: extern "C" fn(), 100 | _declare_vtab: extern "C" fn(), 101 | _enable_shared_cache: extern "C" fn(), 102 | _errcode: extern "C" fn(), 103 | _errmsg: extern "C" fn(), 104 | _errmsg16: extern "C" fn(), 105 | _exec: extern "C" fn(), 106 | _expired: extern "C" fn(), 107 | finalize: extern "C" fn(stmt: *mut Sqlite3Stmt) -> c_int, 108 | _free: extern "C" fn(), 109 | _free_table: extern "C" fn(), 110 | _get_autocommit: extern "C" fn(), 111 | _get_auxdata: extern "C" fn(), 112 | _get_table: extern "C" fn(), 113 | _global_recover: extern "C" fn(), 114 | _interruptx: extern "C" fn(), 115 | _last_insert_rowid: extern "C" fn(), 116 | _libversion: extern "C" fn(), 117 | libversion_number: extern "C" fn() -> c_int, 118 | _malloc: extern "C" fn(), 119 | _mprintf: extern "C" fn(), 120 | _open: extern "C" fn(), 121 | _open16: extern "C" fn(), 122 | prepare: extern "C" fn( 123 | db: *mut Sqlite3, 124 | query: *const c_uchar, 125 | query_len: c_int, 126 | stmt: *mut *mut Sqlite3Stmt, 127 | pz_tail: *mut *mut c_uchar, 128 | ) -> c_int, 129 | _prepare16: extern "C" fn(), 130 | _profile: extern "C" fn(), 131 | _progress_handler: extern "C" fn(), 132 | _realloc: extern "C" fn(), 133 | _reset: extern "C" fn(), 134 | _result_blob: extern "C" fn(), 135 | _result_double: extern "C" fn(), 136 | _result_error: extern "C" fn(), 137 | _result_error16: extern "C" fn(), 138 | _result_int: extern "C" fn(), 139 | _result_int64: extern "C" fn(), 140 | _result_null: extern "C" fn(), 141 | _result_text: extern "C" fn(), 142 | _result_text16: extern "C" fn(), 143 | _result_text16be: extern "C" fn(), 144 | _result_text16le: extern "C" fn(), 145 | _result_value: extern "C" fn(), 146 | _rollback_hook: extern "C" fn(), 147 | _set_authorizer: extern "C" fn(), 148 | _set_auxdata: extern "C" fn(), 149 | _xsnprintf: extern "C" fn(), 150 | step: extern "C" fn(stmt: *mut Sqlite3Stmt) -> c_int, 151 | _table_column_metadata: extern "C" fn(), 152 | _thread_cleanup: extern "C" fn(), 153 | _total_changes: extern "C" fn(), 154 | _trace: extern "C" fn(), 155 | _transfer_bindings: extern "C" fn(), 156 | _update_hook: extern "C" fn(), 157 | _user_data: extern "C" fn(), 158 | _value_blob: extern "C" fn(), 159 | _value_bytes: extern "C" fn(), 160 | _value_bytes16: extern "C" fn(), 161 | _value_double: extern "C" fn(), 162 | _value_int: extern "C" fn(), 163 | _value_int64: extern "C" fn(), 164 | _value_numeric_type: extern "C" fn(), 165 | _value_text: extern "C" fn(), 166 | _value_text16: extern "C" fn(), 167 | _value_text16be: extern "C" fn(), 168 | _value_text16le: extern "C" fn(), 169 | _value_type: extern "C" fn(), 170 | _vmprintf: extern "C" fn(), 171 | /* Added ??? */ 172 | _overload_function: extern "C" fn(), 173 | /* Added by 3.3.13 */ 174 | _prepare_v2: extern "C" fn(), 175 | _prepare16_v2: extern "C" fn(), 176 | _clear_bindings: extern "C" fn(), 177 | /* Added by 3.4.1 */ 178 | _create_module_v2: extern "C" fn(), 179 | /* Added by 3.5.0 */ 180 | _bind_zeroblob: extern "C" fn(), 181 | _blob_bytes: extern "C" fn(), 182 | _blob_close: extern "C" fn(), 183 | _blob_open: extern "C" fn(), 184 | _blob_read: extern "C" fn(), 185 | _blob_write: extern "C" fn(), 186 | _create_collation_v2: extern "C" fn(), 187 | _file_control: extern "C" fn(), 188 | _memory_highwater: extern "C" fn(), 189 | _memory_used: extern "C" fn(), 190 | _mutex_alloc: extern "C" fn(), 191 | _mutex_enter: extern "C" fn(), 192 | _mutex_free: extern "C" fn(), 193 | _mutex_leave: extern "C" fn(), 194 | _mutex_try: extern "C" fn(), 195 | _open_v2: extern "C" fn(), 196 | _release_memory: extern "C" fn(), 197 | _result_error_nomem: extern "C" fn(), 198 | _result_error_toobig: extern "C" fn(), 199 | _sleep: extern "C" fn(), 200 | _soft_heap_limit: extern "C" fn(), 201 | _vfs_find: extern "C" fn(), 202 | _vfs_register: extern "C" fn(), 203 | _vfs_unregister: extern "C" fn(), 204 | _xthreadsafe: extern "C" fn(), 205 | _result_zeroblob: extern "C" fn(), 206 | _result_error_code: extern "C" fn(), 207 | _test_control: extern "C" fn(), 208 | _randomness: extern "C" fn(), 209 | _context_db_handle: extern "C" fn(), 210 | _extended_result_codes: extern "C" fn(), 211 | _limit: extern "C" fn(), 212 | _next_stmt: extern "C" fn(), 213 | _sql: extern "C" fn(), 214 | _status: extern "C" fn(), 215 | _backup_finish: extern "C" fn(), 216 | _backup_init: extern "C" fn(), 217 | _backup_pagecount: extern "C" fn(), 218 | _backup_remaining: extern "C" fn(), 219 | _backup_step: extern "C" fn(), 220 | _compileoption_get: extern "C" fn(), 221 | _compileoption_used: extern "C" fn(), 222 | _create_function_v2: extern "C" fn(), 223 | _db_config: extern "C" fn(), 224 | _db_mutex: extern "C" fn(), 225 | _db_status: extern "C" fn(), 226 | _extended_errcode: extern "C" fn(), 227 | _log: extern "C" fn(), 228 | _soft_heap_limit64: extern "C" fn(), 229 | _sourceid: extern "C" fn(), 230 | _stmt_status: extern "C" fn(), 231 | _strnicmp: extern "C" fn(), 232 | _unlock_notify: extern "C" fn(), 233 | _wal_autocheckpoint: extern "C" fn(), 234 | _wal_checkpoint: extern "C" fn(), 235 | _wal_hook: extern "C" fn(), 236 | _blob_reopen: extern "C" fn(), 237 | _vtab_config: extern "C" fn(), 238 | _vtab_on_conflict: extern "C" fn(), 239 | /* Version 3.7.16 and later */ 240 | _close_v2: extern "C" fn(), 241 | _db_filename: extern "C" fn(), 242 | _db_readonly: extern "C" fn(), 243 | _db_release_memory: extern "C" fn(), 244 | _errstr: extern "C" fn(), 245 | _stmt_busy: extern "C" fn(), 246 | _stmt_readonly: extern "C" fn(), 247 | _stricmp: extern "C" fn(), 248 | _uri_boolean: extern "C" fn(), 249 | _uri_int64: extern "C" fn(), 250 | _uri_parameter: extern "C" fn(), 251 | _xvsnprintf: extern "C" fn(), 252 | _wal_checkpoint_v2: extern "C" fn(), 253 | /* Version 3.8.7 and later */ 254 | _auto_extension: extern "C" fn(), 255 | _bind_blob64: extern "C" fn(), 256 | _bind_text64: extern "C" fn(), 257 | _cancel_auto_extension: extern "C" fn(), 258 | _load_extension: extern "C" fn(), 259 | _malloc64: extern "C" fn(), 260 | _msize: extern "C" fn(), 261 | _realloc64: extern "C" fn(), 262 | _reset_auto_extension: extern "C" fn(), 263 | _result_blob64: extern "C" fn(), 264 | _result_text64: extern "C" fn(), 265 | _strglob: extern "C" fn(), 266 | /* Version 3.8.11 and later */ 267 | _value_dup: extern "C" fn(), 268 | _value_free: extern "C" fn(), 269 | _result_zeroblob64: extern "C" fn(), 270 | _bind_zeroblob64: extern "C" fn(), 271 | /* Version 3.9.0 and later */ 272 | _value_subtype: extern "C" fn(), 273 | _result_subtype: extern "C" fn(), 274 | /* Version 3.10.0 and later */ 275 | _status64: extern "C" fn(), 276 | _strlike: extern "C" fn(), 277 | _db_cacheflush: extern "C" fn(), 278 | /* Version 3.12.0 and later */ 279 | _system_errno: extern "C" fn(), 280 | /* Version 3.14.0 and later */ 281 | _trace_v2: extern "C" fn(), 282 | _expanded_sql: extern "C" fn(), 283 | /* Version 3.18.0 and later */ 284 | _set_last_insert_rowid: extern "C" fn(), 285 | /* Version 3.20.0 and later */ 286 | _prepare_v3: extern "C" fn(), 287 | _prepare16_v3: extern "C" fn(), 288 | bind_pointer: extern "C" fn( 289 | stmt: *mut Sqlite3Stmt, 290 | index: c_int, 291 | ptr: *mut *mut FTS5API, 292 | name: *const c_uchar, 293 | cb: *mut c_void, 294 | ) -> c_int, 295 | } 296 | 297 | #[no_mangle] 298 | pub extern "C" fn lindera_fts5_tokenizer_init( 299 | db: *mut Sqlite3, 300 | _pz_err_msg: *mut *mut c_uchar, 301 | p_api: *const c_void, 302 | ) -> c_int { 303 | std::panic::catch_unwind(|| match lindera_fts_tokenizer_internal_init(db, p_api) { 304 | Ok(_) => SQLITE_OK, 305 | Err(code) => code, 306 | }) 307 | .unwrap_or(SQLITE_INTERNAL) 308 | } 309 | 310 | fn lindera_fts_tokenizer_internal_init( 311 | db: *mut Sqlite3, 312 | p_api: *const c_void, 313 | ) -> Result<(), c_int> { 314 | let api = unsafe { (p_api as *const Sqlite3APIRoutines).as_ref() }.ok_or(SQLITE_INTERNAL)?; 315 | 316 | if (api.libversion_number)() < 302000 { 317 | return Err(SQLITE_MISUSE); 318 | } 319 | 320 | let mut stmt = null_mut::(); 321 | let rc = (api.prepare)( 322 | db, 323 | c"SELECT fts5(?1)".as_ptr() as *const u8, 324 | -1, 325 | &mut stmt, 326 | null_mut(), 327 | ); 328 | 329 | if rc != SQLITE_OK { 330 | return Err(rc); 331 | } 332 | 333 | let mut p_fts5_api = null_mut::(); 334 | let rc = (api.bind_pointer)( 335 | stmt, 336 | 1, 337 | &mut p_fts5_api, 338 | c"fts5_api_ptr".as_ptr() as *const u8, 339 | null_mut(), 340 | ); 341 | if rc != SQLITE_OK { 342 | (api.finalize)(stmt); 343 | return Err(rc); 344 | } 345 | 346 | // Intentionally ignore return value, sqlite3 returns SQLITE_ROW 347 | (api.step)(stmt); 348 | 349 | let rc = (api.finalize)(stmt); 350 | if rc != SQLITE_OK { 351 | return Err(rc); 352 | } 353 | 354 | let fts5_api = unsafe { p_fts5_api.as_ref() }.ok_or(SQLITE_INTERNAL)?; 355 | 356 | if fts5_api.i_version != FTS5_API_VERSION { 357 | return Err(SQLITE_MISUSE); 358 | } 359 | 360 | // Add custom tokenizer 361 | let mut tokenizer = Fts5TokenizerApi { 362 | x_create: fts5_create_lindera_tokenizer, 363 | x_delete: fts5_delete_lindera_tokenizer, 364 | x_tokenize: lindera_fts5_tokenize, 365 | }; 366 | 367 | (fts5_api.x_create_tokenizer)( 368 | fts5_api, 369 | c"lindera_tokenizer".as_ptr() as *const u8, 370 | null_mut(), 371 | &mut tokenizer, 372 | fts5_destroy_icu_module, 373 | ); 374 | 375 | Ok(()) 376 | } 377 | 378 | #[no_mangle] 379 | pub extern "C" fn fts5_create_lindera_tokenizer( 380 | _p_context: *mut c_void, 381 | _az_arg: *const *const c_uchar, 382 | _n_arg: c_int, 383 | fts5_tokenizer: *mut *mut Fts5Tokenizer, 384 | ) -> c_int { 385 | let tokenizer = match load_tokenizer() { 386 | Ok(tokenizer) => Box::new(Fts5Tokenizer { tokenizer }), 387 | Err(_) => return SQLITE_INTERNAL, 388 | }; 389 | unsafe { 390 | *fts5_tokenizer = Box::into_raw(tokenizer); 391 | } 392 | 393 | SQLITE_OK 394 | } 395 | 396 | #[no_mangle] 397 | pub extern "C" fn fts5_delete_lindera_tokenizer(fts5_tokenizer: *mut Fts5Tokenizer) { 398 | let tokenizer = unsafe { Box::from_raw(fts5_tokenizer) }; 399 | drop(tokenizer); 400 | } 401 | 402 | #[no_mangle] 403 | pub extern "C" fn fts5_destroy_icu_module(_module: *mut c_void) { 404 | // no-op 405 | } 406 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | extern crate alloc; 2 | 3 | mod common; 4 | #[cfg(feature = "extension")] 5 | mod extension; 6 | 7 | use libc::{c_char, c_int, c_uchar, c_void}; 8 | 9 | use lindera::tokenizer::{Tokenizer, TokenizerBuilder}; 10 | 11 | pub use crate::common::*; 12 | 13 | pub fn load_tokenizer() -> Result { 14 | let builder = TokenizerBuilder::new().map_err(|e| { 15 | eprintln!("Failed to create tokenizer builder: {}", e); 16 | SQLITE_INTERNAL 17 | })?; 18 | let tokenizer = builder.build().map_err(|e| { 19 | eprintln!("Failed to create tokenizer: {}", e); 20 | SQLITE_INTERNAL 21 | })?; 22 | 23 | Ok(tokenizer) 24 | } 25 | 26 | #[no_mangle] 27 | pub extern "C" fn lindera_fts5_tokenize( 28 | tokenizer: *mut Fts5Tokenizer, 29 | p_ctx: *mut c_void, 30 | _flags: c_int, 31 | p_text: *const c_char, 32 | n_text: c_int, 33 | x_token: TokenFunction, 34 | ) -> c_int { 35 | std::panic::catch_unwind(std::panic::AssertUnwindSafe( 36 | || match lindera_fts5_tokenize_internal(tokenizer, p_ctx, p_text, n_text, x_token) { 37 | Ok(()) => SQLITE_OK, 38 | Err(code) => code, 39 | }, 40 | )) 41 | .unwrap_or(SQLITE_INTERNAL) 42 | } 43 | 44 | fn lindera_fts5_tokenize_internal( 45 | tokenizer: *mut Fts5Tokenizer, 46 | p_ctx: *mut c_void, 47 | p_text: *const c_char, 48 | n_text: c_int, 49 | x_token: TokenFunction, 50 | ) -> Result<(), c_int> { 51 | let slice = unsafe { core::slice::from_raw_parts(p_text as *const c_uchar, n_text as usize) }; 52 | 53 | // Map errors to SQLITE_OK because failing here means that the database 54 | // wouldn't accessible. 55 | let input = core::str::from_utf8(slice).map_err(|_| SQLITE_OK)?; 56 | 57 | match unsafe { (*tokenizer).tokenizer.tokenize(input) } { 58 | Ok(tokens) => { 59 | for token in tokens { 60 | let rc = x_token( 61 | p_ctx, 62 | 0, 63 | token.text.as_bytes().as_ptr() as *const c_char, 64 | token.text.len() as c_int, 65 | token.byte_start as c_int, 66 | token.byte_end as c_int, 67 | ); 68 | if rc != SQLITE_OK { 69 | return Err(rc); 70 | } 71 | } 72 | } 73 | Err(_) => { 74 | return Err(SQLITE_INTERNAL); 75 | } 76 | } 77 | 78 | Ok(()) 79 | } 80 | 81 | #[cfg(test)] 82 | mod tests { 83 | use super::*; 84 | 85 | extern "C" fn token_callback( 86 | ctx: *mut c_void, 87 | flags: c_int, 88 | token: *const c_char, 89 | token_len: c_int, 90 | start: c_int, 91 | end: c_int, 92 | ) -> c_int { 93 | assert_eq!(flags, 0); 94 | 95 | let tokens_ptr = ctx as *mut _ as *mut Vec<(String, c_int, c_int)>; 96 | let tokens = unsafe { tokens_ptr.as_mut() }.expect("tokens pointer"); 97 | let slice = 98 | unsafe { core::slice::from_raw_parts(token as *const c_uchar, token_len as usize) }; 99 | let token = String::from_utf8(slice.to_vec()).expect("Expected utf-8 token"); 100 | 101 | tokens.push((token, start, end)); 102 | 103 | return SQLITE_OK; 104 | } 105 | 106 | #[test] 107 | fn it_emits_segments() { 108 | let input = "Ｌｉｎｄｅｒａは形態素解析ｴﾝｼﾞﾝです。ユーザー辞書も利用可能です。"; 109 | let mut tokens: Vec<(String, c_int, c_int)> = vec![]; 110 | 111 | let mut tokenizer = Fts5Tokenizer { 112 | tokenizer: load_tokenizer().unwrap(), 113 | }; 114 | lindera_fts5_tokenize_internal( 115 | &mut tokenizer, 116 | &mut tokens as *mut _ as *mut c_void, 117 | input.as_bytes().as_ptr() as *const c_char, 118 | input.len() as i32, 119 | token_callback, 120 | ) 121 | .expect("tokenize internal should not fail"); 122 | 123 | assert_eq!( 124 | tokens, 125 | [ 126 | ("Lindera", 0, 21), 127 | ("形態素", 24, 33), 128 | ("解析", 33, 39), 129 | ("エンジン", 39, 54), 130 | ("ユーザ", 63, 75), 131 | ("辞書", 75, 81), 132 | ("利用", 84, 90), 133 | ("可能", 90, 96) 134 | ] 135 | .map(|(s, start, end)| (s.to_owned(), start, end)) 136 | ); 137 | } 138 | 139 | #[test] 140 | fn it_ignores_invalid_utf8() { 141 | let input = b"\xc3\x28"; 142 | let mut tokens: Vec<(String, c_int, c_int)> = vec![]; 143 | 144 | let mut tokenizer = Fts5Tokenizer { 145 | tokenizer: load_tokenizer().unwrap(), 146 | }; 147 | assert_eq!( 148 | lindera_fts5_tokenize_internal( 149 | &mut tokenizer, 150 | &mut tokens as *mut _ as *mut c_void, 151 | input.as_ptr() as *const c_char, 152 | input.len() as i32, 153 | token_callback, 154 | ) 155 | .expect_err("tokenize internal should not fail"), 156 | SQLITE_OK 157 | ); 158 | 159 | assert_eq!(tokens, []); 160 | } 161 | } 162 | --------------------------------------------------------------------------------