commit 2f9942640a84a4aa8d34c16b839f0749893dc1d0 Author: Soispha Date: Sat Dec 23 22:41:29 2023 +0100 chore: Initial commit The commits leading to this point can be found in the trinitrix/core repository diff --git a/.envrc b/.envrc new file mode 100644 index 0000000..96eca6b --- /dev/null +++ b/.envrc @@ -0,0 +1,7 @@ +use flake || use nix +watch_file flake.nix + +if on_git_branch; then + echo && git status --short --branch && + echo && git fetch --verbose +fi diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c1539b8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +# build +/target +/result + +# direnv +.direnv + +# keymaps is a library +Cargo.lock diff --git a/.licensure.yml b/.licensure.yml new file mode 100644 index 0000000..38d7a94 --- /dev/null +++ b/.licensure.yml @@ -0,0 +1,166 @@ +--- +# Regexes which if matched by a file path will always be excluded from +# getting a license header +excludes: + - \.gitignore + - .*lock + - \.git/.* + - \.licensure\.yml + - README.* + - LICENSE.spdx + - COPYING + - COPYING.LESSER + - .*\.(md|rst|txt|pdf) +# Definition of the licenses used on this project and to what files +# they should apply. +# +# No default license configuration is provided. This section must be +# configured by the user. +licenses: + # Either a regex or the string "any" to determine to what files this + # license should apply. It is common for projects to have files + # under multiple licenses or with multiple copyright holders. This + # provides the ability to automatically license files correctly + # based on their file paths. + # + # If "any" is provided all files will match this license. + - files: any + # + # The license identifier, a list of common identifiers can be + # found at: https://spdx.org/licenses/ but existence of the ident + # in this list it is not enforced unless auto_template is set to + # true. + ident: LGPL-3.0-or-later + # + # A list of authors who hold copyright over these files + authors: + # Provide either your full name or company name for copyright purposes + - name: The Trinitrix Project + # Optionally provide email for copyright purposes + email: "soispha@vhack.eu, antifallobst@systemausfall.org" + # + # The template that will be rendered to generate the header before + # comment characters are applied. Available variables are: + # - [year]: substituted with the current year. + # - [name of author]: Substituted with name of the author and email + # if provided. If email is provided the output appears as Full + # Name . If multiple authors are provided the + # list is concatenated together with commas. + template: | + Copyright (C) [year] [name of author] + + This file is part of the Keymaps crate for Trinitrix. + + Keymaps is free software: you can redistribute it and/or modify + it under the terms of the Lesser 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 + and the Lesser GNU General Public License along with this program. + If not, see . + # + # If auto_template is true then template is ignored and the SPDX + # API will be queried with the ident value to automatically + # determine the license header template. auto_template works best + # with licenses that have a standardLicenseHeader field defined in + # their license info JSON, if it is not then we will use the full + # licenseText to generate the header which works fine for short + # licenses like MIT but can be quite lengthy for other licenses + # like BSD-4-Clause. The above default template is valid for most + # licenses and is recommended for MIT, and BSD licenses. Common + # licenses that work well with the auto_template feature are GPL + # variants, and the Apache 2.0 license. + # + # Important Note: this means the ident must be a valid SPDX identifier + # auto_template: true + # + # If true try to detect the text wrapping of the template, and unwrap it + unwrap_text: false + +# Define type of comment characters to apply based on file extensions. +comments: + # The extensions (or singular extension) field defines which file + # extensions to apply the commenter to. + - extensions: + - js + - go + - pest + # The commenter field defines the kind of commenter to + # generate. There are two types of commenters: line and block. + # + # This demonstrates a line commenter configuration. A line + # commenter type will apply the comment_char to the beginning of + # each line in the license header. It will then apply a number of + # empty newlines to the end of the header equal to trailing_lines. + # + # If trailing_lines is omitted it is assumed to be 0. + commenter: + type: line + comment_char: "//" + trailing_lines: 2 + + - extensions: + - rs + - tri + - css + - cpp + - c + # This demonstrates a block commenter configuration. A block + # commenter type will add start_block_char as the first character + # in the license header and add end_block_char as the last character + # in the license header. If per_line_char is provided each line of + # the header between the block start and end characters will be + # line commented with the per_line_char + # + # trailing_lines works the same for both block and line commenter + # types + commenter: + type: block + start_block_char: "/*\n" + end_block_char: "*/\n" + per_line_char: "*" + trailing_lines: 2 + + # In this case extension is singular and a single string extension is provided. + - extension: html + commenter: + type: block + start_block_char: "" + + - extensions: + - el + - lisp + commenter: + type: line + comment_char: ";;;" + trailing_lines: 2 + + - extensions: + - ebnf + commenter: + type: block + start_block_char: "#(*\n" + end_block_char: "#*)\n" + per_line_char: "#" + trailing_lines: 2 + + # The extension string "any" is special and so will match any file + # extensions. Commenter configurations are always checked in the + # order they are defined, so if any is used it should be the last + # commenter configuration or else it will override all others. + # + # In this configuration if we can't match the file extension we fall + # back to the popular '#' line comment used in most scripting + # languages. + - extension: any + commenter: + type: line + comment_char: '#' + trailing_lines: 2 diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/COPYING.LESSER b/COPYING.LESSER new file mode 100644 index 0000000..0a04128 --- /dev/null +++ b/COPYING.LESSER @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser 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 +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..373cece --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,20 @@ +[package] +name = "keymaps" +version = "0.1.0" +edition = "2021" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[features] +default = [] +crossterm = ["dep:crossterm"] + +[dependencies] +crossterm = { version = "0.25", optional = true } +log = "0.4.20" +thiserror = "1.0.50" +pest = "2.7.5" +pest_derive = {version = "2.7.5", features = ["grammar-extras"]} + +[dev-dependencies] +pretty_assertions = "1.4.0" diff --git a/LICENSE.spdx b/LICENSE.spdx new file mode 100644 index 0000000..f0232e9 --- /dev/null +++ b/LICENSE.spdx @@ -0,0 +1,7 @@ +SPDXVersion: SPDX-2.3 +DataLicense: CC0-1.0 +Creator: trinitrix contributers +PackageName: Trinitrix-keymaps +PackageOriginator: trinitrix contributers +PackageHomePage: https://git.nerdcult.net/trinitrix/keymaps +PackageLicenseDeclared: LGPL-3.0-or-later diff --git a/cog.toml b/cog.toml new file mode 100644 index 0000000..139c52e --- /dev/null +++ b/cog.toml @@ -0,0 +1,31 @@ +tag_prefix = "v" +branch_whitelist = [ "main" ] +ignore_merge_commits = false + +[commit_types] + +pre_bump_hooks = [ + "licensur -p -i" # update the license header in each file + "nix build", # verify the project builds + "cargo fmt --all" # format + "cargo set-version {{version}}", # bump version in Cargo.toml +] +post_bump_hooks = [ + "git push", + "cargo publish", + "git push origin v{{version}}", # push the new tag to origin +] + +[bump_profiles] + +[changelog] +path = "NEWS.md" +remote = "git.nerdcult.net" +repository = "keymaps" +owner = "trinitrix" +authors = [ + { signature = "Soispha", username = "soispha" }, +] + + +[packages] diff --git a/flake.lock b/flake.lock new file mode 100644 index 0000000..ecbf802 --- /dev/null +++ b/flake.lock @@ -0,0 +1,123 @@ +{ + "nodes": { + "crane": { + "inputs": { + "nixpkgs": [ + "nixpkgs" + ] + }, + "locked": { + "lastModified": 1703089493, + "narHash": "sha256-WUjYqUP/Lhhop9+aiHVFREgElunx1AHEWxqMT8ePfzo=", + "owner": "ipetkov", + "repo": "crane", + "rev": "2a5136f14a9ac93d9d370d64a36026c5de3ae8a4", + "type": "github" + }, + "original": { + "owner": "ipetkov", + "repo": "crane", + "type": "github" + } + }, + "flake-compat": { + "flake": false, + "locked": { + "lastModified": 1696426674, + "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=", + "owner": "edolstra", + "repo": "flake-compat", + "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33", + "type": "github" + }, + "original": { + "owner": "edolstra", + "repo": "flake-compat", + "type": "github" + } + }, + "flake-utils": { + "inputs": { + "systems": "systems" + }, + "locked": { + "lastModified": 1701680307, + "narHash": "sha256-kAuep2h5ajznlPMD9rnQyffWG8EM/C73lejGofXvdM8=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "4022d587cbbfd70fe950c1e2083a02621806a725", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1703349974, + "narHash": "sha256-BcR1wW63W4baNtWbpg25d/mt0DVkEBIFssAY9JPNpZg=", + "owner": "soispha", + "repo": "nixpkgs", + "rev": "7e33c3c5db1c69a50efc2143ffa53539e8b4c0ed", + "type": "github" + }, + "original": { + "owner": "soispha", + "ref": "licensure", + "repo": "nixpkgs", + "type": "github" + } + }, + "root": { + "inputs": { + "crane": "crane", + "flake-compat": "flake-compat", + "flake-utils": "flake-utils", + "nixpkgs": "nixpkgs", + "rust-overlay": "rust-overlay" + } + }, + "rust-overlay": { + "inputs": { + "flake-utils": [ + "flake-utils" + ], + "nixpkgs": [ + "nixpkgs" + ] + }, + "locked": { + "lastModified": 1703297543, + "narHash": "sha256-d4QlzcoSNzb/iZheWtjOyRxoBSaLETSpViENGEkxv9g=", + "owner": "oxalica", + "repo": "rust-overlay", + "rev": "fc77c8b416b1537522d30c710baaaaebf769f816", + "type": "github" + }, + "original": { + "owner": "oxalica", + "repo": "rust-overlay", + "type": "github" + } + }, + "systems": { + "locked": { + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/flake.nix b/flake.nix new file mode 100644 index 0000000..6e458be --- /dev/null +++ b/flake.nix @@ -0,0 +1,112 @@ +# Copyright (C) 2023 The Trinitrix Project +# +# This file is part of the Trixy crate for Trinitrix. +# +# Trixy is free software: you can redistribute it and/or modify +# it under the terms of the Lesser 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 +# and the Lesser GNU General Public License along with this program. +# If not, see . +{ + description = "A rust crate which provides a standatised encoding for keycodes"; + inputs = { + # nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable"; + nixpkgs.url = "github:soispha/nixpkgs/licensure"; + + # inputs for following + flake-compat = { + url = "github:edolstra/flake-compat"; + flake = false; + }; + + crane = { + url = "github:ipetkov/crane"; + inputs = { + nixpkgs.follows = "nixpkgs"; + }; + }; + flake-utils = { + url = "github:numtide/flake-utils"; + inputs = {}; + }; + rust-overlay = { + url = "github:oxalica/rust-overlay"; + inputs = { + nixpkgs.follows = "nixpkgs"; + flake-utils.follows = "flake-utils"; + }; + }; + }; + outputs = { + nixpkgs, + crane, + flake-utils, + rust-overlay, + ... + }: + flake-utils.lib.eachDefaultSystem (system: let + pkgs = import nixpkgs { + inherit system; + overlays = [(import rust-overlay)]; + }; + + nightly = false; + rust = + if nightly + then + (pkgs.rust-bin.selectLatestNightlyWith (toolchain: + toolchain.default)) + .override { + extensions = ["rustc-codegen-cranelift-preview"]; + } + else pkgs.rust-bin.stable.latest.default; + rust_min = + if nightly + then + (pkgs.rust-bin.selectLatestNightlyWith (toolchain: + toolchain.minimal)) + .override { + extensions = ["rustc-codegen-cranelift-preview"]; + } + else pkgs.rust-bin.stable.latest.minimal; + + craneLib = (crane.mkLib pkgs).overrideToolchain rust_min; + + nativeBuildInputs = []; + buildInputs = []; + + craneBuild = craneLib.buildPackage { + src = craneLib.cleanCargoSource ./.; + + doCheck = true; + inherit nativeBuildInputs buildInputs; + }; + in { + checks.default = craneBuild; + packages = { + default = craneBuild; + }; + + devShells.default = pkgs.mkShell { + packages = with pkgs; [ + alejandra + + cocogitto + licensure + + rust + cargo-edit + cargo-expand + ]; + inherit nativeBuildInputs buildInputs; + }; + }); +} diff --git a/src/error/mod.rs b/src/error/mod.rs new file mode 100644 index 0000000..a2baacb --- /dev/null +++ b/src/error/mod.rs @@ -0,0 +1,46 @@ +use std::{fmt::Display, num::ParseIntError}; + +use thiserror::Error; + +use crate::key_repr::{key, keys, Keys}; + +#[derive(Error, Debug)] +pub enum TrieInsertError { + #[error("The key ('{0}') contains nodes, which already have a value set!")] + KeyPathBlocked(Keys), + + #[error("The key ('{key}') already has a value associatet with it, which is: '{value}'")] + KeyAlreadySet { key: Keys, value: V }, + + #[error("The node accessed by this key ('{0}') already has children! You can not set a value for it")] + NodeHasChildren(Keys), +} + +#[derive(Error, Debug)] +pub enum KeyParseError { + #[error("This key expression could not be parsed, see the error message for more: {0}")] + RawParseError(#[from] pest::error::Error), +} + +#[derive(Error, Debug)] +pub enum KeysParseError { + #[error( + "This chain of key expressions could not be parsed, see the error message for more: {0}" + )] + RawParseError(#[from] pest::error::Error), +} + +#[derive(Error, Debug)] +pub enum KeyValueParseError { + #[error("The String ('{0}') is not a correct special key name!")] + NoMatch(String), + + #[error("The number associate with the F key ('{0}') can't be parsed as u8!")] + CantParseFNumber(#[from] ParseIntError), +} + +#[derive(Error, Debug)] +pub enum KeyFromCrossterm { + #[error("Can not parse non Key event to a Key code: ('{0:?}')")] + OnlyKey(crossterm::event::Event), +} diff --git a/src/key_repr/key/crossterm.rs b/src/key_repr/key/crossterm.rs new file mode 100644 index 0000000..d814d47 --- /dev/null +++ b/src/key_repr/key/crossterm.rs @@ -0,0 +1,76 @@ +use crossterm::event::{Event, KeyCode, KeyEvent, KeyEventKind, KeyEventState, KeyModifiers}; + +use crate::{error, key_repr::KeyValue}; + +use super::Key; + +impl Into for Key { + fn into(self) -> Event { + let mut modifiers; + { + modifiers = KeyModifiers::all(); + if !self.alt { + modifiers.remove(KeyModifiers::ALT); + } + if !self.ctrl { + modifiers.remove(KeyModifiers::CONTROL); + } + if !self.meta { + modifiers.remove(KeyModifiers::META); + modifiers.remove(KeyModifiers::SUPER); + } + if !self.shift { + modifiers.remove(KeyModifiers::SHIFT); + } + modifiers.remove(KeyModifiers::HYPER); + modifiers.remove(KeyModifiers::META); + if self.alt || self.ctrl || self.meta || self.shift { + modifiers.remove(KeyModifiers::NONE); + } + } + + let output = Event::Key(KeyEvent { + code: { + if let Some(KeyValue::Char(char)) = self.value { + KeyCode::Char(char) + } else { + self.value.unwrap_or(KeyValue::Null).into() + } + }, + modifiers, + kind: KeyEventKind::Press, + state: KeyEventState::NONE, + }); + output + } +} + +impl TryFrom<&Event> for Key { + type Error = error::KeyFromCrossterm; + + fn try_from(value: &Event) -> std::result::Result { + let mut output_key: Key = Key::new(); + match value { + Event::Key(key_event) => { + { + let key_mods = key_event.modifiers; + + output_key.alt = KeyModifiers::intersects(&key_mods, KeyModifiers::ALT); + output_key.ctrl = KeyModifiers::intersects(&key_mods, KeyModifiers::CONTROL); + output_key.meta = KeyModifiers::intersects(&key_mods, KeyModifiers::META) + || KeyModifiers::intersects(&key_mods, KeyModifiers::SUPER); + output_key.shift = KeyModifiers::intersects(&key_mods, KeyModifiers::SHIFT); + // let hyper = KeyModifiers::intersects(&key_mods, KeyModifiers::HYPER); + // let none = KeyModifiers::intersects(&key_mods, KeyModifiers::NONE); + } + + { + output_key.value = Some(key_event.code.into()); + } + + Ok(output_key) + } + event => Err(error::KeyFromCrossterm::OnlyKey(event.to_owned())), + } + } +} diff --git a/src/key_repr/key/mod.rs b/src/key_repr/key/mod.rs new file mode 100644 index 0000000..e1fae0a --- /dev/null +++ b/src/key_repr/key/mod.rs @@ -0,0 +1,70 @@ +#[cfg(feature = "crossterm")] +mod crossterm; + +mod parsing; + +use std::fmt::Display; + +use pest_derive::Parser; + +use super::KeyValue; + +#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy, Default, Parser)] +#[grammar = "./key_repr/key_representation.pest"] +pub struct Key { + // Modifiers + pub(super) alt: bool, + pub(super) ctrl: bool, + pub(super) meta: bool, + pub(super) shift: bool, + + pub(super) value: Option, +} + +impl Key { + pub fn new() -> Self { + Self::default() + } + + pub fn value(&self) -> Option<&KeyValue> { + self.value.as_ref() + } + + pub fn to_string_repr(self) -> String { + let mut output = String::new(); + if self.alt || self.ctrl || self.meta || self.shift { + output.push('<') + } + if self.alt { + output.push('A'); + } + if self.ctrl { + output.push('C'); + } + if self.meta { + output.push('M'); + } + if self.shift { + output.push('S'); + } + if self.alt || self.ctrl || self.meta || self.shift { + output.push('-') + } + output.push_str( + &self + .value + .expect("There can be no `None`s here, if the Key comes from the public api") + .to_string(), + ); + if self.alt || self.ctrl || self.meta || self.shift { + output.push('>') + } + output + } +} + +impl Display for Key { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str(&self.to_string_repr()) + } +} diff --git a/src/key_repr/key/parsing/mod.rs b/src/key_repr/key/parsing/mod.rs new file mode 100644 index 0000000..5d6b14a --- /dev/null +++ b/src/key_repr/key/parsing/mod.rs @@ -0,0 +1,213 @@ +use std::{fmt::Debug, hash::Hash, marker, str::FromStr}; + +use pest::{iterators::Pair, Parser}; + +use crate::{error, key_repr::{KeyValue, key::Rule}}; + +use super::Key; + +impl Key { + pub fn from_pair(pair: Pair) -> Self + where + R: marker::Copy + Debug + Hash + Ord, + { + let pairs = pair.into_inner(); + let mut output = Self::default(); + + let modifiers: Vec<_> = pairs.clone().find_tagged("modifiers").collect(); + let values: Vec<_> = pairs.clone().find_tagged("value").collect(); + let special_keys: Vec<_> = pairs.find_tagged("special_key").collect(); + + for modifier in modifiers { + match modifier.as_span().as_str() { + "A" => output.alt = true, + "C" => output.ctrl = true, + "M" => output.meta = true, + "S" => output.shift = true, + _ => unreachable!("This modifier should not have been parsed"), + } + } + + if values.is_empty() { + // Check that we have parsed *something* + debug_assert!(!special_keys.is_empty()); + // Check, that we have only parsed one special key + debug_assert_eq!(special_keys.len(), 1); + + let special_key_value: KeyValue = special_keys + .first() + .expect("This should exist (and be the only value)") + .as_str() + .parse() + .expect("This was parsed, and should thus be a valid special_key"); + output.value = Some(special_key_value); + } else { + // Check, that we have only parsed one key + debug_assert_eq!(values.len(), 1); + + let key_str = values.first().expect("This should exist").as_str(); + // Check that we really only have a one char &str + debug_assert_eq!(key_str.chars().count(), 1); + + let key_value: KeyValue = KeyValue::Char( + key_str + .chars() + .nth(0) + .expect("This &str should have a length of exactly one char"), + ); + + output.value = Some(key_value); + } + output + } + // pub(super) fn parse_old(chars: &mut Chars) -> anyhow::Result { + // assert_eq!(chars.pop().expect("This is a developer error"), '<'); + // let mut parse_buffer: Vec = Vec::new(); + // + // let mut reached_non_modifier = false; + // let mut output_key_filled = false; + // let mut output_key = Key::new(); + // while let Some(char) = chars.pop() { + // if char == '>' { + // break; + // } else { + // if char.is_ascii_uppercase() + // || char.is_numeric() && !reached_non_modifier && !output_key_filled + // { + // parse_buffer.push(char); + // } else if char == '-' && !reached_non_modifier && !output_key_filled { + // // We moved to the modified char + // reached_non_modifier = true; + // + // // Our parse_buffer should only contain modifiers: + // let mut alt = false; + // let mut ctrl = false; + // let mut meta = false; + // let mut shift = false; + // + // for char in &parse_buffer { + // match char { + // 'A' => alt = true, + // 'C' => ctrl = true, + // 'M' => meta = true, + // 'S' => shift = true, + // char => bail!( + // "The char ('{}') is not a valid descriptor of a modifier", + // char + // ), + // } + // } + // output_key = Key { + // alt, + // ctrl, + // meta, + // shift, + // value: None, + // }; + // } else if reached_non_modifier && !output_key_filled { + // if char == '<' { + // chars.prepend('<'); + // let key = Key::parse(chars)?; + // output_key = output_key.merge_with(key); + // } else { + // output_key.value = Some(KeyValue::Char(char)); + // } + // output_key_filled = true; + // } else { + // bail!( + // "Your can not put a this char here! + // parse_buffer: '{}'; + // char: '{}'; + // chars: '{:#?}'; + // output_key: '{:#?}' ", + // &parse_buffer.iter().collect::(), + // &char, + // &chars, + // &output_key + // ) + // } + // } + // } + // if output_key_filled { + // Ok(output_key) + // } else { + // let mut parse_buffer = Chars(parse_buffer.into()); + // let get_output = |value: KeyValue| -> Key { + // let key = Key { + // alt: false, + // ctrl: false, + // meta: false, + // shift: false, + // value: Some(value), + // }; + // + // return key.merge_with(output_key); + // }; + // if let Some(char) = parse_buffer.peek() { + // if char == &'F' { + // let _f = parse_buffer.pop(); + // let number: u8 = parse_buffer.to_string().parse().with_context(|| { + // format!("Failed to parse buffer ('{}') as u8", &parse_buffer) + // })?; + // Ok(get_output(KeyValue::F(number))) + // } else { + // match &parse_buffer.to_string()[..] { + // "BACKSPACE" => Ok(get_output(KeyValue::Backspace)), + // "ENTER" => Ok(get_output(KeyValue::Enter)), + // "LEFT" => Ok(get_output(KeyValue::Left)), + // "RIGHT" => Ok(get_output(KeyValue::Right)), + // "UP" => Ok(get_output(KeyValue::Up)), + // "DOWN" => Ok(get_output(KeyValue::Down)), + // "HOME" => Ok(get_output(KeyValue::Home)), + // "END" => Ok(get_output(KeyValue::End)), + // "PAGEUP" => Ok(get_output(KeyValue::PageUp)), + // "PAGEDOWN" => Ok(get_output(KeyValue::PageDown)), + // "TAB" => Ok(get_output(KeyValue::Tab)), + // "BACKTAB" => Ok(get_output(KeyValue::BackTab)), + // "DELETE" => Ok(get_output(KeyValue::Delete)), + // "INSERT" => Ok(get_output(KeyValue::Insert)), + // "ESC" => Ok(get_output(KeyValue::Esc)), + // "CAPSLOCK" => Ok(get_output(KeyValue::CapsLock)), + // "SCROLLlOCK" => Ok(get_output(KeyValue::ScrollLock)), + // "NUMLOCK" => Ok(get_output(KeyValue::NumLock)), + // "PRINTSCREEN" => Ok(get_output(KeyValue::PrintScreen)), + // "PAUSE" => Ok(get_output(KeyValue::Pause)), + // "MENU" => Ok(get_output(KeyValue::Menu)), + // "KEYPADBEGIN" => Ok(get_output(KeyValue::KeypadBegin)), + // + // "DASH" => Ok(get_output(KeyValue::Char('-'))), + // "ANGULAR_BRACKET_OPEN" | "ABO" => Ok(get_output(KeyValue::Char('<'))), + // "ANGULAR_BRACKET_CLOSE" | "ABC" => Ok(get_output(KeyValue::Char('>'))), + // other_str => bail!( + // "The String ('{}') is not a correct special key name!", + // other_str + // ), + // } + // } + // } else { + // bail!( + // "You need to put something into the angulare brackets (<>) + // parse_buffer: '{}'; + // chars: '{:#?}';", + // &parse_buffer, + // &chars, + // ) + // } + // } + // } +} + +impl FromStr for Key { + type Err = error::KeyParseError; + + fn from_str(s: &str) -> Result { + let mut key_pairs: Vec<_> = Self::parse(Rule::key, s)?.find_tagged("key").collect(); + debug_assert_eq!(key_pairs.len(), 1); + let key: Key = Self::from_pair::( + key_pairs + .pop() + .expect("This should contain only this first (and last) element"), + ); + Ok(key) + } +} diff --git a/src/key_repr/key_representation.pest b/src/key_repr/key_representation.pest new file mode 100644 index 0000000..6527bde --- /dev/null +++ b/src/key_repr/key_representation.pest @@ -0,0 +1,60 @@ +angular_bracket_open = _{ "<" } +abo = _{ angular_bracket_open } +angular_bracket_close = _{ ">" } +abc = _{ angular_bracket_close } + +special_key = { + "BACKSPACE" + | "ENTER" + | "LEFT" + | "RIGHT" + | "UP" + | "DOWN" + | "HOME" + | "END" + | "PAGEUP" + | "PAGEDOWN" + | "TAB" + | "BACKTAB" + | "DELETE" + | "INSERT" + | "ESC" + | "CAPSLOCK" + | "SCROLLlOCK" + | "NUMLOCK" + | "PRINTSCREEN" + | "PAUSE" + | "MENU" + | "KEYPADBEGIN" + | ("F" ~ ASCII_DIGIT+) + + // Aliases to make using them easier, as they are also used in the notation + | "DASH" + | "ANGULAR_BRACKET_OPEN" + | "ABO" + | "ANGULAR_BRACKET_CLOSE" + | "ABC" +} + +modifier = { + "A" | // Alt + "C" | // Ctrl + "M" | // Meta + "S" // Shift +} + +value = { + !abo ~ ANY +} + +raw_key = { + ((abo ~ (#modifiers = modifier)+ ~ "-" ~ (#special_key = (abo ~ special_key ~ abc) | #value = value) ~ abc) | #special_key = (abo ~ special_key ~ abc) | #value = value) +} + +// api +key = { + SOI ~ #key = raw_key ~ EOI +} +keys = { + SOI ~ (#keys = raw_key)+ ~ EOI +} diff --git a/src/key_repr/key_value/crossterm.rs b/src/key_repr/key_value/crossterm.rs new file mode 100644 index 0000000..178e860 --- /dev/null +++ b/src/key_repr/key_value/crossterm.rs @@ -0,0 +1,70 @@ +use crossterm::event::KeyCode; + +use super::KeyValue; + +impl From for KeyValue { + fn from(value: KeyCode) -> Self { + match value { + KeyCode::Backspace => Self::Backspace, + KeyCode::Enter => Self::Enter, + KeyCode::Left => Self::Left, + KeyCode::Right => Self::Right, + KeyCode::Up => Self::Up, + KeyCode::Down => Self::Down, + KeyCode::Home => Self::Home, + KeyCode::End => Self::End, + KeyCode::PageUp => Self::PageUp, + KeyCode::PageDown => Self::PageDown, + KeyCode::Tab => Self::Tab, + KeyCode::BackTab => Self::BackTab, + KeyCode::Delete => Self::Delete, + KeyCode::Insert => Self::Insert, + KeyCode::F(n) => Self::F(n), + KeyCode::Char(c) => Self::Char(c), + KeyCode::Null => Self::Null, + KeyCode::Esc => Self::Esc, + KeyCode::CapsLock => Self::CapsLock, + KeyCode::ScrollLock => Self::ScrollLock, + KeyCode::NumLock => Self::NumLock, + KeyCode::PrintScreen => Self::PrintScreen, + KeyCode::Pause => Self::Pause, + KeyCode::Menu => Self::Menu, + KeyCode::KeypadBegin => Self::KeypadBegin, + // FIXME(@soispha): This reduces our information, casting a KeyCode to a KeyValue + // and back again would not equal the original KeyCode <2023-10-15> + KeyCode::Media(_) => Self::Null, + KeyCode::Modifier(_) => Self::Null, + } + } +} +impl Into for KeyValue { + fn into(self) -> KeyCode { + match self { + Self::Backspace => KeyCode::Backspace, + Self::Enter => KeyCode::Enter, + Self::Left => KeyCode::Left, + Self::Right => KeyCode::Right, + Self::Up => KeyCode::Up, + Self::Down => KeyCode::Down, + Self::Home => KeyCode::Home, + Self::End => KeyCode::End, + Self::PageUp => KeyCode::PageUp, + Self::PageDown => KeyCode::PageDown, + Self::Tab => KeyCode::Tab, + Self::BackTab => KeyCode::BackTab, + Self::Delete => KeyCode::Delete, + Self::Insert => KeyCode::Insert, + Self::F(n) => KeyCode::F(n), + Self::Char(c) => KeyCode::Char(c), + Self::Null => KeyCode::Null, + Self::Esc => KeyCode::Esc, + Self::CapsLock => KeyCode::CapsLock, + Self::ScrollLock => KeyCode::ScrollLock, + Self::NumLock => KeyCode::NumLock, + Self::PrintScreen => KeyCode::PrintScreen, + Self::Pause => KeyCode::Pause, + Self::Menu => KeyCode::Menu, + Self::KeypadBegin => KeyCode::KeypadBegin, + } + } +} diff --git a/src/key_repr/key_value/mod.rs b/src/key_repr/key_value/mod.rs new file mode 100644 index 0000000..61240d4 --- /dev/null +++ b/src/key_repr/key_value/mod.rs @@ -0,0 +1,123 @@ +#[cfg(feature = "crossterm")] +mod crossterm; + +use std::{ + fmt::{Display, Write}, + str::FromStr, +}; + +use crate::error; + +// taken directly from crossterm +#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy)] +pub enum KeyValue { + Backspace, + Enter, + Left, + Right, + Up, + Down, + Home, + End, + PageUp, + PageDown, + Tab, + BackTab, + Delete, + Insert, + F(u8), + Char(char), + Null, // TODO(@soispha): Should we keep this key (as it's effectively not a key)?<2023-10-15> + Esc, + CapsLock, + ScrollLock, + NumLock, + PrintScreen, + Pause, + Menu, + KeypadBegin, + // TODO(@soispha): We could add support for these: <2023-10-15> + // Media(MediaKeyCode), +} + +impl FromStr for KeyValue { + type Err = error::KeyValueParseError; + + fn from_str(s: &str) -> Result { + match s { + "BACKSPACE" => Ok(Self::Backspace), + "ENTER" => Ok(Self::Enter), + "LEFT" => Ok(Self::Left), + "RIGHT" => Ok(Self::Right), + "UP" => Ok(Self::Up), + "DOWN" => Ok(Self::Down), + "HOME" => Ok(Self::Home), + "END" => Ok(Self::End), + "PAGEUP" => Ok(Self::PageUp), + "PAGEDOWN" => Ok(Self::PageDown), + "TAB" => Ok(Self::Tab), + "BACKTAB" => Ok(Self::BackTab), + "DELETE" => Ok(Self::Delete), + "INSERT" => Ok(Self::Insert), + "ESC" => Ok(Self::Esc), + "CAPSLOCK" => Ok(Self::CapsLock), + "SCROLLlOCK" => Ok(Self::ScrollLock), + "NUMLOCK" => Ok(Self::NumLock), + "PRINTSCREEN" => Ok(Self::PrintScreen), + "PAUSE" => Ok(Self::Pause), + "MENU" => Ok(Self::Menu), + "KEYPADBEGIN" => Ok(Self::KeypadBegin), + f_str + // FIXME(@soispha): This should check the full string, as something + // like 'FA12' would also match this case <2023-11-07> + if f_str.starts_with('F') + && f_str.ends_with(['0', '1', '2', '3', '4', '5', '6', '7', '8', '9']) => + { + Ok(Self::F(f_str.trim_matches('F').parse()?)) + } + + "DASH" => Ok(Self::Char('-')), + "ANGULAR_BRACKET_OPEN" | "ABO" => Ok(Self::Char('<')), + "ANGULAR_BRACKET_CLOSE" | "ABC" => Ok(Self::Char('>')), + other_str => Err(Self::Err::NoMatch(other_str.to_owned())), + } + } +} + +impl Display for KeyValue { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + let mut w = |str| f.write_str(str); + match self { + KeyValue::Backspace => w(""), + KeyValue::Enter => w(""), + KeyValue::Left => w(""), + KeyValue::Right => w(""), + KeyValue::Up => w(""), + KeyValue::Down => w(""), + KeyValue::Home => w(""), + KeyValue::End => w(""), + KeyValue::PageUp => w(""), + KeyValue::PageDown => w(""), + KeyValue::Tab => w(""), + KeyValue::BackTab => w(""), + KeyValue::Delete => w(""), + KeyValue::Insert => w(""), + KeyValue::F(n) => f.write_fmt(format_args!("", n)), + KeyValue::Char(c) => match c { + '<' => w(""), + '>' => w(""), + '-' => w(""), + c => f.write_char(*c), + }, + KeyValue::Null => w(""), + KeyValue::Esc => w(""), + KeyValue::CapsLock => w(""), + KeyValue::ScrollLock => w(""), + KeyValue::NumLock => w(""), + KeyValue::PrintScreen => w(""), + KeyValue::Pause => w(""), + KeyValue::Menu => w(""), + KeyValue::KeypadBegin => w(""), + } + } +} diff --git a/src/key_repr/keys/mod.rs b/src/key_repr/keys/mod.rs new file mode 100644 index 0000000..fc645b7 --- /dev/null +++ b/src/key_repr/keys/mod.rs @@ -0,0 +1,128 @@ +use pest::Parser; +use pest_derive::Parser; + +use crate::error; + +use super::Key; + +use std::{fmt::Display, str::FromStr}; + +#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Default, Parser)] +#[grammar = "./key_repr/key_representation.pest"] +pub struct Keys(pub(super) Vec); + +impl Keys { + pub fn new(initial_value: Key) -> Self { + Keys(vec![initial_value]) + } + pub fn join(&self, key: Key) -> Keys { + let mut output = self.0.clone(); + output.push(key); + Keys(output) + } +} + +pub struct KeysIter { + keys: Keys, + index: usize, +} + +pub struct KeysIterB<'a> { + keys: &'a Keys, + index: usize, +} + +impl IntoIterator for Keys { + type Item = Key; + type IntoIter = KeysIter; + + fn into_iter(self) -> Self::IntoIter { + KeysIter { + keys: self, + index: 0, + } + } +} + +impl Iterator for KeysIter { + type Item = Key; + + fn next(&mut self) -> Option { + let output = if self.keys.0.len() <= self.index { + None + } else { + Some(self.keys.0[self.index]) + }; + self.index += 1; + output + } +} + +impl<'a> IntoIterator for &'a Keys { + type Item = &'a Key; + type IntoIter = KeysIterB<'a>; + + fn into_iter(self) -> Self::IntoIter { + KeysIterB { + keys: self, + index: 0, + } + } +} + +impl<'a> Iterator for KeysIterB<'a> { + type Item = &'a Key; + + fn next(&mut self) -> Option { + let output = self.keys.0.get(self.index); + self.index += 1; + output + } +} + +impl Display for Keys { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + f.write_str( + &self + .into_iter() + .map(|key| key.to_string_repr()) + .collect::(), + ) + } +} + +impl FromStr for Keys { + type Err = error::KeysParseError; + + fn from_str(s: &str) -> Result { + let mut output: Vec = vec![]; + let parsed = Self::parse(Rule::keys, s)?; + + let keys: Vec<_> = parsed.find_tagged("keys").collect(); + + for key in keys { + let output_key: Key = Key::from_pair(key); + output.push(output_key) + } + + // let mut chars = Chars(s.chars().collect()); + // while let Some(char) = chars.pop() { + // match char { + // '<' => { + // chars.prepend('<'); + // let key = Key::parse(&mut chars) + // .with_context(|| format!("Failed to parse keymapping ('{}')", &chars))?; + // output.push(key) + // } + // other_char => output.push(Key { + // alt: false, + // ctrl: false, + // meta: false, + // shift: false, + // value: Some(KeyValue::Char(other_char)), + // }), + // } + // } + Ok(Keys(output)) + } +} diff --git a/src/key_repr/mod.rs b/src/key_repr/mod.rs new file mode 100644 index 0000000..925038e --- /dev/null +++ b/src/key_repr/mod.rs @@ -0,0 +1,189 @@ +pub mod key; +pub mod key_value; +pub mod keys; + +pub use key::Key; +pub use key_value::*; +pub use keys::Keys; + +#[cfg(test)] +mod test { + use crate::key_repr::{Key, KeyValue}; + use pretty_assertions::assert_eq; + + use super::Keys; + + // "ba" => "Ctrl+a" && "b" && "a" + // "" => "A" || "Shift+a" + // "A" => "A" + // " " => "Alt+a" || "Super+a" + // "a" => "a" && "Ctrl+b" && "Ctrl+a" + // "" => "Ctrl+Shift+Alt+b" + // "a " => "a" && " " + // "å🙂" => "å" && "🙂" + // "" => escape key + // "" => backspace key (and so forth) + // "" => "-" + // "" || "" => "<" + // "" || "" => ">" + #[test] + fn test_simple() { + let keys: Keys = "".parse().unwrap(); + assert_eq!( + keys, + Keys(vec![Key { + alt: false, + ctrl: true, + meta: false, + shift: false, + value: Some(KeyValue::Char('a')) + }]) + ) + } + + #[test] + fn test_shift_a() { + let keys: Keys = "".parse().unwrap(); + assert_eq!( + keys, + Keys(vec![Key { + alt: false, + ctrl: false, + meta: false, + shift: true, + value: Some(KeyValue::Char('a')) + }]) + ) + } + + #[test] + fn test_string_repr() { + let key = Key { + alt: true, + ctrl: false, + meta: true, + shift: true, + value: Some(KeyValue::Up), + }; + assert_eq!(">".to_owned(), key.to_string_repr()); + } + #[test] + fn test_string_repr_special() { + let key = Key { + alt: true, + ctrl: false, + meta: true, + shift: true, + value: Some(KeyValue::Char('<')), + }; + assert_eq!( + ">".to_owned(), + key.to_string_repr() + ); + } + + #[test] + fn test_extra_special_keys() { + // The part works! Although we should probably not encourage it + let keys: Keys = ">>".parse().unwrap(); + assert_eq!( + keys, + Keys(vec![ + Key { + alt: false, + ctrl: true, + meta: false, + shift: false, + value: Some(KeyValue::Char('-')) + }, + Key { + alt: false, + ctrl: true, + meta: false, + shift: false, + value: Some(KeyValue::Char('-')) + }, + Key { + alt: true, + ctrl: false, + meta: false, + shift: false, + value: Some(KeyValue::Char('<')) + }, + Key { + alt: false, + ctrl: false, + meta: false, + shift: false, + value: Some(KeyValue::Char('>')) + }, + ]) + ) + } + + #[test] + fn test_false_pattern() { + let keys: Result = "".parse(); + assert!(keys.is_err()) + } + + #[test] + fn test_f_keys() { + let key: Key = ">".parse().unwrap(); + let expected = Key { + alt: false, + ctrl: true, + meta: false, + shift: false, + value: Some(KeyValue::F(255)), + }; + assert_eq!(key, expected); + } + + #[test] + fn test_complex() { + let keys: Keys = ">a 🙂" + .parse() + .unwrap_or_else(|e| panic!("{}", e)); + assert_eq!( + keys, + Keys(vec![ + Key { + alt: false, + ctrl: true, + meta: false, + shift: false, + value: Some(KeyValue::Char('a')) + }, + Key { + alt: true, + ctrl: true, + meta: true, + shift: true, + value: Some(KeyValue::Esc) + }, + Key { + alt: false, + ctrl: false, + meta: false, + shift: false, + value: Some(KeyValue::Char('a')) + }, + Key { + alt: false, + ctrl: false, + meta: false, + shift: false, + value: Some(KeyValue::Char(' ')) + }, + Key { + alt: false, + ctrl: false, + meta: false, + shift: false, + value: Some(KeyValue::Char('🙂')) + }, + ]) + ) + } +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..ab1be33 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,3 @@ +pub mod key_repr; +pub mod trie; +pub mod error; diff --git a/src/trie.rs b/src/trie.rs new file mode 100644 index 0000000..87b4671 --- /dev/null +++ b/src/trie.rs @@ -0,0 +1,248 @@ +use std::collections::HashMap; + +use log::info; + +use crate::error; + +use super::key_repr::{Key, Keys}; + +#[derive(Debug, PartialEq, Eq)] +pub struct Node> { + children: HashMap>>, + value: Option, + is_terminal: bool, + is_child: bool, +} + +impl> Default for Node { + fn default() -> Self { + Self::new() + } +} + +impl> Node { + pub fn new() -> Node { + Node { + children: HashMap::new(), + is_terminal: true, + is_child: false, + value: None, + } + } + pub fn new_child() -> Node { + Node { + children: HashMap::new(), + is_terminal: true, + is_child: true, + value: None, + } + } + + pub fn is_terminal(&self) -> bool { + self.is_terminal + } + pub fn is_child(&self) -> bool { + self.is_child + } + + /// Get a reference to a child value of this node by key, will return None if the key does not exist. + /// If the key does exists, but does not have any values associated with it, it will return an + /// empty vector + /// The boolean denotes if the returned node is a true end or just a waypoint. It should be + /// called, when the bool is true + pub fn get(&self, keys: &Keys) -> Option<(Vec<&Node>, bool)> { + let mut current_node = self; + let mut old_node = None; + for char in keys { + // r + // | + // a + // / \ + // b a + // | + // c + // + // + // + // r->a->a: Some([a]) -> a.is_child() && a.is_terminal() ? call a : *key input pending* + // r->a->b: Some([b]) -> b.is_child() && b.is_terminal() ? *call b* : key input pending + // r->a->c: None -> continue + // r->a->a->c: Some([c]) -> c.is_child() && c.is_terminal() ? *call c* : key input pending + // + // r->a: Some([a, b]) -> key input pending + if let Some(node) = current_node.children.get(char) { + old_node = Some((current_node, char)); + current_node = node; + } else { + return None; + } + } + if current_node.is_child() && current_node.is_terminal() { + let (on, char) = old_node.expect("At this point, this should be Some"); + info!("Returning calling node for char: '{}'", char); + Some(( + vec![on + .children + .get(char) + .expect("This should be some, as this was checked above")], + true, + )) + } else { + Some(( + current_node.children.values().map(|a| a.as_ref()).collect(), + false, + )) + } + } + + /// Insert a key value pair into the trie. The key is supplied as a string to facilitate the + /// creation of nested nodes. + pub fn insert(&mut self, keys: &Keys, value: V) -> Result<(), error::TrieInsertError> { + let mut current_node = self; + for char in keys { + let child_node = current_node + .children + .entry(char.to_owned()) + .or_insert(Box::new(Node::new_child())); + if current_node.value.is_some() { + return Err(error::TrieInsertError::KeyPathBlocked(keys.to_owned())); + } + current_node.is_terminal = false; + current_node = child_node + } + if current_node.value.is_some() { + return Err(error::TrieInsertError::KeyAlreadySet { + key: keys.to_owned(), + value: current_node + .value + .as_ref() + .expect("This should be set") + .to_owned(), + }); + } else if !current_node.children.is_empty() { + return Err(error::TrieInsertError::NodeHasChildren(keys.to_owned())); + } else { + current_node.value = Some(value); + Ok(()) + } + } + + /// Return the values from this node. If the node does not have a value associated with it, + /// return None + pub fn value(&self) -> Option<&V> { + self.value.as_ref() + } + + /// Collect all values from this nodes children. Can be called recursively as it should be + /// tail-recursive. + pub fn collect_values_all(&self) -> Vec<&V> { + if self.is_terminal && self.is_child { + vec![self.value.as_ref().expect("We checked above")] + } else { + let out: Vec<_> = self + .children + .values() + .flat_map(|node| node.collect_values_all()) + .collect(); + out + } + } +} + +#[cfg(test)] +mod test { + use crate::key_repr::{Key, Keys}; + use pretty_assertions::assert_eq; + + use super::Node; + + fn i(str: &str) -> Keys { + str.parse().unwrap() + } + fn k(str: &str) -> Key { + str.parse::().unwrap() + } + fn collect>( + nodes: Option<(Vec<&Node>, bool)>, + ) -> Vec<&V> { + let (nodes, _should_call) = nodes.unwrap(); + nodes + .iter() + .map(|node| node.value()) + .filter_map(|x| x) + .collect() + } + + #[test] + fn test_empty_values() { + let trie: Node = Node::new(); + assert_eq!(trie.collect_values_all(), Vec::<&bool>::new()); + } + + #[test] + fn test_insert() { + let mut trie: Node = Node::new(); + + trie.insert(&i("abc"), true).unwrap(); + trie.insert(&i("abd"), true).unwrap(); + trie.insert(&i("aca"), false).unwrap(); + + let output: Vec<&bool> = vec![&true, &true]; + let get_output: Vec<_> = collect(trie.get(&i("ab"))); + assert_eq!(get_output, output); + } + + #[test] + fn test_duplicate_insert() { + let mut trie: Node = Node::new(); + + trie.insert(&i("abc"), true).unwrap(); + trie.insert(&i("aca"), true).unwrap(); + let output = trie.insert(&i("ab"), false); + + dbg!(&trie); + assert!(output.is_err()); + } + + #[test] + fn test_multiple_get() { + // | | | | | + // a <- Input 1st a | q | i + // / \ | | + // b a <- Input 2nd a | | + // / \ | | + // d e + let mut trie: Node = Node::new(); + let mut output: Node = Node::new(); + + trie.insert(&i("aa"), true).unwrap(); + trie.insert(&i("abe"), true).unwrap(); + trie.insert(&i("abd"), true).unwrap(); + + output.insert(&i("abd"), true).unwrap(); + output.insert(&i("abe"), true).unwrap(); + output.insert(&i("aa"), true).unwrap(); + output.insert(&i("acd"), true).unwrap(); + output.insert(&i("ace"), true).unwrap(); + + let a_children = &output.children.get(&k("a")).unwrap(); + let output_nodes = vec![ + a_children.children[&k("a")].as_ref(), + a_children.children[&k("b")].as_ref(), + ]; + + let (nodes, _should_call) = trie.get(&i("a")).unwrap(); + assert_eq!(nodes, output_nodes); + } + + #[test] + fn test_wrong_get() { + let mut trie: Node = Node::new(); + + trie.insert(&i("abc"), true).unwrap(); + trie.insert(&i("abd"), true).unwrap(); + trie.insert(&i("aca"), false).unwrap(); + + assert!(trie.get(&i("bb")).is_none()); + } +}