diff options
Diffstat (limited to 'common/ini')
| -rw-r--r-- | common/ini/COPYING | 674 | ||||
| -rw-r--r-- | common/ini/COPYING.LESSER | 165 | ||||
| -rw-r--r-- | common/ini/Makefile.am | 86 | ||||
| -rw-r--r-- | common/ini/configure.ac | 30 | ||||
| -rw-r--r-- | common/ini/ini.conf | 55 | ||||
| -rw-r--r-- | common/ini/ini.d/real.conf | 56 | ||||
| -rw-r--r-- | common/ini/ini.d/test.conf | 41 | ||||
| -rw-r--r-- | common/ini/ini_comment.c | 509 | ||||
| -rw-r--r-- | common/ini/ini_comment.h | 106 | ||||
| -rw-r--r-- | common/ini/ini_comment_ut.c | 176 | ||||
| -rw-r--r-- | common/ini/ini_config.c | 846 | ||||
| -rw-r--r-- | common/ini/ini_config.cfg.doxy.in | 1566 | ||||
| -rw-r--r-- | common/ini/ini_config.h | 1791 | ||||
| -rw-r--r-- | common/ini/ini_config.pc.in | 11 | ||||
| -rw-r--r-- | common/ini/ini_config_ut.c | 1535 | ||||
| -rw-r--r-- | common/ini/ini_defines.h | 74 | ||||
| -rw-r--r-- | common/ini/ini_get_array.c | 356 | ||||
| -rw-r--r-- | common/ini/ini_get_value.c | 589 | ||||
| -rw-r--r-- | common/ini/ini_list.c | 123 | ||||
| -rw-r--r-- | common/ini/ini_metadata.c | 510 | ||||
| -rw-r--r-- | common/ini/ini_metadata.h | 43 | ||||
| -rw-r--r-- | common/ini/ini_parse.c | 190 | ||||
| -rw-r--r-- | common/ini/ini_parse.h | 36 | ||||
| -rw-r--r-- | common/ini/ini_print.c | 387 | ||||
| -rw-r--r-- | common/ini/m4/.dir | 0 |
25 files changed, 0 insertions, 9955 deletions
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 |