commit 7ca8f68987e406632cff47da8a74b6db57b93e91 Author: a-sansara Date: Mon Jul 30 18:25:03 2018 +0200 initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..567609b --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +build/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9cecc1d --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {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 . + +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: + + {project} Copyright (C) {year} {fullname} + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e69de29 diff --git a/build.sh b/build.sh new file mode 100755 index 0000000..b35ada3 --- /dev/null +++ b/build.sh @@ -0,0 +1,16 @@ +#!/bin/bash +DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" +cd "$DIR" +meson --prefix=/usr ./ build +sudo ninja -v install -C build +if [ $? -eq 0 ]; then + echo "== LIB BUILD SUCCESS ==" + valac -v --pkg gee-0.8 --pkg pluie-echo-0.2 --pkg pluie-yaml-0.3 main.vala + if [ $? -eq 0 ]; then + echo "== BUILD SUCCESS ==" + else + echo "== BUILD FAILED ==" + fi +else + echo "== LIB BUILD FAILED ==" +fi diff --git a/build/.gitkeep b/build/.gitkeep new file mode 100644 index 0000000..adfc128 --- /dev/null +++ b/build/.gitkeep @@ -0,0 +1 @@ +# .gitkeep diff --git a/install.vala.in b/install.vala.in new file mode 100644 index 0000000..469711c --- /dev/null +++ b/install.vala.in @@ -0,0 +1,9 @@ +namespace Pluie +{ + namespace Yaml + { + protected const string INSTALL_PATH = "@INSTALL_PATH@"; + protected const string DATA_PATH = "@DATA_PATH@"; + public const string VERSION = "@VERSION@"; + } +} diff --git a/main.vala b/main.vala new file mode 100644 index 0000000..105db6e --- /dev/null +++ b/main.vala @@ -0,0 +1,34 @@ +using GLib; +using Gee; +using Pluie; + +int main (string[] args) +{ + Echo.init(true); + + var path = "resources/test.yml"; + var done = false; + + of.title ("Pluie Yaml Parser", Pluie.Yaml.VERSION, "a-sansara"); + + of.action ("Reading file", path); + of.echo (); + var reader = new Io.Reader (path); + while (reader.readable) { + of.echo ("%s %s".printf ( + of.c (ECHO.DATE ).s ("%03d |".printf (reader.line)), + of.c (ECHO.OPTION_SEP).s (reader.read ())) + ); + } + of.echo ("EOF"); + of.state (true); + + of.action ("Parsing file", path); + var processor = new Yaml.Processor (path); + done = processor.done; + + of.state (done); + of.echo (); + return (int) done; + +} diff --git a/meson.build b/meson.build new file mode 100644 index 0000000..aecb988 --- /dev/null +++ b/meson.build @@ -0,0 +1,73 @@ +project('libpluie-yaml', 'vala', 'c') + +cc = meson.get_compiler('c') +dep_glib = dependency('glib-2.0') +dep_gobject = dependency('gobject-2.0') +dep_gio = dependency('gio-2.0') +dep_gee = dependency('gee-0.8') +dep_echo = dependency('pluie-echo-0.2') +dep_m = cc.find_library('m', required : false) +dep_yaml = cc.find_library('yaml', required : true) + +#~ add_global_link_arguments('-lyaml', language : 'c') + +version = '0.3' +bindir = join_paths(get_option('prefix'), get_option('bindir')) +datadir = join_paths(get_option('prefix'), get_option('datadir'), 'pluie') +libdir = join_paths(get_option('prefix'), get_option('libdir'), 'pkgconfig') +incdir = join_paths(get_option('prefix'), get_option('includedir'), 'pluie') + +conf = configuration_data() +conf.set('VERSION' , version) +conf.set('INSTALL_PATH', bindir) +conf.set('DATA_PATH' , datadir) + +configure_file( + input: 'install.vala.in', + output: 'install.vala', + configuration: conf +) + +sources = [ + 'build/install.vala', + 'src/vala/Pluie/Io.Reader.vala', + 'src/vala/Pluie/Io.StreamLineMark.vala', + 'src/vala/Pluie/Yaml.global.vala', + 'src/vala/Pluie/Yaml.Event.vala', + 'src/vala/Pluie/Yaml.Processor.vala', + 'src/vala/Pluie/Yaml.BaseNode.vala', + 'src/vala/Pluie/Yaml.Node.vala', + 'src/vala/Pluie/Yaml.NodeCollection.vala', + 'src/vala/Pluie/Yaml.NodeMap.vala', + 'src/vala/Pluie/Yaml.NodeRoot.vala', + 'src/vala/Pluie/Yaml.NodeScalar.vala', + 'src/vala/Pluie/Yaml.NodeSequence.vala', + 'src/vala/Pluie/Yaml.NodeSinglePair.vala', + 'src/c/yaml.c' +] + +install_data('resources/test.yml', install_dir : datadir) + +libpluie_yaml = library( + 'pluie-yaml-' + version, + sources, + vala_header : 'pluie_yaml.h', + vala_vapi : 'pluie-yaml-' +version+'.vapi', + dependencies : [dep_glib, dep_gobject, dep_gio, dep_gee, dep_echo, dep_m, dep_yaml], + install : true, + install_dir : [get_option('libdir'), incdir, true] +) + +pkgconfig = import('pkgconfig') +pkgconfig.generate( + libraries : libpluie_yaml, + requires : 'glib-2.0 gobject-2.0 gio-2.0 gee-0.8 pluie-echo-0.2', + variables : 'datarootdir='+join_paths('${prefix}', get_option('datadir'))+'\ndatadir='+join_paths('${datarootdir}', 'pluie'), + version : version, + name : 'libpluie-yaml', + filebase : 'pluie-yaml-' + version, + subdirs : 'pluie', + description : 'The pluie yaml library' +) + + diff --git a/resources/test.yml b/resources/test.yml new file mode 100644 index 0000000..3f4ee03 --- /dev/null +++ b/resources/test.yml @@ -0,0 +1,30 @@ +%YAML 1.2 +--- ! +invoice: 34843 +date : 2001-01-23 +bill-to: &id001 + given : Chris + family : Dumars + address: + lines: | + 458 Walkman Dr. + "Suite" #292 + city : Royal Oak + state : MI + postal : 48046 +ship-to: *id001 +product: + - sku : BL394D + quantity : 4 + description : Basketball + price : 450.00 + - sku : BL4438H + quantity : 1 + description : Super Hoop + price : 2392.00 +tax : 251.42 +total: 4443.52 +comments: + Late afternoon is best. + Backup contact is Nancy + Billsmer @ 338-4338. diff --git a/src/c/yaml.c b/src/c/yaml.c new file mode 100644 index 0000000..cdcf7d1 --- /dev/null +++ b/src/c/yaml.c @@ -0,0 +1,95 @@ +#include +#include + +/* return a new string with every instance of ch replaced by repl */ +char *replace_char(const char *s, char ch, const char *repl) { + int count = 0; + const char *t; + for(t=s; *t; t++)count += (*t == ch); + size_t rlen = strlen(repl); + char *res = malloc(strlen(s) + (rlen-1)*count + 1); + char *ptr = res; + for(t=s; *t; t++) { + if(*t == ch) { + memcpy(ptr, repl, rlen); + ptr += rlen; + } else { + *ptr++ = *t; + } + } + *ptr = 0; + return res; +} + +char *escape_string(const char *s) { + char *t; + t = replace_char(s, '\"', "\\\""); + t = replace_char(t, '\n', "\\n"); + return t; +} + +void yaml_parse_file(const char *srcPath, const char *destPath) +{ + FILE *rh = fopen(srcPath, "r"); + FILE *wh = fopen(destPath, "w"); + yaml_parser_t parser; + yaml_token_t token; + + if(!yaml_parser_initialize(&parser)) + fputs("Failed to initialize parser!\n", stderr); + if(rh == NULL || wh == NULL) + fputs("Failed to open file!\n", stderr); + + yaml_parser_set_input_file(&parser, rh); + int stop = 0; + do { + yaml_parser_scan(&parser, &token); + long int line = parser.mark.line + 1; + switch(token.type) + { + case YAML_SCALAR_TOKEN : + fprintf(wh, "%lu, %d, %d, \"%s\"\n", line, token.type, token.data.scalar.style, escape_string((char *)token.data.scalar.value)); + break; + + case YAML_ALIAS_TOKEN : + fprintf(wh, "%lu, %d, \"%s\"\n", line, token.type, token.data.alias.value); + break; + + case YAML_ANCHOR_TOKEN : + fprintf(wh, "%lu, %d, \"%s\"\n", line, token.type, token.data.anchor.value); + break; + + case YAML_DOCUMENT_START_TOKEN : + fprintf(wh, "%lu, %d, %d\n", line, token.type, parser.encoding); + break; + + case YAML_TAG_TOKEN : + fprintf(wh, "%lu, %d, \"%s\", \"%s\"\n", line, token.type, token.data.tag.handle, token.data.tag.suffix); + break; + + case YAML_VERSION_DIRECTIVE_TOKEN : + fprintf(wh, "%lu, %d, %d, %d\n", line, token.type, token.data.version_directive.major, token.data.version_directive.minor); + break; + + case YAML_NO_TOKEN : + fprintf(wh, "%lu, %d, \"%s\"\n", line, token.type, escape_string((char *)parser.problem)); + stop = 1; + break; + + /* Others */ + default: + fprintf(wh, "%lu, %d\n", line, token.type); + } + if(token.type != YAML_STREAM_END_TOKEN) + yaml_token_delete(&token); + if (stop == 1) break; + + } + while(token.type != YAML_STREAM_END_TOKEN); + + yaml_token_delete(&token); + yaml_parser_delete(&parser); + fclose(rh); + fclose(wh); +} + diff --git a/src/vala/Pluie/Io.Reader.vala b/src/vala/Pluie/Io.Reader.vala new file mode 100644 index 0000000..98fdbbc --- /dev/null +++ b/src/vala/Pluie/Io.Reader.vala @@ -0,0 +1,115 @@ +using GLib; +using Gee; +using Pluie; + +/** + * a class to read file line by line with convenient methods to rewind to specific lines + * using {@link Io.StreamLineMark} + */ +public class Pluie.Io.Reader +{ + /** + * current file path + */ + public string path { get; internal set; default = null; } + /** + * indicates the current line number + */ + public int line { get; internal set; default = 0; } + /** + * indicates if current stream is readable + */ + public bool readable { get; internal set; default = false; } + /** + * stream used to read the file + */ + DataInputStream stream; + + /** + * construct a reader + * by adding {@link Io.StreamLineMark} + * @param path the path to load + */ + public Reader (string path) + { + this.load (path); + } + + /** + * load a yaml file by specifiyed path + * @param path the path to load + * @return operation succeed + */ + public bool load (string path) + { + Dbg.in (Log.METHOD, "path:'%s'".printf (path), Log.LINE, Log.FILE); + if (path == this.path && this.line > 0) { + if (this.rewind (new Io.StreamLineMark (0, 0))) { + return this.readable; + } + } + this.readable = false; + this.path = path; + this.line = 0; + var file = File.new_for_path (path); + if (!file.query_exists ()) { + of.error ("File '%s' doesn't exist.".printf (file.get_path ())); + } + else { + try { + this.stream = new DataInputStream (file.read ()); + this.readable = true; + this.line++; + } + catch (Error e) { + of.error (e.message); + } + } + Dbg.out (Log.METHOD, "done:%d".printf ((int)this.readable), Log.LINE, Log.FILE); + return this.readable; + } + + /** + * read current stream by line + * @param mark a mark used to operate possible future rewind + * @return current readed line + */ + public string? read (out Io.StreamLineMark? mark = null) + { + mark = null; + string? data = null; + if (this.readable) { + try { + // save pos before consume line + mark = new Io.StreamLineMark (this.stream.tell (), this.line); + data = this.stream.read_line (null); + if ((this.readable = data != null)) { + this.line++; + } + } + catch (IOError e) { + this.readable = false; + of.error (e.message); + } + } + return data; + } + + /** + * rewind current reading to specifiyed mark + * @return operation succeed + */ + public bool rewind (Io.StreamLineMark mark) + { + this.readable = false; + try { + this.line = mark.line; + this.readable = this.stream.seek (mark.pos, SeekType.SET); + } + catch (Error e) { + of.error (e.message); + } + return this.readable; + } + +} diff --git a/src/vala/Pluie/Io.StreamLineMark.vala b/src/vala/Pluie/Io.StreamLineMark.vala new file mode 100644 index 0000000..e5702c6 --- /dev/null +++ b/src/vala/Pluie/Io.StreamLineMark.vala @@ -0,0 +1,25 @@ +/** + * a class representing a stream mark recording a line and it's position in the stream + * to permit future rewind @see Io.Reader + */ +public class Pluie.Io.StreamLineMark +{ + /** + * current line + */ + public int line { get; internal set; default = 0; } + /** + * current position (stream.tell value) + */ + public int64 pos { get; internal set; default = 0; } + + /** + * construct a StreamLineMark with given pos & line + */ + public StreamLineMark (int64 pos, int line) + { + this.pos = pos; + this.line = line; + } + +} diff --git a/src/vala/Pluie/Yaml.BaseNode.vala b/src/vala/Pluie/Yaml.BaseNode.vala new file mode 100644 index 0000000..ed707ae --- /dev/null +++ b/src/vala/Pluie/Yaml.BaseNode.vala @@ -0,0 +1,189 @@ +using GLib; +using Gee; +using Pluie; + +/** + * parent class representing a Yaml Node whenether was his type + */ +public class Pluie.Yaml.BaseNode : Object, Pluie.Yaml.Node +{ + /** + * universal unique identifier + */ + public string uuid { get; internal set; } + + /** + * find mode related to Yaml.FIND_MODE, default is Yaml.FIND_MODE.SQUARE_BRACKETS + */ + public static Yaml.FIND_MODE mode { get; set; default = Yaml.FIND_MODE.SQUARE_BRACKETS; } + + /** + * node type related to Yaml.NODE_TYPE + */ + public Yaml.NODE_TYPE node_type { get; internal set; } + + /** + * current representation indent + */ + public int indent { get; internal set; } + + /** + * parent node + */ + public Yaml.Node? parent { get; internal set; } + + /** + * current node data for Yaml.NodeScalar node + */ + public string? data { get; internal set; default = null; } + + /** + * current node name (key) + */ + public string? name { get; internal set; default = null; } + + /** + * default Yaml.Node constructor + * @param parent the parent node + * @param indent the current indentation in node representation string + * @param type the NODE_TYPE of Yaml.Node to create + */ + public BaseNode (Yaml.Node? parent = null, int indent = 0, NODE_TYPE type = NODE_TYPE.UNDEFINED) + { + this.standard (parent, indent, type); + } + + /** + * constructor for root Yaml.Node + */ + public BaseNode.root () { + this.standard (null, -4, NODE_TYPE.ROOT); + this.name = "PluieYamlRootNode"; + } + + /** + * constructor for standard Yaml.Node + * @param parent the parent node + * @param indent the current indentation in node representation string + * @param type the NODE_TYPE of Yaml.Node to create + */ + internal BaseNode.standard (Yaml.Node? parent = null, int indent = 0, NODE_TYPE type = NODE_TYPE.UNDEFINED) + { + this.parent = parent; + this.node_type = type; + this.indent = indent; + this.uuid = Yaml.uuid (); + } + + /** + * stuff on changing parent node + * @param child the childto add + */ + protected virtual bool on_change_parent () + { + bool done = true; + if (this.parent != null) { + done = this.parent.remove_child (this); + } + return done; + } + + /** + * add a child + * @param child the childto add + */ + public virtual bool add (Yaml.Node child) + { + child.parent = this; + return false; + } + + /** + * remove a child + * @param child the child to remove + */ + protected virtual bool remove_child (Yaml.Node child) + { + return false; + } + + /** + * give the next sibling node + */ + public virtual Yaml.Node? next_sibling () + { + Yaml.Node? sibling = null; + if (this.parent != null) { + sibling = (this.parent as Yaml.NodeCollection).child_next_sibling (this); + } + return sibling; + } + + /** + * give the previous sibling node + */ + public virtual Yaml.Node? previous_sibling () + { + Yaml.Node? sibling = null; + if (this.parent != null) { + sibling = (this.parent as Yaml.NodeCollection).child_previous_sibling (this); + } + return sibling; + } + + /** + * give the root parent node + */ + public virtual Yaml.Node? get_root_node () + { + Yaml.Node? parent = this.parent; + if (parent != null) { + while(parent.parent != null) { + parent = parent.parent; + } + } + return parent; + } + + /** + * check if node has child nodes + */ + public virtual bool has_child_nodes () + { + return this.node_type.is_collection () && (this as Yaml.NodeCollection).get_size () > 0; + } + + /** + * check if current node contains the specifiyed child node + * @param child + */ + public virtual bool contains (Yaml.Node child) + { + bool has = false; + if (this.node_type.is_collection ()) { + has = (this as Yaml.NodeCollection).contains (child); + } + return has; + } + + /** + * get a presentation string of current Yaml.Node + */ + public string to_string (bool withIndent = true) + { + + return "%s%s%s%s%s%s%s%s".printf ( + this.node_type.is_root () ? "" : of.s_indent ((int8) (withIndent ? this.indent : 0)), + of.c (ECHO.OPTION).s ("<"), + of.c (ECHO.OPTION_SEP).s (this.node_type.infos ()), + this.name != null ? " %s".printf (this.name) + : (this.node_type.is_scallar () ? " %s".printf (this.data) : ""), + "[%x]".printf (this.ref_count), + this.parent == null ? "" : this.parent.name+"|"+this.indent.to_string(), +//~ " (%d) ".printf (this.indent), + of.c (ECHO.OPTION).s (">"), + of.c (ECHO.DATE).s (" %s".printf(this.uuid)) + ); + } + +} diff --git a/src/vala/Pluie/Yaml.Event.vala b/src/vala/Pluie/Yaml.Event.vala new file mode 100644 index 0000000..df9d2de --- /dev/null +++ b/src/vala/Pluie/Yaml.Event.vala @@ -0,0 +1,39 @@ +using GLib; +using Gee; +using Pluie; + +/** + * a class to read file line by line with convenient methods to rewind to specific lines + * using {@link Io.StreamLineMark} + */ +public class Pluie.Yaml.Event +{ + /** + * event type + */ + public Yaml.EVT evtype { get; internal set; default = 0; } + /** + * indicates the current line number + */ + public int line { get; internal set; default = 0; } + /** + * indicates the current event style + */ + public int? style { get; internal set; default = null; } + /** + * event data + */ + public Gee.HashMap? data { get; internal set; default = null; } + + /** + * construct a Event + * @param path the path to load + */ + public Event (Yaml.EVT evtype, int line=0, int? style=null, Gee.HashMap? data=null) + { + this.evtype = evtype; + this.line = line; + this.style = style; + this.data = data; + } +} diff --git a/src/vala/Pluie/Yaml.Finder.vala b/src/vala/Pluie/Yaml.Finder.vala new file mode 100644 index 0000000..5f37517 --- /dev/null +++ b/src/vala/Pluie/Yaml.Finder.vala @@ -0,0 +1,114 @@ +using GLib; +using Gee; +using Pluie; + +/** + * parent class representing a Yaml Node whenether was his type + */ +public class Pluie.Yaml.Finder : Object +{ + + /** + * Context node + */ + private Yaml.Node? context { get; internal set; } + + /** + * default Yaml.Node constructor + * @param parent the parent node + * @param indent the current indentation in node representation string + * @param type the NODE_TYPE of Yaml.Node to create + */ + public Finder (Yaml.Node context) + { + this.context = context; + } + + /** + * get a path definition depending of current Node.mode + * if path definition is Yaml.FIND_MODE.DOT the path is convert to a + * Yaml.FIND_MODE.SQUARE_BRACKETS path definition + * @path the path definition + * @return the find path definition according to current Node.mode + */ + private string find_path (string path) + { + MatchInfo? mi = null; + string search = ""; + if (BaseNode.mode.is_dot ()) { + var stk = /([^.]*)\./.split (path); + foreach (var s in stk) { + if (s.strip() != "") { + if (/([^\{]+)(\{[0-9]+\})/.match (s, 0, out mi)) { + search = search + "[%s]%s".printf (mi.fetch (1), mi.fetch (2)); + } + else { + search = search + "[%s]".printf (s); + } + } + } + } + else { + search = path; + } + return search; + } + + /** + * indicates if specifiyed MatchInfo is related to a mapping node only or a collection node + * @param mi + */ + private bool is_collection_path (MatchInfo mi, bool mappingOnly = false) + { + return (mi.fetch (FIND_COLLECTION.OPEN) == "[" && mi.fetch (FIND_COLLECTION.CLOSE) == "]") || (!mappingOnly && + (mi.fetch (FIND_COLLECTION.OPEN) == "{" && mi.fetch (FIND_COLLECTION.CLOSE) == "}")); + } + + /** + * find a specific child Yaml.Node corresponding to path definition + * path definition has two mode. + * default mode is Yaml.FIND_MODE.SQUARE_BRACKETS + * node's key name must be enclosed in square brackets + * sequence entry must be enclosed in curly brace + * ex : [grandfather][father][son]{2} + * + * other mode is Yaml.FIND_MODE.DOT + * child mapping node are separated by dot : + * ex : grandfather.father.son{2} + * @param path the definition to retriew the child node + */ + public Yaml.Node? find (string path, Yaml.Node? context = null) + { + string search = this.find_path (path); + bool match = false; + Yaml.Node? node = context == null ? this.context : context; + Regex reg = /(\[|\{)([^\]]*)(\]|\})/; + MatchInfo mi; + try { + of.echo ("find node %s".printf (path)); + for (reg.match (search, 0, out mi) ; mi.matches () ; mi.next ()) { + of.echo ("%s%s%s".printf (mi.fetch (1), mi.fetch (2), mi.fetch (3))); + if (this.is_collection_path (mi)) { + if (!match) match = true; + if (this.is_collection_path (mi, true)) { + node = (node as Yaml.NodeMap).map[mi.fetch (FIND_COLLECTION.KEY)]; + } + else { + int index = int.parse (mi.fetch (FIND_COLLECTION.KEY)); + var n = node as Yaml.NodeSequence; + if (index < n.list.size && index >= 0) { + node = n.list.get (index); + } + else node = null; + } + if (node == null) break; + } + } + } + catch (RegexError e) { + of.error (e.message); + } + if (!match) node = null; + return node; + } +} diff --git a/src/vala/Pluie/Yaml.Node.vala b/src/vala/Pluie/Yaml.Node.vala new file mode 100644 index 0000000..e8c4f08 --- /dev/null +++ b/src/vala/Pluie/Yaml.Node.vala @@ -0,0 +1,76 @@ +using GLib; +using Pluie; + +public interface Pluie.Yaml.Node : Object +{ + /** + * universal unique identifier + */ + public abstract string uuid { get; internal set; } + + /** + * node type related to Yaml.NODE_TYPE + */ + public abstract Yaml.NODE_TYPE node_type { get; internal set; } + + public abstract int indent { get; internal set; } + + /** + * parent node + */ + public abstract Yaml.Node? parent { get; internal set; } + + /** + * current node data for Yaml.NodeScalar node + */ + public abstract string? data { get; internal set; default = null; } + + /** + * current node name (key) + */ + public abstract string? name { get; internal set; default = null; } + + /** + * add a child node to current collection (mapping or sequence) node + * @param child the Yaml.Node child to add + */ + public abstract bool add (Yaml.Node node); + + /** + * stuff on changing parent node + * @param child the childto add + */ + protected abstract bool on_change_parent (); + + /** + * remove a child + * @param child the child to remove + */ + protected abstract bool remove_child (Yaml.Node child); + + /** + * check if node has child nodes + */ + public abstract bool has_child_nodes (); + + /** + * give the next sibling node + */ + public abstract Yaml.Node? next_sibling (); + + /** + * give the previous sibling node + */ + public abstract Yaml.Node? previous_sibling (); + + /** + * give the root parent node + */ + public abstract Yaml.Node? get_root_node (); + + /** + * get a presentation string of current Yaml.Node + */ + public abstract string to_string (bool withIndent = true); + +} diff --git a/src/vala/Pluie/Yaml.NodeCollection.vala b/src/vala/Pluie/Yaml.NodeCollection.vala new file mode 100644 index 0000000..c3235c2 --- /dev/null +++ b/src/vala/Pluie/Yaml.NodeCollection.vala @@ -0,0 +1,32 @@ +using GLib; +using Pluie; + +/** + * a class representing a mapping node + */ +public interface Pluie.Yaml.NodeCollection +{ + + /** + * retriew the previous sibling of specifiyed child node + * @param child + */ + public abstract Yaml.Node? child_previous_sibling (Yaml.Node child); + + /** + * retriew the next sibling of specifiyed child node + * @param child + */ + public abstract Yaml.Node? child_next_sibling (Yaml.Node child); + + /** + * count childnodes + */ + public abstract int get_size (); + + /** + * check if current node contains the specifiyed child node + * @param child + */ + public abstract bool contains (Yaml.Node node); +} diff --git a/src/vala/Pluie/Yaml.NodeMap.vala b/src/vala/Pluie/Yaml.NodeMap.vala new file mode 100644 index 0000000..40a2728 --- /dev/null +++ b/src/vala/Pluie/Yaml.NodeMap.vala @@ -0,0 +1,141 @@ +using GLib; +using Pluie; +using Gee; + +/** + * a class representing a mapping node + */ +public class Pluie.Yaml.NodeMap : Yaml.BaseNode, Yaml.NodeCollection +{ + /** + * map collection for Yaml.NodeMap node + */ + public HashMap map { get; internal set; } + + /** + * construct a mapping node + * @param parent the parent node + * @param indent the current indentation in node representation string + * @param name the current name (key) of mapping node + */ + public NodeMap (Yaml.Node? parent = null, int indent = 0, string? name = null) + { + base (parent, indent, NODE_TYPE.MAPPING); + this.map = new HashMap (); + this.name = name; + } + + /** + * remove a child + * @param child the child to remove + */ + protected override bool remove_child (Yaml.Node child) + { + bool done = true; + if (this.map != null && this.map.has_key (child.name)) { + done = this.map.unset(child.name); + } + return done; + } + + /** + * add a child node to current collection (mapping or sequence) node + * @param child the Yaml.Node child to add + */ + public override bool add (Yaml.Node node) + { + node.on_change_parent (); + node.indent = this.indent + 4; + node.parent = this; + if (this.map == null) { + this.map = new HashMap (); + } + this.map.set (node.name, node); + return true; + } + + /** + * display childs + */ + public void display_childs () + { + of.action ("display_childs map\n"); + of.echo (this.to_string ()); + if (this.map.size > 0) { + foreach (string key in this.map.keys) { + of.echo (this.map.get(key).to_string ()); + } + } + else { + of.echo (of.s_indent ()+"node has no childs"); + } + } + + /** + * count childnodes + */ + public int get_size () { + return this.map.size; + } + + /** + * check if current node contains the specifiyed child node + * @param child + */ + public override bool contains (Yaml.Node child) { + bool has = false; + foreach (Yaml.Node entry in map.values) { + if (child.uuid == entry.uuid) { + has = true; + break; + } + } + return has; + } + + /** + * retriew the next sibling of specifiyed child node + * @param child + */ + public virtual Yaml.Node? child_next_sibling (Yaml.Node child) + { + Yaml.Node? target = null; + bool match = false; + if (this.map.size > 0) { + foreach (string key in this.map.keys) { + if (child.name == key) { + match = true; + continue; + } + if (match) { + target = this.map.get(key); + } + } + } + return target; + } + + /** + * retriew the previous sibling of specifiyed child node + * @param child + */ + public virtual Yaml.Node? child_previous_sibling (Yaml.Node child) + { + Yaml.Node? target = null; + bool match = false; + if (this.map.size > 0) { + foreach (string key in this.map.keys) { + if (child.name == key) { + match = true; + break; + } + target = this.map.get(key); + } + } + if (!match) { + target = null; + } + return target; + } + +} diff --git a/src/vala/Pluie/Yaml.NodeRoot.vala b/src/vala/Pluie/Yaml.NodeRoot.vala new file mode 100644 index 0000000..8e612ed --- /dev/null +++ b/src/vala/Pluie/Yaml.NodeRoot.vala @@ -0,0 +1,20 @@ +using Pluie; + +/** + * a class representing a single/pair mapping node + */ +public class Pluie.Yaml.NodeRoot : Yaml.NodeMap +{ + /** + * construct a single/pair mapping node + * @param parent the parent node + * @param indent the current indentation in node representation string + * @param name the current name (key) of sequence node + * @param data the current scalar data + */ + public NodeRoot (Yaml.Node? parent = null, int indent = 0, string? name = null, string? data = null) + { + this.standard (null, -4, NODE_TYPE.ROOT); + this.name = "PluieYamlRootNode"; + } +} diff --git a/src/vala/Pluie/Yaml.NodeScalar.vala b/src/vala/Pluie/Yaml.NodeScalar.vala new file mode 100644 index 0000000..f7ff5a7 --- /dev/null +++ b/src/vala/Pluie/Yaml.NodeScalar.vala @@ -0,0 +1,20 @@ +using Pluie; + +/** + * a class representing a scalar node + */ +public class Pluie.Yaml.NodeScalar : Yaml.BaseNode +{ + /** + * construct a scalar node + * @param parent the parent node + * @param indent the current indentation in node representation string + * @param data the current scalar data + */ + public NodeScalar (Yaml.Node? parent = null, int indent = 0, string? data = null) + { + base (parent, indent, NODE_TYPE.SCALAR); + this.data = data; + } + +} diff --git a/src/vala/Pluie/Yaml.NodeSequence.vala b/src/vala/Pluie/Yaml.NodeSequence.vala new file mode 100644 index 0000000..65048f1 --- /dev/null +++ b/src/vala/Pluie/Yaml.NodeSequence.vala @@ -0,0 +1,157 @@ +using Pluie; +using Gee; + +/** + * a class representing a sequence node + */ +public class Pluie.Yaml.NodeSequence : Yaml.BaseNode, Yaml.NodeCollection +{ + + /** + * sequence collection for Yaml.NodeSequence node + */ + public ArrayList list { get; internal set; } + + /** + * construct a sequence node + * @param parent the parent node + * @param indent the current indentation in node representation string + * @param name the current name (key) of sequence node + */ + public NodeSequence (Yaml.Node? parent = null, int indent = 0, string? name = null) + { + base (parent, indent, NODE_TYPE.SEQUENCE); + this.name = name; + } + + /** + * remove a child + * @param child the child to remove + */ + protected override bool remove_child (Yaml.Node child) + { + bool done = true; + if (this.list.contains (child)) { + done = this.list.remove (child); + } + return done; + } + + /** + * add a child node to current collection (mapping or sequence) node + * @param child the Yaml.Node child to add + */ + public override bool add (Yaml.Node node) + { + if (this.list == null) { + this.list = new ArrayList (); + } + node.on_change_parent (); + node.indent = this.indent + 4; + node.parent = this; + return this.list.add (node); + } + + /** + * add a child Yaml.NodeScalar containing specifiyed data + * @param data the scalar data + * @return the scalar node + */ + public Yaml.Node add_scalar (string? data = null) + { + Yaml.Node scalar = new Yaml.NodeScalar (this, this.indent+4, data); + this.add (scalar); + return scalar; + } + + /** + * retriew a child node throught specifiyed index + * @param index index of searched child + * @return the child node + */ + public Yaml.Node item (int index) + { + return this.list.get (index); + } + + /** + * retriew the first child node + * @return the first child node + */ + public Yaml.Node first () + { + return this.list.first (); + } + + + /** + * retriew the last child node + * @return the last child node + */ + public Yaml.Node last () + { + return this.list.last (); + } + + /** + * display childs + */ + public void display_childs () + { + of.action ("display_childs sequence\n"); + of.echo (this.to_string ()); + if (this.list!= null && this.list.size > 0) { + foreach (Yaml.Node child in this.list) { + of.echo (child.to_string ()); + } + } + else { + of.echo (of.s_indent ()+"node has no childs"); + } + } + + /** + * count childnodes + */ + public int get_size () { + return this.list.size; + } + + /** + * check if current node contains the specifiyed child node + * @param child + */ + public override bool contains (Yaml.Node child) { + return this.list.contains (child); + } + + /** + * retriew the next sibling of specifiyed child node + * @param child + */ + public Yaml.Node? child_next_sibling (Yaml.Node child) + { + Yaml.Node? target = null; + if (this.list.size > 0 && this.list.contains (child)) { + int index = this.list.index_of (child); + target = this.list.get(index+1); + } + return target; + } + + /** + * retriew the previous sibling of specifiyed child node + * @param child + */ + public Yaml.Node? child_previous_sibling (Yaml.Node child) + { + Yaml.Node? target = null; + if (this.list.size > 0 && this.list.contains (child)) { + int index = this.list.index_of (child); + if (index > 0) { + target = this.list.get(index-1); + } + } + return target; + } +} diff --git a/src/vala/Pluie/Yaml.NodeSinglePair.vala b/src/vala/Pluie/Yaml.NodeSinglePair.vala new file mode 100644 index 0000000..57a14b0 --- /dev/null +++ b/src/vala/Pluie/Yaml.NodeSinglePair.vala @@ -0,0 +1,34 @@ +using Pluie; + +/** + * a class representing a single/pair mapping node + */ +public class Pluie.Yaml.NodeSinglePair : Yaml.NodeMap +{ + /** + * construct a single/pair mapping node + * @param parent the parent node + * @param indent the current indentation in node representation string + * @param name the current name (key) of sequence node + * @param data the current scalar data + */ + public NodeSinglePair (Yaml.Node? parent = null, int indent = 0, string? name = null, string? data = null) + { + this.standard (parent, indent, NODE_TYPE.SINGLE_PAIR); + this.name = name; + if (data != null) { + var scalar = new Yaml.NodeScalar (this, this.indent+4, data); + scalar.name = "singlepair"; + this.add (scalar); + } + } + + /** + * get child scalar node + * @return the scalar node + */ + public Yaml.Node? scalar () + { + return this.map["singlepair"]; + } +} diff --git a/src/vala/Pluie/Yaml.Processor.vala b/src/vala/Pluie/Yaml.Processor.vala new file mode 100644 index 0000000..844499c --- /dev/null +++ b/src/vala/Pluie/Yaml.Processor.vala @@ -0,0 +1,332 @@ +using GLib; +using Gee; +using Pluie; +extern void yaml_parse_file(string srcPath, string destPath); + +/** + * a tiny Yaml Parser whose purpose is not to comply with all yaml specifications but to parse yaml configuration files + * todo improve description of what is expected + */ +public class Pluie.Yaml.Processor +{ + const string REG_EVENT = "^([0-9]+), ([0-9]+)(.*)$"; + const string REG_VERSION = "^, ([0-9]+), ([0-9]+)$"; + const string REG_TAG = "^, \"([^\"]*)\", \"([^\"]*)\"$"; + const string REG_ERROR = "^, \"([^\"]*)\"$"; + const string REG_SCALAR = "^, ([0-9]+), \"([^\"]*)\"$"; + const string REG_ANCHOR = "^, \"([^\"]*)\"$"; + const string REG_ALIAS = "^, \"([^\"]*)\"$"; + + /** + * enum linked to used RegExp in parse_line + */ + enum MIEVT + { + NONE, + LINE, + TYPE, + DATA + } + + /** + * enum linked to used RegExp in parse_line + */ + enum MIEVT_VERSION + { + NONE, + MAJOR, + MINOR + } + + /** + * enum linked to used RegExp in parse_line + */ + enum MIEVT_SCALAR + { + NONE, + STYLE, + DATA + } + + /** + * enum linked to used RegExp in parse_line + */ + enum MIEVT_TAG + { + NONE, + HANDLE, + SUFFIX + } + + /** + * enum linked to used RegExp in parse_line + */ + enum MIEVT_ANCHOR + { + NONE, + ID, + } + + /** + * enum linked to used RegExp in parse_line + */ + enum MIEVT_ERROR + { + NONE, + DATA, + } + + /** + * indicate if file has been sucessfully parsed + */ + public bool done; + + /** + * indicate if parsing msut stop + */ + bool stop; + + /** + * the mark use to rewind line throught Io.Reader + */ + Io.StreamLineMark? mark; + + /** + * Reader used to load content yaml file + */ + Io.Reader reader; + + /** + * Events list + */ + Gee.LinkedList events { get; internal set; } + + /** + *Anchor map + */ + Gee.HashMap anchors { get; internal set; } + + /** + * @param path the path of file to parse + */ + public Processor (string path) + { + var destPath = Path.build_filename (Environment.get_tmp_dir (), Path.get_basename(path)); + yaml_parse_file(path, destPath); + this.reader = new Io.Reader (destPath); + this.scan (); + } + + /** + * parse a file related to specifiyed path + * @param path the path to parse + */ + public bool scan (string? path = null) + { + Dbg.in (Log.METHOD, "path:'%s'".printf (path), Log.LINE, Log.FILE); + if (path != null) { + this.reader.load (path); + } + else { + this.reader.rewind(new Io.StreamLineMark(0, 0)); + } + this.events = new Gee.LinkedList(); + this.anchors = new Gee.HashMap(); + this.stop = this.done = false; + of.action ("Scanning events", path); + while (this.reader.readable) { + this.scan_line (this.reader.read ()); + } + this.process_events (); + + this.done = true; + Dbg.out (Log.METHOD, "done:%d".printf ((int)done), Log.LINE, Log.FILE); + return this.done; + } + + /** + * + */ + private void process_events () + { + of.action ("Reading events"); + foreach (Yaml.Event event in this.events) { + int len = 24 - event.evtype.infos ().length; + stdout.printf(" [ %s"+@" %$(len)s "+", %d, %s", event.evtype.infos (), " ", event.line, event.style != null ? event.style.to_string () : "0"); + if (event.data != null && event.data.size > 0) { + stdout.printf (", {"); + var it = event.data.map_iterator (); + string sep; + for (var has_next = it.next (); has_next; has_next = it.next ()) { + sep = it.has_next () ? ", " : ""; + stdout.printf ("%s: %s%s", it.get_key (), it.get_value (), sep); + } + stdout.printf (" }"); + } + stdout.printf("]\n"); + } + } + + /** + * set event version + * @param evtdata the current data event + * @param line the current line + * @throws GLib.RegexError + */ + private void set_event_version(string evtdata, int line) throws GLib.RegexError + { + MatchInfo mi = null; + Regex reg = new Regex (REG_VERSION); + HashMap? data = null; + if (reg.match (evtdata, 0, out mi)) { + data = new HashMap(); + data.set("major", mi.fetch (MIEVT_VERSION.MAJOR)); + data.set("minor", mi.fetch (MIEVT_VERSION.MINOR)); + } + this.events.offer(new Yaml.Event(EVT.VERSION_DIRECTIVE, line, null, data)); + } + + + /** + * set event tag + * @param evtdata the current data event + * @param line the current line + * @throws GLib.RegexError + */ + private void set_event_tag(string evtdata, int line) throws GLib.RegexError + { + MatchInfo mi = null; + Regex reg = new Regex (REG_TAG); + HashMap? data = null; + if (reg.match (evtdata, 0, out mi)) { + data = new HashMap(); + data.set("handle", mi.fetch (MIEVT_TAG.HANDLE)); + data.set("suffix", mi.fetch (MIEVT_TAG.SUFFIX)); + } + this.events.offer(new Yaml.Event(EVT.TAG, line, null, data)); + } + + /** + * set event version + * @param evtdata the current data event + * @param line the current line + * @throws GLib.RegexError + */ + private void set_event_error(string evtdata, int line) throws GLib.RegexError + { + MatchInfo mi = null; + Regex reg = new Regex (REG_ERROR); + HashMap? data = null; + if (reg.match (evtdata, 0, out mi)) { + data = new HashMap(); + data.set("error", mi.fetch (MIEVT_ERROR.DATA)); + } + this.events.offer(new Yaml.Event(EVT.NONE, line, null, data)); + } + + /** + * set event scalar + * @param evtdata the current data event + * @param line the current line + * @throws GLib.RegexError + */ + private void set_event_scalar(string evtdata, int line) throws GLib.RegexError + { + MatchInfo mi = null; + Regex reg = new Regex (REG_SCALAR); + HashMap? data = null; + int? style = null; + if (reg.match (evtdata, 0, out mi)) { + style = int.parse(mi.fetch (MIEVT_SCALAR.STYLE)); + data = new HashMap(); + data.set("data", mi.fetch (MIEVT_SCALAR.DATA)); + } + this.events.offer(new Yaml.Event(EVT.SCALAR, line, style, data)); + } + + /** + * set event anchor + * @param evtdata the current data event + * @param line the current line + * @throws GLib.RegexError + */ + private void set_event_anchor(string evtdata, int line) throws GLib.RegexError + { + MatchInfo mi = null; + Regex reg = new Regex (REG_ANCHOR); + HashMap? data = null; + if (reg.match (evtdata, 0, out mi)) { + data = new HashMap(); + data.set("id", mi.fetch (MIEVT_ANCHOR.ID)); + } + this.anchors.set(data.get("id"), this.events.size); + this.events.offer(new Yaml.Event(EVT.ANCHOR, line, null, data)); + } + + /** + * set event alias + * @param evtdata the current data event + * @param line the current line + * @throws GLib.RegexError + */ + private void set_event_alias(string evtdata, int line) throws GLib.RegexError + { + MatchInfo mi = null; + Regex reg = new Regex (REG_ALIAS); + HashMap? data = null; + if (reg.match (evtdata, 0, out mi)) { + data = new HashMap(); + data.set("id", mi.fetch (MIEVT_ANCHOR.ID)); + } + this.events.offer(new Yaml.Event(EVT.ALIAS, line, null, data)); + } + + /** + * parse specifiyed line + * @param data the current line + */ + private void scan_line (string? data = null) + { + Dbg.in (Log.METHOD, null, Log.LINE, Log.FILE); + if (data == null) { + this.stop = true; + return; + } + try { + MatchInfo mi = null; + Regex reg = new Regex (REG_EVENT); + if (reg.match (data, 0, out mi)) { + int line = int.parse(mi.fetch (MIEVT.LINE)); + int type = int.parse(mi.fetch (MIEVT.TYPE)); + string evtdata = mi.fetch (MIEVT.DATA); + switch(type) { + case EVT.SCALAR : + this.set_event_scalar(evtdata, line); + break; + case EVT.ANCHOR : + this.set_event_anchor(evtdata, line); + break; + case EVT.ALIAS : + this.set_event_alias(evtdata, line); + break; + case EVT.TAG : + this.set_event_tag(evtdata, line); + break; + case EVT.VERSION_DIRECTIVE : + this.set_event_version(evtdata, line); + break; + case EVT.NONE : + this.set_event_error(evtdata, line); + break; + default : + this.events.offer(new Yaml.Event((Yaml.EVT)type, line, null, null)); + break; + } + } + } + catch (GLib.RegexError e) { + Dbg.error (e.message, Log.METHOD, Log.LINE, Log.FILE); + } + Dbg.out (Log.METHOD, null, Log.LINE, Log.FILE); + } +} diff --git a/src/vala/Pluie/Yaml.global.vala b/src/vala/Pluie/Yaml.global.vala new file mode 100644 index 0000000..2de9c08 --- /dev/null +++ b/src/vala/Pluie/Yaml.global.vala @@ -0,0 +1,186 @@ +namespace Pluie +{ + namespace Yaml + { + /** + * haxadecimal sequence + */ + const string hexa_sequence = "0123456789abcdef"; + + /** + * convert %02x string to uint8 + * @param hex2byte string representation of hexadecimal value on 1 byte + */ + uint8 hex_to_dec (string hexbyte) + { + return (uint8) ( + Yaml.hexa_sequence.index_of(hexbyte.data[0].to_string ())*16 + + Yaml.hexa_sequence.index_of(hexbyte.data[1].to_string ()) + ); + } + + /** + * enum MatchInfo keys of Yaml.Mode.find method related to mode FIND_MODE.SQUARE_BRACKETS of Yaml.Node + */ + public enum EVT { + NONE, + STREAM_START, + STREAM_END, + VERSION_DIRECTIVE, + TAG_DIRECTIVE, + DOCUMENT_START, + DOCUMENT_END, + BLOCK_SEQUENCE_START, + BLOCK_MAPPING_START, + BLOCK_END, + FLOW_SEQUENCE_START, + FLOW_SEQUENCE_END, + FLOW_MAPPING_START, + FLOW_MAPPING_END, + BLOCK_ENTRY, + FLOW_ENTRY, + KEY, + VALUE, + ALIAS, + ANCHOR, + TAG, + SCALAR; + + /** + *@return infos related to EVT + */ + public string infos () + { + return this.to_string().substring("PLUIE_YAML_".length); + } + } + + /** + * enum possible find mode of Yaml.Node.mode + */ + public enum FIND_MODE + { + DOT, + SQUARE_BRACKETS; + + /** + * + */ + public bool is_dot () + { + return this == DOT; + } + } + + /** + * enum MatchInfo keys of Yaml.Mode.find method related to mode FIND_MODE.SQUARE_BRACKETS of Yaml.Node + */ + internal enum FIND_COLLECTION + { + PATH, + OPEN, + KEY, + CLOSE; + } + + /** + * enum MatchInfo keys of Yaml.Node.find method related to mode FIND_MODE.DOT of Yaml.Node + */ + internal enum FIND_DOT + { + PATH, + KEY, + SEQUENCE; + } + + /** + * enum possible type of Yaml.Node + */ + public enum NODE_TYPE + { + UNDEFINED, + ROOT, + SCALAR, + SINGLE_PAIR, + MAPPING, + SEQUENCE; + + /** + * @return if current NODE_TYPE match a collection node (root|mapping|sequence) + */ + public bool is_collection () + { + return this == MAPPING || this == SEQUENCE || this == ROOT; + } + + /** + * @return if current NODE_TYPE match a scalar node + */ + public bool is_scallar () + { + return this == SCALAR; + } + + /** + * @return if current NODE_TYPE match a single/pair mapping node + */ + public bool is_single_pair () + { + return this == SINGLE_PAIR; + } + + /** + * @return if current NODE_TYPE match a mapping node + */ + public bool is_mapping () + { + return this == MAPPING; + } + + /** + * @return if current NODE_TYPE match a sequence node + */ + public bool is_sequence () + { + return this == SEQUENCE; + } + + /** + * @return if current NODE_TYPE match a root node + */ + public bool is_root () + { + return this == ROOT; + } + + /** + *@return infos related to NODE_TYPE + */ + public string infos () + { + return this.to_string().substring("PLUIE_YAML_NODE_TYPE_".length); + } + } + + /** + *@return universal infos related to NODE_TYPE + */ + public string uuid () + { + var sb = new StringBuilder(); + for (var i = 0; i < 4; i++) sb.append (Random.next_int ().to_string ("%08x")); + var h = sb.str; + var d = Yaml.hex_to_dec (h.substring (16, 2)); + d &= 0x3f; + d |= 0x80; + return "%s-%s-4%s-%02x%s-%s".printf ( + h.substring (0, 8), + h.substring (8, 4), + h.substring (13, 3), + d, + h.substring (18, 2), + h.substring (20) + ); + } + } +}