hashirama/gd-tools
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

begin

Browse source
This commit is contained in:
千住柱間 2024-02-04 14:24:04 -04:00
parent bd4ab83ce2
commit d02eef1687
94 changed files with 1295912 additions and 226 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
BUILDING.md Normal file
View file

@ -0,0 +1,60 @@
# Building with CMake
## Build
This project doesn't require any special command-line flags to build to keep
things simple.
Here are the steps for building in release mode with a single-configuration
generator, like the Unix Makefiles one:
```sh
cmake -S . -B build -D CMAKE_BUILD_TYPE=Release
cmake --build build
```
Here are the steps for building in release mode with a multi-configuration
generator, like the Visual Studio ones:
```sh
cmake -S . -B build
cmake --build build --config Release
```
### Building with MSVC
Note that MSVC by default is not standards compliant and you need to pass some
flags to make it behave properly. See the `flags-windows` preset in the
[CMakePresets.json](CMakePresets.json) file for the flags and with what
variable to provide them to CMake during configuration.
### Building on Apple Silicon
CMake supports building on Apple Silicon properly since 3.20.1. Make sure you
have the [latest version][1] installed.
## Install
This project doesn't require any special command-line flags to install to keep
things simple. As a prerequisite, the project has to be built with the above
commands already.
The below commands require at least CMake 3.15 to run, because that is the
version in which [Install a Project][2] was added.
Here is the command for installing the release mode artifacts with a
single-configuration generator, like the Unix Makefiles one:
```sh
cmake --install build
```
Here is the command for installing the release mode artifacts with a
multi-configuration generator, like the Visual Studio ones:
```sh
cmake --install build --config Release
```
[1]: https://cmake.org/download/
[2]: https://cmake.org/cmake/help/latest/manual/cmake.1.html#install-a-project

74
CMakeLists.txt Normal file
View file

@ -0,0 +1,74 @@
cmake_minimum_required(VERSION 3.14)
include(cmake/prelude.cmake)
project(
gd-tools
VERSION 1.4
DESCRIPTION "A set of helpful programs to enhance goldendict for immersion learning."
HOMEPAGE_URL "https://github.com/Ajatt-Tools/gd-tools"
LANGUAGES CXX
)
include(cmake/project-is-top-level.cmake)
include(cmake/variables.cmake)
set(CMAKE_CXX_STANDARD 23)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_CXX_EXTENSIONS OFF)
# ---- Download Dependencies ----
include(FetchContent)
FetchContent_Declare(cpr GIT_REPOSITORY https://github.com/libcpr/cpr.git
GIT_TAG 3b15fa82ea74739b574d705fea44959b58142eb8) # Replace with your desired git commit from: https://github.com/libcpr/cpr/releases
FetchContent_MakeAvailable(cpr)
#FetchContent_Declare(fmt
# GIT_REPOSITORY https://github.com/fmtlib/fmt.git
# GIT_TAG master
#)
#FetchContent_MakeAvailable(fmt)
FetchContent_Declare(json URL https://github.com/nlohmann/json/releases/download/v3.11.3/json.tar.xz)
FetchContent_MakeAvailable(json)
# ---- Find Local Libs
#find_package(marisa REQUIRED)
#find_package(rdricpp REQUIRED)
add_subdirectory(rdricpp)
# ---- Declare executable ----
set(SOURCES src/anki_search.cpp src/echo.cpp src/massif.cpp src/images.cpp src/marisa.cpp src/util.cpp src/kana_conv.cpp)
set(HEADERS src/anki_search.h src/echo.h src/massif.h src/images.h src/marisa.h src/util.h src/kana_conv.h)
add_executable(gd-tools_exe src/main.cpp ${SOURCES} ${HEADERS})
add_executable(gd-tools::exe ALIAS gd-tools_exe)
set_property(TARGET gd-tools_exe PROPERTY OUTPUT_NAME gd-tools)
target_compile_features(gd-tools_exe PRIVATE cxx_std_23)
target_link_libraries(gd-tools_exe PRIVATE -lasan -lubsan cpr::cpr nlohmann_json::nlohmann_json -lmarisa rdricpp)
# ---- Install rules ----
if(NOT CMAKE_SKIP_INSTALL_RULES)
include(cmake/install-rules.cmake)
endif()
# ---- Developer mode ----
if(NOT gd-tools_DEVELOPER_MODE)
return()
elseif(NOT PROJECT_IS_TOP_LEVEL)
message(
AUTHOR_WARNING
"Developer mode is intended for developers of gd-tools"
)
endif()
include(cmake/dev-mode.cmake)

154
CMakePresets.json Normal file
View file

@ -0,0 +1,154 @@
{
"version": 2,
"cmakeMinimumRequired": {
"major": 3,
"minor": 14,
"patch": 0
},
"configurePresets": [
{
"name": "cmake-pedantic",
"hidden": true,
"warnings": {
"dev": true,
"deprecated": true,
"uninitialized": true,
"unusedCli": true,
"systemVars": false
},
"errors": {
"dev": true,
"deprecated": true
}
},
{
"name": "dev-mode",
"hidden": true,
"inherits": "cmake-pedantic",
"cacheVariables": {
"gd-tools_DEVELOPER_MODE": "ON"
}
},
{
"name": "cppcheck",
"hidden": true,
"cacheVariables": {
"CMAKE_CXX_CPPCHECK": "cppcheck;--inline-suppr"
}
},
{
"name": "clang-tidy",
"hidden": true,
"cacheVariables": {
"CMAKE_CXX_CLANG_TIDY": "clang-tidy;--header-filter=^${sourceDir}/"
}
},
{
"name": "ci-std",
"description": "This preset makes sure the project actually builds with at least the specified standard",
"hidden": true,
"cacheVariables": {
"CMAKE_CXX_EXTENSIONS": "OFF",
"CMAKE_CXX_STANDARD": "20",
"CMAKE_CXX_STANDARD_REQUIRED": "ON"
}
},
{
"name": "flags-gcc-clang",
"description": "These flags are supported by both GCC and Clang",
"hidden": true,
"cacheVariables": {
"CMAKE_CXX_FLAGS": "-U_FORTIFY_SOURCE -D_FORTIFY_SOURCE=3 -D_GLIBCXX_ASSERTIONS=1 -fstack-protector-strong -fcf-protection=full -fstack-clash-protection -Wall -Wextra -Wpedantic -Wconversion -Wsign-conversion -Wcast-qual -Wformat=2 -Wundef -Werror=float-equal -Wshadow -Wcast-align -Wunused -Wnull-dereference -Wdouble-promotion -Wimplicit-fallthrough -Wextra-semi -Woverloaded-virtual -Wnon-virtual-dtor -Wold-style-cast",
"CMAKE_EXE_LINKER_FLAGS": "-Wl,--allow-shlib-undefined,--as-needed,-z,noexecstack,-z,relro,-z,now,-z,nodlopen",
"CMAKE_SHARED_LINKER_FLAGS": "-Wl,--allow-shlib-undefined,--as-needed,-z,noexecstack,-z,relro,-z,now,-z,nodlopen"
}
},
{
"name": "flags-appleclang",
"hidden": true,
"cacheVariables": {
"CMAKE_CXX_FLAGS": "-fstack-protector-strong -Wall -Wextra -Wpedantic -Wconversion -Wsign-conversion -Wcast-qual -Wformat=2 -Wundef -Werror=float-equal -Wshadow -Wcast-align -Wunused -Wnull-dereference -Wdouble-promotion -Wimplicit-fallthrough -Wextra-semi -Woverloaded-virtual -Wnon-virtual-dtor -Wold-style-cast"
}
},
{
"name": "flags-msvc",
"description": "Note that all the flags after /W4 are required for MSVC to conform to the language standard",
"hidden": true,
"cacheVariables": {
"CMAKE_CXX_FLAGS": "/sdl /guard:cf /utf-8 /diagnostics:caret /w14165 /w44242 /w44254 /w44263 /w34265 /w34287 /w44296 /w44365 /w44388 /w44464 /w14545 /w14546 /w14547 /w14549 /w14555 /w34619 /w34640 /w24826 /w14905 /w14906 /w14928 /w45038 /W4 /permissive- /volatile:iso /Zc:inline /Zc:preprocessor /Zc:enumTypes /Zc:lambda /Zc:__cplusplus /Zc:externConstexpr /Zc:throwingNew /EHsc",
"CMAKE_EXE_LINKER_FLAGS": "/machine:x64 /guard:cf"
}
},
{
"name": "ci-linux",
"generator": "Unix Makefiles",
"hidden": true,
"inherits": ["flags-gcc-clang", "ci-std"],
"cacheVariables": {
"CMAKE_BUILD_TYPE": "Release"
}
},
{
"name": "ci-darwin",
"generator": "Unix Makefiles",
"hidden": true,
"inherits": ["flags-appleclang", "ci-std"],
"cacheVariables": {
"CMAKE_BUILD_TYPE": "Release"
}
},
{
"name": "ci-win64",
"inherits": ["flags-msvc", "ci-std"],
"generator": "Visual Studio 17 2022",
"architecture": "x64",
"hidden": true
},
{
"name": "coverage-linux",
"binaryDir": "${sourceDir}/build/coverage",
"inherits": "ci-linux",
"hidden": true,
"cacheVariables": {
"ENABLE_COVERAGE": "ON",
"CMAKE_BUILD_TYPE": "Coverage",
"CMAKE_CXX_FLAGS_COVERAGE": "-Og -g --coverage -fkeep-inline-functions -fkeep-static-functions",
"CMAKE_EXE_LINKER_FLAGS_COVERAGE": "--coverage",
"CMAKE_SHARED_LINKER_FLAGS_COVERAGE": "--coverage"
}
},
{
"name": "ci-coverage",
"inherits": ["coverage-linux", "dev-mode"],
"cacheVariables": {
"COVERAGE_HTML_COMMAND": ""
}
},
{
"name": "ci-sanitize",
"binaryDir": "${sourceDir}/build/sanitize",
"inherits": ["ci-linux", "dev-mode"],
"cacheVariables": {
"CMAKE_BUILD_TYPE": "Sanitize",
"CMAKE_CXX_FLAGS_SANITIZE": "-U_FORTIFY_SOURCE -O2 -g -fsanitize=address,undefined -fno-omit-frame-pointer -fno-common"
}
},
{
"name": "ci-build",
"binaryDir": "${sourceDir}/build",
"hidden": true
},
{
"name": "ci-macos",
"inherits": ["ci-build", "ci-darwin", "dev-mode"]
},
{
"name": "ci-ubuntu",
"inherits": ["ci-build", "ci-linux", "clang-tidy", "cppcheck", "dev-mode"]
},
{
"name": "ci-windows",
"inherits": ["ci-build", "ci-win64", "dev-mode"]
}
]
}

77
CMakeUserPresets.json Normal file
View file

@ -0,0 +1,77 @@
{
"version": 2,
"cmakeMinimumRequired": {
"major": 3,
"minor": 14,
"patch": 0
},
"configurePresets": [
{
"name": "dev-common",
"hidden": true,
"inherits": ["dev-mode", "clang-tidy"],
"cacheVariables": {
"BUILD_MCSS_DOCS": "ON"
}
},
{
"name": "dev-linux",
"binaryDir": "${sourceDir}/build/dev-linux",
"inherits": ["dev-common", "ci-linux"],
"cacheVariables": {
"CMAKE_BUILD_TYPE": "Debug",
"CMAKE_EXPORT_COMPILE_COMMANDS": "ON"
}
},
{
"name": "dev-darwin",
"binaryDir": "${sourceDir}/build/dev-darwin",
"inherits": ["dev-common", "ci-darwin"],
"cacheVariables": {
"CMAKE_BUILD_TYPE": "Debug",
"CMAKE_EXPORT_COMPILE_COMMANDS": "ON"
}
},
{
"name": "dev-win64",
"binaryDir": "${sourceDir}/build/dev-win64",
"inherits": ["dev-common", "ci-win64"],
"environment": {
"UseMultiToolTask": "true",
"EnforceProcessCountAcrossBuilds": "true"
}
},
{
"name": "dev",
"binaryDir": "${sourceDir}/build/dev",
"inherits": "dev-linux"
},
{
"name": "dev-coverage",
"binaryDir": "${sourceDir}/build/coverage",
"inherits": ["dev-mode", "coverage-linux"]
}
],
"buildPresets": [
{
"name": "dev",
"configurePreset": "dev",
"configuration": "Debug",
"jobs": 8
}
],
"testPresets": [
{
"name": "dev",
"configurePreset": "dev",
"configuration": "Debug",
"output": {
"outputOnFailure": true
},
"execution": {
"jobs": 8,
"noTestsAction": "error"
}
}
]
}

892
LICENSE
View file

@ -1,232 +1,674 @@
GNU GENERAL PUBLIC LICENSE GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007 Version 3, 29 June 2007
Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/> Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. of this license document, but changing it is not allowed.
Preamble Preamble
The GNU General Public License is a free, copyleft license for software and other kinds of works. The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
The licenses for most software and other practical works are designed
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. your programs, too.
For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
The precise terms and conditions for copying, distribution and modification follow.
To protect your rights, we need to prevent others from denying you
TERMS AND CONDITIONS these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
0. Definitions. you modify it: responsibilities to respect the freedom of others.
“This License” refers to version 3 of the GNU General Public License. For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations. know their rights.
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work. Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
A “covered work” means either the unmodified Program or a work based on the Program. giving you legal permission to copy, distribute and/or modify it.
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. authors of previous versions.
1. Source Code. Some devices are designed to deny users access to install or run
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work. modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. of the GPL, as needed to protect the freedom of users.
The Corresponding Source for a work in source code form is that same work. Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
2. Basic Permissions. software on general-purpose computers, but in those that do, we wish to
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. patents cannot be used to render the program non-free.
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. The precise terms and conditions for copying, distribution and
modification follow.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. TERMS AND CONDITIONS
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 0. Definitions.
4. Conveying Verbatim Copies. "This License" refers to version 3 of the GNU General Public License.
You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
"Copyright" also means copyright-like laws that apply to other kinds of
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. works, such as semiconductor masks.
5. Conveying Modified Source Versions. "The Program" refers to any copyrightable work licensed under this
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
To "modify" a work means to copy from or adapt all or part of the work
b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”. in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. earlier work or a work "based on" the earlier work.
d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A "covered work" means either the unmodified Program or a work based
on the Program.
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
To "propagate" a work means to do anything with it that, without
6. Conveying Non-Source Forms. permission, would make you directly or secondarily liable for
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. distribution (with or without modification), making available to the
public, and in some countries other activities as well.
b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
To "convey" a work means any kind of propagation that enables other
c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
An interactive user interface displays "Appropriate Legal Notices"
e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. menu, a prominent item in the list meets this criterion.
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). 1. Source Code.
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. form of a work.
7. Additional Terms. A "Standard Interface" means an interface that either is an official
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. is widely used among developers working in that language.
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or "Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
d) Limiting the use for publicity purposes of names of licensors or authors of the material; or (if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
The "Corresponding Source" for a work in object code form means all
f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
8. Termination. linked subprograms that the work is specifically designed to require,
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). such as by intimate data communication or control flow between those
subprograms and other parts of the work.
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
The Corresponding Source need not include anything that users
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. can regenerate automatically from other parts of the Corresponding
Source.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
The Corresponding Source for a work in source code form is that
9. Acceptance Not Required for Having Copies. same work.
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
2. Basic Permissions.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
11. Patents. rights of fair use or other equivalent, as provided by copyright law.
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”.
You may make, run and propagate covered works that you do not
A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. your copyrighted material outside their relationship with you.
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. makes it unnecessary.
12. No Surrender of Others' Freedom. 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
No covered work shall be deemed part of an effective technological
13. Use with the GNU Affero General Public License. measure under any applicable law fulfilling obligations under article
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
14. Revised Versions of this License. measures.
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
When you convey a covered work, you waive any legal power to forbid
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. users, your or third parties' legal rights to forbid circumvention of
technological measures.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 4. Conveying Verbatim Copies.
16. Limitation of Liability. You may convey verbatim copies of the Program's source code as you
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
17. Interpretation of Sections 15 and 16. keep intact all notices stating that this License and any
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
END OF TERMS AND CONDITIONS recipients a copy of this License along with the Program.
How to Apply These Terms to Your New Programs You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
5. Conveying Modified Source Versions.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
You may convey a work based on the Program, or the modifications to
gd-tools produce it from the Program, in the form of source code under the
Copyright (C) 2024 hashirama terms of section 4, provided that you also meet all of these conditions:
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
b) The work must carry prominent notices stating that it is
You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>. released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail. Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
gd-tools Copyright (C) 2024 hashirama <program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”. The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>. You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <https://www.gnu.org/philosophy/why-not-lgpl.html>. The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

179
README.md
View file

@ -1,2 +1,179 @@
# gd-tools # GoldenDict tools
A set of helpful programs to enhance goldendict for immersion learning.
## Table of Contents
- [Installation](#installation)
- [gd-marisa](#gd-marisa)
- [gd-mecab](#gd-mecab)
- [gd-images](#gd-images)
- [gd-strokeorder](#gd-strokeorder)
- [gd-handwritten](#gd-handwritten)
- [gd-massif](#gd-massif)
- [gd-ankisearch](#gd-ankisearch)
## Installation
First, [install goldendict-ng](https://tatsumoto-ren.github.io/blog/setting-up-goldendict.html).
### Pacman-based distros
Install [gd-tools-git](https://aur.archlinux.org/packages/gd-tools-git) from the AUR.
### Other distros
If you want to package `gd-tools` for your distro and know how to do it,
please create a pull request.
<details>
<summary>Manual installation</summary>
1) To build the `gd-tools` you need to install `xmake` and `gcc` (13.1 and newer).
2) Run `./quickinstall.sh`.
**Note:** You can run `./quickinstall.sh --local`
to install the program locally (to `~/.local/` ).
</details>
## Setup
Open GoldenDict, press "Edit" > "Dictionaries" > "Programs" and add the installed executables.
Set type to `html`.
Command Line: `<name of script> --word %GDWORD% --sentence %GDSEARCH%`.
Optionally add arguments, such as: `gd-mecab --word %GDWORD% --sentence %GDSEARCH% --user-dict <path> --font-size 20px`.
These programs are treated as dictionaries and you can add them under "Dictionaries" or "Groups".
## gd-marisa
This script outputs the sentence with clickable characters
and searches for the longest available dictionary entry
(from a predefined list) beginning at that character.
For deinflection it currently relies on [rdricpp](https://github.com/Ajatt-Tools/rdricpp).
It also provides links of available entries of smaller substrings.
![demo](https://user-images.githubusercontent.com/50422430/229341045-96283fc9-8ecb-49bb-a011-abd2d3e4e43e.gif)
**Usage**
```
gd-marisa --word %GDWORD% --sentence %GDSEARCH% --path-to-dic [PATH_TO_DIC_FILE]
```
The path to the `.dic` is an optional argument and defaults to `/usr/share/gd-tools/marisa_words.dic`
**Dependencies**
[marisa-trie](https://github.com/s-yata/marisa-trie).
The official Arch Linux package is called [marisa](https://archlinux.org/packages/community/x86_64/marisa/),
but it's already a dependency of goldendict.
**Building an own index from a set of words**
If you would like to make changes to found words,
you can also create an own index from a newline-separated list of words (here called `keyset.txt`):
```
marisa-build < keyset.txt > keyset.dic
```
More information at https://www.s-yata.jp/marisa-trie/docs/readme.en.html
## gd-mecab
This script passes a sentence through mecab in order to make every part of the sentence clickable.
https://user-images.githubusercontent.com/50422430/226139459-0c8bcf0e-e68f-491e-8171-bae3f50a7ae1.mp4
**Dependencies**
This script requires [MeCab](https://taku910.github.io/mecab/) and the IPA dictionary to be installed.
If you are on an Arch Linux system you can simply install the AUR package `mecab-ipa` to obtain both.
**Command format**
Add this script to GoldenDict under "Dictionaries" > "Programs" (format HTML), like this:
```
gd-mecab --word %GDWORD% --sentence %GDSEARCH%
```
**Optional arguments**
* `--font-size SIZE` the font size to be used, e.g. `30px`.
* `--user-dict FILE` full path to the user_dic.dic file. This is done automatically if you install via make.
## gd-images
This script shows the top 5 pictures from Bing images for the given search string.
![image](https://user-images.githubusercontent.com/50422430/224940994-eb3e1be6-9cd8-4776-88cf-850c78648e81.png)
## gd-strokeorder
This script shows the search string in the `KanjiStrokeOrders` font.
![screenshot](https://user-images.githubusercontent.com/69171671/224840590-b740a1b6-8526-49ed-b4cd-efe03689a132.png)
Font source: https://www.nihilist.org.uk/
**Arguments**:
* `--max-len` `5` maximum size of the input string.
* `--font-size` `10rem` font size. It has to be large in order to see the stroke numbers.
**How to call**:
```
gd-strokeorder --word %GDWORD%
```
## gd-handwritten
This script displays the handwritten form of each character
![screenshot](https://user-images.githubusercontent.com/53496273/254959907-4aa7d72d-2d58-4bd3-8b3a-c2f6f3186834.png)
Font source: [ArmedLemon](https://github.com/Ajatt-Tools/gd-tools/blob/main/res/ArmedLemon.ttf).
**How to call**:
```
gd-handwritten --word %GDWORD%
```
## gd-massif
This script shows example sentences from https://massif.la/
![image](https://user-images.githubusercontent.com/50422430/226018360-e46605f0-2fb4-481c-801e-73aca84fae70.png)
## gd-ankisearch
This script searches Anki cards in your collection that contain %GDWORD%.
![screenshot](https://github.com/Ajatt-Tools/gd-tools/assets/69171671/45a6b3a1-97de-439c-8f17-bd6f81d81d73)
**Arguments:**
* `--field-name` `NAME` optional field to limit search to.
* `--deck-name` `NAME` optional deck to limit search to.
* `--show-fields` `VocabKanji,SentKanji` optional comma-separated list of fields to show.
**Example invocation:**
```
gd-ankisearch --field-name VocabKanji --show-fields VocabKanji,SentKanji,Image,SentAudio --word %GDWORD%
```
## gd-mandarin
This script passes a sentence through mecab in order to make every part of the sentence clickable.
It also automatically converts the sentence to traditional characters.
![image](https://github.com/KonstantinDjairo/gd-tools/assets/53496273/20921976-9221-416e-820a-b6bb22db906b)
To use `gd-mandarin`,
you need to install `gd-tools` by running `./quickinstall.sh --mandarin`.

33
cmake/coverage.cmake Normal file
View file

@ -0,0 +1,33 @@
# ---- Variables ----
# We use variables separate from what CTest uses, because those have
# customization issues
set(
COVERAGE_TRACE_COMMAND
lcov -c -q
-o "${PROJECT_BINARY_DIR}/coverage.info"
-d "${PROJECT_BINARY_DIR}"
--include "${PROJECT_SOURCE_DIR}/*"
CACHE STRING
"; separated command to generate a trace for the 'coverage' target"
)
set(
COVERAGE_HTML_COMMAND
genhtml --legend -f -q
"${PROJECT_BINARY_DIR}/coverage.info"
-p "${PROJECT_SOURCE_DIR}"
-o "${PROJECT_BINARY_DIR}/coverage_html"
CACHE STRING
"; separated command to generate an HTML report for the 'coverage' target"
)
# ---- Coverage target ----
add_custom_target(
coverage
COMMAND ${COVERAGE_TRACE_COMMAND}
COMMAND ${COVERAGE_HTML_COMMAND}
COMMENT "Generating coverage report"
VERBATIM
)

39
cmake/dev-mode.cmake Normal file
View file

@ -0,0 +1,39 @@
# Testing library
FetchContent_Declare(
catch
GIT_REPOSITORY https://github.com/catchorg/Catch2.git
GIT_TAG v3.5.2)
FetchContent_MakeAvailable(catch)
# Adds Catch2::Catch2
include(cmake/folders.cmake)
include(CTest)
include(Catch)
if(BUILD_TESTING)
add_subdirectory(test)
endif()
add_executable(tests tests_main.cpp)
target_compile_features(tests PRIVATE cxx_std_23)
# Should be linked to the rdricpp library, as well as the Catch2 testing library
target_link_libraries(tests PRIVATE cpr::cpr fmt::fmt nlohmann_json::nlohmann_json marisa rdricpp Catch2::Catch2WithMain)
catch_discover_tests(tests)
add_test(NAME Test COMMAND tests)
option(BUILD_MCSS_DOCS "Build documentation using Doxygen and m.css" OFF)
if(BUILD_MCSS_DOCS)
include(cmake/docs.cmake)
endif()
option(ENABLE_COVERAGE "Enable coverage support separate from CTest's" OFF)
if(ENABLE_COVERAGE)
include(cmake/coverage.cmake)
endif()
include(cmake/lint-targets.cmake)
include(cmake/spell-targets.cmake)
add_folders(Project)

112
cmake/docs-ci.cmake Normal file
View file

@ -0,0 +1,112 @@
cmake_minimum_required(VERSION 3.14)
foreach(var IN ITEMS PROJECT_BINARY_DIR PROJECT_SOURCE_DIR)
if(NOT DEFINED "${var}")
message(FATAL_ERROR "${var} must be defined")
endif()
endforeach()
set(bin "${PROJECT_BINARY_DIR}")
set(src "${PROJECT_SOURCE_DIR}")
# ---- Dependencies ----
set(mcss_SOURCE_DIR "${bin}/docs/.ci")
if(NOT IS_DIRECTORY "${mcss_SOURCE_DIR}")
file(MAKE_DIRECTORY "${mcss_SOURCE_DIR}")
file(
DOWNLOAD
https://github.com/friendlyanon/m.css/releases/download/release-1/mcss.zip
"${mcss_SOURCE_DIR}/mcss.zip"
STATUS status
EXPECTED_MD5 00cd2757ebafb9bcba7f5d399b3bec7f
)
if(NOT status MATCHES "^0;")
message(FATAL_ERROR "Download failed with ${status}")
endif()
execute_process(
COMMAND "${CMAKE_COMMAND}" -E tar xf mcss.zip
WORKING_DIRECTORY "${mcss_SOURCE_DIR}"
RESULT_VARIABLE result
)
if(NOT result EQUAL "0")
message(FATAL_ERROR "Extraction failed with ${result}")
endif()
file(REMOVE "${mcss_SOURCE_DIR}/mcss.zip")
endif()
find_program(Python3_EXECUTABLE NAMES python3 python)
if(NOT Python3_EXECUTABLE)
message(FATAL_ERROR "Python executable was not found")
endif()
# ---- Process project() call in CMakeLists.txt ----
file(READ "${src}/CMakeLists.txt" content)
string(FIND "${content}" "project(" index)
if(index EQUAL "-1")
message(FATAL_ERROR "Could not find \"project(\"")
endif()
string(SUBSTRING "${content}" "${index}" -1 content)
string(FIND "${content}" "\n)\n" index)
if(index EQUAL "-1")
message(FATAL_ERROR "Could not find \"\\n)\\n\"")
endif()
string(SUBSTRING "${content}" 0 "${index}" content)
file(WRITE "${bin}/docs-ci.project.cmake" "docs_${content}\n)\n")
macro(list_pop_front list out)
list(GET "${list}" 0 "${out}")
list(REMOVE_AT "${list}" 0)
endmacro()
function(docs_project name)
cmake_parse_arguments(PARSE_ARGV 1 "" "" "VERSION;DESCRIPTION;HOMEPAGE_URL" LANGUAGES)
set(PROJECT_NAME "${name}" PARENT_SCOPE)
if(DEFINED _VERSION)
set(PROJECT_VERSION "${_VERSION}" PARENT_SCOPE)
string(REGEX MATCH "^[0-9]+(\\.[0-9]+)*" versions "${_VERSION}")
string(REPLACE . ";" versions "${versions}")
set(suffixes MAJOR MINOR PATCH TWEAK)
while(NOT versions STREQUAL "" AND NOT suffixes STREQUAL "")
list_pop_front(versions version)
list_pop_front(suffixes suffix)
set("PROJECT_VERSION_${suffix}" "${version}" PARENT_SCOPE)
endwhile()
endif()
if(DEFINED _DESCRIPTION)
set(PROJECT_DESCRIPTION "${_DESCRIPTION}" PARENT_SCOPE)
endif()
if(DEFINED _HOMEPAGE_URL)
set(PROJECT_HOMEPAGE_URL "${_HOMEPAGE_URL}" PARENT_SCOPE)
endif()
endfunction()
include("${bin}/docs-ci.project.cmake")
# ---- Generate docs ----
if(NOT DEFINED DOXYGEN_OUTPUT_DIRECTORY)
set(DOXYGEN_OUTPUT_DIRECTORY "${bin}/docs")
endif()
set(out "${DOXYGEN_OUTPUT_DIRECTORY}")
foreach(file IN ITEMS Doxyfile conf.py)
configure_file("${src}/docs/${file}.in" "${bin}/docs/${file}" @ONLY)
endforeach()
set(mcss_script "${mcss_SOURCE_DIR}/documentation/doxygen.py")
set(config "${bin}/docs/conf.py")
file(REMOVE_RECURSE "${out}/html" "${out}/xml")
execute_process(
COMMAND "${Python3_EXECUTABLE}" "${mcss_script}" "${config}"
WORKING_DIRECTORY "${bin}/docs"
RESULT_VARIABLE result
)
if(NOT result EQUAL "0")
message(FATAL_ERROR "m.css returned with ${result}")
endif()

46
cmake/docs.cmake Normal file
View file

@ -0,0 +1,46 @@
# ---- Dependencies ----
set(extract_timestamps "")
if(CMAKE_VERSION VERSION_GREATER_EQUAL "3.24")
set(extract_timestamps DOWNLOAD_EXTRACT_TIMESTAMP YES)
endif()
include(FetchContent)
FetchContent_Declare(
mcss URL
https://github.com/friendlyanon/m.css/releases/download/release-1/mcss.zip
URL_MD5 00cd2757ebafb9bcba7f5d399b3bec7f
SOURCE_DIR "${PROJECT_BINARY_DIR}/mcss"
UPDATE_DISCONNECTED YES
${extract_timestamps}
)
FetchContent_MakeAvailable(mcss)
find_package(Python3 3.6 REQUIRED)
# ---- Declare documentation target ----
set(
DOXYGEN_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/docs"
CACHE PATH "Path for the generated Doxygen documentation"
)
set(working_dir "${PROJECT_BINARY_DIR}/docs")
foreach(file IN ITEMS Doxyfile conf.py)
configure_file("docs/${file}.in" "${working_dir}/${file}" @ONLY)
endforeach()
set(mcss_script "${mcss_SOURCE_DIR}/documentation/doxygen.py")
set(config "${working_dir}/conf.py")
add_custom_target(
docs
COMMAND "${CMAKE_COMMAND}" -E remove_directory
"${DOXYGEN_OUTPUT_DIRECTORY}/html"
"${DOXYGEN_OUTPUT_DIRECTORY}/xml"
COMMAND "${Python3_EXECUTABLE}" "${mcss_script}" "${config}"
COMMENT "Building documentation using Doxygen and m.css"
WORKING_DIRECTORY "${working_dir}"
VERBATIM
)

21
cmake/folders.cmake Normal file
View file

@ -0,0 +1,21 @@
set_property(GLOBAL PROPERTY USE_FOLDERS YES)
# Call this function at the end of a directory scope to assign a folder to
# targets created in that directory. Utility targets will be assigned to the
# UtilityTargets folder, otherwise to the ${name}Targets folder. If a target
# already has a folder assigned, then that target will be skipped.
function(add_folders name)
get_property(targets DIRECTORY PROPERTY BUILDSYSTEM_TARGETS)
foreach(target IN LISTS targets)
get_property(folder TARGET "${target}" PROPERTY FOLDER)
if(DEFINED folder)
continue()
endif()
set(folder Utility)
get_property(type TARGET "${target}" PROPERTY TYPE)
if(NOT type STREQUAL "UTILITY")
set(folder "${name}")
endif()
set_property(TARGET "${target}" PROPERTY FOLDER "${folder}Targets")
endforeach()
endfunction()

6
cmake/install-rules.cmake Normal file
View file

@ -0,0 +1,6 @@
install(TARGETS gd-tools_exe DESTINATION bin)
install(FILES res/marisa_words.dic res/user_dic.dic DESTINATION share/gd-tools)
if(PROJECT_IS_TOP_LEVEL)
include(CPack)
endif()

33
cmake/lint-targets.cmake Normal file
View file

@ -0,0 +1,33 @@
set(
FORMAT_PATTERNS
src/*.cpp src/*.hpp
include/*.hpp
test/*.cpp test/*.hpp
CACHE STRING
"; separated patterns relative to the project source dir to format"
)
set(FORMAT_COMMAND clang-format CACHE STRING "Formatter to use")
add_custom_target(
format-check
COMMAND "${CMAKE_COMMAND}"
-D "FORMAT_COMMAND=${FORMAT_COMMAND}"
-D "PATTERNS=${FORMAT_PATTERNS}"
-P "${PROJECT_SOURCE_DIR}/cmake/lint.cmake"
WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}"
COMMENT "Linting the code"
VERBATIM
)
add_custom_target(
format-fix
COMMAND "${CMAKE_COMMAND}"
-D "FORMAT_COMMAND=${FORMAT_COMMAND}"
-D "PATTERNS=${FORMAT_PATTERNS}"
-D FIX=YES
-P "${PROJECT_SOURCE_DIR}/cmake/lint.cmake"
WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}"
COMMENT "Fixing the code"
VERBATIM
)

51
cmake/lint.cmake Normal file
View file

@ -0,0 +1,51 @@
cmake_minimum_required(VERSION 3.14)
macro(default name)
if(NOT DEFINED "${name}")
set("${name}" "${ARGN}")
endif()
endmacro()
default(FORMAT_COMMAND clang-format)
default(
PATTERNS
src/*.cpp src/*.hpp
include/*.hpp
test/*.cpp test/*.hpp
)
default(FIX NO)
set(flag --output-replacements-xml)
set(args OUTPUT_VARIABLE output)
if(FIX)
set(flag -i)
set(args "")
endif()
file(GLOB_RECURSE files ${PATTERNS})
set(badly_formatted "")
set(output "")
string(LENGTH "${CMAKE_SOURCE_DIR}/" path_prefix_length)
foreach(file IN LISTS files)
execute_process(
COMMAND "${FORMAT_COMMAND}" --style=file "${flag}" "${file}"
WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
RESULT_VARIABLE result
${args}
)
if(NOT result EQUAL "0")
message(FATAL_ERROR "'${file}': formatter returned with ${result}")
endif()
if(NOT FIX AND output MATCHES "\n<replacement offset")
string(SUBSTRING "${file}" "${path_prefix_length}" -1 relative_file)
list(APPEND badly_formatted "${relative_file}")
endif()
set(output "")
endforeach()
if(NOT badly_formatted STREQUAL "")
list(JOIN badly_formatted "\n" bad_list)
message("The following files are badly formatted:\n\n${bad_list}\n")
message(FATAL_ERROR "Run again with FIX=YES to fix these files.")
endif()

10
cmake/prelude.cmake Normal file
View file

@ -0,0 +1,10 @@
# ---- In-source guard ----
if(CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR)
message(
FATAL_ERROR
"In-source builds are not supported. "
"Please read the BUILDING document before trying to build this project. "
"You may need to delete 'CMakeCache.txt' and 'CMakeFiles/' first."
)
endif()

6
cmake/project-is-top-level.cmake Normal file
View file

@ -0,0 +1,6 @@
# This variable is set by project() in CMake 3.21+
string(
COMPARE EQUAL
"${CMAKE_SOURCE_DIR}" "${PROJECT_SOURCE_DIR}"
PROJECT_IS_TOP_LEVEL
)

22
cmake/spell-targets.cmake Normal file
View file

@ -0,0 +1,22 @@
set(SPELL_COMMAND codespell CACHE STRING "Spell checker to use")
add_custom_target(
spell-check
COMMAND "${CMAKE_COMMAND}"
-D "SPELL_COMMAND=${SPELL_COMMAND}"
-P "${PROJECT_SOURCE_DIR}/cmake/spell.cmake"
WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}"
COMMENT "Checking spelling"
VERBATIM
)
add_custom_target(
spell-fix
COMMAND "${CMAKE_COMMAND}"
-D "SPELL_COMMAND=${SPELL_COMMAND}"
-D FIX=YES
-P "${PROJECT_SOURCE_DIR}/cmake/spell.cmake"
WORKING_DIRECTORY "${PROJECT_SOURCE_DIR}"
COMMENT "Fixing spelling errors"
VERBATIM
)

29
cmake/spell.cmake Normal file
View file

@ -0,0 +1,29 @@
cmake_minimum_required(VERSION 3.14)
macro(default name)
if(NOT DEFINED "${name}")
set("${name}" "${ARGN}")
endif()
endmacro()
default(SPELL_COMMAND codespell)
default(FIX NO)
set(flag "")
if(FIX)
set(flag -w)
endif()
execute_process(
COMMAND "${SPELL_COMMAND}" ${flag}
WORKING_DIRECTORY "${CMAKE_SOURCE_DIR}"
RESULT_VARIABLE result
)
if(result EQUAL "65")
message(FATAL_ERROR "Run again with FIX=YES to fix these errors.")
elseif(result EQUAL "64")
message(FATAL_ERROR "Spell checker printed the usage info. Bad arguments?")
elseif(NOT result EQUAL "0")
message(FATAL_ERROR "Spell checker returned with ${result}")
endif()

28
cmake/variables.cmake Normal file
View file

@ -0,0 +1,28 @@
# ---- Developer mode ----
# Developer mode enables targets and code paths in the CMake scripts that are
# only relevant for the developer(s) of gd-tools
# Targets necessary to build the project must be provided unconditionally, so
# consumers can trivially build and package the project
if(PROJECT_IS_TOP_LEVEL)
option(gd-tools_DEVELOPER_MODE "Enable developer mode" OFF)
endif()
# ---- Warning guard ----
# target_include_directories with the SYSTEM modifier will request the compiler
# to omit warnings from the provided paths, if the compiler supports that
# This is to provide a user experience similar to find_package when
# add_subdirectory or FetchContent is used to consume this project
set(warning_guard "")
if(NOT PROJECT_IS_TOP_LEVEL)
option(
gd-tools_INCLUDES_WITH_SYSTEM
"Use SYSTEM modifier for gd-tools's includes, disabling warnings"
ON
)
mark_as_advanced(gd-tools_INCLUDES_WITH_SYSTEM)
if(gd-tools_INCLUDES_WITH_SYSTEM)
set(warning_guard SYSTEM)
endif()
endif()

32
docs/Doxyfile.in Normal file
View file

@ -0,0 +1,32 @@
# Configuration for Doxygen for use with CMake
# Only options that deviate from the default are included
# To create a new Doxyfile containing all available options, call `doxygen -g`
# Get Project name and version from CMake
PROJECT_NAME = "@PROJECT_NAME@"
PROJECT_NUMBER = "@PROJECT_VERSION@"
# Add sources
INPUT = "@PROJECT_SOURCE_DIR@/README.md" "@PROJECT_SOURCE_DIR@/include" "@PROJECT_SOURCE_DIR@/source" "@PROJECT_SOURCE_DIR@/docs/pages"
EXTRACT_ALL = YES
RECURSIVE = YES
OUTPUT_DIRECTORY = "@DOXYGEN_OUTPUT_DIRECTORY@"
# Use the README as a main page
USE_MDFILE_AS_MAINPAGE = "@PROJECT_SOURCE_DIR@/README.md"
# set relative include paths
FULL_PATH_NAMES = YES
STRIP_FROM_PATH = "@PROJECT_SOURCE_DIR@/include" "@PROJECT_SOURCE_DIR@"
STRIP_FROM_INC_PATH =
# We use m.css to generate the html documentation, so we only need XML output
GENERATE_XML = YES
GENERATE_HTML = NO
GENERATE_LATEX = NO
XML_PROGRAMLISTING = NO
CREATE_SUBDIRS = NO
# Include all directories, files and namespaces in the documentation
# Disable to include only explicitly documented objects
M_SHOW_UNDOCUMENTED = YES

6
docs/conf.py.in Normal file
View file

@ -0,0 +1,6 @@
DOXYFILE = 'Doxyfile'
LINKS_NAVBAR1 = [
(None, 'pages', [(None, 'about')]),
(None, 'namespaces', []),
]

7
docs/pages/about.dox Normal file
View file

@ -0,0 +1,7 @@
/**
* @page about About
* @section about-doxygen Doxygen documentation
* This page is auto generated using
* <a href="https://www.doxygen.nl/">Doxygen</a>, making use of some useful
* <a href="https://www.doxygen.nl/manual/commands.html">special commands</a>.
*/

104
rdricpp/.clang-format Normal file
View file

@ -0,0 +1,104 @@
BasedOnStyle: LLVM
AccessModifierOffset: -2
AlignAfterOpenBracket: BlockIndent
AlignConsecutiveAssignments: false
AlignConsecutiveDeclarations: false
AlignEscapedNewlines: Left
AlignOperands: true
AlignTrailingComments: false
AllowAllParametersOfDeclarationOnNextLine: false
AllowAllArgumentsOnNextLine: false
AllowShortBlocksOnASingleLine: true
AllowShortCaseLabelsOnASingleLine: false
AllowShortFunctionsOnASingleLine: Empty
AllowShortIfStatementsOnASingleLine: false
AllowShortLoopsOnASingleLine: false
AllowShortLambdasOnASingleLine: All
AlwaysBreakAfterDefinitionReturnType: None
AlwaysBreakAfterReturnType: None
AlwaysBreakBeforeMultilineStrings: true
AlwaysBreakTemplateDeclarations: Yes
BinPackArguments: false
BinPackParameters: false
BreakBeforeBraces: Custom
BraceWrapping:
AfterClass: true
AfterControlStatement: false
AfterEnum: false
AfterFunction: true
AfterNamespace: false
AfterObjCDeclaration: false
AfterStruct: true
AfterUnion: false
BeforeCatch: false
BeforeElse: false
IndentBraces: false
SplitEmptyFunction: false
SplitEmptyNamespace: true
SplitEmptyRecord: true
BreakAfterJavaFieldAnnotations: true
BreakBeforeBinaryOperators: NonAssignment
BreakBeforeInheritanceComma: true
BreakBeforeTernaryOperators: true
BreakConstructorInitializers: AfterColon
BreakConstructorInitializersBeforeComma: false
BreakStringLiterals: true
ColumnLimit: 120
CommentPragmas: '^ IWYU pragma:'
CompactNamespaces: false
ConstructorInitializerAllOnOneLineOrOnePerLine: false
ConstructorInitializerIndentWidth: 2
ContinuationIndentWidth: 2
Cpp11BracedListStyle: false
DerivePointerAlignment: false
DisableFormat: false
ExperimentalAutoDetectBinPacking: true
FixNamespaceComments: true
ForEachMacros:
- foreach
- Q_FOREACH
- BOOST_FOREACH
IncludeCategories:
- Priority: 2
Regex: ^"(llvm|llvm-c|clang|clang-c)/
- Priority: 3
Regex: ^(<|"(gtest|gmock|isl|json)/)
- Priority: 1
Regex: .*
IncludeIsMainRegex: (Test)?$
IndentCaseLabels: false
IndentWidth: 2
IndentWrappedFunctionNames: true
JavaScriptQuotes: Leave
JavaScriptWrapImports: true
KeepEmptyLinesAtTheStartOfBlocks: true
Language: Cpp
MacroBlockBegin: ''
MacroBlockEnd: ''
MaxEmptyLinesToKeep: 1
NamespaceIndentation: Inner
ObjCBlockIndentWidth: 7
ObjCSpaceAfterProperty: true
ObjCSpaceBeforeProtocolList: false
PointerAlignment: Left
ReflowComments: true
SortIncludes: true
SortUsingDeclarations: false
SpaceAfterCStyleCast: false
SpaceAfterTemplateKeyword: false
SpaceBeforeAssignmentOperators: true
SpaceBeforeParens: ControlStatements
SpaceInEmptyParentheses: false
SpacesBeforeTrailingComments: 1
SpacesInAngles: false
SpacesInCStyleCastParentheses: false
SpacesInContainerLiterals: true
SpacesInParentheses: false
SpacesInSquareBrackets: false
Standard: c++20
TabWidth: 8
UseTab: Never
SpaceBeforeRangeBasedForLoopColon: false
QualifierAlignment: Right
AllowShortEnumsOnASingleLine: false
InsertTrailingCommas: Wrapped

37
rdricpp/.clang-tidy Normal file
View file

@ -0,0 +1,37 @@
---
Checks: "*,
cppcoreguidelines-*,
modernize-*,
clang-*,
clang-analyzer-*,
readability-*,
-abseil-*,
-altera-*,
-android-*,
-fuchsia-*,
-google-*,
-llvm*,
-zircon-*,
-misc-non-private-member-variables-in-classes,
-modernize-use-trailing-return-type,
-readability-else-after-return,
-readability-static-accessed-through-instance,
-readability-avoid-const-params-in-decls,
-readability-identifier-length,
-cppcoreguidelines-non-private-member-variables-in-classes,
-cppcoreguidelines-pro-bounds-constant-array-index,
-bugprone-easily-swappable-parameters,
-google-readability-todo,
-google-readability-casting
"
WarningsAsErrors: ''
HeaderFilterRegex: ''
FormatStyle: none
CheckOptions:
- key: readability-identifier-length.IgnoredVariableNames
value: 'x|y|z'
- key: readability-identifier-length.IgnoredParameterNames
value: 'x|y|z'
- key: readability-identifier-length.MinimumParameterNameLength
value: '2'

4
rdricpp/.gitignore vendored Normal file
View file

@ -0,0 +1,4 @@
.xmake/
build/
/.cache
.DS_Store

38
rdricpp/CMakeLists.txt Normal file
View file

@ -0,0 +1,38 @@
# Works with 3.14 and tested through 3.28
cmake_minimum_required(VERSION 3.14...3.28)
project(Rdricpp
VERSION 0.2
DESCRIPTION "Rikaitan Deinflector Reference Implementation in C++."
LANGUAGES CXX)
# Only do these if this is the main project
# Testing only available if this is the main program
if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)
set(CMAKE_CXX_EXTENSIONS OFF)
set_property(GLOBAL PROPERTY USE_FOLDERS ON)
include(CTest)
endif()
# FetchContent added in CMake 3.11, downloads during the configure step
# FetchContent_MakeAvailable was added in CMake 3.14; simpler usage
include(FetchContent)
# The compiled library code is here
add_subdirectory(src)
# The executable code is here
add_subdirectory(bin)
# Run tests with make test
if((CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME OR RDRICPP_TESTING)
AND BUILD_TESTING)
add_subdirectory(tests)
endif()

674
rdricpp/LICENSE Normal file
View file

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

2
rdricpp/README.md Normal file
View file

@ -0,0 +1,2 @@
# rdricpp
Rikaitan Deinflector Reference Implementation in C++.

4
rdricpp/bin/CMakeLists.txt Normal file
View file

@ -0,0 +1,4 @@
add_executable(rdricpp-exec main.cpp)
target_compile_features(rdricpp PRIVATE cxx_std_23)
target_link_libraries(rdricpp-exec PRIVATE rdricpp)

31
rdricpp/bin/main.cpp Normal file
View file

@ -0,0 +1,31 @@
/*
* Rikaitan Deinflector Reference Implementation
*
* Copyright (C) 2023 Ajatt-Tools and contributors
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, visit the http://fsf.org website.
*/
#include "rdricpp/ostream.h"
#include "rdricpp/rdricpp.h"
#include <iostream>
#include <ranges>
int main(int const argc, char const* const* const argv)
{
for (auto const idx: std::views::iota(1, argc)) {
std::cout << ajt::rdricpp::deinflect(*std::next(argv, idx));
}
return 0;
}

82
rdricpp/include/rdricpp/ostream.h Normal file
View file

@ -0,0 +1,82 @@
/*
* Rikaitan Deinflector Reference Implementation
*
* Copyright (C) 2023 Ajatt-Tools and contributors
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, visit the http://fsf.org website.
*/
#pragma once
#include "types.h"
#include <array>
#include <iostream>
#include <string_view>
#include <vector>
namespace ajt::rdricpp {
template<typename Stored, size_t Size>
auto& operator<<(std::ostream& os, std::array<Stored, Size> const& array)
{
for (auto const& item: array) {
os << item << ' ';
}
os << '\n';
return os;
}
template<typename Stored>
auto& operator<<(std::ostream& os, std::vector<Stored> const& array)
{
os << "[";
for (auto const& item: array) {
os << item << ", ";
}
os << "]";
return os;
}
inline auto& operator<<(std::ostream& os, Reason const& reason)
{
os << "{ .kana_in=" << reason.kana_in << ", .kana_out=" << reason.kana_out << ", .rules_in=" << reason.rules_in
<< ", .rules_out=" << reason.rules_out << " }\n";
return os;
}
inline auto& operator<<(std::ostream& os, RuleSet const& ruleset)
{
os << "{ .name=\"" << ruleset.name << "\", .rules=" << ruleset.rules << " }\n";
return os;
}
inline auto& operator<<(std::ostream& os, Deinflection const& deinflection)
{
os << "{.term=" << deinflection.term //
<< ", .rules=" << deinflection.rules //
<< ", .reasons=" << deinflection.reasons //
<< "}";
return os;
}
inline auto& operator<<(std::ostream& os, std::vector<Deinflection> const& deinflections)
{
for (auto const& deinflection: deinflections) {
os << deinflection << '\n';
}
os << '\n';
return os;
}
} // namespace ajt::rdricpp

30
rdricpp/include/rdricpp/rdricpp.h Normal file
View file

@ -0,0 +1,30 @@
/*
* Rikaitan Deinflector Reference Implementation
*
* Copyright (C) 2023 Ajatt-Tools and contributors
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, visit the http://fsf.org website.
*/
#pragma once
#include "types.h"
#include <string_view>
#include <vector>
namespace ajt::rdricpp {
auto deinflect(std::string_view const source) -> std::vector<Deinflection>;
}

3635
rdricpp/include/rdricpp/rule_sets.h Normal file
View file

File diff suppressed because it is too large Load diff

69
rdricpp/include/rdricpp/types.h Normal file
View file

@ -0,0 +1,69 @@
/*
* Rikaitan Deinflector Reference Implementation
*
* Copyright (C) 2023 Ajatt-Tools and contributors
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, visit the http://fsf.org website.
*/
#pragma once
#include <array>
#include <cstdint>
#include <string>
#include <string_view>
#include <vector>
namespace ajt::rdricpp {
enum RuleType : uint32_t {
none = 0U,
v1 = 1U, // Verb ichidan
v5 = 2U, // Verb godan
vs = 4U, // Verb suru
vk = 8U, // Verb kuru
vz = 16U, // Verb zuru
adj_i = 32U, // Adjective i
iru = 64U // Intermediate -iru endings for progressive or perfect tense
};
struct Reason
{
std::string_view kana_in{};
std::string_view kana_out{};
RuleType rules_in{};
RuleType rules_out{};
[[nodiscard]] bool empty() const noexcept
{
return rules_in == RuleType::none and rules_out == RuleType::none and kana_in.empty() and kana_out.empty();
}
};
static constexpr size_t arr_max_size{ 50 };
struct RuleSet
{
std::string_view name{};
std::array<Reason, arr_max_size> rules{};
};
struct Deinflection
{
std::string term{};
RuleType rules{};
std::vector<std::string> reasons{};
};
} // namespace ajt::rdricpp

21
rdricpp/src/CMakeLists.txt Normal file
View file

@ -0,0 +1,21 @@
set(HEADER_LIST "${Rdricpp_SOURCE_DIR}/include/rdricpp/rdricpp.h")
add_library(rdricpp STATIC rdricpp.cpp ${HEADER_LIST})
#Expose include dir
target_include_directories(rdricpp PUBLIC ../include)
target_compile_features(rdricpp PUBLIC cxx_std_23)
source_group(
TREE "${PROJECT_SOURCE_DIR}/include"
PREFIX "Header Files"
FILES ${HEADER_LIST})
#Installation
install(TARGETS rdricpp DESTINATION lib/)

85
rdricpp/src/rdricpp.cpp Normal file
View file

@ -0,0 +1,85 @@
/*
* Rikaitan Deinflector Reference Implementation
*
* Copyright (C) 2023 Ajatt-Tools and contributors
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, visit the http://fsf.org website.
*/
#include "rdricpp/rdricpp.h"
#include "rdricpp/rule_sets.h"
#include "rdricpp/types.h"
#include <array>
#include <iostream>
#include <string_view>
#include <vector>
namespace ajt::rdricpp {
template<typename Stored>
auto copy_and_prepend(std::vector<Stored> const& first, Stored&& value) -> std::vector<Stored>
{
std::vector<Stored> joined = { value };
joined.insert(joined.cend(), first.cbegin(), first.cend());
return joined;
}
auto rule_applies(Deinflection const& result, Reason const& rule) -> bool
{
if (result.rules != RuleType::none and (rule.rules_in & result.rules) == RuleType::none) {
return false;
}
if (not result.term.ends_with(rule.kana_in)) {
return false;
}
if (result.term.size() + rule.kana_out.size() <= rule.kana_in.size()) {
return false;
}
return true;
}
auto deinflect(std::string_view const source) -> std::vector<Deinflection>
{
std::vector<Deinflection> results{
Deinflection{
.term = std::string{ source },
.rules = RuleType::none,
.reasons = {},
},
};
for (size_t idx = 0; idx < results.size(); ++idx) {
for (RuleSet const& ruleset: rulesets) {
for (Reason const& rule: ruleset.rules) {
if (rule.empty()) {
// reached the end of ruleset
break;
}
if (Deinflection const& result = results.at(idx); rule_applies(result, rule)) {
results.push_back(Deinflection{
.term = (result.term.substr(0, result.term.size() - rule.kana_in.size()).append(rule.kana_out)),
.rules = rule.rules_out,
.reasons = copy_and_prepend(result.reasons, std::string(ruleset.name)),
});
}
}
}
}
return results;
}
} // namespace ajt::rdricpp

18
rdricpp/tests/CMakeLists.txt Normal file
View file

@ -0,0 +1,18 @@
# Testing library
FetchContent_Declare(
catch
GIT_REPOSITORY https://github.com/catchorg/Catch2.git
GIT_TAG v3.5.2)
FetchContent_MakeAvailable(catch)
# Adds Catch2::Catch2
include(Catch)
add_executable(tests tests.cpp test_cases.cpp test_cases.h)
target_compile_features(tests PRIVATE cxx_std_23)
# Should be linked to the rdricpp library, as well as the Catch2 testing library
target_link_libraries(tests PRIVATE rdricpp Catch2::Catch2WithMain)
catch_discover_tests(tests)
add_test(NAME Test COMMAND tests)

973
rdricpp/tests/test_cases.cpp Normal file
View file

@ -0,0 +1,973 @@
/*
* Rikaitan Deinflector Reference Implementation
*
* Copyright (C) 2023 Ajatt-Tools and contributors
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, visit the http://fsf.org website.
*/
#include "test_cases.h"
namespace ajt::rdricpp {
std::vector<TestGroup> test_groups()
{
return {
TestGroup{
.valid= true,
.tests= {
// Adjective
TestCase{ .term = "愛しい", .source = "愛しい", .rule = RuleType::adj_i, .reasons = {} },
TestCase{ .term = "愛しい", .source = "愛しそう", .rule = RuleType::adj_i, .reasons = { "-sou" } },
TestCase{ .term = "愛しい", .source = "愛しすぎる", .rule = RuleType::adj_i, .reasons = { "-sugiru" } },
TestCase{ .term = "愛しい", .source = "愛しかったら", .rule = RuleType::adj_i, .reasons = { "-tara" } },
TestCase{ .term = "愛しい", .source = "愛しかったり", .rule = RuleType::adj_i, .reasons = { "-tari" } },
TestCase{ .term = "愛しい", .source = "愛しくて", .rule = RuleType::adj_i, .reasons = { "-te" } },
TestCase{ .term = "愛しい", .source = "愛しく", .rule = RuleType::adj_i, .reasons = { "adv" } },
TestCase{ .term = "愛しい", .source = "愛しくない", .rule = RuleType::adj_i, .reasons = { "negative" } },
TestCase{ .term = "愛しい", .source = "愛しさ", .rule = RuleType::adj_i, .reasons = { "noun" } },
TestCase{ .term = "愛しい", .source = "愛しかった", .rule = RuleType::adj_i, .reasons = { "past" } },
TestCase{ .term = "愛しい", .source = "愛しくありません", .rule = RuleType::adj_i, .reasons = { "polite negative" } },
TestCase{ .term = "愛しい",
.source = "愛しくありませんでした",
.rule = RuleType::adj_i,
.reasons = { "polite past negative" } },
TestCase{ .term = "愛しい", .source = "愛しき", .rule = RuleType::adj_i, .reasons = { "-ki" } },
TestCase{ .term = "愛しい", .source = "愛しげ", .rule = RuleType::adj_i, .reasons = { "-ge" } },
// Common verbs
TestCase{ .term = "食べる", .source = "食べる", .rule = RuleType::v1, .reasons = {} },
TestCase{ .term = "食べる", .source = "食べます", .rule = RuleType::v1, .reasons = { "polite" } },
TestCase{ .term = "食べる", .source = "食べた", .rule = RuleType::v1, .reasons = { "past" } },
TestCase{ .term = "食べる", .source = "食べました", .rule = RuleType::v1, .reasons = { "polite past" } },
TestCase{ .term = "食べる", .source = "食べて", .rule = RuleType::v1, .reasons = { "-te" } },
TestCase{ .term = "食べる", .source = "食べられる", .rule = RuleType::v1, .reasons = { "potential or passive" } },
TestCase{ .term = "食べる", .source = "食べられる", .rule = RuleType::v1, .reasons = { "potential or passive" } },
TestCase{ .term = "食べる", .source = "食べさせる", .rule = RuleType::v1, .reasons = { "causative" } },
TestCase{ .term = "食べる",
.source = "食べさせられる",
.rule = RuleType::v1,
.reasons = { "causative", "potential or passive" } },
TestCase{ .term = "食べる", .source = "食べろ", .rule = RuleType::v1, .reasons = { "imperative" } },
TestCase{ .term = "食べる", .source = "食べない", .rule = RuleType::v1, .reasons = { "negative" } },
TestCase{ .term = "食べる", .source = "食べません", .rule = RuleType::v1, .reasons = { "polite negative" } },
TestCase{ .term = "食べる", .source = "食べなかった", .rule = RuleType::v1, .reasons = { "negative", "past" } },
TestCase{ .term = "食べる", .source = "食べませんでした", .rule = RuleType::v1, .reasons = { "polite past negative" } },
TestCase{ .term = "食べる", .source = "食べなくて", .rule = RuleType::v1, .reasons = { "negative", "-te" } },
TestCase{ .term = "食べる", .source = "食べられない", .rule = RuleType::v1, .reasons = { "potential or passive", "negative" } },
TestCase{ .term = "食べる", .source = "食べられない", .rule = RuleType::v1, .reasons = { "potential or passive", "negative" } },
TestCase{ .term = "食べる", .source = "食べさせない", .rule = RuleType::v1, .reasons = { "causative", "negative" } },
TestCase{ .term = "食べる",
.source = "食べさせられない",
.rule = RuleType::v1,
.reasons = { "causative", "potential or passive", "negative" } },
TestCase{ .term = "食べる", .source = "食べるな", .rule = RuleType::v1, .reasons = { "imperative negative" } },
TestCase{ .term = "食べる", .source = "食べれば", .rule = RuleType::v1, .reasons = { "-ba" } },
TestCase{ .term = "食べる", .source = "食べちゃう", .rule = RuleType::v1, .reasons = { "-chau" } },
TestCase{ .term = "食べる", .source = "食べちまう", .rule = RuleType::v1, .reasons = { "-chimau" } },
TestCase{ .term = "食べる", .source = "食べなさい", .rule = RuleType::v1, .reasons = { "-nasai" } },
TestCase{ .term = "食べる", .source = "食べそう", .rule = RuleType::v1, .reasons = { "-sou" } },
TestCase{ .term = "食べる", .source = "食べすぎる", .rule = RuleType::v1, .reasons = { "-sugiru" } },
TestCase{ .term = "食べる", .source = "食べたい", .rule = RuleType::v1, .reasons = { "-tai" } },
TestCase{ .term = "食べる", .source = "食べたら", .rule = RuleType::v1, .reasons = { "-tara" } },
TestCase{ .term = "食べる", .source = "食べたり", .rule = RuleType::v1, .reasons = { "-tari" } },
TestCase{ .term = "食べる", .source = "食べず", .rule = RuleType::v1, .reasons = { "-zu" } },
TestCase{ .term = "食べる", .source = "食べぬ", .rule = RuleType::v1, .reasons = { "-nu" } },
TestCase{ .term = "食べる", .source = "食べ", .rule = RuleType::v1, .reasons = { "masu stem" } },
TestCase{ .term = "食べる", .source = "食べましょう", .rule = RuleType::v1, .reasons = { "polite volitional" } },
TestCase{ .term = "食べる", .source = "食べよう", .rule = RuleType::v1, .reasons = { "volitional" } },
// {"causative passive"}
TestCase{ .term = "食べる", .source = "食べとく", .rule = RuleType::v1, .reasons = { "-toku" } },
TestCase{ .term = "食べる", .source = "食べている", .rule = RuleType::v1, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "食べる", .source = "食べておる", .rule = RuleType::v1, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "食べる", .source = "食べてる", .rule = RuleType::v1, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "食べる", .source = "食べとる", .rule = RuleType::v1, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "食べる", .source = "食べてしまう", .rule = RuleType::v1, .reasons = { "-te", "-shimau" } },
TestCase{ .term = "買う", .source = "買う", .rule = RuleType::v5, .reasons = {} },
TestCase{ .term = "買う", .source = "買います", .rule = RuleType::v5, .reasons = { "polite" } },
TestCase{ .term = "買う", .source = "買った", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "買う", .source = "買いました", .rule = RuleType::v5, .reasons = { "polite past" } },
TestCase{ .term = "買う", .source = "買って", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "買う", .source = "買える", .rule = RuleType::v5, .reasons = { "potential" } },
TestCase{ .term = "買う", .source = "買われる", .rule = RuleType::v5, .reasons = { "passive" } },
TestCase{ .term = "買う", .source = "買わせる", .rule = RuleType::v5, .reasons = { "causative" } },
TestCase{ .term = "買う", .source = "買わせられる", .rule = RuleType::v5, .reasons = { "causative", "potential or passive" } },
TestCase{ .term = "買う", .source = "買え", .rule = RuleType::v5, .reasons = { "imperative" } },
TestCase{ .term = "買う", .source = "買わない", .rule = RuleType::v5, .reasons = { "negative" } },
TestCase{ .term = "買う", .source = "買いません", .rule = RuleType::v5, .reasons = { "polite negative" } },
TestCase{ .term = "買う", .source = "買わなかった", .rule = RuleType::v5, .reasons = { "negative", "past" } },
TestCase{ .term = "買う", .source = "買いませんでした", .rule = RuleType::v5, .reasons = { "polite past negative" } },
TestCase{ .term = "買う", .source = "買わなくて", .rule = RuleType::v5, .reasons = { "negative", "-te" } },
TestCase{ .term = "買う", .source = "買えない", .rule = RuleType::v5, .reasons = { "potential", "negative" } },
TestCase{ .term = "買う", .source = "買われない", .rule = RuleType::v5, .reasons = { "passive", "negative" } },
TestCase{ .term = "買う", .source = "買わせない", .rule = RuleType::v5, .reasons = { "causative", "negative" } },
TestCase{ .term = "買う",
.source = "買わせられない",
.rule = RuleType::v5,
.reasons = { "causative", "potential or passive", "negative" } },
TestCase{ .term = "買う", .source = "買うな", .rule = RuleType::v5, .reasons = { "imperative negative" } },
TestCase{ .term = "買う", .source = "買えば", .rule = RuleType::v5, .reasons = { "-ba" } },
TestCase{ .term = "買う", .source = "買っちゃう", .rule = RuleType::v5, .reasons = { "-chau" } },
TestCase{ .term = "買う", .source = "買っちまう", .rule = RuleType::v5, .reasons = { "-chimau" } },
TestCase{ .term = "買う", .source = "買いなさい", .rule = RuleType::v5, .reasons = { "-nasai" } },
TestCase{ .term = "買う", .source = "買いそう", .rule = RuleType::v5, .reasons = { "-sou" } },
TestCase{ .term = "買う", .source = "買いすぎる", .rule = RuleType::v5, .reasons = { "-sugiru" } },
TestCase{ .term = "買う", .source = "買いたい", .rule = RuleType::v5, .reasons = { "-tai" } },
TestCase{ .term = "買う", .source = "買ったら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "買う", .source = "買ったり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "買う", .source = "買わず", .rule = RuleType::v5, .reasons = { "-zu" } },
TestCase{ .term = "買う", .source = "買わぬ", .rule = RuleType::v5, .reasons = { "-nu" } },
TestCase{ .term = "買う", .source = "買い", .rule = RuleType::v5, .reasons = { "masu stem" } },
TestCase{ .term = "買う", .source = "買いましょう", .rule = RuleType::v5, .reasons = { "polite volitional" } },
TestCase{ .term = "買う", .source = "買おう", .rule = RuleType::v5, .reasons = { "volitional" } },
TestCase{ .term = "買う", .source = "買わされる", .rule = RuleType::v5, .reasons = { "causative passive" } },
TestCase{ .term = "買う", .source = "買っとく", .rule = RuleType::v5, .reasons = { "-toku" } },
TestCase{ .term = "買う", .source = "買っている", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "買う", .source = "買っておる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "買う", .source = "買ってる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "買う", .source = "買っとる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "買う", .source = "買ってしまう", .rule = RuleType::v5, .reasons = { "-te", "-shimau" } },
TestCase{ .term = "行く", .source = "行く", .rule = RuleType::v5, .reasons = {} },
TestCase{ .term = "行く", .source = "行きます", .rule = RuleType::v5, .reasons = { "polite" } },
TestCase{ .term = "行く", .source = "行った", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "行く", .source = "行きました", .rule = RuleType::v5, .reasons = { "polite past" } },
TestCase{ .term = "行く", .source = "行って", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "行く", .source = "行ける", .rule = RuleType::v5, .reasons = { "potential" } },
TestCase{ .term = "行く", .source = "行かれる", .rule = RuleType::v5, .reasons = { "passive" } },
TestCase{ .term = "行く", .source = "行かせる", .rule = RuleType::v5, .reasons = { "causative" } },
TestCase{ .term = "行く", .source = "行かせられる", .rule = RuleType::v5, .reasons = { "causative", "potential or passive" } },
TestCase{ .term = "行く", .source = "行け", .rule = RuleType::v5, .reasons = { "imperative" } },
TestCase{ .term = "行く", .source = "行かない", .rule = RuleType::v5, .reasons = { "negative" } },
TestCase{ .term = "行く", .source = "行きません", .rule = RuleType::v5, .reasons = { "polite negative" } },
TestCase{ .term = "行く", .source = "行かなかった", .rule = RuleType::v5, .reasons = { "negative", "past" } },
TestCase{ .term = "行く", .source = "行きませんでした", .rule = RuleType::v5, .reasons = { "polite past negative" } },
TestCase{ .term = "行く", .source = "行かなくて", .rule = RuleType::v5, .reasons = { "negative", "-te" } },
TestCase{ .term = "行く", .source = "行けない", .rule = RuleType::v5, .reasons = { "potential", "negative" } },
TestCase{ .term = "行く", .source = "行かれない", .rule = RuleType::v5, .reasons = { "passive", "negative" } },
TestCase{ .term = "行く", .source = "行かせない", .rule = RuleType::v5, .reasons = { "causative", "negative" } },
TestCase{ .term = "行く",
.source = "行かせられない",
.rule = RuleType::v5,
.reasons = { "causative", "potential or passive", "negative" } },
TestCase{ .term = "行く", .source = "行くな", .rule = RuleType::v5, .reasons = { "imperative negative" } },
TestCase{ .term = "行く", .source = "行けば", .rule = RuleType::v5, .reasons = { "-ba" } },
TestCase{ .term = "行く", .source = "行っちゃう", .rule = RuleType::v5, .reasons = { "-chau" } },
TestCase{ .term = "行く", .source = "行っちまう", .rule = RuleType::v5, .reasons = { "-chimau" } },
TestCase{ .term = "行く", .source = "行きなさい", .rule = RuleType::v5, .reasons = { "-nasai" } },
TestCase{ .term = "行く", .source = "行きそう", .rule = RuleType::v5, .reasons = { "-sou" } },
TestCase{ .term = "行く", .source = "行きすぎる", .rule = RuleType::v5, .reasons = { "-sugiru" } },
TestCase{ .term = "行く", .source = "行きたい", .rule = RuleType::v5, .reasons = { "-tai" } },
TestCase{ .term = "行く", .source = "行いたら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "行く", .source = "行いたり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "行く", .source = "行かず", .rule = RuleType::v5, .reasons = { "-zu" } },
TestCase{ .term = "行く", .source = "行かぬ", .rule = RuleType::v5, .reasons = { "-nu" } },
TestCase{ .term = "行く", .source = "行き", .rule = RuleType::v5, .reasons = { "masu stem" } },
TestCase{ .term = "行く", .source = "行きましょう", .rule = RuleType::v5, .reasons = { "polite volitional" } },
TestCase{ .term = "行く", .source = "行こう", .rule = RuleType::v5, .reasons = { "volitional" } },
TestCase{ .term = "行く", .source = "行かされる", .rule = RuleType::v5, .reasons = { "causative passive" } },
TestCase{ .term = "行く", .source = "行いとく", .rule = RuleType::v5, .reasons = { "-toku" } },
TestCase{ .term = "行く", .source = "行っている", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "行く", .source = "行っておる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "行く", .source = "行ってる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "行く", .source = "行っとる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "行く", .source = "行ってしまう", .rule = RuleType::v5, .reasons = { "-te", "-shimau" } },
TestCase{ .term = "泳ぐ", .source = "泳ぐ", .rule = RuleType::v5, .reasons = {} },
TestCase{ .term = "泳ぐ", .source = "泳ぎます", .rule = RuleType::v5, .reasons = { "polite" } },
TestCase{ .term = "泳ぐ", .source = "泳いだ", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "泳ぐ", .source = "泳ぎました", .rule = RuleType::v5, .reasons = { "polite past" } },
TestCase{ .term = "泳ぐ", .source = "泳いで", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "泳ぐ", .source = "泳げる", .rule = RuleType::v5, .reasons = { "potential" } },
TestCase{ .term = "泳ぐ", .source = "泳がれる", .rule = RuleType::v5, .reasons = { "passive" } },
TestCase{ .term = "泳ぐ", .source = "泳がせる", .rule = RuleType::v5, .reasons = { "causative" } },
TestCase{ .term = "泳ぐ", .source = "泳がせられる", .rule = RuleType::v5, .reasons = { "causative", "potential or passive" } },
TestCase{ .term = "泳ぐ", .source = "泳げ", .rule = RuleType::v5, .reasons = { "imperative" } },
TestCase{ .term = "泳ぐ", .source = "泳がない", .rule = RuleType::v5, .reasons = { "negative" } },
TestCase{ .term = "泳ぐ", .source = "泳ぎません", .rule = RuleType::v5, .reasons = { "polite negative" } },
TestCase{ .term = "泳ぐ", .source = "泳がなかった", .rule = RuleType::v5, .reasons = { "negative", "past" } },
TestCase{ .term = "泳ぐ", .source = "泳ぎませんでした", .rule = RuleType::v5, .reasons = { "polite past negative" } },
TestCase{ .term = "泳ぐ", .source = "泳がなくて", .rule = RuleType::v5, .reasons = { "negative", "-te" } },
TestCase{ .term = "泳ぐ", .source = "泳げない", .rule = RuleType::v5, .reasons = { "potential", "negative" } },
TestCase{ .term = "泳ぐ", .source = "泳がれない", .rule = RuleType::v5, .reasons = { "passive", "negative" } },
TestCase{ .term = "泳ぐ", .source = "泳がせない", .rule = RuleType::v5, .reasons = { "causative", "negative" } },
TestCase{ .term = "泳ぐ",
.source = "泳がせられない",
.rule = RuleType::v5,
.reasons = { "causative", "potential or passive", "negative" } },
TestCase{ .term = "泳ぐ", .source = "泳ぐな", .rule = RuleType::v5, .reasons = { "imperative negative" } },
TestCase{ .term = "泳ぐ", .source = "泳げば", .rule = RuleType::v5, .reasons = { "-ba" } },
TestCase{ .term = "泳ぐ", .source = "泳いじゃう", .rule = RuleType::v5, .reasons = { "-chau" } },
TestCase{ .term = "泳ぐ", .source = "泳いじまう", .rule = RuleType::v5, .reasons = { "-chimau" } },
TestCase{ .term = "泳ぐ", .source = "泳ぎなさい", .rule = RuleType::v5, .reasons = { "-nasai" } },
TestCase{ .term = "泳ぐ", .source = "泳ぎそう", .rule = RuleType::v5, .reasons = { "-sou" } },
TestCase{ .term = "泳ぐ", .source = "泳ぎすぎる", .rule = RuleType::v5, .reasons = { "-sugiru" } },
TestCase{ .term = "泳ぐ", .source = "泳ぎたい", .rule = RuleType::v5, .reasons = { "-tai" } },
TestCase{ .term = "泳ぐ", .source = "泳いだら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "泳ぐ", .source = "泳いだり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "泳ぐ", .source = "泳がず", .rule = RuleType::v5, .reasons = { "-zu" } },
TestCase{ .term = "泳ぐ", .source = "泳がぬ", .rule = RuleType::v5, .reasons = { "-nu" } },
TestCase{ .term = "泳ぐ", .source = "泳ぎ", .rule = RuleType::v5, .reasons = { "masu stem" } },
TestCase{ .term = "泳ぐ", .source = "泳ぎましょう", .rule = RuleType::v5, .reasons = { "polite volitional" } },
TestCase{ .term = "泳ぐ", .source = "泳ごう", .rule = RuleType::v5, .reasons = { "volitional" } },
TestCase{ .term = "泳ぐ", .source = "泳がされる", .rule = RuleType::v5, .reasons = { "causative passive" } },
TestCase{ .term = "泳ぐ", .source = "泳いどく", .rule = RuleType::v5, .reasons = { "-toku" } },
TestCase{ .term = "泳ぐ", .source = "泳いでいる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "泳ぐ", .source = "泳いでおる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "泳ぐ", .source = "泳いでる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "泳ぐ", .source = "泳いでしまう", .rule = RuleType::v5, .reasons = { "-te", "-shimau" } },
TestCase{ .term = "話す", .source = "話す", .rule = RuleType::v5, .reasons = {} },
TestCase{ .term = "話す", .source = "話します", .rule = RuleType::v5, .reasons = { "polite" } },
TestCase{ .term = "話す", .source = "話した", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "話す", .source = "話しました", .rule = RuleType::v5, .reasons = { "polite past" } },
TestCase{ .term = "話す", .source = "話して", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "話す", .source = "話せる", .rule = RuleType::v5, .reasons = { "potential" } },
TestCase{ .term = "話す", .source = "話される", .rule = RuleType::v5, .reasons = { "passive" } },
TestCase{ .term = "話す", .source = "話させる", .rule = RuleType::v5, .reasons = { "causative" } },
TestCase{ .term = "話す", .source = "話させられる", .rule = RuleType::v5, .reasons = { "causative", "potential or passive" } },
TestCase{ .term = "話す", .source = "話せ", .rule = RuleType::v5, .reasons = { "imperative" } },
TestCase{ .term = "話す", .source = "話さない", .rule = RuleType::v5, .reasons = { "negative" } },
TestCase{ .term = "話す", .source = "話しません", .rule = RuleType::v5, .reasons = { "polite negative" } },
TestCase{ .term = "話す", .source = "話さなかった", .rule = RuleType::v5, .reasons = { "negative", "past" } },
TestCase{ .term = "話す", .source = "話しませんでした", .rule = RuleType::v5, .reasons = { "polite past negative" } },
TestCase{ .term = "話す", .source = "話さなくて", .rule = RuleType::v5, .reasons = { "negative", "-te" } },
TestCase{ .term = "話す", .source = "話せない", .rule = RuleType::v5, .reasons = { "potential", "negative" } },
TestCase{ .term = "話す", .source = "話されない", .rule = RuleType::v5, .reasons = { "passive", "negative" } },
TestCase{ .term = "話す", .source = "話させない", .rule = RuleType::v5, .reasons = { "causative", "negative" } },
TestCase{ .term = "話す",
.source = "話させられない",
.rule = RuleType::v5,
.reasons = { "causative", "potential or passive", "negative" } },
TestCase{ .term = "話す", .source = "話すな", .rule = RuleType::v5, .reasons = { "imperative negative" } },
TestCase{ .term = "話す", .source = "話せば", .rule = RuleType::v5, .reasons = { "-ba" } },
TestCase{ .term = "話す", .source = "話しちゃう", .rule = RuleType::v5, .reasons = { "-chau" } },
TestCase{ .term = "話す", .source = "話しちまう", .rule = RuleType::v5, .reasons = { "-chimau" } },
TestCase{ .term = "話す", .source = "話しなさい", .rule = RuleType::v5, .reasons = { "-nasai" } },
TestCase{ .term = "話す", .source = "話しそう", .rule = RuleType::v5, .reasons = { "-sou" } },
TestCase{ .term = "話す", .source = "話しすぎる", .rule = RuleType::v5, .reasons = { "-sugiru" } },
TestCase{ .term = "話す", .source = "話したい", .rule = RuleType::v5, .reasons = { "-tai" } },
TestCase{ .term = "話す", .source = "話したら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "話す", .source = "話したり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "話す", .source = "話さず", .rule = RuleType::v5, .reasons = { "-zu" } },
TestCase{ .term = "話す", .source = "話さぬ", .rule = RuleType::v5, .reasons = { "-nu" } },
TestCase{ .term = "話す", .source = "話し", .rule = RuleType::v5, .reasons = { "masu stem" } },
TestCase{ .term = "話す", .source = "話しましょう", .rule = RuleType::v5, .reasons = { "polite volitional" } },
TestCase{ .term = "話す", .source = "話そう", .rule = RuleType::v5, .reasons = { "volitional" } },
// {"causative passive"}
TestCase{ .term = "話す", .source = "話しとく", .rule = RuleType::v5, .reasons = { "-toku" } },
TestCase{ .term = "話す", .source = "話している", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "話す", .source = "話しておる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "話す", .source = "話してる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "話す", .source = "話しとる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "話す", .source = "話してしまう", .rule = RuleType::v5, .reasons = { "-te", "-shimau" } },
TestCase{ .term = "待つ", .source = "待つ", .rule = RuleType::v5, .reasons = {} },
TestCase{ .term = "待つ", .source = "待ちます", .rule = RuleType::v5, .reasons = { "polite" } },
TestCase{ .term = "待つ", .source = "待った", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "待つ", .source = "待ちました", .rule = RuleType::v5, .reasons = { "polite past" } },
TestCase{ .term = "待つ", .source = "待って", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "待つ", .source = "待てる", .rule = RuleType::v5, .reasons = { "potential" } },
TestCase{ .term = "待つ", .source = "待たれる", .rule = RuleType::v5, .reasons = { "passive" } },
TestCase{ .term = "待つ", .source = "待たせる", .rule = RuleType::v5, .reasons = { "causative" } },
TestCase{ .term = "待つ", .source = "待たせられる", .rule = RuleType::v5, .reasons = { "causative", "potential or passive" } },
TestCase{ .term = "待つ", .source = "待て", .rule = RuleType::v5, .reasons = { "imperative" } },
TestCase{ .term = "待つ", .source = "待たない", .rule = RuleType::v5, .reasons = { "negative" } },
TestCase{ .term = "待つ", .source = "待ちません", .rule = RuleType::v5, .reasons = { "polite negative" } },
TestCase{ .term = "待つ", .source = "待たなかった", .rule = RuleType::v5, .reasons = { "negative", "past" } },
TestCase{ .term = "待つ", .source = "待ちませんでした", .rule = RuleType::v5, .reasons = { "polite past negative" } },
TestCase{ .term = "待つ", .source = "待たなくて", .rule = RuleType::v5, .reasons = { "negative", "-te" } },
TestCase{ .term = "待つ", .source = "待てない", .rule = RuleType::v5, .reasons = { "potential", "negative" } },
TestCase{ .term = "待つ", .source = "待たれない", .rule = RuleType::v5, .reasons = { "passive", "negative" } },
TestCase{ .term = "待つ", .source = "待たせない", .rule = RuleType::v5, .reasons = { "causative", "negative" } },
TestCase{ .term = "待つ",
.source = "待たせられない",
.rule = RuleType::v5,
.reasons = { "causative", "potential or passive", "negative" } },
TestCase{ .term = "待つ", .source = "待つな", .rule = RuleType::v5, .reasons = { "imperative negative" } },
TestCase{ .term = "待つ", .source = "待てば", .rule = RuleType::v5, .reasons = { "-ba" } },
TestCase{ .term = "待つ", .source = "待っちゃう", .rule = RuleType::v5, .reasons = { "-chau" } },
TestCase{ .term = "待つ", .source = "待っちまう", .rule = RuleType::v5, .reasons = { "-chimau" } },
TestCase{ .term = "待つ", .source = "待ちなさい", .rule = RuleType::v5, .reasons = { "-nasai" } },
TestCase{ .term = "待つ", .source = "待ちそう", .rule = RuleType::v5, .reasons = { "-sou" } },
TestCase{ .term = "待つ", .source = "待ちすぎる", .rule = RuleType::v5, .reasons = { "-sugiru" } },
TestCase{ .term = "待つ", .source = "待ちたい", .rule = RuleType::v5, .reasons = { "-tai" } },
TestCase{ .term = "待つ", .source = "待ったら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "待つ", .source = "待ったり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "待つ", .source = "待たず", .rule = RuleType::v5, .reasons = { "-zu" } },
TestCase{ .term = "待つ", .source = "待たぬ", .rule = RuleType::v5, .reasons = { "-nu" } },
TestCase{ .term = "待つ", .source = "待ち", .rule = RuleType::v5, .reasons = { "masu stem" } },
TestCase{ .term = "待つ", .source = "待ちましょう", .rule = RuleType::v5, .reasons = { "polite volitional" } },
TestCase{ .term = "待つ", .source = "待とう", .rule = RuleType::v5, .reasons = { "volitional" } },
TestCase{ .term = "待つ", .source = "待たされる", .rule = RuleType::v5, .reasons = { "causative passive" } },
TestCase{ .term = "待つ", .source = "待っとく", .rule = RuleType::v5, .reasons = { "-toku" } },
TestCase{ .term = "待つ", .source = "待っている", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "待つ", .source = "待っておる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "待つ", .source = "待ってる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "待つ", .source = "待っとる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "待つ", .source = "待ってしまう", .rule = RuleType::v5, .reasons = { "-te", "-shimau" } },
TestCase{ .term = "死ぬ", .source = "死ぬ", .rule = RuleType::v5, .reasons = {} },
TestCase{ .term = "死ぬ", .source = "死にます", .rule = RuleType::v5, .reasons = { "polite" } },
TestCase{ .term = "死ぬ", .source = "死んだ", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "死ぬ", .source = "死にました", .rule = RuleType::v5, .reasons = { "polite past" } },
TestCase{ .term = "死ぬ", .source = "死んで", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "死ぬ", .source = "死ねる", .rule = RuleType::v5, .reasons = { "potential" } },
TestCase{ .term = "死ぬ", .source = "死なれる", .rule = RuleType::v5, .reasons = { "passive" } },
TestCase{ .term = "死ぬ", .source = "死なせる", .rule = RuleType::v5, .reasons = { "causative" } },
TestCase{ .term = "死ぬ", .source = "死なせられる", .rule = RuleType::v5, .reasons = { "causative", "potential or passive" } },
TestCase{ .term = "死ぬ", .source = "死ね", .rule = RuleType::v5, .reasons = { "imperative" } },
TestCase{ .term = "死ぬ", .source = "死なない", .rule = RuleType::v5, .reasons = { "negative" } },
TestCase{ .term = "死ぬ", .source = "死にません", .rule = RuleType::v5, .reasons = { "polite negative" } },
TestCase{ .term = "死ぬ", .source = "死ななかった", .rule = RuleType::v5, .reasons = { "negative", "past" } },
TestCase{ .term = "死ぬ", .source = "死にませんでした", .rule = RuleType::v5, .reasons = { "polite past negative" } },
TestCase{ .term = "死ぬ", .source = "死ななくて", .rule = RuleType::v5, .reasons = { "negative", "-te" } },
TestCase{ .term = "死ぬ", .source = "死ねない", .rule = RuleType::v5, .reasons = { "potential", "negative" } },
TestCase{ .term = "死ぬ", .source = "死なれない", .rule = RuleType::v5, .reasons = { "passive", "negative" } },
TestCase{ .term = "死ぬ", .source = "死なせない", .rule = RuleType::v5, .reasons = { "causative", "negative" } },
TestCase{ .term = "死ぬ",
.source = "死なせられない",
.rule = RuleType::v5,
.reasons = { "causative", "potential or passive", "negative" } },
TestCase{ .term = "死ぬ", .source = "死ぬな", .rule = RuleType::v5, .reasons = { "imperative negative" } },
TestCase{ .term = "死ぬ", .source = "死ねば", .rule = RuleType::v5, .reasons = { "-ba" } },
TestCase{ .term = "死ぬ", .source = "死んじゃう", .rule = RuleType::v5, .reasons = { "-chau" } },
TestCase{ .term = "死ぬ", .source = "死んじまう", .rule = RuleType::v5, .reasons = { "-chimau" } },
TestCase{ .term = "死ぬ", .source = "死になさい", .rule = RuleType::v5, .reasons = { "-nasai" } },
TestCase{ .term = "死ぬ", .source = "死にそう", .rule = RuleType::v5, .reasons = { "-sou" } },
TestCase{ .term = "死ぬ", .source = "死にすぎる", .rule = RuleType::v5, .reasons = { "-sugiru" } },
TestCase{ .term = "死ぬ", .source = "死にたい", .rule = RuleType::v5, .reasons = { "-tai" } },
TestCase{ .term = "死ぬ", .source = "死んだら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "死ぬ", .source = "死んだり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "死ぬ", .source = "死なず", .rule = RuleType::v5, .reasons = { "-zu" } },
TestCase{ .term = "死ぬ", .source = "死なぬ", .rule = RuleType::v5, .reasons = { "-nu" } },
TestCase{ .term = "死ぬ", .source = "死に", .rule = RuleType::v5, .reasons = { "masu stem" } },
TestCase{ .term = "死ぬ", .source = "死にましょう", .rule = RuleType::v5, .reasons = { "polite volitional" } },
TestCase{ .term = "死ぬ", .source = "死のう", .rule = RuleType::v5, .reasons = { "volitional" } },
TestCase{ .term = "死ぬ", .source = "死なされる", .rule = RuleType::v5, .reasons = { "causative passive" } },
TestCase{ .term = "死ぬ", .source = "死んどく", .rule = RuleType::v5, .reasons = { "-toku" } },
TestCase{ .term = "死ぬ", .source = "死んでいる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "死ぬ", .source = "死んでおる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "死ぬ", .source = "死んでる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "死ぬ", .source = "死んでしまう", .rule = RuleType::v5, .reasons = { "-te", "-shimau" } },
TestCase{ .term = "遊ぶ", .source = "遊ぶ", .rule = RuleType::v5, .reasons = {} },
TestCase{ .term = "遊ぶ", .source = "遊びます", .rule = RuleType::v5, .reasons = { "polite" } },
TestCase{ .term = "遊ぶ", .source = "遊んだ", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "遊ぶ", .source = "遊びました", .rule = RuleType::v5, .reasons = { "polite past" } },
TestCase{ .term = "遊ぶ", .source = "遊んで", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "遊ぶ", .source = "遊べる", .rule = RuleType::v5, .reasons = { "potential" } },
TestCase{ .term = "遊ぶ", .source = "遊ばれる", .rule = RuleType::v5, .reasons = { "passive" } },
TestCase{ .term = "遊ぶ", .source = "遊ばせる", .rule = RuleType::v5, .reasons = { "causative" } },
TestCase{ .term = "遊ぶ", .source = "遊ばせられる", .rule = RuleType::v5, .reasons = { "causative", "potential or passive" } },
TestCase{ .term = "遊ぶ", .source = "遊べ", .rule = RuleType::v5, .reasons = { "imperative" } },
TestCase{ .term = "遊ぶ", .source = "遊ばない", .rule = RuleType::v5, .reasons = { "negative" } },
TestCase{ .term = "遊ぶ", .source = "遊びません", .rule = RuleType::v5, .reasons = { "polite negative" } },
TestCase{ .term = "遊ぶ", .source = "遊ばなかった", .rule = RuleType::v5, .reasons = { "negative", "past" } },
TestCase{ .term = "遊ぶ", .source = "遊びませんでした", .rule = RuleType::v5, .reasons = { "polite past negative" } },
TestCase{ .term = "遊ぶ", .source = "遊ばなくて", .rule = RuleType::v5, .reasons = { "negative", "-te" } },
TestCase{ .term = "遊ぶ", .source = "遊べない", .rule = RuleType::v5, .reasons = { "potential", "negative" } },
TestCase{ .term = "遊ぶ", .source = "遊ばれない", .rule = RuleType::v5, .reasons = { "passive", "negative" } },
TestCase{ .term = "遊ぶ", .source = "遊ばせない", .rule = RuleType::v5, .reasons = { "causative", "negative" } },
TestCase{ .term = "遊ぶ",
.source = "遊ばせられない",
.rule = RuleType::v5,
.reasons = { "causative", "potential or passive", "negative" } },
TestCase{ .term = "遊ぶ", .source = "遊ぶな", .rule = RuleType::v5, .reasons = { "imperative negative" } },
TestCase{ .term = "遊ぶ", .source = "遊べば", .rule = RuleType::v5, .reasons = { "-ba" } },
TestCase{ .term = "遊ぶ", .source = "遊んじゃう", .rule = RuleType::v5, .reasons = { "-chau" } },
TestCase{ .term = "遊ぶ", .source = "遊んじまう", .rule = RuleType::v5, .reasons = { "-chimau" } },
TestCase{ .term = "遊ぶ", .source = "遊びなさい", .rule = RuleType::v5, .reasons = { "-nasai" } },
TestCase{ .term = "遊ぶ", .source = "遊びそう", .rule = RuleType::v5, .reasons = { "-sou" } },
TestCase{ .term = "遊ぶ", .source = "遊びすぎる", .rule = RuleType::v5, .reasons = { "-sugiru" } },
TestCase{ .term = "遊ぶ", .source = "遊びたい", .rule = RuleType::v5, .reasons = { "-tai" } },
TestCase{ .term = "遊ぶ", .source = "遊んだら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "遊ぶ", .source = "遊んだり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "遊ぶ", .source = "遊ばず", .rule = RuleType::v5, .reasons = { "-zu" } },
TestCase{ .term = "遊ぶ", .source = "遊ばぬ", .rule = RuleType::v5, .reasons = { "-nu" } },
TestCase{ .term = "遊ぶ", .source = "遊び", .rule = RuleType::v5, .reasons = { "masu stem" } },
TestCase{ .term = "遊ぶ", .source = "遊びましょう", .rule = RuleType::v5, .reasons = { "polite volitional" } },
TestCase{ .term = "遊ぶ", .source = "遊ぼう", .rule = RuleType::v5, .reasons = { "volitional" } },
TestCase{ .term = "遊ぶ", .source = "遊ばされる", .rule = RuleType::v5, .reasons = { "causative passive" } },
TestCase{ .term = "遊ぶ", .source = "遊んどく", .rule = RuleType::v5, .reasons = { "-toku" } },
TestCase{ .term = "遊ぶ", .source = "遊んでいる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "遊ぶ", .source = "遊んでおる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "遊ぶ", .source = "遊んでる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "遊ぶ", .source = "遊んでしまう", .rule = RuleType::v5, .reasons = { "-te", "-shimau" } },
TestCase{ .term = "飲む", .source = "飲む", .rule = RuleType::v5, .reasons = {} },
TestCase{ .term = "飲む", .source = "飲みます", .rule = RuleType::v5, .reasons = { "polite" } },
TestCase{ .term = "飲む", .source = "飲んだ", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "飲む", .source = "飲みました", .rule = RuleType::v5, .reasons = { "polite past" } },
TestCase{ .term = "飲む", .source = "飲んで", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "飲む", .source = "飲める", .rule = RuleType::v5, .reasons = { "potential" } },
TestCase{ .term = "飲む", .source = "飲まれる", .rule = RuleType::v5, .reasons = { "passive" } },
TestCase{ .term = "飲む", .source = "飲ませる", .rule = RuleType::v5, .reasons = { "causative" } },
TestCase{ .term = "飲む", .source = "飲ませられる", .rule = RuleType::v5, .reasons = { "causative", "potential or passive" } },
TestCase{ .term = "飲む", .source = "飲め", .rule = RuleType::v5, .reasons = { "imperative" } },
TestCase{ .term = "飲む", .source = "飲まない", .rule = RuleType::v5, .reasons = { "negative" } },
TestCase{ .term = "飲む", .source = "飲みません", .rule = RuleType::v5, .reasons = { "polite negative" } },
TestCase{ .term = "飲む", .source = "飲まなかった", .rule = RuleType::v5, .reasons = { "negative", "past" } },
TestCase{ .term = "飲む", .source = "飲みませんでした", .rule = RuleType::v5, .reasons = { "polite past negative" } },
TestCase{ .term = "飲む", .source = "飲まなくて", .rule = RuleType::v5, .reasons = { "negative", "-te" } },
TestCase{ .term = "飲む", .source = "飲めない", .rule = RuleType::v5, .reasons = { "potential", "negative" } },
TestCase{ .term = "飲む", .source = "飲まれない", .rule = RuleType::v5, .reasons = { "passive", "negative" } },
TestCase{ .term = "飲む", .source = "飲ませない", .rule = RuleType::v5, .reasons = { "causative", "negative" } },
TestCase{ .term = "飲む",
.source = "飲ませられない",
.rule = RuleType::v5,
.reasons = { "causative", "potential or passive", "negative" } },
TestCase{ .term = "飲む", .source = "飲むな", .rule = RuleType::v5, .reasons = { "imperative negative" } },
TestCase{ .term = "飲む", .source = "飲めば", .rule = RuleType::v5, .reasons = { "-ba" } },
TestCase{ .term = "飲む", .source = "飲んじゃう", .rule = RuleType::v5, .reasons = { "-chau" } },
TestCase{ .term = "飲む", .source = "飲んじまう", .rule = RuleType::v5, .reasons = { "-chimau" } },
TestCase{ .term = "飲む", .source = "飲みなさい", .rule = RuleType::v5, .reasons = { "-nasai" } },
TestCase{ .term = "飲む", .source = "飲みそう", .rule = RuleType::v5, .reasons = { "-sou" } },
TestCase{ .term = "飲む", .source = "飲みすぎる", .rule = RuleType::v5, .reasons = { "-sugiru" } },
TestCase{ .term = "飲む", .source = "飲みたい", .rule = RuleType::v5, .reasons = { "-tai" } },
TestCase{ .term = "飲む", .source = "飲んだら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "飲む", .source = "飲んだり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "飲む", .source = "飲まず", .rule = RuleType::v5, .reasons = { "-zu" } },
TestCase{ .term = "飲む", .source = "飲まぬ", .rule = RuleType::v5, .reasons = { "-nu" } },
TestCase{ .term = "飲む", .source = "飲み", .rule = RuleType::v5, .reasons = { "masu stem" } },
TestCase{ .term = "飲む", .source = "飲みましょう", .rule = RuleType::v5, .reasons = { "polite volitional" } },
TestCase{ .term = "飲む", .source = "飲もう", .rule = RuleType::v5, .reasons = { "volitional" } },
TestCase{ .term = "飲む", .source = "飲まされる", .rule = RuleType::v5, .reasons = { "causative passive" } },
TestCase{ .term = "飲む", .source = "飲んどく", .rule = RuleType::v5, .reasons = { "-toku" } },
TestCase{ .term = "飲む", .source = "飲んでいる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "飲む", .source = "飲んでおる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "飲む", .source = "飲んでる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "飲む", .source = "飲んでしまう", .rule = RuleType::v5, .reasons = { "-te", "-shimau" } },
TestCase{ .term = "作る", .source = "作る", .rule = RuleType::v5, .reasons = {} },
TestCase{ .term = "作る", .source = "作ります", .rule = RuleType::v5, .reasons = { "polite" } },
TestCase{ .term = "作る", .source = "作った", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "作る", .source = "作りました", .rule = RuleType::v5, .reasons = { "polite past" } },
TestCase{ .term = "作る", .source = "作って", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "作る", .source = "作れる", .rule = RuleType::v5, .reasons = { "potential" } },
TestCase{ .term = "作る", .source = "作られる", .rule = RuleType::v5, .reasons = { "passive" } },
TestCase{ .term = "作る", .source = "作らせる", .rule = RuleType::v5, .reasons = { "causative" } },
TestCase{ .term = "作る", .source = "作らせられる", .rule = RuleType::v5, .reasons = { "causative", "potential or passive" } },
TestCase{ .term = "作る", .source = "作れ", .rule = RuleType::v5, .reasons = { "imperative" } },
TestCase{ .term = "作る", .source = "作らない", .rule = RuleType::v5, .reasons = { "negative" } },
TestCase{ .term = "作る", .source = "作りません", .rule = RuleType::v5, .reasons = { "polite negative" } },
TestCase{ .term = "作る", .source = "作らなかった", .rule = RuleType::v5, .reasons = { "negative", "past" } },
TestCase{ .term = "作る", .source = "作りませんでした", .rule = RuleType::v5, .reasons = { "polite past negative" } },
TestCase{ .term = "作る", .source = "作らなくて", .rule = RuleType::v5, .reasons = { "negative", "-te" } },
TestCase{ .term = "作る", .source = "作れない", .rule = RuleType::v5, .reasons = { "potential", "negative" } },
TestCase{ .term = "作る", .source = "作られない", .rule = RuleType::v5, .reasons = { "passive", "negative" } },
TestCase{ .term = "作る", .source = "作らせない", .rule = RuleType::v5, .reasons = { "causative", "negative" } },
TestCase{ .term = "作る",
.source = "作らせられない",
.rule = RuleType::v5,
.reasons = { "causative", "potential or passive", "negative" } },
TestCase{ .term = "作る", .source = "作るな", .rule = RuleType::v5, .reasons = { "imperative negative" } },
TestCase{ .term = "作る", .source = "作れば", .rule = RuleType::v5, .reasons = { "-ba" } },
TestCase{ .term = "作る", .source = "作っちゃう", .rule = RuleType::v5, .reasons = { "-chau" } },
TestCase{ .term = "作る", .source = "作っちまう", .rule = RuleType::v5, .reasons = { "-chimau" } },
TestCase{ .term = "作る", .source = "作りなさい", .rule = RuleType::v5, .reasons = { "-nasai" } },
TestCase{ .term = "作る", .source = "作りそう", .rule = RuleType::v5, .reasons = { "-sou" } },
TestCase{ .term = "作る", .source = "作りすぎる", .rule = RuleType::v5, .reasons = { "-sugiru" } },
TestCase{ .term = "作る", .source = "作りたい", .rule = RuleType::v5, .reasons = { "-tai" } },
TestCase{ .term = "作る", .source = "作ったら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "作る", .source = "作ったり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "作る", .source = "作らず", .rule = RuleType::v5, .reasons = { "-zu" } },
TestCase{ .term = "作る", .source = "作らぬ", .rule = RuleType::v5, .reasons = { "-nu" } },
TestCase{ .term = "作る", .source = "作り", .rule = RuleType::v5, .reasons = { "masu stem" } },
TestCase{ .term = "作る", .source = "作りましょう", .rule = RuleType::v5, .reasons = { "polite volitional" } },
TestCase{ .term = "作る", .source = "作ろう", .rule = RuleType::v5, .reasons = { "volitional" } },
TestCase{ .term = "作る", .source = "作らされる", .rule = RuleType::v5, .reasons = { "causative passive" } },
TestCase{ .term = "作る", .source = "作っとく", .rule = RuleType::v5, .reasons = { "-toku" } },
TestCase{ .term = "作る", .source = "作っている", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "作る", .source = "作っておる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "作る", .source = "作ってる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "作る", .source = "作っとる", .rule = RuleType::v5, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "作る", .source = "作ってしまう", .rule = RuleType::v5, .reasons = { "-te", "-shimau" } },
// Irregular verbs
TestCase{ .term = "為る", .source = "為る", .rule = RuleType::vs, .reasons = {} },
TestCase{ .term = "為る", .source = "為ます", .rule = RuleType::vs, .reasons = { "polite" } },
TestCase{ .term = "為る", .source = "為た", .rule = RuleType::vs, .reasons = { "past" } },
TestCase{ .term = "為る", .source = "為ました", .rule = RuleType::vs, .reasons = { "polite past" } },
TestCase{ .term = "為る", .source = "為て", .rule = RuleType::vs, .reasons = { "-te" } },
TestCase{ .term = "為る", .source = "為られる", .rule = RuleType::vs, .reasons = { "potential or passive" } },
TestCase{ .term = "為る", .source = "為れる", .rule = RuleType::vs, .reasons = { "passive" } },
TestCase{ .term = "為る", .source = "為せる", .rule = RuleType::vs, .reasons = { "causative" } },
TestCase{ .term = "為る", .source = "為させる", .rule = RuleType::vs, .reasons = { "causative" } },
TestCase{ .term = "為る", .source = "為せられる", .rule = RuleType::vs, .reasons = { "causative", "potential or passive" } },
TestCase{ .term = "為る", .source = "為させられる", .rule = RuleType::vs, .reasons = { "causative", "potential or passive" } },
TestCase{ .term = "為る", .source = "為ろ", .rule = RuleType::vs, .reasons = { "imperative" } },
TestCase{ .term = "為る", .source = "為ない", .rule = RuleType::vs, .reasons = { "negative" } },
TestCase{ .term = "為る", .source = "為ません", .rule = RuleType::vs, .reasons = { "polite negative" } },
TestCase{ .term = "為る", .source = "為なかった", .rule = RuleType::vs, .reasons = { "negative", "past" } },
TestCase{ .term = "為る", .source = "為ませんでした", .rule = RuleType::vs, .reasons = { "polite past negative" } },
TestCase{ .term = "為る", .source = "為なくて", .rule = RuleType::vs, .reasons = { "negative", "-te" } },
TestCase{ .term = "為る", .source = "為られない", .rule = RuleType::vs, .reasons = { "potential or passive", "negative" } },
TestCase{ .term = "為る", .source = "為れない", .rule = RuleType::vs, .reasons = { "passive", "negative" } },
TestCase{ .term = "為る", .source = "為せない", .rule = RuleType::vs, .reasons = { "causative", "negative" } },
TestCase{ .term = "為る", .source = "為させない", .rule = RuleType::vs, .reasons = { "causative", "negative" } },
TestCase{ .term = "為る",
.source = "為せられない",
.rule = RuleType::vs,
.reasons = { "causative", "potential or passive", "negative" } },
TestCase{ .term = "為る",
.source = "為させられない",
.rule = RuleType::vs,
.reasons = { "causative", "potential or passive", "negative" } },
TestCase{ .term = "為る", .source = "為るな", .rule = RuleType::vs, .reasons = { "imperative negative" } },
TestCase{ .term = "為る", .source = "為れば", .rule = RuleType::vs, .reasons = { "-ba" } },
TestCase{ .term = "為る", .source = "為ちゃう", .rule = RuleType::vs, .reasons = { "-chau" } },
TestCase{ .term = "為る", .source = "為ちまう", .rule = RuleType::vs, .reasons = { "-chimau" } },
TestCase{ .term = "為る", .source = "為なさい", .rule = RuleType::vs, .reasons = { "-nasai" } },
TestCase{ .term = "為る", .source = "為そう", .rule = RuleType::vs, .reasons = { "-sou" } },
TestCase{ .term = "為る", .source = "為すぎる", .rule = RuleType::vs, .reasons = { "-sugiru" } },
TestCase{ .term = "為る", .source = "為たい", .rule = RuleType::vs, .reasons = { "-tai" } },
TestCase{ .term = "為る", .source = "為たら", .rule = RuleType::vs, .reasons = { "-tara" } },
TestCase{ .term = "為る", .source = "為たり", .rule = RuleType::vs, .reasons = { "-tari" } },
TestCase{ .term = "為る", .source = "為ず", .rule = RuleType::vs, .reasons = { "-zu" } },
TestCase{ .term = "為る", .source = "為ぬ", .rule = RuleType::vs, .reasons = { "-nu" } },
// {"masu stem"}
TestCase{ .term = "為る", .source = "為ましょう", .rule = RuleType::vs, .reasons = { "polite volitional" } },
TestCase{ .term = "為る", .source = "為よう", .rule = RuleType::vs, .reasons = { "volitional" } },
// {"causative passive"}
TestCase{ .term = "為る", .source = "為とく", .rule = RuleType::vs, .reasons = { "-toku" } },
TestCase{ .term = "為る", .source = "為ている", .rule = RuleType::vs, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "為る", .source = "為ておる", .rule = RuleType::vs, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "為る", .source = "為てる", .rule = RuleType::vs, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "為る", .source = "為とる", .rule = RuleType::vs, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "為る", .source = "為てしまう", .rule = RuleType::vs, .reasons = { "-te", "-shimau" } },
TestCase{ .term = "する", .source = "する", .rule = RuleType::vs, .reasons = {} },
TestCase{ .term = "する", .source = "します", .rule = RuleType::vs, .reasons = { "polite" } },
TestCase{ .term = "する", .source = "した", .rule = RuleType::vs, .reasons = { "past" } },
TestCase{ .term = "する", .source = "しました", .rule = RuleType::vs, .reasons = { "polite past" } },
TestCase{ .term = "する", .source = "して", .rule = RuleType::vs, .reasons = { "-te" } },
TestCase{ .term = "する", .source = "できる", .rule = RuleType::vs, .reasons = { "potential" } },
TestCase{ .term = "する", .source = "出来る", .rule = RuleType::vs, .reasons = { "potential" } },
TestCase{ .term = "する", .source = "せられる", .rule = RuleType::vs, .reasons = { "potential or passive" } },
TestCase{ .term = "する", .source = "される", .rule = RuleType::vs, .reasons = { "passive" } },
TestCase{ .term = "する", .source = "させる", .rule = RuleType::vs, .reasons = { "causative" } },
TestCase{ .term = "する", .source = "せさせる", .rule = RuleType::vs, .reasons = { "causative" } },
TestCase{ .term = "する", .source = "させられる", .rule = RuleType::vs, .reasons = { "causative", "potential or passive" } },
TestCase{ .term = "する", .source = "せさせられる", .rule = RuleType::vs, .reasons = { "causative", "potential or passive" } },
TestCase{ .term = "する", .source = "しろ", .rule = RuleType::vs, .reasons = { "imperative" } },
TestCase{ .term = "する", .source = "しない", .rule = RuleType::vs, .reasons = { "negative" } },
TestCase{ .term = "する", .source = "しません", .rule = RuleType::vs, .reasons = { "polite negative" } },
TestCase{ .term = "する", .source = "しなかった", .rule = RuleType::vs, .reasons = { "negative", "past" } },
TestCase{ .term = "する", .source = "しませんでした", .rule = RuleType::vs, .reasons = { "polite past negative" } },
TestCase{ .term = "する", .source = "しなくて", .rule = RuleType::vs, .reasons = { "negative", "-te" } },
TestCase{ .term = "する", .source = "せられない", .rule = RuleType::vs, .reasons = { "potential or passive", "negative" } },
TestCase{ .term = "する", .source = "されない", .rule = RuleType::vs, .reasons = { "passive", "negative" } },
TestCase{ .term = "する", .source = "させない", .rule = RuleType::vs, .reasons = { "causative", "negative" } },
TestCase{ .term = "する", .source = "せさせない", .rule = RuleType::vs, .reasons = { "causative", "negative" } },
TestCase{ .term = "する",
.source = "させられない",
.rule = RuleType::vs,
.reasons = { "causative", "potential or passive", "negative" } },
TestCase{ .term = "する",
.source = "せさせられない",
.rule = RuleType::vs,
.reasons = { "causative", "potential or passive", "negative" } },
TestCase{ .term = "する", .source = "するな", .rule = RuleType::vs, .reasons = { "imperative negative" } },
TestCase{ .term = "する", .source = "すれば", .rule = RuleType::vs, .reasons = { "-ba" } },
TestCase{ .term = "する", .source = "しちゃう", .rule = RuleType::vs, .reasons = { "-chau" } },
TestCase{ .term = "する", .source = "しちまう", .rule = RuleType::vs, .reasons = { "-chimau" } },
TestCase{ .term = "する", .source = "しなさい", .rule = RuleType::vs, .reasons = { "-nasai" } },
TestCase{ .term = "する", .source = "しそう", .rule = RuleType::vs, .reasons = { "-sou" } },
TestCase{ .term = "する", .source = "しすぎる", .rule = RuleType::vs, .reasons = { "-sugiru" } },
TestCase{ .term = "する", .source = "したい", .rule = RuleType::vs, .reasons = { "-tai" } },
TestCase{ .term = "する", .source = "したら", .rule = RuleType::vs, .reasons = { "-tara" } },
TestCase{ .term = "する", .source = "したり", .rule = RuleType::vs, .reasons = { "-tari" } },
TestCase{ .term = "する", .source = "せず", .rule = RuleType::vs, .reasons = { "-zu" } },
TestCase{ .term = "する", .source = "せぬ", .rule = RuleType::vs, .reasons = { "-nu" } },
// {"masu stem"}
TestCase{ .term = "する", .source = "しましょう", .rule = RuleType::vs, .reasons = { "polite volitional" } },
TestCase{ .term = "する", .source = "しよう", .rule = RuleType::vs, .reasons = { "volitional" } },
// {"causative passive"}
TestCase{ .term = "する", .source = "しとく", .rule = RuleType::vs, .reasons = { "-toku" } },
TestCase{ .term = "する", .source = "している", .rule = RuleType::vs, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "する", .source = "しておる", .rule = RuleType::vs, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "する", .source = "してる", .rule = RuleType::vs, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "する", .source = "しとる", .rule = RuleType::vs, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "する", .source = "してしまう", .rule = RuleType::vs, .reasons = { "-te", "-shimau" } },
TestCase{ .term = "来る", .source = "来る", .rule = RuleType::vk, .reasons = {} },
TestCase{ .term = "来る", .source = "来ます", .rule = RuleType::vk, .reasons = { "polite" } },
TestCase{ .term = "来る", .source = "来た", .rule = RuleType::vk, .reasons = { "past" } },
TestCase{ .term = "来る", .source = "来ました", .rule = RuleType::vk, .reasons = { "polite past" } },
TestCase{ .term = "来る", .source = "来て", .rule = RuleType::vk, .reasons = { "-te" } },
TestCase{ .term = "来る", .source = "来られる", .rule = RuleType::vk, .reasons = { "potential or passive" } },
TestCase{ .term = "来る", .source = "来られる", .rule = RuleType::vk, .reasons = { "potential or passive" } },
TestCase{ .term = "来る", .source = "来させる", .rule = RuleType::vk, .reasons = { "causative" } },
TestCase{ .term = "来る", .source = "来させられる", .rule = RuleType::vk, .reasons = { "causative", "potential or passive" } },
TestCase{ .term = "来る", .source = "来い", .rule = RuleType::vk, .reasons = { "imperative" } },
TestCase{ .term = "来る", .source = "来ない", .rule = RuleType::vk, .reasons = { "negative" } },
TestCase{ .term = "来る", .source = "来ません", .rule = RuleType::vk, .reasons = { "polite negative" } },
TestCase{ .term = "来る", .source = "来なかった", .rule = RuleType::vk, .reasons = { "negative", "past" } },
TestCase{ .term = "来る", .source = "来ませんでした", .rule = RuleType::vk, .reasons = { "polite past negative" } },
TestCase{ .term = "来る", .source = "来なくて", .rule = RuleType::vk, .reasons = { "negative", "-te" } },
TestCase{ .term = "来る", .source = "来られない", .rule = RuleType::vk, .reasons = { "potential or passive", "negative" } },
TestCase{ .term = "来る", .source = "来られない", .rule = RuleType::vk, .reasons = { "potential or passive", "negative" } },
TestCase{ .term = "来る", .source = "来させない", .rule = RuleType::vk, .reasons = { "causative", "negative" } },
TestCase{ .term = "来る",
.source = "来させられない",
.rule = RuleType::vk,
.reasons = { "causative", "potential or passive", "negative" } },
TestCase{ .term = "来る", .source = "来るな", .rule = RuleType::vk, .reasons = { "imperative negative" } },
TestCase{ .term = "来る", .source = "来れば", .rule = RuleType::vk, .reasons = { "-ba" } },
TestCase{ .term = "来る", .source = "来ちゃう", .rule = RuleType::vk, .reasons = { "-chau" } },
TestCase{ .term = "来る", .source = "来ちまう", .rule = RuleType::vk, .reasons = { "-chimau" } },
TestCase{ .term = "来る", .source = "来なさい", .rule = RuleType::vk, .reasons = { "-nasai" } },
TestCase{ .term = "来る", .source = "来そう", .rule = RuleType::vk, .reasons = { "-sou" } },
TestCase{ .term = "来る", .source = "来すぎる", .rule = RuleType::vk, .reasons = { "-sugiru" } },
TestCase{ .term = "来る", .source = "来たい", .rule = RuleType::vk, .reasons = { "-tai" } },
TestCase{ .term = "来る", .source = "来たら", .rule = RuleType::vk, .reasons = { "-tara" } },
TestCase{ .term = "来る", .source = "来たり", .rule = RuleType::vk, .reasons = { "-tari" } },
TestCase{ .term = "来る", .source = "来ず", .rule = RuleType::vk, .reasons = { "-zu" } },
TestCase{ .term = "来る", .source = "来ぬ", .rule = RuleType::vk, .reasons = { "-nu" } },
TestCase{ .term = "来る", .source = "来", .rule = RuleType::vk, .reasons = { "masu stem" } },
TestCase{ .term = "来る", .source = "来ましょう", .rule = RuleType::vk, .reasons = { "polite volitional" } },
TestCase{ .term = "来る", .source = "来よう", .rule = RuleType::vk, .reasons = { "volitional" } },
// {"causative passive"}
TestCase{ .term = "来る", .source = "来とく", .rule = RuleType::vk, .reasons = { "-toku" } },
TestCase{ .term = "来る", .source = "来ている", .rule = RuleType::vk, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "来る", .source = "来ておる", .rule = RuleType::vk, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "来る", .source = "来てる", .rule = RuleType::vk, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "来る", .source = "来とる", .rule = RuleType::vk, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "来る", .source = "来てしまう", .rule = RuleType::vk, .reasons = { "-te", "-shimau" } },
TestCase{ .term = "來る", .source = "來る", .rule = RuleType::vk, .reasons = {} },
TestCase{ .term = "來る", .source = "來ます", .rule = RuleType::vk, .reasons = { "polite" } },
TestCase{ .term = "來る", .source = "來た", .rule = RuleType::vk, .reasons = { "past" } },
TestCase{ .term = "來る", .source = "來ました", .rule = RuleType::vk, .reasons = { "polite past" } },
TestCase{ .term = "來る", .source = "來て", .rule = RuleType::vk, .reasons = { "-te" } },
TestCase{ .term = "來る", .source = "來られる", .rule = RuleType::vk, .reasons = { "potential or passive" } },
TestCase{ .term = "來る", .source = "來られる", .rule = RuleType::vk, .reasons = { "potential or passive" } },
TestCase{ .term = "來る", .source = "來させる", .rule = RuleType::vk, .reasons = { "causative" } },
TestCase{ .term = "來る", .source = "來させられる", .rule = RuleType::vk, .reasons = { "causative", "potential or passive" } },
TestCase{ .term = "來る", .source = "來い", .rule = RuleType::vk, .reasons = { "imperative" } },
TestCase{ .term = "來る", .source = "來ない", .rule = RuleType::vk, .reasons = { "negative" } },
TestCase{ .term = "來る", .source = "來ません", .rule = RuleType::vk, .reasons = { "polite negative" } },
TestCase{ .term = "來る", .source = "來なかった", .rule = RuleType::vk, .reasons = { "negative", "past" } },
TestCase{ .term = "來る", .source = "來ませんでした", .rule = RuleType::vk, .reasons = { "polite past negative" } },
TestCase{ .term = "來る", .source = "來なくて", .rule = RuleType::vk, .reasons = { "negative", "-te" } },
TestCase{ .term = "來る", .source = "來られない", .rule = RuleType::vk, .reasons = { "potential or passive", "negative" } },
TestCase{ .term = "來る", .source = "來られない", .rule = RuleType::vk, .reasons = { "potential or passive", "negative" } },
TestCase{ .term = "來る", .source = "來させない", .rule = RuleType::vk, .reasons = { "causative", "negative" } },
TestCase{ .term = "來る",
.source = "來させられない",
.rule = RuleType::vk,
.reasons = { "causative", "potential or passive", "negative" } },
TestCase{ .term = "來る", .source = "來るな", .rule = RuleType::vk, .reasons = { "imperative negative" } },
TestCase{ .term = "來る", .source = "來れば", .rule = RuleType::vk, .reasons = { "-ba" } },
TestCase{ .term = "來る", .source = "來ちゃう", .rule = RuleType::vk, .reasons = { "-chau" } },
TestCase{ .term = "來る", .source = "來ちまう", .rule = RuleType::vk, .reasons = { "-chimau" } },
TestCase{ .term = "來る", .source = "來なさい", .rule = RuleType::vk, .reasons = { "-nasai" } },
TestCase{ .term = "來る", .source = "來そう", .rule = RuleType::vk, .reasons = { "-sou" } },
TestCase{ .term = "來る", .source = "來すぎる", .rule = RuleType::vk, .reasons = { "-sugiru" } },
TestCase{ .term = "來る", .source = "來たい", .rule = RuleType::vk, .reasons = { "-tai" } },
TestCase{ .term = "來る", .source = "來たら", .rule = RuleType::vk, .reasons = { "-tara" } },
TestCase{ .term = "來る", .source = "來たり", .rule = RuleType::vk, .reasons = { "-tari" } },
TestCase{ .term = "來る", .source = "來ず", .rule = RuleType::vk, .reasons = { "-zu" } },
TestCase{ .term = "來る", .source = "來ぬ", .rule = RuleType::vk, .reasons = { "-nu" } },
TestCase{ .term = "來る", .source = "來", .rule = RuleType::vk, .reasons = { "masu stem" } },
TestCase{ .term = "來る", .source = "來ましょう", .rule = RuleType::vk, .reasons = { "polite volitional" } },
TestCase{ .term = "來る", .source = "來よう", .rule = RuleType::vk, .reasons = { "volitional" } },
// {"causative passive"}
TestCase{ .term = "來る", .source = "來とく", .rule = RuleType::vk, .reasons = { "-toku" } },
TestCase{ .term = "來る", .source = "來ている", .rule = RuleType::vk, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "來る", .source = "來ておる", .rule = RuleType::vk, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "來る", .source = "來てる", .rule = RuleType::vk, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "來る", .source = "來とる", .rule = RuleType::vk, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "來る", .source = "來てしまう", .rule = RuleType::vk, .reasons = { "-te", "-shimau" } },
TestCase{ .term = "くる", .source = "くる", .rule = RuleType::vk, .reasons = {} },
TestCase{ .term = "くる", .source = "きます", .rule = RuleType::vk, .reasons = { "polite" } },
TestCase{ .term = "くる", .source = "きた", .rule = RuleType::vk, .reasons = { "past" } },
TestCase{ .term = "くる", .source = "きました", .rule = RuleType::vk, .reasons = { "polite past" } },
TestCase{ .term = "くる", .source = "きて", .rule = RuleType::vk, .reasons = { "-te" } },
TestCase{ .term = "くる", .source = "こられる", .rule = RuleType::vk, .reasons = { "potential or passive" } },
TestCase{ .term = "くる", .source = "こられる", .rule = RuleType::vk, .reasons = { "potential or passive" } },
TestCase{ .term = "くる", .source = "こさせる", .rule = RuleType::vk, .reasons = { "causative" } },
TestCase{ .term = "くる", .source = "こさせられる", .rule = RuleType::vk, .reasons = { "causative", "potential or passive" } },
TestCase{ .term = "くる", .source = "こい", .rule = RuleType::vk, .reasons = { "imperative" } },
TestCase{ .term = "くる", .source = "こない", .rule = RuleType::vk, .reasons = { "negative" } },
TestCase{ .term = "くる", .source = "きません", .rule = RuleType::vk, .reasons = { "polite negative" } },
TestCase{ .term = "くる", .source = "こなかった", .rule = RuleType::vk, .reasons = { "negative", "past" } },
TestCase{ .term = "くる", .source = "きませんでした", .rule = RuleType::vk, .reasons = { "polite past negative" } },
TestCase{ .term = "くる", .source = "こなくて", .rule = RuleType::vk, .reasons = { "negative", "-te" } },
TestCase{ .term = "くる", .source = "こられない", .rule = RuleType::vk, .reasons = { "potential or passive", "negative" } },
TestCase{ .term = "くる", .source = "こられない", .rule = RuleType::vk, .reasons = { "potential or passive", "negative" } },
TestCase{ .term = "くる", .source = "こさせない", .rule = RuleType::vk, .reasons = { "causative", "negative" } },
TestCase{ .term = "くる",
.source = "こさせられない",
.rule = RuleType::vk,
.reasons = { "causative", "potential or passive", "negative" } },
TestCase{ .term = "くる", .source = "くるな", .rule = RuleType::vk, .reasons = { "imperative negative" } },
TestCase{ .term = "くる", .source = "くれば", .rule = RuleType::vk, .reasons = { "-ba" } },
TestCase{ .term = "くる", .source = "きちゃう", .rule = RuleType::vk, .reasons = { "-chau" } },
TestCase{ .term = "くる", .source = "きちまう", .rule = RuleType::vk, .reasons = { "-chimau" } },
TestCase{ .term = "くる", .source = "きなさい", .rule = RuleType::vk, .reasons = { "-nasai" } },
TestCase{ .term = "くる", .source = "きそう", .rule = RuleType::vk, .reasons = { "-sou" } },
TestCase{ .term = "くる", .source = "きすぎる", .rule = RuleType::vk, .reasons = { "-sugiru" } },
TestCase{ .term = "くる", .source = "きたい", .rule = RuleType::vk, .reasons = { "-tai" } },
TestCase{ .term = "くる", .source = "きたら", .rule = RuleType::vk, .reasons = { "-tara" } },
TestCase{ .term = "くる", .source = "きたり", .rule = RuleType::vk, .reasons = { "-tari" } },
TestCase{ .term = "くる", .source = "こず", .rule = RuleType::vk, .reasons = { "-zu" } },
TestCase{ .term = "くる", .source = "こぬ", .rule = RuleType::vk, .reasons = { "-nu" } },
TestCase{ .term = "くる", .source = "き", .rule = RuleType::vk, .reasons = { "masu stem" } },
TestCase{ .term = "くる", .source = "きましょう", .rule = RuleType::vk, .reasons = { "polite volitional" } },
TestCase{ .term = "くる", .source = "こよう", .rule = RuleType::vk, .reasons = { "volitional" } },
// {"causative passive"}
TestCase{ .term = "くる", .source = "きとく", .rule = RuleType::vk, .reasons = { "-toku" } },
TestCase{ .term = "くる", .source = "きている", .rule = RuleType::vk, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "くる", .source = "きておる", .rule = RuleType::vk, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "くる", .source = "きてる", .rule = RuleType::vk, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "くる", .source = "きとる", .rule = RuleType::vk, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "くる", .source = "きてしまう", .rule = RuleType::vk, .reasons = { "-te", "-shimau" } },
// Zuru verbs
TestCase{ .term = "論ずる", .source = "論ずる", .rule = RuleType::vz, .reasons = {} },
TestCase{ .term = "論ずる", .source = "論じます", .rule = RuleType::vz, .reasons = { "polite" } },
TestCase{ .term = "論ずる", .source = "論じた", .rule = RuleType::vz, .reasons = { "past" } },
TestCase{ .term = "論ずる", .source = "論じました", .rule = RuleType::vz, .reasons = { "polite past" } },
TestCase{ .term = "論ずる", .source = "論じて", .rule = RuleType::vz, .reasons = { "-te" } },
TestCase{ .term = "論ずる", .source = "論ぜられる", .rule = RuleType::vz, .reasons = { "potential or passive" } },
TestCase{ .term = "論ずる", .source = "論ざれる", .rule = RuleType::vz, .reasons = { "potential or passive" } },
TestCase{ .term = "論ずる", .source = "論じされる", .rule = RuleType::vz, .reasons = { "passive" } },
TestCase{ .term = "論ずる", .source = "論ぜされる", .rule = RuleType::vz, .reasons = { "passive" } },
TestCase{ .term = "論ずる", .source = "論じさせる", .rule = RuleType::vz, .reasons = { "causative" } },
TestCase{ .term = "論ずる", .source = "論ぜさせる", .rule = RuleType::vz, .reasons = { "causative" } },
TestCase{ .term = "論ずる",
.source = "論じさせられる",
.rule = RuleType::vz,
.reasons = { "causative", "potential or passive" } },
TestCase{ .term = "論ずる",
.source = "論ぜさせられる",
.rule = RuleType::vz,
.reasons = { "causative", "potential or passive" } },
TestCase{ .term = "論ずる", .source = "論じろ", .rule = RuleType::vz, .reasons = { "imperative" } },
TestCase{ .term = "論ずる", .source = "論じない", .rule = RuleType::vz, .reasons = { "negative" } },
TestCase{ .term = "論ずる", .source = "論じません", .rule = RuleType::vz, .reasons = { "polite negative" } },
TestCase{ .term = "論ずる", .source = "論じなかった", .rule = RuleType::vz, .reasons = { "negative", "past" } },
TestCase{ .term = "論ずる", .source = "論じませんでした", .rule = RuleType::vz, .reasons = { "polite past negative" } },
TestCase{ .term = "論ずる", .source = "論じなくて", .rule = RuleType::vz, .reasons = { "negative", "-te" } },
TestCase{ .term = "論ずる", .source = "論ぜられない", .rule = RuleType::vz, .reasons = { "potential or passive", "negative" } },
TestCase{ .term = "論ずる", .source = "論じされない", .rule = RuleType::vz, .reasons = { "passive", "negative" } },
TestCase{ .term = "論ずる", .source = "論ぜされない", .rule = RuleType::vz, .reasons = { "passive", "negative" } },
TestCase{ .term = "論ずる", .source = "論じさせない", .rule = RuleType::vz, .reasons = { "causative", "negative" } },
TestCase{ .term = "論ずる", .source = "論ぜさせない", .rule = RuleType::vz, .reasons = { "causative", "negative" } },
TestCase{ .term = "論ずる",
.source = "論じさせられない",
.rule = RuleType::vz,
.reasons = { "causative", "potential or passive", "negative" } },
TestCase{ .term = "論ずる",
.source = "論ぜさせられない",
.rule = RuleType::vz,
.reasons = { "causative", "potential or passive", "negative" } },
TestCase{ .term = "論ずる", .source = "論ずるな", .rule = RuleType::vz, .reasons = { "imperative negative" } },
TestCase{ .term = "論ずる", .source = "論ずれば", .rule = RuleType::vz, .reasons = { "-ba" } },
TestCase{ .term = "論ずる", .source = "論じちゃう", .rule = RuleType::vz, .reasons = { "-chau" } },
TestCase{ .term = "論ずる", .source = "論じちまう", .rule = RuleType::vz, .reasons = { "-chimau" } },
TestCase{ .term = "論ずる", .source = "論じなさい", .rule = RuleType::vz, .reasons = { "-nasai" } },
TestCase{ .term = "論ずる", .source = "論じそう", .rule = RuleType::vz, .reasons = { "-sou" } },
TestCase{ .term = "論ずる", .source = "論じすぎる", .rule = RuleType::vz, .reasons = { "-sugiru" } },
TestCase{ .term = "論ずる", .source = "論じたい", .rule = RuleType::vz, .reasons = { "-tai" } },
TestCase{ .term = "論ずる", .source = "論じたら", .rule = RuleType::vz, .reasons = { "-tara" } },
TestCase{ .term = "論ずる", .source = "論じたり", .rule = RuleType::vz, .reasons = { "-tari" } },
TestCase{ .term = "論ずる", .source = "論ぜず", .rule = RuleType::vz, .reasons = { "-zu" } },
TestCase{ .term = "論ずる", .source = "論ぜぬ", .rule = RuleType::vz, .reasons = { "-nu" } },
// {"masu stem"}
TestCase{ .term = "論ずる", .source = "論じましょう", .rule = RuleType::vz, .reasons = { "polite volitional" } },
TestCase{ .term = "論ずる", .source = "論じよう", .rule = RuleType::vz, .reasons = { "volitional" } },
// {"causative passive"}
TestCase{ .term = "論ずる", .source = "論じとく", .rule = RuleType::vz, .reasons = { "-toku" } },
TestCase{ .term = "論ずる", .source = "論じている", .rule = RuleType::vz, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "論ずる", .source = "論じておる", .rule = RuleType::vz, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "論ずる", .source = "論じてる", .rule = RuleType::vz, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "論ずる", .source = "論じとる", .rule = RuleType::vz, .reasons = { "-te", "progressive or perfect" } },
TestCase{ .term = "論ずる", .source = "論じてしまう", .rule = RuleType::vz, .reasons = { "-te", "-shimau" } },
// Uncommon irregular verbs
TestCase{ .term = "のたまう", .source = "のたもうて", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "のたまう", .source = "のたもうた", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "のたまう", .source = "のたもうたら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "のたまう", .source = "のたもうたり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "おう", .source = "おうて", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "こう", .source = "こうて", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "そう", .source = "そうて", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "とう", .source = "とうて", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "請う", .source = "請うて", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "乞う", .source = "乞うて", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "恋う", .source = "恋うて", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "問う", .source = "問うて", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "負う", .source = "負うて", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "沿う", .source = "沿うて", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "添う", .source = "添うて", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "副う", .source = "副うて", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "厭う", .source = "厭うて", .rule = RuleType::v5, .reasons = { "-te" } },
TestCase{ .term = "おう", .source = "おうた", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "こう", .source = "こうた", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "そう", .source = "そうた", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "とう", .source = "とうた", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "請う", .source = "請うた", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "乞う", .source = "乞うた", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "恋う", .source = "恋うた", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "問う", .source = "問うた", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "負う", .source = "負うた", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "沿う", .source = "沿うた", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "添う", .source = "添うた", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "副う", .source = "副うた", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "厭う", .source = "厭うた", .rule = RuleType::v5, .reasons = { "past" } },
TestCase{ .term = "おう", .source = "おうたら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "こう", .source = "こうたら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "そう", .source = "そうたら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "とう", .source = "とうたら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "請う", .source = "請うたら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "乞う", .source = "乞うたら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "恋う", .source = "恋うたら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "問う", .source = "問うたら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "負う", .source = "負うたら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "沿う", .source = "沿うたら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "添う", .source = "添うたら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "副う", .source = "副うたら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "厭う", .source = "厭うたら", .rule = RuleType::v5, .reasons = { "-tara" } },
TestCase{ .term = "おう", .source = "おうたり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "こう", .source = "こうたり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "そう", .source = "そうたり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "とう", .source = "とうたり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "請う", .source = "請うたり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "乞う", .source = "乞うたり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "恋う", .source = "恋うたり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "問う", .source = "問うたり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "負う", .source = "負うたり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "沿う", .source = "沿うたり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "添う", .source = "添うたり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "副う", .source = "副うたり", .rule = RuleType::v5, .reasons = { "-tari" } },
TestCase{ .term = "厭う", .source = "厭うたり", .rule = RuleType::v5, .reasons = { "-tari" } },
// Combinations
TestCase{ .term = "抱き抱える",
.source = "抱き抱えていなければ",
.rule = RuleType::v1,
.reasons = { "-te", "progressive or perfect", "negative", "-ba" } },
TestCase{ .term = "抱きかかえる",
.source = "抱きかかえていなければ",
.rule = RuleType::v1,
.reasons = { "-te", "progressive or perfect", "negative", "-ba" } },
TestCase{ .term = "打ち込む",
.source = "打ち込んでいませんでした",
.rule = RuleType::v5,
.reasons = { "-te", "progressive or perfect", "polite past negative" } },
TestCase{ .term = "食べる",
.source = "食べさせられたくなかった",
.rule = RuleType::v1,
.reasons = { "causative", "potential or passive", "-tai", "negative", "past" } } }
},
TestGroup{
.valid= false,
.tests= { { .term = "する", .source = "すます", .rule = RuleType::vs },
TestCase{ .term = "する", .source = "すた", .rule = RuleType::vs },
TestCase{ .term = "する", .source = "すました", .rule = RuleType::vs },
TestCase{ .term = "する", .source = "すて", .rule = RuleType::vs },
TestCase{ .term = "する", .source = "すれる", .rule = RuleType::vs },
TestCase{ .term = "する", .source = "すせる", .rule = RuleType::vs },
TestCase{ .term = "する", .source = "すせられる", .rule = RuleType::vs },
TestCase{ .term = "する", .source = "すろ", .rule = RuleType::vs },
TestCase{ .term = "する", .source = "すない", .rule = RuleType::vs },
TestCase{ .term = "する", .source = "すません", .rule = RuleType::vs },
TestCase{ .term = "する", .source = "すなかった", .rule = RuleType::vs },
TestCase{ .term = "する", .source = "すませんでした", .rule = RuleType::vs },
TestCase{ .term = "する", .source = "すなくて", .rule = RuleType::vs },
TestCase{ .term = "する", .source = "すれない", .rule = RuleType::vs },
TestCase{ .term = "する", .source = "すせない", .rule = RuleType::vs },
TestCase{ .term = "する", .source = "すせられない", .rule = RuleType::vs },
TestCase{ .term = "くる", .source = "くます", .rule = RuleType::vk },
TestCase{ .term = "くる", .source = "くた", .rule = RuleType::vk },
TestCase{ .term = "くる", .source = "くました", .rule = RuleType::vk },
TestCase{ .term = "くる", .source = "くて", .rule = RuleType::vk },
TestCase{ .term = "くる", .source = "くられる", .rule = RuleType::vk },
TestCase{ .term = "くる", .source = "くられる", .rule = RuleType::vk },
TestCase{ .term = "くる", .source = "くさせる", .rule = RuleType::vk },
TestCase{ .term = "くる", .source = "くさせられる", .rule = RuleType::vk },
TestCase{ .term = "くる", .source = "くい", .rule = RuleType::vk },
TestCase{ .term = "くる", .source = "くない", .rule = RuleType::vk },
TestCase{ .term = "くる", .source = "くません", .rule = RuleType::vk },
TestCase{ .term = "くる", .source = "くなかった", .rule = RuleType::vk },
TestCase{ .term = "くる", .source = "くませんでした", .rule = RuleType::vk },
TestCase{ .term = "くる", .source = "くなくて", .rule = RuleType::vk },
TestCase{ .term = "くる", .source = "くられない", .rule = RuleType::vk },
TestCase{ .term = "くる", .source = "くられない", .rule = RuleType::vk },
TestCase{ .term = "くる", .source = "くさせない", .rule = RuleType::vk },
TestCase{ .term = "くる", .source = "くさせられない", .rule = RuleType::vk },
TestCase{ .term = "かわいい", .source = "かわいげ", .rule = RuleType::adj_i, .reasons = { "-ge" } },
TestCase{ .term = "可愛い", .source = "かわいげ", .rule = RuleType::adj_i, .reasons = { "-ge" } } }
},
TestGroup{
.valid= true,
.tests= { // -e
TestCase{ .term = "すごい", .source = "すげえ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "やばい", .source = "やべえ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "うるさい", .source = "うるせえ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "ひどい", .source = "ひでえ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "ない", .source = "ねえ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "できる", .source = "できねえ", .rule = RuleType::v1, .reasons = { "negative", "-e" } },
TestCase{ .term = "しんじる", .source = "しんじねえ", .rule = RuleType::v1, .reasons = { "negative", "-e" } },
TestCase{ .term = "さむい", .source = "さめえ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "さむい", .source = "さみい", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "あつい", .source = "あちぇえ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "あつい", .source = "あちい", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "やすい", .source = "やせえ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "たかい", .source = "たけえ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "かわいい", .source = "かわええ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "つよい", .source = "ついぇえ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "こわい", .source = "こうぇえ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "みじかい", .source = "みじけえ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "ながい", .source = "なげえ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "くさい", .source = "くせえ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "うまい", .source = "うめえ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "でかい", .source = "でけえ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "まずい", .source = "まっぜえ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "ちっちゃい", .source = "ちっちぇえ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "あかい", .source = "あけえ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "こわい", .source = "こええ", .rule = RuleType::adj_i, .reasons = { "-e" } },
TestCase{ .term = "つよい", .source = "つええ", .rule = RuleType::adj_i, .reasons = { "-e" } } }
}
};
}
} // namespace ajt::rdricpp

56
rdricpp/tests/test_cases.h Normal file
View file

@ -0,0 +1,56 @@
/*
* Rikaitan Deinflector Reference Implementation
*
* Copyright (C) 2023 Ajatt-Tools and contributors
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, visit the http://fsf.org website.
*/
#pragma once
#include "rdricpp/ostream.h"
#include "rdricpp/types.h"
#include <ostream>
#include <string>
#include <vector>
namespace ajt::rdricpp {
struct TestCase
{
std::string term{};
std::string source{};
RuleType rule{};
std::vector<std::string> reasons{};
};
inline auto& operator<<(std::ostream& os, TestCase const& test_case)
{
os << "{.term=" << test_case.term //
<< ", .source=" << test_case.source //
<< ", .rule=" << test_case.rule //
<< ", .reasons=" << test_case.reasons //
<< "}";
return os;
}
struct TestGroup
{
bool valid{};
std::vector<TestCase> tests{};
};
std::vector<TestGroup> test_groups();
}

48
rdricpp/tests/tests.cpp Normal file
View file

@ -0,0 +1,48 @@
/*
* Rikaitan Deinflector Reference Implementation
*
* Copyright (C) 2023 Ajatt-Tools and contributors
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, visit the http://fsf.org website.
*/
#include "rdricpp/rdricpp.h"
#include "test_cases.h"
#include <algorithm>
#include <catch2/catch_test_macros.hpp>
#include <ranges>
namespace ajt::rdricpp {
bool is_result_included(std::vector<Deinflection> const& results, TestCase const& test_case)
{
return std::ranges::any_of(std::views::all(results), [&test_case](Deinflection const& result) {
return (
result.term == test_case.term
and (result.rules == RuleType::none or (test_case.rule & result.rules) == test_case.rule)
and test_case.reasons == result.reasons
);
});
}
TEST_CASE("Deinflect", "[deinflect]")
{
for (TestGroup const& group: test_groups()) {
for (TestCase const& test_case: group.tests) {
REQUIRE(group.valid == is_result_included(deinflect(test_case.source), test_case));
}
}
}
} // namespace ajt::rdricpp

BIN
res/ArmedLemon.ttf Normal file
View file

Binary file not shown.

BIN
res/KanjiStrokeOrders_v4.004.ttf Normal file
View file

Binary file not shown.

1
res/download-font.txt Normal file
View file

@ -0,0 +1 @@
https://www.nihilist.org.uk/

BIN
res/mandarin_dict/char.bin Normal file
View file

Binary file not shown.

41
res/mandarin_dict/dicrc Normal file
View file

@ -0,0 +1,41 @@
; List of features
; f[0]: pos1
; f[1]: pos2
; f[2]: pos3
; f[3]: pos4
; f[4]: pinyin pronunciation
; f[5]: traditional Chinese character form
; f[6]: simplified Chinese character form
; f[7]: definition
cost-factor = 700
bos-feature = BOS/EOS,*,*,*,*,*,*,*,*,*,*,*,*,*,*,*,*
; If the analysis target is a known word, eval-size specifies criteria for correct answers.
; Unlike Japanese, Chinese has no conjugation.
; Therefore, four elements that are pos 1, 2, 3, 4 are evaluated. Other elements, such as pronunciation information, are ignored.
eval-size = 4
unk-eval-size = 4
config-charset = utf8
output-format-type = cedict
node-format-cedict = %m\t%f[0],%f[1],%f[2],%f[3],%f[4],%f[5],%f[6],%f[7]\n
unk-format-cedict = %m\t%f[0],%f[1],%f[2],%f[3],%f[4],%f[5]\n
bos-format-cedict =
eos-format-cedict = EOS\n
node-format-traditional = %f[5]
unk-format-traditional = %f[5]
bos-format-traditional =
eos-format-traditional = \n
node-format-simplified = %f[6]
unk-format-simplified = %f[6]
bos-format-simplified =
eos-format-simplified = \n
node-format-gdmandarin = <a href="bword:%f[5]">%f[5]</a>
unk-format-gdmandarin = <a href="bword:%f[5]">%f[5]</a>
bos-format-gdmandarin =
eos-format-gdmandarin = \n

BIN
res/mandarin_dict/matrix.bin Normal file
View file

Binary file not shown.

BIN
res/mandarin_dict/sys.dic Normal file
View file

Binary file not shown.

BIN
res/mandarin_dict/unk.dic Executable file
View file

Binary file not shown.

BIN
res/mandarin_dict/user.dic Normal file
View file

Binary file not shown.

BIN
res/marisa_words.dic Normal file
View file

Binary file not shown.

1284684
res/marisa_words.raw Normal file
View file

File diff suppressed because it is too large Load diff

BIN
res/user_dic.dic Normal file
View file

Binary file not shown.

310
src/anki_search.cpp Normal file
View file

@ -0,0 +1,310 @@
/*
* gd-tools - a set of programs to enhance goldendict for immersion learning.
* Copyright (C) 2023 Ajatt-Tools
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "anki_search.h"
#include "precompiled.h"
#include "util.h"
// reference
// https://camo.githubusercontent.com/192ba92ba3971bbb9eecede21c5f8d3a0a1afd52516af28a199335813e75f243/68747470733a2f2f692e696d6775722e636f6d2f6958335648484f2e706e67
// todo print tags (with links)
using namespace std::string_view_literals;
using json = nlohmann::json;
static constexpr auto ankiconnect_addr{ "127.0.0.1:8765"sv };
static constexpr std::chrono::seconds timeout{ 3U };
static constexpr std::size_t expected_n_fields{ 10 };
static constexpr std::string_view help_text = R"EOF(usage: gd-ankisearch [OPTIONS]
Search your Anki collection and output Note Ids that match query.
OPTIONS
--field-name NAME optional field to limit search to.
--deck-name NAME optional deck to limit search to.
--show-fields F1,F2 optional comma-separated list of fields to show.
--word WORD required search term
EXAMPLES
gd-ankisearch --field-name VocabKanji --word %GDWORD%
gd-ankisearch --deck-name Mining --word %GDWORD%
)EOF";
static constexpr std::string_view css_style = R"EOF(<style>
.gd-ankisearch-table {
font-family: arial, sans-serif;
border-collapse: collapse;
border-spacing: 0;
max-width: 100%;
width: 100%;
display: block;
overflow-x: auto;
overscroll-behavior-inline: contain;
}
.gd-ankisearch-table td,
.gd-ankisearch-table th {
border: 1px solid #dddddd;
text-align: left;
padding: 4px;
}
.gd-ankisearch-table tr:nth-child(odd) {
background-color: #dddddd55;
}
.gd-ankisearch-table tr:first-child {
background-color: #00000011;
}
.gd-ankisearch-table tr.new {
border-bottom: 2px solid #3b82f6;
background-color: #3b82f611;
}
.gd-ankisearch-table tr.learning {
border-bottom: 2px solid #dc2626;
background-color: #dc262611;
}
.gd-ankisearch-table tr.review {
border-bottom: 2px solid #16a34a;
background-color: #16a34a11;
}
.gd-ankisearch-table tr.buried {
border-bottom: 2px solid #858585;
background-color: #85858511;
}
.gd-ankisearch-table tr.suspended {
border-bottom: 2px solid #ffe88d;
background-color: #ffe88d11;
}
.gd-ankisearch-table img {
max-height: 200px;
max-width: 200px;
}
.gd-ankisearch-table a {
color: #1b2c5d;
text-decoration: none;
}
.gd-ankisearch-table a:hover {
filter: hue-rotate(-20deg) brightness(120%);
}
</style>
)EOF";
using NameToValMap = std::unordered_map<std::string, std::string>;
struct card_info
{
uint64_t id;
int64_t queue;
int64_t type;
std::string deck_name;
NameToValMap fields;
};
auto split_anki_field_names(std::string_view const show_fields) -> std::vector<std::string>
{
// Expects a list of Anki fields separated by commas.
std::vector<std::string> parsed{};
parsed.reserve(expected_n_fields);
std::ranges::copy(
show_fields //
| std::views::split(',') //
| std::views::transform([](auto v) { return std::string(v.begin(), v.end()); }), //
std::back_inserter(parsed)
);
return parsed;
}
struct search_params
{
std::string_view gd_word{};
std::string_view field_name{};
std::string_view deck_name{};
std::vector<std::string> show_fields{};
void assign(std::string_view const key, std::string_view const value)
{
if (key == "--field-name") {
field_name = value;
} else if (key == "--deck-name") {
deck_name = value;
} else if (key == "--show-fields") {
show_fields = split_anki_field_names(value);
} else if (key == "--word") {
gd_word = value;
}
}
};
auto make_find_cards_request_str(search_params const& params) -> std::string
{
auto request = json::parse(R"EOF({
"action": "findCards",
"version": 6,
"params": {
"query": "deck:current"
}
})EOF");
std::string query{ params.gd_word };
if (not params.field_name.empty()) {
query = std::format("\"{}:*{}*\"", params.field_name, query);
}
if (not params.deck_name.empty()) {
query = std::format("\"deck:{}\" {}", params.deck_name, query);
}
request["params"]["query"] = query;
return request.dump();
}
auto make_get_media_dir_path_request_str() -> std::string
{
return R"EOF({
"action": "getMediaDirPath",
"version": 6
})EOF";
}
auto make_ankiconnect_request(std::string_view const request_str) -> cpr::Response
{
return cpr::Post(
cpr::Url{ ankiconnect_addr },
cpr::Body{ request_str },
cpr::Header{ { "Content-Type", "application/json" } },
cpr::Timeout{ timeout }
);
}
auto make_info_request_str(std::vector<uint64_t> const& cids)
{
auto request = json::parse(R"EOF({
"action": "cardsInfo",
"version": 6,
"params": {
"cards": []
}
})EOF");
request["params"]["cards"] = cids;
return request.dump();
}
auto get_cids_info(std::vector<uint64_t> const& cids) -> nlohmann::json
{
auto const request_str = make_info_request_str(cids);
cpr::Response const r = make_ankiconnect_request(request_str);
raise_if(r.status_code != cpr::status::HTTP_OK, "Couldn't connect to Anki.");
auto const obj = json::parse(r.text);
raise_if(not obj["error"].is_null(), "Error getting data from AnkiConnect.");
return obj["result"];
}
auto find_cids(search_params const& params) -> std::vector<uint64_t>
{
auto const request_str = make_find_cards_request_str(params);
cpr::Response const r = make_ankiconnect_request(request_str);
raise_if(r.status_code != cpr::status::HTTP_OK, "Couldn't connect to Anki.");
auto const obj = json::parse(r.text);
raise_if(not obj["error"].is_null(), "Error getting data from AnkiConnect.");
return obj["result"];
}
auto fetch_media_dir_path() -> std::string
{
auto const request_str = make_get_media_dir_path_request_str();
cpr::Response const r = make_ankiconnect_request(request_str);
raise_if(r.status_code != cpr::status::HTTP_OK, "Couldn't connect to Anki.");
auto const obj = json::parse(r.text);
raise_if(not obj["error"].is_null(), "Error getting data from AnkiConnect.");
return obj["result"];
}
void print_table_header(search_params const& params)
{
// Print the first row (header) that contains <th></th> tags, starting with Card ID.
print("<tr>");
print("<th>Card ID</th>");
print("<th>Deck name</th>");
for (auto const& field: params.show_fields) { print("<th>{}</th>", field); }
print("</tr>\n");
}
auto card_json_to_obj(nlohmann::json const& card_json) -> card_info
{
// https://github.com/FooSoft/anki-connect#cardsinfo
return {
.id = card_json["cardId"],
.queue = card_json["queue"],
.type = card_json["type"],
.deck_name = card_json["deckName"], //
.fields =
[&card_json]() {
NameToValMap result{};
for (auto const& element: card_json["fields"].items()) {
result.emplace(element.key(), element.value()["value"]);
}
return result;
}(), //
};
}
auto gd_format(std::string const& field_content, std::string const& media_dir_path) -> std::string
{
// Make sure GoldenDict displays images correctly by specifying the full path.
static std::regex const img_re{ "(<img[^<>]*src=\")" };
static std::regex const any_undesirables{ R"EOF(\[sound:|\]|<[^<>]+>|["'.,!?]+|…|。|、|！|？|　|・|～|\(|\))EOF" };
auto const link_content = strtrim(std::regex_replace(field_content, any_undesirables, " "));
auto const link_text = std::regex_replace(field_content, img_re, std::format("$1file://{}/", media_dir_path));
return link_content.empty() ? link_text : std::format("<a href=\"ankisearch:{}\">{}</a>", link_content, link_text);
}
void print_cards_info(search_params const& params)
{
auto const cids = find_cids(params);
if (cids.empty()) {
return print("No cards found.\n");
}
auto const media_dir_path = fetch_media_dir_path();
print("<table class=\"gd-ankisearch-table\">\n");
print_table_header(params);
for (auto const& card: get_cids_info(cids) | std::views::transform(card_json_to_obj)) {
print("<tr class=\"{}\">", determine_card_class(card.queue, card.type));
print("<td><a href=\"ankisearch:cid:{}\">{}</a></td>", card.id, card.id);
print("<td>{}</td>", card.deck_name);
for (auto const& field_name: params.show_fields) {
print(
"<td>{}</td>",
(card.fields.contains(field_name) and not card.fields.at(field_name).empty()
? gd_format(card.fields.at(field_name), media_dir_path)
: "Not present")
);
}
print("</tr>\n");
}
print("</table>\n");
print("{}\n", css_style);
}
void search_anki_cards(std::span<std::string_view const> const args)
{
try {
print_cards_info(fill_args<search_params>(args));
} catch (gd::help_requested const& ex) {
print(help_text);
} catch (gd::runtime_error const& ex) {
print("{}\n", ex.what());
}
}

5
src/anki_search.h Normal file
View file

@ -0,0 +1,5 @@
#pragma once
#include "precompiled.h"
auto search_anki_cards(std::span<std::string_view const> const args) -> void;

92
src/echo.cpp Normal file
View file

@ -0,0 +1,92 @@
/*
* gd-tools - a set of programs to enhance goldendict for immersion learning.
* Copyright (C) 2023 Ajatt-Tools
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "kana_conv.h"
#include "precompiled.h"
#include "util.h"
using namespace std::string_view_literals;
static constexpr std::size_t default_len{ CharByteLen::THREE * 5UL };
static constexpr std::string_view help_text = R"EOF(usage: gd-echo [OPTIONS]
Echo input back to GoldenDict as HTML with the KanjiStrokeOrders font applied.
OPTIONS
--max-len NUMBER maximum length of the input string (bytes).
--font-size SIZE font size (with unit).
--font-family font family (name).
--word WORD text to print.
EXAMPLES
gd-echo --max-len 5 --font-size 10rem --word "書"
gd-echo --max-len 3 --font-size 120px --word "薔薇"
)EOF";
struct stroke_order_params
{
std::string_view gd_word{};
std::string_view font_size{ "10rem" };
std::string_view font_family{ "KanjiStrokeOrders" };
std::size_t max_len{ default_len };
void assign(std::string_view const key, std::string_view const value)
{
if (key == "--max-len") {
max_len = parse_number<std::size_t>(value).value_or(default_len);
} else if (key == "--font-size") {
font_size = value;
} else if (key == "--font-family") {
font_family = value;
} else if (key == "--word") {
gd_word = value;
}
}
};
void print_css(stroke_order_params const& params)
{
static constexpr std::string_view css = R"EOF(
<style>
.gd_echo_{} {{
font-size: {};
font-family: "{}";
}}
</style>
)EOF";
print(css, this_pid, params.font_size, params.font_family);
}
void print_with_stroke_order(stroke_order_params const& params)
{
if (params.gd_word.length() <= params.max_len) {
print("<div class=\"gd_echo_{}\">{}</div>\n", this_pid, params.gd_word);
print_css(params);
}
}
void stroke_order(std::span<std::string_view const> const args)
{
try {
print_with_stroke_order(fill_args<stroke_order_params>(args));
} catch (gd::help_requested const& ex) {
print(help_text);
} catch (gd::runtime_error const& ex) {
print("{}\n", ex.what());
}
}

5
src/echo.h Normal file
View file

@ -0,0 +1,5 @@
#pragma once
#include "precompiled.h"
void stroke_order(std::span<std::string_view const> const args);

3
src/gd-handwritten.sh Executable file
View file

@ -0,0 +1,3 @@
#!/bin/bash
gd-echo --font-family "ArmedLemon" "$@"

182
src/gd-mandarin.sh Normal file
View file

@ -0,0 +1,182 @@
#!/bin/bash
#
# gd-tools - a set of programs to enhance goldendict for immersion learning.
# Copyright (C) 2023 Ajatt-Tools
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
set -euo pipefail
# Requires installing mecab
# Open GoldenDict, press "Edit" > "Dictionaries" > "Programs" and add this script as type html.
TEMP_FILE=/tmp/gd-mandarin_cache
# Default path to user_dic.dic, assuming that the user ran `xmake install`.
USER_DICT=~/.local/gd-mandarin/user.dic
FONT_SIZE=2rem
GDWORD=""
GDSEARCH=""
sanitize_input() {
sed -E \
-e 's, +,,g' \
-e 's,[a-z]+, ,Ig' \
-e 's,\n, ,g'
}
usage() {
local -r bn=$(basename -- "$0")
cat <<-EOF
usage: $bn [OPTIONS] --word %GDWORD% --sentence %GDSEARCH%
echo input back to GoldenDict as HTML with sentence split into parts
OPTIONS
EOF
column -t -s'|' <<-EOF
--user-dict PATH|path to the user dictionary.
--font-size SIZE|font size. The default value is 30px
EOF
}
find_dicdir() {
dirname -- "$(
find \
~/.local/gd-mandarin \
/usr/lib/mecab/dic \
~/.local/share/Anki2/addons21 \
-type f -name dicrc -print -quit
)"
}
mecab_split() {
if ! command -v mecab &>/dev/null; then
echo "Error: MeCab is not installed. Please install MeCab and try again."
exit 1
fi
mecab -d . -Ogdmandarin --dicdir="$(find_dicdir)" --userdic="${USER_DICT}"
}
print_css() {
cat <<-EOF
<style>
.gd-mandarin {
font-size: ${FONT_SIZE:-2rem};
color: #1268c3;
font-weight: normal;
}
.gd-mandarin a {
display: inline-block;
font-weight: normal;
color: royalblue;
text-decoration: none;
}
.gd-mandarin a:not(:last-of-type)::after {
content: "";
display: inline-block;
background-color: #333;
margin: 4px;
width: 3px;
height: 3px;
border-radius: 100vmax;
vertical-align: middle;
cursor: text;
user-select: text;
}
.gd-mandarin a b {
background-color: #ddeeff;
border-radius: 0.2rem;
font-weight: 500;
}
</style>
EOF
}
highlight_word() {
local target_word=$* search=""
search=$(cat -- -)
search=${search//">$target_word<"/"><b>${target_word}</b><"}
echo "$search"
}
die() {
echo "$*" >&2
notify-send "$(basename -- "$0")" "$*" &
exit 1
}
main() {
if (($# == 0)) || [[ $* == --help ]] || [[ $* == -h ]]; then
usage
exit
fi
while (($# > 0)); do
case $1 in
--font-size)
shift
FONT_SIZE=$1
;;
--user-dict)
shift
USER_DICT=$1
;;
--word)
shift
GDWORD=$1
;;
--sentence)
shift
GDSEARCH=$1
;;
*)
die "Invalid argument passed."
;;
esac
shift
done
if ! [[ -f $USER_DICT ]]; then
die "Provided user dictionary doesn't exist or isn't a file."
fi
if [[ -z $GDSEARCH ]] || [[ -z $GDWORD ]]; then
die "Not enough parameters."
fi
local -r input=$(echo "$GDSEARCH" | sanitize_input)
local -r output=$(grep -Fxs -A1 "$input" -- "$TEMP_FILE")
echo '<div class="gd-mandarin">'
if [[ -n $output ]]; then
echo "$output" |
tail -1 |
highlight_word "$GDWORD"
else
echo "$input" |
tee -a "$TEMP_FILE" |
mecab_split |
tee -a "$TEMP_FILE" |
highlight_word "$GDWORD"
printf -- '\n\n' >>"$TEMP_FILE"
fi
echo '</div>'
print_css
}
main "$@"

205
src/gd-mecab.sh Executable file
View file

@ -0,0 +1,205 @@
#!/bin/bash
#
# gd-tools - a set of programs to enhance goldendict for immersion learning.
# Copyright (C) 2023 Ajatt-Tools
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
set -euo pipefail
# Requires installing mecab
# Open GoldenDict, press "Edit" > "Dictionaries" > "Programs" and add this script as type html.
TEMP_FILE=/tmp/mecab-cache
# Default path to user_dic.dic, assuming that the user ran `xmake install`.
USER_DICT=""
FONT_SIZE=2rem
GDWORD=""
GDSEARCH=""
sanitize_input() {
sed -E \
-e 's, +,,g' \
-e 's,[a-z]+, ,Ig' \
-e 's,\n, ,g'
}
usage() {
local -r bn=$(basename -- "$0")
cat <<-EOF
usage: $bn [OPTIONS] --word %GDWORD% --sentence %GDSEARCH%
echo input back to GoldenDict as HTML with sentence split into parts
OPTIONS
EOF
column -t -s'|' <<-EOF
--user-dict PATH|path to the user dictionary.
--font-size SIZE|font size. The default value is 30px
EOF
}
find_user_dict() {
find \
"$USER_DICT" \
/usr/share/gd-tools/user_dic.dic \
~/.local/share/gd-tools/user_dic.dic \
-type f -print -quit 2>/dev/null
}
find_dicdir() {
dirname -- "$(
find \
/usr/lib/mecab/dic/mecab-ipadic-neologd \
/usr/lib/mecab/dic \
~/.local/share/Anki2/addons21 \
-type f -name dicrc -print -quit 2>/dev/null
)"
}
mecab_split() {
if ! command -v mecab &>/dev/null; then
echo "Error: MeCab is not installed. Please install MeCab and try again."
exit 1
fi
local -r user_dict=$(find_user_dict)
local -a args=(
mecab
--node-format='<a href="bword:%f[6]">%m</a>'
--unk-format='<a href="bword:%m">%m</a>'
--eos-format='<br>'
--dicdir="$(find_dicdir)"
--userdic="${USER_DICT}"
)
if [[ -n $user_dict ]]; then
args+=("$user_dict")
fi
"${args[@]}"
}
print_css() {
cat <<-EOF
<style>
* {
margin: 0;
padding: 0;
}
.gd-mecab {
font-size: ${FONT_SIZE:-2rem};
color: #1268c3;
font-weight: normal;
}
.gd-mecab a {
display: inline-block;
font-weight: normal;
color: royalblue;
text-decoration: none;
}
.gd-mecab a:not(:last-of-type)::after {
content: "";
display: inline-block;
background-color: #333;
margin: 4px;
width: 3px;
height: 3px;
border-radius: 100vmax;
vertical-align: middle;
cursor: text;
user-select: text;
}
.gd-mecab a b {
background-color: #ddeeff;
border-radius: 0.2rem;
font-weight: 500;
}
</style>
EOF
}
highlight_word() {
local target_word=$* search=""
search=$(cat -- -)
search=${search//">$target_word<"/"><b>${target_word}</b><"}
echo "$search"
}
die() {
echo "$*" >&2
notify-send "$(basename -- "$0")" "$*" &
exit 1
}
main() {
if (($# == 0)) || [[ $* == --help ]] || [[ $* == -h ]]; then
usage
exit
fi
while (($# > 0)); do
case $1 in
--font-size)
shift
FONT_SIZE=$1
;;
--user-dict)
shift
USER_DICT=$1
;;
--word)
shift
GDWORD=$1
;;
--sentence)
shift
GDSEARCH=$1
;;
*)
die "Invalid argument passed."
;;
esac
shift
done
if [[ -n $USER_DICT ]] && ! [[ -f $USER_DICT ]]; then
die "Provided user dictionary doesn't exist or isn't a file."
fi
if [[ -z $GDSEARCH ]] || [[ -z $GDWORD ]]; then
die "Not enough parameters."
fi
local -r input=$(echo "$GDSEARCH" | sanitize_input)
local -r output=$(grep -Fxs -A1 "$input" -- "$TEMP_FILE")
echo '<div class="gd-mecab">'
if [[ -n $output ]]; then
echo "$output" |
tail -1 |
highlight_word "$GDWORD"
else
echo "$input" |
tee -a "$TEMP_FILE" |
mecab_split |
tee -a "$TEMP_FILE" |
highlight_word "$GDWORD"
printf -- '\n\n' >>"$TEMP_FILE"
fi
echo '</div>'
print_css
}
main "$@"

3
src/gd-strokeorder.sh Executable file
View file

@ -0,0 +1,3 @@
#!/bin/bash
gd-echo --font-family "KanjiStrokeOrders" "$@"

104
src/images.cpp Normal file
View file

@ -0,0 +1,104 @@
/*
* gd-tools - a set of programs to enhance goldendict for immersion learning.
* Copyright (C) 2023 Ajatt-Tools
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "precompiled.h"
#include "util.h"
using namespace std::literals;
static constexpr std::size_t default_max_time_s{ 6 };
static constexpr std::string_view help_text = R"EOF(usage: gd-images [OPTIONS]
Get images from Bing.
OPTIONS
--max-time SECONDS maximum time in seconds to wait for response.
--word WORD search term.
EXAMPLES
gd-images --max-time 6 --word "犬"
gd-images --word 猫
)EOF";
static constexpr std::string_view css_style = R"EOF(<style>
.gallery {
display: grid;
gap: 10px;
margin: 0;
justify-items: center;
align-items: start;
align-content: start;
justify-content: space-between;
grid-template-columns: repeat(auto-fit, minmax(250px, 1fr));
}
.gallery img {
margin: 0 auto;
max-width: 100%;
width: 100%;
border-radius: 5px;
display: block;
max-height: 95vh;
object-fit: contain;
}
</style>)EOF";
struct images_params
{
std::chrono::seconds max_time{ default_max_time_s };
std::string gd_word{};
void assign(std::string_view const key, std::string_view const value)
{
if (key == "--max-time") {
max_time = std::chrono::seconds{ parse_number<std::size_t>(value).value_or(default_max_time_s) };
} else if (key == "--word") {
gd_word = value;
}
}
};
void fetch_images(images_params const& params)
{
cpr::Response const r = cpr::Get(
cpr::Url{ "https://www.bing.com/images/search"sv },
cpr::Parameters{ { "q", params.gd_word }, { "mkt", "ja-JP" } },
cpr::Header{ { "User-Agent", "Mozilla/5.0" } },
cpr::VerifySsl{ false },
cpr::Timeout{ params.max_time }
);
raise_if(r.status_code != 200, "Couldn't connect to Bing.");
static std::regex const img_re("<img[^<>]*class=\"mimg[^<>]*>");
auto images_begin = std::sregex_iterator(std::begin(r.text), std::end(r.text), img_re);
auto images_end = std::sregex_iterator();
print("<div class=\"gallery\">\n");
for (auto const& match: std::ranges::subrange(images_begin, images_end) | std::views::take(5)) {
print("{}\n", match.str());
}
print("</div>\n");
print("{}\n", css_style);
}
void images(std::span<std::string_view const> const args)
{
try {
fetch_images(fill_args<images_params>(args));
} catch (gd::help_requested const& ex) {
print(help_text);
} catch (gd::runtime_error const& ex) {
print("{}\n", ex.what());
}
}

5
src/images.h Normal file
View file

@ -0,0 +1,5 @@
#pragma once
#include "precompiled.h"
void images(std::span<std::string_view const> const args);

73
src/kana_conv.cpp Normal file
View file

@ -0,0 +1,73 @@
/*
* gd-tools - a set of programs to enhance goldendict for immersion learning.
* Copyright (C) 2023 Ajatt-Tools
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "kana_conv.h"
#include "precompiled.h"
#include "util.h"
auto unicode_char_byte_len(char const& ch) -> CharByteLen
{
// See `man charsets` -> Unicode for explanation of below
if ((ch & 0xC0) == 0x80) {
// intermediate unicode char
return CharByteLen::SKIP;
} else if ((ch & 0x80) == 0x00) {
// Start of ASCII character
return CharByteLen::ONE;
} else if ((ch & 0xE0) == 0xC0) {
// Cyrillic, etc.
return CharByteLen::TWO;
} else if ((ch & 0xF0) == 0xE0) {
// Start of 3 byte sequence (CJK)
return CharByteLen::THREE;
} else if ((ch & 0xF8) == 0xF0) {
// Other Unicode
return CharByteLen::FOUR;
}
throw gd::runtime_error{ std::format("Can't recognize byte: '{:x}'.", ch) };
}
auto create_map(std::string_view from, std::string_view to) -> KanaConvMap
{
KanaConvMap result{};
for (auto const [idx, uni_char]: enum_unicode_chars(from)) {
result.emplace(uni_char, to.substr(idx, uni_char.length()));
}
return result;
}
auto half_to_full(std::string& str) -> std::string&
{
static KanaConvMap const conv_map = {
{ "ｱ", "ア" }, { "ｲ", "イ" }, { "ｳ", "ウ" }, { "ｴ", "エ" }, { "ｵ", "オ" }, { "ｶ", "カ" }, { "ｷ", "キ" },
{ "ｸ", "ク" }, { "ｹ", "ケ" }, { "ｺ", "コ" }, { "ｻ", "サ" }, { "ｼ", "シ" }, { "ｽ", "ス" }, { "ｾ", "セ" },
{ "ｿ", "ソ" }, { "ﾀ", "タ" }, { "ﾁ", "チ" }, { "ﾂ", "ツ" }, { "ﾃ", "テ" }, { "ﾄ", "ト" }, { "ﾅ", "ナ" },
{ "ﾆ", "ニ" }, { "ﾇ", "ヌ" }, { "ﾈ", "ネ" }, { "ﾉ", "ノ" }, { "ﾊ", "ハ" }, { "ﾋ", "ヒ" }, { "ﾌ", "フ" },
{ "ﾍ", "ヘ" }, { "ﾎ", "ホ" }, { "ﾏ", "マ" }, { "ﾐ", "ミ" }, { "ﾑ", "ム" }, { "ﾒ", "メ" }, { "ﾓ", "モ" },
{ "ﾔ", "ヤ" }, { "ﾕ", "ユ" }, { "ﾖ", "ヨ" }, { "ﾗ", "ラ" }, { "ﾘ", "リ" }, { "ﾙ", "ル" }, { "ﾚ", "レ" },
{ "ﾛ", "ロ" }, { "ﾜ", "ワ" }, { "ｦ", "ヲ" }, { "ﾝ", "ン" }, { "ｧ", "ァ" }, { "ｨ", "ィ" }, { "ｩ", "ゥ" },
{ "ｪ", "ェ" }, { "ｫ", "ォ" }, { "ｯ", "ッ" }, { "ｬ", "ャ" }, { "ｭ", "ュ" }, { "ｮ", "ョ" }, { "｡", "。" },
{ "､", "、" }, { "･", "・" }, { "゛", "ﾞ" }, { "゜", "ﾟ" }, { "｢", "「" }, { "｣", "」" }, { "ｰ", "ー" }
};
for (auto const [idx, uni_char]: enum_unicode_chars(str)) {
if (conv_map.contains(uni_char)) {
str.replace(idx, uni_char.length(), conv_map.at(uni_char));
}
}
return str;
}

101
src/kana_conv.h Normal file
View file

@ -0,0 +1,101 @@
#pragma once
#include "precompiled.h"
using KanaConvMap = std::unordered_map<std::string_view, std::string_view>;
enum CharByteLen : std::size_t { SKIP = 0, ONE = 1, TWO = 2, THREE = 3, FOUR = 4 };
enum class Direction { kata_to_hira, hira_to_kata };
auto create_map(std::string_view from, std::string_view to) -> KanaConvMap;
auto unicode_char_byte_len(char const& ch) -> CharByteLen;
inline constexpr std::string_view hiragana_chars =
"ぁあぃいぅうぇえぉおかがか゚きぎき゚くぐく゚けげけ゚こごこ゚さざしじすずせぜそぞただちぢっつづてでとどなにぬねのはばぱひびぴふ"
"ぶぷへべぺほぼぽまみむめもゃやゅゆょよらりるれろゎわゐゑをんゔゕゖゝゞ";
inline constexpr std::string_view katakana_chars =
"ァアィイゥウェエォオカガカ゚キギキ゚クグク゚ケゲケ゚コゴコ゚サザシジスズセゼソゾタダチヂッツヅテデトドナニヌネノハバパヒビピフ"
"ブプヘベペホボポマミムメモャヤュユョヨラリルレロヮワヰヱヲンヴヵヶヽヾ";
struct Utf8CharView
{
std::size_t idx; // starting position of a char in string, counting by bytes
std::string_view ch; // the whole character, e.g. "あ" (len=3)
};
struct Utf8IdxLen
{
std::size_t idx; // starting position of a char in string, counting by bytes
std::size_t len; // length of the utf8 character in bytes.
static Utf8IdxLen from_tuple(std::tuple<std::size_t, char const> enumerated)
{
return Utf8IdxLen(
std::get<0>(enumerated), //
unicode_char_byte_len(std::get<1>(enumerated))
);
}
};
constexpr auto enum_unicode_chars(std::string_view str)
{
// return a sequence of Utf8CharView.
// e.g. [ (0, "あ"), (3, "い") ]
return std::views::enumerate(str) //
| std::views::transform(Utf8IdxLen::from_tuple)
| std::views::filter([](Utf8IdxLen const ch) { return (ch.len != CharByteLen::SKIP); })
| std::views::transform([str](Utf8IdxLen const ch) {
assert(ch.len > 0);
return Utf8CharView(ch.idx, str.substr(ch.idx, ch.len));
});
}
constexpr auto iter_unicode_chars(std::string_view str)
{
return enum_unicode_chars(str) | std::views::transform([](Utf8CharView const v) { return v.ch; });
}
template<Direction D>
auto convert_kana(std::string_view str) -> std::string
{
static auto const conv_map{ [] {
if constexpr (D == Direction::kata_to_hira) {
return create_map(katakana_chars, hiragana_chars);
} else {
return create_map(hiragana_chars, katakana_chars);
}
}() };
std::string result{};
result.reserve(str.length());
for (auto const [idx, uni_char]: enum_unicode_chars(str)) {
result.append(conv_map.contains(uni_char) ? conv_map.at(uni_char) : uni_char);
}
return result;
}
inline auto katakana_to_hiragana(std::string_view str) -> std::string
{
return convert_kana<Direction::kata_to_hira>(str);
}
inline auto hiragana_to_katakana(std::string_view str) -> std::string
{
return convert_kana<Direction::hira_to_kata>(str);
}
auto half_to_full(std::string& str) -> std::string&;
struct KanaInsensitiveMore
{
bool operator()(std::string const& lhs, std::string const& rhs) const
{
if (lhs.length() != rhs.length()) {
return lhs.length() > rhs.length();
} else {
return hiragana_to_katakana(lhs) > hiragana_to_katakana(rhs);
}
}
};
using JpSet = std::set<std::string, KanaInsensitiveMore>;

121
src/main.cpp Normal file
View file

@ -0,0 +1,121 @@
/*
* gd-tools - a set of programs to enhance goldendict for immersion learning.
* Copyright (C) 2023 Ajatt-Tools
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "anki_search.h"
#include "echo.h"
#include "images.h"
#include "marisa.h"
#include "massif.h"
#include "precompiled.h"
static constexpr std::string_view help_text = R"EOF(usage: {} ACTION [OPTIONS]
A set of helpful programs to enhance GoldenDict for immersion learning.
ACTIONS
ankisearch Search word in Anki.
massif Search word on Massif.
images Search images on Bing.
marisa Split search string using MARISA.
strokeorder Show stroke order of a word.
handwritten Display the handwritten form of a word.
OPTIONS
-h,--help Print this help screen.
EXAMPLES
gd-tools ankisearch --field-name VocabKanji %GDWORD%
gd-ankisearch --field-name VocabKanji %GDWORD%
gd-ankisearch --deck-name Mining %GDWORD%
)EOF";
auto get_help_str(std::string_view program_name) -> std::string
{
return std::format(help_text, program_name);
}
auto print_help(std::string_view const program_name) -> void
{
print("{}", get_help_str(program_name));
}
auto base_name(auto file_path) -> std::string
{
return std::filesystem::path(file_path).filename();
}
template<std::integral Ret = uint64_t>
constexpr auto djbx33a(std::string_view const s) -> Ret
{
Ret acc = 5381;
for (auto const ch: s) { acc = (acc * 33) + static_cast<Ret>(ch); }
return acc;
}
constexpr auto operator""_h(char const* s, [[maybe_unused]] size_t const size)
{
return djbx33a(std::string_view(s, size));
}
auto take_action(std::span<std::string_view const> const args) -> void
{
auto const program_name = base_name(args.front());
// Command passed as program name (first arg).
std::span rest = args.subspan(1);
switch (djbx33a(program_name)) {
case "gd-ankisearch"_h:
return search_anki_cards(rest);
case "gd-echo"_h:
return stroke_order(rest);
case "gd-massif"_h:
return massif(rest);
case "gd-images"_h:
return images(rest);
case "gd-marisa"_h:
return marisa_split(rest);
}
// Help requested explicitly.
if (std::size(args) < 2 or args[1] == "-h" or args[1] == "--help") {
return print_help(program_name);
}
// Command passed as second arg (first is "gd-tools").
rest = rest.subspan(1);
switch (djbx33a(args[1])) {
case "ankisearch"_h:
return search_anki_cards(rest);
case "echo"_h:
return stroke_order(rest);
case "massif"_h:
return massif(rest);
case "images"_h:
return images(rest);
case "marisa"_h:
return marisa_split(rest);
}
// Couldn't determine command.
return print_help(program_name);
}
auto main(int const argc, char const* const* const argv) -> int
{
take_action(std::vector<std::string_view>{ argv, std::next(argv, argc) });
return 0;
}

246
src/marisa.cpp Normal file
View file

@ -0,0 +1,246 @@
/*
* gd-tools - a set of programs to enhance goldendict for immersion learning.
* Copyright (C) 2023 Ajatt-Tools
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "kana_conv.h"
#include "precompiled.h"
#include "util.h"
using namespace std::string_literals;
using namespace ajt::rdricpp;
static constexpr std::string_view help_text = R"EOF(usage: gd-marisa [OPTIONS]
Split sentence using MARISA and print links to each word.
OPTIONS
--word WORD required word
--sentence SENTENCE required sentence
--path-to-dic optional path to words.dic
EXAMPLES
gd-marisa --word %GDWORD% --sentence %GDSEARCH%
)EOF";
static constexpr std::string_view css_style = R"EOF(
<style>
.gd-marisa {
font-size: 2rem;
margin-bottom: 0.05em;
margin-top: -0.2em;
color: #1268c3;
font-weight: normal;
}
.gd-marisa a {
display: inline-block;
font-weight: normal;
color: royalblue;
text-decoration: none;
border-bottom: dashed max(1px, calc(1em / 16)) currentColor;
}
.gd-marisa a.gd-headword {
background-color: #ddeeff;
border-radius: 0.2rem;
font-weight: 500;
}
.gd-marisa > ul {
--size: 1rem;
font-size: var(--size);
padding-inline-start: var(--size);
margin-block: 2px;
}
.gd-marisa .alternatives {
--size: 1rem;
display: grid;
font-size: var(--size);
gap: calc( var(--size) / 4);
max-width: 100%;
margin: 0 auto;
grid-template-columns: repeat(auto-fill, minmax(150px, 1fr));
align-content: start;
justify-content: space-around;
text-align: left;
padding: 5px 0px;
}
.gd-marisa .alternatives > ul {
list-style-type: none;
margin: 0;
padding: calc( var(--size) / 4);
background-color: hsl(150deg 30% 60% / 10%);
}
</style>
)EOF";
static constexpr std::size_t max_forward_search_len_bytes{ CharByteLen::THREE * 20UL };
auto find_dic_file() -> std::filesystem::path
{
static auto const locations = {
// possible .dic locations
std::filesystem::path("/usr/share/gd-tools/marisa_words.dic"),
std::filesystem::path(std::getenv("HOME")) / ".local/share/gd-tools/marisa_words.dic"
};
for (auto const& location: locations) {
if (std::filesystem::exists(location) and std::filesystem::is_regular_file(location)) {
return location;
}
}
throw gd::runtime_error("Couldn't find the word list.");
}
struct marisa_params
{
std::string gd_word{};
std::string gd_sentence{};
std::string path_to_dic{ find_dic_file() };
auto assign(std::string_view const key, std::string_view const value) -> void
{
if (key == "--word") {
gd_word = value;
} else if (key == "--sentence") {
gd_sentence = value;
} else if (key == "--path-to-dic") {
path_to_dic = value;
}
}
};
auto cmp_len(std::string_view a, std::string_view b) -> bool
{
return a.length() < b.length();
}
struct Deinflected
{
std::string_view from;
std::vector<Deinflection> to;
};
auto find_deinflections_starting_with(std::string_view const search_str) -> std::vector<Deinflected>
{
std::vector<Deinflected> hits;
// loop from larger towards shorter substrings
for (std::string_view substr: enum_unicode_chars(search_str) //
| std::views::reverse
| std::views::transform( //
[&search_str](Utf8CharView const ch) { //
return search_str.substr(0UL, ch.idx + ch.ch.size());
}
)) {
hits.emplace_back(substr, deinflect(substr));
}
return hits;
}
auto find_keywords_starting_with(marisa::Agent& agent, marisa::Trie const& trie, std::string const& search_str) -> JpSet
{
JpSet results{};
auto const variants = { search_str, hiragana_to_katakana(search_str), katakana_to_hiragana(search_str) };
auto deinflections = std::views::all(variants) //
| std::views::transform(find_deinflections_starting_with) //
| std::views::join //
| std::views::transform([](Deinflected const& group) { return group.to; }) //
| std::views::join;
for (auto const& deinflection: deinflections) {
agent.set_query(deinflection.term.c_str());
while (trie.common_prefix_search(agent)) { //
results.emplace(agent.key().ptr(), agent.key().length());
}
}
return results;
}
void lookup_words(marisa_params params)
{
half_to_full(params.gd_word);
std::erase_if(params.gd_word, is_space);
std::erase_if(params.gd_sentence, is_space);
if (params.gd_sentence.empty()) {
params.gd_sentence = params.gd_word;
} else {
half_to_full(params.gd_sentence);
}
marisa::Trie trie;
marisa::Agent agent;
std::ifstream file{ params.path_to_dic };
raise_if(not file.good(), std::format(R"(Error. The dictionary file "{}" does not exist.)", params.path_to_dic));
trie.load(params.path_to_dic.c_str());
print(R"(<div class="gd-marisa">)");
std::ptrdiff_t pos_in_gd_word{ 0 };
std::vector<JpSet> alternatives{};
alternatives.reserve(20);
// Link longest words starting with each position in sentence.
for (auto const [idx, uni_char]: enum_unicode_chars(params.gd_sentence)) {
auto const headwords{ find_keywords_starting_with(
agent,
trie, //
params.gd_sentence.substr(idx, max_forward_search_len_bytes)
) };
// set bword to the longest found key in the trie.
std::string const bword{ headwords.empty() ? std::string{ uni_char } : std::ranges::max(headwords, cmp_len) };
if (params.gd_word == bword) {
pos_in_gd_word = static_cast<std::ptrdiff_t>(bword.length());
} else {
pos_in_gd_word -= static_cast<std::ptrdiff_t>(uni_char.length());
}
print(
R"(<a class="{}" href="bword:{}">{}</a>)",
(pos_in_gd_word > 0 ? "gd-headword" : "gd-word"),
bword,
uni_char
);
alternatives.push_back(headwords);
}
// Show available entries for other substrings.
print(R"(<div class="alternatives">)");
for (auto const& group: alternatives | std::views::filter(&JpSet::size)) {
print("<ul>");
for (auto const& word: group) {
print(
R"(<li><a class="{}" href="bword:{}">{}</a></li>)",
(word == params.gd_word ? "gd-headword" : ""),
word,
word
);
}
print("</ul>"); // close ul
}
print("</div>"); // close div.alternatives
print("</div>"); // close div.gd-marisa
print("{}", css_style);
}
void marisa_split(std::span<std::string_view const> const args)
{
try {
lookup_words(fill_args<marisa_params>(args));
} catch (gd::help_requested const& ex) {
print(help_text);
} catch (gd::runtime_error const& ex) {
print("{}", ex.what());
}
}

5
src/marisa.h Normal file
View file

@ -0,0 +1,5 @@
#pragma once
#include "precompiled.h"
auto marisa_split(std::span<std::string_view const> const args) -> void;

106
src/massif.cpp Normal file
View file

@ -0,0 +1,106 @@
/*
* gd-tools - a set of programs to enhance goldendict for immersion learning.
* Copyright (C) 2023 Ajatt-Tools
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "precompiled.h"
#include "util.h"
using namespace std::literals;
static constexpr std::size_t default_max_time_s{ 6 };
static constexpr std::string_view help_text = R"EOF(usage: gd-massif [OPTIONS]
Get example sentences from Massif.
OPTIONS
--max-time SECONDS maximum time in seconds to wait for response.
--word WORD search term.
EXAMPLES
gd-massif --max-time 6 --word "貴様"
gd-massif --word 貴様
)EOF";
static constexpr std::string_view css_style = R"EOF(<style>
.gd-massif {
padding-inline-start: 0;
margin-inline-start: 0;
}
.gd-massif li {
font-size: 1.5rem;
list-style: none;
}
.gd-massif .result-meta {
font-size: 12px;
}
.gd-massif a {
color: royalblue;
}
.gd-massif em {
font-style: normal;
background-color: #ddeeff;
border-radius: 0.2rem;
}
</style>)EOF";
struct massif_params
{
std::chrono::seconds max_time{ default_max_time_s };
std::string_view gd_word{};
void assign(std::string_view const key, std::string_view const value)
{
if (key == "--max-time") {
max_time = std::chrono::seconds{ parse_number<std::size_t>(value).value_or(default_max_time_s) };
} else if (key == "--word") {
gd_word = value;
}
}
};
void fetch_massif_examples(massif_params const& params)
{
cpr::Response const r = cpr::Get(
cpr::Url{ std::format("https://massif.la/ja/search?q={}", params.gd_word) },
cpr::Timeout{ params.max_time },
cpr::VerifySsl{ false }
);
raise_if(r.status_code != 200, "Couldn't connect to Massif.");
print("<ul class=\"gd-massif\">\n");
for (auto const& line:
r.text //
| std::views::split('\n') //
| std::views::transform([](auto const& sub_view) { return std::string_view{ sub_view }; })
| std::views::drop_while([](auto const str_view) {
return not str_view.contains("<li class=\"text-japanese\">");
})
| std::views::take_while([](auto const str_view) { return not str_view.contains("</ul>"); })) {
print("{}\n", line);
}
print("</ul>\n");
print("{}\n", css_style);
}
void massif(std::span<std::string_view const> const args)
{
try {
fetch_massif_examples(fill_args<massif_params>(args));
} catch (gd::help_requested const& ex) {
print(help_text);
} catch (gd::runtime_error const& ex) {
print("{}\n", ex.what());
}
}

5
src/massif.h Normal file
View file

@ -0,0 +1,5 @@
#pragma once
#include "precompiled.h"
void massif(std::span<std::string_view const> const args);

38
src/precompiled.h Normal file
View file

@ -0,0 +1,38 @@
#pragma once
// STL
#include <algorithm>
#include <cassert>
#include <charconv>
#include <chrono>
#include <concepts>
#include <filesystem>
#include <iomanip>
#include <iostream>
#include <format>
#include <iterator>
#include <optional>
#include <ranges>
#include <regex>
#include <span>
#include <stdexcept>
#include <string>
#include <string_view>
#include <system_error>
#include <vector>
// Glibc
#include <unistd.h>
// Other
#include <cpr/cpr.h>
#include <marisa/trie.h>
#include <nlohmann/json.hpp>
#include <rdricpp/rdricpp.h>
template <typename... Args>
void print(std::string_view format, const Args&... args) {
std::string result;
result = std::vformat(format, std::make_format_args(args...));
std::cout << result << std::endl;
}

76
src/util.cpp Normal file
View file

@ -0,0 +1,76 @@
/*
* gd-tools - a set of programs to enhance goldendict for immersion learning.
* Copyright (C) 2023 Ajatt-Tools
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "util.h"
#include "precompiled.h"
auto determine_card_class(int64_t const card_queue, int64_t const card_type) noexcept -> std::string_view
{
// determine card class to be used in CSS when printing
// https://github.com/ankidroid/Anki-Android/wiki/Database-Structure
switch (card_queue) {
case -3:
case -2:
return "buried";
case -1:
return "suspended";
case 0:
return "new";
case 1:
case 3:
return "learning";
case 2:
return "review";
default:
break;
}
switch (card_type) {
case 0:
return "new";
case 1:
case 3:
return "learning";
case 2:
return "review";
default:
break;
}
return "unknown";
}
auto is_space(char const ch) noexcept -> bool
{
return static_cast<bool>(std::isspace(static_cast<unsigned char>(ch)));
}
auto strtrim(std::string_view str) noexcept -> std::string
{
auto v = std::views::all(str) //
| std::views::reverse //
| std::views::drop_while(is_space) //
| std::views::reverse //
| std::views::drop_while(is_space);
return std::string{ v.begin(), v.end() };
}
void str_replace(std::string& str, std::string_view from, std::string_view to) noexcept
{
if (auto idx = str.find(from); idx != std::string::npos) {
str.replace(idx, from.length(), to);
}
}

77
src/util.h Normal file
View file

@ -0,0 +1,77 @@
#pragma once
#include "precompiled.h"
namespace gd {
class help_requested : public std::invalid_argument
{
public:
help_requested() : std::invalid_argument("Help requested.") {}
};
class runtime_error : public std::runtime_error
{
public:
runtime_error(std::string_view const what) : std::runtime_error(std::string{ what }) {}
};
} // namespace gd
inline void raise_if(bool expr, std::string_view const message = "Invalid argument.")
{
if (expr) {
throw gd::runtime_error(message);
}
}
template<typename T>
concept PassedParamsStruct = requires(T params) {
{
params.gd_word
} -> std::convertible_to<std::string_view>;
params.assign("a", "b");
};
template<PassedParamsStruct T>
auto fill_args(std::span<std::string_view const> const args) -> T
{
auto params = T{};
for (auto it = std::begin(args); it != std::end(args);) {
if (*it == "--help" or *it == "-h") {
throw gd::help_requested();
}
std::ptrdiff_t advance = 1;
std::string_view value = (std::next(it) != std::end(args)) ? *std::next(it) : "";
if (it->starts_with("-")) {
// Expect next arg to be the value.
raise_if(value.empty() or value.starts_with("-"));
advance = 2;
}
params.assign(*it, value);
it += advance;
}
if (params.gd_word.empty()) {
throw gd::help_requested();
}
return params;
}
auto determine_card_class(int64_t const card_queue, int64_t const card_type) noexcept -> std::string_view;
template<std::integral Integral>
auto parse_number(std::string_view const s) -> std::optional<Integral>
{
if (Integral value{}; std::from_chars(s.begin(), s.end(), value).ec == std::errc{})
return value;
else
return std::nullopt;
};
auto is_space(char const ch) noexcept -> bool;
auto strtrim(std::string_view str) noexcept -> std::string;
void str_replace(std::string& str, std::string_view from, std::string_view to) noexcept;
inline std::string const this_pid{ std::to_string(getpid()) };

310
src_bac/anki_search.cpp Normal file
View file

@ -0,0 +1,310 @@
/*
* gd-tools - a set of programs to enhance goldendict for immersion learning.
* Copyright (C) 2023 Ajatt-Tools
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "anki_search.h"
#include "precompiled.h"
#include "util.h"
// reference
// https://camo.githubusercontent.com/192ba92ba3971bbb9eecede21c5f8d3a0a1afd52516af28a199335813e75f243/68747470733a2f2f692e696d6775722e636f6d2f6958335648484f2e706e67
// todo print tags (with links)
using namespace std::string_view_literals;
using json = nlohmann::json;
static constexpr auto ankiconnect_addr{ "127.0.0.1:8765"sv };
static constexpr std::chrono::seconds timeout{ 3U };
static constexpr std::size_t expected_n_fields{ 10 };
static constexpr std::string_view help_text = R"EOF(usage: gd-ankisearch [OPTIONS]
Search your Anki collection and output Note Ids that match query.
OPTIONS
--field-name NAME optional field to limit search to.
--deck-name NAME optional deck to limit search to.
--show-fields F1,F2 optional comma-separated list of fields to show.
--word WORD required search term
EXAMPLES
gd-ankisearch --field-name VocabKanji --word %GDWORD%
gd-ankisearch --deck-name Mining --word %GDWORD%
)EOF";
static constexpr std::string_view css_style = R"EOF(<style>
.gd-ankisearch-table {
font-family: arial, sans-serif;
border-collapse: collapse;
border-spacing: 0;
max-width: 100%;
width: 100%;
display: block;
overflow-x: auto;
overscroll-behavior-inline: contain;
}
.gd-ankisearch-table td,
.gd-ankisearch-table th {
border: 1px solid #dddddd;
text-align: left;
padding: 4px;
}
.gd-ankisearch-table tr:nth-child(odd) {
background-color: #dddddd55;
}
.gd-ankisearch-table tr:first-child {
background-color: #00000011;
}
.gd-ankisearch-table tr.new {
border-bottom: 2px solid #3b82f6;
background-color: #3b82f611;
}
.gd-ankisearch-table tr.learning {
border-bottom: 2px solid #dc2626;
background-color: #dc262611;
}
.gd-ankisearch-table tr.review {
border-bottom: 2px solid #16a34a;
background-color: #16a34a11;
}
.gd-ankisearch-table tr.buried {
border-bottom: 2px solid #858585;
background-color: #85858511;
}
.gd-ankisearch-table tr.suspended {
border-bottom: 2px solid #ffe88d;
background-color: #ffe88d11;
}
.gd-ankisearch-table img {
max-height: 200px;
max-width: 200px;
}
.gd-ankisearch-table a {
color: #1b2c5d;
text-decoration: none;
}
.gd-ankisearch-table a:hover {
filter: hue-rotate(-20deg) brightness(120%);
}
</style>
)EOF";
using NameToValMap = std::unordered_map<std::string, std::string>;
struct card_info
{
uint64_t id;
int64_t queue;
int64_t type;
std::string deck_name;
NameToValMap fields;
};
auto split_anki_field_names(std::string_view const show_fields) -> std::vector<std::string>
{
// Expects a list of Anki fields separated by commas.
std::vector<std::string> parsed{};
parsed.reserve(expected_n_fields);
std::ranges::copy(
show_fields //
| std::views::split(',') //
| std::views::transform([](auto v) { return std::string(v.begin(), v.end()); }), //
std::back_inserter(parsed)
);
return parsed;
}
struct search_params
{
std::string_view gd_word{};
std::string_view field_name{};
std::string_view deck_name{};
std::vector<std::string> show_fields{};
void assign(std::string_view const key, std::string_view const value)
{
if (key == "--field-name") {
field_name = value;
} else if (key == "--deck-name") {
deck_name = value;
} else if (key == "--show-fields") {
show_fields = split_anki_field_names(value);
} else if (key == "--word") {
gd_word = value;
}
}
};
auto make_find_cards_request_str(search_params const& params) -> std::string
{
auto request = json::parse(R"EOF({
"action": "findCards",
"version": 6,
"params": {
"query": "deck:current"
}
})EOF");
std::string query{ params.gd_word };
if (not params.field_name.empty()) {
query = fmt::format("\"{}:*{}*\"", params.field_name, query);
}
if (not params.deck_name.empty()) {
query = fmt::format("\"deck:{}\" {}", params.deck_name, query);
}
request["params"]["query"] = query;
return request.dump();
}
auto make_get_media_dir_path_request_str() -> std::string
{
return R"EOF({
"action": "getMediaDirPath",
"version": 6
})EOF";
}
auto make_ankiconnect_request(std::string_view const request_str) -> cpr::Response
{
return cpr::Post(
cpr::Url{ ankiconnect_addr },
cpr::Body{ request_str },
cpr::Header{ { "Content-Type", "application/json" } },
cpr::Timeout{ timeout }
);
}
auto make_info_request_str(std::vector<uint64_t> const& cids)
{
auto request = json::parse(R"EOF({
"action": "cardsInfo",
"version": 6,
"params": {
"cards": []
}
})EOF");
request["params"]["cards"] = cids;
return request.dump();
}
auto get_cids_info(std::vector<uint64_t> const& cids) -> nlohmann::json
{
auto const request_str = make_info_request_str(cids);
cpr::Response const r = make_ankiconnect_request(request_str);
raise_if(r.status_code != cpr::status::HTTP_OK, "Couldn't connect to Anki.");
auto const obj = json::parse(r.text);
raise_if(not obj["error"].is_null(), "Error getting data from AnkiConnect.");
return obj["result"];
}
auto find_cids(search_params const& params) -> std::vector<uint64_t>
{
auto const request_str = make_find_cards_request_str(params);
cpr::Response const r = make_ankiconnect_request(request_str);
raise_if(r.status_code != cpr::status::HTTP_OK, "Couldn't connect to Anki.");
auto const obj = json::parse(r.text);
raise_if(not obj["error"].is_null(), "Error getting data from AnkiConnect.");
return obj["result"];
}
auto fetch_media_dir_path() -> std::string
{
auto const request_str = make_get_media_dir_path_request_str();
cpr::Response const r = make_ankiconnect_request(request_str);
raise_if(r.status_code != cpr::status::HTTP_OK, "Couldn't connect to Anki.");
auto const obj = json::parse(r.text);
raise_if(not obj["error"].is_null(), "Error getting data from AnkiConnect.");
return obj["result"];
}
void print_table_header(search_params const& params)
{
// Print the first row (header) that contains <th></th> tags, starting with Card ID.
fmt::print("<tr>");
fmt::print("<th>Card ID</th>");
fmt::print("<th>Deck name</th>");
for (auto const& field: params.show_fields) { fmt::print("<th>{}</th>", field); }
fmt::print("</tr>\n");
}
auto card_json_to_obj(nlohmann::json const& card_json) -> card_info
{
// https://github.com/FooSoft/anki-connect#cardsinfo
return {
.id = card_json["cardId"],
.queue = card_json["queue"],
.type = card_json["type"],
.deck_name = card_json["deckName"], //
.fields =
[&card_json]() {
NameToValMap result{};
for (auto const& element: card_json["fields"].items()) {
result.emplace(element.key(), element.value()["value"]);
}
return result;
}(), //
};
}
auto gd_format(std::string const& field_content, std::string const& media_dir_path) -> std::string
{
// Make sure GoldenDict displays images correctly by specifying the full path.
static std::regex const img_re{ "(<img[^<>]*src=\")" };
static std::regex const any_undesirables{ R"EOF(\[sound:|\]|<[^<>]+>|["'.,!?]+|…|。|、|！|？|　|・|～|\(|\))EOF" };
auto const link_content = strtrim(std::regex_replace(field_content, any_undesirables, " "));
auto const link_text = std::regex_replace(field_content, img_re, fmt::format("$1file://{}/", media_dir_path));
return link_content.empty() ? link_text : fmt::format("<a href=\"ankisearch:{}\">{}</a>", link_content, link_text);
}
void print_cards_info(search_params const& params)
{
auto const cids = find_cids(params);
if (cids.empty()) {
return fmt::print("No cards found.\n");
}
auto const media_dir_path = fetch_media_dir_path();
fmt::print("<table class=\"gd-ankisearch-table\">\n");
print_table_header(params);
for (auto const& card: get_cids_info(cids) | std::views::transform(card_json_to_obj)) {
fmt::print("<tr class=\"{}\">", determine_card_class(card.queue, card.type));
fmt::print("<td><a href=\"ankisearch:cid:{}\">{}</a></td>", card.id, card.id);
fmt::print("<td>{}</td>", card.deck_name);
for (auto const& field_name: params.show_fields) {
fmt::print(
"<td>{}</td>",
(card.fields.contains(field_name) and not card.fields.at(field_name).empty()
? gd_format(card.fields.at(field_name), media_dir_path)
: "Not present")
);
}
fmt::print("</tr>\n");
}
fmt::print("</table>\n");
fmt::print("{}\n", css_style);
}
void search_anki_cards(std::span<std::string_view const> const args)
{
try {
print_cards_info(fill_args<search_params>(args));
} catch (gd::help_requested const& ex) {
fmt::print(help_text);
} catch (gd::runtime_error const& ex) {
fmt::print("{}\n", ex.what());
}
}

5
src_bac/anki_search.h Normal file
View file

@ -0,0 +1,5 @@
#pragma once
#include "precompiled.h"
auto search_anki_cards(std::span<std::string_view const> const args) -> void;

92
src_bac/echo.cpp Normal file
View file

@ -0,0 +1,92 @@
/*
* gd-tools - a set of programs to enhance goldendict for immersion learning.
* Copyright (C) 2023 Ajatt-Tools
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "kana_conv.h"
#include "precompiled.h"
#include "util.h"
using namespace std::string_view_literals;
static constexpr std::size_t default_len{ CharByteLen::THREE * 5UL };
static constexpr std::string_view help_text = R"EOF(usage: gd-echo [OPTIONS]
Echo input back to GoldenDict as HTML with the KanjiStrokeOrders font applied.
OPTIONS
--max-len NUMBER maximum length of the input string (bytes).
--font-size SIZE font size (with unit).
--font-family font family (name).
--word WORD text to print.
EXAMPLES
gd-echo --max-len 5 --font-size 10rem --word "書"
gd-echo --max-len 3 --font-size 120px --word "薔薇"
)EOF";
struct stroke_order_params
{
std::string_view gd_word{};
std::string_view font_size{ "10rem" };
std::string_view font_family{ "KanjiStrokeOrders" };
std::size_t max_len{ default_len };
void assign(std::string_view const key, std::string_view const value)
{
if (key == "--max-len") {
max_len = parse_number<std::size_t>(value).value_or(default_len);
} else if (key == "--font-size") {
font_size = value;
} else if (key == "--font-family") {
font_family = value;
} else if (key == "--word") {
gd_word = value;
}
}
};
void print_css(stroke_order_params const& params)
{
static constexpr std::string_view css = R"EOF(
<style>
.gd_echo_{} {{
font-size: {};
font-family: "{}";
}}
</style>
)EOF";
fmt::print(css, this_pid, params.font_size, params.font_family);
}
void print_with_stroke_order(stroke_order_params const& params)
{
if (params.gd_word.length() <= params.max_len) {
fmt::print("<div class=\"gd_echo_{}\">{}</div>\n", this_pid, params.gd_word);
print_css(params);
}
}
void stroke_order(std::span<std::string_view const> const args)
{
try {
print_with_stroke_order(fill_args<stroke_order_params>(args));
} catch (gd::help_requested const& ex) {
fmt::print(help_text);
} catch (gd::runtime_error const& ex) {
fmt::print("{}\n", ex.what());
}
}

5
src_bac/echo.h Normal file
View file

@ -0,0 +1,5 @@
#pragma once
#include "precompiled.h"
void stroke_order(std::span<std::string_view const> const args);

3
src_bac/gd-handwritten.sh Executable file
View file

@ -0,0 +1,3 @@
#!/bin/bash
gd-echo --font-family "ArmedLemon" "$@"

182
src_bac/gd-mandarin.sh Normal file
View file

@ -0,0 +1,182 @@
#!/bin/bash
#
# gd-tools - a set of programs to enhance goldendict for immersion learning.
# Copyright (C) 2023 Ajatt-Tools
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
set -euo pipefail
# Requires installing mecab
# Open GoldenDict, press "Edit" > "Dictionaries" > "Programs" and add this script as type html.
TEMP_FILE=/tmp/gd-mandarin_cache
# Default path to user_dic.dic, assuming that the user ran `xmake install`.
USER_DICT=~/.local/gd-mandarin/user.dic
FONT_SIZE=2rem
GDWORD=""
GDSEARCH=""
sanitize_input() {
sed -E \
-e 's, +,,g' \
-e 's,[a-z]+, ,Ig' \
-e 's,\n, ,g'
}
usage() {
local -r bn=$(basename -- "$0")
cat <<-EOF
usage: $bn [OPTIONS] --word %GDWORD% --sentence %GDSEARCH%
echo input back to GoldenDict as HTML with sentence split into parts
OPTIONS
EOF
column -t -s'|' <<-EOF
--user-dict PATH|path to the user dictionary.
--font-size SIZE|font size. The default value is 30px
EOF
}
find_dicdir() {
dirname -- "$(
find \
~/.local/gd-mandarin \
/usr/lib/mecab/dic \
~/.local/share/Anki2/addons21 \
-type f -name dicrc -print -quit
)"
}
mecab_split() {
if ! command -v mecab &>/dev/null; then
echo "Error: MeCab is not installed. Please install MeCab and try again."
exit 1
fi
mecab -d . -Ogdmandarin --dicdir="$(find_dicdir)" --userdic="${USER_DICT}"
}
print_css() {
cat <<-EOF
<style>
.gd-mandarin {
font-size: ${FONT_SIZE:-2rem};
color: #1268c3;
font-weight: normal;
}
.gd-mandarin a {
display: inline-block;
font-weight: normal;
color: royalblue;
text-decoration: none;
}
.gd-mandarin a:not(:last-of-type)::after {
content: "";
display: inline-block;
background-color: #333;
margin: 4px;
width: 3px;
height: 3px;
border-radius: 100vmax;
vertical-align: middle;
cursor: text;
user-select: text;
}
.gd-mandarin a b {
background-color: #ddeeff;
border-radius: 0.2rem;
font-weight: 500;
}
</style>
EOF
}
highlight_word() {
local target_word=$* search=""
search=$(cat -- -)
search=${search//">$target_word<"/"><b>${target_word}</b><"}
echo "$search"
}
die() {
echo "$*" >&2
notify-send "$(basename -- "$0")" "$*" &
exit 1
}
main() {
if (($# == 0)) || [[ $* == --help ]] || [[ $* == -h ]]; then
usage
exit
fi
while (($# > 0)); do
case $1 in
--font-size)
shift
FONT_SIZE=$1
;;
--user-dict)
shift
USER_DICT=$1
;;
--word)
shift
GDWORD=$1
;;
--sentence)
shift
GDSEARCH=$1
;;
*)
die "Invalid argument passed."
;;
esac
shift
done
if ! [[ -f $USER_DICT ]]; then
die "Provided user dictionary doesn't exist or isn't a file."
fi
if [[ -z $GDSEARCH ]] || [[ -z $GDWORD ]]; then
die "Not enough parameters."
fi
local -r input=$(echo "$GDSEARCH" | sanitize_input)
local -r output=$(grep -Fxs -A1 "$input" -- "$TEMP_FILE")
echo '<div class="gd-mandarin">'
if [[ -n $output ]]; then
echo "$output" |
tail -1 |
highlight_word "$GDWORD"
else
echo "$input" |
tee -a "$TEMP_FILE" |
mecab_split |
tee -a "$TEMP_FILE" |
highlight_word "$GDWORD"
printf -- '\n\n' >>"$TEMP_FILE"
fi
echo '</div>'
print_css
}
main "$@"

205
src_bac/gd-mecab.sh Executable file
View file

@ -0,0 +1,205 @@
#!/bin/bash
#
# gd-tools - a set of programs to enhance goldendict for immersion learning.
# Copyright (C) 2023 Ajatt-Tools
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
set -euo pipefail
# Requires installing mecab
# Open GoldenDict, press "Edit" > "Dictionaries" > "Programs" and add this script as type html.
TEMP_FILE=/tmp/mecab-cache
# Default path to user_dic.dic, assuming that the user ran `xmake install`.
USER_DICT=""
FONT_SIZE=2rem
GDWORD=""
GDSEARCH=""
sanitize_input() {
sed -E \
-e 's, +,,g' \
-e 's,[a-z]+, ,Ig' \
-e 's,\n, ,g'
}
usage() {
local -r bn=$(basename -- "$0")
cat <<-EOF
usage: $bn [OPTIONS] --word %GDWORD% --sentence %GDSEARCH%
echo input back to GoldenDict as HTML with sentence split into parts
OPTIONS
EOF
column -t -s'|' <<-EOF
--user-dict PATH|path to the user dictionary.
--font-size SIZE|font size. The default value is 30px
EOF
}
find_user_dict() {
find \
"$USER_DICT" \
/usr/share/gd-tools/user_dic.dic \
~/.local/share/gd-tools/user_dic.dic \
-type f -print -quit 2>/dev/null
}
find_dicdir() {
dirname -- "$(
find \
/usr/lib/mecab/dic/mecab-ipadic-neologd \
/usr/lib/mecab/dic \
~/.local/share/Anki2/addons21 \
-type f -name dicrc -print -quit 2>/dev/null
)"
}
mecab_split() {
if ! command -v mecab &>/dev/null; then
echo "Error: MeCab is not installed. Please install MeCab and try again."
exit 1
fi
local -r user_dict=$(find_user_dict)
local -a args=(
mecab
--node-format='<a href="bword:%f[6]">%m</a>'
--unk-format='<a href="bword:%m">%m</a>'
--eos-format='<br>'
--dicdir="$(find_dicdir)"
--userdic="${USER_DICT}"
)
if [[ -n $user_dict ]]; then
args+=("$user_dict")
fi
"${args[@]}"
}
print_css() {
cat <<-EOF
<style>
* {
margin: 0;
padding: 0;
}
.gd-mecab {
font-size: ${FONT_SIZE:-2rem};
color: #1268c3;
font-weight: normal;
}
.gd-mecab a {
display: inline-block;
font-weight: normal;
color: royalblue;
text-decoration: none;
}
.gd-mecab a:not(:last-of-type)::after {
content: "";
display: inline-block;
background-color: #333;
margin: 4px;
width: 3px;
height: 3px;
border-radius: 100vmax;
vertical-align: middle;
cursor: text;
user-select: text;
}
.gd-mecab a b {
background-color: #ddeeff;
border-radius: 0.2rem;
font-weight: 500;
}
</style>
EOF
}
highlight_word() {
local target_word=$* search=""
search=$(cat -- -)
search=${search//">$target_word<"/"><b>${target_word}</b><"}
echo "$search"
}
die() {
echo "$*" >&2
notify-send "$(basename -- "$0")" "$*" &
exit 1
}
main() {
if (($# == 0)) || [[ $* == --help ]] || [[ $* == -h ]]; then
usage
exit
fi
while (($# > 0)); do
case $1 in
--font-size)
shift
FONT_SIZE=$1
;;
--user-dict)
shift
USER_DICT=$1
;;
--word)
shift
GDWORD=$1
;;
--sentence)
shift
GDSEARCH=$1
;;
*)
die "Invalid argument passed."
;;
esac
shift
done
if [[ -n $USER_DICT ]] && ! [[ -f $USER_DICT ]]; then
die "Provided user dictionary doesn't exist or isn't a file."
fi
if [[ -z $GDSEARCH ]] || [[ -z $GDWORD ]]; then
die "Not enough parameters."
fi
local -r input=$(echo "$GDSEARCH" | sanitize_input)
local -r output=$(grep -Fxs -A1 "$input" -- "$TEMP_FILE")
echo '<div class="gd-mecab">'
if [[ -n $output ]]; then
echo "$output" |
tail -1 |
highlight_word "$GDWORD"
else
echo "$input" |
tee -a "$TEMP_FILE" |
mecab_split |
tee -a "$TEMP_FILE" |
highlight_word "$GDWORD"
printf -- '\n\n' >>"$TEMP_FILE"
fi
echo '</div>'
print_css
}
main "$@"

3
src_bac/gd-strokeorder.sh Executable file
View file

@ -0,0 +1,3 @@
#!/bin/bash
gd-echo --font-family "KanjiStrokeOrders" "$@"

104
src_bac/images.cpp Normal file
View file

@ -0,0 +1,104 @@
/*
* gd-tools - a set of programs to enhance goldendict for immersion learning.
* Copyright (C) 2023 Ajatt-Tools
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "precompiled.h"
#include "util.h"
using namespace std::literals;
static constexpr std::size_t default_max_time_s{ 6 };
static constexpr std::string_view help_text = R"EOF(usage: gd-images [OPTIONS]
Get images from Bing.
OPTIONS
--max-time SECONDS maximum time in seconds to wait for response.
--word WORD search term.
EXAMPLES
gd-images --max-time 6 --word "犬"
gd-images --word 猫
)EOF";
static constexpr std::string_view css_style = R"EOF(<style>
.gallery {
display: grid;
gap: 10px;
margin: 0;
justify-items: center;
align-items: start;
align-content: start;
justify-content: space-between;
grid-template-columns: repeat(auto-fit, minmax(250px, 1fr));
}
.gallery img {
margin: 0 auto;
max-width: 100%;
width: 100%;
border-radius: 5px;
display: block;
max-height: 95vh;
object-fit: contain;
}
</style>)EOF";
struct images_params
{
std::chrono::seconds max_time{ default_max_time_s };
std::string gd_word{};
void assign(std::string_view const key, std::string_view const value)
{
if (key == "--max-time") {
max_time = std::chrono::seconds{ parse_number<std::size_t>(value).value_or(default_max_time_s) };
} else if (key == "--word") {
gd_word = value;
}
}
};
void fetch_images(images_params const& params)
{
cpr::Response const r = cpr::Get(
cpr::Url{ "https://www.bing.com/images/search"sv },
cpr::Parameters{ { "q", params.gd_word }, { "mkt", "ja-JP" } },
cpr::Header{ { "User-Agent", "Mozilla/5.0" } },
cpr::VerifySsl{ false },
cpr::Timeout{ params.max_time }
);
raise_if(r.status_code != 200, "Couldn't connect to Bing.");
static std::regex const img_re("<img[^<>]*class=\"mimg[^<>]*>");
auto images_begin = std::sregex_iterator(std::begin(r.text), std::end(r.text), img_re);
auto images_end = std::sregex_iterator();
fmt::print("<div class=\"gallery\">\n");
for (auto const& match: std::ranges::subrange(images_begin, images_end) | std::views::take(5)) {
fmt::print("{}\n", match.str());
}
fmt::print("</div>\n");
fmt::print("{}\n", css_style);
}
void images(std::span<std::string_view const> const args)
{
try {
fetch_images(fill_args<images_params>(args));
} catch (gd::help_requested const& ex) {
fmt::print(help_text);
} catch (gd::runtime_error const& ex) {
fmt::print("{}\n", ex.what());
}
}

5
src_bac/images.h Normal file
View file

@ -0,0 +1,5 @@
#pragma once
#include "precompiled.h"
void images(std::span<std::string_view const> const args);

73
src_bac/kana_conv.cpp Normal file
View file

@ -0,0 +1,73 @@
/*
* gd-tools - a set of programs to enhance goldendict for immersion learning.
* Copyright (C) 2023 Ajatt-Tools
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "kana_conv.h"
#include "precompiled.h"
#include "util.h"
auto unicode_char_byte_len(char const& ch) -> CharByteLen
{
// See `man charsets` -> Unicode for explanation of below
if ((ch & 0xC0) == 0x80) {
// intermediate unicode char
return CharByteLen::SKIP;
} else if ((ch & 0x80) == 0x00) {
// Start of ASCII character
return CharByteLen::ONE;
} else if ((ch & 0xE0) == 0xC0) {
// Cyrillic, etc.
return CharByteLen::TWO;
} else if ((ch & 0xF0) == 0xE0) {
// Start of 3 byte sequence (CJK)
return CharByteLen::THREE;
} else if ((ch & 0xF8) == 0xF0) {
// Other Unicode
return CharByteLen::FOUR;
}
throw gd::runtime_error{ fmt::format("Can't recognize byte: '{:x}'.", ch) };
}
auto create_map(std::string_view from, std::string_view to) -> KanaConvMap
{
KanaConvMap result{};
for (auto const [idx, uni_char]: enum_unicode_chars(from)) {
result.emplace(uni_char, to.substr(idx, uni_char.length()));
}
return result;
}
auto half_to_full(std::string& str) -> std::string&
{
static KanaConvMap const conv_map = {
{ "ｱ", "ア" }, { "ｲ", "イ" }, { "ｳ", "ウ" }, { "ｴ", "エ" }, { "ｵ", "オ" }, { "ｶ", "カ" }, { "ｷ", "キ" },
{ "ｸ", "ク" }, { "ｹ", "ケ" }, { "ｺ", "コ" }, { "ｻ", "サ" }, { "ｼ", "シ" }, { "ｽ", "ス" }, { "ｾ", "セ" },
{ "ｿ", "ソ" }, { "ﾀ", "タ" }, { "ﾁ", "チ" }, { "ﾂ", "ツ" }, { "ﾃ", "テ" }, { "ﾄ", "ト" }, { "ﾅ", "ナ" },
{ "ﾆ", "ニ" }, { "ﾇ", "ヌ" }, { "ﾈ", "ネ" }, { "ﾉ", "ノ" }, { "ﾊ", "ハ" }, { "ﾋ", "ヒ" }, { "ﾌ", "フ" },
{ "ﾍ", "ヘ" }, { "ﾎ", "ホ" }, { "ﾏ", "マ" }, { "ﾐ", "ミ" }, { "ﾑ", "ム" }, { "ﾒ", "メ" }, { "ﾓ", "モ" },
{ "ﾔ", "ヤ" }, { "ﾕ", "ユ" }, { "ﾖ", "ヨ" }, { "ﾗ", "ラ" }, { "ﾘ", "リ" }, { "ﾙ", "ル" }, { "ﾚ", "レ" },
{ "ﾛ", "ロ" }, { "ﾜ", "ワ" }, { "ｦ", "ヲ" }, { "ﾝ", "ン" }, { "ｧ", "ァ" }, { "ｨ", "ィ" }, { "ｩ", "ゥ" },
{ "ｪ", "ェ" }, { "ｫ", "ォ" }, { "ｯ", "ッ" }, { "ｬ", "ャ" }, { "ｭ", "ュ" }, { "ｮ", "ョ" }, { "｡", "。" },
{ "､", "、" }, { "･", "・" }, { "゛", "ﾞ" }, { "゜", "ﾟ" }, { "｢", "「" }, { "｣", "」" }, { "ｰ", "ー" }
};
for (auto const [idx, uni_char]: enum_unicode_chars(str)) {
if (conv_map.contains(uni_char)) {
str.replace(idx, uni_char.length(), conv_map.at(uni_char));
}
}
return str;
}

101
src_bac/kana_conv.h Normal file
View file

@ -0,0 +1,101 @@
#pragma once
#include "precompiled.h"
using KanaConvMap = std::unordered_map<std::string_view, std::string_view>;
enum CharByteLen : std::size_t { SKIP = 0, ONE = 1, TWO = 2, THREE = 3, FOUR = 4 };
enum class Direction { kata_to_hira, hira_to_kata };
auto create_map(std::string_view from, std::string_view to) -> KanaConvMap;
auto unicode_char_byte_len(char const& ch) -> CharByteLen;
inline constexpr std::string_view hiragana_chars =
"ぁあぃいぅうぇえぉおかがか゚きぎき゚くぐく゚けげけ゚こごこ゚さざしじすずせぜそぞただちぢっつづてでとどなにぬねのはばぱひびぴふ"
"ぶぷへべぺほぼぽまみむめもゃやゅゆょよらりるれろゎわゐゑをんゔゕゖゝゞ";
inline constexpr std::string_view katakana_chars =
"ァアィイゥウェエォオカガカ゚キギキ゚クグク゚ケゲケ゚コゴコ゚サザシジスズセゼソゾタダチヂッツヅテデトドナニヌネノハバパヒビピフ"
"ブプヘベペホボポマミムメモャヤュユョヨラリルレロヮワヰヱヲンヴヵヶヽヾ";
struct Utf8CharView
{
std::size_t idx; // starting position of a char in string, counting by bytes
std::string_view ch; // the whole character, e.g. "あ" (len=3)
};
struct Utf8IdxLen
{
std::size_t idx; // starting position of a char in string, counting by bytes
std::size_t len; // length of the utf8 character in bytes.
static Utf8IdxLen from_tuple(std::tuple<std::size_t, char const> enumerated)
{
return Utf8IdxLen(
std::get<0>(enumerated), //
unicode_char_byte_len(std::get<1>(enumerated))
);
}
};
constexpr auto enum_unicode_chars(std::string_view str)
{
// return a sequence of Utf8CharView.
// e.g. [ (0, "あ"), (3, "い") ]
return std::views::enumerate(str) //
| std::views::transform(Utf8IdxLen::from_tuple)
| std::views::filter([](Utf8IdxLen const ch) { return (ch.len != CharByteLen::SKIP); })
| std::views::transform([str](Utf8IdxLen const ch) {
assert(ch.len > 0);
return Utf8CharView(ch.idx, str.substr(ch.idx, ch.len));
});
}
constexpr auto iter_unicode_chars(std::string_view str)
{
return enum_unicode_chars(str) | std::views::transform([](Utf8CharView const v) { return v.ch; });
}
template<Direction D>
auto convert_kana(std::string_view str) -> std::string
{
static auto const conv_map{ [] {
if constexpr (D == Direction::kata_to_hira) {
return create_map(katakana_chars, hiragana_chars);
} else {
return create_map(hiragana_chars, katakana_chars);
}
}() };
std::string result{};
result.reserve(str.length());
for (auto const [idx, uni_char]: enum_unicode_chars(str)) {
result.append(conv_map.contains(uni_char) ? conv_map.at(uni_char) : uni_char);
}
return result;
}
inline auto katakana_to_hiragana(std::string_view str) -> std::string
{
return convert_kana<Direction::kata_to_hira>(str);
}
inline auto hiragana_to_katakana(std::string_view str) -> std::string
{
return convert_kana<Direction::hira_to_kata>(str);
}
auto half_to_full(std::string& str) -> std::string&;
struct KanaInsensitiveMore
{
bool operator()(std::string const& lhs, std::string const& rhs) const
{
if (lhs.length() != rhs.length()) {
return lhs.length() > rhs.length();
} else {
return hiragana_to_katakana(lhs) > hiragana_to_katakana(rhs);
}
}
};
using JpSet = std::set<std::string, KanaInsensitiveMore>;

121
src_bac/main.cpp Normal file
View file

@ -0,0 +1,121 @@
/*
* gd-tools - a set of programs to enhance goldendict for immersion learning.
* Copyright (C) 2023 Ajatt-Tools
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "anki_search.h"
#include "echo.h"
#include "images.h"
#include "marisa.h"
#include "massif.h"
#include "precompiled.h"
static constexpr std::string_view help_text = R"EOF(usage: {} ACTION [OPTIONS]
A set of helpful programs to enhance GoldenDict for immersion learning.
ACTIONS
ankisearch Search word in Anki.
massif Search word on Massif.
images Search images on Bing.
marisa Split search string using MARISA.
strokeorder Show stroke order of a word.
handwritten Display the handwritten form of a word.
OPTIONS
-h,--help Print this help screen.
EXAMPLES
gd-tools ankisearch --field-name VocabKanji %GDWORD%
gd-ankisearch --field-name VocabKanji %GDWORD%
gd-ankisearch --deck-name Mining %GDWORD%
)EOF";
auto get_help_str(std::string_view program_name) -> std::string
{
return fmt::format(help_text, program_name);
}
auto print_help(std::string_view const program_name) -> void
{
fmt::print("{}", get_help_str(program_name));
}
auto base_name(auto file_path) -> std::string
{
return std::filesystem::path(file_path).filename();
}
template<std::integral Ret = uint64_t>
constexpr auto djbx33a(std::string_view const s) -> Ret
{
Ret acc = 5381;
for (auto const ch: s) { acc = (acc * 33) + static_cast<Ret>(ch); }
return acc;
}
constexpr auto operator""_h(char const* s, [[maybe_unused]] size_t const size)
{
return djbx33a(std::string_view(s, size));
}
auto take_action(std::span<std::string_view const> const args) -> void
{
auto const program_name = base_name(args.front());
// Command passed as program name (first arg).
std::span rest = args.subspan(1);
switch (djbx33a(program_name)) {
case "gd-ankisearch"_h:
return search_anki_cards(rest);
case "gd-echo"_h:
return stroke_order(rest);
case "gd-massif"_h:
return massif(rest);
case "gd-images"_h:
return images(rest);
case "gd-marisa"_h:
return marisa_split(rest);
}
// Help requested explicitly.
if (std::size(args) < 2 or args[1] == "-h" or args[1] == "--help") {
return print_help(program_name);
}
// Command passed as second arg (first is "gd-tools").
rest = rest.subspan(1);
switch (djbx33a(args[1])) {
case "ankisearch"_h:
return search_anki_cards(rest);
case "echo"_h:
return stroke_order(rest);
case "massif"_h:
return massif(rest);
case "images"_h:
return images(rest);
case "marisa"_h:
return marisa_split(rest);
}
// Couldn't determine command.
return print_help(program_name);
}
auto main(int const argc, char const* const* const argv) -> int
{
take_action(std::vector<std::string_view>{ argv, std::next(argv, argc) });
return 0;
}

246
src_bac/marisa.cpp Normal file
View file

@ -0,0 +1,246 @@
/*
* gd-tools - a set of programs to enhance goldendict for immersion learning.
* Copyright (C) 2023 Ajatt-Tools
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "kana_conv.h"
#include "precompiled.h"
#include "util.h"
using namespace std::string_literals;
using namespace ajt::rdricpp;
static constexpr std::string_view help_text = R"EOF(usage: gd-marisa [OPTIONS]
Split sentence using MARISA and print links to each word.
OPTIONS
--word WORD required word
--sentence SENTENCE required sentence
--path-to-dic optional path to words.dic
EXAMPLES
gd-marisa --word %GDWORD% --sentence %GDSEARCH%
)EOF";
static constexpr std::string_view css_style = R"EOF(
<style>
.gd-marisa {
font-size: 2rem;
margin-bottom: 0.05em;
margin-top: -0.2em;
color: #1268c3;
font-weight: normal;
}
.gd-marisa a {
display: inline-block;
font-weight: normal;
color: royalblue;
text-decoration: none;
border-bottom: dashed max(1px, calc(1em / 16)) currentColor;
}
.gd-marisa a.gd-headword {
background-color: #ddeeff;
border-radius: 0.2rem;
font-weight: 500;
}
.gd-marisa > ul {
--size: 1rem;
font-size: var(--size);
padding-inline-start: var(--size);
margin-block: 2px;
}
.gd-marisa .alternatives {
--size: 1rem;
display: grid;
font-size: var(--size);
gap: calc( var(--size) / 4);
max-width: 100%;
margin: 0 auto;
grid-template-columns: repeat(auto-fill, minmax(150px, 1fr));
align-content: start;
justify-content: space-around;
text-align: left;
padding: 5px 0px;
}
.gd-marisa .alternatives > ul {
list-style-type: none;
margin: 0;
padding: calc( var(--size) / 4);
background-color: hsl(150deg 30% 60% / 10%);
}
</style>
)EOF";
static constexpr std::size_t max_forward_search_len_bytes{ CharByteLen::THREE * 20UL };
auto find_dic_file() -> std::filesystem::path
{
static auto const locations = {
// possible .dic locations
std::filesystem::path("/usr/share/gd-tools/marisa_words.dic"),
std::filesystem::path(std::getenv("HOME")) / ".local/share/gd-tools/marisa_words.dic"
};
for (auto const& location: locations) {
if (std::filesystem::exists(location) and std::filesystem::is_regular_file(location)) {
return location;
}
}
throw gd::runtime_error("Couldn't find the word list.");
}
struct marisa_params
{
std::string gd_word{};
std::string gd_sentence{};
std::string path_to_dic{ find_dic_file() };
auto assign(std::string_view const key, std::string_view const value) -> void
{
if (key == "--word") {
gd_word = value;
} else if (key == "--sentence") {
gd_sentence = value;
} else if (key == "--path-to-dic") {
path_to_dic = value;
}
}
};
auto cmp_len(std::string_view a, std::string_view b) -> bool
{
return a.length() < b.length();
}
struct Deinflected
{
std::string_view from;
std::vector<Deinflection> to;
};
auto find_deinflections_starting_with(std::string_view const search_str) -> std::vector<Deinflected>
{
std::vector<Deinflected> hits;
// loop from larger towards shorter substrings
for (std::string_view substr: enum_unicode_chars(search_str) //
| std::views::reverse
| std::views::transform( //
[&search_str](Utf8CharView const ch) { //
return search_str.substr(0UL, ch.idx + ch.ch.size());
}
)) {
hits.emplace_back(substr, deinflect(substr));
}
return hits;
}
auto find_keywords_starting_with(marisa::Agent& agent, marisa::Trie const& trie, std::string const& search_str) -> JpSet
{
JpSet results{};
auto const variants = { search_str, hiragana_to_katakana(search_str), katakana_to_hiragana(search_str) };
auto deinflections = std::views::all(variants) //
| std::views::transform(find_deinflections_starting_with) //
| std::views::join //
| std::views::transform([](Deinflected const& group) { return group.to; }) //
| std::views::join;
for (auto const& deinflection: deinflections) {
agent.set_query(deinflection.term.c_str());
while (trie.common_prefix_search(agent)) { //
results.emplace(agent.key().ptr(), agent.key().length());
}
}
return results;
}
void lookup_words(marisa_params params)
{
half_to_full(params.gd_word);
std::erase_if(params.gd_word, is_space);
std::erase_if(params.gd_sentence, is_space);
if (params.gd_sentence.empty()) {
params.gd_sentence = params.gd_word;
} else {
half_to_full(params.gd_sentence);
}
marisa::Trie trie;
marisa::Agent agent;
std::ifstream file{ params.path_to_dic };
raise_if(not file.good(), fmt::format(R"(Error. The dictionary file "{}" does not exist.)", params.path_to_dic));
trie.load(params.path_to_dic.c_str());
fmt::println(R"(<div class="gd-marisa">)");
std::ptrdiff_t pos_in_gd_word{ 0 };
std::vector<JpSet> alternatives{};
alternatives.reserve(20);
// Link longest words starting with each position in sentence.
for (auto const [idx, uni_char]: enum_unicode_chars(params.gd_sentence)) {
auto const headwords{ find_keywords_starting_with(
agent,
trie, //
params.gd_sentence.substr(idx, max_forward_search_len_bytes)
) };
// set bword to the longest found key in the trie.
std::string const bword{ headwords.empty() ? std::string{ uni_char } : std::ranges::max(headwords, cmp_len) };
if (params.gd_word == bword) {
pos_in_gd_word = static_cast<std::ptrdiff_t>(bword.length());
} else {
pos_in_gd_word -= static_cast<std::ptrdiff_t>(uni_char.length());
}
fmt::print(
R"(<a class="{}" href="bword:{}">{}</a>)",
(pos_in_gd_word > 0 ? "gd-headword" : "gd-word"),
bword,
uni_char
);
alternatives.push_back(headwords);
}
// Show available entries for other substrings.
fmt::println(R"(<div class="alternatives">)");
for (auto const& group: alternatives | std::views::filter(&JpSet::size)) {
fmt::println("<ul>");
for (auto const& word: group) {
fmt::println(
R"(<li><a class="{}" href="bword:{}">{}</a></li>)",
(word == params.gd_word ? "gd-headword" : ""),
word,
word
);
}
fmt::println("</ul>"); // close ul
}
fmt::println("</div>"); // close div.alternatives
fmt::println("</div>"); // close div.gd-marisa
fmt::println("{}", css_style);
}
void marisa_split(std::span<std::string_view const> const args)
{
try {
lookup_words(fill_args<marisa_params>(args));
} catch (gd::help_requested const& ex) {
fmt::println(help_text);
} catch (gd::runtime_error const& ex) {
fmt::println("{}", ex.what());
}
}

5
src_bac/marisa.h Normal file
View file

@ -0,0 +1,5 @@
#pragma once
#include "precompiled.h"
auto marisa_split(std::span<std::string_view const> const args) -> void;

106
src_bac/massif.cpp Normal file
View file

@ -0,0 +1,106 @@
/*
* gd-tools - a set of programs to enhance goldendict for immersion learning.
* Copyright (C) 2023 Ajatt-Tools
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "precompiled.h"
#include "util.h"
using namespace std::literals;
static constexpr std::size_t default_max_time_s{ 6 };
static constexpr std::string_view help_text = R"EOF(usage: gd-massif [OPTIONS]
Get example sentences from Massif.
OPTIONS
--max-time SECONDS maximum time in seconds to wait for response.
--word WORD search term.
EXAMPLES
gd-massif --max-time 6 --word "貴様"
gd-massif --word 貴様
)EOF";
static constexpr std::string_view css_style = R"EOF(<style>
.gd-massif {
padding-inline-start: 0;
margin-inline-start: 0;
}
.gd-massif li {
font-size: 1.5rem;
list-style: none;
}
.gd-massif .result-meta {
font-size: 12px;
}
.gd-massif a {
color: royalblue;
}
.gd-massif em {
font-style: normal;
background-color: #ddeeff;
border-radius: 0.2rem;
}
</style>)EOF";
struct massif_params
{
std::chrono::seconds max_time{ default_max_time_s };
std::string_view gd_word{};
void assign(std::string_view const key, std::string_view const value)
{
if (key == "--max-time") {
max_time = std::chrono::seconds{ parse_number<std::size_t>(value).value_or(default_max_time_s) };
} else if (key == "--word") {
gd_word = value;
}
}
};
void fetch_massif_examples(massif_params const& params)
{
cpr::Response const r = cpr::Get(
cpr::Url{ fmt::format("https://massif.la/ja/search?q={}", params.gd_word) },
cpr::Timeout{ params.max_time },
cpr::VerifySsl{ false }
);
raise_if(r.status_code != 200, "Couldn't connect to Massif.");
fmt::print("<ul class=\"gd-massif\">\n");
for (auto const& line:
r.text //
| std::views::split('\n') //
| std::views::transform([](auto const& sub_view) { return std::string_view{ sub_view }; })
| std::views::drop_while([](auto const str_view) {
return not str_view.contains("<li class=\"text-japanese\">");
})
| std::views::take_while([](auto const str_view) { return not str_view.contains("</ul>"); })) {
fmt::print("{}\n", line);
}
fmt::print("</ul>\n");
fmt::print("{}\n", css_style);
}
void massif(std::span<std::string_view const> const args)
{
try {
fetch_massif_examples(fill_args<massif_params>(args));
} catch (gd::help_requested const& ex) {
fmt::print(help_text);
} catch (gd::runtime_error const& ex) {
fmt::print("{}\n", ex.what());
}
}

5
src_bac/massif.h Normal file
View file

@ -0,0 +1,5 @@
#pragma once
#include "precompiled.h"
void massif(std::span<std::string_view const> const args);

30
src_bac/precompiled.h Normal file
View file

@ -0,0 +1,30 @@
// STL
#include <algorithm>
#include <cassert>
#include <charconv>
#include <chrono>
#include <concepts>
#include <filesystem>
#include <iomanip>
#include <iostream>
#include <iterator>
#include <optional>
#include <ranges>
#include <regex>
#include <span>
#include <stdexcept>
#include <string>
#include <string_view>
#include <system_error>
#include <vector>
// Glibc
#include <unistd.h>
// Other
#include <cpr/cpr.h>
#include <fmt/format.h>
#include <fmt/ranges.h>
#include <marisa/trie.h>
#include <nlohmann/json.hpp>
#include <rdricpp/rdricpp.h>

76
src_bac/util.cpp Normal file
View file

@ -0,0 +1,76 @@
/*
* gd-tools - a set of programs to enhance goldendict for immersion learning.
* Copyright (C) 2023 Ajatt-Tools
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#include "util.h"
#include "precompiled.h"
auto determine_card_class(int64_t const card_queue, int64_t const card_type) noexcept -> std::string_view
{
// determine card class to be used in CSS when printing
// https://github.com/ankidroid/Anki-Android/wiki/Database-Structure
switch (card_queue) {
case -3:
case -2:
return "buried";
case -1:
return "suspended";
case 0:
return "new";
case 1:
case 3:
return "learning";
case 2:
return "review";
default:
break;
}
switch (card_type) {
case 0:
return "new";
case 1:
case 3:
return "learning";
case 2:
return "review";
default:
break;
}
return "unknown";
}
auto is_space(char const ch) noexcept -> bool
{
return static_cast<bool>(std::isspace(static_cast<unsigned char>(ch)));
}
auto strtrim(std::string_view str) noexcept -> std::string
{
auto v = std::views::all(str) //
| std::views::reverse //
| std::views::drop_while(is_space) //
| std::views::reverse //
| std::views::drop_while(is_space);
return std::string{ v.begin(), v.end() };
}
void str_replace(std::string& str, std::string_view from, std::string_view to) noexcept
{
if (auto idx = str.find(from); idx != std::string::npos) {
str.replace(idx, from.length(), to);
}
}

77
src_bac/util.h Normal file
View file

@ -0,0 +1,77 @@
#pragma once
#include "precompiled.h"
namespace gd {
class help_requested : public std::invalid_argument
{
public:
help_requested() : std::invalid_argument("Help requested.") {}
};
class runtime_error : public std::runtime_error
{
public:
runtime_error(std::string_view const what) : std::runtime_error(std::string{ what }) {}
};
} // namespace gd
inline void raise_if(bool expr, std::string_view const message = "Invalid argument.")
{
if (expr) {
throw gd::runtime_error(message);
}
}
template<typename T>
concept PassedParamsStruct = requires(T params) {
{
params.gd_word
} -> std::convertible_to<std::string_view>;
params.assign("a", "b");
};
template<PassedParamsStruct T>
auto fill_args(std::span<std::string_view const> const args) -> T
{
auto params = T{};
for (auto it = std::begin(args); it != std::end(args);) {
if (*it == "--help" or *it == "-h") {
throw gd::help_requested();
}
std::ptrdiff_t advance = 1;
std::string_view value = (std::next(it) != std::end(args)) ? *std::next(it) : "";
if (it->starts_with("-")) {
// Expect next arg to be the value.
raise_if(value.empty() or value.starts_with("-"));
advance = 2;
}
params.assign(*it, value);
it += advance;
}
if (params.gd_word.empty()) {
throw gd::help_requested();
}
return params;
}
auto determine_card_class(int64_t const card_queue, int64_t const card_type) noexcept -> std::string_view;
template<std::integral Integral>
auto parse_number(std::string_view const s) -> std::optional<Integral>
{
if (Integral value{}; std::from_chars(s.begin(), s.end(), value).ec == std::errc{})
return value;
else
return std::nullopt;
};
auto is_space(char const ch) noexcept -> bool;
auto strtrim(std::string_view str) noexcept -> std::string;
void str_replace(std::string& str, std::string_view from, std::string_view to) noexcept;
inline std::string const this_pid{ std::to_string(getpid()) };

18
tests/CMakeLists.txt.FIXME Normal file
View file

@ -0,0 +1,18 @@
# Testing library
FetchContent_Declare(
catch
GIT_REPOSITORY https://github.com/catchorg/Catch2.git
GIT_TAG v3.5.2)
FetchContent_MakeAvailable(catch)
# Adds Catch2::Catch2
include(Catch)
add_executable(tests tests_main.cpp)
target_compile_features(tests PRIVATE cxx_std_23)
# Should be linked to the rdricpp library, as well as the Catch2 testing library
target_link_libraries(tests PRIVATE cpr::cpr fmt::fmt nlohmann_json::nlohmann_json marisa rdricpp Catch2::Catch2WithMain)
catch_discover_tests(tests)
add_test(NAME Test COMMAND tests)

50
tests/tests_main.cpp Normal file
View file

@ -0,0 +1,50 @@
#include "kana_conv.h"
#include "util.h"
#include <catch2/catch_test_macros.hpp>
using SVec = std::vector<std::string_view>;
using namespace std::string_view_literals;
TEST_CASE("Hiragana to katakana", "[hiragana_to_katakana]")
{
REQUIRE(hiragana_to_katakana("あいうえお") == "アイウエオ");
REQUIRE(hiragana_to_katakana("お前はもう死んでいる。") == "オ前ハモウ死ンデイル。");
REQUIRE(katakana_to_hiragana("イマリ") == "いまり");
REQUIRE(katakana_to_hiragana("ニャ〜") == "にゃ〜");
REQUIRE(
katakana_to_hiragana("<div>オープンソース形態素解析エンジンです。Test 😀")
== "<div>おーぷんそーす形態素解析えんじんです。Test 😀"
);
}
TEST_CASE("Trim string", "[strtrim]")
{
REQUIRE(strtrim(" あいうえお ") == "あいうえお");
}
TEST_CASE("Iterate chars", "[iterate]")
{
auto const test_case = "あいうえおabcdeабвгд"sv;
auto const ref_vec = SVec{ "あ", "い", "う", "え", "お", "a", "b", "c", "d", "e", "а", "б", "в", "г", "д" };
auto test_vec = SVec{};
std::ranges::copy(iter_unicode_chars(test_case), std::back_inserter(test_vec));
REQUIRE(test_vec == ref_vec);
}
TEST_CASE("half to full", "[convert]")
{
std::string from =
"ｱ ｲ ｳ ｴ ｵ ｶ ｷ ｸ ｹ ｺ ｻ ｼ ｽ ｾ ｿ ﾀ ﾁ ﾂ ﾃ ﾄ ﾅ ﾆ ﾇ ﾈ ﾉ ﾊ ﾋ ﾌ ﾍ ﾎ ﾏ ﾐ ﾑ ﾒ ﾓ ﾔ ﾕ ﾖ ﾗ ﾘ ﾙ ﾚ ﾛ ﾜ ｦ ﾝ ｧ ｨ ｩ ｪ ｫ ｯ ｬ ｭ ｮ";
std::string const to =
"ア イ ウ エ オ カ キ ク ケ コ サ シ ス セ ソ タ チ ツ テ ト ナ ニ ヌ ネ ノ ハ ヒ フ ヘ ホ マ ミ ム メ モ ヤ ユ ヨ "
"ラ リ ル レ ロ ワ ヲ ン ァ ィ ゥ ェ ォ ッ ャ ュ ョ";
half_to_full(from);
REQUIRE(from == to);
}
TEST_CASE("JpSet", "[JpSet]")
{
JpSet set = { "キサマ", "きさま" };
REQUIRE(set.size() == 1);
}