diff options
Diffstat (limited to 'common')
88 files changed, 0 insertions, 37734 deletions
diff --git a/common/COPYING b/common/COPYING deleted file mode 100644 index 94a9ed024..000000000 --- a/common/COPYING +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - <one line to give the program's name and a brief idea of what it does.> - Copyright (C) <year> <name of author> - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see <http://www.gnu.org/licenses/>. - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - <program> Copyright (C) <year> <name of author> - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -<http://www.gnu.org/licenses/>. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/common/COPYING.LESSER b/common/COPYING.LESSER deleted file mode 100644 index 755013bb2..000000000 --- a/common/COPYING.LESSER +++ /dev/null @@ -1,165 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - - This version of the GNU Lesser General Public License incorporates -the terms and conditions of version 3 of the GNU General Public -License, supplemented by the additional permissions listed below. - - 0. Additional Definitions. - - As used herein, "this License" refers to version 3 of the GNU Lesser -General Public License, and the "GNU GPL" refers to version 3 of the GNU -General Public License. - - "The Library" refers to a covered work governed by this License, -other than an Application or a Combined Work as defined below. - - An "Application" is any work that makes use of an interface provided -by the Library, but which is not otherwise based on the Library. -Defining a subclass of a class defined by the Library is deemed a mode -of using an interface provided by the Library. - - A "Combined Work" is a work produced by combining or linking an -Application with the Library. The particular version of the Library -with which the Combined Work was made is also called the "Linked -Version". - - The "Minimal Corresponding Source" for a Combined Work means the -Corresponding Source for the Combined Work, excluding any source code -for portions of the Combined Work that, considered in isolation, are -based on the Application, and not on the Linked Version. - - The "Corresponding Application Code" for a Combined Work means the -object code and/or source code for the Application, including any data -and utility programs needed for reproducing the Combined Work from the -Application, but excluding the System Libraries of the Combined Work. - - 1. Exception to Section 3 of the GNU GPL. - - You may convey a covered work under sections 3 and 4 of this License -without being bound by section 3 of the GNU GPL. - - 2. Conveying Modified Versions. - - If you modify a copy of the Library, and, in your modifications, a -facility refers to a function or data to be supplied by an Application -that uses the facility (other than as an argument passed when the -facility is invoked), then you may convey a copy of the modified -version: - - a) under this License, provided that you make a good faith effort to - ensure that, in the event an Application does not supply the - function or data, the facility still operates, and performs - whatever part of its purpose remains meaningful, or - - b) under the GNU GPL, with none of the additional permissions of - this License applicable to that copy. - - 3. Object Code Incorporating Material from Library Header Files. - - The object code form of an Application may incorporate material from -a header file that is part of the Library. You may convey such object -code under terms of your choice, provided that, if the incorporated -material is not limited to numerical parameters, data structure -layouts and accessors, or small macros, inline functions and templates -(ten or fewer lines in length), you do both of the following: - - a) Give prominent notice with each copy of the object code that the - Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the object code with a copy of the GNU GPL and this license - document. - - 4. Combined Works. - - You may convey a Combined Work under terms of your choice that, -taken together, effectively do not restrict modification of the -portions of the Library contained in the Combined Work and reverse -engineering for debugging such modifications, if you also do each of -the following: - - a) Give prominent notice with each copy of the Combined Work that - the Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the Combined Work with a copy of the GNU GPL and this license - document. - - c) For a Combined Work that displays copyright notices during - execution, include the copyright notice for the Library among - these notices, as well as a reference directing the user to the - copies of the GNU GPL and this license document. - - d) Do one of the following: - - 0) Convey the Minimal Corresponding Source under the terms of this - License, and the Corresponding Application Code in a form - suitable for, and under terms that permit, the user to - recombine or relink the Application with a modified version of - the Linked Version to produce a modified Combined Work, in the - manner specified by section 6 of the GNU GPL for conveying - Corresponding Source. - - 1) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (a) uses at run time - a copy of the Library already present on the user's computer - system, and (b) will operate properly with a modified version - of the Library that is interface-compatible with the Linked - Version. - - e) Provide Installation Information, but only if you would otherwise - be required to provide such information under section 6 of the - GNU GPL, and only to the extent that such information is - necessary to install and execute a modified version of the - Combined Work produced by recombining or relinking the - Application with a modified version of the Linked Version. (If - you use option 4d0, the Installation Information must accompany - the Minimal Corresponding Source and Corresponding Application - Code. If you use option 4d1, you must provide the Installation - Information in the manner specified by section 6 of the GNU GPL - for conveying Corresponding Source.) - - 5. Combined Libraries. - - You may place library facilities that are a work based on the -Library side by side in a single library together with other library -facilities that are not Applications and are not covered by this -License, and convey such a combined library under terms of your -choice, if you do both of the following: - - a) Accompany the combined library with a copy of the same work based - on the Library, uncombined with any other library facilities, - conveyed under the terms of this License. - - b) Give prominent notice with the combined library that part of it - is a work based on the Library, and explaining where to find the - accompanying uncombined form of the same work. - - 6. Revised Versions of the GNU Lesser General Public License. - - The Free Software Foundation may publish revised and/or new versions -of the GNU Lesser 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 -Library as you received it specifies that a certain numbered version -of the GNU Lesser General Public License "or any later version" -applies to it, you have the option of following the terms and -conditions either of that published version or of any later version -published by the Free Software Foundation. If the Library as you -received it does not specify a version number of the GNU Lesser -General Public License, you may choose any version of the GNU Lesser -General Public License ever published by the Free Software Foundation. - - If the Library as you received it specifies that a proxy can decide -whether future versions of the GNU Lesser General Public License shall -apply, that proxy's public statement of acceptance of any version is -permanent authorization for you to choose that version for the -Library. diff --git a/common/Makefile.am b/common/Makefile.am deleted file mode 100644 index 187ad5edd..000000000 --- a/common/Makefile.am +++ /dev/null @@ -1,33 +0,0 @@ -ACLOCAL_AMFLAGS = -I m4 -SUBDIRS = trace dhash path_utils refarray collection ini -DOCDIRS = path_utils refarray collection ini - -dist_noinst_DATA = \ - m4 - -if SINGLELIB -# Build all components as a single shared library -lib_LTLIBRARIES = libsssd_util.la -libsssd_util_la_SOURCES = -libsssd_util_la_LIBADD = \ - collection/libcollection.la \ - ini/libini_config.la \ - dhash/libdhash.la \ - refarray/libref_array.la -libsssd_util_la_CFLAGS = $(AM_CFLAGS) \ - -I ./collection \ - -I ./ini \ - -I ./dhash \ - -I ./refarray \ - -I ./trace -endif - -tests: all - for subdir in $(SUBDIRS); do \ - $(MAKE) -C $$subdir $@; \ - done - -docs: - for subdir in $(DOCDIRS); do \ - $(MAKE) -C $$subdir $@; \ - done diff --git a/common/README b/common/README deleted file mode 100644 index 1b0357349..000000000 --- a/common/README +++ /dev/null @@ -1,12 +0,0 @@ -TO BUILD EXECUTE: - -autoreconf -i -./configure -make - -If you build first time after getting source use: - -autoreconf -i -f - -Most information about how to use the interfaces can be found in header files -and in the unit tests (*_ut.c). diff --git a/common/collection/COPYING b/common/collection/COPYING deleted file mode 100644 index 94a9ed024..000000000 --- a/common/collection/COPYING +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - <one line to give the program's name and a brief idea of what it does.> - Copyright (C) <year> <name of author> - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see <http://www.gnu.org/licenses/>. - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - <program> Copyright (C) <year> <name of author> - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -<http://www.gnu.org/licenses/>. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/common/collection/COPYING.LESSER b/common/collection/COPYING.LESSER deleted file mode 100644 index 755013bb2..000000000 --- a/common/collection/COPYING.LESSER +++ /dev/null @@ -1,165 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - - This version of the GNU Lesser General Public License incorporates -the terms and conditions of version 3 of the GNU General Public -License, supplemented by the additional permissions listed below. - - 0. Additional Definitions. - - As used herein, "this License" refers to version 3 of the GNU Lesser -General Public License, and the "GNU GPL" refers to version 3 of the GNU -General Public License. - - "The Library" refers to a covered work governed by this License, -other than an Application or a Combined Work as defined below. - - An "Application" is any work that makes use of an interface provided -by the Library, but which is not otherwise based on the Library. -Defining a subclass of a class defined by the Library is deemed a mode -of using an interface provided by the Library. - - A "Combined Work" is a work produced by combining or linking an -Application with the Library. The particular version of the Library -with which the Combined Work was made is also called the "Linked -Version". - - The "Minimal Corresponding Source" for a Combined Work means the -Corresponding Source for the Combined Work, excluding any source code -for portions of the Combined Work that, considered in isolation, are -based on the Application, and not on the Linked Version. - - The "Corresponding Application Code" for a Combined Work means the -object code and/or source code for the Application, including any data -and utility programs needed for reproducing the Combined Work from the -Application, but excluding the System Libraries of the Combined Work. - - 1. Exception to Section 3 of the GNU GPL. - - You may convey a covered work under sections 3 and 4 of this License -without being bound by section 3 of the GNU GPL. - - 2. Conveying Modified Versions. - - If you modify a copy of the Library, and, in your modifications, a -facility refers to a function or data to be supplied by an Application -that uses the facility (other than as an argument passed when the -facility is invoked), then you may convey a copy of the modified -version: - - a) under this License, provided that you make a good faith effort to - ensure that, in the event an Application does not supply the - function or data, the facility still operates, and performs - whatever part of its purpose remains meaningful, or - - b) under the GNU GPL, with none of the additional permissions of - this License applicable to that copy. - - 3. Object Code Incorporating Material from Library Header Files. - - The object code form of an Application may incorporate material from -a header file that is part of the Library. You may convey such object -code under terms of your choice, provided that, if the incorporated -material is not limited to numerical parameters, data structure -layouts and accessors, or small macros, inline functions and templates -(ten or fewer lines in length), you do both of the following: - - a) Give prominent notice with each copy of the object code that the - Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the object code with a copy of the GNU GPL and this license - document. - - 4. Combined Works. - - You may convey a Combined Work under terms of your choice that, -taken together, effectively do not restrict modification of the -portions of the Library contained in the Combined Work and reverse -engineering for debugging such modifications, if you also do each of -the following: - - a) Give prominent notice with each copy of the Combined Work that - the Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the Combined Work with a copy of the GNU GPL and this license - document. - - c) For a Combined Work that displays copyright notices during - execution, include the copyright notice for the Library among - these notices, as well as a reference directing the user to the - copies of the GNU GPL and this license document. - - d) Do one of the following: - - 0) Convey the Minimal Corresponding Source under the terms of this - License, and the Corresponding Application Code in a form - suitable for, and under terms that permit, the user to - recombine or relink the Application with a modified version of - the Linked Version to produce a modified Combined Work, in the - manner specified by section 6 of the GNU GPL for conveying - Corresponding Source. - - 1) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (a) uses at run time - a copy of the Library already present on the user's computer - system, and (b) will operate properly with a modified version - of the Library that is interface-compatible with the Linked - Version. - - e) Provide Installation Information, but only if you would otherwise - be required to provide such information under section 6 of the - GNU GPL, and only to the extent that such information is - necessary to install and execute a modified version of the - Combined Work produced by recombining or relinking the - Application with a modified version of the Linked Version. (If - you use option 4d0, the Installation Information must accompany - the Minimal Corresponding Source and Corresponding Application - Code. If you use option 4d1, you must provide the Installation - Information in the manner specified by section 6 of the GNU GPL - for conveying Corresponding Source.) - - 5. Combined Libraries. - - You may place library facilities that are a work based on the -Library side by side in a single library together with other library -facilities that are not Applications and are not covered by this -License, and convey such a combined library under terms of your -choice, if you do both of the following: - - a) Accompany the combined library with a copy of the same work based - on the Library, uncombined with any other library facilities, - conveyed under the terms of this License. - - b) Give prominent notice with the combined library that part of it - is a work based on the Library, and explaining where to find the - accompanying uncombined form of the same work. - - 6. Revised Versions of the GNU Lesser General Public License. - - The Free Software Foundation may publish revised and/or new versions -of the GNU Lesser 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 -Library as you received it specifies that a certain numbered version -of the GNU Lesser General Public License "or any later version" -applies to it, you have the option of following the terms and -conditions either of that published version or of any later version -published by the Free Software Foundation. If the Library as you -received it does not specify a version number of the GNU Lesser -General Public License, you may choose any version of the GNU Lesser -General Public License ever published by the Free Software Foundation. - - If the Library as you received it specifies that a proxy can decide -whether future versions of the GNU Lesser General Public License shall -apply, that proxy's public statement of acceptance of any version is -permanent authorization for you to choose that version for the -Library. diff --git a/common/collection/Makefile.am b/common/collection/Makefile.am deleted file mode 100644 index 4e90aed12..000000000 --- a/common/collection/Makefile.am +++ /dev/null @@ -1,73 +0,0 @@ -#DEBUG_FLAGS=@DEBUG_VAR@ -TRACE_LEVEL=@TRACE_VAR@ - -DOXYGEN = @DOXYGEN@ - -topdir=$(srcdir)/.. - -AM_CFLAGS = -if HAVE_GCC - AM_CFLAGS += \ - -Wall -Wshadow -Wstrict-prototypes -Wpointer-arith -Wcast-qual \ - -Wcast-align -Wwrite-strings -endif - -AM_CPPFLAGS = -I$(topdir) -I$(topdir)/trace $(TRACE_LEVEL) - -ACLOCAL_AMFLAGS = -I m4 - -# Set up the pkg-config file -pkgconfigdir = $(libdir)/pkgconfig -dist_pkgconfig_DATA = collection.pc - -dist_include_HEADERS = \ - collection.h \ - collection_tools.h \ - collection_queue.h \ - collection_stack.h - -dist_noinst_DATA = m4 - -# Build library -lib_LTLIBRARIES = libcollection.la -libcollection_la_SOURCES = \ - collection.c \ - collection_tools.c \ - collection_cnv.c \ - collection_queue.c \ - collection_stack.c \ - collection_cmp.c \ - collection_iter.c \ - collection_priv.h \ - ../trace/trace.h -libcollection_la_LDFLAGS = \ - -version-info 2:0:0 - -# Build unit test -check_PROGRAMS = collection_ut collection_stack_ut collection_queue_ut -collection_ut_SOURCES = collection_ut.c -collection_ut_LDADD = libcollection.la -collection_stack_ut_SOURCES = collection_stack_ut.c -collection_stack_ut_LDADD = libcollection.la -collection_queue_ut_SOURCES = collection_queue_ut.c -collection_queue_ut_LDADD = libcollection.la - -if HAVE_DOXYGEN -docs: -# A temp way of building docs until we hook into the package build - rm -fR doc - mkdir -p doc - $(DOXYGEN) collection.cfg.doxy -else -docs: - @echo "Doxygen not installed, cannot generate documentation" - @exit 1 -endif - - -TESTS = collection_ut collection_stack_ut collection_queue_ut - -tests: all $(check_PROGRAMS) - -clean-local: - rm -Rf doc diff --git a/common/collection/collection.c b/common/collection/collection.c deleted file mode 100644 index 87ac32124..000000000 --- a/common/collection/collection.c +++ /dev/null @@ -1,3056 +0,0 @@ -/* - COLLECTION LIBRARY - - Implementation of the collection library interface. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - Collection Library 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. - - Collection Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with Collection Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#define _GNU_SOURCE -#include <string.h> -#include <stdlib.h> -#include <errno.h> -#include <ctype.h> -#include <time.h> -#include "config.h" -#include "trace.h" - -/* The collection should use the real structures */ -#include "collection_priv.h" -#include "collection.h" - - -/* Internal constants defined to denote actions that can be performed by find handler */ -#define COLLECTION_ACTION_FIND 1 -#define COLLECTION_ACTION_DEL 2 -#define COLLECTION_ACTION_UPDATE 3 -#define COLLECTION_ACTION_GET 4 - - -/* Special internal error code to indicate that collection search was interrupted */ -#define EINTR_INTERNAL 10000 - - -/* Potential subject for management with libtools */ -#define DATE_FORMAT "%c" - -#define TIME_ARRAY_SIZE 100 - -/* Magic numbers for hashing */ -#if SIZEOF_LONG == 8 - #define FNV1a_prime 1099511628211ul - #define FNV1a_base 14695981039346656037ul -#elif SIZEOF_LONG_LONG == 8 - #define FNV1a_prime 1099511628211ull - #define FNV1a_base 14695981039346656037ull -#else - #error "Platform cannot support 64-bit constant integers" -#endif - -/* Struct used for passing parameter for update operation */ -struct update_property { - int type; - void *data; - int length; - int found; -}; - -/* This struct is used to construct path - * to an item in the collection (tree) - */ -struct path_data { - char *name; - int length; - struct path_data *previous_path; -}; - -/* Structure to keep data needed to - * copy collection - * while traversing it - */ -struct col_copy { - int mode; - struct path_data *current_path; - char *given_name; - int given_len; - col_copy_cb copy_cb; - void *ext_data; -}; - -/******************** FUNCTION DECLARATIONS ****************************/ - -/* Have to declare those due to function cross referencing */ -static int col_find_item_and_do(struct collection_item *ci, - const char *property_to_find, - int type, - int mode_flags, - col_item_fn item_handler, - void *custom_data, - int action); - -/* Traverse callback for find & delete function */ -static int col_act_traverse_handler(struct collection_item *head, - struct collection_item *previous, - struct collection_item *current, - void *passed_traverse_data, - col_item_fn user_item_handler, - void *custom_data, - int *stop); - -/* Traverse handler to find parent of the item */ -static int col_parent_traverse_handler(struct collection_item *head, - struct collection_item *previous, - struct collection_item *current, - void *traverse_data, - col_item_fn user_item_handler, - void *custom_data, - int *stop); - -/* Traverse callback signature */ -typedef int (*internal_item_fn)(struct collection_item *head, - struct collection_item *previous, - struct collection_item *current, - void *traverse_data, - col_item_fn user_item_handler, - void *custom_data, - int *stop); -/* Function to walk_items */ -static int col_walk_items(struct collection_item *ci, - int mode_flags, - internal_item_fn traverse_handler, - void *traverse_data, - col_item_fn user_item_handler, - void *custom_data, - unsigned *depth); - -/* Function to get sub collection */ -static int col_get_subcollection(const char *property, - int property_len, - int type, - void *data, - int length, - void *found, - int *dummy); - -/* Function to destroy collection */ -void col_destroy_collection(struct collection_item *ci); - -/******************** SUPPLEMENTARY FUNCTIONS ****************************/ -/* BASIC OPERATIONS */ - -/* Function that checks if property can be added */ -static int col_validate_property(const char *property) -{ - TRACE_FLOW_STRING("col_validate_property", "Entry point."); - /* Only alpha numeric characters are allowed in names of the properties */ - int invalid = 0; - const char *check; - - check = property; - while (*check != '\0') { - /* It turned out that limiting collection charcters is bad */ - if ((*check < ' ') || (*check == '!')) { - invalid = 1; - break; - } - check++; - } - TRACE_FLOW_NUMBER("col_validate_property. Returning ", invalid); - return invalid; -} - -/* Function that cleans the item */ -void col_delete_item(struct collection_item *item) -{ - struct collection_item *other_collection; - - TRACE_FLOW_STRING("col_delete_item","Entry point."); - - if (item == NULL) { - TRACE_FLOW_STRING("col_delete_item","Nothing to delete!"); - return; - } - - /* Handle external or embedded collection */ - if(item->type == COL_TYPE_COLLECTIONREF) { - /* Our data is a pointer to a whole external collection so dereference - * it or delete */ - other_collection = *((struct collection_item **)(item->data)); - col_destroy_collection(other_collection); - } - - TRACE_INFO_STRING("Deleting property:", item->property); - TRACE_INFO_NUMBER("Type:", item->type); - - if (item->property != NULL) free(item->property); - if (item->data != NULL) free(item->data); - - free(item); - - TRACE_FLOW_STRING("col_delete_item","Exit."); -} - -/* A generic function to allocate a property item */ -int col_allocate_item(struct collection_item **ci, const char *property, - const void *item_data, int length, int type) -{ - struct collection_item *item = NULL; - - TRACE_FLOW_STRING("col_allocate_item", "Entry point."); - TRACE_INFO_NUMBER("Will be using type:", type); - - /* Check the length */ - if (length >= COL_MAX_DATA) { - TRACE_ERROR_STRING("col_allocate_item", "Data to long."); - return EMSGSIZE; - } - - if (col_validate_property(property)) { - TRACE_ERROR_STRING("Invalid chracters in the property name", property); - return EINVAL; - } - - /* Allocate memory for the structure */ - item = (struct collection_item *)malloc(sizeof(struct collection_item)); - if (item == NULL) { - TRACE_ERROR_STRING("col_allocate_item", "Malloc failed."); - return ENOMEM; - } - - /* After we initialize members we can use delete_item() in case of error */ - item->next = NULL; - item->property = NULL; - item->data = NULL; - TRACE_INFO_NUMBER("About to set type to:", type); - item->type = type; - - /* Copy property */ - item->property = strdup(property); - if (item->property == NULL) { - TRACE_ERROR_STRING("col_allocate_item", "Failed to dup property."); - col_delete_item(item); - return ENOMEM; - } - - item->phash = col_make_hash(property, 0, &(item->property_len)); - TRACE_INFO_NUMBER("Item hash", item->phash); - TRACE_INFO_NUMBER("Item property length", item->property_len); - TRACE_INFO_NUMBER("Item property strlen", strlen(item->property)); - - /* Deal with data */ - item->data = malloc(length); - if (item->data == NULL) { - TRACE_ERROR_STRING("col_allocate_item", "Failed to dup data."); - col_delete_item(item); - return ENOMEM; - } - - memcpy(item->data, item_data, length); - item->length = length; - - /* Make sure that data is NULL terminated in case of string */ - if (type == COL_TYPE_STRING) ((char *)(item->data))[length-1] = '\0'; - - *ci = item; - - TRACE_INFO_STRING("Item property", item->property); - TRACE_INFO_NUMBER("Item property type", item->type); - TRACE_INFO_NUMBER("Item data length", item->length); - TRACE_FLOW_STRING("col_allocate_item", "Success exit."); - return EOK; -} - -/* Structure used to find things in collection */ -struct property_search { - const char *property; - uint64_t hash; - struct collection_item *parent; - int index; - int count; - int found; - int use_type; - int type; -}; - -/* Find the parent of the item with given name */ -static int col_find_property(struct collection_item *collection, - const char *refprop, - int idx, - int use_type, - int type, - struct collection_item **parent) -{ - struct property_search ps; - int i = 0; - unsigned depth = 0; - - TRACE_FLOW_STRING("col_find_property", "Entry."); - - *parent = NULL; - - ps.property = refprop; - ps.hash = FNV1a_base; - ps.parent = NULL; - ps.index = idx; - ps.count = 0; - ps.found = 0; - ps.use_type = use_type; - ps.type = type; - - /* Create hash of the string to search */ - while(refprop[i] != 0) { - ps.hash = ps.hash ^ toupper(refprop[i]); - ps.hash *= FNV1a_prime; - i++; - } - - /* We do not care about error here */ - (void)col_walk_items(collection, COL_TRAVERSE_ONELEVEL, - col_parent_traverse_handler, - (void *)parent, NULL, (void *)&ps, - &depth); - - if (*parent) { - /* Item is found in the collection */ - TRACE_FLOW_STRING("col_find_property", "Exit - item found"); - return 1; - } - - /* Item is not found */ - TRACE_FLOW_STRING("col_find_property", "Exit - item NOT found"); - return EOK; -} - - - -/* Insert item into the current collection */ -int col_insert_item_into_current(struct collection_item *collection, - struct collection_item *item, - int disposition, - const char *refprop, - int idx, - unsigned flags) -{ - struct collection_header *header = NULL; - struct collection_item *parent = NULL; - struct collection_item *current = NULL; - int refindex = 0; - - TRACE_FLOW_STRING("col_insert_item_into_current", "Entry point"); - - /* Do best effort on the item */ - if ((!item) || (item->next)) { - TRACE_ERROR_STRING("Passed in item is invalid", ""); - return EINVAL; - } - - if (collection == NULL) { - TRACE_INFO_STRING("col_insert_item_into_current", - "Collection accepting is NULL"); - if (item->type == COL_TYPE_COLLECTION) { - /* This is a special case of self creation */ - TRACE_INFO_STRING("col_insert_item_into_current", - "Adding header item to new collection."); - collection = item; - } - else { - TRACE_ERROR_STRING("Passed in item is invalid", ""); - return EINVAL; - } - } - else { - /* We can add items only to collections */ - if (collection->type != COL_TYPE_COLLECTION) { - TRACE_ERROR_STRING("Attempt to add item to non collection.",""); - TRACE_ERROR_STRING("Collection name:", collection->property); - TRACE_ERROR_NUMBER("Collection type:", collection->type); - return EINVAL; - } - } - - /* After processing flags we can process disposition */ - - header = (struct collection_header *)collection->data; - - /* Check flags first */ - switch(flags) { - case COL_INSERT_NOCHECK: /* No check - good just fall through */ - TRACE_INFO_STRING("Insert without check", ""); - break; - case COL_INSERT_DUPOVER: /* Find item and overwrite - ignore disposition */ - if (col_find_property(collection, item->property, 0, 0, 0, &parent)) { - current = parent->next; - item->next = current->next; - parent->next = item; - if (header->last == current) header->last = item; - col_delete_item(current); - /* Deleted one added another - count stays the same! */ - TRACE_FLOW_STRING("col_insert_item_into_current", "Dup overwrite exit"); - return EOK; - } - /* Not found so we fall thorough and add as requested */ - break; - - case COL_INSERT_DUPOVERT: /* Find item by name and type and overwrite - ignore disposition */ - if (col_find_property(collection, item->property, 0, 1, item->type, &parent)) { - current = parent->next; - item->next = current->next; - parent->next = item; - if (header->last == current) header->last = item; - col_delete_item(current); - /* Deleted one added another - count stays the same! */ - TRACE_FLOW_STRING("col_insert_item_into_current", "Dup overwrite exit"); - return EOK; - } - /* Not found so we fall thorough and add as requested */ - break; - - case COL_INSERT_DUPERROR: if (col_find_property(collection, item->property, 0, 0, 0, &parent)) { - /* Return error */ - TRACE_ERROR_NUMBER("Duplicate property", EEXIST); - return EEXIST; - } - break; - - case COL_INSERT_DUPERRORT: if (col_find_property(collection, item->property, 0, 1, item->type, &parent)) { - /* Return error */ - TRACE_ERROR_NUMBER("Duplicate property of the same type", EEXIST); - return EEXIST; - } - break; - - case COL_INSERT_DUPMOVE: /* Find item and delete */ - if (col_find_property(collection, item->property, 0, 0, 0, &parent)) { - current = parent->next; - parent->next = current->next; - if (header->last == current) header->last = parent; - col_delete_item(current); - header->count--; - } - /* Now add item according to the disposition */ - break; - - case COL_INSERT_DUPMOVET: /* Find item and delete */ - TRACE_INFO_STRING("Property:", item->property); - TRACE_INFO_NUMBER("Type:", item->type); - if (col_find_property(collection, item->property, 0, 1, item->type, &parent)) { - TRACE_INFO_NUMBER("Current:", (unsigned)(parent->next)); - current = parent->next; - parent->next = current->next; - if (header->last == current) header->last = parent; - col_delete_item(current); - header->count--; - } - /* Now add item according to the disposition */ - break; - - default: /* The new ones should be added here */ - TRACE_ERROR_NUMBER("Flag is not implemented", ENOSYS); - return ENOSYS; - } - - - switch (disposition) { - case COL_DSP_END: /* Link new item to the last item in the list if there any */ - if (header->count != 0) header->last->next = item; - /* Make sure we save a new last element */ - header->last = item; - header->count++; - break; - - case COL_DSP_FRONT: /* Same as above if there is header only */ - if (header->count == 1) { - header->last->next = item; - header->last = item; - } - else { - item->next = collection->next; - collection->next = item; - } - header->count++; - break; - - case COL_DSP_BEFORE: /* Check argument */ - if (!refprop) { - TRACE_ERROR_STRING("In this case property is required", ""); - return EINVAL; - } - - /* We need to find property */ - if (col_find_property(collection, refprop, 0, 0, 0, &parent)) { - item->next = parent->next; - parent->next = item; - header->count++; - } - else { - TRACE_ERROR_STRING("Property not found", refprop); - return ENOENT; - } - break; - - case COL_DSP_AFTER: /* Check argument */ - if (!refprop) { - TRACE_ERROR_STRING("In this case property is required", ""); - return EINVAL; - } - - /* We need to find property */ - if (col_find_property(collection, refprop, 0, 0, 0, &parent)) { - parent = parent->next; - if (parent->next) { - /* It is not the last item */ - item->next = parent->next; - parent->next = item; - } - else { - /* It is the last item */ - header->last->next = item; - header->last = item; - } - header->count++; - } - else { - TRACE_ERROR_STRING("Property not found", refprop); - return ENOENT; - } - break; - - case COL_DSP_INDEX: if(idx == 0) { - /* Same is first */ - if (header->count == 1) { - header->last->next = item; - header->last = item; - } - else { - item->next = collection->next; - collection->next = item; - } - } - else if(idx >= header->count - 1) { - /* In this case add to the end */ - header->last->next = item; - /* Make sure we save a new last element */ - header->last = item; - } - else { - /* In the middle */ - parent = collection; - /* Move to the right position counting */ - while (idx > 0) { - idx--; - parent = parent->next; - } - item->next = parent->next; - parent->next = item; - } - header->count++; - break; - - case COL_DSP_FIRSTDUP: - case COL_DSP_LASTDUP: - case COL_DSP_NDUP: - - if (disposition == COL_DSP_FIRSTDUP) refindex = 0; - else if (disposition == COL_DSP_LASTDUP) refindex = -1; - else refindex = idx; - - /* We need to find property based on index */ - if (col_find_property(collection, item->property, refindex, 0, 0, &parent)) { - item->next = parent->next; - parent->next = item; - header->count++; - if(header->last == parent) header->last = item; - } - else { - TRACE_ERROR_STRING("Property not found", refprop); - return ENOENT; - } - break; - - default: - TRACE_ERROR_STRING("Disposition is not implemented", ""); - return ENOSYS; - - } - - - TRACE_INFO_STRING("Collection:", collection->property); - TRACE_INFO_STRING("Just added item is:", item->property); - TRACE_INFO_NUMBER("Item type.", item->type); - TRACE_INFO_NUMBER("Number of items in collection now is.", header->count); - - TRACE_FLOW_STRING("col_insert_item_into_current", "Exit"); - return EOK; -} - -/* Extract item from the current collection */ -int col_extract_item_from_current(struct collection_item *collection, - int disposition, - const char *refprop, - int idx, - int type, - struct collection_item **ret_ref) -{ - struct collection_header *header = NULL; - struct collection_item *parent = NULL; - struct collection_item *current = NULL; - struct collection_item *found = NULL; - int refindex = 0; - int use_type = 0; - - TRACE_FLOW_STRING("col_extract_item_from_current", "Entry point"); - - /* Check that collection is not empty */ - if ((collection == NULL) || (collection->type != COL_TYPE_COLLECTION)) { - TRACE_ERROR_STRING("Collection can't be NULL", ""); - return EINVAL; - } - - header = (struct collection_header *)collection->data; - - /* Before moving forward we need to check if there is anything to extract */ - if (header->count <= 1) { - TRACE_ERROR_STRING("Collection is empty.", "Nothing to extract."); - return ENOENT; - } - - if (type != 0) use_type = 1; - - switch (disposition) { - case COL_DSP_END: /* Extract last item in the list. */ - parent = collection; - current = collection->next; - while (current->next != NULL) { - parent = current; - current = current->next; - } - *ret_ref = parent->next; - parent->next = NULL; - /* Special case - one data element */ - if (header->count == 2) header->last = collection; - else header->last = parent; - break; - - case COL_DSP_FRONT: /* Extract first item in the list */ - *ret_ref = collection->next; - collection->next = (*ret_ref)->next; - /* Special case - one data element */ - if (header->count == 2) header->last = collection; - break; - - case COL_DSP_BEFORE: /* Check argument */ - if (!refprop) { - TRACE_ERROR_STRING("In this case property is required", ""); - return EINVAL; - } - - /* We have to do it in two steps */ - /* First find the property that is mentioned */ - if (col_find_property(collection, refprop, 0, use_type, type, &found)) { - /* We found the requested property */ - if (found->next == collection->next) { - /* The referenced property is the first in the list */ - TRACE_ERROR_STRING("Nothing to extract. Lists starts with property", refprop); - return ENOENT; - } - /* Get to the parent of the item that is before the one that is found */ - parent = collection; - current = collection->next; - while (current != found) { - parent = current; - current = current->next; - } - *ret_ref = current; - parent->next = current->next; - - } - else { - TRACE_ERROR_STRING("Property not found", refprop); - return ENOENT; - } - break; - - case COL_DSP_AFTER: /* Check argument */ - if (!refprop) { - TRACE_ERROR_STRING("In this case property is required", ""); - return EINVAL; - } - - /* We need to find property */ - if (col_find_property(collection, refprop, 0, use_type, type, &parent)) { - current = parent->next; - if (current->next) { - *ret_ref = current->next; - current->next = (*ret_ref)->next; - /* If we removed the last element adjust header */ - if(current->next == NULL) header->last = current; - } - else { - TRACE_ERROR_STRING("Property is last in the list", refprop); - return ENOENT; - } - } - else { - TRACE_ERROR_STRING("Property not found", refprop); - return ENOENT; - } - break; - - case COL_DSP_INDEX: if (idx == 0) { - *ret_ref = collection->next; - collection->next = (*ret_ref)->next; - /* Special case - one data element */ - if (header->count == 2) header->last = collection; - } - /* Index 0 stands for the first data element. - * Count includes header element. - */ - else if (idx >= (header->count - 1)) { - TRACE_ERROR_STRING("Index is out of boundaries", refprop); - return ENOENT; - } - else { - /* Loop till the element with right index */ - refindex = 0; - parent = collection; - current = collection->next; - while (refindex < idx) { - parent = current; - current = current->next; - refindex++; - } - *ret_ref = parent->next; - parent->next = (*ret_ref)->next; - /* If we removed the last element adjust header */ - if (parent->next == NULL) header->last = parent; - } - break; - - case COL_DSP_FIRSTDUP: - case COL_DSP_LASTDUP: - case COL_DSP_NDUP: - - if (disposition == COL_DSP_FIRSTDUP) refindex = 0; - else if (disposition == COL_DSP_LASTDUP) refindex = -2; - else refindex = idx; - - /* We need to find property based on index */ - if (col_find_property(collection, refprop, refindex, use_type, type, &parent)) { - *ret_ref = parent->next; - parent->next = (*ret_ref)->next; - /* If we removed the last element adjust header */ - if(parent->next == NULL) header->last = parent; - } - else { - TRACE_ERROR_STRING("Property not found", refprop); - return ENOENT; - } - break; - - default: - TRACE_ERROR_STRING("Disposition is not implemented", ""); - return ENOSYS; - - } - - - /* Clear item and reduce count */ - (*ret_ref)->next = NULL; - header->count--; - - TRACE_INFO_STRING("Collection:", (*ret_ref)->property); - TRACE_INFO_NUMBER("Item type.", (*ret_ref)->type); - TRACE_INFO_NUMBER("Number of items in collection now is.", header->count); - - TRACE_FLOW_STRING("col_extract_item_from_current", "Exit"); - return EOK; -} - -/* Extract item from the collection */ -int col_extract_item(struct collection_item *collection, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - int type, - struct collection_item **ret_ref) -{ - struct collection_item *col = NULL; - int error = EOK; - - TRACE_FLOW_STRING("col_extract_item", "Entry point"); - - /* Check that collection is not empty */ - if ((collection == NULL) || (collection->type != COL_TYPE_COLLECTION)) { - TRACE_ERROR_STRING("Collection can't be NULL", ""); - return EINVAL; - } - - /* Get subcollection if needed */ - if (subcollection == NULL) { - col = collection; - } - else { - TRACE_INFO_STRING("Subcollection id not null, searching", subcollection); - error = col_find_item_and_do(collection, subcollection, - COL_TYPE_COLLECTIONREF, - COL_TRAVERSE_DEFAULT, - col_get_subcollection, (void *)(&col), - COLLECTION_ACTION_FIND); - if (error) { - TRACE_ERROR_NUMBER("Search for subcollection returned error:", error); - return error; - } - - if (col == NULL) { - TRACE_ERROR_STRING("Search for subcollection returned NULL pointer", ""); - return ENOENT; - } - - } - - /* Extract from the current collection */ - error = col_extract_item_from_current(col, - disposition, - refprop, - idx, - type, - ret_ref); - if (error) { - TRACE_ERROR_NUMBER("Failed to extract item from the current collection", error); - return error; - } - - TRACE_FLOW_STRING("col_extract_item", "Exit"); - return EOK; -} - - -/* Remove item (property) from collection.*/ -int col_remove_item(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - int type) -{ - int error = EOK; - struct collection_item *ret_ref = NULL; - - TRACE_FLOW_STRING("col_remove_item", "Exit"); - - /* Extract from the current collection */ - error = col_extract_item(ci, - subcollection, - disposition, - refprop, - idx, - type, - &ret_ref); - if (error) { - TRACE_ERROR_NUMBER("Failed to extract item from the collection", error); - return error; - } - - col_delete_item(ret_ref); - - TRACE_FLOW_STRING("col_remove_item", "Exit"); - return EOK; -} - -/* Remove item (property) from current collection. - * Just a simple wrapper. - */ -int col_remove_item_from_current(struct collection_item *ci, - int disposition, - const char *refprop, - int idx, - int type) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_remove_item_from_current", "Exit"); - - /* Remove item from current collection */ - error = col_remove_item(ci, - NULL, - disposition, - refprop, - idx, - type); - - TRACE_FLOW_NUMBER("col_remove_item_from_current. Exit. Returning", error); - return error; -} - - -/* Insert the item into the collection or subcollection */ -int col_insert_item(struct collection_item *collection, - const char *subcollection, - struct collection_item *item, - int disposition, - const char *refprop, - int idx, - unsigned flags) -{ - int error; - struct collection_item *acceptor = NULL; - - TRACE_FLOW_STRING("col_insert_item", "Entry point."); - - /* Do best effort on the item */ - if ((!item) || (item->next)) { - TRACE_ERROR_STRING("Passed in item is invalid", ""); - return EINVAL; - } - - /* Check that collection is not empty */ - if ((collection == NULL) && (item->type != COL_TYPE_COLLECTION)) { - TRACE_ERROR_STRING("Collection can't be NULL", ""); - return EINVAL; - } - - /* Add item to collection */ - if (subcollection == NULL) { - acceptor = collection; - } - else { - TRACE_INFO_STRING("Subcollection id not null, searching", subcollection); - error = col_find_item_and_do(collection, subcollection, - COL_TYPE_COLLECTIONREF, - COL_TRAVERSE_DEFAULT, - col_get_subcollection, (void *)(&acceptor), - COLLECTION_ACTION_FIND); - if (error) { - TRACE_ERROR_NUMBER("Search for subcollection returned error:", error); - return error; - } - - if (acceptor == NULL) { - TRACE_ERROR_STRING("Search for subcollection returned NULL pointer", ""); - return ENOENT; - } - - } - - /* Instert item to the current collection */ - error = col_insert_item_into_current(acceptor, - item, - disposition, - refprop, - idx, - flags); - - if (error) { - TRACE_ERROR_NUMBER("Failed to insert item into current collection", error); - return error; - } - - TRACE_FLOW_STRING("insert_item", "Exit"); - return EOK; -} - - -/* Insert property with reference. - * This is internal function so we do not check parameters. - * See external wrapper below. - */ -static int col_insert_property_with_ref_int(struct collection_item *collection, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - int type, - const void *data, - int length, - struct collection_item **ret_ref) -{ - struct collection_item *item = NULL; - int error; - - TRACE_FLOW_STRING("col_insert_property_with_ref_int", "Entry point."); - - /* Create a new property out of the given parameters */ - error = col_allocate_item(&item, property, data, length, type); - if (error) { - TRACE_ERROR_NUMBER("Failed to allocate item", error); - return error; - } - - /* Send the property to the insert_item function */ - error = col_insert_item(collection, - subcollection, - item, - disposition, - refprop, - idx, - flags); - if (error) { - TRACE_ERROR_NUMBER("Failed to insert item", error); - col_delete_item(item); - return error; - } - - if (ret_ref) *ret_ref = item; - - TRACE_FLOW_STRING("col_insert_property_with_ref_int", "Exit"); - return EOK; -} - -/* Special function used to copy item from one - * collection to another using caller's callback. - */ -static int col_copy_item_with_cb(struct collection_item *collection, - const char *property, - int type, - const void *data, - int length, - col_copy_cb copy_cb, - void *ext_data) -{ - struct collection_item *item = NULL; - int skip = 0; - int error = EOK; - - TRACE_FLOW_STRING("col_copy_item_with_cb", "Entry point."); - - /* Create a new property out of the given parameters */ - error = col_allocate_item(&item, property, data, length, type); - if (error) { - TRACE_ERROR_NUMBER("Failed to allocate item", error); - return error; - } - - /* Call callback if any */ - if (copy_cb) { - TRACE_INFO_STRING("Calling callback for item:", item->property); - error = copy_cb(item, ext_data, &skip); - if (error) { - TRACE_ERROR_NUMBER("Callback failed", error); - col_delete_item(item); - return error; - } - } - - /* Are we told to skip this item? */ - if (skip) col_delete_item(item); - else { - /* Insted property into the collection */ - error = col_insert_item(collection, - NULL, - item, - COL_DSP_END, - NULL, - 0, - 0); - if (error) { - TRACE_ERROR_NUMBER("Failed to insert item", error); - col_delete_item(item); - return error; - } - } - - TRACE_FLOW_STRING("col_copy_item_with_cb", "Exit"); - return EOK; -} - - -/* This is public function so we need to check the validity - * of the arguments. - */ -int col_insert_property_with_ref(struct collection_item *collection, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - int type, - const void *data, - int length, - struct collection_item **ret_ref) -{ - int error; - - TRACE_FLOW_STRING("col_insert_property_with_ref", "Entry point."); - - /* Check that collection is not empty */ - if (collection == NULL) { - TRACE_ERROR_STRING("Collection cant be NULL", ""); - return EINVAL; - } - - error = col_insert_property_with_ref_int(collection, - subcollection, - disposition, - refprop, - idx, - flags, - property, - type, - data, - length, - ret_ref); - - TRACE_FLOW_NUMBER("col_insert_property_with_ref_int Returning:", error); - return error; -} -/* TRAVERSE HANDLERS */ - -/* Special handler to just set a flag if the item is found */ -static int col_is_in_item_handler(const char *property, - int property_len, - int type, - void *data, - int length, - void *found, - int *dummy) -{ - TRACE_FLOW_STRING("col_is_in_item_handler", "Entry."); - TRACE_INFO_STRING("Property:", property); - TRACE_INFO_NUMBER("Property length:", property_len); - TRACE_INFO_NUMBER("Type:", type); - TRACE_INFO_NUMBER("Length:", length); - - *((int *)(found)) = COL_MATCH; - - TRACE_FLOW_STRING("col_is_in_item_handler", "Success Exit."); - - return EOK; -} - -/* Special handler to retrieve the sub collection */ -static int col_get_subcollection(const char *property, - int property_len, - int type, - void *data, - int length, - void *found, - int *dummy) -{ - TRACE_FLOW_STRING("col_get_subcollection", "Entry."); - TRACE_INFO_STRING("Property:", property); - TRACE_INFO_NUMBER("Property length:", property_len); - TRACE_INFO_NUMBER("Type:", type); - TRACE_INFO_NUMBER("Length:", length); - - *((struct collection_item **)(found)) = *((struct collection_item **)(data)); - - TRACE_FLOW_STRING("col_get_subcollection","Success Exit."); - - return EOK; - -} - - - -/* CLEANUP */ - -/* Cleans the collection tree including current item. */ -/* The passed in variable should not be used after the call - * as memory is freed!!! */ -static void col_delete_collection(struct collection_item *ci) -{ - TRACE_FLOW_STRING("col_delete_collection", "Entry."); - - if (ci == NULL) { - TRACE_FLOW_STRING("col_delete_collection", "Nothing to do Exit."); - return; - } - - TRACE_INFO_STRING("Real work to do", ""); - TRACE_INFO_STRING("Property", ci->property); - TRACE_INFO_NUMBER("Next item", ci->next); - - col_delete_collection(ci->next); - - /* Delete this item */ - col_delete_item(ci); - TRACE_FLOW_STRING("col_delete_collection", "Exit."); -} - - -/* NAME MANAGEMENT - used by search */ - -/* Internal data structures used for search */ - - -struct find_name { - const char *name_to_find; - int name_len_to_find; - uint64_t hash; - int type_to_match; - char *given_name; - int given_len; - struct path_data *current_path; - int action; -}; - -/* Create a new name */ -static int col_create_path_data(struct path_data **name_path, - const char *name, int length, - const char *property, int property_len, - char sep) -{ - int error = EOK; - struct path_data *new_name_path; - - TRACE_FLOW_STRING("col_create_path_data", "Entry."); - - TRACE_INFO_STRING("Constructing path from name:", name); - TRACE_INFO_STRING("Constructing path from property:", property); - - /* Allocate structure */ - new_name_path = (struct path_data *)malloc(sizeof(struct path_data)); - if (new_name_path == NULL) { - TRACE_ERROR_NUMBER("Failed to allocate memory for new path struct.", ENOMEM); - return ENOMEM; - } - new_name_path->name = malloc(length + property_len + 2); - if (new_name_path->name == NULL) { - TRACE_ERROR_NUMBER("Failed to allocate memory for new path name.", ENOMEM); - free(new_name_path); - return ENOMEM; - } - - /* Construct the new name */ - new_name_path->length = 0; - - if(length > 0) { - memcpy(new_name_path->name, name, length); - new_name_path->length = length; - new_name_path->name[new_name_path->length] = sep; - new_name_path->length++; - new_name_path->name[new_name_path->length] = '\0'; - TRACE_INFO_STRING("Name so far:", new_name_path->name); - TRACE_INFO_NUMBER("Len so far:", new_name_path->length); - } - memcpy(&new_name_path->name[new_name_path->length], property, property_len); - new_name_path->length += property_len; - new_name_path->name[new_name_path->length] = '\0'; - - /* Link to the chain */ - new_name_path->previous_path = *name_path; - *name_path = new_name_path; - - TRACE_INFO_STRING("Constructed path", new_name_path->name); - - - TRACE_FLOW_NUMBER("col_create_path_data. Returning:", error); - return error; -} - -/* Matching item name and type */ -static int col_match_item(struct collection_item *current, - struct find_name *traverse_data) -{ - - const char *find_str; - const char *start; - const char *data_str; - - TRACE_FLOW_STRING("col_match_item", "Entry"); - - if (traverse_data->type_to_match & current->type) { - - /* Check if there is any value to match */ - if ((traverse_data->name_to_find == NULL) || - (*(traverse_data->name_to_find) == '\0')) { - TRACE_INFO_STRING("col_match_item", - "Returning MATCH because there is no search criteria!"); - return COL_MATCH; - } - - /* Check the hashes - if they do not match return */ - if (traverse_data->hash != current->phash) { - TRACE_INFO_STRING("col_match_item","Returning NO match!"); - return COL_NOMATCH; - } - - /* We will do the actual string comparison only if the hashes matched */ - - /* Start comparing the two strings from the end */ - find_str = traverse_data->name_to_find + traverse_data->name_len_to_find; - start = current->property; - data_str = start + current->property_len; - - TRACE_INFO_STRING("Searching for:", traverse_data->name_to_find); - TRACE_INFO_STRING("Item name:", current->property); - TRACE_INFO_STRING("Current path:", traverse_data->current_path->name); - TRACE_INFO_NUMBER("Searching:", toupper(*find_str)); - TRACE_INFO_NUMBER("Have:", toupper(*data_str)); - - /* We start pointing to 0 so the loop will be executed at least once */ - while (toupper(*data_str) == toupper(*find_str)) { - - TRACE_INFO_STRING("Loop iteration:",""); - - if (data_str == start) { - if (find_str > traverse_data->name_to_find) { - if (*(find_str-1) == '!') { - /* We matched the property but the search string is - * longer so we need to continue matching */ - TRACE_INFO_STRING("col_match_item", - "Need to continue matching"); - start = traverse_data->current_path->name; - data_str = &start[traverse_data->current_path->length - 1]; - find_str -= 2; - continue; - } - else { - TRACE_INFO_STRING("col_match_item","Returning NO match!"); - return COL_NOMATCH; - } - } - else { - TRACE_INFO_STRING("col_match_item","Returning MATCH!"); - return COL_MATCH; - } - } - else if ((find_str == traverse_data->name_to_find) && - (*(data_str-1) == '!')) return COL_MATCH; - - data_str--; - find_str--; - TRACE_INFO_NUMBER("Searching:", toupper(*find_str)); - TRACE_INFO_NUMBER("Have:", toupper(*data_str)); - - } - } - - TRACE_FLOW_STRING("col_match_item","Returning NO match!"); - return COL_NOMATCH; - -} - -/* Function to delete the data that contains search path */ -static void col_delete_path_data(struct path_data *path) -{ - TRACE_FLOW_STRING("col_delete_path_data","Entry."); - - if (path != NULL) { - TRACE_INFO_STRING("col_delete_path_data", "Item to delete exits."); - if (path->previous_path != NULL) { - TRACE_INFO_STRING("col_delete_path_data", - "But previous item to delete exits to. Nesting."); - col_delete_path_data(path->previous_path); - } - if (path->name != NULL) { - TRACE_INFO_STRING("col_delete_path_data Deleting path:", path->name); - free(path->name); - } - TRACE_INFO_STRING("col_delete_path_data", "Deleting path element"); - free(path); - } - TRACE_FLOW_STRING("col_delete_path_data", "Exit"); -} - - -/* MAIN TRAVERSAL FUNCTION */ - -/* Internal function to walk collection */ -/* For each item walked it will call traverse handler. - Traverse handler accepts: current item, - user provided item handler and user provided custom data. */ -/* See below different traverse handlers for different cases */ -static int col_walk_items(struct collection_item *ci, - int mode_flags, - internal_item_fn traverse_handler, - void *traverse_data, - col_item_fn user_item_handler, - void *custom_data, - unsigned *depth) -{ - struct collection_item *current; - struct collection_item *parent = NULL; - struct collection_item *sub; - int stop = 0; - int error = EOK; - - TRACE_FLOW_STRING("col_walk_items", "Entry."); - TRACE_INFO_NUMBER("Mode flags:", mode_flags); - - /* Increase depth */ - /* NOTE: The depth is increased at the entry to the function. - * and decreased right before the exit so it is safe to decrease it. - */ - (*depth)++; - - current = ci; - - while (current) { - - TRACE_INFO_STRING("Processing item:", current->property); - TRACE_INFO_NUMBER("Item type:", current->type); - - if (current->type == COL_TYPE_COLLECTIONREF) { - - TRACE_INFO_STRING("Subcollection:", current->property); - - if ((mode_flags & COL_TRAVERSE_IGNORE) == 0) { - - TRACE_INFO_STRING("Subcollection is not ignored.", ""); - /* We are not ignoring sub collections */ - - if ((mode_flags & COL_TRAVERSE_FLAT) == 0) { - - TRACE_INFO_STRING("Subcollection is not flattened.", ""); - /* We are not flattening sub collections. - * The flattening means that we are not going - * to return reference and headers for sub collections. - * We will also not do special end collection - * invocation for sub collections. - */ - error = traverse_handler(ci, parent, current, traverse_data, - user_item_handler, custom_data, &stop); - if (stop != 0) { - TRACE_INFO_STRING("Traverse handler returned STOP.", ""); - error = EINTR_INTERNAL; - } - /* Check what error we got */ - if (error == EINTR_INTERNAL) { - TRACE_FLOW_NUMBER("Internal error - means we are stopping.", error); - (*depth)--; - return error; - } - else if (error) { - TRACE_ERROR_NUMBER("Traverse handler returned error.", error); - (*depth)--; - return error; - } - } - - if ((mode_flags & COL_TRAVERSE_ONELEVEL) == 0) { - TRACE_INFO_STRING("Before diving into sub collection",""); - sub = *((struct collection_item **)(current->data)); - TRACE_INFO_STRING("Sub collection name", sub->property); - TRACE_INFO_NUMBER("Header type", sub->type); - /* We need to go into sub collections */ - error = col_walk_items(sub, mode_flags, - traverse_handler, traverse_data, - user_item_handler, custom_data, - depth); - TRACE_INFO_STRING("Returned from sub collection processing", ""); - TRACE_INFO_STRING("Done processing item:", current->property); - TRACE_INFO_NUMBER("Done processing item type:", current->type); - - } - } - } - else { - /* Check if it is a header and we are not on the root level. - * If we are flattening collection we need to skip headers - * for sub collections. - */ - - /* Call handler if: - * a) It is not collection header - * OR - * b) It is header we are flattening but we are on top level - * OR - * c) It is header and we are not flattening. - */ - if ((current->type != COL_TYPE_COLLECTION) || - (((mode_flags & COL_TRAVERSE_FLAT) != 0) && (*depth == 1)) || - ((mode_flags & COL_TRAVERSE_FLAT) == 0)) { - /* Call handler then move on */ - error = traverse_handler(ci, parent, current, - traverse_data, user_item_handler, - custom_data, &stop); - - } - } - /* If we are stopped - return EINTR_INTERNAL */ - if (stop != 0) { - TRACE_INFO_STRING("Traverse handler returned STOP.", ""); - error = EINTR_INTERNAL; - } - /* Check what error we got */ - if (error == EINTR_INTERNAL) { - TRACE_FLOW_NUMBER("Internal error - means we are stopping.", error); - (*depth)--; - return error; - } - else if (error) { - TRACE_ERROR_NUMBER("Traverse handler returned error.", error); - (*depth)--; - return error; - } - - parent = current; - current = current->next; - - } - - TRACE_INFO_STRING("Out of loop", ""); - - /* Check if we need to have a special - * call at the end of the collection. - */ - if ((mode_flags & COL_TRAVERSE_END) != 0) { - - /* Do this dummy invocation only: - * a) If we are flattening and on the root level - * b) We are not flattening - */ - if ((((mode_flags & COL_TRAVERSE_FLAT) != 0) && (*depth == 1)) || - ((mode_flags & COL_TRAVERSE_FLAT) == 0)) { - - TRACE_INFO_STRING("About to do the special end collection invocation of handler", ""); - error = traverse_handler(ci, parent, current, - traverse_data, user_item_handler, - custom_data, &stop); - } - } - - TRACE_FLOW_NUMBER("col_walk_items. Returns: ", error); - (*depth)--; - return error; -} - - -/* ACTION */ - -/* Find an item by property name and perform an action on it. */ -/* No pattern matching supported in the first implementation. */ -/* To refer to child properties use notatation like this: */ -/* parent!child!subchild!subsubchild etc. */ -static int col_find_item_and_do(struct collection_item *ci, - const char *property_to_find, - int type, - int mode_flags, - col_item_fn item_handler, - void *custom_data, - int action) -{ - - int error = EOK; - struct find_name *traverse_data = NULL; - unsigned depth = 0; - int count = 0; - const char *last_part; - char *sep; - - TRACE_FLOW_STRING("col_find_item_and_do", "Entry."); - - /* Item handler is always required */ - if ((item_handler == NULL) && - (action == COLLECTION_ACTION_FIND)) { - TRACE_ERROR_NUMBER("No item handler - returning error!", EINVAL); - return EINVAL; - } - - /* Collection is requered */ - if (ci == NULL) { - TRACE_ERROR_NUMBER("No collection to search!", EINVAL); - return EINVAL; - } - - /* Make sure that there is anything to search */ - type &= COL_TYPE_ANY; - if (((property_to_find == NULL) && (type == 0)) || - ((*property_to_find == '\0') && (type == 0))) { - TRACE_ERROR_NUMBER("No item search criteria specified - returning error!", ENOENT); - return ENOENT; - } - /* Prepare data for traversal */ - traverse_data = (struct find_name *)malloc(sizeof(struct find_name)); - if (traverse_data == NULL) { - TRACE_ERROR_NUMBER("Failed to allocate traverse data memory - returning error!", ENOMEM); - return ENOMEM; - } - - TRACE_INFO_STRING("col_find_item_and_do", "Filling in traverse data."); - - traverse_data->name_to_find = property_to_find; - - if (property_to_find != NULL) { - - traverse_data->name_len_to_find = strlen(property_to_find); - - /* Check if the search string ends with "!" - this is illegal */ - if (traverse_data->name_to_find[traverse_data->name_len_to_find - 1] == '!') { - TRACE_ERROR_NUMBER("Search string is invalid.", EINVAL); - free(traverse_data); - return EINVAL; - } - - /* Find last ! if any */ - sep = strrchr(traverse_data->name_to_find, '!'); - if (sep != NULL) { - sep++; - last_part = sep; - } - else last_part = traverse_data->name_to_find; - - TRACE_INFO_STRING("Last item", last_part); - - /* Create hash of the last part */ - traverse_data->hash = FNV1a_base; - - /* Create hash of the string to search */ - while(last_part[count] != 0) { - traverse_data->hash = traverse_data->hash ^ toupper(last_part[count]); - traverse_data->hash *= FNV1a_prime; - count++; - } - } - else { - /* We a looking for a first element of a given type */ - TRACE_INFO_STRING("No search string", ""); - traverse_data->name_len_to_find = 0; - } - - - traverse_data->type_to_match = type; - traverse_data->given_name = NULL; - traverse_data->given_len = 0; - traverse_data->current_path = NULL; - traverse_data->action = action; - - mode_flags |= COL_TRAVERSE_END; - - TRACE_INFO_STRING("col_find_item_and_do", "About to walk the tree."); - TRACE_INFO_NUMBER("Traverse flags", mode_flags); - - error = col_walk_items(ci, mode_flags, col_act_traverse_handler, - (void *)traverse_data, item_handler, custom_data, - &depth); - - if (traverse_data->current_path != NULL) { - TRACE_INFO_STRING("find_item_and_do", - "Path was not cleared - deleting"); - col_delete_path_data(traverse_data->current_path); - } - - free(traverse_data); - - if (error && (error != EINTR_INTERNAL)) { - TRACE_ERROR_NUMBER("Walk items returned error. Returning: ", error); - return error; - } - else { - TRACE_FLOW_STRING("Walk items returned SUCCESS.", ""); - return EOK; - } -} - -/* Function to replace data in the item */ -static int col_update_current_item(struct collection_item *current, - struct update_property *update_data) -{ - TRACE_FLOW_STRING("col_update_current_item", "Entry"); - - /* If type is different or same but it is string or binary we need to - * replace the storage */ - if ((current->type != update_data->type) || - ((current->type == update_data->type) && - ((current->type == COL_TYPE_STRING) || - (current->type == COL_TYPE_BINARY)))) { - TRACE_INFO_STRING("Replacing item data buffer", ""); - free(current->data); - current->data = malloc(update_data->length); - if (current->data == NULL) { - TRACE_ERROR_STRING("Failed to allocate memory", ""); - current->length = 0; - return ENOMEM; - } - current->length = update_data->length; - } - - TRACE_INFO_STRING("Overwriting item data", ""); - memcpy(current->data, update_data->data, current->length); - current->type = update_data->type; - - if (current->type == COL_TYPE_STRING) - ((char *)(current->data))[current->length-1] = '\0'; - - TRACE_FLOW_STRING("update_current_item", "Exit"); - return EOK; -} - -/* TRAVERSE CALLBACKS */ - -/* Traverse handler for simple traverse function */ -/* Handler must be able to deal with NULL current item */ -static int col_simple_traverse_handler(struct collection_item *head, - struct collection_item *previous, - struct collection_item *current, - void *traverse_data, - col_item_fn user_item_handler, - void *custom_data, - int *stop) -{ - int error = EOK; - struct collection_item end_item; - char zero = '\0'; - - TRACE_FLOW_STRING("col_simple_traverse_handler", "Entry."); - - if (current == NULL) { - memset((void *)&end_item, 0, sizeof(struct collection_item)); - end_item.type = COL_TYPE_END; - end_item.property = &zero; - current = &end_item; - } - - error = user_item_handler(current->property, - current->property_len, - current->type, - current->data, - current->length, - custom_data, - stop); - - TRACE_FLOW_NUMBER("col_simple_traverse_handler. Returning:", error); - return error; -} - -/* Traverse handler for to find parent */ -static int col_parent_traverse_handler(struct collection_item *head, - struct collection_item *previous, - struct collection_item *current, - void *traverse_data, - col_item_fn user_item_handler, - void *custom_data, - int *stop) -{ - struct property_search *to_find; - int done = 0; - int match = 0; - - TRACE_FLOW_STRING("col_parent_traverse_handler", "Entry."); - - to_find = (struct property_search *)custom_data; - - TRACE_INFO_NUMBER("Looking for HASH:", (unsigned)(to_find->hash)); - TRACE_INFO_NUMBER("Current HASH:", (unsigned)(current->phash)); - - /* Check hashes first */ - if(to_find->hash == current->phash) { - - /* Check type if we are asked to use type */ - if ((to_find->use_type) && (!(to_find->type & current->type))) { - TRACE_FLOW_STRING("parent_traverse_handler. Returning:","Exit. Hash is Ok, type is not"); - return EOK; - } - - /* Validate property. Make sure we include terminating 0 in the comparison */ - if (strncasecmp(current->property, to_find->property, current->property_len + 1) == 0) { - - match = 1; - to_find->found = 1; - - /* Do the right thing based on index */ - /* If index is 0 we are looking for the first value in the list of duplicate properties */ - if (to_find->index == 0) done = 1; - /* If index is non zero we are looking for N-th instance of the dup property */ - else if (to_find->index > 0) { - if (to_find->count == to_find->index) done = 1; - else { - /* Record found instance and move on */ - to_find->parent = previous; - (to_find->count)++; - } - } - /* If we are looking for last instance just record it */ - else to_find->parent = previous; - } - } - - if (done) { - *stop = 1; - *((struct collection_item **)traverse_data) = previous; - } - else { - /* As soon as we found first non matching one but there was a match - * return the parent of the last found item. - */ - if (((!match) || (current->next == NULL)) && (to_find->index != 0) && (to_find->found)) { - *stop = 1; - if (to_find->index == -2) - *((struct collection_item **)traverse_data) = to_find->parent; - else - *((struct collection_item **)traverse_data) = to_find->parent->next; - } - } - - - TRACE_FLOW_STRING("col_parent_traverse_handler. Returning:","Exit"); - return EOK; -} - - -/* Traverse callback for find & delete function */ -static int col_act_traverse_handler(struct collection_item *head, - struct collection_item *previous, - struct collection_item *current, - void *passed_traverse_data, - col_item_fn user_item_handler, - void *custom_data, - int *stop) -{ - int error = EOK; - struct find_name *traverse_data = NULL; - char *name; - int length; - struct path_data *temp; - struct collection_header *header; - char *property; - int property_len; - struct update_property *update_data; - - TRACE_FLOW_STRING("col_act_traverse_handler", "Entry."); - - traverse_data = (struct find_name *)passed_traverse_data; - - /* We can be called when current points to NULL */ - if (current == NULL) { - TRACE_INFO_STRING("col_act_traverse_handler", - "Special call at the end of the collection."); - temp = traverse_data->current_path; - traverse_data->current_path = temp->previous_path; - temp->previous_path = NULL; - col_delete_path_data(temp); - traverse_data->given_name = NULL; - traverse_data->given_len = 0; - TRACE_FLOW_NUMBER("Handling end of collection - removed path. Returning:", error); - return error; - } - - /* Create new path at the beginning of a new sub collection */ - if (current->type == COL_TYPE_COLLECTION) { - - TRACE_INFO_STRING("col_act_traverse_handler", - "Processing collection handle."); - - /* Create new path */ - if (traverse_data->current_path != NULL) { - TRACE_INFO_STRING("Already have part of the path", ""); - name = traverse_data->current_path->name; - length = traverse_data->current_path->length; - TRACE_INFO_STRING("Path:", name); - TRACE_INFO_NUMBER("Path len:", length); - } - else { - name = NULL; - length = 0; - } - - if (traverse_data->given_name != NULL) { - property = traverse_data->given_name; - property_len = traverse_data->given_len; - } - else { - property = current->property; - property_len = current->property_len; - } - - TRACE_INFO_STRING("col_act_traverse_handler", "About to create path data."); - - error = col_create_path_data(&(traverse_data->current_path), - name, length, - property, property_len, '!'); - - TRACE_INFO_NUMBER("col_create_path_data returned:", error); - return error; - } - - /* Handle the collection pointers */ - if (current->type == COL_TYPE_COLLECTIONREF) { - traverse_data->given_name = current->property; - traverse_data->given_len = current->property_len; - TRACE_INFO_STRING("Saved given name:", traverse_data->given_name); - } - - TRACE_INFO_STRING("Processing item with property:", current->property); - - /* Do here what we do with items */ - if (col_match_item(current, traverse_data)) { - TRACE_INFO_STRING("Matched item:", current->property); - switch (traverse_data->action) { - case COLLECTION_ACTION_FIND: - TRACE_INFO_STRING("It is a find action - calling handler.", ""); - if (user_item_handler != NULL) { - /* Call user handler */ - error = user_item_handler(current->property, - current->property_len, - current->type, - current->data, - current->length, - custom_data, - stop); - - TRACE_INFO_NUMBER("Handler returned:", error); - TRACE_INFO_NUMBER("Handler set STOP to:", *stop); - - } - break; - - case COLLECTION_ACTION_GET: - TRACE_INFO_STRING("It is a get action.", ""); - if (custom_data != NULL) - *((struct collection_item **)(custom_data)) = current; - break; - - case COLLECTION_ACTION_DEL: - TRACE_INFO_STRING("It is a delete action.", ""); - /* Make sure we tell the caller we found a match */ - if (custom_data != NULL) - *(int *)custom_data = COL_MATCH; - - /* Adjust header of the collection */ - header = (struct collection_header *)head->data; - header->count--; - if (current->next == NULL) - header->last = previous; - - /* Unlink and delete iteam */ - /* Previous can't be NULL here becuase we never delete - * header elements */ - previous->next = current->next; - col_delete_item(current); - TRACE_INFO_STRING("Did the delete of the item.", ""); - break; - - case COLLECTION_ACTION_UPDATE: - TRACE_INFO_STRING("It is an update action.", ""); - if((current->type == COL_TYPE_COLLECTION) || - (current->type == COL_TYPE_COLLECTIONREF)) { - TRACE_ERROR_STRING("Can't update collections it is an error for now", ""); - return EINVAL; - } - - /* Make sure we tell the caller we found a match */ - if (custom_data != NULL) { - update_data = (struct update_property *)custom_data; - update_data->found = COL_MATCH; - error = col_update_current_item(current, update_data); - } - else { - TRACE_ERROR_STRING("Error - update data is required", ""); - return EINVAL; - } - - TRACE_INFO_STRING("Did the delete of the item.", ""); - break; - default: - break; - } - /* Force interrupt if we found */ - *stop = 1; - } - - TRACE_FLOW_NUMBER("col_act_traverse_handler returning", error); - return error; -} - - -/* Traverse handler for copy function */ -static int col_copy_traverse_handler(struct collection_item *head, - struct collection_item *previous, - struct collection_item *current, - void *passed_traverse_data, - col_item_fn user_item_handler, - void *custom_data, - int *stop) -{ - int error = EOK; - struct collection_item *parent; - struct collection_item *other = NULL; - struct col_copy *traverse_data; - struct path_data *temp; - char *name; - int length; - char *property = NULL; - int property_len; - struct collection_header *header; - char *offset; - - TRACE_FLOW_STRING("col_copy_traverse_handler", "Entry."); - - parent = (struct collection_item *)custom_data; - traverse_data = (struct col_copy *)passed_traverse_data; - - /* We can be called when current points to NULL */ - /* This will happen only in the FLATDOT case */ - if (current == NULL) { - TRACE_INFO_STRING("col_copy_traverse_handler", - "Special call at the end of the collection."); - temp = traverse_data->current_path; - traverse_data->current_path = temp->previous_path; - temp->previous_path = NULL; - col_delete_path_data(temp); - traverse_data->given_name = NULL; - traverse_data->given_len = 0; - TRACE_FLOW_NUMBER("Handling end of collection - removed path. Returning:", error); - return error; - } - - /* Create new path at the beginning of a new sub collection */ - if (current->type == COL_TYPE_COLLECTION) { - - TRACE_INFO_STRING("col_copy_traverse_handler", - "Processing collection handle."); - if (traverse_data->mode == COL_COPY_FLATDOT) { - /* Create new path */ - if (traverse_data->current_path != NULL) { - TRACE_INFO_STRING("Already have part of the path", ""); - name = traverse_data->current_path->name; - length = traverse_data->current_path->length; - TRACE_INFO_STRING("Path:", name); - TRACE_INFO_NUMBER("Path len:", length); - if (traverse_data->given_name != NULL) { - property = traverse_data->given_name; - property_len = traverse_data->given_len; - } - else { - property = current->property; - property_len = current->property_len; - } - } - else { - /* Do not create prefix for top collection - * if there is no given name. - */ - name = NULL; - length = 0; - if (traverse_data->given_name != NULL) { - property = traverse_data->given_name; - property_len = traverse_data->given_len; - } - else { - property = NULL; - property_len = 0; - } - } - - TRACE_INFO_STRING("col_copy_traverse_handler", "About to create path data."); - - error = col_create_path_data(&(traverse_data->current_path), - name, length, - property, property_len, '.'); - - TRACE_FLOW_NUMBER("col_copy_traverse_handler processed header:", error); - return error; - } - else { - TRACE_FLOW_NUMBER("col_copy_traverse_handler skipping the header:", error); - return error; - } - } - - - /* Check if this is a special case of sub collection */ - if (current->type == COL_TYPE_COLLECTIONREF) { - - TRACE_INFO_STRING("Found a subcollection we need to copy. Name:", - current->property); - - /* Based on the mode we need to do different things */ - switch (traverse_data->mode) { - case COL_COPY_NORMAL: - - error = col_copy_collection(&other, - *((struct collection_item **)(current->data)), - current->property, - COL_COPY_NORMAL); - if (error) { - TRACE_ERROR_NUMBER("Copy subcollection returned error:", error); - return error; - } - - /* Add new item to a collection - * all references are now sub collections */ - error = col_insert_property_with_ref_int(parent, - NULL, - COL_DSP_END, - NULL, - 0, - 0, - current->property, - COL_TYPE_COLLECTIONREF, - (void *)(&other), - sizeof(struct collection_item **), - NULL); - - TRACE_FLOW_NUMBER("col_copy_traverse_handler returning in NORMAL mode:", error); - return error; - - case COL_COPY_KEEPREF: - - /* Just increase reference count of the referenced collection */ - other = *((struct collection_item **)(current->data)); - header = (struct collection_header *)(other->data); - header->reference_count++; - - /* Add new item to a collection - * all references are now sub collections */ - error = col_insert_property_with_ref_int(parent, - NULL, - COL_DSP_END, - NULL, - 0, - 0, - current->property, - COL_TYPE_COLLECTIONREF, - (void *)(&other), - sizeof(struct collection_item **), - NULL); - TRACE_FLOW_NUMBER("col_copy_traverse_handler returning in KEEPREF mode:", error); - return error; - - case COL_COPY_TOP: - /* Told to ignore sub collections */ - TRACE_FLOW_NUMBER("col_copy_traverse_handler returning in TOP mode:", error); - return error; - - case COL_COPY_FLATDOT: - - traverse_data->given_name = current->property; - traverse_data->given_len = current->property_len; - TRACE_INFO_STRING("Saved given name:", traverse_data->given_name); - TRACE_FLOW_NUMBER("col_copy_traverse_handler returning in FLATDOT mode:", error); - return error; - - /* NOTE: The mode COL_COPY_FLAT is not in the list of cases becuase - * in this flat mode we traverse collection using COL_TRAVERSE_FLAT flag - * thus we should not be called on referenced collections at all - * by the col_walk_items() function. - */ - - default: - TRACE_ERROR_NUMBER("col_copy_traverse_handler bad mode error:", EINVAL); - return EINVAL; - } - } - else { - - if (traverse_data->mode == COL_COPY_FLATDOT) { - /* Since this code can't use asprintf have to do it hard way */ - property = malloc(traverse_data->current_path->length + - current->property_len + 2); - if (property == NULL) { - TRACE_ERROR_NUMBER("Failed to allocate memory for a new name:", error); - return error; - } - /* Add first part and dot only if we have prefix */ - offset = property; - if (traverse_data->current_path->length) { - memcpy(offset, traverse_data->current_path->name, - traverse_data->current_path->length); - offset[traverse_data->current_path->length] = '.'; - offset += traverse_data->current_path->length + 1; - } - memcpy(offset, current->property, current->property_len); - offset[current->property_len] = '\0'; - } - else property = current->property; - - TRACE_INFO_STRING("Using property:", property); - - error = col_copy_item_with_cb(parent, - property, - current->type, - current->data, - current->length, - traverse_data->copy_cb, - traverse_data->ext_data); - - /* Free property if we allocated it */ - if (traverse_data->mode == COL_COPY_FLATDOT) free(property); - - if (error) { - TRACE_ERROR_NUMBER("Failed to copy property:", error); - return error; - } - } - - TRACE_FLOW_NUMBER("col_copy_traverse_handler returning", error); - return error; -} - - - - -/********************* MAIN INTERFACE FUNCTIONS *****************************/ - - -/* CREATE */ - -/* Function that creates an named collection of a given class*/ -int col_create_collection(struct collection_item **ci, const char *name, - unsigned cclass) -{ - struct collection_item *handle = NULL; - struct collection_header header; - int error = EOK; - - TRACE_FLOW_STRING("col_create_collection", "Entry."); - - /* Prepare header */ - header.last = NULL; - header.reference_count = 1; - header.count = 0; - header.cclass = cclass; - - /* Create a collection type property */ - error = col_insert_property_with_ref_int(NULL, - NULL, - COL_DSP_END, - NULL, - 0, - 0, - name, - COL_TYPE_COLLECTION, - &header, - sizeof(header), - &handle); - - - if (error) return error; - - *ci = handle; - - TRACE_FLOW_STRING("col_create_collection", "Success Exit."); - return EOK; -} - - -/* DESTROY */ - -/* Function that destroys a collection */ -void col_destroy_collection(struct collection_item *ci) -{ - struct collection_header *header; - - TRACE_FLOW_STRING("col_destroy_collection", "Entry."); - - /* Do not try to delete NULL */ - if (ci == NULL) return; - - /* You can delete only whole collection not a part of it */ - if (ci->type != COL_TYPE_COLLECTION) { - TRACE_ERROR_STRING("Attempt to delete a non collection - BAD!", ""); - TRACE_ERROR_NUMBER("Actual type is:", ci->type); - return; - } - - TRACE_INFO_STRING("Name:", ci->property); - - /* Collection can be referenced by other collection */ - header = (struct collection_header *)(ci->data); - TRACE_INFO_NUMBER("Reference count:", header->reference_count); - if (header->reference_count > 1) { - TRACE_INFO_STRING("Dereferencing a referenced collection.", ""); - header->reference_count--; - TRACE_INFO_NUMBER("Number after dereferencing.", - header->reference_count); - } - else { - col_delete_collection(ci); - } - - TRACE_FLOW_STRING("col_destroy_collection", "Exit."); -} - - -/* COPY */ - -/* Wrapper around a more advanced function */ -int col_copy_collection(struct collection_item **collection_copy, - struct collection_item *collection_to_copy, - const char *name_to_use, - int copy_mode) -{ - int error = EOK; - TRACE_FLOW_STRING("col_copy_collection", "Entry."); - - error = col_copy_collection_with_cb(collection_copy, - collection_to_copy, - name_to_use, - copy_mode, - NULL, - NULL); - - TRACE_FLOW_NUMBER("col_copy_collection. Exit. Returning", error); - return error; -} - -/* Create a deep copy of the current collection. */ -/* Referenced collections of the donor are copied as sub collections. */ -int col_copy_collection_with_cb(struct collection_item **collection_copy, - struct collection_item *collection_to_copy, - const char *name_to_use, - int copy_mode, - col_copy_cb copy_cb, - void *ext_data) -{ - int error = EOK; - struct collection_item *new_collection = NULL; - const char *name; - struct collection_header *header; - unsigned depth = 0; - struct col_copy traverse_data; - int flags; - - TRACE_FLOW_STRING("col_copy_collection_with_cb", "Entry."); - - /* Collection is required */ - if (collection_to_copy == NULL) { - TRACE_ERROR_NUMBER("No collection to search!", EINVAL); - return EINVAL; - } - - /* Storage is required too */ - if (collection_copy == NULL) { - TRACE_ERROR_NUMBER("No memory provided to receive collection copy!", EINVAL); - return EINVAL; - } - - /* NOTE: Refine this check if adding a new copy mode */ - if ((copy_mode < 0) || (copy_mode > COL_COPY_TOP)) { - TRACE_ERROR_NUMBER("Invalid copy mode:", copy_mode); - return EINVAL; - } - - /* Determine what name to use */ - if (name_to_use != NULL) - name = name_to_use; - else - name = collection_to_copy->property; - - header = (struct collection_header *)collection_to_copy->data; - - /* Create a new collection */ - error = col_create_collection(&new_collection, name, header->cclass); - if (error) { - TRACE_ERROR_NUMBER("col_create_collection failed returning", error); - return error; - } - - traverse_data.mode = copy_mode; - traverse_data.current_path = NULL; - traverse_data.given_name = NULL; - traverse_data.given_len = 0; - traverse_data.copy_cb = copy_cb; - traverse_data.ext_data = ext_data; - - if (copy_mode == COL_COPY_FLATDOT) flags = COL_TRAVERSE_DEFAULT | COL_TRAVERSE_END; - else if (copy_mode == COL_COPY_FLAT) flags = COL_TRAVERSE_FLAT; - else flags = COL_TRAVERSE_ONELEVEL; - - error = col_walk_items(collection_to_copy, flags, - col_copy_traverse_handler, (void *)(&traverse_data), - NULL, new_collection, &depth); - - if (!error) *collection_copy = new_collection; - else col_destroy_collection(new_collection); - - TRACE_FLOW_NUMBER("col_copy_collection_with_cb returning", error); - return error; - -} - - -/* EXTRACTION */ - -/* Extract collection */ -int col_get_collection_reference(struct collection_item *ci, - struct collection_item **acceptor, - const char *collection_to_find) -{ - struct collection_header *header; - struct collection_item *subcollection = NULL; - int error = EOK; - - TRACE_FLOW_STRING("col_get_collection_reference", "Entry."); - - if ((ci == NULL) || - (ci->type != COL_TYPE_COLLECTION) || - (acceptor == NULL)) { - TRACE_ERROR_NUMBER("Invalid parameter - returning error",EINVAL); - return EINVAL; - } - - if (collection_to_find) { - /* Find a sub collection */ - TRACE_INFO_STRING("We are given subcollection name - search it:", - collection_to_find); - error = col_find_item_and_do(ci, collection_to_find, - COL_TYPE_COLLECTIONREF, - COL_TRAVERSE_DEFAULT, - col_get_subcollection, - (void *)(&subcollection), - COLLECTION_ACTION_FIND); - if (error) { - TRACE_ERROR_NUMBER("Search failed returning error", error); - return error; - } - - if (subcollection == NULL) { - TRACE_ERROR_STRING("Search for subcollection returned NULL pointer", ""); - return ENOENT; - } - } - else { - /* Create reference to the same collection */ - TRACE_INFO_STRING("Creating reference to the top level collection.", ""); - subcollection = ci; - } - - header = (struct collection_header *)subcollection->data; - TRACE_INFO_NUMBER("Count:", header->count); - TRACE_INFO_NUMBER("Ref count:", header->reference_count); - header->reference_count++; - TRACE_INFO_NUMBER("Ref count after increment:", header->reference_count); - *acceptor = subcollection; - - TRACE_FLOW_STRING("col_get_collection_reference", "Success Exit."); - return EOK; -} - -/* Get collection - if current item is a reference get a real collection from it. */ -int col_get_reference_from_item(struct collection_item *ci, - struct collection_item **acceptor) -{ - struct collection_header *header; - struct collection_item *subcollection = NULL; - - TRACE_FLOW_STRING("get_reference_from_item", "Entry."); - - if ((ci == NULL) || - (ci->type != COL_TYPE_COLLECTIONREF) || - (acceptor == NULL)) { - TRACE_ERROR_NUMBER("Invalid parameter - returning error",EINVAL); - return EINVAL; - } - - subcollection = *((struct collection_item **)ci->data); - - header = (struct collection_header *)subcollection->data; - TRACE_INFO_NUMBER("Count:", header->count); - TRACE_INFO_NUMBER("Ref count:", header->reference_count); - header->reference_count++; - TRACE_INFO_NUMBER("Ref count after increment:", header->reference_count); - *acceptor = subcollection; - - TRACE_FLOW_STRING("col_get_reference_from_item", "Success Exit."); - return EOK; -} - -/* ADDITION */ - -/* Add collection to collection */ -int col_add_collection_to_collection(struct collection_item *ci, - const char *sub_collection_name, - const char *as_property, - struct collection_item *collection_to_add, - int mode) -{ - struct collection_item *acceptor = NULL; - const char *name_to_use; - struct collection_header *header; - struct collection_item *collection_copy; - int error = EOK; - struct col_copy traverse_data; - unsigned depth = 0; - - - TRACE_FLOW_STRING("col_add_collection_to_collection", "Entry."); - - if ((ci == NULL) || - (ci->type != COL_TYPE_COLLECTION) || - (collection_to_add == NULL) || - (collection_to_add->type != COL_TYPE_COLLECTION)) { - /* Need to debug here */ - TRACE_ERROR_NUMBER("Missing parameter - returning error", EINVAL); - return EINVAL; - } - - if (sub_collection_name != NULL) { - /* Find a sub collection */ - TRACE_INFO_STRING("We are given subcollection name - search it:", - sub_collection_name); - error = col_find_item_and_do(ci, sub_collection_name, - COL_TYPE_COLLECTIONREF, - COL_TRAVERSE_DEFAULT, - col_get_subcollection, - (void *)(&acceptor), - COLLECTION_ACTION_FIND); - if (error) { - TRACE_ERROR_NUMBER("Search failed returning error", error); - return error; - } - - if (acceptor == NULL) { - TRACE_ERROR_STRING("Search for subcollection returned NULL pointer", ""); - return ENOENT; - } - - } - else { - acceptor = ci; - } - - if (as_property != NULL) - name_to_use = as_property; - else - name_to_use = collection_to_add->property; - - - TRACE_INFO_STRING("Going to use name:", name_to_use); - - - switch (mode) { - case COL_ADD_MODE_REFERENCE: - TRACE_INFO_STRING("We are adding a reference.", ""); - TRACE_INFO_NUMBER("Type of the header element:", - collection_to_add->type); - TRACE_INFO_STRING("Header name we are adding.", - collection_to_add->property); - /* Create a pointer to external collection */ - /* For future thread safety: Transaction start -> */ - error = col_insert_property_with_ref_int(acceptor, - NULL, - COL_DSP_END, - NULL, - 0, - 0, - name_to_use, - COL_TYPE_COLLECTIONREF, - (void *)(&collection_to_add), - sizeof(struct collection_item **), - NULL); - - TRACE_INFO_NUMBER("Type of the header element after adding property:", - collection_to_add->type); - TRACE_INFO_STRING("Header name we just added.", - collection_to_add->property); - if (error) { - TRACE_ERROR_NUMBER("Adding property failed with error:", error); - return error; - } - header = (struct collection_header *)collection_to_add->data; - TRACE_INFO_NUMBER("Count:", header->count); - TRACE_INFO_NUMBER("Ref count:", header->reference_count); - header->reference_count++; - TRACE_INFO_NUMBER("Ref count after increment:", - header->reference_count); - /* -> Transaction end */ - break; - - case COL_ADD_MODE_EMBED: - TRACE_INFO_STRING("We are embedding the collection.", ""); - /* First check if the passed in collection is referenced more than once */ - TRACE_INFO_NUMBER("Type of the header element we are adding:", - collection_to_add->type); - TRACE_INFO_STRING("Header name we are adding.", - collection_to_add->property); - TRACE_INFO_NUMBER("Type of the header element we are adding to:", - acceptor->type); - TRACE_INFO_STRING("Header name we are adding to.", - acceptor->property); - - error = col_insert_property_with_ref_int(acceptor, - NULL, - COL_DSP_END, - NULL, - 0, - 0, - name_to_use, - COL_TYPE_COLLECTIONREF, - (void *)(&collection_to_add), - sizeof(struct collection_item **), - NULL); - - - TRACE_INFO_NUMBER("Adding property returned:", error); - break; - - case COL_ADD_MODE_CLONE: - TRACE_INFO_STRING("We are cloning the collection.", ""); - TRACE_INFO_STRING("Name we will use.", name_to_use); - - /* For future thread safety: Transaction start -> */ - error = col_copy_collection(&collection_copy, - collection_to_add, name_to_use, - COL_COPY_NORMAL); - if (error) return error; - - TRACE_INFO_STRING("We have a collection copy.", collection_copy->property); - TRACE_INFO_NUMBER("Collection type.", collection_copy->type); - TRACE_INFO_STRING("Acceptor collection.", acceptor->property); - TRACE_INFO_NUMBER("Acceptor collection type.", acceptor->type); - - error = col_insert_property_with_ref_int(acceptor, - NULL, - COL_DSP_END, - NULL, - 0, - 0, - name_to_use, - COL_TYPE_COLLECTIONREF, - (void *)(&collection_copy), - sizeof(struct collection_item **), - NULL); - - /* -> Transaction end */ - TRACE_INFO_NUMBER("Adding property returned:", error); - break; - - case COL_ADD_MODE_FLAT: - TRACE_INFO_STRING("We are flattening the collection.", ""); - - traverse_data.mode = COL_COPY_FLAT; - traverse_data.current_path = NULL; - traverse_data.copy_cb = NULL; - traverse_data.ext_data = NULL; - - if ((as_property) && (*as_property)) { - /* The normal assignement generates a warning - * becuase I am assigning const to a non const. - * I can't make the structure member to be const - * since it changes but it changes - * to point to different stings at different time - * This is just an initial sting it will use. - * The logic does not change the content of the string. - * To overcome the issue I use memcpy(); - */ - memcpy(&(traverse_data.given_name), - &(as_property), sizeof(char *)); - traverse_data.given_len = strlen(as_property); - } - else { - traverse_data.given_name = NULL; - traverse_data.given_len = 0; - } - - error = col_walk_items(collection_to_add, COL_TRAVERSE_FLAT, - col_copy_traverse_handler, (void *)(&traverse_data), - NULL, acceptor, &depth); - - TRACE_INFO_NUMBER("Copy collection flat returned:", error); - break; - - case COL_ADD_MODE_FLATDOT: - TRACE_INFO_STRING("We are flattening the collection with dots.", ""); - - traverse_data.mode = COL_COPY_FLATDOT; - traverse_data.current_path = NULL; - traverse_data.copy_cb = NULL; - traverse_data.ext_data = NULL; - - if ((as_property) && (*as_property)) { - /* The normal assignement generates a warning - * becuase I am assigning const to a non const. - * I can't make the structure member to be const - * since it changes but it changes - * to point to different stings at different time - * This is just an initial sting it will use. - * The logic does not change the content of the string. - * To overcome the issue I use memcpy(); - */ - memcpy(&(traverse_data.given_name), - &(as_property), sizeof(char *)); - traverse_data.given_len = strlen(as_property); - } - else { - traverse_data.given_name = NULL; - traverse_data.given_len = 0; - } - - error = col_walk_items(collection_to_add, COL_TRAVERSE_DEFAULT | COL_TRAVERSE_END, - col_copy_traverse_handler, (void *)(&traverse_data), - NULL, acceptor, &depth); - - TRACE_INFO_NUMBER("Copy collection flatdot returned:", error); - break; - - default: - error = EINVAL; - } - - TRACE_FLOW_NUMBER("col_add_collection_to_collection returning:", error); - return error; -} - -/* TRAVERSING */ - -/* Function to traverse the entire collection including optionally - * sub collections */ -int col_traverse_collection(struct collection_item *ci, - int mode_flags, - col_item_fn item_handler, - void *custom_data) -{ - - int error = EOK; - unsigned depth = 0; - - TRACE_FLOW_STRING("col_traverse_collection", "Entry."); - - if (ci == NULL) { - TRACE_ERROR_NUMBER("No collection to traverse!", EINVAL); - return EINVAL; - } - - error = col_walk_items(ci, mode_flags, col_simple_traverse_handler, - NULL, item_handler, custom_data, &depth); - - if ((error != 0) && (error != EINTR_INTERNAL)) { - TRACE_ERROR_NUMBER("Error walking tree", error); - return error; - } - - TRACE_FLOW_STRING("col_traverse_collection", "Success exit."); - return EOK; -} - -/* CHECK */ - -/* Convenience function to check if specific property is in the collection */ -int col_is_item_in_collection(struct collection_item *ci, - const char *property_to_find, - int type, - int mode_flags, - int *found) -{ - int error; - - TRACE_FLOW_STRING("col_is_item_in_collection","Entry."); - - *found = COL_NOMATCH; - error = col_find_item_and_do(ci, property_to_find, - type, mode_flags, - col_is_in_item_handler, - (void *)found, - COLLECTION_ACTION_FIND); - - TRACE_FLOW_NUMBER("col_is_item_in_collection returning", error); - return error; -} - -/* SEARCH */ -/* Search function. Looks up an item in the collection based on the property. - Essentually it is a traverse function with spacial traversing logic. - */ -int col_get_item_and_do(struct collection_item *ci, - const char *property_to_find, - int type, - int mode_flags, - col_item_fn item_handler, - void *custom_data) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_get_item_and_do","Entry."); - - error = col_find_item_and_do(ci, property_to_find, - type, mode_flags, - item_handler, - custom_data, - COLLECTION_ACTION_FIND); - - TRACE_FLOW_NUMBER("col_get_item_and_do returning", error); - return error; -} - - -/* Get raw item */ -int col_get_item(struct collection_item *ci, - const char *property_to_find, - int type, - int mode_flags, - struct collection_item **item) -{ - - int error = EOK; - - TRACE_FLOW_STRING("col_get_item", "Entry."); - - error = col_find_item_and_do(ci, property_to_find, - type, mode_flags, - NULL, (void *)item, - COLLECTION_ACTION_GET); - - TRACE_FLOW_NUMBER("col_get_item returning", error); - return error; -} - -/* DELETE */ -/* Delete property from the collection */ -int col_delete_property(struct collection_item *ci, - const char *property_to_find, - int type, - int mode_flags) -{ - int error = EOK; - int found; - - TRACE_FLOW_STRING("col_delete_property", "Entry."); - found = COL_NOMATCH; - - error = col_find_item_and_do(ci, property_to_find, - type, mode_flags, - NULL, (void *)(&found), - COLLECTION_ACTION_DEL); - - if ((error == EOK) && (found == COL_NOMATCH)) - error = ENOENT; - - TRACE_FLOW_NUMBER("col_delete_property returning", error); - return error; -} - -/* UPDATE */ -/* Update property in the collection */ -int col_update_property(struct collection_item *ci, - const char *property_to_find, - int type, - void *new_data, - int length, - int mode_flags) -{ - int error = EOK; - struct update_property update_data; - - TRACE_FLOW_STRING("col_update_property", "Entry."); - update_data.type = type; - update_data.data = new_data; - update_data.length = length; - update_data.found = COL_NOMATCH; - - error = col_find_item_and_do(ci, property_to_find, - type, mode_flags, - NULL, (void *)(&update_data), - COLLECTION_ACTION_UPDATE); - - if ((error == EOK) && (update_data.found == COL_NOMATCH)) - error = ENOENT; - - TRACE_FLOW_NUMBER("col_update_property returning", error); - return error; -} - - -/* Function to modify the item */ -int col_modify_item(struct collection_item *item, - const char *property, - int type, - const void *data, - int length) -{ - TRACE_FLOW_STRING("col_modify_item", "Entry"); - - if ((item == NULL) || - (item->type == COL_TYPE_COLLECTION) || - (item->type == COL_TYPE_COLLECTIONREF)) { - TRACE_ERROR_NUMBER("Invalid argument or invalid argument type", EINVAL); - return EINVAL; - } - - if (property != NULL) { - if (col_validate_property(property)) { - TRACE_ERROR_STRING("Invalid chracters in the property name", property); - return EINVAL; - } - free(item->property); - item->property = strdup(property); - if (item->property == NULL) { - TRACE_ERROR_STRING("Failed to allocate memory", ""); - return ENOMEM; - } - - /* Update property length and hash if we rename the property */ - item->phash = col_make_hash(property, 0, &(item->property_len)); - TRACE_INFO_NUMBER("Item hash", item->phash); - TRACE_INFO_NUMBER("Item property length", item->property_len); - TRACE_INFO_NUMBER("Item property strlen", strlen(item->property)); - - } - - /* We need to change data ? */ - if(length) { - - /* If type is different or same but it is string or binary we need to - * replace the storage */ - if ((item->type != type) || - ((item->type == type) && - ((item->type == COL_TYPE_STRING) || (item->type == COL_TYPE_BINARY)))) { - TRACE_INFO_STRING("Replacing item data buffer", ""); - free(item->data); - item->data = malloc(length); - if (item->data == NULL) { - TRACE_ERROR_STRING("Failed to allocate memory", ""); - item->length = 0; - return ENOMEM; - } - item->length = length; - } - - TRACE_INFO_STRING("Overwriting item data", ""); - memcpy(item->data, data, item->length); - item->type = type; - - if (item->type == COL_TYPE_STRING) - ((char *)(item->data))[item->length - 1] = '\0'; - } - - TRACE_FLOW_STRING("col_modify_item", "Exit"); - return EOK; -} - - -/* Set collection class */ -int col_set_collection_class(struct collection_item *item, - unsigned cclass) -{ - struct collection_header *header; - - TRACE_FLOW_STRING("col_set_collection_class", "Entry"); - - if (item->type != COL_TYPE_COLLECTION) { - TRACE_INFO_NUMBER("Not a collectin object. Type is", item->type); - return EINVAL; - } - - header = (struct collection_header *)item->data; - header->cclass = cclass; - TRACE_FLOW_STRING("col_set_collection_class", "Exit"); - return EOK; -} - -/* Get collection class */ -int col_get_collection_class(struct collection_item *item, - unsigned *cclass) -{ - struct collection_header *header; - - TRACE_FLOW_STRING("col_get_collection_class", "Entry"); - - if (item->type != COL_TYPE_COLLECTION) { - TRACE_ERROR_NUMBER("Not a collection object. Type is", item->type); - return EINVAL; - } - - header = (struct collection_header *)item->data; - *cclass = header->cclass; - TRACE_FLOW_STRING("col_get_collection_class", "Exit"); - return EOK; -} - -/* Get collection count */ -int col_get_collection_count(struct collection_item *item, - unsigned *count) -{ - struct collection_header *header; - - TRACE_FLOW_STRING("col_get_collection_count", "Entry"); - - if (item->type != COL_TYPE_COLLECTION) { - TRACE_ERROR_NUMBER("Not a collectin object. Type is", item->type); - return EINVAL; - } - - header = (struct collection_header *)item->data; - *count = header->count; - TRACE_FLOW_STRING("col_get_collection_count", "Exit"); - return EOK; - -} - -/* Convinience function to check if the collection is of the specific class */ -/* In case of internal error assumes that collection is not of the right class */ -int col_is_of_class(struct collection_item *item, unsigned cclass) -{ - int error = EOK; - unsigned ret_class = 0; - - TRACE_FLOW_STRING("col_is_of_class invoked", ""); - - error = col_get_collection_class(item, &ret_class); - if (error || (ret_class != cclass)) - return 0; - else - return 1; -} - -/* Get propery */ -const char *col_get_item_property(struct collection_item *ci, - int *property_len) -{ - if (property_len != NULL) *property_len = ci->property_len; - return ci->property; -} - -/* Get type */ -int col_get_item_type(struct collection_item *ci) -{ - return ci->type; -} - -/* Get length */ -int col_get_item_length(struct collection_item *ci) -{ - return ci->length; -} - -/* Get data */ -void *col_get_item_data(struct collection_item *ci) -{ - return ci->data; -} - -/* Get hash */ -uint64_t col_get_item_hash(struct collection_item *ci) -{ - return ci->phash; -} - -/* Calculates hash of the string using internal hashing - * algorithm. Populates "length" with length - * of the string not counting 0. - * Length argument can be NULL. - */ -uint64_t col_make_hash(const char *string, int sub_len, int *length) -{ - uint64_t hash = 0; - int str_len = 0; - - TRACE_FLOW_STRING("col_make_hash called for string:", string); - - if (string) { - hash = FNV1a_base; - while (string[str_len] != 0) { - - /* Check if we need to stop */ - if ((sub_len > 0) && (str_len == sub_len)) break; - - hash = hash ^ toupper(string[str_len]); - hash *= FNV1a_prime; - str_len++; - } - } - - if (length) *length = str_len; - - TRACE_FLOW_NUMBER("col_make_hash returning hash:", hash); - - return hash; -} diff --git a/common/collection/collection.cfg.doxy.in b/common/collection/collection.cfg.doxy.in deleted file mode 100644 index 7f5d94e1b..000000000 --- a/common/collection/collection.cfg.doxy.in +++ /dev/null @@ -1,1566 +0,0 @@ -# Doxyfile 1.6.3 - -# 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 = "libcollection" - -# 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 = @PACKAGE_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 = doc - -# 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 = YES - -# 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 = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the - -# 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 = YES - -# 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 = NO - -# 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 = NO - -# 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 = YES - -# 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 = YES - -# 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 = NO - -# 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 = YES - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen -# will list include files with double quotes in the documentation -# rather than with sharp brackets. - -FORCE_LOCAL_INCLUDES = 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 = NOGENERATE MAN - -# 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 = NO - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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 = NO - -# 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 = @srcdir@ - -# 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 = *.c *.h - -# 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 = *_ut.c *priv* config.h - -# 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 = - -# 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 - -# If the HTML_FOOTER_DESCRIPTION tag is set to YES, Doxygen will -# add generated date, project name and doxygen version to HTML footer. - -HTML_FOOTER_DESCRIPTION= NO - -# 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_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting -# this to NO can help when comparing the output of multiple runs. - -HTML_TIMESTAMP = YES - -# 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 = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files -# will be generated, which together with the HTML files, form an Eclipse help -# plugin. To install this plugin and make it available under the help contents -# menu in Eclipse, the contents of the directory containing the HTML and XML -# files needs to be copied into the plugins directory of eclipse. The name of -# the directory within the plugins directory should be the same as -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have -# this name. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# 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 enabled 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), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should -# typically be disabled. For large projects the javascript based search engine -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. - -SEARCHENGINE = YES - -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index -# file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup -# and does not have live searching capabilities. - -SERVER_BASED_SEARCH = 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. -# Note that when enabling USE_PDFLATEX this option is only used for -# generating bitmaps for formulas in the HTML output, but not in the -# Makefile that is written to the output directory. - -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 = YES - -# 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 = YES - -# 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 = NO - -# 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 = YES - -# 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 = YES - -# 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 = NO - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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/common/collection/collection.h b/common/collection/collection.h deleted file mode 100644 index b656ebb34..000000000 --- a/common/collection/collection.h +++ /dev/null @@ -1,3189 +0,0 @@ -/* - COLLECTION LIBRARY - - Header file for collection interface. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - Collection Library 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. - - Collection Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with Collection Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#ifndef COLLECTION_H -#define COLLECTION_H - -#include <stdint.h> - -/** @mainpage The COLLECTION interface - * The collection is a set of items of different types. - * - * To better understand how collections work imagine travel bags. - * They usually come in different sizes and one can put a bag in a bag when - * they put away to the shelf in a garage or closet. Collection is such bag - * except that you can put other bags into each other even if they are not - * empty.<br> - * When you put items into a bag you do not see the contents of the bag. - * You just hold the bag. How many other bags inside this bag you do not know. - * But you might know that you put a "wallet" somewhere there. - * You ask the bag you hold: "find my wallet and give it to me". - * get_item function will return you the item that is your "wallet". - * You can then change something or just get information about the item you - * retrieved. But in most cases you do not need the wallet itself. You want to - * get something from the wallet or put something into it. IMO money would - * be an obvious choice. To do this you use update_xxx_property functions.<br> - * There might be a bag somewhere deep and you might want to add something to - * it. add_xxx_property_xxx functions allow you to specify sub collection you - * want the item to be added to. If this sub collection argument is NULL top - * level collection is assumed.<br> - * The search in the collections uses a "x!y!z" notation to refer to an item (or - * property). You can search for "wallet" and it will find any first instance of - * the "wallet" in your luggage. But you might have two wallets. One is yours and - * another is your significant other's. So you might say find "my!wallet". - * It will find wallet in your bag (collection) named "my". This collection can - * be many levels deep inside other collections. You do not need to know the - * full path to get to it. But if you have the full path you can use the fill - * path like this "luggage!newbags!my!wallet".<br> - * It is useful to be able to put bags into bags as well as get them out of each - * other. When the collection is created the header keeps a reference count on - * how many copies of the collection are known to the world. So one can put a - * collection into collection and give up its access to it (embed) or still hold - * to the reference. By embedding the collection the caller effectively gives - * up its responsibility to destroy the collection after it is used.<br> - * By extracting reference from an internal collection the caller gains access - * to the collection directly and thus has responsibility to destroy it after - * use. - * - * Internally collection is implemented as a link list rather than a hash - * table. - * This makes it suitable for small (dozens of items) sets of data for which - * the order is important. Thus the collection properties and sub collections - * can be used to model objects like a book case. Imagine a book case that - * consists of multiple shelves. You can perform operations like "add a new - * shelf after second shelf" or "put a book on the 4th shelf right before - * the book with the red cover." - * - * A bit of terminology: - * - <b>collection</b> - an object implemented as a link list that holds - * properties (attributes). - * - <b>property</b> - a named logical element of the collection. - * - <b>item</b> - physical element of the collection, think about it - * as a node in the link list. - * - <b>value</b> - data associated with the property. - * - <b>type</b> - type of the data associated with a property. - * - <b>length</b> - length of the data associated with the property. - * - <b>sub collection</b> - collection embedded into another collection. - * It is a property with the value of a special - * type. The name of the property that denotes - * a sub collection can be different from the name - * of the collection it refers to. - * - <b>traverse</b> - call a function that will internally iterate - * through a collection and do something with its - * elements. - * - <b>iterate</b> - step through a collection yourselves. - * - * Characters with codes less than space in ASCII table are illegal for - * property names. - * Character '!' also illegal in a property or collection name and - * reserved for "x!y!z" notation. - * - * There is always a header item in any collection that starts the collection. - * Most of the functions in the interface (unless explicitly stated otherwise) - * assume that the collection_item * argument points to the header element. - * Passing in elements extracted from the middle of a collection to functions - * that expect header elements is illegal. There might be not enough checking - * at the moment but this will be enforced in future versions of the library. - * - */ - -#ifndef EOK -#define EOK 0 -#endif - -/** - * @defgroup collection COLLECTION interface - * @{ - */ - -/** - * @brief Default class for a free form collection. - */ -#define COL_CLASS_DEFAULT 0 - -/** - * @brief Value indicates that property is not found. - * - * Used in search functions. - */ -#define COL_NOMATCH 0 -/** - * @brief Value indicates that property is found. - * - * Used in search functions. - */ -#define COL_MATCH 1 - - -/** - * @defgroup coltypes Type definition constants - * @{ - */ -/** - * @brief Indicates that property is of type "string". - * - * For elements of type string the length includes the trailing 0. - */ -#define COL_TYPE_STRING 0x00000001 -/** @brief Indicates that property is of type "binary". */ -#define COL_TYPE_BINARY 0x00000002 -/** @brief Indicates that property is of type "integer". */ -#define COL_TYPE_INTEGER 0x00000004 -/** @brief Indicates that property is of type "unsigned". */ -#define COL_TYPE_UNSIGNED 0x00000008 -/** @brief Indicates that property is of type "long". */ -#define COL_TYPE_LONG 0x00000010 -/** @brief Indicates that property is of type "unsigned long". */ -#define COL_TYPE_ULONG 0x00000020 -/** @brief Indicates that property is of type "double". */ -#define COL_TYPE_DOUBLE 0x00000040 -/** @brief Indicates that property is of Boolean type. */ -#define COL_TYPE_BOOL 0x00000080 -/** - * @brief Indicates that property is of type "collection". - * - * The item of this type denotes that starting element of a - * collection. - */ -#define COL_TYPE_COLLECTION 0x00000100 -/** - * @brief Indicates that property is of type "sub collection". - * - * An item of this type is a pointer to an existing external - * collection. - */ -#define COL_TYPE_COLLECTIONREF 0x00000200 -/** - * @brief Special type that denotes the end of the collection. - * - * Useful when traversing collections. - */ -#define COL_TYPE_END 0x10000000 -/** - * @brief Special type that denotes any property in the collection. - * - * Useful when traversing collection and searching for a property - * of unknown type but known name. - */ -#define COL_TYPE_ANY 0x0FFFFFFF -/** - * @} - */ - - -/** - * @defgroup addmodes Constants defining add modes - * - * The following constants define how one collection can be added to another. - * - * @{ - */ -/** @brief Add a collection into a collection as a reference */ -#define COL_ADD_MODE_REFERENCE 0 -/** - * @brief Embed the collection into another collection. - * - * The collection will become part of another collection. - * After this operation the handle to the collection being added - * should not be used or freed. - * Embedding a collection can be done only once. - * If the collection is referenced by another collection, - * the operation will fail. - */ -#define COL_ADD_MODE_EMBED 1 -/** - * @brief Perform a deep copy. - * - * Perform a deep copy of a collection with - * all its sub collections */ -#define COL_ADD_MODE_CLONE 2 -/** - * @brief Create a flattened copy. - * - * Create a deep copy of a collection with - * its sub collections flattening and NOT - * resolving duplicates. - */ -#define COL_ADD_MODE_FLAT 3 -/** - * @brief Create a flattened copy with constructed names. - * - * Creates a deep copy of a collection with - * its sub collections flattening and NOT - * resolving duplicates. Names are constructed - * in dotted notation. - * For example the sub collection - * named "sub" containing "foo" and - * "bar" will be flattened as: - * "sub.foo", "sub.bar". - */ -#define COL_ADD_MODE_FLATDOT 4 -/** - * @} - */ - - -/** - * @defgroup traverseconst Constants defining traverse modes - * - * The following constants define how a collection can be - * traversed or iterated. - * - * Flags defined below can generally be combined with each other. - * - * \ref COL_TRAVERSE_FLAT, \ref COL_TRAVERSE_SHOWSUB, - * \ref COL_TRAVERSE_ONLYSUB are mutually exclusive flags. - * If combined together results will be unpredictable.<br> - * <b>DO NOT MIX THEM IN ONE ITERATOR.</b> - * - * - * @{ - */ -/** @brief Traverse all items in the collection. */ -#define COL_TRAVERSE_DEFAULT 0x00000000 -/** - * @brief Traverse only the top level. - * - * Traverse only top level - * ignored if the IGNORE flag is - * specified - */ -#define COL_TRAVERSE_ONELEVEL 0x00000001 -/** - * @brief Insert end collection marker. - * - * Call the handler once more when the - * end of the collection is reached. - * Specifying this flag would cause a traversing - * function to call a callback once more passing - * in a virtual property of type \ref COL_TYPE_END. - * Good for processing nested collections. - */ -#define COL_TRAVERSE_END 0x00000002 -/** @brief Ignore sub collections as if none is present. */ -#define COL_TRAVERSE_IGNORE 0x00000004 -/** - * @brief Flatten the collection. - * - * Traversing this way would act as if - * all the properties of sub collection are properties - * of the root collection. The referencing properties or - * headers of the referenced collections are skipped. - * - * If we think of the book case example - * this is very useful when one wants to iterate through - * all the books skipping information about - * which shelf they are on. - */ -#define COL_TRAVERSE_FLAT 0x00000008 -/** - * @defgroup moreiterflag Additional iterator flags - * - * \note NOTE: These flags ignored by traverse functions and - * can be used only in the iterator. - * - * @{ - */ -/** - * @brief Include headers of sub collections. - * - * When one collection is embedded or referenced by another collection - * there are two names we can be interested in. The name of the property - * that defines the reference and the name of the embedded collection. - * It is recommended that they be the same, however there may be cases - * when the name of the referencing property and referenced collection - * should be different. By default only the name of the referencing - * property is returned while iterating through the collection and - * its sub collections. Specifying this flag would cause the names - * of the collection (header elements) be included into the iteration - * process. - * - * Flag is ignored if the \ref COL_TRAVERSE_ONELEVEL flag is - * specified and not ignored. - * Flag is ignored is also ignored if the FLAT flag is specified. */ -#define COL_TRAVERSE_SHOWSUB 0x00010000 -/** - * @brief Show sub collections. - * - * Show the header of the sub collection instead of the reference. - * Flag is ignored if the \ref COL_TRAVERSE_ONELEVEL flag is - * specified and not ignored. - * Flag is ignored is also ignored if the FLAT flag is specified. */ -#define COL_TRAVERSE_ONLYSUB 0x00020000 -/** - * @} - */ - -/** - * @} - */ - -/** - * @defgroup copyconst Constants defining copy modes - * - * The following constants define modes accepted by copy - * collection function(s). - * - * @{ - */ -/** - * @brief Perform a deep copy. - * - * Referenced collections of the donor are copied as sub - * collections. - */ -#define COL_COPY_NORMAL 0 -/** - * @brief Perform a deep flat copy. - * - * Collection is flattened. No name construction performed. - */ -#define COL_COPY_FLAT 1 -/** - * @brief Perform a deep flat copy constructing names. - * - * Collection is flattened. Names are concatenated with dot. - */ -#define COL_COPY_FLATDOT 2 -/** @brief Perform a deep copy but leave references as references. */ -#define COL_COPY_KEEPREF 3 -/** @brief Copy only top level collection. */ -#define COL_COPY_TOP 4 -/** - * @} - */ - -/** - * @defgroup sortconst Constants defining sort order - * - * All flags can be combined in OR operation. - * Flags \ref COL_SORT_ASC and \ref COL_SORT_DESC are - * mutually exclusive. If both specified the - * collection will be sorted in the descending order. - * - * @{ - */ -/** @brief Sort in ascending order. */ -#define COL_SORT_ASC 0x00000000 -/** @brief Sort in descending order. */ -#define COL_SORT_DESC 0x00000001 -/** @brief Sort all sub collections. */ -#define COL_SORT_SUB 0x00000002 -/** - * @brief Sort only embedded sub collections. - * - * Ignored if \ref COL_SORT_SUB is not specified. - */ -#define COL_SORT_MYSUB 0x00000004 -/** - * @} - */ - - -/* Public declaration of the private data */ -#ifndef COLLECTION_PRIV_H -/** - * @struct collection_item - * @brief Opaque structure that holds one property. - * - * Your implementation can assume that following members - * will always be members of the collection_item. - * but you should use get_item_xxx functions to get them - * and never access internal data directly. - * - * - char *property; - * - int property_len; - * - int type; - * - int length; - * - void *data; - */ -struct collection_item; -/** - * @struct collection_iterator - * @brief Opaque iterator structure. - * - * The iterator structure is used - * when one wants to traverse the collection - * going through its properties and optionally - * sub collections. - * - * Caller should never assume - * anything about internals of this structure. - */ -struct collection_iterator; - -#endif /* COLLECTION_PRIV_H */ - - -/** - * @brief Create a collection - * - * The function will create a collection. - * Each collection should have name and class. - * - * @param[out] ci Newly allocated collection object. - * @param[in] name The name is supposed to be a unique identifier of - * the collection. This is useful when the collections - * are stored within other collections or inside other - * aggregation objects. Caller is free to use any name. - * Name should consist of the ASCII characters with codes - * non less than space. Exclamation mark character is - * a special character and can't be used in name of - * collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] cclass Class is used to relate the collection to a specific - * group of the collections of the same structure. - * This is very useful when you try to represent - * objects using collections and you want to check if - * the objects have same structure or not. - * There is no predefined name space for the collection - * classes. Defining classes is left to the application - * developers.<br> - * <b>NOTE:</b> - * If you decide to build an interface using collection - * library pick a range for the classes you are - * going to use and make sure that they do not collide - * with other interfaces built on top of the collection. - * - * @return 0 - Collection was created successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the collection name. - * @return EMSGSIZE - Collection name is too long. - */ -int col_create_collection(struct collection_item **ci, - const char *name, - unsigned cclass); - -/** - * @brief Destroy a collection - * - * The function will destroy a collection. - * - * @param[in] ci Collection object. - * - */ -void col_destroy_collection(struct collection_item *ci); - -/** - * @brief Copy item callback. - * - * Callback is used by the - * \ref col_copy_collection_with_cb "col_copy_collection_with_cb" function. - * Function is called after the new item is created but not yet - * inserted into the target collection. - * The implementer of the callback can alter the item data - * or indicate to the caller that the item should be skipped. - * - * @param[in] item Newly allocated item that will be inserted - * into the new collection. - * @param[in] ext_data Data the application might want to - * pass to the callback. - * @param[out] skip Pointer to a variable that indicates if the - * item should be skipped or not. - * Set this variable to any nonzero value - * and the item will be skipped. - * @return 0 - Success - * @return Function can return any error code. This code - * will be propagated through the internal functions and - * returned to the application. - * - */ -typedef int (*col_copy_cb)(struct collection_item *item, - void *ext_data, - int *skip); - -/** - * @brief Copy collection with data modification. - * - * Function create a deep copy of the current collection. - * Calls caller provided callback before copying each item's data. - * This is useful if the data needs to be resolved in some way. - * The best use is when the template is copied and the values - * in the template are resolved to the actual values. - * The acceptable modes are defined \ref copyconst "here". - * - * @param[out] col_copy Newly created collection object. - * @param[in] col_to_copy Collection object that will be copied. - * @param[in] name_to_use Name of the new collection. - * @param[in] copy_mode How to \ref copyconst "copy". - * @param[in] copy_cb Pointer to a callback \ref col_copy_cb. - * Can be NULL. In this case data is copied - * without modification. - * @param[in] ext_data Data the application might want to - * pass to the callback. - * - * @return 0 - Collection was copied successfully. - * @return ENOMEM - No memory. - * @return EINVAL - The value of some of the arguments is invalid. - * @return Any error code returned by the callback. - * - */ -int col_copy_collection_with_cb(struct collection_item **col_copy, - struct collection_item *col_to_copy, - const char *name_to_use, - int copy_mode, - col_copy_cb copy_cb, - void *ext_data); - -/** - * @brief Copy collection without data modification. - * - * Function creates a deep copy of the current collection. - * It wraps the \ref col_copy_collection_with_cb function. - * The acceptable modes are defined \ref copyconst "here". - * - * @param[out] col_copy Newly created collection object. - * @param[in] col_to_copy Collection object that will be copied. - * @param[in] name_to_use Name of the new collection. - * @param[in] copy_mode How to \ref copyconst "copy". - * - * @return 0 - Collection was copied successfully. - * @return ENOMEM - No memory. - * @return EINVAL - The value of some of the arguments is invalid. - * - */ -int col_copy_collection(struct collection_item **col_copy, - struct collection_item *col_to_copy, - const char *name_to_use, - int copy_mode); - -/** - * @brief Add collection to collection. - * - * Function adds one collection into another - * depending upon a specified \ref addmodes "mode". - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add collection to. If NULL the collection - * is added to the root collection. - * @param[in] as_property Name of the property that will constitute - * the reference. If NULL the name of - * the collection being added will be used. - * If specified the restrictions to - * the name characters and length apply. - * For more details about the name related - * restrictions see - * \ref addproperty "col_add_xxx_property" - * functions. - * @param[in] ci_to_add Collection to add. - * @param[in] mode Specifies \ref addmodes "how" - * the collection should be added. - * - * @return 0 - Collection was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - The value of some of the arguments is invalid. - * The attempt to update a property which is - * a reference to a collection or a collection - * name. - * @return ENOENT - Property to update is not found. -*/ -int col_add_collection_to_collection(struct collection_item *ci, - const char *subcollection, - const char *as_property, - struct collection_item *ci_to_add, - int mode); -/** - * @brief Search Callback - * - * Signature of the callback that needs to be used when - * traversing a collection or looking for a specific item. - * - * @param[in] property The name of the property will - * be passed in this parameter. - * @param[in] property_len Length of the property name - * will be passed in this parameter. - * @param[in] type Type of the data will be passed - * in this parameter. - * @param[in] data Pointer to the data will be passed - * in this parameter. - * @param[in] length Length of data will be passed in - * this parameter. - * @param[in] custom_dat Custom data will be passed in - * this parameter. - * @param[out] stop Pointer to a variable where the handler - * can put nonzero to stop traversing - * of the collection. - * @return 0 - Success - * @return Function can return any error code. This code - * will be propagated through the internal functions and - * returned to the application. - */ -typedef int (*col_item_fn)(const char *property, - int property_len, - int type, - void *data, - int length, - void *custom_dat, - int *stop); - - -/** - * @brief Traverse collection - * - * Function to traverse the entire collection - * including (optionally) sub collections. - * - * @param[in] ci Collection object to traverse. - * @param[in] mode_flags How to traverse. - * See details \ref traverseconst "here". - * @param[in] item_handler Application supplied callback. - * It will be called for each item - * in the collection including headers. - * @param[in] custom_data Custom data that application - * might want to pass to the callback. - * - * @return 0 - Collection was traversed successfully. - * @return ENOMEM - No memory. - * @return EINVAL - The value of some of the arguments is invalid. - * @return Any error code returned by the callback. - * - */ -int col_traverse_collection(struct collection_item *ci, - int mode_flags, - col_item_fn item_handler, - void *custom_data); - -/** - * @brief Search and do function. - * - * Looks up an item in the collection based on the property and type. - * Actually it is a traverse function with special traversing logic. - * It traverses the whole collection but calls the supplied - * callback only for the items that match the search criteria. - * It is the responsibility of the caller to define how the callback - * is going to indicate that the item it was looking for is found. - * Function will not return error if the item is not found. - * It is the responsibility of the calling application to check - * the data passed in custom_data and see if the item was found and - * that the action was performed. - * - * @param[in] ci Collection object to traverse. - * @param[in] property_to_find Name of the property to find. - * Parameter supports "x!y" - * notation. - * @param[in] type Type filter. Only properties - * of the given type will match. - * Can be 0 to indicate that all - * types should be evaluated. - * @param[in] mode_flags How to traverse the collection. - * See details \ref traverseconst "here". - * @param[in] item_handler Function to call when the item is found. - * @param[in] custom_data Custom data passed to the callback. - * - * @return 0 - Operation completed successfully. - * @return EINVAL - The value of some of the arguments is invalid. - * @return ENOENT - The search criteria is incorrect. - * @return ENOMEM - No memory. - * @return Any error code returned by the callback. - * - */ -int col_get_item_and_do(struct collection_item *ci, - const char *property_to_find, - int type, - int mode_flags, - col_item_fn item_handler, - void *custom_data); - -/** - * @brief Search function to get an item. - * - * Convenience function to get individual item. - * Caller should be aware that this is not a copy of the item - * but the pointer to actual item stored in the collection. - * The returned pointer should never be altered or freed by caller of the function. - * The caller should be sure that the collection does not go out of scope - * while the pointer to its data is in use. - * Working with the internals of the collection item structure directly - * may cause problems in future if the internal implementation changes. - * The caller needs to be aware that function does not return - * error if item is not found. The caller needs to check if - * item is not NULL to determine whether something was found. - * Internally function is a wrapper around the \ref col_get_item_and_do - * function. - * - * Use \ref getitem "item management" functions to work with the item. - * - * @param[in] ci Collection object to traverse. - * @param[in] property_to_find Name of the property to find. - * Parameter supports "x!y" - * notation. - * @param[in] type Type filter. Only properties - * of the given type will match. - * Can be 0 to indicate that all - * types should be evaluated. - * @param[in] mode_flags How to traverse the collection. - * See details \ref traverseconst "here". - * @param[in] item Pointer to found item or NULL - * if item is not found. - * - * @return 0 - No internal errors during search. - * @return EINVAL - The value of some of the arguments is invalid. - * @return ENOENT - The search criteria is incorrect. - * @return ENOMEM - No memory. - * - */ -int col_get_item(struct collection_item *ci, - const char *property_to_find, - int type, - int mode_flags, - struct collection_item **item); - -/** - * @brief Sort collection. - * - * If the sub collections are included in sorting - * each collection is sorted separately (this is not a global sort). - * It might be dangerous to sort sub collections if - * sub collection is not owned by the current collection. - * If it is a reference to an external collection - * there might be an issue. To skip the collections that - * externally referenced use \ref COL_SORT_MYSUB flag. - * Keep in mind that if a collection is referenced - * more than once by other collection and that collection - * is sorted with sub collections the referenced - * collection will be sorted more than once. - * - * NOTE: Current implementation of the sorting - * function is very simple and alternative - * implementations might be provided later. - * - * @param[in] col Collection to sort. - * @param[in] cmp_flags For more information see - * \ref compflags "comparison flags". - * @param[in] sort_flags For more information see - * \ref sortconst "sort flags". - * - * @return 0 - No internal errors during sorting. - * @return EINVAL - The value of some of the arguments is invalid. - * - */ -int col_sort_collection(struct collection_item *col, - unsigned cmp_flags, - unsigned sort_flags); - -/** - * @brief Delete property. - * - * Delete property from the collection. - * It is recommended to use a more efficient function - * \ref col_remove_item for the same purpose if - * the property is unique or if the collection - * has a known structure. - * The col_delete_property function has some advantage only - * if it is not known where property - * resides and what is the structure of the collection. - * In this case "foo!bar!baz" notation can be used in - * the property_to_find argument to find and delete - * the property "baz" that is in a sub collection "bar" - * which is in turn a part of a collection "foo". - * - * @param[in] ci Collection to delete property from. - * @param[in] property_to_find Property to delete. - * @param[in] type Use type if names are not unique - * and you know the type of the value - * you want to delete. Otherwise set to 0. - * @param[in] mode_flags The flags define how the collection - * should be searched. For more information - * see \ref traverseconst "traverse constants". - * - * @return 0 - Property was deleted successfully. - * @return EINVAL - The value of some of the arguments is invalid. - * @return ENOMEM - No memory. - * @return ENOENT - Property not found. - * - */ -int col_delete_property(struct collection_item *ci, - const char *property_to_find, - int type, - int mode_flags); - -/** - * @brief Is property in the collection? - * - * Convenience function to check if the property - * is indeed in the collection. - * - * @param[in] ci Collection to search. - * @param[in] property_to_find Property to find. - * @param[in] type Use type if names are not unique - * and you know the type of the value - * you want to check. Otherwise set to 0. - * @param[in] mode_flags The flags define how the collection - * should be searched. For more information - * see \ref traverseconst "traverse constants". - * @param[out] found The variable that will receive the result - * of the search. - * COL_NOMATCH - if not found - * COL_MATCH if found - * - * @return 0 - Search completed successfully. - * @return EINVAL - The value of some of the arguments is invalid. - * @return ENOMEM - No memory. - * - */ -int col_is_item_in_collection(struct collection_item *ci, - const char *property_to_find, - int type, - int mode_flags, - int *found); - -/** - * @brief Get a reference to a collection - * - * Get a pointer to a collection included into another collection. - * If the col_to_find is NULL function returns a reference - * to the top level collection. - * Delete extracted collection after use to decrease reference count. - * - * @param[in] ci Collection to search. - * @param[out] acceptor Variable that accepts pointer to - * an extracted collection. - * Use \ref col_destroy_collection to - * free returned object reference after - * use. - * @param[in] col_to_find Collection to find. - * "foo!bar!baz" notation can be used. - * - * @return 0 - Success. - * @return EINVAL - The value of some of the arguments is invalid. - * @return ENOMEM - No memory. - */ -int col_get_collection_reference(struct collection_item *ci, - struct collection_item **acceptor, - const char *col_to_find); - -/** - * @brief Get a reference from the item - * - * Get a pointer to a collection from a current item - * if current item is a reference to the collection. - * If current item is not a reference to a collection an error - * will be returned. - * Delete extracted collection after use to decrease reference count. - * - * @param[in] item Item to extract the reference from. - * @param[out] acceptor Variable that accepts pointer to - * an extracted collection. - * Use \ref col_destroy_collection to - * free returned object reference after - * use. - * - * @return 0 - Success. - * @return EINVAL - The value of some of the arguments is invalid. - */ -int col_get_reference_from_item(struct collection_item *item, - struct collection_item **acceptor); - - - -/** - * @brief Get collection class. - * - * The classes of the collections can be used to convey information - * about the collection's internal structure. - * Some interfaces built on top of the collection might - * impose restrictions on the collection structure. - * For example the interface can decide that it is going - * to deal with the collections that do not have sub collections - * and elements of the collections are always only strings. - * So the interface will define a class of the collection - * and create a function that would take the strings and create - * such a collection. Then other functions of that interface - * would check if the provided collection is of the specified class. - * If not the interface would reject the collection right away. - * If the collection is of the valid class the interface might - * call the validation function to make sure that this is really - * the case however it needs to validate it only once and lower level - * functions can rely on the class value of the collection - * without performing duplicate validation. - * - * @param[in] ci Collection object. - * @param[out] cclass Variable that will receive - * the value of the class. - * @return 0 - Success. - * @return EINVAL - The value of some of the arguments is invalid. - * - */ -int col_get_collection_class(struct collection_item *ci, - unsigned *cclass); - -/** - * @brief Set collection class. - * - * Sometimes as a result of the collection modification - * the class of the collection can change. - * - * @param[in] ci Collection object. - * @param[in] cclass New class value. - * - * @return 0 - Success. - * @return EINVAL - The value of some of the arguments is invalid. - * - */ -int col_set_collection_class(struct collection_item *ci, - unsigned cclass); - -/** - * @brief Get count of the elements. - * - * It is useful to know how many items are there in the collection. - * - * @param[in] ci Collection object. - * @param[out] count Variable will receive the value - * of the number of the items in - * the collection. Collection - * header or references to external - * collections are counted as well. - * This means that every collection - * has at least one item - the header. - * - * @return 0 - Success. - * @return EINVAL - The value of some of the arguments is invalid. - * - */ -int col_get_collection_count(struct collection_item *ci, - unsigned *count); - - -/** - * @brief Check the class of collection. - * - * Convenience function to check if the collection is of the specific class. - * In case of internal error assumes that collection is not of the right class. - * - * @param[in] ci Collection object. - * @param[in] cclass Class value to compare to to. - * - * @return 0 - If any internal error or classes do not match. - * @return 1 - No error and classes do match. - * - */ -int col_is_of_class(struct collection_item *ci, - unsigned cclass); - - -/** - * @defgroup addproperty Add property functions - * - * Functions in this section add properties to a collection. - * - * All the functions in this section add a property of the specified - * type to the collection object. - * They are convenience wrappers around the col_insert_xxx_property - * functions. - * They always append property to the end of the collection. - * - * Common parameters for these functions are: - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection is not found. - * - * @{ - */ - -/** - * @brief Add a string property to a collection. - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] string Null terminated string to add. - * @param[in] length Length of the string. Should include the length - * of the terminating 0. - * If the length is shorter than the full string - * the string will be truncated. If the length is - * longer than the actual string there might be - * garbage at end of the actual string. - * Library will always properly NULL terminate - * the string at the given position dictated - * by length but in no way will inspect the validity - * of the passed in data. This is left to the calling - * application. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection is not found. - * - */ -int col_add_str_property(struct collection_item *ci, - const char *subcollection, - const char *property, - const char *string, - int length); - -/** - * @brief Add a binary property to a collection. - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] binary_data Data to add. - * @param[in] length Length of the data. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection is not found. - * - */ -int col_add_binary_property(struct collection_item *ci, - const char *subcollection, - const char *property, - void *binary_data, - int length); - -/** - * @brief Add an integer property to a collection. - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Integer value to add. Value is signed. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection is not found. - * - */ -int col_add_int_property(struct collection_item *ci, - const char *subcollection, - const char *property, - int32_t number); - -/** - * @brief Add an unsigned integer property to a collection. - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Unsigned integer value to add. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection is not found. - * - */ -int col_add_unsigned_property(struct collection_item *ci, - const char *subcollection, - const char *property, - uint32_t number); - -/** - * @brief Add an long property to a collection. - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Long integer value to add. Value is signed. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection is not found. - * - */ -int col_add_long_property(struct collection_item *ci, - const char *subcollection, - const char *property, - int64_t number); - -/** - * @brief Add an unsigned long property to a collection. - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Unsigned long integer value to add. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection is not found. - * - */ -int col_add_ulong_property(struct collection_item *ci, - const char *subcollection, - const char *property, - uint64_t number); - -/** - * @brief Add a property of type double to a collection. - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Floating point value. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection is not found. - * - */ -int col_add_double_property(struct collection_item *ci, - const char *subcollection, - const char *property, - double number); -/** - * @brief Add a Boolean property to a collection. - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] logical Boolean value. 0 - false, nonzero - true. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection is not found. - * - */ -int col_add_bool_property(struct collection_item *ci, - const char *subcollection, - const char *property, - unsigned char logical); - - -/** - * @brief Add a property of a specified type to a collection. - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] type See type definitions \ref coltypes "here". - * @param[in] data Data to add. - * @param[in] length Length of the data. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection is not found. - * - */ -int col_add_any_property(struct collection_item *ci, - const char *subcollection, - const char *property, - int type, - void *data, - int length); - -/** - * @defgroup addprop_withref Add properties with reference - * - * Family of functions that add properties to a collection - * and return reference to an item that holds - * a newly created property. - * - * All the functions in this section append a property of - * the specified type to the collection object. - * - * Parameters for the functions and return values are the same - * as for the \ref addproperty "col_add_xxx_property" functions. - * The only difference is that these functions have one additional - * argument: - * - * @param[out] ret_ref Reference to the newly added item that - * holds the property. - * - * @{ - */ - -/** - * @brief Add a string property to a collection. - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] string Null terminated string to add. - * @param[in] length Length of the string. Should include the length - * of the terminating 0. - * If the length is shorter than the full string - * the string will be truncated. If the length is - * longer than the actual string there might be - * garbage at end of the actual string. - * Library will always properly NULL terminate - * the string at the given position dictated - * by length but in no way will inspect the validity - * of the passed in data. This is left to the calling - * application. - * @param[out] ret_ref Reference to the newly added item that - * holds the property. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection is not found. - * - */ -int col_add_str_property_with_ref(struct collection_item *ci, - const char *subcollection, - const char *property, - char *string, int length, - struct collection_item **ret_ref); - -/** - * @brief Add a binary property to a collection. - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] binary_data Data to add. - * @param[in] length Length of the data. - * @param[out] ret_ref Reference to the newly added item that - * holds the property. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection is not found. - * - */ -int col_add_binary_property_with_ref(struct collection_item *ci, - const char *subcollection, - const char *property, - void *binary_data, int length, - struct collection_item **ret_ref); - -/** - * @brief Add an integer property to a collection. - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Integer value to add. Value is signed. - * @param[out] ret_ref Reference to the newly added item that - * holds the property. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection is not found. - * - */ -int col_add_int_property_with_ref(struct collection_item *ci, - const char *subcollection, - const char *property, int32_t number, - struct collection_item **ret_ref); - -/** - * @brief Add an unsigned integer property to a collection. - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Unsigned integer value to add. - * @param[out] ret_ref Reference to the newly added item that - * holds the property. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection is not found. - * - */ -int col_add_unsigned_property_with_ref(struct collection_item *ci, - const char *subcollection, - const char *property, uint32_t number, - struct collection_item **ret_ref); - -/** - * @brief Add an long property to a collection. - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Long integer value to add. Value is signed. - * @param[out] ret_ref Reference to the newly added item that - * holds the property. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection is not found. - * - */ -int col_add_long_property_with_ref(struct collection_item *ci, - const char *subcollection, - const char *property, int64_t number, - struct collection_item **ret_ref); - -/** - * @brief Add an unsigned long property to a collection. - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Unsigned long integer value to add. - * @param[out] ret_ref Reference to the newly added item that - * holds the property. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection is not found. - * - */ -int col_add_ulong_property_with_ref(struct collection_item *ci, - const char *subcollection, - const char *property, uint64_t number, - struct collection_item **ret_ref); - -/** - * @brief Add a property of type double to a collection. - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Floating point value. - * @param[out] ret_ref Reference to the newly added item that - * holds the property. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection is not found. - * - */ -int col_add_double_property_with_ref(struct collection_item *ci, - const char *subcollection, - const char *property, double number, - struct collection_item **ret_ref); - -/** - * @brief Add a Boolean property to a collection. - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] logical Boolean value. 0 - false, nonzero - true. - * @param[out] ret_ref Reference to the newly added item that - * holds the property. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection is not found. - * - */ -int col_add_bool_property_with_ref(struct collection_item *ci, - const char *subcollection, - const char *property, unsigned char logical, - struct collection_item **ret_ref); - - -/** - * @brief Add a property of a specified type to a collection. - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] type See type definitions \ref coltypes "here". - * @param[in] data Data to add. - * @param[in] length Length of the data. - * @param[out] ret_ref Reference to the newly added item that - * holds the property. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection is not found. - * - */ -int col_add_any_property_with_ref(struct collection_item *ci, - const char *subcollection, - const char *property, - int type, void *data, int length, - struct collection_item **ret_ref); - -/** - * @} - */ - -/** - * @} - */ - -/** - * @defgroup insertproperty Insert property functions - * - * Functions in this section insert properties into a collection - * at a specified position. - * - * Common parameters for these functions are: - * - * @param[in] ci Root collection object. - * @param[in] subcollection Name of the inner collection to - * add property to. If NULL the property - * is added to the root collection. - * @param[in] disposition Defines relation point. - * For more information see - * \ref dispvalues "disposition defines". - * @param[in] refprop Property to relate to - * @param[in] idx Index (see comments below). - * @param[in] flags Flags that control naming issues. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * - * - * Other arguments are the same as the arguments for the - * \ref addproperty "col_add_xxx_property" functions. - * - * @return 0 - Property was insterted successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * @return ENOENT - Sub collection or property to relate to is not found. - * @return EEXIST - Property with given name already exists. - * This error is returned if collection - * should hold unique names. - * For more information see description of the - * "flags" argument. - * @return ENOSYS - Flag or disposition value is not implemented. - * @{ - */ -/** @brief Insert a string property. */ -int col_insert_str_property(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - const char *string, - int length); - -/** @brief Insert a binary property. */ -int col_insert_binary_property(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - void *binary_data, - int length); - -/** @brief Insert an integer property. */ -int col_insert_int_property(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - int32_t number); - -/** @brief Insert an unsigned property. */ -int col_insert_unsinged_property(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - uint32_t number); - -/** @brief Insert a long property. */ -int col_insert_long_property(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - int64_t number); - -/** @brief Insert an unsigned long property. */ -int col_insert_ulong_property(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - uint64_t number); - -/** @brief Insert a property with a floating point value. */ -int col_insert_double_property(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - double number); - -/** @brief Insert a property with a Boolean value. */ -int col_insert_bool_property(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - unsigned char logical); - -/** @brief Insert a string property and get back a reference. */ -int col_insert_str_property_with_ref(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - const char *string, - int length, - struct collection_item **ret_ref); - -/** @brief Insert a binary property and get back a reference. */ -int col_insert_binary_property_with_ref(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - void *binary_data, - int length, - struct collection_item **ret_ref); - -/** @brief Insert an integer property and get back a reference. */ -int col_insert_int_property_with_ref(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - int32_t number, - struct collection_item **ret_ref); - -/** @brief Insert an unsigned property and get back a reference. */ -int col_insert_unsinged_property_with_ref(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - uint32_t number, - struct collection_item **ret_ref); - -/** @brief Insert a long property and get back a reference. */ -int col_insert_long_property_with_ref(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - int64_t number, - struct collection_item **ret_ref); - -/** @brief Insert an unsigned long property and get back a reference. */ -int col_insert_ulong_property_with_ref(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - uint64_t number, - struct collection_item **ret_ref); - -/** - * @brief Insert a property with a floating - * point value and get back a reference. - */ -int col_insert_double_property_with_ref(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - double number, - struct collection_item **ret_ref); - -/** @brief Insert a property with a Boolean value and get back a reference. */ -int col_insert_bool_property_with_ref(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - unsigned char logical, - struct collection_item **ret_ref); - -/** @brief Insert property of any type and get back a reference. */ -int col_insert_property_with_ref(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - int type, - const void *data, - int length, - struct collection_item **ret_ref); - - -/** - * @} - */ - -/** - * @defgroup updateproperty Update property functions - * - * Functions in this section update properties in a collection. - * - * All update functions search the property using the - * internal traverse function. - * Use same "x!y" notation to specify a property. - * For more details about the search logic see - * \ref col_get_item_and_do function. - * - * The existing value of the property is destroyed and lost. - * - * It is not possible to rename the property using these functions. - * To do more advanced modifications see \ref col_modify_item function - * and \ref modwrap "item modification wrappers" . - * - * Common parameters for these functions are: - * - * @param[in] ci Root collection object. - * @param[in] property Name of the property. - * @param[in] mode_flags Specify how the collection - * should to be traversed. - * - * The rest of the arguments specify the new values for - * the property. For more details about these arguments see - * the description of the \ref addproperty "col_add_xxx_property" - * corresponding function. - * - * - * @return 0 - Property was updated successfully. - * @return ENOMEM - No memory. - * @return EINVAL - The value of some of the arguments is invalid. - * The attempt to update a property which is - * a reference to a collection or a collection - * name. - * @return ENOENT - Property to update is not found. - * - * @{ - */ -/** - * Update a property with a string value. - * Length should include the terminating 0. - */ -int col_update_str_property(struct collection_item *ci, - const char *property, - int mode_flags, - char *string, - int length); -/** - * Update a property with a binary value. - */ -int col_update_binary_property(struct collection_item *ci, - const char *property, - int mode_flags, - void *binary_data, - int length); -/** - * Update a property with an integer value. - */ -int col_update_int_property(struct collection_item *ci, - const char *property, - int mode_flags, - int32_t number); -/** - * Update a property with an unsigned value. - */ -int col_update_unsigned_property(struct collection_item *ci, - const char *property, - int mode_flags, - uint32_t number); -/** - * Update a property with a long value. - */ -int col_update_long_property(struct collection_item *ci, - const char *property, - int mode_flags, - int64_t number); -/** - * Update a property with an unsigned long value. - */ -int col_update_ulong_property(struct collection_item *ci, - const char *property, - int mode_flags, - uint64_t number); -/** - * Update a property with a floating point value. - */ -int col_update_double_property(struct collection_item *ci, - const char *property, - int mode_flags, - double number); -/** - * Update a property with a Boolean value. - */ -int col_update_bool_property(struct collection_item *ci, - const char *property, - int mode_flags, - unsigned char logical); - -/** - * Update a property with a value by specifying type - * and value. See definitions of the type constants - * \ref coltypes "here". - * All other col_update_xxx_property functions are wrappers - * around this one. - */ -int col_update_property(struct collection_item *ci, - const char *property, - int type, - void *new_data, - int length, - int mode_flags); - - -/** - * @} - */ - -/** - * @defgroup getitem Item management - * - * Group of functions that allows retrieving individual elements - * of the \ref collection_item hiding the internal implementation. - * - * @{ - */ - -/** - * @defgroup compflags Comparison flags - * - * This section describes the flags used in item comparison. - * - * Flags: - * - \ref COL_CMPIN_PROP_EQU - * - \ref COL_CMPIN_PROP_BEG - * - \ref COL_CMPIN_PROP_MID - * - \ref COL_CMPIN_PROP_END - * - * are mutually exclusive. - * - * All other flags can be provided in any combination. - * - * @{ - */ -/** @brief Properties should be exactly equal */ -#define COL_CMPIN_PROP_EQU 0x000000004 -/** @brief Properties should start with the same substring. */ -#define COL_CMPIN_PROP_BEG 0x000000005 -/** @brief One property should be a substring of another. */ -#define COL_CMPIN_PROP_MID 0x000000006 -/** @brief Properties should have the same substring at the end. */ -#define COL_CMPIN_PROP_END 0x000000007 - -/** - * @brief Make sure that there is a dot. - * - * Useful with _BEG, _MID and _END flags to check that the there is - * a dot (if present) in the right place (before, after or both). - * For example the first item is named "foo.bar" and the second - * is "bar". Using _END the "bar" will be found but if _DOT flag is - * used too the function will also check if there was a "." before the found - * string in this case. - * Ignored in case of _EQU. - */ -#define COL_CMPIN_PROP_DOT 0x000000008 - -/** @brief Compare property lengths. */ -#define COL_CMPIN_PROP_LEN 0x000000010 - -/** @brief Compare types. */ -#define COL_CMPIN_TYPE 0x000000020 - -/** @brief Compare data lengths. */ -#define COL_CMPIN_DATA_LEN 0x000000040 - -/** - * @brief Compare data. - * - * Compares data (up to the length of the second one) - * if type is the same. If type is different - * function will assume data is different - * without performing actual comparison. - */ -#define COL_CMPIN_DATA 0x000000080 - -/** - * @} - */ - - -/** - * @defgroup outflags Comparison results flags - * - * This section describes the flags set as a result of - * a comparison operation. - * - * @{ - */ - -/** - * @brief Second item's property is greater. - * - * If _EQU was specified and the property of the second item - * is greater the following bit will be set - */ -#define COL_CMPOUT_PROP_STR 0x00000001 - -/** - * @brief Second item's property is longer. - * - * If told to compare property lengths - * and the second is longer this bit will be set. - */ -#define COL_CMPOUT_PROP_LEN 0x00000002 -/** - * @brief Second item's data is longer. - * - * If told to compare data lengths - * and second is longer this bit will be set - */ -#define COL_CMPOUT_DATA_LEN 0x00000004 -/** - * @brief Second item's data is greater. - * - * If told to compare data - * and types are the same, then - * if the second one is greater this bit will - * be set. If data is binary flag is never set. - */ -#define COL_CMPOUT_DATA 0x00000008 - -/** - * @} - */ - -/** - * @defgroup dispvalues Disposition constants - * - * Possible dispositions for insert, extract and delete function(s). - * Not all of these dispositions are implemented day one. - * If disposition is not implemented the function - * will return error ENOSYS. - * - * Other dispositions might be possible in future. - * - * @{ - */ -/** - * @brief Relate to the end of the collection - * - * For "insert": - * - Add property to the end of the collection. - * - * For "extract" or "delete": - * - Extract or delete the last property in the collection. - */ -#define COL_DSP_END 0 -/** - * @brief Relate to the beginning of the collection - * - * For "insert": - * - Add property to the beginning of the collection right after the header. - * - * For "extract" or "delete": - * - Extract or delete the first property in the collection. - * This is the one right after the header. - */ -#define COL_DSP_FRONT 1 -/** - * @brief Before the given property - * - * For "insert": - * - Add property before the referenced property. - * - * For "extract" or "delete": - * - Extract or delete the property that stands - * before the referenced property in the collection. - * If given property is the first in the collection - * ENOENT is returned. - */ -#define COL_DSP_BEFORE 2 -/** - * @brief After the given property - * - * For "insert": - * - Add property immediately the referenced property. - * - * For "extract" or "delete": - * - Extract or delete the property that stands - * after the referenced property in the collection. - * If given property is the last in the collection - * ENOENT is returned. - */ -#define COL_DSP_AFTER 3 -/** - * @brief Use index - * - * For "insert": - * - The COL_DSP_INDEX adds the item as N-th item after header in the list. - * Index is zero based. - * If there are less than N items in the list the item is added to the end. - * The index value of 0 means that the item will be added immediately - * after the header. Index of 1 will mean that it is added after first data - * item and so on. - * - * For "extract" or "delete": - * - In case of extraction or deletion the N-th item of the collection - * will be extracted or deleted. - * Index is zero based. - * If there are less than N+1 items in the list the function will return ENOENT. - * - */ -#define COL_DSP_INDEX 4 -/** - * @brief Use first among duplicates - * - * This mode applies only to the list of duplicate - * properties that are going one after another. - * - * For "insert": - * - Add property as a first dup of the given property. - * The property name is taken from the item - * and the value refprop is ignored. - * - * For "extract" or "delete": - * - Delete or extract first duplicate property. - * The property name is taken from the refprop. - * The property will be extracted or deleted if found - * regardless of whether there are any duplicates or not. - */ -#define COL_DSP_FIRSTDUP 5 -/** - * @brief Use last among duplicates - * - * This mode applies only to the list of duplicate - * properties that are going one after another. - * - * For "insert": - * - Add property as the last dup of the given property. - * The property name is taken from the item - * and the value refprop is ignored. - * - * For "extract" or "delete": - * - Delete or extract the last duplicate of the property. - * The property name is taken from the refprop. - * Extracts or deletes last duplicate property in the uninterrupted - * sequence of properties with the same name. - * The property will be extracted or deleted if found - * regardless of whether there are any duplicates or not. - */ -#define COL_DSP_LASTDUP 6 -/** - * @brief Use N-th among duplicates - * - * This mode applies only to the list of duplicate - * properties that are going one after another. - * - * For "insert": - * - Add property as a N-th dup of the given property. - * The property name is taken from the item - * and the value refprop is ignored. - * Index is zero based. - * The COL_DSP_NDUP is used in case of the multi value property - * to add a new property with the same name into specific place - * in the list of properties with the same name. - * The index of 0 will mean to add the property before the first - * instance of the property with the same name. - * If the property does not exist ENOENT will be returned. - * If the index is greater than the last property with the same - * name the item will be added immediately after last - * property with the same name. - * - * For "extract" or "delete": - * - Delete or extract N-th duplicate property. - * Index is zero based. - * The property name is taken from the refprop. - * If index is greater than number of duplicate - * properties in the sequence ENOENT is returned. - * - */ -#define COL_DSP_NDUP 7 -/** - * @} - */ - -/** - * @defgroup insflags Flags used in insert item functions - * - * Flags that can be used with insert functions. - * - * In future can more flags might be added. - * - * <b>NOTE:</b> Use of the duplicate checking flags is costly - * since it requires a forward look up of the whole - * collection before the item is inserted. - * Do not use it until it is absolutely necessary. - * - * @{ - */ -/** @brief This is the default mode - no dup checks on insert */ -#define COL_INSERT_NOCHECK 0 -/** - * @brief Check for duplicate name and overwrite. - * Position arguments are ignored. - */ -#define COL_INSERT_DUPOVER 1 -/** - * @brief Check for duplicate name and type and overwrite. - * Position arguments are ignored. - */ -#define COL_INSERT_DUPOVERT 2 -/** @brief Return error EEXIST if the entry with the same name exists. */ -#define COL_INSERT_DUPERROR 3 -/** - * @brief Return error EEXIST if the entry - * with the same name and type exists. - */ -#define COL_INSERT_DUPERRORT 4 -/** @brief Check for duplicates, overwrite, - * extract and then move to the position requested. - */ -#define COL_INSERT_DUPMOVE 5 -/** @brief Check for duplicate name and type, overwrite, - * extract and then move to the position requested. - */ -#define COL_INSERT_DUPMOVET 6 - -/** - * @} - */ - - - -/** - * @brief Get item property. - * - * Get name of the property from the item. If the item is a header - * the name of the property is the name of the collection. - * The element that denotes the collection header has - * type \ref COL_TYPE_COLLECTION. - * Optionally the property length can be retrieved too. - * - * @param[in] ci Item to get property from. - * If item is invalid the function - * will cause a segment violation. - * @param[out] property_len If not NULL the variable - * will receive the length - * of the property not counting - * terminating 0. - * - * @return Property name. - * - */ -const char *col_get_item_property(struct collection_item *ci, - int *property_len); - -/** - * @brief Get item type. - * - * Get type from the item. - * - * @param[in] ci Item to get type from. - * If item is invalid the function - * will cause a segment violation. - * - * @return Item type. - * - */ -int col_get_item_type(struct collection_item *ci); - -/** - * @brief Get value length from the item. - * - * Get value length from the item. For strings this includes - * NULL terminating zero. - * - * @param[in] ci Item to get value length from. - * If item is invalid the function - * will cause a segment violation. - * - * @return Value length. - * - */ -int col_get_item_length(struct collection_item *ci); - -/** - * @brief Get property value from the item. - * - * Get property value from the item. - * - * @param[in] ci Item to get value from. - * If item is invalid the function - * will cause a segment violation. - * - * @return Property value. - * - */ -void *col_get_item_data(struct collection_item *ci); - -/** - * @brief Get hash value from the item. - * - * Get hash value from the item. The hash value is - * 64-bit hash created from the property name. - * It is done to optimize the searches. - * - * This function is exposed for some corner cases - * that require low level operations, for example - * for custom search callbacks to take advantage - * of the internal hashes. - * - * @param[in] ci Item to get hash from. - * If item is invalid the function - * will cause a segment violation. - * - * @return Hash value. - * - */ -uint64_t col_get_item_hash(struct collection_item *ci); - -/** - * @brief Calculate hash value for a string. - * - * Calculates hash value of the string using internal hashing - * algorithm. Populates "length" with length - * of the string not counting 0. - * - * This function is useful if you want to build a custom - * search or collection sorting function. - * - * @param[in] string String to hash. If NULL hash is 0. - * @param[in] sub_len If it is greater than zero - * it is used to count how many - * characters from string should - * be included into hash calculation. - * If 0 the actual length of the string - * is determined and used. - * @param[out] length Will receive the calculated length - * of the provided string. - * Length argument can be NULL. - * - * @return Hash value. - */ -uint64_t col_make_hash(const char *string, int sub_len, int *length); - - -/** - * @brief Compare two items. - * - * The second item is evaluated against the first. - * Function returns 0 if two items are the same - * and non-zero otherwise. - * The \ref compflags "in_flags" is a bit mask that - * defines how the items should be compared. - * - * If items are different they might be sorted following - * some order. For example one can order items by name - * but not by type. - * If the result of the function is non-zero - * the \ref outflags "out_flags" (if provided) will be - * set to indicate if the second item is greater - * then the first. - * - * @param[in] first First item to compare. - * @param[in] second Second item to compare. - * @param[in] in_flags See \ref compflags "comparison flags". - * @param[out] out_flags See \ref outflags "output flags". - * - * - * @return 0 if items are the same and nonzero otherwise. - - */ -int col_compare_items(struct collection_item *first, - struct collection_item *second, - unsigned in_flags, - unsigned *out_flags); - - - -/** - * @brief Modify any item element. - * - * This function is useful if you want to modify the item that - * you got as a result of \ref iterfunc "iterating" through - * collection or by calling \ref col_get_item. - * Previous type and data of the item is destroyed. - * - * If you want to rename an item provide a new name in the property - * argument otherwise keep it NULL. - * - * If you want the data to remain unchanged use 0 as a length parameter. - * - * If item is a reference or a collection the call will return an error. - * - * The are several convenience function that are wrappers - * around this function. For more information - * see \ref modwrap "item modification wrappers". - * - * @param[in] item Item to modify. - * @param[in] property Property name. Use NULL to leave the property - * unchanged. - * @param[in] type See \ref coltypes "types" for more information. - * @param[in] data New value. - * @param[in] length New value. Use 0 to leave the value and its type - * unchanged. - * - * @return 0 - Item was successfully modified. - * @return ENOMEM - No memory. - * @return EINVAL - The value of some of the arguments is invalid. - * The attempt to modify an item which is - * a reference to a collection or a collection - * name. - */ -int col_modify_item(struct collection_item *item, - const char *property, - int type, - const void *data, - int length); - -/** - * @defgroup modwrap Item modification wrappers - * - * The functions in this section are convenience wrappers - * around \ref col_modify_item. - * They return same error codes. - * - * @{ - */ - -/** - * @brief Modify item property. - * - * This function is a convenience wrapper around \ref col_modify_item. - * It is equivalent to: col_modify_item(item, property, 0, NULL, 0); - * - */ -int col_modify_item_property(struct collection_item *item, - const char *property); - -/** - * @brief Modify item value to be a string. - * - * This function is a convenience wrapper around \ref col_modify_item. - * It sets a value of the item to a provided string. - * If property is not NULL it also renames the property. - * If the length argument is not zero the string will be truncated to - * this length. If the length is 0 the length will be calculated based - * on the length of the actual string. - * Original value is always destroyed. - * - * @return - same error values as \ref col_modify_item. - */ -int col_modify_str_item(struct collection_item *item, - const char *property, - const char *string, - int length); -/** - * @brief Modify item value to be a binary blob. - * - * This function is a convenience wrapper around \ref col_modify_item. - * It sets a value of the item to a provided binary buffer. - * If property is not NULL it also renames the property. - * Original value is always destroyed. - * - * @return - same error values as \ref col_modify_item. - */ -int col_modify_binary_item(struct collection_item *item, - const char *property, - void *binary_data, - int length); -/** - * @brief Modify item value to be a Boolean. - * - * This function is a convenience wrapper around \ref col_modify_item. - * It sets a value of the item to a provided logical value. - * If property is not NULL it also renames the property. - * Original value is always destroyed. - * - * @return - same error values as \ref col_modify_item. - */ -int col_modify_bool_item(struct collection_item *item, - const char *property, - unsigned char logical); -/** - * @brief Modify item value to be an integer. - * - * This function is a convenience wrapper around \ref col_modify_item. - * It sets a value of the item to a provided integer value. - * If property is not NULL it also renames the property. - * Original value is always destroyed. - * - * @return - same error values as \ref col_modify_item. - */ -int col_modify_int_item(struct collection_item *item, - const char *property, - int32_t number); -/** - * @brief Modify item value to be a long integer. - * - * This function is a convenience wrapper around \ref col_modify_item. - * It sets a value of the item to a provided long integer value. - * If property is not NULL it also renames the property. - * Original value is always destroyed. - * - * @return - same error values as \ref col_modify_item. - */ -int col_modify_long_item(struct collection_item *item, - const char *property, - int64_t number); -/** - * @brief Modify item value to be an unsigned long. - * - * This function is a convenience wrapper around \ref col_modify_item. - * It sets a value of the item to a provided unsigned long value. - * If property is not NULL it also renames the property. - * Original value is always destroyed. - * - * @return - same error values as \ref col_modify_item. - */ -int col_modify_ulong_item(struct collection_item *item, - const char *property, - uint64_t number); -/** - * @brief Modify item value to be an unsigned integer. - * - * This function is a convenience wrapper around \ref col_modify_item. - * It sets a value of the item to a provided unsigned integer value. - * If property is not NULL it also renames the property. - * Original value is always destroyed. - * - * @return - same error values as \ref col_modify_item. - */ -int col_modify_unsigned_item(struct collection_item *item, - const char *property, - uint32_t number); -/** - * @brief Modify item value to be a floating point. - * - * This function is a convenience wrapper around \ref col_modify_item. - * It sets a value of the item to a provided floating point value. - * If property is not NULL it also renames the property. - * Original value is always destroyed. - * - * @return - same error values as \ref col_modify_item. - */ -int col_modify_double_item(struct collection_item *item, - const char *property, - double number); - -/** - * @} - */ - -/** - * @brief Extract item from the collection. - * - * Function to find and remove an item from the collection. - * Function does not destroy the item instead it returns a reference - * to the item so it can be used later and inserted back into this or - * other collection. - * The function assumes that the caller knows the collection - * the property is stored in. - * The header of the collection can't be extracted with this function - * but the reference to the collection can. - * - * Function allows specifying relative position of the item in the - * collection. One can specify that he wants to extract an item - * that is first in the collection or last, or after other item - * in the collection. For more details see parameter definitions. - * - * After extracting the item from the collection the caller has to - * either insert it back into some collection using \ref col_insert_item - * or delete it using \ref col_delete_item. - * - * - * @param[in] ci Collection object. - * @param[in] subcollection Name of the sub collection to extract - * item from. If NULL, the top level collection - * is used. One can use "foo!bar!baz" - * notation to identify the sub collection. - * @param[in] disposition Constant that controls how the relative - * position of the item to extract is determined. - * For more information see \ref dispvalues - * "disposition constants". - * @param[in] refprop Name of the property to relate to. - * This can be used to specify that function - * should extract next item after the item - * with this name. Leave NULL if the - * disposition you are using does not - * relate to an item in the collection. - * @param[in] idx Index of the property to extract. - * Useful for multi-value properties where - * several properties have same name in a row. - * @param[in] type Type filter. Only the item of the matching - * type will be used. It can be a bit mask of - * more than one type. Use 0 if you do not - * need to filter by type. - * @param[out] ret_ref Variable will receive the value of the - * pointer to the extracted item. - * - * @return 0 - Item was successfully extracted. - * @return ENOMEM - No memory. - * @return EINVAL - The value of some of the arguments is invalid. - * @return ENOENT - Sub collection is not found. - * The position can't be determined. For example - * extracting next item after item with name "foo" - * will cause this error if item "foo" is the last - * item in the collection. There are other cases - * when this error can be returned but the common - * theme is that something was not found. - * @return ENOSYS Unknown disposition value. - */ -int col_extract_item(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - int type, - struct collection_item **ret_ref); - -/** - * @brief Extract item from the current collection. - * - * Function is similar to the \ref col_extract_item. - * It acts exactly the same as \ref col_extract_item when the - * subcollection parameter of the \ref col_extract_item is set to NULL. - * - * @param[in] ci Collection object. - * @param[in] disposition Constant that controls how the relative - * position of the item to extract is determined. - * For more information see \ref dispvalues - * "disposition constants". - * @param[in] refprop Name of the property to relate to. - * This can be used to specify that function - * should extract next item after the item - * with this name. Leave NULL if the - * disposition you are using does not - * relate to an item in the collection. - * @param[in] idx Index of the property to extract. - * Useful for multi-value properties where - * several properties have same name in a row. - * @param[in] type Type filter. Only the item of the matching - * type will be used. It can be a bit mask of - * more than one type. Use 0 if you do not - * need to filter by type. - * @param[out] ret_ref Variable will receive the value of the - * pointer to the extracted item. - * - * @return 0 - Item was successfully extracted. - * @return ENOMEM - No memory. - * @return EINVAL - The value of some of the arguments is invalid. - * @return ENOENT - Sub collection is not found. - * The position can't be determined. For example - * extracting next item after item with name "foo" - * will cause this error if item "foo" is the last - * item in the collection. There are other cases - * when this error can be returned but the common - * theme is that something was not found. - * @return ENOSYS Unknown disposition value. - */ -int col_extract_item_from_current(struct collection_item *ci, - int disposition, - const char *refprop, - int idx, - int type, - struct collection_item **ret_ref); - -/** - * @brief Remove item from the collection. - * - * Function internally calls \ref col_extract_item and then - * \ref col_delete_item for the extracted item. - * - * Function is similar to \ref col_delete_property function - * but allows more specific information about what item (property) - * to remove. - * - * The header will not be considered for deletion. - * - * @param[in] ci Collection object. - * @param[in] subcollection Name of the sub collection to remove - * item from. If NULL, the top level collection - * is used. One can use "foo!bar!baz" - * notation to identify the sub collection. - * @param[in] disposition Constant that controls how the relative - * position of the item to remove is determined. - * For more information see \ref dispvalues - * "disposition constants". - * @param[in] refprop Name of the property to relate to. - * This can be used to specify that function - * should remove next item after the item - * with this name. Leave NULL if the - * disposition you are using does not - * relate to an item in the collection. - * @param[in] idx Index of the property to remove. - * Useful for multi-value properties where - * several properties have same name in a row. - * @param[in] type Type filter. Only the item of the matching - * type will be used. It can be a bit mask of - * more than one type. Use 0 if you do not - * need to filter by type. - * - * @return 0 - Item was successfully removed. - * @return ENOMEM - No memory. - * @return EINVAL - The value of some of the arguments is invalid. - * @return ENOENT - Sub collection is not found. - * The position can't be determined. For example - * deleting next item after item with name "foo" - * will cause this error if item "foo" is the last - * item in the collection. There are other cases - * when this error can be returned but the common - * theme is that something was not found. - * @return ENOSYS Unknown disposition value. - */ -int col_remove_item(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - int type); - - -/** - * @brief Remove item from the current collection. - * - * Function is similar to the \ref col_remove_item. - * It acts exactly the same as \ref col_remove_item when the - * subcollection parameter of the \ref col_remove_item is set to NULL. - * - * @param[in] ci Collection object. - * @param[in] disposition Constant that controls how the relative - * position of the item to remove is determined. - * For more information see \ref dispvalues - * "disposition constants". - * @param[in] refprop Name of the property to relate to. - * This can be used to specify that function - * should remove next item after the item - * with this name. Leave NULL if the - * disposition you are using does not - * relate to an item in the collection. - * @param[in] idx Index of the property to remove. - * Useful for multi-value properties where - * several properties have same name in a row. - * @param[in] type Type filter. Only the item of the matching - * type will be used. It can be a bit mask of - * more than one type. Use 0 if you do not - * need to filter by type. - * - * @return 0 - Item was successfully removed. - * @return ENOMEM - No memory. - * @return EINVAL - The value of some of the arguments is invalid. - * @return ENOENT - Sub collection is not found. - * The position can't be determined. For example - * deleting next item after item with name "foo" - * will cause this error if item "foo" is the last - * item in the collection. There are other cases - * when this error can be returned but the common - * theme is that something was not found. - * @return ENOSYS Unknown disposition value. - */ -int col_remove_item_from_current(struct collection_item *ci, - int disposition, - const char *refprop, - int idx, - int type); - -/** - * @brief Insert item to the collection. - * - * <b>WARNING:</b> Only use this function to insert items - * that were extracted using \ref col_extract_item or - * \ref col_extract_item_from_current. - * <b>NEVER</b> use it with items that were returned by: - * - \ref col_get_item - * - \ref addproperty "add property" functions - * - \ref addprop_withref "add property with reference" functions - * - \ref insertproperty "instert property" functions. - * - * The fundamental difference is that when you extracted item - * using col_extract_item() it stops to be managed by a collection. - * With such item you can: - * - a) Insert this item into another (or same) collection - * - b) Get item information using corresponding item management functions. - * - c) Destroy item using col_delete_item(). - * - * You are required to do either a) or c) with such item. - * - * @param[in] ci Collection object. - * @param[in] subcollection Name of the sub collection to insert - * item into. If NULL, the top level collection - * is used. One can use "foo!bar!baz" - * notation to identify the sub collection. - * @param[in] item Item to insert. - * @param[in] disposition Constant that controls where to insert - * the item. - * For more information see \ref dispvalues - * "disposition constants". - * @param[in] refprop Name of the property to relate to. - * This can be used to specify that function - * should insert the item after the item - * with this name. Leave NULL if the - * disposition you are using does not - * relate to an item in the collection. - * @param[in] idx Index of the property to insert. - * Useful for multi-value properties where - * several properties have same name in a row. - * @param[in] flags Flags that control naming issues. - * See \ref insflags "insert flags" - * for more details. - * - * @return 0 - Item was successfully extracted. - * @return ENOMEM - No memory. - * @return EINVAL - The value of some of the arguments is invalid. - * @return ENOENT - Sub collection is not found. - * The position can't be determined. For example - * extracting next item after item with name "foo" - * will cause this error if item "foo" is the last - * item in the collection. There are other cases - * when this error can be returned but the common - * theme is that something was not found. - * @return ENOSYS Unknown disposition value. - * @return EEXIST If duplicate name/type checking is turned on - * and duplicate name/type is detected. - * - */ -int col_insert_item(struct collection_item *ci, - const char *subcollection, - struct collection_item *item, - int disposition, - const char *refprop, - int idx, - unsigned flags); - -/** - * @brief Insert item to the current collection. - * - * Function is equivalent to \ref col_insert_item with - * subcollection parameter equal NULL. - * - * @param[in] ci Collection object. - * @param[in] item Item to insert. - * @param[in] disposition Constant that controls where to insert - * the item. - * For more information see \ref dispvalues - * "disposition constants". - * @param[in] refprop Name of the property to relate to. - * This can be used to specify that function - * should insert the item after the item - * with this name. Leave NULL if the - * disposition you are using does not - * relate to an item in the collection. - * @param[in] idx Index of the property to insert. - * Useful for multi-value properties where - * several properties have same name in a row. - * @param[in] flags Flags that control naming issues. - * See \ref insflags "insert flags" - * for more details. - * - * @return 0 - Item was successfully extracted. - * @return ENOMEM - No memory. - * @return EINVAL - The value of some of the arguments is invalid. - * @return ENOENT - Sub collection is not found. - * The position can't be determined. For example - * extracting next item after item with name "foo" - * will cause this error if item "foo" is the last - * item in the collection. There are other cases - * when this error can be returned but the common - * theme is that something was not found. - * @return ENOSYS Unknown disposition value. - * @return EEXIST If duplicate name/type checking is turned on - * and duplicate name/type is detected. - * - */ -int col_insert_item_into_current(struct collection_item *ci, - struct collection_item *item, - int disposition, - const char *refprop, - int idx, - unsigned flags); - - - -/** - * @brief Delete extracted item. - * - * <b>NEVER</b> use this function to delete an item - * that was not previously extracted from the collection. - * - * There is currently no function to create an item aside and - * then insert it into the collection so the col_delete_item - * has only one use. In future this may change. - * - * @param[in] item Item to delete. - * - */ -void col_delete_item(struct collection_item *item); - -/** - * @} - */ - - -/** - * @defgroup iterfunc Iterator interface - * - * The functions in this section allow iterating - * through a collection in a loop where the caller - * implements the loop. It is different from the search and - * traverse functions described in other sections because those - * functions implement the loop themselves and call provided - * callback in a specific situation. - * - * @{ - */ - -/** - * @brief Bind iterator to a collection. - * - * This function creates an iterator object and binds it to the collection. - * - * @param[out] iterator Newly created iterator object. - * @param[in] ci Collection to iterate. - * @param[in] mode_flags Flags define how to traverse the collection. - * For more information see \ref traverseconst - * "constants defining traverse modes". - * - * @return 0 - Iterator was created successfully. - * @return ENOMEM - No memory. - * @return EINVAL - The value of some of the arguments is invalid. - * - */ -int col_bind_iterator(struct collection_iterator **iterator, - struct collection_item *ci, - int mode_flags); - -/** - * @brief Unbind the iterator from the collection. - * - * @param[in] iterator Iterator object to free. - */ -void col_unbind_iterator(struct collection_iterator *iterator); - -/** - * @brief Iterate collection. - * - * Advance to next item in the collection. After the iterator is - * bound it does not point to any item in the collection. - * Use this function in the loop to step through all items - * in the collection. See unit test for code examples. - * - * @param[in] iterator Iterator object to use. - * @param[out] item Pointer to the collection item. - * Do not destroy or alter this pointer - * in any ways. To access the internals - * of the item use \ref getitem "item management" - * functions. - * The value of the item will be set to NULL if - * the end of the collection is reached. - * - * @return 0 - Item was successfully retrieved. - * @return EINVAL - The value of some of the arguments is invalid. - */ -int col_iterate_collection(struct collection_iterator *iterator, - struct collection_item **item); - -/** - * @brief Move up - * - * Stop processing this sub collection and move to the next item in the - * collection some levels up. - * - * @param[in] iterator Iterator object to use. - * @param[in] level Indicates how many levels up you want to jump. - * If 0 - call is a no op. - * If the depth is less then requested level - * the iterator will get to the 0 level and - * next call to \ref col_iterate_collection - * will return NULL item. - * - * @return 0 - Iterator was successfully repositioned. - * @return EINVAL - The value of some of the arguments is invalid. - */ -int col_iterate_up(struct collection_iterator *iterator, unsigned level); - -/** - * @brief Get current depth - * - * How deep are we relative to the top level? - * This function will report depth that in some cases might look - * misleading. The reason is that traverse flags affect the internal - * level we are on at each moment. - * For example the default traverse behavior is to show - * references to the sub collections. - * So when the item reference is returned the - * depth automatically adjusted to level inside the sub collection. - * So if function is called in this situation the level returned will - * denote the level inside collection. - * Now imagine that this collection is empty so the attempt to read - * element will push you automatically one level up (in absence of the - * \ref COL_TRAVERSE_END flag). If in this situation you encounter another - * collection the reference will be returned and level automatically - * adjusted to level inside the collection. - * The point is that the level is reliable only after - * a data item was returned. - * To avoid this ambiguity another function \ref col_get_item_depth - * was introduced. - * - * @param[in] iterator Iterator object to use. - * @param[in] depth The variable will receive the depth - * the iterator is on. The value is 0 - * if the iterator is on the top level. - * - * @return 0 - Success. - * @return EINVAL - The value of some of the arguments is invalid. - */ -int col_get_iterator_depth(struct collection_iterator *iterator, int *depth); - -/** - * @brief Get depth of the last returned item. - * - * @param[in] iterator Iterator object to use. - * @param[in] depth The variable will receive the depth - * the iterator is on. - * Item from the top level will have - * depth equal to 0. The value of 0 - * will also be returned if no item - * was read so far. - * - * @return 0 - Success. - * @return EINVAL - The value of some of the arguments is invalid. - */ -int col_get_item_depth(struct collection_iterator *iterator, int *depth); - -/** - * @brief Pin iterator - * - * Pins down the iterator to loop around current point. - * - * This feature allows some search optimization. - * The idea is to be able to put a 'pin' - * into a specific place while iterating - * the collection and make this place a new - * "wrap around" place for the collection. - * This means that next time you - * iterate this collection you will start - * iterating from the next item and - * the item you got before setting pin will be - * the last in your iteration cycle. - * - * Here is the example: - * - * Assume you have two collections that you need - * to compare and perform some action on collection - * 1 based on the presence of the item in collection 2. - * - Collection1 = A, B, C, D, E, F - * - Collection2 = A, C, F - * - * The usual approach is to try A from collection 1 - * against A, B, C from collection 2. "A" will be found - * right away. But to find "F" it has to be compared - * to "A" and "C" first. The fact that the collections - * are to some extent ordered can in some cases - * help to reduce the number of comparisons. - * If we found "C" in the list we can put a "pin" - * into the collection there causing the iterator - * to warp at this "pin" point. Since "D" and "E" - * are not in the second collection we will have - * to make same amount of comparisons in traditional - * or "pinned" case to not find them. - * To find "F" in pinned case there will be just one - * comparison. - * - Traditional case = 1 + 3 + 2 + 3 + 3 + 3 = 15 - * - Pinned case = 1 + 3 + 1 + 3 + 3 + 1 = 12 - * - * It is a 20% comparison reduction. - * - * @param[in] iterator Iterator object to use. - * - * @return 0 - Success. - * @return EINVAL - The value of the argument is invalid. - */ -void col_pin_iterator(struct collection_iterator *iterator); - -/** - * @brief Rewind iterator - * - * Rewinds iterator to the current pin point which is by - * default the beginning of the collection until changed by - * \ref col_pin_iterator function. - * - * @param[in] iterator Iterator object to use. - * - * @return 0 - Success. - * @return EINVAL - The value of the argument is invalid. - */ -void col_rewind_iterator(struct collection_iterator *iterator); - - -/** - * @} - */ - -/** - * @} - */ - -#endif diff --git a/common/collection/collection.pc.in b/common/collection/collection.pc.in deleted file mode 100644 index 31e86fe41..000000000 --- a/common/collection/collection.pc.in +++ /dev/null @@ -1,11 +0,0 @@ -prefix=@prefix@ -exec_prefix=@exec_prefix@ -libdir=@libdir@ -includedir=@includedir@ - -Name: @PACKAGE_NAME@ -Description: A data-type to collect data in a heirarchical structure for easy iteration and serialization -Version: @PACKAGE_VERSION@ -Libs: -L${libdir} -lcollection -Cflags: -I${includedir} -URL: http://fedorahosted.org/sssd/ diff --git a/common/collection/collection_cmp.c b/common/collection/collection_cmp.c deleted file mode 100644 index c1f9017d0..000000000 --- a/common/collection/collection_cmp.c +++ /dev/null @@ -1,436 +0,0 @@ -/* - COLLECTION LIBRARY - - Function to compare items. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - Collection Library 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. - - Collection Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with Collection Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#define _GNU_SOURCE -#include <string.h> -#include <stdlib.h> -#include <errno.h> -#include <ctype.h> -#include <time.h> -#include "config.h" -#include "trace.h" - -/* The collection should use the real structures */ -#include "collection_priv.h" -#include "collection.h" - -#define NONZERO 1 -#define PROP_MSK 0x000000007 - - -#define TYPED_MATCH(type) \ - do { \ - if (*((type *)(first->data)) != *((type *)(second->data))) { \ - result = NONZERO; \ - if ((out_flags) && \ - (*((type *)(first->data)) < *((type *)(second->data)))) { \ - *out_flags |= COL_CMPOUT_DATA; \ - } \ - } \ - } while(0) - - -/* Function to compare two items */ -int col_compare_items(struct collection_item *first, - struct collection_item *second, - unsigned in_flags, - unsigned *out_flags) -{ - int result = 0; - unsigned mode; - int cmpres = 0; - char *substr; - - TRACE_FLOW_STRING("col_compare_items", "Entry."); - - /* If any of the arguments is NULL return - * that they are different. - */ - if ((first == NULL) || (second == NULL)) { - TRACE_INFO_STRING("One of the items is NULL", ""); - return NONZERO; - } - - /* Check if we are told to compare something */ - if (!in_flags) { - TRACE_INFO_NUMBER("No flags specified", in_flags); - return NONZERO; - } - - if (out_flags) *out_flags = 0; - - /* Start comparison */ - mode = in_flags & PROP_MSK; - if (mode > 0 ) { - /* We are told to compare the properties */ - switch(mode) { - - case COL_CMPIN_PROP_EQU: /* looking for exact match */ - - /* Compare hashes and lengths first */ - if ((first->phash == first->phash) && - (first->property_len == second->property_len)) { - /* Collections are case insensitive, sorry... */ - cmpres = strncasecmp(first->property, - second->property, - second->property_len); - if (cmpres != 0) { - result = NONZERO; - if (cmpres < 0) { - /* Second is greater */ - if (out_flags) *out_flags |= COL_CMPOUT_PROP_STR; - } - } - } - else { - result = NONZERO; - /* They are different so check if we need to compare? */ - if (out_flags) { - cmpres = strncasecmp(first->property, - second->property, - second->property_len); - if (cmpres < 0) { - /* Second is greater */ - *out_flags |= COL_CMPOUT_PROP_STR; - } - } - } - break; - - case COL_CMPIN_PROP_BEG: /* looking for beginning */ - - /* Compare lengths first */ - if (first->property_len >= second->property_len) { - cmpres = strncasecmp(first->property, - second->property, - second->property_len); - if (cmpres == 0) { - /* Check we need to validate for dot */ - if (in_flags & COL_CMPIN_PROP_DOT) { - if ((first->property[second->property_len] != '\0') && - (first->property[second->property_len] != '.')) { - result = NONZERO; - } - } - } - else result = NONZERO; - } - else result = NONZERO; - break; - - case COL_CMPIN_PROP_MID: /* looking for middle */ - - /* Compare lengths first */ - if (first->property_len >= second->property_len) { - substr = strcasestr(first->property, second->property); - if (substr != NULL) { - /* Check we need to validate for dot */ - if (in_flags & COL_CMPIN_PROP_DOT) { - /* Check if we have a dot before or after */ - if (((substr != first->property) && - (first->property[(substr - first->property) - 1] != '.')) || - ((substr[second->property_len] != '\0') && - (substr[second->property_len] != '.'))) { - result = NONZERO; - } - } - } - else result = NONZERO; - } - else result = NONZERO; - break; - - case COL_CMPIN_PROP_END: /* looking for end */ - - /* Compare lengths first */ - if (first->property_len >= second->property_len) { - substr = first->property + (first->property_len - second->property_len); - cmpres = strncasecmp(substr, - second->property, - second->property_len); - if (cmpres == 0) { - /* Check we need to validate for dot */ - if (in_flags & COL_CMPIN_PROP_DOT) { - if ((substr != first->property) && - (first->property[(substr - first->property) - 1] != '.')) { - result = NONZERO; - } - } - } - else result = NONZERO; - } - else result = NONZERO; - break; - - default: result = NONZERO; - break; - } - } - - /* Check if we are told to compare property lengths */ - if (in_flags & COL_CMPIN_PROP_LEN) { - if (first->property_len != second->property_len) { - result = NONZERO; - /* Do we need to tell who is greater? */ - if ((out_flags) && (first->property_len < second->property_len)) { - *out_flags |= COL_CMPOUT_PROP_LEN; - } - } - } - - /* Check if we are told to compare types */ - if (in_flags & COL_CMPIN_TYPE) { - if (first->type != second->type) result = NONZERO; - } - - /* Check if we need to compare data length */ - if (in_flags & COL_CMPIN_DATA_LEN) { - if (first->length != second->length) { - result = NONZERO; - /* Do we need to tell who is greater? */ - if ((out_flags) && (first->length < second->length)) { - *out_flags |= COL_CMPOUT_DATA_LEN; - } - } - } - - /* Check if we need to compare data */ - if (in_flags & COL_CMPIN_DATA) { - if (first->type == second->type) { - switch(first->type) { - - case COL_TYPE_STRING: - if (first->length == second->length) { - cmpres = strncmp((const char *)first->data, - (const char *)second->data, - first->length); - - if (cmpres != 0) { - result = NONZERO; - if (cmpres < 0) { - /* Second is greater */ - if (out_flags) *out_flags |= COL_CMPOUT_DATA; - } - } - - } - else result = NONZERO; - break; - - case COL_TYPE_BINARY: - if (first->length == second->length) { - cmpres = memcmp(first->data, - second->data, - first->length); - - if (cmpres != 0) result = NONZERO; - } - else result = NONZERO; - break; - - case COL_TYPE_INTEGER: - /* Use macro to match data */ - TYPED_MATCH(int); - break; - - case COL_TYPE_UNSIGNED: - /* Use macro to match data */ - TYPED_MATCH(unsigned); - break; - - case COL_TYPE_LONG: - /* Use macro to match data */ - TYPED_MATCH(long); - break; - - case COL_TYPE_ULONG: - /* Use macro to match data */ - TYPED_MATCH(unsigned long); - break; - - case COL_TYPE_DOUBLE: - /* Use macro to match data */ - TYPED_MATCH(double); - break; - - case COL_TYPE_BOOL: - /* Use macro to match data */ - TYPED_MATCH(unsigned char); - break; - - /* These are never same */ - case COL_TYPE_COLLECTION: - case COL_TYPE_COLLECTIONREF: - case COL_TYPE_END: - default: - result = NONZERO; - break; - } - - } - else result = NONZERO; - } - - TRACE_FLOW_NUMBER("col_compare_items. Exit. Returning:", result); - return result; -} - -/* Sort collection */ -int col_sort_collection(struct collection_item *col, - unsigned cmp_flags, - unsigned sort_flags) -{ - int error = EOK; - - struct collection_item *current; - struct collection_header *header; - struct collection_item **array; - struct collection_item *temp_item; - struct collection_item *other; - size_t size; - int ind, last; - int i, j; - int res; - unsigned out_flags; - - TRACE_FLOW_STRING("col_sort_collection", "Entry."); - - TRACE_INFO_NUMBER("Comparison flags:", cmp_flags); - TRACE_INFO_NUMBER("Sort flags:", sort_flags); - - if ((col == NULL) || (col->type != COL_TYPE_COLLECTION)) { - TRACE_ERROR_STRING("Collecton must not ne NULL", ""); - return EINVAL; - } - - /* This will be a fast and simple implementation for now */ - header = (struct collection_header *)(col->data); - - if ((sort_flags & COL_SORT_SUB) && - (sort_flags & COL_SORT_MYSUB) && - (header->reference_count > 1)) { - TRACE_FLOW_STRING("col_sort_collection", "Exit."); - return error; - } - - size = sizeof(struct collection_item *) * (header->count - 1); - array = (struct collection_item **)malloc(size); - if (array == NULL) { - TRACE_ERROR_NUMBER("Failed to allocate memory", ENOMEM); - return ENOMEM; - } - - /* Fill array */ - current = col->next; - ind = 0; - while (current != NULL) { - TRACE_INFO_STRING("Item:", current->property); - array[ind] = current; - if ((sort_flags & COL_SORT_SUB) && - (array[ind]->type == COL_TYPE_COLLECTIONREF)) { - /* If we found a subcollection and we need to sort it - * then sort it. - */ - other = *((struct collection_item **)(array[ind]->data)); - error = col_sort_collection(other, cmp_flags, sort_flags); - if (error) { - TRACE_ERROR_NUMBER("Subcollection sort failed", error); - free(array); - return error; - } - } - ind++; - current = current->next; - } - - last = ind - 1; - - for (i = 0; i < last; i++) { - - TRACE_INFO_STRING("Arg1:", array[i]->property); - TRACE_INFO_STRING("Arg2:", array[i + 1]->property); - - res = col_compare_items(array[i], - array[i + 1], - cmp_flags, - &out_flags); - - TRACE_INFO_STRING("Result:", ((res == 0) ? "same" : "different")); - TRACE_INFO_NUMBER("Out flags", out_flags); - - /* If they are not same and second is not greater - * in any way then we need to swap them */ - if ((res != 0) && (out_flags == 0)) { - /* Swap */ - TRACE_INFO_STRING("Swapping:", ""); - TRACE_INFO_STRING("Item:", array[i]->property); - TRACE_INFO_STRING("Item:", array[i + 1]->property); - - temp_item = array[i]; - array[i] = array[i + 1]; - array[i + 1] = temp_item; - - /* But we need to go up bubbling this item - */ - j = i; - while (j > 0) { - res = col_compare_items(array[j - 1], - array[j], - cmp_flags, - &out_flags); - /* If they are not same and second is not greater - * in any way then we need to swap them */ - if ((res != 0) && (out_flags == 0)) { - /* Swap */ - temp_item = array[j - 1]; - array[j - 1] = array[j]; - array[j] = temp_item; - } - else break; - j--; - } - } - } - - /* Build the chain back */ - if (sort_flags & COL_SORT_DESC) { - col->next = array[last]; - for (i = last; i > 0 ; i--) { - array[i]->next = array[i - 1]; - } - array[0]->next = NULL; - header->last = array[0]; - } - else { - col->next = array[0]; - for (i = 0; i < last ; i++) { - array[i]->next = array[i + 1]; - } - array[last]->next = NULL; - header->last = array[last]; - } - - free(array); - - TRACE_FLOW_STRING("col_sort_collection", "Exit."); - return error; - -} diff --git a/common/collection/collection_cnv.c b/common/collection/collection_cnv.c deleted file mode 100644 index e9ca05dbd..000000000 --- a/common/collection/collection_cnv.c +++ /dev/null @@ -1,1273 +0,0 @@ -/* - COLLECTION LIBRARY - - Convenience wrapper functions are implemented here. - They take a lot of space but pretty simple so they - are separated from the core logic. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - Collection Library 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. - - Collection Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with Collection Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#define _GNU_SOURCE -#include <string.h> -#include <stdlib.h> -#include <errno.h> -#include <ctype.h> -#include <time.h> -#include "trace.h" - -/* The collection should use the teal structures */ -#include "collection_priv.h" -#include "collection.h" - -/* PROPERTIES */ -/* Insert string property with positioning */ -int col_insert_str_property(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - const char *string, - int length) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_insert_string_property", "Entry."); - - if (length == 0) length = strlen(string) + 1; - - error = col_insert_property_with_ref(ci, - subcollection, - disposition, - refprop, - idx, - flags, - property, - COL_TYPE_STRING, - (const void *)string, - length, - NULL); - - TRACE_FLOW_NUMBER("col_insert_string_property returning", error); - return error; -} - -/* Insert binary property with positioning */ -int col_insert_binary_property(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - void *binary_data, - int length) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_insert_binary_property", "Entry."); - - error = col_insert_property_with_ref(ci, - subcollection, - disposition, - refprop, - idx, - flags, - property, - COL_TYPE_BINARY, - binary_data, - length, - NULL); - - TRACE_FLOW_NUMBER("col_insert_binary_property returning", error); - return error; -} - - -/* Insert integer property with positioning */ -int col_insert_int_property(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - int32_t number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_insert_int_property", "Entry."); - - error = col_insert_property_with_ref(ci, - subcollection, - disposition, - refprop, - idx, - flags, - property, - COL_TYPE_INTEGER, - (void *)&number, - sizeof(int32_t), - NULL); - - TRACE_FLOW_NUMBER("col_insert_int_property returning", error); - return error; -} - - -/* Insert unsigned property with positioning */ -int col_insert_unsigned_property(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - uint32_t number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_insert_unsigned_property", "Entry."); - - error = col_insert_property_with_ref(ci, - subcollection, - disposition, - refprop, - idx, - flags, - property, - COL_TYPE_UNSIGNED, - (void *)&number, - sizeof(uint32_t), - NULL); - - TRACE_FLOW_NUMBER("col_insert_unsigned_property returning", error); - return error; -} - - -/* Insert long property with positioning */ -int col_insert_long_property(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - int64_t number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_insert_long_property", "Entry."); - - error = col_insert_property_with_ref(ci, - subcollection, - disposition, - refprop, - idx, - flags, - property, - COL_TYPE_LONG, - (void *)&number, - sizeof(int64_t), - NULL); - - TRACE_FLOW_NUMBER("col_insert_long_property returning", error); - return error; -} - -/* Insert unsigned long property with positioning */ -int col_insert_ulong_property(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - uint64_t number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_insert_ulong_property", "Entry."); - - error = col_insert_property_with_ref(ci, - subcollection, - disposition, - refprop, - idx, - flags, - property, - COL_TYPE_ULONG, - (void *)&number, - sizeof(uint64_t), - NULL); - - TRACE_FLOW_NUMBER("col_insert_ulong_property returning", error); - return error; -} - -/* Insert double property with positioning */ -int col_insert_double_property(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - double number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_insert_double_property", "Entry."); - - error = col_insert_property_with_ref(ci, - subcollection, - disposition, - refprop, - idx, - flags, - property, - COL_TYPE_DOUBLE, - (void *)&number, - sizeof(double), - NULL); - - TRACE_FLOW_NUMBER("col_insert_double_property returning", error); - return error; -} - -/* Insert bool property with positioning */ -int col_insert_bool_property(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - unsigned char logical) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_insert_bool_property", "Entry."); - - error = col_insert_property_with_ref(ci, - subcollection, - disposition, - refprop, - idx, - flags, - property, - COL_TYPE_BOOL, - (void *)&logical, - sizeof(unsigned char), - NULL); - - TRACE_FLOW_NUMBER("col_insert_bool_property returning", error); - return error; -} - - -/* Insert string property with positioning and reference. */ -int col_insert_str_property_with_ref(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - const char *string, - int length, - struct collection_item **ret_ref) -{ - int error = EOK; - void *ptr; - - TRACE_FLOW_STRING("col_insert_string_property_with_ref", "Entry."); - - if (length == 0) length = strlen(string) + 1; - - /* Work around a compilation warning */ - memcpy(&ptr, &string, sizeof(void *)); - - error = col_insert_property_with_ref(ci, - subcollection, - disposition, - refprop, - idx, - flags, - property, - COL_TYPE_STRING, - ptr, - length, - ret_ref); - - TRACE_FLOW_NUMBER("col_insert_string_property_with_ref returning", error); - return error; -} - -/* Insert binary property with positioning and reference. */ -int col_insert_binary_property_with_ref(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - void *binary_data, - int length, - struct collection_item **ret_ref) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_insert_binary_property_with_ref", "Entry."); - - error = col_insert_property_with_ref(ci, - subcollection, - disposition, - refprop, - idx, - flags, - property, - COL_TYPE_BINARY, - (void *)binary_data, - length, - ret_ref); - - TRACE_FLOW_NUMBER("col_insert_binary_property_with_ref returning", error); - return error; -} - -/* Insert int property with positioning and reference. */ -int col_insert_int_property_with_ref(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - int32_t number, - struct collection_item **ret_ref) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_insert_int_property_with_ref", "Entry."); - - error = col_insert_property_with_ref(ci, - subcollection, - disposition, - refprop, - idx, - flags, - property, - COL_TYPE_INTEGER, - (void *)&number, - sizeof(int32_t), - ret_ref); - - TRACE_FLOW_NUMBER("col_insert_int_property_with_ref returning", error); - return error; -} - - -/* Insert unsigned property with positioning and reference. */ -int col_insert_unsigned_property_with_ref(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - uint32_t number, - struct collection_item **ret_ref) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_insert_unsigned_property_with_ref", "Entry."); - - error = col_insert_property_with_ref(ci, - subcollection, - disposition, - refprop, - idx, - flags, - property, - COL_TYPE_UNSIGNED, - (void *)&number, - sizeof(uint32_t), - ret_ref); - - TRACE_FLOW_NUMBER("col_insert_unsigned_property_with_ref returning", error); - return error; -} - -/* Insert long property with positioning and reference. */ -int col_insert_long_property_with_ref(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - int64_t number, - struct collection_item **ret_ref) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_insert_long_property_with_ref", "Entry."); - - error = col_insert_property_with_ref(ci, - subcollection, - disposition, - refprop, - idx, - flags, - property, - COL_TYPE_LONG, - (void *)&number, - sizeof(int64_t), - ret_ref); - - TRACE_FLOW_NUMBER("col_insert_long_property_with_ref returning", error); - return error; -} - -/* Insert unsigned long property with positioning and reference. */ -int col_insert_ulong_property_with_ref(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - uint64_t number, - struct collection_item **ret_ref) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_insert_ulong_property_with_ref", "Entry."); - - error = col_insert_property_with_ref(ci, - subcollection, - disposition, - refprop, - idx, - flags, - property, - COL_TYPE_ULONG, - (void *)&number, - sizeof(uint64_t), - ret_ref); - - TRACE_FLOW_NUMBER("col_insert_ulong_property_with_ref returning", error); - return error; -} - -/* Insert double property with positioning and reference. */ -int col_insert_double_property_with_ref(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - double number, - struct collection_item **ret_ref) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_insert_double_property_with_ref", "Entry."); - - error = col_insert_property_with_ref(ci, - subcollection, - disposition, - refprop, - idx, - flags, - property, - COL_TYPE_DOUBLE, - (void *)&number, - sizeof(double), - ret_ref); - - TRACE_FLOW_NUMBER("col_insert_double_property_with_ref returning", error); - return error; -} - -/* Insert bool property with positioning and reference. */ -int col_insert_bool_property_with_ref(struct collection_item *ci, - const char *subcollection, - int disposition, - const char *refprop, - int idx, - unsigned flags, - const char *property, - unsigned char logical, - struct collection_item **ret_ref) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_insert_bool_property_with_ref", "Entry."); - - error = col_insert_property_with_ref(ci, - subcollection, - disposition, - refprop, - idx, - flags, - property, - COL_TYPE_BOOL, - (void *)&logical, - sizeof(unsigned char), - ret_ref); - - TRACE_FLOW_NUMBER("col_insert_bool_property_with_ref returning", error); - return error; -} - - -/* Add a string property. */ -int col_add_str_property(struct collection_item *ci, - const char *subcollection, - const char *property, - const char *string, - int length) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_add_str_property", "Entry."); - - error = col_insert_str_property(ci, - subcollection, - COL_DSP_END, - NULL, - 0, - 0, - property, - string, - length); - - TRACE_FLOW_NUMBER("col_add_str_property returning", error); - return error; -} - -/* Add a binary property. */ -int col_add_binary_property(struct collection_item *ci, - const char *subcollection, - const char *property, - void *binary_data, - int length) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_add_binary_property", "Entry."); - - error = col_insert_binary_property(ci, - subcollection, - COL_DSP_END, - NULL, - 0, - 0, - property, - binary_data, - length); - - TRACE_FLOW_NUMBER("col_add_binary_property returning", error); - return error; -} - -/* Add an int property. */ -int col_add_int_property(struct collection_item *ci, - const char *subcollection, - const char *property, - int32_t number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_add_int_property", "Entry."); - - error = col_insert_int_property(ci, - subcollection, - COL_DSP_END, - NULL, - 0, - 0, - property, - number); - - TRACE_FLOW_NUMBER("col_add_int_property returning", error); - return error; -} - -/* Add an unsigned int property. */ -int col_add_unsigned_property(struct collection_item *ci, - const char *subcollection, - const char *property, - uint32_t number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_add_unsigned_property", "Entry."); - - error = col_insert_unsigned_property(ci, - subcollection, - COL_DSP_END, - NULL, - 0, - 0, - property, - number); - - TRACE_FLOW_NUMBER("col_add_unsigned_property returning", error); - return error; -} - -/* Add an long property. */ -int col_add_long_property(struct collection_item *ci, - const char *subcollection, - const char *property, - int64_t number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_add_long_property", "Entry."); - - - error = col_insert_long_property(ci, - subcollection, - COL_DSP_END, - NULL, - 0, - 0, - property, - number); - - TRACE_FLOW_NUMBER("col_add_long_property returning", error); - return error; -} - -/* Add an unsigned long property. */ -int col_add_ulong_property(struct collection_item *ci, - const char *subcollection, - const char *property, - uint64_t number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_add_ulong_property", "Entry."); - - error = col_insert_ulong_property(ci, - subcollection, - COL_DSP_END, - NULL, - 0, - 0, - property, - number); - - TRACE_FLOW_NUMBER("col_add_ulong_property returning", error); - return error; -} - -/* Add a double property. */ -int col_add_double_property(struct collection_item *ci, - const char *subcollection, - const char *property, - double number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_add_double_property", "Entry."); - - error = col_insert_double_property(ci, - subcollection, - COL_DSP_END, - NULL, - 0, - 0, - property, - number); - - TRACE_FLOW_NUMBER("col_add_double_property returning", error); - return error; -} - -/* Add a bool property. */ -int col_add_bool_property(struct collection_item *ci, - const char *subcollection, - const char *property, - unsigned char logical) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_add_bool_property", "Entry."); - - error = col_insert_bool_property(ci, - subcollection, - COL_DSP_END, - NULL, - 0, - 0, - property, - logical); - - TRACE_FLOW_NUMBER("col_add_bool_property returning", error); - return error; -} - -/* A function to add a property */ -int col_add_any_property(struct collection_item *ci, - const char *subcollection, - const char *property, - int type, - void *data, - int length) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_add_any_property", "Entry."); - - error = col_insert_property_with_ref(ci, - subcollection, - COL_DSP_END, - NULL, - 0, - 0, - property, - type, - data, - length, - NULL); - - TRACE_FLOW_NUMBER("col_add_any_property returning", error); - return error; -} - -/* Add a string property with reference */ -int col_add_str_property_with_ref(struct collection_item *ci, - const char *subcollection, - const char *property, - char *string, int length, - struct collection_item **ref_ret) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_add_str_property_with_ref", "Entry."); - - error = col_insert_str_property_with_ref(ci, - subcollection, - COL_DSP_END, - NULL, - 0, - 0, - property, - string, - length, - ref_ret); - - TRACE_FLOW_NUMBER("col_add_str_property_with_ref returning", error); - return error; -} - -/* Add a binary property with reference. */ -int col_add_binary_property_with_ref(struct collection_item *ci, - const char *subcollection, - const char *property, - void *binary_data, int length, - struct collection_item **ref_ret) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_add_binary_property_with_ref", "Entry."); - - error = col_insert_binary_property_with_ref(ci, - subcollection, - COL_DSP_END, - NULL, - 0, - 0, - property, - binary_data, - length, - ref_ret); - - TRACE_FLOW_NUMBER("col_add_binary_property_with_ref returning", error); - return error; -} - -/* Add an int property with reference. */ -int col_add_int_property_with_ref(struct collection_item *ci, - const char *subcollection, - const char *property, - int32_t number, - struct collection_item **ref_ret) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_add_int_property_with_ref", "Entry."); - - error = col_insert_int_property_with_ref(ci, - subcollection, - COL_DSP_END, - NULL, - 0, - 0, - property, - number, - ref_ret); - - TRACE_FLOW_NUMBER("col_add_int_property_with_ref returning", error); - return error; -} - -/* Add an unsigned int property with reference. */ -int col_add_unsigned_property_with_ref(struct collection_item *ci, - const char *subcollection, - const char *property, - uint32_t number, - struct collection_item **ref_ret) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_add_unsigned_property_with_ref", "Entry."); - - error = col_insert_unsigned_property_with_ref(ci, - subcollection, - COL_DSP_END, - NULL, - 0, - 0, - property, - number, - ref_ret); - - TRACE_FLOW_NUMBER("col_add_unsigned_property_with_ref returning", error); - return error; -} - -/* Add an long property with reference. */ -int col_add_long_property_with_ref(struct collection_item *ci, - const char *subcollection, - const char *property, - int64_t number, - struct collection_item **ref_ret) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_add_long_property_with_ref", "Entry."); - - error = col_insert_long_property_with_ref(ci, - subcollection, - COL_DSP_END, - NULL, - 0, - 0, - property, - number, - ref_ret); - - TRACE_FLOW_NUMBER("col_add_long_property_with_ref returning", error); - return error; -} - -/* Add an unsigned long property with reference. */ -int col_add_ulong_property_with_ref(struct collection_item *ci, - const char *subcollection, - const char *property, - uint64_t number, - struct collection_item **ref_ret) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_add_ulong_property_with_ref", "Entry."); - - error = col_insert_ulong_property_with_ref(ci, - subcollection, - COL_DSP_END, - NULL, - 0, - 0, - property, - number, - ref_ret); - - TRACE_FLOW_NUMBER("col_add_ulong_property_with_ref returning", error); - return error; -} - -/* Add a double property with reference. */ -int col_add_double_property_with_ref(struct collection_item *ci, - const char *subcollection, - const char *property, - double number, - struct collection_item **ref_ret) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_add_double_property_with_ref", "Entry."); - - error = col_insert_double_property_with_ref(ci, - subcollection, - COL_DSP_END, - NULL, - 0, - 0, - property, - number, - ref_ret); - - TRACE_FLOW_NUMBER("col_add_double_property_with_ref returning", error); - return error; -} - -/* Add a bool property with reference. */ -int col_add_bool_property_with_ref(struct collection_item *ci, - const char *subcollection, - const char *property, - unsigned char logical, - struct collection_item **ref_ret) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_add_bool_property_with_ref", "Entry."); - - error = col_insert_bool_property_with_ref(ci, - subcollection, - COL_DSP_END, - NULL, - 0, - 0, - property, - logical, - ref_ret); - - TRACE_FLOW_NUMBER("col_add_bool_property_with_ref returning", error); - return error; -} - -/* A function to add a property with reference. */ -int col_add_any_property_with_ref(struct collection_item *ci, - const char *subcollection, - const char *property, - int type, - void *data, - int length, - struct collection_item **ref_ret) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_add_any_property_with_ref", "Entry."); - - error = col_insert_property_with_ref(ci, - subcollection, - COL_DSP_END, - NULL, - 0, - 0, - property, - type, - data, - length, - ref_ret); - - TRACE_FLOW_NUMBER("col_add_any_property_with_ref returning", error); - return error; -} - - -/* Update a string property in the collection. - * Length should include the terminating 0 */ -int col_update_str_property(struct collection_item *ci, - const char *property, - int mode_flags, - char *string, - int length) -{ - int error = EOK; - TRACE_FLOW_STRING("col_update_str_property", "Entry."); - - if (length == 0) length = strlen(string) + 1; - error = col_update_property(ci, property, COL_TYPE_STRING, - (void *)string, length, mode_flags); - - TRACE_FLOW_NUMBER("col_update_str_property Returning", error); - return error; -} - -/* Update a binary property in the collection. */ -int col_update_binary_property(struct collection_item *ci, - const char *property, - int mode_flags, - void *binary_data, - int length) -{ - int error = EOK; - TRACE_FLOW_STRING("col_update_binary_property", "Entry."); - - error = col_update_property(ci, property, COL_TYPE_BINARY, - binary_data, length, mode_flags); - - TRACE_FLOW_NUMBER("col_update_binary_property Returning", error); - return error; -} - -/* Update an int property in the collection. */ -int col_update_int_property(struct collection_item *ci, - const char *property, - int mode_flags, - int32_t number) -{ - int error = EOK; - TRACE_FLOW_STRING("col_update_int_property", "Entry."); - - error = col_update_property(ci, property, COL_TYPE_INTEGER, - (void *)(&number), sizeof(int32_t), mode_flags); - - TRACE_FLOW_NUMBER("col_update_int_property Returning", error); - return error; -} - -/* Update an unsigned int property. */ -int col_update_unsigned_property(struct collection_item *ci, - const char *property, - int mode_flags, - uint32_t number) -{ - int error = EOK; - TRACE_FLOW_STRING("col_update_unsigned_property", "Entry."); - - error = col_update_property(ci, property, COL_TYPE_UNSIGNED, - (void *)(&number), sizeof(uint32_t), - mode_flags); - - TRACE_FLOW_NUMBER("col_update_unsigned_property Returning", error); - return error; -} - -/* Update a long property. */ -int col_update_long_property(struct collection_item *ci, - const char *property, - int mode_flags, - int64_t number) -{ - int error = EOK; - TRACE_FLOW_STRING("col_update_long_property", "Entry."); - - error = col_update_property(ci, property, COL_TYPE_LONG, - (void *)(&number), sizeof(int64_t), - mode_flags); - - TRACE_FLOW_NUMBER("col_update_long_property Returning", error); - return error; - -} - -/* Update an unsigned long property. */ -int col_update_ulong_property(struct collection_item *ci, - const char *property, - int mode_flags, - uint64_t number) -{ - int error = EOK; - TRACE_FLOW_STRING("col_update_ulong_property", "Entry."); - - error = col_update_property(ci, property, COL_TYPE_ULONG, - (void *)(&number), sizeof(uint64_t), - mode_flags); - - TRACE_FLOW_NUMBER("col_update_ulong_property Returning", error); - return error; -} - -/* Update a double property. */ -int col_update_double_property(struct collection_item *ci, - const char *property, - int mode_flags, - double number) -{ - int error = EOK; - TRACE_FLOW_STRING("col_update_double_property", "Entry."); - - error = col_update_property(ci, property, COL_TYPE_DOUBLE, - (void *)(&number), sizeof(double), - mode_flags); - - TRACE_FLOW_NUMBER("col_update_double_property Returning", error); - return error; -} - -/* Update a bool property. */ -int col_update_bool_property(struct collection_item *ci, - const char *property, - int mode_flags, - unsigned char logical) -{ - int error = EOK; - TRACE_FLOW_STRING("col_update_bool_property", "Entry."); - - error = col_update_property(ci, property, COL_TYPE_BOOL, - (void *)(&logical), sizeof(unsigned char), - mode_flags); - - TRACE_FLOW_NUMBER("col_update_bool_property Returning", error); - return error; -} - -/* Rename item */ -int col_modify_item_property(struct collection_item *item, - const char *property) -{ - int error; - - TRACE_FLOW_STRING("col_modify_item_property", "Entry"); - - error = col_modify_item(item, property, 0, NULL, 0); - - TRACE_FLOW_STRING("col_modify_item_property", "Exit"); - return error; -} - -/* Convenience functions that wrap modify_item(). */ -/* Modify item data to be str */ -int col_modify_str_item(struct collection_item *item, - const char *property, - const char *string, - int length) -{ - int len; - int error; - - TRACE_FLOW_STRING("col_modify_str_item", "Entry"); - - if (length != 0) len = length; - else len = strlen(string) + 1; - - error = col_modify_item(item, property, - COL_TYPE_STRING, (const void *)string, len); - - TRACE_FLOW_STRING("col_modify_str_item", "Exit"); - return error; -} - -/* Modify item data to be binary */ -int col_modify_binary_item(struct collection_item *item, - const char *property, - void *binary_data, - int length) -{ - int error; - - TRACE_FLOW_STRING("col_modify_binary_item", "Entry"); - - error = col_modify_item(item, property, COL_TYPE_BINARY, binary_data, length); - - TRACE_FLOW_STRING("col_modify_binary_item", "Exit"); - return error; -} - -/* Modify item data to be bool */ -int col_modify_bool_item(struct collection_item *item, - const char *property, - unsigned char logical) -{ - int error; - - TRACE_FLOW_STRING("col_modify_bool_item", "Entry"); - - error = col_modify_item(item, property, COL_TYPE_BOOL, (void *)(&logical), 1); - - TRACE_FLOW_STRING("col_modify_bool_item", "Exit"); - return error; -} - -/* Modify item data to be int */ -int col_modify_int_item(struct collection_item *item, - const char *property, - int32_t number) -{ - int error; - - TRACE_FLOW_STRING("col_modify_int_item","Entry"); - - error = col_modify_item(item, property, COL_TYPE_INTEGER, - (void *)(&number), sizeof(int32_t)); - - TRACE_FLOW_STRING("col_modify_int_item", "Exit"); - return error; -} - -/* Modify item data to be long */ -int col_modify_long_item(struct collection_item *item, - const char *property, - int64_t number) -{ - int error; - - TRACE_FLOW_STRING("col_modify_long_item", "Entry"); - - error = col_modify_item(item, property, COL_TYPE_LONG, - (void *)(&number), sizeof(int64_t)); - - TRACE_FLOW_STRING("col_modify_long_item", "Exit"); - return error; -} - -/* Modify item data to be unigned long */ -int col_modify_ulong_item(struct collection_item *item, - const char *property, - uint64_t number) -{ - int error; - - TRACE_FLOW_STRING("col_modify_ulong_item", "Entry"); - - error = col_modify_item(item, property, COL_TYPE_ULONG, - (void *)(&number), sizeof(uint64_t)); - - TRACE_FLOW_STRING("col_modify_ulong_item", "Exit"); - return error; -} - -int col_modify_unsigned_item(struct collection_item *item, - const char *property, - uint32_t number) -{ - int error; - - TRACE_FLOW_STRING("col_modify_unsigned_item", "Entry"); - - error = col_modify_item(item, property, COL_TYPE_UNSIGNED, - (void *)(&number), sizeof(uint32_t)); - - TRACE_FLOW_STRING("col_modify_unsigned_item", "Exit"); - return error; -} - -int col_modify_double_item(struct collection_item *item, - const char *property, - double number) -{ - int error; - - TRACE_FLOW_STRING("col_modify_double_item", "Entry"); - - error = col_modify_item(item, property, COL_TYPE_DOUBLE, - (void *)(&number), sizeof(double)); - - TRACE_FLOW_STRING("col_modify_double_item", "Exit"); - return error; -} diff --git a/common/collection/collection_iter.c b/common/collection/collection_iter.c deleted file mode 100644 index f3735d7d1..000000000 --- a/common/collection/collection_iter.c +++ /dev/null @@ -1,428 +0,0 @@ -/* - COLLECTION LIBRARY - - Implementation of the collection library iterator functions. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - Collection Library 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. - - Collection Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with Collection Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#define _GNU_SOURCE -#include <string.h> -#include <stdlib.h> -#include <errno.h> -#include <ctype.h> -#include <time.h> -#include "config.h" -#include "trace.h" - -/* The collection should use the real structures */ -#include "collection_priv.h" -#include "collection.h" - -/* Depth for iterator depth allocation block */ -#define STACK_DEPTH_BLOCK 15 - -/* Grow iteration stack */ -static int col_grow_stack(struct collection_iterator *iterator, unsigned desired) -{ - int grow_by = 0; - struct collection_item **temp; - - TRACE_FLOW_STRING("col_grow_stack", "Entry."); - - if (desired > iterator->stack_size) { - grow_by = (((desired - iterator->stack_size) / STACK_DEPTH_BLOCK) + 1) * STACK_DEPTH_BLOCK; - temp = (struct collection_item **)realloc(iterator->stack, grow_by * sizeof(struct collection_item *)); - if (temp == NULL) { - TRACE_ERROR_NUMBER("Failed to allocate memory", ENOMEM); - return ENOMEM; - } - iterator->stack = temp; - iterator->stack_size += grow_by; - } - TRACE_FLOW_STRING("col_grow_stack", "Exit."); - return EOK; -} - - - -/* Bind iterator to a collection */ -int col_bind_iterator(struct collection_iterator **iterator, - struct collection_item *ci, - int mode_flags) -{ - int error; - struct collection_header *header; - struct collection_iterator *iter = NULL; - - TRACE_FLOW_STRING("col_bind_iterator", "Entry."); - - /* Do some argument checking first */ - if ((iterator == NULL) || (ci == NULL)) { - TRACE_ERROR_NUMBER("Invalid parameter.", EINVAL); - return EINVAL; - } - - iter = (struct collection_iterator *)malloc(sizeof(struct collection_iterator)); - if (iter == NULL) { - TRACE_ERROR_NUMBER("Error allocating memory for the iterator.", ENOMEM); - return ENOMEM; - } - - /* Allocate memory for the stack */ - iter->stack = NULL; - iter->stack_size = 0; - iter->stack_depth = 0; - iter->item_level = 0; - iter->flags = mode_flags; - iter->pin_level = 0; - iter->can_break = 0; - - TRACE_INFO_NUMBER("Iterator flags", iter->flags); - - /* Allocate memory for stack */ - error = col_grow_stack(iter, 1); - if(error) { - free(iter); - TRACE_ERROR_NUMBER("Error growing stack.", error); - return error; - } - - /* Create a special end item */ - error = col_allocate_item(&(iter->end_item), "", NULL, 0, COL_TYPE_END); - if(error) { - free(iter); - TRACE_ERROR_NUMBER("Error allocating end item.", error); - return error; - } - - /* Make sure that we tie iterator to the collection */ - header = (struct collection_header *)ci->data; - header->reference_count++; - iter->top = ci; - iter->pin = ci; - *(iter->stack) = ci; - iter->stack_depth++; - - *iterator = iter; - - TRACE_FLOW_STRING("col_bind_iterator", "Exit"); - return EOK; -} - -/* Stop processing this subcollection and move to the next item in the - * collection 'level' levels up.*/ -int col_iterate_up(struct collection_iterator *iterator, unsigned level) -{ - TRACE_FLOW_STRING("iterate_up", "Entry"); - - if (iterator == NULL) { - TRACE_ERROR_NUMBER("Invalid parameter.", EINVAL); - return EINVAL; - } - - TRACE_INFO_NUMBER("Going up:", level); - TRACE_INFO_NUMBER("Current stack depth:", iterator->stack_depth); - - /* If level is big just move to the top, - * that will end the iteration process. - */ - if (level >= iterator->stack_depth) iterator->stack_depth = 0; - else iterator->stack_depth -= level; - - TRACE_INFO_NUMBER("Stack depth at the end:", iterator->stack_depth); - TRACE_FLOW_STRING("col_iterate_up", "Exit"); - return EOK; -} - -/* How deep are we relative to the top level.*/ -int col_get_iterator_depth(struct collection_iterator *iterator, int *depth) -{ - TRACE_FLOW_STRING("col_get_iterator_depth", "Entry"); - - if ((iterator == NULL) || (depth == NULL)) { - TRACE_ERROR_NUMBER("Invalid parameter.", EINVAL); - return EINVAL; - } - - *depth = iterator->stack_depth - 1; - - TRACE_INFO_NUMBER("Stack depth at the end:", iterator->stack_depth); - TRACE_FLOW_STRING("col_get_iterator_depth","Exit"); - return EOK; -} - -/* What was the level of the last item we got? */ -int col_get_item_depth(struct collection_iterator *iterator, int *depth) -{ - TRACE_FLOW_STRING("col_get_item_depth", "Entry"); - - if ((iterator == NULL) || (depth == NULL)) { - TRACE_ERROR_NUMBER("Invalid parameter.", EINVAL); - return EINVAL; - } - - *depth = iterator->item_level; - - TRACE_INFO_NUMBER("Item level at the end:", iterator->item_level); - TRACE_FLOW_STRING("col_get_item_depth","Exit"); - return EOK; -} - - - -/* Unbind the iterator from the collection */ -void col_unbind_iterator(struct collection_iterator *iterator) -{ - TRACE_FLOW_STRING("col_unbind_iterator", "Entry."); - if (iterator != NULL) { - col_destroy_collection(iterator->top); - col_delete_item(iterator->end_item); - free(iterator->stack); - free(iterator); - } - TRACE_FLOW_STRING("col_unbind_iterator", "Exit"); -} - -/* Get items from the collection one by one following the tree */ -int col_iterate_collection(struct collection_iterator *iterator, - struct collection_item **item) -{ - int error; - struct collection_item *current; - struct collection_item *other; - - TRACE_FLOW_STRING("col_iterate_collection", "Entry."); - - /* Check if we have storage for item */ - if (item == NULL) { - TRACE_ERROR_NUMBER("Invalid parameter.", EINVAL); - return EINVAL; - } - - while (1) { - - TRACE_INFO_NUMBER("Stack depth:", iterator->stack_depth); - - if (iterator->stack_depth == 0) { - /* Re-init so if we continue looping we start over */ - iterator->stack[0] = iterator->top; - iterator->stack_depth++; - iterator->item_level = 0; - } - - /* Is current item available */ - current = iterator->stack[iterator->stack_depth - 1]; - iterator->item_level = iterator->stack_depth - 1; - - /* Are we done? */ - if (((iterator->stack_depth - 1) == iterator->pin_level) && - (iterator->pin == current)) { - if (iterator->can_break) { - TRACE_FLOW_STRING("We are done.", ""); - *item = NULL; - iterator->can_break = 0; - return EOK; - } - else iterator->can_break = 1; - } - - /* We are not done so check if we have an item */ - if (current != NULL) { - - TRACE_INFO_STRING("Current item:", current->property); - TRACE_INFO_NUMBER("Current item type:", current->type); - - /* Is this a collection reference */ - if (current->type == COL_TYPE_COLLECTIONREF) { - /* We do follow references? */ - TRACE_INFO_STRING("Current item:", "collection reference"); - if ((iterator->flags & COL_TRAVERSE_IGNORE) == 0) { - /* We should not ignore - then move on */ - TRACE_INFO_STRING("Collection references are not ignored", ""); - error = col_grow_stack(iterator, iterator->stack_depth + 1); - if (error) { - TRACE_ERROR_NUMBER("Error growing stack.", error); - return error; - } - /* Do we need to go deeper than one level ? */ - if ((iterator->flags & COL_TRAVERSE_ONELEVEL) == 0) { - TRACE_INFO_STRING("Need to go deeper", ""); - /* We need to go deeper... */ - /* Do we need to show headers but not reference? */ - if ((iterator->flags & COL_TRAVERSE_ONLYSUB) != 0) { - TRACE_INFO_STRING("Instructed to show header not reference", ""); - other = *((struct collection_item **)current->data); - iterator->stack[iterator->stack_depth] = other->next; - iterator->item_level = iterator->stack_depth; - *item = other; - } - /* Do we need to show both? */ - else if ((iterator->flags & COL_TRAVERSE_SHOWSUB) != 0) { - TRACE_INFO_STRING("Instructed to show header and reference",""); - iterator->stack[iterator->stack_depth] = *((struct collection_item **)(current->data)); - *item = current; - /* Do not need to adjust level here */ - } - /* Do not show either */ - else if ((iterator->flags & COL_TRAVERSE_FLAT) != 0) { - TRACE_INFO_STRING("Instructed not to show header and reference",""); - other = *((struct collection_item **)current->data); - iterator->stack[iterator->stack_depth] = other->next; - iterator->stack[iterator->stack_depth - 1] = current->next; - iterator->stack_depth++; - /* Do not need to adjust level here */ - continue; - } - /* We need to show reference only */ - else { - TRACE_INFO_STRING("Instructed to show reference only", ""); - other = *((struct collection_item **)current->data); - TRACE_INFO_STRING("Sub collection:", other->property); - TRACE_INFO_NUMBER("Sub collection type:", other->type); - iterator->stack[iterator->stack_depth] = other->next; - if (other->next != NULL) { - TRACE_INFO_STRING("Will show this item next time:", other->next->property); - TRACE_INFO_NUMBER("Will show this item next time type:", other->next->type); - } - *item = current; - TRACE_INFO_NUMBER("Level of the reference:", iterator->item_level); - /* Do not need to adjust level here */ - } - - TRACE_INFO_STRING("We return item:", (*item)->property); - TRACE_INFO_NUMBER("We return item type:", (*item)->type); - TRACE_INFO_STRING("Moving to the next item on the previous item in stack", ""); - iterator->stack[iterator->stack_depth - 1] = current->next; - iterator->stack_depth++; - - } - else { - TRACE_INFO_STRING("Instructed to parse just one level", ""); - /* On one level - just return current */ - *item = current; - TRACE_INFO_STRING("Moving to the next item on one level", ""); - iterator->stack[iterator->stack_depth - 1] = current->next; - } - break; - } - else { - /* We need to ignore references so move to the next item */ - TRACE_INFO_STRING("Stepping over the reference", ""); - iterator->stack[iterator->stack_depth - 1] = current->next; - continue; - } - } - else { - /* Got a normal item - return it and move to the next one */ - if ((current->type == COL_TYPE_COLLECTION) && - ((iterator->flags & COL_TRAVERSE_FLAT) != 0) && - (iterator->stack_depth > 1)) { - TRACE_INFO_STRING("Header of the sub collection in flat case ", ""); - iterator->stack[iterator->stack_depth - 1] = current->next; - continue; - } - else { - TRACE_INFO_STRING("Simple item", ""); - *item = current; - iterator->stack[iterator->stack_depth - 1] = current->next; - } - break; - } - } - else { - /* Item is NULL */ - TRACE_INFO_STRING("Finished level", "moving to upper level"); - iterator->stack_depth--; - /* Remember that item_level is zero based while depth is size - * so we decrease and then assign. */ - TRACE_INFO_NUMBER("Stack depth at the end:", iterator->stack_depth); - if ((iterator->flags & COL_TRAVERSE_END) != 0) { - - /* Show end element - * a) If we are flattening but at the top - * b) We are not flattening - */ - if ((((iterator->flags & COL_TRAVERSE_FLAT) != 0) && - (iterator->stack_depth == 0)) || - ((iterator->flags & COL_TRAVERSE_FLAT) == 0)) { - - /* Return dummy entry to indicate the end of the collection */ - TRACE_INFO_STRING("Finished level", "told to return END"); - *item = iterator->end_item; - break; - } - } - else { - /* Move to next level */ - continue; - } - } - } - - TRACE_FLOW_STRING("col_iterate_collection", "Exit"); - return EOK; -} - - -/* Pins down the iterator to loop around this point */ -void col_pin_iterator(struct collection_iterator *iterator) -{ - TRACE_FLOW_STRING("col_iterator_add_pin", "Entry"); - - if ((!iterator) || (!iterator->stack)) { - TRACE_FLOW_STRING("Invalid itertor", "Ingoring"); - return; - } - - while ((iterator->stack_depth) && - (iterator->stack[iterator->stack_depth - 1] == NULL)) { - iterator->stack_depth--; - } - - if (iterator->stack_depth == 0) { - iterator->pin = iterator->top; - iterator->pin_level = 0; - } - else { - iterator->pin = iterator->stack[iterator->stack_depth - 1]; - iterator->pin_level = iterator->stack_depth - 1; - } - iterator->can_break = 0; - - TRACE_FLOW_STRING("col_iterator_add_pin", "Exit"); -} - - -/* Rewinds iterator to the beginning */ -void col_rewind_iterator(struct collection_iterator *iterator) -{ - TRACE_FLOW_STRING("col_rewind_iterator", "Entry"); - - if ((!iterator) || (!iterator->stack)) { - TRACE_FLOW_STRING("Invalid itertor", "Ingoring"); - return; - } - - iterator->pin = iterator->top; - iterator->stack[0] = iterator->top; - iterator->stack_depth = 1; - iterator->item_level = 0; - iterator->pin_level = 0; - iterator->can_break = 0; - - TRACE_FLOW_STRING("col_rewind_iterator", "Exit"); -} diff --git a/common/collection/collection_priv.h b/common/collection/collection_priv.h deleted file mode 100644 index a8aa36699..000000000 --- a/common/collection/collection_priv.h +++ /dev/null @@ -1,84 +0,0 @@ -/* - COLLECTION LIBRARY - - Header file for internal structures used by the collection interface. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - Collection Library 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. - - Collection Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with Collection Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#ifndef COLLECTION_PRIV_H -#define COLLECTION_PRIV_H - -#include <stdint.h> - -/* Define real strcutures */ -/* Structure that holds one property. - * This structure should never be assumed and used directly other than - * inside the collection.c that contains actual implementation or - * collection_tools.c or collection_utils.c. - */ -struct collection_item { - /* Member that contains element linking information. - * This member should never be directly accessed by an application. - */ - struct collection_item *next; - - /* Your implementation can assume that these members - * will always be members of the collection_item. - * but you should use get_item_xxx functions to get them. - */ - char *property; - int property_len; - int type; - int length; - void *data; - uint64_t phash; -}; - - -/* Internal iterator structure - exposed for reference. - * Never access internals of this structure in your application. - */ -struct collection_iterator { - struct collection_item *top; - struct collection_item **stack; - unsigned stack_size; - unsigned stack_depth; - unsigned item_level; - int flags; - struct collection_item *end_item; - struct collection_item *pin; - unsigned pin_level; - unsigned can_break; -}; - - -/* Special type of data that stores collection header information. */ -struct collection_header { - struct collection_item *last; - unsigned reference_count; - unsigned count; - unsigned cclass; -}; - -/* Internal function to allocate item */ -int col_allocate_item(struct collection_item **ci, - const char *property, - const void *item_data, - int length, - int type); - -#endif diff --git a/common/collection/collection_queue.c b/common/collection/collection_queue.c deleted file mode 100644 index adac8ee67..000000000 --- a/common/collection/collection_queue.c +++ /dev/null @@ -1,360 +0,0 @@ -/* - QUEUE - - Implementation of the queue on top of collection library interface. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - Collection Library 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. - - Collection Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with Collection Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#include <stdlib.h> -#include <errno.h> -#include "collection_queue.h" -#include "trace.h" - -/* Function that creates a queue object */ -int col_create_queue(struct collection_item **queue) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_create_queue", "Entry point."); - - error = col_create_collection(queue, COL_NAME_QUEUE, COL_CLASS_QUEUE); - - TRACE_FLOW_STRING("col_create_queue", "Exit."); - return error; -} - -/* Function that destroys a queue object */ -void col_destroy_queue(struct collection_item *queue) -{ - TRACE_FLOW_STRING("col_destroy_queue", "Entry point."); - - col_destroy_collection(queue); - - TRACE_FLOW_STRING("col_destroy_queue", "Exit"); -} - - -/* Put a string property into a queue. */ -int col_enqueue_str_property(struct collection_item *queue, - const char *property, - const char *string, - int length) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_enqueue_str_property", "Entry point."); - - /* Check that queue is not empty */ - if (queue == NULL) { - TRACE_ERROR_STRING("queue can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a queue */ - if (!col_is_of_class(queue, COL_CLASS_QUEUE)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_add_str_property(queue, NULL, property, string, length); - - TRACE_FLOW_STRING("col_enqueue_str_property", "Exit."); - return error; -} - -/* Put a binary property into a queue. */ -int col_enqueue_binary_property(struct collection_item *queue, - const char *property, - void *binary_data, - int length) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_enqueue_binary_property", "Entry point."); - - /* Check that queue is not empty */ - if (queue == NULL) { - TRACE_ERROR_STRING("queue can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a queue */ - if (!col_is_of_class(queue, COL_CLASS_QUEUE)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_add_binary_property(queue, NULL, property, binary_data, length); - - TRACE_FLOW_STRING("col_enqueue_binary_property", "Exit."); - return error; -} - - -/* Put an int property into a queue. */ -int col_enqueue_int_property(struct collection_item *queue, - const char *property, - int32_t number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_enqueue_int_property", "Entry point."); - - /* Check that queue is not empty */ - if (queue == NULL) { - TRACE_ERROR_STRING("queue can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a queue */ - if (!col_is_of_class(queue, COL_CLASS_QUEUE)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_add_int_property(queue, NULL, property, number); - - TRACE_FLOW_STRING("col_enqueue_int_property", "Exit."); - return error; -} - -/* Put an unsigned int property into a queue. */ -int col_enqueue_unsigned_property(struct collection_item *queue, - const char *property, - uint32_t number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_enqueue_unsigned_property", "Entry point."); - - /* Check that queue is not empty */ - if (queue == NULL) { - TRACE_ERROR_STRING("queue can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a queue */ - if (!col_is_of_class(queue, COL_CLASS_QUEUE)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_add_unsigned_property(queue, NULL, property, number); - - TRACE_FLOW_STRING("col_enqueue_unsigned_property", "Exit."); - return error; -} - - -/* Put a long property. */ -int col_enqueue_long_property(struct collection_item *queue, - const char *property, - int64_t number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_enqueue_long_property", "Entry point."); - - /* Check that queue is not empty */ - if (queue == NULL) { - TRACE_ERROR_STRING("queue can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a queue */ - if (!col_is_of_class(queue, COL_CLASS_QUEUE)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_add_long_property(queue, NULL, property, number); - - TRACE_FLOW_STRING("col_enqueue_long_property", "Exit."); - return error; -} - -/* Put an unsigned long property. */ -int col_enqueue_ulong_property(struct collection_item *queue, - const char *property, - uint64_t number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_enqueue_ulong_property", "Entry point."); - - /* Check that queue is not empty */ - if (queue == NULL) { - TRACE_ERROR_STRING("queue can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a queue */ - if (!col_is_of_class(queue, COL_CLASS_QUEUE)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_add_ulong_property(queue, NULL, property, number); - - TRACE_FLOW_STRING("col_enqueue_ulong_property", "Exit."); - return error; -} - -/* Put a double property. */ -int col_enqueue_double_property(struct collection_item *queue, - const char *property, - double number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_enqueue_double_property", "Entry point."); - - /* Check that queue is not empty */ - if (queue == NULL) { - TRACE_ERROR_STRING("queue can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a queue */ - if (!col_is_of_class(queue, COL_CLASS_QUEUE)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_add_double_property(queue, NULL, property, number); - - TRACE_FLOW_STRING("enqueue_double_property", "Exit."); - return error; -} - -/* Put a bool property. */ -int col_enqueue_bool_property(struct collection_item *queue, - const char *property, - unsigned char logical) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_enqueue_bool_property", "Entry point."); - - /* Check that queue is not empty */ - if (queue == NULL) { - TRACE_ERROR_STRING("queue can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a queue */ - if (!col_is_of_class(queue, COL_CLASS_QUEUE)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_add_bool_property(queue, NULL, property, logical); - - TRACE_FLOW_STRING("col_enqueue_bool_property", "Exit."); - return error; -} - -/* Put any property */ -int col_enqueue_any_property(struct collection_item *queue, - const char *property, - int type, - void *data, - int length) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_enqueue_any_property", "Entry point."); - - /* Check that queue is not empty */ - if (queue == NULL) { - TRACE_ERROR_STRING("queue can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a queue */ - if (!col_is_of_class(queue, COL_CLASS_QUEUE)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_add_any_property(queue, NULL, property, type, data, length); - - TRACE_FLOW_STRING("col_enqueue_any_property", "Exit."); - return error; -} - -/* Enqueue item */ -int col_enqueue_item(struct collection_item *queue, - struct collection_item *item) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_enqueue_item", "Entry point."); - - /* Check that queue is not empty */ - if (queue == NULL) { - TRACE_ERROR_STRING("queue can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a queue */ - if (!col_is_of_class(queue, COL_CLASS_QUEUE)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_insert_item_into_current(queue, - item, - COL_DSP_END, - NULL, - 0, - COL_INSERT_NOCHECK); - - TRACE_FLOW_STRING("col_enqueue_item", "Exit."); - return error; -} - -/* Dequeue item */ -int col_dequeue_item(struct collection_item *queue, - struct collection_item **item) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_dequeue_item", "Entry point."); - - /* Check that queue is not empty */ - if (queue == NULL) { - TRACE_ERROR_STRING("queue can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a queue */ - if (!col_is_of_class(queue, COL_CLASS_QUEUE)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_extract_item_from_current(queue, - COL_DSP_FRONT, - NULL, - 0, - 0, - item); - - TRACE_FLOW_STRING("col_dequeue_item", "Exit."); - return error; -} diff --git a/common/collection/collection_queue.h b/common/collection/collection_queue.h deleted file mode 100644 index 86c392523..000000000 --- a/common/collection/collection_queue.h +++ /dev/null @@ -1,323 +0,0 @@ -/* - QUEUE - - Header file for queue implemented using collection interface. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - Collection Library 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. - - Collection Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with Collection Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#ifndef COLLECTION_QUEUE_H -#define COLLECTION_QUEUE_H - -#include "collection.h" - -/** - * @defgroup queue QUEUE interface - * - * Queue interface is a wrapper on top of the \ref collection - * interface. It implements a queue using a collection object. - * - * @{ - */ - -/** @brief Class for the queue object */ -#define COL_CLASS_QUEUE 40000 -/** @brief All queues use this name as the name of the collection */ -#define COL_NAME_QUEUE "queue" - -/** - * @brief Create queue. - * - * Function that creates a queue object. - * - * @param[out] queue Newly created queue object. - * - * @return 0 - Queue was created successfully. - * @return ENOMEM - No memory. - * - */ -int col_create_queue(struct collection_item **queue); - -/** - * @brief Destroy queue. - * - * Function that destroys a queue object. - * - * @param[in] queue Queue object to destroy. - * - */ -void col_destroy_queue(struct collection_item *queue); - -/** - * @brief Add string to the queue. - * - * @param[in] queue Queue object. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] string Null terminated string to add. - * @param[in] length Length of the string. Should include the length - * of the terminating 0. - * If the length is shorter than the full string - * the string will be truncated. If the length is - * longer than the actual string there might be - * garbage at end of the actual string. - * Library will always properly NULL terminate - * the string at the given position dictated - * by length but in no way will inspect the validity - * of the passed in data. This is left to the calling - * application. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * - */ -int col_enqueue_str_property(struct collection_item *queue, - const char *property, - const char *string, - int length); -/** - * @brief Add binary value to the queue. - * - * @param[in] queue Queue object. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] binary_data Data to add. - * @param[in] length Length of the binary data. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - * @return EMSGSIZE - Property name is too long. - * - */ -int col_enqueue_binary_property(struct collection_item *queue, - const char *property, - void *binary_data, - int length); -/** - * @brief Add integer value to the queue. - * - * @param[in] queue Queue object. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Value to add. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - * @return EMSGSIZE - Property name is too long. - * - */ -int col_enqueue_int_property(struct collection_item *queue, - const char *property, - int32_t number); -/** - * @brief Add unsigned value to the queue. - * - * @param[in] queue Queue object. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Value to add. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - * @return EMSGSIZE - Property name is too long. - * - */ -int col_enqueue_unsigned_property(struct collection_item *queue, - const char *property, - uint32_t number); -/** - * @brief Add long integer value to the queue. - * - * @param[in] queue Queue object. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Value to add. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - * @return EMSGSIZE - Property name is too long. - * - */ -int col_enqueue_long_property(struct collection_item *queue, - const char *property, - int64_t number); -/** - * @brief Add unsigned long value to the queue. - * - * @param[in] queue Queue object. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Value to add. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - * @return EMSGSIZE - Property name is too long. - * - */ -int col_enqueue_ulong_property(struct collection_item *queue, - const char *property, - uint64_t number); -/** - * @brief Add floating point value to the queue. - * - * @param[in] queue Queue object. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Value to add. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - * @return EMSGSIZE - Property name is too long. - * - */ -int col_enqueue_double_property(struct collection_item *queue, - const char *property, - double number); -/** - * @brief Add Boolean value to the queue. - * - * @param[in] queue Queue object. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] logical Value to add. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - * @return EMSGSIZE - Property name is too long. - * - */ -int col_enqueue_bool_property(struct collection_item *queue, - const char *property, - unsigned char logical); - -/** - * @brief Add value of any type to the queue. - * - * @param[in] queue Queue object. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] type Type to use. - * @param[in] data Data to add. - * @param[in] length Length of the data. - * - * @return 0 - Property was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * - */ -int col_enqueue_any_property(struct collection_item *queue, - const char *property, - int type, - void *data, - int length); - -/** - * @brief Push item into the queue. - * - * @param[in] queue Queue object. - * @param[in] item Item to push. - * - * @return 0 - Item was added successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - */ -int col_enqueue_item(struct collection_item *queue, - struct collection_item *item); - -/** - * @brief Get item from the queue. - * - * @param[in] queue Queue object. - * @param[out] item Variable receives the value - * of the retrieved item. - * Will be set to NULL if there are - * no more items in the queue. - * - * @return 0 - No internal issues detected. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - */ -int col_dequeue_item(struct collection_item *queue, - struct collection_item **item); - - -#endif diff --git a/common/collection/collection_queue_ut.c b/common/collection/collection_queue_ut.c deleted file mode 100644 index fbe6ea382..000000000 --- a/common/collection/collection_queue_ut.c +++ /dev/null @@ -1,214 +0,0 @@ -/* - QUEUE INTERFACE - - Queue unit test. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - Collection Library 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. - - Collection Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with Collection Library. If not, see <http://www.gnu.org/licenses/>. -*/ - - -#include <stdio.h> -#include <string.h> -#include <errno.h> -#define TRACE_HOME -#include "trace.h" -#include "collection_queue.h" -#include "collection_tools.h" - -typedef int (*test_fn)(void); - -int verbose = 0; - -#define COLOUT(foo) \ - do { \ - if (verbose) foo; \ - } while(0) - - -int queue_test(void) -{ - struct collection_item *queue = NULL; - char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 }; - struct collection_item *item = NULL; - int i; - unsigned count; - int error = EOK; - - TRACE_FLOW_STRING("queue_test","Entry."); - - COLOUT(printf("\n\nQUEUE TEST!!!.\n\n\n")); - - if((error = col_create_queue(&queue)) || - (error = col_enqueue_str_property(queue, "item1","value 1" ,0)) || - (error = col_enqueue_int_property(queue, "item2", -1)) || - (error = col_enqueue_unsigned_property(queue, "item3", 1)) || - (error = col_enqueue_long_property(queue, "item4", 100)) || - (error = col_enqueue_ulong_property(queue, "item5", 1000)) || - (error = col_enqueue_double_property(queue, "item6", 1.1)) || - (error = col_enqueue_bool_property(queue, "item7", 1)) || - (error = col_enqueue_binary_property(queue, "item8", binary_dump, sizeof(binary_dump)))) { - printf("Failed to enqueue property. Error %d\n", error); - col_destroy_collection(queue); - return error; - } - - COLOUT(col_debug_collection(queue,COL_TRAVERSE_DEFAULT)); - - error = col_get_collection_count(queue, &count); - if (error) { - printf("Failed to get count. Error %d\n", error); - col_destroy_collection(queue); - return error; - } - - count--; - - COLOUT(printf("Rotate the queue.\n")); - - for (i = 0; i < count; i++) { - if ((error = col_dequeue_item(queue, &item)) || - (error = col_enqueue_item(queue, item))) { - printf("Failed to dequeue or enqueue items. Error %d\n", error); - col_destroy_collection(queue); - return error; - } - COLOUT(col_debug_collection(queue,COL_TRAVERSE_DEFAULT)); - } - - col_destroy_collection(queue); - TRACE_FLOW_NUMBER("queue_test. Returning", error); - - COLOUT(printf("\n\nEND OF QUEUE TEST!!!.\n\n\n")); - - return error; -} - - -int empty_test(void) -{ - struct collection_item *queue = NULL; - struct collection_item *item = NULL; - int i; - unsigned count; - int error = EOK; - - TRACE_FLOW_STRING("empty_test","Entry."); - - COLOUT(printf("\n\nEMPTY QUEUE TEST!!!.\n\n\n")); - - if((error = col_create_queue(&queue)) || - (error = col_enqueue_str_property(queue, "item1","value 1" ,0)) || - (error = col_enqueue_int_property(queue, "item2", -1)) || - (error = col_enqueue_unsigned_property(queue, "item3", 1))) { - printf("Failed to enqueue property. Error %d\n", error); - col_destroy_collection(queue); - return error; - } - - COLOUT(col_debug_collection(queue,COL_TRAVERSE_DEFAULT)); - - error = col_get_collection_count(queue, &count); - if (error) { - printf("Failed to get count. Error %d\n", error); - col_destroy_collection(queue); - return error; - } - - count--; - - COLOUT(printf("Empty the queue.\n")); - - for (i = 0; i < count; i++) { - if ((error = col_dequeue_item(queue, &item))) { - printf("Failed to dequeue or enqueue items. Error %d\n", error); - col_destroy_collection(queue); - return error; - } - - col_delete_item(item); - - COLOUT(col_debug_collection(queue,COL_TRAVERSE_DEFAULT)); - } - - COLOUT(printf("Add elements again.\n")); - if((error = col_enqueue_str_property(queue, "item1","value 1" ,0)) || - (error = col_enqueue_int_property(queue, "item2", -1)) || - (error = col_enqueue_unsigned_property(queue, "item3", 1))) { - printf("Failed to enqueue property. Error %d\n", error); - col_destroy_collection(queue); - return error; - } - - COLOUT(col_debug_collection(queue,COL_TRAVERSE_DEFAULT)); - - error = col_get_collection_count(queue, &count); - if (error) { - printf("Failed to get count. Error %d\n", error); - col_destroy_collection(queue); - return error; - } - - count--; - - COLOUT(printf("Empty the queue again.\n")); - - for (i = 0; i < count; i++) { - if ((error = col_dequeue_item(queue, &item))) { - printf("Failed to dequeue or enqueue items. Error %d\n", error); - col_destroy_collection(queue); - return error; - } - - col_delete_item(item); - - COLOUT(col_debug_collection(queue,COL_TRAVERSE_DEFAULT)); - } - - col_destroy_collection(queue); - - TRACE_FLOW_NUMBER("empty_test. Returning", error); - - COLOUT(printf("\n\nEND OF QUEUE TEST!!!.\n\n\n")); - - return error; -} - - -/* Main function of the unit test */ -int main(int argc, char *argv[]) -{ - int error = 0; - test_fn tests[] = { queue_test, - empty_test, - NULL }; - test_fn t; - int i = 0; - - if ((argc > 1) && (strcmp(argv[1], "-v") == 0)) verbose = 1; - - printf("Start\n"); - - while ((t = tests[i++])) { - error = t(); - if (error) { - printf("Failed!\n"); - return error; - } - } - - printf("Success!\n"); - return 0; -} diff --git a/common/collection/collection_stack.c b/common/collection/collection_stack.c deleted file mode 100644 index 509df5113..000000000 --- a/common/collection/collection_stack.c +++ /dev/null @@ -1,358 +0,0 @@ -/* - STACK - - Implementation of the stack on top of collection library interface. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - Collection Library 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. - - Collection Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with Collection Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#include <stdlib.h> -#include <errno.h> -#include "collection_stack.h" -#include "trace.h" - -/* Function that creates a stack object */ -int col_create_stack(struct collection_item **stack) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_create_stack", "Entry point."); - - error = col_create_collection(stack, COL_NAME_STACK, COL_CLASS_STACK); - - TRACE_FLOW_STRING("col_create_stack", "Exit."); - return error; -} - -/* Function that destroys a stack object */ -void col_destroy_stack(struct collection_item *stack) -{ - TRACE_FLOW_STRING("col_destroy_stack", "Entry point."); - - col_destroy_collection(stack); - - TRACE_FLOW_STRING("col_destroy_stack", "Exit"); -} - - - -int col_push_str_property(struct collection_item *stack, - const char *property, const char *string, int length) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_push_str_property", "Entry point."); - - /* Check that stack is not empty */ - if (stack == NULL) { - TRACE_ERROR_STRING("Stack can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a stack */ - if (!col_is_of_class(stack, COL_CLASS_STACK)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_add_str_property(stack, NULL, property, string, length); - - TRACE_FLOW_STRING("col_push_str_property", "Exit."); - return error; -} - -/* Push a binary property to stack. */ -int col_push_binary_property(struct collection_item *stack, - const char *property, - void *binary_data, - int length) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_push_binary_property", "Entry point."); - - /* Check that stack is not empty */ - if (stack == NULL) { - TRACE_ERROR_STRING("Stack can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a stack */ - if (!col_is_of_class(stack, COL_CLASS_STACK)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_add_binary_property(stack, NULL, property, binary_data, length); - - TRACE_FLOW_STRING("col_push_binary_property", "Exit."); - return error; -} - - -/* Push an int property to stack. */ -int col_push_int_property(struct collection_item *stack, - const char *property, - int32_t number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_push_int_property", "Entry point."); - - /* Check that stack is not empty */ - if (stack == NULL) { - TRACE_ERROR_STRING("Stack can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a stack */ - if (!col_is_of_class(stack, COL_CLASS_STACK)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_add_int_property(stack, NULL, property, number); - - TRACE_FLOW_STRING("col_push_int_property", "Exit."); - return error; -} - -/* Push an unsigned int property to stack. */ -int col_push_unsigned_property(struct collection_item *stack, - const char *property, - uint32_t number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_push_unsigned_property", "Entry point."); - - /* Check that stack is not empty */ - if (stack == NULL) { - TRACE_ERROR_STRING("Stack can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a stack */ - if (!col_is_of_class(stack, COL_CLASS_STACK)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_add_unsigned_property(stack, NULL, property, number); - - TRACE_FLOW_STRING("col_push_unsigned_property", "Exit."); - return error; -} - - -/* Push a long property. */ -int col_push_long_property(struct collection_item *stack, - const char *property, - int64_t number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_push_long_property", "Entry point."); - - /* Check that stack is not empty */ - if (stack == NULL) { - TRACE_ERROR_STRING("Stack can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a stack */ - if (!col_is_of_class(stack, COL_CLASS_STACK)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_add_long_property(stack, NULL, property, number); - - TRACE_FLOW_STRING("col_push_long_property", "Exit."); - return error; -} - -/* Push an unsigned long property. */ -int col_push_ulong_property(struct collection_item *stack, - const char *property, - uint64_t number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_push_ulong_property", "Entry point."); - - /* Check that stack is not empty */ - if (stack == NULL) { - TRACE_ERROR_STRING("Stack can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a stack */ - if (!col_is_of_class(stack, COL_CLASS_STACK)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_add_ulong_property(stack, NULL, property, number); - - TRACE_FLOW_STRING("col_push_ulong_property", "Exit."); - return error; -} - -/* Push a double property. */ -int col_push_double_property(struct collection_item *stack, - const char *property, - double number) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_push_double_property", "Entry point."); - - /* Check that stack is not empty */ - if (stack == NULL) { - TRACE_ERROR_STRING("Stack can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a stack */ - if (!col_is_of_class(stack, COL_CLASS_STACK)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_add_double_property(stack, NULL, property, number); - - TRACE_FLOW_STRING("col_push_double_property", "Exit."); - return error; -} - -/* Push a bool property. */ -int col_push_bool_property(struct collection_item *stack, - const char *property, - unsigned char logical) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_push_bool_property", "Entry point."); - - /* Check that stack is not empty */ - if (stack == NULL) { - TRACE_ERROR_STRING("Stack can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a stack */ - if (!col_is_of_class(stack, COL_CLASS_STACK)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_add_bool_property(stack, NULL, property, logical); - - TRACE_FLOW_STRING("push_double_property", "Exit."); - return error; -} - -/* Push any property */ -int col_push_any_property(struct collection_item *stack, - const char *property, - int type, - void *data, - int length) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_push_any_property", "Entry point."); - - /* Check that stack is not empty */ - if (stack == NULL) { - TRACE_ERROR_STRING("Stack can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a stack */ - if (!col_is_of_class(stack, COL_CLASS_STACK)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_add_any_property(stack, NULL, property, type, data, length); - - TRACE_FLOW_STRING("col_push_any_property", "Exit."); - return error; -} - -/* Push item */ -int col_push_item(struct collection_item *stack, - struct collection_item *item) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_push_item", "Entry point."); - - /* Check that stack is not empty */ - if (stack == NULL) { - TRACE_ERROR_STRING("Stack can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a stack */ - if (!col_is_of_class(stack, COL_CLASS_STACK)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_insert_item_into_current(stack, - item, - COL_DSP_END, - NULL, - 0, - COL_INSERT_NOCHECK); - - TRACE_FLOW_STRING("col_push_item", "Exit."); - return error; -} - -/* Pop_item */ -int col_pop_item(struct collection_item *stack, - struct collection_item **item) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_pop_item", "Entry point."); - - /* Check that stack is not empty */ - if (stack == NULL) { - TRACE_ERROR_STRING("Stack can't be NULL", ""); - return EINVAL; - } - - /* Make sure it is a stack */ - if (!col_is_of_class(stack, COL_CLASS_STACK)) { - TRACE_ERROR_STRING("Wrong class", ""); - return EINVAL; - } - - error = col_extract_item_from_current(stack, - COL_DSP_END, - NULL, - 0, - 0, - item); - - TRACE_FLOW_STRING("col_pop_item", "Exit."); - return error; -} diff --git a/common/collection/collection_stack.h b/common/collection/collection_stack.h deleted file mode 100644 index f9b01309f..000000000 --- a/common/collection/collection_stack.h +++ /dev/null @@ -1,325 +0,0 @@ -/* - STACK - - Header file for stack implemented using collection interface. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - Collection Library 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. - - Collection Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with Collection Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#ifndef COLLECTION_STACK_H -#define COLLECTION_STACK_H - -#include <collection.h> - -/** - * @defgroup stack STACK interface - * - * Stack interface is a wrapper on top of the \ref collection - * interface. It implements a stack using a collection object. - * - * @{ - */ - -/** @brief Class for the stack object */ -#define COL_CLASS_STACK 30000 -/** @brief All stacks use this name as the name of the collection */ -#define COL_NAME_STACK "stack" - -/** - * @brief Create stack. - * - * Function that creates a stack object. - * - * @param[out] stack Newly created stack object. - * - * @return 0 - Stack was created successfully. - * @return ENOMEM - No memory. - * - */ -int col_create_stack(struct collection_item **stack); - -/** - * @brief Destroy stack. - * - * Function that destroys a stack object. - * - * @param[in] stack Stack object to destroy. - * - */ - -void col_destroy_stack(struct collection_item *stack); - -/** - * @brief Push string to the stack. - * - * @param[in] stack Stack object. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] string Null terminated string to add. - * @param[in] length Length of the string. Should include the length - * of the terminating 0. - * If the length is shorter than the full string - * the string will be truncated. If the length is - * longer than the actual string there might be - * garbage at end of the actual string. - * Library will always properly NULL terminate - * the string at the given position dictated - * by length but in no way will inspect the validity - * of the passed in data. This is left to the calling - * application. - * - * @return 0 - Property was pushed successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * - */ -int col_push_str_property(struct collection_item *stack, - const char *property, - const char *string, - int length); -/** - * @brief Push binary value to the stack. - * - * @param[in] stack Stack object. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] binary_data Data to add. - * @param[in] length Length of the binary data. - * - * @return 0 - Property was pushed successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - * @return EMSGSIZE - Property name is too long. - * - */ -int col_push_binary_property(struct collection_item *stack, - const char *property, - void *binary_data, - int length); -/** - * @brief Push integer value to the stack. - * - * @param[in] stack Stack object. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Value to add. - * - * @return 0 - Property was pushed successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - * @return EMSGSIZE - Property name is too long. - * - */ -int col_push_int_property(struct collection_item *stack, - const char *property, - int32_t number); -/** - * @brief Push unsigned value to the stack. - * - * @param[in] stack Stack object. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Value to add. - * - * @return 0 - Property was pushed successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - * @return EMSGSIZE - Property name is too long. - * - */ -int col_push_unsigned_property(struct collection_item *stack, - const char *property, - uint32_t number); -/** - * @brief Push long integer value to the stack. - * - * @param[in] stack Stack object. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Value to add. - * - * @return 0 - Property was pushed successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - * @return EMSGSIZE - Property name is too long. - * - */ -int col_push_long_property(struct collection_item *stack, - const char *property, - int64_t number); -/** - * @brief Push unsigned long value to the stack. - * - * @param[in] stack Stack object. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Value to add. - * - * @return 0 - Property was pushed successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - * @return EMSGSIZE - Property name is too long. - * - */ -int col_push_ulong_property(struct collection_item *stack, - const char *property, - uint64_t number); -/** - * @brief Push floating point value to the stack. - * - * @param[in] stack Stack object. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] number Value to add. - * - * @return 0 - Property was pushed successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - * @return EMSGSIZE - Property name is too long. - * - */ -int col_push_double_property(struct collection_item *stack, - const char *property, - double number); -/** - * @brief Push Boolean value to the stack. - * - * @param[in] stack Stack object. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] logical Value to add. - * - * @return 0 - Property was pushed successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - * @return EMSGSIZE - Property name is too long. - * - */ -int col_push_bool_property(struct collection_item *stack, - const char *property, - unsigned char logical); - -/** - * @brief Push value of any type to the stack. - * - * @param[in] stack Stack object. - * @param[in] property Name of the property.<br> - * Name should consist of the ASCII characters - * with codes non less than space. - * Exclamation mark character is - * a special character and can't be used - * in name of collection or property.<br> - * Maximum allowed length is defined at compile time. - * The default value is 64k. - * @param[in] type Type to use. - * @param[in] data Data to add. - * @param[in] length Length of the data. - * - * @return 0 - Property was pushed successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid characters in the property name. - * Value argument is invalid in some way. - * @return EMSGSIZE - Property name is too long. - * - */ -int col_push_any_property(struct collection_item *stack, - const char *property, - int type, - void *data, - int length); - -/** - * @brief Push item into the stack. - * - * @param[in] stack Stack object. - * @param[in] item Item to push. - * - * @return 0 - Item was pushed successfully. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - */ - -int col_push_item(struct collection_item *stack, - struct collection_item *item); - - -/** - * @brief Pop item from the stack. - * - * @param[in] stack Stack object. - * @param[out] item Variable receives the value - * of the retrieved item. - * Will be set to NULL if there are - * no more items in the stack. - * - * @return 0 - No internal issues detected. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - */ -int col_pop_item(struct collection_item *stack, - struct collection_item **item); - -#endif diff --git a/common/collection/collection_stack_ut.c b/common/collection/collection_stack_ut.c deleted file mode 100644 index e0633b7b7..000000000 --- a/common/collection/collection_stack_ut.c +++ /dev/null @@ -1,131 +0,0 @@ -/* - STACK INTERFACE - - Stack unit test. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - Collection Library 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. - - Collection Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with Collection Library. If not, see <http://www.gnu.org/licenses/>. -*/ - - -#include <stdio.h> -#include <string.h> -#include <errno.h> -#define TRACE_HOME -#include "trace.h" -#include "collection_stack.h" -#include "collection_tools.h" - -typedef int (*test_fn)(void); - -int verbose = 0; - -#define COLOUT(foo) \ - do { \ - if (verbose) foo; \ - } while(0) - - - -int stack_test(void) -{ - struct collection_item *stack = NULL; - char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 }; - struct collection_item *item1 = NULL; - struct collection_item *item2 = NULL; - - int error = EOK; - - TRACE_FLOW_STRING("stack_test", "Entry."); - - COLOUT(printf("\n\nSTACK TEST!!!.\n\n\n")); - - if ((error = col_create_stack(&stack)) || - (error = col_push_str_property(stack, "item1", "value 1", 0)) || - (error = col_push_int_property(stack, "item2", -1)) || - (error = col_push_unsigned_property(stack, "item3", 1)) || - (error = col_push_long_property(stack, "item4", 100)) || - (error = col_push_ulong_property(stack, "item5", 1000)) || - (error = col_push_double_property(stack, "item6", 1.1)) || - (error = col_push_bool_property(stack, "item7", 1)) || - (error = col_push_binary_property(stack, "item8", binary_dump, sizeof(binary_dump)))) { - printf("Failed to push property. Error %d\n", error); - col_destroy_collection(stack); - return error; - } - - COLOUT(col_debug_collection(stack, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("Swapping last two items by popping and pushing them back.\n")); - - if ((error = col_pop_item(stack, &item1)) || - (error = col_pop_item(stack, &item2))) { - printf("Failed to pop items. Error %d\n", error); - col_destroy_collection(stack); - return error; - } - - COLOUT(printf("\nPopped two last items.\n")); - COLOUT(col_debug_collection(stack, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("\nLast item.\n")); - COLOUT(col_debug_item(item1)); - - COLOUT(printf("\nPrevious item.\n")); - COLOUT(col_debug_item(item2)); - - if ((error = col_push_item(stack, item1)) || - (error = col_push_item(stack, item2))) { - printf("Failed to pop or push items. Error %d\n", error); - col_destroy_collection(stack); - return error; - } - - COLOUT(printf("\n\nPushed two items again in reverse order.\n\n")); - - COLOUT(col_debug_collection(stack, COL_TRAVERSE_DEFAULT)); - col_destroy_collection(stack); - TRACE_FLOW_NUMBER("stack_test. Returning", error); - - COLOUT(printf("\n\nEND OF STACK TEST!!!.\n\n")); - - return error; -} - -/* Main function of the unit test */ - -int main(int argc, char *argv[]) -{ - int error = 0; - test_fn tests[] = { stack_test, - NULL }; - test_fn t; - int i = 0; - - if ((argc > 1) && (strcmp(argv[1], "-v") == 0)) verbose = 1; - - printf("Start\n"); - - while ((t = tests[i++])) { - error = t(); - if (error) { - printf("Failed!\n"); - return error; - } - } - - printf("Success!\n"); - return 0; -} diff --git a/common/collection/collection_tools.c b/common/collection/collection_tools.c deleted file mode 100644 index 7352b3aac..000000000 --- a/common/collection/collection_tools.c +++ /dev/null @@ -1,754 +0,0 @@ -/* - COLLECTION LIBRARY - - Additional functions for printing and debugging collections. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - Collection Library 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. - - Collection Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with Collection Library. If not, see <http://www.gnu.org/licenses/>. -*/ - - -#include <stdio.h> -#include <malloc.h> -#include <errno.h> -#include <string.h> -#include "trace.h" -#include "collection_priv.h" -#include "collection.h" -#include "collection_tools.h" - -/* Debug handle */ -int col_debug_handle(const char *property, - int property_len, - int type, - void *data, - int length, - void *custom_data, - int *dummy) -{ - int i; - int nest_level; - int ignore = 0; - - TRACE_FLOW_STRING("col_debug_handle", "Entry."); - - - nest_level = *(int *)(custom_data); - if (nest_level == -1) { - ignore = 1; - nest_level = 1; - } - - TRACE_INFO_NUMBER("We are getting this pointer:", custom_data); - TRACE_INFO_NUMBER("Nest level:", nest_level); - - switch (type) { - case COL_TYPE_STRING: - printf(">%*s%s[%d] str: %s (%d)\n", - (nest_level -1) * 4, "", - property, - length, - (char *)(data), - nest_level); - break; - case COL_TYPE_BINARY: - printf(">%*s%s[%d] bin: ", - (nest_level -1) * 4, "", - property, - length); - for (i = 0; i < length; i++) - printf("%02X", ((unsigned char *)(data))[i]); - printf(" (%d)\n", nest_level); - break; - case COL_TYPE_INTEGER: - printf(">%*s%s[%d] int: %d (%d)\n", - (nest_level -1) * 4, "", - property, - length, - *((int32_t *)(data)), - nest_level); - break; - case COL_TYPE_UNSIGNED: - printf(">%*s%s[%d] uint: %u (%d)\n", - (nest_level -1) * 4, "", - property, - length, - *((uint32_t *)(data)), - nest_level); - break; - case COL_TYPE_LONG: - printf(">%*s%s[%d] long: %lld (%d)\n", - (nest_level -1) * 4, "", - property, - length, - (long long int)(*((int64_t *)(data))), - nest_level); - break; - case COL_TYPE_ULONG: - printf(">%*s%s[%d] ulong: %llu (%d)\n", - (nest_level -1) * 4, "", - property, - length, - (long long unsigned)(*((uint64_t *)(data))), - nest_level); - break; - case COL_TYPE_DOUBLE: - printf(">%*s%s[%d] double: %.4f (%d)\n", - (nest_level -1) * 4, "", - property, - length, - *((double *)(data)), - nest_level); - break; - case COL_TYPE_BOOL: - printf(">%*s%s[%d] bool: %s (%d)\n", - (nest_level -1) * 4, "", - property, - length, - (*((unsigned char *)(data)) == '\0') ? "false" : "true", - nest_level); - break; - case COL_TYPE_COLLECTION: - if (!ignore) nest_level++; - printf(">%*s%s[%d] header: count %d, ref_count %d class %d data: ", - (nest_level -1) * 4, "", - property, - length, - ((struct collection_header *)(data))->count, - ((struct collection_header *)(data))->reference_count, - ((struct collection_header *)(data))->cclass); - for (i = 0; i < length; i++) - printf("%02X", ((unsigned char *)(data))[i]); - printf(" (%d)\n", nest_level); - break; - case COL_TYPE_COLLECTIONREF: - printf(">%*s%s[%d] external link: ", - (nest_level -1) * 4, "", - property, - length); - for (i = 0; i < length; i++) - printf("%02X", ((unsigned char *)(data))[i]); - printf(" (%d)\n", nest_level); - break; - case COL_TYPE_END: - printf(">%*sEND[N/A] (%d)\n", - (nest_level -1) * 4, "", - nest_level); - if (!ignore) nest_level--; - break; - default: - printf("Not implemented yet.\n"); - break; - } - *(int *)(custom_data) = nest_level; - TRACE_INFO_NUMBER("Nest level at the end:", nest_level); - TRACE_FLOW_STRING("col_debug_handle", "Success exit."); - return EOK; -} - -/* Convenience function to debug an item */ -inline int col_debug_item(struct collection_item *item) -{ - int dummy = 0; - int nest_level = -1; - return col_debug_handle(item->property, - item->property_len, - item->type, - item->data, - item->length, - (void *)(&nest_level), - &dummy); -} - - -/* Print collection for debugging purposes */ -int col_debug_collection(struct collection_item *handle, int flag) -{ - int error = EOK; - int nest_level = 0; - - TRACE_FLOW_STRING("col_debug_collection", "Entry."); - - printf("DEBUG COLLECTION %s\n", handle->property); - - flag |= COL_TRAVERSE_END; - - printf("Traverse flags %d\n", flag); - - /* Traverse collection */ - error = col_traverse_collection(handle, flag, - col_debug_handle, - (void *)(&nest_level)); - if (error) printf("Error debuging collection %d\n", error); - - TRACE_FLOW_STRING("col_debug_collection", "Exit."); - return error; -} - - -/* Return a static string based on type of the element */ -static inline const char *col_get_type(int type) -{ - switch (type) { - case COL_TYPE_STRING: - return COL_TYPE_NAME_STRING; - - case COL_TYPE_INTEGER: - return COL_TYPE_NAME_INTEGER; - - case COL_TYPE_UNSIGNED: - return COL_TYPE_NAME_UNSIGNED; - - case COL_TYPE_LONG: - return COL_TYPE_NAME_LONG; - - case COL_TYPE_ULONG: - return COL_TYPE_NAME_ULONG; - - case COL_TYPE_BINARY: - return COL_TYPE_NAME_BINARY; - - case COL_TYPE_DOUBLE: - return COL_TYPE_NAME_DOUBLE; - - case COL_TYPE_BOOL: - return COL_TYPE_NAME_BOOL; - - default: - return COL_TYPE_NAME_UNKNOWN; - } - -} - -/* Calculate the potential size of the item */ -int col_get_data_len(int type, int length) -{ - int len = 0; - - TRACE_FLOW_STRING("col_get_data_len", "Entry point"); - - switch (type) { - case COL_TYPE_INTEGER: - case COL_TYPE_UNSIGNED: - len = 11; - break; - case COL_TYPE_LONG: - case COL_TYPE_ULONG: - len = 20; - break; - - case COL_TYPE_STRING: - case COL_TYPE_BINARY: - len = length * 2 + 2; - break; - - case COL_TYPE_DOUBLE: - len = 64; - break; - - case COL_TYPE_BOOL: - len = 6; - break; - - default: - len = 0; - break; - } - - TRACE_FLOW_STRING("col_get_data_len","Exit point"); - - return len; -} - -/* Copy data escaping characters */ -static int col_copy_esc(char *dest, const char *source, char esc) -{ - int i = 0; - int j = 0; - - dest[j] = esc; - j++; - - while (source[i]) { - if ((source[i] == '\\') || - (source[i] == esc)) { - - dest[j] = '\\'; - j++; - - } - dest[j] = source[i]; - i++; - j++; - } - dest[j] = esc; - j++; - - return j; -} - -/* Grow buffer to accomodate more space */ -int col_grow_buffer(struct col_serial_data *buf_data, int len) -{ - char *tmp; - - TRACE_FLOW_STRING("col_grow_buffer", "Entry point"); - TRACE_INFO_NUMBER("Current length: ", buf_data->length); - TRACE_INFO_NUMBER("Increment length: ", len); - TRACE_INFO_NUMBER("Expected length: ", buf_data->length+len); - TRACE_INFO_NUMBER("Current size: ", buf_data->size); - - /* Grow buffer if needed */ - while (buf_data->length+len >= buf_data->size) { - tmp = realloc(buf_data->buffer, buf_data->size + BLOCK_SIZE); - if (tmp == NULL) { - TRACE_ERROR_NUMBER("Error. Failed to allocate memory.", ENOMEM); - return ENOMEM; - } - buf_data->buffer = tmp; - buf_data->size += BLOCK_SIZE; - TRACE_INFO_NUMBER("New size: ", buf_data->size); - - } - - TRACE_INFO_NUMBER("Final size: ", buf_data->size); - TRACE_FLOW_STRING("col_grow_buffer", "Success Exit."); - return EOK; -} - -/* Specail function to add different formatting symbols to the output */ -int col_put_marker(struct col_serial_data *buf_data, const void *data, int len) -{ - int error = EOK; - - TRACE_FLOW_STRING("col_put_marker", "Entry point"); - TRACE_INFO_NUMBER("Marker length: ", len); - - error = col_grow_buffer(buf_data, len); - if (error) { - TRACE_ERROR_NUMBER("col_grow_buffer failed with: ", error); - return error; - } - memcpy(buf_data->buffer + buf_data->length, data, len); - buf_data->length += len; - buf_data->buffer[buf_data->length] = '\0'; - - TRACE_FLOW_STRING("col_put_marker","Success exit"); - return error; -} - -/* Add item's data */ -int col_serialize(const char *property_in, - int property_len_in, - int type, - void *data_in, - int length_in, - void *custom_data, - int *dummy) -{ - int len; - struct col_serial_data *buf_data; - const char *property; - const void *data; - int property_len; - int length; - int error = EOK; - int i; - - TRACE_FLOW_STRING("col_serialize","Entry point"); - - *dummy = 0; - - /* Check is there is buffer. If not allocate */ - buf_data = (struct col_serial_data *)custom_data; - if (buf_data == NULL) { - TRACE_ERROR_STRING("Error.", "Storage data is not passed in!"); - return EINVAL; - } - if (buf_data->buffer == NULL) { - TRACE_INFO_STRING("First time use.", "Allocating buffer."); - buf_data->buffer = malloc(BLOCK_SIZE); - if (buf_data->buffer == NULL) { - TRACE_ERROR_NUMBER("Error. Failed to allocate memory.", ENOMEM); - return ENOMEM; - } - buf_data->buffer[0] = '\0'; - buf_data->length = 0; - buf_data->size = BLOCK_SIZE; - } - - TRACE_INFO_NUMBER("Buffer len: ", buf_data->length); - TRACE_INFO_NUMBER("Buffer size: ", buf_data->size); - TRACE_INFO_STRING("Buffer: ", buf_data->buffer); - - /* Check the beginning of the collection */ - if (type == COL_TYPE_COLLECTION) { - TRACE_INFO_STRING("Serializing collection: ", property_in); - TRACE_INFO_STRING("First header. ", ""); - error = col_put_marker(buf_data, "(", 1); - if (error != EOK) return error; - property = TEXT_COLLECTION; - property_len = TEXT_COLLEN; - data = property_in; - length = property_len_in + 1; - type = COL_TYPE_STRING; - buf_data->nest_level++; - } - /* Check for subcollections */ - else if (type == COL_TYPE_COLLECTIONREF) { - /* Skip */ - TRACE_FLOW_STRING("col_serialize", "skip reference return"); - return EOK; - } - /* Check for the end of the collection */ - else if (type == COL_TYPE_END) { - if ((buf_data->length > 0) && - (buf_data->buffer[buf_data->length-1] == ',')) { - buf_data->length--; - buf_data->buffer[buf_data->length] = '\0'; - } - if (buf_data->nest_level > 0) { - buf_data->nest_level--; - error = col_put_marker(buf_data, ")", 1); - if (error != EOK) return error; - } - TRACE_FLOW_STRING("col_serialize", "end collection item processed returning"); - return EOK; - } - else { - property = property_in; - property_len = property_len_in; - data = data_in; - length = length_in; - } - - TRACE_INFO_STRING("Property: ", property); - TRACE_INFO_NUMBER("Property length: ", property_len); - - /* Start with property and "=" */ - if ((error = col_put_marker(buf_data, property, property_len)) || - (error = col_put_marker(buf_data, "=", 1))) { - TRACE_ERROR_NUMBER("put_marker returned error: ", error); - return error; - } - /* Get projected length of the item */ - len = col_get_data_len(type,length); - TRACE_INFO_NUMBER("Expected data length: ",len); - TRACE_INFO_STRING("Buffer so far: ", buf_data->buffer); - - /* Make sure we have enough space */ - if ((error = col_grow_buffer(buf_data, len))) { - TRACE_ERROR_NUMBER("grow_buffer returned error: ", error); - return error; - } - - /* Add the value */ - switch (type) { - case COL_TYPE_STRING: - /* Escape double quotes */ - len = col_copy_esc(&buf_data->buffer[buf_data->length], - (const char *)(data), '"'); - break; - - case COL_TYPE_BINARY: - buf_data->buffer[buf_data->length] = '\''; - for (i = 0; i < length; i++) - sprintf(&buf_data->buffer[buf_data->length + i *2] + 1, - "%02X", (unsigned int)(((const unsigned char *)(data))[i])); - len = length * 2 + 1; - buf_data->buffer[buf_data->length + len] = '\''; - len++; - break; - - case COL_TYPE_INTEGER: - len = sprintf(&buf_data->buffer[buf_data->length], - "%d", *((const int32_t *)(data))); - break; - - case COL_TYPE_UNSIGNED: - len = sprintf(&buf_data->buffer[buf_data->length], - "%u", *((const uint32_t *)(data))); - break; - - case COL_TYPE_LONG: - len = sprintf(&buf_data->buffer[buf_data->length], - "%lld", - (long long int)(*((const int64_t *)(data)))); - break; - - case COL_TYPE_ULONG: - len = sprintf(&buf_data->buffer[buf_data->length], - "%llu", - (long long unsigned)(*((const uint64_t *)(data)))); - break; - - case COL_TYPE_DOUBLE: - len = sprintf(&buf_data->buffer[buf_data->length], - "%.4f", *((const double *)(data))); - break; - - case COL_TYPE_BOOL: - len = sprintf(&buf_data->buffer[buf_data->length], - "%s", (*((const unsigned char *)(data))) ? "true" : "false"); - break; - - default: - buf_data->buffer[buf_data->length] = '\0'; - len = 0; - break; - } - - /* Adjust length */ - buf_data->length += len; - buf_data->buffer[buf_data->length] = '\0'; - - /* Always put a comma at the end */ - error = col_put_marker(buf_data, ",", 1); - if (error != EOK) { - TRACE_ERROR_NUMBER("put_marker returned error: ", error); - return error; - } - - TRACE_INFO_STRING("Data: ", buf_data->buffer); - TRACE_FLOW_STRING("col_serialize", "Exit point"); - return EOK; - -} - -/* Print the collection using default serialization */ -int col_print_collection(struct collection_item *handle) -{ - struct col_serial_data buf_data; - int error = EOK; - - TRACE_FLOW_STRING("col_print_collection", "Entry"); - - printf("COLLECTION:\n"); - - buf_data.buffer = NULL; - buf_data.length = 0; - buf_data.size = 0; - buf_data.nest_level = 0; - - /* Traverse collection */ - error = col_traverse_collection(handle, - COL_TRAVERSE_DEFAULT | COL_TRAVERSE_END , - col_serialize, (void *)(&buf_data)); - if (error) - printf("Error traversing collection %d\n", error); - else - printf("%s\n", buf_data.buffer); - - free(buf_data.buffer); - - TRACE_FLOW_NUMBER("col_print_collection returning", error); - return error; -} - -/* Print the collection using iterator */ -int col_print_collection2(struct collection_item *handle) -{ - struct collection_iterator *iterator = NULL; - int error = EOK; - struct collection_item *item = NULL; - int nest_level = 0; - int dummy = 0; - int line = 1; - - TRACE_FLOW_STRING("col_print_collection2", "Entry"); - - /* If we have something to print print it */ - if (handle == NULL) { - TRACE_ERROR_STRING("No error list", ""); - return EINVAL; - } - - /* Bind iterator */ - error = col_bind_iterator(&iterator, handle, - COL_TRAVERSE_DEFAULT | - COL_TRAVERSE_END | - COL_TRAVERSE_SHOWSUB); - if (error) { - TRACE_ERROR_NUMBER("Error (bind):", error); - return error; - } - - do { - /* Loop through a collection */ - error = col_iterate_collection(iterator, &item); - if (error) { - TRACE_ERROR_NUMBER("Error (iterate):", error); - col_unbind_iterator(iterator); - return error; - } - - /* Are we done ? */ - if (item == NULL) break; - - if (item->type != COL_TYPE_END) printf("%05d", line); - - col_debug_handle(item->property, - item->property_len, - item->type, - item->data, - item->length, - (void *)(&nest_level), - &dummy); - line++; - } - while(1); - - /* Do not forget to unbind iterator - otherwise there will be a leak */ - col_unbind_iterator(iterator); - - TRACE_INFO_STRING("col_print_collection2", "Exit"); - return EOK; -} - -/* Find and print one item using default serialization */ -int col_print_item(struct collection_item *handle, const char *name) -{ - struct col_serial_data buf_data; - int error = EOK; - - TRACE_FLOW_STRING("col_print_item", "Entry"); - - printf("PRINT ITEM:\n"); - - buf_data.buffer = NULL; - buf_data.length = 0; - buf_data.size = 0; - buf_data.nest_level = 0; - - error = col_get_item_and_do(handle, name, COL_TYPE_ANY, - COL_TRAVERSE_DEFAULT, - col_serialize, &buf_data); - if(error) printf("Error searching collection %d\n", error); - else { - if (buf_data.buffer != NULL) { - if (buf_data.length > 0) buf_data.length--; - buf_data.buffer[buf_data.length] = '\0', - printf("%s\n", buf_data.buffer); - free(buf_data.buffer); - } - else { - printf("Name %s is not found in the collection %s.\n", - name, handle->property); - } - } - - TRACE_FLOW_NUMBER("col_print_item returning", error); - return error; -} - -/* Function to free the list of properties. */ -void col_free_property_list(char **str_list) -{ - int current = 0; - - TRACE_FLOW_STRING("col_free_property_list","Entry"); - - if (str_list != NULL) { - while(str_list[current]) { - free(str_list[current]); - current++; - } - free(str_list); - } - - TRACE_FLOW_STRING("col_free_property_list","Exit"); -} - - -/* Convert collection to list of properties */ -char **col_collection_to_list(struct collection_item *handle, int *size, int *error) -{ - struct collection_iterator *iterator; - struct collection_item *item = NULL; - char **list; - unsigned count; - int err; - int current = 0; - - TRACE_FLOW_STRING("col_collection_to_list","Entry"); - - /* Get number of the subsections */ - err = col_get_collection_count(handle, &count); - if (err) { - TRACE_ERROR_NUMBER("Failed to get count of items from collection.", err); - if (error) *error = err; - return NULL; - } - - /* Allocate memory for the sections */ - list = (char **)malloc(count * sizeof(char *)); - if (list == NULL) { - TRACE_ERROR_NUMBER("Failed to get allocate memory.", ENOMEM); - if (error) *error = ENOMEM; - return NULL; - } - - /* Now iterate to fill in the sections */ - /* Bind iterator */ - err = col_bind_iterator(&iterator, handle, COL_TRAVERSE_ONELEVEL); - if (err) { - TRACE_ERROR_NUMBER("Failed to bind.", err); - if (error) *error = err; - free(list); - return NULL; - } - - while(1) { - /* Loop through a collection */ - err = col_iterate_collection(iterator, &item); - if (err) { - TRACE_ERROR_NUMBER("Failed to iterate collection", err); - if (error) *error = err; - col_free_property_list(list); - col_unbind_iterator(iterator); - return NULL; - } - - /* Are we done ? */ - if (item == NULL) break; - - TRACE_INFO_STRING("Property:", col_get_item_property(item, NULL)); - - /* Skip head */ - if(col_get_item_type(item) == COL_TYPE_COLLECTION) continue; - - - /* Allocate memory for the new string */ - list[current] = strdup(col_get_item_property(item, NULL)); - if (list[current] == NULL) { - TRACE_ERROR_NUMBER("Failed to dup string.", ENOMEM); - if (error) *error = ENOMEM; - col_free_property_list(list); - return NULL; - } - current++; - } - - list[current] = NULL; - - /* Do not forget to unbind iterator - otherwise there will be a leak */ - col_unbind_iterator(iterator); - - if (size) *size = (int)(count - 1); - if (error) *error = EOK; - - TRACE_FLOW_STRING("col_collection_to_list returning", ((list == NULL) ? "NULL" : list[0])); - return list; -} diff --git a/common/collection/collection_tools.h b/common/collection/collection_tools.h deleted file mode 100644 index eec91caff..000000000 --- a/common/collection/collection_tools.h +++ /dev/null @@ -1,268 +0,0 @@ -/* - COLLECTION LIBRARY - - Header file for supplementary functions that provide - printing and debugging of collections. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - Collection Library 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. - - Collection Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with Collection Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#ifndef COLLECTION_TOOLS_H -#define COLLECTION_TOOLS_H - -#include "collection.h" - -/** - * @defgroup tools TOOLS interface - * - * Additional functions retaed to tracing, - * printing, debugging and serializaing collections. - * - * Functions in this module are more a sample implementation - * than a part of the interface. There is a chance they will - * change over time. - * - * @{ - */ - -#ifdef HAVE_TRACE -#define COL_DEBUG_COLLECTION(collection) col_debug_collection(collection,COL_TRAVERSE_DEFAULT); -#else -#define COL_DEBUG_COLLECTION(collection) ; -#endif - -/** @brief Name used for string type. */ -#define COL_TYPE_NAME_STRING "string" -/** @brief Name used for binary type. */ -#define COL_TYPE_NAME_BINARY "bin" -/** @brief Name used for integer type. */ -#define COL_TYPE_NAME_INTEGER "int" -/** @brief Name used for unsigned integer type. */ -#define COL_TYPE_NAME_UNSIGNED "uint" -/** @brief Name used for long type. */ -#define COL_TYPE_NAME_LONG "long" -/** @brief Name used for unsigned long type. */ -#define COL_TYPE_NAME_ULONG "ulong" -/** @brief Name used for floating point type. */ -#define COL_TYPE_NAME_DOUBLE "double" -/** @brief Name used for boolean type. */ -#define COL_TYPE_NAME_BOOL "bool" -/** @brief Name used for unknown type. */ -#define COL_TYPE_NAME_UNKNOWN "unknown" - -/** @brief Literal used in the default serialization. */ -#define TEXT_COLLECTION "SET" -/** @brief Length of the \ref TEXT_COLLECTION literal. */ -#define TEXT_COLLEN 3 - -/** - * @brief The data will be allocated in BLOCK_SIZE - * blocks during serialization. - */ -#define BLOCK_SIZE 1024 - -/** - * @struct col_serial_data - * @brief Structure is used to incrementaly serialize collection. - */ -struct col_serial_data { - char *buffer; - int size; - int length; - int nest_level; -}; - - -/** - * @brief Calculate the potential size of the item. - * - * @param[in] type Type of the value. - * @param[in] length Length of the value. - * - * @return Maximum length the value would occupy when serialized. - */ -int col_get_data_len(int type, int length); - -/** - * @brief Grow serialization buffer. - * - * @param[in] buf_data Serialization object. - * @param[in] len For how much the serialization storage - * should be incrementally increased. - * - * @return 0 - Success. - * @return ENOMEM - No memory. - */ -int col_grow_buffer(struct col_serial_data *buf_data, int len); - -/** - * @brief Add special data to the serialization output. - * - * @param[in] buf_data Serialization object. - * @param[in] data Pointer to special data. - * @param[in] len Length of the data to insert. - * - * @return 0 - Success. - * @return ENOMEM - No memory. - */ -int col_put_marker(struct col_serial_data *buf_data, - const void *data, int len); - -/** - * @brief Serialization of data callback. - * - * @param[in] property_in Property to serialize. - * @param[in] property_len_in Length of the property to serialize. - * @param[in] type Type of the value. - * @param[in] data_in Value to serialize. - * @param[in] length_in Length of the value. - * @param[in] custom_data State data passed to callback. - * It is actually a serialization object. - * @param[in] dummy Not used. It is here because - * the callback needs to comply - * to the functions signature. - * - * @return 0 - Success. - * @return ENOMEM - No memory. - */ -int col_serialize(const char *property_in, - int property_len_in, - int type, - void *data_in, - int length_in, - void *custom_data, - int *dummy); - -/** - * @brief Debug property callback. - * - * @param[in] property Property to debug. - * @param[in] property_len Length of the property to debug. - * @param[in] type Type of the value. - * @param[in] data Value to serialize. - * @param[in] length Length of the value. - * @param[in] custom_data State data passed to the callback. - * @param[in] dummy Not used. It is here because - * the callback needs to comply - * to the functions signature. - * - * @return 0 - Success. - * @return ENOMEM - No memory. - */ -int col_debug_handle(const char *property, - int property_len, - int type, - void *data, - int length, - void *custom_data, - int *dummy); - -/** - * @brief Convenience function to debug an item. - * - * Prints item internals. - * - * @param[in] item Item to print. - * - * @return 0 - Success. - * @return ENOMEM - No memory. - */ -int col_debug_item(struct collection_item *item); - -/** - * @brief Print collection for debugging purposes. - * - * Prints collection internals. - * - * @param[in] handle Collection to debug. - * @param[in] flag See traverse flags. - * - * @return 0 - Success. - * @return ENOMEM - No memory. - */ -int col_debug_collection(struct collection_item *handle, - int flag); - -/** - * @brief Print collection data. - * - * Prints collection data. - * Uses traverse function to iterate through - * the collection. - * - * @param[in] handle Collection to print. - * - * @return 0 - Success. - * @return ENOMEM - No memory. - */ -int col_print_collection(struct collection_item *handle); - -/** - * @brief Print collection data. - * - * Prints collection data. - * Uses iterator to process the collection. - * - * @param[in] handle Collection to print. - * - * @return 0 - Success. - * @return ENOMEM - No memory. - */ -int col_print_collection2(struct collection_item *handle); - -/** - * @brief Find and print one property. - * - * Prints item data. - * - * @param[in] handle Collection to search. - * @param[in] name Item to find and print. - * - * @return 0 - Success. - * @return ENOMEM - No memory. - */ -int col_print_item(struct collection_item *handle, const char *name); - -/** - * @brief Convert collection to the array of properties. - * - * @param[in] handle Collection to convert. - * @param[in] size Will receive the number of - * the strings in the array. - * Can be NULL if caller is not interested - * in the size of the array. - * @param[in] error Will receive error value if any. - * Can be NULL if the caller does - * not care about error codes. - * - 0 - Success. - * - ENOMEM - No memory. - * - * @return List of strings that constitute - * the properties in the collection. - * Collection name is not included. - */ -char **col_collection_to_list(struct collection_item *handle, - int *size, - int *error); - -/** - * @brief Free list of properties. - * - * @param[in] str_list List to free. - */ -void col_free_property_list(char **str_list); - -#endif diff --git a/common/collection/collection_ut.c b/common/collection/collection_ut.c deleted file mode 100644 index 92d9d0c47..000000000 --- a/common/collection/collection_ut.c +++ /dev/null @@ -1,1851 +0,0 @@ -/* - COLLECTION LIBRARY - - Collection unit test. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - Collection Library 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. - - Collection Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with Collection Library. If not, see <http://www.gnu.org/licenses/>. -*/ - - -#include <stdio.h> -#include <string.h> -#include <errno.h> -#define TRACE_HOME -#include "trace.h" -#include "collection.h" -#include "collection_tools.h" - -typedef int (*test_fn)(void); - -int verbose = 0; - -#define COLOUT(foo) \ - do { \ - if (verbose) foo; \ - } while(0) - - - -int ref_collection_test(void) -{ - struct collection_item *peer = NULL; - struct collection_item *socket = NULL; - struct collection_item *socket2 = NULL; - char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 }; - - int error = EOK; - - TRACE_FLOW_STRING("ref_collection_test", "Entry."); - - COLOUT(printf("\n\nREF TEST!!!.\n\n\n")); - COLOUT(printf("Creating PEER collection.\n")); - - if ((error = col_create_collection(&peer, "peer", 0)) || - (error = col_add_str_property(peer, NULL, "hostname", "peerhost.mytest.com", 0)) || - /* Expect trailing zero to be truncated */ - (error = col_add_str_property(peer, NULL, "IPv4", "10.10.10.10", 12)) || - (error = col_add_str_property(peer, NULL, "IPv6", "bla:bla:bla:bla:bla:bla", 0))) { - printf("Failed to add property. Error %d\n", error); - col_destroy_collection(peer); - return error; - } - - COLOUT(printf("Creating SOCKET collection.\n")); - - if ((error = col_create_collection(&socket, "socket", 0)) || - (error = col_add_int_property(socket, NULL, "id", 1)) || - (error = col_add_long_property(socket, NULL, "packets", 100000000L)) || - (error = col_add_binary_property(socket, NULL, "stack", binary_dump, sizeof(binary_dump)))) { - col_destroy_collection(peer); - col_destroy_collection(socket); - printf("Failed to add property. Error %d\n", error); - return error; - } - - COLOUT(col_debug_collection(socket, COL_TRAVERSE_DEFAULT)); - COLOUT(col_debug_collection(peer, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("Adding PEER collection to SOCKET collection as a reference named PEER\n")); - - /* Embed peer host into the socket2 as reference */ - error = col_add_collection_to_collection(socket, NULL, "peer", peer, COL_ADD_MODE_REFERENCE); - if (error) { - col_destroy_collection(peer); - col_destroy_collection(socket); - printf("Failed to add collection to collection. Error %d\n", error); - return error; - } - - COLOUT(col_debug_collection(socket, COL_TRAVERSE_DEFAULT)); - COLOUT(col_debug_collection(peer, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("About to destroy PEER\n")); - col_destroy_collection(peer); - COLOUT(col_debug_collection(socket, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("About to extract PEER\n")); - error = col_get_collection_reference(socket, &peer, "peer"); - if (error) { - col_destroy_collection(socket); - printf("Failed to extract collection. Error %d\n", error); - return error; - } - - COLOUT(col_debug_collection(socket, COL_TRAVERSE_DEFAULT)); - COLOUT(col_debug_collection(peer, COL_TRAVERSE_DEFAULT)); - col_destroy_collection(peer); - - COLOUT(col_debug_collection(socket, COL_TRAVERSE_DEFAULT)); - - error = col_get_collection_reference(socket, &socket2, NULL); - if (error) { - col_destroy_collection(socket); - printf("Failed to extract collection. Error %d\n", error); - return error; - } - - COLOUT(col_debug_collection(socket2, COL_TRAVERSE_DEFAULT)); - col_destroy_collection(socket); - COLOUT(col_debug_collection(socket2, COL_TRAVERSE_DEFAULT)); - col_destroy_collection(socket2); - - TRACE_FLOW_NUMBER("ref_collection_test. Returning", error); - - COLOUT(printf("\n\nEND OF REF TEST!!!.\n\n\n")); - - return error; - -} - - -int single_collection_test(void) -{ - struct collection_item *handle = NULL; - int error = EOK; - - TRACE_FLOW_STRING("single_collection_test", "Entry."); - - if ((error = col_create_collection(&handle, "string_test", 0)) || - (error = col_add_str_property(handle, NULL, "property_1", "some data", 0)) || - (error = col_add_str_property(handle, NULL, "property_2", "some other data", 2)) || - (error = col_add_str_property(handle, NULL, "property_3", "more data", 7))) { - printf("Failed to add property. Error %d\n", error); - col_destroy_collection(handle); - return error; - } - - error = col_add_str_property(handle, NULL, "property 1!", "some data", 0); - if (error) { - COLOUT(printf("Expected error adding bad property to collection %d\n", error)); - } - else { - printf("Expected error but got success\n"); - return -1; - } - - error = col_add_double_property(handle, NULL, "double", 0.253545); - if (error) { - printf("Failed to add double property. Error %d\n", error); - col_destroy_collection(handle); - return error; - } - - error = col_update_double_property(handle, "double", COL_TRAVERSE_DEFAULT, 1.999999); - if (error) { - printf("Failed to update double property. Error %d\n", error); - col_destroy_collection(handle); - return error; - } - - COLOUT(printf("Created collection\n")); - - /* Traverse collection */ - if (verbose) { - error = col_debug_collection(handle, COL_TRAVERSE_DEFAULT); - if (error) { - printf("Error debugging collection %d\n", error); - return error; - } - error = col_print_collection(handle); - if (error) { - printf("Error printing collection %d\n", error); - return error; - } - } - - col_destroy_collection(handle); - - TRACE_FLOW_NUMBER("single_collection_test. Error: ", error); - return error; -} - -int add_collection_test(void) -{ - struct collection_item *peer = NULL; - struct collection_item *socket = NULL; - char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 }; - - int error = EOK; - - TRACE_FLOW_STRING("add_collection_test", "Entry."); - - COLOUT(printf("\n\nADD TEST!!!.\n\n\n")); - COLOUT(printf("Creating PEER collection.\n")); - - if ((error = col_create_collection(&peer, "peer", 0)) || - (error = col_add_str_property(peer, NULL, "hostname", "peerhost.mytest.com", 0)) || - /* Expect trailing zero to be truncated */ - (error = col_add_str_property(peer, NULL, "IPv4", "10.10.10.10", 12)) || - (error = col_add_str_property(peer, NULL, "IPv6", "bla:bla:bla:bla:bla:bla", 0))) { - printf("Failed to add property. Error %d", error); - col_destroy_collection(peer); - return error; - } - - COLOUT(printf("Creating SOCKET collection.\n")); - - if ((error = col_create_collection(&socket, "socket", 0)) || - (error = col_add_int_property(socket, NULL, "id", 1)) || - (error = col_add_long_property(socket, NULL, "packets", 100000000L)) || - (error = col_add_binary_property(socket, NULL, "stack", binary_dump, sizeof(binary_dump)))) { - col_destroy_collection(peer); - col_destroy_collection(socket); - printf("Failed to add property. Error %d\n", error); - return error; - } - - COLOUT(col_debug_collection(socket, COL_TRAVERSE_DEFAULT)); - COLOUT(col_debug_collection(peer, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("Adding PEER collection to SOCKET collection as a reference named PEER\n")); - - /* Embed peer host into the socket2 as reference */ - error = col_add_collection_to_collection(socket, NULL, "peer", peer, COL_ADD_MODE_REFERENCE); - if (error) { - col_destroy_collection(peer); - col_destroy_collection(socket); - printf("Failed to create collection. Error %d\n", error); - return error; - } - - COLOUT(col_debug_collection(socket, COL_TRAVERSE_DEFAULT)); - COLOUT(col_debug_collection(peer, COL_TRAVERSE_DEFAULT)); - col_destroy_collection(peer); - COLOUT(col_debug_collection(socket, COL_TRAVERSE_DEFAULT)); - col_destroy_collection(socket); - TRACE_FLOW_NUMBER("add_collection_test. Returning", error); - return error; -} - -int copy_cb(struct collection_item *item, - void *ext_data, - int *skip) -{ - COLOUT(printf("INSIDE Copy Callback\n")); - COLOUT(col_debug_item(item)); - COLOUT(printf("Passed in data: %s\n", (char *) ext_data)); - if (strcmp(col_get_item_property(item, NULL), "id") == 0) *skip = 1; - return EOK; -} - - -int mixed_collection_test(void) -{ - struct collection_item *peer; - struct collection_item *socket1; - struct collection_item *socket2; - struct collection_item *socket3; - struct collection_item *event; - struct collection_item *host; - char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 }; - int found = 0; - unsigned int class = 0; - char foo[] = "foo"; - - int error = EOK; - - TRACE_FLOW_STRING("mixed_collection_test", "Entry."); - - COLOUT(printf("\n\nMIXED TEST!!!.\n\n\n")); - COLOUT(printf("Creating PEER collection.\n")); - - if ((error = col_create_collection(&peer, "peer", 0)) || - (error = col_add_str_property(peer, NULL, "hostname", "peerhost.mytest.com", 0)) || - /* Expect trailing zero to be truncated */ - (error = col_add_str_property(peer, NULL, "IPv4", "10.10.10.10", 12)) || - (error = col_add_str_property(peer, NULL, "IPv6", "bla:bla:bla:bla:bla:bla", 0))) { - printf("Failed to add property. Error %d", error); - col_destroy_collection(peer); - return error; - } - - COLOUT(col_debug_collection(peer, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("Creating HOST collection.\n")); - - if ((error = col_create_collection(&host, "host", 0)) || - (error = col_add_str_property(host, NULL, "hostname", "myhost.mytest.com", 0)) || - (error = col_add_str_property(host, NULL, "IPv4", "20.20.20.20", 13)) || - (error = col_add_str_property(host, NULL, "IPv6", "bla:bla:bla:bla:bla:bla", 0)) || - (error = col_add_double_property(host, NULL, "double", 0.253545))) { - printf("Failed to add property. Error %d", error); - col_destroy_collection(peer); - col_destroy_collection(host); - return error; - } - - COLOUT(col_debug_collection(host, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("Creating SOCKET1 collection.\n")); - - if ((error = col_create_collection(&socket1, "socket1", 0)) || - (error = col_add_int_property(socket1, NULL, "id", 1)) || - (error = col_add_long_property(socket1, NULL, "packets", 100000000L)) || - (error = col_add_binary_property(socket1, NULL, "stack", binary_dump, sizeof(binary_dump)))) { - col_destroy_collection(peer); - col_destroy_collection(host); - col_destroy_collection(socket1); - printf("Failed to add property. Error %d\n", error); - return error; - } - - COLOUT(col_debug_collection(socket1, COL_TRAVERSE_DEFAULT)); - COLOUT(printf("Creating a copy of SOCKET1 collection named SOCKET2.\n")); - - error = col_copy_collection(&socket2, socket1, "socket2", COL_COPY_NORMAL); - if (error) { - col_destroy_collection(peer); - col_destroy_collection(host); - col_destroy_collection(socket1); - printf("Failed to copy collection. Error %d\n", error); - return error; - } - - COLOUT(col_debug_collection(socket2, COL_TRAVERSE_DEFAULT)); - COLOUT(col_debug_collection(peer, COL_TRAVERSE_DEFAULT)); - - error = col_copy_collection_with_cb(&socket3, socket1, "socket3", - COL_COPY_FLATDOT, copy_cb, (void *)foo); - if (error) { - col_destroy_collection(peer); - col_destroy_collection(host); - col_destroy_collection(socket1); - col_destroy_collection(socket2); - printf("Failed to copy collection. Error %d\n", error); - return error; - } - - COLOUT(col_debug_collection(socket3, COL_TRAVERSE_DEFAULT)); - col_destroy_collection(socket3); - - COLOUT(printf("Adding PEER collection to SOCKET2 collection as a reference named PEER2\n")); - - /* Embed peer host into the socket2 as reference */ - error = col_add_collection_to_collection(socket2, NULL, "peer2", peer, COL_ADD_MODE_REFERENCE); - if (error) { - col_destroy_collection(peer); - col_destroy_collection(host); - col_destroy_collection(socket1); - col_destroy_collection(socket2); - printf("Failed to create collection. Error %d\n", error); - return error; - } - - COLOUT(col_debug_collection(socket2, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("Creating an EVENT collection.\n")); - - /* Construct event */ - error = col_create_collection(&event, "event", 0); - if (error) { - col_destroy_collection(peer); - col_destroy_collection(host); - col_destroy_collection(socket1); - col_destroy_collection(socket2); - printf("Failed to create collection. Error %d\n", error); - return error; - } - - COLOUT(col_debug_collection(event, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("Adding HOST to EVENT.\n")); - - /* Add host to event */ - error = col_add_collection_to_collection(event, NULL, NULL, host, COL_ADD_MODE_REFERENCE); - if (error) { - col_destroy_collection(peer); - col_destroy_collection(host); - col_destroy_collection(socket1); - col_destroy_collection(socket2); - printf("Failed to add collections. Error %d\n", error); - return error; - } - - COLOUT(col_debug_collection(event, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("Embed SOCKET1 into EVENT.\n")); - /* Donate socket1 to event */ - /* Socket1 should not be used after this */ - error = col_add_collection_to_collection(event, NULL, NULL, socket1, COL_ADD_MODE_EMBED); - if (error) { - col_destroy_collection(peer); - col_destroy_collection(host); - col_destroy_collection(socket1); - col_destroy_collection(socket2); - printf("Failed to add collections. Error %d\n", error); - return error; - } - - COLOUT(printf("Traverse one level:\n")); - COLOUT(col_debug_collection(event, COL_TRAVERSE_ONELEVEL)); - COLOUT(printf("Traverse ignore subcollections:\n")); - COLOUT(col_debug_collection(event, COL_TRAVERSE_IGNORE)); - COLOUT(printf("Traverse normal:\n")); - COLOUT(col_debug_collection(event, COL_TRAVERSE_DEFAULT)); - COLOUT(col_debug_collection(socket1, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("SOCKET1 MUST NO BE USED AFTER THIS POINT!!!\n")); - socket1 = NULL; - - COLOUT(printf("Add collection PEER as PEER1 to subcollection SOCKET1 of the EVENT.\n")); - - COLOUT(col_debug_collection(peer, COL_TRAVERSE_DEFAULT)); - - error = col_add_collection_to_collection(event, "socket1", "peer1", peer, COL_ADD_MODE_CLONE); - if (error) { - col_destroy_collection(peer); - col_destroy_collection(host); - /* No socket1 any more :) */ - col_destroy_collection(socket2); - printf("Failed to add collections. Error %d\n", error); - return error; - } - - COLOUT(col_debug_collection(event, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("Add property named TIMEOUT to PEER collection.\n")); - - /* Add new property to the peer collection */ - error = col_add_int_property(peer, NULL, "timeout", 5); - if (error) { - col_destroy_collection(peer); - col_destroy_collection(host); - /* No socket1 any more :) */ - col_destroy_collection(socket2); - printf("Failed to add property. Error %d\n", error); - return error; - } - - COLOUT(col_debug_collection(socket2, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("Add property named DELAY to PEER1 collection.\n")); - - error = col_add_int_property(event, "peer1", "delay", 10); - if (error) { - col_destroy_collection(peer); - col_destroy_collection(host); - /* No socket1 any more :) */ - col_destroy_collection(socket2); - printf("Failed to add property. Error %d\n", error); - return error; - } - - COLOUT(col_debug_collection(event, COL_TRAVERSE_DEFAULT)); - COLOUT(col_debug_collection(host, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("Check if property PEER1.DELAY is in the EVENT collection.\n")); - - /* Check if the property in the collection */ - found = 0; - error = col_is_item_in_collection(event, "peer1!delay", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT, &found); - if (error) { - col_destroy_collection(peer); - col_destroy_collection(host); - /* No socket1 any more :) */ - col_destroy_collection(socket2); - printf("Failed to check property. Error %d\n", error); - return error; - } - - if (found == 1) { - COLOUT(printf("Property is found!\n")); - } - else { - COLOUT(printf("Error property is not found!\n")); - } - - - COLOUT(col_print_item(event, "peer1!IPv6")); - COLOUT(col_print_item(event, "event!socket1!peer1!IPv6")); - COLOUT(col_print_item(event, "event!peer1!IPv6")); - COLOUT(col_print_item(event, "speer1!IPv6")); - COLOUT(col_print_item(event, "eer1!IPv6")); - COLOUT(col_print_item(event, "!peer1!IPv6")); - COLOUT(col_print_item(event, "t!peer1!IPv6")); - - /* Traverse collection */ - if (verbose) { - error = col_print_collection2(event); - if (error) { - printf("Error printing collection %d\n", error); - return error; - } - } - - COLOUT(printf("Delete property PEER1!DELAY from the EVENT collection.\n")); - - error = col_delete_property(event, "peer1!delay", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT); - if (error) { - col_destroy_collection(peer); - col_destroy_collection(host); - /* No socket1 any more :) */ - col_destroy_collection(socket2); - printf("Failed to delete property. Error %d\n", error); - return error; - } - - COLOUT(printf("Printing EVENT.\n")); - - /* Traverse collection */ - if (verbose) { - error = col_print_collection2(event); - if (error) { - printf("Error printing collection %d\n", error); - return error; - } - } - - COLOUT(printf("Debugging EVENT.\n")); - if (verbose) { - error = col_debug_collection(event, COL_TRAVERSE_DEFAULT); - if (error) { - printf("Error printing collection %d\n", error); - return error; - } - } - COLOUT(printf("Cleanup of the collections PEER, HOST and SOCKET2.\n")); - - /* Destroy a referenced collection */ - col_destroy_collection(peer); - col_destroy_collection(host); - col_destroy_collection(socket2); - - COLOUT(printf("Printing EVENT again.\n")); - - /* Traverse collection again - peer should still be there */ - if (verbose) { - error = col_print_collection(event); - if (error) { - col_destroy_collection(event); - printf("Error printing collection %d\n", error); - return error; - } - } - - COLOUT(printf("Debugging EVENT again.\n")); - - if (verbose) { - error = col_debug_collection(event, COL_TRAVERSE_DEFAULT); - if (error) { - col_destroy_collection(event); - printf("Error printing collection %d\n", error); - return error; - } - } - - COLOUT(printf("Attempt to add property to a referenced collection.\n")); - - error = col_add_int_property(event, "host", "session", 500); - if (error) { - col_destroy_collection(event); - printf("Error was NOT able to add property to a referenced collection %d.\n", error); - return error; - } - - COLOUT(printf("Attempt to delete non-existent property.\n")); - - /* Can't delete non exitent property */ - error = col_delete_property(event, "host.host", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT); - if (error == 0) { - col_destroy_collection(event); - printf("Error was able to delete property that does not exist.\n"); - return -1; - } - else COLOUT(printf("Expected error %d\n", error)); - - /* Set collection class */ - error = col_set_collection_class(event, 2); - if (error != 0) { - col_destroy_collection(event); - printf("Error was NOT able to set class.\n"); - return error; - } - - error = col_get_collection_class(event, &class); - if (error != 0) { - col_destroy_collection(event); - printf("Error was NOT able to get class.\n"); - return error; - } - else COLOUT(printf("Class = %d\n", class)); - - if (col_is_of_class(event, 2)) { - COLOUT(printf("Class mathced!\n")); - } - else { - col_destroy_collection(event); - printf("Error - bad class.\n"); - return -1; - } - - COLOUT(printf("Done. Cleaning...\n")); - - col_destroy_collection(event); - - COLOUT(printf("Exit.\n")); - TRACE_FLOW_NUMBER("add_collection_test. Returning", EOK); - return EOK; -} - - -int iterator_test(void) -{ - struct collection_item *peer; - struct collection_item *initial; - - struct collection_item *socket1; - struct collection_item *socket2; - struct collection_item *socket3; - struct collection_iterator *iterator = NULL; - int error = EOK; - struct collection_item *item = NULL; - char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 }; - int depth = 0; - int idepth = 0; - int len = 0; - int i; - uint64_t hash1, hash2; - int rwnd = 0; - - COLOUT(printf("\n\n==== ITERATOR TEST ====\n\n")); - - if ((error = col_create_collection(&initial, "strater", 0)) || - (error = col_create_collection(&peer, "peer", 0)) || - (error = col_add_str_property(initial, NULL, "hostname", "peerhost.mytest.com", 0)) || - /* Expect trailing zero to be truncated */ - (error = col_add_str_property(initial, NULL, "IPv4", "10.10.10.10", 12)) || - (error = col_add_str_property(initial, NULL, "IPv6", "bla:bla:bla:bla:bla:bla", 0)) || - (error = col_add_collection_to_collection(peer, NULL, NULL, initial, COL_ADD_MODE_FLAT))) { - printf("Failed to add property. Error %d", error); - col_destroy_collection(peer); - col_destroy_collection(initial); - return error; - } - - col_destroy_collection(initial); - - if ((error = col_create_collection(&socket1, "socket", 0)) || - (error = col_add_int_property(socket1, NULL, "id", 1)) || - (error = col_add_long_property(socket1, NULL, "packets", 100000000L)) || - (error = col_add_binary_property(socket1, NULL, "stack", binary_dump, sizeof(binary_dump)))) { - col_destroy_collection(peer); - col_destroy_collection(socket1); - printf("Failed to add property. Error %d\n", error); - return error; - } - - if ((error = col_create_collection(&socket2, "socket", 0)) || - (error = col_add_int_property(socket2, NULL, "id", 2)) || - (error = col_add_long_property(socket2, NULL, "packets", 200000000L)) || - (error = col_add_binary_property(socket2, NULL, "queue", binary_dump, sizeof(binary_dump)))) { - col_destroy_collection(peer); - col_destroy_collection(socket1); - col_destroy_collection(socket2); - printf("Failed to add property. Error %d\n", error); - return error; - } - - if ((error = col_create_collection(&socket3, "socket", 0))) { - col_destroy_collection(peer); - col_destroy_collection(socket1); - col_destroy_collection(socket2); - printf("Failed to add property. Error %d\n", error); - return error; - } - - error = col_add_collection_to_collection(peer, NULL, "first", socket1, COL_ADD_MODE_REFERENCE); - if (error) { - col_destroy_collection(peer); - col_destroy_collection(socket1); - col_destroy_collection(socket2); - col_destroy_collection(socket3); - printf("Failed to add collection to collection. Error %d\n", error); - return error; - } - - error = col_add_collection_to_collection(peer, NULL, "second", socket2, COL_ADD_MODE_EMBED); - if (error) { - col_destroy_collection(peer); - col_destroy_collection(socket1); - col_destroy_collection(socket2); - col_destroy_collection(socket3); - printf("Failed to add collection to collection. Error %d\n", error); - return error; - } - - error = col_add_collection_to_collection(peer, NULL, "third", socket3, COL_ADD_MODE_EMBED); - if (error) { - col_destroy_collection(peer); - col_destroy_collection(socket1); - col_destroy_collection(socket3); - printf("Failed to add collection to collection. Error %d\n", error); - return error; - } - - error = col_add_collection_to_collection(peer, NULL, "forth", socket1, COL_ADD_MODE_FLATDOT); - if (error) { - col_destroy_collection(peer); - col_destroy_collection(socket1); - printf("Failed to add collection to collection. Error %d\n", error); - return error; - } - - error = col_add_collection_to_collection(peer, NULL, NULL, socket1, COL_ADD_MODE_FLATDOT); - if (error) { - col_destroy_collection(peer); - col_destroy_collection(socket1); - printf("Failed to add collection to collection. Error %d\n", error); - return error; - } - - col_destroy_collection(socket1); - - /* Bind iterator */ - error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_DEFAULT); - if (error) { - printf("Error (bind): %d\n", error); - col_destroy_collection(peer); - return error; - } - - COLOUT(printf("\n\nCollection (traverse default):\n\n")); - COLOUT(col_debug_collection(peer, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("\n\nCollection (traverse flat):\n\n")); - COLOUT(col_debug_collection(peer, COL_TRAVERSE_FLAT | COL_TRAVERSE_END)); - - COLOUT(printf("\n\nIteration (1):\n\n")); - - do { - - - /* Loop through a collection */ - error = col_iterate_collection(iterator, &item); - if (error) { - printf("Error (iterate): %d\n", error); - col_unbind_iterator(iterator); - col_destroy_collection(peer); - return error; - } - - /* Are we done ? */ - if (item == NULL) break; - - depth = 0; - col_get_item_depth(iterator, &depth); - idepth = 0; - col_get_iterator_depth(iterator, &idepth); - - - COLOUT(printf("%*sProperty (%s), type = %d, data size = %d depth = %d idepth = %d\n", - depth * 4, "", - col_get_item_property(item, NULL), - col_get_item_type(item), - col_get_item_length(item), - depth, - idepth)); - - if ((strcmp(col_get_item_property(item, NULL), "id")==0) && - (*((int *)(col_get_item_data(item))) == 1)) { - COLOUT(printf("\n\nFound property we need - go up!!!\n\n\n")); - - /* This should work! */ - error = col_iterate_up(iterator, 1); - if (error) { - printf("We expected success but got error %d\n", error); - col_unbind_iterator(iterator); - col_destroy_collection(peer); - return error; - } - - if ((error = col_modify_str_item(item, "id2", "test", 0)) || - ((verbose) && (error = col_debug_item(item))) || - (error = col_modify_str_item(item, NULL, "test", 2)) || - ((verbose) && (error = col_debug_item(item))) || - (error = col_modify_binary_item(item, NULL, binary_dump, sizeof(binary_dump))) || - ((verbose) && (error = col_debug_item(item))) || - (error = col_modify_bool_item(item, NULL, 1)) || - ((verbose) && (error = col_debug_item(item))) || - (error = col_modify_int_item(item, "int", 1)) || - ((verbose) && (error = col_debug_item(item))) || - (error = col_modify_long_item(item, "long", 1000000000L)) || - ((verbose) && (error = col_debug_item(item))) || - (error = col_modify_ulong_item(item, "ulong", 4000000000UL)) || - ((verbose) && (error = col_debug_item(item))) || - (error = col_modify_unsigned_item(item, "unsigned", 4000000000U)) || - ((verbose) && (error = col_debug_item(item))) || - (error = col_modify_double_item(item, "double", -1.1)) || - ((verbose) && (error = col_debug_item(item)))) { - printf("Failed to change property.\n"); - col_unbind_iterator(iterator); - col_destroy_collection(peer); - return error; - } - - COLOUT(printf("Item name: %s\n", col_get_item_property(item, NULL))); - COLOUT(printf("Item hash: %lu\n", (unsigned long int)col_get_item_hash(item))); - error = col_modify_item_property(item, "new_name"); - if (error) { - printf("We expected success but got error %d\n", error); - col_unbind_iterator(iterator); - col_destroy_collection(peer); - return error; - } - len = 0; - COLOUT(printf("Item name: %s\n", col_get_item_property(item, &len))); - COLOUT(printf("Item hash: %lu\n", (unsigned long int)col_get_item_hash(item))); - COLOUT(printf("Item length: %d\n", len)); - - len = 0; - hash1 = col_make_hash("new_name", 0, &len); - COLOUT(printf("String name: %s\n", "new_name")); - COLOUT(printf("String hash: %lu\n", (unsigned long int)hash1)); - COLOUT(printf("String length: %d\n", len)); - - len = 0; - hash2 = col_make_hash("new_name_suffix", 8, &len); - COLOUT(printf("String name: %.*s\n", len, "new_name_suffix")); - COLOUT(printf("String hash: %lu\n", (unsigned long int)hash2)); - COLOUT(printf("String length: %d\n", len)); - if (hash1 != hash2) { - printf("Hash calculation failed\n"); - col_unbind_iterator(iterator); - col_destroy_collection(peer); - return EINVAL; - } - - hash2 = col_make_hash("new_name", 8, &len); - COLOUT(printf("String name: %.*s\n", len, "new_name")); - COLOUT(printf("String hash: %lu\n", (unsigned long int)hash2)); - COLOUT(printf("String length: %d\n", len)); - if (hash1 != hash2) { - printf("Hash calculation failed\n"); - col_unbind_iterator(iterator); - col_destroy_collection(peer); - return EINVAL; - } - - } - } - while(1); - - col_unbind_iterator(iterator); - - /* Bind iterator again in flat mode */ - error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_FLAT); - if (error) { - printf("Error (bind): %d\n", error); - col_destroy_collection(peer); - return error; - } - - COLOUT(printf("\n\nIteration (2 - flat):\n\n")); - - do { - - /* Loop through a collection */ - error = col_iterate_collection(iterator, &item); - if (error) { - printf("Error (iterate): %d\n", error); - col_destroy_collection(peer); - col_unbind_iterator(iterator); - return error; - } - - /* Are we done ? */ - if (item == NULL) break; - - depth = 0; - col_get_item_depth(iterator, &depth); - COLOUT(printf("%*s", depth * 4, "")); - COLOUT(col_debug_item(item)); - - if ((strcmp(col_get_item_property(item, NULL), "queue") == 0) && - (rwnd == 0)) { - COLOUT(printf("Rewinding iterator...\n")); - col_rewind_iterator(iterator); - rwnd++; - } - - } - while(1); - - /* Do not forget to unbind iterator - otherwise there will be a leak */ - col_unbind_iterator(iterator); - - /* Bind iterator again in flat mode */ - error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_FLAT | COL_TRAVERSE_END); - if (error) { - printf("Error (bind): %d\n", error); - col_destroy_collection(peer); - return error; - } - - COLOUT(printf("\n\nIteration (3 flat with end):\n\n")); - - do { - - /* Loop through a collection */ - error = col_iterate_collection(iterator, &item); - if (error) { - printf("Error (iterate): %d\n", error); - col_destroy_collection(peer); - col_unbind_iterator(iterator); - return error; - } - - /* Are we done ? */ - if (item == NULL) break; - - depth = 0; - col_get_item_depth(iterator, &depth); - COLOUT(printf("%*s", depth * 4, "")); - COLOUT(col_debug_item(item)); - - } - while(1); - - /* Do not forget to unbind iterator - otherwise there will be a leak */ - col_unbind_iterator(iterator); - - /* Bind iterator again in flat mode */ - error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_DEFAULT | COL_TRAVERSE_END); - if (error) { - printf("Error (bind): %d\n", error); - col_destroy_collection(peer); - return error; - } - - COLOUT(printf("\n\nIteration (4 default with end):\n\n")); - - do { - - /* Loop through a collection */ - error = col_iterate_collection(iterator, &item); - if (error) { - printf("Error (iterate): %d\n", error); - col_destroy_collection(peer); - col_unbind_iterator(iterator); - return error; - } - - /* Are we done ? */ - if (item == NULL) break; - - depth = 0; - col_get_item_depth(iterator, &depth); - COLOUT(printf("%*s", depth * 4, "")); - COLOUT(col_debug_item(item)); - - } - while(1); - - /* Do not forget to unbind iterator - otherwise there will be a leak */ - col_unbind_iterator(iterator); - - /* Bind iterator again in flat mode */ - error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_SHOWSUB | COL_TRAVERSE_END); - if (error) { - printf("Error (bind): %d\n", error); - col_destroy_collection(peer); - return error; - } - - - COLOUT(printf("\n\nIteration (5 show headers and references with end):\n\n")); - - do { - - /* Loop through a collection */ - error = col_iterate_collection(iterator, &item); - if (error) { - printf("Error (iterate): %d\n", error); - col_destroy_collection(peer); - col_unbind_iterator(iterator); - return error; - } - - /* Are we done ? */ - if (item == NULL) break; - - depth = 0; - col_get_item_depth(iterator, &depth); - COLOUT(printf("%*s", depth * 4, "")); - COLOUT(col_debug_item(item)); - - } - while(1); - - /* Do not forget to unbind iterator - otherwise there will be a leak */ - col_unbind_iterator(iterator); - - /* Bind iterator again in flat mode */ - error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_SHOWSUB); - if (error) { - printf("Error (bind): %d\n", error); - col_destroy_collection(peer); - return error; - } - - - COLOUT(printf("\n\nIteration (6 show headers and references no END):\n\n")); - - do { - - /* Loop through a collection */ - error = col_iterate_collection(iterator, &item); - if (error) { - printf("Error (iterate): %d\n", error); - col_destroy_collection(peer); - col_unbind_iterator(iterator); - return error; - } - - /* Are we done ? */ - if (item == NULL) break; - - depth = 0; - col_get_item_depth(iterator, &depth); - COLOUT(printf("%*s", depth * 4, "")); - COLOUT(col_debug_item(item)); - - } - while(1); - - /* Do not forget to unbind iterator - otherwise there will be a leak */ - col_unbind_iterator(iterator); - - /* Bind iterator again in flat mode */ - error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_ONLYSUB); - if (error) { - printf("Error (bind): %d\n", error); - col_destroy_collection(peer); - return error; - } - - COLOUT(printf("\n\nIteration (7 show headers only no END):\n\n")); - - do { - - /* Loop through a collection */ - error = col_iterate_collection(iterator, &item); - if (error) { - printf("Error (iterate): %d\n", error); - col_destroy_collection(peer); - col_unbind_iterator(iterator); - return error; - } - - /* Are we done ? */ - if (item == NULL) break; - - depth = 0; - col_get_item_depth(iterator, &depth); - COLOUT(printf("%*s", depth * 4, "")); - COLOUT(col_debug_item(item)); - - } - while(1); - - /* Do not forget to unbind iterator - otherwise there will be a leak */ - col_unbind_iterator(iterator); - - - /* Bind iterator */ - error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_DEFAULT); - if (error) { - printf("Error (bind): %d\n", error); - col_destroy_collection(peer); - return error; - } - - COLOUT(printf("\n\nIterate up test:\n\n")); - - do { - - /* Loop through a collection */ - error = col_iterate_collection(iterator, &item); - if (error) { - printf("Error (iterate): %d\n", error); - col_unbind_iterator(iterator); - col_destroy_collection(peer); - return error; - } - - /* Are we done ? */ - if (item == NULL) break; - - depth = 0; - col_get_item_depth(iterator, &depth); - idepth = 0; - col_get_iterator_depth(iterator, &idepth); - - - COLOUT(printf("%*sProperty (%s), type = %d, data size = %d depth = %d idepth = %d\n", - depth * 4, "", - col_get_item_property(item, NULL), - col_get_item_type(item), - col_get_item_length(item), - depth, - idepth)); - - if (strcmp(col_get_item_property(item, NULL), "queue") == 0) { - - COLOUT(printf("\n\nFound property we need - go up!!!\n")); - COLOUT(printf("Expect bail out of collection processing.\n\n")); - - /* This should work! */ - error = col_iterate_up(iterator, 10); - if (error) { - printf("We expected success but got error %d\n", error); - col_unbind_iterator(iterator); - col_destroy_collection(peer); - return error; - } - - } - } - while(1); - - col_unbind_iterator(iterator); - - /* Bind iterator again in flat mode */ - error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_FLAT | COL_TRAVERSE_END); - if (error) { - printf("Error (bind): %d\n", error); - col_destroy_collection(peer); - return error; - } - - COLOUT(printf("\n\nCircled looping:\n\n")); - - for (i = 0; i < 200; i++) { - /* Loop through a collection */ - error = col_iterate_collection(iterator, &item); - if (error) { - printf("Error (iterate): %d\n", error); - col_destroy_collection(peer); - col_unbind_iterator(iterator); - return error; - } - - /* Are we done ? */ - if (item == NULL) { - COLOUT(printf("Reached end.\n\n")); - } - else { - depth = 0; - col_get_item_depth(iterator, &depth); - COLOUT(printf("%*s", depth * 4, "")); - COLOUT(col_debug_item(item)); - } - } - - /* Do not forget to unbind iterator - otherwise there will be a leak */ - col_unbind_iterator(iterator); - - /* Bind iterator again in flat mode */ - error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_FLAT | COL_TRAVERSE_END); - if (error) { - printf("Error (bind): %d\n", error); - col_destroy_collection(peer); - return error; - } - - COLOUT(printf("\n\nCircled looping with pin:\n\n")); - - do { - /* Loop through a collection */ - error = col_iterate_collection(iterator, &item); - if (error) { - printf("Error (iterate): %d\n", error); - col_destroy_collection(peer); - col_unbind_iterator(iterator); - return error; - } - - if (strcmp(col_get_item_property(item, NULL), "queue") == 0) { - /* Make it a new looping point */ - col_pin_iterator(iterator); - COLOUT(printf("Found pin point.\n\n")); - break; - } - /* Are we done ? */ - if (item == NULL) { - printf("Unexpected end.\n\n"); - col_destroy_collection(peer); - col_unbind_iterator(iterator); - return EINVAL; - } - else { - depth = 0; - col_get_item_depth(iterator, &depth); - COLOUT(printf("%*s", depth * 4, "")); - COLOUT(col_debug_item(item)); - } - } - while(1); - - /* Second loop around the pin point */ - for (i = 0; i < 200; i++) { - /* Loop through a collection */ - error = col_iterate_collection(iterator, &item); - if (error) { - printf("Error (iterate): %d\n", error); - col_destroy_collection(peer); - col_unbind_iterator(iterator); - return error; - } - - /* Are we done ? */ - if (item == NULL) { - COLOUT(printf("Reached end.\n\n")); - } - else { - depth = 0; - col_get_item_depth(iterator, &depth); - COLOUT(printf("%*s", depth * 4, "")); - COLOUT(col_debug_item(item)); - } - } - - /* Do not forget to unbind iterator - otherwise there will be a leak */ - col_unbind_iterator(iterator); - - - /* Bind iterator again in flat mode */ - error = col_bind_iterator(&iterator, peer, COL_TRAVERSE_DEFAULT | COL_TRAVERSE_END); - if (error) { - printf("Error (bind): %d\n", error); - col_destroy_collection(peer); - return error; - } - - COLOUT(printf("\n\nCircled looping with pin (default):\n\n")); - - do { - /* Loop through a collection */ - error = col_iterate_collection(iterator, &item); - if (error) { - printf("Error (iterate): %d\n", error); - col_destroy_collection(peer); - col_unbind_iterator(iterator); - return error; - } - - if (strcmp(col_get_item_property(item, NULL), "queue") == 0) { - /* Make it a new looping point */ - col_pin_iterator(iterator); - COLOUT(printf("Found pin point.\n\n")); - break; - } - /* Are we done ? */ - if (item == NULL) { - printf("Unexpected end.\n\n"); - col_destroy_collection(peer); - col_unbind_iterator(iterator); - return EINVAL; - } - else { - depth = 0; - col_get_item_depth(iterator, &depth); - COLOUT(printf("%*s", depth * 4, "")); - COLOUT(col_debug_item(item)); - } - } - while(1); - - /* Second loop around the pin point */ - for (i = 0; i < 200; i++) { - /* Loop through a collection */ - error = col_iterate_collection(iterator, &item); - if (error) { - printf("Error (iterate): %d\n", error); - col_destroy_collection(peer); - col_unbind_iterator(iterator); - return error; - } - - /* Are we done ? */ - if (item == NULL) { - COLOUT(printf("Reached end.\n\n")); - } - else { - depth = 0; - col_get_item_depth(iterator, &depth); - COLOUT(printf("%*s", depth * 4, "")); - COLOUT(col_debug_item(item)); - } - } - - /* Do not forget to unbind iterator - otherwise there will be a leak */ - col_unbind_iterator(iterator); - col_destroy_collection(peer); - - return EOK; -} - - -int insert_extract_test(void) -{ - struct collection_item *col; - struct collection_item *col2; - int error = EOK; - struct collection_item *item = NULL; - - COLOUT(printf("\n\n==== INSERTION TEST ====\n\n")); - - if ((error = col_create_collection(&col, "insertion", 0)) || - (error = col_insert_str_property(col, NULL, COL_DSP_END, - NULL, 0, COL_INSERT_NOCHECK, - "property1", "value1", 0)) || - (error = col_insert_str_property(col, NULL, COL_DSP_END, - NULL, 0, COL_INSERT_NOCHECK, - "property2", "value2", 0)) || - (error = col_insert_str_property(col, NULL, COL_DSP_FRONT, - NULL, 0, COL_INSERT_NOCHECK, - "property0", "value0", 0)) || - (error = col_insert_str_property(col, NULL, COL_DSP_BEFORE, - "property0", 0, COL_INSERT_NOCHECK, - "property_-1", "value_-1", 0)) || - (error = col_insert_str_property(col, NULL, COL_DSP_BEFORE, - "property1", 0, COL_INSERT_NOCHECK, - "property0_5", "value0_5", 0)) || - (error = col_insert_str_property(col, NULL, COL_DSP_BEFORE, - "property2", 0, COL_INSERT_NOCHECK, - "property1_5", "value1_5", 0)) || - (error = col_insert_str_property(col, NULL, COL_DSP_AFTER, - "property_-1", 0, COL_INSERT_NOCHECK, - "property_-0_5", "value_-0_5", 0)) || - (error = col_insert_str_property(col, NULL, COL_DSP_AFTER, - "property1_5", 0, COL_INSERT_NOCHECK, - "property1_6", "value1_6", 0)) || - (error = col_insert_str_property(col, NULL, COL_DSP_INDEX, - NULL, 10, COL_INSERT_NOCHECK, - "property10", "value10", 0)) || - (error = col_insert_str_property(col, NULL, COL_DSP_INDEX, - NULL, 0, COL_INSERT_NOCHECK, - "property_-2", "value_-2", 0)) || - (error = col_insert_str_property(col, NULL, COL_DSP_INDEX, - NULL, 1, COL_INSERT_NOCHECK, - "property_-1_5", "value_-1_5", 0)) || - (error = col_insert_str_property(col, NULL, COL_DSP_FIRSTDUP, - NULL, 0, COL_INSERT_NOCHECK, - "property0", "value0firstdup", 0)) || - (error = col_insert_str_property(col, NULL, COL_DSP_LASTDUP, - NULL, 0, COL_INSERT_NOCHECK, - "property0", "value0lastdup", 0)) || - (error = col_insert_str_property(col, NULL, COL_DSP_NDUP, - NULL, 1, COL_INSERT_NOCHECK, - "property0", "value0middledup", 0)) || - (error = col_insert_str_property(col, NULL, 0, - NULL, 0, COL_INSERT_DUPOVER , - "property0", "value0firstdupupdate", 0)) || - (error = col_insert_str_property(col, NULL, 0, - NULL, 0, COL_INSERT_DUPOVERT, - "property1", "value1update", 0)) || - ((error = col_insert_str_property(col, NULL, 0, - NULL, 0, COL_INSERT_DUPERROR, - "property0", "does not matter", 0)) != EEXIST) || - (error = col_insert_str_property(col, NULL, COL_DSP_NDUP, - NULL, 5, COL_INSERT_NOCHECK, - "property10", "value10dup", 0)) || - (error = col_insert_str_property(col, NULL, COL_DSP_LASTDUP, - NULL, 0, COL_INSERT_NOCHECK, - "property10", "value10lastdup", 0)) || - (error = col_insert_str_property(col, NULL, COL_DSP_END, - NULL, 0, COL_INSERT_DUPMOVET, - "property_-2", "value-2moved_to_bottom", 0)) || - (error = col_insert_str_property(col, NULL, COL_DSP_FRONT, - NULL, 0, COL_INSERT_DUPMOVE, - "property1_6", "value_1_6_moved_moved_to_front", 0))) { - - printf("ERROR in the ITERATION TEST\n"); - col_debug_collection(col, COL_TRAVERSE_DEFAULT); - col_destroy_collection(col); - return error; - } - - COLOUT(printf("\n\nCollection:\n\n")); - COLOUT(col_debug_collection(col, COL_TRAVERSE_DEFAULT)); - - - COLOUT(printf("\n\n==== EXTRACTION TEST ====\n\n")); - - if ((error = col_create_collection(&col2, "extraction", 0)) || - - (error = col_extract_item(col, NULL, COL_DSP_FRONT, - NULL, 0, 0, &item)) || - - (error = col_insert_item(col2, NULL, item, COL_DSP_FRONT, - NULL, 0, COL_INSERT_NOCHECK)) || - - ((verbose) && (error = col_debug_collection(col2, COL_TRAVERSE_DEFAULT))) || - - (error = col_extract_item(col, NULL, COL_DSP_END, - NULL, 0, 0, &item)) || - - (error = col_insert_item(col2, NULL, item, COL_DSP_END, - NULL, 0, COL_INSERT_NOCHECK)) || - - ((verbose) && (error = col_debug_collection(col2, COL_TRAVERSE_DEFAULT))) || - - (error = col_insert_str_property(col, NULL, COL_DSP_INDEX, - NULL, 100, COL_INSERT_NOCHECK, - "property100", "value100", 0)) || - - (error = col_extract_item(col, NULL, COL_DSP_AFTER, - "property10", 0, COL_TYPE_STRING, &item)) || - - (error = col_insert_item(col2, NULL, item, COL_DSP_END, - NULL, 0, COL_INSERT_NOCHECK)) || - - ((verbose) && (error = col_debug_collection(col2, COL_TRAVERSE_DEFAULT))) || - - (error = col_extract_item(col, NULL, COL_DSP_BEFORE, - "property0", 0, COL_TYPE_STRING, &item)) || - - (error = col_insert_item(col2, NULL, item, COL_DSP_END, - NULL, 0, COL_INSERT_NOCHECK)) || - - ((verbose) && (error = col_debug_collection(col2, COL_TRAVERSE_DEFAULT))) || - - (error = col_extract_item(col, NULL, COL_DSP_INDEX, - NULL, 1, 0, &item)) || - - (error = col_insert_item(col2, NULL, item, COL_DSP_END, - NULL, 0, COL_INSERT_NOCHECK)) || - - ((verbose) && (error = col_debug_collection(col2, COL_TRAVERSE_DEFAULT))) || - - (error = col_extract_item(col, NULL, COL_DSP_NDUP, - "property0", 1, 0, &item)) || - - (error = col_insert_item(col2, NULL, item, COL_DSP_END, - NULL, 0, COL_INSERT_NOCHECK)) || - - ((verbose) && (error = col_debug_collection(col2, COL_TRAVERSE_DEFAULT))) || - - (error = col_extract_item(col, NULL, COL_DSP_LASTDUP, - "property0", 0, 0, &item)) || - - (error = col_insert_item(col2, NULL, item, COL_DSP_END, - NULL, 0, COL_INSERT_NOCHECK)) || - - ((verbose) && (error = col_debug_collection(col2, COL_TRAVERSE_DEFAULT))) || - - (error = col_extract_item(col, NULL, COL_DSP_FIRSTDUP, - "property0", 0, 0, &item)) || - - (error = col_insert_item(col2, NULL, item, COL_DSP_END, - NULL, 0, COL_INSERT_NOCHECK)) || - - ((verbose) && (error = col_debug_collection(col2, COL_TRAVERSE_DEFAULT)))) { - - COLOUT(printf("ERROR in the EXTRACTION TEST\n")); - COLOUT(printf("Collection 1\n")); - COLOUT(col_debug_collection(col, COL_TRAVERSE_DEFAULT)); - COLOUT(printf("Collection 2\n")); - COLOUT(col_debug_collection(col2, COL_TRAVERSE_DEFAULT)); - col_destroy_collection(col); - col_destroy_collection(col2); - return error; - } - - COLOUT(printf("Collection 1\n")); - COLOUT(col_debug_collection(col, COL_TRAVERSE_DEFAULT)); - COLOUT(printf("Collection 2\n")); - COLOUT(col_debug_collection(col2, COL_TRAVERSE_DEFAULT)); - - col_destroy_collection(col2); - col_destroy_collection(col); - - - return EOK; -} - -int delete_test(void) -{ - - struct collection_item *col; - int error = EOK; - - COLOUT(printf("\n\n==== DELETION TEST 1====\n\n")); - - if ((error = col_create_collection(&col, "test", 0)) || - (error = col_add_int_property(col, NULL, "tt", 1)) || - ((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) || - (error = col_add_int_property(col, NULL, "test", 1)) || - ((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) || - (error = col_delete_property(col, "test", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT)) || - ((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) || - (error = col_add_int_property(col, NULL, "test", 1)) || - ((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) || - (error = col_delete_property(col, "test", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT)) || - ((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) || - (error = col_add_int_property(col, NULL, "test", 1))) { - printf("Error in delete test %d\n", error); - col_destroy_collection(col); - return error; - } - - COLOUT(col_debug_collection(col, COL_TRAVERSE_DEFAULT)); - col_destroy_collection(col); - - COLOUT(printf("\n\n==== DELETION TEST 1 END ====\n\n")); - COLOUT(printf("\n\n==== DELETION TEST 2====\n\n")); - - if ((error = col_create_collection(&col, "test2", 0)) || - (error = col_add_int_property(col, NULL, "tt", 1)) || - ((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) || - (error = col_add_int_property(col, NULL, "test", 1)) || - ((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) || - (error = col_remove_item(col, NULL, COL_DSP_END, NULL, 0, COL_TYPE_ANY)) || - ((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) || - (error = col_add_int_property(col, NULL, "test", 1)) || - ((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) || - (error = col_remove_item_from_current(col, COL_DSP_AFTER, "tt", 0, COL_TYPE_ANY)) || - ((verbose) && (error = col_debug_collection(col, COL_TRAVERSE_DEFAULT))) || - (error = col_add_int_property(col, NULL, "test", 1))) { - printf("Error in delete test %d\n", error); - col_destroy_collection(col); - return error; - } - - COLOUT(col_debug_collection(col, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("\n\n==== DELETION TEST 2 END ====\n\n")); - - - col_destroy_collection(col); - - return error; -} - -/* Search test */ -int search_test(void) -{ - struct collection_item *level1 = NULL; - struct collection_item *level2 = NULL; - struct collection_item *level3 = NULL; - struct collection_item *level4 = NULL; - char binary_dump[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8 }; - int found = 0; - int error = 0; - - COLOUT(printf("\n\n==== SEARCH TEST ====\n\n")); - - if ((error = col_create_collection(&level1, "level1", 0)) || - (error = col_create_collection(&level2, "level2", 0)) || - (error = col_add_collection_to_collection(level1, NULL, NULL, level2, COL_ADD_MODE_REFERENCE)) || - (error = col_create_collection(&level3, "level3", 0)) || - (error = col_add_collection_to_collection(level1, "level2", NULL, level3, COL_ADD_MODE_REFERENCE)) || - (error = col_create_collection(&level4, "leveL4", 0)) || - (error = col_add_collection_to_collection(level1, "level3", NULL, level4, COL_ADD_MODE_REFERENCE)) || - (error = col_add_int_property(level1, "leveL4", "id", 1)) || - (error = col_add_long_property(level1, "level3", "packets", 100000000L)) || - (error = col_add_binary_property(level1, "level2", "stack", binary_dump, sizeof(binary_dump)))) { - col_destroy_collection(level1); - col_destroy_collection(level2); - col_destroy_collection(level3); - col_destroy_collection(level4); - printf("Failed to build test. Error %d\n", error); - return error; - } - - COLOUT(col_debug_collection(level1, COL_TRAVERSE_DEFAULT)); - - error = col_is_item_in_collection(level1, "level1!level2!level3!level4!", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT, &found); - if (!error) { - col_destroy_collection(level1); - col_destroy_collection(level2); - col_destroy_collection(level3); - col_destroy_collection(level4); - printf("Expected error here since the search data is illegal but got success\n"); - return EINVAL; - } - - found = 0; - error = 0; - error = col_is_item_in_collection(level1, "level1!level2!level3!level4!id", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT, &found); - if ((error) || (!found)) { - col_destroy_collection(level1); - col_destroy_collection(level2); - col_destroy_collection(level3); - col_destroy_collection(level4); - printf("Failed to find item [level1!level2!level3!level4!id]. Error %d\n", error); - return error ? error : ENOENT; - } - else COLOUT(printf("Expected item is found\n")); - - - found = 0; - error = 0; - error = col_is_item_in_collection(level1, "level3!level4!id", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT, &found); - if ((error) || (!found)) { - col_destroy_collection(level1); - col_destroy_collection(level2); - col_destroy_collection(level3); - col_destroy_collection(level4); - printf("Failed to find item [level3!level4!id]. Error %d\n", error); - return error ? error : ENOENT; - } - else COLOUT(printf("Expected item is found\n")); - - found = 0; - error = 0; - error = col_is_item_in_collection(level1, "level3!packets", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT, &found); - if ((error) || (!found)) { - col_destroy_collection(level1); - col_destroy_collection(level2); - col_destroy_collection(level3); - col_destroy_collection(level4); - printf("Failed to find item [level3.packets]. Error %d\n", error); - return error ? error : ENOENT; - } - else COLOUT(printf("Expected item is found\n")); - - found = 0; - error = 0; - error = col_is_item_in_collection(level1, "level1!level2!stack", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT, &found); - if ((error) || (!found)) { - col_destroy_collection(level1); - col_destroy_collection(level2); - col_destroy_collection(level3); - col_destroy_collection(level4); - printf("Failed to find item [level1!level2!stack]. Error %d\n", error); - return error ? error : ENOENT; - } - else COLOUT(printf("Expected item is found\n")); - - found = 0; - error = 0; - error = col_is_item_in_collection(level1, "level1!level2!level3", COL_TYPE_ANY, COL_TRAVERSE_DEFAULT, &found); - if ((error) || (!found)) { - col_destroy_collection(level1); - col_destroy_collection(level2); - col_destroy_collection(level3); - col_destroy_collection(level4); - printf("Failed to find item [level1!level2!level3]. Error %d\n", error); - return error ? error : ENOENT; - } - else COLOUT(printf("Expected item is found\n")); - - col_destroy_collection(level1); - col_destroy_collection(level2); - col_destroy_collection(level3); - col_destroy_collection(level4); - - COLOUT(printf("\n\n==== SEARCH TEST END ====\n\n")); - - return EOK; -} - -/* Sort test */ -int sort_test(void) -{ - struct collection_item *level1 = NULL; - struct collection_item *level2a = NULL; - struct collection_item *level2b = NULL; - struct collection_item *level3 = NULL; - int error = 0; - - COLOUT(printf("\n\n==== SORT TEST ====\n\n")); - - if ((error = col_create_collection(&level1, "level1", 0)) || - (error = col_create_collection(&level2a, "level2a", 0)) || - (error = col_add_collection_to_collection(level1, NULL, NULL, level2a, COL_ADD_MODE_REFERENCE)) || - (error = col_create_collection(&level2b, "level2b", 0)) || - (error = col_add_collection_to_collection(level1, NULL, NULL, level2b, COL_ADD_MODE_REFERENCE)) || - (error = col_create_collection(&level3, "level3", 0)) || - (error = col_add_collection_to_collection(level1, "level2a", NULL, level3, COL_ADD_MODE_REFERENCE)) || - (error = col_add_collection_to_collection(level1, "level2b", NULL, level3, COL_ADD_MODE_REFERENCE)) || - (error = col_add_int_property(level1, NULL, "int3", 1)) || - (error = col_add_int_property(level1, NULL, "int2", 2)) || - (error = col_add_int_property(level1, NULL, "int1", 3)) || - (error = col_add_bool_property(level1, NULL, "bool3", 1)) || - (error = col_add_bool_property(level1, NULL, "bool2", 1)) || - (error = col_add_bool_property(level1, NULL, "bool1", 0)) || - (error = col_add_unsigned_property(level1, NULL, "unsigned1", 2)) || - (error = col_add_unsigned_property(level1, NULL, "unsigned3", 1)) || - (error = col_add_unsigned_property(level1, NULL, "unsigned2", 3)) || - (error = col_add_long_property(level1, NULL, "long3", 1)) || - (error = col_add_long_property(level1, NULL, "long2", 2)) || - (error = col_add_long_property(level1, NULL, "long1", 3)) || - (error = col_add_ulong_property(level1, NULL, "ulong1", 2)) || - (error = col_add_ulong_property(level1, NULL, "ulong3", 1)) || - (error = col_add_ulong_property(level1, NULL, "ulong2", 3)) || - (error = col_add_double_property(level1, NULL, "double1", 2.2)) || - (error = col_add_double_property(level1, NULL, "double3", 1.1)) || - (error = col_add_double_property(level1, NULL, "double2", 3.3)) || - (error = col_add_int_property(level3, NULL, "int3L3", 1)) || - (error = col_add_int_property(level3, NULL, "int2L3", 2)) || - (error = col_add_int_property(level3, NULL, "int1L3", 3)) || - (error = col_add_unsigned_property(level1, "level2a!level3", "unsigned1L3", 2)) || - (error = col_add_unsigned_property(level1, "level2a!level3", "unsigned3L3", 1)) || - (error = col_add_unsigned_property(level1, "level2a!level3", "unsigned2L3", 3)) || - (error = col_add_long_property(level1, "level2b!level3", "long3L3", 1)) || - (error = col_add_long_property(level1, "level2b!level3", "long2L3", 2)) || - (error = col_add_long_property(level1, "level2b!level3", "long1L3", 3)) || - (error = col_add_ulong_property(level1, "level3", "ulong1L3", 2)) || - (error = col_add_ulong_property(level1, "level3", "ulong3L3", 1)) || - (error = col_add_ulong_property(level1, "level3", "ulong2L3", 3)) || - (error = col_add_bool_property(level3, NULL, "bool3", 1)) || - (error = col_add_bool_property(level3, NULL, "bool2", 1)) || - (error = col_add_bool_property(level3, NULL, "bool1", 0)) || - (error = col_add_double_property(level3, NULL, "double1L3", 2.2)) || - (error = col_add_double_property(level3, NULL, "double3L3", 1.1)) || - (error = col_add_double_property(level3, NULL, "double2L3", 3.3))) { - col_destroy_collection(level1); - col_destroy_collection(level2a); - col_destroy_collection(level2b); - col_destroy_collection(level3); - printf("Failed to build test. Error %d\n", error); - return error; - } - - COLOUT(printf("\nUNSORTED COLLECTION\n\n")); - COLOUT(col_debug_collection(level1, COL_TRAVERSE_DEFAULT)); - - error = col_sort_collection(level1, COL_CMPIN_PROP_EQU, COL_SORT_SUB | COL_SORT_MYSUB); - if (error) { - col_destroy_collection(level1); - col_destroy_collection(level2a); - col_destroy_collection(level2b); - col_destroy_collection(level3); - printf("Failed sort. Error %d\n", error); - return error; - } - - COLOUT(printf("\nSORTED BUT SKIPPING REFERENCES\n\n")); - COLOUT(col_debug_collection(level1, COL_TRAVERSE_DEFAULT)); - - error = col_sort_collection(level1, COL_CMPIN_PROP_EQU, COL_SORT_SUB); - if (error) { - col_destroy_collection(level1); - col_destroy_collection(level2a); - col_destroy_collection(level2b); - col_destroy_collection(level3); - printf("Failed sort. Error %d\n", error); - return error; - } - - COLOUT(printf("\nSORTED BUT NOT SKIPPING REFERENCES\n\n")); - COLOUT(col_debug_collection(level1, COL_TRAVERSE_DEFAULT)); - - error = col_sort_collection(level1, COL_CMPIN_DATA_LEN, COL_SORT_SUB | COL_SORT_DESC); - if (error) { - col_destroy_collection(level1); - col_destroy_collection(level2a); - col_destroy_collection(level2b); - col_destroy_collection(level3); - printf("Failed sort. Error %d\n", error); - return error; - } - - COLOUT(printf("\nSORTED DESC NOT SKIPPING BY LENGTH OF DATA\n\n")); - COLOUT(col_debug_collection(level1, COL_TRAVERSE_DEFAULT)); - - error = col_sort_collection(level1, COL_CMPIN_PROP_LEN, COL_SORT_SUB | COL_SORT_DESC); - if (error) { - col_destroy_collection(level1); - col_destroy_collection(level2a); - col_destroy_collection(level2b); - col_destroy_collection(level3); - printf("Failed sort. Error %d\n", error); - return error; - } - - COLOUT(printf("\nSORTED DESC NOT SKIPPING BY LENGTH OF PROPERTY\n\n")); - COLOUT(col_debug_collection(level1, COL_TRAVERSE_DEFAULT)); - - error = col_sort_collection(level1, COL_CMPIN_DATA, COL_SORT_SUB | COL_SORT_DESC); - if (error) { - col_destroy_collection(level1); - col_destroy_collection(level2a); - col_destroy_collection(level2b); - col_destroy_collection(level3); - printf("Failed sort. Error %d\n", error); - return error; - } - - COLOUT(printf("\nSORTED DESC NOT SKIPPING BY DATA\n\n")); - COLOUT(col_debug_collection(level1, COL_TRAVERSE_DEFAULT)); - - col_destroy_collection(level1); - col_destroy_collection(level2a); - col_destroy_collection(level2b); - col_destroy_collection(level3); - - COLOUT(printf("\n\n==== SORT TEST END ====\n\n")); - - return EOK; -} - -/* Main function of the unit test */ - -int main(int argc, char *argv[]) -{ - int error = 0; - test_fn tests[] = { ref_collection_test, - single_collection_test, - add_collection_test, - mixed_collection_test, - iterator_test, - insert_extract_test, - delete_test, - search_test, - sort_test, - NULL }; - test_fn t; - int i = 0; - - if ((argc > 1) && (strcmp(argv[1], "-v") == 0)) verbose = 1; - - printf("Start\n"); - - while ((t = tests[i++])) { - error = t(); - if (error) { - printf("Failed!\n"); - return error; - } - } - - printf("Success!\n"); - return 0; - -} diff --git a/common/collection/configure.ac b/common/collection/configure.ac deleted file mode 100644 index 02c0ab4c3..000000000 --- a/common/collection/configure.ac +++ /dev/null @@ -1,42 +0,0 @@ -AC_INIT([collection], - [0.5.0], - [sssd-devel@lists.fedorahosted.org]) -AC_CONFIG_SRCDIR([collection.c]) -AC_CONFIG_AUX_DIR([build]) -AM_INIT_AUTOMAKE([-Wall -Werror foreign]) -AC_PROG_CC -AC_PROG_LIBTOOL -AC_CONFIG_MACRO_DIR([m4]) -AC_PROG_INSTALL - -AM_CONDITIONAL([HAVE_GCC], [test "$ac_cv_prog_gcc" = yes]) - -m4_pattern_allow([AM_SILENT_RULES]) -AM_SILENT_RULES - -AC_CONFIG_HEADERS([config.h]) - -# Enable trace build -AC_ARG_ENABLE([trace], - [AS_HELP_STRING([--enable-trace[=LEVEL]],[build with low level tracing enabled])], - [trace_level="$enableval"], - [trace_level="0"]) -AS_IF([test ["$trace_level" -gt "0"] -a ["$trace_level" -lt "8"] ],[AC_SUBST([TRACE_VAR],["-DTRACE_LEVEL=$trace_level"])]) - -AC_CHECK_SIZEOF([long]) -AC_CHECK_SIZEOF([long long]) - -AC_CHECK_FUNC([strcasestr], - AC_DEFINE([HAVE_STRCASESTR], - [1], - [Define if strcasestr exists]), - AC_MSG_ERROR("Platform must support strcasestr")) - -AC_DEFINE([COL_MAX_DATA], [65535], [Max length of the data block allowed in the collection value.]) - -AC_PATH_PROG([DOXYGEN], [doxygen], [false]) -AM_CONDITIONAL([HAVE_DOXYGEN], [test x$DOXYGEN != xfalse ]) - - -AC_CONFIG_FILES([Makefile collection.cfg.doxy collection.pc]) -AC_OUTPUT diff --git a/common/collection/m4/.dir b/common/collection/m4/.dir deleted file mode 100644 index e69de29bb..000000000 --- a/common/collection/m4/.dir +++ /dev/null diff --git a/common/configure.ac b/common/configure.ac deleted file mode 100644 index 3bee4ae62..000000000 --- a/common/configure.ac +++ /dev/null @@ -1,42 +0,0 @@ -m4_include([../version.m4]) -AC_INIT([sssd_libs], - VERSION_NUMBER, - [sssd-devel@lists.fedorahosted.org]) -AC_CONFIG_SRCDIR([README]) -AC_CONFIG_AUX_DIR([build]) -AM_INIT_AUTOMAKE([-Wall -Werror foreign]) -AC_PROG_CC -AC_PROG_LIBTOOL -AC_CONFIG_MACRO_DIR([m4]) -AC_PROG_INSTALL - -AC_CONFIG_HEADERS([config.h]) - - -# Enable trace build -AC_ARG_ENABLE([trace], - [AS_HELP_STRING([--enable-trace[=LEVEL]],[build with low level tracing enabled])], - [trace_level="$enableval"], - [trace_level="0"]) -AS_IF([test ["$trace_level" -gt "0"] -a ["$trace_level" -lt "8"] ],[AC_SUBST([TRACE_VAR],["-DTRACE_LEVEL=$trace_level"])]) - - -AC_CONFIG_FILES([Makefile - trace/Makefile]) - -AC_CONFIG_SUBDIRS([dhash path_utils refarray collection ini]) - -AC_DEFUN([WITH_SINGLELIB], - [ AC_ARG_WITH([singlelib], - [AC_HELP_STRING([--with-singlelib], - [Whether to build a shared object containing all sssd_utils [no]] - ) - ], - [], - with_singlelib=yes - ) - ]) - -AM_CONDITIONAL([SINGLELIB], [test x$with_singlelib = xyes ]) - -AC_OUTPUT diff --git a/common/dhash/COPYING b/common/dhash/COPYING deleted file mode 100644 index 94a9ed024..000000000 --- a/common/dhash/COPYING +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - <one line to give the program's name and a brief idea of what it does.> - Copyright (C) <year> <name of author> - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see <http://www.gnu.org/licenses/>. - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - <program> Copyright (C) <year> <name of author> - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -<http://www.gnu.org/licenses/>. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/common/dhash/COPYING.LESSER b/common/dhash/COPYING.LESSER deleted file mode 100644 index 755013bb2..000000000 --- a/common/dhash/COPYING.LESSER +++ /dev/null @@ -1,165 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - - This version of the GNU Lesser General Public License incorporates -the terms and conditions of version 3 of the GNU General Public -License, supplemented by the additional permissions listed below. - - 0. Additional Definitions. - - As used herein, "this License" refers to version 3 of the GNU Lesser -General Public License, and the "GNU GPL" refers to version 3 of the GNU -General Public License. - - "The Library" refers to a covered work governed by this License, -other than an Application or a Combined Work as defined below. - - An "Application" is any work that makes use of an interface provided -by the Library, but which is not otherwise based on the Library. -Defining a subclass of a class defined by the Library is deemed a mode -of using an interface provided by the Library. - - A "Combined Work" is a work produced by combining or linking an -Application with the Library. The particular version of the Library -with which the Combined Work was made is also called the "Linked -Version". - - The "Minimal Corresponding Source" for a Combined Work means the -Corresponding Source for the Combined Work, excluding any source code -for portions of the Combined Work that, considered in isolation, are -based on the Application, and not on the Linked Version. - - The "Corresponding Application Code" for a Combined Work means the -object code and/or source code for the Application, including any data -and utility programs needed for reproducing the Combined Work from the -Application, but excluding the System Libraries of the Combined Work. - - 1. Exception to Section 3 of the GNU GPL. - - You may convey a covered work under sections 3 and 4 of this License -without being bound by section 3 of the GNU GPL. - - 2. Conveying Modified Versions. - - If you modify a copy of the Library, and, in your modifications, a -facility refers to a function or data to be supplied by an Application -that uses the facility (other than as an argument passed when the -facility is invoked), then you may convey a copy of the modified -version: - - a) under this License, provided that you make a good faith effort to - ensure that, in the event an Application does not supply the - function or data, the facility still operates, and performs - whatever part of its purpose remains meaningful, or - - b) under the GNU GPL, with none of the additional permissions of - this License applicable to that copy. - - 3. Object Code Incorporating Material from Library Header Files. - - The object code form of an Application may incorporate material from -a header file that is part of the Library. You may convey such object -code under terms of your choice, provided that, if the incorporated -material is not limited to numerical parameters, data structure -layouts and accessors, or small macros, inline functions and templates -(ten or fewer lines in length), you do both of the following: - - a) Give prominent notice with each copy of the object code that the - Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the object code with a copy of the GNU GPL and this license - document. - - 4. Combined Works. - - You may convey a Combined Work under terms of your choice that, -taken together, effectively do not restrict modification of the -portions of the Library contained in the Combined Work and reverse -engineering for debugging such modifications, if you also do each of -the following: - - a) Give prominent notice with each copy of the Combined Work that - the Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the Combined Work with a copy of the GNU GPL and this license - document. - - c) For a Combined Work that displays copyright notices during - execution, include the copyright notice for the Library among - these notices, as well as a reference directing the user to the - copies of the GNU GPL and this license document. - - d) Do one of the following: - - 0) Convey the Minimal Corresponding Source under the terms of this - License, and the Corresponding Application Code in a form - suitable for, and under terms that permit, the user to - recombine or relink the Application with a modified version of - the Linked Version to produce a modified Combined Work, in the - manner specified by section 6 of the GNU GPL for conveying - Corresponding Source. - - 1) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (a) uses at run time - a copy of the Library already present on the user's computer - system, and (b) will operate properly with a modified version - of the Library that is interface-compatible with the Linked - Version. - - e) Provide Installation Information, but only if you would otherwise - be required to provide such information under section 6 of the - GNU GPL, and only to the extent that such information is - necessary to install and execute a modified version of the - Combined Work produced by recombining or relinking the - Application with a modified version of the Linked Version. (If - you use option 4d0, the Installation Information must accompany - the Minimal Corresponding Source and Corresponding Application - Code. If you use option 4d1, you must provide the Installation - Information in the manner specified by section 6 of the GNU GPL - for conveying Corresponding Source.) - - 5. Combined Libraries. - - You may place library facilities that are a work based on the -Library side by side in a single library together with other library -facilities that are not Applications and are not covered by this -License, and convey such a combined library under terms of your -choice, if you do both of the following: - - a) Accompany the combined library with a copy of the same work based - on the Library, uncombined with any other library facilities, - conveyed under the terms of this License. - - b) Give prominent notice with the combined library that part of it - is a work based on the Library, and explaining where to find the - accompanying uncombined form of the same work. - - 6. Revised Versions of the GNU Lesser General Public License. - - The Free Software Foundation may publish revised and/or new versions -of the GNU Lesser 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 -Library as you received it specifies that a certain numbered version -of the GNU Lesser General Public License "or any later version" -applies to it, you have the option of following the terms and -conditions either of that published version or of any later version -published by the Free Software Foundation. If the Library as you -received it does not specify a version number of the GNU Lesser -General Public License, you may choose any version of the GNU Lesser -General Public License ever published by the Free Software Foundation. - - If the Library as you received it specifies that a proxy can decide -whether future versions of the GNU Lesser General Public License shall -apply, that proxy's public statement of acceptance of any version is -permanent authorization for you to choose that version for the -Library. diff --git a/common/dhash/Makefile.am b/common/dhash/Makefile.am deleted file mode 100644 index d5a561871..000000000 --- a/common/dhash/Makefile.am +++ /dev/null @@ -1,35 +0,0 @@ -AM_CFLAGS = -if HAVE_GCC - AM_CFLAGS += \ - -Wall -Wshadow -Wstrict-prototypes -Wpointer-arith -Wcast-qual \ - -Wcast-align -Wwrite-strings -endif - -ACLOCAL_AMFLAGS = -I m4 - -pkgconfigdir = $(libdir)/pkgconfig -dist_pkgconfig_DATA = dhash.pc - -dist_noinst_DATA = m4 - -dist_include_HEADERS = dhash.h - -lib_LTLIBRARIES = libdhash.la -libdhash_la_SOURCES = dhash.c -libdhash_la_LDFLAGS = \ - -version-info 1:0:0 - -check_PROGRAMS = dhash_test dhash_example -TESTS = $(check_PROGRAMS) - -dhash_test_SOURCES = examples/dhash_test.c -dhash_test_LDADD = dhash.o - -dhash_example_SOURCES = examples/dhash_example.c -dhash_example_LDADD = dhash.o - -examplesdir = $(docdir)/examples -dist_examples_DATA = examples/dhash_test.c examples/dhash_example.c -dist_doc_DATA = README - -tests: all $(check_PROGRAMS) diff --git a/common/dhash/README b/common/dhash/README deleted file mode 100644 index bee5024ee..000000000 --- a/common/dhash/README +++ /dev/null @@ -1 +0,0 @@ -Documentation for libdhash can be found in dhash.h diff --git a/common/dhash/configure.ac b/common/dhash/configure.ac deleted file mode 100644 index bf06cfc5a..000000000 --- a/common/dhash/configure.ac +++ /dev/null @@ -1,31 +0,0 @@ -AC_INIT([dhash], [0.4.0], [jdennis@redhat.com]) -AC_CONFIG_SRCDIR([dhash.c]) -AC_CONFIG_AUX_DIR([build]) -AM_INIT_AUTOMAKE([-Wall -Werror foreign]) -AC_PROG_CC -AC_PROG_LIBTOOL -AC_CONFIG_MACRO_DIR([m4]) -AC_PROG_INSTALL - -AM_CONDITIONAL([HAVE_GCC], [test "$ac_cv_prog_gcc" = yes]) - -m4_pattern_allow([AM_SILENT_RULES]) -AM_SILENT_RULES - -AC_CONFIG_HEADERS([config.h]) - -# Enable trace build -AC_ARG_ENABLE([trace], - [AS_HELP_STRING([--enable-trace[=LEVEL]],[build with low level tracing enabled])], - [trace_level="$enableval"], - [trace_level="0"]) -AS_IF([test ["$trace_level" -gt "0"] -a ["$trace_level" -lt "8"] ],[AC_SUBST([TRACE_VAR],["-DTRACE_LEVEL=$trace_level"])]) - -#Support old versions of autotools that don't provide docdir -AC_SUBST([docdir]) -if test x$docdir = x; then - AC_SUBST([docdir], ${datadir}/doc/AC_PACKAGE_NAME) -fi - -AC_CONFIG_FILES([Makefile dhash.pc]) -AC_OUTPUT diff --git a/common/dhash/dhash.c b/common/dhash/dhash.c deleted file mode 100644 index cb292b7be..000000000 --- a/common/dhash/dhash.c +++ /dev/null @@ -1,993 +0,0 @@ -/* - Authors: - John Dennis <jdennis.redhat.com> - Esmond Pitt <ejp@ausmelb.oz.AU> - - This implementation was based on a 3/7/1989 public domain submission - to comp.sources.misc by Esmond Pitt <ejp@ausmelb.oz.AU>. - - Copyright (C) 2009 Red Hat - - This program 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. - - 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 Lesser General Public License for more 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/>. -*/ - -/*****************************************************************************/ -/******************************** Documentation ******************************/ -/*****************************************************************************/ - -/* - * See documentation in corresponding header file dhash.h. - * - * Compilation controls: - * DEBUG controls some informative traces, mainly for debugging. - * HASH_STATISTICS causes hash_accesses and hash_collisions to be maintained; - * when combined with DEBUG, these are displayed by hash_destroy(). - * - */ - -/*****************************************************************************/ -/******************************* Include Files *******************************/ -/*****************************************************************************/ - -#include <stdio.h> -#include <string.h> -#include <stdlib.h> -#include <errno.h> -#include "dhash.h" - -/*****************************************************************************/ -/****************************** Internal Defines *****************************/ -/*****************************************************************************/ - -#define PRIME_1 37 -#define PRIME_2 1048583 - - /* - * Fast arithmetic, relying on powers of 2, and on pre-processor - * concatenation property - */ - -#define halloc(table, size) table->halloc(size, table->halloc_pvt) -#define hfree(table, ptr) table->hfree(ptr, table->halloc_pvt) -#define hdelete_callback(table, type, entry) do { \ - if (table->delete_callback) { \ - table->delete_callback(entry, type, table->delete_pvt); \ - } \ -} while(0) - -/*****************************************************************************/ -/************************** Internal Type Definitions ************************/ -/*****************************************************************************/ - -typedef struct element_t { - hash_entry_t entry; - struct element_t *next; -} element_t, *segment_t; - - -struct hash_table_str { - unsigned long p; /* Next bucket to be split */ - unsigned long maxp; /* upper bound on p during expansion */ - unsigned long entry_count; /* current # entries */ - unsigned long bucket_count; /* current # buckets */ - unsigned long segment_count; /* current # segments */ - unsigned long min_load_factor; - unsigned long max_load_factor; - unsigned long directory_size; - unsigned int directory_size_shift; - unsigned long segment_size; - unsigned int segment_size_shift; - hash_delete_callback *delete_callback; - void *delete_pvt; - hash_alloc_func *halloc; - hash_free_func *hfree; - void *halloc_pvt; - segment_t **directory; -#ifdef HASH_STATISTICS - hash_statistics_t statistics; -#endif - -}; - -typedef unsigned long address_t; - -typedef struct hash_keys_callback_data_t { - unsigned long index; - hash_key_t *keys; -} hash_keys_callback_data_t; - -typedef struct hash_values_callback_data_t { - unsigned long index; - hash_value_t *values; -} hash_values_callback_data_t; - -struct _hash_iter_context_t { - struct hash_iter_context_t iter; - hash_table_t *table; - unsigned long i, j; - segment_t *s; - element_t *p; -}; - -/*****************************************************************************/ -/********************** External Function Declarations *********************/ -/*****************************************************************************/ - -/*****************************************************************************/ -/********************** Internal Function Declarations *********************/ -/*****************************************************************************/ - -static address_t convert_key(hash_key_t *key); -static address_t hash(hash_table_t *table, hash_key_t *key); -static bool key_equal(hash_key_t *a, hash_key_t *b); -static int contract_table(hash_table_t *table); -static int expand_table(hash_table_t *table); -static hash_entry_t *hash_iter_next(struct hash_iter_context_t *iter); - -/*****************************************************************************/ -/************************* External Global Variables ***********************/ -/*****************************************************************************/ - -/*****************************************************************************/ -/************************* Internal Global Variables ***********************/ -/*****************************************************************************/ - -#if DEBUG -int debug_level = 1; -#endif - -/*****************************************************************************/ -/*************************** Internal Functions ****************************/ -/*****************************************************************************/ - -static void *sys_malloc_wrapper(size_t size, void *pvt) -{ - return malloc(size); -} - -static void sys_free_wrapper(void *ptr, void *pvt) -{ - return free(ptr); -} - -static address_t convert_key(hash_key_t *key) -{ - address_t h; - unsigned char *k; - - switch(key->type) { - case HASH_KEY_ULONG: - h = key->ul; - break; - case HASH_KEY_STRING: - /* Convert string to integer */ - for (h = 0, k = (unsigned char *) key->str; *k; k++) - h = h * PRIME_1 ^ (*k - ' '); - break; - default: - h = key->ul; - break; - } - return h; -} - -static address_t hash(hash_table_t *table, hash_key_t *key) -{ - address_t h, address; - - h = convert_key(key); - h %= PRIME_2; - address = h & (table->maxp-1); /* h % maxp */ - if (address < table->p) - address = h & ((table->maxp << 1)-1); /* h % (2*table->maxp) */ - - return address; -} - -static bool is_valid_key_type(hash_key_enum key_type) -{ - switch(key_type) { - case HASH_KEY_ULONG: - case HASH_KEY_STRING: - return true; - default: - return false; - } -} - -static bool is_valid_value_type(hash_value_enum value_type) -{ - switch(value_type) { - case HASH_VALUE_UNDEF: - case HASH_VALUE_PTR: - case HASH_VALUE_INT: - case HASH_VALUE_UINT: - case HASH_VALUE_LONG: - case HASH_VALUE_ULONG: - case HASH_VALUE_FLOAT: - case HASH_VALUE_DOUBLE: - return true; - default: - return false; - } -} - -static bool key_equal(hash_key_t *a, hash_key_t *b) -{ - if (a->type != b->type) return false; - - switch(a->type) { - case HASH_KEY_ULONG: - return (a->ul == b->ul); - case HASH_KEY_STRING: - return (strcmp(a->str, b->str) == 0); - } - return false; -} - - -static int expand_table(hash_table_t *table) -{ - address_t new_address; - unsigned long old_segment_index, new_segment_index; - unsigned long old_segment_dir, new_segment_dir; - segment_t *old_segment, *new_segment; - element_t *current, **previous, **last_of_new; - - if (table->bucket_count < (table->directory_size << table->segment_size_shift)) { -#ifdef DEBUG - if (debug_level >= 1) - fprintf(stderr, "expand_table on entry: bucket_count=%lu, segment_count=%lu p=%lu maxp=%lu\n", - table->bucket_count, table->segment_count, table->p, table->maxp); -#endif -#ifdef HASH_STATISTICS - table->statistics.table_expansions++; -#endif - - /* - * Locate the bucket to be split - */ - old_segment_dir = table->p >> table->segment_size_shift; - old_segment = table->directory[old_segment_dir]; - old_segment_index = table->p & (table->segment_size-1); /* p % segment_size */ - /* - * Expand address space; if necessary create a new segment - */ - new_address = table->maxp + table->p; - new_segment_dir = new_address >> table->segment_size_shift; - new_segment_index = new_address & (table->segment_size-1); /* new_address % segment_size */ - if (new_segment_index == 0) { - table->directory[new_segment_dir] = (segment_t *)halloc(table, table->segment_size * sizeof(segment_t)); - if (table->directory[new_segment_dir] == NULL) { - return HASH_ERROR_NO_MEMORY; - } - memset(table->directory[new_segment_dir], 0, table->segment_size * sizeof(segment_t)); - table->segment_count++; - } - new_segment = table->directory[new_segment_dir]; - /* - * Adjust state variables - */ - table->p++; - if (table->p == table->maxp) { - table->maxp <<= 1; /* table->maxp *= 2 */ - table->p = 0; - } - table->bucket_count++; - /* - * Relocate records to the new bucket - */ - previous = &old_segment[old_segment_index]; - current = *previous; - last_of_new = &new_segment[new_segment_index]; - *last_of_new = NULL; - while (current != NULL) { - if (hash(table, ¤t->entry.key) == new_address) { - /* - * Attach it to the end of the new chain - */ - *last_of_new = current; - /* - * Remove it from old chain - */ - *previous = current->next; - last_of_new = ¤t->next; - current = current->next; - *last_of_new = NULL; - } else { - /* - * leave it on the old chain - */ - previous = ¤t->next; - current = current->next; - } - } -#ifdef DEBUG - if (debug_level >= 1) - fprintf(stderr, "expand_table on exit: bucket_count=%lu, segment_count=%lu p=%lu maxp=%lu\n", - table->bucket_count, table->segment_count, table->p, table->maxp); -#endif - } - return HASH_SUCCESS; -} - -static int contract_table(hash_table_t *table) -{ - address_t new_address, old_address; - unsigned long old_segment_index, new_segment_index; - unsigned long old_segment_dir, new_segment_dir; - segment_t *old_segment, *new_segment; - element_t *current; - - if (table->bucket_count > table->segment_size) { -#ifdef DEBUG - if (debug_level >= 1) - fprintf(stderr, "contract_table on entry: bucket_count=%lu, segment_count=%lu p=%lu maxp=%lu\n", - table->bucket_count, table->segment_count, table->p, table->maxp); -#endif - -#ifdef HASH_STATISTICS - table->statistics.table_contractions++; -#endif - /* - * Locate the bucket to be merged with the last bucket - */ - old_address = table->bucket_count - 1; - old_segment_dir = old_address >> table->segment_size_shift; - old_segment = table->directory[old_segment_dir]; - old_segment_index = old_address & (table->segment_size-1); /* old_address % segment_size */ - - /* - * Adjust state variables - */ - if (table->p > 0) { - table->p--; - } else { - table->maxp >>= 1; - table->p = table->maxp - 1; - } - table->bucket_count--; - - /* - * Find the last bucket to merge back - */ - if((current = old_segment[old_segment_index]) != NULL) { - new_address = hash(table, &old_segment[old_segment_index]->entry.key); - new_segment_dir = new_address >> table->segment_size_shift; - new_segment_index = new_address & (table->segment_size-1); /* new_address % segment_size */ - new_segment = table->directory[new_segment_dir]; - - /* - * Relocate records to the new bucket by splicing the two chains - * together by inserting the old chain at the head of the new chain. - * First find the end of the old chain, then set its next pointer to - * point to the head of the new chain, set the head of the new chain to - * point to the old chain, then finally set the head of the old chain to - * NULL. - */ - - while (current->next != NULL) { - current = current->next; - } - - current->next = new_segment[new_segment_index]; - new_segment[new_segment_index] = old_segment[old_segment_index]; - old_segment[old_segment_index] = NULL; - } - /* - * If we have removed the last of the chains in this segment then free the - * segment since its no longer in use. - */ - if (old_segment_index == 0) { - table->segment_count--; - hfree(table, table->directory[old_segment_dir]); - } - -#ifdef DEBUG - if (debug_level >= 1) - fprintf(stderr, "contract_table on exit: bucket_count=%lu, segment_count=%lu p=%lu maxp=%lu\n", - table->bucket_count, table->segment_count, table->p, table->maxp); -#endif - - } - return HASH_SUCCESS; -} - -static int lookup(hash_table_t *table, hash_key_t *key, element_t **element_arg, segment_t **chain_arg) -{ - address_t h; - segment_t *current_segment; - unsigned long segment_index, segment_dir; - segment_t *chain, element; - - *element_arg = NULL; - *chain_arg = NULL; - - if (!table) return HASH_ERROR_BAD_TABLE; - -#ifdef HASH_STATISTICS - table->statistics.hash_accesses++; -#endif - h = hash(table, key); - segment_dir = h >> table->segment_size_shift; - segment_index = h & (table->segment_size-1); /* h % segment_size */ - /* - * valid segment ensured by hash() - */ - current_segment = table->directory[segment_dir]; - -#ifdef DEBUG - if (debug_level >= 2) - fprintf(stderr, "lookup: h=%lu, segment_dir=%lu, segment_index=%lu current_segment=%p\n", - h, segment_dir, segment_index, current_segment); -#endif - - if (current_segment == NULL) return EFAULT; - chain = ¤t_segment[segment_index]; - element = *chain; - /* - * Follow collision chain - */ - while (element != NULL && !key_equal(&element->entry.key, key)) { - chain = &element->next; - element = *chain; -#ifdef HASH_STATISTICS - table->statistics.hash_collisions++; -#endif - } - *element_arg = element; - *chain_arg = chain; - - return HASH_SUCCESS; -} - -static bool hash_keys_callback(hash_entry_t *item, void *user_data) -{ - hash_keys_callback_data_t *data = (hash_keys_callback_data_t *)user_data; - - data->keys[data->index++] = item->key; - return true; -} - -static bool hash_values_callback(hash_entry_t *item, void *user_data) -{ - hash_values_callback_data_t *data = (hash_values_callback_data_t *)user_data; - - data->values[data->index++] = item->value; - return true; -} - -/*****************************************************************************/ -/**************************** Exported Functions ***************************/ -/*****************************************************************************/ - -const char* hash_error_string(int error) -{ - switch(error) { - case HASH_SUCCESS: return "Success"; - case HASH_ERROR_BAD_KEY_TYPE: return "Bad key type"; - case HASH_ERROR_BAD_VALUE_TYPE: return "Bad value type"; - case HASH_ERROR_NO_MEMORY: return "No memory"; - case HASH_ERROR_KEY_NOT_FOUND: return "Key not found"; - case HASH_ERROR_BAD_TABLE: return "Bad table"; - } - return NULL; -} - - -int hash_create(unsigned long count, hash_table_t **tbl, - hash_delete_callback *delete_callback, - void *delete_private_data) -{ - return hash_create_ex(count, tbl, 0, 0, 0, 0, - NULL, NULL, NULL, - delete_callback, - delete_private_data); -} - -int hash_create_ex(unsigned long count, hash_table_t **tbl, - unsigned int directory_bits, - unsigned int segment_bits, - unsigned long min_load_factor, - unsigned long max_load_factor, - hash_alloc_func *alloc_func, - hash_free_func *free_func, - void *alloc_private_data, - hash_delete_callback *delete_callback, - void *delete_private_data) -{ - unsigned long i; - unsigned int n_addr_bits; - address_t addr; - hash_table_t *table = NULL; - - if (alloc_func == NULL) alloc_func = sys_malloc_wrapper; - if (free_func == NULL) free_func = sys_free_wrapper; - - /* Compute directory and segment parameters */ - if (directory_bits == 0) directory_bits = HASH_DEFAULT_DIRECTORY_BITS; - if (segment_bits == 0) segment_bits = HASH_DEFAULT_SEGMENT_BITS; - - for (addr = ~0, n_addr_bits = 0; addr; addr >>= 1, n_addr_bits++); - - if (directory_bits + segment_bits > n_addr_bits) return EINVAL; - - table = (hash_table_t *)alloc_func(sizeof(hash_table_t), - alloc_private_data); - if (table == NULL) { - return HASH_ERROR_NO_MEMORY; - } - memset(table, 0, sizeof(hash_table_t)); - table->halloc = alloc_func; - table->hfree = free_func; - table->halloc_pvt = alloc_private_data; - - table->directory_size_shift = directory_bits; - for (i = 0, table->directory_size = 1; i < table->directory_size_shift; i++, table->directory_size <<= 1); - - table->segment_size_shift = segment_bits; - for (i = 0, table->segment_size = 1; i < table->segment_size_shift; i++, table->segment_size <<= 1); - - - /* Allocate directory */ - table->directory = (segment_t **)halloc(table, table->directory_size * sizeof(segment_t *)); - if (table->directory == NULL) { - return HASH_ERROR_NO_MEMORY; - } - memset(table->directory, 0, table->directory_size * sizeof(segment_t *)); - - /* - * Adjust count to be nearest higher power of 2, minimum SEGMENT_SIZE, then - * convert into segments. - */ - i = table->segment_size; - while (i < count) - i <<= 1; - count = i >> table->segment_size_shift; - - table->segment_count = 0; - table->p = 0; - table->entry_count = 0; - table->delete_callback = delete_callback; - table->delete_pvt = delete_private_data; - - /* - * Allocate initial 'i' segments of buckets - */ - for (i = 0; i < count; i++) { - table->directory[i] = (segment_t *)halloc(table, table->segment_size * sizeof(segment_t)); - if (table->directory[i] == NULL) { - hash_destroy(table); - return HASH_ERROR_NO_MEMORY; - } - memset(table->directory[i], 0, table->segment_size * sizeof(segment_t)); - table->segment_count++; - } - table->bucket_count = table->segment_count << table->segment_size_shift; - table->maxp = table->bucket_count; - table->min_load_factor = min_load_factor == 0 ? HASH_DEFAULT_MIN_LOAD_FACTOR : min_load_factor; - table->max_load_factor = max_load_factor == 0 ? HASH_DEFAULT_MAX_LOAD_FACTOR : max_load_factor; - -#if DEBUG - if (debug_level >= 1) - fprintf(stderr, "hash_create_ex: table=%p count=%lu maxp=%lu segment_count=%lu\n", - table, count, table->maxp, table->segment_count); -#endif -#ifdef HASH_STATISTICS - memset(&table->statistics, 0, sizeof(table->statistics)); -#endif - - *tbl = table; - return HASH_SUCCESS; -} - -#ifdef HASH_STATISTICS -int hash_get_statistics(hash_table_t *table, hash_statistics_t *statistics) -{ - if (!table) return HASH_ERROR_BAD_TABLE; - if (!statistics) return EINVAL; - - *statistics = table->statistics; - - return HASH_SUCCESS; -} -#endif - -int hash_destroy(hash_table_t *table) -{ - unsigned long i, j; - segment_t *s; - element_t *p, *q; - - if (!table) return HASH_ERROR_BAD_TABLE; - - if (table != NULL) { - for (i = 0; i < table->segment_count; i++) { - /* test probably unnecessary */ - if ((s = table->directory[i]) != NULL) { - for (j = 0; j < table->segment_size; j++) { - p = s[j]; - while (p != NULL) { - q = p->next; - hdelete_callback(table, HASH_TABLE_DESTROY, &p->entry); - if (p->entry.key.type == HASH_KEY_STRING) { - hfree(table, (char *)p->entry.key.str); - } - hfree(table, (char *)p); - p = q; - } - } - hfree(table, s); - } - } - hfree(table, table->directory); - hfree(table, table); - table = NULL; - } - return HASH_SUCCESS; -} - -int hash_iterate(hash_table_t *table, hash_iterate_callback callback, void *user_data) -{ - unsigned long i, j; - segment_t *s; - element_t *p; - - if (!table) return HASH_ERROR_BAD_TABLE; - - if (table != NULL) { - for (i = 0; i < table->segment_count; i++) { - /* test probably unnecessary */ - if ((s = table->directory[i]) != NULL) { - for (j = 0; j < table->segment_size; j++) { - p = s[j]; - while (p != NULL) { - if(!(*callback)(&p->entry, user_data)) return HASH_SUCCESS; - p = p->next; - } - } - } - } - } - return HASH_SUCCESS; -} - -static hash_entry_t *hash_iter_next(struct hash_iter_context_t *iter_arg) -{ - struct _hash_iter_context_t *iter = (struct _hash_iter_context_t *) iter_arg; - hash_entry_t *entry; - - if (iter->table == NULL) return NULL; - goto state_3a; - - state_1: - iter->i++; - if(iter->i >= iter->table->segment_count) return NULL; - /* test probably unnecessary */ - iter->s = iter->table->directory[iter->i]; - if (iter->s == NULL) goto state_1; - iter->j = 0; - state_2: - if (iter->j >= iter->table->segment_size) goto state_1; - iter->p = iter->s[iter->j]; - state_3a: - if (iter->p == NULL) goto state_3b; - entry = &iter->p->entry; - iter->p = iter->p->next; - return entry; - state_3b: - iter->j++; - goto state_2; - - /* Should never reach here */ - fprintf(stderr, "ERROR hash_iter_next reached invalid state\n"); - return NULL; -} - -struct hash_iter_context_t *new_hash_iter_context(hash_table_t *table) -{ - struct _hash_iter_context_t *iter; - - if (!table) return NULL;; - - iter = halloc(table, sizeof(struct _hash_iter_context_t)); - if (iter == NULL) { - return NULL; - } - - - iter->iter.next = (hash_iter_next_t) hash_iter_next; - - iter->table = table; - iter->i = 0; - iter->j = 0; - iter->s = table->directory[iter->i]; - iter->p = iter->s[iter->j]; - - return (struct hash_iter_context_t *)iter; -} - -unsigned long hash_count(hash_table_t *table) -{ - return table->entry_count; -} - - -int hash_keys(hash_table_t *table, unsigned long *count_arg, hash_key_t **keys_arg) -{ - unsigned long count = table->entry_count; - hash_key_t *keys; - hash_keys_callback_data_t data; - - if (!table) return HASH_ERROR_BAD_TABLE; - - if (count == 0) { - *count_arg = 0; - *keys_arg = NULL; - return HASH_SUCCESS; - } - - keys = halloc(table, sizeof(hash_key_t) * count); - if (keys == NULL) { - *count_arg = -1; - *keys_arg = NULL; - return HASH_ERROR_NO_MEMORY; - } - - data.index = 0; - data.keys = keys; - - hash_iterate(table, hash_keys_callback, &data); - - *count_arg = count; - *keys_arg = keys; - return HASH_SUCCESS; -} - -int hash_values(hash_table_t *table, unsigned long *count_arg, hash_value_t **values_arg) -{ - unsigned long count = table->entry_count; - hash_value_t *values; - hash_values_callback_data_t data; - - if (!table) return HASH_ERROR_BAD_TABLE; - - if (count == 0) { - *count_arg = 0; - *values_arg = NULL; - return HASH_SUCCESS; - } - - values = halloc(table, sizeof(hash_value_t) * count); - if (values == NULL) { - *count_arg = -1; - *values_arg = NULL; - return HASH_ERROR_NO_MEMORY; - } - - data.index = 0; - data.values = values; - - hash_iterate(table, hash_values_callback, &data); - - *count_arg = count; - *values_arg = values; - return HASH_SUCCESS; -} - -typedef struct hash_entries_callback_data_t { - unsigned long index; - hash_entry_t *entries; -} hash_entries_callback_data_t; - -static bool hash_entries_callback(hash_entry_t *item, void *user_data) -{ - hash_entries_callback_data_t *data = (hash_entries_callback_data_t *)user_data; - - data->entries[data->index++] = *item; - return true; -} - -int hash_entries(hash_table_t *table, unsigned long *count_arg, hash_entry_t **entries_arg) -{ - unsigned long count = table->entry_count; - hash_entry_t *entries; - hash_entries_callback_data_t data; - - if (!table) return HASH_ERROR_BAD_TABLE; - - if (count == 0) { - *count_arg = 0; - *entries_arg = NULL; - return HASH_SUCCESS; - } - - entries = halloc(table, sizeof(hash_entry_t) * count); - if (entries == NULL) { - *count_arg = -1; - *entries_arg = NULL; - return HASH_ERROR_NO_MEMORY; - } - - data.index = 0; - data.entries = entries; - - hash_iterate(table, hash_entries_callback, &data); - - *count_arg = count; - *entries_arg = entries; - return HASH_SUCCESS; -} - -bool hash_has_key(hash_table_t *table, hash_key_t *key) -{ - hash_value_t value; - - if (hash_lookup(table, key, &value) == HASH_SUCCESS) - return true; - else - return false; -} - - -int hash_get_default(hash_table_t *table, hash_key_t *key, hash_value_t *value, hash_value_t *default_value) -{ - int error; - - if (!table) return HASH_ERROR_BAD_TABLE; - - if ((error = hash_lookup(table, key, value)) != HASH_SUCCESS) { - if ((error = hash_enter(table, key, default_value)) != HASH_SUCCESS) { - return error; - } - *value = *default_value; - return HASH_SUCCESS; - } - - return HASH_SUCCESS; -} - -int hash_enter(hash_table_t *table, hash_key_t *key, hash_value_t *value) -{ - int error; - segment_t element, *chain; - size_t len; - - if (!table) return HASH_ERROR_BAD_TABLE; - - if (!is_valid_key_type(key->type)) - return HASH_ERROR_BAD_KEY_TYPE; - - if (!is_valid_value_type(value->type)) - return HASH_ERROR_BAD_VALUE_TYPE; - - lookup(table, key, &element, &chain); - - if (element == NULL) { /* not found */ - element = (element_t *)halloc(table, sizeof(element_t)); - if (element == NULL) { - /* Allocation failed, return NULL */ - return HASH_ERROR_NO_MEMORY; - } - memset(element, 0, sizeof(element_t)); - /* - * Initialize new element - */ - switch(element->entry.key.type = key->type) { - case HASH_KEY_ULONG: - element->entry.key.ul = key->ul; - break; - case HASH_KEY_STRING: - len = strlen(key->str)+1; - element->entry.key.str = halloc(table, len); - if (element->entry.key.str == NULL) { - hfree(table, element); - return HASH_ERROR_NO_MEMORY; - } - memcpy((void *)element->entry.key.str, key->str, len); - break; - } - switch(element->entry.value.type = value->type) { - case HASH_VALUE_UNDEF: - element->entry.value.ul = 0; - break; - case HASH_VALUE_PTR: - element->entry.value.ptr = value->ptr; - break; - case HASH_VALUE_INT: - element->entry.value.i = value->i; - break; - case HASH_VALUE_UINT: - element->entry.value.ui = value->ui; - break; - case HASH_VALUE_LONG: - element->entry.value.l = value->l; - break; - case HASH_VALUE_ULONG: - element->entry.value.ul = value->ul; - break; - case HASH_VALUE_FLOAT: - element->entry.value.f = value->f; - break; - case HASH_VALUE_DOUBLE: - element->entry.value.d = value->d; - break; - } - *chain = element; /* link into chain */ - element->next = NULL; - /* - * Table over-full? - */ - if (++table->entry_count / table->bucket_count > table->max_load_factor) { - if ((error = expand_table(table)) != HASH_SUCCESS) { /* doesn't affect element */ - return error; - } - } - } /* end not found */ - return HASH_SUCCESS; -} - -int hash_lookup(hash_table_t *table, hash_key_t *key, hash_value_t *value) -{ - segment_t element, *chain; - - if (!table) return HASH_ERROR_BAD_TABLE; - - if (!is_valid_key_type(key->type)) - return HASH_ERROR_BAD_KEY_TYPE; - - lookup(table, key, &element, &chain); - - if (element) { - *value = element->entry.value; - return HASH_SUCCESS; - } else { - return HASH_ERROR_KEY_NOT_FOUND; - } -} - -int hash_delete(hash_table_t *table, hash_key_t *key) -{ - int error; - segment_t element, *chain; - - if (!table) return HASH_ERROR_BAD_TABLE; - - if (!is_valid_key_type(key->type)) - return HASH_ERROR_BAD_KEY_TYPE; - - lookup(table, key, &element, &chain); - - if (element) { - hdelete_callback(table, HASH_ENTRY_DESTROY, &element->entry); - *chain = element->next; /* remove from chain */ - /* - * Table too sparse? - */ - if (--table->entry_count / table->bucket_count < table->min_load_factor) { - if ((error = contract_table(table)) != HASH_SUCCESS) { /* doesn't affect element */ - return error; - } - } - if (element->entry.key.type == HASH_KEY_STRING) { - hfree(table, (char *)element->entry.key.str); - } - hfree(table, element); - return HASH_SUCCESS; - } else { - return HASH_ERROR_KEY_NOT_FOUND; - } -} - - diff --git a/common/dhash/dhash.h b/common/dhash/dhash.h deleted file mode 100644 index 70d083e3c..000000000 --- a/common/dhash/dhash.h +++ /dev/null @@ -1,391 +0,0 @@ -/* - Authors: - John Dennis <jdennis.redhat.com> - Esmond Pitt <ejp@ausmelb.oz.AU> - - This implementation was based on a 3/7/1989 public domain submission - to comp.sources.misc by Esmond Pitt <ejp@ausmelb.oz.AU>. - - Copyright (C) 2009 Red Hat - - This program 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. - - 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 Lesser General Public License for more 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 DHASH_H -#define DHASH_H - -/*****************************************************************************/ -/******************************** Documentation ******************************/ -/*****************************************************************************/ - -#if 0 - -Dynamic hash table implementation based on article in CACM April 1988 pp. -446-457, by Per-Ake Larson. - -This implementation was based on a 3/7/1989 submission to comp.sources.misc by -Esmond Pitt (ejp@ausmelb.oz.AU) that emulated the hsearch(3) interface. The interface -was reworked to be much more flexible and significant new functionality was -added by John Dennis (jdennis@sharpeye.com). - -A hash table maintains a set of <key,value> pairs. Lookups are performed by -locating the key in the table and returning its value. - -A dynamic hash table keeps the number of hash collisions constant -independent of the number of entries in the hash table. - -Both keys and values may be of different types. Two different key types are -supported, strings and unsigned longs. If the key type is a string the hash -library will automatically allocate memory to hold the hash key string and -will automatically free the memory for the key string when the hash entry -is destroyed. Items in the hash table only match when their key types match -AND the keys themselves match. For example if there were two hash entries, -one whose key type was an unsigned long equal to 1 and one whose key type was -a string equal to "1" they would not match, these are considered two -distinct entries. - -The value of the key may be a undefined, pointer, an int, an unsigned int, a -long, an unsigned long, a float, or a double. The hash library does nothing -with user pointers (value.type == HASH_VALUE_PTR). Its the user responsibility -to free items pointed to by these pointers when a hash entry is deleted or the -hash table is destroyed (see hash_delete_callback and/or hash_destroy). - -See dhash_example.c for an illustration of how one might use the API. It does not -represent complete API coverage nor the optimal way to do things in all cases, -it is just a general example. - -Copyright 2009-1010 John Dennis -This program is distributed under the terms of the GNU Lesser General Public -License (LGPL). See the included COPYING and COPYING.lesser files for the -terms of this license. - -#endif - -/*****************************************************************************/ -/******************************* Include Files *******************************/ -/*****************************************************************************/ - -#include <stdbool.h> - -/*****************************************************************************/ -/*********************************** Defines *********************************/ -/*****************************************************************************/ - -#if 1 -#define HASH_STATISTICS -#endif - -#define HASH_DEFAULT_DIRECTORY_BITS 5 -#define HASH_DEFAULT_SEGMENT_BITS 5 -#define HASH_DEFAULT_MIN_LOAD_FACTOR 1 -#define HASH_DEFAULT_MAX_LOAD_FACTOR 5 - -#define HASH_ERROR_BASE -2000 -#define HASH_ERROR_LIMIT (HASH_ERROR_BASE+20) -#define IS_HASH_ERROR(error) (((error) >= HASH_ERROR_BASE) && ((error) < HASH_ERROR_LIMIT)) - -#define HASH_SUCCESS 0 -#define HASH_ERROR_BAD_KEY_TYPE (HASH_ERROR_BASE + 1) -#define HASH_ERROR_BAD_VALUE_TYPE (HASH_ERROR_BASE + 2) -#define HASH_ERROR_NO_MEMORY (HASH_ERROR_BASE + 3) -#define HASH_ERROR_KEY_NOT_FOUND (HASH_ERROR_BASE + 4) -#define HASH_ERROR_BAD_TABLE (HASH_ERROR_BASE + 5) - -/*****************************************************************************/ -/******************************* Type Definitions ****************************/ -/*****************************************************************************/ - -struct hash_table_str; -typedef struct hash_table_str hash_table_t; - -typedef enum { - HASH_KEY_STRING, - HASH_KEY_ULONG -} hash_key_enum; - -typedef enum -{ - HASH_VALUE_UNDEF, - HASH_VALUE_PTR, - HASH_VALUE_INT, - HASH_VALUE_UINT, - HASH_VALUE_LONG, - HASH_VALUE_ULONG, - HASH_VALUE_FLOAT, - HASH_VALUE_DOUBLE -} hash_value_enum; - -typedef enum -{ - HASH_TABLE_DESTROY, - HASH_ENTRY_DESTROY -} hash_destroy_enum; - -typedef struct hash_key_t { - hash_key_enum type; - union { - char *str; - unsigned long ul; - }; -} hash_key_t; - -typedef struct hash_value_t { - hash_value_enum type; - union { - void *ptr; - int i; - unsigned int ui; - long l; - unsigned long ul; - float f; - double d; - }; -} hash_value_t; - -typedef struct hash_entry_t { - hash_key_t key; - hash_value_t value; -} hash_entry_t; - -#ifdef HASH_STATISTICS -typedef struct hash_statistics_t { - unsigned long hash_accesses; - unsigned long hash_collisions; - unsigned long table_expansions; - unsigned long table_contractions; -} hash_statistics_t; -#endif - - -/* typedef's for callback based iteration */ -typedef bool(*hash_iterate_callback)(hash_entry_t *item, void *user_data); -typedef void (hash_delete_callback)(hash_entry_t *item, - hash_destroy_enum type, void *pvt); - -/* typedef's for iteration object based iteration */ -struct hash_iter_context_t; -typedef hash_entry_t *(*hash_iter_next_t)(struct hash_iter_context_t *iter); -struct hash_iter_context_t { - hash_iter_next_t next; -}; - -/* typedef for hash_create_ex() */ -typedef void *(hash_alloc_func)(size_t size, void *pvt); -typedef void (hash_free_func)(void *ptr, void *pvt); - -/*****************************************************************************/ -/************************* External Global Variables ***********************/ -/*****************************************************************************/ - -/*****************************************************************************/ -/**************************** Exported Functions ***************************/ -/*****************************************************************************/ - -/* - * Given an error code returned by a hash function, map it to a error string. - * Returns NULL if the error code is unrecognized. - */ -const char* hash_error_string(int error); - -/* - * Create a new hash table with room for n initial entries. hash_create returns - * an opaque pointer to the new hash table in the table parameter. Functions - * operating on the hash table pass in this hash table pointer. This means you - * may have as many concurrent hash tables as you want. The delete_callback - * parameter is a pointer to a function which will be called just prior to a - * hash entry being deleted. This is useful when the hash value has items which - * may need to be disposed of. The delete_callback may be NULL. - * The delete_private_data is data passed to the delete_callback, this way - * custom callbacks can have a private context to reach data they need to use - * before performning their operations. delete_private_data may be NULL. - */ -int hash_create(unsigned long count, hash_table_t **tbl, - hash_delete_callback *delete_callback, - void *delete_private_data); - -/* - * Create a new hash table and fine tune it's configurable parameters. - * Refer to CACM article for explanation of parameters. - * - * directory_bits: number of address bits allocated to top level directory array. - * segment_bits: number of address bits allocated to segment array. - * min_load_factor: table contracted when the ratio of entry count to bucket count - * is less than the min_load_factor the table is contracted. - * max_load_factor: table expanded when the ratio of entry count to bucket count - * is greater than the max_load_factor the table is expanded. - * alloc_func: function pointer for allocation - * free_func: funciton pointer for freeing memory allocated with alloc_func - * alloc_private data: data passed to the alloc and free functions so that - * custom functions can refernce other private data they may - * need during their execution without having to use global - * variables. - * - * Note directory_bits + segment_bits must be <= number of bits in unsigned long - */ -int hash_create_ex(unsigned long count, hash_table_t **tbl, - unsigned int directory_bits, - unsigned int segment_bits, - unsigned long min_load_factor, - unsigned long max_load_factor, - hash_alloc_func *alloc_func, - hash_free_func *free_func, - void *alloc_private_data, - hash_delete_callback *delete_callback, - void *delete_private_data); - -#ifdef HASH_STATISTICS -/* - * Return statistics for the table. - */ -int hash_get_statistics(hash_table_t *table, hash_statistics_t *statistics); -#endif - -/* - * hash_destroy deletes all entries in the hash table, freeing all memory used - * in implementing the hash table. Some hash entries may have values which are - * pointers to user data structures. User pointers are not free by hash_destroy, - * they must be free by the caller. This may be done by iterating over all the - * entries in the table using hash_iterate() and freeing the values or by - * registering a delete callback when the table is created with - * hash_create(). Note, hash keys which are strings will be automatically freed - * by hash_destroy, the caller does not need to free the key strings. - */ -int hash_destroy(hash_table_t *table); - -/* - * Enter or update an item in the table referenced by key. If the key does not - * exist yet the item will be created and inserted into the table with the - * value, otherwise the value for the existing key is updated. The return value - * may be HASH_ERROR_BAD_KEY_TYPE or HASH_ERROR_BAD_VALUE_TYPE if the key or - * value type respectively is invalid. This function might also return - * HASH_ERROR_NO_MEMORY. - */ -int hash_enter(hash_table_t *table, hash_key_t *key, hash_value_t *value); - -/* - * Using the key lookup the value associated with it in the table. If the key is - * not in the table HASH_ERROR_KEY_NOT_FOUND is returned. If the type of key is - * invalid HASH_ERROR_BAD_KEY_TYPE is returned. Otherwise HASH_SUCCESS is - * returned. If the result is anything other than HASH_SUCCESS the value pointer - * is not updated. - */ -int hash_lookup(hash_table_t *table, hash_key_t *key, hash_value_t *value); - -/* - * Like hash_lookup() except if the key is not in the table then it is entered - * into the table and assigned the default_value. Thus it is not possible for - * hash_get_default() to return HASH_ERROR_KEY_NOT_FOUND. - */ -int hash_get_default(hash_table_t *table, hash_key_t *key, hash_value_t *value, hash_value_t *default_value); - -/* - * Delete the item from the table. The key and its type are specified in the key - * parameter which are passed by reference. If the key was in the table - * HASH_SUCCESS is returned otherwise HASH_ERROR_KEY_NOT_FOUND is - * returned. Memory allocated to hold the key if it was a string is free by the - * hash library, but values which are pointers to user data must be freed by the - * caller (see delete_callback). - */ -int hash_delete(hash_table_t *table, hash_key_t *key); - -/* - * Often it is useful to operate on every key and/or value in the hash - * table. The hash_iterate function will invoke the users callback on every item - * in the table as long as the callback returns a non-zero value. Returning a - * zero from the callback can be used to halt the iteration prematurely if some - * condition is met. The user_data parameter is passed to the callback - * function. It can be used for any purpose the caller wants. The callback - * parameter list is: - * - * bool callback(hash_entry_t *item, hash_table_t *user_data); - * - * WARNING: Do not modify the contents of the table during an iteration it will - * produce undefined results. If you need to visit each item in the table and - * potentially delete or insert some entries the proper way to do this is to - * obtain a list of keys or items using hash_keys() or hash_items() which - * returns a copy of the keys or items. You may then loop on the list returned - * and safely update the table (don't forget to free the list when done). - */ -int hash_iterate(hash_table_t *table, hash_iterate_callback callback, void *user_data); - -/* - * This is another method to iterate on every key/value in the hash table. - * However, unlike hash_iterate which requires a callback this function returns - * an iterator object which contains a next() function pointer. Each time - * next() is invoked it returns a pointer to the next hash entry in the table, - * then NULL when all entries have been visited. In some circumstances it's more - * convenient than having to define a callback. Like hash_iterate() one must - * never modify the table contents during iteration. If you intend to modify the - * table during iteration use the functions which return an indepent list of - * keys, values, or items instead and iterate on the list. The iterator object - * must be free'ed when you're done iterating by calling free() on it. - * - * Example: - * - * struct hash_iter_context_t *iter; - * hash_entry_t *entry; - * - * iter = new_hash_iter_context(table); - * while ((entry = iter->next(iter)) != NULL) { - * do_something(entry); - * } - * free(iter); - */ -struct hash_iter_context_t *new_hash_iter_context(hash_table_t *table); - -/* - * Return a count of how many items are currently in the table. - */ -unsigned long hash_count(hash_table_t *table); - -/* - * Get an array of all the keys in the table returned through the keys - * parameter. The number of elements in the array is returned in the count - * parameter. Each key in the array is a copy of the key in the table. Any - * pointers in the key will be shared with the table entry thus both the item in - * the array and the item in the table point to the same object. The array - * should be freed by calling free(). The function may return - * HASH_ERROR_NO_MEMORY, otherwise HASH_SUCCESS. - */ -int hash_keys(hash_table_t *table, unsigned long *count, hash_key_t **keys); - -/* - * Get an array of all the values in the table returned through the values - * parameter. The number of elements in the array is returned in the count - * parameter. Each value in the array is a copy of the value in the table. Any - * pointers in the value will be shared with the table entry thus both the item in - * the array and the item in the table point to the same object. The array - * should be freed by calling free(). The function may return - * HASH_ERROR_NO_MEMORY, otherwise HASH_SUCCESS. - */ -int hash_values(hash_table_t *table, unsigned long *count, hash_value_t **values); - - -/* - * Get an array of all the entries in the table returned through the entries - * parameter. The number of elements in the array is returned in the count - * parameter. Each entry in the array is a copy of the entry in the table. Any - * pointers in the entry will be shared with the table entry thus both the item in - * the array and the item in the table point to the same object. The array - * should be freed by calling free(). The function may return - * HASH_ERROR_NO_MEMORY, otherwise HASH_SUCCESS. - */ -int hash_entries(hash_table_t *table, unsigned long *count, hash_entry_t **entries); - -/* - * Return boolean if the key is in the table. - */ -bool hash_has_key(hash_table_t *table, hash_key_t *key); - -#endif diff --git a/common/dhash/dhash.pc.in b/common/dhash/dhash.pc.in deleted file mode 100644 index 7dfc8a35d..000000000 --- a/common/dhash/dhash.pc.in +++ /dev/null @@ -1,11 +0,0 @@ -prefix=@prefix@ -exec_prefix=@exec_prefix@ -libdir=@libdir@ -includedir=@includedir@ - -Name: @PACKAGE_NAME@ -Description: A hash table which will dynamically resize to achieve optimal storage & access time properties -Version: @PACKAGE_VERSION@ -Libs: -L${libdir} -ldhash -Cflags: -I${includedir} -URL: http://fedorahosted.org/sssd/ diff --git a/common/dhash/examples/dhash_example.c b/common/dhash/examples/dhash_example.c deleted file mode 100644 index bd0ca8eb5..000000000 --- a/common/dhash/examples/dhash_example.c +++ /dev/null @@ -1,138 +0,0 @@ -/* - Authors: - John Dennis <jdennis.redhat.com> - - Copyright (C) 2009 Red Hat - - This program 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. - - 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 Lesser General Public License for more 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/>. -*/ - -#include <stdio.h> -#include <string.h> -#include <stdlib.h> -#include <assert.h> -#include "dhash.h" - -struct my_data_t { - int foo; - char bar[128]; -}; - -void delete_callback(hash_entry_t *entry, hash_destroy_enum type, void *pvt) -{ - if (entry->value.type == HASH_VALUE_PTR) free(entry->value.ptr); -} - -bool visit_callback(hash_entry_t *entry, void *user_data) -{ - unsigned long *count = (unsigned long *)user_data; - struct my_data_t *my_data = (struct my_data_t *) entry->value.ptr; - - (*count)++; - - printf("%s = [foo=%d bar=%s]\n", entry->key.str, my_data->foo, my_data->bar); - return true; -} - -struct my_data_t *new_data(int foo, const char *bar) -{ - struct my_data_t *my_data = malloc(sizeof(struct my_data_t)); - my_data->foo = foo; - strncpy(my_data->bar, bar, sizeof(my_data->bar)); - return my_data; -} -int main(int argc, char **argv) -{ - static hash_table_t *table = NULL; - hash_key_t key, *keys; - hash_value_t value; - struct hash_iter_context_t *iter; - hash_entry_t *entry; - unsigned long i, n_entries; - int error; - struct my_data_t *my_data = new_data(1024, "Hello World!"); - unsigned long count; - - /* Create a hash table */ - error = hash_create(10, &table, delete_callback, NULL); - if (error != HASH_SUCCESS) { - fprintf(stderr, "cannot create hash table (%s)\n", hash_error_string(error)); - return error; - } - - /* Enter a key named "My Data" and specify it's value as a pointer to my_data */ - key.type = HASH_KEY_STRING; - key.str = strdup("My Data"); - value.type = HASH_VALUE_PTR; - value.ptr = my_data; - - if ((error = hash_enter(table, &key, &value)) != HASH_SUCCESS) { - fprintf(stderr, "cannot add to table \"%s\" (%s)\n", key.str, hash_error_string(error)); - return error; - } - - /* Get a list of keys and print them out, free the list when we're done */ - if ((error = hash_keys(table, &count, &keys)) != HASH_SUCCESS) { - fprintf(stderr, "cannot get key list (%s)\n", hash_error_string(error)); - return error; - } - - for (i = 0; i < count; i++) - printf("key: %s\n", keys[i].str); - free(keys); - - /* Lookup the key named "My Data" */ - key.type = HASH_KEY_STRING; - key.str = strdup("My Data"); - if ((error = hash_lookup(table, &key, &value)) != HASH_SUCCESS) { - fprintf(stderr, "cannot find key \"%s\" (%s)\n", key.str, hash_error_string(error)); - } - - /* Visit each entry in the table, callback will increment count on each visit */ - printf("Iterate using callback\n"); - count = 0; - hash_iterate(table, visit_callback, &count); - - /* Assure number of visits equal the table size */ - assert(count == hash_count(table)); - - /* Visit each entry using iterator object */ - printf("Iterate using iterator\n"); - n_entries = 0; - iter = new_hash_iter_context(table); - while ((entry = iter->next(iter)) != NULL) { - struct my_data_t *data = (struct my_data_t *) entry->value.ptr; - - printf("%s = [foo=%d bar=%s]\n", entry->key.str, data->foo, data->bar); - n_entries++; - } - free(iter); - /* Assure number of visits equal the table size */ - assert(n_entries == hash_count(table)); - - /* Remove the entry, deletion callback will be invoked */ - key.type = HASH_KEY_STRING; - key.str = strdup("My Data"); - if ((error = hash_delete(table, &key)) != HASH_SUCCESS) { - fprintf(stderr, "cannot delete from table (%s)\n", hash_error_string(error)); - } - - /* Assure key is no longer in table */ - assert (!hash_has_key(table, &key)); - - /* Free the table */ - hash_destroy(table); - - return 0; -} diff --git a/common/dhash/examples/dhash_test.c b/common/dhash/examples/dhash_test.c deleted file mode 100644 index e5b922dad..000000000 --- a/common/dhash/examples/dhash_test.c +++ /dev/null @@ -1,510 +0,0 @@ -/* - Authors: - John Dennis <jdennis.redhat.com> - - Copyright (C) 2009 Red Hat - - This program 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. - - 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 Lesser General Public License for more 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/>. -*/ - -#include <stdio.h> -#include <assert.h> -#include <string.h> -#include <stdlib.h> -#include <time.h> -#include <getopt.h> -#include "dhash.h" - -#define DEFAULT_MAX_TEST (500) -hash_entry_t *iter_result_1 = NULL; -hash_entry_t *iter_result_2 = NULL; - -unsigned long max_test = DEFAULT_MAX_TEST; -int verbose = 0; - -const char *error_string(int error) -{ - if (IS_HASH_ERROR(error)) - return hash_error_string(error); - - return strerror(error); -} - -char *key_string(hash_key_t *key) -{ - static char buf[1024]; - - switch(key->type) { - case HASH_KEY_ULONG: - snprintf(buf, sizeof(buf), "key ulong = %lu", key->ul); - break; - case HASH_KEY_STRING: - snprintf(buf, sizeof(buf), "key string = \"%s\"", key->str); - break; - default: - snprintf(buf, sizeof(buf), "unknown key type = %d", key->type); - break; - } - return buf; -} - -char *value_string(hash_value_t *value) -{ - static char buf[1024]; - - switch(value->type) { - case HASH_VALUE_UNDEF: - snprintf(buf, sizeof(buf), "value undefined"); - break; - case HASH_VALUE_PTR: - snprintf(buf, sizeof(buf), "value str = \"%s\"", (char *)value->ptr); - break; - case HASH_VALUE_INT: - snprintf(buf, sizeof(buf), "value int = %d", value->i); - break; - case HASH_VALUE_UINT: - snprintf(buf, sizeof(buf), "value unsigned int = %u", value->ui); - break; - case HASH_VALUE_LONG: - snprintf(buf, sizeof(buf), "value long = %ld", value->l); - break; - case HASH_VALUE_ULONG: - snprintf(buf, sizeof(buf), "value unsigned long = %lu", value->ul); - break; - case HASH_VALUE_FLOAT: - snprintf(buf, sizeof(buf), "value float = %f", value->f); - break; - case HASH_VALUE_DOUBLE: - snprintf(buf, sizeof(buf), "value double = %f", value->f); - break; - default: - snprintf(buf, sizeof(buf), "unknown value type = %d", value->type); - break; - } - - return buf; -} - -char *entry_string(hash_entry_t *entry) -{ - static char buf[1024]; - - snprintf(buf, sizeof(buf), "[%s] = [%s]", key_string(&entry->key), value_string(&entry->value)); - - return buf; - -} - -bool callback(hash_entry_t *item, void *user_data) -{ - unsigned long *callback_count = (unsigned long *)user_data; - - iter_result_1[*callback_count] = *item; - - (*callback_count)++; - - if (verbose) printf("%s\n", entry_string(item)); - return true; -} - -void delete_callback(hash_entry_t *item, hash_destroy_enum type, void *pvt) -{ - if (item->value.type == HASH_VALUE_PTR) free(item->value.ptr); -} - -typedef struct test_val_t { - long val; - char *str; -} test_val_t; - - -int main(int argc, char **argv) -{ - test_val_t *test = NULL; - long i, k; - int status; - hash_value_t value; - hash_key_t key; - char buf[1024]; - hash_table_t *table = NULL; - unsigned long callback_count = 0; - unsigned int directory_bits = HASH_DEFAULT_DIRECTORY_BITS; - unsigned int segment_bits = HASH_DEFAULT_SEGMENT_BITS; - unsigned long min_load_factor = HASH_DEFAULT_MIN_LOAD_FACTOR; - unsigned long max_load_factor = HASH_DEFAULT_MAX_LOAD_FACTOR; - - while (1) { - int arg; - int option_index = 0; - static struct option long_options[] = { - {"count", 1, 0, 'c'}, - {"verbose", 1, 0, 'v'}, - {"quiet", 1, 0, 'q'}, - {"directory-bits", 1, 0, 'd'}, - {"segment-bits", 1, 0, 's'}, - {"min-load-factor", 1, 0, 'l'}, - {"max-load-factor", 1, 0, 'h'}, - {0, 0, 0, 0} - }; - - arg = getopt_long(argc, argv, "c:vqd:s:l:h:", - long_options, &option_index); - if (arg == -1) break; - - switch (arg) { - case 'c': - max_test = atol(optarg); - break; - case 'v': - verbose = 1; - break; - case 'q': - verbose = 0; - break; - case 'd': - directory_bits = atoi(optarg); - break; - case 's': - segment_bits = atoi(optarg); - break; - case 'l': - min_load_factor = atol(optarg); - break; - case 'h': - max_load_factor = atol(optarg); - break; - } - } - - if ((test = (test_val_t *) calloc(max_test, sizeof(test_val_t))) == NULL) { - fprintf(stderr, "Failed to allocate test array\n"); - exit(1); - } - if ((iter_result_1 = (hash_entry_t *) calloc(max_test, sizeof(hash_entry_t))) == NULL) { - fprintf(stderr, "Failed to allocate iter_result_1 array\n"); - exit(1); - } - if ((iter_result_2 = (hash_entry_t *) calloc(max_test, sizeof(hash_entry_t))) == NULL) { - fprintf(stderr, "Failed to allocate iter_result_2 array\n"); - exit(1); - } - - - /* Initialize the random number generator */ - srandom(time(0)); - - /* Create the hash table as small as possible to exercise growth */ - if ((status = hash_create_ex(1, &table, - directory_bits, segment_bits, - min_load_factor, max_load_factor, - NULL, NULL, NULL, - delete_callback, NULL)) != HASH_SUCCESS) { - fprintf(stderr, "table creation failed at line %d (%s)\n", __LINE__, error_string(status)); - exit(1); - } - - /* Initialize the array of test values */ - for (i = 0; i < max_test; i++) { - test[i].val = random(); - /* If the value is odd we'll use a string as the key, - * otherwise we'll use an unsigned long as the key */ - if (test[i].val & 1) { - key.type = HASH_KEY_STRING; - sprintf(buf, "%ld", test[i].val); - test[i].str = strdup(buf); - } - } - - /* Enter all the test values into the hash table */ - for (i = 0; i < max_test; i++) { - if (test[i].val & 1) { - key.type = HASH_KEY_STRING; - key.str = test[i].str; - value.type = HASH_VALUE_PTR; - value.ptr = (void *) strdup(test[i].str); - } - else { - key.type = HASH_KEY_ULONG; - key.ul = test[i].val; - value.type = HASH_VALUE_LONG; - value.l = test[i].val; - } - - if (hash_has_key(table, &key)) { - fprintf(stderr, "Error: %ld already in table when inserting, i = %lu, at line %d\n", - test[i].val, i, __LINE__); - exit(1); - } - if ((status = hash_enter(table, &key, &value)) != HASH_SUCCESS) { - fprintf(stderr, "Error: %ld failed insertion at line %d (%s) \n", - test[i].val, __LINE__, error_string(status)); - exit(1); - } - } - - /* Now visit each entry in the table using a callback iterator, - * store what we found in iter_result_1 for testing the iterator object later on */ - if (verbose) printf("callback iterate:\n"); - callback_count = 0; - if ((status = hash_iterate(table, callback, &callback_count)) != HASH_SUCCESS) { - fprintf(stderr, "hash_iterate failed at line %d (%s)\n", __LINE__, error_string(status)); - exit(1); - } - if (verbose) printf("hash_count=%ld, callback_count=%ld\n", hash_count(table), callback_count); - - if (hash_count(table) != callback_count) { - fprintf(stderr, "Error: hash_count(%ld) != callback_count(%ld) at line %d\n", - hash_count(table), callback_count, __LINE__); - exit(1); - } - - /* Now vist each entry in the table using an iterator object */ - { - struct hash_iter_context_t *iter; - unsigned long n_items; - hash_entry_t *entry; - - if (verbose) printf("iter iterate:\n"); - - n_items = 0; - iter = new_hash_iter_context(table); - - while ((entry = iter->next(iter)) != NULL) { - if (verbose) printf("%s\n", entry_string(entry)); - iter_result_2[n_items] = *entry; - n_items++; - } - if (verbose) printf("hash_count=%ld, n_items=%ld\n", hash_count(table), n_items); - - if (hash_count(table) != n_items) { - fprintf(stderr, "Error: hash_count(%ld) != n_items(%ld) at line %d\n", - hash_count(table), n_items, __LINE__); - exit(1); - } - free(iter); - } - - /* Both iterators should have visited each item in the same order, verify ... */ - for (i = 0; i < max_test; i++) { - if (memcmp(&iter_result_1[i], &iter_result_2[i], sizeof(iter_result_1[0])) != 0) { - fprintf(stderr, "Error: iter_result_1[%lu] != iter_result_2[%lu] at line %d\n", - i, i, __LINE__); - exit(1); - } - } - - /* Get an array of keys in the table, print them out */ - { - unsigned long count; - hash_key_t *keys; - - if (verbose) printf("\nhash_keys:\n"); - if ((status = hash_keys(table, &count, &keys)) != HASH_SUCCESS) { - fprintf(stderr, "hash_keys failed at line %d (%s)\n", - __LINE__, error_string(status)); - exit(1); - } - - if (hash_count(table) != count) { - fprintf(stderr, "Error: hash_count(%ld) != hash_keys() count(%ld) at line %d\n", - hash_count(table), count, __LINE__); - exit(1); - } - - for (i = 0; i < count; i++) { - if (verbose) printf("%s\n", key_string(&keys[i])); - } - free(keys); - } - - /* Get an array of values in the table, print them out */ - { - unsigned long count; - hash_value_t *values; - - if (verbose) printf("\nhash_values:\n"); - hash_values(table, &count, &values); - - if (hash_count(table) != count) { - fprintf(stderr, "Error: hash_count(%ld) != hash_values() count(%ld) at line %d\n", - hash_count(table), count, __LINE__); - exit(1); - } - - for (i = 0; i < count; i++) { - if (verbose) printf("%s\n", value_string(&values[i])); - } - free(values); - } - - /* Get an array of items in the table, print them out */ - { - unsigned long count; - hash_entry_t *entries; - - if (verbose) printf("\nhash_entries:\n"); - hash_entries(table, &count, &entries); - - if (hash_count(table) != count) { - fprintf(stderr, "Error: hash_count(%ld) != hash_entries() count(%ld) at line %d\n", - hash_count(table), count, __LINE__); - exit(1); - } - - for (i = 0; i < count; i++) { - if (verbose) printf("%s\n", entry_string(&entries[i])); - } - free(entries); - } - - /* See if we can find every key */ - for (i = max_test - 1; i >= 0; i--) { - if (test[i].val & 1) { - key.type = HASH_KEY_STRING; - key.str = test[i].str; - } - else { - key.type = HASH_KEY_ULONG; - key.ul = test[i].val; - } - if ((status = hash_lookup(table, &key, &value)) != HASH_SUCCESS) { - fprintf(stderr, "Error: failed first lookup for value %ld at index %ld at line %d (%s)\n", - test[i].val, i, __LINE__, error_string(status)); - exit(1); - } - else { - switch(value.type) { - case HASH_VALUE_PTR: - if (strcmp((char *)value.ptr, test[i].str) != 0) { - fprintf(stderr, "Error: corrupt ptr data for %lu at line %d\n", i, __LINE__); - exit(1); - } - break; - case HASH_VALUE_LONG: - if (value.l != test[i].val) { - fprintf(stderr, "Error: corrupt long data for %lu at line %d\n", i, __LINE__); - exit(1); - } - break; - default: - fprintf(stderr, "Error: unknown value type for %lu\n", i); - break; - } - } - } - - - /* - * Delete a key, make sure we can't find it, assure we can find all other - * keys. - */ - for (i = 0; i < max_test; i++) { - if (test[i].val & 1) { - key.type = HASH_KEY_STRING; - key.str = test[i].str; - } - else { - key.type = HASH_KEY_ULONG; - key.ul = test[i].val; - } - - if ((status = hash_lookup(table, &key, &value)) != HASH_SUCCESS) { - fprintf(stderr, "Error: failed delete lookup for value %ld at index %ld at line %d (%s)\n", - test[i].val, i, __LINE__, error_string(status)); - exit(1); - } - - if ((status = hash_delete(table, &key)) != HASH_SUCCESS) { - fprintf(stderr, "Error: %ld not in table when deleting, i = %lu at line %d (%s)\n", - test[i].val, i, __LINE__, error_string(status)); - exit(1); - } - - if (hash_lookup(table, &key, &value) != HASH_ERROR_KEY_NOT_FOUND) { - fprintf(stderr, "Error: found in table after deletion, value = %ld at index %ld at line %d\n", - test[i].val, i, __LINE__); - exit(1); - } - /* See if we can find all remaining keys */ - for (k = i + 1; k < max_test; k++) { - if (test[k].val & 1) { - key.type = HASH_KEY_STRING; - key.str = test[k].str; - } else { - key.type = HASH_KEY_ULONG; - key.ul = test[k].val; - } - if ((status = hash_lookup(table, &key, &value)) != HASH_SUCCESS) { - fprintf(stderr, "Error: failed second lookup for value %ld, i = %lu k = %lu at line %d (%s)\n", - test[k].val, i, k, __LINE__, error_string(status)); - exit(1); - } else { - switch(value.type) { - case HASH_VALUE_PTR: - if (strcmp((char *)value.ptr, test[k].str) != 0) { - fprintf(stderr, "Error: corrupt ptr data for %lu at line %d\n", k, __LINE__); - exit(1); - } - break; - case HASH_VALUE_LONG: - if (value.l != test[k].val) { - fprintf(stderr, "Error: corrupt long data for %lu at line %d\n", k, __LINE__); - exit(1); - } - break; - default: - fprintf(stderr, "Error: unknown value type (%d) for %lu\n", value.type, k); - break; - } - } - } - } - - if (verbose) printf("\n"); - -#ifdef HASH_STATISTICS - { - hash_statistics_t stats; - - if ((status = hash_get_statistics(table, &stats)) != HASH_SUCCESS) { - fprintf(stderr, "Error: could not get statistics at line %d (%s)\n", - __LINE__, error_string(status)); - exit(1); - } - - printf("Statistics: Accesses = %ld, Collisions = %ld, Collision Rate = %.2f, Expansions = %ld, Contractions = %ld\n", - stats.hash_accesses, stats.hash_collisions, - ((float)stats.hash_collisions / (float)stats.hash_accesses), - stats.table_expansions, stats.table_contractions); - } -#endif - - if ((status = hash_destroy(table)) != HASH_SUCCESS) { - fprintf(stderr, "table destruction failed at line %d (%s)\n", - __LINE__, error_string(status)); - exit(1); - } - - for (i = 0; i < max_test; i++) { - if (test[i].val & 1) { - free(test[i].str); - } - } - free(test); - free(iter_result_1); - free(iter_result_2); - - printf("Successfully tested %lu values\n", max_test); - return 0; -} diff --git a/common/dhash/m4/.dir b/common/dhash/m4/.dir deleted file mode 100644 index e69de29bb..000000000 --- a/common/dhash/m4/.dir +++ /dev/null diff --git a/common/ini/COPYING b/common/ini/COPYING deleted file mode 100644 index 94a9ed024..000000000 --- a/common/ini/COPYING +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - <one line to give the program's name and a brief idea of what it does.> - Copyright (C) <year> <name of author> - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see <http://www.gnu.org/licenses/>. - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - <program> Copyright (C) <year> <name of author> - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -<http://www.gnu.org/licenses/>. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/common/ini/COPYING.LESSER b/common/ini/COPYING.LESSER deleted file mode 100644 index 755013bb2..000000000 --- a/common/ini/COPYING.LESSER +++ /dev/null @@ -1,165 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - - This version of the GNU Lesser General Public License incorporates -the terms and conditions of version 3 of the GNU General Public -License, supplemented by the additional permissions listed below. - - 0. Additional Definitions. - - As used herein, "this License" refers to version 3 of the GNU Lesser -General Public License, and the "GNU GPL" refers to version 3 of the GNU -General Public License. - - "The Library" refers to a covered work governed by this License, -other than an Application or a Combined Work as defined below. - - An "Application" is any work that makes use of an interface provided -by the Library, but which is not otherwise based on the Library. -Defining a subclass of a class defined by the Library is deemed a mode -of using an interface provided by the Library. - - A "Combined Work" is a work produced by combining or linking an -Application with the Library. The particular version of the Library -with which the Combined Work was made is also called the "Linked -Version". - - The "Minimal Corresponding Source" for a Combined Work means the -Corresponding Source for the Combined Work, excluding any source code -for portions of the Combined Work that, considered in isolation, are -based on the Application, and not on the Linked Version. - - The "Corresponding Application Code" for a Combined Work means the -object code and/or source code for the Application, including any data -and utility programs needed for reproducing the Combined Work from the -Application, but excluding the System Libraries of the Combined Work. - - 1. Exception to Section 3 of the GNU GPL. - - You may convey a covered work under sections 3 and 4 of this License -without being bound by section 3 of the GNU GPL. - - 2. Conveying Modified Versions. - - If you modify a copy of the Library, and, in your modifications, a -facility refers to a function or data to be supplied by an Application -that uses the facility (other than as an argument passed when the -facility is invoked), then you may convey a copy of the modified -version: - - a) under this License, provided that you make a good faith effort to - ensure that, in the event an Application does not supply the - function or data, the facility still operates, and performs - whatever part of its purpose remains meaningful, or - - b) under the GNU GPL, with none of the additional permissions of - this License applicable to that copy. - - 3. Object Code Incorporating Material from Library Header Files. - - The object code form of an Application may incorporate material from -a header file that is part of the Library. You may convey such object -code under terms of your choice, provided that, if the incorporated -material is not limited to numerical parameters, data structure -layouts and accessors, or small macros, inline functions and templates -(ten or fewer lines in length), you do both of the following: - - a) Give prominent notice with each copy of the object code that the - Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the object code with a copy of the GNU GPL and this license - document. - - 4. Combined Works. - - You may convey a Combined Work under terms of your choice that, -taken together, effectively do not restrict modification of the -portions of the Library contained in the Combined Work and reverse -engineering for debugging such modifications, if you also do each of -the following: - - a) Give prominent notice with each copy of the Combined Work that - the Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the Combined Work with a copy of the GNU GPL and this license - document. - - c) For a Combined Work that displays copyright notices during - execution, include the copyright notice for the Library among - these notices, as well as a reference directing the user to the - copies of the GNU GPL and this license document. - - d) Do one of the following: - - 0) Convey the Minimal Corresponding Source under the terms of this - License, and the Corresponding Application Code in a form - suitable for, and under terms that permit, the user to - recombine or relink the Application with a modified version of - the Linked Version to produce a modified Combined Work, in the - manner specified by section 6 of the GNU GPL for conveying - Corresponding Source. - - 1) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (a) uses at run time - a copy of the Library already present on the user's computer - system, and (b) will operate properly with a modified version - of the Library that is interface-compatible with the Linked - Version. - - e) Provide Installation Information, but only if you would otherwise - be required to provide such information under section 6 of the - GNU GPL, and only to the extent that such information is - necessary to install and execute a modified version of the - Combined Work produced by recombining or relinking the - Application with a modified version of the Linked Version. (If - you use option 4d0, the Installation Information must accompany - the Minimal Corresponding Source and Corresponding Application - Code. If you use option 4d1, you must provide the Installation - Information in the manner specified by section 6 of the GNU GPL - for conveying Corresponding Source.) - - 5. Combined Libraries. - - You may place library facilities that are a work based on the -Library side by side in a single library together with other library -facilities that are not Applications and are not covered by this -License, and convey such a combined library under terms of your -choice, if you do both of the following: - - a) Accompany the combined library with a copy of the same work based - on the Library, uncombined with any other library facilities, - conveyed under the terms of this License. - - b) Give prominent notice with the combined library that part of it - is a work based on the Library, and explaining where to find the - accompanying uncombined form of the same work. - - 6. Revised Versions of the GNU Lesser General Public License. - - The Free Software Foundation may publish revised and/or new versions -of the GNU Lesser 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 -Library as you received it specifies that a certain numbered version -of the GNU Lesser General Public License "or any later version" -applies to it, you have the option of following the terms and -conditions either of that published version or of any later version -published by the Free Software Foundation. If the Library as you -received it does not specify a version number of the GNU Lesser -General Public License, you may choose any version of the GNU Lesser -General Public License ever published by the Free Software Foundation. - - If the Library as you received it specifies that a proxy can decide -whether future versions of the GNU Lesser General Public License shall -apply, that proxy's public statement of acceptance of any version is -permanent authorization for you to choose that version for the -Library. diff --git a/common/ini/Makefile.am b/common/ini/Makefile.am deleted file mode 100644 index ee6c6dee0..000000000 --- a/common/ini/Makefile.am +++ /dev/null @@ -1,86 +0,0 @@ -#DEBUG_FLAGS=@DEBUG_VAR@ -TRACE_LEVEL=@TRACE_VAR@ - -builddir ?= . - -topdir=$(srcdir)/.. -topbuilddir=$(builddir)/.. - -AM_CFLAGS = -if HAVE_GCC - AM_CFLAGS += \ - -Wall -Wshadow -Wstrict-prototypes -Wpointer-arith -Wcast-qual \ - -Wcast-align -Wwrite-strings -endif - -AM_CPPFLAGS = -I$(topdir) -I$(topdir)/trace -I$(topdir)/collection \ - -I$(topdir)/path_utils -I$(topdir)/refarray $(TRACE_LEVEL) - -ACLOCAL_AMFLAGS = -I m4 - -# Set up the pkg-config file -pkgconfigdir = $(libdir)/pkgconfig -dist_pkgconfig_DATA = ini_config.pc - -dist_noinst_DATA = \ - ini.conf \ - ini.d/real.conf \ - ini.d/test.conf \ - m4 - -dist_include_HEADERS = \ - ini_config.h - -# Build library -lib_LTLIBRARIES = libini_config.la -libini_config_la_SOURCES = \ - ini_config.c \ - ini_config.h \ - ini_get_value.c \ - ini_get_array.c \ - ini_list.c \ - ini_print.c \ - ini_parse.c \ - ini_parse.h \ - ini_metadata.c \ - ini_metadata.h \ - ini_defines.h \ - ini_comment.c \ - ini_comment.h - - -libini_config_la_LIBADD = \ - -L$(topbuilddir)/collection \ - -L$(topbuilddir)/path_utils \ - -L$(topbuilddir)/refarray \ - -lcollection \ - -lref_array \ - -lpath_utils -libini_config_la_LDFLAGS = \ - -version-info 2:0:0 - -# Build unit test -check_PROGRAMS = ini_config_ut ini_comment_ut -ini_config_ut_SOURCES = ini_config_ut.c -ini_config_ut_LDADD = libini_config.la -L$(topbuilddir)/collection -lcollection -ini_comment_ut_SOURCES = ini_comment_ut.c -ini_comment_ut_LDADD = libini_config.la - -if HAVE_DOXYGEN -docs: -# A temp way of building docs until we hook into the package build - rm -fR doc - mkdir -p doc - $(DOXYGEN) ini_config.cfg.doxy -else -docs: - @echo "Doxygen not installed, cannot generate documentation" - @exit 1 -endif - -TESTS = ini_config_ut ini_comment_ut - -tests: all $(check_PROGRAMS) - -clean-local: - rm -Rf doc diff --git a/common/ini/configure.ac b/common/ini/configure.ac deleted file mode 100644 index eb3e6f2b2..000000000 --- a/common/ini/configure.ac +++ /dev/null @@ -1,30 +0,0 @@ -AC_INIT([ini_config],[0.6.0],[sssd-devel@lists.fedorahosted.org]) -AC_CONFIG_SRCDIR([ini_config.c]) -AC_CONFIG_AUX_DIR([build]) -AM_INIT_AUTOMAKE([-Wall -Werror foreign]) -AC_PROG_CC -AC_PROG_LIBTOOL -AC_CONFIG_MACRO_DIR([m4]) -AC_PROG_INSTALL - -AM_CONDITIONAL([HAVE_GCC], [test "$ac_cv_prog_gcc" = yes]) - -m4_pattern_allow([AM_SILENT_RULES]) -AM_SILENT_RULES - -AC_CONFIG_HEADERS([config.h]) - -# Enable trace build -AC_ARG_ENABLE([trace], - [AS_HELP_STRING([--enable-trace[=LEVEL]],[build with low level tracing enabled])], - [trace_level="$enableval"], - [trace_level="0"]) -AS_IF([test ["$trace_level" -gt "0"] -a ["$trace_level" -lt "8"] ],[AC_SUBST([TRACE_VAR],["-DTRACE_LEVEL=$trace_level"])]) - -AC_DEFINE([MAX_KEY], [1024], [Max length of the key in the INI file.]) - -AC_PATH_PROG([DOXYGEN], [doxygen], [false]) -AM_CONDITIONAL([HAVE_DOXYGEN], [test x$DOXYGEN != xfalse ]) - -AC_CONFIG_FILES([Makefile ini_config.cfg.doxy ini_config.pc]) -AC_OUTPUT diff --git a/common/ini/ini.conf b/common/ini/ini.conf deleted file mode 100644 index 0d0c7edb4..000000000 --- a/common/ini/ini.conf +++ /dev/null @@ -1,55 +0,0 @@ -# INI file that is used by unit test - -data = ds,mf.ds,mf.ds,m.ds,mds.,fmds. - dskjh = mdsmdssm ,md.sd, - C1 = "abcd" -;test data - -wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww = haha - - [ - - ] - - [ wwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwwww ] - - -;more data - - = "nmjdsbfmsdn" - s = "nmjdsbfmsdn - - HEX1 = 'ABV1' - HEX2 = 'ABV' - [ ttt ] - -C2 ='Ab' - -int=-44i44 -int2=-66U - -c = - -with creame and sugar - - [ dddd ] - -DC1 = 123U - -f=-9.0.0 -DC2 = -235L -DC3 = -345.8907 - - - [ zoo - - something - - - [ ttt ] - -v=55555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555 -v1=55555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555.55555555555555555555555555555555 - -C3 = -34756.56 -C4 = .9 diff --git a/common/ini/ini.d/real.conf b/common/ini/ini.d/real.conf deleted file mode 100644 index c426ec56f..000000000 --- a/common/ini/ini.d/real.conf +++ /dev/null @@ -1,56 +0,0 @@ -[config] -version = 0.1 - -[monitor] -description = Monitor Configuration -sbusTimeout = 10 -sbusAddress = unix:path=/var/lib/sss/pipes/private/dbus -servicePingTime = 10 -bad_number = 5a - -[services] -description = Local service configuration -activeServices = dp, nss, pam, info - -[services/dp] -description = Data Provider Configuration -command = /usr/libexec/sssd/sssd_dp - -[services/nss] -description = NSS Responder Configuration -unixSocket = /var/lib/sss/pipes/nss -command = /usr/libexec/sssd/sssd_nss - -[services/pam] -command = /usr/libexec/sssd/sssd_pam -description = PAM Responder Configuration -unixSocket = /var/lib/sss/pipes/pam - -[services/info] -description = InfoPipe Configuration -command = ./sbin/sssd_info - -[domains] -domainsOrder = , LOCAL, , EXAMPLE.COM, , SOMEOTHER.COM , , - -[domains/LOCAL] -description = Reserved domain for local configurations -legacy = FALSE -enumerate = 3 - -[domains/EXAMPLE.COM] -description = Example domain served by IPA -provider = ipa -server = ipaserver1.example.com -server = ipabackupserver.example.com -legacy = FALSE -enumerate = 0 -binary_test = '010203' -long_array = 1 2; 4' ;8p .16/ 32? -double_array = 1.1 2.222222; .4' . ;8p .16/ -32? -empty_value = -space_value = " " -int32_t = -1000000000 -uint32_t = 3000000000 -int64_t = -1000000000123 -uint64_t = 3000000000123 diff --git a/common/ini/ini.d/test.conf b/common/ini/ini.d/test.conf deleted file mode 100644 index 68e9c674d..000000000 --- a/common/ini/ini.d/test.conf +++ /dev/null @@ -1,41 +0,0 @@ - -data = ds,mf.ds,mf.ds,m.ds,mds.,fmds. - dskjh = mdsmdssm ,md.sd, - C1 = "abcd" -;test data - - - -;more data - - = "nmjdsbfmsdn" - s = "nmjdsbfmsdn - - HEX1 = 'ABV1' - HEX2 = 'ABV' - [ ttt ] - -C2 ='AbBB' - -int=-44i44 -int2=-66U - -c = - - - [ dddd1 ] - -DC1 = 123U - -f=-9.0.0 -DC2 = -235L -DC3 = -345.8907 - - - [ ttt2 ] - -v=55555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555 -v1=55555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555555.55555555555555555555555555555555 - -C3 = -34756.56 -C4 = .9 diff --git a/common/ini/ini_comment.c b/common/ini/ini_comment.c deleted file mode 100644 index 30d21b28c..000000000 --- a/common/ini/ini_comment.c +++ /dev/null @@ -1,509 +0,0 @@ -/* - INI LIBRARY - - Object to handle comments - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2010 - - INI Library 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. - - INI Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with INI Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#define _GNU_SOURCE -#include <errno.h> -#include <string.h> -#include <ctype.h> -#include "config.h" -#include "trace.h" -#include "ref_array.h" -#include "ini_comment.h" - -/* The lines will increment in this number */ -#define INI_COMMENT_BLOCK 10 - -/***************************/ -/* Internal comment states */ -/***************************/ -/* Empty - initial */ -#define INI_COMMENT_EMPTY 0 -/* Read - read from file */ -#define INI_COMMENT_READ 1 -/* Comment was altered */ -#define INI_COMMENT_CHANGED 2 - - -/*********************************/ -/* Modes to wrap ref array calls */ -/*********************************/ -#define INI_COMMENT_MODE_BUILD 1 -#define INI_COMMENT_MODE_APPEND 2 -#define INI_COMMENT_MODE_INSERT 3 -#define INI_COMMENT_MODE_REPLACE 4 -#define INI_COMMENT_MODE_REMOVE 5 -#define INI_COMMENT_MODE_CLEAR 6 - -/****************************************/ -/* Internal structure to hold a comment */ -/****************************************/ -struct ini_comment { - struct ref_array *ra; - uint32_t state; -}; - - -/****************************************/ - -/* Destroy the comment object */ -void ini_comment_destroy(struct ini_comment *ic) -{ - - TRACE_FLOW_STRING("ini_comment_destroy", "Entry"); - if (ic) { - /* Function will check for NULL */ - ref_array_destroy(ic->ra); - free(ic); - } - TRACE_FLOW_STRING("ini_comment_destroy", "Exit"); -} - - -/* Cleanup callback */ -void ini_comment_cb(void *elem, - ref_array_del_enum type, - void *data) -{ - - TRACE_FLOW_STRING("ini_comment_cb", "Entry"); - free(*((char **)elem)); - TRACE_FLOW_STRING("ini_comment_cb", "Exit"); -} - - -/* Create a comment object */ -int ini_comment_create(struct ini_comment **ic) -{ - int error = EOK; - struct ref_array *ra = NULL; - struct ini_comment *ic_new = NULL; - - TRACE_FLOW_STRING("ini_comment_create", "Entry"); - - error = ref_array_create(&ra, - sizeof(char *), - INI_COMMENT_BLOCK, - ini_comment_cb, - NULL); - if (error) { - TRACE_ERROR_NUMBER("Error creating ref array", error); - return error; - } - - ic_new = malloc(sizeof(struct ini_comment)); - if (!ic_new) { - TRACE_ERROR_NUMBER("Memory allocation error", ENOMEM); - ref_array_destroy(ic_new->ra); - return ENOMEM; - } - - /* Initialize members here */ - ic_new->ra = ra; - ic_new->state = INI_COMMENT_EMPTY; - - *ic = ic_new; - - TRACE_FLOW_STRING("ini_comment_create", "Exit"); - return error; -} - - -/* Is the comment valid? */ -static int ini_comment_is_valid(const char *line) -{ - int i; - - TRACE_FLOW_STRING("ini_comment_is_valid", "Entry"); - - /* Null is ok */ - if (!line) { - TRACE_FLOW_STRING("ini_comment_is_valid", "Exit - NULL str"); - return 1; - } - - /* Empty is Ok or starts with a special symbol */ - if ((line[0] == '\0') || - (line[0] == ';') || - (line[0] == '#')) { - TRACE_FLOW_STRING("ini_comment_is_valid", "Exit - empty or comment"); - return 1; - } - - /* All spaces is Ok too */ - TRACE_INFO_STRING("Line to eval", line); - - i = 0; - while (line[i] != '\0') { - if (!isspace(line[i])) { - TRACE_ERROR_STRING("ini_comment_is_valid", "Invalid comment"); - return 0; - } - i++; - } - - TRACE_FLOW_STRING("ini_comment_is_valid", "Exit - empty str"); - return 1; - -} - - -/* - * Modify the comment object - */ -static int ini_comment_modify(struct ini_comment *ic, - int mode, - uint32_t idx, - const char *line) -{ - int error = EOK; - char *elem = NULL; - char *input = NULL; - char *empty = NULL; - uint32_t i, len = 0; - - TRACE_FLOW_STRING("ini_comment_modify", "Entry"); - - if (!ic) { - TRACE_ERROR_NUMBER("Invalid comment object", EINVAL); - return EINVAL; - } - - - if (mode == INI_COMMENT_MODE_BUILD) { - /* - * Can use this function only if object is empty or - * reading from the file. - */ - if ((ic->state != INI_COMMENT_EMPTY) && - (ic->state != INI_COMMENT_READ)) { - TRACE_ERROR_NUMBER("Invalid use of the function", EINVAL); - return EINVAL; - } - } - - /* Make sure that we ignore "line" in reset case */ - if (mode != INI_COMMENT_MODE_CLEAR) - memcpy(&input, &line, sizeof(char *)); - - if (mode != INI_COMMENT_MODE_REMOVE) { - /* - * Check that provided line is a comment or an empty line. - * Can be NULL too. - */ - if (!ini_comment_is_valid(input)) { - TRACE_ERROR_NUMBER("Invalid comment", EINVAL); - return EINVAL; - } - - /* Dup it */ - if (input) elem = strdup(input); - else elem = strdup(""); - - if (!elem) { - TRACE_ERROR_NUMBER("Memory allocation error", ENOMEM); - return ENOMEM; - } - } - - /* Do action depending on mode */ - switch (mode) { - case INI_COMMENT_MODE_BUILD: - - TRACE_INFO_STRING("BUILD mode", ""); - error = ref_array_append(ic->ra, &elem); - break; - - case INI_COMMENT_MODE_APPEND: - - TRACE_INFO_STRING("Append mode", ""); - error = ref_array_append(ic->ra, &elem); - break; - - case INI_COMMENT_MODE_INSERT: - - TRACE_INFO_STRING("Insert mode", ""); - len = ref_array_len(ic->ra); - if (idx > len) { - /* Fill in empty lines */ - for (i = 0; i < (idx-len); i++) { - empty = strdup(""); - if (empty) { - TRACE_ERROR_NUMBER("Memory problem", ENOMEM); - return ENOMEM; - } - error = ref_array_append(ic->ra, &empty); - if (error) { - TRACE_ERROR_NUMBER("Append problem", error); - free(empty); - return error; - } - } - /* Append last line */ - error = ref_array_append(ic->ra, &elem); - } - else { - /* Insert inside the array */ - error = ref_array_insert(ic->ra, idx, &elem); - } - break; - - - case INI_COMMENT_MODE_REPLACE: - - TRACE_INFO_STRING("Replace mode", ""); - error = ref_array_replace(ic->ra, idx, &elem); - break; - - case INI_COMMENT_MODE_REMOVE: - - TRACE_INFO_STRING("Remove mode", ""); - error = ref_array_remove(ic->ra, idx); - break; - - case INI_COMMENT_MODE_CLEAR: - - TRACE_INFO_STRING("Clear mode", ""); - error = ref_array_replace(ic->ra, idx, &elem); - break; - - default : - - TRACE_ERROR_STRING("Coding error", ""); - error = EINVAL; - - } - - if (error) { - TRACE_ERROR_NUMBER("Failed to append line to an array", error); - free(elem); - return error; - } - - /* Change state */ - if (INI_COMMENT_MODE_BUILD) ic->state = INI_COMMENT_READ; - else ic->state = INI_COMMENT_CHANGED; - - - TRACE_FLOW_STRING("ini_comment_modify", "Exit"); - return error; -} - -/* - * Build up a comment object - use this when reading - * comments from a file. - */ -int ini_comment_build(struct ini_comment *ic, const char *line) -{ - int error = EOK; - - TRACE_FLOW_STRING("ini_comment_build", "Entry"); - - error = ini_comment_modify(ic, INI_COMMENT_MODE_BUILD, 0, line); - - TRACE_FLOW_NUMBER("ini_comment_build - Returning", error); - return error; -} - -/* - * Modify comment by instering a line. - */ -int ini_comment_insert(struct ini_comment *ic, - uint32_t idx, - const char *line) -{ - int error = EOK; - - TRACE_FLOW_STRING("ini_comment_insert", "Entry"); - - error = ini_comment_modify(ic, INI_COMMENT_MODE_INSERT, idx, line); - - TRACE_FLOW_NUMBER("ini_comment_insert - Returning", error); - return error; -} - -/* Modify comment by appending a line. */ -int ini_comment_append(struct ini_comment *ic, const char *line) -{ - int error = EOK; - - TRACE_FLOW_STRING("ini_comment_append", "Entry"); - - error = ini_comment_modify(ic, INI_COMMENT_MODE_APPEND, 0, line); - - TRACE_FLOW_NUMBER("ini_comment_append - Returning", error); - return error; -} - -/* Remove line from the comment.*/ -int ini_comment_remove(struct ini_comment *ic, uint32_t idx) -{ - int error = EOK; - - TRACE_FLOW_STRING("ini_comment_remove", "Entry"); - - error = ini_comment_modify(ic, INI_COMMENT_MODE_REMOVE, idx, NULL); - - TRACE_FLOW_NUMBER("ini_comment_remove - Returning", error); - return error; -} - -/* Clear line in the comment. Line is replaced with an empty line */ -int ini_comment_clear(struct ini_comment *ic, uint32_t idx) -{ - int error = EOK; - - TRACE_FLOW_STRING("ini_comment_clear", "Entry"); - - error = ini_comment_modify(ic, INI_COMMENT_MODE_CLEAR, idx, NULL); - - TRACE_FLOW_NUMBER("ini_comment_clear - Returning", error); - return error; - -} - -/* Replace a line in the comment */ -int ini_comment_replace(struct ini_comment *ic, - uint32_t idx, - const char *line) -{ - int error = EOK; - - TRACE_FLOW_STRING("ini_comment_replace", "Entry"); - - error = ini_comment_modify(ic, INI_COMMENT_MODE_REPLACE, idx, line); - - TRACE_FLOW_NUMBER("ini_comment_replace - Returning", error); - return error; -} - - -/* Reset the comment - clean all lines.*/ -int ini_comment_reset(struct ini_comment *ic) -{ - int error = EOK; - - TRACE_FLOW_STRING("ini_comment_reset", "Entry"); - - if (!ic) { - TRACE_ERROR_NUMBER("Invalid comment object", EINVAL); - return EINVAL; - } - - /* Reset comment if it is not empty */ - if (ic->state != INI_COMMENT_EMPTY) { - ref_array_reset(ic->ra); - ic->state = INI_COMMENT_CHANGED; - } - - TRACE_FLOW_STRING("ini_comment_reset", "Exit"); - return error; -} - -/* Get number of lines */ -int ini_comment_get_numlines(struct ini_comment *ic, uint32_t *num) -{ - int error = EOK; - - TRACE_FLOW_STRING("ini_comment_get_numlines", "Entry"); - - if ((!ic) || (!num)) { - TRACE_ERROR_NUMBER("Invalid argument", EINVAL); - return EINVAL; - } - - error = ref_array_getlen(ic->ra, num); - - TRACE_FLOW_NUMBER("ini_comment_get_numlines - Returning", error); - return error; - -} - -/* Get line */ -int ini_comment_get_line(struct ini_comment *ic, uint32_t idx, char **line) -{ - int error = EOK; - void *res = NULL; - - TRACE_FLOW_STRING("ini_comment_get_line", "Entry"); - - if ((!ic) || (!line)) { - TRACE_ERROR_NUMBER("Invalid argument", EINVAL); - return EINVAL; - } - - res = ref_array_get(ic->ra, idx, (void *)line); - if (!res) { - error = EINVAL; - *line = NULL; - } - TRACE_FLOW_NUMBER("ini_comment_get_line - Returning", error); - return error; -} - -/* Swap lines */ -int ini_comment_swap(struct ini_comment *ic, - uint32_t idx1, - uint32_t idx2) -{ - int error = EOK; - - TRACE_FLOW_STRING("ini_comment_swap", "Entry"); - - if (!ic) { - TRACE_ERROR_NUMBER("Invalid argument", EINVAL); - return EINVAL; - } - - error = ref_array_swap(ic->ra, idx1, idx2); - if ((!error) && (idx1 != idx2)) { - ic->state = INI_COMMENT_CHANGED; - } - - TRACE_FLOW_NUMBER("ini_comment_swap - Returning", error); - return error; -} - - -/* Internal function to print comment */ -void ini_comment_print(struct ini_comment *ic, FILE *file) -{ - int len; - int i; - char *ret = NULL; - - TRACE_FLOW_STRING("ini_comment_print", "Entry"); - - if (!file) { - TRACE_ERROR_NUMBER("Invalid file argument", EINVAL); - return; - } - - if (ic) { - len = ref_array_len(ic->ra); - for (i = 0; i < len; i++) { - ref_array_get(ic->ra, i, &ret); - fprintf(file, "%s\n", ret); - } - } - - TRACE_FLOW_STRING("ini_comment_print", "Exit"); - -} diff --git a/common/ini/ini_comment.h b/common/ini/ini_comment.h deleted file mode 100644 index 05c6a7284..000000000 --- a/common/ini/ini_comment.h +++ /dev/null @@ -1,106 +0,0 @@ -/* - INI LIBRARY - - Header file for comment object. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2010 - - INI Library 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. - - INI Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with INI Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#ifndef INI_COMMENT_H -#define INI_COMMENT_H - -#include <stdint.h> -#include <stdio.h> - -#ifndef EOK -#define EOK 0 -#endif - -struct ini_comment; - -/** - * Create a comment object - */ -int ini_comment_create(struct ini_comment **ic); - -/** - * Destroy the comment object - */ -void ini_comment_destroy(struct ini_comment *ic); - -/** - * Build up a comment object - use this when reading - * comments from a file. - */ -int ini_comment_build(struct ini_comment *ic, - const char *line); - -/** - * Modify comment by instering a line. - * - * idx can be: - * 0 - as first - * 1 - after first - * 2 - after second - * ... - * If greater than number of lines - * missing lines are added automatically - * as empty lines - */ -int ini_comment_insert(struct ini_comment *ic, - uint32_t idx, - const char *line); - -/* Modify comment by appending a line. */ -int ini_comment_append(struct ini_comment *ic, - const char *line); - -/* Remove line from the comment.*/ -int ini_comment_remove(struct ini_comment *ic, - uint32_t idx); - -/* Clear line in the comment. Line is replaced with an empty line */ -int ini_comment_clear(struct ini_comment *ic, - uint32_t idx); - -/* Replace a line in the comment */ -int ini_comment_replace(struct ini_comment *ic, - uint32_t idx, - const char *line); - -/* Reset the comment - clean all lines.*/ -int ini_comment_reset(struct ini_comment *ic); - -/* Get number of lines */ -int ini_comment_get_numlines(struct ini_comment *ic, - uint32_t *num); - -/* Get line */ -int ini_comment_get_line(struct ini_comment *ic, - uint32_t idx, - char **line); - -/* Swap lines */ -int ini_comment_swap(struct ini_comment *ic, - uint32_t idx1, - uint32_t idx2); - - -/* Internal function to print comment */ -void ini_comment_print(struct ini_comment *ic, FILE *file); - - -#endif diff --git a/common/ini/ini_comment_ut.c b/common/ini/ini_comment_ut.c deleted file mode 100644 index 40c15b839..000000000 --- a/common/ini/ini_comment_ut.c +++ /dev/null @@ -1,176 +0,0 @@ -/* - INI LIBRARY - - Unit test for the comment object. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2010 - - INI Library 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. - - INI Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with INI Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#include <stdio.h> -#include <string.h> -#include <errno.h> -#define TRACE_HOME -#include "trace.h" -#include "ini_comment.h" - -int verbose = 0; - -#define INIOUT(foo) \ - do { \ - if (verbose) foo; \ - } while(0) - - -int file_test(void) -{ - int error = EOK; - struct ini_comment *ic = NULL; - - if ((error = ini_comment_create(&ic)) || - (error = ini_comment_build(ic, ";Line 0")) || - (error = ini_comment_build(ic, ";Line 1")) || - (error = ini_comment_build(ic, ";Line 2"))) { - printf("Failed to create comment object %d\n", - error); - ini_comment_destroy(ic); - return -1; - } - - INIOUT(printf("<==== Comment ====>\n")); - INIOUT(ini_comment_print(ic, stdout)); - INIOUT(printf("<=================>\n")); - ini_comment_destroy(ic); - - return error; -} - - -int alter_test(void) -{ - int error = EOK; - struct ini_comment *ic = NULL; - uint32_t i, num = 0; - char *line = NULL; - const char *expected[] = { ";Line 0 inserted", - ";Line 1 inserted", - "", - "", - ";Line 3 replaced", - "", - ";Line 4" }; - - - if ((error = ini_comment_create(&ic)) || - (error = ini_comment_build(ic, ";Line 0")) || - (error = ini_comment_build(ic, NULL)) || - (error = ini_comment_build(ic, ";Line 2")) || - (error = ini_comment_build(ic, ";Line 3")) || - (error = ini_comment_build(ic, ""))) { - printf("Failed to create comment object\n"); - ini_comment_destroy(ic); - return -1; - } - - INIOUT(printf("<==== Comment ====>\n")); - INIOUT(ini_comment_print(ic, stdout)); - INIOUT(printf("<=================>\n")); - - if ((error = ini_comment_append(ic, ";Line 4")) || - (error = ini_comment_clear(ic, 2)) || - (error = ini_comment_replace(ic, 3, ";Line 3 replaced")) || - (error = ini_comment_remove(ic, 0)) || - (error = ini_comment_insert(ic, 0, ";Line 0 inserted")) || - (error = ini_comment_insert(ic, 1, ";Line 1 inserted"))) { - printf("Failed to create comment object\n"); - ini_comment_destroy(ic); - return -1; - } - - INIOUT(printf("<==== Comment ====>\n")); - INIOUT(ini_comment_print(ic, stdout)); - INIOUT(printf("<=================>\n")); - - error = ini_comment_get_numlines(ic, &num); - if (error) { - printf("Failed to get number of lines.\n"); - ini_comment_destroy(ic); - return -1; - } - - for (i = 0; i < num; i++) { - error = ini_comment_get_line(ic, i, &line); - if (error) { - printf("Failed to get line.\n"); - ini_comment_destroy(ic); - return -1; - } - if (strcmp(line, expected[i]) != 0) { - printf("Lines do not match.\n"); - printf("GOT: %s\n", line); - printf("EXP: %s\n", expected[i]); - ini_comment_destroy(ic); - return -1; - } - } - - INIOUT(printf("\n\nSwap test\n\n")); - - if ((error = ini_comment_swap(ic, 0 , 6)) || - (error = ini_comment_swap(ic, 1 , 5)) || - (error = ini_comment_swap(ic, 2 , 4))) { - printf("Failed to swap lines.\n"); - ini_comment_destroy(ic); - return -1; - } - - for (i = 0; i < num; i++) { - error = ini_comment_get_line(ic, i, &line); - if (error) { - printf("Failed to get line.\n"); - ini_comment_destroy(ic); - return -1; - } - if (strcmp(line, expected[6 - i]) != 0) { - printf("Lines do not match.\n"); - printf("GOT: %s\n", line); - printf("EXP: %s\n", expected[6 - i]); - ini_comment_destroy(ic); - return -1; - } - } - - ini_comment_destroy(ic); - return error; -} - - -int main(int argc, char *argv[]) -{ - int error = EOK; - - if ((argc > 1) && (strcmp(argv[1], "-v") == 0)) verbose = 1; - - INIOUT(printf("Start\n")); - - if ((error = file_test()) || - (error = alter_test())) { - printf("Test failed! Error %d.\n", error); - return -1; - } - - INIOUT(printf("Success!\n")); - return 0; -} diff --git a/common/ini/ini_config.c b/common/ini/ini_config.c deleted file mode 100644 index 7ed82b186..000000000 --- a/common/ini/ini_config.c +++ /dev/null @@ -1,846 +0,0 @@ -/* - INI LIBRARY - - Reading configuration from INI file - and storing as a collection. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - INI Library 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. - - INI Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with INI Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#define _GNU_SOURCE -#include <errno.h> -#include <string.h> -#include <stdlib.h> -#include "config.h" -#include "trace.h" -#include "collection.h" -#include "collection_tools.h" -#include "path_utils.h" -#include "ini_defines.h" -#include "ini_parse.h" -#include "ini_metadata.h" -#include "ini_config.h" - - -/***************************************************************************/ -/* Function to read single ini file and pupulate - * the provided collection with subcollcetions from the file */ -static int ini_to_collection(FILE *file, - const char *config_filename, - struct collection_item *ini_config, - int error_level, - struct collection_item **error_list, - struct collection_item *lines) -{ - int error; - int status; - int section_count = 0; - char *key = NULL; - char *value = NULL; - struct collection_item *current_section = NULL; - int length; - int ext_err = -1; - struct parse_error pe; - int line = 0; - int created = 0; - char buf[BUFFER_SIZE+1]; - - - TRACE_FLOW_STRING("ini_to_collection", "Entry"); - - /* Open the collection of errors */ - if (error_list != NULL) { - *error_list = NULL; - error = col_create_collection(error_list, INI_ERROR, COL_CLASS_INI_PERROR); - if (error) { - TRACE_ERROR_NUMBER("Failed to create error collection", error); - return error; - } - /* Add file name as the first item */ - error = col_add_str_property(*error_list, NULL, INI_ERROR_NAME, config_filename, 0); - if (error) { - TRACE_ERROR_NUMBER("Failed to and name to collection", error); - col_destroy_collection(*error_list); - return error; - } - created = 1; - } - - /* Read file lines */ - while (1) { - /* Always read one less than the buffer */ - status = read_line(file, buf, BUFFER_SIZE+1, &key, &value, &length, &ext_err); - if (status == RET_EOF) break; - - line++; - - switch (status) { - case RET_PAIR: - -#ifdef HAVE_VALIDATION - - /* Add line to the collection of lines. - * It is pretty safe in this case to just type cast the value to - * int32_t since it is unrealistic that ini file will ever have - * so many lines. - */ - if (lines) { - error = col_add_int_property(lines, NULL, key, (int32_t)line); - if (error) { - TRACE_ERROR_NUMBER("Failed to add line to line collection", error); - col_destroy_collection(current_section); - if (created) { - col_destroy_collection(*error_list); - *error_list = NULL; - } - return error; - } - } - -#endif /* HAVE_VALIDATION */ - - /* Do we have a section at the top of the file ? */ - if (section_count == 0) { - /* Check if collection already exists */ - error = col_get_collection_reference(ini_config, ¤t_section, - INI_DEFAULT_SECTION); - if (error != EOK) { - /* Create default collection */ - if ((error = col_create_collection(¤t_section, - INI_DEFAULT_SECTION, - COL_CLASS_INI_SECTION)) || - (error = col_add_collection_to_collection(ini_config, - NULL,NULL, - current_section, - COL_ADD_MODE_REFERENCE))) { - TRACE_ERROR_NUMBER("Failed to create collection", error); - col_destroy_collection(current_section); - if (created) { - col_destroy_collection(*error_list); - *error_list = NULL; - } - return error; - } - } - section_count++; - } - - /* Put value into the collection */ - error = col_insert_str_property(current_section, - NULL, - COL_DSP_END, - NULL, - 0, - COL_INSERT_DUPOVER, - key, - value, - length); - if (error != EOK) { - TRACE_ERROR_NUMBER("Failed to add pair to collection", error); - col_destroy_collection(current_section); - if (created) { - col_destroy_collection(*error_list); - *error_list = NULL; - } - return error; - } - break; - - case RET_SECTION: - -#ifdef HAVE_VALIDATION - - /* Add line to the collection of lines */ - if (lines) { - /* For easier search make line numbers for the sections negative. - * This would allow differentiating sections and attributes. - * It is pretty safe in this case to just type cast the value to - * int32_t since it is unrealistic that ini file will ever have - * so many lines. - */ - error = col_add_int_property(lines, NULL, key, (int32_t)(-1 * line)); - if (error) { - TRACE_ERROR_NUMBER("Failed to add line to line collection", error); - col_destroy_collection(current_section); - if (created) { - col_destroy_collection(*error_list); - *error_list = NULL; - } - return error; - } - } - -#endif /* HAVE_VALIDATION */ - - /* Read a new section */ - col_destroy_collection(current_section); - current_section = NULL; - - error = col_get_collection_reference(ini_config, ¤t_section, key); - if (error != EOK) { - /* Create default collection */ - if ((error = col_create_collection(¤t_section, key, - COL_CLASS_INI_SECTION)) || - (error = col_add_collection_to_collection(ini_config, - NULL, NULL, - current_section, - COL_ADD_MODE_REFERENCE))) { - TRACE_ERROR_NUMBER("Failed to add collection", error); - col_destroy_collection(current_section); - if (created) { - col_destroy_collection(*error_list); - *error_list = NULL; - } - return error; - } - } - section_count++; - break; - - case RET_EMPTY: - TRACE_INFO_STRING("Empty string", ""); - break; - - case RET_COMMENT: - TRACE_INFO_STRING("Comment", ""); - break; - - case RET_ERROR: - /* Try to add to the error list only if it is present */ - if (error_list) { - pe.line = line; - pe.error = ext_err; - error = col_add_binary_property(*error_list, NULL, - ERROR_TXT, &pe, sizeof(pe)); - if (error) { - TRACE_ERROR_NUMBER("Failed to add error to collection", - error); - col_destroy_collection(current_section); - if (created) { - col_destroy_collection(*error_list); - *error_list = NULL; - } - return error; - } - } - - /* Exit if there was an error parsing file */ - if (error_level != INI_STOP_ON_NONE) { - TRACE_ERROR_STRING("Invalid format of the file", ""); - col_destroy_collection(current_section); - return EIO; - } - break; - - case RET_INVALID: - default: - /* Try to add to the error list only if it is present */ - if (error_list) { - pe.line = line; - pe.error = ext_err; - error = col_add_binary_property(*error_list, NULL, - WARNING_TXT, &pe, sizeof(pe)); - if (error) { - TRACE_ERROR_NUMBER("Failed to add warning to collection", - error); - col_destroy_collection(current_section); - if (created) { - col_destroy_collection(*error_list); - *error_list = NULL; - } - return error; - } - } - - /* Exit if we are told to exit on warnings */ - if (error_level == INI_STOP_ON_ANY) { - TRACE_ERROR_STRING("Invalid format of the file", ""); - if (created) col_destroy_collection(current_section); - return EIO; - } - TRACE_ERROR_STRING("Invalid string", ""); - break; - } - ext_err = -1; - } - - /* Note: File is not closed on this level any more. - * It opened on the level above, checked and closed there. - * It is not the responsibility of this function to close - * file any more. - */ - - COL_DEBUG_COLLECTION(ini_config); - - col_destroy_collection(current_section); - - COL_DEBUG_COLLECTION(ini_config); - - TRACE_FLOW_STRING("ini_to_collection", "Success Exit"); - - return EOK; -} - -/*********************************************************************/ -/* Function to free configuration */ -void free_ini_config(struct collection_item *ini_config) -{ - TRACE_FLOW_STRING("free_ini_config", "Entry"); - col_destroy_collection(ini_config); - TRACE_FLOW_STRING("free_ini_config", "Exit"); -} - -/* Function to free configuration error list */ -void free_ini_config_errors(struct collection_item *error_set) -{ - TRACE_FLOW_STRING("free_ini_config_errors", "Entry"); - col_destroy_collection(error_set); - TRACE_FLOW_STRING("free_ini_config_errors", "Exit"); -} - -#ifdef HAVE_VALIDATION - -/* Function to free configuration lines list. - * - * The following doxygen description is moved here. - * When the function gets exposed move it into - * the header file. - */ -/** - * @brief Function to free lines object. - * - * EXPERIMENTAL. Reserved for future use. - * - * @param[in] lines Lines object. - * - */ - -void free_ini_config_lines(struct collection_item *lines) -{ - TRACE_FLOW_STRING("free_ini_config_lines", "Entry"); - col_destroy_collection(lines); - TRACE_FLOW_STRING("free_ini_config_lines", "Exit"); -} - -#endif /* HAVE_VALIDATION */ - - -/* Read configuration information from a file */ -int config_from_file(const char *application, - const char *config_filename, - struct collection_item **ini_config, - int error_level, - struct collection_item **error_list) -{ - int error; - - TRACE_FLOW_STRING("config_from_file", "Entry"); - error = config_from_file_with_metadata(application, - config_filename, - ini_config, - error_level, - error_list, - 0, - NULL); - TRACE_FLOW_NUMBER("config_from_file. Returns", error); - return error; -} - -/* Read configuration information from a file descriptor */ -int config_from_fd(const char *application, - int fd, - const char *config_source, - struct collection_item **ini_config, - int error_level, - struct collection_item **error_list) -{ - int error; - - TRACE_FLOW_STRING("config_from_fd", "Entry"); - error = config_from_fd_with_metadata(application, - fd, - config_source, - ini_config, - error_level, - error_list, - 0, - NULL); - TRACE_FLOW_NUMBER("config_from_fd. Returns", error); - return error; -} - - - -/* Low level function that prepares the collection - * and calls parser. - */ -static int config_with_metadata(const char *application, - FILE *config_file, - const char *config_source, - struct collection_item **ini_config, - int error_level, - struct collection_item **error_list, - uint32_t metaflags, - struct collection_item **metadata) -{ - int error; - int created = 0; - struct collection_item *lines = NULL; - -#ifdef HAVE_VALIDATION - int created_lines = 0; -#endif - - TRACE_FLOW_STRING("config_from_file", "Entry"); - - /* Now we check arguments in the calling functions. */ - - /* Create collection if needed */ - if (*ini_config == NULL) { - error = col_create_collection(ini_config, - application, - COL_CLASS_INI_CONFIG); - if (error != EOK) { - TRACE_ERROR_NUMBER("Failed to create collection", error); - return error; - } - created = 1; - } - /* Is the collection of the right class? */ - else if (((col_is_of_class(*ini_config, COL_CLASS_INI_CONFIG))== 0) && - ((col_is_of_class(*ini_config, COL_CLASS_INI_META))== 0)) { - TRACE_ERROR_NUMBER("Wrong collection type", EINVAL); - return EINVAL; - } - -#ifdef HAVE_VALIDATION - /* This code is preserved for future use */ - error = col_create_collection(lines, - application, - COL_CLASS_INI_LINES); - if (error != EOK) { - TRACE_ERROR_NUMBER("Failed to create collection", error); - if (created) { - col_destroy_collection(*ini_config); - *ini_config = NULL; - } - return error; - } - created_lines = 1; -#else - /* Until we implement validation do not read the lines. */ - lines = NULL; -#endif /* HAVE_VALIDATION */ - - /* Do the actual work - for now do not read lines.*/ - error = ini_to_collection(config_file, config_source, - *ini_config, error_level, - error_list, lines); - /* In case of error when we created collection - delete it */ - if (error && created) { - col_destroy_collection(*ini_config); - *ini_config = NULL; - } - - /* FIXME - put lines collection into the metadata */ - - TRACE_FLOW_NUMBER("config_from_file. Returns", error); - return error; -} - -/* Function to read the ini file from fd - * with meta data. - */ -int config_from_fd_with_metadata(const char *application, - int ext_fd, - const char *config_filename, - struct collection_item **ini_config, - int error_level, - struct collection_item **error_list, - uint32_t metaflags, - struct collection_item **metadata) -{ - int error = EOK; - int file_error = EOK; - int save_error = 0; - int fd = -1; - FILE *config_file = NULL; - char abs_name[PATH_MAX + 1]; - char buff[CONVERSION_BUFFER]; - - TRACE_FLOW_STRING("config_from_fd_with_metadata", "Entry"); - - /* We need to check arguments before we can move on, - * and start allocating memory. - */ - if ((ini_config == NULL) || - (application == NULL)) { - TRACE_ERROR_NUMBER("Invalid argument", EINVAL); - return EINVAL; - } - - /* Prepare meta data */ - error = prepare_metadata(metaflags, metadata, &save_error); - if (error) { - TRACE_ERROR_NUMBER("Failed to prepare metadata", error); - return error; - } - - errno = 0; - - if (ext_fd == -1) { - /* No file descriptor so use name */ - config_file = fopen(config_filename, "r"); - } - else { - /* Create a copy of the descriptor so that we can close it if needed */ - fd = dup(ext_fd); - if (fd != -1) config_file = fdopen(fd, "r"); - } - file_error = errno; - - if (save_error) { - /* Record the result of the open file operation in metadata */ - snprintf(buff, CONVERSION_BUFFER, "%d", file_error); - error = col_add_str_property(*metadata, - INI_META_SEC_ERROR, - INI_META_KEY_READ_ERROR, - buff, - 0); - if (error) { - /* Something is really wrong if we failed here */ - TRACE_ERROR_NUMBER("Failed to save file open error", error); - if (config_file) fclose(config_file); - return error; - } - } - - if(!config_file) { - TRACE_ERROR_NUMBER("Failed to open file", file_error); - return file_error; - } - - /* Normalize path for reporting purposes */ - error = make_normalized_absolute_path(abs_name, - PATH_MAX, - config_filename); - if(error) { - TRACE_ERROR_NUMBER("Failed to resolve path", error); - fclose(config_file); - return error; - } - - - if (metadata) { - /* Collect meta data before actually parsing the file */ - error = collect_metadata(metaflags, - metadata, - config_file, - abs_name); - if(error) { - TRACE_ERROR_NUMBER("Failed to collect metadata", error); - fclose(config_file); - return error; - } - } - - if (!(metaflags & INI_META_ACTION_NOPARSE)) { - /* Parse data if needed */ - error = config_with_metadata(application, - config_file, - abs_name, - ini_config, - error_level, - error_list, - metaflags, - metadata); - } - - /* We opened the file we close it */ - fclose(config_file); - - TRACE_FLOW_NUMBER("config_from_fd_with_metadata. Returns", error); - return error; -} - -/* Function to read the ini file with metadata - * using file name. - */ -int config_from_file_with_metadata(const char *application, - const char *config_filename, - struct collection_item **ini_config, - int error_level, - struct collection_item **error_list, - uint32_t metaflags, - struct collection_item **metadata) -{ - int error = EOK; - TRACE_FLOW_STRING("config_from_file_with_metadata", "Entry"); - - error = config_from_fd_with_metadata(application, - -1, - config_filename, - ini_config, - error_level, - error_list, - metaflags, - metadata); - - TRACE_FLOW_STRING("config_from_file_with_metadata", "Exit"); - return error; -} - - -/* Read default config file and then overwrite it with a specific one - * from the directory */ -int config_for_app_with_metadata(const char *application, - const char *config_file, - const char *config_dir, - struct collection_item **ini_config, - int error_level, - struct collection_item **error_set, - uint32_t metaflags, - struct collection_item **meta_default, - struct collection_item **meta_appini) -{ - int error = EOK; - char *file_name; - struct collection_item *error_list_common = NULL; - struct collection_item *error_list_specific = NULL; - struct collection_item **pass_common = NULL; - struct collection_item **pass_specific = NULL; - int created = 0; - int tried = 0; - int noents = 0; - - TRACE_FLOW_STRING("config_for_app", "Entry"); - - if (ini_config == NULL) { - TRACE_ERROR_NUMBER("Invalid parameter", EINVAL); - return EINVAL; - } - - if ((config_file == NULL) && (config_dir == NULL)) { - TRACE_ERROR_NUMBER("Noop call of the function is invalid", EINVAL); - return EINVAL; - } - - /* Prepare error collection pointers */ - if (error_set != NULL) { - TRACE_INFO_STRING("Error set is not NULL", "preparing error set"); - pass_common = &error_list_common; - pass_specific = &error_list_specific; - *error_set = NULL; - /* Construct the overarching error collection */ - error = col_create_collection(error_set, - FILE_ERROR_SET, - COL_CLASS_INI_PESET); - if (error != EOK) { - TRACE_ERROR_NUMBER("Failed to create collection", error); - return error; - } - } - else { - TRACE_INFO_STRING("No error set. Errors will not be captured", ""); - pass_common = NULL; - pass_specific = NULL; - } - - /* Create collection if needed */ - if (*ini_config == NULL) { - TRACE_INFO_STRING("New config collection. Allocate.", ""); - error = col_create_collection(ini_config, - application, - COL_CLASS_INI_CONFIG); - if (error != EOK) { - TRACE_ERROR_NUMBER("Failed to create collection", error); - if (error_set) { - col_destroy_collection(*error_set); - *error_set = NULL; - } - return error; - } - created = 1; - } - /* Is the collection of the right class? */ - else if ((col_is_of_class(*ini_config, COL_CLASS_INI_CONFIG) == 0) && - (col_is_of_class(*ini_config, COL_CLASS_INI_META) == 0)) { - TRACE_ERROR_NUMBER("Wrong collection type", EINVAL); - return EINVAL; - } - - /* Read master file */ - if (config_file != NULL) { - TRACE_INFO_STRING("Reading master file:", config_file); - /* Get configuration information from the file */ - error = config_from_file_with_metadata(application, - config_file, - ini_config, - error_level, - pass_common, - metaflags, - meta_default); - tried++; - /* ENOENT and EOK are Ok */ - if (error) { - if (error != ENOENT) { - TRACE_ERROR_NUMBER("Failed to read master file", error); - /* In case of error when we created collection - delete it */ - if(error && created) { - col_destroy_collection(*ini_config); - *ini_config = NULL; - } - /* We do not clear the error_set here */ - return error; - } - else noents++; - } - /* Add error results if any to the overarching error collection */ - if ((pass_common != NULL) && (*pass_common != NULL)) { - TRACE_INFO_STRING("Process errors resulting from file:", config_file); - error = col_add_collection_to_collection(*error_set, NULL, NULL, - *pass_common, - COL_ADD_MODE_EMBED); - if (error) { - if (created) { - col_destroy_collection(*ini_config); - *ini_config = NULL; - } - if (error_set) { - col_destroy_collection(*error_set); - *error_set = NULL; - } - TRACE_ERROR_NUMBER("Failed to add error collection to another error collection", error); - return error; - } - } - } - - if (config_dir != NULL) { - /* Get specific application file */ - file_name = malloc(strlen(config_dir) + strlen(application) + NAME_OVERHEAD); - if (file_name == NULL) { - error = ENOMEM; - TRACE_ERROR_NUMBER("Failed to allocate memory for file name", error); - /* In case of error when we created collection - delete it */ - if(created) { - col_destroy_collection(*ini_config); - *ini_config = NULL; - } - if (error_set) { - col_destroy_collection(*error_set); - *error_set = NULL; - } - return error; - } - - sprintf(file_name, "%s%s%s.conf", config_dir, SLASH, application); - TRACE_INFO_STRING("Opening file:", file_name); - /* Read specific file */ - error = config_from_file_with_metadata(application, - file_name, - ini_config, - error_level, - pass_specific, - metaflags, - meta_appini); - tried++; - free(file_name); - /* ENOENT and EOK are Ok */ - if (error) { - if (error != ENOENT) { - TRACE_ERROR_NUMBER("Failed to read specific application file", error); - /* In case of error when we created collection - delete it */ - if (error && created) { - col_destroy_collection(*ini_config); - *ini_config = NULL; - } - /* We do not clear the error_set here */ - return error; - } - else noents++; - } - /* Add error results if any to the overarching error collection */ - if ((pass_specific != NULL) && (*pass_specific != NULL)) { - error = col_add_collection_to_collection(*error_set, NULL, NULL, - *pass_specific, - COL_ADD_MODE_EMBED); - if (error) { - if (created) { - col_destroy_collection(*ini_config); - *ini_config = NULL; - } - if (error_set) { - col_destroy_collection(*error_set); - *error_set = NULL; - } - TRACE_ERROR_NUMBER("Failed to add error collection to another error collection", error); - return error; - } - } - } - - /* If we failed to read or access file as many - * times as we tried and we told to stop on any errors - * we should report an error. - */ - TRACE_INFO_NUMBER("Tried:", tried); - TRACE_INFO_NUMBER("Noents:", noents); - - if ((tried == noents) && (error_level == INI_STOP_ON_ANY)) { - TRACE_ERROR_NUMBER("Fail to read or access all the files tried", ENOENT); - if (created) { - col_destroy_collection(*ini_config); - *ini_config = NULL; - } - if (error_set) { - col_destroy_collection(*error_set); - *error_set = NULL; - } - return ENOENT; - } - - TRACE_FLOW_STRING("config_to_collection", "Exit"); - return EOK; -} - - -/* Function to return configuration data - * for the application without meta data. - */ -int config_for_app(const char *application, - const char *config_file, - const char *config_dir, - struct collection_item **ini_config, - int error_level, - struct collection_item **error_set) -{ - int error = EOK; - TRACE_FLOW_STRING("config_for_app", "Entry"); - - error = config_for_app_with_metadata(application, - config_file, - config_dir, - ini_config, - error_level, - error_set, - 0, - NULL, - NULL); - - TRACE_FLOW_NUMBER("config_for_app. Returning", error); - return error; -} diff --git a/common/ini/ini_config.cfg.doxy.in b/common/ini/ini_config.cfg.doxy.in deleted file mode 100644 index f7763f4f3..000000000 --- a/common/ini/ini_config.cfg.doxy.in +++ /dev/null @@ -1,1566 +0,0 @@ -# Doxyfile 1.6.3 - -# 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 = "libini_config" - -# 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 = @PACKAGE_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 = doc - -# 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 = YES - -# 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 = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the - -# 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 = YES - -# 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 = NO - -# 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 = NO - -# 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 = YES - -# 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 = YES - -# 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 = NO - -# 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 = YES - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen -# will list include files with double quotes in the documentation -# rather than with sharp brackets. - -FORCE_LOCAL_INCLUDES = 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 = NOGENERATE MAN - -# 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 = NO - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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 = NO - -# 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 = @srcdir@ - -# 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 = *.c *.h - -# 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 = *_ut.c config.h - -# 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 = - -# 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 - -# If the HTML_FOOTER_DESCRIPTION tag is set to YES, Doxygen will -# add generated date, project name and doxygen version to HTML footer. - -HTML_FOOTER_DESCRIPTION= NO - -# 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_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting -# this to NO can help when comparing the output of multiple runs. - -HTML_TIMESTAMP = YES - -# 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 = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files -# will be generated, which together with the HTML files, form an Eclipse help -# plugin. To install this plugin and make it available under the help contents -# menu in Eclipse, the contents of the directory containing the HTML and XML -# files needs to be copied into the plugins directory of eclipse. The name of -# the directory within the plugins directory should be the same as -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have -# this name. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# 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 enabled 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), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should -# typically be disabled. For large projects the javascript based search engine -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. - -SEARCHENGINE = YES - -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index -# file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup -# and does not have live searching capabilities. - -SERVER_BASED_SEARCH = 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. -# Note that when enabling USE_PDFLATEX this option is only used for -# generating bitmaps for formulas in the HTML output, but not in the -# Makefile that is written to the output directory. - -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 = YES - -# 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 = YES - -# 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 = NO - -# 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 = YES - -# 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 = YES - -# 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 = NO - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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/common/ini/ini_config.h b/common/ini/ini_config.h deleted file mode 100644 index 28e1af8df..000000000 --- a/common/ini/ini_config.h +++ /dev/null @@ -1,1791 +0,0 @@ -/* - INI LIBRARY - - Header file for reading configuration from INI file - and storing as a collection. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - INI Library 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. - - INI Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with INI Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#ifndef INI_CONFIG_H -#define INI_CONFIG_H - -#include <sys/types.h> -#include <sys/stat.h> -#include <unistd.h> -#include <limits.h> -#include <stdio.h> -#include "collection.h" - -/** @mainpage The INI configuration interface - * - * The goal of the this interface is to allow applications - * to read configuration from the INI file. - * - * So why yet another library to read data from INI file? - * As we started the SSSD project we looked around for a - * open source library that would meet the following - * requirements: - * - Is written in C (not C++) - * - Is lightweight. - * - Has an live community. - * - Supported on multiple platforms . - * - Can evolve as we build SSSD solution. - * - Can deal with different types of values including arrays. - * - Can deal with sections that are related to each other - * and can form a hierarchy of sections. - * - Has a compatible license we can use. - * - * We have seen several solutions but none was able to address our - * requirements fully. As a result we started developing our own - * INI parsing library. It is currently stable, however there is - * a list of the enhancements that we eventually plan to implement. - * One of the most interesting future features is the grammar - * validation utility. It is targeted at helping to diagnose - * a misconfiguration. - * - * Currently INI parser allows reading and merging INI files - * and getting a resulting configuration in one object. - * - * One of the main differences of this interface is that - * the library is created with the idea of reading the configuration - * data not managing it. Thus currently you will not find - * any function that alters the configuration data read from the files. - * There is a set of proposed enhancements to be able to manipulate - * the configuration data and save it back but there have been no real - * driver for it. This API is focused on letting applications read data - * from a file (or files) and interpret it, not to generate configuration - * files. There are all sorts of different tools that already do that. - * - * The INI configuration interface uses COLLECTION (see libcollection - * interface) to store data internally. - * - * Concepts: - * - The INI file consists of the key value pairs. - * - The keys and values are separated by the equal sign. - * The spaces around equal sign are trimmed. Everything before the equal - * sign is the key, everything after is the value. - * - Comments are the lines that start with ";" or "#" in the first - * position of the line. - * - Library currently does not support multi-line values. - * - The keys and values are read and stored in the internal - * collection. - * - More than one file can constitute the configuration for the application. - * For example there can be a generic file in the /etc that - * contains configuration for all the applications of this class running - * on the box and then there might be a special file - * with parameters specific for the application in the - * /etc/whatever.d directory. Interface allows reading - * both files in one call. The specific configuration for application - * will overwrite the generic one. - * - If there is no section in the file or there are key value pairs - * declared before the first section those pairs will be placed into - * the default section. - * - The values are treated as strings. Spaces are trimmed at the beginning - * and the end of the value. The value ends at the end of the line. - * If values is too long an error will be returned. - * - Parsing of the values happens when the caller tries to interpret - * the value. The caller can use different functions to do this. - * The value can be treated as numeric, logical, string, binary, - * array of strings or array of numbers. In case of arrays the functions - * accept separators that will be used to slice the value into the array - * elements. - * - If there is any error parsing the section and key values it can be - * intercepted by the caller. There are different modes that the library - * supports regarding error handling. See details in the description - * of the individual functions. - */ - -/** - * @defgroup ini_config INI configuration interface - * @{ - */ - -/** - * @defgroup constants Constants - * @{ - */ - -/** - * @brief Name of the default section. - * - * This is the name of the implied section where orphan key-value - * pairs will be put. - */ -#define INI_DEFAULT_SECTION "default" - -/** - * @defgroup classes Collection classes - * - * INI uses COLLECTION library to store data. - * It creates different objects with implied internal structure. - * To be able to validate the objects - * it is a good practice to define a class for each type of - * the object. - * - * This section contains constants that define - * internal collection classes used by INI interface. - * They are exposed so that if you use collection for - * other purposes you can make sure that the object classes - * do not overlap. It is a good practice to avoid - * them overlapping. Non-overlapping class space - * would make internal type checking more effective - * so that if an object of the wrong class is passed to - * some interface the interface would be able to - * check and detect an error. - * - * @{ - */ -/** @brief Base for the class definitions. */ -#define COL_CLASS_INI_BASE 20000 -/** - * @brief Class for the configuration object. - * - * The configuration object consists of the collection - * of collections where each sub collection is a section. - * Application however should not assume that this always - * be the case. Use only INI interface functions - * get data from the configuration object. - * Do not use the raw collection interface to get - * data. - */ -#define COL_CLASS_INI_CONFIG COL_CLASS_INI_BASE + 0 -/** - * @brief A one level collection of key value pairs - * where values are always strings. - */ -#define COL_CLASS_INI_SECTION COL_CLASS_INI_BASE + 1 -/** - * @brief A one level collection of parse errors. - * - * Collection stores \ref parse_error structures. - */ -#define COL_CLASS_INI_PERROR COL_CLASS_INI_BASE + 2 -/** - * @brief Collection of error collections. - * - * When multiple files are read during one call - * each file has its own set of parsing errors - * and warnings. This is the collection - * of such sets. - */ -#define COL_CLASS_INI_PESET COL_CLASS_INI_BASE + 3 - -/** - * @brief Collection of metadata. - * - * Collection that stores metadata. - */ -#define COL_CLASS_INI_META COL_CLASS_INI_BASE + 4 -/** - * @} - */ - -/** - * @defgroup errorlevel Error tolerance constants - * - * Constants in this section define what to do if - * error or warning encountered while parsing the INI file. - * - * @{ - */ -/** @brief Fail if any problem is detected. */ -#define INI_STOP_ON_ANY 0 -/** @brief Best effort - do not fail. */ -#define INI_STOP_ON_NONE 1 -/** @brief Fail on errors only. */ -#define INI_STOP_ON_ERROR 2 - -/** - * @} - */ - -/** - * @defgroup parseerr Parsing errors and warnings - * - * @{ - */ -/** @brief Line is too long (Error). */ -#define ERR_LONGDATA 1 -/** @brief No closing bracket in section definition (Error). */ -#define ERR_NOCLOSESEC 2 -/** @brief Section name is missing (Error). */ -#define ERR_NOSECTION 3 -/** @brief Section name too long (Error). */ -#define ERR_SECTIONLONG 4 -/** @brief No equal sign (Warning). */ -#define ERR_NOEQUAL 5 -/** @brief No key before equal sign (Warning). */ -#define ERR_NOKEY 6 -/** @brief Key is too long (Warning). */ -#define ERR_LONGKEY 7 - -/** @brief Size of the error array. */ -#define ERR_MAXPARSE ERR_LONGKEY - -/** - * @} - */ - -/** - * @defgroup gramerr Grammar errors and warnings - * - * Placeholder for now. Reserved for future use. - * - * @{ - */ -#define ERR_MAXGRAMMAR 0 -/** - * @} - */ - -/** - * @defgroup valerr Validation errors and warnings - * - * Placeholder for now. Reserved for future use. - * - * @{ - */ -#define ERR_MAXVALID 0 - - -/** - * @} - */ - -/** - * @defgroup accesscheck Access control check flags - * - * @{ - */ - -/** - * @brief Validate access mode - * - * If this flag is specified the mode parameter - * will be matched against the permissions set on the file - * using the provided mask. - */ -#define INI_ACCESS_CHECK_MODE 0x00000001 - -/** - * @brief Validate uid - * - * Provided uid will be checked against uid - * of the file. - */ -#define INI_ACCESS_CHECK_UID 0x00000002 - -/** - * @brief Validate gid - * - * Provided gid will be checked against gid - * of the file. - */ -#define INI_ACCESS_CHECK_GID 0x00000004 - -/** - * @} - */ - - -/** - * @} - */ - -/** - * @defgroup structures Structures - * @{ - */ - -/** @brief Structure that holds error number and - * line number for the encountered error. - */ -struct parse_error { - unsigned line; - int error; -}; - - -/** - * @} - */ - -/** - * @defgroup metadata Meta data - * - * Metadata is a collection of a similar structure as any ini file. - * The difference is that there are some predefined sections - * and attributes inside these sections. - * Using meta flags one can specify what section he is interested - * in including into the meta data. If a flag for a corresponding - * meta data section is specified the data for this section will - * be included into the meta data collection. The caller can then - * use meta data collection to get items from it and then get - * a specific value using a corresponding conversion function. - * - * Think about the meta data as an INI file that looks like this: - * - * <b> - * [ACCESS] - * - uid = <i>\<ini file owner uid\></i> - * - gid = <i>\<ini file group gid\></i> - * - perm = <i>\<permissions word\></i> - * - name = <i>\<file name\></i> - * - created = <i>\<time stamp\></i> - * - modified = <i>\<time stamp\></i> - * - ... - * - * [ERROR] - * - read_error = <i><file open error if any\></i> - * - ... - * - * [<i>TBD</i>] - * - ... - * - * </b> - * - * The names of the keys and sections provide an example - * of how the meta data is structured. Look information - * about specific sections and available keys in this manual - * to get the exact set of currently supported sections - * and keys. - * - * @{ - */ - -/** - * @brief Collect only meta data. - * - * Special flag that indicates that only meta data - * needs to be collected. No parsing should be performed. - * - */ -#define INI_META_ACTION_NOPARSE 0x10000000 - -/** - * @defgroup metasection Meta data section names - * - * @{ - */ - -/** - * @brief Meta data section that stores file access information - * and ownership. - */ -#define INI_META_SEC_ACCESS "ACCESS" - -/** - * @brief Meta data "access" section flag to include access section - * into the output. - */ -#define INI_META_SEC_ACCESS_FLAG 0x00000001 - - -/** - * @defgroup metaaccesskeys Key names available in the "ACCESS" section - * - * @{ - * - */ - -/** - * @brief The value for this key will store user ID of the INI file owner. - * - */ -#define INI_META_KEY_UID "uid" - -/** - * @brief The value for this key will store group ID of the INI file owner. - * - */ -#define INI_META_KEY_GID "gid" - -/** - * @brief The value for this key will store INI file access permissions. - * - */ -#define INI_META_KEY_PERM "perm" - -/** - * @brief The value for this key will store INI file device ID. - * - */ -#define INI_META_KEY_DEV "dev" - -/** - * @brief The value for this key will store INI file inode number. - * - */ -#define INI_META_KEY_INODE "inode" - -/** - * @brief The value for this key will store INI file modification time stamp. - * - */ -#define INI_META_KEY_MODIFIED "modified" - -/** - * @brief The value for this key will store INI file full name. - * - */ -#define INI_META_KEY_NAME "name" - -/** - * @} - */ - -/** - * @brief Meta data section that stores error related information. - */ -#define INI_META_SEC_ERROR "ERROR" - -/** - * @brief Meta data "error" section flag to include access section - * into the output. - */ -#define INI_META_SEC_ERROR_FLAG 0x00000002 - - -/** - * @defgroup metaerrorkeys Key names available in the "ERROR" section - * - * @{ - * - */ - -/** - * @brief The value for this key will store read error when file was opened. - * - * If file was opened by caller first but this section was requested - * the value will be zero. - */ -#define INI_META_KEY_READ_ERROR "read_error" - - -/** - * @} - */ - -/** - * @} - */ - -/** - * @} - */ - - -/** - * @defgroup functions Functions - * @{ - */ - -/** @brief Function to return a parsing error as a string. - * - * @param[in] parsing_error Error code for the parsing error. - * - * @return Error string. - */ -const char *parsing_error_str(int parsing_error); - - -/** - * @brief Read configuration information from a file. - * - * @param[in] application Name of the application, - * will be used as name of - * the collection. - * @param[in] config_filename Name of the config file, - * if NULL the configuration - * collection will be empty. - * @param[out] ini_config If *ini_config is NULL - * a new ini object will be - * allocated, otherwise - * the one that is pointed to - * will be updated. - * @param[in] error_level Break for errors, warnings - * or best effort (don't break). - * @param[out] error_list List of errors for the file - * detected during parsing. - * - * @return 0 - Success. - * @return EINVAL - Invalid parameter. - * @return EMOMEM - No memory. - * @return Any error returned by fopen(). - * - */ -int config_from_file(const char *application, - const char *config_filename, - struct collection_item **ini_config, - int error_level, - struct collection_item **error_list); - -/** - * @brief Read configuration information from a file descriptor. - * - * @param[in] application Name of the application, - * will be used as name of - * the collection. - * @param[in] fd Previously opened file - * descriptor for the config file. - * @param[in] config_source Name of the file being parsed, - * for use when printing the error - * list. - * @param[out] ini_config If *ini_config is NULL - * a new ini object will be - * allocated, otherwise - * the one that is pointed to - * will be updated. - * @param[in] error_level Break for errors, warnings - * or best effort (don't break). - * @param[out] error_list List of errors for the file - * detected during parsing. - * - * @return 0 - Success. - * @return EMOMEM - No memory. - * @return EINVAL - Invalid parameter. - * - */ -int config_from_fd(const char *application, - int fd, - const char *config_source, - struct collection_item **ini_config, - int error_level, - struct collection_item **error_list); - - - -/** - * @brief Read configuration information from a file with - * additional meta data. - * - * Meta data consists of addition information about - * the file for example when it was created - * or who is the owner. For the detailed description - * of the meta data content and structure see - * \ref metadata "meta data" section. - * - * If the metadata argument is not NULL - * the calling function MUST always free meta data since it can - * be allocated even if the function returned error. - * - * @param[in] application Name of the application, - * will be used as name of - * the collection. - * @param[in] config_filename Name of the config file, - * if NULL the configuration - * collection will be empty. - * @param[out] ini_config If *ini_config is NULL - * a new ini object will be - * allocated, otherwise - * the one that is pointed to - * will be updated. - * @param[in] error_level Break for errors, warnings - * or best effort (don't break). - * @param[out] error_list List of errors for the file - * detected during parsing. - * @param[in] metaflags A bit mask of flags that define - * what kind of metadata should - * be collected. - * @param[out] metadata Collection of metadata - * values. See \ref metadata "meta data" - * section for more details. - * Can be NULL. - * - * @return 0 - Success. - * @return EINVAL - Invalid parameter. - * @return EMOMEM - No memory. - * @return Any error returned by fopen(). - * - * - */ -int config_from_file_with_metadata( - const char *application, - const char *config_filename, - struct collection_item **ini_config, - int error_level, - struct collection_item **error_list, - uint32_t metaflags, - struct collection_item **metadata); - - -/** - * @brief Read configuration information from a file descriptor - * with additional meta data. - * - * Meta data consists of addition information about - * the file for example when it was created - * or who is the owner. For the detailed description - * of the meta data content and structure see - * \ref metadata "meta data" section. - * - * If the metadata argument is not NULL - * the calling function MUST always free meta data since it can - * be allocated even if the function returned error. - * - * @param[in] application Name of the application, - * will be used as name of - * the collection. - * @param[in] fd Previously opened file - * descriptor for the config file. - * @param[in] config_source Name of the file being parsed, - * for use when printing the error - * list. - * @param[out] ini_config If *ini_config is NULL - * a new ini object will be - * allocated, otherwise - * the one that is pointed to - * will be updated. - * @param[in] error_level Break for errors, warnings - * or best effort (don't break). - * @param[out] error_list List of errors for the file - * detected during parsing. - * @param[in] metaflags A bit mask of flags that define - * what kind of metadata should - * be collected. - * @param[out] metadata Collection of metadata - * values. See \ref metadata "meta data" - * section for more details. - * Can be NULL. - * - * @return 0 - Success. - * @return EINVAL - Invalid parameter. - * @return EMOMEM - No memory. - * - */ -int config_from_fd_with_metadata( - const char *application, - int fd, - const char *config_source, - struct collection_item **ini_config, - int error_level, - struct collection_item **error_list, - uint32_t metaflags, - struct collection_item **metadata); - - -/** - * @brief Read default configuration file and then - * overwrite it with a specific one from the directory. - * - * @param[in] application Name of the application, - * will be used as name of - * the collection. - * @param[in] config_file Name of the configuration file, - * with default settings for all - * appplications. - * @param[in] config_dir Name of the directory where - * the configuration files for - * different applications reside. - * Function will look for file - * with the name constructed by - * appending ".ini" to the end of - * the "application" argument. - * @param[out] ini_config A new configuration object. - * @param[in] error_level Break for errors, warnings - * or best effort (don't break). - * @param[out] error_set Collection of error lists. - * One list per file. - * - * @return 0 - Success. - * @return EINVAL - Invalid parameter. - * @return EMOMEM - No memory. - * @return Any error returned by fopen(). - */ -int config_for_app(const char *application, - const char *config_file, - const char *config_dir, - struct collection_item **ini_config, - int error_level, - struct collection_item **error_set); - -/** - * @brief Read default configuration file and then - * overwrite it with a specific one from the directory. - * - * If requested collect meta data for both. - * - * If the metadata argument is not NULL - * the calling function MUST always free meta data since it can - * be allocated even if the function returned error. - * - * @param[in] application Name of the application, - * will be used as name of - * the collection. - * @param[in] config_file Name of the configuration file, - * with default settings for all - * appplications. - * @param[in] config_dir Name of the directory where - * the configuration files for - * different applications reside. - * Function will look for file - * with the name constructed by - * appending ".ini" to the end of - * the "application" argument. - * @param[out] ini_config A new configuration object. - * @param[in] error_level Break for errors, warnings - * or best effort (don't break). - * @param[out] error_set Collection of error lists. - * One list per file. - * @param[in] metaflags A bit mask of flags that define - * what kind of metadata should - * be collected. - * @param[out] meta_default Collection of metadata - * values for the default common - * config file for all applications. - * See \ref metadata "meta data" - * section for more details. - * Can be NULL. - * @param[out] meta_appini Collection of metadata - * values for the application - * specific config file. - * See \ref metadata "meta data" - * section for more details. - * Can be NULL. - * - * @return 0 - Success. - * @return EINVAL - Invalid parameter. - * @return EMOMEM - No memory. - * @return Any error returned by fopen(). - */ -int config_for_app_with_metadata( - const char *application, - const char *config_file, - const char *config_dir, - struct collection_item **ini_config, - int error_level, - struct collection_item **error_set, - uint32_t metaflags, - struct collection_item **meta_default, - struct collection_item **meta_appini); - - -/** - * - * @brief Function to check ownership and permissions - * - * The function allow caller to make decision - * if the configuration file is from a trusted source - * or not. - * - * The flags control how to perform check. - * See \ref accesscheck "Access control check flags" - * section for more information. - * - * @param[in] metadata Meta data object. - * Can't be NULL. - * @param[in] flags How and what to check. - * Must be nonzero. - * @param[in] uid UID to check. - * @param[in] gid GID to check. - * @param[in] mode Mode to check. - * Only permission bits - * are used. - * @param[in] mask Which mode bits to check. - * If 0 all permision bits - * are checked. - * - * @return 0 - Success. - * @return EINVAL - Invalid parameter. - * @return EACCESS - File properties do not match provided - * access parameters. - */ -int config_access_check(struct collection_item *metadata, - uint32_t flags, - uid_t uid, - gid_t gid, - mode_t mode, - mode_t mask); - - -/** - * @brief Function compares two meta data objects - * - * Function compares two meta data objects - * to determine whether the configuration - * has changed since last time the meta data - * was collected. - * The function checks three things about the - * file: - * - time stamp - * - device ID - * - i-node - * If any of those changes function will indicate - * that configuration changed. - * - * @param[in] metadata Recent meta data object. - * @param[in] saved_metadata Previously saved meta - * data object. - * @param[out] changed Will be set to a nonzero value - * if the configuration has changed. - * - * @return 0 - No internal error - * @return EINVAL - Invalid argument - * @return ENOENT - Expected value is missing - * @return ENOMEM - No memory - */ -int config_changed(struct collection_item *metadata, - struct collection_item *saved_metadata, - int *changed); - -/** - * @brief Function to free configuration object. - * - * @param[in] ini_config Configuration object. - * - */ -void free_ini_config(struct collection_item *ini_config); - -/** - * @brief Function to free configuration errors. - * - * @param[in] error_set Configuration error set object. - * - */ -void free_ini_config_errors(struct collection_item *error_set); - - -/** - * @brief Function to free metadata. - * - * @param[in] metadata Configuration meta data object. - * - */ -void free_ini_config_metadata(struct collection_item *metadata); - - -/** - * @brief Print errors and warnings that were detected while parsing one file. - * - * @param[in] file File descriptor. - * @param[in] error_list List of the parsing errors. - * - */ -void print_file_parsing_errors(FILE *file, - struct collection_item *error_list); - - -/** - * @brief Print errors and warnings that were detected - * parsing configuration as a whole. - * - * Use this function to print results of the config_for_app() call. - * - * @param[in] file File descriptor. - * @param[in] error_set List of lists of the parsing errors. - * - */ -void print_config_parsing_errors(FILE *file, - struct collection_item *error_set); - -/** - * @brief Get list of sections. - * - * Get list of sections from the configuration object - * as an array of strings. - * Function allocates memory for the array of the sections. - * Use \ref free_section_list() to free allocated memory. - * - * @param[in] ini_config Configuration object. - * @param[out] size If not NULL parameter will - * receive number of sections - * in the configuration. - * @param[out] error If not NULL parameter will - * receive the error code. - * 0 - Success. - * EINVAL - Invalid parameter. - * ENOMEM - No memory. - * - * @return Array of strings. - */ -char **get_section_list(struct collection_item *ini_config, - int *size, - int *error); - -/** - * @brief Free list of sections. - * - * The section array created by \ref get_section_list() - * should be freed using this function. - * - * @param[in] section_list Array of strings returned by - * \ref get_section_list() function. - */ -void free_section_list(char **section_list); - -/** - * @brief Get list of attributes. - * - * Get list of attributes in a section as an array of strings. - * Function allocates memory for the array of attributes. - * Use \ref free_attribute_list() to free allocated memory. - * - * @param[in] ini_config Configuration object. - * @param[in] section Section name. - * @param[out] size If not NULL parameter will - * receive number of attributes - * in the section. - * @param[out] error If not NULL parameter will - * receive the error code. - * 0 - Success. - * EINVAL - Invalid parameter. - * ENOMEM - No memory. - * - * @return Array of strings. - */ -char **get_attribute_list(struct collection_item *ini_config, - const char *section, - int *size, - int *error); - -/** - * @brief Free list of attributes. - * - * The attribute array created by \ref get_attribute_list() - * should be freed using this function. - * - * @param[in] attr_list Array of strings returned by - * \ref get_attribute_list() function. - */ -void free_attribute_list(char **attr_list); - -/** - * @brief Get a configuration item form the configuration. - * - * Check return error code first. If the function returns - * an error there is a serious problem. - * Then check if item is found. Function will set - * item parameter to NULL if no attribute with - * provided name is found in the collection. - * - * @param[in] section Section name. - * If NULL assumed default. - * @param[in] name Attribute name to find. - * @param[in] ini_config Configuration object to search. - * @param[out] item Element of configuration - * collection. - * Will be set to NULL if - * element with the given name - * is not found. - * @return 0 - Success. - * @return EINVAL - Invalid parameter. - * @return ENOMEM - No memory. - * - */ -int get_config_item(const char *section, - const char *name, - struct collection_item *ini_config, - struct collection_item **item); - -/** - * @brief Convert item value to integer number. - * - * This is a conversion function. - * It converts the value read from the INI file - * and stored in the configuration item - * into an integer number. Any of the conversion - * functions can be used to try to convert the value - * stored as a string inside the item. - * The results can be different depending upon - * how the caller tries to interpret the value. - * If "strict" parameter is non zero the function will fail - * if there are more characters after the last digit. - * The value range is from INT_MIN to INT_MAX. - * - * @param[in] item Item to interpret. - * It must be retrieved using - * \ref get_config_item(). - * @param[in] strict Fail the function if - * the symbol after last digit - * is not valid. - * @param[in] def Default value to use if - * conversion failed. - * @param[out] error Variable will get the value - * of the error code if - * error happened. - * Can be NULL. In this case - * function does not set - * the code. - * Codes: - * - 0 - Success. - * - EINVAL - Argument is invalid. - * - EIO - Conversion failed due - * invalid characters. - * - ERANGE - Value is out of range. - * - * @return Converted value. - * In case of failure the function returns default value and - * sets error code into the provided variable. - */ -int get_int_config_value(struct collection_item *item, - int strict, - int def, - int *error); - -/** - * @brief Convert item value to long number. - * - * This is a conversion function. - * It converts the value read from the INI file - * and stored in the configuration item - * into a long number. Any of the conversion - * functions can be used to try to convert the value - * stored as a string inside the item. - * The results can be different depending upon - * how the caller tries to interpret the value. - * If "strict" parameter is non zero the function will fail - * if there are more characters after the last digit. - * The value range is from LONG_MIN to LONG_MAX. - * - * @param[in] item Item to interpret. - * It must be retrieved using - * \ref get_config_item(). - * @param[in] strict Fail the function if - * the symbol after last digit - * is not valid. - * @param[in] def Default value to use if - * conversion failed. - * @param[out] error Variable will get the value - * of the error code if - * error happened. - * Can be NULL. In this case - * function does not set - * the code. - * Codes: - * - 0 - Success. - * - EINVAL - Argument is invalid. - * - EIO - Conversion failed due - * invalid characters. - * - ERANGE - Value is out of range. - * - * @return Converted value. - * In case of failure the function returns default value and - * sets error code into the provided variable. - */ -long get_long_config_value(struct collection_item *item, - int strict, - long def, - int *error); - -/** - * @brief Convert item value to unsigned integer number. - * - * This is a conversion function. - * It converts the value read from the INI file - * and stored in the configuration item - * into an unsigned integer number. Any of the conversion - * functions can be used to try to convert the value - * stored as a string inside the item. - * The results can be different depending upon - * how the caller tries to interpret the value. - * If "strict" parameter is non zero the function will fail - * if there are more characters after the last digit. - * The value range is from 0 to UINT_MAX. - * - * @param[in] item Item to interpret. - * It must be retrieved using - * \ref get_config_item(). - * @param[in] strict Fail the function if - * the symbol after last digit - * is not valid. - * @param[in] def Default value to use if - * conversion failed. - * @param[out] error Variable will get the value - * of the error code if - * error happened. - * Can be NULL. In this case - * function does not set - * the code. - * Codes: - * - 0 - Success. - * - EINVAL - Argument is invalid. - * - EIO - Conversion failed due - * invalid characters. - * - ERANGE - Value is out of range. - * - * @return Converted value. - * In case of failure the function returns default value and - * sets error code into the provided variable. - */ -unsigned get_unsigned_config_value(struct collection_item *item, - int strict, - unsigned def, - int *error); - -/** - * @brief Convert item value to unsigned long number. - * - * This is a conversion function. - * It converts the value read from the INI file - * and stored in the configuration item - * into an unsigned long number. Any of the conversion - * functions can be used to try to convert the value - * stored as a string inside the item. - * The results can be different depending upon - * how the caller tries to interpret the value. - * If "strict" parameter is non zero the function will fail - * if there are more characters after the last digit. - * The value range is from 0 to ULONG_MAX. - * - * @param[in] item Item to interpret. - * It must be retrieved using - * \ref get_config_item(). - * @param[in] strict Fail the function if - * the symbol after last digit - * is not valid. - * @param[in] def Default value to use if - * conversion failed. - * @param[out] error Variable will get the value - * of the error code if - * error happened. - * Can be NULL. In this case - * function does not set - * the code. - * Codes: - * - 0 - Success. - * - EINVAL - Argument is invalid. - * - EIO - Conversion failed due - * invalid characters. - * - ERANGE - Value is out of range. - * - * @return Converted value. - * In case of failure the function returns default value and - * sets error code into the provided variable. - */ -unsigned long get_ulong_config_value(struct collection_item *item, - int strict, - unsigned long def, - int *error); - -/** - * @brief Convert item value to integer number. - * - * This is a conversion function. - * It converts the value read from the INI file - * and stored in the configuration item - * into an int32_t number. Any of the conversion - * functions can be used to try to convert the value - * stored as a string inside the item. - * The results can be different depending upon - * how the caller tries to interpret the value. - * If "strict" parameter is non zero the function will fail - * if there are more characters after the last digit. - * The value range is from INT_MIN to INT_MAX. - * - * @param[in] item Item to interpret. - * It must be retrieved using - * \ref get_config_item(). - * @param[in] strict Fail the function if - * the symbol after last digit - * is not valid. - * @param[in] def Default value to use if - * conversion failed. - * @param[out] error Variable will get the value - * of the error code if - * error happened. - * Can be NULL. In this case - * function does not set - * the code. - * Codes: - * - 0 - Success. - * - EINVAL - Argument is invalid. - * - EIO - Conversion failed due - * invalid characters. - * - ERANGE - Value is out of range. - * - * @return Converted value. - * In case of failure the function returns default value and - * sets error code into the provided variable. - */ -int32_t get_int32_config_value(struct collection_item *item, - int strict, - int32_t def, - int *error); - -/** - * @brief Convert item value to integer number. - * - * This is a conversion function. - * It converts the value read from the INI file - * and stored in the configuration item - * into an uint32_t number. Any of the conversion - * functions can be used to try to convert the value - * stored as a string inside the item. - * The results can be different depending upon - * how the caller tries to interpret the value. - * If "strict" parameter is non zero the function will fail - * if there are more characters after the last digit. - * The value range is from 0 to ULONG_MAX. - * - * @param[in] item Item to interpret. - * It must be retrieved using - * \ref get_config_item(). - * @param[in] strict Fail the function if - * the symbol after last digit - * is not valid. - * @param[in] def Default value to use if - * conversion failed. - * @param[out] error Variable will get the value - * of the error code if - * error happened. - * Can be NULL. In this case - * function does not set - * the code. - * Codes: - * - 0 - Success. - * - EINVAL - Argument is invalid. - * - EIO - Conversion failed due - * invalid characters. - * - ERANGE - Value is out of range. - * - * @return Converted value. - * In case of failure the function returns default value and - * sets error code into the provided variable. - */ -uint32_t get_uint32_config_value(struct collection_item *item, - int strict, - uint32_t def, - int *error); - -/** - * @brief Convert item value to integer number. - * - * This is a conversion function. - * It converts the value read from the INI file - * and stored in the configuration item - * into an int64_t number. Any of the conversion - * functions can be used to try to convert the value - * stored as a string inside the item. - * The results can be different depending upon - * how the caller tries to interpret the value. - * If "strict" parameter is non zero the function will fail - * if there are more characters after the last digit. - * The value range is from LLONG_MIN to LLONG_MAX. - * - * @param[in] item Item to interpret. - * It must be retrieved using - * \ref get_config_item(). - * @param[in] strict Fail the function if - * the symbol after last digit - * is not valid. - * @param[in] def Default value to use if - * conversion failed. - * @param[out] error Variable will get the value - * of the error code if - * error happened. - * Can be NULL. In this case - * function does not set - * the code. - * Codes: - * - 0 - Success. - * - EINVAL - Argument is invalid. - * - EIO - Conversion failed due - * invalid characters. - * - ERANGE - Value is out of range. - * - * @return Converted value. - * In case of failure the function returns default value and - * sets error code into the provided variable. - */ -int64_t get_int64_config_value(struct collection_item *item, - int strict, - int64_t def, - int *error); - -/** - * @brief Convert item value to integer number. - * - * This is a conversion function. - * It converts the value read from the INI file - * and stored in the configuration item - * into an uint64_t number. Any of the conversion - * functions can be used to try to convert the value - * stored as a string inside the item. - * The results can be different depending upon - * how the caller tries to interpret the value. - * If "strict" parameter is non zero the function will fail - * if there are more characters after the last digit. - * The value range is from 0 to ULLONG_MAX. - * - * @param[in] item Item to interpret. - * It must be retrieved using - * \ref get_config_item(). - * @param[in] strict Fail the function if - * the symbol after last digit - * is not valid. - * @param[in] def Default value to use if - * conversion failed. - * @param[out] error Variable will get the value - * of the error code if - * error happened. - * Can be NULL. In this case - * function does not set - * the code. - * Codes: - * - 0 - Success. - * - EINVAL - Argument is invalid. - * - EIO - Conversion failed due - * invalid characters. - * - ERANGE - Value is out of range. - * - * @return Converted value. - * In case of failure the function returns default value and - * sets error code into the provided variable. - */ -uint64_t get_uint64_config_value(struct collection_item *item, - int strict, - uint64_t def, - int *error); - -/** - * @brief Convert item value to floating point number. - * - * This is a conversion function. - * It converts the value read from the INI file - * and stored in the configuration item - * into a floating point number. Any of the conversion - * functions can be used to try to convert the value - * stored as a string inside the item. - * The results can be different depending upon - * how the caller tries to interpret the value. - * If "strict" parameter is non zero the function will fail - * if there are more characters after the last digit. - * - * @param[in] item Item to interpret. - * It must be retrieved using - * \ref get_config_item(). - * @param[in] strict Fail the function if - * the symbol after last digit - * is not valid. - * @param[in] def Default value to use if - * conversion failed. - * @param[out] error Variable will get the value - * of the error code if - * error happened. - * Can be NULL. In this case - * function does not set - * the code. - * Codes: - * - 0 - Success. - * - EINVAL - Argument is invalid. - * - EIO - Conversion failed due - * invalid characters. - * - * @return Converted value. - * In case of failure the function returns default value and - * sets error code into the provided variable. - */ -double get_double_config_value(struct collection_item *item, - int strict, - double def, - int *error); - -/** - * @brief Convert item value into a logical value. - * - * This is a conversion function. - * It converts the value read from the INI file - * and stored in the configuration item - * into a Boolean. Any of the conversion - * functions can be used to try to convert the value - * stored as a string inside the item. - * The results can be different depending upon - * how the caller tries to interpret the value. - * - * @param[in] item Item to interpret. - * It must be retrieved using - * \ref get_config_item(). - * @param[in] def Default value to use if - * conversion failed. - * @param[out] error Variable will get the value - * of the error code if - * error happened. - * Can be NULL. In this case - * function does not set - * the code. - * Codes: - * - 0 - Success. - * - EINVAL - Argument is invalid. - * - EIO - Conversion failed due - * invalid characters. - * - * @return Converted value. - * In case of failure the function returns default value and - * sets error code into the provided variable. - */ -unsigned char get_bool_config_value(struct collection_item *item, - unsigned char def, - int *error); - -/** - * @brief Get string configuration value - * - * Function creates a copy of the string value stored in the item. - * Returned value needs to be freed after use. - * If error occurred the returned value will be NULL. - * - * @param[in] item Item to use. - * It must be retrieved using - * \ref get_config_item(). - * @param[out] error Variable will get the value - * of the error code if - * error happened. - * Can be NULL. In this case - * function does not set - * the code. - * Codes: - * - 0 - Success. - * - EINVAL - Argument is invalid. - * - ENOMEM - No memory. - * - * @return Copy of the string or NULL. - */ -char *get_string_config_value(struct collection_item *item, - int *error); -/** - * @brief Function returns the string stored in the item. - * - * Function returns a reference to the string value - * stored inside the item. This string can't be altered. - * The string will go out of scope if the item is deleted. - * - * @param[in] item Item to use. - * It must be retrieved using - * \ref get_config_item(). - * @param[out] error Variable will get the value - * of the error code if - * error happened. - * Can be NULL. In this case - * function does not set - * the code. - * Codes: - * - 0 - Success. - * - EINVAL - Argument is invalid. - * - * @return String from the item. - */ -const char *get_const_string_config_value(struct collection_item *item, - int *error); - -/** - * @brief Convert item value into a binary sequence. - * - * This is a conversion function. - * It converts the value read from the INI file - * and stored in the configuration item - * into a sequence of bytes. - * Any of the conversion functions - * can be used to try to convert the value - * stored as a string inside the item. - * The results can be different depending upon - * how the caller tries to interpret the value. - * - * The function allocates memory. - * It is the responsibility of the caller to free it after use. - * Use \ref free_bin_config_value() for this purpose. - * Functions will return NULL if conversion failed. - * - * Function assumes that the value being interpreted - * has a special format. - * The string should be taken in single quotes - * and consist of hex encoded value represented by - * two hex digits per byte. - * Case does not matter. - * - * Example: '0a2BFeCc' - * - * @param[in] item Item to interpret. - * It must be retrieved using - * \ref get_config_item(). - * @param[out] length Variable that optionally receives - * the length of the binary - * sequence. - * @param[out] error Variable will get the value - * of the error code if - * error happened. - * Can be NULL. In this case - * function does not set - * the code. - * Codes: - * - 0 - Success. - * - EINVAL - Argument is invalid. - * - EIO - Conversion failed due - * invalid characters. - * - ENOMEM - No memory. - * - * @return Converted value. - * In case of failure the function returns NULL. - */ -char *get_bin_config_value(struct collection_item *item, - int *length, - int *error); - -/** - * @brief Free binary buffer - * - * Free binary value returned by \ref get_bin_config_value(). - * - * @param[in] bin Binary buffer to free. - * - */ -void free_bin_config_value(char *bin); - -/** - * @brief Convert value to an array of strings. - * - * This is a conversion function. - * It converts the value read from the INI file - * and stored in the configuration item - * into an array of strings. Any of the conversion - * functions can be used to try to convert the value - * stored as a string inside the item. - * The results can be different depending upon - * how the caller tries to interpret the value. - * - * Separator string includes up to three different separators. - * If separator NULL, comma is assumed. - * The spaces are trimmed automatically around separators - * in the string. - * The function drops empty tokens from the list. - * This means that the string like this: "apple, ,banana, ,orange ," - * will be translated into the list of three items: - * "apple","banana" and "orange". - * - * The length of the allocated array is returned in "size". - * Size and error parameters can be NULL. - * Use \ref free_string_config_array() to free the array after use. - * - * The array is always NULL terminated so - * it is safe not to get size and just loop until - * array element is NULL. - * - * @param[in] item Item to interpret. - * It must be retrieved using - * \ref get_config_item(). - * @param[in] sep String cosisting of separator - * symbols. For example: ",.;" would mean - * that comma, dot and semicolon - * should be treated as separators - * in the value. - * @param[out] size Variable that optionally receives - * the size of the array. - * @param[out] error Variable will get the value - * of the error code if - * error happened. - * Can be NULL. In this case - * function does not set - * the code. - * Codes: - * - 0 - Success. - * - EINVAL - Argument is invalid. - * - EIO - Conversion failed. - * - ENOMEM - No memory. - * - * @return Array of strings. - * In case of failure the function returns NULL. - */ -char **get_string_config_array(struct collection_item *item, - const char *sep, - int *size, - int *error); - -/** - * @brief Convert value to an array of strings. - * - * This is a conversion function. - * It converts the value read from the INI file - * and stored in the configuration item - * into an array of strings. Any of the conversion - * functions can be used to try to convert the value - * stored as a string inside the item. - * The results can be different depending upon - * how the caller tries to interpret the value. - * - * Separator string includes up to three different separators. - * If separator NULL, comma is assumed. - * The spaces are trimmed automatically around separators - * in the string. - * The function does not drop empty tokens from the list. - * This means that the string like this: "apple, ,banana, ,orange ," - * will be translated into the list of five items: - * "apple", "", "banana", "" and "orange". - * - * The length of the allocated array is returned in "size". - * Size and error parameters can be NULL. - * Use \ref free_string_config_array() to free the array after use. - * - * The array is always NULL terminated so - * it is safe not to get size and just loop until - * array element is NULL. - * - * @param[in] item Item to interpret. - * It must be retrieved using - * \ref get_config_item(). - * @param[in] sep String cosisting of separator - * symbols. For example: ",.;" would mean - * that comma, dot and semicolon - * should be treated as separators - * in the value. - * @param[out] size Variable that optionally receives - * the size of the array. - * @param[out] error Variable will get the value - * of the error code if - * error happened. - * Can be NULL. In this case - * function does not set - * the code. - * Codes: - * - 0 - Success. - * - EINVAL - Argument is invalid. - * - EIO - Conversion failed. - * - ENOMEM - No memory. - * - * @return Array of strings. - * In case of failure the function returns NULL. - */ -char **get_raw_string_config_array(struct collection_item *item, - const char *sep, - int *size, - int *error); - -/** - * @brief Convert value to an array of long values. - * - * This is a conversion function. - * It converts the value read from the INI file - * and stored in the configuration item - * into an array of long values. Any of the conversion - * functions can be used to try to convert the value - * stored as a string inside the item. - * The results can be different depending upon - * how the caller tries to interpret the value. - * - * Separators inside the string are detected automatically. - * The spaces are trimmed automatically around separators - * in the string. - * - * The length of the allocated array is returned in "size". - * Size parameter can't be NULL. - * - * Use \ref free_long_config_array() to free the array after use. - * - * @param[in] item Item to interpret. - * It must be retrieved using - * \ref get_config_item(). - * @param[out] size Variable that receives - * the size of the array. - * @param[out] error Variable will get the value - * of the error code if - * error happened. - * Can be NULL. In this case - * function does not set - * the code. - * Codes: - * - 0 - Success. - * - EINVAL - Argument is invalid. - * - EIO - Conversion failed. - * - ERANGE - Value is out of range. - * - ENOMEM - No memory. - * - * @return Array of long values. - * In case of failure the function returns NULL. - */ -long *get_long_config_array(struct collection_item *item, - int *size, - int *error); - -/** - * @brief Convert value to an array of floating point values. - * - * This is a conversion function. - * It converts the value read from the INI file - * and stored in the configuration item - * into an array of floating point values. Any of the conversion - * functions can be used to try to convert the value - * stored as a string inside the item. - * The results can be different depending upon - * how the caller tries to interpret the value. - * - * Separators inside the string are detected automatically. - * The spaces are trimmed automatically around separators - * in the string. - * - * The length of the allocated array is returned in "size". - * Size parameter can't be NULL. - * - * Use \ref free_double_config_array() to free the array after use. - * - * @param[in] item Item to interpret. - * It must be retrieved using - * \ref get_config_item(). - * @param[out] size Variable that receives - * the size of the array. - * @param[out] error Variable will get the value - * of the error code if - * error happened. - * Can be NULL. In this case - * function does not set - * the code. - * Codes: - * - 0 - Success. - * - EINVAL - Argument is invalid. - * - EIO - Conversion failed. - * - ENOMEM - No memory. - * - * @return Array of floating point values. - * In case of failure the function returns NULL. - */ -double *get_double_config_array(struct collection_item *item, - int *size, - int *error); - -/** - * @brief Free array of string values. - * - * Use this function to free the array returned by - * \ref get_string_config_array() or by - * \ref get_raw_string_config_array(). - * - * @param[in] str_config Array of string values. - */ -void free_string_config_array(char **str_config); - -/** - * @brief Free array of long values. - * - * Use this function to free the array returned by - * \ref get_long_config_array(). - * - * @param[in] array Array of long values. - */ -void free_long_config_array(long *array); -/** - * @brief Free array of floating pointer values. - * - * Use this function to free the array returned by - * \ref get_double_config_array(). - * - * @param[in] array Array of floating pointer values. - */ -void free_double_config_array(double *array); - - -/** - * @} - */ - -#endif diff --git a/common/ini/ini_config.pc.in b/common/ini/ini_config.pc.in deleted file mode 100644 index efa8da978..000000000 --- a/common/ini/ini_config.pc.in +++ /dev/null @@ -1,11 +0,0 @@ -prefix=@prefix@ -exec_prefix=@exec_prefix@ -libdir=@libdir@ -includedir=@includedir@ - -Name: @PACKAGE_NAME@ -Description: Library to process config files in INI format into a libcollection data structure -Version: @PACKAGE_VERSION@ -Libs: -L${libdir} -lini_config -lcollection -Cflags: -I${includedir} -URL: http://fedorahosted.org/sssd/ diff --git a/common/ini/ini_config_ut.c b/common/ini/ini_config_ut.c deleted file mode 100644 index a1ac52ce6..000000000 --- a/common/ini/ini_config_ut.c +++ /dev/null @@ -1,1535 +0,0 @@ -/* - INI LIBRARY - - Unit test for the INI library. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - INI Library 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. - - INI Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with INI Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#include <stdlib.h> -#include <stdio.h> -#include <string.h> -#include <errno.h> -#include <unistd.h> -#include <fcntl.h> -#include <sys/stat.h> -#define TRACE_HOME -#include "trace.h" -#include "ini_config.h" -#include "collection.h" -#include "collection_tools.h" - - -int verbose = 0; - -#define COLOUT(foo) \ - do { \ - if (verbose) foo; \ - } while(0) - - -int basic_test(void) -{ - int error; - struct collection_item *ini_config = NULL; - struct collection_item *error_set = NULL; - - error = config_for_app("test", NULL, NULL, - &ini_config, INI_STOP_ON_NONE, &error_set); - if (error != EINVAL) { - printf("Expected error EINVAL got somethign else: %d\n", error); - return EINVAL; - } - - error = config_for_app("test", "foo", "bar", - &ini_config, INI_STOP_ON_ANY, &error_set); - if (error != ENOENT) { - printf("Expected error ENOENT got somethign else: %d\n", error); - return ENOENT; - } - - error = config_for_app("test", "./ini.conf", "./ini.d", - &ini_config, INI_STOP_ON_NONE, &error_set); - if (error) { - printf("Attempt to read configuration returned error: %d\n", error); - return error; - } - - COLOUT(col_debug_collection(ini_config,COL_TRAVERSE_DEFAULT)); - COLOUT(col_print_collection(ini_config)); - COLOUT(col_print_collection(error_set)); - - COLOUT(printf("\n\n----------------------\n")); - /* Output parsing errors (if any) */ - COLOUT(print_config_parsing_errors(stdout, error_set)); - COLOUT(printf("----------------------\n\n\n")); - - - free_ini_config(ini_config); - free_ini_config_errors(error_set); - return 0; -} - -int single_file(void) -{ - int error; - struct collection_item *ini_config = NULL; - struct collection_item *error_set = NULL; - struct collection_item *metadata = NULL; - uint32_t flags; - - error = config_from_file("test", "./not_exist_ini.conf", - &ini_config, INI_STOP_ON_NONE, &error_set); - if (error) { - COLOUT(printf("Attempt to read configuration returned error: %d." - " EXPECTED.\n\n", error)); - if(error != ENOENT) return error; - } - - error = config_from_file("test", - "./ini.conf", - &ini_config, - INI_STOP_ON_NONE, - &error_set); - if (error) { - printf("Attempt to read configuration returned error: %d\n", error); - return error; - } - - COLOUT(col_debug_collection(ini_config, COL_TRAVERSE_DEFAULT)); - COLOUT(col_print_collection(ini_config)); - COLOUT(col_print_collection(error_set)); - - COLOUT(printf("\n\n----------------------\n")); - /* Output parsing errors (if any) */ - COLOUT(print_file_parsing_errors(stdout, error_set)); - COLOUT(printf("----------------------\n\n\n")); - - - free_ini_config(ini_config); - free_ini_config_errors(error_set); - - ini_config = NULL; - error_set = NULL; - - COLOUT(printf("TEST WITH METADATA NO PARSE\n")); - flags = INI_META_SEC_ACCESS_FLAG | - INI_META_SEC_ERROR_FLAG | - INI_META_ACTION_NOPARSE; - - error = config_from_file_with_metadata("test", "./ini.conf", - &ini_config, INI_STOP_ON_NONE, - NULL, - flags, - &metadata); - if (error) { - printf("Attempt to read configuration returned error: %d\n",error); - if (metadata) { - printf("\n\nMeta data\n"); - col_debug_collection(metadata, COL_TRAVERSE_DEFAULT); - } - free_ini_config_metadata(metadata); - return error; - } - - if (ini_config) { - printf("Expected no config but got some.\n"); - col_debug_collection(ini_config, COL_TRAVERSE_DEFAULT); - free_ini_config(ini_config); - printf("\n\nMeta data\n"); - col_debug_collection(metadata, COL_TRAVERSE_DEFAULT); - free_ini_config_metadata(metadata); - return EINVAL; - } - - COLOUT(printf("\n\nMeta data\n")); - COLOUT(col_debug_collection(metadata, COL_TRAVERSE_DEFAULT)); - free_ini_config_metadata(metadata); - - COLOUT(printf("\n\n----------------------\n")); - - error = config_from_file_with_metadata("test", "./ini.conf", - &ini_config, INI_STOP_ON_NONE, - &error_set, - 0, - NULL); - if (error) { - printf("Attempt to read configuration returned error: %d\n",error); - print_file_parsing_errors(stdout, error_set); - free_ini_config_errors(error_set); - return error; - } - - COLOUT(printf("\n\n----------------------\n")); - COLOUT(col_debug_collection(ini_config, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("\n\n----------------------\n")); - /* Output parsing errors (if any) */ - COLOUT(print_file_parsing_errors(stdout, error_set)); - COLOUT(printf("----------------------\n\n\n")); - - - free_ini_config(ini_config); - free_ini_config_errors(error_set); - - return 0; -} - -int single_fd(void) -{ - int error; - struct collection_item *ini_config = NULL; - struct collection_item *error_set = NULL; - struct collection_item *metadata = NULL; - uint32_t flags; - - int fd = open("./ini.conf", O_RDONLY); - if (fd < 0) { - error = errno; - printf("Attempt to read configuration returned error: %d\n", error); - return error; - } - - error = config_from_fd("test", fd, "./ini.conf", &ini_config, - INI_STOP_ON_NONE, &error_set); - if (error) { - printf("Attempt to read configuration returned error: %d\n",error); - return error; - } - - COLOUT(col_debug_collection(ini_config, COL_TRAVERSE_DEFAULT)); - COLOUT(col_print_collection(ini_config)); - COLOUT(col_print_collection(error_set)); - - COLOUT(printf("\n\n----------------------\n")); - /* Output parsing errors (if any) */ - COLOUT(print_file_parsing_errors(stdout, error_set)); - COLOUT(printf("----------------------\n\n\n")); - - - free_ini_config(ini_config); - free_ini_config_errors(error_set); - close(fd); - - ini_config = NULL; - error_set = NULL; - - COLOUT(printf("TEST WITH FILE FD & META DATA\n")); - - fd = open("./ini.conf", O_RDONLY); - if (fd < 0) { - error = errno; - printf("Attempt to read configuration returned error: %d\n", error); - return error; - } - - flags = INI_META_SEC_ACCESS_FLAG | - INI_META_SEC_ERROR_FLAG | - INI_META_ACTION_NOPARSE; - - error = config_from_fd_with_metadata("test", fd, - "./ini.conf", - &ini_config, - INI_STOP_ON_NONE, - &error_set, - flags, - &metadata); - if (error) { - printf("Attempt to read configuration returned error: %d\n",error); - printf("\n\nErrors\n"); - print_file_parsing_errors(stdout, error_set); - free_ini_config_errors(error_set); - if (metadata) { - printf("\n\nMeta data\n"); - col_debug_collection(metadata, COL_TRAVERSE_DEFAULT); - } - free_ini_config_metadata(metadata); - return error; - } - - if (ini_config) { - printf("Expected no config but got some.\n"); - col_debug_collection(ini_config, COL_TRAVERSE_DEFAULT); - free_ini_config(ini_config); - return EINVAL; - } - - - COLOUT(printf("\n\nMeta data\n")); - COLOUT(col_debug_collection(metadata, COL_TRAVERSE_DEFAULT)); - free_ini_config_metadata(metadata); - - - error = config_from_fd_with_metadata("test", fd, - "./ini.conf", - &ini_config, - INI_STOP_ON_NONE, - &error_set, - 0, - NULL); - - close(fd); - - if (error) { - printf("Attempt to read configuration returned error: %d\n",error); - printf("\n\nErrors\n"); - print_file_parsing_errors(stdout, error_set); - free_ini_config_errors(error_set); - return error; - } - - COLOUT(col_debug_collection(ini_config, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("\n\n----------------------\n")); - /* Output parsing errors (if any) */ - COLOUT(print_file_parsing_errors(stdout, error_set)); - COLOUT(printf("----------------------\n\n\n")); - - - free_ini_config(ini_config); - free_ini_config_errors(error_set); - - return 0; -} - -int negative_test(void) -{ - int error; - unsigned int count; - struct collection_item *ini_config = NULL; - - /* App name is null - expect failure */ - error = config_for_app(NULL, - NULL, - NULL, - NULL, - INI_STOP_ON_NONE, - NULL); - if (!error) { - printf("Expected error: %d got success\n", EINVAL); - return -1; - } - - /* Config collection storage is NULL - expect failure */ - error = config_for_app("real", - NULL, - NULL, - NULL, - INI_STOP_ON_NONE, - NULL); - if (!error) { - printf("Expected error: %d got success\n", EINVAL); - return -1; - } - - /* Config collection storage is NULL - expect failure */ - error = config_for_app("real", - "real.conf", - NULL, - NULL, - INI_STOP_ON_NONE, - NULL); - if (!error) { - printf("Expected error: %d got success\n", EINVAL); - return -1; - } - - /* Expect success but empty config */ - error = config_for_app("real", - "real.conf", - NULL, - &ini_config, - INI_STOP_ON_NONE, - NULL); - if (error) { - printf("Expected success got error: %d\n",error); - return error; - } - - count = 0; - (void)col_get_collection_count(ini_config, &count); - if (count > 1) { - printf("Expected empty collection but" - " got contents with %d elements\n", count); - col_print_collection(ini_config); - return -1; - } - - free_ini_config(ini_config); - return 0; - -} - -int real_test(const char *file) -{ - int error; - struct collection_item *ini_config = NULL; - struct collection_item *error_set = NULL; - struct collection_iterator *iterator = NULL; - struct collection_item *item = NULL; - int type; - - COLOUT(printf("\n\n===== REAL TEST START ======\n")); - COLOUT(printf("Reading collection\n")); - error = config_for_app("real", file, "./ini.d", - &ini_config, INI_STOP_ON_NONE, &error_set); - if (error) { - printf("Attempt to read configuration returned error: %d\n", error); - return error; - } - - COLOUT(printf("Debugging the config collection:\n")); - COLOUT(col_debug_collection(ini_config, COL_TRAVERSE_DEFAULT)); - COLOUT(printf("Debugging the error collection:\n")); - COLOUT(col_debug_collection(error_set, COL_TRAVERSE_DEFAULT)); - - COLOUT(printf("About to print parsing errors:\n")); - COLOUT(printf("\n\n----------------------\n")); - /* Output parsing errors (if any) */ - COLOUT(print_config_parsing_errors(stdout, error_set)); - COLOUT(printf("----------------------\n\n\n")); - - COLOUT(printf("About to bind iterator to print" - " the config file contents.\n")); - /* Bind iterator */ - error = col_bind_iterator(&iterator, ini_config, - COL_TRAVERSE_DEFAULT|COL_TRAVERSE_END); - if (error) { - printf("Failed to bind iterator: %d\n",error); - col_destroy_collection(ini_config); - col_destroy_collection(error_set); - return error; - } - - COLOUT(printf("About to start iteration loop.\n")); - do { - /* Loop through a collection */ - error = col_iterate_collection(iterator, &item); - if (error) { - printf("Error iterating collection: %d", error); - col_unbind_iterator(iterator); - return error; - } - - /* Are we done ? */ - if (item == NULL) break; - - type = col_get_item_type(item); - - /* Start of the collection */ - if (type == COL_TYPE_COLLECTION) - COLOUT(printf("Contents of the application's configuration %s\n", - col_get_item_property(item, NULL))); - /* End of section */ - else if (type == COL_TYPE_END) COLOUT(printf("\n")); - /* Section header ? */ - else if (type == COL_TYPE_COLLECTIONREF) - COLOUT(printf("[%s]\n", col_get_item_property(item, NULL))); - /* Anything else - we know they are all strings*/ - else - COLOUT(printf("%s = %s\n", - col_get_item_property(item, NULL), - (char *)col_get_item_data(item))); - } - while(1); - - /* Do not forget to unbind iterator - otherwise there will be a leak */ - COLOUT(printf("About to clean up.\n")); - col_unbind_iterator(iterator); - - free_ini_config(ini_config); - free_ini_config_errors(error_set); - return 0; -} - -int get_test(void) -{ - - int error; - struct collection_item *ini_config = NULL; - struct collection_item *error_set = NULL; - struct collection_item *item = NULL; - int number; - long number_long; - double number_double; - unsigned number_unsigned; - unsigned long number_ulong; - unsigned char logical; - char *str; - const char *cstr; - const char *cstrn; - void *binary; - int length; - int i = 0; - char **strarray; - char **strptr; - int size; - long *array; - double *darray; - char **prop_array; - int32_t val_int32; - uint32_t val_uint32; - int64_t val_int64; - uint64_t val_uint64; - - - COLOUT(printf("\n\n===== GET TEST START ======\n")); - COLOUT(printf("Reading collection\n")); - - error = config_for_app("real", NULL, "./ini.d", - &ini_config, INI_STOP_ON_NONE, &error_set); - if (error) { - printf("Attempt to read configuration returned error: %d\n", error); - return error; - } - - COLOUT(printf("Debugging the config collection:\n")); - COLOUT(col_debug_collection(ini_config, COL_TRAVERSE_DEFAULT)); - COLOUT(printf("Debugging the error collection:\n")); - COLOUT(col_debug_collection(error_set, COL_TRAVERSE_DEFAULT)); - free_ini_config_errors(error_set); - - COLOUT(printf("Negtive test - trying to get non" - " existing key-value pair.\n")); - - /* Negative test */ - item = NULL; - error = get_config_item("monitor1", "description1", ini_config, &item); - if (error) { - printf("Expected success but got error! %d\n", error); - free_ini_config(ini_config); - return error; - } - - /* Item should not be found */ - if (item != NULL) { - printf("Expected NULL but got something else!\n"); - free_ini_config(ini_config); - return -1; - } - - /* Another negative test but section exists this time */ - item = NULL; - error = get_config_item("monitor", "description1", ini_config, &item); - if (error) { - printf("Expected success but got error! %d\n", error); - free_ini_config(ini_config); - return error; - } - - /* Item should not be found */ - if(item != NULL) { - printf("Expected NULL but got something else!\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(printf("Trying to get an item.\n")); - - /* Positive test */ - item = NULL; - error = get_config_item("monitor", "description", ini_config, &item); - if (error) { - printf("Expected success but got error! %d\n", error); - free_ini_config(ini_config); - return error; - } - - /* Item should be found */ - if (item == NULL) { - printf("Expected item but got something NULL!\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(col_debug_item(item)); - - COLOUT(printf("Get item as string without duplication" - " from the NULL item.\n")); - - /* Get a string without duplicication */ - /* Negative test */ - cstrn = get_const_string_config_value(NULL, NULL); - if (cstrn != NULL) { - printf("Expected error got success.\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(printf("Get item as string without duplication" - "from the correct item.\n")); - - /* Now get string from the right item */ - error = 0; - cstr = get_const_string_config_value(item, &error); - if (error) { - printf("Expected success got error %d.\n", error); - free_ini_config(ini_config); - return error; - } - - COLOUT(printf("Value: [%s]\n", cstr)); - - /* Same thing but create a dup */ - - COLOUT(printf("Get item as string with duplication" - " from correct item.\n")); - - error = 0; - str = get_string_config_value(item, &error); - if (error) { - printf("Expected success got error %d.\n", error); - free_ini_config(ini_config); - return error; - } - - COLOUT(printf("Value: [%s]\n", str)); - free(str); - - - /* Get a badly formated number */ - COLOUT(printf("Convert item to number with strict conversion.\n")); - - item = NULL; - error = get_config_item("monitor", "bad_number", ini_config, &item); - if (error) { - printf("Expected success but got error! %d\n", error); - free_ini_config(ini_config); - return error; - } - - /* Item should be found */ - if (item == NULL) { - printf("Expected item but got something NULL!\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(col_debug_item(item)); - - - /* Now try to get value in different ways */ - error = 0; - number = get_int_config_value(item, 1, 10, &error); - if (error) { - /* We expected error in this case */ - COLOUT(printf("Expected error.\n")); - if(number != 10) { - printf("It failed to set default value.\n"); - free_ini_config(ini_config); - return -1; - } - } - - COLOUT(printf("Convert item to number without strict conversion.\n")); - - error = 0; - number = 1; - number = get_int_config_value(item, 0, 10, &error); - if (error) { - /* We expected error in this case */ - printf("Did not expect error.\n"); - free_ini_config(ini_config); - return error; - } - - if (number != 5) { - /* We expected error in this case */ - printf("We expected that the conversion will return 5.\n"); - free_ini_config(ini_config); - return -1; - } - - /* Get real integer */ - - COLOUT(printf("Fetch another item from section \"domains/LOCAL\"" - " named \"enumerate\".\n")); - - item = NULL; - error = get_config_item("domains/LOCAL","enumerate", ini_config, &item); - if (error) { - printf("Expected success but got error! %d\n", error); - free_ini_config(ini_config); - return error; - } - - /* Item should be found */ - if (item == NULL) { - printf("Expected success but got NULL.\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(printf("Convert item to integer.\n")); - - /* Take number out of it */ - error = 0; - number = get_int_config_value(item, 1, 100, &error); - if (error) { - printf("Did not expect error. Got %d\n", error); - free_ini_config(ini_config); - return error; - } - - /* It is 3 in the file */ - if (number != 3) { - printf("We expected that the conversion will return 3.\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(printf("Expected 3 got %d\n", number)); - - COLOUT(printf("Convert item to long.\n")); - - /* Take number out of it */ - error = 0; - number_long = get_long_config_value(item, 1, 100, &error); - if (error) { - printf("Did not expect error. Got %d\n", error); - free_ini_config(ini_config); - return error; - } - - /* It is 3 in the file */ - if (number_long != 3) { - printf("We expected that the conversion will return 3.\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(printf("Expected 3 got %ld\n", number_long)); - - COLOUT(printf("Convert item to unsigned.\n")); - - /* Take number out of it */ - error = 0; - number_unsigned = get_unsigned_config_value(item, 1, 100, &error); - if (error) { - printf("Did not expect error. Got %d\n", error); - free_ini_config(ini_config); - return error; - } - - /* It is 3 in the file */ - if(number_unsigned != 3) { - printf("We expected that the conversion will return 3.\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(printf("Expected 3 got %d\n", number_unsigned)); - - COLOUT(printf("Convert item to unsigned long.\n")); - - /* Take number out of it */ - error = 0; - number_ulong = get_ulong_config_value(item, 1, 100, &error); - if (error) { - printf("Did not expect error. Got %d\n", error); - free_ini_config(ini_config); - return error; - } - - /* It is 3 in the file */ - if (number_ulong != 3) { - printf("We expected that the conversion will return 3.\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(printf("Expected 3 got %lu\n", number_ulong)); - - COLOUT(printf("Convert item to double.\n")); - - /* Take number out of it */ - error = 0; - number_double = get_double_config_value(item, 1, 100., &error); - if (error) { - printf("Did not expect error. Got %d\n", error); - free_ini_config(ini_config); - return error; - } - - /* It is 3 in the file */ - if (number_double != 3.) { - printf("We expected that the conversion will return 3.\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(printf("Expected 3 got %e\n", number_double)); - - COLOUT(printf("Convert item to bool.\n")); - - /* Take number out of it */ - error = 0; - logical = get_bool_config_value(item, 1, &error); - if (!error) { - printf("Expect error. Got success.\n"); - free_ini_config(ini_config); - return -1; - } - - /* Get real bool item and convert it */ - COLOUT(printf("Get real bool item \"legacy\" and convert it.\n")); - - item = NULL; - error = get_config_item("domains/LOCAL","legacy", ini_config, &item); - if (error) { - printf("Expected success but got error! %d\n",error); - free_ini_config(ini_config); - return error; - } - - /* Item should be found */ - if (item == NULL) { - printf("Expected success but got NULL.\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(printf("Convert item to bool.\n")); - - error = 0; - logical = get_bool_config_value(item, 1, &error); - if (error) { - printf("Expect success got error %d.\n", error); - free_ini_config(ini_config); - return error; - } - - if (logical) { - printf("Expected false but got true - bad.\n"); - return -1; - } - - COLOUT(printf("In the files it is FALSE so we got false.\n")); - - COLOUT(printf("Get binary item\n")); - - item = NULL; - error = get_config_item("domains/EXAMPLE.COM", - "binary_test", - ini_config, - &item); - if (error) { - printf("Expected success but got error! %d\n", error); - free_ini_config(ini_config); - return error; - } - - /* Item should be found */ - if (item == NULL) { - printf("Expected success but got NULL.\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(col_debug_item(item)); - - error = 0; - binary = get_bin_config_value(item, &length, &error); - if (error) { - printf("Expect success got error %d.\n", error); - free_ini_config(ini_config); - return error; - } - - COLOUT(printf("Binary value (expect 123) = ")); - COLOUT(for (i=0;i<length;i++) { - printf("%d",*((unsigned char*)(binary)+i)); - }); - COLOUT(printf("\n")); - - free_bin_config_value(binary); - - COLOUT(printf("Get string array item\n")); - - item = NULL; - error = get_config_item("domains", "domainsorder", ini_config, &item); - if(error) { - printf("Expected success but got error! %d\n",error); - free_ini_config(ini_config); - return error; - } - - /* Item should be found */ - if (item == NULL) { - printf("Expected success but got NULL.\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(col_debug_item(item)); - - COLOUT(printf("Get str array without size.\n")); - - error = 0; - strarray = get_string_config_array(item, ",", NULL, &error); - if (error) { - printf("Expect success got error %d.\n", error); - free_ini_config(ini_config); - return error; - } - - /* Can be used with this cycle */ - strptr = strarray; - while (*strptr != NULL) { - COLOUT(printf("[%s]\n",*strptr)); - strptr++; - } - - free_string_config_array(strarray); - - COLOUT(printf("Get raw str array without size.\n")); - - error = 0; - strarray = get_raw_string_config_array(item, ",", NULL, &error); - if (error) { - printf("Expect success got error %d.\n", error); - free_ini_config(ini_config); - return error; - } - - /* Can be used with this cycle */ - strptr = strarray; - while (*strptr != NULL) { - COLOUT(printf("[%s]\n",*strptr)); - strptr++; - } - - free_string_config_array(strarray); - - COLOUT(printf("Get str array with size.\n")); - - error = 0; - size = 0; - strarray = get_string_config_array(item, ",", &size, &error); - if (error) { - printf("Expect success got error %d.\n", error); - free_ini_config(ini_config); - return error; - } - - /* Can be used with this cycle */ - COLOUT(for (i=0;i<size;i++) printf("[%s]\n",*(strarray + i))); - - free_string_config_array(strarray); - - COLOUT(printf("Get raw str array with size.\n")); - - error = 0; - size = 0; - strarray = get_raw_string_config_array(item, ",", &size, &error); - if (error) { - printf("Expect success got error %d.\n", error); - free_ini_config(ini_config); - return error; - } - - /* Can be used with this cycle */ - COLOUT(for (i=0;i<size;i++) printf("[%s]\n",*(strarray + i))); - - free_string_config_array(strarray); - - COLOUT(printf("Get long array item\n")); - - item = NULL; - error = get_config_item("domains/EXAMPLE.COM", - "long_array", - ini_config, - &item); - if(error) { - printf("Expected success but got error! %d\n", error); - free_ini_config(ini_config); - return error; - } - - /* Item should be found */ - if (item == NULL) { - printf("Expected success but got NULL.\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(col_debug_item(item)); - - error = 0; - size = 0; /* Here size is not optional!!! */ - array = get_long_config_array(item, &size, &error); - if(error) { - printf("Expect success got error %d.\n", error); - free_ini_config(ini_config); - return error; - } - - /* Can be used with this cycle */ - COLOUT(for (i=0;i<size;i++) printf("%ld\n", *(array + i))); - - free_long_config_array(array); - - COLOUT(printf("Get double array item\n")); - - item = NULL; - error = get_config_item("domains/EXAMPLE.COM", - "double_array", - ini_config, - &item); - if (error) { - printf("Expected success but got error! %d\n", error); - free_ini_config(ini_config); - return error; - } - - /* Item should be found */ - if (item == NULL) { - printf("Expected success but got NULL.\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(col_debug_item(item)); - - error = 0; - size = 0; /* Here size is not optional!!! */ - darray = get_double_config_array(item, &size, &error); - if (error) { - printf("Expect success got error %d.\n", error); - free_ini_config(ini_config); - return error; - } - - /* Can be used with this cycle */ - COLOUT(for (i=0;i<size;i++) printf("%.4f\n", darray[i])); - - free_double_config_array(darray); - - COLOUT(printf("\n\nSection list - no size\n")); - - /* Do not care about the error or size */ - prop_array = get_section_list(ini_config, NULL, NULL); - if (prop_array == NULL) { - printf("Expect success got error.\n"); - free_ini_config(ini_config); - return -1; - } - - i = 0; - COLOUT(while (prop_array[i]) { - printf("Section: [%s]\n", prop_array[i]); - i++; - }); - - free_section_list(prop_array); - - COLOUT(printf("\n\nSection list - with size\n")); - - /* Do not care about the error or size */ - prop_array = get_section_list(ini_config, &size, NULL); - if (prop_array == NULL) { - printf("Expect success got error.\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(for (i=0;i<size;i++) printf("Section: [%s]\n", prop_array[i])); - free_section_list(prop_array); - - COLOUT(printf("\n\nAttributes in the section - with size and error\n")); - - /* Do not care about the error or size */ - prop_array = get_attribute_list(ini_config, - "domains/EXAMPLE.COM", - &size, - &error); - if (prop_array == NULL) { - printf("Expect success got error.\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(for (i=0;i<size;i++) printf("Attribute: [%s]\n", prop_array[i])); - free_attribute_list(prop_array); - - - /***************************************/ - /* Test special types */ - /***************************************/ - COLOUT(printf("Test int32_t\n")); - - item = NULL; - error = get_config_item("domains/EXAMPLE.COM", - "int32_t", - ini_config, - &item); - if (error) { - printf("Expected success but got error! %d\n", error); - free_ini_config(ini_config); - return error; - } - - /* Item should be found */ - if (item == NULL) { - printf("Expected success but got NULL.\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(col_debug_item(item)); - - error = 0; - val_int32 = get_int32_config_value(item, 1, 0, &error); - if (error) { - printf("Expect success got error %d.\n", error); - free_ini_config(ini_config); - return error; - } - - COLOUT(printf("Value: %d\n", val_int32)); - - /***************************************/ - - COLOUT(printf("Test uint32_t\n")); - - item = NULL; - error = get_config_item("domains/EXAMPLE.COM", - "uint32_t", - ini_config, - &item); - if (error) { - printf("Expected success but got error! %d\n", error); - free_ini_config(ini_config); - return error; - } - - /* Item should be found */ - if (item == NULL) { - printf("Expected success but got NULL.\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(col_debug_item(item)); - - error = 0; - val_uint32 = get_uint32_config_value(item, 1, 0, &error); - if (error) { - printf("Expect success got error %d.\n", error); - free_ini_config(ini_config); - return error; - } - - COLOUT(printf("Value: %u\n", val_uint32)); - - /***************************************/ - - COLOUT(printf("Test int64_t\n")); - - item = NULL; - error = get_config_item("domains/EXAMPLE.COM", - "int64_t", - ini_config, - &item); - if (error) { - printf("Expected success but got error! %d\n", error); - free_ini_config(ini_config); - return error; - } - - /* Item should be found */ - if (item == NULL) { - printf("Expected success but got NULL.\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(col_debug_item(item)); - - error = 0; - val_int64 = get_int64_config_value(item, 1, 0, &error); - if (error) { - printf("Expect success got error %d.\n", error); - free_ini_config(ini_config); - return error; - } - - COLOUT(printf("Value: %lld\n", (long long)val_int64)); - - /***************************************/ - - COLOUT(printf("Test uint32_t\n")); - - item = NULL; - error = get_config_item("domains/EXAMPLE.COM", - "uint64_t", - ini_config, - &item); - if (error) { - printf("Expected success but got error! %d\n", error); - free_ini_config(ini_config); - return error; - } - - /* Item should be found */ - if (item == NULL) { - printf("Expected success but got NULL.\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(col_debug_item(item)); - - error = 0; - val_uint64 = get_uint64_config_value(item, 1, 0, &error); - if (error) { - printf("Expect success got error %d.\n", error); - free_ini_config(ini_config); - return error; - } - - COLOUT(printf("Value: %llu\n", (unsigned long long)val_uint64)); - - /***************************************/ - - COLOUT(printf("Get empty array item\n")); - - item = NULL; - error = get_config_item("domains/EXAMPLE.COM", - "empty_value", - ini_config, - &item); - if(error) { - printf("Expected success but got error! %d\n", error); - free_ini_config(ini_config); - return error; - } - - /* Item should be found */ - if (item == NULL) { - printf("Expected success but got NULL.\n"); - free_ini_config(ini_config); - return -1; - } - - COLOUT(col_debug_item(item)); - - error = 0; - size = 0; /* Here size is not optional!!! */ - strarray = get_string_config_array(item, ",", &size, &error); - if(error) { - printf("Expect success got error %d.\n", error); - free_ini_config(ini_config); - return error; - } - - if (size != 0) { - for (i=0; i<size; i++) printf("%s\n", *(strarray + i)); - printf("Expected size=0, got size=%d\n", size); - free_string_config_array(strarray); - free_ini_config(ini_config); - return -1; - } - - - free_string_config_array(strarray); - - free_ini_config(ini_config); - COLOUT(printf("Done with get test!\n")); - return EOK; -} - -/* This is an emulation of the case when daemon starts - * and one needs to parse the configuration file - * for the first time and load configuration - */ -int startup_test(void) -{ - int error; - struct collection_item *ini_config = NULL; - struct collection_item *error_set = NULL; - struct collection_item *metadata = NULL; - uint32_t flags; - - - /* At startup we can simplify our life by - * parsing configuration and then checking - * the permissions. It is less optimal from - * the performnce point of view but simple to implement. - * Since it is the start of the daemon we can - * hope that parsing the config file would - * usually not a be a wasted effort. - * If permission check fails that means we should - * exit. Ok so we just parse the INI file for nothing. - * Not a big deal, I would say... - */ - - COLOUT(printf("STARTUP TEST\n")); - - /* Set file permissions to 0664 */ - chmod("./ini.conf", 0664); - - flags = INI_META_SEC_ACCESS_FLAG | - INI_META_SEC_ERROR_FLAG; - - error = config_from_file_with_metadata("test", "./ini.conf", - &ini_config, INI_STOP_ON_NONE, - &error_set, - flags, - &metadata); - /* - * This is just for debugging. - * do not copy into your implementation - */ - if (metadata) { - COLOUT(printf("\n\nMeta data\n")); - COLOUT(col_debug_collection(metadata, COL_TRAVERSE_DEFAULT)); - } - - - if (error) { - printf("Attempt to read configuration returned error: %d\n",error); - - /* If you want to do any specific error checking, do it here. - * If you want to get the file error code from the - * metadata get it here. - */ - free_ini_config_metadata(metadata); - - /* Error reporting start ==> */ - if (error_set) { - printf("\n\nErrors\n"); - col_debug_collection(error_set, COL_TRAVERSE_DEFAULT); - } - /* <==== end */ - free_ini_config_errors(error_set); - return error; - } - - free_ini_config_errors(error_set); - - /* So we are here if we successfully got configuration. */ - /* You can check ownership and permissions here in one call */ - /* We will check just permissions here. */ - error = config_access_check(metadata, - INI_ACCESS_CHECK_MODE, /* add uid & gui flags - * in real case - */ - 0, /* <- will be real uid in real case */ - 0, /* <- will be real gid in real case */ - 0440, /* Checking for r--r----- */ - 0); - /* This check is expected to fail since - * the actual permissions on the test file are: rw-rw-r-- - */ - - if (!error) { - printf("Expected error got success!\n"); - free_ini_config_metadata(metadata); - free_ini_config(ini_config); - return EACCES; - } - - error = config_access_check(metadata, - INI_ACCESS_CHECK_MODE, /* add uid & gui flags - * in real case - */ - 0, /* <- will be real uid in real case */ - 0, /* <- will be real gid in real case */ - 0664, /* Checkling for rw-rw-r-- */ - 0); - - if (error) { - printf("Access check failed %d!\n", error); - free_ini_config_metadata(metadata); - free_ini_config(ini_config); - return EACCES; - } - - - /* Use configuration */ - - COLOUT(printf("\n\nMeta data\n")); - COLOUT(col_debug_collection(metadata, COL_TRAVERSE_DEFAULT)); - free_ini_config_metadata(metadata); - - COLOUT(printf("\n\n----------------------\n")); - - COLOUT(printf("\n\nConfiguration\n")); - COLOUT(col_debug_collection(ini_config, COL_TRAVERSE_DEFAULT)); - free_ini_config(ini_config); - - return 0; -} - -int reload_test(void) -{ - - int error; - struct collection_item *ini_config = NULL; - struct collection_item *metadata = NULL; - struct collection_item *saved_metadata = NULL; - uint32_t flags; - int changed = 0; - int fd; - - COLOUT(printf("RELOAD TEST\n")); - - /* Assume we saved metadata at the beginning - * when we opened the file and read configuration - * for the first time. - * Here we have to emulate it. - */ - - flags = INI_META_SEC_ACCESS_FLAG | - INI_META_ACTION_NOPARSE; - - error = config_from_file_with_metadata("test", "./ini.conf", - &ini_config, - 0, - NULL, - flags, - &saved_metadata); - if (error) { - printf("Attempt to read configuration returned error: %d\n",error); - free_ini_config_metadata(saved_metadata); - return error; - } - - /*****************************************/ - - /* We are reloading so we probably doing it becuase - * we got a signal ot some kind of time out expired - * and it might be time for us to check if we need - * to reload. So assume it is time to check... - */ - - /* It is safer to open file first */ - fd = open("./ini.conf", O_RDONLY); - if (fd < 0) { - error = errno; - printf("Attempt to read configuration returned error: %d\n", error); - free_ini_config_metadata(saved_metadata); - return error; - } - - /* You migth be checking pretty frequently, once in 5 min for example - * but the config usually does not change for months - * so you do not want to do any extra processing every time you check. - */ - - /* Do permission check here right away on the file, or... */ - - - flags = INI_META_SEC_ACCESS_FLAG | - INI_META_ACTION_NOPARSE; - - error = config_from_fd_with_metadata("test", fd, - "./ini.conf", - &ini_config, - 0, - NULL, - flags, - &metadata); - if (error) { - printf("Attempt to read configuration returned error: %d\n",error); - if (metadata) { - printf("\n\nMeta data\n"); - col_debug_collection(metadata, COL_TRAVERSE_DEFAULT); - } - free_ini_config_metadata(metadata); - free_ini_config_metadata(saved_metadata); - close(fd); - return error; - } - - /* ...or you can do permission check here using the metadata - * as it is done in the startup test. - * For now we skip this part and move on. - */ - - error = config_changed(metadata, saved_metadata, &changed); - - if (error) { - printf("Internal error: %d\n",error); - printf("\n\nSaved Meta data\n"); - col_debug_collection(saved_metadata, COL_TRAVERSE_DEFAULT); - printf("\n\nMeta data\n"); - col_debug_collection(metadata, COL_TRAVERSE_DEFAULT); - free_ini_config_metadata(saved_metadata); - free_ini_config_metadata(metadata); - close(fd); - return error; - - } - - if (changed) { - - /* Read the config from the descriptor and use it. - * Discard old saved meta data and save - * the latest one for future use... - */ - - /* Here it would be an error if it is different */ - printf("Meta data is supposed to be same but different.\n"); - printf("\n\nSaved Meta data\n"); - col_debug_collection(saved_metadata, COL_TRAVERSE_DEFAULT); - printf("\n\nMeta data\n"); - col_debug_collection(metadata, COL_TRAVERSE_DEFAULT); - } - - free_ini_config_metadata(saved_metadata); - free_ini_config_metadata(metadata); - close(fd); - - return 0; -} - - -int main(int argc, char *argv[]) -{ - int error = EOK; - char *srcdir = NULL; - - if ((argc > 1) && (strcmp(argv[1], "-v") == 0)) verbose = 1; - - COLOUT(printf("Start\n")); - - srcdir = getenv("srcdir"); - if(srcdir) { - if(chdir(srcdir) != 0) { - error = errno; - printf("Failed to change directory, error %d\n", error); - return error; - } - } - - if ((error = basic_test()) || - (error = single_file()) || - (error = single_fd()) || - (error = real_test(NULL)) || - /* This should result in merged configuration */ - (error = real_test("./ini.conf")) || - (error = startup_test()) || - (error = reload_test()) || - (error = get_test())) { - printf("Test failed! Error %d.\n", error); - return -1; - } - - COLOUT(printf("Success!\n")); - return 0; -} diff --git a/common/ini/ini_defines.h b/common/ini/ini_defines.h deleted file mode 100644 index 46ed00f42..000000000 --- a/common/ini/ini_defines.h +++ /dev/null @@ -1,74 +0,0 @@ -/* - INI LIBRARY - - Header file for the internal constants for the INI interface. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2010 - - INI Library 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. - - INI Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with INI Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#ifndef INI_DEFINES_H -#define INI_DEFINES_H - -#define NAME_OVERHEAD 10 - -#define SLASH "/" - - -/* Name of the special collection used to store parsing errors */ -#define FILE_ERROR_SET "ini_file_error_set" - -/* Text error strings used when errors are printed out */ -#define WARNING_TXT _("Warning") -#define ERROR_TXT _("Error") -/* For parse errors */ -#define WRONG_COLLECTION _("Passed in list is not a list of parse errors.\n") -#define FAILED_TO_PROCCESS _("Internal Error. Failed to process error list.\n") -#define ERROR_HEADER _("Parsing errors and warnings in file: %s\n") -/* For grammar errors */ -#define WRONG_GRAMMAR _("Passed in list is not a list of grammar errors.\n") -#define FAILED_TO_PROC_G _("Internal Error. Failed to process list of grammar errors.\n") -#define ERROR_HEADER_G _("Logical errors and warnings in file: %s\n") -/* For validation errors */ -#define WRONG_VALIDATION _("Passed in list is not a list of validation errors.\n") -#define FAILED_TO_PROC_V _("Internal Error. Failed to process list of validation errors.\n") -#define ERROR_HEADER_V _("Validation errors and warnings in file: %s\n") - -#define LINE_FORMAT _("%s (%d) on line %d: %s\n") - - -/* Codes that parsing function can return */ -#define RET_PAIR 0 -#define RET_COMMENT 1 -#define RET_SECTION 2 -#define RET_INVALID 3 -#define RET_EMPTY 4 -#define RET_EOF 5 -#define RET_ERROR 6 - -#define INI_ERROR "errors" -#define INI_ERROR_NAME "errname" - -/* Internal sizes. MAX_KEY is defined in config.h */ -#define MAX_VALUE PATH_MAX -#define BUFFER_SIZE MAX_KEY + MAX_VALUE + 3 - -/* Beffer length used for int to string conversions */ -#define CONVERSION_BUFFER 80 - -/* Different error string functions can be passed as callbacks */ -typedef const char * (*error_fn)(int error); - -#endif diff --git a/common/ini/ini_get_array.c b/common/ini/ini_get_array.c deleted file mode 100644 index b2cbfacf9..000000000 --- a/common/ini/ini_get_array.c +++ /dev/null @@ -1,356 +0,0 @@ -/* - INI LIBRARY - - Value interpretation functions for arrays of values - and corresponding memory cleanup functions. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2010 - - INI Library 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. - - INI Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with INI Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#define _GNU_SOURCE -#include <stdio.h> -#include <errno.h> -#include <string.h> -#include <stdlib.h> -#include <ctype.h> -#include <locale.h> -#include "config.h" -#include "trace.h" -#include "collection.h" -#include "collection_tools.h" -#include "ini_defines.h" -#include "ini_config.h" - -/* - * Internal contants to indicate how - * to process the lists of strings. - */ -#define EXCLUDE_EMPTY 0 -#define INCLUDE_EMPTY 1 - -/* Arrays of stings */ -static char **get_str_cfg_array(struct collection_item *item, - int include, - const char *sep, - int *size, - int *error) -{ - char *copy = NULL; - char *dest = NULL; - char locsep[4]; - int lensep; - char *buff; - int count = 0; - int len = 0; - int resume_len; - char **array; - char *start; - int i, j; - int dlen; - - TRACE_FLOW_STRING("get_str_cfg_array", "Entry"); - - /* Do we have the item ? */ - if ((item == NULL) || - (col_get_item_type(item) != COL_TYPE_STRING)) { - TRACE_ERROR_NUMBER("Invalid argument.", EINVAL); - if (error) *error = EINVAL; - return NULL; - } - - /* Handle the separators */ - if (sep == NULL) { - locsep[0] = ','; - locsep[1] = '\0'; - lensep = 2; - } - else { - strncpy(locsep, sep, 3); - locsep[3] = '\0'; - lensep = strlen(locsep) + 1; - } - - /* Allocate memory for the copy of the string */ - copy = malloc(col_get_item_length(item)); - if (copy == NULL) { - TRACE_ERROR_NUMBER("Failed to allocate memory.", ENOMEM); - if (error) *error = ENOMEM; - return NULL; - } - - /* Loop through the string */ - dest = copy; - buff = col_get_item_data(item); - start = buff; - dlen = col_get_item_length(item); - for(i = 0; i < dlen; i++) { - for(j = 0; j < lensep; j++) { - if(buff[i] == locsep[j]) { - /* If we found one of the separators trim spaces around */ - resume_len = len; - while (len > 0) { - if (isspace(start[len - 1])) len--; - else break; - } - TRACE_INFO_STRING("Current:", start); - TRACE_INFO_NUMBER("Length:", len); - if (len > 0) { - /* Save block aside */ - memcpy(dest, start, len); - count++; - dest += len; - *dest = '\0'; - dest++; - } - else if(include) { - count++; - *dest = '\0'; - dest++; - } - if (locsep[j] == '\0') break; /* We are done */ - - /* Move forward and trim spaces if any */ - start += resume_len + 1; - i++; - TRACE_INFO_STRING("Other pointer :", buff + i); - while ((i < dlen) && (isspace(*start))) { - i++; - start++; - } - len = -1; /* Len will be increased in the loop */ - i--; /* i will be increas so we need to step back */ - TRACE_INFO_STRING("Remaining buffer after triming spaces:", start); - break; - } - } - len++; - } - - /* Now we know how many items are there in the list */ - array = malloc((count + 1) * sizeof(char *)); - if (array == NULL) { - free(copy); - TRACE_ERROR_NUMBER("Failed to allocate memory.", ENOMEM); - if (error) *error = ENOMEM; - return NULL; - } - - /* Loop again to fill in the pointers */ - start = copy; - for (i = 0; i < count; i++) { - TRACE_INFO_STRING("Token :", start); - TRACE_INFO_NUMBER("Item :", i); - array[i] = start; - /* Move to next item */ - while(*start) start++; - start++; - } - array[count] = NULL; - - if (error) *error = EOK; - if (size) *size = count; - /* If count is 0 the copy needs to be freed */ - if (count == 0) free(copy); - TRACE_FLOW_STRING("get_str_cfg_array", "Exit"); - return array; -} - -/* Get array of strings from item eliminating empty tokens */ -char **get_string_config_array(struct collection_item *item, - const char *sep, int *size, int *error) -{ - TRACE_FLOW_STRING("get_string_config_array", "Called."); - return get_str_cfg_array(item, EXCLUDE_EMPTY, sep, size, error); -} -/* Get array of strings from item preserving empty tokens */ -char **get_raw_string_config_array(struct collection_item *item, - const char *sep, int *size, int *error) -{ - TRACE_FLOW_STRING("get_raw_string_config_array", "Called."); - return get_str_cfg_array(item, INCLUDE_EMPTY, sep, size, error); -} - -/* Special function to free string config array */ -void free_string_config_array(char **str_config) -{ - TRACE_FLOW_STRING("free_string_config_array", "Entry"); - - if (str_config != NULL) { - if (*str_config != NULL) free(*str_config); - free(str_config); - } - - TRACE_FLOW_STRING("free_string_config_array", "Exit"); -} - -/* Get an array of long values. - * NOTE: For now I leave just one function that returns numeric arrays. - * In future if we need other numeric types we can change it to do strtoll - * internally and wrap it for backward compatibility. - */ -long *get_long_config_array(struct collection_item *item, int *size, int *error) -{ - const char *str; - char *endptr; - long val = 0; - long *array; - int count = 0; - int err; - - TRACE_FLOW_STRING("get_long_config_array", "Entry"); - - /* Do we have the item ? */ - if ((item == NULL) || - (col_get_item_type(item) != COL_TYPE_STRING) || - (size == NULL)) { - TRACE_ERROR_NUMBER("Invalid argument.", EINVAL); - if (error) *error = EINVAL; - return NULL; - } - - /* Assume that we have maximum number of different numbers */ - array = (long *)malloc(sizeof(long) * col_get_item_length(item)/2); - if (array == NULL) { - TRACE_ERROR_NUMBER("Failed to allocate memory.", ENOMEM); - if (error) *error = ENOMEM; - return NULL; - } - - /* Now parse the string */ - str = (const char *)col_get_item_data(item); - while (*str) { - - errno = 0; - val = strtol(str, &endptr, 10); - err = errno; - - if (err) { - TRACE_ERROR_NUMBER("Conversion failed", err); - free(array); - if (error) *error = err; - return NULL; - } - - if (endptr == str) { - TRACE_ERROR_NUMBER("Nothing processed", EIO); - free(array); - if (error) *error = EIO; - return NULL; - } - - /* Save value */ - array[count] = val; - count++; - /* Are we done? */ - if (*endptr == 0) break; - /* Advance to the next valid number */ - for (str = endptr; *str; str++) { - if (isdigit(*str) || (*str == '-') || (*str == '+')) break; - } - } - - *size = count; - if (error) *error = EOK; - - TRACE_FLOW_NUMBER("get_long_config_value returning", val); - return array; - -} - -/* Get an array of double values */ -double *get_double_config_array(struct collection_item *item, int *size, int *error) -{ - const char *str; - char *endptr; - double val = 0; - double *array; - int count = 0; - struct lconv *loc; - - TRACE_FLOW_STRING("get_double_config_array", "Entry"); - - /* Do we have the item ? */ - if ((item == NULL) || - (col_get_item_type(item) != COL_TYPE_STRING) || - (size == NULL)) { - TRACE_ERROR_NUMBER("Invalid argument.", EINVAL); - if (error) *error = EINVAL; - return NULL; - } - - /* Assume that we have maximum number of different numbers */ - array = (double *)malloc(sizeof(double) * col_get_item_length(item)/2); - if (array == NULL) { - TRACE_ERROR_NUMBER("Failed to allocate memory.", ENOMEM); - if (error) *error = ENOMEM; - return NULL; - } - - /* Get locale information so that we can check for decimal point character. - * Based on the man pages it is unclear if this is an allocated memory or not. - * Seems like it is a static thread or process local structure so - * I will not try to free it after use. - */ - loc = localeconv(); - - /* Now parse the string */ - str = (const char *)col_get_item_data(item); - while (*str) { - TRACE_INFO_STRING("String to convert",str); - errno = 0; - val = strtod(str, &endptr); - if ((errno == ERANGE) || - ((errno != 0) && (val == 0)) || - (endptr == str)) { - TRACE_ERROR_NUMBER("Conversion failed", EIO); - free(array); - if (error) *error = EIO; - return NULL; - } - /* Save value */ - array[count] = val; - count++; - /* Are we done? */ - if (*endptr == 0) break; - TRACE_INFO_STRING("End pointer after conversion",endptr); - /* Advance to the next valid number */ - for (str = endptr; *str; str++) { - if (isdigit(*str) || (*str == '-') || (*str == '+') || - /* It is ok to do this since the string is null terminated */ - ((*str == *(loc->decimal_point)) && isdigit(str[1]))) break; - } - } - - *size = count; - if (error) *error = EOK; - - TRACE_FLOW_NUMBER("get_double_config_value returning", val); - return array; - -} - - -/* Special function to free long config array */ -void free_long_config_array(long *array) -{ - if (array != NULL) free(array); -} - -/* Special function to free double config array */ -void free_double_config_array(double *array) -{ - if (array != NULL) free(array); -} diff --git a/common/ini/ini_get_value.c b/common/ini/ini_get_value.c deleted file mode 100644 index f31077f11..000000000 --- a/common/ini/ini_get_value.c +++ /dev/null @@ -1,589 +0,0 @@ -/* - INI LIBRARY - - Value interpretation functions for single values - and corresponding memory cleanup functions. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2010 - - INI Library 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. - - INI Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with INI Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#define _GNU_SOURCE -#include <stdio.h> -#include <errno.h> -#include <string.h> -#include <stdlib.h> -#include <ctype.h> -#include "config.h" -#include "trace.h" -#include "collection.h" -#include "collection_tools.h" -#include "ini_defines.h" -#include "ini_config.h" - -/* Function to get value from the configuration handle */ -int get_config_item(const char *section, - const char *name, - struct collection_item *ini_config, - struct collection_item **item) -{ - int error = EOK; - struct collection_item *section_handle = NULL; - const char *to_find; - char default_section[] = INI_DEFAULT_SECTION; - - TRACE_FLOW_STRING("get_config_item", "Entry"); - - /* Do we have the accepting memory ? */ - if (item == NULL) { - TRACE_ERROR_NUMBER("No buffer - invalid argument.", EINVAL); - return EINVAL; - } - - /* Is the collection of a right type */ - if ((col_is_of_class(ini_config, COL_CLASS_INI_CONFIG) == 0) && - (col_is_of_class(ini_config, COL_CLASS_INI_META) == 0)) { - TRACE_ERROR_NUMBER("Wrong collection type", EINVAL); - return EINVAL; - } - - *item = NULL; - - if (section == NULL) to_find = default_section; - else to_find = section; - - TRACE_INFO_STRING("Getting Name:", name); - TRACE_INFO_STRING("In Section:", section); - - /* Get Subcollection */ - error = col_get_collection_reference(ini_config, §ion_handle, to_find); - /* Check error */ - if (error && (error != ENOENT)) { - TRACE_ERROR_NUMBER("Failed to get section", error); - return error; - } - - /* Did we find a section */ - if ((error == ENOENT) || (section_handle == NULL)) { - /* We have not found section - return success */ - TRACE_FLOW_STRING("get_value_from_config", "No such section"); - return EOK; - } - - /* Get item */ - error = col_get_item(section_handle, name, - COL_TYPE_STRING, COL_TRAVERSE_ONELEVEL, item); - - /* Make sure we free the section we found */ - col_destroy_collection(section_handle); - - TRACE_FLOW_NUMBER("get_config_item returning", error); - return error; -} - -/* Get long long value from config item */ -static long long get_llong_config_value(struct collection_item *item, - int strict, - long long def, - int *error) -{ - int err; - const char *str; - char *endptr; - long long val = 0; - - TRACE_FLOW_STRING("get_llong_config_value", "Entry"); - - /* Do we have the item ? */ - if ((item == NULL) || - (col_get_item_type(item) != COL_TYPE_STRING)) { - TRACE_ERROR_NUMBER("Invalid argument.", EINVAL); - if (error) *error = EINVAL; - return def; - } - - if (error) *error = EOK; - - /* Try to parse the value */ - str = (const char *)col_get_item_data(item); - errno = 0; - val = strtoll(str, &endptr, 10); - err = errno; - - /* Check for various possible errors */ - if (err != 0) { - TRACE_ERROR_NUMBER("Conversion failed", err); - if (error) *error = err; - return def; - } - - /* Other error cases */ - if ((endptr == str) || (strict && (*endptr != '\0'))) { - TRACE_ERROR_NUMBER("More characters or nothing processed", EIO); - if (error) *error = EIO; - return def; - } - - TRACE_FLOW_NUMBER("get_llong_config_value returning", (long)val); - return val; -} - -/* Get unsigned long long value from config item */ -static unsigned long long get_ullong_config_value(struct collection_item *item, - int strict, - unsigned long long def, - int *error) -{ - int err; - const char *str; - char *endptr; - unsigned long long val = 0; - - TRACE_FLOW_STRING("get_ullong_config_value", "Entry"); - - /* Do we have the item ? */ - if ((item == NULL) || - (col_get_item_type(item) != COL_TYPE_STRING)) { - TRACE_ERROR_NUMBER("Invalid argument.", EINVAL); - if (error) *error = EINVAL; - return def; - } - - if (error) *error = EOK; - - /* Try to parse the value */ - str = (const char *)col_get_item_data(item); - errno = 0; - val = strtoull(str, &endptr, 10); - err = errno; - - /* Check for various possible errors */ - if (err != 0) { - TRACE_ERROR_NUMBER("Conversion failed", err); - if (error) *error = err; - return def; - } - - /* Other error cases */ - if ((endptr == str) || (strict && (*endptr != '\0'))) { - TRACE_ERROR_NUMBER("More characters or nothing processed", EIO); - if (error) *error = EIO; - return def; - } - - TRACE_FLOW_NUMBER("get_ullong_config_value returning", val); - return val; -} - - -/* Get integer value from config item */ -int get_int_config_value(struct collection_item *item, - int strict, - int def, - int *error) -{ - long long val = 0; - int err = 0; - - TRACE_FLOW_STRING("get_int_config_value", "Entry"); - - val = get_llong_config_value(item, strict, def, &err); - if (err == 0) { - if ((val > INT_MAX) || (val < INT_MIN)) { - val = def; - err = ERANGE; - } - } - - if (error) *error = err; - - TRACE_FLOW_NUMBER("get_int_config_value returning", (int)val); - return (int)val; -} - -/* Get unsigned integer value from config item */ -unsigned get_unsigned_config_value(struct collection_item *item, - int strict, - unsigned def, - int *error) -{ - unsigned long long val = 0; - int err = 0; - - TRACE_FLOW_STRING("get_unsigned_config_value", "Entry"); - - val = get_ullong_config_value(item, strict, def, &err); - if (err == 0) { - if (val > UINT_MAX) { - val = def; - err = ERANGE; - } - } - - if (error) *error = err; - - TRACE_FLOW_NUMBER("get_unsigned_config_value returning", - (unsigned)val); - return (unsigned)val; -} - -/* Get long value from config item */ -long get_long_config_value(struct collection_item *item, - int strict, - long def, - int *error) -{ - long long val = 0; - int err = 0; - - TRACE_FLOW_STRING("get_long_config_value", "Entry"); - - val = get_llong_config_value(item, strict, def, &err); - if (err == 0) { - if ((val > LONG_MAX) || (val < LONG_MIN)) { - val = def; - err = ERANGE; - } - } - - if (error) *error = err; - - TRACE_FLOW_NUMBER("get_long_config_value returning", - (long)val); - return (long)val; -} - -/* Get unsigned long value from config item */ -unsigned long get_ulong_config_value(struct collection_item *item, - int strict, - unsigned long def, - int *error) -{ - unsigned long long val = 0; - int err = 0; - - TRACE_FLOW_STRING("get_ulong_config_value", "Entry"); - - val = get_ullong_config_value(item, strict, def, &err); - if (err == 0) { - if (val > ULONG_MAX) { - val = def; - err = ERANGE; - } - } - - if (error) *error = err; - - TRACE_FLOW_NUMBER("get_ulong_config_value returning", - (unsigned long)val); - return (unsigned long)val; -} - -/* Get int32_t value from config item */ -int32_t get_int32_config_value(struct collection_item *item, - int strict, - int32_t def, - int *error) -{ - int val = 0; - - TRACE_FLOW_STRING("get_int32_config_value", "Entry"); - - val = get_int_config_value(item, strict, (int)def, error); - - TRACE_FLOW_SNUMBER("get_int32_config_value returning", (int32_t)val); - return (int32_t)val; -} - -/* Get uint32_t value from config item */ -uint32_t get_uint32_config_value(struct collection_item *item, - int strict, - uint32_t def, - int *error) -{ - unsigned val = 0; - - TRACE_FLOW_STRING("get_uint32_config_value", "Entry"); - - val = get_unsigned_config_value(item, strict, (unsigned)def, error); - - TRACE_FLOW_NUMBER("get_uint32_config_value returning", (uint32_t)val); - return (uint32_t)val; -} - -/* Get int64_t value from config item */ -int64_t get_int64_config_value(struct collection_item *item, - int strict, - int64_t def, - int *error) -{ - long long val = 0; - - TRACE_FLOW_STRING("get_int64_config_value", "Entry"); - - val = get_llong_config_value(item, strict, (long long)def, error); - - TRACE_FLOW_SLNUMBER("get_int64_config_value returning", (int64_t)val); - return (int64_t)val; -} - -/* Get uint64_t value from config item */ -uint64_t get_uint64_config_value(struct collection_item *item, - int strict, - uint64_t def, - int *error) -{ - unsigned long long val = 0; - - TRACE_FLOW_STRING("get_uint64_config_value", "Entry"); - - val = get_ullong_config_value(item, - strict, - (unsigned long long)def, - error); - - TRACE_FLOW_LNUMBER("get_uint64_config_value returning", (uint64_t)val); - return (uint64_t)val; -} - -/* Get double value */ -double get_double_config_value(struct collection_item *item, - int strict, double def, int *error) -{ - const char *str; - char *endptr; - double val = 0; - - TRACE_FLOW_STRING("get_double_config_value", "Entry"); - - /* Do we have the item ? */ - if ((item == NULL) || - (col_get_item_type(item) != COL_TYPE_STRING)) { - TRACE_ERROR_NUMBER("Invalid argument.", EINVAL); - if (error) *error = EINVAL; - return def; - } - - if (error) *error = EOK; - - /* Try to parse the value */ - str = (const char *)col_get_item_data(item); - errno = 0; - val = strtod(str, &endptr); - - /* Check for various possible errors */ - if ((errno == ERANGE) || - ((errno != 0) && (val == 0)) || - (endptr == str)) { - TRACE_ERROR_NUMBER("Conversion failed", EIO); - if (error) *error = EIO; - return def; - } - - if (strict && (*endptr != '\0')) { - TRACE_ERROR_NUMBER("More characters than expected", EIO); - if (error) *error = EIO; - val = def; - } - - TRACE_FLOW_DOUBLE("get_double_config_value returning", val); - return val; -} - -/* Get boolean value */ -unsigned char get_bool_config_value(struct collection_item *item, - unsigned char def, int *error) -{ - const char *str; - int len; - - TRACE_FLOW_STRING("get_bool_config_value", "Entry"); - - /* Do we have the item ? */ - if ((item == NULL) || - (col_get_item_type(item) != COL_TYPE_STRING)) { - TRACE_ERROR_NUMBER("Invalid argument.", EINVAL); - if (error) *error = EINVAL; - return def; - } - - if (error) *error = EOK; - - str = (const char *)col_get_item_data(item); - len = col_get_item_length(item); - - /* Try to parse the value */ - if ((strncasecmp(str, "true", len) == 0) || - (strncasecmp(str, "yes", len) == 0)) { - TRACE_FLOW_STRING("Returning", "true"); - return '\1'; - } - else if ((strncasecmp(str, "false", len) == 0) || - (strncasecmp(str, "no", len) == 0)) { - TRACE_FLOW_STRING("Returning", "false"); - return '\0'; - } - - TRACE_ERROR_STRING("Returning", "error"); - if (error) *error = EIO; - return def; -} - -/* Return a string out of the value */ -char *get_string_config_value(struct collection_item *item, - int *error) -{ - char *str = NULL; - - TRACE_FLOW_STRING("get_string_config_value", "Entry"); - - /* Do we have the item ? */ - if ((item == NULL) || - (col_get_item_type(item) != COL_TYPE_STRING)) { - TRACE_ERROR_NUMBER("Invalid argument.", EINVAL); - if (error) *error = EINVAL; - return NULL; - } - - str = strdup((const char *)col_get_item_data(item)); - if (str == NULL) { - TRACE_ERROR_NUMBER("Failed to allocate memory.", ENOMEM); - if (error) *error = ENOMEM; - return NULL; - } - - if (error) *error = EOK; - - TRACE_FLOW_STRING("get_string_config_value returning", str); - return str; -} - -/* Get string from item */ -const char *get_const_string_config_value(struct collection_item *item, int *error) -{ - const char *str; - - TRACE_FLOW_STRING("get_const_string_config_value", "Entry"); - - /* Do we have the item ? */ - if ((item == NULL) || - (col_get_item_type(item) != COL_TYPE_STRING)) { - TRACE_ERROR_NUMBER("Invalid argument.", EINVAL); - if (error) *error = EINVAL; - return NULL; - } - - str = (const char *)col_get_item_data(item); - - if (error) *error = EOK; - - TRACE_FLOW_STRING("get_const_string_config_value returning", str); - return str; -} - -/* A special hex format is assumed. - * The string should be taken in single quotes - * and consist of hex encoded value two hex digits per byte. - * Example: '0A2BFECC' - * Case does not matter. - */ -char *get_bin_config_value(struct collection_item *item, - int *length, int *error) -{ - int i; - char *value = NULL; - const char *buff; - int size = 0; - unsigned char hex; - int len; - const char *str; - - TRACE_FLOW_STRING("get_bin_config_value", "Entry"); - - /* Do we have the item ? */ - if ((item == NULL) || - (col_get_item_type(item) != COL_TYPE_STRING)) { - TRACE_ERROR_NUMBER("Invalid argument.", EINVAL); - if (error) *error = EINVAL; - return NULL; - } - - /* Check the length */ - len = col_get_item_length(item)-1; - if ((len%2) != 0) { - TRACE_ERROR_STRING("Invalid length for binary data", ""); - if (error) *error = EINVAL; - return NULL; - } - - str = (const char *)col_get_item_data(item); - - /* Is the format correct ? */ - if ((*str != '\'') || - (str[len -1] != '\'')) { - TRACE_ERROR_STRING("String is not escaped",""); - if (error) *error = EIO; - return NULL; - } - - /* Check that all the symbols are ok */ - buff = str + 1; - len -= 2; - for (i = 0; i < len; i += 2) { - if (!isxdigit(buff[i]) || !isxdigit(buff[i + 1])) { - TRACE_ERROR_STRING("Invalid encoding for binary data", buff + i); - if (error) *error = EIO; - return NULL; - } - } - - /* The value is good so we can allocate memory for it */ - value = malloc(len / 2); - if (value == NULL) { - TRACE_ERROR_NUMBER("Failed to allocate memory.", ENOMEM); - if (error) *error = ENOMEM; - return NULL; - } - - /* Convert the value */ - for (i = 0; i < len; i += 2) { - if (isdigit(buff[i])) { - if (isdigit(buff[i+1])) - hex = 16 * (buff[i] - '0') + (buff[i+1] - '0'); - else - hex = 16 * (buff[i] - '0') + (tolower(buff[i+1]) - 'a' + 10); - } - else { - if (isdigit(buff[i+1])) - hex = 16 * (tolower(buff[i]) - 'a') + (buff[i+1] - '0'); - else - hex = 16 * (tolower(buff[i]) - 'a' + 10) + (tolower(buff[i+1]) - 'a' + 10); - } - - value[size] = (char)(hex); - size++; - } - - if (error) *error = EOK; - if (length) *length = size; - TRACE_FLOW_STRING("get_bin_config_value", "Exit"); - return value; -} - -/* Function to free binary configuration value */ -void free_bin_config_value(char *value) -{ - if (value) free(value); -} diff --git a/common/ini/ini_list.c b/common/ini/ini_list.c deleted file mode 100644 index 95894a153..000000000 --- a/common/ini/ini_list.c +++ /dev/null @@ -1,123 +0,0 @@ -/* - INI LIBRARY - - Value interpretation functions for single values - and corresponding memory cleanup functions. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2010 - - INI Library 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. - - INI Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with INI Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#define _GNU_SOURCE -#include <stdio.h> -#include <errno.h> -/* -#include <string.h> -#include <ctype.h> -#include <stdlib.h> -#include <locale.h> -#include <fcntl.h> -#include <unistd.h> -#include <limits.h> -*/ -#include "config.h" -#include "trace.h" -#include "collection.h" -#include "collection_tools.h" -#include "ini_config.h" - - -/* The section array should be freed using this function */ -void free_section_list(char **section_list) -{ - TRACE_FLOW_STRING("free_section_list","Entry"); - - col_free_property_list(section_list); - - TRACE_FLOW_STRING("free_section_list","Exit"); -} - -/* The section array should be freed using this function */ -void free_attribute_list(char **section_list) -{ - TRACE_FLOW_STRING("free_attribute_list","Entry"); - - col_free_property_list(section_list); - - TRACE_FLOW_STRING("free_attribute_list","Exit"); -} - - -/* Get list of sections as an array of strings. - * Function allocates memory for the array of the sections. - */ -char **get_section_list(struct collection_item *ini_config, int *size, int *error) -{ - char **list; - - TRACE_FLOW_STRING("get_section_list","Entry"); - /* Do we have the item ? */ - if ((ini_config == NULL) || - ((col_is_of_class(ini_config, COL_CLASS_INI_CONFIG) == 0) && - (col_is_of_class(ini_config, COL_CLASS_INI_META) == 0))) { - TRACE_ERROR_NUMBER("Invalid argument.", EINVAL); - if (error) *error = EINVAL; - return NULL; - } - - /* Pass it to the function from collection API */ - list = col_collection_to_list(ini_config, size, error); - - TRACE_FLOW_STRING("get_section_list returning", ((list == NULL) ? "NULL" : list[0])); - return list; -} - -/* Get list of attributes in a section as an array of strings. - * Function allocates memory for the array of the strings. - */ -char **get_attribute_list(struct collection_item *ini_config, const char *section, int *size, int *error) -{ - struct collection_item *subcollection = NULL; - char **list; - int err; - - TRACE_FLOW_STRING("get_attribute_list","Entry"); - /* Do we have the item ? */ - if ((ini_config == NULL) || - ((col_is_of_class(ini_config, COL_CLASS_INI_CONFIG) == 0) && - (col_is_of_class(ini_config, COL_CLASS_INI_META) == 0)) || - (section == NULL)) { - TRACE_ERROR_NUMBER("Invalid argument.", EINVAL); - if (error) *error = EINVAL; - return NULL; - } - - /* Fetch section */ - err = col_get_collection_reference(ini_config, &subcollection, section); - /* Check error */ - if (err && (subcollection == NULL)) { - TRACE_ERROR_NUMBER("Failed to get section", err); - if (error) *error = EINVAL; - return NULL; - } - - /* Pass it to the function from collection API */ - list = col_collection_to_list(subcollection, size, error); - - col_destroy_collection(subcollection); - - TRACE_FLOW_STRING("get_attribute_list returning", ((list == NULL) ? "NULL" : list[0])); - return list; -} diff --git a/common/ini/ini_metadata.c b/common/ini/ini_metadata.c deleted file mode 100644 index f6d35453e..000000000 --- a/common/ini/ini_metadata.c +++ /dev/null @@ -1,510 +0,0 @@ -/* - INI LIBRARY - - Functions to process metadata. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2010 - - INI Library 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. - - INI Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with INI Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#define _GNU_SOURCE -#include <sys/types.h> -#include <sys/stat.h> -#include <unistd.h> -#include <errno.h> -#include "config.h" -#include "collection.h" -#include "collection_tools.h" -#include "trace.h" -#include "ini_config.h" -#include "ini_metadata.h" - -#define INI_METADATA "meta" - -/* Beffer length used for int to string conversions */ -#define CONVERSION_BUFFER 80 - -/* Invalid file mode */ -#define WRONG_FMODE 0x80000000 - -/* Prepare metadata */ -int prepare_metadata(uint32_t metaflags, - struct collection_item **metadata, - int *save_error) -{ - int error = EOK; - struct collection_item *metasec = NULL; - - TRACE_FLOW_STRING("prepare_metadata", "Entry"); - - /* Are we supposed to collect or process meta data ? */ - if (!metadata) { - TRACE_FLOW_STRING("No meta data", "Exit"); - return EOK; - } - - /* Allocate metadata */ - error = col_create_collection(metadata, - INI_METADATA, - COL_CLASS_INI_META); - if (error) { - TRACE_ERROR_NUMBER("Failed to create meta data", error); - return error; - } - - /* Check and create section for file error if needed */ - if (metaflags & INI_META_SEC_ERROR_FLAG) { - /* Create ERROR collection */ - if ((error = col_create_collection(&metasec, - INI_META_SEC_ERROR, - COL_CLASS_INI_SECTION)) || - (error = col_add_collection_to_collection( - *metadata, - NULL, - NULL, - metasec, - COL_ADD_MODE_REFERENCE))) { - TRACE_ERROR_NUMBER("Failed to create error section", error); - col_destroy_collection(metasec); - col_destroy_collection(*metadata); - *metadata = NULL; - return error; - } - /* If we are here we would have to save file open error */ - *save_error = 1; - col_destroy_collection(metasec); - } - - TRACE_FLOW_STRING("prepare_metadata", "Exit"); - return error; -} - - - -/* Collect metadata for the file */ -int collect_metadata(uint32_t metaflags, - struct collection_item **metadata, - FILE *config_file, - const char *config_filename) -{ - int error = EOK; - struct collection_item *metasec = NULL; - int filedes; - struct stat file_stats; - char buff[CONVERSION_BUFFER]; - - TRACE_FLOW_STRING("collect_metadata", "Entry"); - /* Check and create section for file error if needed */ - if (metaflags & INI_META_SEC_ACCESS_FLAG) { - /* Create ACCESS collection */ - error = col_create_collection(&metasec, - INI_META_SEC_ACCESS, - COL_CLASS_INI_SECTION); - if (error) { - TRACE_ERROR_NUMBER("Failed to create access section.", error); - col_destroy_collection(metasec); - return error; - } - - filedes = fileno(config_file); - - /* Collect statistics */ - errno = 0; - if (fstat(filedes, &file_stats) < 0) { - error = errno; - TRACE_ERROR_NUMBER("Failed to get statistics.", error); - col_destroy_collection(metasec); - return error; - } - - /* Record statistics */ - /* UID */ - snprintf(buff, CONVERSION_BUFFER, "%lu", - (unsigned long)file_stats.st_uid); - error = col_add_str_property(metasec, - NULL, - INI_META_KEY_UID, - buff, - 0); - if (error) { - TRACE_ERROR_NUMBER("Failed to save uid", error); - col_destroy_collection(metasec); - return error; - } - - /* GID */ - snprintf(buff, CONVERSION_BUFFER, "%lu", - (unsigned long)file_stats.st_gid); - error = col_add_str_property(metasec, - NULL, - INI_META_KEY_GID, - buff, - 0); - if (error) { - TRACE_ERROR_NUMBER("Failed to save gid", error); - col_destroy_collection(metasec); - return error; - } - - /* PERMISSIONS */ - snprintf(buff, CONVERSION_BUFFER, "%lu", - (unsigned long)file_stats.st_mode); - error = col_add_str_property(metasec, - NULL, - INI_META_KEY_PERM, - buff, - 0); - if (error) { - TRACE_ERROR_NUMBER("Failed to save permissions", error); - col_destroy_collection(metasec); - return error; - } - - /* Modification time stamp */ - snprintf(buff, CONVERSION_BUFFER, "%ld", - (long int)file_stats.st_mtime); - error = col_add_str_property(metasec, - NULL, - INI_META_KEY_MODIFIED, - buff, - 0); - if (error) { - TRACE_ERROR_NUMBER("Failed to save modification time", error); - col_destroy_collection(metasec); - return error; - } - - /* Name */ - error = col_add_str_property(metasec, - NULL, - INI_META_KEY_NAME, - config_filename, - 0); - if (error) { - TRACE_ERROR_NUMBER("Failed to save file name", error); - col_destroy_collection(metasec); - return error; - } - - /* The device ID can actualy be bigger than - * 32-bits according to the type sizes. - * However it is probaly not going to happen - * on a real system. - * Add a check for this case. - */ - if (file_stats.st_dev > ULONG_MAX) { - TRACE_ERROR_NUMBER("Device is out of range", ERANGE); - col_destroy_collection(metasec); - return ERANGE; - } - - /* Device ID */ - TRACE_INFO_LNUMBER("Device ID", file_stats.st_dev); - - snprintf(buff, CONVERSION_BUFFER, "%lu", - (unsigned long)file_stats.st_dev); - error = col_add_str_property(metasec, - NULL, - INI_META_KEY_DEV, - buff, - 0); - if (error) { - TRACE_ERROR_NUMBER("Failed to save inode", error); - col_destroy_collection(metasec); - return error; - } - - /* i-node */ - snprintf(buff, CONVERSION_BUFFER, "%lu", - (unsigned long)file_stats.st_ino); - error = col_add_str_property(metasec, - NULL, - INI_META_KEY_INODE, - buff, - 0); - if (error) { - TRACE_ERROR_NUMBER("Failed to save inode", error); - col_destroy_collection(metasec); - return error; - } - - /* Add section to metadata */ - error = col_add_collection_to_collection( - *metadata, - NULL, - NULL, - metasec, - COL_ADD_MODE_REFERENCE); - - col_destroy_collection(metasec); - - if (error) { - TRACE_ERROR_NUMBER("Failed to save file name", error); - return error; - } - } - - TRACE_FLOW_STRING("collect_metadata", "Exit"); - return error; -} - -/* Function to free metadata */ -void free_ini_config_metadata(struct collection_item *metadata) -{ - TRACE_FLOW_STRING("free_ini_config_metadata", "Entry"); - col_destroy_collection(metadata); - TRACE_FLOW_STRING("free_ini_config_metadata", "Exit"); -} - -/* Function to check uid or gid */ -static int check_id(struct collection_item *metadata, - unsigned long id, - const char *key) -{ - int error = EOK; - struct collection_item *item = NULL; - unsigned long fid; - - TRACE_FLOW_STRING("check_id", "Entry"); - TRACE_INFO_STRING("Key", key); - - error = get_config_item(INI_META_SEC_ACCESS, - key, - metadata, - &item); - if (error) { - TRACE_ERROR_NUMBER("Internal collection error.", error); - return error; - } - - /* Entry is supposed to be there so it is an error - * is the item is not found. - */ - if (item == NULL) { - TRACE_ERROR_NUMBER("Expected item is not found.", ENOENT); - return ENOENT; - } - - fid = get_ulong_config_value(item, 1, -1, &error); - if ((error) || (fid == -1)) { - TRACE_ERROR_NUMBER("Conversion failed", EINVAL); - return EINVAL; - } - - if (id != fid) { - TRACE_ERROR_NUMBER("File ID:", fid); - TRACE_ERROR_NUMBER("ID passed in.", id); - TRACE_ERROR_NUMBER("Access denied.", EACCES); - return EACCES; - } - - TRACE_FLOW_STRING("check_id", "Exit"); - return EOK; -} - -/* Function to check access */ -int config_access_check(struct collection_item *metadata, - uint32_t flags, - uid_t uid, - gid_t gid, - mode_t mode, - mode_t mask) -{ - int error = EOK; - struct collection_item *item = NULL; - mode_t f_mode; - - TRACE_FLOW_STRING("config_access_check", "Entry"); - - flags &= INI_ACCESS_CHECK_MODE | - INI_ACCESS_CHECK_GID | - INI_ACCESS_CHECK_UID; - - if ((metadata == NULL) || (flags == 0)) { - TRACE_ERROR_NUMBER("Invalid parameter.", EINVAL); - return EINVAL; - - } - - /* Check that metadata is actually metadata */ - if(!col_is_of_class(metadata, COL_CLASS_INI_META)) { - TRACE_ERROR_NUMBER("Invalid collection.", EINVAL); - return EINVAL; - } - - /* Check mode */ - if (flags & INI_ACCESS_CHECK_MODE) { - - error = get_config_item(INI_META_SEC_ACCESS, - INI_META_KEY_PERM, - metadata, - &item); - if (error) { - TRACE_ERROR_NUMBER("Internal collection error.", error); - return error; - } - - /* Entry is supposed to be there so it is an error - * is the item is not found. - */ - if (item == NULL) { - TRACE_ERROR_NUMBER("Expected item is not found.", ENOENT); - return ENOENT; - } - - f_mode = (mode_t)get_ulong_config_value(item, 1, WRONG_FMODE, &error); - if ((error) || (f_mode == WRONG_FMODE)) { - TRACE_ERROR_NUMBER("Conversion failed", error); - return ENOENT; - } - - TRACE_INFO_NUMBER("File mode as saved.", f_mode); - f_mode &= S_IRWXU | S_IRWXG | S_IRWXO; - TRACE_INFO_NUMBER("File mode adjusted.", f_mode); - - TRACE_INFO_NUMBER("Mode as provided.", mode); - mode &= S_IRWXU | S_IRWXG | S_IRWXO; - TRACE_INFO_NUMBER("Mode adjusted.", mode); - - /* Adjust mask */ - if (mask == 0) mask = S_IRWXU | S_IRWXG | S_IRWXO; - else mask &= S_IRWXU | S_IRWXG | S_IRWXO; - - if ((mode & mask) != (f_mode & mask)) { - TRACE_INFO_NUMBER("File mode:", (mode & mask)); - TRACE_INFO_NUMBER("Mode adjusted.", (f_mode & mask)); - TRACE_ERROR_NUMBER("Access denied.", EACCES); - return EACCES; - } - } - - /* Check uid */ - if (flags & INI_ACCESS_CHECK_UID) { - - error = check_id(metadata, (unsigned long)uid, INI_META_KEY_UID); - if (error) { - TRACE_ERROR_NUMBER("Check for UID failed.", error); - return error; - } - } - - /* Check gid */ - if (flags & INI_ACCESS_CHECK_GID) { - - error = check_id(metadata, (unsigned long)gid, INI_META_KEY_GID); - if (error) { - TRACE_ERROR_NUMBER("Check for UID failed.", error); - return error; - } - } - - TRACE_FLOW_STRING("config_access_check", "Exit"); - return error; - -} - -static unsigned long get_checked_value(struct collection_item *metadata, - const char *key, - int *err) -{ - - int error = EOK; - struct collection_item *item = NULL; - unsigned long value; - - TRACE_FLOW_STRING("get_checked_value", "Entry"); - TRACE_INFO_STRING("Key", key); - - error = get_config_item(INI_META_SEC_ACCESS, - key, - metadata, - &item); - if (error) { - TRACE_ERROR_NUMBER("Internal collection error.", error); - *err = error; - return 0; - } - - /* Entry is supposed to be there so it is an error - * is the item is not found. - */ - if (item == NULL) { - TRACE_ERROR_NUMBER("Expected item is not found.", ENOENT); - *err = ENOENT; - return 0; - } - - value = get_ulong_config_value(item, 1, -1, &error); - if ((error) || (value == -1)) { - TRACE_ERROR_NUMBER("Conversion failed", EINVAL); - *err = EINVAL; - return 0; - } - - *err = 0; - - TRACE_FLOW_NUMBER("get_checked_value Returning", value); - return value; - -} - - -/* Function to check whether the configuration is different */ -int config_changed(struct collection_item *metadata, - struct collection_item *saved_metadata, - int *changed) -{ - int error = EOK; - struct collection_item *md[2]; - unsigned long value[3][2]; - const char *key[] = { INI_META_KEY_MODIFIED, - INI_META_KEY_DEV, - INI_META_KEY_INODE }; - int i, j; - - - TRACE_FLOW_STRING("config_changed", "Entry"); - - if ((!metadata) || - (!saved_metadata) || - (!changed) || - (!col_is_of_class(metadata, COL_CLASS_INI_META)) || - (!col_is_of_class(saved_metadata, COL_CLASS_INI_META))) { - TRACE_ERROR_NUMBER("Invalid argument.", EINVAL); - return EINVAL; - } - - md[0] = metadata; - md[1] = saved_metadata; - - /* Get three values from each collection and compare them */ - for (i = 0; i < 3; i++) { - for (j = 0; j < 2; j++) { - value[i][j] = get_checked_value(md[j], key[i] , &error); - if (error) { - TRACE_ERROR_NUMBER("Failed to get section.", error); - return error; - } - } - if (value[i][0] != value[i][1]) { - *changed = 1; - break; - } - } - - TRACE_FLOW_STRING("config_changed", "Exit"); - return error; - -} diff --git a/common/ini/ini_metadata.h b/common/ini/ini_metadata.h deleted file mode 100644 index 7d766277e..000000000 --- a/common/ini/ini_metadata.h +++ /dev/null @@ -1,43 +0,0 @@ -/* - INI LIBRARY - - Header file for the meta data related functions. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - INI Library 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. - - INI Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with INI Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#ifndef INI_METADATA_H -#define INI_METADATA_H - -#include <stdint.h> -#include <stdio.h> -#include "collection.h" - - -/* Prepare metadata */ -int prepare_metadata(uint32_t metaflags, - struct collection_item **metadata, - int *save_error); - -/* Collect metadata for the file */ -int collect_metadata(uint32_t metaflags, - struct collection_item **metadata, - FILE *config_file, - const char *config_filename); - - - -#endif diff --git a/common/ini/ini_parse.c b/common/ini/ini_parse.c deleted file mode 100644 index 7b3785c34..000000000 --- a/common/ini/ini_parse.c +++ /dev/null @@ -1,190 +0,0 @@ -/* - INI LIBRARY - - Low level parsing functions - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2010 - - INI Library 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. - - INI Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with INI Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#define _GNU_SOURCE -#include <errno.h> -#include <string.h> -#include <ctype.h> -#include "config.h" -#include "trace.h" -#include "ini_parse.h" -#include "ini_defines.h" -#include "ini_config.h" - - -/* Reads a line from the file */ -int read_line(FILE *file, - char *buf, - int read_size, - char **key, char **value, - int *length, - int *ext_error) -{ - - char *res; - int len; - char *buffer; - int i; - char *eq; - - TRACE_FLOW_STRING("read_line", "Entry"); - - *ext_error = 0; - - buffer = buf; - - /* Get data from file */ - res = fgets(buffer, read_size - 1, file); - if (res == NULL) { - TRACE_ERROR_STRING("Read nothing", ""); - return RET_EOF; - } - - /* Make sure the buffer is NULL terminated */ - buffer[read_size - 1] = '\0'; - - len = strlen(buffer); - if (len == 0) { - TRACE_ERROR_STRING("Nothing was read.", ""); - return RET_EMPTY; - } - - /* Added \r just in case we deal with Windows in future */ - if ((buffer[len - 1] != '\n') && (buffer[len - 1] != '\r')) { - TRACE_ERROR_STRING("String it too big!", ""); - *ext_error = ERR_LONGDATA; - return RET_ERROR; - } - - /* Ingnore comments */ - if ((*buffer == ';') || (*buffer == '#')) { - TRACE_FLOW_STRING("Comment", buf); - return RET_COMMENT; - } - - TRACE_INFO_STRING("BUFFER before trimming:", buffer); - - /* Trucate trailing spaces and CRs */ - /* Make sure not to step before the beginning */ - while (len && isspace(buffer[len - 1])) { - buffer[len - 1] = '\0'; - len--; - } - - TRACE_INFO_STRING("BUFFER after trimming trailing spaces:", buffer); - - /* Trucate leading spaces */ - while (isspace(*buffer)) { - buffer++; - len--; - } - - TRACE_INFO_STRING("BUFFER after trimming leading spaces:", buffer); - TRACE_INFO_NUMBER("BUFFER length:", len); - - /* Empty line */ - if (len == 0) { - TRACE_FLOW_STRING("Empty line", buf); - return RET_EMPTY; - } - - /* Section */ - if (*buffer == '[') { - if (buffer[len-1] != ']') { - TRACE_ERROR_STRING("Invalid format for section", buf); - *ext_error = ERR_NOCLOSESEC; - return RET_ERROR; - } - buffer++; - len--; - while (isspace(*buffer)) { - buffer++; - len--; - } - if (len == 0) { - TRACE_ERROR_STRING("Invalid format for section", buf); - *ext_error = ERR_NOSECTION; - return RET_ERROR; - } - - buffer[len - 1] = '\0'; - len--; - while (isspace(buffer[len - 1])) { - buffer[len - 1] = '\0'; - len--; - } - if (len >= MAX_KEY) { - TRACE_ERROR_STRING("Section name is too long", buf); - *ext_error = ERR_SECTIONLONG; - return RET_ERROR; - } - - *key = buffer; - return RET_SECTION; - } - - /* Assume we are dealing with the K-V here */ - /* Find "=" */ - eq = strchr(buffer, '='); - if (eq == NULL) { - TRACE_ERROR_STRING("No equal sign", buf); - *ext_error = ERR_NOEQUAL; - return RET_INVALID; - } - - len -= eq-buffer; - - /* Strip spaces around "=" */ - i = eq - buffer - 1; - while ((i >= 0) && isspace(buffer[i])) i--; - if (i < 0) { - TRACE_ERROR_STRING("No key", buf); - *ext_error = ERR_NOKEY; - return RET_INVALID; - } - - /* Copy key into provided buffer */ - if(i >= MAX_KEY) { - TRACE_ERROR_STRING("Key name is too long", buf); - *ext_error = ERR_LONGKEY; - return RET_INVALID; - } - *key = buffer; - buffer[i + 1] = '\0'; - TRACE_INFO_STRING("KEY:", *key); - - eq++; - len--; - while (isspace(*eq)) { - eq++; - len--; - } - - *value = eq; - /* Make sure we include trailing 0 into data */ - *length = len + 1; - - TRACE_INFO_STRING("VALUE:", *value); - TRACE_INFO_NUMBER("LENGTH:", *length); - - TRACE_FLOW_STRING("read_line", "Exit"); - return RET_PAIR; -} diff --git a/common/ini/ini_parse.h b/common/ini/ini_parse.h deleted file mode 100644 index 56a0db92e..000000000 --- a/common/ini/ini_parse.h +++ /dev/null @@ -1,36 +0,0 @@ -/* - INI LIBRARY - - Header file for the internal parsing functions. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2010 - - INI Library 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. - - INI Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with INI Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#ifndef INI_PARSE_H -#define INI_PARSE_H - -#include <stdio.h> - -/* Internal function to read line from INI file */ -int read_line(FILE *file, - char *buf, - int read_size, - char **key, - char **value, - int *length, - int *ext_error); - -#endif diff --git a/common/ini/ini_print.c b/common/ini/ini_print.c deleted file mode 100644 index e8f9186b6..000000000 --- a/common/ini/ini_print.c +++ /dev/null @@ -1,387 +0,0 @@ -/* - INI LIBRARY - - Parsing functions of the INI interface - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - INI Library 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. - - INI Library 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 more details. - - You should have received a copy of the GNU Lesser General Public License - along with INI Library. If not, see <http://www.gnu.org/licenses/>. -*/ - -#define _GNU_SOURCE -#include <stdio.h> -#include <errno.h> -#include "config.h" -/* For error text */ -#include <libintl.h> -#define _(String) gettext (String) -/* INI file is used as a collection */ -#include "trace.h" -#include "collection.h" -#include "collection_tools.h" -#include "ini_defines.h" -#include "ini_config.h" - - -/*============================================================*/ -/* The following classes moved here from the public header - * They are reserved for future use. - * - * NOTE: before exposing these constants again in the common header - * check that the class IDs did not get reused over time by - * other classes. - */ -/** @brief Collection of grammar errors. - * - * Reserved for future use. - */ -#define COL_CLASS_INI_GERROR COL_CLASS_INI_BASE + 5 -/** @brief Collection of validation errors. - * - * Reserved for future use. - */ -#define COL_CLASS_INI_VERROR COL_CLASS_INI_BASE + 6 - -#ifdef HAVE_VALIDATION - -/** @brief Collection of lines from the INI file. - * - * Reserved for future use - */ -#define COL_CLASS_INI_LINES COL_CLASS_INI_BASE + 7 - -#endif /* HAVE_VALIDATION */ -/*============================================================*/ - - -/* Function to return parsing error */ -const char *parsing_error_str(int parsing_error) -{ - const char *placeholder= _("Unknown pasing error."); - const char *str_error[] = { _("Data is too long."), - _("No closing bracket."), - _("Section name is missing."), - _("Section name is too long."), - _("Equal sign is missing."), - _("Property name is missing."), - _("Property name is too long.") - }; - - /* Check the range */ - if ((parsing_error < 1) || (parsing_error > ERR_MAXPARSE)) - return placeholder; - else - return str_error[parsing_error-1]; -} - -/* Function to return grammar error. - * This function is currently not used. - * It is planned to be used by the INI - * file grammar parser. - * - * The following doxygen description is moved here. - * When the function gets exposed move it into - * the header file. - */ -/** @brief Function to return a grammar error in template. - * - * EXPERIMENTAL. Reserved for future use. - * - * This error is returned when the template - * is translated into the grammar object. - * - * @param[in] parsing_error Error code for the grammar error. - * - * @return Error string. - */ - -const char *grammar_error_str(int grammar_error) -{ - const char *placeholder= _("Unknown grammar error."); - /* THIS IS A TEMPORARY PLACEHOLDER !!!! */ - const char *str_error[] = { _(""), - _(""), - _(""), - _(""), - _(""), - _(""), - _("") - }; - - /* Check the range */ - if ((grammar_error < 1) || (grammar_error > ERR_MAXGRAMMAR)) - return placeholder; - else - return str_error[grammar_error-1]; -} - -/* Function to return validation error. - * This function is currently not used. - * It is planned to be used by the INI - * file grammar validator. - * - * The following doxygen description is moved here. - * When the function gets exposed move it into - * the header file. - */ -/** @brief Function to return a validation error. - * - * EXPERIMENTAL. Reserved for future use. - * - * This is the error that it is returned when - * the INI file is validated against the - * grammar object. - * - * @param[in] parsing_error Error code for the validation error. - * - * @return Error string. - */ -const char *validation_error_str(int validation_error) -{ - const char *placeholder= _("Unknown validation error."); - /* THIS IS A TEMPORARY PLACEHOLDER !!!! */ - const char *str_error[] = { _(""), - _(""), - _(""), - _(""), - _(""), - _(""), - _("") - }; - - /* Check the range */ - if ((validation_error < 1) || (validation_error > ERR_MAXVALID)) - return placeholder; - else - return str_error[validation_error-1]; -} - - - -/* Internal function that prints errors */ -static void print_error_list(FILE *file, - struct collection_item *error_list, - int cclass, - char *wrong_col_error, - char *failed_to_process, - char *error_header, - char *line_format, - error_fn error_function) -{ - struct collection_iterator *iterator; - int error; - struct collection_item *item = NULL; - struct parse_error *pe; - unsigned int count; - - TRACE_FLOW_STRING("print_error_list", "Entry"); - - /* If we have something to print print it */ - if (error_list == NULL) { - TRACE_ERROR_STRING("No error list",""); - return; - } - - /* Make sure we go the right collection */ - if (!col_is_of_class(error_list, cclass)) { - TRACE_ERROR_STRING("Wrong collection class:", wrong_col_error); - fprintf(file,"%s\n", wrong_col_error); - return; - } - - /* Bind iterator */ - error = col_bind_iterator(&iterator, error_list, COL_TRAVERSE_DEFAULT); - if (error) { - TRACE_ERROR_STRING("Error (bind):", failed_to_process); - fprintf(file, "%s\n", failed_to_process); - return; - } - - while(1) { - /* Loop through a collection */ - error = col_iterate_collection(iterator, &item); - if (error) { - TRACE_ERROR_STRING("Error (iterate):", failed_to_process); - fprintf(file, "%s\n", failed_to_process); - col_unbind_iterator(iterator); - return; - } - - /* Are we done ? */ - if (item == NULL) break; - - /* Process collection header */ - if (col_get_item_type(item) == COL_TYPE_COLLECTION) { - col_get_collection_count(item, &count); - if (count <= 2) break; - } else if (col_get_item_type(item) == COL_TYPE_STRING) { - fprintf(file, error_header, (char *)col_get_item_data(item)); - } - else { - /* Put error into provided format */ - pe = (struct parse_error *)(col_get_item_data(item)); - fprintf(file, line_format, - col_get_item_property(item, NULL), /* Error or warning */ - pe->error, /* Error */ - pe->line, /* Line */ - error_function(pe->error)); /* Error str */ - } - - } - - /* Do not forget to unbind iterator - otherwise there will be a leak */ - col_unbind_iterator(iterator); - - TRACE_FLOW_STRING("print_error_list", "Exit"); -} - -/* Print errors and warnings that were detected while parsing one file */ -void print_file_parsing_errors(FILE *file, - struct collection_item *error_list) -{ - print_error_list(file, - error_list, - COL_CLASS_INI_PERROR, - WRONG_COLLECTION, - FAILED_TO_PROCCESS, - ERROR_HEADER, - LINE_FORMAT, - parsing_error_str); -} - - -/* Print errors and warnings that were detected while processing grammar. - * - * The following doxygen description is moved here. - * When the function gets exposed move it into - * the header file. - */ -/** - * @brief Print errors and warnings that were detected while - * checking grammar of the template. - * - * EXPERIMENTAL. Reserved for future use. - * - * @param[in] file File descriptor. - * @param[in] error_list List of the parsing errors. - * - */ -void print_grammar_errors(FILE *file, - struct collection_item *error_list) -{ - print_error_list(file, - error_list, - COL_CLASS_INI_GERROR, - WRONG_GRAMMAR, - FAILED_TO_PROC_G, - ERROR_HEADER_G, - LINE_FORMAT, - grammar_error_str); -} - -/* Print errors and warnings that were detected while validating INI file. - * - * The following doxygen description is moved here. - * When the function gets exposed move it into - * the header file. - */ -/** - * @brief Print errors and warnings that were detected while - * checking INI file against the grammar object. - * - * EXPERIMENTAL. Reserved for future use. - * - * @param[in] file File descriptor. - * @param[in] error_list List of the parsing errors. - * - */ -void print_validation_errors(FILE *file, - struct collection_item *error_list) -{ - print_error_list(file, - error_list, - COL_CLASS_INI_VERROR, - WRONG_VALIDATION, - FAILED_TO_PROC_V, - ERROR_HEADER_V, - LINE_FORMAT, - validation_error_str); -} - -/* Print errors and warnings that were detected while parsing - * the whole configuration */ -void print_config_parsing_errors(FILE *file, - struct collection_item *error_list) -{ - struct collection_iterator *iterator; - int error; - struct collection_item *item = NULL; - struct collection_item *file_errors = NULL; - - TRACE_FLOW_STRING("print_config_parsing_errors", "Entry"); - - /* If we have something to print print it */ - if (error_list == NULL) { - TRACE_ERROR_STRING("No error list", ""); - return; - } - - /* Make sure we go the right collection */ - if (!col_is_of_class(error_list, COL_CLASS_INI_PESET)) { - TRACE_ERROR_STRING("Wrong collection class:", WRONG_COLLECTION); - fprintf(file, "%s\n", WRONG_COLLECTION); - return; - } - - /* Bind iterator */ - error = col_bind_iterator(&iterator, error_list, COL_TRAVERSE_DEFAULT); - if (error) { - TRACE_ERROR_STRING("Error (bind):", FAILED_TO_PROCCESS); - fprintf(file,"%s\n", FAILED_TO_PROCCESS); - return; - } - - while(1) { - /* Loop through a collection */ - error = col_iterate_collection(iterator, &item); - if (error) { - TRACE_ERROR_STRING("Error (iterate):", FAILED_TO_PROCCESS); - fprintf(file, "%s\n", FAILED_TO_PROCCESS); - col_unbind_iterator(iterator); - return; - } - - /* Are we done ? */ - if (item == NULL) break; - - /* Print per file sets of errors */ - if (col_get_item_type(item) == COL_TYPE_COLLECTIONREF) { - /* Extract a sub collection */ - error = col_get_reference_from_item(item, &file_errors); - if (error) { - TRACE_ERROR_STRING("Error (extract):", FAILED_TO_PROCCESS); - fprintf(file, "%s\n", FAILED_TO_PROCCESS); - col_unbind_iterator(iterator); - return; - } - print_file_parsing_errors(file, file_errors); - col_destroy_collection(file_errors); - } - } - - /* Do not forget to unbind iterator - otherwise there will be a leak */ - col_unbind_iterator(iterator); - - TRACE_FLOW_STRING("print_config_parsing_errors", "Exit"); -} diff --git a/common/ini/m4/.dir b/common/ini/m4/.dir deleted file mode 100644 index e69de29bb..000000000 --- a/common/ini/m4/.dir +++ /dev/null diff --git a/common/m4/.dir b/common/m4/.dir deleted file mode 100644 index e69de29bb..000000000 --- a/common/m4/.dir +++ /dev/null diff --git a/common/path_utils/COPYING b/common/path_utils/COPYING deleted file mode 100644 index 94a9ed024..000000000 --- a/common/path_utils/COPYING +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - <one line to give the program's name and a brief idea of what it does.> - Copyright (C) <year> <name of author> - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see <http://www.gnu.org/licenses/>. - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - <program> Copyright (C) <year> <name of author> - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -<http://www.gnu.org/licenses/>. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/common/path_utils/COPYING.LESSER b/common/path_utils/COPYING.LESSER deleted file mode 100644 index 755013bb2..000000000 --- a/common/path_utils/COPYING.LESSER +++ /dev/null @@ -1,165 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - - This version of the GNU Lesser General Public License incorporates -the terms and conditions of version 3 of the GNU General Public -License, supplemented by the additional permissions listed below. - - 0. Additional Definitions. - - As used herein, "this License" refers to version 3 of the GNU Lesser -General Public License, and the "GNU GPL" refers to version 3 of the GNU -General Public License. - - "The Library" refers to a covered work governed by this License, -other than an Application or a Combined Work as defined below. - - An "Application" is any work that makes use of an interface provided -by the Library, but which is not otherwise based on the Library. -Defining a subclass of a class defined by the Library is deemed a mode -of using an interface provided by the Library. - - A "Combined Work" is a work produced by combining or linking an -Application with the Library. The particular version of the Library -with which the Combined Work was made is also called the "Linked -Version". - - The "Minimal Corresponding Source" for a Combined Work means the -Corresponding Source for the Combined Work, excluding any source code -for portions of the Combined Work that, considered in isolation, are -based on the Application, and not on the Linked Version. - - The "Corresponding Application Code" for a Combined Work means the -object code and/or source code for the Application, including any data -and utility programs needed for reproducing the Combined Work from the -Application, but excluding the System Libraries of the Combined Work. - - 1. Exception to Section 3 of the GNU GPL. - - You may convey a covered work under sections 3 and 4 of this License -without being bound by section 3 of the GNU GPL. - - 2. Conveying Modified Versions. - - If you modify a copy of the Library, and, in your modifications, a -facility refers to a function or data to be supplied by an Application -that uses the facility (other than as an argument passed when the -facility is invoked), then you may convey a copy of the modified -version: - - a) under this License, provided that you make a good faith effort to - ensure that, in the event an Application does not supply the - function or data, the facility still operates, and performs - whatever part of its purpose remains meaningful, or - - b) under the GNU GPL, with none of the additional permissions of - this License applicable to that copy. - - 3. Object Code Incorporating Material from Library Header Files. - - The object code form of an Application may incorporate material from -a header file that is part of the Library. You may convey such object -code under terms of your choice, provided that, if the incorporated -material is not limited to numerical parameters, data structure -layouts and accessors, or small macros, inline functions and templates -(ten or fewer lines in length), you do both of the following: - - a) Give prominent notice with each copy of the object code that the - Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the object code with a copy of the GNU GPL and this license - document. - - 4. Combined Works. - - You may convey a Combined Work under terms of your choice that, -taken together, effectively do not restrict modification of the -portions of the Library contained in the Combined Work and reverse -engineering for debugging such modifications, if you also do each of -the following: - - a) Give prominent notice with each copy of the Combined Work that - the Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the Combined Work with a copy of the GNU GPL and this license - document. - - c) For a Combined Work that displays copyright notices during - execution, include the copyright notice for the Library among - these notices, as well as a reference directing the user to the - copies of the GNU GPL and this license document. - - d) Do one of the following: - - 0) Convey the Minimal Corresponding Source under the terms of this - License, and the Corresponding Application Code in a form - suitable for, and under terms that permit, the user to - recombine or relink the Application with a modified version of - the Linked Version to produce a modified Combined Work, in the - manner specified by section 6 of the GNU GPL for conveying - Corresponding Source. - - 1) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (a) uses at run time - a copy of the Library already present on the user's computer - system, and (b) will operate properly with a modified version - of the Library that is interface-compatible with the Linked - Version. - - e) Provide Installation Information, but only if you would otherwise - be required to provide such information under section 6 of the - GNU GPL, and only to the extent that such information is - necessary to install and execute a modified version of the - Combined Work produced by recombining or relinking the - Application with a modified version of the Linked Version. (If - you use option 4d0, the Installation Information must accompany - the Minimal Corresponding Source and Corresponding Application - Code. If you use option 4d1, you must provide the Installation - Information in the manner specified by section 6 of the GNU GPL - for conveying Corresponding Source.) - - 5. Combined Libraries. - - You may place library facilities that are a work based on the -Library side by side in a single library together with other library -facilities that are not Applications and are not covered by this -License, and convey such a combined library under terms of your -choice, if you do both of the following: - - a) Accompany the combined library with a copy of the same work based - on the Library, uncombined with any other library facilities, - conveyed under the terms of this License. - - b) Give prominent notice with the combined library that part of it - is a work based on the Library, and explaining where to find the - accompanying uncombined form of the same work. - - 6. Revised Versions of the GNU Lesser General Public License. - - The Free Software Foundation may publish revised and/or new versions -of the GNU Lesser 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 -Library as you received it specifies that a certain numbered version -of the GNU Lesser General Public License "or any later version" -applies to it, you have the option of following the terms and -conditions either of that published version or of any later version -published by the Free Software Foundation. If the Library as you -received it does not specify a version number of the GNU Lesser -General Public License, you may choose any version of the GNU Lesser -General Public License ever published by the Free Software Foundation. - - If the Library as you received it specifies that a proxy can decide -whether future versions of the GNU Lesser General Public License shall -apply, that proxy's public statement of acceptance of any version is -permanent authorization for you to choose that version for the -Library. diff --git a/common/path_utils/Makefile.am b/common/path_utils/Makefile.am deleted file mode 100644 index 5cd797b70..000000000 --- a/common/path_utils/Makefile.am +++ /dev/null @@ -1,50 +0,0 @@ -AM_CFLAGS = -if HAVE_GCC - AM_CFLAGS += \ - -Wall -Wshadow -Wstrict-prototypes -Wpointer-arith -Wcast-qual \ - -Wcast-align -Wwrite-strings -endif - -ACLOCAL_AMFLAGS = -I m4 - -DOXYGEN = @DOXYGEN@ - -pkgconfigdir = $(libdir)/pkgconfig -dist_pkgconfig_DATA = path_utils.pc - -dist_include_HEADERS = path_utils.h - -dist_noinst_DATA = m4 - -lib_LTLIBRARIES = libpath_utils.la -libpath_utils_la_SOURCES = path_utils.c -libpath_utils_la_LDFLAGS = \ - -version-info 1:0:0 - -if HAVE_CHECK - check_PROGRAMS = path_utils_ut -endif - -path_utils_ut_SOURCES = \ - path_utils_ut.c -path_utils_ut_CFLAGS = \ - $(AM_CFLAGS) \ - $(CHECK_CFLAGS) -path_utils_ut_LDADD = \ - $(CHECK_LIBS) \ - libpath_utils.la -TESTS = $(check_PROGRAMS) - -tests: all $(check_PROGRAMS) - -if HAVE_DOXYGEN -docs: - rm -fR doc - mkdir -p doc - $(DOXYGEN) path_utils.cfg.doxy -else -docs: - @echo "Doxygen not installed, cannot generate documentation" - @exit 1 -endif - diff --git a/common/path_utils/README b/common/path_utils/README deleted file mode 100644 index 2ccc3dc93..000000000 --- a/common/path_utils/README +++ /dev/null @@ -1 +0,0 @@ -Documentation for libpath_utils can be found in path_utils.h diff --git a/common/path_utils/configure.ac b/common/path_utils/configure.ac deleted file mode 100644 index f8b850f48..000000000 --- a/common/path_utils/configure.ac +++ /dev/null @@ -1,27 +0,0 @@ -AC_INIT([path_utils], [0.2.0], [jdennis@redhat.com]) -AC_CONFIG_SRCDIR([path_utils.c]) -AC_CONFIG_AUX_DIR([build]) -AM_INIT_AUTOMAKE([-Wall -Werror foreign]) -AC_PROG_CC -AC_PROG_LIBTOOL -AC_CONFIG_MACRO_DIR([m4]) -AC_PROG_INSTALL - -AM_CONDITIONAL([HAVE_GCC], [test "$ac_cv_prog_gcc" = yes]) - -PKG_CHECK_MODULES([CHECK], [check >= 0.9.5], [have_check=1], [have_check=]) -if test x$have_check = x; then - AC_MSG_WARN([Without the 'CHECK' libraries, you will be unable to run all tests in the 'make check' suite]) -fi -AM_CONDITIONAL([HAVE_CHECK], [test x$have_check != x]) - -m4_pattern_allow([AM_SILENT_RULES]) -AM_SILENT_RULES - -AC_CONFIG_HEADERS([config.h]) - -AC_PATH_PROG([DOXYGEN], [doxygen], [false]) -AM_CONDITIONAL([HAVE_DOXYGEN], [test x$DOXYGEN != xfalse ]) - -AC_CONFIG_FILES([Makefile path_utils.cfg.doxy path_utils.pc]) -AC_OUTPUT diff --git a/common/path_utils/m4/.dir b/common/path_utils/m4/.dir deleted file mode 100644 index e69de29bb..000000000 --- a/common/path_utils/m4/.dir +++ /dev/null diff --git a/common/path_utils/path_utils.c b/common/path_utils/path_utils.c deleted file mode 100644 index 97c845c70..000000000 --- a/common/path_utils/path_utils.c +++ /dev/null @@ -1,608 +0,0 @@ -/* - Authors: - John Dennis <jdennis.redhat.com> - - Copyright (C) 2009 Red Hat - - This program 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. - - 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 Lesser General Public License for more 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/>. -*/ - -/*****************************************************************************/ -/******************************** Documentation ******************************/ -/*****************************************************************************/ - -/*****************************************************************************/ -/******************************* Include Files *******************************/ -/*****************************************************************************/ - -#include <stdio.h> -#include <string.h> -#include <stdlib.h> -#include <unistd.h> -#include <dirent.h> -#include <sys/errno.h> -#include <sys/stat.h> - -#include <libgen.h> - -#include "path_utils.h" - -/*****************************************************************************/ -/****************************** Internal Defines *****************************/ -/*****************************************************************************/ - -/*****************************************************************************/ -/************************** Internal Type Definitions ************************/ -/*****************************************************************************/ - -/*****************************************************************************/ -/********************** External Function Declarations *********************/ -/*****************************************************************************/ - -/*****************************************************************************/ -/********************** Internal Function Declarations *********************/ -/*****************************************************************************/ - -/*****************************************************************************/ -/************************* External Global Variables ***********************/ -/*****************************************************************************/ - -/*****************************************************************************/ -/************************* Internal Global Variables ***********************/ -/*****************************************************************************/ - -/*****************************************************************************/ -/**************************** Inline Functions *****************************/ -/*****************************************************************************/ - -/*****************************************************************************/ -/*************************** Internal Functions ****************************/ -/*****************************************************************************/ - -/*****************************************************************************/ -/**************************** Exported Functions ***************************/ -/*****************************************************************************/ - -const char *path_utils_error_string(int error) -{ - switch(error) { - case SUCCESS: return _("Success"); - case PATH_UTILS_ERROR_NOT_FULLY_NORMALIZED: return _("Path could not be fully normalized"); - } - return NULL; -} - -static int dot_to_absolute(char *rel_path, int rel_path_size) -{ - char tmp_path[PATH_MAX]; - - if (strcmp(rel_path, ".") == 0) { - if (getcwd(rel_path, rel_path_size) == NULL) { - if (errno == ERANGE) - return ENOBUFS; - else - return errno; - } - } else if (strcmp(rel_path, "..") == 0) { - if (getcwd(tmp_path, sizeof(tmp_path)) == NULL) { - if (errno == ERANGE) - return ENOBUFS; - else - return errno; - } - strncpy(rel_path, dirname(tmp_path), rel_path_size); - if (rel_path[rel_path_size-1] != 0) return ENOBUFS; - } - - return SUCCESS; -} - -int get_basename(char *base_name, size_t base_name_size, const char *path) -{ - char tmp_path[PATH_MAX]; - int ret; - - if (!path) return EINVAL; - if (!base_name || base_name_size < 1) return ENOBUFS; - - strncpy(tmp_path, path, sizeof(tmp_path)); - if (tmp_path[sizeof(tmp_path)-1] != 0) return ENOBUFS; - strncpy(base_name, basename(tmp_path), base_name_size); - if (base_name[base_name_size-1] != 0) return ENOBUFS; - - ret = dot_to_absolute(base_name, base_name_size); - if (ret != SUCCESS) { - return ret; - } - - return SUCCESS; -} - -int get_dirname(char *dir_path, size_t dir_path_size, const char *path) -{ - char tmp_path[PATH_MAX]; - int ret; - - if (!path) return EINVAL; - if (!dir_path || dir_path_size < 1) return ENOBUFS; - - strncpy(tmp_path, path, sizeof(tmp_path)); - if (tmp_path[sizeof(tmp_path)-1] != 0) return ENOBUFS; - strncpy(dir_path, dirname(tmp_path), dir_path_size); - if (dir_path[dir_path_size-1] != 0) return ENOBUFS; - - ret = dot_to_absolute(dir_path, dir_path_size); - if (ret != SUCCESS) { - return ret; - } - - return SUCCESS; -} - -int get_directory_and_base_name(char *dir_path, size_t dir_path_size, - char *base_name, size_t base_name_size, - const char *path) -{ - char tmp_path[PATH_MAX]; - int ret; - - if (!path) return EINVAL; - if (!dir_path || dir_path_size < 1) return ENOBUFS; - if (!base_name || base_name_size < 1) return ENOBUFS; - - strncpy(tmp_path, path, sizeof(tmp_path)); - if (tmp_path[sizeof(tmp_path)-1] != 0) return ENOBUFS; - strncpy(base_name, basename(tmp_path), base_name_size); - if (base_name[base_name_size-1] != 0) return ENOBUFS; - - strncpy(tmp_path, path, sizeof(tmp_path)); - if (tmp_path[sizeof(tmp_path)-1] != 0) return ENOBUFS; - strncpy(dir_path, dirname(tmp_path), dir_path_size); - if (dir_path[dir_path_size-1] != 0) return ENOBUFS; - - ret = dot_to_absolute(dir_path, dir_path_size); - if (ret != SUCCESS) { - return ret; - } - - if (strcmp(base_name, ".") == 0) { - strncpy(base_name, "", base_name_size); - if (base_name[base_name_size-1] != 0) return ENOBUFS; - } - - return SUCCESS; -} - -bool is_absolute_path(const char *path) -{ - if (!path) return false; - return path[0] == '/'; -} - -int path_concat(char *path, size_t path_size, const char *head, const char *tail) -{ - const char *p, *src; - char *dst, *dst_end; - - if (!path || path_size < 1) return ENOBUFS; - - dst = path; - dst_end = path + path_size - 1; /* -1 allows for NULL terminator */ - - if (head && *head) { - for (p = head; *p; p++); /* walk to end of head */ - for (p--; p >= head && *p == '/'; p--); /* skip any trailing slashes in head */ - if ((p - head) > path_size-1) return ENOBUFS; - for (src = head; src <= p && dst < dst_end;) *dst++ = *src++; /* copy head */ - } - if (tail && *tail) { - for (p = tail; *p && *p == '/'; p++); /* skip any leading slashes in tail */ - if (dst > path) - if (dst < dst_end) *dst++ = '/'; /* insert single slash between head & tail */ - for (src = p; *src && dst <= dst_end;) *dst++ = *src++; /* copy tail */ - if (*src) return ENOBUFS; /* failed to copy everything */ - } - *dst = 0; - if (dst > dst_end) { - return ENOBUFS; - } - return SUCCESS; - -} - -int make_path_absolute(char *absolute_path, size_t absolute_path_size, const char *path) -{ - int result = SUCCESS; - const char *src; - char *dst, *dst_end; - - if (!absolute_path || absolute_path_size < 1) return ENOBUFS; - - dst = absolute_path; - dst_end = absolute_path + absolute_path_size - 1; /* -1 allows for NULL terminator */ - - if (is_absolute_path(path)) { - for (src = path; *src && dst < dst_end;) *dst++ = *src++; - *dst = 0; - if (dst > dst_end || *src) result = ENOBUFS; - return result; - } - - if ((getcwd(absolute_path, absolute_path_size) == NULL)) { - if (errno == ERANGE) - return ENOBUFS; - else - return errno; - } - - for (dst = absolute_path; *dst && dst < dst_end; dst++); - if (!(path && *path)) return result; - if (dst > dst_end) { - *absolute_path = 0; - return ENOBUFS; - } - - *dst++ = '/'; - if (dst > dst_end) { - *absolute_path = 0; - return ENOBUFS; - } - - for (src = path; *src && dst < dst_end;) *dst++ = *src++; - if (*src) return ENOBUFS; /* failed to copy everything */ - *dst = 0; - - return result; -} - -char **split_path(const char *path, int *count) -{ - int n_components, component_len, total_component_len, alloc_len; - const char *start, *end; - char *mem_block, **array_ptr, *component_ptr; - - if (count) *count = 0; - if (!path) return NULL; - - /* If path is absolute add in special "/" root component */ - if (*path == '/') { - n_components = 1; - total_component_len = 2; - } else { - n_components = 0; - total_component_len = 0; - } - - /* Scan for components, keep several counts */ - for (start = end = path; *start; start = end) { - for (start = end; *start && *start == '/'; start++); - for (end = start; *end && *end != '/'; end++); - if ((component_len = end - start) == 0) break; - n_components++; - total_component_len += component_len + 1; - } - - /* - * Allocate a block big enough for component array (with trailing NULL - * entry, hence n_components+1) and enough room for a copy of each NULL - * terminated component. We'll copy the components into the same allocation - * block after the end of the pointer array. - */ - alloc_len = ((n_components+1) * sizeof(char *)) + total_component_len; - - if ((mem_block = malloc(alloc_len)) == NULL) { - if (count) *count = -1; - return NULL; - } - - /* component array */ - array_ptr = (char **)mem_block; - /* components copied after end of array */ - component_ptr = mem_block + ((n_components+1)*sizeof(char *)); - - /* If path is absolute add in special "/" root component */ - if (*path == '/') { - *array_ptr++ = component_ptr; - *component_ptr++ = '/'; - *component_ptr++ = 0; - } - - for (start = end = path; *start; start = end) { - for (start = end; *start && *start == '/'; start++); - for (end = start; *end && *end != '/'; end++); - if ((component_len = end - start) == 0) break; - - *array_ptr++ = component_ptr; - while (start < end) *component_ptr++ = *start++; - *component_ptr++ = 0; - } - *array_ptr++ = NULL; - if (count) *count = n_components; - return (char **)mem_block; -} - -int normalize_path(char *normalized_path, size_t normalized_path_size, const char *path) -{ - int result = SUCCESS; - int component_len; - bool is_absolute, can_backup; - const char *start, *end; - char *dst, *dst_end, *p, *limit; - - if (!normalized_path || normalized_path_size < 1) return ENOBUFS; - - dst = normalized_path; - dst_end = normalized_path + normalized_path_size - 1; /* -1 allows for NULL terminator */ - can_backup = true; - - if (!path || !*path) { - if (dst > dst_end) { - *dst = 0; - return ENOBUFS; - } - *dst++ = '.'; - *dst = 0; - return result; - } - - if ((is_absolute = *path == '/')) { - if (dst < dst_end) { - *dst++ = '/'; - } else { - *dst = 0; - return ENOBUFS; - } - } - - for (start = end = path; *start; start = end) { - for (start = end; *start && *start == '/'; start++); - for (end = start; *end && *end != '/'; end++); - if ((component_len = end - start) == 0) break; - if (component_len == 1 && start[0] == '.') continue; - if (component_len == 2 && start[0] == '.' && start[1] == '.' && can_backup) { - /* back up one level */ - if ((is_absolute && dst == normalized_path+1) || (!is_absolute && dst == normalized_path)) { - if (is_absolute) continue; - can_backup = false; - result = PATH_UTILS_ERROR_NOT_FULLY_NORMALIZED; - } else { - if (is_absolute) - limit = normalized_path+1; - else - limit = normalized_path; - for (p = dst-1; p >= limit && *p != '/'; p--); - if (p < limit) - dst = limit; - else - dst = p; - continue; - } - } - - if ((end-start) > (dst_end-dst)) { - return ENOBUFS; - } - - if ((dst > normalized_path) && (dst < dst_end) && (dst[-1] != '/')) *dst++ = '/'; - while ((start < end) && (dst < dst_end)) *dst++ = *start++; - } - - if (dst == normalized_path) { - if (is_absolute) - *dst++ = '/'; - else - *dst++ = '.'; - } - *dst = 0; - return result; -} - -int common_path_prefix(char *common_path, - size_t common_path_size, - int *common_count, - const char *path1, const char *path2) -{ - int count1, count2, min_count, i, n_common, result; - char **split1, **split2; - char *dst, *dst_end, *src; - - if (!common_path || common_path_size < 1) return ENOBUFS; - - result = SUCCESS; - n_common = 0; - split1 = split_path(path1, &count1); - split2 = split_path(path2, &count2); - - if (count1 <= count2) - min_count = count1; - else - min_count = count2; - - if (min_count <= 0 || !split1 || !split2 ) { - result = SUCCESS; - *common_path = 0; - goto done; - } - - for (n_common = 0; n_common < min_count; n_common++) { - if (strcmp(split1[n_common], split2[n_common]) != 0) break; - } - - if (n_common == 0) { - result = SUCCESS; - *common_path = 0; - goto done; - } - - dst = common_path; - dst_end = common_path + common_path_size - 1; /* -1 allows for NULL terminator */ - for (i = 0; i < n_common; i++) { - for (src = split1[i]; *src && dst < dst_end;) *dst++ = *src++; - if (dst == dst_end && *src) { - *dst = 0; - result = ENOBUFS; - goto done; - } - if (dst[-1] != '/' && i < n_common-1) { /* insert path separator */ - if (dst == dst_end) { - *dst = 0; - result = ENOBUFS; - goto done; - } - *dst++ = '/'; - } - } - *dst = 0; - - done: - free(split1); - free(split2); - if (common_count) *common_count = n_common; - return result; -} - -int make_normalized_absolute_path(char *result_path, size_t result_path_size, const char *path) -{ - int error; - char absolute_path[PATH_MAX]; - - if (!result_path || result_path_size < 1) return ENOBUFS; - *result_path = 0; - if ((error = make_path_absolute(absolute_path, sizeof(absolute_path), path)) != SUCCESS) return error; - if ((error = normalize_path(result_path, result_path_size, absolute_path)) != SUCCESS) return error; - return SUCCESS; -} - -int find_existing_directory_ancestor(char *ancestor, size_t ancestor_size, const char *path) -{ - int error; - char dir_path[PATH_MAX]; - struct stat info; - - if (!ancestor || ancestor_size < 1) return ENOBUFS; - *ancestor = 0; - strncpy(dir_path, path, sizeof(dir_path)); - if (dir_path[sizeof(dir_path)-1] != 0) return ENOBUFS; - - while (strcmp(dir_path, "/") != 0) { - if (lstat(dir_path, &info) < 0) { - error = errno; - if (error != ENOENT) return error; - } else { - if (S_ISDIR(info.st_mode)) break; - } - error = get_dirname(dir_path, sizeof(dir_path), dir_path); - if (error != SUCCESS) { - return error; - } - } - - strncpy(ancestor, dir_path, ancestor_size); - if (ancestor[ancestor_size-1] != 0) return ENOBUFS; - return SUCCESS; -} - -int directory_list(const char *path, bool recursive, - directory_list_callback_t callback, void *user_data) -{ - DIR *dir; - struct dirent *entry; - struct stat info; - int error = 0; - char entry_path[PATH_MAX]; - bool prune = false; - - if (!(dir = opendir(path))) { - error = errno; - return error; - } - - for (entry = readdir(dir); entry; entry = readdir(dir)) { - prune = false; - if (strcmp(entry->d_name, ".") == 0 || - strcmp(entry->d_name, "..") == 0) { - continue; - } - - error = path_concat(entry_path, sizeof(entry_path), - path, entry->d_name); - if (error != SUCCESS) { - closedir(dir); - /* Don't bother checking the return here. - * The path_concat error is more important - */ - return error; - } - - if (lstat(entry_path, &info) < 0) { - continue; - } - - prune = !callback(path, entry->d_name, entry_path, &info, user_data); - if (S_ISDIR(info.st_mode)) { - if (recursive && !prune) { - error = directory_list(entry_path, recursive, - callback, user_data); - if (error != SUCCESS) { - closedir(dir); - /* Don't bother checking the return here. - * The directory_list error is more important - */ - return error; - } - } - } - } - error = closedir(dir); - if (error) { - return error; - } - return SUCCESS; -} - -bool is_ancestor_path(const char *ancestor, const char *path) -{ - char **path_components, **ancestor_components; - int i, path_count, ancestor_count; - bool result; - - result = false; - path_components = split_path(path, &path_count); - ancestor_components = split_path(ancestor, &ancestor_count); - - if (!path_components || !ancestor_components) { - result = false; - goto exit; - } - - if (ancestor_count >= path_count) { - result = false; - goto exit; - } - - for (i = 0; i < ancestor_count; i++) { - if (strcmp(path_components[i], ancestor_components[i]) != 0) { - result = false; - goto exit; - } - } - - result = true; - - exit: - free(path_components); - free(ancestor_components); - return result; -} - diff --git a/common/path_utils/path_utils.cfg.doxy.in b/common/path_utils/path_utils.cfg.doxy.in deleted file mode 100644 index 90a7dd1bf..000000000 --- a/common/path_utils/path_utils.cfg.doxy.in +++ /dev/null @@ -1,1566 +0,0 @@ -# Doxyfile 1.6.3 - -# 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 = "path_utils" - -# 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 = @PACKAGE_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 = doc - -# 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 = YES - -# 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 = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the - -# 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 = YES - -# 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 = NO - -# 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 = NO - -# 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 = YES - -# 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 = YES - -# 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 = NO - -# 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 = YES - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen -# will list include files with double quotes in the documentation -# rather than with sharp brackets. - -FORCE_LOCAL_INCLUDES = 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 = NOGENERATE MAN - -# 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 = NO - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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 = NO - -# 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 = @srcdir@ - -# 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 = *.c *.h - -# 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 = *_ut.c config.h - -# 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 = - -# 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 - -# If the HTML_FOOTER_DESCRIPTION tag is set to YES, Doxygen will -# add generated date, project name and doxygen version to HTML footer. - -HTML_FOOTER_DESCRIPTION= NO - -# 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_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting -# this to NO can help when comparing the output of multiple runs. - -HTML_TIMESTAMP = YES - -# 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 = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files -# will be generated, which together with the HTML files, form an Eclipse help -# plugin. To install this plugin and make it available under the help contents -# menu in Eclipse, the contents of the directory containing the HTML and XML -# files needs to be copied into the plugins directory of eclipse. The name of -# the directory within the plugins directory should be the same as -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have -# this name. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# 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 enabled 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), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should -# typically be disabled. For large projects the javascript based search engine -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. - -SEARCHENGINE = YES - -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index -# file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup -# and does not have live searching capabilities. - -SERVER_BASED_SEARCH = 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. -# Note that when enabling USE_PDFLATEX this option is only used for -# generating bitmaps for formulas in the HTML output, but not in the -# Makefile that is written to the output directory. - -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 = YES - -# 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 = YES - -# 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 = NO - -# 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 = YES - -# 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 = YES - -# 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 = NO - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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/common/path_utils/path_utils.h b/common/path_utils/path_utils.h deleted file mode 100644 index 2fd567c4e..000000000 --- a/common/path_utils/path_utils.h +++ /dev/null @@ -1,429 +0,0 @@ -/* - Authors: - John Dennis <jdennis.redhat.com> - - Copyright (C) 2009 Red Hat - - This program 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. - - 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 Lesser General Public License for more 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 PATH_UTILS_H -#define PATH_UTILS_H - -/*****************************************************************************/ -/******************************** Documentation ******************************/ -/*****************************************************************************/ - -/** @mainpage Pathname manipulation utilities - * - * This library contains a set of utilities designed to extract info from - * and manipulate path names. - * - */ - -/*****************************************************************************/ -/******************************* Include Files *******************************/ -/*****************************************************************************/ - -#include <stdbool.h> -#include <libintl.h> -#include <sys/param.h> -#include <sys/stat.h> - -/*****************************************************************************/ -/*********************************** Defines *********************************/ -/*****************************************************************************/ - -/** - * @defgroup constants Constants - * @{ - */ - -#ifndef _ -#define _(String) gettext(String) -#endif - -/** - * @brief SUCCESS (=0) is returned by all functions in the path_utils - * library on success. - */ -#ifndef SUCCESS -#define SUCCESS 0 -#endif - -/** - * @} - */ - -/** - * @defgroup errors Error codes and macros - * @{ - */ - -#define PATH_UTILS_ERROR_BASE -3000 -#define PATH_UTILS_ERROR_LIMIT (PATH_UTILS_ERROR_BASE+20) - -/** - * @brief You can use this macro to check if an error code is one of - * the internal path_utils codes. - */ -#define IS_PATH_UTILS_ERROR(error) (((error) >= PATH_UTILS_ERROR_BASE) && ((error) < PATH_UTILS_ERROR_LIMIT)) - -/** @brief A path cannot be normalized due to too many parent links - * - * Returned when a relative path contains too many parent (\c "..") links. - * Please see the documentation of \c normalize_path() for full explanation. - */ -#define PATH_UTILS_ERROR_NOT_FULLY_NORMALIZED (PATH_UTILS_ERROR_BASE + 1) - -/** - * @} - */ - -/*****************************************************************************/ -/******************************* Type Definitions ****************************/ -/*****************************************************************************/ - -/*****************************************************************************/ -/************************* External Global Variables ***********************/ -/*****************************************************************************/ - -/*****************************************************************************/ -/**************************** Exported Functions ***************************/ -/*****************************************************************************/ - -/** - * @defgroup functions Functions - * @{ - */ - -/** @brief Given an error code return the string description. - * - * @param[in] error The error code - * - * @return Error string. If error code is not recognized \c NULL is returned. - */ -const char *path_utils_error_string(int error); - -/** @brief Get the basename component of a path - * - * Given a path, copy the basename component (in the usual case, the part - * following the final "/") into the buffer \c base_name - * whose length is \c base_name_size. If the path does not contain a slash, - * \c get_basename() returns a copy of path. - * - * @param[out] base_name The basename component - * @param[in] base_name_size The size of the base_name buffer - * @param[in] path The full path to parse - * - * @return \c SUCCESS if successful, non-zero error code otherwise. - * Possible errors: - * \li \c ENOBUFS if the buffer space is too small - * \li \c EINVAL The path was a NULL pointer - */ -int get_basename(char *base_name, size_t base_name_size, const char *path); - -/** @brief Copy the directory components of a path - * - * Given a path, copy the directory components (in the usual case, the path - * up to, but not including the final "/") into the buffer \c dir_path whose - * length is \c dir_path_size. If the path does not contain a slash, - * \c get_dirname() returns the current working directory. - * - * @param[out] dir_path The directory component - * @param[in] dir_path_size The size of the dir_path buffer - * @param[in] path The full path to parse - * - * @return \c SUCCESS if successful, non-zero error code otherwise. - * Possible errors: - * \li \c ENOBUFS If the buffer space is too small - * \li \c EACCES Permission to read or search a component of the filename was denied. - * \li \c ENAMETOOLONG The size of the null-terminated pathname exceeds PATH_MAX bytes. - * \li \c ENOENT The current working directory has been unlinked. - * \li \c EINVAL The path was a NULL pointer - */ -int get_dirname(char *dir_path, size_t dir_path_size, const char *path); - -/** @brief Get the basaname and directory components of a path - * - * Given a path, copy the directory components into the buffer \c dir_path whose - * length is \c dir_path_size and copy the basename component into the buffer - * \c base_name whose length is \c base_name_size. - * - * @param[out] base_name The basename component - * @param[in] base_name_size The size of the base_name buffer - * @param[out] dir_path The directory component - * @param[in] dir_path_size The size of the dir_path buffer - * @param[in] path The full path to parse - * - * @return \c SUCCESS if successful, non-zero error code otherwise. - * Possible errors: - * \li \c ENOBUFS If the buffer space is too small - * \li \c EACCES Permission to read or search a component of the filename was denied. - * \li \c ENAMETOOLONG The size of the null-terminated pathname exceeds PATH_MAX bytes. - * \li \c ENOENT The current working directory has been unlinked. - * \li \c EINVAL The path was a NULL pointer - */ -int get_directory_and_base_name(char *dir_path, size_t dir_path_size, - char *base_name, size_t base_name_size, - const char *path); - -/** @brief Tell if path is absolute or relative - * - * @param[in] path The path to check - * - * @return \c true if the path is absolute, \c false otherwise. - */ -bool is_absolute_path(const char *path); - -/** @brief Concatenate two components of a path - * - * Given two paths, \c head & \c tail, copy their concatenation into the - * buffer \c path whose length is \c path_size. - * - * @param[out] path The full path - * @param[in] path_size The size of the path buffer - * @param[in] head The first component of the path - * @param[in] tail The second component of the path - * - * @return \c SUCCESS if successful, non-zero error code otherwise. - * \li \c ENOBUFS If the buffer space is too small - */ -int path_concat(char *path, size_t path_size, const char *head, const char *tail); - -/** @brief Convert a path into absolute - * - * Given a path make it absolute storing the absolute path in into the buffer - * \c absolute_path whose length is \c absolute_path_size. - * - * Returns \c SUCCESS if successful, non-zero error code otherwise. Possible errors: - * \li \c ENOBUFS If the buffer space is too small - * \li \c ENOMEM If user memory cannot be mapped - * \li \c ENOENT If directory does not exist (i.e. it has been deleted) - * \li \c EFAULT If memory access violation occurs while copying - * \li \c EINVAL The path was a NULL pointer - */ -int make_path_absolute(char *absolute_path, size_t absolute_path_size, const char *path); - -/** @brief Split a file system path into individual components. - * - * Split a file system path into individual components. Return a pointer to an - * array of char pointers, each array entry is a pointer to a copy of the - * component. As a special case if the path begins with / then the first - * component is "/" so the caller can identify the pah as absolute with the - * first component being the root. The last entry in the array is \c NULL serving - * as a termination sentinel. An optional integer count parameter can be - * provided, which if non-NULL will have the number of components written into - * it. Thus the caller can iterate on the array until it sees a \c NULL pointer or - * iterate count times indexing the array. - * - * The caller is responsible for calling \c free() on the returned array. This - * frees both the array of component pointers and the copies of each component - * in one operation because the copy of each component is stored in the same - * allocation block. - * - * The original path parameter is not modified. - * - * In the event of an error \c NULL is returned and count (if specified) will be -1. - * - * Examples: - * - * \code - * char **components, **component; - * int i; - * - * components = split_path(path, NULL); - * for (component = components; *component; component++) - * printf("\"%s\" ", *component); - * free(components); - * \endcode - * - * -OR- - * - * \code - * components = split_path(path, &count); - * for (i = 0; i < count; i++) - * printf("\"%s\" ", components[i]); - * free(components); - * \endcode - * - * @param[in] path The original path - * @param[out] count The number of components the path was split into - * - * @return An array of char pointers, each array entry is a pointer to a - * copy of the component or NULL on error. - */ -char **split_path(const char *path, int *count); - -/** @brief Normalizes a path - * - * Normalizes a path copying the resulting normalized path into the buffer - * \c normalized_path whose length is \c normalized_size. - * - * A path is normalized when: - * \li only 1 slash separates all path components - * \li there are no \c . path components (except if \c . is the only component) - * \li there are no \c .. path components - * - * The input path may either be an absolute path or a path fragment. - * - * As a special case if the input path is \c NULL, the empty string \c "", - * or \c "." the returned normalized path will be \c ".". - * - * \c ".." path components point to the parent directory which effectively - * means poping the parent off the path. But what happens when there are - * more \c ".." path components than ancestors in the path? The answer depends - * on whether the path is an absolute path or a path fragment. If the path is - * absolute then the extra \c ".." components which would move above the root - * (/) are simply ignored. This effectively limits the path to the root. - * However if the path is not absolute, rather it is a path fragment, and - * there are more \c ".." components than ancestors which can be "popped off" - * then as many \c ".." components will be popped off the fragement as - * possible without changing the meaning of the path fragment. In this case - * some extra \c ".." components will be left in the path and the function - * will return the error \c ERROR_COULD_NOT_NORMALIZE_PATH_FULLY. However the - * function will still normalize as much of the path fragment as is possible. - * The behavior of \c ".." components when the input path is a fragment is - * adopted because after normalizing a path fragment then the normalized path - * fragment if made absolute should reference the same file system name as if - * the unnormalized fragment were made absolute. Note this also means - * \c ERROR_COULD_NOT_NORMALIZE_PATH_FULLY will never be returned if the input - * path is absolute. - * - * @returns \c SUCCESS if successful, non-zero error code otherwise. Possible - * errors: - * \li \c ENOBUFS If the buffer space is too small - * \li \c ERROR_COULD_NOT_NORMALIZE_PATH_FULLY If not all \c ".." path components could be removed - */ -int normalize_path(char *normalized_path, size_t normalized_path_size, const char *path); - -/** @brief Find the common prefix between two paths - * - * Finds the common prefix between two paths, returns the common prefix and - * optionally the count of how many path components were common between the - * two paths (if \c common_count is non-NULL). Please note that for absolute - * paths, the \c "/" root prefix is treated as a common components, so the - * paths \c "/usr/lib" and \c "/usr/share" would have two common components - - * \c "/" and \c "/usr". - * - * Contrary to some other implementations, \c common_path_prefix() works on - * path components, not characters, which guarantees at least some level of - * sanity of the returned prefixes (for example, the common prefix of - * \c "/usr/share" and \c "/usr/src" would be \c "/usr") - * - * @returns \c SUCCESS if successful, non-zero error code otherwise. - * Possible errors: - * \li \c ENOBUFS if the buffer space is too small - */ -int common_path_prefix(char *common_path, - size_t common_path_size, - int *common_count, - const char *path1, const char *path2); - - -/** @brief Make the input path absolute if it's not already, then normalize it. - * - * @returns \c SUCCESS if successful, non-zero error code otherwise. - * Possible errors: - * \li \c ENOBUFS if the buffer space is too small - */ -int make_normalized_absolute_path(char *result_path, size_t result_path_size, const char *path); - -/** - * Find the first path component which is an existing directory by walking from - * the tail of the path to it's head, return the path of the existing directory. - * - * If the pathname is relative and does not contain a directory, the current - * directory is returned as parent. - * - * @returns \c SUCCESS if successful, non-zero error code otherwise. - * Possible errors: - * \li \c ENOBUFS if the buffer space is too small - * \li \c EACCES Search permission is denied for one of the directories. - * \li \c ELOOP Too many symbolic links encountered while traversing the path. - * \li \c ENAMETOOLONG File name too long. - * \li \c ENOMEM Out of memory (i.e., kernel memory). - */ -int find_existing_directory_ancestor(char *ancestor, size_t ancestor_size, const char *path); - -/** @brief callback for the \c directory_list() function - * - * Please see the description of \c directory_list() to see more - * details about this callback - * - * @param[in] directory Directory name of the visited path - * @param[in] base_name Base name of the visited path - * @param[in] path Full name of the visited path - * @param[in] info Info about the visited directory - * @param[in] user_data Callback data passed by caller - * - * @returns if \c false, do not recursively descend into the directory, - * descend if \c true - */ -typedef bool (*directory_list_callback_t)(const char *directory, const char *base_name, - const char *path, struct stat *info, - void *user_data); -/** @brief Walk a directory. - * - * Walk a directory. If \c recursive is \c true child directories will be - * descended into. The supplied callback is invoked for each entry in the - * directory. - * - * The callback is provided with the directory name, basename, the full - * pathname (i.e. directory name + basename) a stat structure for the path - * item and a pointer to any user supplied data specified in the \c user_data - * parameter. If the callback returns \c false for a directory the recursive - * descent into that directory does not occur thus effectively "pruning" - * the tree. - * - * @param[in] path The path to examine - * @param[in] recursive Whether to recursively examine entries in the directory - * @param[in] callback The callback to invoke for each entry - * @param[in] user_data The data to pass into the callback - * - * @returns SUCCESS if successfull, an error code if not. - */ -int directory_list(const char *path, bool recursive, - directory_list_callback_t callback, void *user_data); - -/** @brief Tell if one path is ancestor of another - * - * Test to see if the path passed in the \c ancestor parameter is an ancestor - * of the path passed in the path parameter returning true if it is, \c false - * otherwise. - * - * The test is "static" as such it is performed on the string components in - * each path. Live symbolic links in the file system are not taken into - * consideration. The test operates by splitting each path into it's individual - * components and then comparing each component pairwise for string - * equality. Both paths mush share a common root component for the test to be - * meaningful (e.g. don't attempt to compare an absolute path with a relative - * path). - * - * Example: - * \code - * is_ancestor_path("/a/b/c" "/a/b/c/d") => true - * is_ancestor_path("/a/b/c/d" "/a/b/c/d") => false // equal, not ancestor - * is_ancestor_path("/a/x/c" "/a/b/c/d") => false - * \endcode - * - * @returns \c true if \c ancestor is an ancestor of \c path - */ -bool is_ancestor_path(const char *ancestor, const char *path); - -/** - * @} - */ - -#endif /* PATH_UTILS_H */ diff --git a/common/path_utils/path_utils.pc.in b/common/path_utils/path_utils.pc.in deleted file mode 100644 index aaf7531be..000000000 --- a/common/path_utils/path_utils.pc.in +++ /dev/null @@ -1,11 +0,0 @@ -prefix=@prefix@ -exec_prefix=@exec_prefix@ -libdir=@libdir@ -includedir=@includedir@ - -Name: @PACKAGE_NAME@ -Description: Utility functions to manipulate filesystem pathnames -Version: @PACKAGE_VERSION@ -Libs: -L${libdir} -lpath_utils -Cflags: -I${includedir} -URL: http://fedorahosted.org/sssd/ diff --git a/common/path_utils/path_utils_ut.c b/common/path_utils/path_utils_ut.c deleted file mode 100644 index 044e9ea2d..000000000 --- a/common/path_utils/path_utils_ut.c +++ /dev/null @@ -1,721 +0,0 @@ -/* - path_utils - unit tests - - Authors: - Jakub Hrozek <jhrozek@redhat.com> - - Copyright (C) 2009 Red Hat - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see <http://www.gnu.org/licenses/>. -*/ - -#define _GNU_SOURCE /* asprintf */ - -#include <check.h> -#include <stdlib.h> -#include <stdio.h> -#include <unistd.h> -#include <errno.h> - -#include "path_utils.h" - -#define fail_unless_str_equal(a, b) do { \ - fail_unless(strcmp(a, b) == 0, \ - "The strings '%s' and '%s' are different, expected same", \ - a, b); \ -} while(0); - -#define DIR_TEMPLATE "test-directory-list-dir-XXXXXX" -#define SUBDIR "test-directory-list-subdir" -#define SUBSUBDIR "test-directory-list-subsubdir" -char *dlist_dir; -char *dlist_subdir; -char *dlist_subsubdir; - -/**** get_dirname ****/ -START_TEST(test_dirname) -{ - char p[PATH_MAX]; - char cwd[PATH_MAX]; - - fail_unless(get_dirname(p, PATH_MAX, "/foo/bar") == SUCCESS); - fail_unless_str_equal(p, "/foo"); - - fail_unless(get_dirname(p, PATH_MAX, "/") == SUCCESS); - fail_unless_str_equal(p, "/"); - - fail_unless(get_dirname(p, PATH_MAX, "/foo") == SUCCESS); - fail_unless_str_equal(p, "/"); - - fail_unless(get_dirname(p, PATH_MAX, "//foo//bar") == SUCCESS); - fail_unless_str_equal(p, "//foo"); - - fail_unless(get_dirname(p, PATH_MAX, "//foo//") == SUCCESS); - fail_unless_str_equal(p, "//"); - - fail_unless(get_dirname(p, PATH_MAX, "foo//bar") == SUCCESS); - fail_unless_str_equal(p, "foo"); - - fail_unless(get_dirname(p, PATH_MAX, "foo//////bar") == SUCCESS); - fail_unless_str_equal(p, "foo"); - - /* if pathname does not contain a slash, dirname returns cwd */ - fail_if(getcwd(cwd, PATH_MAX) == NULL, "getcwd failed"); - - fail_unless(get_dirname(p, PATH_MAX, "foo") == SUCCESS); - fail_unless_str_equal(p, cwd); - - fail_unless(get_dirname(p, PATH_MAX, ".") == SUCCESS); - fail_unless_str_equal(p, cwd); - - fail_unless(get_dirname(p, PATH_MAX, "..") == SUCCESS); - fail_unless_str_equal(p, cwd); - - fail_unless(get_dirname(p, PATH_MAX, "") == SUCCESS); - fail_unless_str_equal(p, cwd); -} -END_TEST - -START_TEST(test_dirname_neg) -{ - char neg[3]; - char p[PATH_MAX]; - - fail_if(get_dirname(neg, 3, "/foo/bar") == SUCCESS); - fail_unless(get_dirname(p, PATH_MAX, NULL) == EINVAL); -} -END_TEST - -/**** get_basename ****/ -START_TEST(test_basename) -{ - char p[PATH_MAX]; - char cwd[PATH_MAX]; - - fail_unless(get_basename(p, PATH_MAX, "/foo/bar") == SUCCESS); - fail_unless_str_equal(p, "bar"); - - fail_unless(get_basename(p, PATH_MAX, "/foo/") == SUCCESS); - fail_unless_str_equal(p, "foo"); - - fail_unless(get_basename(p, PATH_MAX, "foo") == SUCCESS); - fail_unless_str_equal(p, "foo"); - - fail_unless(get_basename(p, PATH_MAX, "/") == SUCCESS); - fail_unless_str_equal(p, "/"); - - fail_if(getcwd(cwd, PATH_MAX) == NULL, "getcwd failed"); - - fail_unless(get_basename(p, PATH_MAX, ".") == SUCCESS); - fail_unless_str_equal(p, cwd); - - fail_unless(get_basename(p, PATH_MAX, "") == SUCCESS); - fail_unless_str_equal(p, cwd); -} -END_TEST - -START_TEST(test_basename_neg) -{ - char neg[3]; - char p[PATH_MAX]; - - fail_if(get_basename(neg, 3, "/foo/bar") == SUCCESS); - - fail_unless(get_basename(p, PATH_MAX, NULL) == EINVAL); -} -END_TEST - -/**** is_absolute_path ****/ -START_TEST(test_is_absolute_path) -{ - fail_unless(is_absolute_path("") == false); - fail_unless(is_absolute_path("foo/bar") == false); - - fail_unless(is_absolute_path("/foo/bar") == true); - fail_unless(is_absolute_path("/foo") == true); - fail_unless(is_absolute_path("/") == true); -} -END_TEST - -/**** get_dirname_and_basename ****/ -/* Just a couple of basic tests - get_dirname_and_basename() - * uses get_dirname() and get_basename() under the hood which - * are tested enough in their specific tests - */ -START_TEST(test_dirname_and_basename) -{ - char dir[PATH_MAX]; - char base[PATH_MAX]; - char cwd[PATH_MAX]; - int ret; - - ret = get_directory_and_base_name(dir, PATH_MAX, base, PATH_MAX, "/foo/bar"); - fail_unless(ret == SUCCESS); - fail_unless_str_equal(dir, "/foo"); - fail_unless_str_equal(base, "bar"); - - ret = get_directory_and_base_name(dir, PATH_MAX, base, PATH_MAX, "/foo"); - fail_unless(ret == SUCCESS); - fail_unless_str_equal(dir, "/"); - fail_unless_str_equal(base, "foo"); - - ret = get_directory_and_base_name(dir, PATH_MAX, base, PATH_MAX, "/"); - fail_unless(ret == SUCCESS); - fail_unless_str_equal(dir, "/"); - fail_unless_str_equal(base, "/"); - - fail_if(getcwd(cwd, PATH_MAX) == NULL, "getcwd failed"); - - ret = get_directory_and_base_name(dir, PATH_MAX, base, PATH_MAX, "foo"); - fail_unless(ret == SUCCESS); - fail_unless_str_equal(dir, cwd); - fail_unless_str_equal(base, "foo"); - - ret = get_directory_and_base_name(dir, PATH_MAX, base, PATH_MAX, ""); - fail_unless(ret == SUCCESS); - fail_unless_str_equal(dir, cwd); - fail_unless_str_equal(base, ""); - - ret = get_directory_and_base_name(dir, PATH_MAX, base, PATH_MAX, "."); - fail_unless(ret == SUCCESS); - fail_unless_str_equal(dir, cwd); - fail_unless_str_equal(base, ""); -} -END_TEST - -START_TEST(test_dirname_and_basename_neg) -{ - char dir[PATH_MAX]; - char base[PATH_MAX]; - int ret; - - ret = get_directory_and_base_name(dir, PATH_MAX, base, PATH_MAX, NULL); - fail_unless(ret == EINVAL); -} -END_TEST - -/**** path_concat ****/ -START_TEST(test_path_concat) -{ - char p[PATH_MAX]; - char p2[9]; - - fail_unless(path_concat(p, PATH_MAX, "/foo", "bar") == SUCCESS); - fail_unless_str_equal(p, "/foo/bar"); - - fail_unless(path_concat(p, PATH_MAX, "/foo", "/bar") == SUCCESS); - fail_unless_str_equal(p, "/foo/bar"); - - fail_unless(path_concat(p, PATH_MAX, "/foo/", "/bar") == SUCCESS); - fail_unless_str_equal(p, "/foo/bar"); - - fail_unless(path_concat(p, PATH_MAX, "/foo", "") == SUCCESS); - fail_unless_str_equal(p, "/foo"); - - fail_unless(path_concat(p, PATH_MAX, "foo", NULL) == SUCCESS); - fail_unless_str_equal(p, "foo"); - - fail_unless(path_concat(p, PATH_MAX, "", "foo") == SUCCESS); - fail_unless_str_equal(p, "foo"); - - fail_unless(path_concat(p, PATH_MAX, NULL, "foo") == SUCCESS); - fail_unless_str_equal(p, "foo"); - - /* on-by-one */ - fail_unless(path_concat(p2, 9, "/foo", "bar") == SUCCESS); - fail_unless_str_equal(p2, "/foo/bar"); -} -END_TEST - -START_TEST(test_path_concat_neg) -{ - char small[3]; - char small2[4]; - char p2[8]; - - /* these two test different conditions */ - fail_unless(path_concat(small, 3, "/foo", "bar") == ENOBUFS); - fail_unless(path_concat(small2, 4, "/foo", "bar") == ENOBUFS); - - /* off-by-one */ - fail_unless(path_concat(p2, 8, "/foo", "bar") == ENOBUFS); - fail_unless_str_equal(p2, "/foo/bar"); -} -END_TEST - -/**** make_path_absolute ****/ -START_TEST(test_make_path_absolute) -{ - char p[PATH_MAX]; - char p2[PATH_MAX]; - char cwd[PATH_MAX]; - char *buf; - size_t buf_len; - - fail_unless(make_path_absolute(p, PATH_MAX, "/foo") == SUCCESS); - fail_unless_str_equal(p, "/foo"); - - fail_if(getcwd(cwd, PATH_MAX) == NULL, "getcwd failed"); - - fail_unless(make_path_absolute(p, PATH_MAX, "foo") == SUCCESS); - snprintf(p2, PATH_MAX, "%s/foo", cwd); - fail_unless_str_equal(p, p2); - - fail_unless(make_path_absolute(p, PATH_MAX, "") == SUCCESS); - fail_unless_str_equal(p, cwd); - - /* on-by-one; 2 = terminating null + path delimeter */ - buf_len = strlen(cwd) + strlen("foo") + 2; - buf = malloc(buf_len); - fail_if(buf == NULL); - fail_unless(make_path_absolute(buf, buf_len, "foo") == SUCCESS); - free(buf); -} -END_TEST - -START_TEST(test_make_path_absolute_neg) -{ - char small[1]; - char cwd[PATH_MAX]; - char *small2; - int small_len; - - fail_unless(make_path_absolute(small, 1, "/foo") == ENOBUFS); - fail_unless(make_path_absolute(NULL, 1, "/foo") == ENOBUFS); - - /* off-by-one */ - fail_if(getcwd(cwd, PATH_MAX) == NULL, "getcwd failed"); - small_len = strlen(cwd) + strlen("foo") + 1; - small2 = malloc(small_len); - fail_if(small2 == NULL); - fail_unless(make_path_absolute(small2, small_len, "foo") == ENOBUFS); - free(small2); - - /* just enough space for cwd */ - small_len = strlen(cwd) + 1; - small2 = malloc(small_len); - fail_if(small2 == NULL); - fail_unless(make_path_absolute(small2, small_len, "foo") == ENOBUFS); - free(small2); -} -END_TEST - -/**** make_normalized_absolute_path ****/ -START_TEST(test_make_normalized_absolute_path) -{ - char p[PATH_MAX]; - char p2[PATH_MAX]; - char cwd[PATH_MAX]; - - fail_if(getcwd(cwd, PATH_MAX) == NULL, "getcwd failed"); - - fail_unless(make_normalized_absolute_path(p, PATH_MAX, "foo/baz/../bar") == SUCCESS); - snprintf(p2, PATH_MAX, "%s/foo/bar", cwd); - fail_unless_str_equal(p, p2); - - fail_unless(make_normalized_absolute_path(p, PATH_MAX, "/foo/../bar") == SUCCESS); - fail_unless_str_equal(p, "/bar"); - - fail_unless(make_normalized_absolute_path(p, PATH_MAX, "/foo/../baz/../bar") == SUCCESS); - fail_unless_str_equal(p, "/bar"); -} -END_TEST - -START_TEST(test_make_normalized_absolute_path_neg) -{ - char small[1]; - - fail_unless(make_path_absolute(small, 1, "/foo") == ENOBUFS); - fail_unless(make_path_absolute(NULL, 1, "/foo") == ENOBUFS); -} -END_TEST - -/**** split_path ****/ -START_TEST(test_split_path) -{ - char **array; - int n; - - array = split_path("/foo/bar", &n); - fail_if(array == NULL); - fail_unless(n == 3); - fail_unless_str_equal(array[0], "/"); - fail_unless_str_equal(array[1], "foo"); - fail_unless_str_equal(array[2], "bar"); - free(array); - - array = split_path("/foo/../bar", &n); - fail_if(array == NULL); - fail_unless(n == 4); - fail_unless_str_equal(array[0], "/"); - fail_unless_str_equal(array[1], "foo"); - fail_unless_str_equal(array[2], ".."); - fail_unless_str_equal(array[3], "bar"); - free(array); - - array = split_path("/foo/bar", NULL); - fail_if(array == NULL); - fail_unless_str_equal(array[0], "/"); - fail_unless_str_equal(array[1], "foo"); - fail_unless_str_equal(array[2], "bar"); - free(array); - - array = split_path("foo/bar", &n); - fail_if(array == NULL); - fail_unless(n == 2); - fail_unless_str_equal(array[0], "foo"); - fail_unless_str_equal(array[1], "bar"); - free(array); - - array = split_path(".", &n); - fail_if(array == NULL); - fail_unless(n == 1); - fail_unless_str_equal(array[0], "."); - free(array); - - array = split_path("foo", &n); - fail_if(array == NULL); - fail_unless(n == 1); - fail_unless_str_equal(array[0], "foo"); - free(array); - - /* one might expect { "" } or outright NULL, but we agreed not to - * do changes beyond bugfixes at this point */ - array = split_path("", &n); - fail_if(array == NULL); - fail_unless(n == 0); - fail_unless(array[0] == NULL); - free(array); -} -END_TEST - -START_TEST(test_split_path_neg) -{ - char **array; - int n; - - array = split_path(NULL, &n); - fail_unless(array == NULL); - - array = split_path(NULL, NULL); - fail_unless(array == NULL); -} -END_TEST - -/**** normalize_path ****/ -START_TEST(test_normalize_path) -{ - char norm[PATH_MAX]; - char small[8]; - - fail_unless(normalize_path(norm, PATH_MAX, "/foo/../bar") == SUCCESS); - fail_unless_str_equal(norm, "/bar"); - - fail_unless(normalize_path(norm, PATH_MAX, "/foo/../baz/../bar") == SUCCESS); - fail_unless_str_equal(norm, "/bar"); - - fail_unless(normalize_path(norm, PATH_MAX, "foo/baz/../bar") == SUCCESS); - fail_unless_str_equal(norm, "foo/bar"); - - fail_unless(normalize_path(norm, PATH_MAX, "/foo/./bar") == SUCCESS); - fail_unless_str_equal(norm, "/foo/bar"); - - fail_unless(normalize_path(norm, PATH_MAX, "/foo//bar") == SUCCESS); - fail_unless_str_equal(norm, "/foo/bar"); - - fail_unless(normalize_path(norm, PATH_MAX, "/foo//bar") == SUCCESS); - fail_unless_str_equal(norm, "/foo/bar"); - - fail_unless(normalize_path(norm, PATH_MAX, "") == SUCCESS); - fail_unless_str_equal(norm, "."); - - fail_unless(normalize_path(norm, PATH_MAX, "/../..") == SUCCESS); - fail_unless_str_equal(norm, "/"); - - /* on-by-one */ - fail_unless(normalize_path(small, 8, "foo/baz/../bar") == SUCCESS); - fail_unless_str_equal(small, "foo/bar"); -} -END_TEST - -START_TEST(test_normalize_path_neg) -{ - char norm[PATH_MAX]; - char small[4]; - - fail_unless(normalize_path(norm, PATH_MAX, "foo/../..") == PATH_UTILS_ERROR_NOT_FULLY_NORMALIZED); - - /* with a buffer of 4 chars, this would test off-by-one error */ - fail_unless(normalize_path(small, 4, "/foo/../bar") == ENOBUFS); -} -END_TEST - -/**** common_path_prefix ****/ -START_TEST(test_common_path_prefix) -{ - char common[PATH_MAX]; - char small[5]; - int count; - - fail_unless(common_path_prefix(common, PATH_MAX, &count, "/usr/lib", "/usr/share") == SUCCESS); - fail_unless_str_equal(common, "/usr"); - fail_unless(count == 2); - - fail_unless(common_path_prefix(common, PATH_MAX, NULL, "/usr/lib", "/usr/share") == SUCCESS); - fail_unless_str_equal(common, "/usr"); - - fail_unless(common_path_prefix(common, PATH_MAX, &count, "/usr/lib", "/usr/lab") == SUCCESS); - fail_unless_str_equal(common, "/usr"); - fail_unless(count == 2); - - fail_unless(common_path_prefix(common, PATH_MAX, &count, "foo", "bar") == SUCCESS); - fail_unless_str_equal(common, ""); - fail_unless(count == 0); - - fail_unless(common_path_prefix(common, PATH_MAX, &count, "/", "/") == SUCCESS); - fail_unless_str_equal(common, "/"); - fail_unless(count == 1); - - fail_unless(common_path_prefix(common, PATH_MAX, &count, NULL, "/usr/share") == SUCCESS); - fail_unless_str_equal(common, ""); - fail_unless(count == 0); - - /* on-by-one */ - fail_unless(common_path_prefix(small, 5, NULL, "/usr/lib", "/usr/share") == SUCCESS); - fail_unless_str_equal(small, "/usr"); -} -END_TEST - -START_TEST(test_common_path_prefix_neg) -{ - char small[1]; - char small2[4]; - int count; - - fail_unless(common_path_prefix(small, 1, &count, "/usr/lib", "/usr/share") == ENOBUFS); - fail_unless(common_path_prefix(NULL, PATH_MAX, &count, "/usr/lib", "/usr/share") == ENOBUFS); - /* off-by-one */ - fail_unless(common_path_prefix(small2, 4, NULL, "/usr/lib", "/usr/share") == ENOBUFS); -} -END_TEST - -/**** find_existing_directory_ancestor ****/ -START_TEST(test_find_existing_directory_ancestor) -{ - char p[PATH_MAX]; - char cwd[PATH_MAX]; - - fail_unless(find_existing_directory_ancestor(p, PATH_MAX, "/etc/passwd") == SUCCESS); - fail_unless_str_equal(p, "/etc"); - - /* if pathname does not contain a slash, the parent is cwd */ - fail_if(getcwd(cwd, PATH_MAX) == NULL, "getcwd failed"); - - fail_unless(find_existing_directory_ancestor(p, PATH_MAX, "foo/bar") == SUCCESS); - fail_unless_str_equal(p, cwd); -} -END_TEST - -START_TEST(test_find_existing_directory_ancestor_neg) -{ - char small[4]; - fail_unless(find_existing_directory_ancestor(small, 4, "/etc/passwd") == ENOBUFS); - fail_unless(find_existing_directory_ancestor(NULL, 4, "/etc/passwd") == ENOBUFS); -} -END_TEST - -/**** directory_list ****/ -void setup_directory_list(void) -{ - char *s = NULL; - int ret; - - s = strdup(DIR_TEMPLATE); - fail_unless(s != NULL, "strdup failed\n"); - dlist_dir = mkdtemp(s); - fail_unless(dlist_dir != NULL, "mkstemp failed [%d][%s]", errno, strerror(errno)); - - ret = asprintf(&dlist_subdir, "%s/%s", dlist_dir, SUBDIR); - fail_unless(ret != 1, "strdup failed\n"); - ret = mkdir(dlist_subdir, 0700); - fail_unless(ret != -1, "mkdir %s failed [%d][%s]", dlist_subdir, errno, strerror(errno)); - - ret = asprintf(&dlist_subsubdir, "%s/%s", dlist_subdir, SUBSUBDIR); - fail_unless(ret != 1, "strdup failed\n"); - ret = mkdir(dlist_subsubdir, 0700); - fail_unless(ret != -1, "mkdir %s failed [%d][%s]", dlist_subsubdir, errno, strerror(errno)); -} - -void teardown_directory_list(void) -{ - int ret; - - if (dlist_subsubdir) { - ret = rmdir(dlist_subsubdir); - fail_unless(ret != -1, "unlink %s failed [%d][%s]", dlist_subsubdir, errno, strerror(errno)); - free(dlist_subsubdir); - dlist_subsubdir = NULL; - } - - if (dlist_subdir) { - ret = rmdir(dlist_subdir); - fail_unless(ret != -1, "unlink %s failed [%d][%s]", dlist_subdir, errno, strerror(errno)); - free(dlist_subdir); - dlist_subdir = NULL; - } - - if (dlist_dir) { - ret = rmdir(dlist_dir); - fail_unless(ret != -1, "unlink %s failed [%d][%s]", dlist_dir, errno, strerror(errno)); - free(dlist_dir); - dlist_dir = NULL; - } -} - -bool dirlist_cb_nonrecursive(const char *directory, const char *base_name, - const char *path, struct stat *info, - void *user_data) -{ - int *data = (int *) user_data; - - fail_unless_str_equal(path, dlist_subdir); - fail_unless(*data == 123); - - return true; -} - -bool dirlist_cb_recursive(const char *directory, const char *base_name, - const char *path, struct stat *info, - void *user_data) -{ - bool *seen_child = (bool *) user_data; - static bool seen_parent = false; - - if (!seen_parent) { - fail_unless_str_equal(path, dlist_subdir); - seen_parent = true; - } else { - *seen_child = true; - fail_unless_str_equal(path, dlist_subsubdir); - seen_parent = false; - } - - return true; -} - -START_TEST(test_directory_list) -{ - int data = 123; - bool seen_child; - - fail_unless(directory_list(dlist_dir, false, dirlist_cb_nonrecursive, &data) == SUCCESS); - - seen_child = false; - fail_unless(directory_list(dlist_dir, true, dirlist_cb_recursive, &seen_child) == SUCCESS); - fail_unless(seen_child == true); - - seen_child = false; - fail_unless(directory_list(dlist_dir, false, dirlist_cb_recursive, &seen_child) == SUCCESS); - fail_unless(seen_child == false); -} -END_TEST - -START_TEST(test_directory_list_neg) -{ - fail_if(directory_list("/not/here", false, dirlist_cb_nonrecursive, NULL) == SUCCESS); - fail_if(directory_list("/etc/passwd", false, dirlist_cb_nonrecursive, NULL) == SUCCESS); -} -END_TEST - -/**** is_ancestor_path ****/ -START_TEST(test_is_ancestor_path) -{ - fail_unless(is_ancestor_path("/a/b/c", "/a/b/c/d") == true); - /* equal, not ancestor */ - fail_unless(is_ancestor_path("/a/b/c/d", "/a/b/c/d") == false); - fail_unless(is_ancestor_path("/a/x/c", "/a/b/c/d") == false); - fail_unless(is_ancestor_path(NULL, "/a/b/c/d") == false); - fail_unless(is_ancestor_path("/a/x/c", NULL) == false); - fail_unless(is_ancestor_path(NULL, NULL) == false); - fail_unless(is_ancestor_path("", "") == false); -} -END_TEST - - -Suite *path_utils_suite(void) -{ - Suite *s = suite_create("path_utils"); - - TCase *tc_path_utils = tcase_create("path_utils"); - TCase *tc_directory_list = tcase_create("path_utils_directory_list"); - - tcase_add_test(tc_path_utils, test_dirname); - tcase_add_test(tc_path_utils, test_dirname_neg); - - tcase_add_test(tc_path_utils, test_basename); - tcase_add_test(tc_path_utils, test_basename_neg); - - tcase_add_test(tc_path_utils, test_dirname_and_basename); - tcase_add_test(tc_path_utils, test_dirname_and_basename_neg); - - tcase_add_test(tc_path_utils, test_is_absolute_path); - - tcase_add_test(tc_path_utils, test_path_concat); - tcase_add_test(tc_path_utils, test_path_concat_neg); - - tcase_add_test(tc_path_utils, test_split_path); - tcase_add_test(tc_path_utils, test_split_path_neg); - - tcase_add_test(tc_path_utils, test_make_path_absolute); - tcase_add_test(tc_path_utils, test_make_path_absolute_neg); - - tcase_add_test(tc_path_utils, test_normalize_path); - tcase_add_test(tc_path_utils, test_normalize_path_neg); - - tcase_add_test(tc_path_utils, test_make_normalized_absolute_path); - tcase_add_test(tc_path_utils, test_make_normalized_absolute_path_neg); - - tcase_add_test(tc_path_utils, test_common_path_prefix); - tcase_add_test(tc_path_utils, test_common_path_prefix_neg); - - tcase_add_test(tc_path_utils, test_find_existing_directory_ancestor); - tcase_add_test(tc_path_utils, test_find_existing_directory_ancestor_neg); - - tcase_add_test(tc_path_utils, test_is_ancestor_path); - - tcase_add_checked_fixture(tc_directory_list, - setup_directory_list, - teardown_directory_list); - tcase_add_test(tc_directory_list, test_directory_list); - tcase_add_test(tc_directory_list, test_directory_list_neg); - - suite_add_tcase(s, tc_path_utils); - suite_add_tcase(s, tc_directory_list); - - return s; -} - -int main(void) -{ - int number_failed; - - Suite *s = path_utils_suite(); - SRunner *sr = srunner_create(s); - /* If CK_VERBOSITY is set, use that, otherwise it defaults to CK_NORMAL */ - srunner_run_all(sr, CK_ENV); - number_failed = srunner_ntests_failed(sr); - srunner_free(sr); - return (number_failed == 0) ? EXIT_SUCCESS : EXIT_FAILURE; -} - diff --git a/common/refarray/COPYING b/common/refarray/COPYING deleted file mode 100644 index 94a9ed024..000000000 --- a/common/refarray/COPYING +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - <one line to give the program's name and a brief idea of what it does.> - Copyright (C) <year> <name of author> - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see <http://www.gnu.org/licenses/>. - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - <program> Copyright (C) <year> <name of author> - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -<http://www.gnu.org/licenses/>. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/common/refarray/COPYING.LESSER b/common/refarray/COPYING.LESSER deleted file mode 100644 index 755013bb2..000000000 --- a/common/refarray/COPYING.LESSER +++ /dev/null @@ -1,165 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - - This version of the GNU Lesser General Public License incorporates -the terms and conditions of version 3 of the GNU General Public -License, supplemented by the additional permissions listed below. - - 0. Additional Definitions. - - As used herein, "this License" refers to version 3 of the GNU Lesser -General Public License, and the "GNU GPL" refers to version 3 of the GNU -General Public License. - - "The Library" refers to a covered work governed by this License, -other than an Application or a Combined Work as defined below. - - An "Application" is any work that makes use of an interface provided -by the Library, but which is not otherwise based on the Library. -Defining a subclass of a class defined by the Library is deemed a mode -of using an interface provided by the Library. - - A "Combined Work" is a work produced by combining or linking an -Application with the Library. The particular version of the Library -with which the Combined Work was made is also called the "Linked -Version". - - The "Minimal Corresponding Source" for a Combined Work means the -Corresponding Source for the Combined Work, excluding any source code -for portions of the Combined Work that, considered in isolation, are -based on the Application, and not on the Linked Version. - - The "Corresponding Application Code" for a Combined Work means the -object code and/or source code for the Application, including any data -and utility programs needed for reproducing the Combined Work from the -Application, but excluding the System Libraries of the Combined Work. - - 1. Exception to Section 3 of the GNU GPL. - - You may convey a covered work under sections 3 and 4 of this License -without being bound by section 3 of the GNU GPL. - - 2. Conveying Modified Versions. - - If you modify a copy of the Library, and, in your modifications, a -facility refers to a function or data to be supplied by an Application -that uses the facility (other than as an argument passed when the -facility is invoked), then you may convey a copy of the modified -version: - - a) under this License, provided that you make a good faith effort to - ensure that, in the event an Application does not supply the - function or data, the facility still operates, and performs - whatever part of its purpose remains meaningful, or - - b) under the GNU GPL, with none of the additional permissions of - this License applicable to that copy. - - 3. Object Code Incorporating Material from Library Header Files. - - The object code form of an Application may incorporate material from -a header file that is part of the Library. You may convey such object -code under terms of your choice, provided that, if the incorporated -material is not limited to numerical parameters, data structure -layouts and accessors, or small macros, inline functions and templates -(ten or fewer lines in length), you do both of the following: - - a) Give prominent notice with each copy of the object code that the - Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the object code with a copy of the GNU GPL and this license - document. - - 4. Combined Works. - - You may convey a Combined Work under terms of your choice that, -taken together, effectively do not restrict modification of the -portions of the Library contained in the Combined Work and reverse -engineering for debugging such modifications, if you also do each of -the following: - - a) Give prominent notice with each copy of the Combined Work that - the Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the Combined Work with a copy of the GNU GPL and this license - document. - - c) For a Combined Work that displays copyright notices during - execution, include the copyright notice for the Library among - these notices, as well as a reference directing the user to the - copies of the GNU GPL and this license document. - - d) Do one of the following: - - 0) Convey the Minimal Corresponding Source under the terms of this - License, and the Corresponding Application Code in a form - suitable for, and under terms that permit, the user to - recombine or relink the Application with a modified version of - the Linked Version to produce a modified Combined Work, in the - manner specified by section 6 of the GNU GPL for conveying - Corresponding Source. - - 1) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (a) uses at run time - a copy of the Library already present on the user's computer - system, and (b) will operate properly with a modified version - of the Library that is interface-compatible with the Linked - Version. - - e) Provide Installation Information, but only if you would otherwise - be required to provide such information under section 6 of the - GNU GPL, and only to the extent that such information is - necessary to install and execute a modified version of the - Combined Work produced by recombining or relinking the - Application with a modified version of the Linked Version. (If - you use option 4d0, the Installation Information must accompany - the Minimal Corresponding Source and Corresponding Application - Code. If you use option 4d1, you must provide the Installation - Information in the manner specified by section 6 of the GNU GPL - for conveying Corresponding Source.) - - 5. Combined Libraries. - - You may place library facilities that are a work based on the -Library side by side in a single library together with other library -facilities that are not Applications and are not covered by this -License, and convey such a combined library under terms of your -choice, if you do both of the following: - - a) Accompany the combined library with a copy of the same work based - on the Library, uncombined with any other library facilities, - conveyed under the terms of this License. - - b) Give prominent notice with the combined library that part of it - is a work based on the Library, and explaining where to find the - accompanying uncombined form of the same work. - - 6. Revised Versions of the GNU Lesser General Public License. - - The Free Software Foundation may publish revised and/or new versions -of the GNU Lesser 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 -Library as you received it specifies that a certain numbered version -of the GNU Lesser General Public License "or any later version" -applies to it, you have the option of following the terms and -conditions either of that published version or of any later version -published by the Free Software Foundation. If the Library as you -received it does not specify a version number of the GNU Lesser -General Public License, you may choose any version of the GNU Lesser -General Public License ever published by the Free Software Foundation. - - If the Library as you received it specifies that a proxy can decide -whether future versions of the GNU Lesser General Public License shall -apply, that proxy's public statement of acceptance of any version is -permanent authorization for you to choose that version for the -Library. diff --git a/common/refarray/Makefile.am b/common/refarray/Makefile.am deleted file mode 100644 index abda089d4..000000000 --- a/common/refarray/Makefile.am +++ /dev/null @@ -1,55 +0,0 @@ -TRACE_LEVEL=@TRACE_VAR@ - -topdir=$(srcdir)/.. - -AM_CFLAGS = - -if HAVE_GCC - AM_CFLAGS += \ - -Wall -Wshadow -Wstrict-prototypes -Wpointer-arith -Wcast-qual \ - -Wcast-align -Wwrite-strings -endif - -AM_CPPFLAGS = -I$(topdir)/trace -I$(topdir)/elapi/refarray $(TRACE_LEVEL) - -ACLOCAL_AMFLAGS = -I m4 - -# Set up the pkg-config file -pkgconfigdir = $(libdir)/pkgconfig -pkgconfig_DATA = ref_array.pc - -dist_noinst_DATA = m4 - -dist_include_HEADERS = ref_array.h - -# Build library -lib_LTLIBRARIES = libref_array.la -libref_array_la_SOURCES = \ - ref_array.c -libref_array_la_LDFLAGS = \ - -version-info 1:0:0 - -# Build unit test -check_PROGRAMS = ref_array_ut -ref_array_ut_SOURCES = ref_array_ut.c -ref_array_ut_LDADD = libref_array.la - -if HAVE_DOXYGEN -docs: -# A temp way of building docs until we hook into the package build - rm -fR doc - mkdir -p doc - $(DOXYGEN) ref_array.cfg.doxy -else -docs: - @echo "Doxygen not installed, cannot generate documentation" - @exit 1 -endif - - -TESTS = ref_array_ut - -tests: all $(check_PROGRAMS) - -clean-local: - rm -Rf doc diff --git a/common/refarray/README b/common/refarray/README deleted file mode 100644 index a3e4f617a..000000000 --- a/common/refarray/README +++ /dev/null @@ -1 +0,0 @@ -Documentation for libref_array can be found in ref_array.h diff --git a/common/refarray/configure.ac b/common/refarray/configure.ac deleted file mode 100644 index 55f539dbc..000000000 --- a/common/refarray/configure.ac +++ /dev/null @@ -1,32 +0,0 @@ -AC_INIT([ref_array], - 0.1.0, - [sssd-devel@lists.fedorahosted.org]) -AC_CONFIG_SRCDIR([ref_array.c]) -AC_CONFIG_AUX_DIR([build]) -AM_INIT_AUTOMAKE([-Wall -Werror foreign]) -AC_PROG_CC -AC_PROG_LIBTOOL -AC_CONFIG_MACRO_DIR([m4]) -AC_PROG_INSTALL - -AM_CONDITIONAL([HAVE_GCC], [test "$ac_cv_prog_gcc" = yes]) - -m4_pattern_allow([AM_SILENT_RULES]) -AM_SILENT_RULES - -AC_CONFIG_HEADERS([config.h]) - -# Enable trace build -AC_ARG_ENABLE([trace], - [AS_HELP_STRING([--enable-trace[=LEVEL]],[build with low level tracing enabled])], - [trace_level="$enableval"], - [trace_level="0"]) - -AS_IF([test ["$trace_level" -gt "0"] -a ["$trace_level" -lt "8"] ],[AC_SUBST([TRACE_VAR],["-DTRACE_LEVEL=$trace_level"])]) - -AC_PATH_PROG([DOXYGEN], [doxygen], [false]) -AM_CONDITIONAL([HAVE_DOXYGEN], [test x$DOXYGEN != xfalse ]) - -AC_CONFIG_FILES([Makefile ref_array.cfg.doxy ref_array.pc]) - -AC_OUTPUT diff --git a/common/refarray/m4/.dir b/common/refarray/m4/.dir deleted file mode 100644 index e69de29bb..000000000 --- a/common/refarray/m4/.dir +++ /dev/null diff --git a/common/refarray/ref_array.c b/common/refarray/ref_array.c deleted file mode 100644 index d02f9aed8..000000000 --- a/common/refarray/ref_array.c +++ /dev/null @@ -1,489 +0,0 @@ -/* - REF ARRAY - - Implementation of the dynamic array with reference count. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - You should have received a copy of the GNU General Public License - along with this program. If not, see <http://www.gnu.org/licenses/>. -*/ - -#define _GNU_SOURCE -#include <errno.h> /* for errors */ -#include <stdint.h> -#include <malloc.h> -#include <string.h> -#include <stdio.h> - -#include "ref_array.h" -#include "config.h" -#include "trace.h" - -/* The structure used in referenced array */ -struct ref_array { - void *storage; /* The storage buffer */ - size_t elsize; /* Size of one element in the buffer */ - uint32_t size; /* Size of the storage in items */ - uint32_t grow_by; /* What increment use to reallocate memory */ - uint32_t len; /* Number of the elements in the array */ - uint32_t refcount; /* Reference count */ - ref_array_fn cb; /* Cleanup callback */ - void *cb_data; /* Caller's callback data */ -}; - -/****************************************************/ -/* INTERNAL FUNCTIONS */ -/****************************************************/ -static int ref_array_grow(struct ref_array *ra) -{ - int error = EOK; - void *newbuf = NULL; - - TRACE_FLOW_STRING("ref_array_grow", "Entry"); - - TRACE_INFO_NUMBER("Current length: ", ra->len); - TRACE_INFO_NUMBER("Current size: ", ra->size); - - /* Grow buffer if needed */ - newbuf = realloc(ra->storage, (ra->size + ra->grow_by) * ra->elsize); - if (newbuf == NULL) { - TRACE_ERROR_NUMBER("Failed to allocate memory.", ENOMEM); - return ENOMEM; - } - - ra->storage = newbuf; - ra->size += ra->grow_by; - - TRACE_INFO_NUMBER("Final size: ", ra->size); - TRACE_FLOW_NUMBER("elapi_grow_data. Exit. Returning", error); - return error; - -} - - -/****************************************************/ -/* PUBLIC FUNCTIONS */ -/****************************************************/ - -/* Create referenced array */ -int ref_array_create(struct ref_array **ra, - size_t elemsz, - uint32_t grow_by, - ref_array_fn cb, - void *data) -{ - struct ref_array *new_ra = NULL; - - TRACE_FLOW_STRING("ref_array_create", "Entry"); - - if (!ra) { - TRACE_ERROR_NUMBER("Uninitialized argument.", EINVAL); - return EINVAL; - } - - if ((!elemsz) || (!grow_by)) { - TRACE_ERROR_NUMBER("Invalid argument.", EINVAL); - return EINVAL; - } - - new_ra = (struct ref_array *)malloc(sizeof(struct ref_array)); - - if (!new_ra) { - TRACE_ERROR_NUMBER("Failed to allocate memory.", ENOMEM); - return ENOMEM; - } - - new_ra->storage = NULL; - new_ra->elsize = elemsz; - new_ra->size = 0; - new_ra->grow_by = grow_by; - new_ra->len = 0; - new_ra->refcount = 1; - new_ra->cb = cb; - new_ra->cb_data = data; - - *ra = new_ra; - - TRACE_FLOW_STRING("ref_array_create", "Exit"); - return EOK; -} - -/* Get new reference to an array */ -struct ref_array *ref_array_getref(struct ref_array *ra) -{ - TRACE_FLOW_STRING("ref_array_getref", "Entry"); - - /* Check if array is not NULL */ - if (ra) { - TRACE_INFO_NUMBER("Increasing reference count. Current: ", ra->refcount); - /* Increase reference count */ - ra->refcount++; - TRACE_INFO_NUMBER("Increased reference count. New: ", ra->refcount); - - } - else { - TRACE_ERROR_STRING("Uninitialized array.", "Returning NULL"); - } - - TRACE_FLOW_STRING("ref_array_getref", "Exit"); - return ra; -} - -/* Delete the array */ -void ref_array_destroy(struct ref_array *ra) -{ - int idx; - - TRACE_FLOW_STRING("ref_array_destroy", "Entry"); - - /* Check if array is not NULL */ - if (!ra) { - TRACE_ERROR_STRING("Uninitialized array.", "Coding error???"); - return; - } - - TRACE_INFO_NUMBER("Current reference count: ", ra->refcount); - if (ra->refcount) { - /* Decrease reference count */ - ra->refcount--; - if (ra->refcount == 0) { - TRACE_INFO_NUMBER("It is time to delete array. Count:", ra->refcount); - if (ra->cb) { - for (idx = 0; idx < ra->len; idx++) { - ra->cb((unsigned char *)(ra->storage) + idx * ra->elsize, - REF_ARRAY_DESTROY, ra->cb_data); - } - } - free(ra->storage); - free(ra); - } - } - else { - /* Should never be here... - * This can happen if the caller by mistake would try to - * destroy the object from within the callback. Brrr.... - */ - TRACE_ERROR_STRING("Reference count is 0.", "Coding error???"); - } - - TRACE_FLOW_STRING("ref_array_destroy", "Exit"); -} - -/* Add new element to the array */ -int ref_array_append(struct ref_array *ra, void *element) -{ - int error = EOK; - - TRACE_FLOW_STRING("ref_array_append", "Entry"); - if ((!ra) || (!element)) { - TRACE_ERROR_NUMBER("Uninitialized argument.", EINVAL); - return EINVAL; - } - - /* Do we have enough room for a new element? */ - if (ra->size == ra->len) { - error = ref_array_grow(ra); - if (error) { - TRACE_ERROR_NUMBER("Failed to grow array.", error); - return error; - } - } - - /* Copy element */ - memcpy((unsigned char *)(ra->storage) + ra->len * ra->elsize, - element, - ra->elsize); - - ra->len++; - - TRACE_FLOW_STRING("ref_array_append", "Exit"); - return error; -} - -/* Get element */ -void *ref_array_get(struct ref_array *ra, uint32_t idx, void *acptr) -{ - TRACE_FLOW_STRING("ref_array_get", "Entry"); - - if (!ra) { - TRACE_ERROR_STRING("Uninitialized argument.", ""); - return NULL; - } - - if (idx >= ra->len) { - TRACE_ERROR_NUMBER("Invalid idx.", idx); - return NULL; - } - - TRACE_INFO_NUMBER("Index: ", idx); - - if (acptr) { - - TRACE_INFO_STRING("Copying data.", ""); - memcpy(acptr, - (unsigned char *)(ra->storage) + idx * ra->elsize, - ra->elsize); - - } - - TRACE_FLOW_STRING("ref_array_get returning internal storage", "Exit"); - return (unsigned char *)(ra->storage) + idx * ra->elsize; -} - - -/* Get length */ -int ref_array_getlen(struct ref_array *ra, uint32_t *len) -{ - TRACE_FLOW_STRING("ref_array_getlen", "Entry"); - - if ((!ra) || (!len)) { - TRACE_ERROR_STRING("Uninitialized argument.", ""); - return EINVAL; - } - - *len = ra->len; - - TRACE_FLOW_STRING("ref_array_getlen", "Exit"); - return EOK; -} - -/* Alternative function to get length */ -uint32_t ref_array_len(struct ref_array *ra) -{ - TRACE_FLOW_STRING("ref_array_len", "Entry"); - - if (!ra) { - TRACE_ERROR_STRING("Uninitialized argument.", ""); - errno = EINVAL; - return 0; - } - - TRACE_FLOW_STRING("ref_array_len", "Exit"); - return ra->len; -} - - -/* Insert a new element into the array */ -int ref_array_insert(struct ref_array *ra, - uint32_t idx, - void *element) -{ - int error = EOK; - uint32_t i; - - TRACE_FLOW_STRING("ref_array_insert", "Entry"); - - if ((!ra) || (!element)) { - TRACE_ERROR_NUMBER("Uninitialized argument.", EINVAL); - return EINVAL; - } - - if (idx > ra->len) { - TRACE_ERROR_NUMBER("Index is out of range", ERANGE); - return ERANGE; - } - - /* Do we have enough room for a new element? */ - if (ra->size == ra->len) { - error = ref_array_grow(ra); - if (error) { - TRACE_ERROR_NUMBER("Failed to grow array.", error); - return error; - } - } - - /* Shift elements right */ - for (i = ra->len; i >= (idx + 1); i--) { - memcpy((unsigned char *)(ra->storage) + i * ra->elsize, - (unsigned char *)(ra->storage) + (i - 1) * ra->elsize, - ra->elsize); - } - - /* Overwrite element */ - memcpy((unsigned char *)(ra->storage) + idx * ra->elsize, - element, - ra->elsize); - - ra->len++; - - TRACE_FLOW_STRING("ref_array_insert", "Exit"); - return error; - -} - - -/* Replace element in the array */ -int ref_array_replace(struct ref_array *ra, - uint32_t idx, - void *element) -{ - int error = EOK; - - TRACE_FLOW_STRING("ref_array_replace", "Entry"); - - if ((!ra) || (!element)) { - TRACE_ERROR_NUMBER("Uninitialized argument.", EINVAL); - return EINVAL; - } - - if (idx > ra->len) { - TRACE_ERROR_NUMBER("Index is out of range", ERANGE); - return ERANGE; - } - - /* Clear old element */ - ra->cb((unsigned char *)(ra->storage) + idx * ra->elsize, - REF_ARRAY_DELETE, ra->cb_data); - - /* Overwrite element */ - memcpy((unsigned char *)(ra->storage) + idx * ra->elsize, - element, - ra->elsize); - - - TRACE_FLOW_STRING("ref_array_replace", "Exit"); - return error; -} - - -/* Remove element from the array */ -int ref_array_remove(struct ref_array *ra, - uint32_t idx) -{ - int error = EOK; - uint32_t i; - - TRACE_FLOW_STRING("ref_array_remove", "Entry"); - - if (!ra) { - TRACE_ERROR_NUMBER("Uninitialized argument.", EINVAL); - return EINVAL; - } - - if (idx >= ra->len) { - TRACE_ERROR_NUMBER("Index is out of range", ERANGE); - return ERANGE; - } - - /* Clear old element */ - ra->cb((unsigned char *)(ra->storage) + idx * ra->elsize, - REF_ARRAY_DELETE, ra->cb_data); - - /* Shift elements left */ - for (i = idx + 1; i < ra->len; i++) { - memcpy((unsigned char *)(ra->storage) + (i - 1) * ra->elsize, - (unsigned char *)(ra->storage) + i * ra->elsize, - ra->elsize); - } - - ra->len--; - - TRACE_FLOW_STRING("ref_array_remove", "Exit"); - return error; -} - -/* Reset array */ -void ref_array_reset(struct ref_array *ra) -{ - int idx; - - TRACE_FLOW_STRING("ref_array_reset", "Entry"); - - /* Check if array is not NULL */ - if (!ra) { - TRACE_ERROR_STRING("Uninitialized array.", "Coding error???"); - return; - } - - if (ra->cb) { - for (idx = 0; idx < ra->len; idx++) { - ra->cb((unsigned char *)(ra->storage) + idx * ra->elsize, - REF_ARRAY_DESTROY, ra->cb_data); - } - } - - free(ra->storage); - ra->storage = NULL; - ra->size = 0; - ra->len = 0; - - TRACE_FLOW_STRING("ref_array_reset", "Exit"); -} - -/* Swap two elements in the array */ -int ref_array_swap(struct ref_array *ra, - uint32_t idx1, - uint32_t idx2) -{ - int error = EOK; - void *temp = NULL; - - TRACE_FLOW_STRING("ref_array_swap", "Entry"); - - if (!ra) { - TRACE_ERROR_NUMBER("Uninitialized argument.", EINVAL); - return EINVAL; - } - - if ((idx1 >= ra->len) || - (idx2 >= ra->len)) { - TRACE_ERROR_NUMBER("Index is out of range", ERANGE); - return ERANGE; - } - - if (idx1 == idx2) { - TRACE_FLOW_STRING("ref_array_swap", "Noop return"); - return EOK; - } - - temp = malloc(ra->elsize); - if (!temp) { - TRACE_FLOW_STRING("Failed to allocate memory for temp storage.", ""); - return ENOMEM; - } - - memcpy(temp, - (unsigned char *)(ra->storage) + idx2 * ra->elsize, - ra->elsize); - memcpy((unsigned char *)(ra->storage) + idx2 * ra->elsize, - (unsigned char *)(ra->storage) + idx1 * ra->elsize, - ra->elsize); - memcpy((unsigned char *)(ra->storage) + idx1 * ra->elsize, - temp, - ra->elsize); - - free(temp); - - TRACE_FLOW_STRING("ref_array_swap", "Exit"); - return error; -} - -/* Debug function */ -void ref_array_debug(struct ref_array *ra) -{ - int i,j; - - printf("\nARRAY DUMP START\n"); - printf("Length = %u\n", ra->len); - printf("Size = %u\n", ra->size); - printf("Element = %u\n", (unsigned int)(ra->elsize)); - printf("Grow by = %u\n", ra->grow_by); - printf("Count = %u\n", ra->refcount); - printf("ARRAY:\n"); - for (i = 0; i < ra->len; i++) { - for (j = 0; j < ra->elsize; j++) { - printf("%x", *((unsigned char *)(ra->storage) + i * ra->elsize + j)); - } - printf("\n%s\n", *((char **)((unsigned char *)(ra->storage) + i * ra->elsize))); - } - printf("\nARRAY DUMP END\n\n"); -} diff --git a/common/refarray/ref_array.cfg.doxy.in b/common/refarray/ref_array.cfg.doxy.in deleted file mode 100644 index 455db0a94..000000000 --- a/common/refarray/ref_array.cfg.doxy.in +++ /dev/null @@ -1,1566 +0,0 @@ -# Doxyfile 1.6.3 - -# 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 = "libref_array" - -# 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 = @PACKAGE_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 = doc - -# 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 = YES - -# 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 = "The $name class" \ - "The $name widget" \ - "The $name file" \ - is \ - provides \ - specifies \ - contains \ - represents \ - a \ - an \ - the - -# 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 = YES - -# 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 = NO - -# 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 = NO - -# 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 = YES - -# 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 = YES - -# 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 = NO - -# 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 = YES - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen -# will list include files with double quotes in the documentation -# rather than with sharp brackets. - -FORCE_LOCAL_INCLUDES = 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 = NOGENERATE MAN - -# 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 = NO - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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 = NO - -# 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 = @srcdir@ - -# 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 = *.c *.h - -# 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 = *_ut.c config.h - -# 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 = - -# 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 - -# If the HTML_FOOTER_DESCRIPTION tag is set to YES, Doxygen will -# add generated date, project name and doxygen version to HTML footer. - -HTML_FOOTER_DESCRIPTION= NO - -# 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_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting -# this to NO can help when comparing the output of multiple runs. - -HTML_TIMESTAMP = YES - -# 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 = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files -# will be generated, which together with the HTML files, form an Eclipse help -# plugin. To install this plugin and make it available under the help contents -# menu in Eclipse, the contents of the directory containing the HTML and XML -# files needs to be copied into the plugins directory of eclipse. The name of -# the directory within the plugins directory should be the same as -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before the help appears. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have -# this name. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# 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 enabled 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), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) there is already a search function so this one should -# typically be disabled. For large projects the javascript based search engine -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. - -SEARCHENGINE = YES - -# When the SERVER_BASED_SEARCH tag is enabled the search engine will be implemented using a PHP enabled web server instead of at the web client using Javascript. Doxygen will generate the search PHP script and index -# file to put on the web server. The advantage of the server based approach is that it scales better to large projects and allows full text search. The disadvances is that it is more difficult to setup -# and does not have live searching capabilities. - -SERVER_BASED_SEARCH = 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. -# Note that when enabling USE_PDFLATEX this option is only used for -# generating bitmaps for formulas in the HTML output, but not in the -# Makefile that is written to the output directory. - -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 = YES - -# 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 = YES - -# 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 = NO - -# 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 = YES - -# 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 = YES - -# 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 = NO - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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 = YES - -# 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/common/refarray/ref_array.h b/common/refarray/ref_array.h deleted file mode 100644 index 4b4b2de6b..000000000 --- a/common/refarray/ref_array.h +++ /dev/null @@ -1,321 +0,0 @@ -/* - REF ARRAY - - Header file for of the dynamic array with reference count. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - You should have received a copy of the GNU General Public License - along with this program. If not, see <http://www.gnu.org/licenses/>. -*/ - -#ifndef REF_ARRAY_H -#define REF_ARRAY_H - -#include <stdint.h> -#include <stdlib.h> - -struct ref_array; - -#ifndef EOK -#define EOK 0 -#endif - -/** @mainpage The Referenced Array Interface - * - * The referenced array interface is a dynamically allocated - * array of data of any type. The array can be shared by - * multiple objects to avoid data duplication. - * - * The array is created once and then any number of - * the references can be requested. The references are pointers - * to the array. Each reference must be freed after use. - * Freeing last reference to the array would free the array's storage. - * - * The array does not have any knowledge of the data type - * of the actual data stored in the array. All elements of the array - * are of the same size as prescribed by caller when the array is created. - * The caller can potentially mix different types of data in the array - * but this should be done with caution. - * - * At the moment the interface is not complete. - * It provides basic functionality required to support other - * components. In future it might make sense to add entry points - * to insert and delete elements from the array. - * Current use cases do not require this kind of - * functionality so it is left out of the implementation. - * - */ - -/** - * @defgroup ref_array Interface - * @{ - */ - -/** - * @brief Enumeration of the delete modes - * - * When the array is destroyed each element of the array - * most likely needs to be freed. Same is true when an element - * is removed from the array. However the caller might need - * to do different things with the data depending on whether - * the array is destroyed or whether the element is removed. - * This enumeration defines constants that you used to indicate - * which operation was performed. - */ -typedef enum -{ - REF_ARRAY_DESTROY, - REF_ARRAY_DELETE, -} ref_array_del_enum; - - -/** - * @brief Element cleanup callback - * - * Callback that can be provided by a caller - * to free data when the storage is actually destroyed. - */ -typedef void (*ref_array_fn)(void *elem, - ref_array_del_enum type, - void *data); - - -/** - * @brief Create referenced array - * - * @param[out] ra Newly created array object. - * @param[in] elem Element size in bytes. - * @param[in] grow_by Defines how many elements - * should be allocated together - * as one chunk. - * @param[in] cb Cleanup callback. - * @param[in] data Caller supplied data - * passed to cleanup callback. - * - * @return 0 - Success. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - */ -int ref_array_create(struct ref_array **ra, - size_t elem, - uint32_t grow_by, - ref_array_fn cb, - void *data); - -/** - * @brief Get new reference to an array - * - * @param[in] ra Existing array object. - * - * @return A new reference to an array object. - * @return NULL - Invalid argument. - */ -struct ref_array *ref_array_getref(struct ref_array *ra); - -/** - * @brief Delete the array - * - * @param[in] ra Existing array object - * or a reference. - * - */ -void ref_array_destroy(struct ref_array *ra); - -/** - * @brief Add new element to the array - * - * Appends an element to the end of the array. - * - * @param[in] ra Existing array object. - * @param[in] element Pointer to data. - * The number of bytes - * defined at the array creation - * as the array size will be copied - * into the array element. - * - * @return 0 - Success. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - */ -int ref_array_append(struct ref_array *ra, void *element); - -/** - * @brief Get element data - * - * Retrieves data from the array element. - * - * @param[in] ra Existing array object. - * @param[in] idx Index of the array element. - * @param[in] acptr Pointer to the memory - * where the element's data - * will be copied. Can be NULL. - * In this case nothing is copied. - * - * @return Pointer to the data stored in the element. - * Conventionally it should be a const pointer, - * however such declaration would make using - * variable that receives the result of this - * function immutable. This is very inconvenient - * because such variable should be able to - * point to data related to multiple elements - * of the array. - * - * @return Pointer to the element's data. - * @return NULL if index is out of range. - */ -void *ref_array_get(struct ref_array *ra, uint32_t idx, void *acptr); - -/** - * @brief Get array length - * - * Determines length of the array. - * - * @param[in] ra Existing array object. - * @param[out] len Variable will receive - * the length of the array. - * - * @return 0 - Success. - * @return EINVAL - Invalid argument. - */ -int ref_array_getlen(struct ref_array *ra, uint32_t *len); - -/** - * @brief Array length - * - * Alternative function to get length. - * - * @param[in] ra Existing array object. - * - * @return Length of the array. Returns 0 if the array is invalid. - */ -uint32_t ref_array_len(struct ref_array *ra); - -/** - * @brief Insert a new element into the array - * - * Inserts an element into the array. - * If idx is 0 the element will be added - * to the beginning of the array, - * if idx is 1 the element will be added - * after the first element of the array - * and so on. - * If index is greater than the number of - * elements in the array the function - * returns error. - * - * @param[in] ra Existing array object. - * @param[in] idx Index of the array element. - * @param[in] element Pointer to data. - * The number of bytes - * defined at the array creation - * as the array size will be copied - * into the array element. - * - * @return 0 - Success. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - * @return ERANGE - Index is our of range. - */ -int ref_array_insert(struct ref_array *ra, - uint32_t idx, - void *element); -/** - * @brief Replace element in the array - * - * Replace an element of the array - * identified by index with a new value. - * If index is greater than the number of - * elements in the array the function - * returns error. - * - * @param[in] ra Existing array object. - * @param[in] idx Index of the array element. - * @param[in] element Pointer to data. - * The number of bytes - * defined at the array creation - * as the array size will be copied - * into the array element. - * - * @return 0 - Success. - * @return ENOMEM - No memory. - * @return EINVAL - Invalid argument. - * @return ERANGE - Index is our of range. - */ -int ref_array_replace(struct ref_array *ra, - uint32_t idx, - void *element); - - -/** - * @brief Remove element from the array - * - * The element is removed and the length - * is decreased by 1. - * If index is greater than the number of - * elements in the array the function - * returns error. - * - * @param[in] ra Existing array object. - * @param[in] idx Index of the array element. - * - * @return 0 - Success. - * @return EINVAL - Invalid argument. - * @return ERANGE - Index is our of range. - */ -int ref_array_remove(struct ref_array *ra, - uint32_t idx); - - -/** - * @brief Swap two elements in the array - * - * If any of the indexes is greater than - * the number of elements in the array - * the function returns error. - * - * @param[in] ra Existing array object. - * @param[in] idx1 Index of the array element. - * @param[in] idx2 Index of the array element. - * - * @return 0 - Success. - * @return EINVAL - Invalid argument. - * @return ERANGE - Index is our of range. - * @return ENOMEM - No memory. - */ -int ref_array_swap(struct ref_array *ra, - uint32_t idx1, - uint32_t idx2); - - -/** - * @brief Reset array - * - * Function clears all contents without destroying - * the object. The delete callback will be called - * for every element of the array from the beginning - * to the end passing in REF_ARRAY_DESTROY value. - * All the storage for the array will be deallocated. - * After the call the array will be empty as if just created. - * - * - * @param[in] ra Existing array object. - * No return value. - * - */ -void ref_array_reset(struct ref_array *ra); - -/** - * @} - */ - - -#endif diff --git a/common/refarray/ref_array.pc.in b/common/refarray/ref_array.pc.in deleted file mode 100644 index c4fe94141..000000000 --- a/common/refarray/ref_array.pc.in +++ /dev/null @@ -1,11 +0,0 @@ -prefix=@prefix@ -exec_prefix=@exec_prefix@ -libdir=@libdir@ -includedir=@includedir@ - -Name: @PACKAGE_NAME@ -Description: A dynamically-growing, reference-counted array -Version: @PACKAGE_VERSION@ -Libs: -L${libdir} -lref_array -Cflags: -I${includedir} -URL: http://fedorahosted.org/sssd/ diff --git a/common/refarray/ref_array_ut.c b/common/refarray/ref_array_ut.c deleted file mode 100644 index 6e6009a0a..000000000 --- a/common/refarray/ref_array_ut.c +++ /dev/null @@ -1,595 +0,0 @@ -/* - REF ARRAY - - Implementation of the dynamic array with reference count. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - You should have received a copy of the GNU General Public License - along with this program. If not, see <http://www.gnu.org/licenses/>. -*/ - -#define _GNU_SOURCE -#include <errno.h> /* for errors */ -#include <stdint.h> -#include <stdio.h> -#include <string.h> -#include <stdlib.h> - -#include "ref_array.h" -#include "config.h" -#define TRACE_HOME -#include "trace.h" - -int verbose = 0; - -#define RAOUT(foo) \ - do { \ - if (verbose) foo; \ - } while(0) - -extern void ref_array_debug(struct ref_array *ra); - -typedef int (*test_fn)(void); - -/* Basic test */ -int ref_array_basic_test(void) -{ - const char *line1 = "line1"; - const char *line2 = "line2"; - const char *line3 = "line3"; - const char *line4 = "line4"; - const char *line5 = "line5"; - const char *line6 = "line6"; - uint32_t i; - struct ref_array *ra; - struct ref_array *ra2; - int error = EOK; - uint32_t len = 0; - uint32_t other_len = 0; - char *ret; - char *elem; - void *ptr; - - error = ref_array_create(&ra, sizeof(char *), 1, NULL, NULL); - if (error) { - printf("Failed to create array %d\n", error); - return error; - } - - RAOUT(ref_array_debug(ra)); - - error = ref_array_append(ra, &line1); - if (error) { - ref_array_destroy(ra); - printf("Failed to append to array line 1 %d\n", error); - return error; - } - - RAOUT(ref_array_debug(ra)); - - error = ref_array_append(ra, &line2); - if (error) { - ref_array_destroy(ra); - printf("Failed to append to array line 2 %d\n", error); - return error; - } - - RAOUT(ref_array_debug(ra)); - - error = ref_array_append(ra, &line3); - if (error) { - ref_array_destroy(ra); - printf("Failed to append to array line 3 %d\n", error); - return error; - } - - RAOUT(ref_array_debug(ra)); - - error = ref_array_append(ra, &line4); - if (error) { - ref_array_destroy(ra); - printf("Failed to append to array line 4 %d\n", error); - return error; - } - - RAOUT(ref_array_debug(ra)); - - error = ref_array_append(ra, &line5); - if (error) { - ref_array_destroy(ra); - printf("Failed to append to array line 5 %d\n", error); - return error; - } - - RAOUT(ref_array_debug(ra)); - - error = ref_array_append(ra, &line6); - if (error) { - ref_array_destroy(ra); - printf("Failed to append to array line 6 %d\n", error); - return error; - } - - RAOUT(ref_array_debug(ra)); - - RAOUT(printf("\n\nTest 1 - Printing lines.\n\n")); - - error = ref_array_getlen(ra, &other_len); - if (error) { - ref_array_destroy(ra); - printf("Failed to get length %d\n", error); - return error; - } - - len = ref_array_len(ra); - - if (len != other_len) { - ref_array_destroy(ra); - printf("Lengths do not match:\n"); - printf("Len : %d\n", len); - printf("Get Len: %d\n", other_len); - return EFAULT; - } - - for (i = 0; i < len; i++) { - ref_array_get(ra, i, &ret); - RAOUT(printf("%s\n", ret)); - } - - RAOUT(printf("\n\nTest 2 - Creating reference and then printing lines.\n\n")); - - ra2 = ref_array_getref(ra); - ref_array_destroy(ra); - - for (i = 0; i < len; i++) { - ret = *((char **)ref_array_get(ra2, i, NULL)); - RAOUT(printf("%s\n", ret)); - } - - RAOUT(printf("\n\nTest 3 - Get elements with copying.\n\n")); - - for (i = 0; i < len; i++) { - ref_array_get(ra2, i, &ret); - RAOUT(printf("%s\n", ret)); - } - - RAOUT(printf("\n\nTest 4a - Get elements with copying and assignment.\n\n")); - - /* This is a bad practice to use one variable - * as a parameter and as an acceptor for the return value. - * See next example for a better way to do it. - */ - for (i = 0; i < len; i++) { - ret = *((char **)ref_array_get(ra2, i, &ret)); - RAOUT(printf("%s\n", ret)); - } - - RAOUT(printf("\n\nTest 4b - Get elements with copying and assignment.\n\n")); - - for (i = 0; i < len; i++) { - ret = *((char **)ref_array_get(ra2, i, &elem)); - RAOUT(printf("%s\n", ret)); - RAOUT(printf("%s\n", elem)); - if (strcmp(ret, elem) != 0) { - ref_array_destroy(ra2); - printf("\nRetrieved strings were expected to be same,\n"); - printf("but they are not:\n"); - printf("By pointer:[%s]\nAs element:[%s]\n", ret, elem); - return EFAULT; - } - } - - RAOUT(printf("\n\nTest 5 - While loop up.\n\n")); - - i = 0; - for (;;) { - ptr = ref_array_get(ra2, i, &ret); - if (ptr) { - RAOUT(printf("%s\n", ret)); - i++; - } - else break; - } - - RAOUT(printf("\n\nTest 6 - While loop down.\n\n")); - - i = len - 1; - for (;;) { - ptr = ref_array_get(ra2, i, &ret); - if (ptr) { - RAOUT(printf("%s\n", ret)); - i--; - } - else break; - } - - RAOUT(printf("\n\nDone!!!\n\n")); - - ref_array_destroy(ra2); - return EOK; -} - -void array_cleanup(void *elem, - ref_array_del_enum type, - void *data) -{ - RAOUT(printf("%s%s\n", (char *)data, *((char **)elem))); - free(*((char **)elem)); -} - -/* Free test */ -int ref_array_free_test(void) -{ - const char *line1 = "line1"; - const char *line2 = "line2"; - const char *line3 = "line3"; - const char *line4 = "line4"; - char text[] = "Deleting: "; - char *str; - uint32_t i; - struct ref_array *ra; - int error = EOK; - char *ret; - void *ptr; - - error = ref_array_create(&ra, sizeof(char *), 1, array_cleanup, (char *)text); - if (error) { - printf("Failed to create array %d\n", error); - return error; - } - - RAOUT(ref_array_debug(ra)); - - str = strdup(line1); - - error = ref_array_append(ra, &str); - if (error) { - ref_array_destroy(ra); - printf("Failed to append to array line 1 %d\n", error); - return error; - } - - RAOUT(ref_array_debug(ra)); - - str = strdup(line2); - - error = ref_array_append(ra, &str); - if (error) { - ref_array_destroy(ra); - printf("Failed to append to array line 2 %d\n", error); - return error; - } - - RAOUT(ref_array_debug(ra)); - - str = strdup(line3); - - error = ref_array_append(ra, &str); - if (error) { - ref_array_destroy(ra); - printf("Failed to append to array line 3 %d\n", error); - return error; - } - - RAOUT(ref_array_debug(ra)); - - str = strdup(line4); - - error = ref_array_append(ra, &str); - if (error) { - ref_array_destroy(ra); - printf("Failed to append to array line 4 %d\n", error); - return error; - } - - RAOUT(ref_array_debug(ra)); - - i = 0; - for (;;) { - ptr = ref_array_get(ra, i, &ret); - if (ptr) { - RAOUT(printf("%s\n", ret)); - i++; - } - else break; - } - - RAOUT(printf("\n\nDone!!!\n\n")); - - ref_array_destroy(ra); - return EOK; -} - -int ref_array_adv_test(void) -{ - int error = EOK; - const char *lines[] = { "line0", - "line1", - "line2", - "line3", - "line4", - "line5", - "line6", - "line7", - "line8", - "line9" }; - char text[] = "Deleting: "; - char *str; - uint32_t i; - struct ref_array *ra; - char *ret; - void *ptr; - int expected[] = { 0, 1, 7, 8, 9 }; - int expected2[] = { 1, 7, 8, 9, 0 }; - - error = ref_array_create(&ra, - sizeof(char *), - 1, - array_cleanup, - (char *)text); - if (error) { - printf("Failed to create array %d\n", error); - return error; - } - - for (i = 0; i < 5;i++) { - - str = strdup(lines[i]); - - error = ref_array_append(ra, &str); - if (error) { - ref_array_destroy(ra); - printf("Failed to append line %d, error %d\n", - i, error); - return error; - } - } - - RAOUT(printf("\nInitial array.\n")); - - i = 0; - for (;;) { - ptr = ref_array_get(ra, i, &ret); - if (ptr) { - RAOUT(printf("%s\n", ret)); - i++; - } - else break; - } - - - /* Try to remove invalid entry */ - error = ref_array_remove(ra, 1000); - if (error != ERANGE) { - ref_array_destroy(ra); - printf("Removing entry expected error got success.\n"); - return -1; - } - - /* Try to insert invalid entry */ - error = ref_array_insert(ra, 1000, &text); - if (error != ERANGE) { - ref_array_destroy(ra); - printf("Inserting entry expected error got success.\n"); - return -1; - } - - /* Try to replace invalid entry */ - error = ref_array_replace(ra, 1000, &text); - if (error != ERANGE) { - ref_array_destroy(ra); - printf("Replacing entry expected error got success.\n"); - return -1; - } - - /* Insert several entries */ - for (i = 9; i > 4; i--) { - - str = strdup(lines[i]); - - error = ref_array_insert(ra, 9 - i, &str); - if (error) { - ref_array_destroy(ra); - free(str); - printf("Failed to insert line %d, error %d\n", - i, error); - return error; - } - } - - /* Displpay array contents */ - RAOUT(printf("\nArray with inserted values.\n")); - i = 0; - for (;;) { - ptr = ref_array_get(ra, i, &ret); - if (ptr) { - RAOUT(printf("%s\n", ret)); - i++; - } - else break; - } - - /* Replace everything */ - for (i = 0; i < 10;i++) { - - str = strdup(lines[i]); - - error = ref_array_replace(ra, i, &str); - if (error) { - ref_array_destroy(ra); - free(str); - printf("Failed to replace line %d, error %d\n", - i, error); - return error; - } - } - - /* Displpay array contents */ - RAOUT(printf("\nArray with replaced values.\n")); - i = 0; - for (;;) { - ptr = ref_array_get(ra, i, &ret); - if (ptr) { - RAOUT(printf("%s\n", ret)); - i++; - } - else break; - } - - /* Reset */ - ref_array_reset(ra); - - /* Displpay array contents */ - RAOUT(printf("\nEmpty array.\n")); - i = 0; - for (;;) { - ptr = ref_array_get(ra, i, &ret); - if (ptr) { - RAOUT(printf("%s\n", ret)); - i++; - } - else break; - } - - /* Add everything */ - for (i = 0; i < 10;i++) { - - str = strdup(lines[i]); - - error = ref_array_insert(ra, i, &str); - if (error) { - ref_array_destroy(ra); - free(str); - printf("Failed to insert into array %d\n", error); - return error; - } - } - - /* Displpay array contents */ - RAOUT(printf("\nAll added back.\n")); - i = 0; - for (;;) { - ptr = ref_array_get(ra, i, &ret); - if (ptr) { - RAOUT(printf("%s\n", ret)); - i++; - } - else break; - } - - /* Remove part */ - for (i = 0; i < 5;i++) { - - error = ref_array_remove(ra, 2); - if (error) { - ref_array_destroy(ra); - printf("Failed to remive item from array %d\n", error); - return error; - } - } - - /* Displpay array contents */ - RAOUT(printf("\nCleaned array.\n")); - i = 0; - for (;;) { - ptr = ref_array_get(ra, i, &ret); - if (ptr) { - RAOUT(printf("%s\n", ret)); - i++; - } - else break; - } - - RAOUT(printf("\n\nChecking for expected contents\n\n")); - - i = 0; - for (;;) { - ptr = ref_array_get(ra, i, &ret); - if (ptr) { - RAOUT(printf("Comparing:\n[%s]\n[%s]\n\n", - ret, lines[expected[i]])); - if (strcmp(ret, lines[expected[i]]) != 0) { - printf("Unexpected contents of the array.\n"); - ref_array_destroy(ra); - return -1; - } - i++; - } - else break; - } - - RAOUT(printf("\n\nSwap test\n\n")); - - if ((error = ref_array_swap(ra, 0, 1)) || - (error = ref_array_swap(ra, 1, 2)) || - (error = ref_array_swap(ra, 2, 3)) || - (error = ref_array_swap(ra, 3, 4))) { - ref_array_destroy(ra); - printf("Failed to to swap %d\n", error); - return error; - } - - i = 0; - for (;;) { - ptr = ref_array_get(ra, i, &ret); - if (ptr) { - RAOUT(printf("Comparing:\n[%s]\n[%s]\n\n", - ret, lines[expected2[i]])); - if (strcmp(ret, lines[expected2[i]]) != 0) { - printf("Unexpected contents of the array.\n"); - ref_array_destroy(ra); - return -1; - } - i++; - } - else break; - } - - RAOUT(printf("\n\nDone!!!\n\n")); - - ref_array_destroy(ra); - return EOK; -} - - - -/* Main function of the unit test */ -int main(int argc, char *argv[]) -{ - int error = 0; - test_fn tests[] = { ref_array_basic_test, - ref_array_free_test, - ref_array_adv_test, - NULL }; - test_fn t; - int i = 0; - char *var; - - if ((argc > 1) && (strcmp(argv[1], "-v") == 0)) verbose = 1; - else { - var = getenv("COMMON_TEST_VERBOSE"); - if (var) verbose = 1; - } - - RAOUT(printf("Start\n")); - - while ((t = tests[i++])) { - error = t(); - if (error) { - RAOUT(printf("Failed with error %d!\n", error)); - return error; - } - } - - RAOUT(printf("Success!\n")); - return 0; -} diff --git a/common/trace/Makefile.am b/common/trace/Makefile.am deleted file mode 100644 index b097ff203..000000000 --- a/common/trace/Makefile.am +++ /dev/null @@ -1,3 +0,0 @@ -dist_noinst_HEADERS = trace.h - -tests: all diff --git a/common/trace/trace.h b/common/trace/trace.h deleted file mode 100644 index 04aa5c8b8..000000000 --- a/common/trace/trace.h +++ /dev/null @@ -1,159 +0,0 @@ -/* - COMMON TRACE - - Common header file for tracing. - - Copyright (C) Dmitri Pal <dpal@redhat.com> 2009 - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 3 of the License, or - (at your option) any later version. - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - You should have received a copy of the GNU General Public License - along with this program. If not, see <http://www.gnu.org/licenses/>. -*/ - -#ifndef COMMON_TRACE_H -#define COMMON_TRACE_H - -#ifdef TRACE_LEVEL -#define HAVE_TRACE -#include <stdio.h> - -/* The trace level is a bit mask */ -#define TRACE_FLOW 0x0000001 /* - trace messages that are entry exit into functions */ -#define TRACE_ERROR 0x0000002 /* - trace messages that are errors */ -#define TRACE_INFO 0x0000004 /* - trace things that are informational */ - - -#ifdef TRACE_HOME /* Define this in the module that contains main */ -unsigned trace_level = TRACE_LEVEL; -#else -extern unsigned trace_level; -#endif /* TRACE_HOME */ -#endif /* TRACE_LEVEL */ - - - -#ifdef HAVE_TRACE -/* Tracing strings */ -#define TRACE_STRING(level, msg, str) \ - do { \ - if (level & trace_level) { \ - printf("[DEBUG] %40s (%4d) %s%s %s\n", \ - __FILE__, __LINE__, \ - (level == TRACE_ERROR) ? "ERROR-> " : "", \ - (msg != NULL) ? msg : "MISSING MESSAGE", \ - (str != NULL) ? str : "(null)"); \ - } \ - } while(0) - -/* Tracing unsigned numbers */ -#define TRACE_NUMBER(level, msg, num) \ - do { \ - if (level & trace_level) { \ - printf("[DEBUG] %40s (%4d) %s%s %lu\n", \ - __FILE__, __LINE__, \ - (level == TRACE_ERROR) ? "ERROR-> " : "", \ - (msg != NULL) ? msg : "MISSING MESSAGE", \ - (unsigned long int)(num)); \ - } \ - } while(0) - -/* Tracing signed numbers */ -#define TRACE_SNUMBER(level, msg, num) \ - do { \ - if (level & trace_level) { \ - printf("[DEBUG] %40s (%4d) %s%s %ld\n", \ - __FILE__, __LINE__, \ - (level == TRACE_ERROR) ? "ERROR-> " : "", \ - (msg != NULL) ? msg : "MISSING MESSAGE", \ - (long int)(num)); \ - } \ - } while(0) - -/* Tracing long numbers */ -#define TRACE_LNUMBER(level, msg, num) \ - do { \ - if (level & trace_level) { \ - printf("[DEBUG] %40s (%4d) %s%s %llu\n", \ - __FILE__, __LINE__, \ - (level == TRACE_ERROR) ? "ERROR-> " : "", \ - (msg != NULL) ? msg : "MISSING MESSAGE", \ - (unsigned long long int)(num)); \ - } \ - } while(0) - -/* Tracing signed long numbers */ -#define TRACE_SLNUMBER(level, msg, num) \ - do { \ - if (level & trace_level) { \ - printf("[DEBUG] %40s (%4d) %s%s %lld\n", \ - __FILE__, __LINE__, \ - (level == TRACE_ERROR) ? "ERROR-> " : "", \ - (msg != NULL) ? msg : "MISSING MESSAGE", \ - (long long int)(num)); \ - } \ - } while(0) - -/* Tracing doubles */ -#define TRACE_DOUBLE(level, msg, num) \ - do { \ - if (level & trace_level) { \ - printf("[DEBUG] %40s (%4d) %s%s %e\n", \ - __FILE__, __LINE__, \ - (level == TRACE_ERROR) ? "ERROR-> " : "", \ - (msg != NULL) ? msg : "MISSING MESSAGE", \ - (double)(num)); \ - } \ - } while(0) - -/* Assertion */ -#define TRACE_ASSERT(expression) expression ? : printf("ASSERTION FAILED\n") -#else /* HAVE_TRACE */ - -/* Noop in case the tracing is disabled */ -#define TRACE_STRING(level, msg, str) -#define TRACE_NUMBER(level, msg, num) -#define TRACE_SNUMBER(level, msg, num) -#define TRACE_LNUMBER(level, msg, num) -#define TRACE_SLNUMBER(level, msg, num) -#define TRACE_DOUBLE(level, msg, num) -#endif /* HAVE_TRACE */ - - -/* Convenience wrappers for strings */ -#define TRACE_FLOW_STRING(msg, str) TRACE_STRING(TRACE_FLOW, msg, str) -#define TRACE_ERROR_STRING(msg, str) TRACE_STRING(TRACE_ERROR, msg, str) -#define TRACE_INFO_STRING(msg, str) TRACE_STRING(TRACE_INFO, msg, str) - -/* Convenience wrappers for unsigned numbers */ -#define TRACE_FLOW_NUMBER(msg, num) TRACE_NUMBER(TRACE_FLOW, msg, num) -#define TRACE_ERROR_NUMBER(msg, num) TRACE_NUMBER(TRACE_ERROR, msg, num) -#define TRACE_INFO_NUMBER(msg, num) TRACE_NUMBER(TRACE_INFO, msg, num) - -/* Convenience wrappers for signed numbers */ -#define TRACE_FLOW_SNUMBER(msg, num) TRACE_SNUMBER(TRACE_FLOW, msg, num) -#define TRACE_ERROR_SNUMBER(msg, num) TRACE_SNUMBER(TRACE_ERROR, msg, num) -#define TRACE_INFO_SNUMBER(msg, num) TRACE_SNUMBER(TRACE_INFO, msg, num) - -/* Convenience wrappers for 64-bit long unsigned numbers */ -#define TRACE_FLOW_LNUMBER(msg, num) TRACE_LNUMBER(TRACE_FLOW, msg, num) -#define TRACE_ERROR_LNUMBER(msg, num) TRACE_LNUMBER(TRACE_ERROR, msg, num) -#define TRACE_INFO_LNUMBER(msg, num) TRACE_LNUMBER(TRACE_INFO, msg, num) - -/* Convenience wrappers for 64-bit long signed numbers */ -#define TRACE_FLOW_SLNUMBER(msg, num) TRACE_SLNUMBER(TRACE_FLOW, msg, num) -#define TRACE_ERROR_SLNUMBER(msg, num) TRACE_SLNUMBER(TRACE_ERROR, msg, num) -#define TRACE_INFO_SLNUMBER(msg, num) TRACE_SLNUMBER(TRACE_INFO, msg, num) - -/* Convenience wrappers for numbers */ -#define TRACE_FLOW_DOUBLE(msg, num) TRACE_DOUBLE(TRACE_FLOW, msg, num) -#define TRACE_ERROR_DOUBLE(msg, num) TRACE_DOUBLE(TRACE_ERROR, msg, num) -#define TRACE_INFO_DOUBLE(msg, num) TRACE_DOUBLE(TRACE_INFO, msg, num) - -#endif /* COMMON_TRACE_H */ |