diff options
48 files changed, 1423 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ddc2bd1 --- /dev/null +++ b/.gitignore @@ -0,0 +1,14 @@ +# general things to ignore +build/ +dist/ +*.egg-info/ +*.egg +*.py[cod] +__pycache__/ +*.so +*~ +venv/ + +# due to using nox and pytest +.nox +.cache @@ -0,0 +1,675 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<https://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<https://www.gnu.org/licenses/why-not-lgpl.html>. + diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..e467c66 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,39 @@ +# https://packaging.python.org/en/latest/tutorials/packaging-projects/#choosing-a-build-backend +[build-system] +requires = ["setuptools"] +build-backend = "setuptools.build_meta" + +[project] +name = "skaldpress" +version = "1.0.0" # REQUIRED, although can be dynamic +description = "" +readme = "README" +requires-python = ">=3.10" +license = { file = "LICENSE" } +authors = [{ name = "Qrius", email = "[email protected]" }] + +classifiers = [ + "Development Status :: 3 - Alpha", + "Intended Audience :: Developers", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Programming Language :: Python :: 3 :: Only", +] +dependencies = ["markdown", "py-gfm"] + +[project.optional-dependencies] +dev = ["check-manifest", "black"] +test = ["coverage"] + +[project.urls] +"Homepage" = "https://git.quirio.net/skaldpress" + +[project.scripts] +smp = "smp:main" +#skaldpress = "skaldpress:main" + +[tool.setuptools] diff --git a/src/smp/__init__.py b/src/smp/__init__.py new file mode 100644 index 0000000..63cecaf --- /dev/null +++ b/src/smp/__init__.py @@ -0,0 +1,45 @@ +__version__ = "0.0.1" +import smp.macro_processor +import smp.builtins + + +def repl(): + print("=Skaldpress Macro Processor (REPL)") + # print(" type \"quit\" to exit"); + print("NOT IMPLEMENTED") + # Intend to use code.InteractiveConsole or code.InteractiveInterpreter + # as well as the readline library + + +def read_stdin(): + import sys + + data = sys.stdin.read() + smp = macro_processor.MacroProcessor() + res = smp.process_input(data) + print("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━", file=sys.stderr) + print(res) + + +def main(): + import sys + + if not sys.stdin.isatty(): + read_stdin() + sys.exit(0) + + if len(sys.argv) > 1 and sys.argv[1] == "-": + read_stdin() + sys.exit(0) + + if len(sys.argv) == 1: + repl() + sys.exit(0) + + with open(sys.argv[1], "r") as f: + file_content = f.read() + + smp = macro_processor.MacroProcessor() + res = smp.process_input(file_content) + print("━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━", file=sys.stderr) + print(res) diff --git a/src/smp/builtins.py b/src/smp/builtins.py new file mode 100644 index 0000000..4cbb0a3 --- /dev/null +++ b/src/smp/builtins.py @@ -0,0 +1,153 @@ +import smp.exceptions +import subprocess +import datetime +import markdown +from gfm import AutolinkExtension, TaskListExtension + +def smp_builtin_define(macro_processor, macro_name, macro_value=None): + macro_name = macro_processor.process_input(macro_name) + if macro_value is not None: + macro_value = macro_processor.process_input(macro_value) + macro_processor.macros[macro_name] = macro_value + else: + macro_processor.macros[macro_name] = "" + return "" + + +def smp_builtin_undefine(macro_processor, macro_name): + if macro_name in macro_processor.macros: + del macro_processor[macro_name] + return "" + + +def smp_builtin_define_array(macro_processor, macro_name): + macro_name = macro_processor.process_input(macro_name) + macro_processor.macros[macro_name] = list() + return "" + + +def smp_builtin_ifdef(macro_processor, macro_name, iftrue, iffalse=None): + if macro_name in macro_processor.macros: + return macro_processor.process_input(iftrue) + if iffalse is not None: + return macro_processor.process_input(iffalse) + return "" + + +def smp_builtin_ifndef(macro_processor, macro_name, iftrue, iffalse=None): + if macro_name not in macro_processor.macros: + return macro_processor.process_input(iftrue) + if iffalse is not None: + return macro_processor.process_input(iffalse) + return "" + + +def smp_builtin_ifeq(macro_processor, a, b, iftrue, iffalse=None): + a = macro_processor.process_input(a) + b = macro_processor.process_input(b) + if a == b: + return macro_processor.process_input(iftrue) + if iffalse is not None: + return macro_processor.process_input(iffalse) + return "" + + +def smp_builtin_ifneq(macro_processor, a, b, iftrue, iffalse=None): + a = macro_processor.process_input(a) + b = macro_processor.process_input(b) + if a != b: + return macro_processor.process_input(iftrue) + if iffalse is not None: + return macro_processor.process_input(iffalse) + return "" + + +def smp_builtin_include(macro_processor, filename): + filename = macro_processor.process_input(filename) + with open(filename, "r") as f: + file_content = f.read() + return macro_processor.process_input(file_content) + + +def smp_builtin_include_verbatim(macro_processor, filename): + filename = macro_processor.process_input(filename) + with open(filename, "r") as f: + file_content = f.read() + return file_content + + +def smp_builtin_shell(macro_processor, cmd_args): + cmd_args = macro_processor.process_input(cmd_args) + return subprocess.check_output(cmd_args, shell=True).decode() + + +def smp_builtin_eval(macro_processor, expression): + r = eval(expression, macro_processor.py_global_env, macro_processor.macros) + return r + + +def smp_builtin_array_push(macro_processor, array_name, *values): + if array_name not in macro_processor.macros: + raise Exception(f"{array_name} is not a macro") + if not isinstance(macro_processor.macros[array_name], list): + raise Exception(f"{array_name} is not a array") + for value in values: + macro_processor.macros[array_name].append(value) + return "" + + +def smp_builtin_array_size(macro_processor, array_name): + if array_name not in macro_processor.macros: + raise Exception(f"{array_name} is not a macro") + if not isinstance(macro_processor.macros[array_name], list): + raise Exception(f"{array_name} is not a array") + return str(len(macro_processor.macros[array_name])) + + +def smp_builtin_array_each(macro_processor, array_name, template): + if array_name not in macro_processor.macros: + raise Exception(f"{array_name} is not a macro") + if not isinstance(macro_processor.macros[array_name], list): + raise Exception(f"{array_name} is not a array") + out = "" + for el in macro_processor.macros[array_name]: + if isinstance(el, str): + el = [el] + out += macro_processor.process_input(macro_processor.expand_macro(template, el)) + return out + +def smp_builtin_explode(macro_processor, array_name, delimiter, input): + if array_name not in macro_processor.macros: + raise Exception(f"{array_name} is not a macro") + if not isinstance(macro_processor.macros[array_name], list): + raise Exception(f"{array_name} is not a array") + delimiter = macro_processor.process_input(delimiter) + for el in macro_processor.process_input(input).split(delimiter): + macro_processor.macros[array_name].append(el) + return "" + +def smp_builtin_format_time(macro_processor, format, time): + timestamp = macro_processor.process_input(time) + dobj = datetime.datetime.fromisoformat(timestamp) + return dobj.strftime(format) + +def smp_builtin_html_from_markdown(macro_processor, text, extensions=list()): + # Get rid of quoting, I don't remember why, but the rust implementation does it like this. + for _ in range(2): + text = macro_processor.process_input(text) + extensions.append(AutolinkExtension()) + extensions.append(TaskListExtension(max_depth=2)) + return markdown.markdown(text, extensions=extensions) + +def smp_builtin_dumpenv(macro_processor): + out = "" + out += "━ Macros ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n" + for key, val in macro_processor.macros.items(): + out += f"{repr(key)}: {repr(val)}\n" + out += "━ Globals ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n" + for key, val in macro_processor.py_global_env.items(): + if key == "__builtins__": + continue + out += f"{repr(key)}: {repr(val)}\n" + out += "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━" + return out diff --git a/src/smp/exceptions.py b/src/smp/exceptions.py new file mode 100644 index 0000000..62eee32 --- /dev/null +++ b/src/smp/exceptions.py @@ -0,0 +1,7 @@ +class SMPException(Exception): + pass + + +class MacroArgumentException(Exception): + def __init__(self, message): + super().__init__(message) diff --git a/src/smp/macro_processor.py b/src/smp/macro_processor.py new file mode 100644 index 0000000..ad996d7 --- /dev/null +++ b/src/smp/macro_processor.py @@ -0,0 +1,287 @@ +import smp.builtins +import traceback +import inspect + +from typing import Any +from enum import Enum +from io import StringIO +from contextlib import redirect_stdout + + +class ParserState(Enum): + NORMAL = 1 + IN_QUOTES = 2 + IN_MACRO = 3 + IN_MACRO_ARGS = 4 + IN_SPECIAL_MACRO = 5 + IN_SPECIAL_MACRO_EXPRESSION = 6 + IN_CODE = 7 + DNL = 8 + + +def macro_is_whitespace_deleting(s: str) -> bool: + if len(s) == 0: + return False + return s[-1] == "_" + + +def macro_name_clean(macro_name: str) -> str: + if macro_is_whitespace_deleting(macro_name): + macro_name = macro_name[:-1] + return macro_name + + +class MacroProcessor: + """All currently defined macros in this MacroProcessor""" + + macros: dict[str, Any] + """ All macro invocations that has happened """ + macro_invocations: list[tuple[str, list[str]]] + """ Emitted warnings """ + warnings: list[Any] + """ Global environment for python execution """ + py_global_env: dict + + special_macros: dict[str, tuple[str, str]] + + def __init__(self, prefix=""): + self.macros = dict() + self.special_macros = dict() + self.macro_invocations = list() + self.warnings = list() + self.py_global_env = dict() + self._define_builtins(prefix=prefix) + + def _define_builtins(self, prefix=""): + self.macros[f"{prefix}define"] = smp.builtins.smp_builtin_define + self.macros[f"{prefix}undefine"] = smp.builtins.smp_builtin_undefine + self.macros[f"{prefix}define_array"] = smp.builtins.smp_builtin_define_array + self.macros[f"{prefix}ifdef"] = smp.builtins.smp_builtin_ifdef + self.macros[f"{prefix}ifndef"] = smp.builtins.smp_builtin_ifndef + self.macros[f"{prefix}ifeq"] = smp.builtins.smp_builtin_ifeq + self.macros[f"{prefix}ifneq"] = smp.builtins.smp_builtin_ifneq + self.macros[f"{prefix}include"] = smp.builtins.smp_builtin_include + self.macros[f"{prefix}include_verbatim"] = ( + smp.builtins.smp_builtin_include_verbatim + ) + self.macros[f"{prefix}shell"] = smp.builtins.smp_builtin_shell + self.macros[f"{prefix}dumpenv"] = smp.builtins.smp_builtin_dumpenv + self.macros[f"{prefix}eval"] = smp.builtins.smp_builtin_eval + self.macros[f"{prefix}array_push"] = smp.builtins.smp_builtin_array_push + self.macros[f"{prefix}array_each"] = smp.builtins.smp_builtin_array_each + self.macros[f"{prefix}array_size"] = smp.builtins.smp_builtin_array_size + self.macros[f"{prefix}explode"] = smp.builtins.smp_builtin_explode + self.macros[f"{prefix}format_time"] = smp.builtins.smp_builtin_format_time + self.macros[f"{prefix}html_from_markdown"] = smp.builtins.smp_builtin_html_from_markdown + self.special_macros[f"test"] = ("", "") + + def expand_macro(self, macro_name: str, args: list[str] = list()) -> str: + # Ignore trailing underscore in macro name, the parser will pop a space in front if + # present, but we should ignore it for finding the macro. + macro_name = macro_name_clean(macro_name) + if macro_name not in self.macros: + if len(args) == 0: + return macro_name + out = f"{macro_name}(" + for i, arg in enumerate(args): + out += self.process_input(arg) + if i < (len(args) - 1): + out += "," + out += ")" + return out + + # Strip leading whitespace from arguments + for arg in args: + arg = arg.strip() + + # Log macro invokation + # The fact that we are here, does not ensure that the macro is actually expanded into + # something useful, just that it exists, and was invoked + self.macro_invocations.append((macro_name, args)) + + macro = self.macros.get(macro_name) + + if callable(macro): + signature = inspect.signature(macro) + macro_args = [] + if ( + "macro_processor" in signature.parameters + or "smp" in signature.parameters + ): + macro_args.append(self) + macro_args.extend(args) + return str(macro(*macro_args)) + if isinstance(macro, str): + expanded = macro + for i, arg in enumerate(args): + placeholder = f"${i}" + expanded = macro.replace(placeholder, arg) + return self.process_input(expanded) + return f"{repr(macro)}" + + def process_input(self, input: str): + """ + I also want to add special syntax for "special blocks", + I am thinking of two main options, either some macro_names are intercepted, _or_ a special kind of macro can exist like + These will be on a line-basis, so they simply end on newline + @if <python-expression> + + @else <python-expression> + + @endif + + @for <python-expression> + @endfor + """ + output = "" + state = ParserState.NORMAL + macro_name = "" + macro_args = [] + argument = "" + py_expr = "" + + skip_next_line_ending = False + + # We should keep track of filename, linenumber, and character number on line here + # So we can give sensible error messages + + quote_level = 0 + parens_level = 0 + + i = 0 + while i < len(input): + c = input[i] + peek = None if i + 1 >= len(input) else input[i + 1] + #prev = None if i - 1 < 0 else input[i - 1] + + # import sys + # print(f"[{i:4}] {repr(c):4} -> {repr(peek):4} [{state}] = {repr(output)}", file=sys.stderr) + + if state == ParserState.DNL: + if c == "\n": + state = ParserState.NORMAL + elif state == ParserState.NORMAL: + if skip_next_line_ending and (c == "\n"): + skip_next_line_ending = False + i += 1 + continue + + if c == "%" and peek == "(": + state = ParserState.IN_CODE + i += 2 + continue + + if c == "%" and peek == '"': + state = ParserState.IN_QUOTES + quote_level += 1 + i += 1 + elif c.isalnum(): + state = ParserState.IN_MACRO + macro_name += c + else: + output += c + + elif state == ParserState.IN_QUOTES: + if c == "%" and peek == '"': + quote_level += 1 + i += 1 + output += '%"' + elif c == '"' and peek == "%": + quote_level -= 1 + if quote_level == 0: + state = ParserState.NORMAL + else: + output += '"%' + i += 1 + else: + output += c + elif state == ParserState.IN_MACRO: + if c.isalnum() or c == "_": + macro_name += c + elif c == "(": + parens_level += 1 + state = ParserState.IN_MACRO_ARGS + else: + if macro_is_whitespace_deleting(macro_name): + if output[-1] == " ": + output = output[:-1] + macro_name = macro_name_clean(macro_name) + + if macro_name == "SNNL": + skip_next_line_ending = c != "\n" + elif macro_name == "DNL": + if c != "\n": + state = ParserState.DNL + macro_name = "" + i += 1 + continue + else: + expanded = self.expand_macro(macro_name) + output += expanded + output += c + macro_name = "" + state = ParserState.NORMAL + elif state == ParserState.IN_MACRO_ARGS: + if c == "%" and peek == '"': + quote_level += 1 + i += 2 + argument += '%"' + continue + elif c == '"' and peek == "%": + quote_level -= 1 + i += 2 + argument += '"%' + continue + elif quote_level > 0: + argument += c + i += 1 + continue + + if (c == ")") and (parens_level == 1): + if macro_is_whitespace_deleting(macro_name): + if output[-1] == " ": + output = output[:-1] + macro_name = macro_name_clean(macro_name) + parens_level = 0 + macro_args.append(argument.strip()) + expanded = self.expand_macro(macro_name, macro_args) + output += expanded + state = ParserState.NORMAL + macro_name = "" + macro_args = [] + argument = "" + elif (c == ",") and (parens_level == 1): + macro_args.append(argument.strip()) + argument = "" + else: + if c == "(": + parens_level += 1 + if c == ")": + parens_level -= 1 + argument += c + elif state == ParserState.IN_CODE: + if c == ")" and peek == "%": + try: + f = StringIO() + with redirect_stdout(f): + exec(py_expr, self.py_global_env, self.macros) + s = f.getvalue() + if s != "": + output += s + except Exception: + traceback.print_exc() + py_expr = "" + state = ParserState.NORMAL + i += 1 + else: + py_expr += c + i += 1 + + # Handle cases where the text ends with a macro without arguments + if macro_name != "": + if macro_is_whitespace_deleting(macro_name): + if output[-1] == " ": + output = output[:-1] + macro_name = macro_name_clean(macro_name) + output += self.expand_macro(macro_name) + return output diff --git a/tests/example_include.smp b/tests/example_include.smp new file mode 100644 index 0000000..f38b21f --- /dev/null +++ b/tests/example_include.smp @@ -0,0 +1 @@ +define(SMP)SNNL diff --git a/tests/input_files/array_each_1 b/tests/input_files/array_each_1 new file mode 100644 index 0000000..5844d71 --- /dev/null +++ b/tests/input_files/array_each_1 @@ -0,0 +1,7 @@ +define_array(arr)DNL +define(item, <span>$0</span>)DNL +array_push(arr, test)DNL +array_push(arr, tast)DNL +array_each(arr, item) +--- +<span>test</span><span>tast</span> diff --git a/tests/input_files/array_push_1 b/tests/input_files/array_push_1 new file mode 100644 index 0000000..fb59320 --- /dev/null +++ b/tests/input_files/array_push_1 @@ -0,0 +1,5 @@ +define_array(arr)DNL +array_push(arr, test)DNL +array_size(arr) +--- +1 diff --git a/tests/input_files/array_push_2 b/tests/input_files/array_push_2 new file mode 100644 index 0000000..3b4d652 --- /dev/null +++ b/tests/input_files/array_push_2 @@ -0,0 +1,5 @@ +define_array(arr)DNL +array_push(arr, test, tast, toast)DNL +array_size(arr) +--- +3 diff --git a/tests/input_files/array_push_3 b/tests/input_files/array_push_3 new file mode 100644 index 0000000..60417b4 --- /dev/null +++ b/tests/input_files/array_push_3 @@ -0,0 +1,8 @@ +define_array(arr)DNL +array_push(arr, test, tast, toast)DNL +array_size(arr) +array_push(arr, test, tast, toast)DNL +array_size(arr) +--- +3 +6 diff --git a/tests/input_files/define_1 b/tests/input_files/define_1 new file mode 100644 index 0000000..68002ea --- /dev/null +++ b/tests/input_files/define_1 @@ -0,0 +1,5 @@ +define(TEMP, testvalue) +TEMP +--- + +testvalue diff --git a/tests/input_files/define_2 b/tests/input_files/define_2 new file mode 100644 index 0000000..016294a --- /dev/null +++ b/tests/input_files/define_2 @@ -0,0 +1,3 @@ +define(TEMP, TEMP2)define(TEMP)ifdef(TEMP2, TEMP2_ISDEF) +--- +TEMP2_ISDEF diff --git a/tests/input_files/dnl_1 b/tests/input_files/dnl_1 new file mode 100644 index 0000000..c12bc01 --- /dev/null +++ b/tests/input_files/dnl_1 @@ -0,0 +1,4 @@ +DNL +test +--- +test diff --git a/tests/input_files/dnl_2 b/tests/input_files/dnl_2 new file mode 100644 index 0000000..356aee9 --- /dev/null +++ b/tests/input_files/dnl_2 @@ -0,0 +1,4 @@ +DNL ifdef(a, b, c) +test +--- +test diff --git a/tests/input_files/dnl_3 b/tests/input_files/dnl_3 new file mode 100644 index 0000000..356aee9 --- /dev/null +++ b/tests/input_files/dnl_3 @@ -0,0 +1,4 @@ +DNL ifdef(a, b, c) +test +--- +test diff --git a/tests/input_files/dnl_4 b/tests/input_files/dnl_4 new file mode 100644 index 0000000..67c1c0e --- /dev/null +++ b/tests/input_files/dnl_4 @@ -0,0 +1,4 @@ +DNL +test +--- +test diff --git a/tests/input_files/explode_1 b/tests/input_files/explode_1 new file mode 100644 index 0000000..79b70ba --- /dev/null +++ b/tests/input_files/explode_1 @@ -0,0 +1,5 @@ +define_array(arr)DNL +explode(arr, |, a|b|c|d)DNL +array_size(arr) +--- +4 diff --git a/tests/input_files/explode_2 b/tests/input_files/explode_2 new file mode 100644 index 0000000..7ef0c08 --- /dev/null +++ b/tests/input_files/explode_2 @@ -0,0 +1,6 @@ +define_array(arr)DNL +define(item, $0)DNL +explode(arr, |, a|b|c|d)DNL +array_each(arr, item) +--- +abcd diff --git a/tests/input_files/format_time_1 b/tests/input_files/format_time_1 new file mode 100644 index 0000000..bd9a097 --- /dev/null +++ b/tests/input_files/format_time_1 @@ -0,0 +1,3 @@ +format_time(%d %B %Y, 2024-04-04T00:00:00Z) +--- +04 April 2024 diff --git a/tests/input_files/ifdef_1 b/tests/input_files/ifdef_1 new file mode 100644 index 0000000..a308141 --- /dev/null +++ b/tests/input_files/ifdef_1 @@ -0,0 +1,6 @@ +define(MAC1, test)SNNL +ifdef(MAC1, MAC1_ISDEF) +ifdef(MAC2, MAC2_ISDEF, MAC2_ISNDEF) +--- +MAC1_ISDEF +MAC2_ISNDEF diff --git a/tests/input_files/ifdef_2 b/tests/input_files/ifdef_2 new file mode 100644 index 0000000..ecef66c --- /dev/null +++ b/tests/input_files/ifdef_2 @@ -0,0 +1,3 @@ +ifdef(MAC, MAC_ISDEF) +--- + diff --git a/tests/input_files/ifdef_3 b/tests/input_files/ifdef_3 new file mode 100644 index 0000000..4867034 --- /dev/null +++ b/tests/input_files/ifdef_3 @@ -0,0 +1,3 @@ +ifdef(MAC, MAC_ISDEF, MAC_ISNDEF) +--- +MAC_ISNDEF diff --git a/tests/input_files/ifeq_1 b/tests/input_files/ifeq_1 new file mode 100644 index 0000000..3e49f68 --- /dev/null +++ b/tests/input_files/ifeq_1 @@ -0,0 +1,3 @@ +ifeq(a, a, true, false) +--- +true diff --git a/tests/input_files/ifeq_2 b/tests/input_files/ifeq_2 new file mode 100644 index 0000000..fe7c0ac --- /dev/null +++ b/tests/input_files/ifeq_2 @@ -0,0 +1,3 @@ +ifeq(a, b, true, false) +--- +false diff --git a/tests/input_files/ifeq_3 b/tests/input_files/ifeq_3 new file mode 100644 index 0000000..42646b8 --- /dev/null +++ b/tests/input_files/ifeq_3 @@ -0,0 +1,3 @@ +ifeq(a, a, true) +--- +true diff --git a/tests/input_files/ifeq_4 b/tests/input_files/ifeq_4 new file mode 100644 index 0000000..d069530 --- /dev/null +++ b/tests/input_files/ifeq_4 @@ -0,0 +1,3 @@ +ifeq(a, b, true) +--- + diff --git a/tests/input_files/ifndef_1 b/tests/input_files/ifndef_1 new file mode 100644 index 0000000..857204b --- /dev/null +++ b/tests/input_files/ifndef_1 @@ -0,0 +1,3 @@ +ifndef(MAC, MAC_ISNDEF) +--- +MAC_ISNDEF diff --git a/tests/input_files/ifndef_2 b/tests/input_files/ifndef_2 new file mode 100644 index 0000000..fbe0ba3 --- /dev/null +++ b/tests/input_files/ifndef_2 @@ -0,0 +1,4 @@ +define(MAC, test)SNNL +ifndef(MAC, MAC_ISNDEF, MAC_ISDEF) +--- +MAC_ISDEF diff --git a/tests/input_files/ifndef_3 b/tests/input_files/ifndef_3 new file mode 100644 index 0000000..82a180d --- /dev/null +++ b/tests/input_files/ifndef_3 @@ -0,0 +1,4 @@ +define(MAC, test)SNNL +ifndef(MAC, MAC_ISNDEF) +--- + diff --git a/tests/input_files/ifneq_1 b/tests/input_files/ifneq_1 new file mode 100644 index 0000000..5b443c5 --- /dev/null +++ b/tests/input_files/ifneq_1 @@ -0,0 +1,3 @@ +ifneq(a, a, true, false) +--- +false diff --git a/tests/input_files/ifneq_2 b/tests/input_files/ifneq_2 new file mode 100644 index 0000000..8145e9f --- /dev/null +++ b/tests/input_files/ifneq_2 @@ -0,0 +1,3 @@ +ifneq(a, b, true, false) +--- +true diff --git a/tests/input_files/ifneq_3 b/tests/input_files/ifneq_3 new file mode 100644 index 0000000..163d871 --- /dev/null +++ b/tests/input_files/ifneq_3 @@ -0,0 +1,3 @@ +ifneq(a, a, true) +--- + diff --git a/tests/input_files/ifneq_4 b/tests/input_files/ifneq_4 new file mode 100644 index 0000000..c93a572 --- /dev/null +++ b/tests/input_files/ifneq_4 @@ -0,0 +1,3 @@ +ifneq(a, b, true) +--- +true diff --git a/tests/input_files/include_1 b/tests/input_files/include_1 new file mode 100644 index 0000000..1621de2 --- /dev/null +++ b/tests/input_files/include_1 @@ -0,0 +1,3 @@ +include(tests/example_include.smp) +--- + diff --git a/tests/input_files/include_2 b/tests/input_files/include_2 new file mode 100644 index 0000000..2714eff --- /dev/null +++ b/tests/input_files/include_2 @@ -0,0 +1,4 @@ +include(tests/example_include.smp)SNNL +ifdef(SMP, SMP_ISDEF, SMP_ISNDEF) +--- +SMP_ISDEF diff --git a/tests/input_files/markdown_html_1 b/tests/input_files/markdown_html_1 new file mode 100644 index 0000000..6a9f143 --- /dev/null +++ b/tests/input_files/markdown_html_1 @@ -0,0 +1,5 @@ +html_from_markdown(%" +# Test +"%) +--- +<h1>Test</h1> diff --git a/tests/input_files/markdown_html_2 b/tests/input_files/markdown_html_2 new file mode 100644 index 0000000..6a9f143 --- /dev/null +++ b/tests/input_files/markdown_html_2 @@ -0,0 +1,5 @@ +html_from_markdown(%" +# Test +"%) +--- +<h1>Test</h1> diff --git a/tests/input_files/non_macro_html b/tests/input_files/non_macro_html new file mode 100644 index 0000000..6f49b4a --- /dev/null +++ b/tests/input_files/non_macro_html @@ -0,0 +1,7 @@ +<html> + <p>This is a <em>test</em></p> +</html> +--- +<html> + <p>This is a <em>test</em></p> +</html> diff --git a/tests/input_files/shell_1 b/tests/input_files/shell_1 new file mode 100644 index 0000000..3eb1f14 --- /dev/null +++ b/tests/input_files/shell_1 @@ -0,0 +1,3 @@ +shell(printf test) +--- +test diff --git a/tests/input_files/snnl_1 b/tests/input_files/snnl_1 new file mode 100644 index 0000000..47a10b9 --- /dev/null +++ b/tests/input_files/snnl_1 @@ -0,0 +1,4 @@ +SNNL +test +--- +test diff --git a/tests/input_files/snnl_2 b/tests/input_files/snnl_2 new file mode 100644 index 0000000..2fcd0ba --- /dev/null +++ b/tests/input_files/snnl_2 @@ -0,0 +1,4 @@ +SNNL +test +--- +test diff --git a/tests/input_files/snnl_3 b/tests/input_files/snnl_3 new file mode 100644 index 0000000..4a7dad7 --- /dev/null +++ b/tests/input_files/snnl_3 @@ -0,0 +1,5 @@ +define(MAC1, test)SNNL +MAC1 SNNL +test +--- +test test diff --git a/tests/input_files/special_macros_1 b/tests/input_files/special_macros_1 new file mode 100644 index 0000000..eba505b --- /dev/null +++ b/tests/input_files/special_macros_1 @@ -0,0 +1,3 @@ +@test +--- +@test diff --git a/tests/input_files/whitespace_deleting_1 b/tests/input_files/whitespace_deleting_1 new file mode 100644 index 0000000..ccda45f --- /dev/null +++ b/tests/input_files/whitespace_deleting_1 @@ -0,0 +1,3 @@ +define(a, b) a +--- + b diff --git a/tests/input_files/whitespace_deleting_2 b/tests/input_files/whitespace_deleting_2 new file mode 100644 index 0000000..8777c39 --- /dev/null +++ b/tests/input_files/whitespace_deleting_2 @@ -0,0 +1,3 @@ +define(a, b) a_ +--- +b diff --git a/tests/test_macro_processor.sh b/tests/test_macro_processor.sh new file mode 100755 index 0000000..1a7accd --- /dev/null +++ b/tests/test_macro_processor.sh @@ -0,0 +1,43 @@ +#!/bin/bash + +ALL_OUTPUT=0 + +test () { + file_content=$(<tests/input_files/$1) + readarray -t sections < <(awk -v RS="---" '{print}' <<< "$file_content") + var1=$(echo "$file_content" | awk -v RS="\n---\n" 'NR==1') + var2=$(echo "$file_content" | awk -v RS="\n---\n" 'NR==2') + + if [ "$ALL_OUTPUT" -eq 0 ]; then + res=$(echo -n "$var1" | smp 2> /dev/null) + else + res=$(echo -n "$var1" | smp) + fi + if [ ! "$res" = "$var2" ]; then + tput setaf 1 + echo "$1 NOT OK:" + tput setaf 3 + echo "- Expected --" + echo "$var2" + tput setaf 1 + echo "- Result ----" + echo "$res" + echo "-------------" + tput sgr0 + exit 1 + else + tput setaf 2 + echo "$1 OK" + tput sgr0 + fi +} + +if [ "$#" -eq 1 ]; then + ALL_OUTPUT=1 + test $1 +else + for file in tests/input_files/*; do + test "$(basename $file)" + done +fi + |