diff options
| -rw-r--r-- | LICENSE | 674 | ||||
| -rw-r--r-- | Makefile.am | 1 | ||||
| -rwxr-xr-x | bootstrap | 5 | ||||
| -rw-r--r-- | configure.ac | 13 | ||||
| -rw-r--r-- | src/Makefile.am | 2 | ||||
| -rw-r--r-- | src/ix2.c | 632 | ||||
| -rw-r--r-- | src/ix2.h | 42 | ||||
| -rw-r--r-- | src/list.h | 252 | ||||
| -rw-r--r-- | src/test.c | 101 |
9 files changed, 1722 insertions, 0 deletions
@@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + 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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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 <http://www.gnu.org/licenses/>. + +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: + + <program> Copyright (C) <year> <name of author> + 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 +<http://www.gnu.org/licenses/>. + + 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 +<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/Makefile.am b/Makefile.am new file mode 100644 index 0000000..af437a6 --- /dev/null +++ b/Makefile.am @@ -0,0 +1 @@ +SUBDIRS = src diff --git a/bootstrap b/bootstrap new file mode 100755 index 0000000..99f6f06 --- /dev/null +++ b/bootstrap @@ -0,0 +1,5 @@ +#!/bin/sh + +aclocal \ +&& automake --gnu --add-missing \ +&& autoconf diff --git a/configure.ac b/configure.ac new file mode 100644 index 0000000..bc889ed --- /dev/null +++ b/configure.ac @@ -0,0 +1,13 @@ +AC_INIT([libix2], [1.0], [vcaputo@pengaru.com]) +AM_INIT_AUTOMAKE([-Wall -Werror foreign]) +AC_PROG_CC +AM_PROG_CC_C_O +AM_PROG_AR +AC_PROG_RANLIB +AM_SILENT_RULES([yes]) + +AC_CONFIG_FILES([ + Makefile + src/Makefile +]) +AC_OUTPUT diff --git a/src/Makefile.am b/src/Makefile.am new file mode 100644 index 0000000..c2387f2 --- /dev/null +++ b/src/Makefile.am @@ -0,0 +1,2 @@ +noinst_LIBRARIES = libix2.a +libix2_a_SOURCES = list.h ix2.c ix2.h diff --git a/src/ix2.c b/src/ix2.c new file mode 100644 index 0000000..fcdeb79 --- /dev/null +++ b/src/ix2.c @@ -0,0 +1,632 @@ +/* + * Copyright (C) 2018 Vito Caputo - <vcaputo@pengaru.com> + * + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 3 as published + * by the Free Software Foundation. + * + * 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 <http://www.gnu.org/licenses/>. + */ + +/* 2d spatial index - implemented as a quadtree */ + +/* There are various outstanding TODO items littered throughout this code, + * it's usable as-is but by no means finished or optimized. + */ + +#include <assert.h> +#include <stdlib.h> + +#include "ix2.h" +#include "list.h" + +typedef struct v2f_t { + float x, y; +} v2f_t; + +typedef struct aabb_t { + v2f_t min, max; +} aabb_t; + +typedef struct ix2_node_t ix2_node_t; + +typedef struct ix2_object_t { + list_head_t references; /* list of all ix2_node references to this object */ + list_head_t hits; /* node on hit list for non-point searches, to prevent potential double hits like when an object and search both span nodes */ + /* XXX: note this makes non-point searches non-reentrant! i.e. you can't perform another non-point search on the same ix2 + * from a search callback operating on the same ix2. TODO investigate efficient solutions. An obvious one is to simply put + * multiple of these nodes in every object and support a small number of simultaneous non-point searches, which may suffice. + */ + aabb_t aabb; /* AABB of this object */ + float aabb_len_sq; /* length(aabb.max - aabb.min)^2 TODO: this isn't utilized yet, optimization potential */ + void *object; /* user handle linking this object to the index */ +} ix2_object_t; + +typedef struct ix2_object_ref_t { + list_head_t objects; /* node on ix2_node objects list */ + list_head_t references; /* node on ix2_object references list */ + ix2_object_t *object; /* object being referenced */ + ix2_node_t *node; /* node referencing object */ +} ix2_object_ref_t; + +struct ix2_node_t { + v2f_t center; /* spatial center point of ix2_node */ + ix2_node_t *children; /* array of 4 child quadrants when not a leaf, NULL when a leaf */ + unsigned n_objects; /* number of objects in leaf when !children */ + list_head_t objects; /* list of all objects in leaf when !children */ +}; + +typedef struct ix2_t { + aabb_t aabb; /* spatial bounds of ix2 root */ + unsigned max_per_node; /* maximum number of objects to put in a node until max_depth reached */ + unsigned max_depth; /* maximum depth of ix2 tree where nodes cease being divided further */ + ix2_node_t root; /* root node of ix2 quadtree */ +} ix2_t; + +static ix2_object_t * add_object(ix2_t *ix2, unsigned *depth, ix2_node_t *node, aabb_t *node_aabb, ix2_object_t *object, ix2_object_ref_t **reference_cache); + + +/* Check if point resides within aabb */ +static inline int aabb_contains_point(aabb_t *aabb, v2f_t *point) +{ + assert(aabb); + assert(point); + + if (point->x < aabb->min.x) + return 0; + + if (point->x > aabb->max.x) + return 0; + + if (point->y < aabb->min.y) + return 0; + + if (point->y > aabb->max.y) + return 0; + + return 1; +} + + +/* check if a and b overlap */ +static inline int aabb_overlap(aabb_t *a, aabb_t *b) +{ + assert(a); + assert(b); + + return (a->min.x <= b->max.x && + a->max.x >= b->min.x && + a->min.y <= b->max.y && + a->max.y >= b->min.y); +} + + +/* initialize a node centered in aabb */ +static void init_node(ix2_node_t *node, aabb_t *aabb) +{ + assert(node); + assert(aabb); + + INIT_LIST_HEAD(&node->objects); + + node->center.x = aabb->min.x; + node->center.y = aabb->min.y; + node->center.x += .5f * (aabb->max.x - aabb->min.x); + node->center.y += .5f * (aabb->max.y - aabb->min.y); +} + + +/* initialize a quadrants aabb_t array from a parent node aabb and center point */ +static void init_quadrants(aabb_t *quadrants, aabb_t *parent_aabb, v2f_t *quadrants_center) +{ + assert(quadrants); + assert(parent_aabb); + assert(quadrants_center); +/* + +-+-+ + |0|1| + +-+-+ + |2|3| + +-+-+ +*/ + quadrants[0].min.x = parent_aabb->min.x; + quadrants[0].min.y = quadrants_center->y; + quadrants[0].max.x = quadrants_center->x; + quadrants[0].max.y = parent_aabb->max.y; + + quadrants[1].min.x = quadrants_center->x; + quadrants[1].min.y = quadrants_center->y; + quadrants[1].max.x = parent_aabb->max.x; + quadrants[1].max.y = parent_aabb->max.y; + + quadrants[2].min.x = parent_aabb->min.x; + quadrants[2].min.y = parent_aabb->min.y; + quadrants[2].max.x = quadrants_center->x; + quadrants[2].max.y = quadrants_center->y; + + quadrants[3].min.x = quadrants_center->x; + quadrants[3].min.y = parent_aabb->min.y; + quadrants[3].max.x = parent_aabb->max.x; + quadrants[3].max.y = quadrants_center->y; +} + + +/* Unlink a single object reference, disconnecting it from the object and node */ +static void unlink_object_ref(ix2_object_ref_t *ref) +{ + assert(ref); + + /* TODO: is there an actual need to maintain and detect the unlinked state w/NULL ptrs? */ + if (!ref->node) + return; + + list_del(&ref->objects); + list_del(&ref->references); + ref->node->n_objects--; + ref->object = NULL; + ref->node = NULL; +} + + +/* Unlink an object from the index, unlinking all node references. + * If references_cache is NULL, all unlinked references are freed. + * Otherwise, the unlinked references are added to the references_cache list. + */ +static void unlink_object(ix2_object_t *object, list_head_t *references_cache) +{ + ix2_object_ref_t *ref, *_ref; + + assert(object); + + list_for_each_entry_safe(ref, _ref, &object->references, references) { + unlink_object_ref(ref); + + if (references_cache) { + list_add_tail(&ref->references, references_cache); + continue; + } + + free(ref); + } +} + + +/* Link an object into a node. + * If ref is not NULL, it's an existing reference to move to a new node rather than allocating a new one. + * Returns the reference on success, NULL on failure + * On falure the supplied object is left intact. + */ +static ix2_object_ref_t * link_object(ix2_object_t *object, ix2_node_t *node, ix2_object_ref_t **cached_ref) +{ + ix2_object_ref_t *ref = NULL; + + assert(object); + assert(node); + + if (cached_ref && *cached_ref) { + ref = *cached_ref; + *cached_ref = NULL; + unlink_object_ref(ref); + } + + if (!ref) + ref = calloc(1, sizeof(ix2_object_ref_t)); + + if (!ref) + return NULL; + + list_add_tail(&ref->references, &object->references); + list_add_tail(&ref->objects, &node->objects); + ref->object = object; + ref->node = node; + node->n_objects++; + + return ref; +} + + +/* Compute the diagonal length of the aabb, leaving it squared */ +static inline float aabb_len_sq(aabb_t *aabb) +{ + float len_sq; + + assert(aabb); + + /* TODO: import the full v2f.h and do this with v2f_sub() && v2f_dot()? */ + len_sq = (aabb->max.x - aabb->min.x) * (aabb->max.x - aabb->min.x); + len_sq += (aabb->max.y - aabb->min.y) * (aabb->max.y - aabb->min.y); + + return len_sq; +} + + +/* remove an object */ +static void remove_object(ix2_object_t *object) +{ + assert(object); + + unlink_object(object, NULL); + free(object); +} + + +/* Split node and distribute objects referenced from node->objects into a + * newly created node->children. + */ +ix2_node_t * split_node(ix2_t *ix2, unsigned *depth, ix2_node_t *node, aabb_t *node_aabb) +{ + aabb_t quadrants[4]; + ix2_object_ref_t *r, *_r; + int i; + + assert(ix2); + assert(depth); + assert(node); + assert(!node->children); + assert(node_aabb); + + /* allocate and setup the children nodes */ + node->children = calloc(4, sizeof(ix2_node_t)); + if (!node->children) + goto _fail; + + init_quadrants(quadrants, node_aabb, &node->center); + for (i = 0; i < 4; i++) + init_node(&node->children[i], &quadrants[i]); + + /* distribute objects across node->children, removing node->objects + * references along the way. The references are supplied + */ + list_for_each_entry_safe(r, _r, &node->objects, objects) { + ix2_object_t *o = r->object; + + /* XXX: this can probably be done more efficiently */ + for (i = 0; i < 4; i++) { + if (!aabb_overlap(&quadrants[i], &o->aabb)) + continue; + + if (!add_object(ix2, depth, &node->children[i], &quadrants[i], o, &r)) + goto _fail; + } + } + + return node->children; + +_fail: + /* TODO: some kind of cleanup? */ + return NULL; +} + + +/* Add a member object to the space described by node && node_aabb + * + * This function may need to divide nodes and/or recur. + * + * Since it may need to allocate memory for object references via + * link_object(), and may need to allocate space for children + * nodes, it may fail. + * + * As an optimization, a list of object refs may be supplied in object_refs for + * use when linking the object. + * + * On failure NULL is returned and object is freed (including all its references). + * On success the supplied object is simply returned, with potentialy new references added. + */ +static ix2_object_t * add_object(ix2_t *ix2, unsigned *depth, ix2_node_t *node, aabb_t *node_aabb, ix2_object_t *object, ix2_object_ref_t **reference_cache) +{ + assert(ix2); + assert(depth); + assert(node); + assert(node_aabb); + assert(object); + + /* If not a leaf, simply recur on overlapping children */ + if (node->children) { + aabb_t quadrants[4]; + int i; + + *depth++; + init_quadrants(quadrants, node_aabb, &node->center); + for (i = 0; i < 4; i++) { + if (!aabb_overlap(&quadrants[i], &object->aabb)) + continue; + + if (!add_object(ix2, depth, &node->children[i], &quadrants[i], object, reference_cache)) + goto _fail; + } + *depth--; + + return object; + } + + + /* Node is a leaf, optimistically link the object to the node */ + if (!link_object(object, node, reference_cache)) + goto _fail; + + + /* If the node is overflowing, split it */ + if (node->n_objects > ix2->max_per_node && *depth < ix2->max_depth) { + *depth++; + if (!split_node(ix2, depth, node, node_aabb)) + goto _fail; + *depth--; + } + + return object; + +_fail: + remove_object(object); + + return NULL; +} + + +/* Create a new ix2 index with bounds aabb, splitting nodes > max_per_node until max_depth */ +ix2_t * ix2_new(aabb_t *aabb, unsigned max_per_node, unsigned max_depth) +{ + ix2_t *ix2; + + assert(aabb); + + ix2 = calloc(1, sizeof(ix2_t)); + if (!ix2) + return NULL; + + init_node(&ix2->root, aabb); + + ix2->aabb = *aabb; + ix2->max_per_node = max_per_node; + ix2->max_depth = max_depth; + + return ix2; +} + + +/* Free the index ix2 and everything associated with it */ +/* Note the external objects which have been indexed are not freed */ +void ix2_free(ix2_t *ix2) +{ + /* TODO: free everything */ + free(ix2); +} + + +/* Insert object spatially described by object_aabb into the index ix2 */ +ix2_object_t * ix2_insert_object(ix2_t *ix2, aabb_t *object_aabb, void *object) +{ + unsigned depth = 0; + ix2_object_t *o; + + assert(ix2); + assert(object_aabb); + assert(object_aabb->min.x <= object_aabb->max.x); + assert(object_aabb->min.y <= object_aabb->max.y); + + o = calloc(1, sizeof(ix2_object_t)); + if (!o) + return NULL; + + INIT_LIST_HEAD(&o->references); + INIT_LIST_HEAD(&o->hits); + + o->aabb = *object_aabb; + o->object = object; + o->aabb_len_sq = aabb_len_sq(object_aabb); + + if (!aabb_overlap(&ix2->aabb, object_aabb)) + return object; + + return add_object(ix2, &depth, &ix2->root, &ix2->aabb, o, NULL); +} + + +/* Remove object from the index ix2 and free it. */ +/* This may be either the object handle returned by ix2_node_insert(), or + * the handle supplied to ix2_search_cb(). + */ +void ix2_remove_object(ix2_t *ix2, ix2_object_t *object) +{ + assert(ix2); + assert(object); + + remove_object(object); +} + + +/* Move already inserted object to new aabb. */ +/* Returns object on success, NULL on failure. */ +/* On failure object is removed and freed. XXX: change to leave where it was? */ +ix2_object_t * ix2_move_object(ix2_t *ix2, ix2_object_t *object, aabb_t *object_aabb) +{ + unsigned depth = 0; + + assert(ix2); + assert(object); + assert(object_aabb); + assert(object_aabb->min.x <= object_aabb->max.x); + assert(object_aabb->min.y <= object_aabb->max.y); + + /* TODO FIXME: cache and reuse the references, requires changing + * add_object to receive a list of cached references rather than the + * singleton it currently expects. + * unlink_object() already knows how to leave those references on a + * supplied list head which is currently NULL. + */ + unlink_object(object, NULL); + + object->aabb = *object_aabb; + object->aabb_len_sq = aabb_len_sq(object_aabb); + + if (!aabb_overlap(&ix2->aabb, object_aabb)) + return object; + + return add_object(ix2, &depth, &ix2->root, &ix2->aabb, object, NULL /* TODO */); +} + + +/* Search for objects overlapping a point in index ix2. */ +/* Returns number of cb calls performed on hits, if cb is NULL calls will be skipped but hits still counted for return. */ +unsigned ix2_search_by_point(ix2_t *ix2, v2f_t *point, ix2_search_cb cb, void *cb_context) +{ + unsigned n_hits = 0; + ix2_object_ref_t *ref, *_ref; + ix2_node_t *node; + aabb_t node_aabb; + + assert(ix2); + assert(point); + + if (!aabb_contains_point(&ix2->aabb, point)) + return 0; + + node = &ix2->root; + node_aabb = ix2->aabb; + + /* find the leaf node containing point */ + while (node->children) { + aabb_t quadrants[4]; + int i; + + /* TODO: this can be done more efficiently - + * by simply comparing point to the center and + * deriving the index from that + */ + init_quadrants(quadrants, &node_aabb, &node->center); + for (i = 0; i < 4; i++) { + if (aabb_contains_point(&quadrants[i], point)) + break; + } + + node = &node->children[i]; + node_aabb = quadrants[i]; + } + + /* search the leaf for matches */ + list_for_each_entry_safe(ref, _ref, &node->objects, objects) { + if (!aabb_contains_point(&ref->object->aabb, point)) + continue; + + if (cb) { + ix2_search_status_t r; + + r = cb(cb_context, ref->object, &ref->object->aabb, ref->object->object); + if (r == IX2_SEARCH_STOP) + break; + + if (r == IX2_SEARCH_IGNORE) + continue; + } + + n_hits++; + } + + + return n_hits; +} + + +/* recursively search the specified node for objects overlapping with search_aabb, + * add hits to the list @ hits. + */ +static void search_node_by_aabb(ix2_node_t *node, aabb_t *node_aabb, aabb_t *search_aabb, list_head_t *hits) +{ + ix2_object_ref_t *ref, *_ref; + + assert(node); + assert(node_aabb); + assert(search_aabb); + assert(hits); + + if (node->children) { + aabb_t quadrants[4]; + int i; + + init_quadrants(quadrants, node_aabb, &node->center); + for (i = 0; i < 4; i++) { + if (aabb_overlap(&quadrants[i], search_aabb)) + search_node_by_aabb(&node->children[i], &quadrants[i], search_aabb, hits); + } + + return; + } + + + list_for_each_entry_safe(ref, _ref, &node->objects, objects) { + if (!aabb_overlap(&ref->object->aabb, search_aabb)) + continue; + + list_move_tail(&ref->object->hits, hits); + } +} + + +/* Search for objects overlapping an aabb in index ix2. */ +/* Returns number of cb calls performed on hits, if cb is NULL calls will be skipped but hits still counted for return. */ +unsigned ix2_search_by_aabb(ix2_t *ix2, aabb_t *search_aabb, ix2_search_cb cb, void *cb_context) +{ + unsigned n_hits = 0; + LIST_HEAD (hits); + ix2_object_t *o, *_o; + + assert(ix2); + assert(search_aabb); + + if (!aabb_overlap(&ix2->aabb, search_aabb)) + return 0; + + /* XXX: for the aabb-based search a list of hits is first constructed, + * this prevents multiple callbacks on the same object by first + * allowing those multiple hits to simply move the object within the + * hits list. In a separate pass the hits are processed with the + * callbacks. + * + * There are two unfortunate consquences to this approach: + * 1. No nested/reentrant aabb searches on the same ix2, as the hit list + * node is embedded in the ix2_object_t. + * 2. No way to terminate the search from the callback. + * This may be mitigated by adding a limit count to the search + * function, but that can't address scenarios where you want to + * terminate the search on something arbitrary like after the first + * hit of a specific object type. + * + * TODO: investigate alternative solutions. Obvious options: + * - Putting more than one hit list node in every object for limited + * nesting. + * - Maintain a per-search hash-table which gets accessed before + * every callback to see if the object has been seen already, adding + * it if not before calling the callback. This strikes me as very + * heavyweight. + */ + search_node_by_aabb(&ix2->root, &ix2->aabb, search_aabb, &hits); + + list_for_each_entry_safe(o, _o, &hits, hits) { + list_del_init(&o->hits); + + if (cb) { + ix2_search_status_t r; + + r = cb(cb_context, o, &o->aabb, o->object); + if (r == IX2_SEARCH_STOP) + break; + + if (r == IX2_SEARCH_IGNORE) + continue; + } + + n_hits++; + } + + /* just in case the search was aborted, finish deleting these nodes */ + /* FIXME: this whole hit list thing is pretty janky */ + list_for_each_entry_safe(o, _o, &hits, hits) + list_del_init(&o->hits); + + return n_hits; +} diff --git a/src/ix2.h b/src/ix2.h new file mode 100644 index 0000000..345a310 --- /dev/null +++ b/src/ix2.h @@ -0,0 +1,42 @@ +/* + * Copyright (C) 2018 Vito Caputo - <vcaputo@pengaru.com> + * + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 3 as published + * by the Free Software Foundation. + * + * 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 <http://www.gnu.org/licenses/>. + */ + +#ifndef _IX2_H +#define _IX2_H + +typedef struct ix2_object_t ix2_object_t; +typedef struct ix2_t ix2_t; +typedef struct aabb_t aabb_t; +typedef struct v2f_t v2f_t; + +typedef enum ix2_search_status_t { + IX2_SEARCH_STOP, + IX2_SEARCH_IGNORE, + IX2_SEARCH_CONTINUE +} ix2_search_status_t; + +typedef ix2_search_status_t (*ix2_search_cb)(void *cb_context, ix2_object_t *ix2_object, aabb_t *ix2_object_aabb, void *object); + +ix2_t * ix2_new(aabb_t *aabb, unsigned max_per_node, unsigned max_depth); +void ix2_free(ix2_t *ix2); +ix2_object_t * ix2_insert_object(ix2_t *ix2, aabb_t *aabb, void *object); +void ix2_remove_object(ix2_t *ix2, ix2_object_t *object); +ix2_object_t * ix2_move_object(ix2_t *ix2, ix2_object_t *object, aabb_t *aabb); +unsigned ix2_search_by_point(ix2_t *ix2, v2f_t *point, ix2_search_cb cb, void *arg); +unsigned ix2_search_by_aabb(ix2_t *ix2, aabb_t *aabb, ix2_search_cb cb, void *arg); +unsigned ix2_search_by_ray(ix2_t *ix2, v2f_t *origin, v2f_t *direction, ix2_search_cb cb, void *arg); + +#endif diff --git a/src/list.h b/src/list.h new file mode 100644 index 0000000..48bca36 --- /dev/null +++ b/src/list.h @@ -0,0 +1,252 @@ +#ifndef __LIST_H +#define __LIST_H + +/* linux kernel linked list interface */ + +/* + * Simple doubly linked list implementation. + * + * Some of the internal functions ("__xxx") are useful when + * manipulating whole lists rather than single entries, as + * sometimes we already know the next/prev entries and we can + * generate better code by using them directly rather than + * using the generic single-entry routines. + */ + +typedef struct list_head { + struct list_head *next, *prev; +} list_head_t; + +#define LIST_HEAD_INIT(name) { &(name), &(name) } + +#define LIST_HEAD(name) \ + struct list_head name = LIST_HEAD_INIT(name) + +#define INIT_LIST_HEAD(ptr) do { \ + (ptr)->next = (ptr); (ptr)->prev = (ptr); \ +} while (0) + +/* + * Insert a new entry between two known consecutive entries. + * + * This is only for internal list manipulation where we know + * the prev/next entries already! + */ +static inline void __list_add(struct list_head *new, + struct list_head *prev, + struct list_head *next) +{ + next->prev = new; + new->next = next; + new->prev = prev; + prev->next = new; +} + +/** + * list_add - add a new entry + * @new: new entry to be added + * @head: list head to add it after + * + * Insert a new entry after the specified head. + * This is good for implementing stacks. + */ +static inline void list_add(struct list_head *new, struct list_head *head) +{ + __list_add(new, head, head->next); +} + +/** + * list_add_tail - add a new entry + * @new: new entry to be added + * @head: list head to add it before + * + * Insert a new entry before the specified head. + * This is useful for implementing queues. + */ +static inline void list_add_tail(struct list_head *new, struct list_head *head) +{ + __list_add(new, head->prev, head); +} + +/* + * Delete a list entry by making the prev/next entries + * point to each other. + * + * This is only for internal list manipulation where we know + * the prev/next entries already! + */ +static inline void __list_del(struct list_head *prev, struct list_head *next) +{ + next->prev = prev; + prev->next = next; +} + +/** + * list_del - deletes entry from list. + * @entry: the element to delete from the list. + * Note: list_empty on entry does not return true after this, the entry is in an undefined state. + */ +static inline void list_del(struct list_head *entry) +{ + __list_del(entry->prev, entry->next); + entry->next = (void *) 0; + entry->prev = (void *) 0; +} + +/** + * list_del_init - deletes entry from list and reinitialize it. + * @entry: the element to delete from the list. + */ +static inline void list_del_init(struct list_head *entry) +{ + __list_del(entry->prev, entry->next); + INIT_LIST_HEAD(entry); +} + +/** + * list_move - delete from one list and add as another's head + * @list: the entry to move + * @head: the head that will precede our entry + */ +static inline void list_move(struct list_head *list, struct list_head *head) +{ + __list_del(list->prev, list->next); + list_add(list, head); +} + +/** + * list_move_tail - delete from one list and add as another's tail + * @list: the entry to move + * @head: the head that will follow our entry + */ +static inline void list_move_tail(struct list_head *list, + struct list_head *head) +{ + __list_del(list->prev, list->next); + list_add_tail(list, head); +} + +/** + * list_empty - tests whether a list is empty + * @head: the list to test. + */ +static inline int list_empty(struct list_head *head) +{ + return head->next == head; +} + +static inline void __list_splice(struct list_head *list, + struct list_head *head) +{ + struct list_head *first = list->next; + struct list_head *last = list->prev; + struct list_head *at = head->next; + + first->prev = head; + head->next = first; + + last->next = at; + at->prev = last; +} + +/** + * list_splice - join two lists + * @list: the new list to add. + * @head: the place to add it in the first list. + */ +static inline void list_splice(struct list_head *list, struct list_head *head) +{ + if (!list_empty(list)) + __list_splice(list, head); +} + +/** + * list_splice_init - join two lists and reinitialise the emptied list. + * @list: the new list to add. + * @head: the place to add it in the first list. + * + * The list at @list is reinitialised + */ +static inline void list_splice_init(struct list_head *list, + struct list_head *head) +{ + if (!list_empty(list)) { + __list_splice(list, head); + INIT_LIST_HEAD(list); + } +} + +/** + * list_entry - get the struct for this entry + * @ptr: the &struct list_head pointer. + * @type: the type of the struct this is embedded in. + * @member: the name of the list_struct within the struct. + */ +#define list_entry(ptr, type, member) \ + ((type *)((char *)(ptr)-(unsigned long)(&((type *)0)->member))) + +/** + * list_for_each - iterate over a list + * @pos: the &struct list_head to use as a loop counter. + * @head: the head for your list. + */ +#define list_for_each(pos, head) \ + for (pos = (head)->next; pos != (head); \ + pos = pos->next) +/** + * list_for_each_prev - iterate over a list backwards + * @pos: the &struct list_head to use as a loop counter. + * @head: the head for your list. + */ +#define list_for_each_prev(pos, head) \ + for (pos = (head)->prev; pos != (head); \ + pos = pos->prev) + +/** + * list_for_each_safe - iterate over a list safe against removal of list entry + * @pos: the &struct list_head to use as a loop counter. + * @n: another &struct list_head to use as temporary storage + * @head: the head for your list. + */ +#define list_for_each_safe(pos, n, head) \ + for (pos = (head)->next, n = pos->next; pos != (head); \ + pos = n, n = pos->next) + +/** + * list_for_each_entry - iterate over list of given type + * @pos: the type * to use as a loop counter. + * @head: the head for your list. + * @member: the name of the list_struct within the struct. + */ +#define list_for_each_entry(pos, head, member) \ + for (pos = list_entry((head)->next, typeof(*pos), member); \ + &pos->member != (head); \ + pos = list_entry(pos->member.next, typeof(*pos), member)) + +/** + * list_for_each_entry_prev - iterate over list of given type backwards + * @pos: the type * to use as a loop counter. + * @head: the head for your list. + * @member: the name of the list_struct within the struct. + */ +#define list_for_each_entry_prev(pos, head, member) \ + for (pos = list_entry((head)->prev, typeof(*pos), member); \ + &pos->member != (head); \ + pos = list_entry(pos->member.prev, typeof(*pos), member)) + + +/** + * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry + * @pos: the type * to use as a loop counter. + * @n: another type * to use as temporary storage + * @head: the head for your list. + * @member: the name of the list_struct within the struct. + */ +#define list_for_each_entry_safe(pos, n, head, member) \ + for (pos = list_entry((head)->next, typeof(*pos), member), \ + n = list_entry(pos->member.next, typeof(*pos), member); \ + &pos->member != (head); \ + pos = n, n = list_entry(n->member.next, typeof(*n), member)) + + +#endif diff --git a/src/test.c b/src/test.c new file mode 100644 index 0000000..8436e61 --- /dev/null +++ b/src/test.c @@ -0,0 +1,101 @@ +/* + * Copyright (C) 2018 Vito Caputo - <vcaputo@pengaru.com> + * + * This program is free software: you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 3 as published + * by the Free Software Foundation. + * + * 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 <http://www.gnu.org/licenses/>. + */ + + +#include <assert.h> +#include <stdio.h> + +#include <ix2.h> + +typedef struct v2f_t { + float x, y; +} v2f_t; + +typedef struct aabb_t { + v2f_t min, max; +} aabb_t; + + +ix2_search_status_t cb(void *cb_context, ix2_object_t *ix2_object, aabb_t *ix2_object_aabb, void *object) +{ + fprintf(stderr, "found %p ix2_object=%p ix2_object_aabb=%f,%f ... %f,%f\n", cb_context, ix2_object, + ix2_object_aabb->min.x, ix2_object_aabb->min.y, ix2_object_aabb->max.x, ix2_object_aabb->max.y); + + return IX2_SEARCH_CONTINUE; +} + +typedef struct object_t { + aabb_t aabb; + ix2_object_t *ix; +} object_t; + +int main(int argc, char *argv[]) +{ + object_t objects[] = { + { .aabb = {{ -1.f, -1.f }, { 1.f, 1.f }} }, + { .aabb = {{ -.2f, -.2f }, { -.1f, -.1f }} }, + { .aabb = {{ -.2f, .2f }, { -.1f, .3f }} }, + { .aabb = {{ .1f, .1f }, { .2f, .2f }} }, + { .aabb = {{ -.2f, -.2f }, { .1f, .1f }} }, + { .aabb = {{ -.1f, -.1f }, { .2f, .2f }} }, + }; + aabb_t aabb = {{ -1.f, -1.f }, {1.f, 1.f }}; + + ix2_object_t *o, *j; + ix2_t *ix2; + + ix2 = ix2_new(&aabb, 2, 8); + if (!ix2) { + fprintf(stderr, "unable to create index\n"); + return 1; + } + + for (int i = 0; i < sizeof(objects) / sizeof(*objects); i++) { + objects[i].ix = ix2_insert_object(ix2, &objects[i].aabb, &objects[i]); + if (!o) { + fprintf(stderr, "unable to insert object %i\n", i); + return 1; + } + } + + for (int i = 0; i < sizeof(objects) / sizeof(*objects); i++) { + /* TODO: actually verify the expected objects are hit */ + if (!ix2_search_by_point(ix2, &objects[i].aabb.min, cb, &objects[i])) { + fprintf(stderr, "unable to lookup object %i by min point\n", i); + return 1; + } + + if (!ix2_search_by_point(ix2, &objects[i].aabb.max, cb, &objects[i])) { + fprintf(stderr, "unable to lookup object %i by max point\n", i); + return 1; + } + } + + for (int i = 0; i < sizeof(objects) / sizeof(*objects); i++) { + /* TODO: actually verify the expected objects are hit */ + if (!ix2_search_by_aabb(ix2, &objects[i].aabb, cb, &objects[i])) { + fprintf(stderr, "unable to lookup object %i by perfect aabb\n", i); + return 1; + } + } + + for (int i = 0; i < sizeof(objects) / sizeof(*objects); i++) + ix2_remove_object(ix2, objects[i].ix); + + ix2_free(ix2); + + return 0; +} |