commit caf6b2f67d589c7d8966471cbf5057833919aa40 Author: a-Sansara Date: Sat Nov 4 03:14:21 2017 +0100 version 0.1.0 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..dae5e7e --- /dev/null +++ b/README.md @@ -0,0 +1,114 @@ +# libpluie-echo + +small vala shared library managing tracing, display formatting and ansi-extended colors on stdout & stderror. + + +## Prerequisites + +valac meson ninja glib gobject + + +## Install + +git clone the project then cd to project and do : + +``` +meson --prefix=/usr ./ build +sudo ninja install -C build +``` + +## Compilation + +``` +valac --pkg pluie-echo-0.1 main.vala -o echo +``` + +## Usage + +#### playing with colors +``` +using Pluie; + +int main (string[] args) +{ + var c1 = new Color(37, false); + var c2 = new Color(204, true); + stdout.printf ("[%s][%s]", c1.s ("oki"), c2.s ("cool")); + return 0; +} +``` + +#### init OutputFormatter +``` +using GLib; +using Pluie; + +int main (string[] args) +{ + OutputFormatter of; + Echo.init (true /* enable tracing */, "resources/echo.ini", out of); + Dbg.in (Log.METHOD); + + of.echo ( + // multiline string + "\nsample echo\non multiple\nline", + // newline + true, + // indent all line + true, + // set color with Pluie.ECHO enum listing all defined styles + ECHO.ACTION + ); + ... + return 0; +} +``` + +#### more samples + +![Sample 1 code](https://www.meta-tech.academy/img/libpluie-echo_sample_code1.png) +![Sample 1 output](https://www.meta-tech.academy/img/libpluie-echo_sample1.png) +![Sample 2 code](https://www.meta-tech.academy/img/libpluie-echo_sample_code2.png) +![Sample 2 output](https://www.meta-tech.academy/img/libpluie-echo_sample2.png) + + +## Configuration + +configuration file is installed on {prefix}/share/pluie/echo.ini + +``` +[Term] +term_width = 105 +indent = 4 +key_maxlen = 17 + +[Colors] +# keys are fixed. overwrite only values +# fg ansi extended color code (0..255), bold (0|1), bg ansi extended color code (0..255) +default = +comment = 103,1 +option = 37,1 +option_sep = 158 +arg = 97,1 +arg_sep = 147,1 +title = 15,1,24 +title_item = 220,1 +title_sep = 24,1 +section = 37 +sep = 59 +item = 215,1 +action = 97,1 +done = 15,1,36 +fail = 15,1,196 +key = 37,1 +val = 215,1 +date = 215,1 +time = 210,1 +microtime = 204,1 +file = 95,1 +num = 218,1 +enter = 36,1 +leave = 167,1 +warn = 220,1,89 +error = 15,1,196 +``` 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/main.vala b/main.vala new file mode 100644 index 0000000..3580c0f --- /dev/null +++ b/main.vala @@ -0,0 +1,65 @@ +using GLib; +using Pluie; + +errordomain MyError { + CODE +} + +int main (string[] args) +{ + OutputFormatter of; + Echo.init (true, "resources/echo.ini", out of); + + Dbg.in (Log.METHOD, null, Log.LINE, Log.FILE); + + of.title ("MyApp", "0.2.2", "a-sansara"); + + of.echo ("sample echo\n"); + + of.keyval ("path", "/tmp/blob"); + of.keyval ("otherlongoption", "other value"); + + of.echo ("\nsample echo\non multiple\nline", true, true); + + of.action ("reading config", "toto.conf"); + + of.state (false); + + of.warn ("boloss warning"); + of.echo (); + + var cmd = new Sys.Cmd ("ls -la"); + + int status = cmd.run(); + of.action ("running cmd", cmd.name); + of.echo ("\n%s".printf (cmd.output), true, true); + + of.state (status == 0); + + try { + throw new MyError.CODE("this is the error message"); + } + catch (MyError e) { + of.error (e.message); + } + of.rs (true); + of.rs (true, "ok"); + of.rs (false, "", "exit"); + + of.echo(); + + string com = "Vala is syntactically similar to C# and includes several features such as: anonymous functions, signals, properties, generics, assisted memory management, exception handling, type inference, and foreach statements.[3] Its developers Jürg Billeter and Raffaele Sandrini aim to bring these features to the plain C runtime with little overhead and no special runtime support by targeting the GObject object system"; + string mycom = of.wordwrap (com, of.term_width-44); + int line = mycom.split("\n").length; + of.echo (mycom, true, true, ECHO.COMMENT, 40); + + of.usage_option ("quiet", "q", "SHUTUP", false, line); + of.echo(); + + of.echo (mycom, true, true, ECHO.COMMENT, 40); + of.usage_option ("record-desktop", "r", "TIME", false, line); + + of.echo(); + Dbg.out (Log.METHOD, null, Log.LINE, Log.FILE); + return 0; +} diff --git a/meson.build b/meson.build new file mode 100644 index 0000000..e4560d9 --- /dev/null +++ b/meson.build @@ -0,0 +1,45 @@ +project('libpluie-echo', 'vala', 'c') + +glib_dep = dependency('glib-2.0') +gobject_dep = dependency('gobject-2.0') + +version = '0.1' +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) + +sources = [ + 'src/Pluie.Color.vala', + 'src/Pluie.ColorConf.vala', + 'src/Pluie.Dbg.vala', + 'src/Pluie.global.vala', + 'src/Pluie.OutputFormatter.vala', + 'src/Pluie.Sys.Cmd.vala' +] + +install_data('resources/echo.ini', install_dir : datadir) + +libpluie_echo = library('pluie-echo-' + version, sources, + vala_header: 'pluie_echo.h', + vala_vapi: 'pluie-echo-' +version+'.vapi', + dependencies: [glib_dep, gobject_dep], + install: true, + install_dir: [get_option('libdir'), incdir, true]) + +pkgconfig = import('pkgconfig') +pkgconfig.generate(libraries: libpluie_echo, + requires: 'glib-2.0 gobject-2.0', + variables: 'datarootdir=${prefix}/share\ndatadir=${datarootdir}/pluie', + version: version, + name: 'libpluie-echo', + filebase: 'pluie-echo-' + version, + subdirs: 'pluie', + description: 'The pluie echo library') + + diff --git a/pluie_echo.h b/pluie_echo.h new file mode 100644 index 0000000..e45c61c --- /dev/null +++ b/pluie_echo.h @@ -0,0 +1,225 @@ +/* pluie_echo.h generated by valac 0.36.6, the Vala compiler, do not modify */ + + +#ifndef __PLUIE_ECHO_H__ +#define __PLUIE_ECHO_H__ + +#include +#include +#include +#include + +G_BEGIN_DECLS + + +#define PLUIE_TYPE_ECHO (pluie_echo_get_type ()) + +#define PLUIE_TYPE_OUTPUT_FORMATTER (pluie_output_formatter_get_type ()) +#define PLUIE_OUTPUT_FORMATTER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), PLUIE_TYPE_OUTPUT_FORMATTER, PluieOutputFormatter)) +#define PLUIE_OUTPUT_FORMATTER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), PLUIE_TYPE_OUTPUT_FORMATTER, PluieOutputFormatterClass)) +#define PLUIE_IS_OUTPUT_FORMATTER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PLUIE_TYPE_OUTPUT_FORMATTER)) +#define PLUIE_IS_OUTPUT_FORMATTER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PLUIE_TYPE_OUTPUT_FORMATTER)) +#define PLUIE_OUTPUT_FORMATTER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PLUIE_TYPE_OUTPUT_FORMATTER, PluieOutputFormatterClass)) + +typedef struct _PluieOutputFormatter PluieOutputFormatter; +typedef struct _PluieOutputFormatterClass PluieOutputFormatterClass; + +#define PLUIE_TYPE_COLOR_CONF (pluie_color_conf_get_type ()) +#define PLUIE_COLOR_CONF(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), PLUIE_TYPE_COLOR_CONF, PluieColorConf)) +#define PLUIE_COLOR_CONF_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), PLUIE_TYPE_COLOR_CONF, PluieColorConfClass)) +#define PLUIE_IS_COLOR_CONF(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PLUIE_TYPE_COLOR_CONF)) +#define PLUIE_IS_COLOR_CONF_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PLUIE_TYPE_COLOR_CONF)) +#define PLUIE_COLOR_CONF_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PLUIE_TYPE_COLOR_CONF, PluieColorConfClass)) + +typedef struct _PluieColorConf PluieColorConf; +typedef struct _PluieColorConfClass PluieColorConfClass; +typedef struct _PluieColorConfPrivate PluieColorConfPrivate; + +#define PLUIE_TYPE_COLOR (pluie_color_get_type ()) +#define PLUIE_COLOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), PLUIE_TYPE_COLOR, PluieColor)) +#define PLUIE_COLOR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), PLUIE_TYPE_COLOR, PluieColorClass)) +#define PLUIE_IS_COLOR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PLUIE_TYPE_COLOR)) +#define PLUIE_IS_COLOR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PLUIE_TYPE_COLOR)) +#define PLUIE_COLOR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PLUIE_TYPE_COLOR, PluieColorClass)) + +typedef struct _PluieColor PluieColor; +typedef struct _PluieColorClass PluieColorClass; +typedef struct _PluieColorPrivate PluieColorPrivate; +typedef struct _PluieOutputFormatterPrivate PluieOutputFormatterPrivate; + +#define PLUIE_SYS_TYPE_CMD (pluie_sys_cmd_get_type ()) +#define PLUIE_SYS_CMD(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), PLUIE_SYS_TYPE_CMD, PluieSysCmd)) +#define PLUIE_SYS_CMD_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), PLUIE_SYS_TYPE_CMD, PluieSysCmdClass)) +#define PLUIE_SYS_IS_CMD(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PLUIE_SYS_TYPE_CMD)) +#define PLUIE_SYS_IS_CMD_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), PLUIE_SYS_TYPE_CMD)) +#define PLUIE_SYS_CMD_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), PLUIE_SYS_TYPE_CMD, PluieSysCmdClass)) + +typedef struct _PluieSysCmd PluieSysCmd; +typedef struct _PluieSysCmdClass PluieSysCmdClass; +typedef struct _PluieSysCmdPrivate PluieSysCmdPrivate; + +typedef enum { + PLUIE_ECHO_DEFAULT, + PLUIE_ECHO_COMMENT, + PLUIE_ECHO_OPTION, + PLUIE_ECHO_OPTION_SEP, + PLUIE_ECHO_ARG, + PLUIE_ECHO_ARG_SEP, + PLUIE_ECHO_TITLE, + PLUIE_ECHO_TITLE_ITEM, + PLUIE_ECHO_TITLE_SEP, + PLUIE_ECHO_SECTION, + PLUIE_ECHO_SEP, + PLUIE_ECHO_ITEM, + PLUIE_ECHO_ACTION, + PLUIE_ECHO_DONE, + PLUIE_ECHO_FAIL, + PLUIE_ECHO_KEY, + PLUIE_ECHO_VAL, + PLUIE_ECHO_DATE, + PLUIE_ECHO_TIME, + PLUIE_ECHO_MICROTIME, + PLUIE_ECHO_FILE, + PLUIE_ECHO_NUM, + PLUIE_ECHO_ENTER, + PLUIE_ECHO_LEAVE, + PLUIE_ECHO_WARN, + PLUIE_ECHO_ERROR +} PluieECHO; + +struct _PluieColorConf { + GTypeInstance parent_instance; + volatile int ref_count; + PluieColorConfPrivate * priv; +}; + +struct _PluieColorConfClass { + GTypeClass parent_class; + void (*finalize) (PluieColorConf *self); +}; + +struct _PluieColor { + GTypeInstance parent_instance; + volatile int ref_count; + PluieColorPrivate * priv; +}; + +struct _PluieColorClass { + GTypeClass parent_class; + void (*finalize) (PluieColor *self); +}; + +struct _PluieOutputFormatter { + GTypeInstance parent_instance; + volatile int ref_count; + PluieOutputFormatterPrivate * priv; + gint indent; + gint term_width; + PluieColorConf* conf; +}; + +struct _PluieOutputFormatterClass { + GTypeClass parent_class; + void (*finalize) (PluieOutputFormatter *self); +}; + +struct _PluieSysCmd { + GTypeInstance parent_instance; + volatile int ref_count; + PluieSysCmdPrivate * priv; +}; + +struct _PluieSysCmdClass { + GTypeClass parent_class; + void (*finalize) (PluieSysCmd *self); +}; + + +GType pluie_echo_get_type (void) G_GNUC_CONST; +gpointer pluie_output_formatter_ref (gpointer instance); +void pluie_output_formatter_unref (gpointer instance); +GParamSpec* pluie_param_spec_output_formatter (const gchar* name, const gchar* nick, const gchar* blurb, GType object_type, GParamFlags flags); +void pluie_value_set_output_formatter (GValue* value, gpointer v_object); +void pluie_value_take_output_formatter (GValue* value, gpointer v_object); +gpointer pluie_value_get_output_formatter (const GValue* value); +GType pluie_output_formatter_get_type (void) G_GNUC_CONST; +void pluie_echo_init (gboolean debug, const gchar* path, PluieOutputFormatter* * of); +extern gboolean pluie_dbg_DBG_ENABLED; +#define PLUIE_DBG_DBG_ENTER ((gint8) 1) +#define PLUIE_DBG_DBG_LEAVE ((gint8) 2) +#define PLUIE_DBG_DBG_INLINE ((gint8) 0) +#define PLUIE_DBG_DBG_ERROR ((gint8) 8) +#define PLUIE_DBG_DBG_WARN ((gint8) 9) +void pluie_dbg_init (PluieOutputFormatter* of, gboolean debug); +void pluie_dbg_in (const gchar* method, const gchar* params, gint line, const gchar* file); +void pluie_dbg_out (const gchar* method, const gchar* params, gint line, const gchar* file); +void pluie_dbg_msg (const gchar* msg, gint line, const gchar* file); +void pluie_dbg_error (const gchar* msg, const gchar* method, gint line, const gchar* file, gint8 mode); +void pluie_dbg_log (const gchar* msg, gint line, gint8 mode, const gchar* file); +gpointer pluie_color_conf_ref (gpointer instance); +void pluie_color_conf_unref (gpointer instance); +GParamSpec* pluie_param_spec_color_conf (const gchar* name, const gchar* nick, const gchar* blurb, GType object_type, GParamFlags flags); +void pluie_value_set_color_conf (GValue* value, gpointer v_object); +void pluie_value_take_color_conf (GValue* value, gpointer v_object); +gpointer pluie_value_get_color_conf (const GValue* value); +GType pluie_color_conf_get_type (void) G_GNUC_CONST; +PluieColorConf* pluie_color_conf_new (const gchar* path); +PluieColorConf* pluie_color_conf_construct (GType object_type, const gchar* path); +gpointer pluie_color_ref (gpointer instance); +void pluie_color_unref (gpointer instance); +GParamSpec* pluie_param_spec_color (const gchar* name, const gchar* nick, const gchar* blurb, GType object_type, GParamFlags flags); +void pluie_value_set_color (GValue* value, gpointer v_object); +void pluie_value_take_color (GValue* value, gpointer v_object); +gpointer pluie_value_get_color (const GValue* value); +GType pluie_color_get_type (void) G_GNUC_CONST; +PluieColor* pluie_color_conf_get (PluieColorConf* self, PluieECHO name); +gint pluie_color_conf_param (PluieColorConf* self, const gchar* name); +PluieColor* pluie_color_new (guint8* fg, gboolean bold, guint8* bg); +PluieColor* pluie_color_construct (GType object_type, guint8* fg, gboolean bold, guint8* bg); +gchar* pluie_color_to_string (PluieColor* self); +gchar* pluie_color_s (PluieColor* self, const gchar* label, gboolean off, gboolean* bold); +gchar* pluie_color_off (void); +guint8* pluie_color_get_fg (PluieColor* self); +void pluie_color_set_fg (PluieColor* self, guint8* value); +guint8* pluie_color_get_bg (PluieColor* self); +void pluie_color_set_bg (PluieColor* self, guint8* value); +gboolean pluie_color_get_bold (PluieColor* self); +void pluie_color_set_bold (PluieColor* self, gboolean value); +PluieOutputFormatter* pluie_output_formatter_new (PluieColorConf* conf); +PluieOutputFormatter* pluie_output_formatter_construct (GType object_type, PluieColorConf* conf); +PluieColor* pluie_output_formatter_c (PluieOutputFormatter* self, PluieECHO name); +gchar* pluie_output_formatter_move_up (PluieOutputFormatter* self, gint line); +gchar* pluie_output_formatter_move_down (PluieOutputFormatter* self, gint line); +PluieColor* pluie_output_formatter_test (PluieOutputFormatter* self, gboolean exp, gboolean _error_); +gchar* pluie_output_formatter_s_indent (PluieOutputFormatter* self, gint8 adjust); +gchar* pluie_output_formatter_title_sep (PluieOutputFormatter* self); +void pluie_output_formatter_title (PluieOutputFormatter* self, const gchar* label, const gchar* version, const gchar* author); +void pluie_output_formatter_action (PluieOutputFormatter* self, const gchar* name, const gchar* val); +void pluie_output_formatter_warn (PluieOutputFormatter* self, const gchar* label); +void pluie_output_formatter_error (PluieOutputFormatter* self, const gchar* label, gboolean warn); +void pluie_output_formatter_rs (PluieOutputFormatter* self, gboolean test, const gchar* done, const gchar* fail); +void pluie_output_formatter_echo_up (PluieOutputFormatter* self, gint line, const gchar* s); +void pluie_output_formatter_echo (PluieOutputFormatter* self, const gchar* data, gboolean lf, gboolean indent_all, PluieECHO color, gint8 indent_adjust); +void pluie_output_formatter_state (PluieOutputFormatter* self, gboolean test); +gchar* pluie_output_formatter_wordwrap (PluieOutputFormatter* self, const gchar* str, gint width, gboolean cut); +void pluie_output_formatter_usage_option (PluieOutputFormatter* self, const gchar* name, const gchar* shortname, const gchar* argname, gboolean val, gint echo_up); +void pluie_output_formatter_keyval (PluieOutputFormatter* self, const gchar* key, const gchar* val); +gpointer pluie_sys_cmd_ref (gpointer instance); +void pluie_sys_cmd_unref (gpointer instance); +GParamSpec* pluie_sys_param_spec_cmd (const gchar* name, const gchar* nick, const gchar* blurb, GType object_type, GParamFlags flags); +void pluie_sys_value_set_cmd (GValue* value, gpointer v_object); +void pluie_sys_value_take_cmd (GValue* value, gpointer v_object); +gpointer pluie_sys_value_get_cmd (const GValue* value); +GType pluie_sys_cmd_get_type (void) G_GNUC_CONST; +PluieSysCmd* pluie_sys_cmd_new (const gchar* name); +PluieSysCmd* pluie_sys_cmd_construct (GType object_type, const gchar* name); +gint pluie_sys_cmd_run (PluieSysCmd* self, gboolean display, const gchar* name); +const gchar* pluie_sys_cmd_get_output (PluieSysCmd* self); +const gchar* pluie_sys_cmd_get_error (PluieSysCmd* self); +const gchar* pluie_sys_cmd_get_name (PluieSysCmd* self); +gint pluie_sys_cmd_get_status (PluieSysCmd* self); + + +G_END_DECLS + +#endif diff --git a/resources/echo.ini b/resources/echo.ini new file mode 100644 index 0000000..d039266 --- /dev/null +++ b/resources/echo.ini @@ -0,0 +1,34 @@ +[Term] +term_width = 105 +indent = 4 +key_maxlen = 17 + +[Colors] +# key are fixed. overwrite only values +# fg ansi extended color code (0..255), bold (0|1), bg ansi extended color code (0..255) +default = +comment = 103,1 +option = 37,1 +option_sep = 158 +arg = 97,1 +arg_sep = 147,1 +title = 15,1,24 +title_item = 220,1 +title_sep = 24,1 +section = 37 +sep = 59 +item = 215,1 +action = 97,1 +done = 15,1,36 +fail = 15,1,196 +key = 37,1 +val = 215,1 +date = 215,1 +time = 210,1 +microtime = 204,1 +file = 95,1 +num = 218,1 +enter = 36,1 +leave = 167,1 +warn = 220,1,89 +error = 15,1,196 diff --git a/src/Pluie.Color.vala b/src/Pluie.Color.vala new file mode 100644 index 0000000..d5636e8 --- /dev/null +++ b/src/Pluie.Color.vala @@ -0,0 +1,54 @@ +public class Pluie.Color +{ + + public uint8? fg { get; set; default = 15; } + public uint8? bg { get; set; default = null; } + public bool bold { get; set; default = false; } + + + public Color (uint8? fg = 15, bool bold = false, uint8? bg = null) + { + this.fg = fg; + this.bg = bg; + this.bold = bold; + } + + + public string to_string () + { + string s = "\033[%s%sm".printf ( + this.bg == null ? "%d;".printf ((int) this.bold) + : "%d;48;5;%u%s".printf ((int) this.bold, this.bg, this.fg != null ? ";" : ""), + this.fg == null ? "" + : "38;5;%u".printf (this.fg) + ); + return s; + } + + + public string s (string? label = null, bool off = true, bool? bold = null) + { + bool prevbold = this.bold; + if (bold != null) { + this.bold = bold; + } + string s = label == null || label == "" ? ( off ? Color.off () : "") : this.echo (label, off); + if (bold != null) { + this.bold = prevbold; + } + return s; + } + + + private string echo (string label, bool off = true) + { + return "%s%s%s".printf (this.to_string (), label, off ? Color.off() : ""); + } + + + public static string off () + { + return "\033[m"; + } + +} diff --git a/src/Pluie.ColorConf.vala b/src/Pluie.ColorConf.vala new file mode 100644 index 0000000..d24647c --- /dev/null +++ b/src/Pluie.ColorConf.vala @@ -0,0 +1,96 @@ +using GLib; +using Pluie; + +public class Pluie.ColorConf +{ + + const char KF_LIST_SEP = ','; + + string path; + GLib.KeyFile kf; + string[] keys; + Array colors = new Array (); + + + public ColorConf(string path) + { + Dbg.in (Log.METHOD, "path:'%s'".printf (path), Log.LINE, Log.FILE); + this.path = path; + this.load_config(); + Dbg.out (Log.METHOD, null, Log.LINE, Log.FILE); + } + + + public new unowned Color? @get (ECHO name) + { + unowned Color c = this.colors.index ((int)name); + return c; + } + + + private void load_config (string? path = null) + { + Dbg.in (Log.METHOD, null, Log.LINE, Log.FILE); + this.kf = new KeyFile (); + Dbg.msg ("loading file", Log.LINE, Log.FILE); + this.kf.set_list_separator (ColorConf.KF_LIST_SEP); + try { + this.kf.load_from_file (path == null ? this.path : path, KeyFileFlags.NONE); + this.keys = kf.get_keys ("Colors"); + this.colors.set_size((uint) keys.length); + for (var i = 0; i < this.keys.length ; i++) { + this.colors.insert_val ((uint) i, this.load_color (this.keys[i])); + } + } + catch (KeyFileError e) { + Dbg.error (e.message, Log.METHOD, Log.LINE, Log.FILE); + } + catch (FileError e) { + Dbg.error (e.message, Log.METHOD, Log.LINE, Log.FILE); + } + Dbg.out (Log.METHOD, null, Log.LINE, Log.FILE); + } + + + private string get_config (string key, string group = "Colors") + { + string v = ""; + try { + v = this.kf.get_string (group, key); + } + catch (GLib.KeyFileError e) { + Dbg.error (e.message, Log.METHOD, Log.LINE, Log.FILE); + } + return v; + } + + + public int param (string name) + { + string[] plist = { "term_width", "indent", "key_maxlen" }; + int val = 0; + if (name in plist) { + val = int.parse (this.get_config (name, "Term")); + } + return val; + } + + + private Color load_color(string name) + { + uint8? fg = null; + uint8? bg = null; + bool bold = false; + string[] params = this.get_config(name).split(","); + if (params.length >= 3) { + bg = (uint8) int.parse(params[2]); + } + if (params.length >= 2) { + bold = (bool) int.parse(params[1]); + } + if (params.length >= 1) { + fg = (uint8) int.parse(params[0]); + } + return new Color(fg, bold, bg); + } +} diff --git a/src/Pluie.Dbg.vala b/src/Pluie.Dbg.vala new file mode 100644 index 0000000..79f5863 --- /dev/null +++ b/src/Pluie.Dbg.vala @@ -0,0 +1,96 @@ +using GLib; + +namespace Pluie.Dbg +{ + + static OutputFormatter o; + public static bool DBG_ENABLED = false; + public const int8 DBG_ENTER = 1; + public const int8 DBG_LEAVE = 2; + public const int8 DBG_INLINE = 0; + public const int8 DBG_ERROR = 8; + public const int8 DBG_WARN = 9; + + + public void init (OutputFormatter of, bool debug = false) + { + o = of; + Pluie.Dbg.DBG_ENABLED = debug; + } + + + private string parse_params (string? params) + { + string str = ""; + if (DBG_ENABLED) { + if (params != null) { + string[] list = params.split(":"); + string sep = ""; + for (var i = 0; i < list.length; i++) { + str += sep + o.c (i % 2 == 0 ? ECHO.KEY : ECHO.VAL).s (list[i] == "(null)" ? "null" : (list[i])); + sep = i % 2 == 1 ? ", " : ":"; + } + } + } + return str; + } + + public static void @in(string method, string? params = null, int line = 0, string? file = null) + { + Dbg.log ("%s (%s)".printf (method, Dbg.parse_params(params)), line, DBG_ENTER, file); + } + + + public static void @out(string method, string? params = null, int line = 0, string? file = null) + { + Dbg.log ("%s (%s)".printf (method, Dbg.parse_params(params)), line, DBG_LEAVE, file); + } + + + public static void msg(string msg, int line = 0, string? file = null) + { + Dbg.log (msg, line, DBG_INLINE, file); + } + + + public static void @error(string msg, string method, int line = 0, string? file = null, int8 mode = DBG_ERROR) + { + Dbg.log (file != null ? "%s %s (in %s)".printf (msg, Color.off (), method) : msg, line, mode, file == null ? "%s".printf (method) : file); + } + + + private static string dbg_label_mode (int8 mode) + { + string label; + switch (mode) { + case DBG_ENTER : label = o.c (ECHO.ENTER).s ("> "); break; + case DBG_LEAVE : label = o.c (ECHO.LEAVE).s ("< "); break; + case DBG_ERROR : label = o.c (ECHO.ERROR).s (" Error: ", false); break; + case DBG_WARN : label = o.c (ECHO.WARN ).s (" Warn: ", false); break; + default : label = " "; break; + } + return label; + } + + + public static void log (string msg, int line = 0, int8 mode = DBG_INLINE, string? file = null) + { + if (DBG_ENABLED) { + var time = new DateTime.now_local (); + stderr.printf ( + "%s%s%s%s%s%s%s%s%s %s\n", + o.c (ECHO.ARG ).s ("["), + o.c (ECHO.DATE).s (time.format ("%H:%M")), + o.c (ECHO.TIME).s (time.format (":%S")), + o.c (ECHO.MICROTIME).s (".%d".printf (time.get_microsecond ())), + file != null ? o.c (ECHO.COMMENT).s (" "+file) : "", + line > 0 && (mode != DBG_INLINE || file != null) ? o.c (ECHO.NUM).s (":%d".printf (line)) : "", + o.c (ECHO.ARG).s ("] "), + dbg_label_mode(mode), + line > 0 && mode == DBG_INLINE && file == null ? o.c (ECHO.NUM).s ("%d: ".printf (line))+msg : msg, + Color.off () + ); + } + } + +} diff --git a/src/Pluie.OutputFormatter.vala b/src/Pluie.OutputFormatter.vala new file mode 100644 index 0000000..56f4ac7 --- /dev/null +++ b/src/Pluie.OutputFormatter.vala @@ -0,0 +1,233 @@ +using GLib; +using Pluie; + +public class Pluie.OutputFormatter +{ + + string sep = "──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────"; + string space = " "; + string symbol = "➤"; + public int indent; + public int term_width; + int key_maxlen; + protected ColorConf conf; + + + public OutputFormatter (ColorConf conf) + { + this.conf = conf; + this.term_width = conf.param("term_width"); + this.indent = conf.param("indent"); + this.key_maxlen = conf.param("key_maxlen"); + } + + + public unowned Color c (ECHO name) + { + unowned Color color = this.conf.get (name); + return color; + } + + + public string move_up (int line) + { + return "\033[%dA".printf (line); + } + + + public string move_down (int line) + { + return "\033[%dB".printf (line); + } + + + protected Color test (bool exp, bool error = false) + { + return !error ? (exp ? this.c (ECHO.DONE) : this.c (ECHO.FAIL)) : (exp ? this.c (ECHO.ERROR) : this.c (ECHO.WARN)); + } + + + public string s_indent (int8 adjust = 0) + { + return "%.*s".printf (this.indent+adjust, this.space); + } + + + protected string title_sep () + { + return this.c (ECHO.TITLE_SEP).s (" %.*s".printf ((this.term_width-1)*3, this.sep)); + } + + + public void title (string label, string? version = null, string? author = null) + { + string s = version == null ? " " : this.c (ECHO.TITLE_ITEM).s (" v" + version+" ", false); + if (author != null) { + s += "%s %s".printf (this.c (ECHO.TITLE).s ("| by", false, false), this.c (ECHO.TITLE_ITEM).s (author, false)); + } + stdout.printf ( + "\n%s\n %s%s %s\n%s\n", + this.title_sep (), + this.c (ECHO.TITLE).s (" "+label, false), + s, + Color.off (), + this.title_sep () + ); + } + + + public void action (string name, string? val = "") + { + stdout.printf ( + "\n%s%s %s %s\n", + this.s_indent (-2), + this.c (ECHO.ITEM ).s (this.symbol, false), + this.c (ECHO.ACTION).s (name, false), + this.c (ECHO.VAL ).s (val) + ); + } + + + public void warn (string label) + { + this.error (label, true); + } + + + public void error (string label, bool warn = false) + { + stderr.printf ( + "\n%s%s\n", + this.s_indent (-2), + this.test(!warn, true).s (" %s : %s ".printf (warn ? "warn" : "error", label)) + ); + } + + + public void rs (bool test, string done = "done", string fail = "fail") + { + stdout.printf ( + "\n%s%s\n", + this.s_indent (-2), + this.test (test).s (" %s ".printf (test ? done : fail)) + ); + } + + + public void echo_up (int line, string s) + { + stdout.printf ("%s\r%s%s\r", this.move_up(line), s, this.move_down(line)); + } + + + public void echo (string? data = "", bool lf = true, bool indent_all = false, ECHO color = ECHO.DEFAULT, int8 indent_adjust = 0) + { + string s; + if (indent_all) { + var b = new StringBuilder (); + bool begin = true; + foreach (string line in data.split ("\n")) { + b.append (begin ? "" : "\n%s".printf (this.s_indent (indent_adjust))); + b.append (line); + if (begin) begin = false; + } + s = b.str; + } + else s = data; + + stdout.printf ( + "%s%s%s%s", + this.s_indent (indent_adjust), + this.c (color).s (s, false), + lf ? "\n" : "", + Color.off () + ); + } + + + public void state (bool test) + { + int len = (this.term_width)*3 - 14 - this.indent-3; + stdout.printf ( + "%s%.*s %s\n", + this.s_indent (), + len, + this.c (ECHO.SEP).s (this.sep), + this.test (test).s (" %s ".printf (test ? "OK" : "KO")) + ); + } + + + public string wordwrap (string str, int width, bool cut = false) + { + unichar c; + int char_count = 0; + int line_offset = 0; + int last_line_offset = 0; + int last_offset = 0; + int space_pos = 0; + int space_offset = 0; + unichar space = ' '; + var sb = new StringBuilder(); + for (int offset = 0; str.get_next_char (ref offset, out c); char_count++) { + if (char_count > width) { + line_offset = c == space ? offset : space_offset+1; + char_count = width - (c == space ? width+1 : space_pos); + sb.append ((string) str[last_line_offset:line_offset]); + sb.append ("\n"); + last_line_offset = line_offset; + } + if (c == space) { + space_pos = char_count; + space_offset = last_offset; + } + last_offset = offset; + } + sb.append ((string) str[line_offset:last_offset]); + return sb.str; + } + + + public void usage_option (string? name = null, string? shortname=null, string? argname = null, bool val = false, int echo_up = 0) + { + string opt = ""; + string arg = ""; + if (shortname != null) { + opt = "%s%s%s".printf ( + this.c (ECHO.OPTION).s ("-"), + this.c (ECHO.OPTION).s (shortname), + name != null ? this.c (ECHO.OPTION_SEP).s (", --") : "" + ); + } + if (name != null) { + opt += this.c (ECHO.OPTION).s (name); + } + if (argname != null) { + arg = " %s%s%s".printf ( + !val ? this.c (ECHO.ARG_SEP).s ("[") : "", + this.c (ECHO.ARG).s (argname), + !val ? this.c (ECHO.ARG_SEP).s ("]") : "" + ); + } + if (echo_up > 0) { + this.echo_up (echo_up, "%s%s%s".printf (this.s_indent(), opt, arg)); + } + else { + stdout.printf ("%s%s%s\n", this.s_indent(), opt, arg); + } + } + + + public void keyval (string key, string val) + { + int len = this.key_maxlen - (int) key.length; + stdout.printf ( + "%s %s "+@" %$(len)s : %s\n", + this.s_indent (), + this.c (ECHO.KEY).s (key), + " ", + this.c (ECHO.VAL).s (val) + ); + } + +} diff --git a/src/Pluie.Sys.Cmd.vala b/src/Pluie.Sys.Cmd.vala new file mode 100644 index 0000000..3f3278e --- /dev/null +++ b/src/Pluie.Sys.Cmd.vala @@ -0,0 +1,54 @@ +using GLib; + +public class Pluie.Sys.Cmd +{ + + public string output { get; private set; } + public string error { get; private set; } + public string name { get; private set; } + public int status { get; private set; } + + + public Cmd (string name) + { + Dbg.in (Log.METHOD, "name:'%s'".printf (name), Log.LINE, Log.FILE); + this.init_cmd (name); + Dbg.out (Log.METHOD, null, Log.LINE, Log.FILE); + } + + + private void init_cmd (string name) + { + Dbg.in (Log.METHOD, "name:'%s'".printf (name), Log.LINE, Log.FILE); + this.name = name; + this.output = null; + this.error = null; + this.status = -1; + Dbg.out (Log.METHOD, null, Log.LINE, Log.FILE); + } + + + public int run (bool display = false, string? name = null) + { + Dbg.in (Log.METHOD, "display:%d:name:'%s'".printf ((int)display, name), Log.LINE, Log.FILE); + try { + if (name != null) { + this.init_cmd (name); + } + int s; string o, e; + Process.spawn_command_line_sync (this.name, out o, out e, out s); + this.status = s; + this.output = o; + this.error = e; + if (display) { + stdout.printf ("runing %s :\n%s", this.name, this.output); + } + } + catch (SpawnError e) { + stderr.printf ("%s\n", e.message); + } + Dbg.out (Log.METHOD, "status:%d".printf (this.status), Log.LINE, Log.FILE); + return this.status; + } + +} diff --git a/src/Pluie.global.vala b/src/Pluie.global.vala new file mode 100644 index 0000000..84ed6c8 --- /dev/null +++ b/src/Pluie.global.vala @@ -0,0 +1,45 @@ +using GLib; +using Pluie; + +namespace Pluie +{ + public enum ECHO + { + DEFAULT, + COMMENT, + OPTION, + OPTION_SEP, + ARG, + ARG_SEP, + TITLE, + TITLE_ITEM, + TITLE_SEP, + SECTION, + SEP, + ITEM, + ACTION, + DONE, + FAIL, + KEY, + VAL, + DATE, + TIME, + MICROTIME, + FILE, + NUM, + ENTER, + LEAVE, + WARN, + ERROR; + } + + namespace Echo + { + public void init (bool debug, string path, out OutputFormatter of) + { + var conf = new ColorConf (path); + of = new OutputFormatter (conf); + Dbg.init (of, debug); + } + } +}