commit 31f2c406254f63cf28b1c6ce2072ab78643c22cc Author: Gergely Nagy Date: Mon Jan 16 15:18:13 2017 +0100 Initial import Lifted out of the monolithic Akela library. Signed-off-by: Gergely Nagy 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..b01c736b --- /dev/null +++ b/README.md @@ -0,0 +1,118 @@ +# Akela-OneShot + +One-shots are a new kind of behaviour for your standard modifier and momentary +layer keys: instead of having to hold them while pressing other keys, they can +be tapped and released, and will remain active until any other key is pressed. +In short, they turn `Shift, A` into `Shift+A`, and `Fn, 1` to `Fn+1`. The main +advantage is that this allows us to place the modifiers and layer keys to +positions that would otherwise be awkward when chording. Nevertheless, they +still act as normal when held, that behaviour is not lost. + +Furthermore, if a one-shot key is tapped two times in quick succession, it +becomes sticky, and remains active until disabled with a third tap. This can be +useful when one needs to input a number of keys with the modifier or layer +active, and still does not wish to hold the key down. + +To make multi-modifier, or multi-layer shortcuts possible, one-shot keys remain +active if another one-shot of the same type is tapped, so `Ctrl, Alt, b` becomes +`Ctrl+Alt+b`, and `L1, L2, c` is turned into `L1+L2+c`. + +## Using the plugin + +There are two major ways in which the plugin can be used: one is to turn +existing modifiers or momentary layer toggles into one-shot keys: + +```c++ +#include + +void setup () { + OneShot.enableAuto (); + + Keyboardio.setup (KEYMAP_SIZE); + Keyboardio.use (&OneShot, NULL); +} +``` + +The other is to explicitly mark keys as one-shot in the keymap: + +```c++ +#include + +// somewhere in the keymap... +OSM(LCtrl), OSL(_FN) + +void setup () { + Keyboardio.setup (KEYMAP_SIZE); + Keyboardio.use (&OneShot, NULL); +} +``` + +## Keymap markup + +There are two macros the plugin provides: + +### `OSM(mod)` + +> A macro that takes a single argument, the name of the modifier: `LCtrl`, +> `LShift`, `LAlt`, `LGUI` or their right-side variant. When marked up with this +> macro, the modifier will act as a one-shot modifier. + +### `OSL(layer)` + +> Takes a layer number as argument, and sets up the key to act as a one-shot +> layer key. +> +> Please note that while `KeyboardioFirmware` supports more, one-shot layers are +> limited to 24 layers only. + +## Plugin methods + +The plugin provides one object, `OneShot`, which implements both one-shot +modifiers and one-shot layer keys. It has the following methods: + +### `.enableAuto()` + +> Automatically turns modifiers and momentary layer switches into their one-shot +> variant. It will only turn keys on the keymap into one-shots: if any macro +> injects a modifier or a momentary layer switch key, those will be left alone, +> as-is. +> +> This **must** be called before any `Keyboardio.use()` call in the `setup()` +> method of your Sketch. + +### `.isActive()` + +> Returns if any one-shot key is in flight. This makes it possible to +> differentiate between having a modifier or layer active, versus having them +> active only until after the next key getting pressed. And this, in turn, is +> useful for macros that need to fiddle with either modifier or layer state: if +> one-shots are not active, they need not restore the original state. + +### `.cancel([withStickies])` + +> The `cancel()` method can be used to cancel any pending one-shot effects, +> useful when one changed their minds, and does not wish to wait for the +> timeout. +> +> The optional `withStickies` argument, if set to `true`, will also cancel +> sticky one-shot effects. If omitted, it defaults to `false`, and not canceling +> stickies. + +### `.on()` + +> Turns the one-shot behaviour on. This method is idempotent, you can call it +> any number of times, at any time. + +### `.off()` + +> The counterpart of the `on()` method, this turns off one-shot behaviour. +> Modifiers will act as normal modifiers, and one-shot layer keys will act as +> momentary layer switchers. As `on()`, this method is idempotent, and can be +> called at any time, from anywhere. + +## 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-OneShot/blob/master/examples/OneShot/OneShot.ino diff --git a/examples/OneShot/OneShot.ino b/examples/OneShot/OneShot.ino new file mode 100644 index 00000000..a81dd013 --- /dev/null +++ b/examples/OneShot/OneShot.ino @@ -0,0 +1,71 @@ +/* -*- 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, + + OSM(LCtrl), Key_Backspace, OSM(LGUI), Key_LShift, + Key_Keymap1_Momentary, + + 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, OSM(RAlt), Key_Space, OSM(RCtrl), + OSL(1) + ), + + [1] = KEYMAP_STACKED + ( + ___, ___, ___, ___, ___, ___, ___, + ___, ___, ___, ___, ___, ___, ___, + ___, ___, ___, ___, ___, ___, + ___, ___, ___, ___, ___, ___, ___, + + ___, ___, ___, ___, + ___, + + ___, ___, ___, ___, ___, ___, ___, + ___, ___, ___, ___, ___, ___, ___, + Key_UpArrow, Key_DnArrow, Key_LArrow, Key_RArrow, ___, ___, + ___, ___, ___, ___, ___, ___, ___, + + ___, ___, ___, ___, + ___ + ), + +}; + +void setup () { + OneShot.enableAuto (); + + Keyboardio.use (&OneShot, NULL); + Keyboardio.setup (KEYMAP_SIZE); +} + +void loop () { + Keyboardio.loop (); +} diff --git a/library.properties b/library.properties new file mode 100644 index 00000000..aef242e1 --- /dev/null +++ b/library.properties @@ -0,0 +1,10 @@ +name=Akela-OneShot +version=0.0.0 +author=Gergely Nagy +maintainer=Gergely Nagy +sentence=One-shot modifiers and layers for Keyboardio boards. +paragraph=Provides a way to use one-shot modifiers and layers. +category=Communication +url=https://github.com/Akela-Plugins/Akela-OneShot +architectures=avr +dot_a_linkage=true diff --git a/src/Akela-OneShot.h b/src/Akela-OneShot.h new file mode 100644 index 00000000..4420a8b6 --- /dev/null +++ b/src/Akela-OneShot.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/OneShot.cpp b/src/Akela/OneShot.cpp new file mode 100644 index 00000000..7cd2596b --- /dev/null +++ b/src/Akela/OneShot.cpp @@ -0,0 +1,287 @@ +/* -*- 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 + +using namespace Akela::Ranges; + +namespace Akela { + // ---- state --------- + + uint8_t OneShot::Timer = 0; + uint8_t OneShot::TimeOut = DEFAULT_TIMEOUT; + uint32_t OneShot::State = 0; + uint32_t OneShot::stickyState = 0; + uint32_t OneShot::pressedState = 0; + Key OneShot::prevKey; + bool OneShot::shouldCancel = false; + bool OneShot::shouldCancelStickies = false; + + // --- helper macros ------ + +#define isOS(key) (key.raw >= OS_FIRST && key.raw <= OS_LAST) +#define isModifier(key) (key.raw >= Key_LCtrl.raw && key.raw <= Key_RGUI.raw) +#define isLayerKey(key) (key.flags & (KEY_FLAGS | SYNTHETIC | SWITCH_TO_KEYMAP) && key.keyCode >= MOMENTARY_OFFSET && key.keyCode <= MOMENTARY_OFFSET + 23) + +#define isOneShot(idx) (bitRead (State, idx)) +#define setOneShot(idx) (bitWrite (State, idx, 1)) +#define clearOneShot(idx) (bitWrite (State, idx, 0)) + +#define isSticky(idx) (bitRead (stickyState, idx)) +#define setSticky(idx) (bitWrite (stickyState, idx, 1)) +#define clearSticky(idx) bitWrite (stickyState, idx, 0) + +#define setPressed(idx) bitWrite(pressedState, idx, 1) +#define clearPressed(idx) bitWrite(pressedState, idx, 0) +#define isPressed(idx) bitRead (pressedState, idx) + +#define isSameAsPrevious(key) (key.raw == prevKey.raw) +#define saveAsPrevious(key) prevKey.raw = key.raw + +#define toNormalMod(key, idx) {key.flags = 0; key.keyCode = Key_LCtrl.keyCode + idx;} +#define toNormalMT(key, idx) { key.raw = Key_NoKey.raw; Layer.on (idx - 8); } +#define hasTimedOut() (Timer >= TimeOut) + + // ----- passthrough ------ + + Key + OneShot::eventHandlerPassthroughHook (Key mappedKey, byte row, byte col, uint8_t keyState) { + if (!isOS (mappedKey)) + return mappedKey; + + uint8_t idx = mappedKey.raw - OS_FIRST; + + if (idx >= 8) { + toNormalMT (mappedKey, idx); + } else { + toNormalMod (mappedKey, idx); + } + + return mappedKey; + } + + void + OneShot::loopNoOpHook (bool postClear) { + } + + // ---- OneShot stuff ---- + + Key + OneShot::eventHandlerAutoHook (Key mappedKey, byte row, byte col, uint8_t keyState) { + // If mappedKey is an injected key, we don't fiddle with those. + if (keyState & INJECTED) + return mappedKey; + + if (!isModifier (mappedKey) && !isLayerKey (mappedKey)) + return mappedKey; + + if (isModifier (mappedKey)) { + uint8_t idx = mappedKey.keyCode - Key_LCtrl.keyCode; + + return (Key){.raw = OSM_FIRST + idx}; + } else { + uint8_t idx = mappedKey.keyCode - MOMENTARY_OFFSET; + + return (Key){.raw = OSL_FIRST + idx}; + } + } + + void + OneShot::injectNormalKey (uint8_t idx, uint8_t keyState) { + Key key; + + if (idx < 8) { + key.flags = Key_LCtrl.flags; + key.keyCode = Key_LCtrl.keyCode + idx; + } else { + key.flags = KEY_FLAGS | SYNTHETIC | SWITCH_TO_KEYMAP; + key.keyCode = MOMENTARY_OFFSET + idx - 8; + } + + handle_key_event (key, 255, 255, keyState | INJECTED); + } + + void + OneShot::activateOneShot (uint8_t idx) { + injectNormalKey (idx, IS_PRESSED); + } + + void + OneShot::cancelOneShot (uint8_t idx) { + clearOneShot (idx); + injectNormalKey (idx, WAS_PRESSED); + } + + Key + OneShot::eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState) { + uint8_t idx; + + if (keyState & INJECTED) + return mappedKey; + + if (!State) { + if (!isOS (mappedKey)) + return mappedKey; + + idx = mappedKey.raw - OS_FIRST; + if (key_toggled_off (keyState)) { + clearPressed (idx); + } else if (key_toggled_on (keyState)){ + Timer = 0; + setPressed (idx); + setOneShot (idx); + saveAsPrevious (mappedKey); + + activateOneShot (idx); + } + + return Key_NoKey; + } + + if (!key_is_pressed (keyState) && !key_was_pressed (keyState)) + return mappedKey; + + if (isOS (mappedKey)) { + idx = mappedKey.raw - OS_FIRST; + + if (isSticky (idx)) { + if (key_toggled_on (keyState)) { // maybe on _off instead? + saveAsPrevious (mappedKey); + clearSticky (idx); + cancelOneShot (idx); + } + } else { + if (key_toggled_off (keyState)) { + clearPressed (idx); + if (hasTimedOut ()) { + cancelOneShot (idx); + } + } + + if (key_toggled_on (keyState)) { + setPressed (idx); + if (isSameAsPrevious (mappedKey)) { + setSticky (idx); + + saveAsPrevious (mappedKey); + } + } + } + + return Key_NoKey; + } + + // ordinary key here, with some event + + if (key_is_pressed (keyState)) { + saveAsPrevious (mappedKey); + } + + if (key_toggled_off (keyState)) { + shouldCancel = true; + } + + return mappedKey; + } + + void + OneShot::loopHook (bool postClear) { + if (!State) + return; + + if (!postClear) { + if (Timer < TimeOut) + Timer++; + + if (hasTimedOut ()) + cancel (); + + for (uint8_t i = 0; i < 32; i++) { + if (shouldCancel) { + if (isSticky (i)) { + if (shouldCancelStickies) { + Timer = 0; + clearSticky (i); + } + } else if (isOneShot (i) && !isPressed (i)) { + Timer = 0; + cancelOneShot (i); + } + } + } + + if (shouldCancel) { + shouldCancel = false; + shouldCancelStickies = false; + } + } else { + for (uint8_t i = 0; i < 8; i++) { + if (isOneShot (i)) { + activateOneShot (i); + } + } + } + } + + // --- glue code --- + + OneShot::OneShot (void) { + } + + void + OneShot::begin (void) { + event_handler_hook_add (eventHandlerHook); + loop_hook_add (loopHook); + } + + bool + OneShot::isActive (void) { + return (State && !hasTimedOut () && !shouldCancel); + } + + void + OneShot::cancel (bool withStickies) { + shouldCancel = true; + shouldCancelStickies = withStickies; + } + + void + OneShot::on (void) { + event_handler_hook_replace (eventHandlerPassthroughHook, eventHandlerHook); + loop_hook_replace (loopNoOpHook, loopHook); + } + + void + OneShot::off (void) { + event_handler_hook_replace (eventHandlerHook, eventHandlerPassthroughHook); + loop_hook_replace (loopHook, loopNoOpHook); + } + + void + OneShot::enableAuto (void) { + event_handler_hook_add (eventHandlerAutoHook); + } + + void + OneShot::inject (Key key, uint8_t keyState) { + eventHandlerHook (key, 255, 255, keyState); + } + +}; + +Akela::OneShot OneShot; diff --git a/src/Akela/OneShot.h b/src/Akela/OneShot.h new file mode 100644 index 00000000..c35881b7 --- /dev/null +++ b/src/Akela/OneShot.h @@ -0,0 +1,65 @@ +/* -*- 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 + +#define OSM(kc) (Key) {.raw = Akela::Ranges::OSM_FIRST + (Key_ ## kc).keyCode - Key_LCtrl.keyCode} +#define OSL(n) (Key) {.raw = Akela::Ranges::OSL_FIRST + n} + +namespace Akela { + class OneShot : public KeyboardioPlugin { + public: + OneShot (void); + + virtual void begin (void) final; + + static void on (void); + static void off (void); + static void enableAuto (void); + static bool isActive (void); + static void cancel (bool withStickies); + static void cancel (void) { cancel (false); }; + + void inject (Key key, uint8_t keyState); + + private: + static uint8_t Timer; + static uint8_t TimeOut; + static uint32_t State; + static uint32_t stickyState; + static uint32_t pressedState; + static Key prevKey; + static bool shouldCancel; + static bool shouldCancelStickies; + + static void injectNormalKey (uint8_t idx, uint8_t keyState); + static void activateOneShot (uint8_t idx); + static void cancelOneShot (uint8_t idx); + + static Key eventHandlerPassthroughHook (Key mappedKey, byte row, byte col, uint8_t keyState); + static void loopNoOpHook (bool postClear); + + static Key eventHandlerAutoHook (Key mappedKey, byte row, byte col, uint8_t keyState); + static Key eventHandlerHook (Key mappedKey, byte row, byte col, uint8_t keyState); + static void loopHook (bool postClear); + }; +}; + +extern Akela::OneShot OneShot;