diff --git a/.github/workflows/gradle.yml b/.github/workflows/gradle.yml new file mode 100644 index 0000000..f9412d0 --- /dev/null +++ b/.github/workflows/gradle.yml @@ -0,0 +1,19 @@ +name: Java CI + +on: [push] + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + - name: Set up JDK 1.8 + uses: actions/setup-java@v1 + with: + java-version: 1.8 + - name: Grant execute permission for gradlew + run: chmod +x gradlew + - name: Build with Gradle + run: ./gradlew build diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..83a87cd --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +# Project exclude paths +/.gradle/ +/build/ +/build/classes/java/main/ +/build/classes/java/test/ +/.idea \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -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 0000000..5f1ac36 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Swiftbird + +Swiftbird is a library created for **Leaf** that allows the creation of what we call +"Property" _(a.k.a Setting)_. +The default implementation wrote by [Shyrogan](https://github.com/Shyrogan) is annotation-based +(see the [Default Implementation](#defaultImplementation) section). + + +## Default implementation + +### Declaring some properties + +Declaring a property works with annotation: +````java +class Configuration { + + @Property(value = "Cheese", description = "It adds cheese, I guess?") + private boolean cheese = false; + +} +```` +will tell Swiftbird to considere the ``cheese`` field as a property. + +### Retrieving your properties + +In order to retrieve your properties, you have to create a ``Swiftbird`` instance using the `create()` method. +Then, you can get the properties in their [PropertyContainer](https://github.com/LeafClient/Swiftbird/blob/master/src/main/java/com/leafclient/swiftbird/PropertyContainer.java) form. + +````java +class Main { + + private final Swiftbird swiftbird = Swiftbird.create(); + + public static void main(String[] args) { + List> properties = swiftbird.in(new Configuration()); + } + +} +```` \ No newline at end of file diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..0b29a44 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,40 @@ +plugins { + java + `maven-publish` +} + +group = "com.leafclient" +version = "1.0.0" +description = "A lightweight yet highly customizable property library for Java" + +repositories { + mavenCentral() + maven("https://jitpack.io") +} + +dependencies { + implementation("com.github.LeafClient", "Struct", "1.0.0") + + testCompile("junit", "junit", "4.12") +} + +configure { + sourceCompatibility = JavaVersion.VERSION_1_8 +} + +val sourcesJar by tasks.registering(Jar::class) { + archiveClassifier.set("sources") + from(sourceSets.main.get().allSource) +} + +artifacts { + archives(sourcesJar) +} + +publishing { + publications { + register("mavenJava", MavenPublication::class) { + from(components["java"]) + } + } +} \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..87b738c Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..44e7c4d --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-5.2.1-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..4af64f9 --- /dev/null +++ b/gradlew @@ -0,0 +1,172 @@ +#!/usr/bin/env sh + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that property. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=$(save "$@") + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then + cd "$(dirname "$0")" +fi + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..6d57edc --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,84 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..c8fc3fc --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,2 @@ +rootProject.name = "Swiftbird" + diff --git a/src/main/java/com/leafclient/swiftbird/PropertyContainer.java b/src/main/java/com/leafclient/swiftbird/PropertyContainer.java new file mode 100644 index 0000000..19e8cc9 --- /dev/null +++ b/src/main/java/com/leafclient/swiftbird/PropertyContainer.java @@ -0,0 +1,26 @@ +package com.leafclient.swiftbird; + +import com.leafclient.struct.structure.Describable; +import com.leafclient.struct.structure.Labelable; + +/** + * Represents a {@link PropertyContainer} to {@link Swiftbird}, it provides some essentials methods for the + * library. + * + * @param Value's type. + */ +public interface PropertyContainer extends Labelable, Describable { + + /** + * @return Returns the current value of this property. + */ + T getValue(); + + /** + * Modifies the value of this property. + * + * @param value New value + */ + void setValue(T value); + +} diff --git a/src/main/java/com/leafclient/swiftbird/Swiftbird.java b/src/main/java/com/leafclient/swiftbird/Swiftbird.java new file mode 100644 index 0000000..08085f6 --- /dev/null +++ b/src/main/java/com/leafclient/swiftbird/Swiftbird.java @@ -0,0 +1,82 @@ +package com.leafclient.swiftbird; + +import com.leafclient.swiftbird.factory.PropertyFactory; +import fr.shyrogan.swiftbird.AnnotatedFieldFactory; + +import java.lang.reflect.Field; +import java.util.*; + +/** + * Swiftbird is a lightweight and intuitive Setting library. + */ +public final class Swiftbird { + + public static PropertyFactory[] DEFAULT_FACTORIES = new PropertyFactory[]{ new AnnotatedFieldFactory()}; + + private final Map>> cache = new WeakHashMap<>(); + private final PropertyFactory[] factories; + + /** + * Creates a new {@link Swiftbird} instance using the specified factories. + * + * @param factories Factories + */ + Swiftbird(PropertyFactory[] factories) { + this.factories = factories; + } + + /** + * @param object Object's instance + * @return Each property in its wrapped form inside of specified object. + */ + public List> in(Object object) { + final List> cached = cache.get(object); + if(cached != null) + return cached; + + final List> result = new ArrayList<>(); + Class objectClass = object.getClass(); + in(objectClass, object, result); + while (objectClass.getSuperclass() != Object.class) { + objectClass = objectClass.getSuperclass(); + in(objectClass, object, result); + } + + cache.put(object, result); + return Collections.unmodifiableList(result); + } + + /** + * Utility method for {@link this#in(Object)} + */ + private void in(Class objectClass, Object object, List> result) { + for(Field field: objectClass.getDeclaredFields()) { + for(PropertyFactory factory: factories) { + if(factory.canApplyTo(field)) { + final PropertyContainer propertyContainer = factory.createSetting(field.getType(), object, field); + if(propertyContainer != null) + result.add(propertyContainer); + } + } + } + } + + /** + * Creates a {@link Swiftbird} instance using the {@link Swiftbird#DEFAULT_FACTORIES}. + * + * @return Swiftbird instance + */ + public static Swiftbird create() { + return new Swiftbird(DEFAULT_FACTORIES); + } + + /** + * Creates a {@link Swiftbird} instance using specified factories. + * + * @return Swiftbird instance + */ + public static Swiftbird create(PropertyFactory... factories) { + return new Swiftbird(factories); + } + +} diff --git a/src/main/java/com/leafclient/swiftbird/factory/PropertyFactory.java b/src/main/java/com/leafclient/swiftbird/factory/PropertyFactory.java new file mode 100644 index 0000000..103d579 --- /dev/null +++ b/src/main/java/com/leafclient/swiftbird/factory/PropertyFactory.java @@ -0,0 +1,33 @@ +package com.leafclient.swiftbird.factory; + +import com.leafclient.swiftbird.PropertyContainer; + +import java.lang.reflect.AnnotatedElement; + +/** + * Swiftbird is focused on being customizable and {@link PropertyFactory} are essential for this purpose. + * + * They are used by the {@link com.leafclient.swiftbird.Swiftbird} instance to get each {@link PropertyContainer} + * forms and instantiate them inside a specified object. + */ +public interface PropertyFactory { + + /** + * Returns if the {@link AnnotatedElement} can be registered by this {@link PropertyFactory}. + * + * @param element AnnotatedElement + * @return True if this factory can be applied to specified element + */ + boolean canApplyTo(AnnotatedElement element); + + /** + * Returns every form of {@link PropertyContainer} instantiated from specified object. + * + * @param valueClass Value's class + * @param object Object's instance + * @param element Annotated element + * @return Listeners + */ + PropertyContainer createSetting(Class valueClass, O object, AnnotatedElement element); + +} diff --git a/src/main/java/fr/shyrogan/swiftbird/AnnotatedFieldFactory.java b/src/main/java/fr/shyrogan/swiftbird/AnnotatedFieldFactory.java new file mode 100644 index 0000000..38d3920 --- /dev/null +++ b/src/main/java/fr/shyrogan/swiftbird/AnnotatedFieldFactory.java @@ -0,0 +1,165 @@ +package fr.shyrogan.swiftbird; + +import com.leafclient.struct.maths.Range; +import com.leafclient.swiftbird.PropertyContainer; +import com.leafclient.swiftbird.factory.PropertyFactory; +import fr.shyrogan.swiftbird.annotation.Property; +import fr.shyrogan.swiftbird.annotation.listener.Listener; +import fr.shyrogan.swiftbird.annotation.number.*; +import fr.shyrogan.swiftbird.setting.FieldPropertyContainer; +import fr.shyrogan.swiftbird.setting.number.NumberPropertyContainer; +import fr.shyrogan.swiftbird.setting.primitive.BooleanPropertyContainer; +import fr.shyrogan.swiftbird.setting.primitive.EnumPropertyContainer; + +import java.lang.invoke.MethodHandle; +import java.lang.invoke.MethodHandles; +import java.lang.reflect.AnnotatedElement; +import java.lang.reflect.Field; +import java.lang.reflect.Method; + +@SuppressWarnings("all") +public final class AnnotatedFieldFactory implements PropertyFactory { + + + private final MethodHandles.Lookup LOOKUP = MethodHandles.lookup(); + + /** + * Checks whether the specified element is a {@link Field}, annotated {@link Property}. + * + * @param element AnnotatedElement + * @return Whether the factory can be used for specified element + */ + @Override + public boolean canApplyTo(AnnotatedElement element) { + return element.isAnnotationPresent(Property.class); + } + + /** + * @inheritDoc + */ + @Override + public PropertyContainer createSetting(Class valueClass, O object, AnnotatedElement element) { + Field field = (Field) element; + field.setAccessible(true); + + try { + MethodHandles.Lookup caller = LOOKUP.in(object.getClass()); + MethodHandle handleGetter = caller.unreflectGetter(field) + .bindTo(object); + MethodHandle handleSetter = caller.unreflectSetter(field) + .bindTo(object); + + // TODO: LambdaMetafactory? + MethodHandle handleListener = null; + + // Value + final Property property = element.getAnnotation(Property.class); + // Listener + final Listener listener = element.getAnnotation(Listener.class); + if(listener != null) { + for(Method method: object.getClass().getDeclaredMethods()) { + if(method.getName().equalsIgnoreCase(listener.value())) { + if(method.getParameterCount() != 2) + throw new RuntimeException("Unable to find listener " + listener.value()); + + handleListener = caller + .unreflect(method) + .bindTo(object); + } + } + } + + // Boolean + if (Boolean.TYPE == valueClass || valueClass == Boolean.class) { + return (PropertyContainer) new BooleanPropertyContainer(property.value(), property.description(), handleGetter, handleSetter, handleListener); + } + else if (Byte.TYPE == valueClass || valueClass == Byte.class) { + final Clamp clamp = element.getAnnotation(Clamp.class); + final Increment increment = element.getAnnotation(Increment.class); + final Range range = clamp == null ? null : Range.of((byte)clamp.minimum(), (byte)clamp.maximum()); + Byte step = null; + if(increment != null) + step = (byte)increment.value(); + else if(range != null) + step = (byte)((range.getMaximum() - range.getMinimum()) / 50); + + return (PropertyContainer) new NumberPropertyContainer<>(property.value(), property.description(), + range, step, handleGetter, handleSetter, handleListener); + } + else if (Short.TYPE == valueClass || valueClass == Short.class) { + final Clamp clamp = element.getAnnotation(Clamp.class); + final Increment increment = element.getAnnotation(Increment.class); + final Range range = clamp == null ? null : Range.of((short)clamp.minimum(), (short)clamp.maximum()); + Short step = null; + if(increment != null) + step = (short)increment.value(); + else if(range != null) + step = (short)((range.getMaximum() - range.getMinimum()) / 50); + + return (PropertyContainer) new NumberPropertyContainer<>(property.value(), property.description(), + range, step, handleGetter, handleSetter, handleListener); + } + else if (Integer.TYPE == valueClass || valueClass == Integer.class) { + final Clamp clamp = element.getAnnotation(Clamp.class); + final Increment increment = element.getAnnotation(Increment.class); + final Range range = clamp == null ? null : Range.of((int)clamp.minimum(), (int)clamp.maximum()); + Integer step = null; + if(increment != null) + step = (int)increment.value(); + else if(range != null) + step = (range.getMaximum() - range.getMinimum()) / 50; + + return (PropertyContainer) new NumberPropertyContainer<>(property.value(), property.description(), + range, step, handleGetter, handleSetter, handleListener); + } + else if (Long.TYPE == valueClass || valueClass == Long.class) { + final Clamp clamp = element.getAnnotation(Clamp.class); + final Increment increment = element.getAnnotation(Increment.class); + final Range range = clamp == null ? null : Range.of((long)clamp.minimum(), (long)clamp.maximum()); + Long step = null; + if(increment != null) + step = (long)increment.value(); + else if(range != null) + step = (range.getMaximum() - range.getMinimum()) / 50; + + return (PropertyContainer) new NumberPropertyContainer<>(property.value(), property.description(), + range, step, handleGetter, handleSetter, handleListener); + } + else if (Float.TYPE == valueClass || valueClass == Float.class) { + final Clamp clamp = element.getAnnotation(Clamp.class); + final Increment increment = element.getAnnotation(Increment.class); + final Range range = clamp == null ? null : Range.of((float)clamp.minimum(), (float)clamp.maximum()); + Float step = null; + if(increment != null) + step = (float)increment.value(); + else if(range != null) + step = (range.getMaximum() - range.getMinimum()) / 50; + + return (PropertyContainer) new NumberPropertyContainer<>(property.value(), property.description(), + range, step, handleGetter, handleSetter, handleListener); + } + else if (Double.TYPE == valueClass || valueClass == Double.class) { + final Clamp clamp = element.getAnnotation(Clamp.class); + final Increment increment = element.getAnnotation(Increment.class); + final Range range = clamp == null ? null : Range.of(clamp.minimum(), clamp.maximum()); + Double step = null; + if(increment != null) + step = increment.value(); + else if(range != null) + step = (range.getMaximum() - range.getMinimum()) / 50; + + return (PropertyContainer) new NumberPropertyContainer<>(property.value(), property.description(), + range, step, handleGetter, handleSetter, handleListener); + } + else if (Enum.class.isAssignableFrom(valueClass)) { + return (PropertyContainer)new EnumPropertyContainer(property.value(), property.description(), handleGetter, handleSetter, handleListener); + } + else { + return new FieldPropertyContainer<>(property.value(), property.description(), handleGetter, handleSetter, handleListener); + } + } catch (Throwable e) { + e.printStackTrace(); + } + return null; + } +} diff --git a/src/main/java/fr/shyrogan/swiftbird/annotation/Property.java b/src/main/java/fr/shyrogan/swiftbird/annotation/Property.java new file mode 100644 index 0000000..cde2506 --- /dev/null +++ b/src/main/java/fr/shyrogan/swiftbird/annotation/Property.java @@ -0,0 +1,28 @@ +package fr.shyrogan.swiftbird.annotation; + +import com.leafclient.swiftbird.PropertyContainer; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Annotates a {@link java.lang.reflect.Field} to allow {@link com.leafclient.swiftbird.Swiftbird} to wrap it into a + * {@link PropertyContainer}. + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.FIELD) +public @interface Property { + + /** + * @return the label of the {@link PropertyContainer} marked by this annotation. + */ + String value(); + + /** + * @return the description of the {@link PropertyContainer} marked by this annotation. + */ + String description() default ""; + +} diff --git a/src/main/java/fr/shyrogan/swiftbird/annotation/listener/Listener.java b/src/main/java/fr/shyrogan/swiftbird/annotation/listener/Listener.java new file mode 100644 index 0000000..144e744 --- /dev/null +++ b/src/main/java/fr/shyrogan/swiftbird/annotation/listener/Listener.java @@ -0,0 +1,27 @@ +package fr.shyrogan.swiftbird.annotation.listener; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Annotation used by {@link com.leafclient.swiftbird.Swiftbird} to specify a property listener. + * + *

+ * A property listener respect this form (T represent our property type): + * T listenerName(T previousValue, T futureValue) + * The returned value allows the listener to change the future value. + *

+ */ +@Target(ElementType.FIELD) +@Retention(RetentionPolicy.RUNTIME) +public @interface Listener { + + /** + * @return listener method's name + * @see Listener + */ + String value(); + +} diff --git a/src/main/java/fr/shyrogan/swiftbird/annotation/number/Clamp.java b/src/main/java/fr/shyrogan/swiftbird/annotation/number/Clamp.java new file mode 100644 index 0000000..f3cae4d --- /dev/null +++ b/src/main/java/fr/shyrogan/swiftbird/annotation/number/Clamp.java @@ -0,0 +1,28 @@ +package fr.shyrogan.swiftbird.annotation.number; + +import com.leafclient.swiftbird.PropertyContainer; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Annotates a {@link fr.shyrogan.swiftbird.annotation.Property} annotated field to provide a minimum + * and maximum value to that property. This only works with primitive numbers. + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.FIELD) +public @interface Clamp { + + /** + * @return the minimum value of marked property + */ + double minimum(); + + /** + * @return the maximum value of marked property + */ + double maximum(); + +} diff --git a/src/main/java/fr/shyrogan/swiftbird/annotation/number/Increment.java b/src/main/java/fr/shyrogan/swiftbird/annotation/number/Increment.java new file mode 100644 index 0000000..84a93a7 --- /dev/null +++ b/src/main/java/fr/shyrogan/swiftbird/annotation/number/Increment.java @@ -0,0 +1,23 @@ +package fr.shyrogan.swiftbird.annotation.number; + +import com.leafclient.swiftbird.PropertyContainer; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Annotates a {@link fr.shyrogan.swiftbird.annotation.Property} annotated field to provide a step value to this property. + * This only works with primitive numbers. + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.FIELD) +public @interface Increment { + + /** + * @return the step value of marked property + */ + double value(); + +} diff --git a/src/main/java/fr/shyrogan/swiftbird/setting/FieldPropertyContainer.java b/src/main/java/fr/shyrogan/swiftbird/setting/FieldPropertyContainer.java new file mode 100644 index 0000000..48e0d30 --- /dev/null +++ b/src/main/java/fr/shyrogan/swiftbird/setting/FieldPropertyContainer.java @@ -0,0 +1,69 @@ +package fr.shyrogan.swiftbird.setting; + +import com.leafclient.swiftbird.PropertyContainer; + +import java.lang.invoke.MethodHandle; + +@SuppressWarnings("unchecked") +public class FieldPropertyContainer implements PropertyContainer { + + private final String label, description; + private transient final MethodHandle valueGetter, valueSetter, listener; + + public FieldPropertyContainer(String label, String description, MethodHandle valueGetter, MethodHandle valueSetter, MethodHandle listener) { + this.label = label; + this.description = description; + this.valueGetter = valueGetter; + this.valueSetter = valueSetter; + this.listener = listener; + } + + /** + * @inheritDoc + */ + @Override + public String getLabel() { + return label; + } + + /** + * @inheritDoc + */ + @Override + public String getDescription() { + return description; + } + + /** + * Returns the current value of this {@link PropertyContainer} by getting using the {@link this#valueGetter}. + * + * @return Current value + */ + @Override + public T getValue() { + try { + return (T) valueGetter.invoke(); + } catch (Throwable e) { + e.printStackTrace(); + } + return null; + } + + /** + * Modifies the value of the field using the {@link this#valueSetter} + * @param value New value + * + * @return This setting for fluent syntax + */ + @Override + public void setValue(T value) { + try { + if(listener != null) + valueSetter.invoke((T) listener.invoke(getValue(), value)); + else + valueSetter.invoke(value); + } catch (Throwable e) { + e.printStackTrace(); + } + } +} diff --git a/src/main/java/fr/shyrogan/swiftbird/setting/number/NumberPropertyContainer.java b/src/main/java/fr/shyrogan/swiftbird/setting/number/NumberPropertyContainer.java new file mode 100644 index 0000000..0e7a522 --- /dev/null +++ b/src/main/java/fr/shyrogan/swiftbird/setting/number/NumberPropertyContainer.java @@ -0,0 +1,83 @@ +package fr.shyrogan.swiftbird.setting.number; + +import com.leafclient.struct.maths.Range; +import fr.shyrogan.swiftbird.setting.FieldPropertyContainer; + +import java.lang.invoke.MethodHandle; + +import static com.leafclient.struct.maths.MathOperationsHelper.add; +import static com.leafclient.struct.maths.MathOperationsHelper.round; +import static com.leafclient.struct.maths.MathOperationsHelper.multiplication; +import static com.leafclient.struct.maths.MathOperationsHelper.cast; + +public final class NumberPropertyContainer extends FieldPropertyContainer { + + private final Range range; + private final T step; + + public NumberPropertyContainer(String label, String description, Range range, T step, MethodHandle valueGetter, MethodHandle valueSetter, MethodHandle listener) { + super(label, description, valueGetter, valueSetter, listener); + this.range = range; + this.step = step; + } + + /** + * Sets the value to a value coerced into {@link this#range} stepped + * to {@link this#step} + * + * @param value New value + * @return Setting for a fluent syntax + */ + @Override + public void setValue(T value) { + super.setValue(range.coerce(round(value, step))); + } + + /** + * Increases the current value by {@link this#step} * factor. + * If the value has no step value this operation is not supported + * @see fr.shyrogan.swiftbird.annotation.number.Increment + * + * @param factor Specified factor + */ + public void increment(int factor) { + if(step == null) + return; + + setValue( + add( + getValue(), + multiplication( + step, + cast(factor, getValue()) + ) + ) + ); + } + + /** + * Decreases the current value by {@link this#step} * factor. + * If the value has no step value this operation is not supported. + * @see fr.shyrogan.swiftbird.annotation.number.Increment + * + * @param factor Specified factor + */ + public void reduce(int factor) { + increment(-factor); + } + + /** + * @return `true` if this value is not clamped + */ + public boolean isIncrementable() { + return step != null; + } + + /** + * @return `true` if this value is not clamped + */ + public boolean isInfinite() { + return range == null; + } + +} diff --git a/src/main/java/fr/shyrogan/swiftbird/setting/primitive/BooleanPropertyContainer.java b/src/main/java/fr/shyrogan/swiftbird/setting/primitive/BooleanPropertyContainer.java new file mode 100644 index 0000000..ef5a929 --- /dev/null +++ b/src/main/java/fr/shyrogan/swiftbird/setting/primitive/BooleanPropertyContainer.java @@ -0,0 +1,35 @@ +package fr.shyrogan.swiftbird.setting.primitive; + +import com.leafclient.struct.structure.Toggleable; +import fr.shyrogan.swiftbird.setting.FieldPropertyContainer; + +import java.lang.invoke.MethodHandle; + +/** + * The boolean implementation for {@link FieldPropertyContainer}. + */ +public final class BooleanPropertyContainer extends FieldPropertyContainer implements Toggleable { + + public BooleanPropertyContainer(String label, String description, MethodHandle valueGetter, MethodHandle valueSetter, MethodHandle listener) { + super(label, description, valueGetter, valueSetter, listener); + } + + /** + * @inheritDoc + */ + @Override + public boolean isRunning() { + return getValue(); + } + + /** + * @inheritDoc + */ + @Override + public void setRunning(boolean value) { + setValue(value); + } + + + +} diff --git a/src/main/java/fr/shyrogan/swiftbird/setting/primitive/EnumPropertyContainer.java b/src/main/java/fr/shyrogan/swiftbird/setting/primitive/EnumPropertyContainer.java new file mode 100644 index 0000000..0203dec --- /dev/null +++ b/src/main/java/fr/shyrogan/swiftbird/setting/primitive/EnumPropertyContainer.java @@ -0,0 +1,27 @@ +package fr.shyrogan.swiftbird.setting.primitive; + +import fr.shyrogan.swiftbird.setting.FieldPropertyContainer; + +import java.lang.invoke.MethodHandle; + +/** + * The enum implementation for {@link FieldPropertyContainer}. + */ +@SuppressWarnings("unchecked") +public final class EnumPropertyContainer> extends FieldPropertyContainer { + + public EnumPropertyContainer(String label, String description, MethodHandle valueGetter, MethodHandle valueSetter, MethodHandle listener) { + super(label, description, valueGetter, valueSetter, listener); + } + + /** + * Returns the enum constants of this value + * + * @return Enum constants + */ + public T[] getEnumConstants() { + return (T[])getValue().getClass() + .getEnumConstants(); + } + +} diff --git a/src/test/java/ConfigurableObject.java b/src/test/java/ConfigurableObject.java new file mode 100644 index 0000000..656ae2f --- /dev/null +++ b/src/test/java/ConfigurableObject.java @@ -0,0 +1,29 @@ +import fr.shyrogan.swiftbird.annotation.Property; +import fr.shyrogan.swiftbird.annotation.listener.Listener; +import fr.shyrogan.swiftbird.annotation.number.Clamp; + +public class ConfigurableObject { + + @Property(value = "Cheese", description = "Do you like jazz?") + private boolean cheese = false; + + @Property(value = "Name", description = "IDK") + @Listener("onChange") + private Result value = Result.PERFECT; + + @Property("Uh") + @Clamp(minimum = 0F, maximum = 50F) + private float uh = 6F; + + public Result onChange(Result current, Result future) { + System.out.println("current: " + current); + System.out.println("future: " + future); + return future; + } + + public enum Result { + PERFECT, + UH_OH; + } + +} diff --git a/src/test/java/Settings.java b/src/test/java/Settings.java new file mode 100644 index 0000000..f4e159f --- /dev/null +++ b/src/test/java/Settings.java @@ -0,0 +1,15 @@ +import com.leafclient.swiftbird.Swiftbird; +import org.junit.Test; + +public class Settings { + + private static Swiftbird swiftbird = Swiftbird.create(); + private static ConfigurableObject configurableObject = new ConfigurableObject(); + + @Test + public void simpleLookUp() { + swiftbird.in(configurableObject) + .forEach(setting -> System.out.println(setting.getLabel() + " " + setting.getValue())); + } + +}