diff options
| -rw-r--r-- | AUTHORS | 3 | ||||
| -rw-r--r-- | COPYING | 661 | ||||
| -rw-r--r-- | README | 9 | ||||
| -rw-r--r-- | doc/mainpage.dox | 8 | ||||
| -rw-r--r-- | doc/reference.doxygen.in | 1517 | ||||
| -rw-r--r-- | sord.pc.in | 10 | ||||
| -rw-r--r-- | sord/sord.h | 350 | ||||
| -rw-r--r-- | src/sord.c | 1142 | ||||
| -rw-r--r-- | src/sord_test.c | 347 | ||||
| l--------- | waf | 1 | ||||
| -rw-r--r-- | wscript | 106 |
11 files changed, 4154 insertions, 0 deletions
@@ -0,0 +1,3 @@ +Author: + +David Robillard <dave@drobilla.net> <http://drobilla.net> @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero 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 your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +<http://www.gnu.org/licenses/>. @@ -0,0 +1,9 @@ +Sord +---- + +Sord is a lightweight C library for storing RDF statements in memory. + +For more information, see <http://drobilla.net/software/sord>. + + -- David Robillard <d@drobilla.net> + diff --git a/doc/mainpage.dox b/doc/mainpage.dox new file mode 100644 index 0000000..d098ce1 --- /dev/null +++ b/doc/mainpage.dox @@ -0,0 +1,8 @@ +/** @mainpage + * @section Overview + * + * <a href="http://drobilla.net/software/qure">Qure</a> is a lightweight + * RDF store based on Tokyo Cabinet. + * + * \li \link qure Public Interface \endlink - C API + */ diff --git a/doc/reference.doxygen.in b/doc/reference.doxygen.in new file mode 100644 index 0000000..cfb13a9 --- /dev/null +++ b/doc/reference.doxygen.in @@ -0,0 +1,1517 @@ +# Doxyfile 1.6.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = Sord + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = @SORD_VERSION@ + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = @SORD_DOC_DIR@ + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = NO + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = NO + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it parses. +# With this tag you can assign which parser to use for a given extension. +# Doxygen has a built-in mapping, but you can override or extend it using this tag. +# The format is ext=language, where ext is a file extension, and language is one of +# the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, +# Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate getter +# and setter methods for a property. Setting this option to YES (the default) +# will make doxygen to replace the get and set methods by a property in the +# documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penality. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will rougly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols + +SYMBOL_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = NO + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = YES + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = NO + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = NO + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = YES + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = NO + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = NO + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = NO + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = NO + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. +# This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command <command> <input-file>, where <command> is the value of +# the FILE_VERSION_FILTER tag, and <input-file> is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by +# doxygen. The layout file controls the global structure of the generated output files +# in an output format independent way. The create the layout file that represents +# doxygen's defaults, run doxygen with the -l option. You can optionally specify a +# file name after the option, if omitted DoxygenLayout.xml will be used as the name +# of the layout file. + +LAYOUT_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = YES + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = @SORD_SRCDIR@/doc/mainpage.dox \ + @SORD_SRCDIR@/sord/sord.h +# \ +# @SORD_SRCDIR@/src/sord.c + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = *.c + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command <filter> <input-file>, where <filter> +# is the value of the INPUT_FILTER tag, and <input-file> is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. +# If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. +# Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. +# The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. +# Otherwise they will link to the documentation. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = NO + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER +# are set, an additional index file will be generated that can be used as input for +# Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated +# HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. +# For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see +# <a href="http://doc.trolltech.com/qthelpproject.html#custom-filters">Qt Help Project / Custom Filters</a>. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's +# filter section matches. +# <a href="http://doc.trolltech.com/qthelpproject.html#filter-attributes">Qt Help Project / Filter Attributes</a>. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to YES, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. + +GENERATE_TREEVIEW = NO + +# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, +# and Class Hierarchy pages using a tree view instead of an ordered list. + +USE_INLINE_TREES = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +# When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP) +# there is already a search function so this one should typically +# be disabled. + +SEARCHENGINE = NO + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = NO + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = NO + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = YES + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. +# This is useful +# if you want to understand what is going on. +# On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse +# the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = NO + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. + +CLASS_DIAGRAMS = NO + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = YES + +# By default doxygen will write a font called FreeSans.ttf to the output +# directory and reference it in all dot files that doxygen generates. This +# font does not include all possible unicode characters however, so when you need +# these (or just want a differently looking font) you can specify the font name +# using DOT_FONTNAME. You need need to make sure dot is able to find the font, +# which can be done by putting it in a standard location or by setting the +# DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory +# containing the font. + +DOT_FONTNAME = FreeSans + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the output directory to look for the +# FreeSans.ttf font (which doxygen will put there itself). If you specify a +# different font using DOT_FONTNAME you can set the path where dot +# can find it using this tag. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = NO + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = NO + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = NO + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = NO + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = NO + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES diff --git a/sord.pc.in b/sord.pc.in new file mode 100644 index 0000000..9dd1223 --- /dev/null +++ b/sord.pc.in @@ -0,0 +1,10 @@ +prefix=@prefix@ +exec_prefix=@exec_prefix@ +libdir=@libdir@ +includedir=@includedir@ + +Name: libsord +Version: @SORD_VERSION@ +Description: Lightweight RDF triple store based on Tokyo Cabinet +Libs: -L${libdir} -lsord +Cflags: -I${includedir} diff --git a/sord/sord.h b/sord/sord.h new file mode 100644 index 0000000..88af9bd --- /dev/null +++ b/sord/sord.h @@ -0,0 +1,350 @@ +/* Sord, a lightweight RDF model library. + * Copyright 2010-2011 David Robillard <d@drobilla.net> + * + * Sord is free software: you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * Sord 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 Lesser General Public + * License for details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +#ifndef SORD_SORD_H +#define SORD_SORD_H + +#include <stdbool.h> +#include <stdint.h> +#include <stdio.h> + +/** @cond */ +#if defined _WIN32 || defined __CYGWIN__ + #define SORD_LIB_IMPORT __declspec(dllimport) + #define SORD_LIB_EXPORT __declspec(dllexport) +#else + #define SORD_LIB_IMPORT __attribute__ ((visibility("default"))) + #define SORD_LIB_EXPORT __attribute__ ((visibility("default"))) +#endif + +#ifdef SORD_SHARED // Building a shared library + #ifdef SORD_INTERNAL // Building SORD (not using it) + #define SORD_API SORD_LIB_EXPORT + #else + #define SORD_API SORD_LIB_IMPORT + #endif +#else // Building a static library + #define SORD_API +#endif +/** @endcond */ + +/** @defgroup sord Public Sord API + * Sord is an RDF tuple store implemented in C. + * Sord stores RDF (subject object predicate) triples, where triples may + * have an added "context" field, i.e. (subject object predicate context). + * @{ + */ + +typedef struct _Sord* Sord; ///< Tuple store +typedef struct _SordIter* SordIter; ///< Store iterator +typedef struct _SordNode* SordNode; ///< Node + +typedef void* SordID; ///< Integer ID of a Node (0 reserved for NULL) +typedef int SordCount; ///< Count of nodes or triples + + +/** Tuple of IDs (statement), or a tuple pattern. + * Nodes are ordered (S P O G). The ID of the default graph is 0. + */ +typedef SordID SordTuple[4]; + +/** Type of a node */ +typedef enum { + SORD_URI = 1, ///< URI + SORD_BLANK = 2, ///< Blank node identifier + SORD_LITERAL = 3 ///< Literal (string with optional lang and/or type) +} SordNodeType; + +/** @name Initialisation and Cleanup */ +//@{ + +/** Create a new store for the given @a path */ +SORD_API +Sord +sord_new(); + +/** Set a store option. + * Options are RDF properties (with the store as the subject), with the + * restriction that each has at most one value. + * If @a value is NULL, the option is unset (i.e. the property is removed). + * + * Known options (with acceptable types): + * - http://drobilla.net/ns/sord#index-spo :: xsd:boolean + * - http://drobilla.net/ns/sord#index-sop :: xsd:boolean + * - http://drobilla.net/ns/sord#index-ops :: xsd:boolean + * - http://drobilla.net/ns/sord#index-osp :: xsd:boolean + * - http://drobilla.net/ns/sord#index-pso :: xsd:boolean + * - http://drobilla.net/ns/sord#index-pos :: xsd:boolean + * + * @param sord Store + * @param key URI of this option (predicate) + * @param value String of option value (object) + * @param type Type of @a value + * @param datatype Data type of @a value (if @a type is SORD_LITERAL), or NULL + * @param lang Language of @a value (if @a type is SORD_LITERAL), or NULL + */ +SORD_API +void +sord_set_option(Sord sord, const char* key, const char* value, + SordNodeType type, const char* datatype, const char* lang); + +/** Open store on disk. */ +SORD_API +bool +sord_open(Sord sord); + +/** Close store on disk. */ +SORD_API +void +sord_close(Sord sord); + +/** Close and free @a sord, leaving disk data intact. */ +SORD_API +void +sord_free(Sord sord); + +//@} + +/** @name Node Loading + * Searching for node IDs by value and loading nodes from disk by ID. + */ + +//@{ + +/** Set the free function for node opaque user data. */ +SORD_API +void +sord_node_set_user_data_free_function(Sord sord, void (*f)(void*)); + +/** Dereference an ID, loading node data into memory. + * The returned node is allocated memory owned by @a sord, + * it can only be freed by the caller via sord_clear_cache. + */ +SORD_API +SordNode +sord_node_load(Sord sord, SordID id); + +/** Set @a s, @a p, and @a o to the nodes in @a tup. + * The actual node values will be loaded from the database into memory + * as necessary, and remain in memory until @ref sord_clear_cache is called. + */ +SORD_API +void +sord_tuple_load(Sord sord, + SordTuple tup, + SordNode* s, + SordNode* p, + SordNode* o); + +/** Clear in-memory node cache (possibly removing unused nodes on disk). */ +SORD_API +void +sord_clear_cache(Sord write); + +/** Find a URI, creating a new one if necessary iff @a create is true. + * Use sord_get_uri_counted instead if the length of @a str is known. + */ +SORD_API +SordID +sord_get_uri(Sord sord, bool create, const char* str); + +/** Find a URI, creating a new one if necessary iff @a create is true. */ +SORD_API +SordID +sord_get_uri_counted(Sord sord, bool create, const char* str, int str_len); + +/** Find a blank, creating a new one if necessary iff @a create is true + * Use sord_get_blank_counted instead if the length of @a str is known. + */ +SORD_API +SordID +sord_get_blank(Sord sord, bool create, const char* str); + +/** Find a blank, creating a new one if necessary iff @a create is true. */ +SORD_API +SordID +sord_get_blank_counted(Sord sord, bool create, const char* str, int str_len); + +/** Find a literal, creating a new one if necessary iff @a create is true. + * Use sord_get_literal_counted instead if the length of @a str is known. + */ +SORD_API +SordID +sord_get_literal(Sord sord, bool create, SordID type, + const char* str, const char* lang); + +/** Find a literal, creating a new one if necessary iff @a create is true. */ +SORD_API +SordID +sord_get_literal_counted(Sord sord, bool create, SordID type, + const char* str, int str_len, + const char* lang, uint8_t lang_len); + +//@} + +/** @name Node Values + * Investigating loaded (in-memory) node values. + */ +//@{ + +/** Return the type of a node (SORD_URI, SORD_BLANK, or SORD_LITERAL). */ +SORD_API +SordNodeType +sord_node_get_type(SordNode node); + +/** Return the string value of a node. */ +SORD_API +const char* +sord_node_get_string(SordNode node); + +/** Set an opaque user pointer on a node. + * Sord does not interpret the user pointer in any way, but it will be + * preserved on the node until the cache is cleared. + */ +SORD_API +void +sord_node_set_user_data(SordNode node, void* user_data); + +/** Get the opaque user pointer on a node. */ +SORD_API +void* +sord_node_get_user_data(SordNode node); + +/** Get the language of a literal node. */ +SORD_API +const char* +sord_literal_get_lang(SordNode node); + +/** Get the datatype URI of a literal node. */ +SORD_API +SordNode +sord_literal_get_datatype(SordNode node); + +//@} + +/** @name Read Operations */ +//@{ + +/** Return the number of nodes stored in @a sord. + * Nodes are included in this count iff they are a part of a tuple in @a sord. + */ +SORD_API +int +sord_num_nodes(Sord read); + +/** Return the number of tuples stored in @a sord. */ +SORD_API +int +sord_num_tuples(Sord read); + +/** Return an iterator to the start of the store. */ +SORD_API +SordIter +sord_begin(Sord read); + +/** Return an iterator that will iterate over each graph URI. */ +SORD_API +SordIter +sord_graphs_begin(Sord read); + +/** Search for a triple pattern. + * @return an iterator to the first match, or NULL if no matches found + */ +SORD_API +SordIter +sord_find(Sord sord, const SordTuple pat); + +//@} + + +/** @name Write Operations */ +//@{ + +/** Add a tuple to the store. */ +SORD_API +void +sord_add(Sord sord, const SordTuple tup); + +/** Remove a tuple from the store. + * This function invalidates all iterators to @a sord (use sord_remove_iter + * if this is undesirable) + */ +SORD_API +void +sord_remove(Sord sord, const SordTuple tup); + +/** Remove a tuple from the store by iterator. + * @a iter will be incremented to point at the next value. + */ +SORD_API +void +sord_remove_iter(Sord sord, SordIter iter); + +/** Remove a graph from the store. */ +SORD_API +void +sord_remove_graph(Sord sord, SordID graph); + +//@} + +/** @name Iteration */ +//@{ + +/** Set @a id to the tuple pointed to by @a iter. */ +SORD_API +void +sord_iter_get(SordIter iter, SordTuple tup); + +/** Return the store pointed to by @a iter. */ +SORD_API +Sord +sord_iter_get_sord(SordIter iter); + +/** Increment @a iter to point to the next statement. */ +SORD_API +bool +sord_iter_increment(SordIter iter); + +/** Return true iff @a iter is at the end of its range. */ +SORD_API +bool +sord_iter_is_end(SordIter iter); + +/** Free @a iter. */ +SORD_API +void +sord_iter_free(SordIter iter); + +//@} + +/** @name Utilities */ +//@{ + +/** Match two tuples (using ID comparison only). + * This function is a straightforward and fast equivalence match with wildcard + * support (ID 0 is a wildcard). It never performs any database access. + * @return true iff @a x and @a y match. + */ +SORD_API +bool +sord_tuple_match(const SordTuple x, const SordTuple y); + +//@} + +/** @} */ + +#endif // SORD_SORD_H diff --git a/src/sord.c b/src/sord.c new file mode 100644 index 0000000..23c1de4 --- /dev/null +++ b/src/sord.c @@ -0,0 +1,1142 @@ +/* Sord, a lightweight RDF model library. + * Copyright 2010-2011 David Robillard <d@drobilla.net> + * + * Sord is free software: you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * Sord 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 Lesser General Public + * License for details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +/** @file + * Sord Implementation. + * + * Tuples are represented as simple arrays of SordID, of length 4, + * which represent statements (RDF triples) with an optional + * context. When contexts are not used, only the first 3 elements + * are considered. + */ + +// C99 +#include <assert.h> +#include <errno.h> +#include <stdbool.h> +#include <stdint.h> +#include <stdio.h> +#include <stdlib.h> +#include <string.h> + +// GLib +#include <glib.h> + +#include "sord-config.h" +#include "sord/sord.h" + +#define SORD_LOG(prefix, ...) fprintf(stderr, "[Sord::" prefix "] " __VA_ARGS__) + +#ifdef SORD_DEBUG_ITER + #define SORD_ITER_LOG(...) SORD_LOG("iter", __VA_ARGS__) +#else + #define SORD_ITER_LOG(...) +#endif +#ifdef SORD_DEBUG_SEARCH + #define SORD_FIND_LOG(...) SORD_LOG("search", __VA_ARGS__) +#else + #define SORD_FIND_LOG(...) +#endif +#ifdef SORD_DEBUG_WRITE + #define SORD_WRITE_LOG(...) SORD_LOG("write", __VA_ARGS__) +#else + #define SORD_WRITE_LOG(...) +#endif + +#define NUM_ORDERS 12 +#define STATEMENT_LEN 3 +#define TUP_LEN STATEMENT_LEN + 1 +#define DEFAULT_ORDER SPO +#define DEFAULT_GRAPH_ORDER GSPO + +#define TUP_FMT "(%d %d %d %d)" +#define TUP_FMT_ARGS(t) ((t)[0]), ((t)[1]), ((t)[2]), ((t)[3]) + +#define TUP_S 0 +#define TUP_P 1 +#define TUP_O 2 +#define TUP_G 3 + +/** Triple ordering */ +typedef enum { + SPO, ///< Subject, Predicate, Object + SOP, ///< Subject, Object, Predicate + OPS, ///< Object, Predicate, Subject + OSP, ///< Object, Subject, Predicate + PSO, ///< Predicate, Subject, Object + POS, ///< Predicate, Object, Subject + GSPO, ///< Graph, Subject, Predicate, Object + GSOP, ///< Graph, Subject, Object, Predicate + GOPS, ///< Graph, Object, Predicate, Subject + GOSP, ///< Graph, Object, Subject, Predicate + GPSO, ///< Graph, Predicate, Subject, Object + GPOS, ///< Graph, Predicate, Object, Subject +} SordOrder; + +/** String name of each ordering (array indexed by SordOrder) */ +static const char* const order_names[NUM_ORDERS] = { + "spo", "sop", "ops", "osp", "pso", "pos", + "gspo", "gsop", "gops", "gosp", "gpso", "gpos" +}; + +/** Tuples of indices for each order, from most to least significant + * (array indexed by SordOrder) + */ +static const int orderings[NUM_ORDERS][TUP_LEN] = { + { 0,1,2,3}, { 0,2,1,3}, { 2,1,0,3}, { 2,0,1,3}, { 1,0,2,3}, { 1,2,0,3}, + {3,0,1,2 }, {3,0,2,1 }, {3,2,1,0 }, {3,2,0,1 }, {3,1,0,2 }, {3,1,2,0 } +}; + +/** Store Metadata */ +typedef struct { + SordCount n_tuples; + SordCount n_nodes; +} SordMeta; + +/** Store */ +struct _Sord { + GHashTable* names; ///< URI or blank node identifier string => ID + GHashTable* literals; ///< Literal => ID + + /** Index for each possible triple ordering (may or may not exist). + * If an index for e.g. SPO exists, it is a dictionary with + * (S P O) keys (as a SordTuplrID), and ignored values. + */ + GSequence* indices[NUM_ORDERS]; + + void (*user_data_free)(void*); ///< Destructor for node user data + + SordMeta* meta; +}; + +/** Mode for searching or iteration */ +typedef enum { + ALL, ///< Iterate to end of store, returning all results, no filtering + SINGLE, ///< Iteration over a single element (exact search) + RANGE, ///< Iterate over range with equal prefix + FILTER_RANGE, ///< Iterate over range with equal prefix, filtering + FILTER_ALL ///< Iterate to end of store, filtering +} SearchMode; + +/** Iterator over some range of a store */ +struct _SordIter { + Sord sord; ///< Store this is an iterator for + GSequenceIter* cur; ///< Current DB cursor + SordTuple pat; ///< Iteration pattern (in ordering order) + int ordering[TUP_LEN]; ///< Store ordering + SearchMode mode; ///< Iteration mode + int n_prefix; ///< Length of range prefix (RANGE, FILTER_RANGE) + bool end; ///< True iff reached end + bool skip_graphs; ///< True iff iteration should ignore graphs +}; + +#define PACKED __attribute__((__packed__)) + +/** Node (value in `nodes' hash table) */ +struct _SordNode { + uint8_t type; ///< SordNodeType + SordCount refs; + int size; ///< Size of node's data (not including type) + void* user_data; ///< Opaque user data + char data[]; ///< String for URI or BLANK, Literal for LITERAL +} PACKED; + +/** Literal value (possibly with type and/or language) */ +typedef struct _SordLiteral { + SordNode type; ///< Literal data type (ID of a URI node, or 0) + uint8_t lang_size; ///< Length of language, including terminator (or 0) + char data[]; ///< Language (terminated), followed by value string +} PACKED Literal; + +static char* +sord_literal_node_get_value(SordNode node) +{ + assert(node->type == SORD_LITERAL); + Literal* lit = (Literal*)node->data; + return lit->data + lit->lang_size; +} + +static unsigned +sord_literal_hash(const void* n) +{ + SordNode node = (SordNode)n; + return g_str_hash(sord_literal_node_get_value(node)); +} + +static gboolean +sord_literal_equal(const void* a, const void* b) +{ + SordNode a_node = (SordNode)a; + SordNode b_node = (SordNode)b; + // FIXME: type, lang + return g_str_equal(sord_literal_node_get_value(a_node), + sord_literal_node_get_value(b_node)); +} + +static inline int +sord_node_compare(Sord sord, const SordNode a, const SordNode b) +{ + if (a->type != b->type) + return a->type - b->type; + + Literal* lit_a; + Literal* lit_b; + switch ((SordNodeType)a->type) { + case SORD_URI: + case SORD_BLANK: + return strcmp(a->data, b->data); + case SORD_LITERAL: + // TODO: lang, type + lit_a = (Literal*)a->data; + lit_b = (Literal*)b->data; + return strcmp(sord_literal_node_get_value(a), sord_literal_node_get_value(b)); + } + assert(false); + return 0; +} + +/** Compare two IDs (dereferencing if necessary). + * The null ID, 0, is treated as a minimum (it is less than every other + * possible ID, except itself). This allows it to be used as a wildcard + * when searching, ensuring the search will reach the minimum possible + * key in the tree and iteration from that point will produce the entire + * result set. + */ +static inline int +sord_id_compare(Sord sord, const SordID a, const SordID b) +{ + if (a == b || !a || !b) { + return (const char*)a - (const char*)b; + } else { + SordNode a_node = sord_node_load(sord, a); + SordNode b_node = sord_node_load(sord, b); + const int ret = sord_node_compare(sord, a_node, b_node); + return ret; + } +} + +/** Return true iff IDs are equivalent, or one is a wildcard */ +static inline bool +sord_id_match(const SordID a, const SordID b) +{ + return !a || !b || (a == b); +} + +static inline bool +sord_tuple_match_inline(const SordTuple x, const SordTuple y) +{ + return sord_id_match(x[0], y[0]) + && sord_id_match(x[1], y[1]) + && sord_id_match(x[2], y[2]) + && sord_id_match(x[3], y[3]); +} + +bool +sord_tuple_match(const SordTuple x, const SordTuple y) +{ + return sord_tuple_match_inline(x, y); +} + +void +sord_tuple_load(Sord sord, SordTuple tup, SordNode* s, SordNode* p, SordNode* o) +{ + *s = sord_node_load(sord, tup[TUP_S]); + *p = sord_node_load(sord, tup[TUP_P]); + *o = sord_node_load(sord, tup[TUP_O]); +} + +/** Compare two tuple IDs lexicographically. + * NULL IDs (equal to 0) are treated as wildcards, always less than every + * other possible ID, except itself. + */ +static int +sord_tuple_compare(const void* x_ptr, const void* y_ptr, void* user_data) +{ + Sord const sord = (Sord)user_data; + SordID* const x = (SordID*)x_ptr; + SordID* const y = (SordID*)y_ptr; + + for (int i = 0; i < TUP_LEN; ++i) { + const int cmp = sord_id_compare(sord, x[i], y[i]); + if (cmp) + return cmp; + } + + return 0; +} + +static inline bool +sord_iter_next(SordIter iter) +{ + if (!iter->skip_graphs) { + iter->cur = g_sequence_iter_next(iter->cur); + return !g_sequence_iter_is_end(iter->cur); + } + + const SordID* key = (const SordID*)g_sequence_get(iter->cur); + const SordTuple initial = { key[0], key[1], key[2], key[3] }; + while (true) { + iter->cur = g_sequence_iter_next(iter->cur); + if (g_sequence_iter_is_end(iter->cur)) + return true; + + key = (const SordID*)g_sequence_get(iter->cur); + for (int i = 0; i < 3; ++i) + if (key[i] != initial[i]) + return false; + } + assert(false); +} + +/** Seek forward as necessary until @a iter points at a match. + * @return true iff iterator reached end of valid range. + */ +static inline bool +sord_iter_seek_match(SordIter iter) +{ + for (iter->end = true; + !g_sequence_iter_is_end(iter->cur); + sord_iter_next(iter)) { + const SordID* const key = (const SordID*)g_sequence_get(iter->cur); + if (sord_tuple_match_inline(key, iter->pat)) + return (iter->end = false); + } + return true; +} + +/** Seek forward as necessary until @a iter points at a match, or the prefix + * no longer matches iter->pat. + * @return true iff iterator reached end of valid range. + */ +static inline bool +sord_iter_seek_match_range(SordIter iter) +{ + if (iter->end) + return true; + + do { + const SordID* key = (const SordID*)g_sequence_get(iter->cur); + + if (sord_tuple_match_inline(key, iter->pat)) + return false; // Found match + + for (int i = 0; i < iter->n_prefix; ++i) { + if (!sord_id_match(key[i], iter->pat[i])) { + iter->end = true; // Reached end of valid range + return true; + } + } + } while (!sord_iter_next(iter)); + + return (iter->end = true); // Reached end +} + +static SordIter +sord_iter_new(Sord sord, GSequenceIter* cur, const SordTuple pat, + SordOrder order, SearchMode mode, int n_prefix) +{ + const int* ordering = orderings[order]; + + SordIter iter = malloc(sizeof(struct _SordIter)); + iter->sord = sord; + iter->cur = cur; + iter->mode = mode; + iter->n_prefix = n_prefix; + iter->end = false; + iter->skip_graphs = order < GSPO; + for (int i = 0; i < TUP_LEN; ++i) { + iter->pat[i] = pat[ordering[i]]; + iter->ordering[i] = ordering[i]; + } + + switch (iter->mode) { + case ALL: + case SINGLE: + case RANGE: + assert(sord_tuple_match_inline( + (const SordID*)g_sequence_get(iter->cur), + iter->pat)); + break; + case FILTER_RANGE: + sord_iter_seek_match_range(iter); + break; + case FILTER_ALL: + sord_iter_seek_match(iter); + break; + } + +#ifdef SORD_DEBUG_ITER + SordTuple value; + sord_iter_get(iter, value); + SORD_ITER_LOG("New %p pat=" TUP_FMT " cur=" TUP_FMT " end=%d\n", (void*)iter, + TUP_FMT_ARGS(pat), TUP_FMT_ARGS(value), iter->end); +#endif + return iter; +} + +Sord +sord_iter_get_sord(SordIter iter) +{ + return iter->sord; +} + +void +sord_iter_get(SordIter iter, SordTuple id) +{ + const SordID* key = (const SordID*)g_sequence_get(iter->cur); + id[iter->ordering[0]] = key[0]; + id[iter->ordering[1]] = key[1]; + id[iter->ordering[2]] = key[2]; + id[iter->ordering[3]] = key[3]; +} + +bool +sord_iter_increment(SordIter iter) +{ + if (iter->end) + return true; + + const SordID* key; + iter->end = sord_iter_next(iter); + if (!iter->end) { + switch (iter->mode) { + case ALL: + // At the end if the cursor is (assigned above) + break; + case SINGLE: + iter->end = true; + break; + case RANGE: + // At the end if the MSN no longer matches + key = (const SordID*)g_sequence_get(iter->cur); + assert(key); + for (int i = 0; i < iter->n_prefix; ++i) { + if (!sord_id_match(key[i], iter->pat[i])) { + iter->end = true; + break; + } + } + break; + case FILTER_RANGE: + // Seek forward to next match, stopping if prefix changes + sord_iter_seek_match_range(iter); + break; + case FILTER_ALL: + // Seek forward to next match + sord_iter_seek_match(iter); + break; + } + } + + if (iter->end) { + SORD_ITER_LOG("%p Reached end\n", (void*)iter); + return true; + } else { +#ifdef SORD_DEBUG_ITER + SordTuple tup; + sord_iter_get(iter, tup); + SORD_ITER_LOG("%p Increment to " TUP_FMT "\n", (void*)iter, TUP_FMT_ARGS(tup)); +#endif + return false; + } +} + +bool +sord_iter_is_end(SordIter iter) +{ + return !iter || iter->end; +} + +void +sord_iter_free(SordIter iter) +{ + SORD_ITER_LOG("%p Free\n", (void*)iter); + if (iter) { + free(iter); + } +} + +/** Return true iff @a sord has an index for @a order. + * If @a graph_search is true, @a order will be modified to be the + * corresponding order with a G prepended (so G will be the MSN). + */ +static inline bool +sord_has_index(Sord sord, SordOrder* order, int* n_prefix, bool graph_search) +{ + if (graph_search) { + *order += GSPO; + *n_prefix += 1; + } + + return sord->indices[*order]; +} + +/** Return the best available index for a pattern. + * @param pat Pattern in standard (S P O G) order + * @param mode Set to the (best) iteration mode for iterating over results + * @param n_prefix Set to the length of the range prefix + * (for @a mode == RANGE and @a mode == FILTER_RANGE) + */ +static inline SordOrder +sord_best_index(Sord sord, const SordTuple pat, SearchMode* mode, int* n_prefix) +{ + const bool graph_search = (pat[TUP_G] != 0); + + const unsigned sig + = (pat[0] ? 1 : 0) * 0x100 + + (pat[1] ? 1 : 0) * 0x010 + + (pat[2] ? 1 : 0) * 0x001; + + SordOrder good[2]; + + // Good orderings that don't require filtering + *mode = RANGE; + *n_prefix = 0; + switch (sig) { + case 0x000: *mode = ALL; return graph_search ? DEFAULT_GRAPH_ORDER : DEFAULT_ORDER; + case 0x001: *mode = RANGE; good[0] = OPS; good[1] = OSP; *n_prefix = 1; break; + case 0x010: *mode = RANGE; good[0] = POS; good[1] = PSO; *n_prefix = 1; break; + case 0x011: *mode = RANGE; good[0] = OPS; good[1] = POS; *n_prefix = 2; break; + case 0x100: *mode = RANGE; good[0] = SPO; good[1] = SOP; *n_prefix = 1; break; + case 0x101: *mode = RANGE; good[0] = SOP; good[1] = OSP; *n_prefix = 2; break; + case 0x110: *mode = RANGE; good[0] = SPO; good[1] = PSO; *n_prefix = 2; break; + case 0x111: *mode = SINGLE; return graph_search ? DEFAULT_GRAPH_ORDER : DEFAULT_ORDER; + } + + if (sord_has_index(sord, &good[0], n_prefix, graph_search)) { + return good[0]; + } else if (sord_has_index(sord, &good[1], n_prefix, graph_search)) { + return good[1]; + } + + // Not so good orderings that require filtering, but can + // still be constrained to a range + switch (sig) { + case 0x011: *mode = FILTER_RANGE; good[0] = OSP; good[1] = PSO; *n_prefix = 1; break; + case 0x101: *mode = FILTER_RANGE; good[0] = SPO; good[1] = OPS; *n_prefix = 1; break; + case 0x110: *mode = FILTER_RANGE; good[0] = SOP; good[1] = POS; *n_prefix = 1; break; + default: break; + } + + if (*mode == FILTER_RANGE) { + if (sord_has_index(sord, &good[0], n_prefix, graph_search)) { + return good[0]; + } else if (sord_has_index(sord, &good[1], n_prefix, graph_search)) { + return good[1]; + } + } + + if (graph_search) { + *mode = FILTER_RANGE; + *n_prefix = 1; + return DEFAULT_GRAPH_ORDER; + } else { + *mode = FILTER_ALL; + return DEFAULT_ORDER; + } +} + +static GSequence* +sord_new_btree() +{ + return g_sequence_new(NULL); +} + +Sord +sord_new() +{ + Sord sord = (Sord)malloc(sizeof(struct _Sord)); + sord->names = g_hash_table_new_full(g_str_hash, g_str_equal, 0, 0); + sord->literals = g_hash_table_new_full(sord_literal_hash, sord_literal_equal, 0, 0); + sord->user_data_free = NULL; + + for (unsigned i = 0; i < NUM_ORDERS; ++i) + sord->indices[i] = NULL; + + return sord; +} + +void +sord_free(Sord sord) +{ + if (!sord) + return; + + free(sord->meta); + g_hash_table_unref(sord->names); + g_hash_table_unref(sord->literals); + for (unsigned i = 0; i < NUM_ORDERS; ++i) + if (sord->indices[i]) + g_sequence_free(sord->indices[i]); + + free(sord); +} + +void +sord_set_option(Sord sord, const char* key, const char* value, + SordNodeType type, const char* datatype, const char* lang) +{ + const char* const prefix = "http://drobilla.net/ns/sord#"; + const size_t prefix_len = strlen(prefix); + if (strncmp(key, prefix, prefix_len)) { + fprintf(stderr, "Unknown option %s\n", key); + return; + } + + const char* option = key + prefix_len; + const bool value_is_true = !strcmp(value, "true") || !strcmp(value, "1") || !strcmp(value, "yes"); + if (!strcmp(option, "index-all")) { + for (int i = 0; i < NUM_ORDERS; ++i) { + sord->indices[i] = sord_new_btree(); + } + } else if (!strncmp(option, "index-", 6) && value_is_true) { + for (int i = 0; i < NUM_ORDERS; ++i) { + if (!strcmp(option + 6, order_names[i])) { + sord->indices[i] = sord_new_btree(); + return; + } + } + } else { + fprintf(stderr, "Unknown option %s\n", key); + } +} + +bool +sord_open(Sord sord) +{ + sord->meta = malloc(sizeof(SordMeta)); + memset(sord->meta, 0, sizeof(SordMeta)); + + bool no_indices = true; + for (unsigned i = 0; i < NUM_ORDERS; ++i) { + if (sord->indices[i]) { + no_indices = false; + break; + } + } + + if (no_indices) { + // Use default indexing, avoids O(n) in all cases + sord->indices[SPO] = sord_new_btree(); + sord->indices[OPS] = sord_new_btree(); + sord->indices[PSO] = sord_new_btree(); + sord->indices[GSPO] = sord_new_btree(); // XXX: default? do on demand? + } + + if (!sord->indices[DEFAULT_ORDER]) + sord->indices[DEFAULT_ORDER] = sord_new_btree(); + + return true; +} + +static void +sord_drop_node(Sord sord, SordID id) +{ + // FIXME: leak? +} + +int +sord_num_tuples(Sord sord) +{ + return sord->meta->n_tuples; +} + +int +sord_num_nodes(Sord sord) +{ + return sord->meta->n_nodes; +} + +void +sord_node_set_user_data_free_function(Sord sord, void (*f)(void*)) +{ + sord->user_data_free = f; +} + +SordIter +sord_begin(Sord sord) +{ + if (sord_num_tuples(sord) == 0) { + return NULL; + } else { + GSequenceIter* cur = g_sequence_get_begin_iter(sord->indices[DEFAULT_ORDER]); + SordTuple pat = { 0, 0, 0, 0 }; + return sord_iter_new(sord, cur, pat, DEFAULT_ORDER, ALL, 0); + } +} + +SordIter +sord_graphs_begin(Sord read) +{ + return NULL; +} + +static inline GSequenceIter* +index_search(Sord sord, GSequence* db, const SordTuple search_key) +{ + return g_sequence_search( + db, (void*)search_key, sord_tuple_compare, sord); +} + +static inline GSequenceIter* +index_lower_bound(Sord sord, GSequence* db, const SordTuple search_key) +{ + GSequenceIter* i = g_sequence_search( + db, (void*)search_key, sord_tuple_compare, sord); + + /* i is now at the position where search_key would be inserted, + but this is not necessarily a match, and we need the leftmost... + */ + + if (g_sequence_iter_is_begin(i)) { + return i; + } else if (g_sequence_iter_is_end(i)) { + i = g_sequence_iter_prev(i); + } + + if (!sord_tuple_match_inline(search_key, g_sequence_get(i))) { + // No match, but perhaps immediately after a match + GSequenceIter* const prev = g_sequence_iter_prev(i); + if (!sord_tuple_match_inline(search_key, g_sequence_get(prev))) { + return i; // No match (caller must check) + } else { + i = prev; + } + } + + /* i now points to some matching element, + but not necessarily the first... + */ + assert(sord_tuple_match_inline(search_key, g_sequence_get(i))); + + while (!g_sequence_iter_is_begin(i)) { + if (sord_tuple_match_inline(search_key, g_sequence_get(i))) { + GSequenceIter* const prev = g_sequence_iter_prev(i); + if (sord_tuple_match_inline(search_key, g_sequence_get(prev))) { + i = prev; + continue; + } + } + break; + } + + return i; +} + +SordIter +sord_find(Sord sord, const SordTuple pat) +{ + if (!pat[0] && !pat[1] && !pat[2] && !pat[3]) + return sord_begin(sord); + + SearchMode mode; + int prefix_len; + const SordOrder index_order = sord_best_index(sord, pat, &mode, &prefix_len); + const int* const ordering = orderings[index_order]; + + SORD_FIND_LOG("Find " TUP_FMT " index=%s mode=%d prefix_len=%d ordering=%d%d%d%d\n", + TUP_FMT_ARGS(pat), order_names[index_order], mode, prefix_len, + ordering[0], ordering[1], ordering[2], ordering[3]); + + // It's easiest to think about this algorithm in terms of (S P O) ordering, + // assuming (A B C) == (S P O). For other orderings this is not actually + // the case, but it works the same way. + const SordID a = pat[ordering[0]]; // Most Significant Node (MSN) + const SordID b = pat[ordering[1]]; // ... + const SordID c = pat[ordering[2]]; // ... + const SordID d = pat[ordering[3]]; // Least Significant Node (LSN) + + if (a && b && c) + mode = SINGLE; // No duplicate tuples (Sord is a set) + + SordTuple search_key = { a, b, c, d }; + GSequence* const db = sord->indices[index_order]; + GSequenceIter* const cur = index_lower_bound(sord, db, search_key); + const SordID* const key = (const SordID*)g_sequence_get(cur); + if (!key || ( (mode == RANGE || mode == SINGLE) + && !sord_tuple_match_inline(search_key, key) )) { + SORD_FIND_LOG("No match found\n"); + return NULL; + } + + return sord_iter_new(sord, cur, pat, index_order, mode, prefix_len); +} + +static SordID +sord_lookup_name(Sord sord, const char* str, int str_len) +{ + return g_hash_table_lookup(sord->names, str); +} + +static SordNode +sord_new_literal_node(Sord sord, SordNode type, + const char* str, int str_len, + const char* lang, uint8_t lang_len, + int* node_size) +{ + const uint8_t lang_size = lang ? lang_len + 1 : lang_len; + *node_size = sizeof(struct _SordNode) + sizeof(struct _SordLiteral) + str_len + 1 + lang_size; + SordNode node = malloc(*node_size); + node->type = SORD_LITERAL; + Literal* lit = (Literal*)node->data; + lit->type = type; + lit->lang_size = lang_size; + if (lang) + memcpy(lit->data, lang, lang_size); + + memcpy(lit->data + lang_size, str, str_len + 1); + return node; +} + +static SordNode +sord_lookup_literal(Sord sord, SordNode type, + const char* str, int str_len, + const char* lang, uint8_t lang_len) +{ + int node_size; + SordNode node = sord_new_literal_node(sord, type, str, str_len, lang, lang_len, &node_size); + + SordNode id = g_hash_table_lookup(sord->literals, node); + free(node); + if (id) { + return id; + } else { + return 0; + } +} + +SordNode +sord_node_load(Sord sord, SordID id) +{ + return (SordNode)id; +} + +static SordNode +sord_new_node(Sord sord, SordNodeType type, const char* buf, int buf_len, int* node_size) +{ + *node_size = sizeof(struct _SordNode) + buf_len; + SordNode node = malloc(*node_size); + node->type = type; + memcpy(node->data, buf, buf_len); + return node; +} + +SordNodeType +sord_node_get_type(SordNode ref) +{ + return ref->type; +} + +const char* +sord_node_get_string(SordNode ref) +{ + switch (ref->type) { + case SORD_URI: + case SORD_BLANK: + return ref->data; + break; + case SORD_LITERAL: + return ((Literal*)&ref->data)->data; + break; + } + assert(false); + return NULL; +} + +void +sord_node_set_user_data(SordNode ref, void* user_data) +{ + ref->user_data = user_data; +} + +void* +sord_node_get_user_data(SordNode ref) +{ + return ref->user_data; +} + +const char* +sord_literal_get_lang(SordNode ref) +{ + Literal* lit = (Literal*)&ref->data; + if (lit->lang_size > 0) + return lit->data; + else + return NULL; +} + +SordNode +sord_literal_get_datatype(SordNode ref) +{ + Literal* lit = (Literal*)&ref->data; + return lit->type; +} + +static void +sord_add_node(Sord sord, SordNode node, int node_size) +{ + node->refs = 0; + ++sord->meta->n_nodes; +} + +SordID +sord_get_uri_counted(Sord sord, bool create, const char* str, int str_len) +{ + SordID id = sord_lookup_name(sord, str, str_len); + if (id || !create) + return id; + + int node_size; + id = sord_new_node(sord, SORD_URI, str, str_len + 1, &node_size); + + assert(id); + g_hash_table_insert(sord->names, (void*)g_strdup(str), (void*)id); + sord_add_node(sord, id, node_size); + + return id; +} + +SordID +sord_get_uri(Sord sord, bool create, const char* str) +{ + return sord_get_uri_counted(sord, create, str, strlen(str)); +} + +SordID +sord_get_blank_counted(Sord sord, bool create, const char* str, int str_len) +{ + SordID id = sord_lookup_name(sord, str, str_len); + if (id || !create) + return id; + + int node_size; + id = sord_new_node(sord, SORD_BLANK, str, str_len + 1, &node_size); + + assert(id); + g_hash_table_insert(sord->names, (void*)g_strdup(str), (void*)id); + sord_add_node(sord, id, node_size); + + return id; +} + +SordID +sord_get_blank(Sord sord, bool create, const char* str) +{ + return sord_get_blank_counted(sord, create, str, strlen(str)); +} + +SordID +sord_get_literal_counted(Sord sord, bool create, SordID type, + const char* str, int str_len, + const char* lang, uint8_t lang_len) +{ + SordID id = sord_lookup_literal(sord, type, str, str_len, lang, lang_len); + if (id || !create) + return id; + + int node_size; + id = sord_new_literal_node(sord, type, str, str_len, lang, lang_len, &node_size); + + g_hash_table_insert(sord->literals, (void*)id, id); + sord_add_node(sord, id, node_size); + + return id; +} + +SordID +sord_get_literal(Sord sord, bool create, SordID type, const char* str, const char* lang) +{ + return sord_get_literal_counted(sord, create, type, str, strlen(str), + lang, lang ? strlen(lang) : 0); +} + +static void +sord_add_tuple_ref(Sord sord, const SordID id) +{ + if (id) { + SordNode node = sord_node_load(sord, id); + ++node->refs; + } +} + +static void +sord_drop_tuple_ref(Sord sord, const SordID id) +{ + if (id) { + SordNode node = sord_node_load(sord, id); + if (--node->refs == 0) { + sord_drop_node(sord, id); + } + } +} + +static inline bool +sord_add_to_index(Sord sord, const SordTuple tup, SordOrder order) +{ + assert(sord->indices[order]); + const int* const ordering = orderings[order]; + const SordTuple key = { + tup[ordering[0]], tup[ordering[1]], tup[ordering[2]], tup[ordering[3]] + }; + GSequenceIter* const cur = index_search(sord, sord->indices[order], key); + if (!g_sequence_iter_is_end(cur) + && !sord_tuple_compare(g_sequence_get(cur), key, sord)) { + return false; // Tuple already stored in this index + } + + // FIXME: memory leak? + SordID* key_copy = malloc(sizeof(SordTuple)); + memcpy(key_copy, key, sizeof(SordTuple)); + g_sequence_insert_before(cur, key_copy); + return true; +} + +void +sord_add(Sord sord, const SordTuple tup) +{ + SORD_WRITE_LOG("Add " TUP_FMT "\n", TUP_FMT_ARGS(tup)); + assert(tup[0] && tup[1] && tup[2]); + + for (unsigned i = 0; i < NUM_ORDERS; ++i) { + if (sord->indices[i]) { + if (!sord_add_to_index(sord, tup, i)) { + assert(i == 0); // Assuming index coherency + return; // Tuple already stored, do nothing + } + } + } + + for (int i = 0; i < TUP_LEN; ++i) + sord_add_tuple_ref(sord, tup[i]); + + ++sord->meta->n_tuples; + assert(sord->meta->n_tuples == g_sequence_get_length(sord->indices[SPO])); +} + +void +sord_remove(Sord sord, const SordTuple tup) +{ + SORD_WRITE_LOG("Remove " TUP_FMT "\n", TUP_FMT_ARGS(tup)); + + for (unsigned i = 0; i < NUM_ORDERS; ++i) { + if (sord->indices[i]) { + const int* const ordering = orderings[i]; + const SordTuple key = { + tup[ordering[0]], tup[ordering[1]], tup[ordering[2]], tup[ordering[3]] + }; + GSequenceIter* const cur = index_search(sord, sord->indices[i], key); + if (!g_sequence_iter_is_end(cur)) { + g_sequence_remove(cur); + } else { + assert(i == 0); // Assuming index coherency + return; // Tuple not found, do nothing + } + } + } + + for (int i = 0; i < TUP_LEN; ++i) + sord_drop_tuple_ref(sord, tup[i]); + + --sord->meta->n_tuples; +} + +void +sord_remove_iter(Sord sord, SordIter iter) +{ + SordTuple tup; + sord_iter_get(iter, tup); + + SORD_WRITE_LOG("Remove " TUP_FMT "\n", TUP_FMT_ARGS(tup)); + + // TODO: Directly remove the iterator's index (avoid one search) + + for (unsigned i = 0; i < NUM_ORDERS; ++i) { + if (sord->indices[i]) { + const int* const ordering = orderings[i]; + const SordTuple key = { + tup[ordering[0]], tup[ordering[1]], tup[ordering[2]], tup[ordering[3]] + }; + GSequenceIter* const cur = index_search(sord, sord->indices[i], key); + if (!g_sequence_iter_is_end(cur)) { + g_sequence_remove(cur); + } else { + assert(i == 0); // Assuming index coherency + } + } + } + + for (int i = 0; i < TUP_LEN; ++i) + sord_drop_tuple_ref(sord, tup[i]); + + --sord->meta->n_tuples; + + iter->end = g_sequence_iter_is_end(iter->cur); +} + +void +sord_remove_graph(Sord sord, SordID graph) +{ + #if 0 + if (!sord->indices[GSPO]) + return; + + // Remove all tuples in graph from non-graph indices + BDBCUR* cur = tcbdbcurnew(sord->indices[GSPO]); + const SordTuple search_key = { graph, 0, 0, 0 }; + int key_size = sizeof(SordTuple); + tcbdbcurjump(cur, &search_key, key_size); + do { + const SordID* key = (const SordID*)tcbdbcurkey3(cur, &key_size); + if (!key || key[0] != graph) + break; + + for (unsigned i = 0; i < GSPO; ++i) { + if (sord->indices[i]) { + const int* const ordering = orderings[i]; + const SordTuple tup = { key[1], key[2], key[3], key[0] }; // Key in SPOG order + const SordTuple subkey = { + tup[ordering[0]], tup[ordering[1]], tup[ordering[2]], tup[ordering[3]] + }; + if (!tcbdbout(sord->indices[i], &subkey, sizeof(SordTuple))) + fprintf(stderr, "Failed to remove key " TUP_FMT "\n", TUP_FMT_ARGS(subkey)); + } + } + + --sord->meta->n_tuples; + } while (tcbdbcurnext(cur)); + + // Remove all tuples in graph from graph indices + for (unsigned i = GSPO; i < NUM_ORDERS; ++i) { + if (sord->indices[i]) { + BDBCUR* cur = tcbdbcurnew(sord->indices[i]); + tcbdbcurjump(cur, &search_key, key_size); + while (true) { + const SordID* key = (const SordID*)tcbdbcurkey3(cur, &key_size); + if (!key || key[0] != graph) { + break; + } else if (i == GSPO) { + for (int i = 0; i < TUP_LEN; ++i) { + sord_drop_tuple_ref(sord, key[i]); + } + } + if (!tcbdbcurout(cur)) + break; + } + } + } + #endif +} diff --git a/src/sord_test.c b/src/sord_test.c new file mode 100644 index 0000000..371e5c1 --- /dev/null +++ b/src/sord_test.c @@ -0,0 +1,347 @@ +/* Sord, a lightweight RDF model library. + * Copyright 2010-2011 David Robillard <d@drobilla.net> + * + * Sord is free software: you can redistribute it and/or modify it under + * the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * Sord 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 Lesser General Public + * License for details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +#define _XOPEN_SOURCE 500 + +#include <stdio.h> +#include <stdlib.h> +#include <string.h> +#include "sord/sord.h" + +static const int DIGITS = 3; +static const int MAX_NUM = 999; + +typedef struct { SordTuple query; int expected_num_results; } QueryTest; + +static SordID +uri(Sord sord, int num) +{ + if (num == 0) + return 0; + + char uri[] = "eg:000"; + const size_t uri_len = 3 + DIGITS; + char* uri_num = uri + 3; // First `0' + snprintf(uri_num, DIGITS + 1, "%0*d", DIGITS, num); + return sord_get_uri_counted(sord, true, uri, uri_len); +} + +void +generate(Sord sord, size_t n_tuples, size_t n_objects_per) +{ + fprintf(stderr, "Generating %zu (S P *) tuples with %zu objects each\n", + n_tuples, n_objects_per); + + for (size_t i = 0; i < n_tuples; ++i) { + int num = (i * n_objects_per) + 1; + + SordID ids[2 + n_objects_per]; + for (size_t j = 0; j < 2 + n_objects_per; ++j) { + ids[j] = uri(sord, num++); + } + + for (size_t j = 0; j < n_objects_per; ++j) { + SordTuple tup = { ids[0], ids[1], ids[2 + j] }; + sord_add(sord, tup); + } + } + + // Add some literals + SordTuple tup; + tup[0] = uri(sord, 98); + tup[1] = uri(sord, 4); + tup[2] = sord_get_literal(sord, true, 0, "hello", NULL); + tup[3] = 0; + sord_add(sord, tup); + tup[2] = sord_get_literal(sord, true, 0, "hi", NULL); + sord_add(sord, tup); + + tup[0] = uri(sord, 14); + tup[2] = sord_get_literal(sord, true, 0, "bonjour", "fr"); + sord_add(sord, tup); + tup[2] = sord_get_literal(sord, true, 0, "salut", "fr"); + sord_add(sord, tup); + + // Attempt to add some duplicates + sord_add(sord, tup); + sord_add(sord, tup); + + // Add a blank node subject + tup[0] = sord_get_blank(sord, true, "ablank"); + sord_add(sord, tup); + + tup[1] = uri(sord, 6); + tup[2] = uri(sord, 7); + sord_add(sord, tup); +} + +/** Trivial function to return EXIT_FAILURE (useful as a breakpoint) */ +int +test_fail() +{ + return EXIT_FAILURE; +} + +#define TUP_FMT "(%6s %6s %6s)" +#define TUP_FMT_ARGS(t) \ + (sord_node_load(sord, (t)[0]) \ + ? sord_node_get_string(sord_node_load(sord, (t)[0])) : "*"), \ + (sord_node_load(sord, (t)[1]) \ + ? sord_node_get_string(sord_node_load(sord, (t)[1])) : "*"), \ + (sord_node_load(sord, (t)[2]) \ + ? sord_node_get_string(sord_node_load(sord, (t)[2])) : "*") + +int +test_read(Sord sord, const size_t n_tuples, const int n_objects_per) +{ + int ret = EXIT_SUCCESS; + + SordTuple id; + + SordIter iter = sord_begin(sord); + if (sord_iter_get_sord(iter) != sord) { + fprintf(stderr, "Fail: Iterator has incorrect sord pointer\n"); + return test_fail(); + } + + for (; !sord_iter_is_end(iter); sord_iter_increment(iter)) + sord_iter_get(iter, id); + + // Attempt to increment past end + if (!sord_iter_increment(iter)) { + fprintf(stderr, "Fail: Successfully incremented past end\n"); + return test_fail(); + } + + sord_iter_free(iter); + +#define NUM_PATTERNS 9 + + QueryTest patterns[NUM_PATTERNS] = { + { { 0, 0, 0 }, (n_tuples * n_objects_per) + 6 }, + { { uri(sord, 9), uri(sord, 9), uri(sord, 9) }, 0 }, + { { uri(sord, 1), uri(sord, 2), uri(sord, 4) }, 1 }, + { { uri(sord, 3), uri(sord, 4), uri(sord, 0) }, 2 }, + { { uri(sord, 0), uri(sord, 2), uri(sord, 4) }, 1 }, + { { uri(sord, 0), uri(sord, 0), uri(sord, 4) }, 1 }, + { { uri(sord, 1), uri(sord, 0), uri(sord, 0) }, 2 }, + { { uri(sord, 1), uri(sord, 0), uri(sord, 4) }, 1 }, + { { uri(sord, 0), uri(sord, 2), uri(sord, 0) }, 2 } }; + + for (unsigned i = 0; i < NUM_PATTERNS; ++i) { + QueryTest test = patterns[i]; + SordTuple pat = { test.query[0], test.query[1], test.query[2], 0 }; + fprintf(stderr, "Query " TUP_FMT "... ", TUP_FMT_ARGS(pat)); + + iter = sord_find(sord, pat); + int num_results = 0; + for (; !sord_iter_is_end(iter); sord_iter_increment(iter)) { + sord_iter_get(iter, id); + ++num_results; + if (!sord_tuple_match(pat, id)) { + sord_iter_free(iter); + fprintf(stderr, "Fail: Query result " TUP_FMT " does not match pattern\n", + TUP_FMT_ARGS(id)); + return test_fail(); + } + } + sord_iter_free(iter); + if (num_results != test.expected_num_results) { + fprintf(stderr, "Fail: Expected %d results, got %d\n", + test.expected_num_results, num_results); + return test_fail(); + } + fprintf(stderr, "OK (%u matches)\n", test.expected_num_results); + } + + // Query blank node subject + SordTuple pat = { sord_get_blank(sord, true, "ablank"), 0, 0 }; + if (!pat[0]) { + fprintf(stderr, "Blank node subject lost\n"); + return test_fail(); + } + fprintf(stderr, "Query " TUP_FMT "... ", TUP_FMT_ARGS(pat)); + iter = sord_find(sord, pat); + int num_results = 0; + for (; !sord_iter_is_end(iter); sord_iter_increment(iter)) { + sord_iter_get(iter, id); + ++num_results; + if (!sord_tuple_match(pat, id)) { + sord_iter_free(iter); + fprintf(stderr, "Fail: Query result " TUP_FMT " does not match pattern\n", + TUP_FMT_ARGS(id)); + return test_fail(); + } + } + fprintf(stderr, "OK\n"); + sord_iter_free(iter); + if (num_results != 2) { + fprintf(stderr, "Blank node subject query failed\n"); + return test_fail(); + } + + // Test nested queries + fprintf(stderr, "Nested Queries... "); + pat[0] = pat[1] = pat[2] = 0; + SordID last_subject = 0; + iter = sord_find(sord, pat); + for (; !sord_iter_is_end(iter); sord_iter_increment(iter)) { + sord_iter_get(iter, id); + if (id[0] == last_subject) + continue; + + SordTuple subpat = { id[0], 0, 0 }; + SordIter subiter = sord_find(sord, subpat); + int num_sub_results = 0; + for (; !sord_iter_is_end(subiter); sord_iter_increment(subiter)) { + SordTuple subid; + sord_iter_get(subiter, subid); + if (!sord_tuple_match(subpat, subid)) { + sord_iter_free(iter); + sord_iter_free(subiter); + fprintf(stderr, "Fail: Nested query result does not match pattern\n"); + return test_fail(); + } + ++num_sub_results; + } + sord_iter_free(subiter); + if (num_sub_results != n_objects_per) { + fprintf(stderr, "Fail: Nested query failed (got %d results, expected %d)\n", + num_sub_results, n_objects_per); + return test_fail(); + } + last_subject = id[0]; + } + fprintf(stderr, "OK\n\n"); + sord_iter_free(iter); + + return ret; +} + +int +test_write(Sord sord, const size_t n_tuples, const int n_objects_per) +{ + int ret = EXIT_SUCCESS; + + fprintf(stderr, "Removing Statements... "); + + // Remove statements + SordIter iter; + for (iter = sord_begin(sord); !sord_iter_is_end(iter);) { + sord_remove_iter(sord, iter); + } + sord_iter_free(iter); + + const int num_tuples = sord_num_tuples(sord); + if (num_tuples != 0) { + fprintf(stderr, "Fail: All tuples removed but %d tuples remain\n", num_tuples); + return test_fail(); + } + + fprintf(stderr, "OK\n\n"); + + return ret; +} + +int +main(int argc, char** argv) +{ + static const size_t n_tuples = 300; + static const int n_objects_per = 2; + + sord_free(NULL); // Shouldn't crash + + // Create with default options + Sord sord = sord_new("testdb"); + sord_set_option(sord, "http://unknown", "something", SORD_LITERAL, NULL, NULL); + sord_open(sord); + generate(sord, n_tuples, n_objects_per); + + if (test_read(sord, n_tuples, n_objects_per)) { + sord_free(sord); + return EXIT_FAILURE; + } + + // Check interning merges equivalent values + SordID uri_id = sord_get_uri(sord, true, "http://example.org"); + SordID blank_id = sord_get_uri(sord, true, "testblank"); + SordID lit_id = sord_get_literal(sord, true, uri_id, "hello", NULL); + //sord_clear_cache(write); + SordID uri_id2 = sord_get_uri(sord, false, "http://example.org"); + SordID blank_id2 = sord_get_uri(sord, false, "testblank"); + SordID lit_id2 = sord_get_literal(sord, false, uri_id, "hello", NULL); + if (uri_id2 != uri_id) { + fprintf(stderr, "Fail: URI interning failed (duplicates)\n"); + goto fail; + } else if (blank_id2 != blank_id) { + fprintf(stderr, "Fail: Blank node interning failed (duplicates)\n"); + goto fail; + } else if (lit_id2 != lit_id) { + fprintf(stderr, "Fail: Literal interning failed (duplicates)\n"); + goto fail; + } + + // Check interning doesn't clash non-equivalent values + SordID uri_id3 = sord_get_uri(sord, false, "http://example.orgX"); + SordID blank_id3 = sord_get_uri(sord, false, "testblankX"); + SordID lit_id3 = sord_get_literal(sord, false, uri_id, "helloX", NULL); + if (uri_id3 == uri_id) { + fprintf(stderr, "Fail: URI interning failed (clash)\n"); + goto fail; + } else if (blank_id3 == blank_id) { + fprintf(stderr, "Fail: Blank node interning failed (clash)\n"); + goto fail; + } else if (lit_id3 == lit_id) { + fprintf(stderr, "Fail: Literal interning failed (clash)\n"); + goto fail; + } + + sord_free(sord); + + // Test each pattern type with each index + static const char* const index_names[6] = { + "spo", "sop", "ops", "osp", "pso", "pos" + }; + + char* option = strdup("http://drobilla.net/ns/sord#index-xxx"); + const size_t option_len = strlen(option); + for (int i = 0; i < 6; ++i) { + strncpy(option + option_len - 3, index_names[i], 3); + sord = sord_new("testdb"); + sord_set_option(sord, option, "true", SORD_LITERAL, NULL, NULL); + printf("Testing Index `%s'\n", index_names[i]); + sord_open(sord); + generate(sord, n_tuples, n_objects_per); + if (test_read(sord, n_tuples, n_objects_per)) + goto fail; + sord_free(sord); + } + free(option); + + sord = sord_new("testdb"); + sord_open(sord); + if (test_write(sord, n_tuples, n_objects_per)) + goto fail; + + sord_free(sord); + + return EXIT_SUCCESS; + +fail: + sord_free(sord); + return EXIT_FAILURE; +} @@ -0,0 +1 @@ +autowaf/waf
\ No newline at end of file @@ -0,0 +1,106 @@ +#!/usr/bin/env python +import autowaf +import Options + +# Version of this package (even if built as a child) +SORD_VERSION = '0.1.0' + +# Library version (UNIX style major, minor, micro) +# major increment <=> incompatible changes +# minor increment <=> compatible changes (additions) +# micro increment <=> no interface changes +# Sord uses the same version number for both library and package +SORD_LIB_VERSION = SORD_VERSION + +# Variables for 'waf dist' +APPNAME = 'sord' +VERSION = SORD_VERSION + +# Mandatory variables +top = '.' +out = 'build' + +def options(opt): + autowaf.set_options(opt) + opt.add_option('--test', action='store_true', default=False, dest='build_tests', + help="Build unit tests") + opt.add_option('--dump', type='string', default='', dest='dump', + help="Dump debugging output (iter, search, write, all)") + +def configure(conf): + autowaf.configure(conf) + autowaf.display_header('Sord configuration') + + conf.check_tool('compiler_cc') + conf.env.append_value('CCFLAGS', '-std=c99') + + autowaf.check_pkg(conf, 'glib-2.0', uselib_store='GLIB', + atleast_version='2.0.0', mandatory=True) + + conf.env['BUILD_TESTS'] = Options.options.build_tests + + dump = Options.options.dump.split(',') + all = 'all' in dump + if all or 'iter' in dump: + conf.define('SORD_DEBUG_ITER', 1) + if all or 'search' in dump: + conf.define('SORD_DEBUG_SEARCH', 1) + if all or 'write' in dump: + conf.define('SORD_DEBUG_WRITE', 1) + + conf.define('SORD_VERSION', SORD_VERSION) + conf.write_config_header('sord-config.h') + + autowaf.display_msg(conf, "Unit tests", str(conf.env['BUILD_TESTS'])) + autowaf.display_msg(conf, "Debug dumping", dump) + print + +def build(bld): + # C Headers + bld.install_files('${INCLUDEDIR}/sord', 'sord/*.h') + + # Pkgconfig file + autowaf.build_pc(bld, 'SORD', SORD_VERSION, []) + + # Library + obj = bld(features = 'c cshlib') + obj.source = 'src/sord.c' + obj.includes = ['.', './src'] + obj.name = 'libsord' + obj.target = 'sord' + obj.vnum = SORD_LIB_VERSION + obj.install_path = '${LIBDIR}' + obj.cflags = [ '-fvisibility=hidden', '-DSORD_SHARED', '-DSORD_INTERNAL' ] + obj.libs = [ 'm' ] + autowaf.use_lib(bld, obj, 'GLIB') + + if bld.env['BUILD_TESTS']: + # Static library (for unit test code coverage) + obj = bld(features = 'c cstlib') + obj.source = 'src/sord.c' + obj.includes = ['.', './src'] + obj.name = 'libsord_static' + obj.target = 'sord_static' + obj.install_path = '' + obj.cflags = [ '-fprofile-arcs', '-ftest-coverage' ] + obj.libs = [ 'm' ] + autowaf.use_lib(bld, obj, 'GLIB') + + # Unit test program + obj = bld(features = 'c cprogram') + obj.source = 'src/sord_test.c' + obj.includes = ['.', './src'] + obj.use = 'libsord_static' + obj.linkflags = '-lgcov' + obj.target = 'sord_test' + obj.install_path = '' + obj.cflags = [ '-fprofile-arcs', '-ftest-coverage' ] + autowaf.use_lib(bld, obj, 'GLIB') + + # Documentation + autowaf.build_dox(bld, 'SORD', SORD_VERSION, top, out) + +def test(ctx): + autowaf.pre_test(ctx, APPNAME) + autowaf.run_tests(ctx, APPNAME, ['./sord_test']) + autowaf.post_test(ctx, APPNAME) |