From 38115d1ec5a8777c18203ce260ee6e70136e4b7e Mon Sep 17 00:00:00 2001 From: madmurphy Date: Tue, 10 Sep 2019 12:32:39 +0100 Subject: [PATCH] Commit #4 --- COPYING | 828 +++++++++++++++++++++++++++++++++++--------- ChangeLog.md | 29 +- README.md | 21 +- VERSION | 1 - m4/not-automake.m4 | 33 +- m4/not-autoshell.m4 | 5 +- m4/not-autotools.m4 | 6 +- m4/not-m4sugar.m4 | 365 ++++++++++--------- m4/not-misc.m4 | 2 +- package.json | 38 ++ 10 files changed, 981 insertions(+), 347 deletions(-) delete mode 100644 VERSION create mode 100644 package.json diff --git a/COPYING b/COPYING index 0a04128..10926e8 100644 --- a/COPYING +++ b/COPYING @@ -1,165 +1,675 @@ - GNU LESSER GENERAL PUBLIC LICENSE + GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 - Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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: + + Copyright (C) + 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 +. - This version of the GNU Lesser General Public License incorporates -the terms and conditions of version 3 of the GNU General Public -License, supplemented by the additional permissions listed below. - - 0. Additional Definitions. - - As used herein, "this License" refers to version 3 of the GNU Lesser -General Public License, and the "GNU GPL" refers to version 3 of the GNU -General Public License. - - "The Library" refers to a covered work governed by this License, -other than an Application or a Combined Work as defined below. - - An "Application" is any work that makes use of an interface provided -by the Library, but which is not otherwise based on the Library. -Defining a subclass of a class defined by the Library is deemed a mode -of using an interface provided by the Library. - - A "Combined Work" is a work produced by combining or linking an -Application with the Library. The particular version of the Library -with which the Combined Work was made is also called the "Linked -Version". - - The "Minimal Corresponding Source" for a Combined Work means the -Corresponding Source for the Combined Work, excluding any source code -for portions of the Combined Work that, considered in isolation, are -based on the Application, and not on the Linked Version. - - The "Corresponding Application Code" for a Combined Work means the -object code and/or source code for the Application, including any data -and utility programs needed for reproducing the Combined Work from the -Application, but excluding the System Libraries of the Combined Work. - - 1. Exception to Section 3 of the GNU GPL. - - You may convey a covered work under sections 3 and 4 of this License -without being bound by section 3 of the GNU GPL. - - 2. Conveying Modified Versions. - - If you modify a copy of the Library, and, in your modifications, a -facility refers to a function or data to be supplied by an Application -that uses the facility (other than as an argument passed when the -facility is invoked), then you may convey a copy of the modified -version: - - a) under this License, provided that you make a good faith effort to - ensure that, in the event an Application does not supply the - function or data, the facility still operates, and performs - whatever part of its purpose remains meaningful, or - - b) under the GNU GPL, with none of the additional permissions of - this License applicable to that copy. - - 3. Object Code Incorporating Material from Library Header Files. - - The object code form of an Application may incorporate material from -a header file that is part of the Library. You may convey such object -code under terms of your choice, provided that, if the incorporated -material is not limited to numerical parameters, data structure -layouts and accessors, or small macros, inline functions and templates -(ten or fewer lines in length), you do both of the following: - - a) Give prominent notice with each copy of the object code that the - Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the object code with a copy of the GNU GPL and this license - document. - - 4. Combined Works. - - You may convey a Combined Work under terms of your choice that, -taken together, effectively do not restrict modification of the -portions of the Library contained in the Combined Work and reverse -engineering for debugging such modifications, if you also do each of -the following: - - a) Give prominent notice with each copy of the Combined Work that - the Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the Combined Work with a copy of the GNU GPL and this license - document. - - c) For a Combined Work that displays copyright notices during - execution, include the copyright notice for the Library among - these notices, as well as a reference directing the user to the - copies of the GNU GPL and this license document. - - d) Do one of the following: - - 0) Convey the Minimal Corresponding Source under the terms of this - License, and the Corresponding Application Code in a form - suitable for, and under terms that permit, the user to - recombine or relink the Application with a modified version of - the Linked Version to produce a modified Combined Work, in the - manner specified by section 6 of the GNU GPL for conveying - Corresponding Source. - - 1) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (a) uses at run time - a copy of the Library already present on the user's computer - system, and (b) will operate properly with a modified version - of the Library that is interface-compatible with the Linked - Version. - - e) Provide Installation Information, but only if you would otherwise - be required to provide such information under section 6 of the - GNU GPL, and only to the extent that such information is - necessary to install and execute a modified version of the - Combined Work produced by recombining or relinking the - Application with a modified version of the Linked Version. (If - you use option 4d0, the Installation Information must accompany - the Minimal Corresponding Source and Corresponding Application - Code. If you use option 4d1, you must provide the Installation - Information in the manner specified by section 6 of the GNU GPL - for conveying Corresponding Source.) - - 5. Combined Libraries. - - You may place library facilities that are a work based on the -Library side by side in a single library together with other library -facilities that are not Applications and are not covered by this -License, and convey such a combined library under terms of your -choice, if you do both of the following: - - a) Accompany the combined library with a copy of the same work based - on the Library, uncombined with any other library facilities, - conveyed under the terms of this License. - - b) Give prominent notice with the combined library that part of it - is a work based on the Library, and explaining where to find the - accompanying uncombined form of the same work. - - 6. Revised Versions of the GNU Lesser General Public License. - - The Free Software Foundation may publish revised and/or new versions -of the GNU Lesser General Public License from time to time. Such new -versions will be similar in spirit to the present version, but may -differ in detail to address new problems or concerns. - - Each version is given a distinguishing version number. If the -Library as you received it specifies that a certain numbered version -of the GNU Lesser General Public License "or any later version" -applies to it, you have the option of following the terms and -conditions either of that published version or of any later version -published by the Free Software Foundation. If the Library as you -received it does not specify a version number of the GNU Lesser -General Public License, you may choose any version of the GNU Lesser -General Public License ever published by the Free Software Foundation. - - If the Library as you received it specifies that a proxy can decide -whether future versions of the GNU Lesser General Public License shall -apply, that proxy's public statement of acceptance of any version is -permanent authorization for you to choose that version for the -Library. diff --git a/ChangeLog.md b/ChangeLog.md index b01a198..1458ad5 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -2,6 +2,31 @@ Change Log ========== +0.3.0 +----- + +Changes: + +* Macro † `nm4_unlambda` has been removed from `not-m4sugar.m4` -- lambda macros + are now safely created without polluting the global scope +* M4sugar clones † `nm4_switch()` and † `nm4_case()` have been removed from + `not-m4sugar.m4` (they were clones of `m4_case()` and `m4_bmatch()` + respectively) +* Reduntant macros `nm4_in()` and `nm4_in_args()` have been removed from + `not-m4sugar.m4` +* The _Not M4sugar_ prefix `nm4_` has been changed to `n4_` +* Macros `n4_case_in()` and `n4_list_index()` have been created in + `not-m4sugar.m4` +* Macros `n4_get_replacements()` and `n4_for_each_match()` in `not-m4sugar.m4` + (formerly † `n4_get_replacements()` and † `n4_for_each_match()`) no longer + depend on `n4_repeat()`, but on GNU `m4_for()` instead +* Macro `n4_define_substrings_as()` in `not-m4sugar.m4` (formerly + † `nm4_define_substrings_as()`) has been re-implemented using a more efficient + algorithm (removed recursion, removed multiple calls to `m4_bregexp()`) +* Code review +* Examples + + 0.2.0 ----- @@ -23,8 +48,8 @@ Changes: `not-m4sugar.m4` have been renamed to `nm4_get_replacements()`, `nm4_define_substrings_as()`, `nm4_for_each_match()`, `nm4_redepth()`, and `nm4_repeat()` -* Code review -* Examples +* Code review +* Examples diff --git a/README.md b/README.md index ab0914c..b665c2f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,23 @@ Not Autotools ============= -A collection of useful and self-documented *M4-ish* macros for GNU Autotools +A collection of awesome and self-documented *M4-ish* macros for GNU Autotools + + +Overview +-------- + +This collection is still very small. The macros are organized by topic and each topic has its own file. Most of the macros are independent from each other, so you can just copy and paste what you need. The few cases where a macro depends on a helper macro from the same file are documented. + +Feel free to contribute. For any question, [drop me a message][1]. + + +Free software +------------- + +This library is free software. You can redistribute it and/or modify it under the terms of the GPL3 license. See [COPYING][2] for details. + + +[1]: https://github.com/madmurphy/not-autotools/issues +[2]: https://github.com/madmurphy/not-autotools/blob/master/COPYING + diff --git a/VERSION b/VERSION deleted file mode 100644 index 0ea3a94..0000000 --- a/VERSION +++ /dev/null @@ -1 +0,0 @@ -0.2.0 diff --git a/m4/not-automake.m4 b/m4/not-automake.m4 index 6578a52..4a0bf97 100644 --- a/m4/not-automake.m4 +++ b/m4/not-automake.m4 @@ -8,7 +8,7 @@ dnl \_| \_/\___/ \__| \_| |_/\__,_|\__\___/ \__\___/ \___/|_|___/ dnl dnl A collection of useful m4-ish macros for GNU Autotools dnl -dnl -- Released under GNU LGPL3 -- +dnl -- Released under GNU GPL3 -- dnl dnl https://github.com/madmurphy/not-autotools dnl *************************************************************************** @@ -37,6 +37,7 @@ dnl This macro can be invoked before `AC_INIT()`. dnl dnl Expansion type: literal dnl Requires: nothing +dnl Author: madmurphy dnl dnl *************************************************************************** AC_DEFUN([NM_GET_AM_VAR], [m4_esyscmd_s([echo ${$1}])]) @@ -50,11 +51,12 @@ dnl and returns a comma-separated list of their names dnl dnl Example: dnl -dnl AC_MSG_NOTICE([This package has been distributed by ]m4_if(nm4_in([USER], [NM_ENVIRONMENT_KEYS]), [1], -dnl [NM_GET_AM_VAR([USER])], -dnl [unknown])) +dnl AC_MSG_NOTICE([This package has been distributed by n4_case_in([USER], +dnl [NM_ENVIRONMENT_KEYS], +dnl [NM_GET_AM_VAR([USER])], +dnl [unknown])]) dnl -dnl For the `nm4_in()` macro, see `not-m4sugar.m4`. +dnl For the `n4_case_in()` macro, see `not-m4sugar.m4`. dnl dnl Note that `automake` runs at a different time (and often even on a dnl different computer) than the `configure` script. @@ -69,14 +71,25 @@ dnl dnl See: dnl https://www.gnu.org/software/autoconf/manual/autoconf-2.69/html_node/Looping-constructs.html dnl +dnl This macro makes a system call the first time it is invoked, then +dnl overwrites itself with the literal list of the environment keys received, +dnl so that any further access to the list will rely on a cache and not anymore +dnl on system calls. If you want to force further system calls after the first +dnl access you can use: +dnl +dnl m4_popdef([NM_ENVIRONMENT_KEYS]) +dnl NM_ENVIRONMENT_KEYS +dnl dnl This macro can be invoked before `AC_INIT()`. dnl dnl Expansion type: literal dnl Requires: nothing +dnl Author: madmurphy dnl dnl *************************************************************************** AC_DEFUN([NM_ENVIRONMENT_KEYS], - [m4_esyscmd([printenv | sed 's/^\([^=]\+\)=.*$/[\1],/g' | tr '\n' ' ' | sed 's/,\s$//'])]) + [m4_pushdef([NM_ENVIRONMENT_KEYS], + m4_quote(m4_esyscmd([printenv | sed 's/^\([^=]\+\)=.*$/[\1],/g' | tr '\n' ' ' | sed 's/,\s*$//'])))[]NM_ENVIRONMENT_KEYS]) dnl NM_LOAD_ENVIRONMENT @@ -103,13 +116,11 @@ dnl This macro can be invoked before `AC_INIT()`. dnl dnl Expansion type: literal (void) dnl Requires: nothing +dnl Author: madmurphy dnl dnl *************************************************************************** -AC_DEFUN_ONCE([NM_LOAD_ENVIRONMENT], [ - m4_changequote([{{<<], [>>}}]) - m4_esyscmd(printenv | sed 's/^\([^=]\+\)=\(.*\)$/{{<>}}, {{<<\2>>}})d][n][l>>}}/g') - m4_changequote({{<<[>>}}, {{<<]>>}}) -]) +AC_DEFUN_ONCE([NA_LOAD_AM_ENVIRONMENT], + [m4_esyscmd_s([echo "m4_changequote([{{<<], [>>}}]){{<<>>}}$(printenv | sed 's/^\([^=]\+\)=\(.*\)$/m4_define({{<>}}, {{<<\2>>}})/g'){{<<>>}}m4_changequote({{<<[>>}}, {{<<]>>}})"])]) dnl *************************************************************************** diff --git a/m4/not-autoshell.m4 b/m4/not-autoshell.m4 index 0bb44a8..d3e3d6b 100644 --- a/m4/not-autoshell.m4 +++ b/m4/not-autoshell.m4 @@ -8,7 +8,7 @@ dnl \_| \_/\___/ \__| \_| |_/\__,_|\__\___/ \__\___/ \___/|_|___/ dnl dnl A collection of useful m4-ish macros for GNU Autotools dnl -dnl -- Released under GNU LGPL3 -- +dnl -- Released under GNU GPL3 -- dnl dnl https://github.com/madmurphy/not-autotools dnl *************************************************************************** @@ -37,6 +37,7 @@ dnl This macro can be invoked only after having invoked `AC_INIT()` dnl dnl Expansion type: shell code dnl Requires: nothing +dnl Author: madmurphy dnl dnl *************************************************************************** AC_DEFUN([NS_SETVAR], [$1=$2]) @@ -58,6 +59,7 @@ dnl This macro can be invoked only after having invoked `AC_INIT()` dnl dnl Expansion type: shell code dnl Requires: nothing +dnl Author: madmurphy dnl dnl *************************************************************************** AC_DEFUN([NS_GETVAR], [@S|@{$1}]) @@ -83,6 +85,7 @@ dnl This macro can be invoked only after having invoked `AC_INIT()` dnl dnl Expansion type: shell code dnl Requires: nothing +dnl Author: madmurphy dnl dnl *************************************************************************** AC_DEFUN([NS_GETOUT], [@S|@@{:@$1@:}@]) diff --git a/m4/not-autotools.m4 b/m4/not-autotools.m4 index d0bb62c..90debd5 100644 --- a/m4/not-autotools.m4 +++ b/m4/not-autotools.m4 @@ -8,7 +8,7 @@ dnl \_| \_/\___/ \__| \_| |_/\__,_|\__\___/ \__\___/ \___/|_|___/ dnl dnl A collection of useful m4-ish macros for GNU Autotools dnl -dnl -- Released under GNU LGPL3 -- +dnl -- Released under GNU GPL3 -- dnl dnl https://github.com/madmurphy/not-autotools dnl *************************************************************************** @@ -38,6 +38,7 @@ dnl This macro can be invoked before `AC_INIT()`. dnl dnl Expansion type: literal dnl Requires: nothing +dnl Author: madmurphy dnl dnl *************************************************************************** m4_define([NA_UP_WORDS_ONLY], @@ -63,6 +64,7 @@ dnl This macro can be invoked only after having invoked `AC_INIT()` dnl dnl Expansion type: shell code dnl Requires: nothing +dnl Author: madmurphy dnl dnl *************************************************************************** AC_DEFUN([NA_SET_GLOBALLY], [ @@ -88,6 +90,7 @@ dnl This macro can be invoked only after having invoked `AC_INIT()` dnl dnl Expansion type: shell code dnl Requires: `NA_UP_WORDS_ONLY()` +dnl Author: madmurphy dnl dnl *************************************************************************** AC_DEFUN([NA_GET_PROGS], [ @@ -125,6 +128,7 @@ dnl This macro can be invoked only after having invoked `AC_INIT()` dnl dnl Expansion type: shell code dnl Requires: `NA_UP_WORDS_ONLY()` +dnl Author: madmurphy dnl dnl *************************************************************************** AC_DEFUN([NA_REQ_PROGS], [ diff --git a/m4/not-m4sugar.m4 b/m4/not-m4sugar.m4 index 71a22cf..f1616b8 100644 --- a/m4/not-m4sugar.m4 +++ b/m4/not-m4sugar.m4 @@ -21,205 +21,188 @@ dnl *************************************************************************** -dnl nm4_switch(text0[, text1, if-matched1[, textN, if-matchedN[, default]]]) +dnl n4_case_in(text, list1, if-found1[, ... listN, if-foundN], [if-not-found]) dnl *************************************************************************** dnl -dnl Switches among literals +dnl Searches for the first occurence of `text` in each comma-separated list +dnl `listN` dnl -dnl Same syntax of `AS_CASE()`, but it operates on M4 macros rather than shell -dnl variables. Furthermore, differently than in `AS_CASE()`, the string -dnl comparisons here are performed literally (patterns are not followed). For -dnl using patterns in string comparisons, see `nm4_case()`. -dnl -dnl Example: -dnl -dnl AC_DEFUN([DIST_STATUS], -dnl [nm4_switch(NM_GET_AM_VAR([USER]), -dnl [madmurphy], -dnl [official release], -dnl [rose], -dnl [semi-official release], -dnl [charlie], -dnl [abusive release], -dnl [unofficial release])]) -dnl AC_MSG_NOTICE([Distribution status: DIST_STATUS]) -dnl -dnl For the `NM_GET_AM_VAR()` macro, see `not-automake.m4`. -dnl -dnl This macro can be invoked before `AC_INIT()`. -dnl -dnl Expansion type: literal -dnl Requires: nothing -dnl -dnl *************************************************************************** -m4_define([nm4_switch], [m4_if(m4_eval([$# < 2]), [0], [m4_if([$2], [$1], [m4_normalize([$3])], [m4_if(m4_eval([$# > 4]), [1], [nm4_switch([$1], m4_shift3($@))], [m4_if(m4_eval([$# & 1]), [0], [m4_normalize(m4_argn([$#], $@))])])])])]) - - -dnl nm4_case(text[, pattern1, if-matched1[, patternN, if-matchedN[, default]]]) -dnl *************************************************************************** +dnl For example, dnl -dnl Switches among patterns +dnl n4_case_in(NM_GET_AM_VAR([USER]), +dnl [[rose], [madmurphy], [charlie]], +dnl [Official release], +dnl [Unofficial release]) dnl -dnl Same syntax of `AS_CASE()`, but it operates on M4 macros rather than shell -dnl variables. Patterns are supported and must follow the same syntax used in -dnl the GNU M4 `regexp()` macro (see: -dnl https://www.gnu.org/software/m4/manual/m4-1.4.14/html_node/Regexp.html). -dnl For literal string comparisons without pattern support, see `nm4_switch()`. +dnl will print "Official release" if the user who generated the `configure` +dnl script was in the list above, ot it will print "Unofficial release" +dnl otherwise (for the `NM_GET_AM_VAR()` macro, see `not-automake.m4`). dnl -dnl Example: +dnl This macro works exactly like `m4_case()`, but instead of looking for the +dnl equality of a target string with one or more other strings, it checks +dnl whether a target string is present in one or more given lists. dnl -dnl AC_DEFUN([SHELL_TYPE], -dnl [nm4_case(NM_GET_AM_VAR([SHELL]), -dnl [/\w*csh$], -dnl [C shell], -dnl [/\w*sh$], -dnl [Other POSIX non-C shell], -dnl [Unknown shell])]) -dnl AC_MSG_NOTICE([Maintainer's shell type: SHELL_TYPE]) +dnl Here is a more articulated example: dnl -dnl For the `NM_GET_AM_VAR()` macro, see `not-automake.m4`. +dnl n4_case_in(NM_GET_AM_VAR([USER]), +dnl [[rose], [madmurphy], [lili], [frank]], +dnl [Official release], +dnl [[rick], [karl], [matilde]], +dnl [Semi-official release], +dnl [[jack], [charlie]], +dnl [Offensive release], +dnl [Unofficial release]) dnl dnl This macro can be invoked before `AC_INIT()`. dnl dnl Expansion type: literal -dnl Requires: nothing +dnl Requires: Autoconf >= 2.62: for the `m4_cond()` macro -- see: +dnl https://www.gnu.org/software/autoconf/manual/autoconf-2.62/html_node/Conditional-constructs.html +dnl Author: madmurphy dnl dnl *************************************************************************** -m4_define([nm4_case], [m4_if(m4_eval([$# < 2]), [0], [m4_if(m4_eval(m4_bregexp([$1], [$2]) > -1), [1], [m4_normalize([$3])], [m4_if(m4_eval([$# > 4]), [1], [nm4_case([$1], m4_shift3($@))], [m4_if(m4_eval([$# & 1]), [0], [m4_normalize(m4_argn([$#], $@))])])])])]) - - -dnl nm4_in_args(target, string1[, string2[, ... stringN ]]) +m4_define([n4_case_in], + [m4_cond([m4_eval($# < 2)], [1], + [], + [m4_argn(1, $2)], [$1], + [$3], + [m4_eval(m4_count($2) > 1)], [1], + [n4_case_in([$1], m4_dquote(m4_shift($2)), m4_shift2($@))], + [m4_eval($# > 4)], [1], + [n4_case_in([$1], m4_shift3($@))], + [$4])]) + + +dnl n4_lambda(macro_body) dnl *************************************************************************** dnl -dnl Searches for the first duplicate of the argument `target` among all the -dnl other arguments -dnl -dnl This macro expands to `1` if a duplicate is found, to `0` otherwise. -dnl -dnl For example, -dnl -dnl nm4_in_args([bar], [foo], [bar], [hello]) -dnl -dnl will expand to `1`. -dnl -dnl This macro can be invoked before `AC_INIT()`. -dnl -dnl Expansion type: literal -dnl Requires: nothing +dnl Creates an anonymous macro on the fly, able to be passed as a callback +dnl argument dnl -dnl *************************************************************************** -m4_define([nm4_in_args], [m4_if(m4_eval([$# < 2]), [1], [0], [m4_if([$1], [$2], [1], [m4_if(m4_eval([$# > 2]), [1], [nm4_in_args([$1], m4_shift2($*))], [0])])])]) - - -dnl nm4_in(target, list) -dnl *************************************************************************** +dnl For example, in the following code a lambda macro instead of a named one is +dnl passed to `m4_map()`: dnl -dnl Searches for the first occurence of `target` in the comma-separated list -dnl `list` +dnl AC_DEFUN([MISSING_PROGRAMS], [[find], [xargs], [sed]]) +dnl AC_MSG_ERROR([Install first m4_map([n4_lambda(["$1", ])], [MISSING_PROGRAMS])then proceed.]) dnl -dnl This macro expands to `1` if `target` is found, to `0` otherwise. +dnl The code above will print: dnl -dnl For example, +dnl Install first "find", "xargs", "sed", then proceed. dnl -dnl nm4_in([PATH], [NM_ENVIRONMENT_KEYS]) +dnl By using the `n4_anon` keyword, a lambda macro can invoke itself repeatedly +dnl (recursion). For example, dnl -dnl will most likely expand to `1` (for the `NM_ENVIRONMENT_KEYS` macro, see -dnl `not-automake.m4`). +dnl AC_MSG_NOTICE([n4_lambda([{$1}m4_if(m4_eval($# > 1), [1], [n4_anon(m4_shift($*))])])([one], [two], [three], [four])]) dnl -dnl This macro can be invoked before `AC_INIT()`. +dnl will print dnl -dnl Expansion type: literal -dnl Requires: nothing +dnl {one}{two}{three}{four} dnl -dnl Note: If you have already included `nm4_in_args()` in your scipts you can -dnl use the following shorter definition of `nm4_in()`: +dnl The `n4_anon` keyword is available only from within the lambda macro body +dnl and works in a stack-like fashion. Do not attempt to redefine it yourself. dnl -dnl m4_define([nm4_in], [nm4_in_args([$1], $2)]) +dnl Lambda macros can be nested within each other: dnl -dnl *************************************************************************** -m4_define([nm4_in], [m4_if(m4_eval(m4_count($2) < 1), [1], [0], [m4_if(m4_argn(1, $2), [$1], [1], [m4_if(m4_eval(m4_count($2) > 1), [1], [nm4_in([$1], [m4_shift($2)])], [0])])])]) - - -dnl nm4_lambda(macro_body) -dnl *************************************************************************** +dnl n4_lambda([Hi there! n4_lambda([This is a nested lambda macro!])]) dnl -dnl Creates an anonymous macro on the fly, able to be passed as a callback -dnl argument +dnl However, as with any other type of macro, reading the arguments of a +dnl nested macro might be difficult. Consider for example the following +dnl code snippet: dnl -dnl Example: +dnl n4_lambda([Hi there! Here it's $1! n4_lambda([And here it's $1!])([Charlie])])([Rose]) dnl -dnl AC_DEFUN([MISSING_PROGRAMS], [[find], [xargs], [sed]]) -dnl AC_MSG_ERROR([Install first m4_map([nm4_lambda(["$1", ])], [MISSING_PROGRAMS])then proceed.]) +dnl It will print: dnl -dnl By using the `nm4_anon()` keyword, the macro body can invoke itself -dnl repeatedly (recursion). For example, +dnl Hi there! Here it's Rose! And here it's Rose! dnl -dnl AC_MSG_NOTICE([nm4_lambda([[{$1}]m4_if(m4_eval($# > 1), [1], [nm4_anon(m4_shift($*))])])([one], [two], [three], [four])]) +dnl This is because `$1` gets replaced with `Rose` before the nested macro's +dnl arguments can expand. The only way to prevent this is to declare the nested +dnl macro out of quotes, so that the expansion of its arguments precedes that +dnl of its parent's. Hence, dnl -dnl will print +dnl n4_lambda([Hi there! Here it's $1! ]n4_lambda([And here it's $1!])([Charlie]))([Rose]) dnl -dnl {one}{two}{three}{four} +dnl will finally print: dnl -dnl The `nm4_anon` keyword is available both within and outside the macro body -dnl (in this last case it will point to the last lambda macro called). For -dnl example, +dnl Hi there! Here it's Rose! And here it's Charlie! dnl -dnl nm4_lambda([[{$1}]m4_if(m4_eval($# > 1), [1], [nm4_anon(m4_shift($*))])])([one], [two], [three], [four]) -dnl nm4_anon([five], [six], [seven], [eight]) +dnl There is no particular limit in the level of nesting reachable, except good +dnl coding practices. As an extreme example, consider the following snippet +dnl (the atypical M4 indentation is only for didactic purpose): dnl -dnl will print +dnl # Let's use `L()` as a shortcut for `n4_lambda()`... +dnl m4_define([L], m4_defn([n4_lambda])) dnl -dnl {one}{two}{three}{four} -dnl {five}{six}{seven}{eight} -dnl -dnl It is suggested, although not strictly needed, to call `nm4_unlambda` as -dnl soon as the lambda macro terminates its function, in order to delete the -dnl `nm4_anon` keyword from the global scope. So, for example: -dnl -dnl nm4_lambda([[{$1}]m4_if(m4_eval($# > 1), [1], [nm4_anon(m4_shift($*))])])([one], [two], [three], [four]) -dnl nm4_anon([five], [six], [seven], [eight]) -dnl nm4_unlambda -dnl nm4_anon([nine], [ten], [eleven], [twelve]) -dnl -dnl will print: -dnl -dnl {one}{two}{three}{four} -dnl {five}{six}{seven}{eight} -dnl nm4_anon(nine, ten, eleven, twelve) +dnl L( +dnl [This is $1] +dnl L( +dnl [This is $1] +dnl L( +dnl [{$1}m4_ifelse(m4_eval($# > 1), [1], [n4_anon(m4_shift($*))])] +dnl )([internal one], [internal two], [internal three], [internal four]) +dnl )([central]) +dnl )([external]) dnl -dnl If the anonymous macro needs to be invoked only once, the `nm4_unlambda` -dnl macro can be invoked directly from the macro body itself: +dnl The example above will print something like this (plus some trailing spaces +dnl due to the bad indentation): dnl -dnl AC_MSG_NOTICE([Some quoted text: nm4_lambda(["$1"][nm4_unlambda])([Hello world!]).]) +dnl This is external +dnl This is central +dnl {internal one}{internal two}{internal three}{internal four} dnl dnl This macro can be invoked before `AC_INIT()`. dnl dnl Expansion type: literal dnl Requires: nothing -dnl Optionally requires: `nm4_unlambda` (for unregistering the lamba macro) +dnl Author: madmurphy dnl dnl *************************************************************************** -m4_define([nm4_lambda], [m4_define([nm4_anon], [$1])][nm4_anon]) +m4_define([n4_lambda], + [m4_define([_n4_anon_orig], [$1])[]m4_define([_n4_anon_init], [m4_pushdef([n4_anon], m4_defn([_n4_anon_orig]))[]m4_undefine([_n4_anon_orig])[]m4_undefine([_n4_anon_init])[]$1[]m4_popdef([n4_anon])])[]_n4_anon_init]) -dnl nm4_unlambda +dnl n4_list_index(list, target, [add-to-return-value], [if-not-found]) dnl *************************************************************************** dnl -dnl Forgets the last lambda macro created +dnl Searches for the first occurence of `target` in the comma-separated list +dnl `list` and returns its position, or `-1` if `target` has not been found +dnl +dnl For example, +dnl +dnl n4_list_index([[foo], [bar], [hello]], [bar]) +dnl +dnl expands to `2`. dnl -dnl See `nm4_lambda()` for details. +dnl If the `add-to-return-value` argument is expressed (this accepts only +dnl numbers, both positive and negative), it will be added to the returned +dnl index -- if `target` has not been found and the `if-not-found` argument is +dnl omitted, it will be added to `-1`. +dnl +dnl If the `if-not-found` argument is expressed, it will be returned every time +dnl `target` is not found. This argument accepts both numerical and +dnl non-numerical values. dnl dnl This macro can be invoked before `AC_INIT()`. dnl -dnl Expansion type: literal (void) -dnl Requires: nothing -dnl Optionally requires: `nm4_lambda()` (for registering lamba macros) +dnl Expansion type: literal +dnl Requires: Autoconf >= 2.62: for the `m4_cond()` macro -- see: +dnl https://www.gnu.org/software/autoconf/manual/autoconf-2.62/html_node/Conditional-constructs.html +dnl Author: madmurphy dnl dnl *************************************************************************** -m4_define([nm4_unlambda], [m4_ifdef([nm4_anon], [m4_undefine([nm4_anon])])]) - - -dnl nm4_define_substrings_as(string, regexp, macro0[, macro1[, ... macroN ]]) +m4_define([n4_list_index], + [m4_cond([m4_eval($# < 2)], [1], + [-1], + [m4_argn(1, $1)], [$2], + [m4_eval([$3] + 0)], + [m4_eval(m4_count($1) > 1)], [1], + [n4_list_index(m4_dquote(m4_shift($1)), [$2], m4_eval([$3] + 1), m4_if(m4_eval($# > 3), [1], [$4], [m4_eval([$3] - 1)]))], + [m4_eval($# > 3)], [1], + [$4], + [m4_eval([$3] - 1)])]) + + +dnl n4_define_substrings_as(string, regexp, macro0[, macro1[, ... macroN ]]) dnl *************************************************************************** dnl dnl Searches for the first match of `regexp` in `string` and defines custom @@ -237,27 +220,30 @@ dnl be defined as empty strings. dnl dnl Example -- Get the current version string from a file named `VERSION`: dnl -dnl nm4_define_substrings_as( -dnl m4_include([VERSION]), -dnl [\([0-9]+\)\s*\.\s*\([0-9]+\)\s*\.\s*\([0-9]+\)], +dnl n4_define_substrings_as( +dnl m4_quote(m4_include([VERSION])), +dnl [\([0-9]+\)\.\([0-9]+\)\.\([0-9]+\)], dnl [VERSION_STR], [VERSION_MAJ], [VERSION_MIN], [VERSION_REV] dnl ) -dnl dnl AC_INIT([foo], VERSION_MAJ[.]VERSION_MIN[.]VERSION_REV) dnl dnl This macro can be invoked before `AC_INIT()`. dnl dnl Expansion type: literal (void) dnl Requires: nothing +dnl Author: madmurphy dnl dnl *************************************************************************** -m4_define([nm4_define_substrings_as], - [m4_if(m4_eval([$# > 2]), [1], - [m4_if(m4_normalize(m4_argn([$#], $*)), [], [], - [m4_bregexp([$1], [$2], [m4_define(m4_normalize(m4_argn([$#], $*)), \]m4_if([$#], [3], [&], m4_eval([$# - 3]))[)])])[]m4_if(m4_eval([$# > 3]), [1], [nm4_define_substrings_as(m4_reverse(m4_shift(m4_reverse($@))))])])]) +m4_define([n4_define_substrings_as], + [m4_bregexp([$1], [$2], + m4_if([$3], [], [], + [[m4_define([$3], [m4_quote(\&)])]])m4_if(m4_eval($# > 3), [1], + [m4_for([_idx_], [1], [$# - 3], [1], + [m4_if(m4_normalize(m4_argn(_idx_, m4_shift3($@))), [], [], + [[m4_define(m4_quote(m4_normalize(m4_argn(]_idx_[, m4_shift3($@)))), m4_quote(\]_idx_[))]])])]))]) -dnl nm4_repeat(text, n_times) +dnl n4_repeat(n_times, text) dnl *************************************************************************** dnl dnl Repeats `text` `n_times` @@ -265,22 +251,59 @@ dnl dnl Every occurrence of `$#` within `text` will be replaced with the current dnl index. For example, dnl -dnl nm4_repeat([foo $#...], [4]) +dnl n4_repeat([4], [foo $#...]) dnl -dnl will expand to: +dnl will expand to dnl dnl foo 1...foo 2...foo 3...foo 4... dnl +dnl If `n4_repeat()` is invoked from within a macro body, `$#` will be replaced +dnl with higher priority with the current macro's number of arguments. For +dnl instance, +dnl +dnl m4_define([print_foo], [n4_repeat([4], [foo $#...])]) +dnl print_foo +dnl +dnl will expand to +dnl +dnl foo 0...foo 0...foo 0...foo 0... +dnl +dnl Therefore, in order to inhibit the immediate expansion of `$#` it is +dnl necessary temporarily to break its components, as in the following example, +dnl +dnl m4_define([print_foo], [n4_repeat([4], [foo ][$][#][...])]) +dnl print_foo +dnl +dnl which will finally expand to +dnl +dnl foo 1...foo 2...foo 3...foo 4... +dnl +dnl This applies also to macro calls. For example, +dnl +dnl m4_define([even_numbers], +dnl [(0)n4_repeat([$1], [, m4_eval(][$][#][ * 2)])]) +dnl +dnl Even numbers: even_numbers([10]) ... +dnl +dnl will expand to +dnl +dnl Even numbers: (0), 2, 4, 6, 8, 10, 12, 14, 16, 18, 20 ... +dnl +dnl However, for complex cases it is suggested to use `m4_for()`. +dnl dnl This macro can be invoked before `AC_INIT()`. dnl dnl Expansion type: literal dnl Requires: nothing +dnl Author: madmurphy dnl dnl *************************************************************************** -m4_define([nm4_repeat], [m4_if(m4_eval([$2] > 0), [1], [nm4_repeat([$1], m4_decr([$2]))]m4_bpatsubst([$1], [\$][#], [$2]))]) +m4_define([n4_repeat], + [m4_if(m4_eval([$1] > 0), [1], + [n4_repeat(m4_decr([$1]), [$2])[]m4_bpatsubst([$2], [\$][#], [$1])])]) -dnl nm4_redepth(regexp) +dnl n4_redepth(regexp) dnl *************************************************************************** dnl dnl Examines a regular expression and returns the number of capturing @@ -291,7 +314,7 @@ dnl as `\[number]` during a replacement dnl dnl For example, dnl -dnl nm4_redepth([\([0-9]+\)\.\([0-9]+\)\.\([0-9]+\)]) +dnl n4_redepth([\([0-9]+\)\.\([0-9]+\)\.\([0-9]+\)]) dnl dnl expands to `3`. dnl @@ -299,12 +322,14 @@ dnl This macro can be invoked before `AC_INIT()`. dnl dnl Expansion type: literal dnl Requires: nothing +dnl Author: madmurphy dnl dnl *************************************************************************** -m4_define([nm4_redepth], [m4_len(m4_bpatsubst(m4_bpatsubst([$1], [\(\\\|)\|\([^\\]\|^\)\(\\\\\)*(\)\|\(\\\)(\|,], [\4]), [[^\\]], []))]) +m4_define([n4_redepth], + [m4_len(m4_bpatsubst(m4_bpatsubst([$1], [\(\\\|)\|\([^\\]\|^\)\(\\\\\)*(\)\|\(\\\)(\|,], [\4]), [[^\\]], []))]) -dnl nm4_for_each_match(string, regexp, macro) +dnl n4_for_each_match(string, regexp, macro) dnl *************************************************************************** dnl dnl Calls the custom macro `macro` for every occurrence of `regexp` in `string` @@ -315,8 +340,7 @@ dnl dnl For example, dnl dnl AC_DEFUN([custom_macro], [...foo $1|$2|$3|$4 bar]) -dnl AC_MSG_NOTICE([nm4_for_each_match([blaablabblac], -dnl [\(b\(l\)\)\(a\)], [custom_macro])]) +dnl AC_MSG_NOTICE([n4_for_each_match([blaablabblac], [\(b\(l\)\)\(a\)], [custom_macro])]) dnl dnl will print: dnl @@ -325,15 +349,16 @@ dnl dnl This macro can be invoked before `AC_INIT()`. dnl dnl Expansion type: literal -dnl Requires: `nm4_redepth()` and `nm4_repeat()` +dnl Requires: `n4_redepth()` +dnl Author: madmurphy dnl dnl *************************************************************************** -m4_define([nm4_for_each_match], +m4_define([n4_for_each_match], [m4_if(m4_bregexp([$1], [$2]), [-1], [], - [m4_bregexp([$1], [$2], [[]$3([\&]]nm4_repeat([[[,]] \]$[#], nm4_redepth([$2]))[)])[]nm4_for_each_match(m4_substr([$1], m4_eval(m4_bregexp([$1], [$2]) + m4_len(m4_bregexp([$1], [$2], [\&])))), [$2], [$3])])]) + [m4_bregexp([$1], [$2], [[]$3([\&]]m4_quote(m4_for([_idx_], [1], m4_quote(n4_redepth([$2])), [1], [, \_idx_]))[)])[]n4_for_each_match(m4_substr([$1], m4_eval(m4_bregexp([$1], [$2]) + m4_len(m4_bregexp([$1], [$2], [\&])))), [$2], [$3])])]) -dnl nm4_get_replacements(string, regexp, macro) +dnl n4_get_replacements(string, regexp, macro) dnl *************************************************************************** dnl dnl Replaces every occurrence of `regexp` in `string` with the text returned by @@ -345,8 +370,7 @@ dnl dnl For example, dnl dnl AC_DEFUN([custom_macro], [XX$3]) -dnl AC_MSG_NOTICE([nm4_get_replacements([hello you world!!], -dnl [\(l\|w\)+\(o\)], [custom_macro])]) +dnl AC_MSG_NOTICE([n4_get_replacements([hello you world!!], [\(l\|w\)+\(o\)], [custom_macro])]) dnl dnl will print: dnl @@ -355,17 +379,18 @@ dnl dnl This macro can be invoked before `AC_INIT()`. dnl dnl Expansion type: literal -dnl Requires: `nm4_redepth()` and `nm4_repeat()` +dnl Requires: `n4_redepth()` +dnl Author: madmurphy dnl dnl *************************************************************************** -m4_define([nm4_get_replacements], +m4_define([n4_get_replacements], [m4_if(m4_bregexp([$1], [$2]), [-1], [$1], - [m4_bpatsubst([$1], [$2], [[]$3([\&]]nm4_repeat([[[,]] \]$[#], nm4_redepth([$2]))[)])])]) + [m4_bpatsubst([$1], [$2], [[]$3([\&]]m4_quote(m4_for([_idx_], [1], m4_quote(n4_redepth([$2])), [1], [, \_idx_]))[)])])]) dnl *************************************************************************** -dnl Note: The `nm4_` prefix (which stands for "Not M4") is used with the +dnl Note: The `n4_` prefix (which stands for "Not m4") is used with the dnl purpose of avoiding collisions with the default GNU M4sugar dnl prefix `m4_`. dnl *************************************************************************** diff --git a/m4/not-misc.m4 b/m4/not-misc.m4 index 5f11141..18cc1ed 100644 --- a/m4/not-misc.m4 +++ b/m4/not-misc.m4 @@ -8,7 +8,7 @@ dnl \_| \_/\___/ \__| \_| |_/\__,_|\__\___/ \__\___/ \___/|_|___/ dnl dnl A collection of useful m4-ish macros for GNU Autotools dnl -dnl -- Released under GNU LGPL3 -- +dnl -- Released under GNU GPL3 -- dnl dnl https://github.com/madmurphy/not-autotools dnl *************************************************************************** diff --git a/package.json b/package.json new file mode 100644 index 0000000..6c97696 --- /dev/null +++ b/package.json @@ -0,0 +1,38 @@ +{ + "name": "Not Autotools", + "version": "0.3.0", + "description": "A collection of awesome and self-documented M4-ish macros for GNU Autotools", + "homepage": "https://github.com/madmurphy/not-autotools", + "author": "madmurphy333@gmail.com", + "license": "LGPL-3.0", + "main": "not-autotools", + "repository": { + "type": "git", + "url": "https://github.com/madmurphy/not-autotools.git" + }, + "dependencies": { + "m4": "*", + "autoconf": "*", + }, + "src": [ + "m4/not-automake.m4", + "m4/not-autoshell.m4", + "m4/not-autotools.m4", + "m4/not-m4sugar.m4", + "m4/not-misc.m4" + ], + "bugs": { + "url": "https://github.com/madmurphy/not-autotools/issues", + "email" : "madmurphy333@gmail.com" + }, + "keywords": [ + "autotools", + "autoconf", + "automake", + "configure", + "m4", + "m4-library", + "m4-macros" + ] +} +