From 6bcc8ee5620e30f084e3bdf315b055774d472267 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 16 Jan 2017 15:18:13 +0100 Subject: [PATCH 01/52] Initial import Lifted out of the monolithic Akela library. Signed-off-by: Gergely Nagy --- .gitignore | 2 + COPYING | 674 +++++++++++++++++++++++++++++ README.md | 56 +++ examples/TopsyTurvy/TopsyTurvy.ino | 57 +++ library.properties | 10 + src/Akela-TopsyTurvy.h | 21 + src/Akela/TopsyTurvy.cpp | 118 +++++ src/Akela/TopsyTurvy.h | 47 ++ 8 files changed, 985 insertions(+) create mode 100644 .gitignore create mode 100644 COPYING create mode 100644 README.md create mode 100644 examples/TopsyTurvy/TopsyTurvy.ino create mode 100644 library.properties create mode 100644 src/Akela-TopsyTurvy.h create mode 100644 src/Akela/TopsyTurvy.cpp create mode 100644 src/Akela/TopsyTurvy.h diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..aead9485 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +.#* +*~ diff --git a/COPYING b/COPYING new file mode 100644 index 00000000..94a9ed02 --- /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/README.md b/README.md new file mode 100644 index 00000000..d1c2387c --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +# Akela-TopsyTurvy + +`TopsyTurvy` is a plugin that inverts the behaviour of the `Shift` key for some +selected keys. That is, if configured so, it will input `!` when pressing the +`1` key without `Shift`, but with the modifier pressed, it will input the +original `1` symbol. + +## Using the plugin + +To use the plugin, one needs to include the header, create a list, and configure +the provided `TopsyTurvy` object to use the dictionary: + +```c++ +#include + +static const Key topsyTurvyList[] PROGMEM = { + Key_1, Key_2, Key_3, Key_4, Key_5, + Key_6, Key_7, Key_8, Key_9, Key_0, + Key_NoKey +}; + +void setup () { + TopsyTurvy.configure (topsyTurvyList); + + Keyboardio.setup (KEYMAP_SIZE); + Keyboardio.use (&TopsyTurvy, NULL); +} +``` + +The list of keys **must** be terminated with a `Key_NoKey`, and **must** reside +in `PROGMEM`. + +## Plugin methods + +The plugin provides the `TopsyTurvy` object, with the following methods: + +### `.configure(list)` + +> Tells `TopsyTurvy` to use the specified list of keys. + +### `.on()` + +> Turns the shift-inversion functionality on. + +### `.off()` + +> Turns the shift-inversion functionality off. In this case, no transformations +> will be applied, and even if keys pressed appear in the list, they will be +> ignored until the plugin is turned back on. + +## Further reading + +Starting from the [example][plugin:example] is the recommended way of getting +started with the plugin. + + [plugin:example]: https://github.com/Akela-Plugins/Akela-TopsyTurvy/blob/master/examples/TopsyTurvy/TopsyTurvy.ino diff --git a/examples/TopsyTurvy/TopsyTurvy.ino b/examples/TopsyTurvy/TopsyTurvy.ino new file mode 100644 index 00000000..43575fbd --- /dev/null +++ b/examples/TopsyTurvy/TopsyTurvy.ino @@ -0,0 +1,57 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2017 Gergely Nagy + * + * 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 . + */ + +#include + +const Key keymaps[][ROWS][COLS] PROGMEM = { + [0] = KEYMAP_STACKED + ( + Key_LEDEffectNext, Key_1, Key_2, Key_3, Key_4, Key_5, Key_LEDEffectNext, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDn, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Esc, + + Key_LCtrl, Key_Backspace, Key_LGUI, Key_LShift, + Key_skip, + + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + + Key_RShift, Key_RAlt, Key_Space, Key_RCtrl, + Key_skip + ), +}; + +static const Key topsyTurvyList[] PROGMEM = { + Key_1, Key_2, Key_3, Key_4, Key_5, + Key_6, Key_7, Key_8, Key_9, Key_0, + Key_NoKey +}; + +void setup () { + TopsyTurvy.configure (topsyTurvyList); + + Keyboardio.setup (KEYMAP_SIZE); + Keyboardio.use (&TopsyTurvy, NULL); +} + +void loop () { + Keyboardio.loop (); +} diff --git a/library.properties b/library.properties new file mode 100644 index 00000000..769fb52d --- /dev/null +++ b/library.properties @@ -0,0 +1,10 @@ +name=Akela-TopsyTurvy +version=0.0.0 +author=Gergely Nagy +maintainer=Gergely Nagy +sentence=Turn the effect of Shift upside down for certain keys. +paragraph=Make it possible to send an unshifted symbol with Shift held. +category=Communication +url=https://github.com/Akela-Plugins/Akela-TopsyTurvy +architectures=avr +dot_a_linkage=true diff --git a/src/Akela-TopsyTurvy.h b/src/Akela-TopsyTurvy.h new file mode 100644 index 00000000..53e39235 --- /dev/null +++ b/src/Akela-TopsyTurvy.h @@ -0,0 +1,21 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2017 Gergely Nagy + * + * 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 . + */ + +#pragma once + +#include diff --git a/src/Akela/TopsyTurvy.cpp b/src/Akela/TopsyTurvy.cpp new file mode 100644 index 00000000..31ae9cc4 --- /dev/null +++ b/src/Akela/TopsyTurvy.cpp @@ -0,0 +1,118 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2017 Gergely Nagy + * + * 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 . + */ + +#include + +#define TOPSYTURVY 0b01000000 + +namespace Akela { + + const Key *TopsyTurvy::topsyTurvyList = NULL; + uint8_t TopsyTurvy::topsyTurvyModState; + + TopsyTurvy::TopsyTurvy (void) { + } + + void + TopsyTurvy::begin (void) { + event_handler_hook_add (this->eventHandlerHook); + loop_hook_add (this->loopHook); + } + + void + TopsyTurvy::configure (const Key list[]) { + topsyTurvyList = (const Key *)list; + } + + void + TopsyTurvy::on (void) { + event_handler_hook_replace (this->noOpHook, this->eventHandlerHook); + loop_hook_replace (this->noOpLoopHook, this->loopHook); + } + + void + TopsyTurvy::off (void) { + event_handler_hook_replace (this->eventHandlerHook, this->noOpHook); + loop_hook_replace (this->loopHook, this->noOpLoopHook); + } + + Key + TopsyTurvy::noOpHook (Key mappedKey, byte row, byte col, uint8_t keyState) { + return mappedKey; + } + + void + TopsyTurvy::noOpLoopHook (bool postClear) { + } + + void + TopsyTurvy::loopHook (bool postClear) { + if (postClear) + return; + + bitWrite (topsyTurvyModState, 0, Keyboard.isModifierActive (Key_LShift.keyCode)); + bitWrite (topsyTurvyModState, 1, Keyboard.isModifierActive (Key_RShift.keyCode)); + } + + Key + TopsyTurvy::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { + if (keyState & TOPSYTURVY) + return mappedKey; + + if (!topsyTurvyList) + return mappedKey; + + if (!key_is_pressed (keyState) && !key_was_pressed (keyState)) + return mappedKey; + + uint8_t idx = 0; + Key newKey; + + do { + newKey.raw = pgm_read_word (&(topsyTurvyList[idx].raw)); + idx++; + } while (newKey.raw != mappedKey.raw && newKey.raw != Key_NoKey.raw); + + if (newKey.raw == Key_NoKey.raw) + return mappedKey; + + // invert the shift state + + if (!topsyTurvyModState) { + Keyboard.press (Key_LShift.keyCode); + handle_key_event (mappedKey, row, col, keyState | TOPSYTURVY); + Keyboard.sendReport (); + Keyboard.release (Key_LShift.keyCode); + } else { + Keyboard.release (Key_LShift.keyCode); + Keyboard.release (Key_RShift.keyCode); + handle_key_event (mappedKey, row, col, keyState | TOPSYTURVY); + Keyboard.sendReport (); + + if (bitRead (topsyTurvyModState, 0)) + Keyboard.press (Key_LShift.keyCode); + if (bitRead (topsyTurvyModState, 1)) + Keyboard.press (Key_RShift.keyCode); + } + + return Key_NoKey; + } + +}; + +Akela::TopsyTurvy TopsyTurvy; diff --git a/src/Akela/TopsyTurvy.h b/src/Akela/TopsyTurvy.h new file mode 100644 index 00000000..bc4fabb3 --- /dev/null +++ b/src/Akela/TopsyTurvy.h @@ -0,0 +1,47 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2017 Gergely Nagy + * + * 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 . + */ + +#pragma once + +#include + +namespace Akela { + class TopsyTurvy: public KeyboardioPlugin { + public: + TopsyTurvy (void); + + virtual void begin (void) final; + + static void configure (const Key topsyTurvyList[]); + + void on (void); + void off (void); + + private: + static const Key *topsyTurvyList; + static uint8_t topsyTurvyModState; + + static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); + static Key noOpHook (Key, byte row, byte col, uint8_t keyState); + + static void loopHook (bool postClear); + static void noOpLoopHook (bool postClear); + }; +}; + +extern Akela::TopsyTurvy TopsyTurvy; From 42c7b9d66269e384fe0a530877748ee04bc5c673 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 16 Jan 2017 17:16:50 +0100 Subject: [PATCH 02/52] Add a status icon. Signed-off-by: Gergely Nagy --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index d1c2387c..ad156785 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # Akela-TopsyTurvy +![status][st:experimental] + + [st:stable]: https://img.shields.io/badge/stable-✔-black.png?style=flat&colorA=44cc11&colorB=494e52 + [st:broken]: https://img.shields.io/badge/broken-X-black.png?style=flat&colorA=e05d44&colorB=494e52 + [st:experimental]: https://img.shields.io/badge/experimental----black.png?style=flat&colorA=dfb317&colorB=494e52 + `TopsyTurvy` is a plugin that inverts the behaviour of the `Shift` key for some selected keys. That is, if configured so, it will input `!` when pressing the `1` key without `Shift`, but with the modifier pressed, it will input the From b73d0109deeea18feb4e8cb79f6b3ee6ca30e08b Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 17 Jan 2017 10:15:07 +0100 Subject: [PATCH 03/52] Move from Akela-Plugins to keyboardio Signed-off-by: Gergely Nagy --- README.md | 2 +- library.properties | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ad156785..d8e1ca51 100644 --- a/README.md +++ b/README.md @@ -59,4 +59,4 @@ The plugin provides the `TopsyTurvy` object, with the following methods: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/Akela-Plugins/Akela-TopsyTurvy/blob/master/examples/TopsyTurvy/TopsyTurvy.ino + [plugin:example]: https://github.com/keyboardio/Akela-TopsyTurvy/blob/master/examples/TopsyTurvy/TopsyTurvy.ino diff --git a/library.properties b/library.properties index 769fb52d..0daf8a57 100644 --- a/library.properties +++ b/library.properties @@ -5,6 +5,6 @@ maintainer=Gergely Nagy sentence=Turn the effect of Shift upside down for certain keys. paragraph=Make it possible to send an unshifted symbol with Shift held. category=Communication -url=https://github.com/Akela-Plugins/Akela-TopsyTurvy +url=https://github.com/keyboardio/Akela-TopsyTurvy architectures=avr dot_a_linkage=true From cbec7c1b1af3256194826c3ea7375668f0279edf Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 19 Jan 2017 11:21:13 +0100 Subject: [PATCH 04/52] More reliable modifier tracking Instead of tracking the modifiers in a loop hook, track them in the event handler. We catch all modifiers, even injected ones. This makes things more reliable, because the loop hook can also catch modifiers that TopsyTurvy injected, which is not desirable. Oh, yeah, we do not catch TopsyTurvy-injected modifiers, because we use the Keyboard singleton directly, instead of injecting the keys back into the workflow. This reduces the jitter described in #1, but does not fix it on its own. Signed-off-by: Gergely Nagy --- src/Akela/TopsyTurvy.cpp | 21 +++++---------------- src/Akela/TopsyTurvy.h | 3 --- 2 files changed, 5 insertions(+), 19 deletions(-) diff --git a/src/Akela/TopsyTurvy.cpp b/src/Akela/TopsyTurvy.cpp index 31ae9cc4..5df183f3 100644 --- a/src/Akela/TopsyTurvy.cpp +++ b/src/Akela/TopsyTurvy.cpp @@ -31,7 +31,6 @@ namespace Akela { void TopsyTurvy::begin (void) { event_handler_hook_add (this->eventHandlerHook); - loop_hook_add (this->loopHook); } void @@ -42,13 +41,11 @@ namespace Akela { void TopsyTurvy::on (void) { event_handler_hook_replace (this->noOpHook, this->eventHandlerHook); - loop_hook_replace (this->noOpLoopHook, this->loopHook); } void TopsyTurvy::off (void) { event_handler_hook_replace (this->eventHandlerHook, this->noOpHook); - loop_hook_replace (this->loopHook, this->noOpLoopHook); } Key @@ -56,19 +53,6 @@ namespace Akela { return mappedKey; } - void - TopsyTurvy::noOpLoopHook (bool postClear) { - } - - void - TopsyTurvy::loopHook (bool postClear) { - if (postClear) - return; - - bitWrite (topsyTurvyModState, 0, Keyboard.isModifierActive (Key_LShift.keyCode)); - bitWrite (topsyTurvyModState, 1, Keyboard.isModifierActive (Key_RShift.keyCode)); - } - Key TopsyTurvy::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { if (keyState & TOPSYTURVY) @@ -77,6 +61,11 @@ namespace Akela { if (!topsyTurvyList) return mappedKey; + if (mappedKey.raw == Key_LShift.raw) + bitWrite (topsyTurvyModState, 0, key_is_pressed (keyState)); + if (mappedKey.raw == Key_RShift.raw) + bitWrite (topsyTurvyModState, 1, key_is_pressed (keyState)); + if (!key_is_pressed (keyState) && !key_was_pressed (keyState)) return mappedKey; diff --git a/src/Akela/TopsyTurvy.h b/src/Akela/TopsyTurvy.h index bc4fabb3..d62e828f 100644 --- a/src/Akela/TopsyTurvy.h +++ b/src/Akela/TopsyTurvy.h @@ -38,9 +38,6 @@ namespace Akela { static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); static Key noOpHook (Key, byte row, byte col, uint8_t keyState); - - static void loopHook (bool postClear); - static void noOpLoopHook (bool postClear); }; }; From a41c3dabc07dd7fa8349e8870bf6d6f50f80eec8 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 19 Jan 2017 11:23:34 +0100 Subject: [PATCH 05/52] More reliable Shift pressing & releasing When a shift is not pressed, press it when a TopsyTurvy key is pressed, and keep it down as long as the TopsyTurvy key is held, too. Release it when the key toggles off. This fixes the jitter of #1 in the case where the key is pressed without a modifier. In the other case, when a TopsyTurvy key is pressed while a Shift is active too, send a report after releasing the shifts, to make sure we do not jitter here, either. Fixes #1. Signed-off-by: Gergely Nagy --- src/Akela/TopsyTurvy.cpp | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/Akela/TopsyTurvy.cpp b/src/Akela/TopsyTurvy.cpp index 5df183f3..010c43f0 100644 --- a/src/Akela/TopsyTurvy.cpp +++ b/src/Akela/TopsyTurvy.cpp @@ -83,13 +83,16 @@ namespace Akela { // invert the shift state if (!topsyTurvyModState) { - Keyboard.press (Key_LShift.keyCode); + if (key_is_pressed (keyState)) + Keyboard.press (Key_LShift.keyCode); handle_key_event (mappedKey, row, col, keyState | TOPSYTURVY); Keyboard.sendReport (); - Keyboard.release (Key_LShift.keyCode); + if (key_toggled_off (keyState)) + Keyboard.release (Key_LShift.keyCode); } else { Keyboard.release (Key_LShift.keyCode); Keyboard.release (Key_RShift.keyCode); + Keyboard.sendReport (); handle_key_event (mappedKey, row, col, keyState | TOPSYTURVY); Keyboard.sendReport (); From eb7f1b7599bd9d3db6e8a3196fc305be021847ce Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 19 Jan 2017 11:40:55 +0100 Subject: [PATCH 06/52] Mark the plugin as stable Signed-off-by: Gergely Nagy --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d8e1ca51..9b0f81ff 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Akela-TopsyTurvy -![status][st:experimental] +![status][st:stable] [st:stable]: https://img.shields.io/badge/stable-✔-black.png?style=flat&colorA=44cc11&colorB=494e52 [st:broken]: https://img.shields.io/badge/broken-X-black.png?style=flat&colorA=e05d44&colorB=494e52 From 136af1bac389584cd6c37dad7aafd3132e49663d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 27 Jan 2017 09:41:19 +0100 Subject: [PATCH 07/52] Don't use Key_LEDEffectNext in the example Signed-off-by: Gergely Nagy --- examples/TopsyTurvy/TopsyTurvy.ino | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/examples/TopsyTurvy/TopsyTurvy.ino b/examples/TopsyTurvy/TopsyTurvy.ino index 43575fbd..a4f8f160 100644 --- a/examples/TopsyTurvy/TopsyTurvy.ino +++ b/examples/TopsyTurvy/TopsyTurvy.ino @@ -21,10 +21,10 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED ( - Key_LEDEffectNext, Key_1, Key_2, Key_3, Key_4, Key_5, Key_LEDEffectNext, - Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, - Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDn, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Esc, + Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDn, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Esc, Key_LCtrl, Key_Backspace, Key_LGUI, Key_LShift, Key_skip, From 2ba371c9e693400c4e7a58c84d77ded5a8e46a47 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 27 Jan 2017 23:01:25 +0100 Subject: [PATCH 08/52] Use the new, double-add protected hook functions Signed-off-by: Gergely Nagy --- src/Akela/TopsyTurvy.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Akela/TopsyTurvy.cpp b/src/Akela/TopsyTurvy.cpp index 010c43f0..e37a1ff6 100644 --- a/src/Akela/TopsyTurvy.cpp +++ b/src/Akela/TopsyTurvy.cpp @@ -30,7 +30,7 @@ namespace Akela { void TopsyTurvy::begin (void) { - event_handler_hook_add (this->eventHandlerHook); + event_handler_hook_use (this->eventHandlerHook); } void From 204d450239e43db46bdc1fc32b397430b361ca61 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 12 Feb 2017 00:04:11 +0100 Subject: [PATCH 09/52] The Big Rename Rename the library to Kaleidoscope-TopsyTurvy, and follow up with other renames. Signed-off-by: Gergely Nagy --- README.md | 11 ++++++----- examples/TopsyTurvy/TopsyTurvy.ino | 11 ++++++----- library.properties | 6 +++--- src/{Akela-TopsyTurvy.h => Kaleidoscope-TopsyTurvy.h} | 4 ++-- src/{Akela => Kaleidoscope}/TopsyTurvy.cpp | 8 ++++---- src/{Akela => Kaleidoscope}/TopsyTurvy.h | 10 +++++----- 6 files changed, 26 insertions(+), 24 deletions(-) rename src/{Akela-TopsyTurvy.h => Kaleidoscope-TopsyTurvy.h} (85%) rename src/{Akela => Kaleidoscope}/TopsyTurvy.cpp (93%) rename src/{Akela => Kaleidoscope}/TopsyTurvy.h (82%) diff --git a/README.md b/README.md index 9b0f81ff..63c33a07 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Akela-TopsyTurvy +# Kaleidoscope-TopsyTurvy ![status][st:stable] @@ -17,7 +17,8 @@ To use the plugin, one needs to include the header, create a list, and configure the provided `TopsyTurvy` object to use the dictionary: ```c++ -#include +#include +#include static const Key topsyTurvyList[] PROGMEM = { Key_1, Key_2, Key_3, Key_4, Key_5, @@ -28,8 +29,8 @@ static const Key topsyTurvyList[] PROGMEM = { void setup () { TopsyTurvy.configure (topsyTurvyList); - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&TopsyTurvy, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&TopsyTurvy, NULL); } ``` @@ -59,4 +60,4 @@ The plugin provides the `TopsyTurvy` object, with the following methods: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Akela-TopsyTurvy/blob/master/examples/TopsyTurvy/TopsyTurvy.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-TopsyTurvy/blob/master/examples/TopsyTurvy/TopsyTurvy.ino diff --git a/examples/TopsyTurvy/TopsyTurvy.ino b/examples/TopsyTurvy/TopsyTurvy.ino index a4f8f160..6648eab4 100644 --- a/examples/TopsyTurvy/TopsyTurvy.ino +++ b/examples/TopsyTurvy/TopsyTurvy.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-TopsyTurvy -- Turn the effect of Shift upside down for certain keys * Copyright (C) 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,7 +16,8 @@ * along with this program. If not, see . */ -#include +#include +#include const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED @@ -48,10 +49,10 @@ static const Key topsyTurvyList[] PROGMEM = { void setup () { TopsyTurvy.configure (topsyTurvyList); - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&TopsyTurvy, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&TopsyTurvy, NULL); } void loop () { - Keyboardio.loop (); + Kaleidoscope.loop (); } diff --git a/library.properties b/library.properties index 0daf8a57..719e1ac5 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Akela-TopsyTurvy +name=Kaleidoscope-TopsyTurvy version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy +maintainer=Gergely Nagy sentence=Turn the effect of Shift upside down for certain keys. paragraph=Make it possible to send an unshifted symbol with Shift held. category=Communication -url=https://github.com/keyboardio/Akela-TopsyTurvy +url=https://github.com/keyboardio/Kaleidoscope-TopsyTurvy architectures=avr dot_a_linkage=true diff --git a/src/Akela-TopsyTurvy.h b/src/Kaleidoscope-TopsyTurvy.h similarity index 85% rename from src/Akela-TopsyTurvy.h rename to src/Kaleidoscope-TopsyTurvy.h index 53e39235..2eace1b4 100644 --- a/src/Akela-TopsyTurvy.h +++ b/src/Kaleidoscope-TopsyTurvy.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-TopsyTurvy -- Turn the effect of Shift upside down for certain keys * Copyright (C) 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,4 +18,4 @@ #pragma once -#include +#include diff --git a/src/Akela/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp similarity index 93% rename from src/Akela/TopsyTurvy.cpp rename to src/Kaleidoscope/TopsyTurvy.cpp index e37a1ff6..9ec1094c 100644 --- a/src/Akela/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-TopsyTurvy -- Turn the effect of Shift upside down for certain keys * Copyright (C) 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,11 +16,11 @@ * along with this program. If not, see . */ -#include +#include #define TOPSYTURVY 0b01000000 -namespace Akela { +namespace KaleidoscopePlugins { const Key *TopsyTurvy::topsyTurvyList = NULL; uint8_t TopsyTurvy::topsyTurvyModState; @@ -107,4 +107,4 @@ namespace Akela { }; -Akela::TopsyTurvy TopsyTurvy; +KaleidoscopePlugins::TopsyTurvy TopsyTurvy; diff --git a/src/Akela/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h similarity index 82% rename from src/Akela/TopsyTurvy.h rename to src/Kaleidoscope/TopsyTurvy.h index d62e828f..40a8a02d 100644 --- a/src/Akela/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-TopsyTurvy -- Turn the effect of Shift upside down for certain keys * Copyright (C) 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,10 +18,10 @@ #pragma once -#include +#include -namespace Akela { - class TopsyTurvy: public KeyboardioPlugin { +namespace KaleidoscopePlugins { + class TopsyTurvy: public KaleidoscopePlugin { public: TopsyTurvy (void); @@ -41,4 +41,4 @@ namespace Akela { }; }; -extern Akela::TopsyTurvy TopsyTurvy; +extern KaleidoscopePlugins::TopsyTurvy TopsyTurvy; From b695e4269d0d8430ce46e5c2b4e1ce64a23ac7e3 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Feb 2017 11:28:42 +0100 Subject: [PATCH 10/52] Test the plugin with Travis CI Signed-off-by: Gergely Nagy --- .gitignore | 2 ++ .travis.yml | 18 ++++++++++++++++++ README.md | 5 ++++- 3 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 .travis.yml diff --git a/.gitignore b/.gitignore index aead9485..be16c9be 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,4 @@ .#* *~ +/hardware/ +/output/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..77431b24 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,18 @@ +language: cpp +dist: trusty +sudo: required +os: + - linux +before_install: + - pushd .. + - wget http://downloads.arduino.cc/arduino-1.6.11-linux64.tar.xz + - tar xf arduino-1.6.11-linux64.tar.xz + - popd +install: + - git clone --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr +script: + - export DEFAULT_SKETCH=$(cd examples; basename *) + - export ARDUINO_PATH=$(pwd)/../arduino-1.6.11 + - export BOARD_HARDWARE_PATH=$(pwd)/hardware + - export EXTRA_BUILDER_ARGS="-libraries ." + - hardware/keyboardio/avr/libraries/Kaleidoscope/tools/kaleidoscope-builder build diff --git a/README.md b/README.md index 63c33a07..41a36557 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # Kaleidoscope-TopsyTurvy -![status][st:stable] +![status][st:stable] [![Build Status][travis:image]][travis:status] + + [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-TopsyTurvy.svg?branch=master + [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-TopsyTurvy [st:stable]: https://img.shields.io/badge/stable-✔-black.png?style=flat&colorA=44cc11&colorB=494e52 [st:broken]: https://img.shields.io/badge/broken-X-black.png?style=flat&colorA=e05d44&colorB=494e52 From a91048b8c6800150ad59f959778f8cc0faae9788 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 7 Mar 2017 14:10:12 +0100 Subject: [PATCH 11/52] Drop the on/off functions Having function to turn a plugin on and off is not the right way, remove them. Fixes #3. Signed-off-by: Gergely Nagy --- README.md | 14 ++------------ examples/TopsyTurvy/TopsyTurvy.ino | 4 ++-- src/Kaleidoscope/TopsyTurvy.cpp | 15 --------------- src/Kaleidoscope/TopsyTurvy.h | 4 ---- 4 files changed, 4 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 41a36557..957e3365 100644 --- a/README.md +++ b/README.md @@ -32,8 +32,8 @@ static const Key topsyTurvyList[] PROGMEM = { void setup () { TopsyTurvy.configure (topsyTurvyList); - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&TopsyTurvy, NULL); + Kaleidoscope.setup (); + USE_PLUGINS (&TopsyTurvy); } ``` @@ -48,16 +48,6 @@ The plugin provides the `TopsyTurvy` object, with the following methods: > Tells `TopsyTurvy` to use the specified list of keys. -### `.on()` - -> Turns the shift-inversion functionality on. - -### `.off()` - -> Turns the shift-inversion functionality off. In this case, no transformations -> will be applied, and even if keys pressed appear in the list, they will be -> ignored until the plugin is turned back on. - ## Further reading Starting from the [example][plugin:example] is the recommended way of getting diff --git a/examples/TopsyTurvy/TopsyTurvy.ino b/examples/TopsyTurvy/TopsyTurvy.ino index 6648eab4..872fc711 100644 --- a/examples/TopsyTurvy/TopsyTurvy.ino +++ b/examples/TopsyTurvy/TopsyTurvy.ino @@ -49,8 +49,8 @@ static const Key topsyTurvyList[] PROGMEM = { void setup () { TopsyTurvy.configure (topsyTurvyList); - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&TopsyTurvy, NULL); + Kaleidoscope.setup (); + USE_PLUGINS (&TopsyTurvy); } void loop () { diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index 9ec1094c..9adf5100 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -38,21 +38,6 @@ namespace KaleidoscopePlugins { topsyTurvyList = (const Key *)list; } - void - TopsyTurvy::on (void) { - event_handler_hook_replace (this->noOpHook, this->eventHandlerHook); - } - - void - TopsyTurvy::off (void) { - event_handler_hook_replace (this->eventHandlerHook, this->noOpHook); - } - - Key - TopsyTurvy::noOpHook (Key mappedKey, byte row, byte col, uint8_t keyState) { - return mappedKey; - } - Key TopsyTurvy::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { if (keyState & TOPSYTURVY) diff --git a/src/Kaleidoscope/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h index 40a8a02d..8de71d36 100644 --- a/src/Kaleidoscope/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -29,15 +29,11 @@ namespace KaleidoscopePlugins { static void configure (const Key topsyTurvyList[]); - void on (void); - void off (void); - private: static const Key *topsyTurvyList; static uint8_t topsyTurvyModState; static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); - static Key noOpHook (Key, byte row, byte col, uint8_t keyState); }; }; From d73b27eea7702a5ce75d5366400f3510bc181e35 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 27 Mar 2017 15:40:05 -0700 Subject: [PATCH 12/52] Update to new handle_keyswitch_event API naming --- src/Kaleidoscope/TopsyTurvy.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index 9adf5100..a15788d8 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -70,7 +70,7 @@ namespace KaleidoscopePlugins { if (!topsyTurvyModState) { if (key_is_pressed (keyState)) Keyboard.press (Key_LShift.keyCode); - handle_key_event (mappedKey, row, col, keyState | TOPSYTURVY); + handle_keyswitch_event (mappedKey, row, col, keyState | TOPSYTURVY); Keyboard.sendReport (); if (key_toggled_off (keyState)) Keyboard.release (Key_LShift.keyCode); @@ -78,7 +78,7 @@ namespace KaleidoscopePlugins { Keyboard.release (Key_LShift.keyCode); Keyboard.release (Key_RShift.keyCode); Keyboard.sendReport (); - handle_key_event (mappedKey, row, col, keyState | TOPSYTURVY); + handle_keyswitch_event (mappedKey, row, col, keyState | TOPSYTURVY); Keyboard.sendReport (); if (bitRead (topsyTurvyModState, 0)) From fac7d3fe5ea95119fb4aa128ee4b946169691585 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 22 May 2017 00:53:40 -0700 Subject: [PATCH 13/52] Bring up to new Key API --- examples/TopsyTurvy/TopsyTurvy.ino | 6 +++--- src/Kaleidoscope/TopsyTurvy.cpp | 16 ++++++++-------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/examples/TopsyTurvy/TopsyTurvy.ino b/examples/TopsyTurvy/TopsyTurvy.ino index 872fc711..5f6bdb17 100644 --- a/examples/TopsyTurvy/TopsyTurvy.ino +++ b/examples/TopsyTurvy/TopsyTurvy.ino @@ -25,9 +25,9 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDn, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Esc, + Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - Key_LCtrl, Key_Backspace, Key_LGUI, Key_LShift, + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, Key_skip, Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, @@ -35,7 +35,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - Key_RShift, Key_RAlt, Key_Space, Key_RCtrl, + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, Key_skip ), }; diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index a15788d8..3c85f6b5 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -46,9 +46,9 @@ namespace KaleidoscopePlugins { if (!topsyTurvyList) return mappedKey; - if (mappedKey.raw == Key_LShift.raw) + if (mappedKey.raw == Key_LeftShift.raw) bitWrite (topsyTurvyModState, 0, key_is_pressed (keyState)); - if (mappedKey.raw == Key_RShift.raw) + if (mappedKey.raw == Key_RightShift.raw) bitWrite (topsyTurvyModState, 1, key_is_pressed (keyState)); if (!key_is_pressed (keyState) && !key_was_pressed (keyState)) @@ -69,22 +69,22 @@ namespace KaleidoscopePlugins { if (!topsyTurvyModState) { if (key_is_pressed (keyState)) - Keyboard.press (Key_LShift.keyCode); + Keyboard.press (Key_LeftShift.keyCode); handle_keyswitch_event (mappedKey, row, col, keyState | TOPSYTURVY); Keyboard.sendReport (); if (key_toggled_off (keyState)) - Keyboard.release (Key_LShift.keyCode); + Keyboard.release (Key_LeftShift.keyCode); } else { - Keyboard.release (Key_LShift.keyCode); - Keyboard.release (Key_RShift.keyCode); + Keyboard.release (Key_LeftShift.keyCode); + Keyboard.release (Key_RightShift.keyCode); Keyboard.sendReport (); handle_keyswitch_event (mappedKey, row, col, keyState | TOPSYTURVY); Keyboard.sendReport (); if (bitRead (topsyTurvyModState, 0)) - Keyboard.press (Key_LShift.keyCode); + Keyboard.press (Key_LeftShift.keyCode); if (bitRead (topsyTurvyModState, 1)) - Keyboard.press (Key_RShift.keyCode); + Keyboard.press (Key_RightShift.keyCode); } return Key_NoKey; From 76d5f2387a7a7ee12122eb4a08c8a73b1a767898 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 23 May 2017 20:16:26 -0700 Subject: [PATCH 14/52] New build infrastructure --- .travis.yml | 29 ++++++++++++++++------------- Makefile | 12 ++++++++++++ 2 files changed, 28 insertions(+), 13 deletions(-) create mode 100644 Makefile diff --git a/.travis.yml b/.travis.yml index 77431b24..e7030acf 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,18 +1,21 @@ -language: cpp dist: trusty -sudo: required +sudo: false os: - linux -before_install: - - pushd .. - - wget http://downloads.arduino.cc/arduino-1.6.11-linux64.tar.xz - - tar xf arduino-1.6.11-linux64.tar.xz - - popd install: - - git clone --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr + - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr script: - - export DEFAULT_SKETCH=$(cd examples; basename *) - - export ARDUINO_PATH=$(pwd)/../arduino-1.6.11 - - export BOARD_HARDWARE_PATH=$(pwd)/hardware - - export EXTRA_BUILDER_ARGS="-libraries ." - - hardware/keyboardio/avr/libraries/Kaleidoscope/tools/kaleidoscope-builder build + - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware +notifications: + irc: + channels: + - "chat.freenode.net#keyboardio" + use_notice: true + skip_join: true + template: + - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" + email: + on_success: change + on_failure: change +cache: + ccache: true diff --git a/Makefile b/Makefile new file mode 100644 index 00000000..9ce0c4a9 --- /dev/null +++ b/Makefile @@ -0,0 +1,12 @@ +# This stub makefile for a Kaleidoscope plugin pulls in +# all targets from the Kaleidoscope-Plugin library + +MAKEFILE_PREFIX=keyboardio/avr/libraries/Kaleidoscope-Plugin/build +UNAME_S := $(shell uname -s) + +BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware +ifeq ($(UNAME_S),Darwin) +BOARD_HARDWARE_PATH ?= $(HOME)/Library/Arduino/hardware +endif + +include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/*.mk From e23f014f1c1429a8a8d262d0a4b3370b4839b60d Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Fri, 26 May 2017 16:20:23 -0700 Subject: [PATCH 15/52] make astyle --- examples/TopsyTurvy/TopsyTurvy.ino | 50 ++++++++++---------- src/Kaleidoscope/TopsyTurvy.cpp | 74 +++++++++++++++--------------- src/Kaleidoscope/TopsyTurvy.h | 4 +- 3 files changed, 64 insertions(+), 64 deletions(-) diff --git a/examples/TopsyTurvy/TopsyTurvy.ino b/examples/TopsyTurvy/TopsyTurvy.ino index 5f6bdb17..4b031e62 100644 --- a/examples/TopsyTurvy/TopsyTurvy.ino +++ b/examples/TopsyTurvy/TopsyTurvy.ino @@ -20,39 +20,39 @@ #include const Key keymaps[][ROWS][COLS] PROGMEM = { - [0] = KEYMAP_STACKED - ( - Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, - Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, - Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - - Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, - Key_skip, - - Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, - Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, - Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - - Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - Key_skip - ), + [0] = KEYMAP_STACKED + ( + Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, + + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + Key_skip, + + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + Key_skip + ), }; static const Key topsyTurvyList[] PROGMEM = { - Key_1, Key_2, Key_3, Key_4, Key_5, - Key_6, Key_7, Key_8, Key_9, Key_0, - Key_NoKey + Key_1, Key_2, Key_3, Key_4, Key_5, + Key_6, Key_7, Key_8, Key_9, Key_0, + Key_NoKey }; void setup () { - TopsyTurvy.configure (topsyTurvyList); + TopsyTurvy.configure (topsyTurvyList); - Kaleidoscope.setup (); - USE_PLUGINS (&TopsyTurvy); + Kaleidoscope.setup (); + USE_PLUGINS (&TopsyTurvy); } void loop () { - Kaleidoscope.loop (); + Kaleidoscope.loop (); } diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index 3c85f6b5..88ca5c0c 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -22,73 +22,73 @@ namespace KaleidoscopePlugins { - const Key *TopsyTurvy::topsyTurvyList = NULL; - uint8_t TopsyTurvy::topsyTurvyModState; +const Key *TopsyTurvy::topsyTurvyList = NULL; +uint8_t TopsyTurvy::topsyTurvyModState; - TopsyTurvy::TopsyTurvy (void) { - } +TopsyTurvy::TopsyTurvy (void) { +} - void - TopsyTurvy::begin (void) { +void +TopsyTurvy::begin (void) { event_handler_hook_use (this->eventHandlerHook); - } +} - void - TopsyTurvy::configure (const Key list[]) { +void +TopsyTurvy::configure (const Key list[]) { topsyTurvyList = (const Key *)list; - } +} - Key - TopsyTurvy::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { +Key +TopsyTurvy::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { if (keyState & TOPSYTURVY) - return mappedKey; + return mappedKey; if (!topsyTurvyList) - return mappedKey; + return mappedKey; if (mappedKey.raw == Key_LeftShift.raw) - bitWrite (topsyTurvyModState, 0, key_is_pressed (keyState)); + bitWrite (topsyTurvyModState, 0, key_is_pressed (keyState)); if (mappedKey.raw == Key_RightShift.raw) - bitWrite (topsyTurvyModState, 1, key_is_pressed (keyState)); + bitWrite (topsyTurvyModState, 1, key_is_pressed (keyState)); if (!key_is_pressed (keyState) && !key_was_pressed (keyState)) - return mappedKey; + return mappedKey; uint8_t idx = 0; Key newKey; do { - newKey.raw = pgm_read_word (&(topsyTurvyList[idx].raw)); - idx++; + newKey.raw = pgm_read_word (&(topsyTurvyList[idx].raw)); + idx++; } while (newKey.raw != mappedKey.raw && newKey.raw != Key_NoKey.raw); if (newKey.raw == Key_NoKey.raw) - return mappedKey; + return mappedKey; // invert the shift state if (!topsyTurvyModState) { - if (key_is_pressed (keyState)) - Keyboard.press (Key_LeftShift.keyCode); - handle_keyswitch_event (mappedKey, row, col, keyState | TOPSYTURVY); - Keyboard.sendReport (); - if (key_toggled_off (keyState)) - Keyboard.release (Key_LeftShift.keyCode); + if (key_is_pressed (keyState)) + Keyboard.press (Key_LeftShift.keyCode); + handle_keyswitch_event (mappedKey, row, col, keyState | TOPSYTURVY); + Keyboard.sendReport (); + if (key_toggled_off (keyState)) + Keyboard.release (Key_LeftShift.keyCode); } else { - Keyboard.release (Key_LeftShift.keyCode); - Keyboard.release (Key_RightShift.keyCode); - Keyboard.sendReport (); - handle_keyswitch_event (mappedKey, row, col, keyState | TOPSYTURVY); - Keyboard.sendReport (); - - if (bitRead (topsyTurvyModState, 0)) - Keyboard.press (Key_LeftShift.keyCode); - if (bitRead (topsyTurvyModState, 1)) - Keyboard.press (Key_RightShift.keyCode); + Keyboard.release (Key_LeftShift.keyCode); + Keyboard.release (Key_RightShift.keyCode); + Keyboard.sendReport (); + handle_keyswitch_event (mappedKey, row, col, keyState | TOPSYTURVY); + Keyboard.sendReport (); + + if (bitRead (topsyTurvyModState, 0)) + Keyboard.press (Key_LeftShift.keyCode); + if (bitRead (topsyTurvyModState, 1)) + Keyboard.press (Key_RightShift.keyCode); } return Key_NoKey; - } +} }; diff --git a/src/Kaleidoscope/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h index 8de71d36..1f17a3b1 100644 --- a/src/Kaleidoscope/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -21,7 +21,7 @@ #include namespace KaleidoscopePlugins { - class TopsyTurvy: public KaleidoscopePlugin { +class TopsyTurvy: public KaleidoscopePlugin { public: TopsyTurvy (void); @@ -34,7 +34,7 @@ namespace KaleidoscopePlugins { static uint8_t topsyTurvyModState; static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); - }; +}; }; extern KaleidoscopePlugins::TopsyTurvy TopsyTurvy; From a49b987d5cd13d768d8b9ed75fbfe9bc9250fec1 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Fri, 2 Jun 2017 22:56:03 -0700 Subject: [PATCH 16/52] Make the linter happy --- src/Kaleidoscope/TopsyTurvy.cpp | 2 +- src/Kaleidoscope/TopsyTurvy.h | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index 88ca5c0c..124c7cc5 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -90,6 +90,6 @@ TopsyTurvy::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyStat return Key_NoKey; } -}; +} // namespace KaleidoscopePlugins KaleidoscopePlugins::TopsyTurvy TopsyTurvy; diff --git a/src/Kaleidoscope/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h index 1f17a3b1..c217c86d 100644 --- a/src/Kaleidoscope/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -25,7 +25,7 @@ class TopsyTurvy: public KaleidoscopePlugin { public: TopsyTurvy (void); - virtual void begin (void) final; + void begin (void) final; static void configure (const Key topsyTurvyList[]); @@ -34,7 +34,7 @@ class TopsyTurvy: public KaleidoscopePlugin { static uint8_t topsyTurvyModState; static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); -}; -}; +} +} // namespace KaleidoscopePlugins extern KaleidoscopePlugins::TopsyTurvy TopsyTurvy; From 32adec8aa96178b15f552a67521f5daab053bd6c Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sat, 3 Jun 2017 22:45:16 -0700 Subject: [PATCH 17/52] astyle with current project style guidelines --- examples/TopsyTurvy/TopsyTurvy.ino | 54 +++++++-------- src/Kaleidoscope/TopsyTurvy.cpp | 108 ++++++++++++++--------------- src/Kaleidoscope/TopsyTurvy.h | 16 ++--- 3 files changed, 89 insertions(+), 89 deletions(-) diff --git a/examples/TopsyTurvy/TopsyTurvy.ino b/examples/TopsyTurvy/TopsyTurvy.ino index 4b031e62..5ce9e43d 100644 --- a/examples/TopsyTurvy/TopsyTurvy.ino +++ b/examples/TopsyTurvy/TopsyTurvy.ino @@ -20,39 +20,39 @@ #include const Key keymaps[][ROWS][COLS] PROGMEM = { - [0] = KEYMAP_STACKED - ( - Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, - Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, - Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - - Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, - Key_skip, - - Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, - Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, - Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, - - Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - Key_skip - ), + [0] = KEYMAP_STACKED + ( + Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, + + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + Key_skip, + + Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + Key_skip + ), }; static const Key topsyTurvyList[] PROGMEM = { - Key_1, Key_2, Key_3, Key_4, Key_5, - Key_6, Key_7, Key_8, Key_9, Key_0, - Key_NoKey + Key_1, Key_2, Key_3, Key_4, Key_5, + Key_6, Key_7, Key_8, Key_9, Key_0, + Key_NoKey }; -void setup () { - TopsyTurvy.configure (topsyTurvyList); +void setup() { + TopsyTurvy.configure(topsyTurvyList); - Kaleidoscope.setup (); - USE_PLUGINS (&TopsyTurvy); + Kaleidoscope.setup(); + USE_PLUGINS(&TopsyTurvy); } -void loop () { - Kaleidoscope.loop (); +void loop() { + Kaleidoscope.loop(); } diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index 124c7cc5..cde9f170 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -25,69 +25,69 @@ namespace KaleidoscopePlugins { const Key *TopsyTurvy::topsyTurvyList = NULL; uint8_t TopsyTurvy::topsyTurvyModState; -TopsyTurvy::TopsyTurvy (void) { +TopsyTurvy::TopsyTurvy(void) { } void -TopsyTurvy::begin (void) { - event_handler_hook_use (this->eventHandlerHook); +TopsyTurvy::begin(void) { + event_handler_hook_use(this->eventHandlerHook); } void -TopsyTurvy::configure (const Key list[]) { - topsyTurvyList = (const Key *)list; +TopsyTurvy::configure(const Key list[]) { + topsyTurvyList = (const Key *)list; } Key -TopsyTurvy::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { - if (keyState & TOPSYTURVY) - return mappedKey; - - if (!topsyTurvyList) - return mappedKey; - - if (mappedKey.raw == Key_LeftShift.raw) - bitWrite (topsyTurvyModState, 0, key_is_pressed (keyState)); - if (mappedKey.raw == Key_RightShift.raw) - bitWrite (topsyTurvyModState, 1, key_is_pressed (keyState)); - - if (!key_is_pressed (keyState) && !key_was_pressed (keyState)) - return mappedKey; - - uint8_t idx = 0; - Key newKey; - - do { - newKey.raw = pgm_read_word (&(topsyTurvyList[idx].raw)); - idx++; - } while (newKey.raw != mappedKey.raw && newKey.raw != Key_NoKey.raw); - - if (newKey.raw == Key_NoKey.raw) - return mappedKey; - - // invert the shift state - - if (!topsyTurvyModState) { - if (key_is_pressed (keyState)) - Keyboard.press (Key_LeftShift.keyCode); - handle_keyswitch_event (mappedKey, row, col, keyState | TOPSYTURVY); - Keyboard.sendReport (); - if (key_toggled_off (keyState)) - Keyboard.release (Key_LeftShift.keyCode); - } else { - Keyboard.release (Key_LeftShift.keyCode); - Keyboard.release (Key_RightShift.keyCode); - Keyboard.sendReport (); - handle_keyswitch_event (mappedKey, row, col, keyState | TOPSYTURVY); - Keyboard.sendReport (); - - if (bitRead (topsyTurvyModState, 0)) - Keyboard.press (Key_LeftShift.keyCode); - if (bitRead (topsyTurvyModState, 1)) - Keyboard.press (Key_RightShift.keyCode); - } - - return Key_NoKey; +TopsyTurvy::eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState) { + if (keyState & TOPSYTURVY) + return mappedKey; + + if (!topsyTurvyList) + return mappedKey; + + if (mappedKey.raw == Key_LeftShift.raw) + bitWrite(topsyTurvyModState, 0, key_is_pressed(keyState)); + if (mappedKey.raw == Key_RightShift.raw) + bitWrite(topsyTurvyModState, 1, key_is_pressed(keyState)); + + if (!key_is_pressed(keyState) && !key_was_pressed(keyState)) + return mappedKey; + + uint8_t idx = 0; + Key newKey; + + do { + newKey.raw = pgm_read_word(&(topsyTurvyList[idx].raw)); + idx++; + } while (newKey.raw != mappedKey.raw && newKey.raw != Key_NoKey.raw); + + if (newKey.raw == Key_NoKey.raw) + return mappedKey; + + // invert the shift state + + if (!topsyTurvyModState) { + if (key_is_pressed(keyState)) + Keyboard.press(Key_LeftShift.keyCode); + handle_keyswitch_event(mappedKey, row, col, keyState | TOPSYTURVY); + Keyboard.sendReport(); + if (key_toggled_off(keyState)) + Keyboard.release(Key_LeftShift.keyCode); + } else { + Keyboard.release(Key_LeftShift.keyCode); + Keyboard.release(Key_RightShift.keyCode); + Keyboard.sendReport(); + handle_keyswitch_event(mappedKey, row, col, keyState | TOPSYTURVY); + Keyboard.sendReport(); + + if (bitRead(topsyTurvyModState, 0)) + Keyboard.press(Key_LeftShift.keyCode); + if (bitRead(topsyTurvyModState, 1)) + Keyboard.press(Key_RightShift.keyCode); + } + + return Key_NoKey; } } // namespace KaleidoscopePlugins diff --git a/src/Kaleidoscope/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h index c217c86d..25493780 100644 --- a/src/Kaleidoscope/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -22,18 +22,18 @@ namespace KaleidoscopePlugins { class TopsyTurvy: public KaleidoscopePlugin { - public: - TopsyTurvy (void); + public: + TopsyTurvy(void); - void begin (void) final; + void begin(void) final; - static void configure (const Key topsyTurvyList[]); + static void configure(const Key topsyTurvyList[]); - private: - static const Key *topsyTurvyList; - static uint8_t topsyTurvyModState; + private: + static const Key *topsyTurvyList; + static uint8_t topsyTurvyModState; - static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); + static Key eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState); } } // namespace KaleidoscopePlugins From 468996e6c8b447344a267b8127ce5eac423ca6c9 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sat, 3 Jun 2017 23:08:58 -0700 Subject: [PATCH 18/52] fix missing ; at end of class --- src/Kaleidoscope/TopsyTurvy.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h index 25493780..54346c85 100644 --- a/src/Kaleidoscope/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -34,7 +34,7 @@ class TopsyTurvy: public KaleidoscopePlugin { static uint8_t topsyTurvyModState; static Key eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState); -} +}; } // namespace KaleidoscopePlugins extern KaleidoscopePlugins::TopsyTurvy TopsyTurvy; From c91db9c56515e76f959aeed44b7d497389ce7e27 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sun, 4 Jun 2017 00:18:14 -0700 Subject: [PATCH 19/52] Fixes to make cpplint happy --- examples/TopsyTurvy/TopsyTurvy.ino | 3 +-- src/Kaleidoscope/TopsyTurvy.cpp | 2 +- src/Kaleidoscope/TopsyTurvy.h | 2 +- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/examples/TopsyTurvy/TopsyTurvy.ino b/examples/TopsyTurvy/TopsyTurvy.ino index 5ce9e43d..24b378b6 100644 --- a/examples/TopsyTurvy/TopsyTurvy.ino +++ b/examples/TopsyTurvy/TopsyTurvy.ino @@ -36,8 +36,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, - Key_skip - ), + Key_skip), }; static const Key topsyTurvyList[] PROGMEM = { diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index cde9f170..bd7f7dd0 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -90,6 +90,6 @@ TopsyTurvy::eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState return Key_NoKey; } -} // namespace KaleidoscopePlugins +} // namespace KaleidoscopePlugins KaleidoscopePlugins::TopsyTurvy TopsyTurvy; diff --git a/src/Kaleidoscope/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h index 54346c85..46baca0c 100644 --- a/src/Kaleidoscope/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -35,6 +35,6 @@ class TopsyTurvy: public KaleidoscopePlugin { static Key eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState); }; -} // namespace KaleidoscopePlugins +} // namespace KaleidoscopePlugins extern KaleidoscopePlugins::TopsyTurvy TopsyTurvy; From e5a8a77a4aee3b5654dd0d135eced36e61016800 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 5 Jun 2017 12:26:38 +0200 Subject: [PATCH 20/52] Kaleidoscope Style Guide conformance Signed-off-by: Gergely Nagy --- README.md | 22 ++++++----- examples/TopsyTurvy/TopsyTurvy.ino | 7 ++-- src/Kaleidoscope/TopsyTurvy.cpp | 63 +++++++++++++----------------- src/Kaleidoscope/TopsyTurvy.h | 16 ++++---- 4 files changed, 52 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index 957e3365..f95bdcad 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-TopsyTurvy.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-TopsyTurvy - [st:stable]: https://img.shields.io/badge/stable-✔-black.png?style=flat&colorA=44cc11&colorB=494e52 - [st:broken]: https://img.shields.io/badge/broken-X-black.png?style=flat&colorA=e05d44&colorB=494e52 - [st:experimental]: https://img.shields.io/badge/experimental----black.png?style=flat&colorA=dfb317&colorB=494e52 + [st:stable]: https://img.shields.io/badge/stable-✔-black.svg?style=flat&colorA=44cc11&colorB=494e52 + [st:broken]: https://img.shields.io/badge/broken-X-black.svg?style=flat&colorA=e05d44&colorB=494e52 + [st:experimental]: https://img.shields.io/badge/experimental----black.svg?style=flat&colorA=dfb317&colorB=494e52 `TopsyTurvy` is a plugin that inverts the behaviour of the `Shift` key for some selected keys. That is, if configured so, it will input `!` when pressing the @@ -23,17 +23,18 @@ the provided `TopsyTurvy` object to use the dictionary: #include #include -static const Key topsyTurvyList[] PROGMEM = { +static const Key topsy_turvy_list[] PROGMEM = { Key_1, Key_2, Key_3, Key_4, Key_5, Key_6, Key_7, Key_8, Key_9, Key_0, Key_NoKey }; void setup () { - TopsyTurvy.configure (topsyTurvyList); - - Kaleidoscope.setup (); USE_PLUGINS (&TopsyTurvy); + + Kaleidoscope.setup (); + + TopsyTurvy.key_list = topsy_turvy_list; } ``` @@ -42,11 +43,12 @@ in `PROGMEM`. ## Plugin methods -The plugin provides the `TopsyTurvy` object, with the following methods: +The plugin provides the `TopsyTurvy` object, with the following property: -### `.configure(list)` +### `.key_list` -> Tells `TopsyTurvy` to use the specified list of keys. +> Set this property to the list of `Key`s `TopsyTurvy` should invert the `Shift` +> behaviour for. ## Further reading diff --git a/examples/TopsyTurvy/TopsyTurvy.ino b/examples/TopsyTurvy/TopsyTurvy.ino index 24b378b6..4828d57e 100644 --- a/examples/TopsyTurvy/TopsyTurvy.ino +++ b/examples/TopsyTurvy/TopsyTurvy.ino @@ -39,17 +39,18 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_skip), }; -static const Key topsyTurvyList[] PROGMEM = { +static const Key topsy_turvy_list[] PROGMEM = { Key_1, Key_2, Key_3, Key_4, Key_5, Key_6, Key_7, Key_8, Key_9, Key_0, Key_NoKey }; void setup() { - TopsyTurvy.configure(topsyTurvyList); + USE_PLUGINS(&TopsyTurvy); Kaleidoscope.setup(); - USE_PLUGINS(&TopsyTurvy); + + TopsyTurvy.key_list = topsy_turvy_list; } void loop() { diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index bd7f7dd0..54ddfdab 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -20,76 +20,69 @@ #define TOPSYTURVY 0b01000000 -namespace KaleidoscopePlugins { +namespace kaleidoscope { -const Key *TopsyTurvy::topsyTurvyList = NULL; -uint8_t TopsyTurvy::topsyTurvyModState; +const Key *TopsyTurvy::key_list = NULL; +uint8_t TopsyTurvy::mod_state_; TopsyTurvy::TopsyTurvy(void) { } -void -TopsyTurvy::begin(void) { - event_handler_hook_use(this->eventHandlerHook); +void TopsyTurvy::begin(void) { + event_handler_hook_use(eventHandlerHook); } -void -TopsyTurvy::configure(const Key list[]) { - topsyTurvyList = (const Key *)list; -} - -Key -TopsyTurvy::eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState) { - if (keyState & TOPSYTURVY) - return mappedKey; +Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state) { + if (key_state & TOPSYTURVY) + return mapped_key; - if (!topsyTurvyList) - return mappedKey; + if (!key_list) + return mapped_key; - if (mappedKey.raw == Key_LeftShift.raw) - bitWrite(topsyTurvyModState, 0, key_is_pressed(keyState)); - if (mappedKey.raw == Key_RightShift.raw) - bitWrite(topsyTurvyModState, 1, key_is_pressed(keyState)); + if (mapped_key.raw == Key_LeftShift.raw) + bitWrite(mod_state_, 0, key_is_pressed(key_state)); + if (mapped_key.raw == Key_RightShift.raw) + bitWrite(mod_state_, 1, key_is_pressed(key_state)); - if (!key_is_pressed(keyState) && !key_was_pressed(keyState)) - return mappedKey; + if (!key_is_pressed(key_state) && !key_was_pressed(key_state)) + return mapped_key; uint8_t idx = 0; Key newKey; do { - newKey.raw = pgm_read_word(&(topsyTurvyList[idx].raw)); + newKey.raw = pgm_read_word(&(key_list[idx].raw)); idx++; - } while (newKey.raw != mappedKey.raw && newKey.raw != Key_NoKey.raw); + } while (newKey.raw != mapped_key.raw && newKey.raw != Key_NoKey.raw); if (newKey.raw == Key_NoKey.raw) - return mappedKey; + return mapped_key; // invert the shift state - if (!topsyTurvyModState) { - if (key_is_pressed(keyState)) + if (!mod_state_) { + if (key_is_pressed(key_state)) Keyboard.press(Key_LeftShift.keyCode); - handle_keyswitch_event(mappedKey, row, col, keyState | TOPSYTURVY); + handle_keyswitch_event(mapped_key, row, col, key_state | TOPSYTURVY); Keyboard.sendReport(); - if (key_toggled_off(keyState)) + if (key_toggled_off(key_state)) Keyboard.release(Key_LeftShift.keyCode); } else { Keyboard.release(Key_LeftShift.keyCode); Keyboard.release(Key_RightShift.keyCode); Keyboard.sendReport(); - handle_keyswitch_event(mappedKey, row, col, keyState | TOPSYTURVY); + handle_keyswitch_event(mapped_key, row, col, key_state | TOPSYTURVY); Keyboard.sendReport(); - if (bitRead(topsyTurvyModState, 0)) + if (bitRead(mod_state_, 0)) Keyboard.press(Key_LeftShift.keyCode); - if (bitRead(topsyTurvyModState, 1)) + if (bitRead(mod_state_, 1)) Keyboard.press(Key_RightShift.keyCode); } return Key_NoKey; } -} // namespace KaleidoscopePlugins +} -KaleidoscopePlugins::TopsyTurvy TopsyTurvy; +kaleidoscope::TopsyTurvy TopsyTurvy; diff --git a/src/Kaleidoscope/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h index 46baca0c..92db2288 100644 --- a/src/Kaleidoscope/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -20,21 +20,21 @@ #include -namespace KaleidoscopePlugins { +namespace kaleidoscope { + class TopsyTurvy: public KaleidoscopePlugin { public: TopsyTurvy(void); void begin(void) final; - static void configure(const Key topsyTurvyList[]); - + static const Key *key_list; private: - static const Key *topsyTurvyList; - static uint8_t topsyTurvyModState; + static uint8_t mod_state_; - static Key eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState); + static Key eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state); }; -} // namespace KaleidoscopePlugins -extern KaleidoscopePlugins::TopsyTurvy TopsyTurvy; +} + +extern kaleidoscope::TopsyTurvy TopsyTurvy; From a3f7ab082d7e22864b549a6f691faf35721589d0 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 8 Jun 2017 14:49:31 +0200 Subject: [PATCH 21/52] Instead of using a list, augment the keymap directly. This is a little bit user-friendlier, more efficient (both space- and performance-wise). Fixes #2. Signed-off-by: Gergely Nagy --- README.md | 34 ++++++++++++++++-------------- examples/TopsyTurvy/TopsyTurvy.ino | 24 +++++++-------------- src/Kaleidoscope/TopsyTurvy.cpp | 20 ++++++------------ src/Kaleidoscope/TopsyTurvy.h | 5 +++-- 4 files changed, 35 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index f95bdcad..f6bcb9aa 100644 --- a/README.md +++ b/README.md @@ -16,39 +16,41 @@ original `1` symbol. ## Using the plugin -To use the plugin, one needs to include the header, create a list, and configure -the provided `TopsyTurvy` object to use the dictionary: +To use the plugin, one needs to include the header, mark keys to apply plugin +effects to, and use the plugin: ```c++ #include #include -static const Key topsy_turvy_list[] PROGMEM = { - Key_1, Key_2, Key_3, Key_4, Key_5, - Key_6, Key_7, Key_8, Key_9, Key_0, - Key_NoKey -}; +// In the keymap: +TOPSY(1), TOPSY(2), TOPSY(3) void setup () { USE_PLUGINS (&TopsyTurvy); Kaleidoscope.setup (); - - TopsyTurvy.key_list = topsy_turvy_list; } ``` -The list of keys **must** be terminated with a `Key_NoKey`, and **must** reside -in `PROGMEM`. +## Keymap markup -## Plugin methods +There is only one macro that the plugin provides, which one can use in keymap definitions: + +### `TOPSY(key)` -The plugin provides the `TopsyTurvy` object, with the following property: +> Mark the specified `key` (without the `Key_` prefix!) for TopsyTurvy, and swap +> the effect of `Shift` when the key is used. One can have any number of +> topsy-turvy keys on a keymap. +> +> The keys must be plain old keys, modifiers or anything other augmentation +> cannot be applied. -### `.key_list` +The plugin provides a number of macros one can use in keymap definitions: + +## Plugin methods -> Set this property to the list of `Key`s `TopsyTurvy` should invert the `Shift` -> behaviour for. +The plugin provides the `TopsyTurvy` object, without any public methods or properties. ## Further reading diff --git a/examples/TopsyTurvy/TopsyTurvy.ino b/examples/TopsyTurvy/TopsyTurvy.ino index 4828d57e..6e2c5d09 100644 --- a/examples/TopsyTurvy/TopsyTurvy.ino +++ b/examples/TopsyTurvy/TopsyTurvy.ino @@ -22,35 +22,27 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED ( - Key_NoKey, Key_1, Key_2, Key_3, Key_4, Key_5, Key_NoKey, - Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, - Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, - Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, + Key_NoKey, TOPSY(1), TOPSY(2), TOPSY(3), TOPSY(4), TOPSY(5), Key_NoKey, + Key_Backtick, Key_Q, Key_W, Key_E, Key_R, Key_T, Key_Tab, + Key_PageUp, Key_A, Key_S, Key_D, Key_F, Key_G, + Key_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, Key_skip, - Key_skip, Key_6, Key_7, Key_8, Key_9, Key_0, Key_skip, - Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, - Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, - Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, + Key_skip, TOPSY(6), TOPSY(7), TOPSY(8), TOPSY(9), TOPSY(0), Key_skip, + Key_Enter, Key_Y, Key_U, Key_I, Key_O, Key_P, Key_Equals, + Key_H, Key_J, Key_K, Key_L, Key_Semicolon, Key_Quote, + Key_skip, Key_N, Key_M, Key_Comma, Key_Period, Key_Slash, Key_Minus, Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, Key_skip), }; -static const Key topsy_turvy_list[] PROGMEM = { - Key_1, Key_2, Key_3, Key_4, Key_5, - Key_6, Key_7, Key_8, Key_9, Key_0, - Key_NoKey -}; - void setup() { USE_PLUGINS(&TopsyTurvy); Kaleidoscope.setup(); - - TopsyTurvy.key_list = topsy_turvy_list; } void loop() { diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index 54ddfdab..73295939 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -22,7 +22,6 @@ namespace kaleidoscope { -const Key *TopsyTurvy::key_list = NULL; uint8_t TopsyTurvy::mod_state_; TopsyTurvy::TopsyTurvy(void) { @@ -36,9 +35,6 @@ Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key if (key_state & TOPSYTURVY) return mapped_key; - if (!key_list) - return mapped_key; - if (mapped_key.raw == Key_LeftShift.raw) bitWrite(mod_state_, 0, key_is_pressed(key_state)); if (mapped_key.raw == Key_RightShift.raw) @@ -47,15 +43,11 @@ Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key if (!key_is_pressed(key_state) && !key_was_pressed(key_state)) return mapped_key; - uint8_t idx = 0; - Key newKey; - - do { - newKey.raw = pgm_read_word(&(key_list[idx].raw)); - idx++; - } while (newKey.raw != mapped_key.raw && newKey.raw != Key_NoKey.raw); + if (mapped_key < ranges::TT_FIRST || mapped_key > ranges::TT_LAST) + return mapped_key; - if (newKey.raw == Key_NoKey.raw) + Key new_key = {.raw = mapped_key.raw - ranges::TT_FIRST}; + if (new_key.raw == Key_NoKey.raw) return mapped_key; // invert the shift state @@ -63,7 +55,7 @@ Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key if (!mod_state_) { if (key_is_pressed(key_state)) Keyboard.press(Key_LeftShift.keyCode); - handle_keyswitch_event(mapped_key, row, col, key_state | TOPSYTURVY); + handle_keyswitch_event(new_key, row, col, key_state | TOPSYTURVY | INJECTED); Keyboard.sendReport(); if (key_toggled_off(key_state)) Keyboard.release(Key_LeftShift.keyCode); @@ -71,7 +63,7 @@ Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key Keyboard.release(Key_LeftShift.keyCode); Keyboard.release(Key_RightShift.keyCode); Keyboard.sendReport(); - handle_keyswitch_event(mapped_key, row, col, key_state | TOPSYTURVY); + handle_keyswitch_event(new_key, row, col, key_state | TOPSYTURVY | INJECTED); Keyboard.sendReport(); if (bitRead(mod_state_, 0)) diff --git a/src/Kaleidoscope/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h index 92db2288..be085c44 100644 --- a/src/Kaleidoscope/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -19,6 +19,9 @@ #pragma once #include +#include + +#define TOPSY(k) (Key) { .raw = kaleidoscope::ranges::TT_FIRST + (Key_ ## k).keyCode } namespace kaleidoscope { @@ -27,8 +30,6 @@ class TopsyTurvy: public KaleidoscopePlugin { TopsyTurvy(void); void begin(void) final; - - static const Key *key_list; private: static uint8_t mod_state_; From 684db7bd02ff25480bca031d17f06b0513cb31dc Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 8 Jun 2017 15:08:16 +0200 Subject: [PATCH 22/52] Handle one TopsyTurvy key / cycle To avoid duplicating keys, handle only one TopsyTurvy key / cycle. We handle the one with the highest index for the time being. Fixes #4. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TopsyTurvy.cpp | 11 +++++++++++ src/Kaleidoscope/TopsyTurvy.h | 2 ++ 2 files changed, 13 insertions(+) diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index 73295939..4d0ce21f 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -23,12 +23,14 @@ namespace kaleidoscope { uint8_t TopsyTurvy::mod_state_; +bool TopsyTurvy::is_active_; TopsyTurvy::TopsyTurvy(void) { } void TopsyTurvy::begin(void) { event_handler_hook_use(eventHandlerHook); + loop_hook_use(loopHook); } Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state) { @@ -46,6 +48,11 @@ Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key if (mapped_key < ranges::TT_FIRST || mapped_key > ranges::TT_LAST) return mapped_key; + if (is_active_) + return Key_NoKey; + + is_active_ = true; + Key new_key = {.raw = mapped_key.raw - ranges::TT_FIRST}; if (new_key.raw == Key_NoKey.raw) return mapped_key; @@ -75,6 +82,10 @@ Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key return Key_NoKey; } +void TopsyTurvy::loopHook(bool is_post_clear) { + is_active_ = false; +} + } kaleidoscope::TopsyTurvy TopsyTurvy; diff --git a/src/Kaleidoscope/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h index be085c44..d3441399 100644 --- a/src/Kaleidoscope/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -32,8 +32,10 @@ class TopsyTurvy: public KaleidoscopePlugin { void begin(void) final; private: static uint8_t mod_state_; + static bool is_active_; static Key eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state); + static void loopHook(bool is_post_clear); }; } From d010846280c093d0e95bec2229c9b82512ff60ce Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 8 Jun 2017 15:16:44 +0200 Subject: [PATCH 23/52] Instead of repeating the highest index, repeat the last one To mimic the normal repeat, track the last topsy key that was pressed, and if there are multiple ones active, ignore anything but the youngest. This makes it possible to hold multiple topsy keys, and have the last one repeat. It does not handle the topsy+normal chording case, though. But this fixes #4 in a better way. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TopsyTurvy.cpp | 17 +++++++---------- src/Kaleidoscope/TopsyTurvy.h | 3 +-- 2 files changed, 8 insertions(+), 12 deletions(-) diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index 4d0ce21f..1310df56 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -23,14 +23,13 @@ namespace kaleidoscope { uint8_t TopsyTurvy::mod_state_; -bool TopsyTurvy::is_active_; +uint8_t TopsyTurvy::last_pressed_position_; TopsyTurvy::TopsyTurvy(void) { } void TopsyTurvy::begin(void) { event_handler_hook_use(eventHandlerHook); - loop_hook_use(loopHook); } Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state) { @@ -48,10 +47,12 @@ Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key if (mapped_key < ranges::TT_FIRST || mapped_key > ranges::TT_LAST) return mapped_key; - if (is_active_) - return Key_NoKey; - - is_active_ = true; + if (key_toggled_on(key_state)) + last_pressed_position_ = row * COLS + col; + else { + if (last_pressed_position_ != row * COLS + col) + return Key_NoKey; + } Key new_key = {.raw = mapped_key.raw - ranges::TT_FIRST}; if (new_key.raw == Key_NoKey.raw) @@ -82,10 +83,6 @@ Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key return Key_NoKey; } -void TopsyTurvy::loopHook(bool is_post_clear) { - is_active_ = false; -} - } kaleidoscope::TopsyTurvy TopsyTurvy; diff --git a/src/Kaleidoscope/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h index d3441399..f97f665c 100644 --- a/src/Kaleidoscope/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -32,10 +32,9 @@ class TopsyTurvy: public KaleidoscopePlugin { void begin(void) final; private: static uint8_t mod_state_; - static bool is_active_; + static uint8_t last_pressed_position_; static Key eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state); - static void loopHook(bool is_post_clear); }; } From d309ff3285845579b4343bfe302e5f89507530ab Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Fri, 9 Jun 2017 12:16:28 -0700 Subject: [PATCH 24/52] cpplint --- src/Kaleidoscope/TopsyTurvy.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index 1310df56..8558553e 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -47,9 +47,9 @@ Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key if (mapped_key < ranges::TT_FIRST || mapped_key > ranges::TT_LAST) return mapped_key; - if (key_toggled_on(key_state)) + if (key_toggled_on(key_state)) { last_pressed_position_ = row * COLS + col; - else { + } else { if (last_pressed_position_ != row * COLS + col) return Key_NoKey; } From 28b3bb2f9b7c1d6c9d906296fa8c6dbf1109968b Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 24 Jul 2017 13:56:50 -0700 Subject: [PATCH 25/52] keyToggledO* camelcasing --- src/Kaleidoscope/TopsyTurvy.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index 8558553e..d4f4e692 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -47,7 +47,7 @@ Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key if (mapped_key < ranges::TT_FIRST || mapped_key > ranges::TT_LAST) return mapped_key; - if (key_toggled_on(key_state)) { + if (keyToggledOn(key_state)) { last_pressed_position_ = row * COLS + col; } else { if (last_pressed_position_ != row * COLS + col) @@ -65,7 +65,7 @@ Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key Keyboard.press(Key_LeftShift.keyCode); handle_keyswitch_event(new_key, row, col, key_state | TOPSYTURVY | INJECTED); Keyboard.sendReport(); - if (key_toggled_off(key_state)) + if (keyToggledOff(key_state)) Keyboard.release(Key_LeftShift.keyCode); } else { Keyboard.release(Key_LeftShift.keyCode); From 68b0112939a86f55fd6912a494771860ec5694f0 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 24 Jul 2017 14:12:54 -0700 Subject: [PATCH 26/52] CamelCase of KeyIsPressed and KeyWasPressed --- src/Kaleidoscope/TopsyTurvy.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index d4f4e692..35df66e3 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -37,11 +37,11 @@ Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key return mapped_key; if (mapped_key.raw == Key_LeftShift.raw) - bitWrite(mod_state_, 0, key_is_pressed(key_state)); + bitWrite(mod_state_, 0, keyIsPressed(key_state)); if (mapped_key.raw == Key_RightShift.raw) - bitWrite(mod_state_, 1, key_is_pressed(key_state)); + bitWrite(mod_state_, 1, keyIsPressed(key_state)); - if (!key_is_pressed(key_state) && !key_was_pressed(key_state)) + if (!keyIsPressed(key_state) && !keyWasPressed(key_state)) return mapped_key; if (mapped_key < ranges::TT_FIRST || mapped_key > ranges::TT_LAST) @@ -61,7 +61,7 @@ Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key // invert the shift state if (!mod_state_) { - if (key_is_pressed(key_state)) + if (keyIsPressed(key_state)) Keyboard.press(Key_LeftShift.keyCode); handle_keyswitch_event(new_key, row, col, key_state | TOPSYTURVY | INJECTED); Keyboard.sendReport(); From bb72deed2301677521f50128dd75541ca555898c Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 24 Jul 2017 14:42:36 -0700 Subject: [PATCH 27/52] CamelCase of handle_*_key* --- src/Kaleidoscope/TopsyTurvy.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index 35df66e3..e473696c 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -63,7 +63,7 @@ Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key if (!mod_state_) { if (keyIsPressed(key_state)) Keyboard.press(Key_LeftShift.keyCode); - handle_keyswitch_event(new_key, row, col, key_state | TOPSYTURVY | INJECTED); + handleKeyswitchEvent(new_key, row, col, key_state | TOPSYTURVY | INJECTED); Keyboard.sendReport(); if (keyToggledOff(key_state)) Keyboard.release(Key_LeftShift.keyCode); @@ -71,7 +71,7 @@ Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key Keyboard.release(Key_LeftShift.keyCode); Keyboard.release(Key_RightShift.keyCode); Keyboard.sendReport(); - handle_keyswitch_event(new_key, row, col, key_state | TOPSYTURVY | INJECTED); + handleKeyswitchEvent(new_key, row, col, key_state | TOPSYTURVY | INJECTED); Keyboard.sendReport(); if (bitRead(mod_state_, 0)) From 93e83ed75a83eeba261cf06f8ff5aac2c155df40 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 25 Jul 2017 13:20:54 -0700 Subject: [PATCH 28/52] Port to new hid facade --- src/Kaleidoscope/TopsyTurvy.cpp | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index e473696c..475e9960 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -17,6 +17,7 @@ */ #include +#include "kaleidoscope/hid.h" #define TOPSYTURVY 0b01000000 @@ -62,22 +63,22 @@ Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key if (!mod_state_) { if (keyIsPressed(key_state)) - Keyboard.press(Key_LeftShift.keyCode); + hid::pressRawKey(Key_LeftShift); handleKeyswitchEvent(new_key, row, col, key_state | TOPSYTURVY | INJECTED); - Keyboard.sendReport(); + hid::sendKeyboardReport(); if (keyToggledOff(key_state)) - Keyboard.release(Key_LeftShift.keyCode); + hid::releaseRawKey(Key_LeftShift); } else { - Keyboard.release(Key_LeftShift.keyCode); - Keyboard.release(Key_RightShift.keyCode); - Keyboard.sendReport(); + hid::releaseRawKey(Key_LeftShift); + hid::releaseRawKey(Key_RightShift); + hid::sendKeyboardReport(); handleKeyswitchEvent(new_key, row, col, key_state | TOPSYTURVY | INJECTED); - Keyboard.sendReport(); + hid::sendKeyboardReport(); if (bitRead(mod_state_, 0)) - Keyboard.press(Key_LeftShift.keyCode); + hid::pressRawKey(Key_LeftShift); if (bitRead(mod_state_, 1)) - Keyboard.press(Key_RightShift.keyCode); + hid::pressRawKey(Key_RightShift); } return Key_NoKey; From 94ab7c4534383c880b8ce9ae0d70dea3d228e3e4 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 25 Jul 2017 15:52:20 -0700 Subject: [PATCH 29/52] Update Makefile to fix OS X build --- Makefile | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index 9ce0c4a9..2b04143a 100644 --- a/Makefile +++ b/Makefile @@ -4,9 +4,10 @@ MAKEFILE_PREFIX=keyboardio/avr/libraries/Kaleidoscope-Plugin/build UNAME_S := $(shell uname -s) -BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware ifeq ($(UNAME_S),Darwin) -BOARD_HARDWARE_PATH ?= $(HOME)/Library/Arduino/hardware +BOARD_HARDWARE_PATH ?= $(HOME)/Documents/Arduino/hardware +else +BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware endif -include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/*.mk +include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/rules.mk From 9082741e97aa9b829a5f9091b94c9a4cf2b279eb Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 17 Aug 2017 12:42:27 +0200 Subject: [PATCH 30/52] Stop using deprecated interfaces Use `Kaleidoscope.use` and `Kaleidoscope.useEventHandlerHook` instead of the deprecated `USE_PLUGINS` and `event_handler_hook_use` interfaces. Signed-off-by: Gergely Nagy --- README.md | 2 +- examples/TopsyTurvy/TopsyTurvy.ino | 2 +- src/Kaleidoscope/TopsyTurvy.cpp | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f6bcb9aa..dedaa01a 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ effects to, and use the plugin: TOPSY(1), TOPSY(2), TOPSY(3) void setup () { - USE_PLUGINS (&TopsyTurvy); + Kaleidoscope.use (&TopsyTurvy); Kaleidoscope.setup (); } diff --git a/examples/TopsyTurvy/TopsyTurvy.ino b/examples/TopsyTurvy/TopsyTurvy.ino index 6e2c5d09..ca2dfddf 100644 --- a/examples/TopsyTurvy/TopsyTurvy.ino +++ b/examples/TopsyTurvy/TopsyTurvy.ino @@ -40,7 +40,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { }; void setup() { - USE_PLUGINS(&TopsyTurvy); + Kaleidoscope.use(&TopsyTurvy); Kaleidoscope.setup(); } diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index 475e9960..fb1db387 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -30,7 +30,7 @@ TopsyTurvy::TopsyTurvy(void) { } void TopsyTurvy::begin(void) { - event_handler_hook_use(eventHandlerHook); + Kaleidoscope.useEventHandlerHook(eventHandlerHook); } Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state) { From 649289319a03cf43b153536688f89374fd17d141 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 21 Aug 2017 22:25:35 -0700 Subject: [PATCH 31/52] Update Makefile with OSX fixes and new paths --- Makefile | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index 2b04143a..8f830f44 100644 --- a/Makefile +++ b/Makefile @@ -1,13 +1,14 @@ # This stub makefile for a Kaleidoscope plugin pulls in # all targets from the Kaleidoscope-Plugin library -MAKEFILE_PREFIX=keyboardio/avr/libraries/Kaleidoscope-Plugin/build UNAME_S := $(shell uname -s) ifeq ($(UNAME_S),Darwin) -BOARD_HARDWARE_PATH ?= $(HOME)/Documents/Arduino/hardware +SKETCHBOOK_DIR ?= $(HOME)/Documents/Arduino/ else -BOARD_HARDWARE_PATH ?= $(HOME)/Arduino/hardware +SKETCHBOOK_DIR ?= $(HOME)/Arduino endif -include $(BOARD_HARDWARE_PATH)/$(MAKEFILE_PREFIX)/rules.mk +BOARD_HARDWARE_PATH ?= $(SKETCHBOOK_DIR)/hardware +KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR ?= keyboardio/avr/build-tools/makefiles/ +include $(BOARD_HARDWARE_PATH)/$(KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR)/rules.mk From 592c0945655cf02e63411fe0e349c0cc5128811f Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 13 May 2018 22:11:54 +0200 Subject: [PATCH 32/52] Updated to use the new plugin APIs Signed-off-by: Gergely Nagy --- README.md | 6 ++--- examples/TopsyTurvy/TopsyTurvy.ino | 8 +++--- src/Kaleidoscope/TopsyTurvy.cpp | 39 ++++++++++++++++++------------ src/Kaleidoscope/TopsyTurvy.h | 15 ++++++++---- 4 files changed, 42 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index dedaa01a..6df17635 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Kaleidoscope-TopsyTurvy -![status][st:stable] [![Build Status][travis:image]][travis:status] +![status][st:experimental] [![Build Status][travis:image]][travis:status] [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-TopsyTurvy.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-TopsyTurvy @@ -26,9 +26,9 @@ effects to, and use the plugin: // In the keymap: TOPSY(1), TOPSY(2), TOPSY(3) -void setup () { - Kaleidoscope.use (&TopsyTurvy); +KALEIDOSCOPE_INIT_PLUGINS(TopsyTurvy); +void setup () { Kaleidoscope.setup (); } ``` diff --git a/examples/TopsyTurvy/TopsyTurvy.ino b/examples/TopsyTurvy/TopsyTurvy.ino index ca2dfddf..c62886d8 100644 --- a/examples/TopsyTurvy/TopsyTurvy.ino +++ b/examples/TopsyTurvy/TopsyTurvy.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-TopsyTurvy -- Turn the effect of Shift upside down for certain keys - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 2017, 2018 Gergely Nagy * * 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 @@ -19,6 +19,7 @@ #include #include +// *INDENT-OFF* const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED ( @@ -38,10 +39,11 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, Key_skip), }; +// *INDENT-ON* -void setup() { - Kaleidoscope.use(&TopsyTurvy); +KALEIDOSCOPE_INIT_PLUGINS(TopsyTurvy); +void setup() { Kaleidoscope.setup(); } diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index fb1db387..dad4976e 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-TopsyTurvy -- Turn the effect of Shift upside down for certain keys - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 2017, 2018 Gergely Nagy * * 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 @@ -26,16 +26,9 @@ namespace kaleidoscope { uint8_t TopsyTurvy::mod_state_; uint8_t TopsyTurvy::last_pressed_position_; -TopsyTurvy::TopsyTurvy(void) { -} - -void TopsyTurvy::begin(void) { - Kaleidoscope.useEventHandlerHook(eventHandlerHook); -} - -Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state) { +EventHandlerResult TopsyTurvy::onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t key_state) { if (key_state & TOPSYTURVY) - return mapped_key; + return EventHandlerResult::OK; if (mapped_key.raw == Key_LeftShift.raw) bitWrite(mod_state_, 0, keyIsPressed(key_state)); @@ -43,21 +36,22 @@ Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key bitWrite(mod_state_, 1, keyIsPressed(key_state)); if (!keyIsPressed(key_state) && !keyWasPressed(key_state)) - return mapped_key; + return EventHandlerResult::OK; if (mapped_key < ranges::TT_FIRST || mapped_key > ranges::TT_LAST) - return mapped_key; + return EventHandlerResult::OK; if (keyToggledOn(key_state)) { last_pressed_position_ = row * COLS + col; } else { - if (last_pressed_position_ != row * COLS + col) - return Key_NoKey; + if (last_pressed_position_ != row * COLS + col) { + return EventHandlerResult::EVENT_CONSUMED; + } } Key new_key = {.raw = mapped_key.raw - ranges::TT_FIRST}; if (new_key.raw == Key_NoKey.raw) - return mapped_key; + return EventHandlerResult::OK; // invert the shift state @@ -81,8 +75,23 @@ Key TopsyTurvy::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key hid::pressRawKey(Key_RightShift); } + return EventHandlerResult::EVENT_CONSUMED; +} + +// Legacy V1 API + +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API +void TopsyTurvy::begin() { + Kaleidoscope.useEventHandlerHook(legacyEventHandler); +} + +Key TopsyTurvy::legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state) { + EventHandlerResult r = ::TopsyTurvy.onKeyswitchEvent(mapped_key, row, col, key_state); + if (r == EventHandlerResult::OK) + return mapped_key; return Key_NoKey; } +#endif } diff --git a/src/Kaleidoscope/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h index f97f665c..9402b6cc 100644 --- a/src/Kaleidoscope/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-TopsyTurvy -- Turn the effect of Shift upside down for certain keys - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 2017, 2018 Gergely Nagy * * 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 @@ -27,14 +27,19 @@ namespace kaleidoscope { class TopsyTurvy: public KaleidoscopePlugin { public: - TopsyTurvy(void); + TopsyTurvy(void) {} + + EventHandlerResult onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t key_state); + +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API + protected: + void begin(); + static Key legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state); +#endif - void begin(void) final; private: static uint8_t mod_state_; static uint8_t last_pressed_position_; - - static Key eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state); }; } From a07cda8019aab630faebb24bbb38decd562a7a1b Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 17 Jun 2018 11:26:23 +0200 Subject: [PATCH 33/52] Override onSetup when using a compatibility layer The default `onSetup` will call `.begin`, to support initializing plugins using the V1 plugins while using `KALEIDOSCOPE_INIT_PLUGINS`. However, plugins that implement a compatibility layer so that they can be used with both the new API, and with `Kaleidoscope.use()` will have a `.begin` method too. Which the default `onSetup` will call, and we'll register the compatibility layer too, in addition to the new-style event handlers. This results in many things running twice, which leads to all kinds of problems. For this reason, override `onSetup`, so that it does not call `begin`. When used with `Kaleidoscope.use()`, the plugin will still work, so compatibility is maintained. But the bug is now gone. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TopsyTurvy.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/Kaleidoscope/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h index 9402b6cc..b75e942a 100644 --- a/src/Kaleidoscope/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -32,6 +32,10 @@ class TopsyTurvy: public KaleidoscopePlugin { EventHandlerResult onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t key_state); #if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API + kaleidoscope::EventHandlerResult onSetup() { + return kaleidoscope::EventHandlerResult::OK; + } + protected: void begin(); static Key legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state); From d38fb4afb06ecdee9e2973600ad621d348d5a5a9 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Aug 2018 23:29:31 +0200 Subject: [PATCH 34/52] Drop the V1 plugin API compatibility code Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TopsyTurvy.cpp | 15 --------------- src/Kaleidoscope/TopsyTurvy.h | 10 ---------- 2 files changed, 25 deletions(-) diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index dad4976e..0800cf90 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -78,21 +78,6 @@ EventHandlerResult TopsyTurvy::onKeyswitchEvent(Key &mapped_key, byte row, byte return EventHandlerResult::EVENT_CONSUMED; } -// Legacy V1 API - -#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API -void TopsyTurvy::begin() { - Kaleidoscope.useEventHandlerHook(legacyEventHandler); -} - -Key TopsyTurvy::legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state) { - EventHandlerResult r = ::TopsyTurvy.onKeyswitchEvent(mapped_key, row, col, key_state); - if (r == EventHandlerResult::OK) - return mapped_key; - return Key_NoKey; -} -#endif - } kaleidoscope::TopsyTurvy TopsyTurvy; diff --git a/src/Kaleidoscope/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h index b75e942a..048debc3 100644 --- a/src/Kaleidoscope/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -31,16 +31,6 @@ class TopsyTurvy: public KaleidoscopePlugin { EventHandlerResult onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t key_state); -#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API - kaleidoscope::EventHandlerResult onSetup() { - return kaleidoscope::EventHandlerResult::OK; - } - - protected: - void begin(); - static Key legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state); -#endif - private: static uint8_t mod_state_; static uint8_t last_pressed_position_; From 4e9a0c8036c539afbb072ffe06c95aec88e5543a Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 21:41:34 +0200 Subject: [PATCH 35/52] Fix a hidden dependency on the old V1 plugin API TopsyTurvy derived from `KaleidoscopePlugin`, which was part of the V1 plugin API, and has been recently removed. Use `kaleidoscope::Plugin` instead, which is its replacement. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TopsyTurvy.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h index 048debc3..3422b2cd 100644 --- a/src/Kaleidoscope/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -25,7 +25,7 @@ namespace kaleidoscope { -class TopsyTurvy: public KaleidoscopePlugin { +class TopsyTurvy: public kaleidoscope::Plugin { public: TopsyTurvy(void) {} From 9720a85b50d6a49c4bf00e90483cfe9e74a38c6b Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:18:00 +0200 Subject: [PATCH 36/52] Relicense under the GPLv3 (only) Signed-off-by: Gergely Nagy --- examples/TopsyTurvy/TopsyTurvy.ino | 19 +++++++++---------- src/Kaleidoscope-TopsyTurvy.h | 19 +++++++++---------- src/Kaleidoscope/TopsyTurvy.cpp | 19 +++++++++---------- src/Kaleidoscope/TopsyTurvy.h | 19 +++++++++---------- 4 files changed, 36 insertions(+), 40 deletions(-) diff --git a/examples/TopsyTurvy/TopsyTurvy.ino b/examples/TopsyTurvy/TopsyTurvy.ino index c62886d8..0b68f19e 100644 --- a/examples/TopsyTurvy/TopsyTurvy.ino +++ b/examples/TopsyTurvy/TopsyTurvy.ino @@ -2,18 +2,17 @@ * Kaleidoscope-TopsyTurvy -- Turn the effect of Shift upside down for certain keys * Copyright (C) 2017, 2018 Gergely Nagy * - * 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 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, version 3. * - * 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. + * 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 . + * You should have received a copy of the GNU General Public License along with + * this program. If not, see . */ #include diff --git a/src/Kaleidoscope-TopsyTurvy.h b/src/Kaleidoscope-TopsyTurvy.h index 2eace1b4..a8bab046 100644 --- a/src/Kaleidoscope-TopsyTurvy.h +++ b/src/Kaleidoscope-TopsyTurvy.h @@ -2,18 +2,17 @@ * Kaleidoscope-TopsyTurvy -- Turn the effect of Shift upside down for certain keys * Copyright (C) 2017 Gergely Nagy * - * 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 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, version 3. * - * 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. + * 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 . + * You should have received a copy of the GNU General Public License along with + * this program. If not, see . */ #pragma once diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index 0800cf90..ca0866ec 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -2,18 +2,17 @@ * Kaleidoscope-TopsyTurvy -- Turn the effect of Shift upside down for certain keys * Copyright (C) 2017, 2018 Gergely Nagy * - * 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 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, version 3. * - * 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. + * 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 . + * You should have received a copy of the GNU General Public License along with + * this program. If not, see . */ #include diff --git a/src/Kaleidoscope/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h index 3422b2cd..cd7e5345 100644 --- a/src/Kaleidoscope/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -2,18 +2,17 @@ * Kaleidoscope-TopsyTurvy -- Turn the effect of Shift upside down for certain keys * Copyright (C) 2017, 2018 Gergely Nagy * - * 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 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, version 3. * - * 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. + * 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 . + * You should have received a copy of the GNU General Public License along with + * this program. If not, see . */ #pragma once From 4086275174b480c0555ec54b4f414f1b8b0d70be Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:18:02 +0200 Subject: [PATCH 37/52] Assign my copyright to Keyboard.io While the original plugin was written independently, significant developments were made while working for Keyboard.io. As such, I feel it is appropriate to assign copyright to the company. Signed-off-by: Gergely Nagy --- examples/TopsyTurvy/TopsyTurvy.ino | 2 +- library.properties | 2 +- src/Kaleidoscope-TopsyTurvy.h | 2 +- src/Kaleidoscope/TopsyTurvy.cpp | 2 +- src/Kaleidoscope/TopsyTurvy.h | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/examples/TopsyTurvy/TopsyTurvy.ino b/examples/TopsyTurvy/TopsyTurvy.ino index 0b68f19e..1e1e52ed 100644 --- a/examples/TopsyTurvy/TopsyTurvy.ino +++ b/examples/TopsyTurvy/TopsyTurvy.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-TopsyTurvy -- Turn the effect of Shift upside down for certain keys - * Copyright (C) 2017, 2018 Gergely Nagy + * Copyright (C) 2017, 2018 Keyboard.io, Inc * * 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 diff --git a/library.properties b/library.properties index 719e1ac5..2e111a12 100644 --- a/library.properties +++ b/library.properties @@ -1,7 +1,7 @@ name=Kaleidoscope-TopsyTurvy version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy +maintainer=Gergely Nagy sentence=Turn the effect of Shift upside down for certain keys. paragraph=Make it possible to send an unshifted symbol with Shift held. category=Communication diff --git a/src/Kaleidoscope-TopsyTurvy.h b/src/Kaleidoscope-TopsyTurvy.h index a8bab046..118a10d9 100644 --- a/src/Kaleidoscope-TopsyTurvy.h +++ b/src/Kaleidoscope-TopsyTurvy.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-TopsyTurvy -- Turn the effect of Shift upside down for certain keys - * Copyright (C) 2017 Gergely Nagy + * Copyright (C) 2017 Keyboard.io, Inc * * 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 diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index ca0866ec..6685a647 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-TopsyTurvy -- Turn the effect of Shift upside down for certain keys - * Copyright (C) 2017, 2018 Gergely Nagy + * Copyright (C) 2017, 2018 Keyboard.io, Inc * * 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 diff --git a/src/Kaleidoscope/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h index cd7e5345..7d2c15db 100644 --- a/src/Kaleidoscope/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-TopsyTurvy -- Turn the effect of Shift upside down for certain keys - * Copyright (C) 2017, 2018 Gergely Nagy + * Copyright (C) 2017, 2018 Keyboard.io, Inc * * 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 From 51ddc7a6ac9d892dfbfcb2cd1151e3933ce133cd Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:18:05 +0200 Subject: [PATCH 38/52] Add CONTRIBUTING.md Copied from Kaleidoscope, as it is applicable here too. Signed-off-by: Gergely Nagy --- CONTRIBUTING.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..c490e3ce --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Developer Certificate of Origin + +All contributions must include acceptance of the DCO: + +``` +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +1 Letterman Drive +Suite D4700 +San Francisco, CA, 94129 + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. +``` + +## Sign your work + +To accept the DCO, please add this line to each commit message with your name +and email address (`git commit -s` will do this for you): + + Signed-off-by: Jane Example From 8a426cc3e3d25dd9a24f6342d6d293b83a43b981 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 26 Aug 2018 21:48:12 +0200 Subject: [PATCH 39/52] Drop the idle-case check We're not calling `onKeyswitchEvent` in the idle cases anymore, drop the check for a few bytes saved. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TopsyTurvy.cpp | 2 -- 1 file changed, 2 deletions(-) diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index 6685a647..a9930924 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -34,8 +34,6 @@ EventHandlerResult TopsyTurvy::onKeyswitchEvent(Key &mapped_key, byte row, byte if (mapped_key.raw == Key_RightShift.raw) bitWrite(mod_state_, 1, keyIsPressed(key_state)); - if (!keyIsPressed(key_state) && !keyWasPressed(key_state)) - return EventHandlerResult::OK; if (mapped_key < ranges::TT_FIRST || mapped_key > ranges::TT_LAST) return EventHandlerResult::OK; From 209a92b6e07906c2f9f89f74a7497373e6a66cda Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 26 Aug 2018 21:59:42 +0200 Subject: [PATCH 40/52] If a non-Topsy key toggles on, disable repeating the Topsy one This is to avoid the case where chording a Topsy and a non-Topsy key would result in both being repeated very fast. This happened because each cycle we sent two reports: one for the Topsy key, one for the others. This didn't allow the host's normal repeating behaviour to kick in, and instead, resulted in both keys being input very fast. Fixes #5. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TopsyTurvy.cpp | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index a9930924..f616f106 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -34,9 +34,13 @@ EventHandlerResult TopsyTurvy::onKeyswitchEvent(Key &mapped_key, byte row, byte if (mapped_key.raw == Key_RightShift.raw) bitWrite(mod_state_, 1, keyIsPressed(key_state)); + if (mapped_key < ranges::TT_FIRST || mapped_key > ranges::TT_LAST) { + if (keyToggledOn(key_state)) { + last_pressed_position_ = row * COLS + col; + } - if (mapped_key < ranges::TT_FIRST || mapped_key > ranges::TT_LAST) return EventHandlerResult::OK; + } if (keyToggledOn(key_state)) { last_pressed_position_ = row * COLS + col; From 62f9fe481dadcaae4fbe4dfb3c88850e13b83682 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 26 Aug 2018 22:33:43 +0200 Subject: [PATCH 41/52] Simplify the normal, "unshifted" case Instead of injecting a new event, modify `mapped_key` instead, and give it a `SHIFT_HELD` flag. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TopsyTurvy.cpp | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index f616f106..fef8864f 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -55,14 +55,10 @@ EventHandlerResult TopsyTurvy::onKeyswitchEvent(Key &mapped_key, byte row, byte return EventHandlerResult::OK; // invert the shift state - if (!mod_state_) { - if (keyIsPressed(key_state)) - hid::pressRawKey(Key_LeftShift); - handleKeyswitchEvent(new_key, row, col, key_state | TOPSYTURVY | INJECTED); - hid::sendKeyboardReport(); - if (keyToggledOff(key_state)) - hid::releaseRawKey(Key_LeftShift); + mapped_key.raw = mapped_key.raw - ranges::TT_FIRST; + mapped_key.flags |= SHIFT_HELD; + return EventHandlerResult::OK; } else { hid::releaseRawKey(Key_LeftShift); hid::releaseRawKey(Key_RightShift); From 1e0ac664fe25575dfec9cfd4d64c664462ac38b6 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 26 Aug 2018 22:34:39 +0200 Subject: [PATCH 42/52] When seeing a modifier key, don't set last_pressed_position_ We do not want modifier keys to abort the TopsyTurvy magic. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TopsyTurvy.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index fef8864f..5c6ae6ed 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -35,7 +35,7 @@ EventHandlerResult TopsyTurvy::onKeyswitchEvent(Key &mapped_key, byte row, byte bitWrite(mod_state_, 1, keyIsPressed(key_state)); if (mapped_key < ranges::TT_FIRST || mapped_key > ranges::TT_LAST) { - if (keyToggledOn(key_state)) { + if (keyToggledOn(key_state) && (mapped_key < Key_LeftControl || mapped_key > Key_RightGui)) { last_pressed_position_ = row * COLS + col; } From 2bfd64a900c2f9f6f0b8b5802b5f92e610091876 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 26 Aug 2018 22:37:55 +0200 Subject: [PATCH 43/52] Simplify the "shifted" case too Like in the unshifted case, avoid injecting keys, and fiddle with `mapped_key` instead. This allows us to get rid of the `TOPSYTURVY` bitflag. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TopsyTurvy.cpp | 25 +++++++------------------ 1 file changed, 7 insertions(+), 18 deletions(-) diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index 5c6ae6ed..7dbb0445 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -18,17 +18,12 @@ #include #include "kaleidoscope/hid.h" -#define TOPSYTURVY 0b01000000 - namespace kaleidoscope { uint8_t TopsyTurvy::mod_state_; uint8_t TopsyTurvy::last_pressed_position_; EventHandlerResult TopsyTurvy::onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t key_state) { - if (key_state & TOPSYTURVY) - return EventHandlerResult::OK; - if (mapped_key.raw == Key_LeftShift.raw) bitWrite(mod_state_, 0, keyIsPressed(key_state)); if (mapped_key.raw == Key_RightShift.raw) @@ -50,26 +45,20 @@ EventHandlerResult TopsyTurvy::onKeyswitchEvent(Key &mapped_key, byte row, byte } } - Key new_key = {.raw = mapped_key.raw - ranges::TT_FIRST}; - if (new_key.raw == Key_NoKey.raw) - return EventHandlerResult::OK; // invert the shift state if (!mod_state_) { mapped_key.raw = mapped_key.raw - ranges::TT_FIRST; mapped_key.flags |= SHIFT_HELD; return EventHandlerResult::OK; - } else { - hid::releaseRawKey(Key_LeftShift); - hid::releaseRawKey(Key_RightShift); - hid::sendKeyboardReport(); - handleKeyswitchEvent(new_key, row, col, key_state | TOPSYTURVY | INJECTED); - hid::sendKeyboardReport(); + } + + if (keyIsPressed(key_state)) { + hid::releaseKey(Key_LeftShift); + hid::releaseKey(Key_RightShift); - if (bitRead(mod_state_, 0)) - hid::pressRawKey(Key_LeftShift); - if (bitRead(mod_state_, 1)) - hid::pressRawKey(Key_RightShift); + mapped_key.raw = mapped_key.raw - ranges::TT_FIRST; + return EventHandlerResult::OK; } return EventHandlerResult::EVENT_CONSUMED; From f74292fbee66e2607ed36e5c2449452431c902a4 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 26 Aug 2018 22:40:05 +0200 Subject: [PATCH 44/52] If a Topsy key is active, consume shifts This allows us to reliably do the `Shift+TOPSY` case. Fixes #11. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TopsyTurvy.cpp | 12 ++++++++++-- src/Kaleidoscope/TopsyTurvy.h | 1 + 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index 7dbb0445..a9831d2f 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -22,12 +22,19 @@ namespace kaleidoscope { uint8_t TopsyTurvy::mod_state_; uint8_t TopsyTurvy::last_pressed_position_; +bool TopsyTurvy::is_active_; EventHandlerResult TopsyTurvy::onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t key_state) { - if (mapped_key.raw == Key_LeftShift.raw) + if (mapped_key.raw == Key_LeftShift.raw) { bitWrite(mod_state_, 0, keyIsPressed(key_state)); - if (mapped_key.raw == Key_RightShift.raw) + if (is_active_) + return EventHandlerResult::EVENT_CONSUMED; + } + if (mapped_key.raw == Key_RightShift.raw) { bitWrite(mod_state_, 1, keyIsPressed(key_state)); + if (is_active_) + return EventHandlerResult::EVENT_CONSUMED; + } if (mapped_key < ranges::TT_FIRST || mapped_key > ranges::TT_LAST) { if (keyToggledOn(key_state) && (mapped_key < Key_LeftControl || mapped_key > Key_RightGui)) { @@ -45,6 +52,7 @@ EventHandlerResult TopsyTurvy::onKeyswitchEvent(Key &mapped_key, byte row, byte } } + is_active_ = keyIsPressed(key_state); // invert the shift state if (!mod_state_) { diff --git a/src/Kaleidoscope/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h index 7d2c15db..8ba92094 100644 --- a/src/Kaleidoscope/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -33,6 +33,7 @@ class TopsyTurvy: public kaleidoscope::Plugin { private: static uint8_t mod_state_; static uint8_t last_pressed_position_; + static bool is_active_; }; } From 2ebf02d76a337c80168d4ec88fae6b8be0ab3651 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 26 Aug 2018 22:47:36 +0200 Subject: [PATCH 45/52] Simplify the shift tracking We do not need to track which shift is pressed, so lets use a bool instead of a bitfield. Makes the shift checking code smaller too! Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TopsyTurvy.cpp | 15 ++++++--------- src/Kaleidoscope/TopsyTurvy.h | 2 +- 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index a9831d2f..63b853ae 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -20,18 +20,15 @@ namespace kaleidoscope { -uint8_t TopsyTurvy::mod_state_; uint8_t TopsyTurvy::last_pressed_position_; +bool TopsyTurvy::is_shifted_; bool TopsyTurvy::is_active_; EventHandlerResult TopsyTurvy::onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t key_state) { - if (mapped_key.raw == Key_LeftShift.raw) { - bitWrite(mod_state_, 0, keyIsPressed(key_state)); - if (is_active_) - return EventHandlerResult::EVENT_CONSUMED; - } - if (mapped_key.raw == Key_RightShift.raw) { - bitWrite(mod_state_, 1, keyIsPressed(key_state)); + + if (mapped_key == Key_LeftShift || + mapped_key == Key_RightShift) { + is_shifted_ = keyIsPressed(key_state); if (is_active_) return EventHandlerResult::EVENT_CONSUMED; } @@ -55,7 +52,7 @@ EventHandlerResult TopsyTurvy::onKeyswitchEvent(Key &mapped_key, byte row, byte is_active_ = keyIsPressed(key_state); // invert the shift state - if (!mod_state_) { + if (!is_shifted_) { mapped_key.raw = mapped_key.raw - ranges::TT_FIRST; mapped_key.flags |= SHIFT_HELD; return EventHandlerResult::OK; diff --git a/src/Kaleidoscope/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h index 8ba92094..e97a9d64 100644 --- a/src/Kaleidoscope/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -31,8 +31,8 @@ class TopsyTurvy: public kaleidoscope::Plugin { EventHandlerResult onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t key_state); private: - static uint8_t mod_state_; static uint8_t last_pressed_position_; + static bool is_shifted_; static bool is_active_; }; From c996c5e4e1ce2834c37e96f379d307c7be01b316 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 26 Aug 2018 22:49:49 +0200 Subject: [PATCH 46/52] Minor code refactoring In the Topsy case, pre-calculate `mapped_key.raw` for both branches, and only modify its flags in the unishfted branch. This saves us about a dozen bytes of PROGMEM. Signed-off-by: Gergely Nagy --- src/Kaleidoscope/TopsyTurvy.cpp | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp index 63b853ae..fef58484 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -50,10 +50,10 @@ EventHandlerResult TopsyTurvy::onKeyswitchEvent(Key &mapped_key, byte row, byte } is_active_ = keyIsPressed(key_state); + mapped_key.raw = mapped_key.raw - ranges::TT_FIRST; // invert the shift state if (!is_shifted_) { - mapped_key.raw = mapped_key.raw - ranges::TT_FIRST; mapped_key.flags |= SHIFT_HELD; return EventHandlerResult::OK; } @@ -62,7 +62,6 @@ EventHandlerResult TopsyTurvy::onKeyswitchEvent(Key &mapped_key, byte row, byte hid::releaseKey(Key_LeftShift); hid::releaseKey(Key_RightShift); - mapped_key.raw = mapped_key.raw - ranges::TT_FIRST; return EventHandlerResult::OK; } From c909c0615b00173817884e1315af330da756b167 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:24:02 -0700 Subject: [PATCH 47/52] Update travis.yml to point to new bundle repo --- .travis.yml | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index e7030acf..e3e64f77 100644 --- a/.travis.yml +++ b/.travis.yml @@ -2,10 +2,15 @@ dist: trusty sudo: false os: - linux +addons: + apt: + packages: + - shellcheck install: - - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Arduino-Boards hardware/keyboardio/avr + - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio hardware/keyboardio script: - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware + - shellcheck bin/kaleidoscope-builder notifications: irc: channels: @@ -13,7 +18,7 @@ notifications: use_notice: true skip_join: true template: - - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" + - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" email: on_success: change on_failure: change From 65c936fb80b0cf2c1936ede2fda9c18cc359ce3f Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:42:30 -0700 Subject: [PATCH 48/52] shellcheck should only be run in the Kaleidoscope repo --- .travis.yml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/.travis.yml b/.travis.yml index e3e64f77..23d30ccc 100644 --- a/.travis.yml +++ b/.travis.yml @@ -2,15 +2,10 @@ dist: trusty sudo: false os: - linux -addons: - apt: - packages: - - shellcheck install: - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio hardware/keyboardio script: - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware - - shellcheck bin/kaleidoscope-builder notifications: irc: channels: From b73588055eedce68abb098bfda6e0af55c505905 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 10 Oct 2018 06:57:55 +0200 Subject: [PATCH 49/52] README.md & Travis cleanup Remove the IRC notifications from Travis (we're not using IRC anymore), and the stable/experimental badge from README.md (because they aren't being kept up to date). Signed-off-by: Gergely Nagy --- .travis.yml | 7 ------- README.md | 6 +----- 2 files changed, 1 insertion(+), 12 deletions(-) diff --git a/.travis.yml b/.travis.yml index 23d30ccc..49b8c498 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,13 +7,6 @@ install: script: - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware notifications: - irc: - channels: - - "chat.freenode.net#keyboardio" - use_notice: true - skip_join: true - template: - - "%{repository_name}/%{branch} %{commit} by %{author}: %{commit_subject} %{build_url} %{message}" email: on_success: change on_failure: change diff --git a/README.md b/README.md index 6df17635..492f68bb 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,10 @@ # Kaleidoscope-TopsyTurvy -![status][st:experimental] [![Build Status][travis:image]][travis:status] +[![Build Status][travis:image]][travis:status] [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-TopsyTurvy.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-TopsyTurvy - [st:stable]: https://img.shields.io/badge/stable-✔-black.svg?style=flat&colorA=44cc11&colorB=494e52 - [st:broken]: https://img.shields.io/badge/broken-X-black.svg?style=flat&colorA=e05d44&colorB=494e52 - [st:experimental]: https://img.shields.io/badge/experimental----black.svg?style=flat&colorA=dfb317&colorB=494e52 - `TopsyTurvy` is a plugin that inverts the behaviour of the `Shift` key for some selected keys. That is, if configured so, it will input `!` when pressing the `1` key without `Shift`, but with the modifier pressed, it will input the From 265cbde9803e0d967723798d1f32986e1864d2d4 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 15:36:22 +0200 Subject: [PATCH 50/52] Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/TopsyTurvy.md`, sources under `src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of merging plugins into a single monorepo. Signed-off-by: Gergely Nagy --- README.md | 50 +----------------- doc/plugin/TopsyTurvy.md | 51 +++++++++++++++++++ src/Kaleidoscope-TopsyTurvy.h | 2 +- .../plugin}/TopsyTurvy.cpp | 4 +- .../plugin}/TopsyTurvy.h | 5 +- 5 files changed, 59 insertions(+), 53 deletions(-) create mode 100644 doc/plugin/TopsyTurvy.md rename src/{Kaleidoscope => kaleidoscope/plugin}/TopsyTurvy.cpp (96%) rename src/{Kaleidoscope => kaleidoscope/plugin}/TopsyTurvy.h (94%) diff --git a/README.md b/README.md index 492f68bb..ba5dfa52 100644 --- a/README.md +++ b/README.md @@ -5,52 +5,4 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-TopsyTurvy.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-TopsyTurvy -`TopsyTurvy` is a plugin that inverts the behaviour of the `Shift` key for some -selected keys. That is, if configured so, it will input `!` when pressing the -`1` key without `Shift`, but with the modifier pressed, it will input the -original `1` symbol. - -## Using the plugin - -To use the plugin, one needs to include the header, mark keys to apply plugin -effects to, and use the plugin: - -```c++ -#include -#include - -// In the keymap: -TOPSY(1), TOPSY(2), TOPSY(3) - -KALEIDOSCOPE_INIT_PLUGINS(TopsyTurvy); - -void setup () { - Kaleidoscope.setup (); -} -``` - -## Keymap markup - -There is only one macro that the plugin provides, which one can use in keymap definitions: - -### `TOPSY(key)` - -> Mark the specified `key` (without the `Key_` prefix!) for TopsyTurvy, and swap -> the effect of `Shift` when the key is used. One can have any number of -> topsy-turvy keys on a keymap. -> -> The keys must be plain old keys, modifiers or anything other augmentation -> cannot be applied. - -The plugin provides a number of macros one can use in keymap definitions: - -## Plugin methods - -The plugin provides the `TopsyTurvy` object, without any public methods or properties. - -## Further reading - -Starting from the [example][plugin:example] is the recommended way of getting -started with the plugin. - - [plugin:example]: https://github.com/keyboardio/Kaleidoscope-TopsyTurvy/blob/master/examples/TopsyTurvy/TopsyTurvy.ino +See [doc/plugin/TopsyTurvy.md](doc/plugin/TopsyTurvy.md) for documentation. diff --git a/doc/plugin/TopsyTurvy.md b/doc/plugin/TopsyTurvy.md new file mode 100644 index 00000000..4807e50c --- /dev/null +++ b/doc/plugin/TopsyTurvy.md @@ -0,0 +1,51 @@ +# Kaleidoscope-TopsyTurvy + +`TopsyTurvy` is a plugin that inverts the behaviour of the `Shift` key for some +selected keys. That is, if configured so, it will input `!` when pressing the +`1` key without `Shift`, but with the modifier pressed, it will input the +original `1` symbol. + +## Using the plugin + +To use the plugin, one needs to include the header, mark keys to apply plugin +effects to, and use the plugin: + +```c++ +#include +#include + +// In the keymap: +TOPSY(1), TOPSY(2), TOPSY(3) + +KALEIDOSCOPE_INIT_PLUGINS(TopsyTurvy); + +void setup () { + Kaleidoscope.setup (); +} +``` + +## Keymap markup + +There is only one macro that the plugin provides, which one can use in keymap definitions: + +### `TOPSY(key)` + +> Mark the specified `key` (without the `Key_` prefix!) for TopsyTurvy, and swap +> the effect of `Shift` when the key is used. One can have any number of +> topsy-turvy keys on a keymap. +> +> The keys must be plain old keys, modifiers or anything other augmentation +> cannot be applied. + +The plugin provides a number of macros one can use in keymap definitions: + +## Plugin methods + +The plugin provides the `TopsyTurvy` object, without any public methods or properties. + +## Further reading + +Starting from the [example][plugin:example] is the recommended way of getting +started with the plugin. + + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-TopsyTurvy/blob/master/examples/TopsyTurvy/TopsyTurvy.ino diff --git a/src/Kaleidoscope-TopsyTurvy.h b/src/Kaleidoscope-TopsyTurvy.h index 118a10d9..ee7c5351 100644 --- a/src/Kaleidoscope-TopsyTurvy.h +++ b/src/Kaleidoscope-TopsyTurvy.h @@ -17,4 +17,4 @@ #pragma once -#include +#include diff --git a/src/Kaleidoscope/TopsyTurvy.cpp b/src/kaleidoscope/plugin/TopsyTurvy.cpp similarity index 96% rename from src/Kaleidoscope/TopsyTurvy.cpp rename to src/kaleidoscope/plugin/TopsyTurvy.cpp index fef58484..a7e460e7 100644 --- a/src/Kaleidoscope/TopsyTurvy.cpp +++ b/src/kaleidoscope/plugin/TopsyTurvy.cpp @@ -19,6 +19,7 @@ #include "kaleidoscope/hid.h" namespace kaleidoscope { +namespace plugin { uint8_t TopsyTurvy::last_pressed_position_; bool TopsyTurvy::is_shifted_; @@ -68,6 +69,7 @@ EventHandlerResult TopsyTurvy::onKeyswitchEvent(Key &mapped_key, byte row, byte return EventHandlerResult::EVENT_CONSUMED; } +} } -kaleidoscope::TopsyTurvy TopsyTurvy; +kaleidoscope::plugin::TopsyTurvy TopsyTurvy; diff --git a/src/Kaleidoscope/TopsyTurvy.h b/src/kaleidoscope/plugin/TopsyTurvy.h similarity index 94% rename from src/Kaleidoscope/TopsyTurvy.h rename to src/kaleidoscope/plugin/TopsyTurvy.h index e97a9d64..d5ad5923 100644 --- a/src/Kaleidoscope/TopsyTurvy.h +++ b/src/kaleidoscope/plugin/TopsyTurvy.h @@ -23,6 +23,7 @@ #define TOPSY(k) (Key) { .raw = kaleidoscope::ranges::TT_FIRST + (Key_ ## k).keyCode } namespace kaleidoscope { +namespace plugin { class TopsyTurvy: public kaleidoscope::Plugin { public: @@ -35,7 +36,7 @@ class TopsyTurvy: public kaleidoscope::Plugin { static bool is_shifted_; static bool is_active_; }; - +} } -extern kaleidoscope::TopsyTurvy TopsyTurvy; +extern kaleidoscope::plugin::TopsyTurvy TopsyTurvy; From 2ef8c8ca2e3f18d83431a2d196c4422ac68813f4 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 15:36:24 +0200 Subject: [PATCH 51/52] Remove files we do not need in the monorepo Signed-off-by: Gergely Nagy --- .gitignore | 4 - .travis.yml | 14 - CONTRIBUTING.md | 50 ---- COPYING | 674 --------------------------------------------- Makefile | 14 - README.md | 8 - library.properties | 10 - 7 files changed, 774 deletions(-) delete mode 100644 .gitignore delete mode 100644 .travis.yml delete mode 100644 CONTRIBUTING.md delete mode 100644 COPYING delete mode 100644 Makefile delete mode 100644 README.md delete mode 100644 library.properties diff --git a/.gitignore b/.gitignore deleted file mode 100644 index be16c9be..00000000 --- a/.gitignore +++ /dev/null @@ -1,4 +0,0 @@ -.#* -*~ -/hardware/ -/output/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 49b8c498..00000000 --- a/.travis.yml +++ /dev/null @@ -1,14 +0,0 @@ -dist: trusty -sudo: false -os: - - linux -install: - - git clone --depth 1 --recurse-submodules https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio hardware/keyboardio -script: - - make travis-test BOARD_HARDWARE_PATH=$(pwd)/hardware -notifications: - email: - on_success: change - on_failure: change -cache: - ccache: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index c490e3ce..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,50 +0,0 @@ -# Developer Certificate of Origin - -All contributions must include acceptance of the DCO: - -``` -Developer Certificate of Origin -Version 1.1 - -Copyright (C) 2004, 2006 The Linux Foundation and its contributors. -1 Letterman Drive -Suite D4700 -San Francisco, CA, 94129 - -Everyone is permitted to copy and distribute verbatim copies of this -license document, but changing it is not allowed. - - -Developer's Certificate of Origin 1.1 - -By making a contribution to this project, I certify that: - -(a) The contribution was created in whole or in part by me and I - have the right to submit it under the open source license - indicated in the file; or - -(b) The contribution is based upon previous work that, to the best - of my knowledge, is covered under an appropriate open source - license and I have the right under that license to submit that - work with modifications, whether created in whole or in part - by me, under the same open source license (unless I am - permitted to submit under a different license), as indicated - in the file; or - -(c) The contribution was provided directly to me by some other - person who certified (a), (b) or (c) and I have not modified - it. - -(d) I understand and agree that this project and the contribution - are public and that a record of the contribution (including all - personal information I submit with it, including my sign-off) is - maintained indefinitely and may be redistributed consistent with - this project or the open source license(s) involved. -``` - -## Sign your work - -To accept the DCO, please add this line to each commit message with your name -and email address (`git commit -s` will do this for you): - - Signed-off-by: Jane Example diff --git a/COPYING b/COPYING deleted file mode 100644 index 94a9ed02..00000000 --- a/COPYING +++ /dev/null @@ -1,674 +0,0 @@ - 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/Makefile b/Makefile deleted file mode 100644 index 8f830f44..00000000 --- a/Makefile +++ /dev/null @@ -1,14 +0,0 @@ -# This stub makefile for a Kaleidoscope plugin pulls in -# all targets from the Kaleidoscope-Plugin library - -UNAME_S := $(shell uname -s) - -ifeq ($(UNAME_S),Darwin) -SKETCHBOOK_DIR ?= $(HOME)/Documents/Arduino/ -else -SKETCHBOOK_DIR ?= $(HOME)/Arduino -endif - -BOARD_HARDWARE_PATH ?= $(SKETCHBOOK_DIR)/hardware -KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR ?= keyboardio/avr/build-tools/makefiles/ -include $(BOARD_HARDWARE_PATH)/$(KALEIDOSCOPE_PLUGIN_MAKEFILE_DIR)/rules.mk diff --git a/README.md b/README.md deleted file mode 100644 index ba5dfa52..00000000 --- a/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Kaleidoscope-TopsyTurvy - -[![Build Status][travis:image]][travis:status] - - [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-TopsyTurvy.svg?branch=master - [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-TopsyTurvy - -See [doc/plugin/TopsyTurvy.md](doc/plugin/TopsyTurvy.md) for documentation. diff --git a/library.properties b/library.properties deleted file mode 100644 index 2e111a12..00000000 --- a/library.properties +++ /dev/null @@ -1,10 +0,0 @@ -name=Kaleidoscope-TopsyTurvy -version=0.0.0 -author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Turn the effect of Shift upside down for certain keys. -paragraph=Make it possible to send an unshifted symbol with Shift held. -category=Communication -url=https://github.com/keyboardio/Kaleidoscope-TopsyTurvy -architectures=avr -dot_a_linkage=true From c2dc43a0808eb9bf1caa35cec62eb702f0dbbe1c Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 18 Oct 2018 00:17:33 +0200 Subject: [PATCH 52/52] Update the documentation links Updates the example and dependency links in the documentation, to use URLs that are valid within the monorepo. Signed-off-by: Gergely Nagy --- doc/plugin/TopsyTurvy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/plugin/TopsyTurvy.md b/doc/plugin/TopsyTurvy.md index 4807e50c..c4370c48 100644 --- a/doc/plugin/TopsyTurvy.md +++ b/doc/plugin/TopsyTurvy.md @@ -48,4 +48,4 @@ The plugin provides the `TopsyTurvy` object, without any public methods or prope Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Kaleidoscope-TopsyTurvy/blob/master/examples/TopsyTurvy/TopsyTurvy.ino + [plugin:example]: ../../examples/TopsyTurvy/TopsyTurvy.ino