diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..26b21a2 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +* @zefir-git diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml new file mode 100644 index 0000000..06e5d36 --- /dev/null +++ b/.github/dependabot.yaml @@ -0,0 +1,8 @@ +version: 2 +updates: + - package-ecosystem: github-actions + directory: / + schedule: + interval: weekly + day: monday + time: "06:00" diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml new file mode 100644 index 0000000..28ed087 --- /dev/null +++ b/.github/workflows/build.yaml @@ -0,0 +1,25 @@ +name: Build + +on: + push: + branches: [main] + pull_request: + branches: [main] + release: + types: [published] + +jobs: + build: + name: Build + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up D compiler + uses: dlang-community/setup-dlang@v2 + with: + compiler: dmd + + - name: Build with dub + run: dub build diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml new file mode 100644 index 0000000..8541ae8 --- /dev/null +++ b/.github/workflows/docs.yaml @@ -0,0 +1,37 @@ +name: Docs + +on: + release: + types: [published] + +jobs: + docs: + name: Docs + runs-on: ubuntu-latest + if: "!github.event.release.prerelease" + permissions: + contents: read + id-token: write + pages: write + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up D compiler + uses: dlang-community/setup-dlang@v2 + with: + compiler: dmd + + - name: Generate docs + run: dub run -y adrdox -- -i src -o docs + + - name: Set up GitHub pages + uses: actions/configure-pages@v5 + + - name: Upload docs artifact to pages + uses: actions/upload-pages-artifact@v3 + with: + path: docs + + - name: Deploy to GitHub Pages + uses: actions/deploy-pages@v4 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b49a30c --- /dev/null +++ b/.gitignore @@ -0,0 +1,16 @@ +.dub +docs.json +__dummy.html +docs/ +/cmd +libcmd.so +libcmd.dylib +libcmd.dll +libcmd.a +libcmd.lib +libcmd-test-* +*.exe +*.pdb +*.o +*.obj +*.lst diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + 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 +. diff --git a/README.md b/README.md index 17f1d2e..850bf88 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,187 @@ # cmd + +[![Documentation](https://img.shields.io/badge/Documentation-blue)](https://modpm.github.io/cmd) +[![GitHub](https://img.shields.io/badge/GitHub-181717?logo=github)](https://github.com/modpm/cmd) +[![CI](https://github.com/modpm/cmd/actions/workflows/build.yaml/badge.svg)](https://github.com/modpm/cmd/actions/workflows/build.yaml) +[![Version](https://img.shields.io/dub/v/cmd)](https://code.dlang.org/packages/cmd) +[![Licence](https://img.shields.io/dub/l/cmd)](https://code.dlang.org/packages/cmd) +[![Score](https://img.shields.io/dub/score/cmd)](https://code.dlang.org/packages/cmd) +[![Downloads](https://img.shields.io/dub/dt/cmd)](https://code.dlang.org/packages/cmd) + Simple, intuitive library for building CLI applications in D. + +Please see the [API Reference Documentation](https://modpm.github.io/cmd). + +## Highlights + +- Nested subcommands (commands may contain other commands). +- Required (`<>`) and optional (`[]`) arguments and options. +- Variadic arguments (`...`) for accepting multiple values. +- Built-in help and usage generation. +- Accepts `--option=value` and `--option value` forms. +- Repeated options are collected as arrays. + +## Quick start + +A minimal example that splits a string. + +```d +import std.stdio; +import std.string; + +import cmd.program; + +void main(string[] argv) +{ + auto args = new Program("split") + .description("Split a string") + .versionString("1.0.0") + .versionOption("--version", "Show version information") + .helpOption("-h, --help", "Show help for command") + .argument("", "String to split") + .option("-s, --separator ", "Separator character") + .option("--first", "Return only the first element") + .parse(argv); + + auto parts = args.argument("string").split(args.option("separator")); + if (args.flag("first")) + writeln(parts[0]); + else + writeln(parts); +} +``` + +> [!NOTE] +> +> `versionOption` enables a version flag for your program (e.g., `--version`), and helpOption enables a help flag +> (e.g., `-h` or `--help`). When specified, these flags are handled automatically: +> the library will print the version or help message and exit. + +## Subcommands + +Add subcommands with .command(); subcommands may themselves have nested subcommands. Example with a single subcommand: + +```d +import std.stdio; +import cmd.program; + +void main(string[] args) +{ + new Program("example") + .description("An example CLI program using cmd") + .helpOption("-h, --help", "Show help for command") + .command(new Command("greet") + .description("Greet someone") + .option("--excited", "Add excitement to the greeting") + .argument("", "Name of the person to greet") + .action((args) { + auto msg = "Hello, " ~ args.argument("name"); + if (args.flag("excited")) + msg ~= "!!!"; + writeln(msg); + return 0; + }) + ) + .run(args); +} +``` + +Invoke as: `example greet [options] `. + +> [!IMPORTANT] +> +> A command cannot have both subcommands and arguments. + +## Flags and options + +Use `.option()` to add options or flags to a command. + +- Options require a parameter. +- Make an option required by wrapping the parameter name in `<>`, e.g. --target ``. +- Make an option optional by wrapping it in `[]`. A default value can be provided for optional options. +- An option with no parameter is a flag; flags are boolean and indicate presence. +- Options and flags may have a short name (`-x`), a long name (`--example`), or both (`-x, --example`). + +Example: + +```d +auto args = new Program("example") + .option("-f, --foo ", "Option with a required parameterer") + .option("-b [bar]", "Option with an optional parameter and default value", "defaultValue") + .option("--flag", "A boolean flag") + .parse(argv); +``` + +Use `args.hasOption(name)` to check if an optional option without a default value is present before accessing it. +To get the first value of an option, use `args.option(name)`. To get all values, use `args.optionList(name)`. + +To check a flag, use `args.flag(name)`. + +> [!NOTE] +> +> `name` can be either the short or long name. For explicitness, you can prefix with a single or double dash, +> e.g. `args.option("-o")` or `args.option("--option")`. + +## Arguments + +Define positional arguments with `.argument()`. + +- Required positional arguments are wrapped in `<>`. +- Optional positional arguments are wrapped in `[]`. +- A variadic (rest) argument is expressed with `...` and if used must be the final argument. + A required variadic argument requires at least one value; an optional variadic argument accepts zero or more. + +Example: + +```d +new Program("example") + .argument("", "Input string or value") + .argument("[output]", "Optional output string or value") + .argument("", "One or more items to process") +``` + +## Custom command classes + +Create modular command implementations by extending `Command`: + +```d +module example.greet_command; + +import std.stdio; +import cmd.command; + +class GreetCommand : Command +{ + public this() + { + super("greet") + .description("Greet someone") + .option("--excited", "Add excitement to the greeting") + .argument("", "Name of the person to greet") + .action((args) { + auto msg = "Hello, " ~ args.argument("name"); + if (args.flag("excited")) + msg ~= "!!!"; + writeln(msg); + return 0; + }); + } +} +``` + +To attach it as a subcommand: `.command(new GreetCommand())`. + +# Built-in help command + +`HelpCommand` is included to enable `help` as a subcommand: + +```d +new Program("example") + .command(new HelpCommand()) +``` + +Usage: `help [command...]` + +Examples: +- `example help` — show help for the program. +- `example help greet` — show help for the `greet` subcommand. diff --git a/dub.json b/dub.json new file mode 100644 index 0000000..99c4768 --- /dev/null +++ b/dub.json @@ -0,0 +1,11 @@ +{ + "authors": [ + "Zefir Kirilov" + ], + "copyright": "Copyright © 2025 Zefir Kirilov", + "description": "Simple, intuitive library for building CLI applications in D.", + "license": "GPL-3.0-only", + "name": "cmd", + "sourcePaths": ["src"], + "targetType": "library" +} diff --git a/skeleton.html b/skeleton.html new file mode 100644 index 0000000..9d49cf4 --- /dev/null +++ b/skeleton.html @@ -0,0 +1,41 @@ + + + + Documentation + + + + + + + +
+
+ Documentation + +
+ + +
+
+
+
+
+
+

+ Copyright © 2025 Zefir Kirilov. Released under the + GPL-3.0 + licence. +

+

+ Page generated with + adrdox +

+
+ + diff --git a/src/cmd/ansi.d b/src/cmd/ansi.d new file mode 100644 index 0000000..672f704 --- /dev/null +++ b/src/cmd/ansi.d @@ -0,0 +1,31 @@ +module cmd.ansi; + +import std.regex; + +/** Removes ANSI escape sequences from a string, leaving only the text that would be displayed. */ +public string stripAnsi(string input) @safe { + return input.replaceAll( + regex("\\x1B\\[[0-9;:?]*[A-Za-z]|\\x1B\\]8;;.*?\\x07(.*?)\\x1B\\]8;;\\x07|\\x1BO.|\\x1B.", "gs"), + "$1" + ); +} + +/** Applies foreground (text) SGR bold (increased intensity). */ +public string bold(string text) nothrow @safe { + return "\x1B[1m" ~ text ~ "\x1B[0m"; +} + +/** Applies foreground (text) SGR dim (faint, decreased intensity). */ +public string dim(string text) nothrow @safe { + return "\x1B[2m" ~ text ~ "\x1B[0m"; +} + +/** Applies foreground (text) SGR bright black. */ +public string brightBlack(string text) nothrow @safe { + return "\x1B[90m" ~ text ~ "\x1B[0m"; +} + +/** Formats text as OSC 8 hyperlink. */ +public string link(string text, string url) nothrow @safe { + return "\x1B]8;;" ~ url ~ "\x07" ~ text ~ "\x1B]8;;\x07"; +} diff --git a/src/cmd/argument.d b/src/cmd/argument.d new file mode 100644 index 0000000..029faf2 --- /dev/null +++ b/src/cmd/argument.d @@ -0,0 +1,96 @@ +module cmd.argument; + +import std.string; + +import cmd.ansi; + +/** Represents a command-line argument. */ +public class Argument { + /** Name of the argument. */ + public const string name; + + /** Description of the argument. */ + public const string description; + + /** Whether the argument is required. */ + public const bool required; + + /** Whether the argument accepts multiple values. */ + public const bool variadic; + + /** Default value of the argument, or `null`. */ + public const string defaultValue; + + /** + * Constructs an argument. + * + * Params: + * name = Name of the argument, must be non-empty. + * required = Whether the argument is required. + * variadic = Whether the argument accepts multiple values. + * description = Description of the argument. + * defaultValue = Default value, or `null`. + * + * Throws: + * AssertionError if name is empty, or if argument is required and default value is not `null`. + */ + public this(string name, bool required, bool variadic, string description, string defaultValue = null) @safe { + assert(!name.empty(), "Argument name must be non-empty"); + if (required) + assert(defaultValue is null, "Required argument cannot have a default value"); + this.name = name; + this.required = required; + this.variadic = variadic; + this.description = description; + this.defaultValue = defaultValue; + } + + /** + * Creates an argument from a formatted string. + * + * Format must be enclosed in `<>` (required) or `[]` (optional). Name may end with `...` to indicate variadic + * argument. + * + * Params: + * format = Formatted string. + * description = Description of the argument. + * defaultValue = Default value, or `null`. + * + * Throws: + * AssertionError if format is not enclosed in `<>` or `[]`. + */ + public static Argument fromString(string format, string description, string defaultValue = null) @safe { + assert( + (format.startsWith("<") && format.endsWith(">")) + || (format.startsWith("[") && format.endsWith("]")), + "Argument format must be enclosed in <> or []" + ); + + const isRequired = format.startsWith("<"); + const namePart = format[1..$ - 1].strip(); + const isVariadic = namePart.endsWith("..."); + + return new Argument( + isVariadic ? namePart[0..$ - 3].strip() : namePart, + isRequired, + isVariadic, + description, + defaultValue + ); + } + + /** + * Returns formatted name, e.g., "" or "[files...]". + * + * Params: + * colors = Whether to use colors. + */ + public string formattedName(bool colors = false) const nothrow @safe { + const auto namePart = name ~ (variadic ? "..." : ""); + if (colors) + return required + ? "<".brightBlack() ~ namePart.dim() ~ ">".brightBlack() + : "[".brightBlack() ~ namePart.dim() ~ "]".brightBlack(); + return required ? "<" ~ namePart ~ ">" : "[" ~ namePart ~ "]"; + } +} diff --git a/src/cmd/command.d b/src/cmd/command.d new file mode 100644 index 0000000..4faca0b --- /dev/null +++ b/src/cmd/command.d @@ -0,0 +1,412 @@ +module cmd.command; + +import core.stdc.stdlib; +import std.algorithm; +import std.array; +import std.range : repeat; +import std.stdio; +import std.string; + +import cmd.ansi; +import cmd.argument; +import cmd.document; +import cmd.flag; +import cmd.option; +import cmd.parsed_args; +import cmd.program; + +/** Represents a command-line command. */ +public class Command { + private const string nameStr; + private string descriptionStr; + package Flag[] flags; + package Option[] options; + package Argument[] arguments; + package Command[] subcommands; + + /** Chain of commands leading to this command. */ + public Command[] chain = null; + private int delegate(ParsedArgs) actionDg; + + /** + * Constructs a new command with the given name. + * + * Params: + * name = Name of the command. + * + * Throws: + * AssertionError if the name is empty. + */ + public this(string name) @safe { + assert(!name.empty(), "Command name must be non-empty"); + this.nameStr = name; + this.actionDg = (args) => args.command.printHelp(); + } + + /** Gets the name of the command. */ + public string name() const nothrow @safe { + return this.nameStr; + } + + /** Sets the description of the command */ + public Command description(string description) nothrow @safe { + this.descriptionStr = description; + return this; + } + + /** Gets the description of the command */ + public string description() const nothrow @safe { + return this.descriptionStr; + } + + /** + * Searches for a subcommand with the specified name. + * + * This function can search either the immediate subcommands of this command + * or recursively within a specified subcommand tree. + * + * Params: + * name = The name of the subcommand to search for. + * root = Optional. The command node to start the search from. + * - If `null`, the search is performed only among this command’s immediate subcommands. + * - If non-`null`, the search is recursive starting from `root` and checks all nested subcommands. + * + * Returns: + * The first `Command` matching the specified name, or `null` if no match is found. + */ + public const(Command) findCommand(string name, const(Command) root = null) const nothrow @safe { + if (root !is null && root.name() == name) return root; + foreach (cmd; root is null ? subcommands : root.subcommands) { + if (cmd.name() == name) return cmd; + if (root !is null) { + const Command found = findCommand(name, cmd); + if (found !is null) return found; + } + } + return null; + } + + private const(Option) findOption(string query) const nothrow @safe { + foreach (opt; options) + if (opt.matches(query)) + return opt; + return null; + } + + private const(Flag) findFlag(string query) const nothrow @safe { + foreach (flag; flags) + if (flag.matches(query)) + return flag; + return null; + } + + private const(Argument) findArgument(string query) const nothrow @safe { + foreach (arg; arguments) + if (arg.name == query) + return arg; + return null; + } + + /** + * Adds a subcommand. + * + * Throws: + * AssertionError if subcommand already has a chain, if this command has arguments, or if a subcommand with the + * same name already exists. + */ + public Command add(Command cmd) @safe { + assert(cmd.chain is null, "Subcommand already has a command chain"); + assert(arguments.empty(), "Cannot add subcommands to a command that has arguments"); + assert(findCommand(cmd.name()) is null, "Command '" ~ cmd.name() ~ "' already exists"); + cmd.chain = this.chain ~ cmd; + subcommands ~= cmd; + return this; + } + + /** + * Adds a subcommand. + * + * Throws: + * AssertionError if subcommand already has a chain, if this command has arguments, or if a subcommand with the + * same name already exists. + */ + public Command command(Command cmd) @safe { + return add(cmd); + } + + /** + * Adds an option. + * + * Throws: + * AssertionError if an option with the same short or long name already exists. + */ + public Command add(Option option) @safe { + assert(findOption(option.shortName) is null, "Option '-" ~ option.shortName ~ "' already exists"); + assert(findOption(option.longName) is null, "Option '--" ~ option.longName ~ "' already exists"); + options ~= option; + return this; + } + + /** + * Adds a flag. + * + * Throws: + * AssertionError if a flag with the same short or long name already exists. + */ + public Command add(Flag flag) @safe { + assert(findFlag(flag.shortName) is null, "Option '-" ~ flag.shortName ~ "' already exists"); + assert(findFlag(flag.longName) is null, "Option '--" ~ flag.longName ~ "' already exists"); + flags ~= flag; + return this; + } + + /** + * Adds an option or flag from formatted string. + * + * Params: + * format = Formatted string defining option or flag. + * description = Description of the option or flag. + * defaultValue = Default value for option, or `null`. + */ + public Command option(string format, string description, string defaultValue = null) @safe { + if (format.canFind("<") || format.canFind("[")) + add(Option.fromString(format, description, defaultValue)); + else + add(Flag.fromString(format, description)); + return this; + } + + /** + * Adds an argument. + * + * Throws: + * AssertionError if the command has subcommands or an argument with the same name already exists. + */ + public Command add(Argument arg) @safe { + assert(subcommands.empty(), "Cannot add arguments to a command that has subcommands"); + assert(findArgument(arg.name) is null, "Argument '" ~ arg.name ~ "' already exists"); + arguments ~= arg; + return this; + } + + /** + * Adds an argument from formatted string. + * + * Params: + * format = Formatted string defining the argument. + * description = Description of the argument. + * defaultValue = Default value of the argument, or `null`. + * + * Throws: + * AssertionError if the argument format is invalid or an argument with the same name already exists. + */ + public Command argument(string format, string description, string defaultValue = null) @safe { + return add(Argument.fromString(format, description, defaultValue)); + } + + /** + * Sets the action delegate to be executed for this command. The default action is to print help for the command. + * + * Params: + * action = Delegate to execute when command runs. + */ + public Command action(int delegate(ParsedArgs) action) nothrow @safe { + this.actionDg = action; + return this; + } + + /** + * Gets the usage string for this command. + * + * Params: + * colors = Whether to use colors in the usage string. + * Throws: + * AssertionError if command chain is null or empty, or if first command is not a Program. + */ + public string usage(bool colors = false) const { + assert(chain !is null, "Command chain is not initialised"); + assert(!chain.empty(), "Command chain is empty. The command should have at least itself in its chain."); + Program program = cast(Program) chain[0]; + assert(program !is null, "First command in chain must be Program"); + + Appender!string sb; + sb.put(program.name()); + if (program.versionOption() || program.helpOption()) + sb.put(" " + ~ "[".brightBlack() ~ ((chain.length > 1 ? "global " : "") ~ "options").dim() ~ "]".brightBlack()); + if (chain.length > 1) + sb.put(" " ~ chain[1..$].map!(c => c.name()).array.join(" ")); + if (!subcommands.empty()) + sb.put(" " ~ "<".brightBlack() ~ "command".dim() ~ ">".brightBlack() ~ " " ~ "...".brightBlack()); + else { + if (!options.empty() || !flags.empty()) + sb.put(" " ~ (options.any!(o => o.required) + ? "<".brightBlack() ~ "options".dim() ~ ">".brightBlack() + : "[".brightBlack() ~ "options".dim() ~ "]".brightBlack() + )); + foreach (arg; arguments) + sb.put(" " ~ arg.formattedName(colors)); + } + return colors ? sb.data : sb.data.stripAnsi(); + } + + /** Prints help for the command. */ + public int printHelp() const { + auto doc = new Document(); + doc.add("Usage:".bold(), usage(true)); + + if (subcommands !is null) { + auto s = new Section("Commands:".bold()); + doc.add(s); + + foreach (cmd; (cast(Command[]) subcommands).dup.sort!((a, b) { + return a.name() < b.name(); + })) s.add(cmd.name(), cmd.description()); + } + + if (arguments !is null) { + auto s = new Section("Arguments:".bold()); + doc.add(s); + + foreach (arg; arguments) + s.add(arg.name, arg.description); + } + + if (!flags.empty() || !options.empty()) { + auto s = new Section("Options:".bold()); + doc.add(s); + + foreach (opt; (cast(Flag[]) (flags ~ cast(Flag[]) options)).sort!((a, b) { + auto nameA = a.longName !is null ? a.longName : a.shortName; + auto nameB = b.longName !is null ? b.longName : b.shortName; + return nameA < nameB; + })) { + if (Option o = cast(Option) opt) + s.add(o.formattedName(colors: true, padded: true), opt.description); + else s.add(opt.formattedName(padded: true), opt.description); + } + } + + doc.print(); + return 0; + } + + /** Prints an error message to stderr. */ + public void error(string description) const { + stderr.writeln("error: " ~ description); + } + + /** Prints an error message to stderr and exits with status. */ + public noreturn error(string description, int status) const { + this.error(description); + exit(status); + } + + package ParsedArgs parse(const(string[]) args, const(Program) program) const { + if (!subcommands.empty()) { + auto index = args.countUntil!(a => a.front() != '-'); + if (index >= 0) { + const(Command) cmd = findCommand(args[index]); + if (cmd is null) + error("unknown command '" ~ args[index] ~ "'", 2); + return cmd.parse(args[0..index] ~ args[index + 1..$], program); + } + } + + ParsedArgs parsedArgs = new ParsedArgs(this, program); + size_t argIndex = 0; + + string[][const(Option)] parsedOptions = new string[][Option]; + string[] variadic = []; + + for (size_t i = 0; i < args.length; ++i) { + string arg = args[i]; + if (arg.front() == '-') { + if (program.versionOption() !is null && program.versionOption().matches(arg)) + exit(program.printVersion()); + if (program.helpOption() !is null && program.helpOption().matches(arg)) + exit(printHelp()); + + const(Flag) flag = findFlag(arg); + if (flag !is null) { + parsedArgs.setFlag(flag); + continue; + } + + const auto equalsIndex = arg.indexOf('='); + const string optName = equalsIndex >= 0 ? arg[0..equalsIndex] : arg; + const(Option) option = findOption(optName); + if (option !is null) { + string value; + if (equalsIndex >= 0) + value =arg[equalsIndex + 1..$]; + else if (i + 1 < args.length) + value = args[++i]; + else + error("missing value for option '" ~ optName ~ "'", 2); + + if (option in parsedOptions) + parsedOptions[option] ~= value; + else + parsedOptions[option] = [value]; + continue; + } + else program.error("unknown option '" ~ optName ~ "'", 2); + } + + if (argIndex + 1 > arguments.length) { + if (!variadic.empty()) { + variadic ~= arg; + continue; + } + error("unexpected argument '" ~ arg ~ "'", 2); + } + + const(Argument) argument = arguments[argIndex++]; + if (argument.variadic) + variadic ~= arg; + else + parsedArgs.setArgument(argument, arg); + } + + if (!variadic.empty()) + parsedArgs.setArgumentList(variadic); + + foreach (opt, value; parsedOptions) { + parsedArgs.setOption(opt, value); + } + + foreach (opt; options) { + if (parsedArgs.hasOption(opt)) continue; + if (opt.required) + error("missing required option '" ~ opt.formattedName() ~ "'", 2); + if (opt.defaultValue !is null) + parsedArgs.setOption(opt, [opt.defaultValue]); + } + + foreach (arg; arguments) { + if (arg.variadic) { + if (parsedArgs.variadic !is null && !parsedArgs.variadic.empty()) + continue; + if (arg.required) + error("missing required argument '" ~ arg.name ~ "'", 2); + if (arg.defaultValue !is null) + parsedArgs.setArgumentList([arg.defaultValue]); + } + else { + if (parsedArgs.hasArgument(arg)) continue; + if (arg.required) + error("missing required argument '" ~ arg.name ~ "'", 2); + if (arg.defaultValue !is null) + parsedArgs.setArgument(arg, arg.defaultValue); + } + } + + return parsedArgs; + } + + public int run(const(string[]) args, const(Program) program) const { + auto parsed = parse(args, program); + return parsed.command.actionDg(parsed); + } +} diff --git a/src/cmd/document.d b/src/cmd/document.d new file mode 100644 index 0000000..860d5c2 --- /dev/null +++ b/src/cmd/document.d @@ -0,0 +1,155 @@ +module cmd.document; + +import std.algorithm; +import std.array; +import std.range; +import std.stdio; +import std.typecons; + +import cmd.ansi; + +/** Represents a term with a definition. */ +public alias Term = Tuple!(string, string); + +/** Represents a section of a document. */ +public class Section { + /** Title of the section. */ + public const string title; + + /** Main body text of the section, or `null`. */ + public const string body; + + /** Terms and definitions associated with the section. */ + protected Term[] termsList; + + /** The length of the longest term. */ + protected size_t longest = 0; + + /** + * Constructs a new section. + * + * Params: + * title = Title of the section. + * body = Main body text of the section, or `null`. + * terms = Terms and definitions associated with the section. + * Throws: + * AssertionError if the title is null. + */ + public this(string title, string body = null, Term[] terms = []) @safe { + assert(title !is null, "Section title cannot be null"); + this.title = title; + this.body = body; + termsList = terms; + longest = !terms.empty() ? terms.map!(t => t[0].stripAnsi().length).maxElement() : 0; + } + + /** Terms and definitions associated with the section. */ + public const(Term[]) terms() const nothrow @safe { + return termsList; + } + + /** Adds a term to the section. */ + public Section add(Term term) @safe { + termsList ~= term; + longest = max(longest, term[0].stripAnsi().length); + return this; + } + + /** + * Adds a term to the section. + * + * Params: + * term = Term text. + * definition = Definition text. + */ + public Section add(string term, string definition) @safe { + return this.add(Term(term, definition)); + } +} + +/** + * Represents a document comprised of sections. + */ +public class Document { + /** Sections associated with this document. */ + protected Section[] sectionsList; + + /** Constructs a new document. */ + public this() nothrow @safe { + sectionsList = []; + } + + /** + * Gets a section associated with this document by its title (ANSI is stripped). + * + * Params: + * title = Title of the section. + * Returns: + * Null if no matching section is found, otherwise the matching section. + */ + public const(Section) section(string title) const @safe { + auto sections = this.sections().find!(s => s.title.stripAnsi() == title.stripAnsi()); + if (sections.empty()) return null; + return sections.front(); + } + + /** Gets the sections associated with this document. */ + public const(Section[]) sections() const nothrow @safe { + return sectionsList; + } + + /** Adds a section to this document. */ + public Document add(Section section) nothrow @safe { + sectionsList ~= section; + return this; + } + + /** + * Adds a section to this document. + * + * Params: + * title = Title of the section. + * body = Body of the section. + * terms = Terms associated with the section. + */ + public Document add(string title, string body = null, Term[] terms = []) @safe { + return this.add(new Section(title, body, terms)); + } + + /** Adds a term to a section matching the specified title (ANSI is stripped for matching). */ + public Document add(string section, Term term) @safe { + auto sections = sectionsList.find!(s => s.title.stripAnsi() == section.stripAnsi()); + assert(!sections.empty(), "Could not find section " ~ section); + sections.front().add(term); + return this; + } + + /** Adds a term to a section matching the specified title (ANSI is stripped for matching). */ + public Document add(string section, string term, string definition) @safe { + return this.add(section, Term(term, definition)); + } + + /** + * Prints this document to standard output. + */ + public void print() const @safe { + const longest = sections().empty() ? 0 : sections().map!(s => s.longest).maxElement(); + + for (size_t i = 0; i < sectionsList.length; ++i) { + const section = sectionsList[i]; + writeln(section.title); + if (section.body !is null) + writeln(" " ~ section.body); + foreach (term; section.terms()) { + writeln( + " " + ~ term[0] + ~ ' '.repeat(max(2, longest - term[0].stripAnsi().length + 2)).array() + ~ term[1] + ); + } + if (i + 1 < sectionsList.length) + writeln(); + } + } +} diff --git a/src/cmd/flag.d b/src/cmd/flag.d new file mode 100644 index 0000000..a5d277d --- /dev/null +++ b/src/cmd/flag.d @@ -0,0 +1,119 @@ +module cmd.flag; + +import std.range; +import std.string; + +/** + * Represents a command-line flag. + */ +public class Flag { + /** Single-character short name, or `null`. */ + public const string shortName; + + /** Long name, or `null`. */ + public const string longName; + + /** Description of the flag. */ + public const string description; + + /** + * Placeholder for padding when there is no short option. + * + * 4 spaces as placeholder for: minus (`-`) + any letter (`a`) + comma (`,`) + space (` `) + * Example: `-a, ` (4 characters) + */ + public static const enum PADDING_MISSING_SHORT = " "; + + /** + * Constructs a flag. + * + * Params: + * shortName = Single-character short name, or `null`. + * longName = Long name, or `null`. + * description = Description of the flag. + * + * Throws: + * AssertionError if both names are `null`, `shortName` not single character, or `longName` empty. + */ + public this(string shortName, string longName, string description) @safe { + assert(shortName is null || shortName.length == 1, "Short name must be a single character"); + assert(longName is null || !longName.empty(), "Long name must be non-empty"); + assert(shortName !is null || longName !is null, "At least one of shortName or longName must be provided"); + + this.shortName = shortName; + this.longName = longName; + this.description = description; + } + + /** + * Creates a flag from a formatted string. + * + * Format may include short name `-x` and/or long name `--name`, comma-separated. + * + * Params: + * format = Formatted string. + * description = Description of the flag. + * + * Throws: + * AssertionError if format does not contain 1 or 2 parts. + */ + public static Flag fromString(string format, string description) @safe { + auto parts = format.strip().split(","); + assert(parts.length == 1 || parts.length == 2, "Expected 1 or 2 parts in flag format"); + + string shortOpt = null; + string longOpt = null; + + foreach (part; parts) { + part = part.strip(); + if (part.startsWith("--")) + longOpt = part[2..$]; + else if (part.startsWith("-")) + shortOpt = part[1..2]; + } + + return new Flag(shortOpt, longOpt, description); + } + + /** + * Returns formatted name, e.g., `-h, --help`. + * + * Params: + * padded = Whether to add spaces at the start if there is no short option. + */ + public string formattedName(bool padded = false) const nothrow @safe { + return "" + ~ (shortName !is null + ? "-" ~ shortName + : (padded ? PADDING_MISSING_SHORT : "") + ) + ~ (longName !is null + ? (shortName !is null ? ", " : "") ~ "--" ~ longName + : "" + ); + } + + /** + * Checks whether the given query matches this flag. + * + * Params: + * query = String to check. + */ + public bool matches(string query) const nothrow @safe { + return + (query.startsWith("--") && longName == query[2..$]) + || (query.startsWith("-") && shortName == query[1..2]) + || query == longName + || query == shortName; + } + + public override hash_t toHash() const nothrow @safe { + return formattedName().hashOf(); + } + + public override bool opEquals(Object o) const nothrow { + if (auto other = cast(Flag) o) + return this.formattedName() == other.formattedName(); + return false; + } +} diff --git a/src/cmd/help_command.d b/src/cmd/help_command.d new file mode 100644 index 0000000..71ca71a --- /dev/null +++ b/src/cmd/help_command.d @@ -0,0 +1,32 @@ +module cmd.help_command; + +import cmd.command; + +/** + * Command to display help for commands. + */ +class HelpCommand : Command { + /** + * Constructs a new HelpCommand instance. + * + * Params: + * description = Command description. + */ + public this(string description = "Show help for command") { + super("help") + .description(description) + .argument("[command...]", "Command to show help for") + .action((args) { + if (!args.hasArgument("command")) + return args.program.printHelp(); + + Command target = cast(Command) args.program; + foreach (cmd; args.argumentList("command")) { + target = cast(Command) target.findCommand(cmd); + if (target is null) + error("unknown command: " ~ cmd, 2); + } + return target.printHelp(); + }); + } +} diff --git a/src/cmd/option.d b/src/cmd/option.d new file mode 100644 index 0000000..7eb3a3d --- /dev/null +++ b/src/cmd/option.d @@ -0,0 +1,123 @@ +module cmd.option; + +import std.string; + +import cmd.ansi; +import cmd.flag; + +/** Represents a command-line option with a parameter. */ +public final class Option : Flag { + /** Name of the parameter. */ + public const string paramName; + + /** Whether the option is required. */ + public const bool required; + + /** Default value of the parameter, or `null`. */ + public const string defaultValue; + + /** + * Constructs an option. + * + * Params: + * shortName = Single-character short name, or `null`. + * longName = Long name, or `null`. + * paramName = Name of the parameter. + * description = Description of the option. + * required = Whether the option is required. + * defaultValue = Default value of the parameter, or `null`. + * + * Throws: + * AssertionError if option is required and default value is not `null`. + */ + public this(string shortName, string longName, string paramName, string description, bool required, + string defaultValue = null) @safe { + if (required) + assert(defaultValue is null, "Required option cannot have a default value"); + + super(shortName, longName, description); + this.paramName = paramName; + this.required = required; + this.defaultValue = defaultValue; + } + + /** + * Creates an option from a formatted string. + * + * Format may include short name `-x` and/or long name `--name`, followed by parameter in `<>` (required) or `[]` + * (optional). Example: "-o, --output ". + * + * Params: + * format = Formatted string. + * description = Description of the option. + * defaultValue = Default value of the parameter, or `null`. + * + * Throws: + * AssertionError if format does not contain 2 or 3 parts, or if parameter part is not enclosed in `<>` or `[]`. + */ + public static Option fromString(string format, string description, string defaultValue = null) @safe { + auto parts = format.strip().split(" "); + assert(parts.length == 2 || parts.length == 3, "Expected 2 or 3 parts in option format"); + + string shortOpt = null; + string longOpt = null; + string paramPart = parts[$ - 1]; + + assert( + (paramPart.startsWith("<") && paramPart.endsWith(">")) + || (paramPart.startsWith("[") && paramPart.endsWith("]")), + "Parameter part must be enclosed in <> or []" + ); + + foreach (part; parts[0..$ - 1]) { + part = part.strip(); + if (part.startsWith("--")) + longOpt = part[2..$]; + else if (part.startsWith("-")) + shortOpt = part[1..2]; + } + + return new Option( + shortOpt, longOpt, paramPart[1..$ - 1].strip(), description, paramPart.startsWith("<"), defaultValue + ); + } + + /** + * Returns formatted name with parameter placeholder, e.g., `-f, --foo `. + * + * Params: + * colors = Whether to use colors. + * padded = Whether to add spaces at the start if there is no short option. + */ + public string formattedName(bool colors, bool padded = false) const nothrow @safe { + return super.formattedName(padded) ~ " " ~ + (colors + ? required + ? "<".brightBlack() ~ paramName.dim() ~ ">".brightBlack() + : "[".brightBlack() ~ paramName.dim() ~ "]".brightBlack() + : required + ? "<" ~ paramName ~ ">" + : "[" ~ paramName ~ "]" + ); + } + + /** + * Returns formatted name with parameter placeholder, e.g., `-f, --foo `. + * + * Params: + * padded = Whether to add spaces at the start if there is no short option. + */ + public override string formattedName(bool padded = false) const nothrow @safe { + return formattedName(colors: false, padded: padded); + } + + public override hash_t toHash() const nothrow @safe { + return formattedName().hashOf(); + } + + public override bool opEquals(Object o) const nothrow { + if (auto other = cast(Option) o) + return this.formattedName() == other.formattedName(); + return false; + } +} diff --git a/src/cmd/package.d b/src/cmd/package.d new file mode 100644 index 0000000..d8c9816 --- /dev/null +++ b/src/cmd/package.d @@ -0,0 +1,11 @@ +module cmd; + +public import cmd.ansi; +public import cmd.argument; +public import cmd.command; +public import cmd.document; +public import cmd.flag; +public import cmd.help_command; +public import cmd.option; +public import cmd.parsed_args; +public import cmd.program; diff --git a/src/cmd/parsed_args.d b/src/cmd/parsed_args.d new file mode 100644 index 0000000..f00d0b2 --- /dev/null +++ b/src/cmd/parsed_args.d @@ -0,0 +1,141 @@ +module cmd.parsed_args; + +import std.array; + +import cmd.argument; +import cmd.command; +import cmd.flag; +import cmd.option; +import cmd.program; + +/** Represents parsed command-line arguments for a command. */ +public final class ParsedArgs { + /** Command associated with the parsed arguments. */ + public const(Command) command; + + /** Program associated with the parsed arguments. */ + public const(Program) program; + + private bool[string] flags; + private string[][string] options; + private string[string] arguments; + package string[] variadic; + + package this(const(Command) command, const(Program) program) nothrow @safe { + this.command = command; + this.program = program; + } + + /** Checks whether the given flag name is present. */ + public bool flag(string name) const nothrow @safe { + foreach (prefix; ["", "-", "--"]) + if (auto p = prefix ~ name in flags) + return *p; + return false; + } + + /** Checks whether the given flag is present. */ + public bool flag(Flag flag) const nothrow @safe { + if (flag.longName !is null) + return this.flag("--" ~ flag.longName); + return this.flag("-" ~ flag.shortName); + } + + /** Checks whether an option with the given name is present. */ + public bool hasOption(string name) const nothrow @safe { + return name in options || "-" ~ name in options || "--" ~ name in options; + } + + /** Checks whether the given option is present. */ + public bool hasOption(const(Option) option) const nothrow @safe { + if (option.longName !is null) + return this.hasOption("--" ~ option.longName); + return this.hasOption("-" ~ option.shortName); + } + + /** Gets the first value for the option with the given name. */ + public string option(string name) const @safe { + foreach (prefix; ["", "-", "--"]) + if (auto p = prefix ~ name in options) + return (*p).front(); + throw new Exception("Option '" ~ name ~ "' not found"); + } + + /** Gets all values for the option with the given name. */ + public const(string[]) optionList(string name) const @safe { + foreach (prefix; ["", "-", "--"]) + if (auto p = prefix ~ name in options) + return *p; + throw new Exception("Option '" ~ name ~ "' not found"); + } + + /** Gets all values for the given option. */ + public const(string[]) optionList(Option option) const @safe { + if (option.shortName !is null) + return this.optionList("-" ~ option.shortName); + return this.optionList("--" ~ option.longName); + } + + /** Checks whether an argument with the given name is present. */ + public bool hasArgument(string name) const nothrow @safe { + if (name in arguments) + return true; + + if (variadic is null || variadic.empty()) + return false; + + foreach (arg; command.arguments) + if (arg.name == name && arg.variadic) + return true; + + return false; + } + + /** Checks whether the given argument is present. */ + public bool hasArgument(const(Argument) argument) const nothrow @safe { + return hasArgument(argument.name); + } + + /** Gets the first value for the argument with the given name. */ + public string argument(string name) const @safe { + return argumentList(name).front(); + } + + /** Gets all values for the argument with the given name. */ + public const(string[]) argumentList(string name) const @safe { + if (auto p = name in arguments) + return [*p]; + + if (variadic !is null && !variadic.empty()) + foreach (arg; command.arguments) + if (arg.name == name && arg.variadic) + return variadic; + + throw new Exception("Argument '" ~ name ~ "' not found"); + } + + package void setOption(const(Option) option, string[] values) @safe { + assert(!hasOption(option), "Option '" ~ option.formattedName() ~ "' already present"); + if (option.longName !is null) + options["--" ~ option.longName] = values; + if (option.shortName !is null) + options["-" ~ option.shortName] = values; + } + + package void setFlag(const(Flag) flag, bool value = true) nothrow @safe { + if (flag.longName !is null) + flags[flag.longName] = value; + if (flag.shortName !is null) + flags[flag.shortName] = value; + } + + package void setArgument(const(Argument) argument, string value) @safe { + assert(!hasArgument(argument), "Argument '" ~ argument.name ~ "' already present"); + arguments[argument.name] = value; + } + + package void setArgumentList(string[] values) @safe { + assert(variadic is null || variadic.empty(), "Argument list already set"); + variadic = values; + } +} diff --git a/src/cmd/program.d b/src/cmd/program.d new file mode 100644 index 0000000..0d96c49 --- /dev/null +++ b/src/cmd/program.d @@ -0,0 +1,206 @@ +module cmd.program; + +import core.stdc.stdlib; +import std.array; +import std.stdio; + +import cmd.argument; +import cmd.command; +import cmd.flag; +import cmd.option; +import cmd.parsed_args; + +/** Represents a command-line program. */ +public class Program : Command { + private string versionStr; + private Flag versionOptionFlag; + private Flag helpOptionFlag; + + /** + * Constructs a new program with the given name. + * + * Params: + * name = Name of the program. + * + * Throws: + * AssertionError if the name is empty. + */ + public this(string name) @safe { + super(name); + this.chain = [this]; + } + + /** Sets the version of the program. */ + public Program versionString(string ver) nothrow @safe { + this.versionStr = ver; + return this; + } + + /** Gets the version of the program. */ + public string versionString() const nothrow @safe { + return versionStr; + } + + /** Sets the version flag for the program and enables getting the version with it. */ + public Program versionOption(Flag flag) @safe { + assert(versionStr !is null, "Version is not set"); + versionOptionFlag = flag; + flags ~= flag; + return this; + } + + /** Sets the version flag for the program from formatted string and enables getting the version with it. */ + public Program versionOption(string format, string description) @safe { + return versionOption(Flag.fromString(format, description)); + } + + /** Gets the version flag for the program. */ + public const(Flag) versionOption() const nothrow @safe { + return versionOptionFlag; + } + + /** Prints the version and returns 0. */ + public const(int) printVersion() const { + assert(versionStr !is null, "Version is not set"); + writeln(versionStr); + return 0; + } + + /** Sets the help flag for the program from formatted string and enables getting command help with it. */ + public Program helpOption(string format, string description) @safe { + return helpOption(Flag.fromString(format, description)); + } + + + /** Sets the help flag for the program and enables getting command help with it. */ + public Program helpOption(Flag flag) nothrow @safe { + helpOptionFlag = flag; + flags ~= flag; + return this; + } + + /** Gets the help flag for the program. */ + public const(Flag) helpOption() const nothrow @safe { + return helpOptionFlag; + } + + /** Sets the description of the command */ + public override Program description(string desc) nothrow @safe { + super.description(desc); + return this; + } + + /** + * Adds a subcommand. + * + * Throws: + * AssertionError if subcommand already has a chain, if this command has arguments, or if a subcommand with the + * same name already exists. + */ + public override Program add(Command cmd) @safe { + super.add(cmd); + return this; + } + + /** + * Adds a subcommand. + * + * Throws: + * AssertionError if subcommand already has a chain, if this command has arguments, or if a subcommand with the + * same name already exists. + */ + public override Program command(Command cmd) @safe { + super.command(cmd); + return this; + } + + /** + * Adds an option. + * + * Throws: + * AssertionError if an option with the same short or long name already exists. + */ + public override Program add(Option option) @safe { + super.add(option); + return this; + } + + /** + * Adds a flag. + * + * Throws: + * AssertionError if a flag with the same short or long name already exists. + */ + public override Program add(Flag flag) @safe { + super.add(flag); + return this; + } + + /** + * Adds an option or flag from formatted string. + * + * Params: + * format = Formatted string defining option or flag. + * description = Description of the option or flag. + * defaultValue = Default value for option, or `null`. + */ + public override Program option(string format, string description, string defaultValue = null) @safe { + super.option(format, description, defaultValue); + return this; + } + + /** + * Adds an argument. + * + * Throws: + * AssertionError if the command has subcommands or an argument with the same name already exists. + */ + public override Program add(Argument arg) @safe { + super.add(arg); + return this; + } + + /** + * Adds an argument from formatted string. + * + * Params: + * format = Formatted string defining the argument. + * description = Description of the argument. + * defaultValue = Default value of the argument, or `null`. + * + * Throws: + * AssertionError if the argument format is invalid or an argument with the same name already exists. + */ + public override Program argument(string format, string description, string defaultValue = null) @safe { + super.argument(format, description, defaultValue); + return this; + } + + /** + * Sets the action delegate to be executed for this command. The default action is to print help for the command. + * + * Params: + * action = Delegate to execute when command runs. + */ + public override Program action(int delegate(ParsedArgs) dg) @safe { + super.action(dg); + return this; + } + + /** + * Gets the parsed arguments. + */ + public ParsedArgs parse(string[] args) const { + return super.parse(args[1..$], this); + } + + /** + * Runs the program with the given arguments. + * + * Params: + * args = Command-line arguments array. + */ + public noreturn run(string[] args) const { + exit(super.run(args[1..$], this)); + } +}