diff --git a/development/libs/libbowl/.build.yml b/development/libs/libbowl/.build.yml new file mode 100644 index 00000000000..bd2f7d78606 --- /dev/null +++ b/development/libs/libbowl/.build.yml @@ -0,0 +1,11 @@ +image: archlinux +packages: + - cmake + - gcc +sources: + - https://git.sr.ht/~spacekookie/libbowl +tasks: + - build: | + cd libbowl + cmake . + make diff --git a/development/libs/libbowl/.gitignore b/development/libs/libbowl/.gitignore new file mode 100644 index 00000000000..a35b02021dc --- /dev/null +++ b/development/libs/libbowl/.gitignore @@ -0,0 +1,63 @@ +CMakeLists.txt.user +CMakeCache.txt +CMakeFiles +CMakeScripts +Testing +Makefile +cmake_install.cmake +install_manifest.txt +compile_commands.json +CTestTestfile.cmake +_deps +# Prerequisites +*.d + +# Object files +*.o +*.ko +*.obj +*.elf + +# Linker output +*.ilk +*.map +*.exp + +# Precompiled Headers +*.gch +*.pch + +# Libraries +*.lib +*.a +*.la +*.lo + +# Shared objects (inc. Windows DLLs) +*.dll +*.so +*.so.* +*.dylib + +# Executables +*.exe +*.out +*.app +*.i*86 +*.x86_64 +*.hex + +# Debug files +*.dSYM/ +*.su +*.idb +*.pdb + +# Kernel Module Compile Results +*.mod* +*.cmd +.tmp_versions/ +modules.order +Module.symvers +Mkfile.old +dkms.conf diff --git a/development/libs/libbowl/CMakeLists.txt b/development/libs/libbowl/CMakeLists.txt new file mode 100644 index 00000000000..93e5d15cec8 --- /dev/null +++ b/development/libs/libbowl/CMakeLists.txt @@ -0,0 +1,32 @@ +cmake_minimum_required(VERSION 2.8.11) +set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c99") +set(BUILD_EXAMPLES 0 CACHE BOOL "Build the included examples projects") +set(LINK_DYNAMIC 0 CACHE BOOL "Set the default linking behaviour to `dynamic`") + +project(bowl) +set(SRC array.c + bowl.c + data.c + hash.c + utils.c) + +if(LINK_DYNAMIC) + add_library(bowl SHARED ${SRC}) +else() + add_library(bowl STATIC ${SRC}) +endif() + +target_include_directories(bowl PUBLIC ".") + +################### EXAMPLES ################### + +if(BUILD_EXAMPLES) + add_executable(example_tree examples/tree.c) + target_link_libraries(example_tree bowl) + + add_executable(example_list examples/list.c) + target_link_libraries(example_list bowl) + + add_executable(example_hash examples/hash.c) + target_link_libraries(example_hash bowl) +endif() diff --git a/development/libs/libbowl/LICENSE b/development/libs/libbowl/LICENSE new file mode 100644 index 00000000000..94a9ed024d3 --- /dev/null +++ b/development/libs/libbowl/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/development/libs/libbowl/README.md b/development/libs/libbowl/README.md new file mode 100644 index 00000000000..bd9ac7bddb0 --- /dev/null +++ b/development/libs/libbowl/README.md @@ -0,0 +1,73 @@ +libbowl [![][badge]][badge-link] +======= + +The last C datastructure library you will ever use. Provides a +versalite API to build nested, serial and hashed structure nodes. + +Check out the [issue tracker][issues] + +I hope you enjoy ❤ + +[badge]: https://builds.sr.ht/~spacekookie/libbowl.svg +[badge-link]: https://builds.sr.ht/~spacekookie/libbowl? +[issues]: https://todo.sr.ht/~spacekookie/libbowl + +Exampple +-------- + +The root structure in `libbowl` is a `bowl`. It can either be a leaf +node, containing some data (`bowl_data`, which can be many types), +or be a structure node, either in `ARRAY`, `LINK` or `HASH` mode. + +Each `libbowl` function returns a status code and uses reverse-input +pointers to communicate results. A convenience `DEBUG` macro is included. + +```C +bowl *list; +int r = bowl_malloc(&list, ARRAY); +if(r) { printf("Failed to malloc!\n"); exit(2); } + +// `DEBUG` does the same thing as the above `if` +bowl *number; +DEBUG (data_malloc(&number, INTEGER, 1312)) + +// Finally append data into list +DEBUG (bowl_append(list, number)) +``` + +Generally, `data` prefixed functions are convenience wrappers around +allocating a `bowl`, setting it's type to `LEAF`, and inserting some +data into it (performing at least 2 allocation calls). + +Freeing a `bowl` structure is as easy as calling free on the top node. + +```C +// ... +DEBUG (bowl_free(list)) +``` + +How to build +------------ + +Build dependencies + +- gcc (`4.0+`) +- cmake (`2.18+`) + +An out-of-source build is recommended. You can specify the linking +behaviour with `-DLINK_DYNAMIC=1`. Optionally you can disable tests +with `-DRUN_TESTS=0`. + +``` +$ mkdir build; cd build +$ cmake .. -DLINK_DYNAMIC=1 -DRUN_TESTS=1 +$ make +``` + +License +------- + +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. diff --git a/development/libs/libbowl/array.c b/development/libs/libbowl/array.c new file mode 100644 index 00000000000..78317e9a0fb --- /dev/null +++ b/development/libs/libbowl/array.c @@ -0,0 +1,129 @@ +#include "bowl.h" +#include "array.h" +#include "utils.h" + +#include + + +err_t array_malloc(struct bowl *self, size_t size) +{ + CHECK(self, INVALID_STATE) + CHECK((size > 0), INVALID_PARAMS) + + struct bowl_arr *arr = malloc(sizeof(struct bowl_arr)); + CHECK(arr, MALLOC_FAILED) + arr->size = size; + arr->used = 0; + + struct bowl **ptr = calloc(sizeof(struct bowl *), arr->size); + CHECK(ptr, MALLOC_FAILED) + arr->ptr = ptr; + + self->_pl.array = arr; + return OK; +} + +err_t array_insert(struct bowl *self, struct bowl *new) +{ + CHECK(self, INVALID_PARAMS) + CHECK(new, INVALID_PARAMS) + + struct bowl_arr *arr = self->_pl.array; + CHECK(arr, INVALID_STATE) + + err_t e = _array_rescale((void ***) &arr->ptr, &arr->size, arr->used); + if(e) return e; + + arr->ptr[arr->used++] = new; + return OK; +} + +err_t array_insert_key(struct bowl *self, size_t idx, struct bowl *new) +{ + CHECK(self, INVALID_PARAMS) + CHECK(new, INVALID_PARAMS) + + struct bowl_arr *arr = self->_pl.array; + CHECK(arr, INVALID_STATE) + CHECK((idx < arr->used), INVALID_PARAMS) + + err_t e = _array_rescale((void ***) &arr->ptr, &arr->size, arr->used); + if(e) return e; + + for(int i = idx + 1; idx < arr->used; i++) + arr->ptr[i] = arr->ptr[i - 1]; + + arr->ptr[idx] = new; + arr->used++; + + return OK; +} + +err_t array_swap_key(struct bowl *self, size_t idx, struct bowl *new, struct bowl **old) +{ + CHECK(self, INVALID_PARAMS) + CHECK(new, INVALID_PARAMS) + + struct bowl_arr *arr = self->_pl.array; + CHECK(arr, INVALID_STATE) + + (*old) = NULL; // Explicitly set to NULL if no such key + CHECK((idx < arr->used), INVALID_PARAMS) + + (*old) = arr->ptr[idx]; + arr->ptr[idx] = new; + + return OK; +} + +err_t array_remove(struct bowl *self, struct bowl *to_remove) +{ + CHECK(self, INVALID_PARAMS) + CHECK(to_remove, INVALID_PARAMS) + + struct bowl_arr *arr = self->_pl.array; + CHECK(arr, INVALID_STATE) + + size_t idx; + err_t e = _array_search((void **) arr->ptr, arr->size, &idx, to_remove); + if(e) return e; + + e = _array_remove((void **) arr->ptr, idx, arr->size, NULL); + return e; +} + +err_t array_remove_key(struct bowl *self, size_t idx, struct bowl **out) +{ + CHECK(self, INVALID_PARAMS); + struct bowl_arr *arr = self->_pl.array; + CHECK(arr, INVALID_STATE) + CHECK((idx < arr->used), INVALID_PARAMS) + + err_t e = _array_remove((void **) arr->ptr, idx, arr->size, (void **) out); + return e; +} + +err_t array_free(struct bowl *self) +{ + CHECK(self, INVALID_PARAMS) + struct bowl_arr *arr = self->_pl.array; + CHECK(arr, INVALID_STATE) + + err_t e; + for(int i = 0; i < arr->used; i++) { + e = bowl_free(arr->ptr[i]); + if(e) break; + } + + free(arr->ptr); + free(arr); + return e; +} + +err_t array_free_shallow(struct bowl_arr *arr) +{ + CHECK(arr, INVALID_STATE) + free(arr->ptr); + free(arr); + return OK; +} diff --git a/development/libs/libbowl/array.h b/development/libs/libbowl/array.h new file mode 100644 index 00000000000..a1ac8c06df7 --- /dev/null +++ b/development/libs/libbowl/array.h @@ -0,0 +1,29 @@ +#ifndef _ARRAY_H_ +#define _ARRAY_H_ + +#ifdef __cplusplus +extern "C" { +#endif + +#include "bowl.h" + +err_t array_malloc(struct bowl *, size_t); + +err_t array_insert(struct bowl *, struct bowl *); + +err_t array_insert_key(struct bowl *, size_t idx, struct bowl *); + +err_t array_swap_key(struct bowl *, size_t idx, struct bowl *, struct bowl **); + +err_t array_remove(struct bowl *, struct bowl *); + +err_t array_remove_key(struct bowl *, size_t, struct bowl **); + +err_t array_free(struct bowl *); + +err_t array_free_shallow(struct bowl_arr *); + +#ifdef __cplusplus +} +#endif +#endif // _ARRAY_H_ diff --git a/development/libs/libbowl/bowl.c b/development/libs/libbowl/bowl.c new file mode 100644 index 00000000000..9d12c69e81b --- /dev/null +++ b/development/libs/libbowl/bowl.c @@ -0,0 +1,151 @@ +#include "bowl.h" +#include "array.h" +#include "hash.h" + +#include +#include +#include + +#define ARRAY_START_SIZE 2 +#define HASH_START_SIZE 24 + +void *_get_data(struct bowl *ptr) +{ + switch(ptr->type) { + case ARRAY | HASH: return ptr->_pl.array; + case LINKED: return ptr->_pl.linked; + case LEAF: return ptr->_pl.data; + default: return NULL; + } +} + +err_t bowl_malloc(struct bowl **ptr, bowl_t type) +{ + CHECK((type != 0), INVALID_PARAMS) + + (*ptr) = malloc(sizeof(struct bowl)); + CHECK(*ptr, MALLOC_FAILED) + + memset(*ptr, 0, sizeof(struct bowl)); + (*ptr)->type = type; + + switch((*ptr)->type) { + case LEAF: return OK; // No further allocation needed + case ARRAY: + case HASH: return array_malloc(*ptr, ARRAY_START_SIZE); + default: return INVALID_STATE; + } + + return OK; +} + +err_t bowl_append(struct bowl *self, struct bowl *new) +{ + CHECK(self, INVALID_PARAMS) + CHECK(new, INVALID_PARAMS) + + switch(self->type) { + case LEAF: return INVALID_PARAMS; + case ARRAY: return array_insert(self, new); + + default: return INVALID_STATE; + } + + return OK; +} + +err_t bowl_insert_key(struct bowl *self, char *key, struct bowl *child) +{ + CHECK(self, INVALID_PARAMS) + CHECK(child, INVALID_PARAMS) + CHECK(key, INVALID_PARAMS) + + switch(self->type) { + case HASH: return hash_insert_key(self, key, child); + default: return INVALID_PARAMS; + } +} + +err_t bowl_insert_idx(struct bowl *self, size_t idx, struct bowl *child) +{ + CHECK(self, INVALID_PARAMS) + CHECK(child, INVALID_PARAMS) + CHECK((idx >= 0), INVALID_PARAMS) + + switch(self->type) { + case LEAF: return INVALID_PARAMS; + case ARRAY: return array_insert_key(self, idx, child); + + default: return INVALID_STATE; + } +} + +err_t bowl_swap_idx(struct bowl *self, size_t idx, struct bowl *child, struct bowl **prev) +{ + CHECK(self, INVALID_PARAMS) + CHECK(child, INVALID_PARAMS) + CHECK((idx >= 0), INVALID_PARAMS) + + switch(self->type) { + case LEAF: return INVALID_PARAMS; + case ARRAY: return array_swap_key(self, idx, child, prev); + + default: return INVALID_STATE; + } +} + +err_t bowl_remove(struct bowl *self, struct bowl *child) +{ + CHECK(self, INVALID_PARAMS) + CHECK(child, INVALID_PARAMS) + + switch(self->type) { + case LEAF: return INVALID_PARAMS; + case ARRAY: return array_remove(self, child); + + default: return INVALID_STATE; + } +} + +err_t bowl_remove_key(struct bowl *self, char *key, struct bowl **prev) +{ + CHECK(self, INVALID_PARAMS) + CHECK(key, INVALID_PARAMS) + + switch(self->type) { + case LEAF: return INVALID_PARAMS; + case HASH: return hash_remove_key(self, key, prev); + + default: return INVALID_STATE; + } +} + +err_t bowl_remove_idx(struct bowl *self, size_t idx, struct bowl **prev) +{ + CHECK(self, INVALID_PARAMS) + CHECK((idx >= 0), INVALID_PARAMS) + + switch(self->type) { + case LEAF: return INVALID_PARAMS; + case ARRAY: return array_remove_key(self, idx, prev); + + default: return INVALID_STATE; + } +} + +err_t bowl_free(struct bowl *self) +{ + CHECK(self, INVALID_PARAMS) + + err_t e; + switch(self->type) { + case LEAF: e = data_free(self->_pl.data); break; + case ARRAY: e = array_free(self); break; + case HASH: e = hash_free(self); break; + default: e = INVALID_STATE; break; + } + if(e) return e; + + free(self); + return OK; +} diff --git a/development/libs/libbowl/bowl.h b/development/libs/libbowl/bowl.h new file mode 100644 index 00000000000..ae1321e4189 --- /dev/null +++ b/development/libs/libbowl/bowl.h @@ -0,0 +1,103 @@ +#ifndef _BOWL_H_ +#define _BOWL_H_ + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#include + +#define REAL_STRLEN(str) (strlen(str) + 1) +#define CHECK(ptr, err) if(!ptr) return err; + +/** Define some generic error codes first that we can propagate **/ +typedef enum { + OK = 0, + ERR = -1, + NOT_IMPLEMENTED = 1, // A runtime error for missing features + + INVALID_PARAMS = 2, // A function didn't get the required parameters + MALLOC_FAILED = 3, // A memory allocation failed + INVALID_STATE = 4, // Calling an operation on an invalid state +} err_t; + +typedef enum { + LITERAL, // Any string that is \0 terminated + INTEGER, // Integer value + REAL, // Floating point value + BOOLEAN, // A 1-byte boolean + RAW // A platform-length pointer +} data_t; + +typedef enum { + LEAF = 1, ARRAY, HASH, LINKED +} bowl_t; + +struct bowl { + bowl_t type; + union { + struct data *data; + struct bowl_arr *array; + struct b_ptr *linked; + } _pl; +}; + +struct data { + data_t type; + union { + char *literal; + bool boolean; + long integer; + double real; + void *raw; + } _pl; +}; + +struct bowl_arr { + size_t size, used; + struct bowl **ptr; +}; + +struct b_ptr { + struct bowl *self; + struct b_ptr *next; +}; + +/// Allocate memory for an new, empty bowl node +err_t bowl_malloc(struct bowl **, bowl_t); + +/// Insert one node at the end of another +err_t bowl_append(struct bowl *, struct bowl *); + +/// Insert a node under a specific key (relevant for HASH nodes) +err_t bowl_insert_key(struct bowl *, char *key, struct bowl *); + +/// Insert a node into a specific index of another node +err_t bowl_insert_idx(struct bowl *, size_t idx, struct bowl *); + +/// Insert and swap a key in place, returning the old one +err_t bowl_swap_idx(struct bowl *, size_t idx, struct bowl *, struct bowl **); + +/// Remove a bowl node by it's pointer reference +err_t bowl_remove(struct bowl *, struct bowl *); + +/// Remove a specific key (relevant for HASH nodes) +err_t bowl_remove_key(struct bowl *, char *key, struct bowl **); + +/// Removing a bowl node with a key +err_t bowl_remove_idx(struct bowl *, size_t idx, struct bowl **); + +/// Cascade-free memory from a bowl node +err_t bowl_free(struct bowl *); + +/// Allocate memory for a new data node +err_t data_malloc(struct bowl **, data_t, ...); + +/// Free all data node memory +err_t data_free(struct data *); + +#ifdef __cplusplus +} +#endif +#endif // _BOWL_H_ diff --git a/development/libs/libbowl/data.c b/development/libs/libbowl/data.c new file mode 100644 index 00000000000..9077d9b2508 --- /dev/null +++ b/development/libs/libbowl/data.c @@ -0,0 +1,81 @@ +#include "bowl.h" + +#include +#include +#include +#include + +/// Allocate memory for a new data node +err_t data_malloc(struct bowl **self, data_t type, ...) +{ + err_t e; + va_list args; + + struct data *d = calloc(sizeof(struct data), 1); + CHECK(d, MALLOC_FAILED) + d->type = type; + + va_start(args, type); + switch(type) { + case LITERAL: { + char *lit = va_arg(args, char *); + size_t len = REAL_STRLEN(lit); + + d->_pl.literal = calloc(sizeof(char), len); + if(!d->_pl.literal) { + e = MALLOC_FAILED; + goto fail; + } + + strcpy(d->_pl.literal, lit); + break; + }; + case INTEGER: { + int i = va_arg(args, long); + d->_pl.integer = i; + break; + } + case REAL: { + int r = va_arg(args, double); + d->_pl.real = r; + break; + } + case BOOLEAN: { + int b = va_arg(args, int); + d->_pl.boolean = (bool) b; + break; + } + case RAW: { + void *raw = va_arg(args, void *); + d->_pl.raw = raw; + break; + } + default: e = INVALID_PARAMS; goto fail; + } + va_end(args); + + e = bowl_malloc(self, LEAF); + if(e) goto fail; + + (*self)->_pl.data = d; + return OK; + +fail: + if(d->type == LITERAL && d->_pl.literal) free(d->_pl.literal); + if(*self) bowl_free(*self); + if(d) free(d); + return e; +} + +/// Free all data node memory +err_t data_free(struct data *self) +{ + CHECK(self, INVALID_PARAMS) + switch(self->type) { + case LITERAL: free(self->_pl.literal); break; + default: break; + } + + free(self); + return OK; +} diff --git a/development/libs/libbowl/examples/hash.c b/development/libs/libbowl/examples/hash.c new file mode 100644 index 00000000000..7a06bbe7868 --- /dev/null +++ b/development/libs/libbowl/examples/hash.c @@ -0,0 +1,23 @@ +#include + +int main() +{ + + // Root node which contains a list + struct bowl *root; + bowl_malloc(&root, HASH); + + struct bowl *a; + data_malloc(&a, LITERAL, "Destroy capitalism"); + bowl_insert_key(root, "a", a); + + struct bowl *b; + data_malloc(&b, INTEGER, 1312); + bowl_insert_key(root, "b", b); + + struct bowl *c; + data_malloc(&c, LITERAL, "Alerta, Antifascista!"); + bowl_insert_key(root, "c", c); + + return bowl_free(root); +} diff --git a/development/libs/libbowl/examples/list.c b/development/libs/libbowl/examples/list.c new file mode 100644 index 00000000000..84205e283f0 --- /dev/null +++ b/development/libs/libbowl/examples/list.c @@ -0,0 +1,23 @@ +#include + +int main() +{ + + // Root node which contains a list + struct bowl *root; + bowl_malloc(&root, ARRAY); + + struct bowl *a; + data_malloc(&a, LITERAL, "Destroy capitalism"); + bowl_append(root, a); + + struct bowl *b; + data_malloc(&b, INTEGER, 1312); + bowl_append(root, b); + + struct bowl *c; + data_malloc(&c, LITERAL, "Alerta, Antifascista!"); + bowl_append(root, c); + + return bowl_free(root); +} diff --git a/development/libs/libbowl/examples/tree.c b/development/libs/libbowl/examples/tree.c new file mode 100644 index 00000000000..eb1b33a8d42 --- /dev/null +++ b/development/libs/libbowl/examples/tree.c @@ -0,0 +1,46 @@ +#include + +int main() +{ + err_t e; + + // Initialise a root node + struct bowl *root; + e = bowl_malloc(&root, ARRAY); + if(e) return e; + + // First Node + struct bowl *a; + e = data_malloc(&a, LITERAL, "Destroy capitalism"); + if(e) return e; + + // Second Node + struct bowl *b; + e = data_malloc(&b, INTEGER, 1312); + if(e) return e; + + // Third node is another ARRAY + struct bowl *c; + e = bowl_malloc(&c, ARRAY); + if(e) return e; + + // Fourth node is another string + struct bowl *d; + e = data_malloc(&d, LITERAL, "Alerta, Antifascista!"); + if(e) return e; + + // Add the d node to c + e = bowl_append(c, d); + if(e) e; + + // Add other nodes to root + e = bowl_append(root, a); + if(e) return e; + e = bowl_append(root, b); + if(e) return e; + e = bowl_append(root, c); + if(e) return e; + + e = bowl_free(root); + return e; +} diff --git a/development/libs/libbowl/hash.c b/development/libs/libbowl/hash.c new file mode 100644 index 00000000000..f1abfb34eca --- /dev/null +++ b/development/libs/libbowl/hash.c @@ -0,0 +1,126 @@ +#include "bowl.h" +#include "array.h" +#include "hash.h" +#include "utils.h" + +#include + +typedef struct { + char *key; + struct bowl *data; +} hash_item; + +err_t hash_insert_key(struct bowl *self, char *key, struct bowl *child) +{ + CHECK(self, INVALID_STATE) + CHECK(child, INVALID_STATE) + CHECK(key, INVALID_STATE) + + // Even though we're a HASH node, we use an array under the hood + struct bowl_arr *arr = self->_pl.array; + CHECK(arr, INVALID_STATE) + + size_t idx; + err_t e = _hash(key, arr->size, &idx); + if(e) return e; + + // If the index is used, rescale and try again + if(arr->ptr[idx] != NULL) { + struct bowl_arr *prev = arr; + + // Allocate new hash array + e = array_malloc(self, arr->size * 2); + if(e) return e; + + for(int i = 0; i < arr->size; i++) { + if(arr->ptr[i] != NULL) { + // FIXME: This is horrible + hash_item *item = (hash_item*) arr->ptr[i]; + e = hash_insert_key(self, item->key, item->data); + if(e) return e; + } + } + + e = hash_insert_key(self, key, child); + if(e) return e; + + hash_free_shallow(prev); + + } else { + hash_item *item = malloc(sizeof(hash_item)); + CHECK(item, MALLOC_FAILED) + + item->key = calloc(sizeof(char), REAL_STRLEN(key)); + CHECK(item->key, MALLOC_FAILED) + strcpy(item->key, key); + + item->data = child; + + arr->ptr[idx] = (struct bowl*) item; + arr->used += 1; + } + + return OK; +} + +err_t hash_remove_key(struct bowl *self, char *key, struct bowl **child) +{ + CHECK(self, INVALID_STATE) + CHECK(child, INVALID_STATE) + CHECK(key, INVALID_STATE) + + // Even though we're a HASH node, we use an array under the hood + struct bowl_arr *arr = self->_pl.array; + CHECK(arr, INVALID_STATE) + + size_t idx; + err_t e = _hash(key, arr->size, &idx); + if(e) return e; + + (*child) = arr->ptr[idx]; + arr->used -= 1; + arr->ptr[idx] = NULL; + return OK; +} + +err_t hash_free(struct bowl *self) +{ + CHECK(self, INVALID_PARAMS) + struct bowl_arr *arr = self->_pl.array; + CHECK(arr, INVALID_PARAMS) + + err_t e = OK; + for(int i = 0; i < arr->size; i++) { + hash_item *item = (hash_item *) arr->ptr[i]; + if(item != NULL) { + CHECK(item->data, INVALID_STATE) + CHECK(item->key, INVALID_STATE) + + e = bowl_free(item->data); + if(e) break; + + free(item->key); + free(item); + } + } + + free(arr->ptr); + free(arr); + return e; +} + +err_t hash_free_shallow(struct bowl_arr *arr) +{ + CHECK(arr, INVALID_PARAMS); + for(int i = 0; i < arr->size; i++) { + hash_item *item = (hash_item *) arr->ptr[i]; + if(item != NULL) { + free(item->key); + free(item); + } + } + + free(arr->ptr); + free(arr); + return OK; +} diff --git a/development/libs/libbowl/hash.h b/development/libs/libbowl/hash.h new file mode 100644 index 00000000000..369d8495e1a --- /dev/null +++ b/development/libs/libbowl/hash.h @@ -0,0 +1,15 @@ +#ifndef HASH_H_ +#define HASH_H_ + +#include "bowl.h" + +err_t hash_insert_key(struct bowl *, char *key, struct bowl *); + +err_t hash_remove_key(struct bowl *, char *key, struct bowl **); + +err_t hash_free(struct bowl *); + +err_t hash_free_shallow(struct bowl_arr *); + +#endif // HASH_H_ + diff --git a/development/libs/libbowl/utils.c b/development/libs/libbowl/utils.c new file mode 100644 index 00000000000..0979d07bd63 --- /dev/null +++ b/development/libs/libbowl/utils.c @@ -0,0 +1,116 @@ +#include +#include +#include +#include "utils.h" + +#define DELTA 0x2 +#define OVERSHOOT 0x8 + +err_t _array_rescale(void ***ptr, size_t *len, size_t use) +{ + CHECK(len, INVALID_PARAMS) + CHECK((use <= *len), INVALID_PARAMS) + CHECK(ptr, INVALID_PARAMS) + + // This is a simple linear scale strategy + if ((int) (*len - OVERSHOOT) >= (int) (use + DELTA)) *len -= OVERSHOOT; + if (use + DELTA >= *len) *len += DELTA; + + *ptr = realloc(*ptr, *len * sizeof(void *)); + return OK; +} + +err_t _array_search(void **ptr, size_t len, size_t *out, void *in) +{ + CHECK(ptr, INVALID_PARAMS) + CHECK(in, INVALID_PARAMS) + CHECK((len > 0), INVALID_PARAMS) + (*out) = -1; + + for(int i = 0; i < len; i++) + if((*ptr) == in) (*out) = i; + + return OK; +} + +err_t _array_remove(void **ptr, size_t idx, size_t len, void **out) +{ + CHECK(ptr, INVALID_PARAMS) + CHECK((idx >= 0), INVALID_PARAMS) + CHECK((len > idx), INVALID_PARAMS) + + if(out != NULL) (*out) = ptr[idx]; + for(int i = idx + 1; idx < len; i++) + ptr[i - 1] = ptr[i]; + + return OK; +} + +err_t _hash(char *str, size_t len, size_t *out) +{ + CHECK(str, INVALID_PARAMS) + CHECK((len > 0), INVALID_PARAMS) + + // Implements the "murmur" non-cryptographic hash + +#define C1 0xcc9e2d51 +#define C2 0x1b873593 +#define N 0xe6546b64 +#define M 5 +#define C3 0x85ebca6b +#define C4 0xc2b2ae35 +#define R1 15 +#define R2 13 +#define R3 16 +#define R4 13 +#define ROTL32(v, shift) ( ((v) << (shift)) | ( (v) >> (32 - (shift))) ) + + size_t key_len = strlen(str); + int l = (int) key_len / 4; + uint32_t seed = 0xAF172FE; + int i = 0; + + uint32_t k = 0; + uint32_t h = seed; + uint8_t *d = (uint8_t *) str; + const uint32_t *chunks = (const uint32_t *)(d + l * 4); + const uint8_t *tail = (const uint8_t *)(d + l * 4); + + for (i = -l; i != 0; ++i) { + k = chunks[i]; + k *= C1; + k = ROTL32(k, R1); + k *= C2; + h ^= k; + h = ROTL32(k, R2); + h = h * M + N; + } + + k = 0; + switch(key_len & 3) { + case 3: + k ^= (tail[2] << 16); + case 2: + k ^= (tail[1] << 8); + case 1: + k ^= tail[0]; + k *= C1; + k = ROTL32(k, R1); + k *= C2; + h ^= k; + default: break; + } + + /* Finalised hash */ + h ^= key_len; + h ^= (h >> R3); + h *= C3; + h ^= (h >> R4); + h *= C4; + h ^= (h >> R3); + + /* Finalise ✨ */ + h %= len; + *out = (size_t) h; + return OK; +} diff --git a/development/libs/libbowl/utils.h b/development/libs/libbowl/utils.h new file mode 100644 index 00000000000..4fa7a901317 --- /dev/null +++ b/development/libs/libbowl/utils.h @@ -0,0 +1,21 @@ +#ifndef _UTIL_H_ +#define _UTIL_H_ + +#ifdef __cplusplus +extern "C" { +#endif + +#include "bowl.h" + +err_t _array_rescale(void ***, size_t *len, size_t use); + +err_t _array_search(void **, size_t, size_t *out, void *in); + +err_t _array_remove(void **, size_t idx, size_t len, void **out); + +err_t _hash(char *str, size_t len, size_t *out); + +#ifdef __cplusplus +} +#endif +#endif // _UTIL_H_