commit 5afe6f02b3cdfd33c9068142514d82c4c3f4d45b Author: Alexander Rosenberg <zanderpkg@pm.me> Date: Sat May 17 20:24:00 2025 +0900 Initial commit diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -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>. diff --git a/README.md b/README.md new file mode 100644 index 0000000..0fdbd84 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# Myoji Accent + +Unfinished myoji (Japanese family name) accent dictionary. diff --git a/accent.lisp b/accent.lisp new file mode 100644 index 0000000..299e0af --- /dev/null +++ b/accent.lisp @@ -0,0 +1,128 @@ +(in-package #:myoji-accent/accent) + +(defun high-accent-char-p (char) + "Return non-nil if CHAR is a character representing a high accent in an accent +string." + (or (equalp char #\h) + (equalp char #\e))) + +(defun accent-point (reading) + "Parse the reading string READING and return its accent point." + (let ((start (position-if #'high-accent-char-p reading)) + (end (position-if #'high-accent-char-p reading :from-end t))) + ;; ensure we have an actual accent point + (when (and start end (not (find #\h reading :start start :end end + :test-not 'equalp))) + (case (elt reading (1- (length reading))) + ((#\h #\H) 0) ;; 平板型 + ((#\e #\E) (1- (length reading))) ;; 尾高型 + ((#\l #\L) (1+ end)))))) ;; 中高型 or 頭高型 + +(defun accent-string (mora point) + "Return an accent string for a word of MORA mora that has an accent of POINT." + (cond + ((not (typep point `(integer 0 ,mora))) nil) + ((= mora 1) + (format nil "~[l~;h~]e" point)) + ((zerop point) + (format nil "l~a" (make-string (1- mora) :initial-element #\h))) + ((= point 1) + (format nil "h~a" (make-string (1- mora) :initial-element #\l))) + ((= point mora) + (format nil "l~ae" (make-string (1- mora) :initial-element #\h))) + (t + (format nil "l~a~a" + (make-string (1- point) :initial-element #\h) + (make-string (- mora point) :initial-element #\l))))) + +(defun accent-name (length point) + "Return the name of the accent for a word of length LENGTH with accent point +POINT." + (cond + ((or (not point) + (> point length)) "不規則") + ((zerop point) "平板型") + ((= point 1) "頭高型") + ((= point length) "尾高型") + (t "中高型"))) + +(defun small-kana-p (char) + "Return non-nil if char is a small kana character (e.g. ょ)." + (find char "ゃゅょャュョ" :test 'eql)) + +(defun char-hl-p (char) + "Return non-nil if CHAR is an h or l (the letters, case insensitive)." + (or (equalp char #\l) + (equalp char #\h))) + +(defun valid-accent-string-p (str &optional len) + "Return non-nil if STR is a valid accent string. If LEN is non-nil, also check +that STR is of the correct length for a word with LEN mora" + (if (and (not (zerop (length str))) + (equalp #\e (elt str (1- (length str))))) + (and (null (find-if-not #'char-hl-p str :end (1- (length str)))) + (member (elt str (1- (length str))) '(#\l #\h #\e) :test 'equalp) + (or (not len) (= len (1- (length str))))) + (and (every #'char-hl-p str) + (or (not len) (= len (length str)))))) + +(defun count-word-mora (word) + "Count the number of mora in WORD. Word should consist only of kana." + (count-if-not #'small-kana-p word)) + +(defun accent-html (reading as) + "Generate HTML to render READING with the accent string AS." + (let ((*print-pretty* nil)) + (if (not (valid-accent-string-p as (count-word-mora reading))) + reading + (spinneret:with-html-string + (loop for char-i below (length reading) + for char = (char-downcase (elt reading char-i)) + for next-char = (when (< (1+ char-i) (length reading)) + (char-downcase (elt reading (1+ char-i)))) + for acc-i = 0 then (if (not (small-kana-p char)) + (1+ acc-i) + acc-i) + for this-accent = (char-downcase (elt as acc-i)) + for next-accent = (when (< (1+ acc-i) (length as)) + (char-downcase (elt as (1+ acc-i)))) + do + (:span :class + (format nil "tone-~a~@[~*-change~]~@[~* tone-end-change~]" + this-accent + (and next-accent (not (eql next-accent #\e)) + (not (small-kana-p next-char)) + (not (eql this-accent next-accent))) + (eql next-accent #\e)) + char)))))) + +(mito:deftable myoji () + ((reading :col-type :binary) + (kanji :col-type :binary) + (accent-string :col-type :binary) + (accent-point :col-type :unsigned) + (accent-name :col-type :binary) + (accent-html :col-type :binary))) + +(defun initialize-connection () + "Initialize the connection to the myoji database." + (mito:connect-toplevel :sqlite3 :database-name #P"myoji.sqlite") + (mito:ensure-table-exists 'myoji)) + +(defun make-myoji (reading kanji &key accent-string accent-point) + "Create a myoji with READING and KANJI. You must supply exactly one of +ACCENT-STRING or ACCENT-POINT." + (assert (or (and accent-string (not accent-point)) + (and (not accent-string) accent-point)) + (accent-string accent-point) + "Exactly one of ACCENT-STRING or ACCENT-POINT must be provided.") + (if accent-string + (setq accent-point (accent-point accent-string)) + (setq accent-string (accent-string (count-word-mora reading) + accent-point))) + (make-instance 'myoji :reading reading :kanji kanji + :accent-string accent-string + :accent-point accent-point + :accent-name (accent-name (count-word-mora reading) + accent-point) + :accent-html (accent-html reading accent-string))) diff --git a/entry.lisp b/entry.lisp new file mode 100644 index 0000000..5a64a57 --- /dev/null +++ b/entry.lisp @@ -0,0 +1,342 @@ +(in-package :myoji-accent/entry) + +(defapp entry + :prefix "/entry" + :name "苗字アクセントを入力") + +(defparameter *entries-per-page* 2 + "The number of entries to be shown per page.") + +(defwidget myoji-list-entry () + ((parent :initarg :parent + :accessor myoji-list-entry-parent + :documentation "The parent list of this entry.") + (id :initarg :id + :type (integer 1) + :accessor myoji-list-entry-id + :documentation "The ID of the myoji object for this entry.") + (myoji :initarg :myoji + :type myoji + :accessor myoji-list-entry-myoji + :documentation "The myoji object for this entry.") + (edit-mode :initform nil + :type boolean + :accessor myoji-list-entry-edit-mode-p + :documentation "Weather we are in edit mode or not.") + (err-msg :initform nil + :type (or null string) + :accessor myoji-list-entry-error + :documentation "An error message to show to the user."))) + +(define-condition accent-error (error) + ((message :initarg :message + :accessor accent-error-message + :type string + :documentation "A description of what went wrong.")) + (:report + (lambda (err stream) + (format stream "~a" (accent-error-message err))))) + +(defmethod update-db-entry ((widget myoji-list-entry) new-kanji new-reading + new-accent) + "Update the entry WIDGET with some new values provided by the user." + (handler-case + (progn + (setf (slot-value widget 'edit-mode) nil) + (let ((obj)) + (handler-case + (let ((accent-point (parse-integer new-accent))) + (when (> accent-point (count-word-mora new-reading)) + (signal + 'accent-error + :message + (format nil "Accent point too bit for word: ~a" new-accent))) + (setq obj (make-myoji new-reading new-kanji + :accent-point accent-point))) + (parse-error () + (if (valid-accent-string-p new-accent) + (setq obj (make-myoji new-reading new-kanji + :accent-string new-accent)) + (signal + 'accent-error + :message + (format nil "Not a valid accent string or number: ~a" new-accent))))) + (mito:insert-dao obj) + (mito:delete-dao (myoji-list-entry-myoji widget)))) + (accent-error (e) + (setf (slot-value widget 'err-msg) (format nil "~a" e))) + (error () + (setf (slot-value widget 'err-msg) "An internal error occured."))) + (reblocks/widget:update widget)) + +(defmethod reblocks/widget:render ((widget myoji-list-entry)) + (with-slots (myoji edit-mode err-msg) widget + (with-html + (if (or edit-mode err-msg) + (with-html-form (:POST #'(lambda (&key kanji reading accent + &allow-other-keys) + (update-db-entry widget kanji reading accent))) + (:tr + (:td (:input :type "text" + :name "kanji" + :value (myoji-kanji myoji))) + (:td (:input :type "text" + :name "reading" + :value (myoji-reading myoji))) + (:td :class "accented" + (:raw (myoji-accent-html myoji))) + (:td (:input :type "text" + :name "accent" + :value (myoji-accent-point myoji))) + (:td (myoji-accent-name myoji)) + (:td (:input :type "submit" + :value "編集") + (:button "削除") + (when err-msg + (:br) + (:p :class "insert-error" + err-msg))))) + (:tr + (:td (myoji-kanji myoji)) + (:td (myoji-reading myoji)) + (:td :class "accented" + (:raw (myoji-accent-html myoji))) + (:td (myoji-accent-point myoji)) + (:td (myoji-accent-name myoji)) + (:td + (:button :onclick + (when (boundp 'reblocks/page::*current-page*) + (reblocks/actions:make-js-action + (lambda (&key &allow-other-keys) + (setf (slot-value widget 'edit-mode) t) + (reblocks/widget:update (myoji-list-entry-parent widget))))) + "編集") + (:button :onclick + (when (boundp 'reblocks/page::*current-page*) + (reblocks/actions:make-js-action + (lambda (&key &allow-other-keys) + ()))) + "削除"))))))) + +(defwidget myoji-list () + ((page-num :initform 0 + :type '(integer 0) + :accessor entry-page-page-num + :documentation "The index of the displayed page.") + (last-low-id :initform 0 + :type '(integer 0) + :accessor entry-page-last-low-id + :documentation "The lowest ID from the last SQL query.") + (last-high-id :initform 0 + :type '(integer 0) + :accessor entry-page-last-high-id + :documentation "The highest ID from the last SQL query.") + (page-entries :initform nil + :type 'list + :accessor entry-page-page-entries + :documentation "The myoji entries for the current page."))) + +(defmethod initialize-instance :after + ((widget myoji-list) &key &allow-other-keys) + ;; get the first page + (next-page widget)) + +(defmethod reblocks/dependencies:get-dependencies ((widget myoji-list)) + (append + (list + (reblocks-lass:make-dependency + `(.myoji-list + :margin-left auto + :margin-right auto + :width "90%" + :border "1px" "black" solid + (table + :width "100%" + :height "100%" + :font-size larger + :border-collapse collapse + :border "1px" "black" solid + ((:or th td) + :border "1px" "black" solid) + ((:or th td) + :padding "5px")) + (|#selector-wrapper| + :width "100%" + :display flex + :justify-content center + (span + :margin-left "5px" + :margin-right "5px"))))) + (call-next-method))) + +(defmethod has-next-page-p ((widget myoji-list)) + "Return non-nil if WIDGET can be paged forward." + (with-slots (page-num page-entries last-high-id) widget + (or (zerop page-num) + (and (= (length page-entries) *entries-per-page*) + (mito:retrieve-by-sql + (sxql:select (:myoji.*) + (sxql:from :myoji) + (sxql:where (:> :id last-high-id)))))))) + +(defmethod has-previous-page-p ((widget myoji-list)) + "Return non-nil if WIDGET can be paged back." + (> (slot-value widget 'page-num) 1)) + +(defmethod reblocks/widget:render ((widget myoji-list)) + (with-slots (page-num page-entries) widget + (with-html + (:table + (:tr (dolist (header '("漢字" "読み方" "アクセント" "アクセントポイント" + "タイプ" "")) + (:th header))) + (dolist (entry page-entries) + (reblocks/widget:render entry))) + (:div :id "selector-wrapper" + (when (boundp 'reblocks/page::*current-page*) + (if (has-previous-page-p widget) + (:button :onclick (reblocks/actions:make-js-action + (lambda (&key &allow-other-keys) + (next-page widget :previous t))) + "<") + (:button :disabled "disabled" + "<")) + (:span (format nil "~a" page-num)) + (if (has-next-page-p widget) + (:button :onclick (reblocks/actions:make-js-action + (lambda (&key &allow-other-keys) + (next-page widget))) + ">") + (:button :disabled "disabled" + ">"))))))) + +(defmethod update-page-from-query-results ((widget myoji-list) results) + "Update the content of the current page of WIDGET with the RESULTS, which are +SQL query results." + (with-slots (page-num last-low-id last-high-id page-entries) widget + (loop for entry in results + for id = (getf entry :id) + maximize id into new-high + minimize id into new-low + collect + (make-instance 'myoji-list-entry + :parent widget + :id id + :myoji (apply #'mito:make-dao-instance + 'myoji-accent/accent:myoji + entry)) + into entry-objects + finally + (setf last-low-id new-low + last-high-id new-high + page-entries entry-objects)))) + +(defmethod reload-page ((widget myoji-list)) + "Reload the current page for WIDGET." + (with-slots (last-low-id last-high-id) widget + (update-page-from-query-results + widget + (mito:retrieve-by-sql + (sxql:select (:myoji.*) + (sxql:from :myoji) + (sxql:where (:>= :id last-low-id)) + (sxql:order-by (:asc :id)) + (sxql:limit *entries-per-page*)))) + (reblocks/widget:update widget))) + +(defmethod next-page ((widget myoji-list) &key previous) + "Display the next page for WIDGET." + (if (or (and (has-next-page-p widget) (not previous)) + (and (has-previous-page-p widget) previous)) + (with-slots (page-num last-low-id last-high-id) widget + (update-page-from-query-results + widget + (mito:retrieve-by-sql + (sxql:select (:myoji.*) + (sxql:from :myoji) + (if previous + (sxql:where (:< :id last-low-id)) + (sxql:where (:> :id last-high-id))) + (if previous + (sxql:order-by (:desc :id)) + (sxql:order-by (:asc :id))) + (sxql:limit *entries-per-page*)))) + (setf page-num (if previous (1- page-num) (1+ page-num))) + (reblocks/widget:update widget)))) + +(defwidget entry-page () + ((list :initform (make-instance 'myoji-list) + :type 'myoji-list + :documentation "The list of already existing entries."))) + +(defmethod reblocks/dependencies:get-dependencies ((widget entry-page)) + (append + (list + (reblocks-lass:make-dependency + `(.entry-page + :width "100%" + (|#add-form| + :margin-top "20px" + :display "flex" + :justify-content center + ((:or (:and span (:not :first-of-type)) |#submit-button|) + :margin-left "10px") + (span + :margin-right "5px")) + (.accented + (span.tone-h + :border-top "1px" solid ,*pitch-color*) + (span.tone-l + :border-bottom "1px" solid ,*pitch-color*) + (span.tone-h-change + :border solid ,*pitch-color* + :border-width "1px" "1px" "0px" "0px") + (span.tone-l-change + :border solid ,*pitch-color* + :border-width "0px" "1px" "1px" "0px") + (span.tone-end-change + :border-right "1px"))))) + (call-next-method))) + +(defun string-integer-p (str) + "Return non-nil if STR is all digits." + (every #'digit-char-p str)) + +(defmethod handle-add-myoji ((widget entry-page) reading kanji accent) + "Add a new myoji to the database." + (let ((mora (count-word-mora reading))) + (cond + ((string-integer-p accent) + (mito:insert-dao (make-myoji reading kanji + :accent-point (parse-integer accent)))) + ((valid-accent-string-p accent mora) + (mito:insert-dao (make-myoji reading kanji + :accent-string accent))) + (t ;; TODO error + )) + (reblocks/widget:update widget))) + +(defmethod reblocks/widget:render ((widget entry-page)) + (with-html + (reblocks/widget:render (slot-value widget 'list)) + (with-html-form (:POST #'(lambda (&key reading kanji accent + &allow-other-keys) + (handle-add-myoji widget reading kanji accent)) + :id "add-form") + (:span "読み方:") + (:input :type "text" + :name "reading") + (:span "漢字:") + (:input :type "text" + :name "kanji") + (:span "アクセント:") + (:input :type "text" + :name "accent") + (:input :id "submit-button" + :type "submit" + :value "追加")))) + +(defmethod reblocks/page:init-page ((app entry) (url-path string) expire-at) + (declare (ignorable url-path expire-at)) + (setf (reblocks/page:get-title) "苗字アクセントを入力") + (make-instance 'entry-page)) diff --git a/index.lisp b/index.lisp new file mode 100644 index 0000000..51edb1f --- /dev/null +++ b/index.lisp @@ -0,0 +1,122 @@ +(in-package #:myoji-accent/index) + +(defapp index + :prefix "/" + :name "苗字アクセント辞典") + +(defwidget index-page () + ((last-search :initform nil + :type '(or string null) + :documentation "The last received query.") + (myoji-list :initform nil + :type 'list + :documentation "List of myoji that where returned by the last +search."))) + +(defparameter *pitch-color* "red" + "The color of pitch accent lines.") + +(defmethod reblocks/dependencies:get-dependencies ((widget index-page)) + (append + (list + (reblocks-lass:make-dependency + `(.index-page + :width "50%" + :margin auto + :margin-top "15%" + (|#page-title| + :text-align "center" + :font-size xxx-large + :margin-bottom "30px") + (|#search-form| + :margin auto + :width "70%" + :display flex + (|#query-input| + :font-size xx-large + :flex auto) + (|#submit-button| + :margin-left "5px" + :font-size xx-large)) + (|#error-message| + :margin-top "20px" + :font-size xx-large + :text-align center + :color "red") + (|#entry-list| + :margin-top "20px" + (.myoji-entry + :font-size xx-large + :text-align center + ((:parent (:not :first-child)) + :margin-top "10px"))) + (.accented + (span.tone-h + :border-top "1px" solid ,*pitch-color*) + (span.tone-l + :border-bottom "1px" solid ,*pitch-color*) + (span.tone-h-change + :border solid ,*pitch-color* + :border-width "1px" "1px" "0px" "0px") + (span.tone-l-change + :border solid ,*pitch-color* + :border-width "0px" "1px" "1px" "0px") + (span.tone-end-change + :border-right "1px"))))) + (call-next-method))) + +(defun empty-query-p (query) + "Return non-nil if QUERY is empty or contains only spaces." + (null (set-difference (coerce query 'list) '(#\Ideographic_Space #\Space + #\No-break_Space #\Tab) + :test 'eql))) + +(defmethod handle-search ((widget index-page) &key query) + (if (empty-query-p query) + (setf (slot-value widget 'last-search) nil + (slot-value widget 'myoji-list) nil) + (let ((myoji-list + (union (mito:retrieve-dao 'myoji-accent/accent:myoji :kanji query) + (mito:retrieve-dao 'myoji-accent/accent:myoji :reading query)))) + (setf (slot-value widget 'last-search) query + (slot-value widget 'myoji-list) myoji-list))) + (reblocks/widget:update widget)) + +(defmethod reblocks/widget:render ((widget index-page)) + (with-slots (last-search myoji-list) widget + (with-html + (:div :id "page-title" + "苗字アクセント辞典") + (with-html-form (:POST #'(lambda (&key query &allow-other-keys) + (handle-search widget :query query)) + :id "search-form") + (:input :id "query-input" + :type "text" + :name "query" + :placeholder "苗字を入力して検索する" + :value (or (slot-value widget 'last-search) "")) + (:input :id "submit-button" + :type "submit" + :value "検索")) + (cond + (myoji-list + (:div :id "entry-list" + (dolist (myoji myoji-list) + (with-accessors ((kanji myoji-kanji) + (accent-point myoji-accent-point) + (accent-name myoji-accent-name) + (accent-html myoji-accent-html)) + myoji + (:div :class "myoji-entry" + (format nil "~a " kanji) + (:raw (format nil "→ <span class=accented>~a</span>" + accent-html)) + (format nil " [~a] (~a)" accent-point accent-name)))))) + (last-search + (:div :id "error-message" + "該当する苗字がみつかりませんでした。")))))) + +(defmethod reblocks/page:init-page ((app index) (url-path string) expire-at) + (declare (ignorable url-path expire-at)) + (setf (reblocks/page:get-title) "苗字アクセント辞典") + (make-instance 'index-page)) diff --git a/myoji-accent.asd b/myoji-accent.asd new file mode 100644 index 0000000..afe2e68 --- /dev/null +++ b/myoji-accent.asd @@ -0,0 +1,18 @@ +(defsystem #:myoji-accent + :version "0.1.0" + :description "Website for looking up the accent of Japanese family names." + :author "Alexander Rosenberg <zanderpkg@pm.me>" + :maintainer "Alexander Rosenberg <zanderpkg@pm.me>" + :homepage "https://git.zander.im/Zander671/myoji-accent" + :license "AGPL3" + :depends-on (#:uiop + #:reblocks + #:reblocks-ui + #:reblocks-lass + #:mito) + :serial t + :components + ((:file "packages") + (:file "accent") + (:file "index") + (:file "entry"))) diff --git a/myoji.sqlite b/myoji.sqlite new file mode 100644 index 0000000..f9ff0c3 Binary files /dev/null and b/myoji.sqlite differ diff --git a/packages.lisp b/packages.lisp new file mode 100644 index 0000000..99614b5 --- /dev/null +++ b/packages.lisp @@ -0,0 +1,41 @@ +(defpackage #:myoji-accent/accent + (:use #:cl) + (:export #:accent-point + #:accent-string + #:accent-name + #:count-word-mora + #:valid-accent-string-p + #:myoji + #:myoji-reading + #:myoji-kanji + #:myoji-accent-string + #:myoji-accent-point + #:myoji-accent-name + #:myoji-accent-html + #:make-myoji + #:initialize-connection)) + +(defpackage #:myoji-accent/index + (:use #:cl #:myoji-accent/accent) + (:import-from #:reblocks/html + #:with-html) + (:import-from #:reblocks-ui/form + #:with-html-form) + (:import-from #:reblocks/widget + #:defwidget) + (:import-from #:reblocks/app + #:defapp) + (:export #:*pitch-color*)) + +(defpackage #:myoji-accent/entry + (:use #:cl #:myoji-accent/accent) + (:import-from #:myoji-accent/index + #:*pitch-color*) + (:import-from #:reblocks/html + #:with-html) + (:import-from #:reblocks-ui/form + #:with-html-form) + (:import-from #:reblocks/widget + #:defwidget) + (:import-from #:reblocks/app + #:defapp))