diff --git a/LICENSE b/LICENSE deleted file mode 100644 index f288702..0000000 --- a/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/Makefile b/Makefile index f2dd960..7a817a6 100644 --- a/Makefile +++ b/Makefile @@ -13,7 +13,7 @@ INC_DIRS ?= $(INCLUDE_DIR) $(3RDPARTY_DIR)/include LIB := $(BUILD_DIR)/$(LIB_FILENAME) SRCS != find '$(SRC_DIR)' -iname '*.c' -SRCS_H != find $(INC_DIRS) '$(SRC_DIR)' -iname '*.h' +SRCS_H != find $(INCLUDE_DIR) -iname '*.h' SRCS_TEST != find '$(TEST_DIR)' -iname '*.c' SRCS_3RDPARTY != find '$(3RDPARTY_DIR)/src' -iname '*.c' @@ -49,7 +49,7 @@ objs: $(OBJS) .PHONY: vieter vieter: $(LIB) -$(LIB): $(OBJS) +$(BUILD_DIR)/$(LIB_FILENAME): $(OBJS) ar -rcs $@ $(OBJS) $(BUILD_DIR)/$(SRC_DIR)/%.c.o: $(SRC_DIR)/%.c @@ -78,6 +78,8 @@ $(TARGETS_MEM_TEST): test-mem-%: % .PHONY: build-test build-test: $(BINS_TEST) +# For simplicity, we link every object file to each of the test files. This +# might be changed later if this starts to become too slow. $(BINS_TEST): %: %.c.o $(LIB) $(CC) \ $^ $(LIBFLAGS) -o $@ diff --git a/README.md b/README.md index 408f760..448b87b 100644 --- a/README.md +++ b/README.md @@ -57,17 +57,6 @@ files defined in its respective module. This allows testing internal functions. To run the tests, simply run `make test`. If you wish to only run a specific test binary, you can find them in `build/test`. -The name of tests in the `TEST_LIST` variable should be prefixed with the -module they're testing. This makes it much easier to distinguish the output of -tests in the CLI. For example: - -```c -TEST_LIST = { - {"cron illegal parts", test_illegal_parts}, - {NULL, NULL} -}; -``` - ### `compile_commands.json` Clangd requires a `compile_commands.json` to function properly. You can diff --git a/include/vieter_tree.h b/include/vieter_tree.h deleted file mode 100644 index 2079eb9..0000000 --- a/include/vieter_tree.h +++ /dev/null @@ -1,70 +0,0 @@ -#ifndef VIETER_TREE -#define VIETER_TREE - -#include -#include - -typedef struct vieter_tree vieter_tree; - -typedef enum vieter_tree_error { - vieter_tree_ok = 0, - vieter_tree_already_present = 1, - vieter_tree_not_present = 2, - vieter_tree_iterator_done = 3 -} vieter_tree_error; - -/* - * Allocate and initialize a new red-black binary tree. - */ -vieter_tree *vieter_tree_init(); - -/* - * Deallocate a red-black binary tree. - */ -void vieter_tree_free(vieter_tree *tree); - -/* - * Insert a new entry into the tree. - */ -vieter_tree_error vieter_tree_insert(vieter_tree *tree, uint64_t key, - void *data); - -/* - * Look for an entry in the tree. - */ -vieter_tree_error vieter_tree_search(void **out, vieter_tree *tree, - uint64_t key); - -/* - * Remove a given entry from the tree. - */ -vieter_tree_error vieter_tree_remove(void **out, vieter_tree *tree, - uint64_t key); - -/* - * Return how many entries are currently in the tree. - */ -uint64_t vieter_tree_size(vieter_tree *tree); - -/* - * An iterator that can be used to traverse a tree in-order. - */ -typedef struct vieter_tree_iterator vieter_tree_iterator; - -/* - * Allocate and initialize a new iterator from the given tree. - */ -vieter_tree_iterator *vieter_tree_iterator_from(vieter_tree *tree); - -/* - * Free an iterator. - */ -void vieter_tree_iterator_free(vieter_tree_iterator **ptp); - -/* - * Return the iterator's next element. - */ -vieter_tree_error vieter_tree_iterator_next(void **out, - vieter_tree_iterator *iter); - -#endif diff --git a/src/cron/vieter_cron_parse.c b/src/cron/vieter_cron_parse.c index b42e1a9..a82d1c3 100644 --- a/src/cron/vieter_cron_parse.c +++ b/src/cron/vieter_cron_parse.c @@ -1,4 +1,4 @@ -#include "vieter_cron_parse.h" +#include "vieter_cron.h" #include #include #include diff --git a/src/cron/vieter_cron_parse.h b/src/cron/vieter_cron_parse.h deleted file mode 100644 index 21ccf81..0000000 --- a/src/cron/vieter_cron_parse.h +++ /dev/null @@ -1,11 +0,0 @@ -#ifndef VIETER_CRON_PARSE -#define VIETER_CRON_PARSE - -#include "vieter_cron.h" - -vieter_cron_parse_error vieter_cron_expr_parse_range(uint64_t *out, char *s, - uint8_t min, uint8_t max); - -vieter_cron_parse_error vieter_cron_expr_parse_part(uint64_t *out, char *s, - uint8_t min, uint8_t max); -#endif diff --git a/src/heap/vieter_heap_tree.h b/src/heap/vieter_heap_tree.h index 615491a..0a299db 100644 --- a/src/heap/vieter_heap_tree.h +++ b/src/heap/vieter_heap_tree.h @@ -5,16 +5,16 @@ #include typedef struct vieter_heap_node { - uint64_t key; - void *data; - struct vieter_heap_node *largest_order; - union { - // Roots point to next tree in the heap, other nodes point to their first - // neighbour. - struct vieter_heap_node *next_tree; - struct vieter_heap_node *next_largest_order; - } ptr; - uint8_t order; + uint64_t key; + void *data; + struct vieter_heap_node *largest_order; + union { + // Roots point to next tree in the heap, other nodes point to their first + // neighbour. + struct vieter_heap_node *next_tree; + struct vieter_heap_node *next_largest_order; + } ptr; + uint8_t order; } vieter_heap_node; /* @@ -36,8 +36,7 @@ void vieter_heap_tree_free(vieter_heap_node *root); * Given the roots of the smallest trees in two heaps, merge them into a single * large heap. */ -vieter_heap_node *vieter_heap_tree_merge(vieter_heap_node *root_a, - vieter_heap_node *root_b); +vieter_heap_node *vieter_heap_tree_merge(vieter_heap_node *root_a, vieter_heap_node *root_b); /* * Given the roots of two trees of the same order, merge them into a heap of one diff --git a/src/tree/vieter_tree.c b/src/tree/vieter_tree.c deleted file mode 100644 index 84a1a26..0000000 --- a/src/tree/vieter_tree.c +++ /dev/null @@ -1,116 +0,0 @@ -#include "vieter_tree_balancing.h" -#include "vieter_tree_internal.h" - -vieter_tree *vieter_tree_init() { return calloc(1, sizeof(vieter_tree)); } - -uint64_t vieter_tree_size(vieter_tree *tree) { return tree->size; } - -vieter_tree_error vieter_tree_insert(vieter_tree *tree, uint64_t key, - void *data) { - if (tree->size == 0) { - tree->root = vieter_tree_node_init(); - tree->root->key = key; - tree->root->data = data; - vieter_tree_node_set(tree->root, vieter_tree_node_black, true); - tree->size = 1; - - return vieter_tree_ok; - } - - vieter_tree_error res = vieter_tree_node_insert(tree->root, key, data); - - if (res != vieter_tree_ok) { - return res; - } - - tree->size++; - - return vieter_tree_ok; -} - -vieter_tree_error vieter_tree_search(void **out, vieter_tree *tree, - uint64_t key) { - if (tree->size == 0) { - return vieter_tree_not_present; - } - - return vieter_tree_node_search(out, tree->root, key); -} - -vieter_tree_error vieter_tree_remove(void **out, vieter_tree *tree, - uint64_t key) { - if (tree->size == 0) { - return vieter_tree_not_present; - } - - vieter_tree_error res = vieter_tree_node_remove(out, &tree->root, key); - - if (res != vieter_tree_ok) { - return res; - } - - tree->size--; - - return vieter_tree_ok; -} - -void vieter_tree_free(vieter_tree *tree) { - if (tree->size == 0) { - goto end; - } - - uint64_t capacity = 4; - uint64_t size = 1; - vieter_tree_node **stack = malloc(capacity * sizeof(vieter_tree_node *)); - stack[0] = tree->root; - - vieter_tree_node *node; - - while (size > 0) { - node = stack[size - 1]; - size--; - - if (size + 2 > capacity) { - capacity *= 2; - stack = realloc(stack, capacity * sizeof(vieter_tree_node *)); - } - - if (node->children[0] != NULL) { - stack[size] = node->children[0]; - size++; - } - - if (node->children[1] != NULL) { - stack[size] = node->children[1]; - size++; - } - - vieter_tree_node_free(node); - } - - free(stack); - -end: - free(tree); -} - -bool vieter_tree_validate(vieter_tree *tree) { - if (tree->size == 0) { - return true; - } - - // DFS to get expected black nodes - uint64_t expected_black_nodes = 0; - vieter_tree_node *node = tree->root; - - while (node != NULL) { - if (vieter_tree_node_get(node, vieter_tree_node_black)) { - expected_black_nodes++; - } - - node = node->children[0]; - } - - return vieter_tree_node_get(tree->root, vieter_tree_node_black) && - vieter_tree_node_validate(tree->root, 0, expected_black_nodes); -} diff --git a/src/tree/vieter_tree_balancing.c b/src/tree/vieter_tree_balancing.c deleted file mode 100644 index 6e7dcd9..0000000 --- a/src/tree/vieter_tree_balancing.c +++ /dev/null @@ -1,289 +0,0 @@ -#include "vieter_tree_balancing.h" -#include - -bool vieter_tree_node_validate(vieter_tree_node *node, - uint64_t passed_black_nodes, - uint64_t expected_black_nodes) { - // Path to NULL children should contain the same amount of black nodes - if (node == NULL) { - return passed_black_nodes == expected_black_nodes; - } - - if (vieter_tree_node_get(node, vieter_tree_node_black)) { - passed_black_nodes++; - } - - // Either the node itself is black, or its children are both either NULL or - // black. - bool correctly_colored_children = - vieter_tree_node_get(node, vieter_tree_node_black) || - ((node->children[0] == NULL || - vieter_tree_node_get(node->children[0], vieter_tree_node_black)) && - (node->children[1] == NULL || - vieter_tree_node_get(node->children[1], vieter_tree_node_black))); - bool right_child_flag_set = - node->parent == NULL || - (vieter_tree_node_get(node, vieter_tree_node_right) == - (node->parent->children[1] == node)); - - return correctly_colored_children && right_child_flag_set && - vieter_tree_node_validate(node->children[0], passed_black_nodes, - expected_black_nodes) && - vieter_tree_node_validate(node->children[1], passed_black_nodes, - expected_black_nodes); -} - -/* - * This function should be rewritten to use tree rotations instead. - */ -vieter_tree_node *vieter_tree_node_balance(vieter_tree_node *node) { - vieter_tree_node *parent = node->parent; - vieter_tree_node *grand_parent = parent->parent; - vieter_tree_node *root = grand_parent; - vieter_tree_node *children[2]; - vieter_tree_node *grand_children[4]; - - uint64_t key_root = root->key; - void *data_root = root->data; - - if (vieter_tree_node_get(node, vieter_tree_node_right)) { - children[0] = parent; - children[1] = node; - - if (vieter_tree_node_get(parent, vieter_tree_node_right)) { - root->key = parent->key; - root->data = parent->data; - - parent->key = key_root; - parent->data = data_root; - - grand_children[0] = grand_parent->children[0]; - grand_children[1] = parent->children[0]; - grand_children[2] = node->children[0]; - grand_children[3] = node->children[1]; - } else { - root->key = node->key; - root->data = node->data; - - node->key = key_root; - node->data = data_root; - - grand_children[0] = parent->children[0]; - grand_children[1] = node->children[0]; - grand_children[2] = node->children[1]; - grand_children[3] = grand_parent->children[1]; - } - } else { - children[0] = node; - children[1] = parent; - - if (vieter_tree_node_get(parent, vieter_tree_node_right)) { - root->key = node->key; - root->data = node->data; - - node->key = key_root; - node->data = data_root; - - grand_children[0] = grand_parent->children[0]; - grand_children[1] = node->children[0]; - grand_children[2] = node->children[1]; - grand_children[3] = parent->children[1]; - } else { - root->key = parent->key; - root->data = parent->data; - - parent->key = key_root; - parent->data = data_root; - - grand_children[0] = node->children[0]; - grand_children[1] = node->children[1]; - grand_children[2] = parent->children[1]; - grand_children[3] = grand_parent->children[1]; - } - } - - vieter_tree_node_set( - root, vieter_tree_node_right, - vieter_tree_node_get(grand_parent, vieter_tree_node_right)); - - vieter_tree_node_set(children[0], vieter_tree_node_black, true); - vieter_tree_node_set(children[1], vieter_tree_node_black, true); - - vieter_tree_node_set(root, vieter_tree_node_black, false); - - vieter_tree_node_set_children(children[0], grand_children); - vieter_tree_node_set_children(children[1], grand_children + 2); - vieter_tree_node_set_children(root, children); - - return root; -} - -void vieter_tree_node_balance_after_insert(vieter_tree_node *node) { - while (!vieter_tree_node_get(node, vieter_tree_node_black) && - node->parent != NULL && - !vieter_tree_node_get(node->parent, vieter_tree_node_black)) { - node = vieter_tree_node_balance(node); - } - - // The root must always be black - if (node->parent == NULL) { - vieter_tree_node_set(node, vieter_tree_node_black, true); - } -} - -vieter_tree_node *vieter_tree_node_rotate(vieter_tree_node *old_root, - bool dir) { - vieter_tree_node *new_root = old_root->children[1 - dir]; - - if (old_root->parent != NULL) { - vieter_tree_node_set_child( - old_root->parent, new_root, - vieter_tree_node_get(old_root, vieter_tree_node_right)); - } else { - new_root->parent = NULL; - } - - // Right rotation - if (dir) { - vieter_tree_node_set_child(old_root, new_root->children[1], false); - vieter_tree_node_set_child(new_root, old_root, true); - } - // Left rotation - else { - vieter_tree_node_set_child(old_root, new_root->children[0], true); - vieter_tree_node_set_child(new_root, old_root, false); - } - - return new_root; -} - -/* - * This function is currently implemented by very literally following the - * Wikipedia pseudocode. It's honestly not too bad, and I couldn't be bothered - * to properly research how to implement red-black removal (how is this so hard - * to find?) - * - * https://en.wikipedia.org/wiki/Red%E2%80%93black_tree#Removal_of_a_black_non-root_leaf - */ -vieter_tree_node *vieter_tree_node_remove_balanced(vieter_tree_node *node) { - vieter_tree_node *out; - - if (node->parent == NULL) { - out = node->children[0] != NULL ? node->children[0] : node->children[1]; - - vieter_tree_node_free(node); - - // This only happens when the root was the only element in the tree - if (out == NULL) - return out; - - vieter_tree_node_set(out, vieter_tree_node_black, true); - out->parent = NULL; - - return out; - } - - // A red node can only have 0 or 2 children. The node we receive only has - // one child at most, so we know if it's red that it doesn't have any - // children. A black node that has a single (right) child can be replaced by - // this child, granted it becomes black as well. Either way, the node can be - // replaced by its right child (even if it's NULL). - if (!vieter_tree_node_get(node, vieter_tree_node_black) || - node->children[1] != NULL) { - out = node->children[1]; - - vieter_tree_node_set_child( - node->parent, node->children[1], - vieter_tree_node_get(node, vieter_tree_node_right)); - - if (node->children[1] != NULL) - vieter_tree_node_set(node->children[1], vieter_tree_node_black, true); - - vieter_tree_node_free(node); - - return out; - } - - // The complicated case is when we want to remove a black leaf - // https://en.wikipedia.org/wiki/Red%E2%80%93black_tree#Removal_of_a_black_non-root_leaf - - out = node; - vieter_tree_node *parent = node->parent; - vieter_tree_node *sibling, *close_nephew, *distant_nephew; - bool dir = vieter_tree_node_get(node, vieter_tree_node_right); - parent->children[dir] = NULL; - - vieter_tree_node_free(node); - - goto start; - - do { - dir = vieter_tree_node_get(node, vieter_tree_node_right); - - start: - sibling = parent->children[1 - dir]; - distant_nephew = sibling->children[1 - dir]; - close_nephew = sibling->children[dir]; - - if (!vieter_tree_node_get(sibling, vieter_tree_node_black)) - goto case3; - - if (distant_nephew != NULL && - !vieter_tree_node_get(distant_nephew, vieter_tree_node_black)) - goto case6; - - if (close_nephew != NULL && - !vieter_tree_node_get(close_nephew, vieter_tree_node_black)) - goto case5; - - if (!vieter_tree_node_get(parent, vieter_tree_node_black)) - goto case4; - - // Case 2 - vieter_tree_node_set(sibling, vieter_tree_node_black, false); - node = parent; - out = node; - } while ((parent = node->parent) != NULL); - - // Case 1 - return out; - -case3: - out = vieter_tree_node_rotate(parent, dir); - vieter_tree_node_set(parent, vieter_tree_node_black, false); - vieter_tree_node_set(sibling, vieter_tree_node_black, true); - sibling = close_nephew; - distant_nephew = sibling->children[1 - dir]; - - if (distant_nephew != NULL && - !vieter_tree_node_get(distant_nephew, vieter_tree_node_black)) - goto case6; - - close_nephew = sibling->children[dir]; - - if (close_nephew != NULL && - !vieter_tree_node_get(close_nephew, vieter_tree_node_black)) - goto case5; - -case4: - vieter_tree_node_set(sibling, vieter_tree_node_black, false); - vieter_tree_node_set(parent, vieter_tree_node_black, true); - - return out; - -case5: - vieter_tree_node_rotate(sibling, 1 - dir); - vieter_tree_node_set(sibling, vieter_tree_node_black, false); - vieter_tree_node_set(close_nephew, vieter_tree_node_black, true); - distant_nephew = sibling; - sibling = close_nephew; - -case6: - out = vieter_tree_node_rotate(parent, dir); - vieter_tree_node_set(sibling, vieter_tree_node_black, - vieter_tree_node_get(parent, vieter_tree_node_black)); - vieter_tree_node_set(parent, vieter_tree_node_black, true); - vieter_tree_node_set(distant_nephew, vieter_tree_node_black, true); - - return out; -} diff --git a/src/tree/vieter_tree_balancing.h b/src/tree/vieter_tree_balancing.h deleted file mode 100644 index e5dced0..0000000 --- a/src/tree/vieter_tree_balancing.h +++ /dev/null @@ -1,46 +0,0 @@ -#ifndef VIETER_TREE_BALANCING -#define VIETER_TREE_BALANCING - -#include "vieter_tree_node.h" - -/* - * Check whether the given tree is a valid red-black tree. - * - * @param node root of the (sub)tree - * @param passed_black_nodes how many black nodes the recursion has already seen - * at this point. This should be initialized as 0 for the topmost call. - * @param expected_black_nodes the correct amount of black nodes to expect when - * a NULL child is encountered. - * @return true if the tree is valid, false otherwise - */ -bool vieter_tree_node_validate(vieter_tree_node *node, - uint64_t passed_black_nodes, - uint64_t expected_black_nodes); - -/* - * Balance a path of 3 nodes into a complete binary tree, with a red root and - * black children. - */ -vieter_tree_node *vieter_tree_node_balance(vieter_tree_node *node); - -/* - * Ensure the tree remains a valid red-black tree after having inserting the - * node. - */ -void vieter_tree_node_balance_after_insert(vieter_tree_node *node); - -/* - * Remove the given node, ensuring the tree remains a valid red-black tree. - * - * @param node node to remove. This should have at most a single child. If node - * isn't the root, this should be the right child, otherwise it can be either. - * @return root of the subtree that this function operated on. This can - * sometimes be the new root of the entire tree. - */ -vieter_tree_node *vieter_tree_node_remove_balanced(vieter_tree_node *node); - -/* - * Perform a tree rotation of the subtree with the given root. - */ -vieter_tree_node *vieter_tree_node_rotate(vieter_tree_node *old_root, bool dir); -#endif diff --git a/src/tree/vieter_tree_internal.h b/src/tree/vieter_tree_internal.h deleted file mode 100644 index 1214572..0000000 --- a/src/tree/vieter_tree_internal.h +++ /dev/null @@ -1,22 +0,0 @@ -#include "vieter_tree.h" -#include "vieter_tree_node.h" - -#include - -struct vieter_tree { - uint64_t size; - vieter_tree_node *root; -}; - -/* - * Inspect whether the tree is still a valid red-black-tree. - * - * @return true if valid, false otherwise. - */ -bool vieter_tree_validate(vieter_tree *tree); - -struct vieter_tree_iterator { - vieter_tree_node *current_node; - bool started; - bool done; -}; diff --git a/src/tree/vieter_tree_iterator.c b/src/tree/vieter_tree_iterator.c deleted file mode 100644 index 4eefe02..0000000 --- a/src/tree/vieter_tree_iterator.c +++ /dev/null @@ -1,49 +0,0 @@ -#include "vieter_tree.h" -#include "vieter_tree_internal.h" - -vieter_tree_iterator *vieter_tree_iterator_from(vieter_tree *tree) { - vieter_tree_iterator *iter = calloc(1, sizeof(vieter_tree_iterator)); - - // An empty tree's iterator will be done immediately - if (tree->size == 0) { - iter->started = true; - iter->done = true; - - return iter; - } - - iter->current_node = tree->root; - - return iter; -} - -vieter_tree_error vieter_tree_iterator_next(void **out, - vieter_tree_iterator *iter) { - if (iter->done) { - return vieter_tree_iterator_done; - } - - if (!iter->started) { - while (iter->current_node->children[0] != NULL) { - iter->current_node = iter->current_node->children[0]; - } - - iter->started = true; - } - - *out = iter->current_node->data; - - iter->current_node = vieter_tree_node_next(iter->current_node); - - if (iter->current_node == NULL) { - iter->done = true; - } - - return vieter_tree_ok; -} - -void vieter_tree_iterator_free(vieter_tree_iterator **ptp) { - free(*ptp); - - *ptp = NULL; -} diff --git a/src/tree/vieter_tree_node.c b/src/tree/vieter_tree_node.c deleted file mode 100644 index 0a8e658..0000000 --- a/src/tree/vieter_tree_node.c +++ /dev/null @@ -1,171 +0,0 @@ -#include "vieter_tree_node.h" -#include "vieter_tree_balancing.h" - -#include - -vieter_tree_node *vieter_tree_node_init() { - return calloc(1, sizeof(vieter_tree_node)); -} - -void vieter_tree_node_free(vieter_tree_node *node) { free(node); } - -void vieter_tree_node_add_child(vieter_tree_node *parent, uint64_t key, - vieter_tree_node *child) { - if (parent == NULL) { - return; - } - - bool side = key > parent->key; - parent->children[side] = child; - - if (child != NULL) { - child->parent = parent; - vieter_tree_node_set(child, vieter_tree_node_right, side); - } -} - -void vieter_tree_node_set_children(vieter_tree_node *parent, - vieter_tree_node **children) { - memcpy(parent->children, children, 2 * sizeof(vieter_tree_node *)); - - for (uint8_t i = 0; i < 2; i++) { - if (parent->children[i] != NULL) { - parent->children[i]->parent = parent; - vieter_tree_node_set(parent->children[i], vieter_tree_node_right, i); - } - } -} - -void vieter_tree_node_set_child(vieter_tree_node *parent, - vieter_tree_node *child, bool right) { - parent->children[right] = child; - - if (child != NULL) { - child->parent = parent; - vieter_tree_node_set(child, vieter_tree_node_right, right); - } -} - -vieter_tree_error vieter_tree_node_insert(vieter_tree_node *root, uint64_t key, - void *data) { - vieter_tree_node *node = root; - vieter_tree_node *parent = root; - - while (node != NULL) { - if (node->key == key) { - return vieter_tree_already_present; - } - - parent = node; - node = node->children[key > parent->key]; - } - - vieter_tree_node *new_node = vieter_tree_node_init(); - new_node->key = key; - new_node->data = data; - - vieter_tree_node_add_child(parent, key, new_node); - vieter_tree_node_balance_after_insert(new_node); - - return vieter_tree_ok; -} - -vieter_tree_error vieter_tree_node_search_node(vieter_tree_node **out, - vieter_tree_node *root, - uint64_t key) { - vieter_tree_node *node = root; - - while (node != NULL) { - if (node->key == key) { - *out = node; - - return vieter_tree_ok; - } - - node = node->children[key > node->key]; - } - - return vieter_tree_not_present; -} - -vieter_tree_error vieter_tree_node_search(void **out, vieter_tree_node *root, - uint64_t key) { - vieter_tree_node *target; - vieter_tree_error res = vieter_tree_node_search_node(&target, root, key); - - if (res != vieter_tree_ok) { - return res; - } - - *out = target->data; - - return vieter_tree_ok; -} - -vieter_tree_error -vieter_tree_node_remove(void **out, vieter_tree_node **root_ptr, uint64_t key) { - vieter_tree_node *target; - vieter_tree_error res = vieter_tree_node_search_node(&target, *root_ptr, key); - - if (res != vieter_tree_ok) { - return res; - } - - *out = target->data; - vieter_tree_node *possible_new_root; - - if (target->children[0] != NULL && target->children[1] != NULL) { - vieter_tree_node *replacement = target->children[1]; - - while (replacement->children[0] != NULL) { - replacement = replacement->children[0]; - } - - target->key = replacement->key; - target->data = replacement->data; - - possible_new_root = vieter_tree_node_remove_balanced(replacement); - } else { - possible_new_root = vieter_tree_node_remove_balanced(target); - } - - if (possible_new_root == NULL) { - *root_ptr = NULL; - } else if (possible_new_root->parent == NULL) { - *root_ptr = possible_new_root; - } - - return vieter_tree_ok; -} - -void vieter_tree_node_set(vieter_tree_node *node, vieter_tree_node_flag flag, - bool set) { - if (set) { - node->flags |= flag; - } else { - node->flags &= ~flag; - } -} - -bool vieter_tree_node_get(vieter_tree_node *node, vieter_tree_node_flag flag) { - return (node->flags & flag) != 0; -} - -vieter_tree_node *vieter_tree_node_next(vieter_tree_node *node) { - if (node->children[1] != NULL) { - node = node->children[1]; - - while (node->children[0] != NULL) { - node = node->children[0]; - } - - return node; - } - - while (node->parent != NULL && - vieter_tree_node_get(node, vieter_tree_node_right)) { - node = node->parent; - } - - return node->parent; -} diff --git a/src/tree/vieter_tree_node.h b/src/tree/vieter_tree_node.h deleted file mode 100644 index 4db3cfe..0000000 --- a/src/tree/vieter_tree_node.h +++ /dev/null @@ -1,94 +0,0 @@ -#ifndef VIETER_TREE_NODE -#define VIETER_TREE_NODE - -#include "vieter_tree.h" -#include -#include - -typedef enum vieter_tree_node_flag { - vieter_tree_node_black = ((uint8_t)1) << 0, - // This flag is used to index the children array. If this flag isn't set, - // it'll evaluate to false, or index 0 in the children array. - vieter_tree_node_right = ((uint8_t)1) << 1 -} vieter_tree_node_flag; - -typedef struct vieter_tree_node { - uint64_t key; - void *data; - struct vieter_tree_node *parent; - struct vieter_tree_node *children[2]; - uint8_t flags; -} vieter_tree_node; - -/* - * Allocate a new node. - */ -vieter_tree_node *vieter_tree_node_init(); - -/* - * Free an allocated node. - */ -void vieter_tree_node_free(vieter_tree_node *node); - -/* - * Insert a new key into the given tree. - */ -vieter_tree_error vieter_tree_node_insert(vieter_tree_node *root, uint64_t key, - void *data); - -/* - * Return the node representing the requested value. - */ -vieter_tree_error vieter_tree_node_search_node(vieter_tree_node **out, - vieter_tree_node *root, - uint64_t key); - -/* - * Search for the data represented by the given key. - */ -vieter_tree_error vieter_tree_node_search(void **out, vieter_tree_node *root, - uint64_t key); - -/* - * Remove the data associated with the given key. - */ -vieter_tree_error -vieter_tree_node_remove(void **out, vieter_tree_node **root_ptr, uint64_t key); - -/* - * Set a node's bit flag to the given value. - */ -void vieter_tree_node_set(vieter_tree_node *node, vieter_tree_node_flag flag, - bool value); - -/* - * Get whether a node's bit flag is set. - */ -bool vieter_tree_node_get(vieter_tree_node *node, vieter_tree_node_flag flag); - -/* - * Add a new child to the parent, replacing either its left or right child, - * depending on the key values. - */ -void vieter_tree_node_add_child(vieter_tree_node *parent, uint64_t key, - vieter_tree_node *child); - -/* - * Replace a node's children array. - */ -void vieter_tree_node_set_children(vieter_tree_node *parent, - vieter_tree_node **children); - -/* - * Set a node's left or right child to the given node. - */ -void vieter_tree_node_set_child(vieter_tree_node *parent, - vieter_tree_node *child, bool right); - -/* - * Return the in-order successor of the given node, or NULL if it's the last - * node in the tree. - */ -vieter_tree_node *vieter_tree_node_next(vieter_tree_node *node); - -#endif diff --git a/test/cron/test_parse.c b/test/cron/test_parse.c index 6417c40..030c720 100644 --- a/test/cron/test_parse.c +++ b/test/cron/test_parse.c @@ -1,7 +1,7 @@ #include "acutest.h" #include "vieter_cron.h" -void test_illegal_expressions() { +void test_not_allowed() { char *expressions[] = { "4 *-7", "4 *-7/4", @@ -33,6 +33,6 @@ void test_illegal_expressions() { } TEST_LIST = { - {"cron illegal expressions", test_illegal_expressions}, + {"not_allowed", test_not_allowed}, {NULL, NULL} }; diff --git a/test/cron/test_parse_part.c b/test/cron/test_parse_part.c deleted file mode 100644 index 5c9c10e..0000000 --- a/test/cron/test_parse_part.c +++ /dev/null @@ -1,43 +0,0 @@ -#include "acutest.h" -#include "vieter_cron_parse.h" - -struct parse_test { - char *part; - uint8_t min; - uint8_t max; -}; - -void test_illegal_parts() { - struct parse_test parts[] = { - { "*-7", 0, 23 }, - { "*-7/4", 0, 23 }, - { "7/*", 0, 23 }, - { "/5", 0, 23 }, - { "4~6", 0, 23 }, - { "5/2-5", 0, 23 }, - { "1/2/3", 0, 23 }, - { "*5", 0, 59 }, - { "x", 0, 59 }, - { NULL, 0, 0 } - }; - - int i = 0; - uint64_t out; - char *s; - - while (parts[i].part != NULL) { - // Function modifies string in-place - s = strdup(parts[i].part); - - TEST_CHECK_(vieter_cron_expr_parse_part(&out, s, parts[i].min, parts[i].max) != vieter_cron_parse_ok, "%s (%i - %i)", parts[i].part, parts[i].min, parts[i].max); - - free(s); - - i++; - } -} - -TEST_LIST = { - {"cron illegal parts", test_illegal_parts}, - {NULL, NULL} -}; diff --git a/test/heap/test_heap.c b/test/heap/test_heap.c index 31ea354..f77b0dc 100644 --- a/test/heap/test_heap.c +++ b/test/heap/test_heap.c @@ -178,10 +178,10 @@ void test_pop_random() { } TEST_LIST = { - {"heap init", test_init}, - {"heap insert", test_insert}, - {"heap insert random", test_insert_random}, - {"heap pop", test_pop}, - {"heap pop random", test_pop_random}, + {"init", test_init}, + {"insert", test_insert}, + {"insert random", test_insert_random}, + {"pop", test_pop}, + {"pop random", test_pop_random}, {NULL, NULL} }; diff --git a/test/heap/test_merge.c b/test/heap/test_merge.c index f0861fe..10053f2 100644 --- a/test/heap/test_merge.c +++ b/test/heap/test_merge.c @@ -23,6 +23,6 @@ void test_merge_same_order() { } TEST_LIST = { - {"heap merge same order", test_merge_same_order}, + {"merge same order", test_merge_same_order}, {NULL, NULL} }; diff --git a/test/tree/test_balancing.c b/test/tree/test_balancing.c deleted file mode 100644 index bdcd846..0000000 --- a/test/tree/test_balancing.c +++ /dev/null @@ -1,71 +0,0 @@ -#include "acutest.h" -#include "vieter_tree_internal.h" -#include "vieter_tree_node.h" -#include "vieter_tree_balancing.h" - -// This uses the examples from wikipedia -// https://en.wikipedia.org/wiki/Tree_rotation - -void test_rotate_right() { - vieter_tree_node *a = vieter_tree_node_init(); - vieter_tree_node *b = vieter_tree_node_init(); - vieter_tree_node *p = vieter_tree_node_init(); - - vieter_tree_node_set_child(p, a, false); - vieter_tree_node_set_child(p, b, true); - - vieter_tree_node *c = vieter_tree_node_init(); - vieter_tree_node *q = vieter_tree_node_init(); - - vieter_tree_node_set_child(q, p, false); - vieter_tree_node_set_child(q, c, true); - - vieter_tree_node *new_root = vieter_tree_node_rotate(q, true); - - TEST_CHECK(new_root == p); - TEST_CHECK(new_root->children[0] == a); - TEST_CHECK(new_root->children[1] == q); - TEST_CHECK(new_root->children[1]->children[0] == b); - TEST_CHECK(new_root->children[1]->children[1] == c); - - vieter_tree_node_free(a); - vieter_tree_node_free(b); - vieter_tree_node_free(p); - vieter_tree_node_free(c); - vieter_tree_node_free(q); -} - -void test_rotate_left() { - vieter_tree_node *b = vieter_tree_node_init(); - vieter_tree_node *c = vieter_tree_node_init(); - vieter_tree_node *q = vieter_tree_node_init(); - - vieter_tree_node_set_child(q, b, false); - vieter_tree_node_set_child(q, c, true); - - vieter_tree_node *a = vieter_tree_node_init(); - vieter_tree_node *p = vieter_tree_node_init(); - - vieter_tree_node_set_child(p, a, false); - vieter_tree_node_set_child(p, q, true); - - vieter_tree_node *new_root = vieter_tree_node_rotate(p, false); - - TEST_CHECK(new_root == q); - TEST_CHECK(new_root->children[0] == p); - TEST_CHECK(new_root->children[1] == c); - TEST_CHECK(new_root->children[0]->children[0] == a); - TEST_CHECK(new_root->children[0]->children[1] == b); - - vieter_tree_node_free(a); - vieter_tree_node_free(b); - vieter_tree_node_free(p); - vieter_tree_node_free(c); - vieter_tree_node_free(q); -} - -TEST_LIST = { - {"tree rotate right", test_rotate_right}, - {"tree rotate left", test_rotate_left}, - {NULL, NULL} -}; diff --git a/test/tree/test_tree.c b/test/tree/test_tree.c deleted file mode 100644 index 10235cb..0000000 --- a/test/tree/test_tree.c +++ /dev/null @@ -1,72 +0,0 @@ -#include "acutest.h" -#include "vieter_tree_internal.h" - -#define TEST_SIZE(tree, size) \ - TEST_CHECK(vieter_tree_size(tree) == size); \ - TEST_MSG("Size: %zu", vieter_tree_size(tree)) - -void test_init() { - vieter_tree *tree = vieter_tree_init(); - TEST_CHECK(tree != NULL); - TEST_SIZE(tree, 0); - vieter_tree_free(tree); -} - -void test_insert() { - vieter_tree *tree = vieter_tree_init(); - - for (uint64_t i = 0; i < 250; i++) { - TEST_CHECK(vieter_tree_insert(tree, i, (void *)i) == vieter_tree_ok); - TEST_SIZE(tree, i + 1); - TEST_CHECK(vieter_tree_validate(tree)); - } - - vieter_tree_iterator *iter = vieter_tree_iterator_from(tree); - - void *out = NULL; - - for (uint64_t i = 0; i < 250; i++) { - TEST_CHECK(vieter_tree_search(&out, tree, i) == vieter_tree_ok); - TEST_CHECK(out == (void *)i); - TEST_CHECK(vieter_tree_insert(tree, i, NULL) == vieter_tree_already_present); - TEST_CHECK(vieter_tree_search(&out, tree, i) == vieter_tree_ok); - - out = NULL; - - TEST_CHECK(vieter_tree_iterator_next(&out, iter) == vieter_tree_ok); - TEST_CHECK(out == (void *)i); - } - - TEST_CHECK(vieter_tree_iterator_next(&out, iter) == vieter_tree_iterator_done); - - vieter_tree_iterator_free(&iter); - vieter_tree_free(tree); -} - -void test_remove() { - vieter_tree *tree = vieter_tree_init(); - - for (uint64_t i = 0; i < 250; i++) { - TEST_CHECK(vieter_tree_insert(tree, i, NULL) == vieter_tree_ok); - TEST_CHECK(vieter_tree_validate(tree)); - } - - void *out; - - for (uint64_t i = 0; i < 250; i++) { - TEST_CHECK(vieter_tree_search(&out, tree, i) == vieter_tree_ok); - TEST_CHECK(vieter_tree_remove(&out, tree, i) == vieter_tree_ok); - TEST_CHECK(vieter_tree_validate(tree)); - TEST_CHECK(vieter_tree_search(&out, tree, i) == vieter_tree_not_present); - TEST_SIZE(tree, 250 - i - 1); - } - - vieter_tree_free(tree); -} - -TEST_LIST = { - {"tree init", test_init}, - {"tree insert", test_insert}, - {"tree remove", test_remove}, - {NULL, NULL} -}; diff --git a/test/tree/test_tree_random.c b/test/tree/test_tree_random.c deleted file mode 100644 index d1b9ab0..0000000 --- a/test/tree/test_tree_random.c +++ /dev/null @@ -1,59 +0,0 @@ -#include "acutest.h" -#include "vieter_tree_internal.h" - -#define TEST_SIZE(tree, size) \ - TEST_CHECK(vieter_tree_size(tree) == size); \ - TEST_MSG("Size: %zu", vieter_tree_size(tree)) - -int uint64_t_compare(const void *a, const void *b) { - if ((*(uint64_t *)a) < (*(uint64_t *)b)) { - return -1; - } else if ((*(uint64_t *)a) > (*(uint64_t *)b)) { - return 1; - } else { - return 0; - } -} - -void test_insert_random() { - const uint64_t n = 1000; - srand(0); - - vieter_tree *tree = vieter_tree_init(); - - uint64_t *numbers = malloc(n * sizeof(uint64_t)); - uint64_t num; - void *out = NULL; - - for (uint64_t i = 0; i < n; i++) { - num = rand(); - vieter_tree_insert(tree, num, (void *)num); - TEST_SIZE(tree, i + 1); - TEST_CHECK(vieter_tree_validate(tree)); - TEST_CHECK(vieter_tree_search(&out, tree, num) == vieter_tree_ok); - TEST_CHECK(out == (void *)num); - - out = NULL; - - numbers[i] = num; - } - - qsort(numbers, n, sizeof(uint64_t), uint64_t_compare); - - vieter_tree_iterator *iter = vieter_tree_iterator_from(tree); - out = NULL; - - for (uint64_t i = 0; i < n; i++) { - TEST_CHECK(vieter_tree_iterator_next(&out, iter) == vieter_tree_ok); - TEST_CHECK(out == (void *)numbers[i]); - } - - free(numbers); - vieter_tree_iterator_free(&iter); - vieter_tree_free(tree); -} - -TEST_LIST = { - {"tree insert random", test_insert_random}, - {NULL, NULL} -};