├── .gitignore ├── .travis.yml ├── Cargo.toml ├── GPLv3.md ├── LGPLv3.md ├── README.md ├── src ├── errors.rs ├── lib.rs ├── matches.rs ├── token.rs ├── usage.rs └── vars.rs └── tests └── main.rs /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | /Cargo.lock 3 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: rust 2 | rust: 3 | - nightly 4 | - beta 5 | - stable 6 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | 3 | name = "pirate" 4 | version = "1.0.0" 5 | authors = ["Zach Dziura "] 6 | description = "A simple arrrguments parser" 7 | repository = "https://github.com/zcdziura/pirate" 8 | keywords = ["parser", "getopts", "options", "arguments"] 9 | license = "LGPL-3.0+" 10 | -------------------------------------------------------------------------------- /GPLv3.md: -------------------------------------------------------------------------------- 1 | GNU General Public License 2 | ========================== 3 | 4 | _Version 3, 29 June 2007_ 5 | _Copyright © 2007 Free Software Foundation, Inc. <>_ 6 | 7 | Everyone is permitted to copy and distribute verbatim copies of this license 8 | document, but changing it is not allowed. 9 | 10 | ## Preamble 11 | 12 | The GNU General Public License is a free, copyleft license for software and other 13 | kinds of works. 14 | 15 | The licenses for most software and other practical works are designed to take away 16 | your freedom to share and change the works. By contrast, the GNU General Public 17 | License is intended to guarantee your freedom to share and change all versions of a 18 | program--to make sure it remains free software for all its users. We, the Free 19 | Software Foundation, use the GNU General Public License for most of our software; it 20 | applies also to any other work released this way by its authors. You can apply it to 21 | your programs, too. 22 | 23 | When we speak of free software, we are referring to freedom, not price. Our General 24 | Public Licenses are designed to make sure that you have the freedom to distribute 25 | copies of free software (and charge for them if you wish), that you receive source 26 | code or can get it if you want it, that you can change the software or use pieces of 27 | it in new free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you these rights or 30 | asking you to surrender the rights. Therefore, you have certain responsibilities if 31 | you distribute copies of the software, or if you modify it: responsibilities to 32 | respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether gratis or for a fee, 35 | you must pass on to the recipients the same freedoms that you received. You must make 36 | sure that they, too, receive or can get the source code. And you must show them these 37 | terms so they know their rights. 38 | 39 | Developers that use the GNU GPL protect your rights with two steps: **(1)** assert 40 | copyright on the software, and **(2)** offer you this License giving you legal permission 41 | to copy, distribute and/or modify it. 42 | 43 | For the developers' and authors' protection, the GPL clearly explains that there is 44 | no warranty for this free software. For both users' and authors' sake, the GPL 45 | requires that modified versions be marked as changed, so that their problems will not 46 | be attributed erroneously to authors of previous versions. 47 | 48 | Some devices are designed to deny users access to install or run modified versions of 49 | the software inside them, although the manufacturer can do so. This is fundamentally 50 | incompatible with the aim of protecting users' freedom to change the software. The 51 | systematic pattern of such abuse occurs in the area of products for individuals to 52 | use, which is precisely where it is most unacceptable. Therefore, we have designed 53 | this version of the GPL to prohibit the practice for those products. If such problems 54 | arise substantially in other domains, we stand ready to extend this provision to 55 | those domains in future versions of the GPL, as needed to protect the freedom of 56 | users. 57 | 58 | Finally, every program is threatened constantly by software patents. States should 59 | not allow patents to restrict development and use of software on general-purpose 60 | computers, but in those that do, we wish to avoid the special danger that patents 61 | applied to a free program could make it effectively proprietary. To prevent this, the 62 | GPL assures that patents cannot be used to render the program non-free. 63 | 64 | The precise terms and conditions for copying, distribution and modification follow. 65 | 66 | ## TERMS AND CONDITIONS 67 | 68 | ### 0. Definitions 69 | 70 | “This License” refers to version 3 of the GNU General Public License. 71 | 72 | “Copyright” also means copyright-like laws that apply to other kinds of 73 | works, such as semiconductor masks. 74 | 75 | “The Program” refers to any copyrightable work licensed under this 76 | License. Each licensee is addressed as “you”. “Licensees” and 77 | “recipients” may be individuals or organizations. 78 | 79 | To “modify” a work means to copy from or adapt all or part of the work in 80 | a fashion requiring copyright permission, other than the making of an exact copy. The 81 | resulting work is called a “modified version” of the earlier work or a 82 | work “based on” the earlier work. 83 | 84 | A “covered work” means either the unmodified Program or a work based on 85 | the Program. 86 | 87 | To “propagate” a work means to do anything with it that, without 88 | permission, would make you directly or secondarily liable for infringement under 89 | applicable copyright law, except executing it on a computer or modifying a private 90 | copy. Propagation includes copying, distribution (with or without modification), 91 | making available to the public, and in some countries other activities as well. 92 | 93 | To “convey” a work means any kind of propagation that enables other 94 | parties to make or receive copies. Mere interaction with a user through a computer 95 | network, with no transfer of a copy, is not conveying. 96 | 97 | An interactive user interface displays “Appropriate Legal Notices” to the 98 | extent that it includes a convenient and prominently visible feature that **(1)** 99 | displays an appropriate copyright notice, and **(2)** tells the user that there is no 100 | warranty for the work (except to the extent that warranties are provided), that 101 | licensees may convey the work under this License, and how to view a copy of this 102 | License. If the interface presents a list of user commands or options, such as a 103 | menu, a prominent item in the list meets this criterion. 104 | 105 | ### 1. Source Code 106 | 107 | The “source code” for a work means the preferred form of the work for 108 | making modifications to it. “Object code” means any non-source form of a 109 | work. 110 | 111 | A “Standard Interface” means an interface that either is an official 112 | standard defined by a recognized standards body, or, in the case of interfaces 113 | specified for a particular programming language, one that is widely used among 114 | developers working in that language. 115 | 116 | The “System Libraries” of an executable work include anything, other than 117 | the work as a whole, that **(a)** is included in the normal form of packaging a Major 118 | Component, but which is not part of that Major Component, and **(b)** serves only to 119 | enable use of the work with that Major Component, or to implement a Standard 120 | Interface for which an implementation is available to the public in source code form. 121 | A “Major Component”, in this context, means a major essential component 122 | (kernel, window system, and so on) of the specific operating system (if any) on which 123 | the executable work runs, or a compiler used to produce the work, or an object code 124 | interpreter used to run it. 125 | 126 | The “Corresponding Source” for a work in object code form means all the 127 | source code needed to generate, install, and (for an executable work) run the object 128 | code and to modify the work, including scripts to control those activities. However, 129 | it does not include the work's System Libraries, or general-purpose tools or 130 | generally available free programs which are used unmodified in performing those 131 | activities but which are not part of the work. For example, Corresponding Source 132 | includes interface definition files associated with source files for the work, and 133 | the source code for shared libraries and dynamically linked subprograms that the work 134 | is specifically designed to require, such as by intimate data communication or 135 | control flow between those subprograms and other parts of the work. 136 | 137 | The Corresponding Source need not include anything that users can regenerate 138 | automatically from other parts of the Corresponding Source. 139 | 140 | The Corresponding Source for a work in source code form is that same work. 141 | 142 | ### 2. Basic Permissions 143 | 144 | All rights granted under this License are granted for the term of copyright on the 145 | Program, and are irrevocable provided the stated conditions are met. This License 146 | explicitly affirms your unlimited permission to run the unmodified Program. The 147 | output from running a covered work is covered by this License only if the output, 148 | given its content, constitutes a covered work. This License acknowledges your rights 149 | of fair use or other equivalent, as provided by copyright law. 150 | 151 | You may make, run and propagate covered works that you do not convey, without 152 | conditions so long as your license otherwise remains in force. You may convey covered 153 | works to others for the sole purpose of having them make modifications exclusively 154 | for you, or provide you with facilities for running those works, provided that you 155 | comply with the terms of this License in conveying all material for which you do not 156 | control copyright. Those thus making or running the covered works for you must do so 157 | exclusively on your behalf, under your direction and control, on terms that prohibit 158 | them from making any copies of your copyrighted material outside their relationship 159 | with you. 160 | 161 | Conveying under any other circumstances is permitted solely under the conditions 162 | stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 163 | 164 | ### 3. Protecting Users' Legal Rights From Anti-Circumvention Law 165 | 166 | No covered work shall be deemed part of an effective technological measure under any 167 | applicable law fulfilling obligations under article 11 of the WIPO copyright treaty 168 | adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention 169 | of such measures. 170 | 171 | When you convey a covered work, you waive any legal power to forbid circumvention of 172 | technological measures to the extent such circumvention is effected by exercising 173 | rights under this License with respect to the covered work, and you disclaim any 174 | intention to limit operation or modification of the work as a means of enforcing, 175 | against the work's users, your or third parties' legal rights to forbid circumvention 176 | of technological measures. 177 | 178 | ### 4. Conveying Verbatim Copies 179 | 180 | You may convey verbatim copies of the Program's source code as you receive it, in any 181 | medium, provided that you conspicuously and appropriately publish on each copy an 182 | appropriate copyright notice; keep intact all notices stating that this License and 183 | any non-permissive terms added in accord with section 7 apply to the code; keep 184 | intact all notices of the absence of any warranty; and give all recipients a copy of 185 | this License along with the Program. 186 | 187 | You may charge any price or no price for each copy that you convey, and you may offer 188 | support or warranty protection for a fee. 189 | 190 | ### 5. Conveying Modified Source Versions 191 | 192 | You may convey a work based on the Program, or the modifications to produce it from 193 | the Program, in the form of source code under the terms of section 4, provided that 194 | you also meet all of these conditions: 195 | 196 | * **a)** The work must carry prominent notices stating that you modified it, and giving a 197 | relevant date. 198 | * **b)** The work must carry prominent notices stating that it is released under this 199 | License and any conditions added under section 7. This requirement modifies the 200 | requirement in section 4 to “keep intact all notices”. 201 | * **c)** You must license the entire work, as a whole, under this License to anyone who 202 | comes into possession of a copy. This License will therefore apply, along with any 203 | applicable section 7 additional terms, to the whole of the work, and all its parts, 204 | regardless of how they are packaged. This License gives no permission to license the 205 | work in any other way, but it does not invalidate such permission if you have 206 | separately received it. 207 | * **d)** If the work has interactive user interfaces, each must display Appropriate Legal 208 | Notices; however, if the Program has interactive interfaces that do not display 209 | Appropriate Legal Notices, your work need not make them do so. 210 | 211 | A compilation of a covered work with other separate and independent works, which are 212 | not by their nature extensions of the covered work, and which are not combined with 213 | it such as to form a larger program, in or on a volume of a storage or distribution 214 | medium, is called an “aggregate” if the compilation and its resulting 215 | copyright are not used to limit the access or legal rights of the compilation's users 216 | beyond what the individual works permit. Inclusion of a covered work in an aggregate 217 | does not cause this License to apply to the other parts of the aggregate. 218 | 219 | ### 6. Conveying Non-Source Forms 220 | 221 | You may convey a covered work in object code form under the terms of sections 4 and 222 | 5, provided that you also convey the machine-readable Corresponding Source under the 223 | terms of this License, in one of these ways: 224 | 225 | * **a)** Convey the object code in, or embodied in, a physical product (including a 226 | physical distribution medium), accompanied by the Corresponding Source fixed on a 227 | durable physical medium customarily used for software interchange. 228 | * **b)** Convey the object code in, or embodied in, a physical product (including a 229 | physical distribution medium), accompanied by a written offer, valid for at least 230 | three years and valid for as long as you offer spare parts or customer support for 231 | that product model, to give anyone who possesses the object code either **(1)** a copy of 232 | the Corresponding Source for all the software in the product that is covered by this 233 | License, on a durable physical medium customarily used for software interchange, for 234 | a price no more than your reasonable cost of physically performing this conveying of 235 | source, or **(2)** access to copy the Corresponding Source from a network server at no 236 | charge. 237 | * **c)** Convey individual copies of the object code with a copy of the written offer to 238 | provide the Corresponding Source. This alternative is allowed only occasionally and 239 | noncommercially, and only if you received the object code with such an offer, in 240 | accord with subsection 6b. 241 | * **d)** Convey the object code by offering access from a designated place (gratis or for 242 | a charge), and offer equivalent access to the Corresponding Source in the same way 243 | through the same place at no further charge. You need not require recipients to copy 244 | the Corresponding Source along with the object code. If the place to copy the object 245 | code is a network server, the Corresponding Source may be on a different server 246 | (operated by you or a third party) that supports equivalent copying facilities, 247 | provided you maintain clear directions next to the object code saying where to find 248 | the Corresponding Source. Regardless of what server hosts the Corresponding Source, 249 | you remain obligated to ensure that it is available for as long as needed to satisfy 250 | these requirements. 251 | * **e)** Convey the object code using peer-to-peer transmission, provided you inform 252 | other peers where the object code and Corresponding Source of the work are being 253 | offered to the general public at no charge under subsection 6d. 254 | 255 | A separable portion of the object code, whose source code is excluded from the 256 | Corresponding Source as a System Library, need not be included in conveying the 257 | object code work. 258 | 259 | A “User Product” is either **(1)** a “consumer product”, which 260 | means any tangible personal property which is normally used for personal, family, or 261 | household purposes, or **(2)** anything designed or sold for incorporation into a 262 | dwelling. In determining whether a product is a consumer product, doubtful cases 263 | shall be resolved in favor of coverage. For a particular product received by a 264 | particular user, “normally used” refers to a typical or common use of 265 | that class of product, regardless of the status of the particular user or of the way 266 | in which the particular user actually uses, or expects or is expected to use, the 267 | product. A product is a consumer product regardless of whether the product has 268 | substantial commercial, industrial or non-consumer uses, unless such uses represent 269 | the only significant mode of use of the product. 270 | 271 | “Installation Information” for a User Product means any methods, 272 | procedures, authorization keys, or other information required to install and execute 273 | modified versions of a covered work in that User Product from a modified version of 274 | its Corresponding Source. The information must suffice to ensure that the continued 275 | functioning of the modified object code is in no case prevented or interfered with 276 | solely because modification has been made. 277 | 278 | If you convey an object code work under this section in, or with, or specifically for 279 | use in, a User Product, and the conveying occurs as part of a transaction in which 280 | the right of possession and use of the User Product is transferred to the recipient 281 | in perpetuity or for a fixed term (regardless of how the transaction is 282 | characterized), the Corresponding Source conveyed under this section must be 283 | accompanied by the Installation Information. But this requirement does not apply if 284 | neither you nor any third party retains the ability to install modified object code 285 | on the User Product (for example, the work has been installed in ROM). 286 | 287 | The requirement to provide Installation Information does not include a requirement to 288 | continue to provide support service, warranty, or updates for a work that has been 289 | modified or installed by the recipient, or for the User Product in which it has been 290 | modified or installed. Access to a network may be denied when the modification itself 291 | materially and adversely affects the operation of the network or violates the rules 292 | and protocols for communication across the network. 293 | 294 | Corresponding Source conveyed, and Installation Information provided, in accord with 295 | this section must be in a format that is publicly documented (and with an 296 | implementation available to the public in source code form), and must require no 297 | special password or key for unpacking, reading or copying. 298 | 299 | ### 7. Additional Terms 300 | 301 | “Additional permissions” are terms that supplement the terms of this 302 | License by making exceptions from one or more of its conditions. Additional 303 | permissions that are applicable to the entire Program shall be treated as though they 304 | were included in this License, to the extent that they are valid under applicable 305 | law. If additional permissions apply only to part of the Program, that part may be 306 | used separately under those permissions, but the entire Program remains governed by 307 | this License without regard to the additional permissions. 308 | 309 | When you convey a copy of a covered work, you may at your option remove any 310 | additional permissions from that copy, or from any part of it. (Additional 311 | permissions may be written to require their own removal in certain cases when you 312 | modify the work.) You may place additional permissions on material, added by you to a 313 | covered work, for which you have or can give appropriate copyright permission. 314 | 315 | Notwithstanding any other provision of this License, for material you add to a 316 | covered work, you may (if authorized by the copyright holders of that material) 317 | supplement the terms of this License with terms: 318 | 319 | * **a)** Disclaiming warranty or limiting liability differently from the terms of 320 | sections 15 and 16 of this License; or 321 | * **b)** Requiring preservation of specified reasonable legal notices or author 322 | attributions in that material or in the Appropriate Legal Notices displayed by works 323 | containing it; or 324 | * **c)** Prohibiting misrepresentation of the origin of that material, or requiring that 325 | modified versions of such material be marked in reasonable ways as different from the 326 | original version; or 327 | * **d)** Limiting the use for publicity purposes of names of licensors or authors of the 328 | material; or 329 | * **e)** Declining to grant rights under trademark law for use of some trade names, 330 | trademarks, or service marks; or 331 | * **f)** Requiring indemnification of licensors and authors of that material by anyone 332 | who conveys the material (or modified versions of it) with contractual assumptions of 333 | liability to the recipient, for any liability that these contractual assumptions 334 | directly impose on those licensors and authors. 335 | 336 | All other non-permissive additional terms are considered “further 337 | restrictions” within the meaning of section 10. If the Program as you received 338 | it, or any part of it, contains a notice stating that it is governed by this License 339 | along with a term that is a further restriction, you may remove that term. If a 340 | license document contains a further restriction but permits relicensing or conveying 341 | under this License, you may add to a covered work material governed by the terms of 342 | that license document, provided that the further restriction does not survive such 343 | relicensing or conveying. 344 | 345 | If you add terms to a covered work in accord with this section, you must place, in 346 | the relevant source files, a statement of the additional terms that apply to those 347 | files, or a notice indicating where to find the applicable terms. 348 | 349 | Additional terms, permissive or non-permissive, may be stated in the form of a 350 | separately written license, or stated as exceptions; the above requirements apply 351 | either way. 352 | 353 | ### 8. Termination 354 | 355 | You may not propagate or modify a covered work except as expressly provided under 356 | this License. Any attempt otherwise to propagate or modify it is void, and will 357 | automatically terminate your rights under this License (including any patent licenses 358 | granted under the third paragraph of section 11). 359 | 360 | However, if you cease all violation of this License, then your license from a 361 | particular copyright holder is reinstated **(a)** provisionally, unless and until the 362 | copyright holder explicitly and finally terminates your license, and **(b)** permanently, 363 | if the copyright holder fails to notify you of the violation by some reasonable means 364 | prior to 60 days after the cessation. 365 | 366 | Moreover, your license from a particular copyright holder is reinstated permanently 367 | if the copyright holder notifies you of the violation by some reasonable means, this 368 | is the first time you have received notice of violation of this License (for any 369 | work) from that copyright holder, and you cure the violation prior to 30 days after 370 | your receipt of the notice. 371 | 372 | Termination of your rights under this section does not terminate the licenses of 373 | parties who have received copies or rights from you under this License. If your 374 | rights have been terminated and not permanently reinstated, you do not qualify to 375 | receive new licenses for the same material under section 10. 376 | 377 | ### 9. Acceptance Not Required for Having Copies 378 | 379 | You are not required to accept this License in order to receive or run a copy of the 380 | Program. Ancillary propagation of a covered work occurring solely as a consequence of 381 | using peer-to-peer transmission to receive a copy likewise does not require 382 | acceptance. However, nothing other than this License grants you permission to 383 | propagate or modify any covered work. These actions infringe copyright if you do not 384 | accept this License. Therefore, by modifying or propagating a covered work, you 385 | indicate your acceptance of this License to do so. 386 | 387 | ### 10. Automatic Licensing of Downstream Recipients 388 | 389 | Each time you convey a covered work, the recipient automatically receives a license 390 | from the original licensors, to run, modify and propagate that work, subject to this 391 | License. You are not responsible for enforcing compliance by third parties with this 392 | License. 393 | 394 | An “entity transaction” is a transaction transferring control of an 395 | organization, or substantially all assets of one, or subdividing an organization, or 396 | merging organizations. If propagation of a covered work results from an entity 397 | transaction, each party to that transaction who receives a copy of the work also 398 | receives whatever licenses to the work the party's predecessor in interest had or 399 | could give under the previous paragraph, plus a right to possession of the 400 | Corresponding Source of the work from the predecessor in interest, if the predecessor 401 | has it or can get it with reasonable efforts. 402 | 403 | You may not impose any further restrictions on the exercise of the rights granted or 404 | affirmed under this License. For example, you may not impose a license fee, royalty, 405 | or other charge for exercise of rights granted under this License, and you may not 406 | initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging 407 | that any patent claim is infringed by making, using, selling, offering for sale, or 408 | importing the Program or any portion of it. 409 | 410 | ### 11. Patents 411 | 412 | A “contributor” is a copyright holder who authorizes use under this 413 | License of the Program or a work on which the Program is based. The work thus 414 | licensed is called the contributor's “contributor version”. 415 | 416 | A contributor's “essential patent claims” are all patent claims owned or 417 | controlled by the contributor, whether already acquired or hereafter acquired, that 418 | would be infringed by some manner, permitted by this License, of making, using, or 419 | selling its contributor version, but do not include claims that would be infringed 420 | only as a consequence of further modification of the contributor version. For 421 | purposes of this definition, “control” includes the right to grant patent 422 | sublicenses in a manner consistent with the requirements of this License. 423 | 424 | Each contributor grants you a non-exclusive, worldwide, royalty-free patent license 425 | under the contributor's essential patent claims, to make, use, sell, offer for sale, 426 | import and otherwise run, modify and propagate the contents of its contributor 427 | version. 428 | 429 | In the following three paragraphs, a “patent license” is any express 430 | agreement or commitment, however denominated, not to enforce a patent (such as an 431 | express permission to practice a patent or covenant not to sue for patent 432 | infringement). To “grant” such a patent license to a party means to make 433 | such an agreement or commitment not to enforce a patent against the party. 434 | 435 | If you convey a covered work, knowingly relying on a patent license, and the 436 | Corresponding Source of the work is not available for anyone to copy, free of charge 437 | and under the terms of this License, through a publicly available network server or 438 | other readily accessible means, then you must either **(1)** cause the Corresponding 439 | Source to be so available, or **(2)** arrange to deprive yourself of the benefit of the 440 | patent license for this particular work, or **(3)** arrange, in a manner consistent with 441 | the requirements of this License, to extend the patent license to downstream 442 | recipients. “Knowingly relying” means you have actual knowledge that, but 443 | for the patent license, your conveying the covered work in a country, or your 444 | recipient's use of the covered work in a country, would infringe one or more 445 | identifiable patents in that country that you have reason to believe are valid. 446 | 447 | If, pursuant to or in connection with a single transaction or arrangement, you 448 | convey, or propagate by procuring conveyance of, a covered work, and grant a patent 449 | license to some of the parties receiving the covered work authorizing them to use, 450 | propagate, modify or convey a specific copy of the covered work, then the patent 451 | license you grant is automatically extended to all recipients of the covered work and 452 | works based on it. 453 | 454 | A patent license is “discriminatory” if it does not include within the 455 | scope of its coverage, prohibits the exercise of, or is conditioned on the 456 | non-exercise of one or more of the rights that are specifically granted under this 457 | License. You may not convey a covered work if you are a party to an arrangement with 458 | a third party that is in the business of distributing software, under which you make 459 | payment to the third party based on the extent of your activity of conveying the 460 | work, and under which the third party grants, to any of the parties who would receive 461 | the covered work from you, a discriminatory patent license **(a)** in connection with 462 | copies of the covered work conveyed by you (or copies made from those copies), or **(b)** 463 | primarily for and in connection with specific products or compilations that contain 464 | the covered work, unless you entered into that arrangement, or that patent license 465 | was granted, prior to 28 March 2007. 466 | 467 | Nothing in this License shall be construed as excluding or limiting any implied 468 | license or other defenses to infringement that may otherwise be available to you 469 | under applicable patent law. 470 | 471 | ### 12. No Surrender of Others' Freedom 472 | 473 | If conditions are imposed on you (whether by court order, agreement or otherwise) 474 | that contradict the conditions of this License, they do not excuse you from the 475 | conditions of this License. If you cannot convey a covered work so as to satisfy 476 | simultaneously your obligations under this License and any other pertinent 477 | obligations, then as a consequence you may not convey it at all. For example, if you 478 | agree to terms that obligate you to collect a royalty for further conveying from 479 | those to whom you convey the Program, the only way you could satisfy both those terms 480 | and this License would be to refrain entirely from conveying the Program. 481 | 482 | ### 13. Use with the GNU Affero General Public License 483 | 484 | Notwithstanding any other provision of this License, you have permission to link or 485 | combine any covered work with a work licensed under version 3 of the GNU Affero 486 | General Public License into a single combined work, and to convey the resulting work. 487 | The terms of this License will continue to apply to the part which is the covered 488 | work, but the special requirements of the GNU Affero General Public License, section 489 | 13, concerning interaction through a network will apply to the combination as such. 490 | 491 | ### 14. Revised Versions of this License 492 | 493 | The Free Software Foundation may publish revised and/or new versions of the GNU 494 | General Public License from time to time. Such new versions will be similar in spirit 495 | to the present version, but may differ in detail to address new problems or concerns. 496 | 497 | Each version is given a distinguishing version number. If the Program specifies that 498 | a certain numbered version of the GNU General Public License “or any later 499 | version” applies to it, you have the option of following the terms and 500 | conditions either of that numbered version or of any later version published by the 501 | Free Software Foundation. If the Program does not specify a version number of the GNU 502 | General Public License, you may choose any version ever published by the Free 503 | Software Foundation. 504 | 505 | If the Program specifies that a proxy can decide which future versions of the GNU 506 | General Public License can be used, that proxy's public statement of acceptance of a 507 | version permanently authorizes you to choose that version for the Program. 508 | 509 | Later license versions may give you additional or different permissions. However, no 510 | additional obligations are imposed on any author or copyright holder as a result of 511 | your choosing to follow a later version. 512 | 513 | ### 15. Disclaimer of Warranty 514 | 515 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 516 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 517 | PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER 518 | EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 519 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE 520 | QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE 521 | DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 522 | 523 | ### 16. Limitation of Liability 524 | 525 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY 526 | COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS 527 | PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, 528 | INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 529 | PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE 530 | OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE 531 | WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 532 | POSSIBILITY OF SUCH DAMAGES. 533 | 534 | ### 17. Interpretation of Sections 15 and 16 535 | 536 | If the disclaimer of warranty and limitation of liability provided above cannot be 537 | given local legal effect according to their terms, reviewing courts shall apply local 538 | law that most closely approximates an absolute waiver of all civil liability in 539 | connection with the Program, unless a warranty or assumption of liability accompanies 540 | a copy of the Program in return for a fee. 541 | 542 | _END OF TERMS AND CONDITIONS_ 543 | 544 | ## How to Apply These Terms to Your New Programs 545 | 546 | If you develop a new program, and you want it to be of the greatest possible use to 547 | the public, the best way to achieve this is to make it free software which everyone 548 | can redistribute and change under these terms. 549 | 550 | To do so, attach the following notices to the program. It is safest to attach them 551 | to the start of each source file to most effectively state the exclusion of warranty; 552 | and each file should have at least the “copyright” line and a pointer to 553 | where the full notice is found. 554 | 555 | 556 | Copyright (C) 557 | 558 | This program is free software: you can redistribute it and/or modify 559 | it under the terms of the GNU General Public License as published by 560 | the Free Software Foundation, either version 3 of the License, or 561 | (at your option) any later version. 562 | 563 | This program is distributed in the hope that it will be useful, 564 | but WITHOUT ANY WARRANTY; without even the implied warranty of 565 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 566 | GNU General Public License for more details. 567 | 568 | You should have received a copy of the GNU General Public License 569 | along with this program. If not, see . 570 | 571 | Also add information on how to contact you by electronic and paper mail. 572 | 573 | If the program does terminal interaction, make it output a short notice like this 574 | when it starts in an interactive mode: 575 | 576 | Copyright (C) 577 | This program comes with ABSOLUTELY NO WARRANTY; for details type 'show w'. 578 | This is free software, and you are welcome to redistribute it 579 | under certain conditions; type 'show c' for details. 580 | 581 | The hypothetical commands `show w` and `show c` should show the appropriate parts of 582 | the General Public License. Of course, your program's commands might be different; 583 | for a GUI interface, you would use an “about box”. 584 | 585 | You should also get your employer (if you work as a programmer) or school, if any, to 586 | sign a “copyright disclaimer” for the program, if necessary. For more 587 | information on this, and how to apply and follow the GNU GPL, see 588 | <>. 589 | 590 | The GNU General Public License does not permit incorporating your program into 591 | proprietary programs. If your program is a subroutine library, you may consider it 592 | more useful to permit linking proprietary applications with the library. If this is 593 | what you want to do, use the GNU Lesser General Public License instead of this 594 | License. But first, please read 595 | <>. 596 | -------------------------------------------------------------------------------- /LGPLv3.md: -------------------------------------------------------------------------------- 1 | GNU Lesser General Public License 2 | ================================= 3 | 4 | _Version 3, 29 June 2007_ 5 | _Copyright © 2007 Free Software Foundation, Inc. <>_ 6 | 7 | Everyone is permitted to copy and distribute verbatim copies 8 | of this license document, but changing it is not allowed. 9 | 10 | 11 | This version of the GNU Lesser General Public License incorporates 12 | the terms and conditions of version 3 of the GNU General Public 13 | License, supplemented by the additional permissions listed below. 14 | 15 | ### 0. Additional Definitions 16 | 17 | As used herein, “this License” refers to version 3 of the GNU Lesser 18 | General Public License, and the “GNU GPL” refers to version 3 of the GNU 19 | General Public License. 20 | 21 | “The Library” refers to a covered work governed by this License, 22 | other than an Application or a Combined Work as defined below. 23 | 24 | An “Application” is any work that makes use of an interface provided 25 | by the Library, but which is not otherwise based on the Library. 26 | Defining a subclass of a class defined by the Library is deemed a mode 27 | of using an interface provided by the Library. 28 | 29 | A “Combined Work” is a work produced by combining or linking an 30 | Application with the Library. The particular version of the Library 31 | with which the Combined Work was made is also called the “Linked 32 | Version”. 33 | 34 | The “Minimal Corresponding Source” for a Combined Work means the 35 | Corresponding Source for the Combined Work, excluding any source code 36 | for portions of the Combined Work that, considered in isolation, are 37 | based on the Application, and not on the Linked Version. 38 | 39 | The “Corresponding Application Code” for a Combined Work means the 40 | object code and/or source code for the Application, including any data 41 | and utility programs needed for reproducing the Combined Work from the 42 | Application, but excluding the System Libraries of the Combined Work. 43 | 44 | ### 1. Exception to Section 3 of the GNU GPL 45 | 46 | You may convey a covered work under sections 3 and 4 of this License 47 | without being bound by section 3 of the GNU GPL. 48 | 49 | ### 2. Conveying Modified Versions 50 | 51 | If you modify a copy of the Library, and, in your modifications, a 52 | facility refers to a function or data to be supplied by an Application 53 | that uses the facility (other than as an argument passed when the 54 | facility is invoked), then you may convey a copy of the modified 55 | version: 56 | 57 | * **a)** under this License, provided that you make a good faith effort to 58 | ensure that, in the event an Application does not supply the 59 | function or data, the facility still operates, and performs 60 | whatever part of its purpose remains meaningful, or 61 | 62 | * **b)** under the GNU GPL, with none of the additional permissions of 63 | this License applicable to that copy. 64 | 65 | ### 3. Object Code Incorporating Material from Library Header Files 66 | 67 | The object code form of an Application may incorporate material from 68 | a header file that is part of the Library. You may convey such object 69 | code under terms of your choice, provided that, if the incorporated 70 | material is not limited to numerical parameters, data structure 71 | layouts and accessors, or small macros, inline functions and templates 72 | (ten or fewer lines in length), you do both of the following: 73 | 74 | * **a)** Give prominent notice with each copy of the object code that the 75 | Library is used in it and that the Library and its use are 76 | covered by this License. 77 | * **b)** Accompany the object code with a copy of the GNU GPL and this license 78 | document. 79 | 80 | ### 4. Combined Works 81 | 82 | You may convey a Combined Work under terms of your choice that, 83 | taken together, effectively do not restrict modification of the 84 | portions of the Library contained in the Combined Work and reverse 85 | engineering for debugging such modifications, if you also do each of 86 | the following: 87 | 88 | * **a)** Give prominent notice with each copy of the Combined Work that 89 | the Library is used in it and that the Library and its use are 90 | covered by this License. 91 | 92 | * **b)** Accompany the Combined Work with a copy of the GNU GPL and this license 93 | document. 94 | 95 | * **c)** For a Combined Work that displays copyright notices during 96 | execution, include the copyright notice for the Library among 97 | these notices, as well as a reference directing the user to the 98 | copies of the GNU GPL and this license document. 99 | 100 | * **d)** Do one of the following: 101 | - **0)** Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | - **1)** Use a suitable shared library mechanism for linking with the 109 | Library. A suitable mechanism is one that **(a)** uses at run time 110 | a copy of the Library already present on the user's computer 111 | system, and **(b)** will operate properly with a modified version 112 | of the Library that is interface-compatible with the Linked 113 | Version. 114 | 115 | * **e)** Provide Installation Information, but only if you would otherwise 116 | be required to provide such information under section 6 of the 117 | GNU GPL, and only to the extent that such information is 118 | necessary to install and execute a modified version of the 119 | Combined Work produced by recombining or relinking the 120 | Application with a modified version of the Linked Version. (If 121 | you use option **4d0**, the Installation Information must accompany 122 | the Minimal Corresponding Source and Corresponding Application 123 | Code. If you use option **4d1**, you must provide the Installation 124 | Information in the manner specified by section 6 of the GNU GPL 125 | for conveying Corresponding Source.) 126 | 127 | ### 5. Combined Libraries 128 | 129 | You may place library facilities that are a work based on the 130 | Library side by side in a single library together with other library 131 | facilities that are not Applications and are not covered by this 132 | License, and convey such a combined library under terms of your 133 | choice, if you do both of the following: 134 | 135 | * **a)** Accompany the combined library with a copy of the same work based 136 | on the Library, uncombined with any other library facilities, 137 | conveyed under the terms of this License. 138 | * **b)** Give prominent notice with the combined library that part of it 139 | is a work based on the Library, and explaining where to find the 140 | accompanying uncombined form of the same work. 141 | 142 | ### 6. Revised Versions of the GNU Lesser General Public License 143 | 144 | The Free Software Foundation may publish revised and/or new versions 145 | of the GNU Lesser General Public License from time to time. Such new 146 | versions will be similar in spirit to the present version, but may 147 | differ in detail to address new problems or concerns. 148 | 149 | Each version is given a distinguishing version number. If the 150 | Library as you received it specifies that a certain numbered version 151 | of the GNU Lesser General Public License “or any later version” 152 | applies to it, you have the option of following the terms and 153 | conditions either of that published version or of any later version 154 | published by the Free Software Foundation. If the Library as you 155 | received it does not specify a version number of the GNU Lesser 156 | General Public License, you may choose any version of the GNU Lesser 157 | General Public License ever published by the Free Software Foundation. 158 | 159 | If the Library as you received it specifies that a proxy can decide 160 | whether future versions of the GNU Lesser General Public License shall 161 | apply, that proxy's public statement of acceptance of any version is 162 | permanent authorization for you to choose that version for the 163 | Library. 164 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Pirate [![Build Status](https://travis-ci.org/zcdziura/pirate.svg?branch=master)](https://travis-ci.org/zcdziura/pirate) 2 | ====== 3 | 4 | A command-line arrrrguments parser, written in Rust. 5 | 6 | Synopsis 7 | -------- 8 | 9 | Most programs that provide a command-line interface use a special-purpose library to make the process easier, such as the GNU Project's `getopt` library. The Rust team provides their own alternative, `getopts`, which deserves an award for the Most Originally Named Project Ever. 10 | 11 | In all seriousness, `getopts` is a fantastic library that gives the developers all of the power necessary to create and interface with command-line arguments. However, with all that power comes complexity. `getopts` -- while straight forward to use -- is verbose. The developer has to call different functions repeatedly in order to add different command-line options to their programs. While the only victim here is the developer's wrists due to carpal tunnel, I felt that there was a better way to do things. 12 | 13 | Enter Pirate (which should totally usurp `getopts` for the award of Most Originally Named Project Ever). 14 | 15 | Installation 16 | ------------ 17 | 18 | Add this to your project's `Cargo.toml` file: 19 | 20 | ``` 21 | [dependencies] 22 | pirate = "1.0.0" 23 | ``` 24 | 25 | and this to your crate root: 26 | 27 | ```rust 28 | extern crate pirate; 29 | ``` 30 | 31 | Usage 32 | ----- 33 | 34 | Using Pirate is simple. First, create a vector defining all of the valid options that your program accepts: 35 | 36 | ```rust 37 | let options = vec![ 38 | "a/addend#The right side of the addition equation; default=1:", 39 | "#Required Arguments", 40 | ":/augend#The left side of an addition equation" 41 | ]; 42 | ``` 43 | 44 | Options are defined in a very specific format: 45 | 46 | * Options that have an associated argument must be followed by a colon (:). The colon must be the last character of the option (see above for example). 47 | * Long-form options are denoted by a preceding slash (/). Options are able to have short- and long-forms. Options which are only long-form still need a preceding slash, e.g. `"/addend"`. 48 | * Required program arguments must have a preceding colon as the first character of the opt, e.g. `":/augend"`. 49 | * Option descriptions are denoted by a proceding hash (#). Descriptions are optional and are used to display helpful information about the option when displaying a program's usage information (typically when the `--help` flag is passed). Options with **only** a description (i.e. no short- or long-form name) are called "Groups", and are used to group options together when displaying usage. 50 | 51 | Next, create a `Vars` struct, which is responsible for keeping track of all of the options, along with the program's name, defined for the program: 52 | 53 | ```rust 54 | let vars: Vars = match pirate::vars("program-name", &options) { 55 | Ok(v) => v, 56 | Err(why) => panic!("Error: {}", why) 57 | } 58 | ``` 59 | 60 | Next, call the `pirate::matches()` function, passing in a vector of the program's environment arguments, along with a mutable reference to the `Vars` struct that you previously defined: 61 | 62 | ```rust 63 | let args: Vec = env::args().collect(); 64 | let matches: Matches = match pirate::matches(&args, &mut vars) { 65 | Ok(m) => m, 66 | Err(why) => { 67 | println!("Error: {}", why); 68 | pirate::usage(&vars); 69 | return; 70 | } 71 | } 72 | ``` 73 | `Matches` is nothing more than a type alias to a `HashMap`. All of the custom methods that make the type easier to use are defined by the `Match` trait. 74 | 75 | And finally, check which arguments were passed to the program. 76 | 77 | ``` 78 | // Returns a reference to the given arg, or None if not found 79 | fn get(arg: &str) -> Option<&String>; 80 | 81 | // Returns true if the match exists, false if not 82 | fn has_match(arg: &str) -> bool; 83 | 84 | // An iterator over all matches found 85 | fn keys() -> Keys; 86 | ``` 87 | 88 | Something to remember when using the `get()` function: by default, the `pirate::matches()` function stores the opt's long-form name as the key, by default, should the long-form exist; otherwise the short-form is used. So, should you define an opt with both a short- and long-form name, when querying for it, pass the long-form as the argument. For example: 89 | 90 | ```rust 91 | let options = vec!["l/long#An example opt"]; 92 | let vars = pirate::vars("program-name", &options); 93 | let args: Vec = env::args().collect(); 94 | let matches = pirate::matches(&args, &mut vars).unwrap(); 95 | 96 | let short = matches.get("l").unwrap(); // Error! This won't work! 97 | let long = matches.get("long").unwrap(); // Success! 98 | 99 | // Usage: program-name -l 100 | ``` 101 | 102 | As shown in a previous example, should you ever want to display the program's usage data, simply call the `pirate::usage()` function, passing in a reverence to your `Vars` struct as an argument. E.g. `pirate::usage(&vars)` 103 | 104 | Example 105 | ------- 106 | 107 | Here is a trivial example that gives a general idea about how to use `pirate`: 108 | 109 | ```rust 110 | extern crate pirate; 111 | 112 | use pirate::{Matches, Match, matches, usage, vars}; 113 | 114 | fn main() { 115 | let env_args: Vec = vec![ 116 | String::from("test"), 117 | String::from("-a"), String::from("2"), 118 | String::from("3") 119 | ]; 120 | let options = vec![ 121 | "a/addend#The right side of the addition equation; default=1:", 122 | "#Required Arguments", 123 | ":/augend#The left side of an addition equation" 124 | ]; 125 | let mut vars = vars("test", &options).unwrap(); 126 | 127 | let matches: Matches = match matches(&env_args, &mut vars) { 128 | Ok(m) => m, 129 | Err(why) => { 130 | println!("Error: {}", why); 131 | usage(&vars); 132 | return; 133 | } 134 | }; 135 | 136 | if matches.has_match("help") { 137 | usage(&vars); 138 | return; 139 | } 140 | 141 | let augend: i32 = matches.get("augend") 142 | .unwrap() 143 | .parse::() 144 | .unwrap(); 145 | 146 | let addend: i32 = match matches.get("addend") { 147 | Some(a) => a.parse::().unwrap(), 148 | None => 1 149 | }; 150 | 151 | let sum = augend + addend; 152 | 153 | println!("{} + {} = {}", augend, addend, sum); 154 | } 155 | ``` 156 | 157 | License 158 | ------- 159 | 160 | Pirate is licensed under the [GNU Lesser General Public License, v3](https://www.gnu.org/licenses/lgpl.html). 161 | -------------------------------------------------------------------------------- /src/errors.rs: -------------------------------------------------------------------------------- 1 | /* Pirate - A command-line arrrrguments parser, written in Rust. 2 | * Copyright (C) 2015 Zachary Dziura 3 | * 4 | * This program is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * This program is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with this program. If not, see . 16 | */ 17 | 18 | use std::error; 19 | use std::fmt::{Display, Formatter, Result}; 20 | 21 | #[derive(Debug)] 22 | pub struct Error { 23 | kind: ErrorKind, 24 | offender: String, 25 | desc: String 26 | } 27 | 28 | impl Error { 29 | pub fn new(kind: ErrorKind, offender: String) -> Error { 30 | Error { 31 | kind: kind.clone(), 32 | offender: offender.clone(), 33 | desc: format!("{} {}", kind.description(), offender.clone()), 34 | } 35 | } 36 | } 37 | 38 | impl error::Error for Error { 39 | fn description(&self) -> &str { 40 | &self.desc 41 | } 42 | } 43 | 44 | impl Display for Error { 45 | fn fmt(&self, f: &mut Formatter) -> Result { 46 | write!(f, "{}", self.desc) 47 | } 48 | } 49 | 50 | #[derive(Clone, Debug)] 51 | pub enum ErrorKind { 52 | InvalidArgument, 53 | MissingArgument, 54 | TokenFormat 55 | } 56 | 57 | impl ErrorKind { 58 | fn description(&self) -> String { 59 | match *self { 60 | ErrorKind::InvalidArgument => String::from("An invalid option was passed to the program:"), 61 | ErrorKind::MissingArgument => String::from("A required argument is missing:"), 62 | ErrorKind::TokenFormat => String::from("A token was created in the wrong format:") 63 | } 64 | } 65 | } 66 | 67 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | /* Pirate - A command-line arrrrguments parser, written in Rust. 2 | * Copyright (C) 2015 Zachary Dziura 3 | * 4 | * This program is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * This program is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with this program. If not, see . 16 | */ 17 | 18 | mod errors; 19 | mod matches; 20 | mod token; 21 | mod usage; 22 | mod vars; 23 | 24 | pub use matches::{Matches, Match, matches}; 25 | pub use vars::{Vars, vars}; 26 | pub use usage::usage; -------------------------------------------------------------------------------- /src/matches.rs: -------------------------------------------------------------------------------- 1 | /* Pirate - A command-line arrrrguments parser, written in Rust. 2 | * Copyright (C) 2015 Zachary Dziura 3 | * 4 | * This program is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * This program is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with this program. If not, see . 16 | */ 17 | 18 | use std::collections::HashMap; 19 | use std::collections::hash_map::Keys; 20 | 21 | use errors::{Error, ErrorKind}; 22 | use vars::Vars; 23 | 24 | pub type Matches = HashMap; 25 | 26 | pub fn matches(env_args: &[String], vars: &mut Vars) -> Result { 27 | let mut matches: Matches = HashMap::new(); 28 | let mut args = env_args.iter(); 29 | 30 | args.next(); // Remove the program name 31 | 32 | while let Some(mut current_arg) = args.next() { 33 | let mut arg_vec: Vec = Vec::new(); 34 | 35 | // Determine if current opt is in short, long, or arg form 36 | if ¤t_arg[..1] == "-" { 37 | if ¤t_arg[..2] == "--" { // Long form opt 38 | arg_vec.push(String::from(¤t_arg[2..])); 39 | } else { // Short form opt 40 | // Assuming it's a group of short-form vars; e.g. tar -xzf 41 | for c in current_arg[1..].chars() { 42 | let mut s = String::new(); 43 | s.push(c); 44 | arg_vec.push(s); 45 | } 46 | } 47 | 48 | for arg in arg_vec.iter() { 49 | if vars.contains_opt(arg) { 50 | let token = vars.get_opt(arg).unwrap(); 51 | 52 | if token.has_arg { 53 | // NOTE: The corresponding arg MUST be immediately following 54 | current_arg = match args.next() { 55 | None => return Err(Error::new(ErrorKind::MissingArgument, arg.clone())), 56 | Some(a) => a 57 | }; 58 | 59 | matches.insert(token.name(), (*current_arg).clone()); 60 | } else { 61 | matches.insert(token.name(), String::new()); 62 | } 63 | } else { 64 | return Err(Error::new(ErrorKind::InvalidArgument, arg.clone())); 65 | } 66 | } 67 | } else { // Probably a required arg 68 | let arg = vars.get_arg().unwrap(); 69 | matches.insert(arg.name(), (*current_arg).clone()); 70 | } 71 | } 72 | 73 | match vars.arg_len() { 74 | 0 => Ok( matches ), 75 | _ => Err(Error::new(ErrorKind::MissingArgument, vars.get_arg().unwrap().name())), 76 | } 77 | } 78 | 79 | pub trait Match { 80 | fn get(&self, arg: &str) -> Option<&String>; 81 | 82 | fn has_match(&self, arg: &str) -> bool; 83 | 84 | fn matches(&self) -> Keys; 85 | } 86 | 87 | impl Match for Matches { 88 | fn get(&self, arg: &str) -> Option<&String> { 89 | self.get(arg) 90 | } 91 | 92 | fn has_match(&self, arg: &str) -> bool { 93 | let arg = String::from(arg); 94 | self.contains_key(&arg) 95 | } 96 | 97 | fn matches(&self) -> Keys { 98 | self.keys() 99 | } 100 | } 101 | 102 | #[cfg(test)] 103 | mod tests { 104 | use super::{Match, matches}; 105 | use super::super::vars::vars; 106 | 107 | #[test] 108 | fn test_matches_good() { 109 | let env_args = vec![String::from("test"), String::from("-a"), String::from("Test")]; 110 | let opts = vec!["o/opt#An option", "a#An argument:"]; 111 | 112 | let mut var = match vars("Test", &opts) { 113 | Ok(m) => m, 114 | Err(why) => panic!("An error occurred: {}", why) 115 | }; 116 | 117 | let matches = matches(&env_args, &mut var).unwrap(); 118 | 119 | let has_opt = match matches.get("opt") { 120 | Some(_) => true, 121 | None => false 122 | }; 123 | let argument = matches.get("a").unwrap(); 124 | assert_eq!(*argument, String::from("Test")); 125 | assert_eq!(has_opt, false); 126 | } 127 | 128 | #[test] 129 | #[should_panic] 130 | fn test_matches_bad() { 131 | let env_args = vec![String::from("test"), String::from("-a")]; 132 | let opts = vec!["o/opt#An option", "a#An argument:"]; 133 | 134 | let mut vars = vars("Test", &opts).unwrap(); 135 | match matches(&env_args, &mut vars) { 136 | Ok(m) => m, 137 | Err(why) => panic!("An error occurred: {}", why) 138 | }; 139 | } 140 | } 141 | -------------------------------------------------------------------------------- /src/token.rs: -------------------------------------------------------------------------------- 1 | /* Pirate - A command-line arrrrguments parser, written in Rust. 2 | * Copyright (C) 2015 Zachary Dziura 3 | * 4 | * This program is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * This program is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with this program. If not, see . 16 | */ 17 | 18 | use std::fmt::{self, Display, Formatter}; 19 | 20 | use errors::{Error, ErrorKind}; 21 | 22 | #[derive(Clone, Debug, PartialEq)] 23 | pub struct Token { 24 | pub short_name: String, 25 | pub long_name: String, 26 | pub description: String, 27 | pub is_arg: bool, 28 | pub has_arg: bool, 29 | pub is_group: bool, 30 | pub padding: usize 31 | } 32 | 33 | pub fn token(input: &str) -> Result { 34 | let mut short_name = String::new(); 35 | let mut long_name = String::new(); 36 | let mut description = String::new(); 37 | let last_char = input.len() - 1; 38 | 39 | let is_arg = match &input[..1] { 40 | ":" => true, 41 | _ => false 42 | }; 43 | 44 | let has_arg = match &input[last_char..] { 45 | ":" => true, 46 | _ => false 47 | }; 48 | 49 | if is_arg && has_arg { 50 | return Err(Error::new(ErrorKind::TokenFormat, String::from(input))); 51 | } 52 | 53 | let option = if is_arg { 54 | &input[1..] 55 | } else if has_arg { 56 | &input[..last_char] 57 | } else { 58 | input 59 | }; 60 | 61 | let mut current_stage = AnalysisStage::ShortName; 62 | for c in option.chars() { 63 | match c { 64 | '/' => current_stage = AnalysisStage::LongName, 65 | '#' => current_stage = AnalysisStage::Description, 66 | _ => { 67 | match current_stage { 68 | AnalysisStage::ShortName => short_name.push(c), 69 | AnalysisStage::LongName => long_name.push(c), 70 | AnalysisStage::Description => description.push(c) 71 | } 72 | } 73 | } 74 | } 75 | 76 | let is_group = if short_name.is_empty() && long_name.is_empty() { 77 | true 78 | } else { 79 | false 80 | }; 81 | 82 | Ok(Token { 83 | short_name: short_name, 84 | long_name: long_name, 85 | is_arg: is_arg, 86 | has_arg: has_arg, 87 | is_group: is_group, 88 | description: description, 89 | padding: 0 90 | }) 91 | } 92 | 93 | impl Token { 94 | pub fn adjust_padding(&mut self, padding: usize) { 95 | self.padding = padding; 96 | } 97 | 98 | pub fn len(&self) -> usize { 99 | let short_name_empty = self.short_name.is_empty(); 100 | let long_name_empty = self.long_name.is_empty(); 101 | 102 | let repr = if !short_name_empty && !long_name_empty { 103 | format!("-{}, --{}", self.short_name, self.long_name) 104 | } else if !short_name_empty && long_name_empty { 105 | format!("-{}", self.short_name) 106 | } else if short_name_empty && !long_name_empty { 107 | format!("--{}", self.long_name) 108 | } else { 109 | String::new() 110 | }; 111 | 112 | repr.len() 113 | } 114 | 115 | pub fn name(&self) -> String { 116 | if !self.long_name.is_empty() { 117 | self.long_name.clone() 118 | } else if !self.short_name.is_empty() { 119 | self.short_name.clone() 120 | } else { 121 | self.description.clone() 122 | } 123 | } 124 | 125 | pub fn usage(&self) -> Option { 126 | let mut repr = String::new(); 127 | 128 | if !self.is_group { 129 | if !self.is_arg { 130 | repr.push('['); 131 | 132 | if !self.short_name.is_empty() { 133 | repr.push('-'); 134 | repr.push_str(&self.short_name); 135 | } 136 | 137 | if !self.long_name.is_empty() { 138 | repr.push_str("|--"); 139 | repr.push_str(&self.long_name); 140 | } 141 | 142 | if self.has_arg { 143 | let name = String::from(self.name()); 144 | repr.push(' '); 145 | repr.push_str(&name); 146 | } 147 | 148 | repr.push(']'); 149 | } else { 150 | let name = String::from(self.name()); 151 | repr.push_str(&name); 152 | } 153 | 154 | Some(repr) 155 | } else { 156 | None 157 | } 158 | } 159 | } 160 | 161 | impl Display for Token { 162 | fn fmt(&self, f: &mut Formatter) -> fmt::Result { 163 | let mut spacing = String::new(); 164 | for _ in 0..self.padding { 165 | spacing.push(' '); 166 | } 167 | 168 | let short_name_empty = self.short_name.is_empty(); 169 | let long_name_empty = self.long_name.is_empty(); 170 | 171 | let repr = if self.is_group { 172 | format!("\n{}:", self.description) 173 | } else if !short_name_empty && !long_name_empty { 174 | format!(" -{}, --{}{} {}", self.short_name, self.long_name, spacing, self.description) 175 | } else if short_name_empty && !long_name_empty { 176 | format!(" --{}{} {}", self.long_name, spacing, self.description) 177 | } else { 178 | format!(" -{}{} {}", self.short_name, spacing, self.description) 179 | }; 180 | 181 | write!(f, "{}", repr) 182 | } 183 | } 184 | 185 | enum AnalysisStage { 186 | ShortName, 187 | LongName, 188 | Description 189 | } 190 | 191 | #[cfg(test)] 192 | mod tests { 193 | use super::{Token, token}; 194 | 195 | #[test] 196 | fn test_new_token() { 197 | let opt = "h/help#Display the program usage"; 198 | let token = match token(opt) { 199 | Ok(t) => t, 200 | Err(why) => panic!("Received error: {}", why) 201 | }; 202 | let control_token = Token { 203 | short_name: String::from("h"), 204 | long_name: String::from("help"), 205 | description: String::from("Display the program usage"), 206 | is_arg: false, 207 | has_arg: false, 208 | is_group: false, 209 | padding: 0 210 | }; 211 | 212 | assert_eq!(token, control_token); 213 | } 214 | 215 | #[test] 216 | fn test_new_group() { 217 | let opt = "#This is a group"; 218 | let token = match token(opt) { 219 | Ok(t) => t, 220 | Err(why) => panic!("Received error: {}", why) 221 | }; 222 | let control_token = Token { 223 | short_name: String::new(), 224 | long_name: String::new(), 225 | description: String::from("This is a group"), 226 | is_arg: false, 227 | has_arg: false, 228 | is_group: true, 229 | padding: 0 230 | }; 231 | 232 | assert_eq!(token, control_token); 233 | } 234 | 235 | #[test] 236 | fn test_new_token_with_arg() { 237 | let opt = "o/option#An option with an argument:"; 238 | let token = match token(opt) { 239 | Ok(t) => t, 240 | Err(why) => panic!("Received error: {}", why) 241 | }; 242 | let control_token = Token { 243 | short_name: String::from("o"), 244 | long_name: String::from("option"), 245 | description: String::from("An option with an argument"), 246 | is_arg: false, 247 | has_arg: true, 248 | is_group: false, 249 | padding: 0 250 | }; 251 | 252 | assert_eq!(token, control_token); 253 | } 254 | 255 | #[test] 256 | fn test_new_token_as_arg() { 257 | let opt = ":a/arg#An argument"; 258 | let token = match token(opt) { 259 | Ok(t) => t, 260 | Err(why) => panic!("Received error: {}", why) 261 | }; 262 | let control_token = Token { 263 | short_name: String::from("a"), 264 | long_name: String::from("arg"), 265 | description: String::from("An argument"), 266 | is_arg: true, 267 | has_arg: false, 268 | is_group: false, 269 | padding: 0 270 | }; 271 | 272 | assert_eq!(token, control_token); 273 | } 274 | 275 | #[test] 276 | #[should_panic] 277 | fn test_invalid_token_format() { 278 | let input = ":w/wrong#Wrong format:"; 279 | match token(input) { 280 | Ok(t) => t, 281 | Err(why) => panic!("Received error: {}", why) 282 | }; 283 | } 284 | 285 | #[test] 286 | fn test_name() { 287 | let short_name = "o"; 288 | let long_name = "/out"; 289 | let group = "#Output"; 290 | 291 | let short_token = token(short_name).unwrap(); 292 | let long_token = token(long_name).unwrap(); 293 | let group_token = token(group).unwrap(); 294 | 295 | assert_eq!(short_token.name(), "o"); 296 | assert_eq!(long_token.name(), "out"); 297 | assert_eq!(group_token.name(), "Output"); 298 | } 299 | } 300 | -------------------------------------------------------------------------------- /src/usage.rs: -------------------------------------------------------------------------------- 1 | /* Pirate - A command-line arrrrguments parser, written in Rust. 2 | * Copyright (C) 2015 Zachary Dziura 3 | * 4 | * This program is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * This program is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with this program. If not, see . 16 | */ 17 | 18 | use vars::Vars; 19 | 20 | pub fn usage(vars: &Vars) { 21 | print!("Usage: {} ", vars.program_name); 22 | 23 | for token in vars.tokens() { 24 | if let Some(usage) = token.usage() { 25 | print!("{} ", usage); 26 | } 27 | } 28 | 29 | println!("\nOptions:"); 30 | for token in vars.tokens() { 31 | println!("{}", token); 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/vars.rs: -------------------------------------------------------------------------------- 1 | /* Pirate - A command-line arrrrguments parser, written in Rust. 2 | * Copyright (C) 2015 Zachary Dziura 3 | * 4 | * This program is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU General Public License as published by 6 | * the Free Software Foundation, either version 3 of the License, or 7 | * (at your option) any later version. 8 | * 9 | * This program is distributed in the hope that it will be useful, 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 | * GNU General Public License for more details. 13 | * 14 | * You should have received a copy of the GNU General Public License 15 | * along with this program. If not, see . 16 | */ 17 | 18 | use std::collections::{HashMap, VecDeque}; 19 | use std::slice::Iter; 20 | 21 | use errors::Error; 22 | use token::{Token, token}; 23 | 24 | pub struct Vars { 25 | tokens: Vec, 26 | opts: HashMap, 27 | args: VecDeque, 28 | pub program_name: String 29 | } 30 | 31 | pub fn vars(program_name: &str, options: &[&str]) -> Result { 32 | let mut tokens: Vec = Vec::new(); 33 | let mut opts: HashMap = HashMap::new(); 34 | let mut args: VecDeque = VecDeque::new(); 35 | let mut index: usize = 0; 36 | 37 | // The first option should be the help option, i.e. -h, --help 38 | let help_token = Token { 39 | short_name: String::from("h"), 40 | long_name: String::from("help"), 41 | description: String::from("Display usage information"), 42 | is_arg: false, 43 | has_arg: false, 44 | is_group: false, 45 | padding: 0 46 | }; 47 | opts.insert(help_token.short_name.clone(), index); 48 | opts.insert(help_token.long_name.clone(), index); 49 | let mut longest_token_len: usize = help_token.len(); 50 | tokens.push(help_token); 51 | index += 1; 52 | 53 | // Second, add the other, user defined options 54 | for opt in options.iter() { 55 | let token = match token(opt) { 56 | Ok(t) => t, 57 | Err(why) => return Err(why) 58 | }; 59 | 60 | if !token.is_group { 61 | if token.is_arg { 62 | args.push_back(index); 63 | } else { 64 | if !token.short_name.is_empty() { 65 | opts.insert(token.short_name.clone(), index); 66 | } 67 | 68 | if !token.long_name.is_empty() { 69 | opts.insert(token.long_name.clone(), index); 70 | } 71 | } 72 | 73 | if token.len() > longest_token_len { 74 | longest_token_len = token.len(); 75 | } 76 | } 77 | tokens.push(token); 78 | index += 1; 79 | } 80 | 81 | // Finally, adjust the padding for each token so they display properly 82 | for t in tokens.iter_mut() { 83 | let token_len = t.len(); 84 | if token_len < longest_token_len { 85 | let delta = longest_token_len - token_len; 86 | t.adjust_padding(delta); 87 | } 88 | } 89 | 90 | Ok(Vars { 91 | opts: opts, 92 | args: args, 93 | tokens: tokens, 94 | program_name: String::from(program_name) 95 | }) 96 | } 97 | 98 | impl Vars { 99 | pub fn get_opt(&self, opt_name: &str) -> Option<&Token> { 100 | if let Some(&index) = self.opts.get(opt_name) { 101 | self.tokens.get(index) 102 | } else { 103 | None 104 | } 105 | } 106 | 107 | pub fn contains_opt(&self, opt: &str) -> bool { 108 | self.opts.contains_key(opt) 109 | } 110 | 111 | pub fn get_arg(&mut self) -> Option<&Token> { 112 | if let Some(index) = self.args.pop_front() { 113 | self.tokens.get(index) 114 | } else { 115 | None 116 | } 117 | } 118 | 119 | pub fn arg_len(&self) -> usize { 120 | self.args.len() 121 | } 122 | 123 | pub fn tokens(&self) -> Iter{ 124 | self.tokens.iter() 125 | } 126 | } -------------------------------------------------------------------------------- /tests/main.rs: -------------------------------------------------------------------------------- 1 | extern crate pirate; 2 | 3 | use pirate::{Matches, Match, matches, usage, vars}; 4 | 5 | #[test] 6 | fn main() { 7 | let env_args: Vec = vec![String::from("test"), String::from("-a"), String::from("2"), 8 | String::from("3")]; 9 | let opts = vec!["a/addend#The right side of the addition equation; default=1:", "#Required Arguments", 10 | ":augend#The left side of an addition equation"]; 11 | let mut vars = vars("test", &opts).unwrap(); 12 | 13 | let matches: Matches = match matches(&env_args, &mut vars) { 14 | Ok(m) => m, 15 | Err(why) => { 16 | println!("Error: {}", why); 17 | usage(&vars); 18 | return; 19 | } 20 | }; 21 | 22 | if matches.has_match("help") { 23 | usage(&vars); 24 | return; 25 | } 26 | 27 | let augend: i32 = matches.get("augend").unwrap().parse::().unwrap(); 28 | 29 | let addend: i32 = match matches.get("addend") { 30 | Some(a) => a.parse::().unwrap(), 31 | None => 1 32 | }; 33 | 34 | let sum = augend + addend; 35 | 36 | assert_eq!(augend, 3); 37 | assert_eq!(addend, 2); 38 | assert_eq!(sum, 5); 39 | } 40 | --------------------------------------------------------------------------------