commit 56852c21def2b90dac61934ce589f2c19b1d71ae Author: Johannes Marbach Date: Sun Sep 12 14:51:07 2021 +0200 Initial import 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/Pipfile b/Pipfile new file mode 100644 index 0000000..1438471 --- /dev/null +++ b/Pipfile @@ -0,0 +1,13 @@ +[[source]] +url = "https://pypi.org/simple" +verify_ssl = true +name = "pypi" + +[packages] +pyyaml = "*" +gitpython = "*" + +[dev-packages] + +[requires] +python_version = "3.8" diff --git a/Pipfile.lock b/Pipfile.lock new file mode 100644 index 0000000..2c9eabd --- /dev/null +++ b/Pipfile.lock @@ -0,0 +1,80 @@ +{ + "_meta": { + "hash": { + "sha256": "2d598f1754849a1e6f92a1ee95baaf2ced919bf20e44a4eec871521e772b0127" + }, + "pipfile-spec": 6, + "requires": { + "python_version": "3.8" + }, + "sources": [ + { + "name": "pypi", + "url": "https://pypi.org/simple", + "verify_ssl": true + } + ] + }, + "default": { + "gitdb": { + "hashes": [ + "sha256:6c4cc71933456991da20917998acbe6cf4fb41eeaab7d6d67fbc05ecd4c865b0", + "sha256:96bf5c08b157a666fec41129e6d327235284cca4c81e92109260f353ba138005" + ], + "markers": "python_version >= '3.4'", + "version": "==4.0.7" + }, + "gitpython": { + "hashes": [ + "sha256:b838a895977b45ab6f0cc926a9045c8d1c44e2b653c1fcc39fe91f42c6e8f05b", + "sha256:fce760879cd2aebd2991b3542876dc5c4a909b30c9d69dfc488e504a8db37ee8" + ], + "index": "pypi", + "version": "==3.1.18" + }, + "pyyaml": { + "hashes": [ + "sha256:08682f6b72c722394747bddaf0aa62277e02557c0fd1c42cb853016a38f8dedf", + "sha256:0f5f5786c0e09baddcd8b4b45f20a7b5d61a7e7e99846e3c799b05c7c53fa696", + "sha256:129def1b7c1bf22faffd67b8f3724645203b79d8f4cc81f674654d9902cb4393", + "sha256:294db365efa064d00b8d1ef65d8ea2c3426ac366c0c4368d930bf1c5fb497f77", + "sha256:3b2b1824fe7112845700f815ff6a489360226a5609b96ec2190a45e62a9fc922", + "sha256:3bd0e463264cf257d1ffd2e40223b197271046d09dadf73a0fe82b9c1fc385a5", + "sha256:4465124ef1b18d9ace298060f4eccc64b0850899ac4ac53294547536533800c8", + "sha256:49d4cdd9065b9b6e206d0595fee27a96b5dd22618e7520c33204a4a3239d5b10", + "sha256:4e0583d24c881e14342eaf4ec5fbc97f934b999a6828693a99157fde912540cc", + "sha256:5accb17103e43963b80e6f837831f38d314a0495500067cb25afab2e8d7a4018", + "sha256:607774cbba28732bfa802b54baa7484215f530991055bb562efbed5b2f20a45e", + "sha256:6c78645d400265a062508ae399b60b8c167bf003db364ecb26dcab2bda048253", + "sha256:72a01f726a9c7851ca9bfad6fd09ca4e090a023c00945ea05ba1638c09dc3347", + "sha256:74c1485f7707cf707a7aef42ef6322b8f97921bd89be2ab6317fd782c2d53183", + "sha256:895f61ef02e8fed38159bb70f7e100e00f471eae2bc838cd0f4ebb21e28f8541", + "sha256:8c1be557ee92a20f184922c7b6424e8ab6691788e6d86137c5d93c1a6ec1b8fb", + "sha256:bb4191dfc9306777bc594117aee052446b3fa88737cd13b7188d0e7aa8162185", + "sha256:bfb51918d4ff3d77c1c856a9699f8492c612cde32fd3bcd344af9be34999bfdc", + "sha256:c20cfa2d49991c8b4147af39859b167664f2ad4561704ee74c1de03318e898db", + "sha256:cb333c16912324fd5f769fff6bc5de372e9e7a202247b48870bc251ed40239aa", + "sha256:d2d9808ea7b4af864f35ea216be506ecec180628aced0704e34aca0b040ffe46", + "sha256:d483ad4e639292c90170eb6f7783ad19490e7a8defb3e46f97dfe4bacae89122", + "sha256:dd5de0646207f053eb0d6c74ae45ba98c3395a571a2891858e87df7c9b9bd51b", + "sha256:e1d4970ea66be07ae37a3c2e48b5ec63f7ba6804bdddfdbd3cfd954d25a82e63", + "sha256:e4fac90784481d221a8e4b1162afa7c47ed953be40d31ab4629ae917510051df", + "sha256:fa5ae20527d8e831e8230cbffd9f8fe952815b2b7dae6ffec25318803a7528fc", + "sha256:fd7f6999a8070df521b6384004ef42833b9bd62cfee11a09bda1079b4b704247", + "sha256:fdc842473cd33f45ff6bce46aea678a54e3d21f1b61a7750ce3c498eedfe25d6", + "sha256:fe69978f3f768926cfa37b867e3843918e012cf83f680806599ddce33c2c68b0" + ], + "index": "pypi", + "version": "==5.4.1" + }, + "smmap": { + "hashes": [ + "sha256:7e65386bd122d45405ddf795637b7f7d2b532e7e401d46bbe3fb49b9986d5182", + "sha256:a9a7479e4c572e2e775c404dcd3080c8dc49f39918c2cf74913d30c4c478e3c2" + ], + "markers": "python_version >= '3.5'", + "version": "==4.0.0" + } + }, + "develop": {} +} diff --git a/README.md b/README.md new file mode 100644 index 0000000..60856cf --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# squeek2lvgl + +squeek2lvgl is a Python script that makes it possible to use [squeekboard] keyboard layouts with [LVGL]'s keyboard widget. To achieve this, [squeekboard]'s YAML syntax for layout definitions is converted into a C file (with an accompanying header) that can then be added to an [LVGL] project. + +To access [squeekboard]'s layout files, squeek2lvgl shallowly clones the [squeekboard] git repository into a temporary directory and purges it before exiting. + +## Usage + +First, set up the virtual Python environment and install the dependencies with + +``` +$ pipenv install +``` + +Afterwards you can execute the script with `pipenv run`. Use the `-h` / `--help` flag to print detailed usage instructions. + +``` +$ pipenv run python squeek2lvgl.py --help +usage: squeek2lvgl.py [-h] --input INPUT [--generate-scancodes] [--output OUTPUT] + +Convert squeekboard layouts to LVGL-compatible C code. + +optional arguments: + -h, --help show this help message and exit + --input INPUT squeekboard layout to use as input for generation. Has to be a YAML file path relative to data/keyboards. Can be specified + multiple times. + --generate-scancodes also generate scancode tables (only works for US layout currently + --output OUTPUT output directory for generated files +``` + +As an example, the following command converts [squeekboard]'s US layout to C + +``` +$ pipenv run python squeek2lvgl.py --input us.yaml --output . +``` + +When the process has finished, `sq2lv_layouts.h` and `sq2lv_layouts.c` will have been written into the current directory. Check the [examples] folder for further details about the generated files. + +## License + +squeek2lvgl Generator is licensed under 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. + +[squeekboard] and its keyboard layouts are licensed under the GNU General Public License version 3.0. + +[LVGL]: https://github.com/lvgl/lvgl +[squeekboard]: https://gitlab.gnome.org/World/Phosh/squeekboard +[examples]: ./examples diff --git a/examples/us-terminal-with-scancodes/sq2lv_layouts.c b/examples/us-terminal-with-scancodes/sq2lv_layouts.c new file mode 100644 index 0000000..c235790 --- /dev/null +++ b/examples/us-terminal-with-scancodes/sq2lv_layouts.c @@ -0,0 +1,186 @@ +/** + * Auto-generated with unsqu33kr + **/ + +#include "sq2lv_layouts.h" +#include + +/** + * Layout: US English (Terminal) - generated from terminal/us + **/ + +static const char * const name_terminal_us = "terminal/us"; + +/* Layer: Lowercase letters - generated from base */ + +static const char * const keycaps_lower_terminal_us[] = { \ + "Ctrl", "Alt", LV_SYMBOL_UP, LV_SYMBOL_DOWN, LV_SYMBOL_LEFT, LV_SYMBOL_RIGHT, "\n", \ + "q", "w", "e", "r", "t", "y", "u", "i", "o", "p", "\n", \ + "a", "s", "d", "f", "g", "h", "j", "k", "l", "\n", \ + "ABC", "z", "x", "c", "v", "b", "n", "m", LV_SYMBOL_BACKSPACE, "\n", \ + "1#", LV_SYMBOL_LEFT, " ", LV_SYMBOL_RIGHT, LV_SYMBOL_OK, "" \ +}; + +static const lv_btnmatrix_ctrl_t attributes_lower_terminal_us[] = { \ + LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, \ + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, \ + 2, 2, 2, 2, 2, 2, 2, 2, 2, \ + LV_KEYBOARD_CTRL_BTN_FLAGS | 3, 2, 2, 2, 2, 2, 2, 2, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, \ + LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 7, LV_KEYBOARD_CTRL_BTN_FLAGS | 7, LV_KEYBOARD_CTRL_BTN_FLAGS | 7, LV_KEYBOARD_CTRL_BTN_FLAGS | 3 \ +}; + +static const int num_scancodes_lower_terminal_us = 5; + +static const int scancodes_lower_terminal_us[] = { \ + KEY_LEFTCTRL, KEY_LEFTALT, KEY_UP, KEY_DOWN, KEY_LEFT, KEY_RIGHT, \ + KEY_Q, KEY_W, KEY_E, KEY_R, KEY_T, KEY_Y, KEY_U, KEY_I, KEY_O, KEY_P, \ + KEY_A, KEY_S, KEY_D, KEY_F, KEY_G, KEY_H, KEY_J, KEY_K, KEY_L, \ + KEY_Z, KEY_X, KEY_C, KEY_V, KEY_B, KEY_N, KEY_M, KEY_BACKSPACE, \ + KEY_LEFT, KEY_SPACE, KEY_RIGHT, KEY_ENTER \ +}; + +static const int scancode_idxs_lower_terminal_us[] = { \ + 0, 1, 2, 3, 4, 5, \ + 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, \ + 16, 17, 18, 19, 20, 21, 22, 23, 24, \ + -1, 25, 26, 27, 28, 29, 30, 31, 32, \ + -1, 33, 34, 35, 36 \ +}; + +static const int scancode_nums_lower_terminal_us[] = { \ + 1, 1, 1, 1, 1, 1, \ + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, \ + 1, 1, 1, 1, 1, 1, 1, 1, 1, \ + 0, 1, 1, 1, 1, 1, 1, 1, 1, \ + 0, 1, 1, 1, 1 \ +}; + +/* Layer: Uppercase letters - generated from upper */ + +static const char * const keycaps_upper_terminal_us[] = { \ + "Ctrl", "Alt", "PgUp", "PgDn", "Home", "End", "\n", \ + "Q", "W", "E", "R", "T", "Y", "U", "I", "O", "P", "\n", \ + "A", "S", "D", "F", "G", "H", "J", "K", "L", "\n", \ + "abc", "Z", "X", "C", "V", "B", "N", "M", LV_SYMBOL_BACKSPACE, "\n", \ + "1#", LV_SYMBOL_LEFT, " ", LV_SYMBOL_RIGHT, LV_SYMBOL_OK, "" \ +}; + +static const lv_btnmatrix_ctrl_t attributes_upper_terminal_us[] = { \ + LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, \ + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, \ + 2, 2, 2, 2, 2, 2, 2, 2, 2, \ + LV_KEYBOARD_CTRL_BTN_FLAGS | 3, 2, 2, 2, 2, 2, 2, 2, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, \ + LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 7, LV_KEYBOARD_CTRL_BTN_FLAGS | 7, LV_KEYBOARD_CTRL_BTN_FLAGS | 7, LV_KEYBOARD_CTRL_BTN_FLAGS | 3 \ +}; + +static const int num_scancodes_upper_terminal_us = 5; + +static const int scancodes_upper_terminal_us[] = { \ + KEY_LEFTCTRL, KEY_LEFTALT, KEY_PAGEUP, KEY_PAGEDOWN, KEY_HOME, KEY_END, \ + KEY_LEFTSHIFT, KEY_Q, KEY_LEFTSHIFT, KEY_W, KEY_LEFTSHIFT, KEY_E, KEY_LEFTSHIFT, KEY_R, KEY_LEFTSHIFT, KEY_T, KEY_LEFTSHIFT, KEY_Y, KEY_LEFTSHIFT, KEY_U, KEY_LEFTSHIFT, KEY_I, KEY_LEFTSHIFT, KEY_O, KEY_LEFTSHIFT, KEY_P, \ + KEY_LEFTSHIFT, KEY_A, KEY_LEFTSHIFT, KEY_S, KEY_LEFTSHIFT, KEY_D, KEY_LEFTSHIFT, KEY_F, KEY_LEFTSHIFT, KEY_G, KEY_LEFTSHIFT, KEY_H, KEY_LEFTSHIFT, KEY_J, KEY_LEFTSHIFT, KEY_K, KEY_LEFTSHIFT, KEY_L, \ + KEY_LEFTSHIFT, KEY_Z, KEY_LEFTSHIFT, KEY_X, KEY_LEFTSHIFT, KEY_C, KEY_LEFTSHIFT, KEY_V, KEY_LEFTSHIFT, KEY_B, KEY_LEFTSHIFT, KEY_N, KEY_LEFTSHIFT, KEY_M, KEY_BACKSPACE, \ + KEY_LEFT, KEY_SPACE, KEY_RIGHT, KEY_ENTER \ +}; + +static const int scancode_idxs_upper_terminal_us[] = { \ + 0, 1, 2, 3, 4, 5, \ + 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, \ + 26, 28, 30, 32, 34, 36, 38, 40, 42, \ + -1, 44, 46, 48, 50, 52, 54, 56, 58, \ + -1, 59, 60, 61, 62 \ +}; + +static const int scancode_nums_upper_terminal_us[] = { \ + 1, 1, 1, 1, 1, 1, \ + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, \ + 2, 2, 2, 2, 2, 2, 2, 2, 2, \ + 0, 2, 2, 2, 2, 2, 2, 2, 1, \ + 0, 1, 1, 1, 1 \ +}; + +/* Layer: Numbers / symbols - generated from numbers */ + +static const char * const keycaps_numbers_terminal_us[] = { \ + "Ctrl", "Alt", LV_SYMBOL_UP, LV_SYMBOL_DOWN, LV_SYMBOL_LEFT, LV_SYMBOL_RIGHT, "\n", \ + "1", "2", "3", "4", "5", "6", "7", "8", "9", "0", "\n", \ + "*", "#", "$", "/", "&", "-", "_", "+", "(", ")", "\n", \ + ",", "\"", "'", ":", ";", "!", "?", LV_SYMBOL_BACKSPACE, "\n", \ + "abc", LV_SYMBOL_LEFT, " ", LV_SYMBOL_RIGHT, ".", LV_SYMBOL_OK, "" \ +}; + +static const lv_btnmatrix_ctrl_t attributes_numbers_terminal_us[] = { \ + LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, \ + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, \ + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, \ + 2, 2, 2, 2, 2, 2, 2, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, \ + LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 7, LV_KEYBOARD_CTRL_BTN_FLAGS | 7, LV_KEYBOARD_CTRL_BTN_FLAGS | 7, 2, LV_KEYBOARD_CTRL_BTN_FLAGS | 3 \ +}; + +static const int num_scancodes_numbers_terminal_us = 5; + +static const int scancodes_numbers_terminal_us[] = { \ + KEY_LEFTCTRL, KEY_LEFTALT, KEY_UP, KEY_DOWN, KEY_LEFT, KEY_RIGHT, \ + KEY_1, KEY_2, KEY_3, KEY_4, KEY_5, KEY_6, KEY_7, KEY_8, KEY_9, KEY_0, \ + KEY_LEFTSHIFT, KEY_8, KEY_LEFTSHIFT, KEY_3, KEY_LEFTSHIFT, KEY_4, KEY_LEFTSHIFT, KEY_QUESTION, KEY_LEFTSHIFT, KEY_7, KEY_MINUS, KEY_LEFTSHIFT, KEY_MINUS, KEY_LEFTSHIFT, KEY_EQUAL, KEY_LEFTSHIFT, KEY_9, KEY_LEFTSHIFT, KEY_0, \ + KEY_COMMA, KEY_LEFTSHIFT, KEY_APOSTROPHE, KEY_APOSTROPHE, KEY_LEFTSHIFT, KEY_SEMICOLON, KEY_SEMICOLON, KEY_LEFTSHIFT, KEY_1, KEY_QUESTION, KEY_BACKSPACE, \ + KEY_LEFT, KEY_SPACE, KEY_RIGHT, KEY_DOT, KEY_ENTER \ +}; + +static const int scancode_idxs_numbers_terminal_us[] = { \ + 0, 1, 2, 3, 4, 5, \ + 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, \ + 16, 18, 20, 22, 24, 26, 27, 29, 31, 33, \ + 35, 36, 38, 39, 41, 42, 44, 45, \ + -1, 46, 47, 48, 49, 50 \ +}; + +static const int scancode_nums_numbers_terminal_us[] = { \ + 1, 1, 1, 1, 1, 1, \ + 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, \ + 2, 2, 2, 2, 2, 1, 2, 2, 2, 2, \ + 1, 2, 1, 2, 1, 2, 1, 1, \ + 0, 1, 1, 1, 1, 1 \ +}; + +/** + * Public interface + **/ + +const sq2lv_layout_t sq2lv_layouts[] = { + /* US English (Terminal) */ + { + .layers = (sq2lv_layer_t[]){ + { + .keycaps = keycaps_lower_terminal_us, + .attributes = attributes_lower_terminal_us, + .num_scancodes = num_scancodes_lower_terminal_us, + .scancodes = scancodes_lower_terminal_us, + .scancode_idxs = scancode_idxs_lower_terminal_us, + .scancode_nums = scancode_nums_lower_terminal_us + }, + { + .keycaps = keycaps_upper_terminal_us, + .attributes = attributes_upper_terminal_us, + .num_scancodes = num_scancodes_upper_terminal_us, + .scancodes = scancodes_upper_terminal_us, + .scancode_idxs = scancode_idxs_upper_terminal_us, + .scancode_nums = scancode_nums_upper_terminal_us + }, + { + .keycaps = keycaps_numbers_terminal_us, + .attributes = attributes_numbers_terminal_us, + .num_scancodes = num_scancodes_numbers_terminal_us, + .scancodes = scancodes_numbers_terminal_us, + .scancode_idxs = scancode_idxs_numbers_terminal_us, + .scancode_nums = scancode_nums_numbers_terminal_us + } + }, + .num_layers = 3 + } +}; + +const int sq2lv_num_layouts = 1; + +const char * const sq2lv_layout_names = + "US English (Terminal)"; diff --git a/examples/us-terminal-with-scancodes/sq2lv_layouts.h b/examples/us-terminal-with-scancodes/sq2lv_layouts.h new file mode 100644 index 0000000..1fe044e --- /dev/null +++ b/examples/us-terminal-with-scancodes/sq2lv_layouts.h @@ -0,0 +1,46 @@ +/** + * Auto-generated with unsqu33kr + **/ + +#ifndef SQ2LV_LAYOUTS_H +#define SQ2LV_LAYOUTS_H + +#include "../lvgl/lvgl.h" + +/* Layout IDs, values can be used as indexes into the sq2lv_layouts array */ +typedef enum { + SQ2LV_LAYOUT_TERMINAL_US = 0 +} sq2lv_layout_id_t; + +/* Layout type */ +typedef struct { + /* Layers array */ + const sq2lv_layer_t * const layers; + /* Total number of layers */ + const int num_layers; +} sq2lv_layout_t; + +/* Layer type */ +typedef struct { + /* Key caps */ + const char ** const keycaps; + /* Button matrix attributes */ + const lv_btnmatrix_ctrl_t * const attributes; + /* Total number of scancodes */ + const int const num_scancodes; + /* Flat array of scancodes */ + const int * const scancodes; + /* Start index in scancodes array for key cap */ + const int * const scancode_idxs; + /* Number of scancodes for key cap */ + const int * const scancode_nums; +} sq2lv_layer_t; + +/* Layouts */ +extern const sq2lv_layout_t sq2lv_layouts[]; +extern const int sq2lv_num_layouts; + +/* Layout names (suitable for use in lv_dropdown_t */ +extern const char * const sq2lv_layout_names; + +#endif /* SQ2LV_LAYOUTS_H */ diff --git a/examples/us/sq2lv_layouts.c b/examples/us/sq2lv_layouts.c new file mode 100644 index 0000000..ed209d5 --- /dev/null +++ b/examples/us/sq2lv_layouts.c @@ -0,0 +1,89 @@ +/** + * Auto-generated with unsqu33kr + **/ + +#include "sq2lv_layouts.h" + +/** + * Layout: US English - generated from us + **/ + +static const char * const name_us = "us"; + +/* Layer: Lowercase letters - generated from base */ + +static const char * const keycaps_lower_us[] = { \ + "q", "w", "e", "r", "t", "y", "u", "i", "o", "p", "\n", \ + "a", "s", "d", "f", "g", "h", "j", "k", "l", "\n", \ + "ABC", "z", "x", "c", "v", "b", "n", "m", LV_SYMBOL_BACKSPACE, "\n", \ + "1#", LV_SYMBOL_LEFT, " ", LV_SYMBOL_RIGHT, ".", LV_SYMBOL_OK, "" \ +}; + +static const lv_btnmatrix_ctrl_t attributes_lower_us[] = { \ + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, \ + 2, 2, 2, 2, 2, 2, 2, 2, 2, \ + LV_KEYBOARD_CTRL_BTN_FLAGS | 3, 2, 2, 2, 2, 2, 2, 2, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, \ + LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 7, LV_KEYBOARD_CTRL_BTN_FLAGS | 7, LV_KEYBOARD_CTRL_BTN_FLAGS | 7, 2, LV_KEYBOARD_CTRL_BTN_FLAGS | 3 \ +}; + +/* Layer: Uppercase letters - generated from upper */ + +static const char * const keycaps_upper_us[] = { \ + "Q", "W", "E", "R", "T", "Y", "U", "I", "O", "P", "\n", \ + "A", "S", "D", "F", "G", "H", "J", "K", "L", "\n", \ + "abc", "Z", "X", "C", "V", "B", "N", "M", LV_SYMBOL_BACKSPACE, "\n", \ + "1#", LV_SYMBOL_LEFT, " ", LV_SYMBOL_RIGHT, ".", LV_SYMBOL_OK, "" \ +}; + +static const lv_btnmatrix_ctrl_t attributes_upper_us[] = { \ + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, \ + 2, 2, 2, 2, 2, 2, 2, 2, 2, \ + LV_KEYBOARD_CTRL_BTN_FLAGS | 3, 2, 2, 2, 2, 2, 2, 2, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, \ + LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 7, LV_KEYBOARD_CTRL_BTN_FLAGS | 7, LV_KEYBOARD_CTRL_BTN_FLAGS | 7, 2, LV_KEYBOARD_CTRL_BTN_FLAGS | 3 \ +}; + +/* Layer: Numbers / symbols - generated from numbers */ + +static const char * const keycaps_numbers_us[] = { \ + "1", "2", "3", "4", "5", "6", "7", "8", "9", "0", "\n", \ + "@", "#", "$", "%", "&", "-", "_", "+", "(", ")", "\n", \ + ",", "\"", "'", ":", ";", "!", "?", LV_SYMBOL_BACKSPACE, "\n", \ + "abc", LV_SYMBOL_LEFT, " ", LV_SYMBOL_RIGHT, ".", LV_SYMBOL_OK, "" \ +}; + +static const lv_btnmatrix_ctrl_t attributes_numbers_us[] = { \ + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, \ + 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, \ + 2, 2, 2, 2, 2, 2, 2, LV_KEYBOARD_CTRL_BTN_FLAGS | 3, \ + LV_KEYBOARD_CTRL_BTN_FLAGS | 3, LV_KEYBOARD_CTRL_BTN_FLAGS | 7, LV_KEYBOARD_CTRL_BTN_FLAGS | 7, LV_KEYBOARD_CTRL_BTN_FLAGS | 7, 2, LV_KEYBOARD_CTRL_BTN_FLAGS | 3 \ +}; + +/** + * Public interface + **/ + +const sq2lv_layout_t sq2lv_layouts[] = { + /* US English */ + { + .layers = (sq2lv_layer_t[]){ + { + .keycaps = keycaps_lower_us, + .attributes = attributes_lower_us + }, + { + .keycaps = keycaps_upper_us, + .attributes = attributes_upper_us + }, + { + .keycaps = keycaps_numbers_us, + .attributes = attributes_numbers_us + } + }, + .num_layers = 3 + } +}; + +const int sq2lv_num_layouts = 1; + +const char * const sq2lv_layout_names = + "US English"; diff --git a/examples/us/sq2lv_layouts.h b/examples/us/sq2lv_layouts.h new file mode 100644 index 0000000..540ecdd --- /dev/null +++ b/examples/us/sq2lv_layouts.h @@ -0,0 +1,46 @@ +/** + * Auto-generated with unsqu33kr + **/ + +#ifndef SQ2LV_LAYOUTS_H +#define SQ2LV_LAYOUTS_H + +#include "../lvgl/lvgl.h" + +/* Layout IDs, values can be used as indexes into the sq2lv_layouts array */ +typedef enum { + SQ2LV_LAYOUT_US = 0 +} sq2lv_layout_id_t; + +/* Layout type */ +typedef struct { + /* Layers array */ + const sq2lv_layer_t * const layers; + /* Total number of layers */ + const int num_layers; +} sq2lv_layout_t; + +/* Layer type */ +typedef struct { + /* Key caps */ + const char ** const keycaps; + /* Button matrix attributes */ + const lv_btnmatrix_ctrl_t * const attributes; + /* Total number of scancodes */ + const int const num_scancodes; + /* Flat array of scancodes */ + const int * const scancodes; + /* Start index in scancodes array for key cap */ + const int * const scancode_idxs; + /* Number of scancodes for key cap */ + const int * const scancode_nums; +} sq2lv_layer_t; + +/* Layouts */ +extern const sq2lv_layout_t sq2lv_layouts[]; +extern const int sq2lv_num_layouts; + +/* Layout names (suitable for use in lv_dropdown_t */ +extern const char * const sq2lv_layout_names; + +#endif /* SQ2LV_LAYOUTS_H */ diff --git a/regenerate-examples.sh b/regenerate-examples.sh new file mode 100755 index 0000000..91132dc --- /dev/null +++ b/regenerate-examples.sh @@ -0,0 +1,29 @@ +#!/bin/bash + +# Copyright 2021 Johannes Marbach +# +# This file is part of squeek2lvgl, hereafter referred to as the program. +# +# 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 . + +pipenv install + +pipenv run python squeek2lvgl.py \ + --input us.yaml \ + --output examples/us + +pipenv run python squeek2lvgl.py \ + --input terminal/us.yaml \ + --output examples/us-terminal-with-scancodes \ + --generate-scancodes diff --git a/squeek2lvgl.py b/squeek2lvgl.py new file mode 100644 index 0000000..ed25c77 --- /dev/null +++ b/squeek2lvgl.py @@ -0,0 +1,699 @@ +#!/usr/bin/env python3 + +# Copyright 2021 Johannes Marbach +# +# This file is part of squeek2lvgl, hereafter referred to as the program. +# +# 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 . + +import argparse +import git +import os +import sys +import tempfile +import yaml + + +### +# Global constants + +outfile_c = 'sq2lv_layouts.c' +outfile_h = 'sq2lv_layouts.h' + +repository_url = 'https://gitlab.gnome.org/World/Phosh/squeekboard.git' +rel_layouts_dir = 'data/keyboards' + +typedef_layer_t = [ + 'typedef struct {', + ' /* Key caps */', + ' const char ** const keycaps;', + ' /* Button matrix attributes */', + ' const lv_btnmatrix_ctrl_t * const attributes;', + # ' /* Number of buttons that trigger a layer switch */', + # ' const int num_triggers;', + # ' /* Button indexes that trigger a layer switch */', + # ' const int * const trigger_idxs;', + # ' /* Indexes of layers to jump to when hitting trigger */', + # ' const int * const trigger_targets;', + ' /* Total number of scancodes */', + ' const int const num_scancodes;', + ' /* Flat array of scancodes */', + ' const int * const scancodes;', + ' /* Start index in scancodes array for key cap */', + ' const int * const scancode_idxs;', + ' /* Number of scancodes for key cap */', + ' const int * const scancode_nums;', + '} sq2lv_layer_t;' +] + +typedef_layout_t = [ + 'typedef struct {', + ' /* Layers array */', + ' const sq2lv_layer_t * const layers;', + ' /* Total number of layers */', + ' const int num_layers;', + '} sq2lv_layout_t;' +] + + +### +# General helpers +## + +def die(msg): + """Print an error message to STDERR and exit with a non-zero code. + + msg -- message to output on STDERR + """ + sys.stderr.write(msg if msg.endswith('\n') else msg + '\n') + sys.exit(1) + + +def warn(msg): + """Print a warning message to STDERR. + + msg -- message to output on STDERR + """ + sys.stderr.write(msg if msg.endswith('\n') else msg + '\n') + + +def parse_arguments(): + """ Parse commandline arguments. + """ + parser = argparse.ArgumentParser(description='Convert squeekboard layouts to LVGL-compatible C code.') + parser.add_argument('--input', dest='input', action='append', required=True, help='squeekboard layout to ' + + 'use as input for generation. Has to be a YAML file path relative to data/keyboards. ' + + 'Can be specified multiple times.') + parser.add_argument('--generate-scancodes', action='store_true', dest='generate_scancodes', help='also ' + + 'generate scancode tables (only works for US layout currently') + parser.add_argument('--output', dest='output', type=str, help='output directory for generated files') + args = parser.parse_args() + + if not args.output or not os.path.isdir(args.output): + die('Error: no valid output directory specified') + + return args + + +def clone_squeekboard_repo(destination): + """ Clone the squeekboard git repository. + + destination -- directory path to clone to + """ + git.Repo.clone_from(repository_url, destination, depth=1) + + +def load_yaml(rel_path): + """ Load a YAML file and return its dictionary representation. + + rel_path -- path of the YAML file relative to the layouts root directory + """ + path = os.path.join(layouts_dir, rel_path) + if not os.path.isfile(path): + die(f'could not find input file {path}') + + data = None + with open(path, 'r') as stream: + try: + data = yaml.safe_load(stream) + except yaml.YAMLError as exc: + die(f'Could not load YAML file {path}: {exc}') + if not data: + die(f'could not load input file {path}') + if not 'views' in data: + die(f'no "views" element in YAML data loaded from input file {path}') + + return data + + +def write_files(lines_c, lines_h): + """Write accumulated output to C and header file, respectively. + + lines_c -- sequence of lines to write to C file + lines_h -- sequence of lines to write to header + """ + with open(os.path.join(args.output, outfile_c), 'w') as fp: + fp.write('\n'.join(lines_c)) + with open(os.path.join(args.output, outfile_h), 'w') as fp: + fp.write('\n'.join(lines_h)) + + +def comma_if_needed(sequence, idx): + """Return a comma unless idx points to the last element in sequence. + + sequence -- a sequence of elements + idx -- an index into the sequence + """ + return ',' if idx < len(sequence) - 1 else '' + + +### +# SourceFileBuilder +## + +class SourceFileBuilder(object): + """Builder for .c and .h files. + """ + + def __init__(self): + """Constructor. + """ + self.lines = [] + self._add_header_comment() + + def add_line(self, line=None): + """Add a single line and return the builder. + + line - string representing the line to add (if None, an empty line will be added) + """ + self.lines.append(line if line else '') + return self + + def add_lines(self, lines): + """Add multiple lines and return the builder. + + lines - a list of strings representing the lines to add + """ + self.lines += lines + return self + + def wrap_in_ifndef(self, macro): + """Wrap all of the current content in a macro check to prevent double inclusion and + return the builder. + + macro -- name of the macro to use + """ + idx = 0 + while self.lines[idx][:2] in ['/*', ' *']: + idx += 1 + self.lines.insert(idx, '') + self.lines.insert(idx + 1, f'#ifndef {macro}') + self.lines.insert(idx + 2, f'#define {macro}') + self.add_lines(['', f'#endif /* {macro} */']) + + def _add_header_comment(self): + """Add the generator header comment and return the builder. + """ + self.add_lines(['/**', ' * Auto-generated with unsqu33kr', ' **/', '']) + return self + + def add_include(self, header): + """Add an include statement and return the builder. + + header -- path to file to be included + """ + self.add_line(f'#include "{header}"') + return self + + def add_system_include(self, header): + """Add a system include statement and return the builder. + + header -- path to file to be included + """ + self.add_line(f'#include <{header}>') + return self + + def add_section_comment(self, title): + """Add a comment marking the beginning of a section and return the builder. + + title -- title of the section + """ + self.add_lines(['/**', f' * {title}', ' **/']) + return self + + def add_subsection_comment(self, title): + """Add a comment marking the beginning of a subsection and return the builder. + + title -- title of the subsection + """ + self.add_line(f'/* {title} */') + return self + + def add_array(self, static, type, identifier, values, row_terminator, array_terminator): + """Add a C array and return the builder. + + static -- True if the variable is static + type -- variable type + identifier -- variable identifier + values -- values per row as a list of lists, + row_terminator -- element to append to each row except the last + array_terminator -- element to append to the last row + """ + prefix = 'static ' if static else '' + self.add_line(f'{prefix}{type} {identifier}[] = ' + '{ \\') + for i, values_in_row in enumerate(values): + elements = values_in_row + if i < len(values) - 1 and row_terminator: + elements.append(row_terminator) + if i == len(values) - 1 and array_terminator: + elements.append(array_terminator) + joined = ', '.join([f'{e}' for e in elements]) + self.add_line(f' {joined}{comma_if_needed(values, i)} \\') + self.add_line('};') + return self + + +### +# Layout processing +## + +layout_name_for_layout_id = { + 'terminal/us': 'US English (Terminal)', + 'de': 'German', + 'es': 'Spanish', + 'fr': 'French', + 'us': 'US English' +} + +def layout_id_to_layout_name(layout_id): + """Return a descriptive name for a layout. + + layout_id -- ID of the layout + """ + return layout_name_for_layout_id[layout_id] + + +def layout_id_to_c_identifier(layout_id): + """Return a string for a layout that is suitable to be used in a C identifier. + + layout_id -- ID of the layout + """ + return layout_id.lower().replace('/', '_') + + +layer_name_for_view_id = { + 'base': 'Lowercase letters', + 'upper': 'Uppercase letters', + 'numbers': 'Numbers / symbols', + 'eschars': 'Special characters' +} + +def view_id_to_layer_name(view_id): + """Return a descriptive name for a layer based on its view ID. + + view_id -- the ID of the view representing the layer + """ + if view_id not in layer_name_for_view_id: + return None + return layer_name_for_view_id[view_id] + + +layer_identifier_for_view_id = { + 'base': 'lower', + 'eschars': 'special' +} + +def view_id_to_c_identifier(view_id): + """Return a string for a view that is suitable to be used in a C identifier. + + view_id -- ID of the view + """ + return layer_identifier_for_view_id[view_id] if view_id in layer_identifier_for_view_id else view_id + + +keycap_for_key = { + '\\': '\\\\', + '"': '\\"', + '↑': 'LV_SYMBOL_UP', + '↓': 'LV_SYMBOL_DOWN', + '←': 'LV_SYMBOL_LEFT', + '→': 'LV_SYMBOL_RIGHT', + 'BackSpace': 'LV_SYMBOL_BACKSPACE', + 'colon': ':', + 'period': '.', + 'preferences': None, + 'Shift_L': { + 'base': 'ABC', + 'upper': 'abc' + }, + 'show_actions': None, + 'show_eschars': { + 'de': 'äöü', + 'es': 'áéí', + 'fr': 'àéô' + }, + 'show_letters': 'abc', + 'show_numbers': '1#', + 'show_numbers_from_symbols': '1#', + 'show_symbols': None, + 'space': ['LV_SYMBOL_LEFT', ' ', 'LV_SYMBOL_RIGHT'], + 'Return': 'LV_SYMBOL_OK', +} + +def key_to_keycap(key, view_id, layout_id): + """Return the list of keycaps for a key + + key -- the key + view_id -- ID of the view the key appears on + layout_id -- ID of the layout the view is part of + """ + keycap = keycap_for_key[key] if key in keycap_for_key else key + if isinstance(keycap, dict): + if view_id in keycap: + keycap = keycap[view_id] + elif layout_id in keycap: + keycap = keycap[layout_id] + else: + keycap = None + if not keycap: + return [] + if isinstance(keycap, list): + return keycap + return [keycap] + + +def key_to_attributes(key, data_buttons): + """Return the LVGL button attributes for a key. + + key -- the key in question + data_buttons -- the "buttons" object from the layout's YAML file + """ + if key in ['period', 'colon', '"'] or key not in data_buttons: + return '2' + width = 7 if key == 'space' else 3 + return f'LV_KEYBOARD_CTRL_BTN_FLAGS | {width}' + + +def keycap_to_c_value(keycap): + """Return the right-hand side C value for a keycap + """ + return keycap if keycap.startswith('LV_') else f'"{keycap}"' + + +scancodes_for_keycap = { + '0': ['KEY_0'], + '1': ['KEY_1'], + '2': ['KEY_2'], + '3': ['KEY_3'], + '4': ['KEY_4'], + '5': ['KEY_5'], + '6': ['KEY_6'], + '7': ['KEY_7'], + '8': ['KEY_8'], + '9': ['KEY_9'], + 'a': ['KEY_A'], + 'b': ['KEY_B'], + 'c': ['KEY_C'], + 'd': ['KEY_D'], + 'e': ['KEY_E'], + 'f': ['KEY_F'], + 'g': ['KEY_G'], + 'h': ['KEY_H'], + 'i': ['KEY_I'], + 'j': ['KEY_J'], + 'k': ['KEY_K'], + 'l': ['KEY_L'], + 'm': ['KEY_M'], + 'n': ['KEY_N'], + 'o': ['KEY_O'], + 'p': ['KEY_P'], + 'q': ['KEY_Q'], + 'r': ['KEY_R'], + 's': ['KEY_S'], + 't': ['KEY_T'], + 'u': ['KEY_U'], + 'v': ['KEY_V'], + 'w': ['KEY_W'], + 'x': ['KEY_X'], + 'y': ['KEY_Y'], + 'z': ['KEY_Z'], + 'A': ['KEY_LEFTSHIFT', 'KEY_A'], + 'B': ['KEY_LEFTSHIFT', 'KEY_B'], + 'C': ['KEY_LEFTSHIFT', 'KEY_C'], + 'D': ['KEY_LEFTSHIFT', 'KEY_D'], + 'E': ['KEY_LEFTSHIFT', 'KEY_E'], + 'F': ['KEY_LEFTSHIFT', 'KEY_F'], + 'G': ['KEY_LEFTSHIFT', 'KEY_G'], + 'H': ['KEY_LEFTSHIFT', 'KEY_H'], + 'I': ['KEY_LEFTSHIFT', 'KEY_I'], + 'J': ['KEY_LEFTSHIFT', 'KEY_J'], + 'K': ['KEY_LEFTSHIFT', 'KEY_K'], + 'L': ['KEY_LEFTSHIFT', 'KEY_L'], + 'M': ['KEY_LEFTSHIFT', 'KEY_M'], + 'N': ['KEY_LEFTSHIFT', 'KEY_N'], + 'O': ['KEY_LEFTSHIFT', 'KEY_O'], + 'P': ['KEY_LEFTSHIFT', 'KEY_P'], + 'Q': ['KEY_LEFTSHIFT', 'KEY_Q'], + 'R': ['KEY_LEFTSHIFT', 'KEY_R'], + 'S': ['KEY_LEFTSHIFT', 'KEY_S'], + 'T': ['KEY_LEFTSHIFT', 'KEY_T'], + 'U': ['KEY_LEFTSHIFT', 'KEY_U'], + 'V': ['KEY_LEFTSHIFT', 'KEY_V'], + 'W': ['KEY_LEFTSHIFT', 'KEY_W'], + 'X': ['KEY_LEFTSHIFT', 'KEY_X'], + 'Y': ['KEY_LEFTSHIFT', 'KEY_Y'], + 'Z': ['KEY_LEFTSHIFT', 'KEY_Z'], + 'Alt': ['KEY_LEFTALT'], + 'Ctrl': ['KEY_LEFTCTRL'], + 'LV_SYMBOL_UP': ['KEY_UP'], + 'LV_SYMBOL_DOWN': ['KEY_DOWN'], + 'LV_SYMBOL_LEFT': ['KEY_LEFT'], + 'LV_SYMBOL_RIGHT': ['KEY_RIGHT'], + 'LV_SYMBOL_BACKSPACE': ['KEY_BACKSPACE'], + 'LV_SYMBOL_OK': ['KEY_ENTER'], + ' ': ['KEY_SPACE'], + 'ABC': [], + 'abc': [], + '1#': [], + 'PgUp': ['KEY_PAGEUP'], + 'PgDn': ['KEY_PAGEDOWN'], + 'Home': ['KEY_HOME'], + 'End': ['KEY_END'], + '*': ['KEY_LEFTSHIFT', 'KEY_8'], + '#': ['KEY_LEFTSHIFT', 'KEY_3'], + '$': ['KEY_LEFTSHIFT', 'KEY_4'], + '/': ['KEY_LEFTSHIFT', 'KEY_QUESTION'], + '&': ['KEY_LEFTSHIFT', 'KEY_7'], + '-': ['KEY_MINUS'], + '_': ['KEY_LEFTSHIFT', 'KEY_MINUS'], + '+': ['KEY_LEFTSHIFT', 'KEY_EQUAL'], + '(': ['KEY_LEFTSHIFT', 'KEY_9'], + ')': ['KEY_LEFTSHIFT', 'KEY_0'], + ',': ['KEY_COMMA'], + '\\"': ['KEY_LEFTSHIFT', 'KEY_APOSTROPHE'], + '\'': ['KEY_APOSTROPHE'], + ':': ['KEY_LEFTSHIFT', 'KEY_SEMICOLON'], + ';': ['KEY_SEMICOLON'], + '!': ['KEY_LEFTSHIFT', 'KEY_1'], + '?': ['KEY_QUESTION'], + '.': ['KEY_DOT'] +} + +def keycap_to_scancodes(keycap): + """Return the scancodes needed to produce a keycap + + keycap -- keycap to produce + """ + if keycap not in scancodes_for_keycap: + die(f'cannot determine scancodes for unknown keycap "{keycap}"') + return scancodes_for_keycap[keycap] + + +def get_keycaps_attrs_scancodes(layout_id, view_id, data_views, data_buttons, include_scancodes): + """Return keycaps, LVGL button attributes and scancodes for a view + + layout_id -- ID of the layout + view_id -- ID of the view + data_views -- the "views" object from the layout's YAML file + data_buttons -- the "buttons" object from the layout's YAML file + include_scancodes -- True if scancodes should be included + """ + keycaps = [] + attrs = [] + scancodes = [] + + for row in data_views[view_id]: + keycaps_in_row = [] + attrs_in_row = [] + scancodes_in_row = [] + for key in row.split(): + for keycap in key_to_keycap(key, view_id, layout_id): + keycaps_in_row.append(keycap_to_c_value(keycap)) + attrs_in_row.append(key_to_attributes(key, data_buttons)) + if include_scancodes: + scancodes_in_row.append(keycap_to_scancodes(keycap)) + keycaps.append(keycaps_in_row) + attrs.append(attrs_in_row) + scancodes.append(scancodes_in_row) + + return keycaps, attrs, scancodes + + +def flatten_scancodes(scancodes): + """Process a nested list of scancodes per key and return a flattened list, a list of starting indexes and a + list of scancode counts. + + scancodes -- list (rows) of list (keys) of list (scancodes) of scancodes + """ + flat = [] + idxs = [] + nums = [] + + if args.generate_scancodes: + idx = 0 + num = 0 + + for scancodes_in_row in scancodes: + flat_in_row = [] + idxs_in_row = [] + nums_in_row = [] + + for codes in scancodes_in_row: + flat_in_row += codes + idxs_in_row.append(idx if len(codes) > 0 else -1) + nums_in_row.append(len(codes)) + idx += len(codes) + + flat.append(flat_in_row) + idxs.append(idxs_in_row) + nums.append(nums_in_row) + + return flat, idxs, nums + + +### +# Main +## + +if __name__ == '__main__': + args = parse_arguments() + + c_builder = SourceFileBuilder() + c_builder.add_include(outfile_h) + if args.generate_scancodes: + c_builder.add_system_include('linux/input.h') + c_builder.add_line() + + h_builder = SourceFileBuilder() + h_builder.add_include('../lvgl/lvgl.h') + h_builder.add_line() + + layouts = [] + + with tempfile.TemporaryDirectory() as tmp: + clone_squeekboard_repo(tmp) + + layouts_dir = os.path.join(tmp, rel_layouts_dir) + + for file in args.input: + layout_id, _ = os.path.splitext(file) + layout_identifier = layout_id_to_c_identifier(layout_id) + + data = load_yaml(file) + data_views = data['views'] + data_buttons = data['buttons'] if 'buttons' in data else {} + + c_builder.add_section_comment(f'Layout: {layout_id_to_layout_name(layout_id)} - generated from {layout_id}') + c_builder.add_line() + c_builder.add_line(f'static const char * const name_{layout_identifier} = "{layout_id}";') + c_builder.add_line() + + layer_identifiers = [] + + for view_id in data_views: + layer_name = view_id_to_layer_name(view_id) + if not layer_name: + warn(f'Ignoring unknown view_id {view_id}') + continue + + layer_identifier = f'{view_id_to_c_identifier(view_id)}_{layout_identifier}' + layer_identifiers.append(layer_identifier) + + c_builder.add_subsection_comment(f'Layer: {layer_name} - generated from {view_id}') + c_builder.add_line() + + keycaps, attrs, scancodes = get_keycaps_attrs_scancodes(layout_id, view_id, data_views, data_buttons, args.generate_scancodes) + + c_builder.add_array(True, 'const char * const', f'keycaps_{layer_identifier}', keycaps, '"\\n"', '""') + c_builder.add_line() + c_builder.add_array(True, 'const lv_btnmatrix_ctrl_t', f'attributes_{layer_identifier}', attrs, '', '') + c_builder.add_line() + + if args.generate_scancodes: + scancodes_flat, scancode_idxs, scancode_nums = flatten_scancodes(scancodes) + + c_builder.add_line(f'static const int num_scancodes_{layer_identifier} = {len(scancodes)};') + c_builder.add_line() + c_builder.add_array(True, 'const int', f'scancodes_{layer_identifier}', scancodes_flat, '', '') + c_builder.add_line() + c_builder.add_array(True, 'const int', f'scancode_idxs_{layer_identifier}', scancode_idxs, '', '') + c_builder.add_line() + c_builder.add_array(True, 'const int', f'scancode_nums_{layer_identifier}', scancode_nums, '', '') + c_builder.add_line() + + layouts.append({ + 'name': layout_id_to_layout_name(layout_id), + 'identifier': layout_identifier, + 'layer_identifiers': layer_identifiers + }) + + h_builder.add_line('/* Layout IDs, values can be used as indexes into the sq2lv_layouts array */') + h_builder.add_line('typedef enum {') + for i, layout in enumerate(layouts): + identifier = layout['identifier'].upper() + h_builder.add_line(f' SQ2LV_LAYOUT_{identifier} = {i}{comma_if_needed(layouts, i)}') + h_builder.add_line('} sq2lv_layout_id_t;') + h_builder.add_line() + + h_builder.add_line('/* Layout type */') + h_builder.add_lines(typedef_layout_t) + h_builder.add_line() + + h_builder.add_line('/* Layer type */') + h_builder.add_lines(typedef_layer_t) + h_builder.add_line() + + h_builder.add_line('/* Layouts */') + h_builder.add_line('extern const sq2lv_layout_t sq2lv_layouts[];') + h_builder.add_line('extern const int sq2lv_num_layouts;') + h_builder.add_line() + + h_builder.add_line('/* Layout names (suitable for use in lv_dropdown_t */') + h_builder.add_line('extern const char * const sq2lv_layout_names;') + + c_builder.add_section_comment('Public interface') + c_builder.add_line() + + c_builder.add_line('const sq2lv_layout_t sq2lv_layouts[] = {') + for i, layout in enumerate(layouts): + c_builder.add_line(' /* ' + layout['name'] + ' */') + c_builder.add_line(' {') + c_builder.add_line(' .layers = (sq2lv_layer_t[]){') + for j, identifier in enumerate(layout['layer_identifiers']): + c_builder.add_line(' {') + fields = ['keycaps', 'attributes'] + if args.generate_scancodes: + fields += ['num_scancodes', 'scancodes', 'scancode_idxs', 'scancode_nums'] + for k, field in enumerate(fields): + c_builder.add_line(f' .{field} = {field}_{identifier}{comma_if_needed(fields, k)}') + c_builder.add_line(' }' + comma_if_needed(layout['layer_identifiers'], j)) + c_builder.add_line(' },') + c_builder.add_line(' .num_layers = ' + str(len(layout['layer_identifiers']))) + c_builder.add_line(' }' + comma_if_needed(layouts, i)) + c_builder.add_line('};') + c_builder.add_line() + + c_builder.add_line('const int sq2lv_num_layouts = ' + str(len(layouts)) + ';') + c_builder.add_line() + + names = [layout['name'] for layout in layouts] + names = '\n ' + ' "\\n"\n '.join([f'"{name}"' for name in names]) + c_builder.add_line(f'const char * const sq2lv_layout_names = {names};') + + h_builder.wrap_in_ifndef('SQ2LV_LAYOUTS_H') + + c_builder.add_line() + h_builder.add_line() + + write_files(c_builder.lines, h_builder.lines) \ No newline at end of file