From e12606e330a55f1a41bd66c903d77980b094f762 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 16 Jan 2017 15:18:13 +0100 Subject: [PATCH 01/32] Initial import Lifted out of the monolithic Akela library. Signed-off-by: Gergely Nagy --- .gitignore | 2 + COPYING | 674 +++++++++++++++++++++++++ README.md | 69 +++ examples/ShapeShifter/ShapeShifter.ino | 57 +++ library.properties | 10 + src/Akela-ShapeShifter.h | 21 + src/Akela/ShapeShifter.cpp | 102 ++++ src/Akela/ShapeShifter.h | 51 ++ 8 files changed, 986 insertions(+) create mode 100644 .gitignore create mode 100644 COPYING create mode 100644 README.md create mode 100644 examples/ShapeShifter/ShapeShifter.ino create mode 100644 library.properties create mode 100644 src/Akela-ShapeShifter.h create mode 100644 src/Akela/ShapeShifter.cpp create mode 100644 src/Akela/ShapeShifter.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..f18e6bfa --- /dev/null +++ b/README.md @@ -0,0 +1,69 @@ +# Akela-ShapeShifter + +`ShapeShifter` is a plugin that makes it considerably easier to change what +symbol is input when a key is pressed together with `Shift`. If one wants to +rearrange the symbols on the number row for example, without modifying the +layout on the operating system side, this plugin is where one can turn to. + +What it does, is very simple: if any key in its dictionary is found pressed +while `Shift` is held, it will press another key instead of the one triggering +the event. For example, if it sees `Shift + 1` pressed together, which normally +results in a `!`, it will press `4` instead of `1`, inputting `$`. + +## Using the plugin + +To use the plugin, one needs to include the header, create a dictionary, and +configure the provided `ShapeShifter` object to use the dictionary: + +```c++ +#include + +static const Akela::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = { + {Key_1, Key_4}, + {Key_4, Key_1}, + {Key_NoKey, Key_NoKey}, +}; + +void setup () { + ShapeShifter.configure (shapeShiftDictionary); + + Keyboardio.setup (KEYMAP_SIZE); + Keyboardio.use (&ShapeShifter, NULL); +} +``` + +The dictionary is made up of `Key` pairs: the first one is to replace, the +second is the replacement. The dictionary must be closed with a `{Key_NoKey, +Key_NoKey}` pair, and **must** reside in `PROGMEM`. + +## Plugin methods + +The plugin provides the `ShapeShifter` object, with the following methods: + +### `.configure(dictionary)` + +> Tells `ShapeShifter` to use the specified dictionary. The dictionary is an +> array of `Akela::ShapeShifter::dictionary_t` elements, which is just a very +> verbose way of saying that its a pair of keys. The first one is the one to +> replace, and the other is to replace it with. +> +> Be aware that the replacement key will be pressed with `Shift` held, so do +> keep that in mind! + +### `.on()` + +> Turns the shape shifting functionality on. Requires that the plugin +> be [configured](#configuredictionary) first. + +### `.off()` + +> Turns the shape shifting functionality off. In this case, no transformations +> will be applied, and even if symbols appear in the dictionary, 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-ShapeShifter/blob/master/examples/ShapeShifter/ShapeShifter.ino diff --git a/examples/ShapeShifter/ShapeShifter.ino b/examples/ShapeShifter/ShapeShifter.ino new file mode 100644 index 00000000..d2ca4d84 --- /dev/null +++ b/examples/ShapeShifter/ShapeShifter.ino @@ -0,0 +1,57 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2016, 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 Akela::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = { + {Key_1, Key_2}, + {Key_2, Key_1}, + {Key_NoKey, Key_NoKey}, +}; + +void setup () { + ShapeShifter.configure (shapeShiftDictionary); + + Keyboardio.setup (KEYMAP_SIZE); + Keyboardio.use (&ShapeShifter, NULL); +} + +void loop () { + Keyboardio.loop (); +} diff --git a/library.properties b/library.properties new file mode 100644 index 00000000..ab2f62a9 --- /dev/null +++ b/library.properties @@ -0,0 +1,10 @@ +name=Akela-ShapeShifter +version=0.0.0 +author=Gergely Nagy +maintainer=Gergely Nagy +sentence=Change the shifted symbols on any key of your choice. +paragraph=Make it possible to send a different keycode when a key is being shifted. +category=Communication +url=https://github.com/Akela-Plugins/Akela-ShapeShifter +architectures=avr +dot_a_linkage=true diff --git a/src/Akela-ShapeShifter.h b/src/Akela-ShapeShifter.h new file mode 100644 index 00000000..9d5b8687 --- /dev/null +++ b/src/Akela-ShapeShifter.h @@ -0,0 +1,21 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2016, 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/ShapeShifter.cpp b/src/Akela/ShapeShifter.cpp new file mode 100644 index 00000000..c4385bea --- /dev/null +++ b/src/Akela/ShapeShifter.cpp @@ -0,0 +1,102 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2016, 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 + +namespace Akela { + + const ShapeShifter::dictionary_t *ShapeShifter::dictionary = NULL; + bool ShapeShifter::modActive; + + ShapeShifter::ShapeShifter (void) { + } + + void + ShapeShifter::begin (void) { + event_handler_hook_add (this->eventHandlerHook); + loop_hook_add (this->loopHook); + } + + void + ShapeShifter::configure (const dictionary_t dictionary_[]) { + dictionary = (const dictionary_t *)dictionary_; + } + + void + ShapeShifter::on (void) { + event_handler_hook_replace (this->noOpHook, this->eventHandlerHook); + loop_hook_replace (this->noOpLoopHook, this->loopHook); + } + + void + ShapeShifter::off (void) { + event_handler_hook_replace (this->eventHandlerHook, this->noOpHook); + loop_hook_replace (this->loopHook, this->noOpLoopHook); + } + + Key + ShapeShifter::noOpHook (Key mappedKey, byte row, byte col, uint8_t keyState) { + return mappedKey; + } + + void + ShapeShifter::noOpLoopHook (bool postClear) { + } + + void + ShapeShifter::loopHook (bool postClear) { + if (postClear) + return; + + modActive = Keyboard.isModifierActive (Key_LShift.keyCode) || + Keyboard.isModifierActive (Key_RShift.keyCode); + } + + Key + ShapeShifter::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { + if (!dictionary) + return mappedKey; + + // If Shift is not active, bail out early. + if (!modActive) + return mappedKey; + + Key orig, repl; + + // Try to find the current key in the dictionary + uint8_t i = 0; + do { + orig.raw = pgm_read_word (&(dictionary[i].original.raw)); + i++; + } while (orig.raw != Key_NoKey.raw && + orig.raw != mappedKey.raw); + i--; + + // If not found, bail out. + if (orig.raw == Key_NoKey.raw) + return mappedKey; + + repl.raw = pgm_read_word (&(dictionary[i].replacement.raw)); + + // If found, handle the alternate key instead + return repl; + } + +}; + +Akela::ShapeShifter ShapeShifter; diff --git a/src/Akela/ShapeShifter.h b/src/Akela/ShapeShifter.h new file mode 100644 index 00000000..41280740 --- /dev/null +++ b/src/Akela/ShapeShifter.h @@ -0,0 +1,51 @@ +/* -*- mode: c++ -*- + * Akela -- Animated Keyboardio Extension Library for Anything + * Copyright (C) 2016, 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 ShapeShifter : public KeyboardioPlugin { + public: + typedef struct { + Key original, replacement; + } dictionary_t; + + ShapeShifter (void); + + virtual void begin (void) final; + + static void configure (const dictionary_t dictionary[]); + + void on (void); + void off (void); + + private: + static const dictionary_t *dictionary; + static bool modActive; + + 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::ShapeShifter ShapeShifter; From a2479a4d4df28aa907e2713637c3b696f7cefc04 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 16 Jan 2017 17:16:49 +0100 Subject: [PATCH 02/32] 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 f18e6bfa..2613bcee 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # Akela-ShapeShifter +![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 + [st:experimental]: https://img.shields.io/badge/experimental----black.png?style=flat&colorA=dfb317&colorB=494e52 + `ShapeShifter` is a plugin that makes it considerably easier to change what symbol is input when a key is pressed together with `Shift`. If one wants to rearrange the symbols on the number row for example, without modifying the From 22afc1d56d020b581de79812b444cc0625a95217 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 17 Jan 2017 10:15:07 +0100 Subject: [PATCH 03/32] 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 2613bcee..76d4e01c 100644 --- a/README.md +++ b/README.md @@ -72,4 +72,4 @@ The plugin provides the `ShapeShifter` 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-ShapeShifter/blob/master/examples/ShapeShifter/ShapeShifter.ino + [plugin:example]: https://github.com/keyboardio/Akela-ShapeShifter/blob/master/examples/ShapeShifter/ShapeShifter.ino diff --git a/library.properties b/library.properties index ab2f62a9..6d78fcde 100644 --- a/library.properties +++ b/library.properties @@ -5,6 +5,6 @@ maintainer=Gergely Nagy sentence=Change the shifted symbols on any key of your choice. paragraph=Make it possible to send a different keycode when a key is being shifted. category=Communication -url=https://github.com/Akela-Plugins/Akela-ShapeShifter +url=https://github.com/keyboardio/Akela-ShapeShifter architectures=avr dot_a_linkage=true From df832e8024f0f0cb13a075ad3c6905c5db8345c2 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 27 Jan 2017 09:39:31 +0100 Subject: [PATCH 04/32] Don't use Key_LEDEffectNext in the example Signed-off-by: Gergely Nagy --- examples/ShapeShifter/ShapeShifter.ino | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/examples/ShapeShifter/ShapeShifter.ino b/examples/ShapeShifter/ShapeShifter.ino index d2ca4d84..58ea39e9 100644 --- a/examples/ShapeShifter/ShapeShifter.ino +++ b/examples/ShapeShifter/ShapeShifter.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 e5fabbce79a3e6c2297ab325119affda6e7f2331 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Fri, 27 Jan 2017 23:01:25 +0100 Subject: [PATCH 05/32] Use the new, double-add protected hook functions Signed-off-by: Gergely Nagy --- src/Akela/ShapeShifter.cpp | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Akela/ShapeShifter.cpp b/src/Akela/ShapeShifter.cpp index c4385bea..7e542d39 100644 --- a/src/Akela/ShapeShifter.cpp +++ b/src/Akela/ShapeShifter.cpp @@ -28,8 +28,8 @@ namespace Akela { void ShapeShifter::begin (void) { - event_handler_hook_add (this->eventHandlerHook); - loop_hook_add (this->loopHook); + event_handler_hook_use (this->eventHandlerHook); + loop_hook_use (this->loopHook); } void From eabc4a987293470ba166171ca310c3ec946e70f3 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 11 Feb 2017 23:49:54 +0100 Subject: [PATCH 06/32] The Big Rename Rename the library to Kaleidoscope-ShapeShifter, and follow up with other renames. Signed-off-by: Gergely Nagy --- README.md | 19 ++++++++++--------- examples/ShapeShifter/ShapeShifter.ino | 13 +++++++------ library.properties | 6 +++--- ...eShifter.h => Kaleidoscope-ShapeShifter.h} | 4 ++-- src/{Akela => Kaleidoscope}/ShapeShifter.cpp | 8 ++++---- src/{Akela => Kaleidoscope}/ShapeShifter.h | 10 +++++----- 6 files changed, 31 insertions(+), 29 deletions(-) rename src/{Akela-ShapeShifter.h => Kaleidoscope-ShapeShifter.h} (85%) rename src/{Akela => Kaleidoscope}/ShapeShifter.cpp (92%) rename src/{Akela => Kaleidoscope}/ShapeShifter.h (84%) diff --git a/README.md b/README.md index 76d4e01c..ac41c29a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Akela-ShapeShifter +# Kaleidoscope-ShapeShifter ![status][st:stable] @@ -22,9 +22,10 @@ To use the plugin, one needs to include the header, create a dictionary, and configure the provided `ShapeShifter` object to use the dictionary: ```c++ -#include +#include +#include -static const Akela::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = { +static const KaleidoscopePlugins::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = { {Key_1, Key_4}, {Key_4, Key_1}, {Key_NoKey, Key_NoKey}, @@ -33,8 +34,8 @@ static const Akela::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = void setup () { ShapeShifter.configure (shapeShiftDictionary); - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&ShapeShifter, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&ShapeShifter, NULL); } ``` @@ -49,9 +50,9 @@ The plugin provides the `ShapeShifter` object, with the following methods: ### `.configure(dictionary)` > Tells `ShapeShifter` to use the specified dictionary. The dictionary is an -> array of `Akela::ShapeShifter::dictionary_t` elements, which is just a very -> verbose way of saying that its a pair of keys. The first one is the one to -> replace, and the other is to replace it with. +> array of `KaleidoscopePlugins::ShapeShifter::dictionary_t` elements, which is +> just a very verbose way of saying that its a pair of keys. The first one is +> the one to replace, and the other is to replace it with. > > Be aware that the replacement key will be pressed with `Shift` held, so do > keep that in mind! @@ -72,4 +73,4 @@ The plugin provides the `ShapeShifter` 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-ShapeShifter/blob/master/examples/ShapeShifter/ShapeShifter.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-ShapeShifter/blob/master/examples/ShapeShifter/ShapeShifter.ino diff --git a/examples/ShapeShifter/ShapeShifter.ino b/examples/ShapeShifter/ShapeShifter.ino index 58ea39e9..1c008f92 100644 --- a/examples/ShapeShifter/ShapeShifter.ino +++ b/examples/ShapeShifter/ShapeShifter.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice * Copyright (C) 2016, 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 @@ -39,7 +40,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { ), }; -static const Akela::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = { +static const KaleidoscopePlugins::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = { {Key_1, Key_2}, {Key_2, Key_1}, {Key_NoKey, Key_NoKey}, @@ -48,10 +49,10 @@ static const Akela::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = void setup () { ShapeShifter.configure (shapeShiftDictionary); - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&ShapeShifter, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&ShapeShifter, NULL); } void loop () { - Keyboardio.loop (); + Kaleidoscope.loop (); } diff --git a/library.properties b/library.properties index 6d78fcde..8282b98d 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Akela-ShapeShifter +name=Kaleidoscope-ShapeShifter version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy +maintainer=Gergely Nagy sentence=Change the shifted symbols on any key of your choice. paragraph=Make it possible to send a different keycode when a key is being shifted. category=Communication -url=https://github.com/keyboardio/Akela-ShapeShifter +url=https://github.com/keyboardio/Kaleidoscope-ShapeShifter architectures=avr dot_a_linkage=true diff --git a/src/Akela-ShapeShifter.h b/src/Kaleidoscope-ShapeShifter.h similarity index 85% rename from src/Akela-ShapeShifter.h rename to src/Kaleidoscope-ShapeShifter.h index 9d5b8687..12c0521a 100644 --- a/src/Akela-ShapeShifter.h +++ b/src/Kaleidoscope-ShapeShifter.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice * Copyright (C) 2016, 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/ShapeShifter.cpp b/src/Kaleidoscope/ShapeShifter.cpp similarity index 92% rename from src/Akela/ShapeShifter.cpp rename to src/Kaleidoscope/ShapeShifter.cpp index 7e542d39..53b14a7a 100644 --- a/src/Akela/ShapeShifter.cpp +++ b/src/Kaleidoscope/ShapeShifter.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,9 +16,9 @@ * along with this program. If not, see . */ -#include +#include -namespace Akela { +namespace KaleidoscopePlugins { const ShapeShifter::dictionary_t *ShapeShifter::dictionary = NULL; bool ShapeShifter::modActive; @@ -99,4 +99,4 @@ namespace Akela { }; -Akela::ShapeShifter ShapeShifter; +KaleidoscopePlugins::ShapeShifter ShapeShifter; diff --git a/src/Akela/ShapeShifter.h b/src/Kaleidoscope/ShapeShifter.h similarity index 84% rename from src/Akela/ShapeShifter.h rename to src/Kaleidoscope/ShapeShifter.h index 41280740..70bef330 100644 --- a/src/Akela/ShapeShifter.h +++ b/src/Kaleidoscope/ShapeShifter.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice * Copyright (C) 2016, 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 ShapeShifter : public KeyboardioPlugin { +namespace KaleidoscopePlugins { + class ShapeShifter : public KaleidoscopePlugin { public: typedef struct { Key original, replacement; @@ -48,4 +48,4 @@ namespace Akela { }; }; -extern Akela::ShapeShifter ShapeShifter; +extern KaleidoscopePlugins::ShapeShifter ShapeShifter; From 70c106fc7d1a92998ce80e7cc9ac62d3c8fc14b0 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Feb 2017 11:28:27 +0100 Subject: [PATCH 07/32] 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 ac41c29a..f9cb1d37 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # Kaleidoscope-ShapeShifter -![status][st:stable] +![status][st:stable] [![Build Status][travis:image]][travis:status] + + [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-ShapeShifter.svg?branch=master + [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-ShapeShifter [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 55f57bdcfe2dc19e38013ca7aff00b7ff68f7195 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Tue, 7 Mar 2017 13:58:22 +0100 Subject: [PATCH 08/32] Drop the on/off functions The on/off functions were meant to make it easier to experiment, but there are - and will be - better ways to achieve the same thing. So remove them, lest anyone ends up using them. Fixes #2. Signed-off-by: Gergely Nagy --- README.md | 15 ++------------- examples/ShapeShifter/ShapeShifter.ino | 4 ++-- src/Kaleidoscope/ShapeShifter.cpp | 21 --------------------- src/Kaleidoscope/ShapeShifter.h | 6 ------ 4 files changed, 4 insertions(+), 42 deletions(-) diff --git a/README.md b/README.md index f9cb1d37..4d857a41 100644 --- a/README.md +++ b/README.md @@ -37,8 +37,8 @@ static const KaleidoscopePlugins::ShapeShifter::dictionary_t shapeShiftDictionar void setup () { ShapeShifter.configure (shapeShiftDictionary); - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&ShapeShifter, NULL); + Kaleidoscope.setup (); + USE_PLUGINS (&ShapeShifter); } ``` @@ -60,17 +60,6 @@ The plugin provides the `ShapeShifter` object, with the following methods: > Be aware that the replacement key will be pressed with `Shift` held, so do > keep that in mind! -### `.on()` - -> Turns the shape shifting functionality on. Requires that the plugin -> be [configured](#configuredictionary) first. - -### `.off()` - -> Turns the shape shifting functionality off. In this case, no transformations -> will be applied, and even if symbols appear in the dictionary, 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/ShapeShifter/ShapeShifter.ino b/examples/ShapeShifter/ShapeShifter.ino index 1c008f92..c4e9d00e 100644 --- a/examples/ShapeShifter/ShapeShifter.ino +++ b/examples/ShapeShifter/ShapeShifter.ino @@ -49,8 +49,8 @@ static const KaleidoscopePlugins::ShapeShifter::dictionary_t shapeShiftDictionar void setup () { ShapeShifter.configure (shapeShiftDictionary); - Kaleidoscope.setup (KEYMAP_SIZE); - Kaleidoscope.use (&ShapeShifter, NULL); + Kaleidoscope.setup (); + USE_PLUGINS (&ShapeShifter); } void loop () { diff --git a/src/Kaleidoscope/ShapeShifter.cpp b/src/Kaleidoscope/ShapeShifter.cpp index 53b14a7a..68a0d544 100644 --- a/src/Kaleidoscope/ShapeShifter.cpp +++ b/src/Kaleidoscope/ShapeShifter.cpp @@ -37,27 +37,6 @@ namespace KaleidoscopePlugins { dictionary = (const dictionary_t *)dictionary_; } - void - ShapeShifter::on (void) { - event_handler_hook_replace (this->noOpHook, this->eventHandlerHook); - loop_hook_replace (this->noOpLoopHook, this->loopHook); - } - - void - ShapeShifter::off (void) { - event_handler_hook_replace (this->eventHandlerHook, this->noOpHook); - loop_hook_replace (this->loopHook, this->noOpLoopHook); - } - - Key - ShapeShifter::noOpHook (Key mappedKey, byte row, byte col, uint8_t keyState) { - return mappedKey; - } - - void - ShapeShifter::noOpLoopHook (bool postClear) { - } - void ShapeShifter::loopHook (bool postClear) { if (postClear) diff --git a/src/Kaleidoscope/ShapeShifter.h b/src/Kaleidoscope/ShapeShifter.h index 70bef330..246ce252 100644 --- a/src/Kaleidoscope/ShapeShifter.h +++ b/src/Kaleidoscope/ShapeShifter.h @@ -33,18 +33,12 @@ namespace KaleidoscopePlugins { static void configure (const dictionary_t dictionary[]); - void on (void); - void off (void); - private: static const dictionary_t *dictionary; static bool modActive; 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 998ff7c753f31bbeb2ee3ac8e16794f65b975dc1 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 22 May 2017 12:48:19 -0700 Subject: [PATCH 09/32] Update to new Key definitions --- examples/ShapeShifter/ShapeShifter.ino | 18 +++++++++--------- src/Kaleidoscope/ShapeShifter.cpp | 2 +- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/examples/ShapeShifter/ShapeShifter.ino b/examples/ShapeShifter/ShapeShifter.ino index c4e9d00e..193cd64c 100644 --- a/examples/ShapeShifter/ShapeShifter.ino +++ b/examples/ShapeShifter/ShapeShifter.ino @@ -22,22 +22,22 @@ 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_PageDn, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Esc, + 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_PageDown, Key_Z, Key_X, Key_C, Key_V, Key_B, Key_Escape, - Key_LCtrl, Key_Backspace, Key_LGUI, Key_LShift, - Key_skip, + Key_LeftControl, Key_Backspace, Key_LeftGui, Key_LeftShift, + Key_NoKey, 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 - ), + Key_RightShift, Key_RightAlt, Key_Spacebar, Key_RightControl, + Key_NoKey + ), }; static const KaleidoscopePlugins::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = { diff --git a/src/Kaleidoscope/ShapeShifter.cpp b/src/Kaleidoscope/ShapeShifter.cpp index 68a0d544..372edfb9 100644 --- a/src/Kaleidoscope/ShapeShifter.cpp +++ b/src/Kaleidoscope/ShapeShifter.cpp @@ -42,7 +42,7 @@ namespace KaleidoscopePlugins { if (postClear) return; - modActive = Keyboard.isModifierActive (Key_LShift.keyCode) || + modActive = Keyboard.isModifierActive (Key_LeftShift.keyCode) || Keyboard.isModifierActive (Key_RShift.keyCode); } From 3d00ef664145bee829f3bda8da68c2eaf2f6030d Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 22 May 2017 12:59:17 -0700 Subject: [PATCH 10/32] Missed a modifier name --- src/Kaleidoscope/ShapeShifter.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/ShapeShifter.cpp b/src/Kaleidoscope/ShapeShifter.cpp index 372edfb9..443ce748 100644 --- a/src/Kaleidoscope/ShapeShifter.cpp +++ b/src/Kaleidoscope/ShapeShifter.cpp @@ -43,7 +43,7 @@ namespace KaleidoscopePlugins { return; modActive = Keyboard.isModifierActive (Key_LeftShift.keyCode) || - Keyboard.isModifierActive (Key_RShift.keyCode); + Keyboard.isModifierActive (Key_RightShift.keyCode); } Key From d3b7467c6fa31efd0c7167c9423ed6c7422fa5f7 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 22 May 2017 13:07:46 -0700 Subject: [PATCH 11/32] ShapeShifter doesn't knwo about LEDs --- examples/ShapeShifter/ShapeShifter.ino | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/examples/ShapeShifter/ShapeShifter.ino b/examples/ShapeShifter/ShapeShifter.ino index 193cd64c..09953d42 100644 --- a/examples/ShapeShifter/ShapeShifter.ino +++ b/examples/ShapeShifter/ShapeShifter.ino @@ -19,10 +19,12 @@ #include #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_skip, Key_1, Key_2, Key_3, Key_4, Key_5, Key_skip, 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, @@ -40,6 +42,9 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { ), }; + + + static const KaleidoscopePlugins::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = { {Key_1, Key_2}, {Key_2, Key_1}, From 12481f3f483bdcf53b16e9d2b562d65fa89eafb6 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 23 May 2017 20:15:08 -0700 Subject: [PATCH 12/32] 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 ae6aeec44d42961aadf4522c4cd1716133c785f7 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Fri, 26 May 2017 16:20:23 -0700 Subject: [PATCH 13/32] make astyle --- examples/ShapeShifter/ShapeShifter.ino | 50 +++++++++++++------------- src/Kaleidoscope/ShapeShifter.cpp | 46 ++++++++++++------------ src/Kaleidoscope/ShapeShifter.h | 6 ++-- 3 files changed, 51 insertions(+), 51 deletions(-) diff --git a/examples/ShapeShifter/ShapeShifter.ino b/examples/ShapeShifter/ShapeShifter.ino index 09953d42..32910e11 100644 --- a/examples/ShapeShifter/ShapeShifter.ino +++ b/examples/ShapeShifter/ShapeShifter.ino @@ -22,42 +22,42 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { - [0] = KEYMAP_STACKED - ( - Key_skip, Key_1, Key_2, Key_3, Key_4, Key_5, Key_skip, - 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_NoKey, - - 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_NoKey - ), + [0] = KEYMAP_STACKED + ( + Key_skip, Key_1, Key_2, Key_3, Key_4, Key_5, Key_skip, + 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_NoKey, + + 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_NoKey + ), }; static const KaleidoscopePlugins::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = { - {Key_1, Key_2}, - {Key_2, Key_1}, - {Key_NoKey, Key_NoKey}, + {Key_1, Key_2}, + {Key_2, Key_1}, + {Key_NoKey, Key_NoKey}, }; void setup () { - ShapeShifter.configure (shapeShiftDictionary); + ShapeShifter.configure (shapeShiftDictionary); - Kaleidoscope.setup (); - USE_PLUGINS (&ShapeShifter); + Kaleidoscope.setup (); + USE_PLUGINS (&ShapeShifter); } void loop () { - Kaleidoscope.loop (); + Kaleidoscope.loop (); } diff --git a/src/Kaleidoscope/ShapeShifter.cpp b/src/Kaleidoscope/ShapeShifter.cpp index 443ce748..ee76f8e3 100644 --- a/src/Kaleidoscope/ShapeShifter.cpp +++ b/src/Kaleidoscope/ShapeShifter.cpp @@ -20,61 +20,61 @@ namespace KaleidoscopePlugins { - const ShapeShifter::dictionary_t *ShapeShifter::dictionary = NULL; - bool ShapeShifter::modActive; +const ShapeShifter::dictionary_t *ShapeShifter::dictionary = NULL; +bool ShapeShifter::modActive; - ShapeShifter::ShapeShifter (void) { - } +ShapeShifter::ShapeShifter (void) { +} - void - ShapeShifter::begin (void) { +void +ShapeShifter::begin (void) { event_handler_hook_use (this->eventHandlerHook); loop_hook_use (this->loopHook); - } +} - void - ShapeShifter::configure (const dictionary_t dictionary_[]) { +void +ShapeShifter::configure (const dictionary_t dictionary_[]) { dictionary = (const dictionary_t *)dictionary_; - } +} - void - ShapeShifter::loopHook (bool postClear) { +void +ShapeShifter::loopHook (bool postClear) { if (postClear) - return; + return; modActive = Keyboard.isModifierActive (Key_LeftShift.keyCode) || - Keyboard.isModifierActive (Key_RightShift.keyCode); - } + Keyboard.isModifierActive (Key_RightShift.keyCode); +} - Key - ShapeShifter::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { +Key +ShapeShifter::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { if (!dictionary) - return mappedKey; + return mappedKey; // If Shift is not active, bail out early. if (!modActive) - return mappedKey; + return mappedKey; Key orig, repl; // Try to find the current key in the dictionary uint8_t i = 0; do { - orig.raw = pgm_read_word (&(dictionary[i].original.raw)); - i++; + orig.raw = pgm_read_word (&(dictionary[i].original.raw)); + i++; } while (orig.raw != Key_NoKey.raw && orig.raw != mappedKey.raw); i--; // If not found, bail out. if (orig.raw == Key_NoKey.raw) - return mappedKey; + return mappedKey; repl.raw = pgm_read_word (&(dictionary[i].replacement.raw)); // If found, handle the alternate key instead return repl; - } +} }; diff --git a/src/Kaleidoscope/ShapeShifter.h b/src/Kaleidoscope/ShapeShifter.h index 246ce252..457104a2 100644 --- a/src/Kaleidoscope/ShapeShifter.h +++ b/src/Kaleidoscope/ShapeShifter.h @@ -21,10 +21,10 @@ #include namespace KaleidoscopePlugins { - class ShapeShifter : public KaleidoscopePlugin { +class ShapeShifter : public KaleidoscopePlugin { public: typedef struct { - Key original, replacement; + Key original, replacement; } dictionary_t; ShapeShifter (void); @@ -39,7 +39,7 @@ namespace KaleidoscopePlugins { static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); static void loopHook (bool postClear); - }; +}; }; extern KaleidoscopePlugins::ShapeShifter ShapeShifter; From a0db8238ff74119597d4a4492b268b34ddfee2b8 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Sat, 3 Jun 2017 02:58:00 -0700 Subject: [PATCH 14/32] astyle and lint --- examples/ShapeShifter/ShapeShifter.ino | 54 +++++++++++----------- src/Kaleidoscope/ShapeShifter.cpp | 64 +++++++++++++------------- src/Kaleidoscope/ShapeShifter.h | 24 +++++----- 3 files changed, 71 insertions(+), 71 deletions(-) diff --git a/examples/ShapeShifter/ShapeShifter.ino b/examples/ShapeShifter/ShapeShifter.ino index 32910e11..52c96752 100644 --- a/examples/ShapeShifter/ShapeShifter.ino +++ b/examples/ShapeShifter/ShapeShifter.ino @@ -22,42 +22,42 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { - [0] = KEYMAP_STACKED - ( - Key_skip, Key_1, Key_2, Key_3, Key_4, Key_5, Key_skip, - 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_NoKey, - - 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_NoKey - ), + [0] = KEYMAP_STACKED + ( + Key_skip, Key_1, Key_2, Key_3, Key_4, Key_5, Key_skip, + 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_NoKey, + + 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_NoKey + ), }; static const KaleidoscopePlugins::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = { - {Key_1, Key_2}, - {Key_2, Key_1}, - {Key_NoKey, Key_NoKey}, + {Key_1, Key_2}, + {Key_2, Key_1}, + {Key_NoKey, Key_NoKey}, }; -void setup () { - ShapeShifter.configure (shapeShiftDictionary); +void setup() { + ShapeShifter.configure(shapeShiftDictionary); - Kaleidoscope.setup (); - USE_PLUGINS (&ShapeShifter); + Kaleidoscope.setup(); + USE_PLUGINS(&ShapeShifter); } -void loop () { - Kaleidoscope.loop (); +void loop() { + Kaleidoscope.loop(); } diff --git a/src/Kaleidoscope/ShapeShifter.cpp b/src/Kaleidoscope/ShapeShifter.cpp index ee76f8e3..3a8ac063 100644 --- a/src/Kaleidoscope/ShapeShifter.cpp +++ b/src/Kaleidoscope/ShapeShifter.cpp @@ -23,57 +23,57 @@ namespace KaleidoscopePlugins { const ShapeShifter::dictionary_t *ShapeShifter::dictionary = NULL; bool ShapeShifter::modActive; -ShapeShifter::ShapeShifter (void) { +ShapeShifter::ShapeShifter(void) { } void -ShapeShifter::begin (void) { - event_handler_hook_use (this->eventHandlerHook); - loop_hook_use (this->loopHook); +ShapeShifter::begin(void) { + event_handler_hook_use(this->eventHandlerHook); + loop_hook_use(this->loopHook); } void -ShapeShifter::configure (const dictionary_t dictionary_[]) { - dictionary = (const dictionary_t *)dictionary_; +ShapeShifter::configure(const dictionary_t dictionary_[]) { + dictionary = (const dictionary_t *)dictionary_; } void -ShapeShifter::loopHook (bool postClear) { - if (postClear) - return; +ShapeShifter::loopHook(bool postClear) { + if (postClear) + return; - modActive = Keyboard.isModifierActive (Key_LeftShift.keyCode) || - Keyboard.isModifierActive (Key_RightShift.keyCode); + modActive = Keyboard.isModifierActive(Key_LeftShift.keyCode) || + Keyboard.isModifierActive(Key_RightShift.keyCode); } Key -ShapeShifter::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { - if (!dictionary) - return mappedKey; +ShapeShifter::eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState) { + if (!dictionary) + return mappedKey; - // If Shift is not active, bail out early. - if (!modActive) - return mappedKey; + // If Shift is not active, bail out early. + if (!modActive) + return mappedKey; - Key orig, repl; + Key orig, repl; - // Try to find the current key in the dictionary - uint8_t i = 0; - do { - orig.raw = pgm_read_word (&(dictionary[i].original.raw)); - i++; - } while (orig.raw != Key_NoKey.raw && - orig.raw != mappedKey.raw); - i--; + // Try to find the current key in the dictionary + uint8_t i = 0; + do { + orig.raw = pgm_read_word(&(dictionary[i].original.raw)); + i++; + } while (orig.raw != Key_NoKey.raw && + orig.raw != mappedKey.raw); + i--; - // If not found, bail out. - if (orig.raw == Key_NoKey.raw) - return mappedKey; + // If not found, bail out. + if (orig.raw == Key_NoKey.raw) + return mappedKey; - repl.raw = pgm_read_word (&(dictionary[i].replacement.raw)); + repl.raw = pgm_read_word(&(dictionary[i].replacement.raw)); - // If found, handle the alternate key instead - return repl; + // If found, handle the alternate key instead + return repl; } }; diff --git a/src/Kaleidoscope/ShapeShifter.h b/src/Kaleidoscope/ShapeShifter.h index 457104a2..214d68e0 100644 --- a/src/Kaleidoscope/ShapeShifter.h +++ b/src/Kaleidoscope/ShapeShifter.h @@ -22,23 +22,23 @@ namespace KaleidoscopePlugins { class ShapeShifter : public KaleidoscopePlugin { - public: - typedef struct { - Key original, replacement; - } dictionary_t; + public: + typedef struct { + Key original, replacement; + } dictionary_t; - ShapeShifter (void); + ShapeShifter(void); - virtual void begin (void) final; + void begin(void) final; - static void configure (const dictionary_t dictionary[]); + static void configure(const dictionary_t dictionary[]); - private: - static const dictionary_t *dictionary; - static bool modActive; + private: + static const dictionary_t *dictionary; + static bool modActive; - static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); - static void loopHook (bool postClear); + static Key eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState); + static void loopHook(bool postClear); }; }; From 8d00a83a441f977141c1ab341445509dbed40c7d Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 5 Jun 2017 11:26:24 +0200 Subject: [PATCH 15/32] Kaleidoscope Style Guide conformance Signed-off-by: Gergely Nagy --- README.md | 26 ++++++++-------- examples/ShapeShifter/ShapeShifter.ino | 17 ++++------- src/Kaleidoscope/ShapeShifter.cpp | 41 +++++++++++--------------- src/Kaleidoscope/ShapeShifter.h | 18 +++++------ 4 files changed, 46 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index 4d857a41..72e02ca4 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-ShapeShifter.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-ShapeShifter - [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 `ShapeShifter` is a plugin that makes it considerably easier to change what symbol is input when a key is pressed together with `Shift`. If one wants to @@ -28,17 +28,18 @@ configure the provided `ShapeShifter` object to use the dictionary: #include #include -static const KaleidoscopePlugins::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = { +static const kaleidoscope::ShapeShifter::dictionary_t shape_shift_dictionary[] PROGMEM = { {Key_1, Key_4}, {Key_4, Key_1}, {Key_NoKey, Key_NoKey}, }; -void setup () { - ShapeShifter.configure (shapeShiftDictionary); +void setup() { + USE_PLUGINS(&ShapeShifter); + + Kaleidoscope.setup(); - Kaleidoscope.setup (); - USE_PLUGINS (&ShapeShifter); + ShapeShifter.dictionary = shape_shift_dictionary; } ``` @@ -48,12 +49,13 @@ Key_NoKey}` pair, and **must** reside in `PROGMEM`. ## Plugin methods -The plugin provides the `ShapeShifter` object, with the following methods: +The plugin provides the `ShapeShifter` object, with the following methods and +properties: -### `.configure(dictionary)` +### `.dictionary` -> Tells `ShapeShifter` to use the specified dictionary. The dictionary is an -> array of `KaleidoscopePlugins::ShapeShifter::dictionary_t` elements, which is +> Set this property to the dictionary `ShapeShifter` should use. The dictionary +> is an array of `kaleidoscope::ShapeShifter::dictionary_t` elements, which is > just a very verbose way of saying that its a pair of keys. The first one is > the one to replace, and the other is to replace it with. > diff --git a/examples/ShapeShifter/ShapeShifter.ino b/examples/ShapeShifter/ShapeShifter.ino index 52c96752..bdb60e7c 100644 --- a/examples/ShapeShifter/ShapeShifter.ino +++ b/examples/ShapeShifter/ShapeShifter.ino @@ -19,12 +19,10 @@ #include #include - - const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED ( - Key_skip, Key_1, Key_2, Key_3, Key_4, Key_5, Key_skip, + Key_skip, Key_1, Key_2, Key_3, Key_4, Key_5, Key_skip, 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, @@ -38,24 +36,21 @@ 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_NoKey - ), + Key_NoKey), }; - - - -static const KaleidoscopePlugins::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = { +static const kaleidoscope::ShapeShifter::dictionary_t shape_shift_dictionary[] PROGMEM = { {Key_1, Key_2}, {Key_2, Key_1}, {Key_NoKey, Key_NoKey}, }; void setup() { - ShapeShifter.configure(shapeShiftDictionary); + USE_PLUGINS(&ShapeShifter); Kaleidoscope.setup(); - USE_PLUGINS(&ShapeShifter); + + ShapeShifter.dictionary = shape_shift_dictionary; } void loop() { diff --git a/src/Kaleidoscope/ShapeShifter.cpp b/src/Kaleidoscope/ShapeShifter.cpp index 3a8ac063..63859c04 100644 --- a/src/Kaleidoscope/ShapeShifter.cpp +++ b/src/Kaleidoscope/ShapeShifter.cpp @@ -18,42 +18,35 @@ #include -namespace KaleidoscopePlugins { +namespace kaleidoscope { const ShapeShifter::dictionary_t *ShapeShifter::dictionary = NULL; -bool ShapeShifter::modActive; +bool ShapeShifter::mod_active_; ShapeShifter::ShapeShifter(void) { } -void -ShapeShifter::begin(void) { - event_handler_hook_use(this->eventHandlerHook); - loop_hook_use(this->loopHook); +void ShapeShifter::begin(void) { + event_handler_hook_use(eventHandlerHook); + loop_hook_use(loopHook); } -void -ShapeShifter::configure(const dictionary_t dictionary_[]) { - dictionary = (const dictionary_t *)dictionary_; -} - -void -ShapeShifter::loopHook(bool postClear) { - if (postClear) +void ShapeShifter::loopHook(bool is_post_clear) { + if (is_post_clear) return; - modActive = Keyboard.isModifierActive(Key_LeftShift.keyCode) || - Keyboard.isModifierActive(Key_RightShift.keyCode); + mod_active_ = Keyboard.isModifierActive(Key_LeftShift.keyCode) || + Keyboard.isModifierActive(Key_RightShift.keyCode); } Key -ShapeShifter::eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState) { +ShapeShifter::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state) { if (!dictionary) - return mappedKey; + return mapped_key; // If Shift is not active, bail out early. - if (!modActive) - return mappedKey; + if (!mod_active_) + return mapped_key; Key orig, repl; @@ -63,12 +56,12 @@ ShapeShifter::eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keySta orig.raw = pgm_read_word(&(dictionary[i].original.raw)); i++; } while (orig.raw != Key_NoKey.raw && - orig.raw != mappedKey.raw); + orig.raw != mapped_key.raw); i--; // If not found, bail out. if (orig.raw == Key_NoKey.raw) - return mappedKey; + return mapped_key; repl.raw = pgm_read_word(&(dictionary[i].replacement.raw)); @@ -76,6 +69,6 @@ ShapeShifter::eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keySta return repl; } -}; +} -KaleidoscopePlugins::ShapeShifter ShapeShifter; +kaleidoscope::ShapeShifter ShapeShifter; diff --git a/src/Kaleidoscope/ShapeShifter.h b/src/Kaleidoscope/ShapeShifter.h index 214d68e0..0b53d881 100644 --- a/src/Kaleidoscope/ShapeShifter.h +++ b/src/Kaleidoscope/ShapeShifter.h @@ -20,7 +20,8 @@ #include -namespace KaleidoscopePlugins { +namespace kaleidoscope { + class ShapeShifter : public KaleidoscopePlugin { public: typedef struct { @@ -31,15 +32,14 @@ class ShapeShifter : public KaleidoscopePlugin { void begin(void) final; - static void configure(const dictionary_t dictionary[]); - - private: static const dictionary_t *dictionary; - static bool modActive; + private: + static bool mod_active_; - static Key eventHandlerHook(Key mappedKey, byte row, byte col, uint8_t keyState); - static void loopHook(bool postClear); -}; + static Key eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state); + static void loopHook(bool is_post_clear); }; -extern KaleidoscopePlugins::ShapeShifter ShapeShifter; +} + +extern kaleidoscope::ShapeShifter ShapeShifter; From a38f033e2b30b4369c89d50dbd96babb08433055 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 25 Jul 2017 14:47:30 -0700 Subject: [PATCH 16/32] port to hid facade --- src/Kaleidoscope/ShapeShifter.cpp | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/Kaleidoscope/ShapeShifter.cpp b/src/Kaleidoscope/ShapeShifter.cpp index 63859c04..e2fe3dc8 100644 --- a/src/Kaleidoscope/ShapeShifter.cpp +++ b/src/Kaleidoscope/ShapeShifter.cpp @@ -17,6 +17,7 @@ */ #include +#include namespace kaleidoscope { @@ -35,8 +36,8 @@ void ShapeShifter::loopHook(bool is_post_clear) { if (is_post_clear) return; - mod_active_ = Keyboard.isModifierActive(Key_LeftShift.keyCode) || - Keyboard.isModifierActive(Key_RightShift.keyCode); + mod_active_ = hid::isModifierKeyActive(Key_LeftShift) || + hid::isModifierKeyActive(Key_RightShift); } Key From 635e67fa73a0a5e2dfcedae23a7a172cbba5de05 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 25 Jul 2017 15:52:18 -0700 Subject: [PATCH 17/32] 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 62c1672bf3e2f1d66100c69b3989f30d0d1ca76c Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Thu, 17 Aug 2017 12:36:43 +0200 Subject: [PATCH 18/32] Stop using deprecated interfaces Use `Kaleidoscope.use`, `Kaleidoscope.useEventHandlerHook`, and `Kaleidoscope.useLoopHook` instead of the deprecated `USE_PLUGINS`, `event_handler_hook_use`, and `loop_hook_use` interfaces. Signed-off-by: Gergely Nagy --- README.md | 4 ++-- examples/ShapeShifter/ShapeShifter.ino | 2 +- src/Kaleidoscope/ShapeShifter.cpp | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 72e02ca4..99714885 100644 --- a/README.md +++ b/README.md @@ -35,10 +35,10 @@ static const kaleidoscope::ShapeShifter::dictionary_t shape_shift_dictionary[] P }; void setup() { - USE_PLUGINS(&ShapeShifter); + Kaleidoscope.use(&ShapeShifter); Kaleidoscope.setup(); - + ShapeShifter.dictionary = shape_shift_dictionary; } ``` diff --git a/examples/ShapeShifter/ShapeShifter.ino b/examples/ShapeShifter/ShapeShifter.ino index bdb60e7c..8e8a12b1 100644 --- a/examples/ShapeShifter/ShapeShifter.ino +++ b/examples/ShapeShifter/ShapeShifter.ino @@ -46,7 +46,7 @@ static const kaleidoscope::ShapeShifter::dictionary_t shape_shift_dictionary[] P }; void setup() { - USE_PLUGINS(&ShapeShifter); + Kaleidoscope.use(&ShapeShifter); Kaleidoscope.setup(); diff --git a/src/Kaleidoscope/ShapeShifter.cpp b/src/Kaleidoscope/ShapeShifter.cpp index e2fe3dc8..6fedcc15 100644 --- a/src/Kaleidoscope/ShapeShifter.cpp +++ b/src/Kaleidoscope/ShapeShifter.cpp @@ -28,8 +28,8 @@ ShapeShifter::ShapeShifter(void) { } void ShapeShifter::begin(void) { - event_handler_hook_use(eventHandlerHook); - loop_hook_use(loopHook); + Kaleidoscope.useEventHandlerHook(eventHandlerHook); + Kaleidoscope.useLoopHook(loopHook); } void ShapeShifter::loopHook(bool is_post_clear) { From a6ffae6a3cab46d9b406ce5b59e3e213e757b0d2 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Mon, 21 Aug 2017 22:25:12 -0700 Subject: [PATCH 19/32] 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 564955195577c4a1598ad94be97bc5eeca26ec15 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 13 May 2018 10:42:28 +0200 Subject: [PATCH 20/32] Updated to use the new plugin APIs Signed-off-by: Gergely Nagy --- README.md | 4 +-- examples/ShapeShifter/ShapeShifter.ino | 10 +++--- src/Kaleidoscope/ShapeShifter.cpp | 47 ++++++++++++++++---------- src/Kaleidoscope/ShapeShifter.h | 18 ++++++---- 4 files changed, 49 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 99714885..6f3b3fe5 100644 --- a/README.md +++ b/README.md @@ -34,9 +34,9 @@ static const kaleidoscope::ShapeShifter::dictionary_t shape_shift_dictionary[] P {Key_NoKey, Key_NoKey}, }; -void setup() { - Kaleidoscope.use(&ShapeShifter); +KALEIDOSCOPE_INIT_PLUGINS(ShapeShifter); +void setup() { Kaleidoscope.setup(); ShapeShifter.dictionary = shape_shift_dictionary; diff --git a/examples/ShapeShifter/ShapeShifter.ino b/examples/ShapeShifter/ShapeShifter.ino index 8e8a12b1..5cb1278f 100644 --- a/examples/ShapeShifter/ShapeShifter.ino +++ b/examples/ShapeShifter/ShapeShifter.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice - * Copyright (C) 2016, 2017 Gergely Nagy + * Copyright (C) 2016, 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 ( @@ -32,12 +33,13 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { 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_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_NoKey), }; +// *INDENT-ON* static const kaleidoscope::ShapeShifter::dictionary_t shape_shift_dictionary[] PROGMEM = { {Key_1, Key_2}, @@ -45,9 +47,9 @@ static const kaleidoscope::ShapeShifter::dictionary_t shape_shift_dictionary[] P {Key_NoKey, Key_NoKey}, }; -void setup() { - Kaleidoscope.use(&ShapeShifter); +KALEIDOSCOPE_INIT_PLUGINS(ShapeShifter); +void setup() { Kaleidoscope.setup(); ShapeShifter.dictionary = shape_shift_dictionary; diff --git a/src/Kaleidoscope/ShapeShifter.cpp b/src/Kaleidoscope/ShapeShifter.cpp index 6fedcc15..2aa1f534 100644 --- a/src/Kaleidoscope/ShapeShifter.cpp +++ b/src/Kaleidoscope/ShapeShifter.cpp @@ -24,30 +24,19 @@ namespace kaleidoscope { const ShapeShifter::dictionary_t *ShapeShifter::dictionary = NULL; bool ShapeShifter::mod_active_; -ShapeShifter::ShapeShifter(void) { -} - -void ShapeShifter::begin(void) { - Kaleidoscope.useEventHandlerHook(eventHandlerHook); - Kaleidoscope.useLoopHook(loopHook); -} - -void ShapeShifter::loopHook(bool is_post_clear) { - if (is_post_clear) - return; - +EventHandlerResult ShapeShifter::beforeReportingState() { mod_active_ = hid::isModifierKeyActive(Key_LeftShift) || hid::isModifierKeyActive(Key_RightShift); + return EventHandlerResult::OK; } -Key -ShapeShifter::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state) { +EventHandlerResult ShapeShifter::onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t key_state) { if (!dictionary) - return mapped_key; + return EventHandlerResult::OK; // If Shift is not active, bail out early. if (!mod_active_) - return mapped_key; + return EventHandlerResult::OK; Key orig, repl; @@ -62,13 +51,35 @@ ShapeShifter::eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_s // If not found, bail out. if (orig.raw == Key_NoKey.raw) - return mapped_key; + return EventHandlerResult::OK; repl.raw = pgm_read_word(&(dictionary[i].replacement.raw)); // If found, handle the alternate key instead - return repl; + mapped_key = repl; + return EventHandlerResult::OK; +} + +// Legacy V1 API +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API +void ShapeShifter::begin() { + Kaleidoscope.useEventHandlerHook(legacyEventHandler); + Kaleidoscope.useLoopHook(legacyLoopHook); +} + +Key ShapeShifter::legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state) { + EventHandlerResult r = ::ShapeShifter.onKeyswitchEvent(mapped_key, row, col, key_state); + if (r == EventHandlerResult::OK) + return mapped_key; + return Key_NoKey; +} + +void ShapeShifter::legacyLoopHook(bool is_post_clear) { + if (is_post_clear) + return; + ::ShapeShifter.beforeReportingState(); } +#endif } diff --git a/src/Kaleidoscope/ShapeShifter.h b/src/Kaleidoscope/ShapeShifter.h index 0b53d881..4bb9d0a4 100644 --- a/src/Kaleidoscope/ShapeShifter.h +++ b/src/Kaleidoscope/ShapeShifter.h @@ -28,16 +28,22 @@ class ShapeShifter : public KaleidoscopePlugin { Key original, replacement; } dictionary_t; - ShapeShifter(void); - - void begin(void) final; + ShapeShifter(void) {} static const dictionary_t *dictionary; + + EventHandlerResult onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t key_state); + EventHandlerResult beforeReportingState(); + +#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API + protected: + void begin(); + static Key legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state); + static void legacyLoopHook(bool is_post_clear); +#endif + private: static bool mod_active_; - - static Key eventHandlerHook(Key mapped_key, byte row, byte col, uint8_t key_state); - static void loopHook(bool is_post_clear); }; } From c489f6702f5d5515ba3678c98f03d9adee37651a Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 17 Jun 2018 11:22:45 +0200 Subject: [PATCH 21/32] 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/ShapeShifter.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/Kaleidoscope/ShapeShifter.h b/src/Kaleidoscope/ShapeShifter.h index 4bb9d0a4..ff90afda 100644 --- a/src/Kaleidoscope/ShapeShifter.h +++ b/src/Kaleidoscope/ShapeShifter.h @@ -36,6 +36,10 @@ class ShapeShifter : public KaleidoscopePlugin { EventHandlerResult beforeReportingState(); #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 d8bfa75cdf767b88d71f328ded82ca59f5ffc3cb Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Mon, 20 Aug 2018 23:25:38 +0200 Subject: [PATCH 22/32] Drop the V1 plugin API compatibility code Signed-off-by: Gergely Nagy --- src/Kaleidoscope/ShapeShifter.cpp | 21 --------------------- src/Kaleidoscope/ShapeShifter.h | 11 ----------- 2 files changed, 32 deletions(-) diff --git a/src/Kaleidoscope/ShapeShifter.cpp b/src/Kaleidoscope/ShapeShifter.cpp index 2aa1f534..d78f8cce 100644 --- a/src/Kaleidoscope/ShapeShifter.cpp +++ b/src/Kaleidoscope/ShapeShifter.cpp @@ -60,27 +60,6 @@ EventHandlerResult ShapeShifter::onKeyswitchEvent(Key &mapped_key, byte row, byt return EventHandlerResult::OK; } -// Legacy V1 API -#if KALEIDOSCOPE_ENABLE_V1_PLUGIN_API -void ShapeShifter::begin() { - Kaleidoscope.useEventHandlerHook(legacyEventHandler); - Kaleidoscope.useLoopHook(legacyLoopHook); -} - -Key ShapeShifter::legacyEventHandler(Key mapped_key, byte row, byte col, uint8_t key_state) { - EventHandlerResult r = ::ShapeShifter.onKeyswitchEvent(mapped_key, row, col, key_state); - if (r == EventHandlerResult::OK) - return mapped_key; - return Key_NoKey; -} - -void ShapeShifter::legacyLoopHook(bool is_post_clear) { - if (is_post_clear) - return; - ::ShapeShifter.beforeReportingState(); -} -#endif - } kaleidoscope::ShapeShifter ShapeShifter; diff --git a/src/Kaleidoscope/ShapeShifter.h b/src/Kaleidoscope/ShapeShifter.h index ff90afda..ffe3f4c2 100644 --- a/src/Kaleidoscope/ShapeShifter.h +++ b/src/Kaleidoscope/ShapeShifter.h @@ -35,17 +35,6 @@ class ShapeShifter : public KaleidoscopePlugin { EventHandlerResult onKeyswitchEvent(Key &mapped_key, byte row, byte col, uint8_t key_state); EventHandlerResult beforeReportingState(); -#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); - static void legacyLoopHook(bool is_post_clear); -#endif - private: static bool mod_active_; }; From 362ce3522a1c2a0b22e536a26254b44847d0ffc1 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:44:35 +0200 Subject: [PATCH 23/32] Fix a hidden dependency on the old V1 plugin API ShapeShifter 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/ShapeShifter.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Kaleidoscope/ShapeShifter.h b/src/Kaleidoscope/ShapeShifter.h index ffe3f4c2..e125e9d2 100644 --- a/src/Kaleidoscope/ShapeShifter.h +++ b/src/Kaleidoscope/ShapeShifter.h @@ -22,7 +22,7 @@ namespace kaleidoscope { -class ShapeShifter : public KaleidoscopePlugin { +class ShapeShifter : public kaleidoscope::Plugin { public: typedef struct { Key original, replacement; From 3886caea3a70c5dea51f4b65d816bc941aeffb53 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:17:25 +0200 Subject: [PATCH 24/32] Relicense under the GPLv3 (only) Signed-off-by: Gergely Nagy --- examples/ShapeShifter/ShapeShifter.ino | 19 +++++++++---------- src/Kaleidoscope-ShapeShifter.h | 19 +++++++++---------- src/Kaleidoscope/ShapeShifter.cpp | 19 +++++++++---------- src/Kaleidoscope/ShapeShifter.h | 19 +++++++++---------- 4 files changed, 36 insertions(+), 40 deletions(-) diff --git a/examples/ShapeShifter/ShapeShifter.ino b/examples/ShapeShifter/ShapeShifter.ino index 5cb1278f..7862cbb8 100644 --- a/examples/ShapeShifter/ShapeShifter.ino +++ b/examples/ShapeShifter/ShapeShifter.ino @@ -2,18 +2,17 @@ * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice * Copyright (C) 2016, 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-ShapeShifter.h b/src/Kaleidoscope-ShapeShifter.h index 12c0521a..0845460d 100644 --- a/src/Kaleidoscope-ShapeShifter.h +++ b/src/Kaleidoscope-ShapeShifter.h @@ -2,18 +2,17 @@ * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice * Copyright (C) 2016, 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/ShapeShifter.cpp b/src/Kaleidoscope/ShapeShifter.cpp index d78f8cce..ba8435b4 100644 --- a/src/Kaleidoscope/ShapeShifter.cpp +++ b/src/Kaleidoscope/ShapeShifter.cpp @@ -2,18 +2,17 @@ * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice * Copyright (C) 2016, 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 . */ #include diff --git a/src/Kaleidoscope/ShapeShifter.h b/src/Kaleidoscope/ShapeShifter.h index e125e9d2..29bf60e5 100644 --- a/src/Kaleidoscope/ShapeShifter.h +++ b/src/Kaleidoscope/ShapeShifter.h @@ -2,18 +2,17 @@ * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice * Copyright (C) 2016, 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 From 1d903b35721f1064e981bfef14917beb98911c46 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:17:27 +0200 Subject: [PATCH 25/32] 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/ShapeShifter/ShapeShifter.ino | 2 +- library.properties | 2 +- src/Kaleidoscope-ShapeShifter.h | 2 +- src/Kaleidoscope/ShapeShifter.cpp | 2 +- src/Kaleidoscope/ShapeShifter.h | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/examples/ShapeShifter/ShapeShifter.ino b/examples/ShapeShifter/ShapeShifter.ino index 7862cbb8..1af4c553 100644 --- a/examples/ShapeShifter/ShapeShifter.ino +++ b/examples/ShapeShifter/ShapeShifter.ino @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice - * Copyright (C) 2016, 2017, 2018 Gergely Nagy + * Copyright (C) 2016, 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 8282b98d..15ee123d 100644 --- a/library.properties +++ b/library.properties @@ -1,7 +1,7 @@ name=Kaleidoscope-ShapeShifter version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy +maintainer=Gergely Nagy sentence=Change the shifted symbols on any key of your choice. paragraph=Make it possible to send a different keycode when a key is being shifted. category=Communication diff --git a/src/Kaleidoscope-ShapeShifter.h b/src/Kaleidoscope-ShapeShifter.h index 0845460d..588933ba 100644 --- a/src/Kaleidoscope-ShapeShifter.h +++ b/src/Kaleidoscope-ShapeShifter.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice - * Copyright (C) 2016, 2017 Gergely Nagy + * Copyright (C) 2016, 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/ShapeShifter.cpp b/src/Kaleidoscope/ShapeShifter.cpp index ba8435b4..3202dfe4 100644 --- a/src/Kaleidoscope/ShapeShifter.cpp +++ b/src/Kaleidoscope/ShapeShifter.cpp @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice - * Copyright (C) 2016, 2017 Gergely Nagy + * Copyright (C) 2016, 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/ShapeShifter.h b/src/Kaleidoscope/ShapeShifter.h index 29bf60e5..344a741e 100644 --- a/src/Kaleidoscope/ShapeShifter.h +++ b/src/Kaleidoscope/ShapeShifter.h @@ -1,6 +1,6 @@ /* -*- mode: c++ -*- * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice - * Copyright (C) 2016, 2017 Gergely Nagy + * Copyright (C) 2016, 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 From 806e331aecb75324321b81836038c421db7d36e2 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 22 Aug 2018 12:17:29 +0200 Subject: [PATCH 26/32] 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 4ee69aeab2630451c2761860e6b6afeed1e13b8b Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:24:02 -0700 Subject: [PATCH 27/32] 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 36702b34485446cc967bf3f9ae65de6d5b4918d7 Mon Sep 17 00:00:00 2001 From: Jesse Vincent Date: Tue, 4 Sep 2018 18:42:30 -0700 Subject: [PATCH 28/32] 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 104247fb24c32b6d56a3e21d52d6a5b5c06bd2a6 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 10 Oct 2018 06:55:16 +0200 Subject: [PATCH 29/32] 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 6f3b3fe5..cbc318e8 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,10 @@ # Kaleidoscope-ShapeShifter -![status][st:stable] [![Build Status][travis:image]][travis:status] +[![Build Status][travis:image]][travis:status] [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-ShapeShifter.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-ShapeShifter - [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 - `ShapeShifter` is a plugin that makes it considerably easier to change what symbol is input when a key is pressed together with `Shift`. If one wants to rearrange the symbols on the number row for example, without modifying the From f478112e2dbc98e258add54514b47e4cfac68973 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 15:22:14 +0200 Subject: [PATCH 30/32] Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/ShapeShifter.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 | 60 +--------------- doc/plugin/ShapeShifter.md | 69 +++++++++++++++++++ examples/ShapeShifter/ShapeShifter.ino | 2 +- src/Kaleidoscope-ShapeShifter.h | 2 +- .../plugin}/ShapeShifter.cpp | 4 +- .../plugin}/ShapeShifter.h | 6 +- 6 files changed, 80 insertions(+), 63 deletions(-) create mode 100644 doc/plugin/ShapeShifter.md rename src/{Kaleidoscope => kaleidoscope/plugin}/ShapeShifter.cpp (96%) rename src/{Kaleidoscope => kaleidoscope/plugin}/ShapeShifter.h (88%) diff --git a/README.md b/README.md index cbc318e8..a7cf2fc6 100644 --- a/README.md +++ b/README.md @@ -5,62 +5,4 @@ [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-ShapeShifter.svg?branch=master [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-ShapeShifter -`ShapeShifter` is a plugin that makes it considerably easier to change what -symbol is input when a key is pressed together with `Shift`. If one wants to -rearrange the symbols on the number row for example, without modifying the -layout on the operating system side, this plugin is where one can turn to. - -What it does, is very simple: if any key in its dictionary is found pressed -while `Shift` is held, it will press another key instead of the one triggering -the event. For example, if it sees `Shift + 1` pressed together, which normally -results in a `!`, it will press `4` instead of `1`, inputting `$`. - -## Using the plugin - -To use the plugin, one needs to include the header, create a dictionary, and -configure the provided `ShapeShifter` object to use the dictionary: - -```c++ -#include -#include - -static const kaleidoscope::ShapeShifter::dictionary_t shape_shift_dictionary[] PROGMEM = { - {Key_1, Key_4}, - {Key_4, Key_1}, - {Key_NoKey, Key_NoKey}, -}; - -KALEIDOSCOPE_INIT_PLUGINS(ShapeShifter); - -void setup() { - Kaleidoscope.setup(); - - ShapeShifter.dictionary = shape_shift_dictionary; -} -``` - -The dictionary is made up of `Key` pairs: the first one is to replace, the -second is the replacement. The dictionary must be closed with a `{Key_NoKey, -Key_NoKey}` pair, and **must** reside in `PROGMEM`. - -## Plugin methods - -The plugin provides the `ShapeShifter` object, with the following methods and -properties: - -### `.dictionary` - -> Set this property to the dictionary `ShapeShifter` should use. The dictionary -> is an array of `kaleidoscope::ShapeShifter::dictionary_t` elements, which is -> just a very verbose way of saying that its a pair of keys. The first one is -> the one to replace, and the other is to replace it with. -> -> Be aware that the replacement key will be pressed with `Shift` held, so do -> keep that in mind! - -## 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-ShapeShifter/blob/master/examples/ShapeShifter/ShapeShifter.ino +See [doc/plugin/ShapeShifter.md](doc/plugin/ShapeShifter.md) for documentation. diff --git a/doc/plugin/ShapeShifter.md b/doc/plugin/ShapeShifter.md new file mode 100644 index 00000000..f1f324dc --- /dev/null +++ b/doc/plugin/ShapeShifter.md @@ -0,0 +1,69 @@ +# Kaleidoscope-ShapeShifter + +`ShapeShifter` is a plugin that makes it considerably easier to change what +symbol is input when a key is pressed together with `Shift`. If one wants to +rearrange the symbols on the number row for example, without modifying the +layout on the operating system side, this plugin is where one can turn to. + +What it does, is very simple: if any key in its dictionary is found pressed +while `Shift` is held, it will press another key instead of the one triggering +the event. For example, if it sees `Shift + 1` pressed together, which normally +results in a `!`, it will press `4` instead of `1`, inputting `$`. + +## Using the plugin + +To use the plugin, one needs to include the header, create a dictionary, and +configure the provided `ShapeShifter` object to use the dictionary: + +```c++ +#include +#include + +static const kaleidoscope::plugin::ShapeShifter::dictionary_t shape_shift_dictionary[] PROGMEM = { + {Key_1, Key_4}, + {Key_4, Key_1}, + {Key_NoKey, Key_NoKey}, +}; + +KALEIDOSCOPE_INIT_PLUGINS(ShapeShifter); + +void setup() { + Kaleidoscope.setup(); + + ShapeShifter.dictionary = shape_shift_dictionary; +} +``` + +The dictionary is made up of `Key` pairs: the first one is to replace, the +second is the replacement. The dictionary must be closed with a `{Key_NoKey, +Key_NoKey}` pair, and **must** reside in `PROGMEM`. + +## Plugin methods + +The plugin provides the `ShapeShifter` object, with the following methods and +properties: + +### `.dictionary` + +> Set this property to the dictionary `ShapeShifter` should use. The dictionary +> is an array of `kaleidoscope::ShapeShifter::dictionary_t` elements, which is +> just a very verbose way of saying that its a pair of keys. The first one is +> the one to replace, and the other is to replace it with. +> +> Be aware that the replacement key will be pressed with `Shift` held, so do +> keep that in mind! + +## 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-ShapeShifter/blob/master/examples/ShapeShifter/ShapeShifter.ino + +## Upgrading + +Previous versions of `ShapeShifter` used +`kaleidoscope::ShapeShifter::dictionary_t` as a type for defining the +dictionary. In newer versions, this is +`kaleidoscope::plugin::ShapeShifter::dictionary_t`. The old name still works, +but will be removed by 2019-01-14. diff --git a/examples/ShapeShifter/ShapeShifter.ino b/examples/ShapeShifter/ShapeShifter.ino index 1af4c553..14631dee 100644 --- a/examples/ShapeShifter/ShapeShifter.ino +++ b/examples/ShapeShifter/ShapeShifter.ino @@ -40,7 +40,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { }; // *INDENT-ON* -static const kaleidoscope::ShapeShifter::dictionary_t shape_shift_dictionary[] PROGMEM = { +static const kaleidoscope::plugin::ShapeShifter::dictionary_t shape_shift_dictionary[] PROGMEM = { {Key_1, Key_2}, {Key_2, Key_1}, {Key_NoKey, Key_NoKey}, diff --git a/src/Kaleidoscope-ShapeShifter.h b/src/Kaleidoscope-ShapeShifter.h index 588933ba..b08d872f 100644 --- a/src/Kaleidoscope-ShapeShifter.h +++ b/src/Kaleidoscope-ShapeShifter.h @@ -17,4 +17,4 @@ #pragma once -#include +#include diff --git a/src/Kaleidoscope/ShapeShifter.cpp b/src/kaleidoscope/plugin/ShapeShifter.cpp similarity index 96% rename from src/Kaleidoscope/ShapeShifter.cpp rename to src/kaleidoscope/plugin/ShapeShifter.cpp index 3202dfe4..f97cefbf 100644 --- a/src/Kaleidoscope/ShapeShifter.cpp +++ b/src/kaleidoscope/plugin/ShapeShifter.cpp @@ -19,6 +19,7 @@ #include namespace kaleidoscope { +namespace plugin { const ShapeShifter::dictionary_t *ShapeShifter::dictionary = NULL; bool ShapeShifter::mod_active_; @@ -59,6 +60,7 @@ EventHandlerResult ShapeShifter::onKeyswitchEvent(Key &mapped_key, byte row, byt return EventHandlerResult::OK; } +} } -kaleidoscope::ShapeShifter ShapeShifter; +kaleidoscope::plugin::ShapeShifter ShapeShifter; diff --git a/src/Kaleidoscope/ShapeShifter.h b/src/kaleidoscope/plugin/ShapeShifter.h similarity index 88% rename from src/Kaleidoscope/ShapeShifter.h rename to src/kaleidoscope/plugin/ShapeShifter.h index 344a741e..59344fb5 100644 --- a/src/Kaleidoscope/ShapeShifter.h +++ b/src/kaleidoscope/plugin/ShapeShifter.h @@ -20,6 +20,7 @@ #include namespace kaleidoscope { +namespace plugin { class ShapeShifter : public kaleidoscope::Plugin { public: @@ -37,7 +38,10 @@ class ShapeShifter : public kaleidoscope::Plugin { private: static bool mod_active_; }; +} +// Backwards compatibility +typedef plugin::ShapeShifter ShapeShifter; } -extern kaleidoscope::ShapeShifter ShapeShifter; +extern kaleidoscope::plugin::ShapeShifter ShapeShifter; From f15e70b6ed1ea63c889b53983941090602ec13ab Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 13 Oct 2018 15:24:17 +0200 Subject: [PATCH 31/32] 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 a7cf2fc6..00000000 --- a/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Kaleidoscope-ShapeShifter - -[![Build Status][travis:image]][travis:status] - - [travis:image]: https://travis-ci.org/keyboardio/Kaleidoscope-ShapeShifter.svg?branch=master - [travis:status]: https://travis-ci.org/keyboardio/Kaleidoscope-ShapeShifter - -See [doc/plugin/ShapeShifter.md](doc/plugin/ShapeShifter.md) for documentation. diff --git a/library.properties b/library.properties deleted file mode 100644 index 15ee123d..00000000 --- a/library.properties +++ /dev/null @@ -1,10 +0,0 @@ -name=Kaleidoscope-ShapeShifter -version=0.0.0 -author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Change the shifted symbols on any key of your choice. -paragraph=Make it possible to send a different keycode when a key is being shifted. -category=Communication -url=https://github.com/keyboardio/Kaleidoscope-ShapeShifter -architectures=avr -dot_a_linkage=true From fa82f9d6489441889ae64d9fac327f04ed067b64 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Wed, 17 Oct 2018 22:39:15 +0200 Subject: [PATCH 32/32] 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/ShapeShifter.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/plugin/ShapeShifter.md b/doc/plugin/ShapeShifter.md index f1f324dc..2dd55c97 100644 --- a/doc/plugin/ShapeShifter.md +++ b/doc/plugin/ShapeShifter.md @@ -58,7 +58,7 @@ properties: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Kaleidoscope-ShapeShifter/blob/master/examples/ShapeShifter/ShapeShifter.ino + [plugin:example]: ../../examples/ShapeShifter/ShapeShifter.ino ## Upgrading