commit 426d4c3ecb781eefb0dee4c0530ca60877ac31bb Author: Soispha Date: Sat Dec 23 22:24:14 2023 +0100 chore: Initial commit The commits leading to this point are documented in the core trinitrix repository before the extraction of trinitry diff --git a/.envrc b/.envrc new file mode 100644 index 0000000..96eca6b --- /dev/null +++ b/.envrc @@ -0,0 +1,7 @@ +use flake || use nix +watch_file flake.nix + +if on_git_branch; then + echo && git status --short --branch && + echo && git fetch --verbose +fi diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ac4fcba --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +# build +/target +/result + +# direnv +.direnv + +# trinitry is a library +Cargo.lock diff --git a/.licensure.yml b/.licensure.yml new file mode 100644 index 0000000..c67c9b2 --- /dev/null +++ b/.licensure.yml @@ -0,0 +1,167 @@ +--- +# Regexes which if matched by a file path will always be excluded from +# getting a license header +excludes: + - \.gitignore + - .*lock + - \.git/.* + - \.licensure\.yml + - README.* + - LICENSE.spdx + - COPYING + - COPYING.LESSER + - .*\.(md|rst|txt|pdf) +# Definition of the licenses used on this project and to what files +# they should apply. +# +# No default license configuration is provided. This section must be +# configured by the user. +licenses: + # Either a regex or the string "any" to determine to what files this + # license should apply. It is common for projects to have files + # under multiple licenses or with multiple copyright holders. This + # provides the ability to automatically license files correctly + # based on their file paths. + # + # If "any" is provided all files will match this license. + - files: any + # + # The license identifier, a list of common identifiers can be + # found at: https://spdx.org/licenses/ but existence of the ident + # in this list it is not enforced unless auto_template is set to + # true. + ident: LGPL-3.0-or-later + # + # A list of authors who hold copyright over these files + authors: + # Provide either your full name or company name for copyright purposes + - name: The Trinitrix Project + # Optionally provide email for copyright purposes + email: "soispha@vhack.eu, antifallobst@systemausfall.org" + # + # The template that will be rendered to generate the header before + # comment characters are applied. Available variables are: + # - [year]: substituted with the current year. + # - [name of author]: Substituted with name of the author and email + # if provided. If email is provided the output appears as Full + # Name . If multiple authors are provided the + # list is concatenated together with commas. + template: | + Copyright (C) [year] [name of author] + + This file is part of the Trinitry crate for Trinitrix. + + Trinitry is free software: you can redistribute it and/or modify + it under the terms of the Lesser 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 + and the Lesser GNU General Public License along with this program. + If not, see . + # + # If auto_template is true then template is ignored and the SPDX + # API will be queried with the ident value to automatically + # determine the license header template. auto_template works best + # with licenses that have a standardLicenseHeader field defined in + # their license info JSON, if it is not then we will use the full + # licenseText to generate the header which works fine for short + # licenses like MIT but can be quite lengthy for other licenses + # like BSD-4-Clause. The above default template is valid for most + # licenses and is recommended for MIT, and BSD licenses. Common + # licenses that work well with the auto_template feature are GPL + # variants, and the Apache 2.0 license. + # + # Important Note: this means the ident must be a valid SPDX identifier + # auto_template: true + # + # If true try to detect the text wrapping of the template, and unwrap it + unwrap_text: false + +# Define type of comment characters to apply based on file extensions. +comments: + # The extensions (or singular extension) field defines which file + # extensions to apply the commenter to. + - extensions: + - js + - go + - pest + # The commenter field defines the kind of commenter to + # generate. There are two types of commenters: line and block. + # + # This demonstrates a line commenter configuration. A line + # commenter type will apply the comment_char to the beginning of + # each line in the license header. It will then apply a number of + # empty newlines to the end of the header equal to trailing_lines. + # + # If trailing_lines is omitted it is assumed to be 0. + commenter: + type: line + comment_char: "//" + trailing_lines: 2 + + - extensions: + - rs + - tri + - css + - cpp + - c + # This demonstrates a block commenter configuration. A block + # commenter type will add start_block_char as the first character + # in the license header and add end_block_char as the last character + # in the license header. If per_line_char is provided each line of + # the header between the block start and end characters will be + # line commented with the per_line_char + # + # trailing_lines works the same for both block and line commenter + # types + commenter: + type: block + start_block_char: "/*\n" + end_block_char: "*/\n" + per_line_char: "*" + trailing_lines: 2 + + # In this case extension is singular and a single string extension is provided. + - extension: html + commenter: + type: block + start_block_char: "\n" + trailing_lines: 2 + + - extensions: + - el + - lisp + commenter: + type: line + comment_char: ";;;" + trailing_lines: 2 + + - extensions: + - ebnf + commenter: + type: block + start_block_char: "#(*\n" + end_block_char: "#*)\n" + per_line_char: "#" + trailing_lines: 2 + + # The extension string "any" is special and so will match any file + # extensions. Commenter configurations are always checked in the + # order they are defined, so if any is used it should be the last + # commenter configuration or else it will override all others. + # + # In this configuration if we can't match the file extension we fall + # back to the popular '#' line comment used in most scripting + # languages. + - extension: any + commenter: + type: line + comment_char: '#' + trailing_lines: 2 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/COPYING.LESSER b/COPYING.LESSER new file mode 100644 index 0000000..0a04128 --- /dev/null +++ b/COPYING.LESSER @@ -0,0 +1,165 @@ + GNU LESSER 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. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..7e5737c --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,14 @@ +[package] +name = "trinitry" +version = "0.1.0" +edition = "2021" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] +pest = "2.7.5" +pest_derive = {version = "2.7.5", features = ["grammar-extras"]} + +# The header imports katex, a js latex parser, into the doc comments +[package.metadata.docs.rs] +rustdoc-args = [ "--html-in-header", "./docs-header.html" ] diff --git a/LICENSE.spdx b/LICENSE.spdx new file mode 100644 index 0000000..0fb14c9 --- /dev/null +++ b/LICENSE.spdx @@ -0,0 +1,7 @@ +SPDXVersion: SPDX-2.3 +DataLicense: CC0-1.0 +Creator: trinitrix contributers +PackageName: Trinitrix-trinitry +PackageOriginator: trinitrix contributers +PackageHomePage: https://git.nerdcult.net/trinitrix/trinitry +PackageLicenseDeclared: LGPL-3.0-or-later diff --git a/cog.toml b/cog.toml new file mode 100644 index 0000000..0f60566 --- /dev/null +++ b/cog.toml @@ -0,0 +1,28 @@ +tag_prefix = "v" +branch_whitelist = [ "prime" ] +ignore_merge_commits = false + +[commit_types] + +pre_bump_hooks = [ + "licensur -p -i" # update the license header in each file + "nix build", # verify the project builds + "cargo fmt --all" # format + "cargo set-version {{version}}", # bump version in Cargo.toml +] +post_bump_hooks = [ + "git push", + "cargo publish", + "git push origin v{{version}}", # push the new tag to origin +] + +[bump_profiles] + +[changelog] +path = "NEWS.md" +remote = "git.nerdcult.net" +repository = "trinitry" +owner = "trinitrix" +authors = [ + { signature = "Soispha", username = "soispha" }, +] diff --git a/docs-header.html b/docs-header.html new file mode 100644 index 0000000..beafd4d --- /dev/null +++ b/docs-header.html @@ -0,0 +1,45 @@ + + + + + + + + + + + + + + diff --git a/flake.lock b/flake.lock new file mode 100644 index 0000000..ecbf802 --- /dev/null +++ b/flake.lock @@ -0,0 +1,123 @@ +{ + "nodes": { + "crane": { + "inputs": { + "nixpkgs": [ + "nixpkgs" + ] + }, + "locked": { + "lastModified": 1703089493, + "narHash": "sha256-WUjYqUP/Lhhop9+aiHVFREgElunx1AHEWxqMT8ePfzo=", + "owner": "ipetkov", + "repo": "crane", + "rev": "2a5136f14a9ac93d9d370d64a36026c5de3ae8a4", + "type": "github" + }, + "original": { + "owner": "ipetkov", + "repo": "crane", + "type": "github" + } + }, + "flake-compat": { + "flake": false, + "locked": { + "lastModified": 1696426674, + "narHash": "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U=", + "owner": "edolstra", + "repo": "flake-compat", + "rev": "0f9255e01c2351cc7d116c072cb317785dd33b33", + "type": "github" + }, + "original": { + "owner": "edolstra", + "repo": "flake-compat", + "type": "github" + } + }, + "flake-utils": { + "inputs": { + "systems": "systems" + }, + "locked": { + "lastModified": 1701680307, + "narHash": "sha256-kAuep2h5ajznlPMD9rnQyffWG8EM/C73lejGofXvdM8=", + "owner": "numtide", + "repo": "flake-utils", + "rev": "4022d587cbbfd70fe950c1e2083a02621806a725", + "type": "github" + }, + "original": { + "owner": "numtide", + "repo": "flake-utils", + "type": "github" + } + }, + "nixpkgs": { + "locked": { + "lastModified": 1703349974, + "narHash": "sha256-BcR1wW63W4baNtWbpg25d/mt0DVkEBIFssAY9JPNpZg=", + "owner": "soispha", + "repo": "nixpkgs", + "rev": "7e33c3c5db1c69a50efc2143ffa53539e8b4c0ed", + "type": "github" + }, + "original": { + "owner": "soispha", + "ref": "licensure", + "repo": "nixpkgs", + "type": "github" + } + }, + "root": { + "inputs": { + "crane": "crane", + "flake-compat": "flake-compat", + "flake-utils": "flake-utils", + "nixpkgs": "nixpkgs", + "rust-overlay": "rust-overlay" + } + }, + "rust-overlay": { + "inputs": { + "flake-utils": [ + "flake-utils" + ], + "nixpkgs": [ + "nixpkgs" + ] + }, + "locked": { + "lastModified": 1703297543, + "narHash": "sha256-d4QlzcoSNzb/iZheWtjOyRxoBSaLETSpViENGEkxv9g=", + "owner": "oxalica", + "repo": "rust-overlay", + "rev": "fc77c8b416b1537522d30c710baaaaebf769f816", + "type": "github" + }, + "original": { + "owner": "oxalica", + "repo": "rust-overlay", + "type": "github" + } + }, + "systems": { + "locked": { + "lastModified": 1681028828, + "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=", + "owner": "nix-systems", + "repo": "default", + "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e", + "type": "github" + }, + "original": { + "owner": "nix-systems", + "repo": "default", + "type": "github" + } + } + }, + "root": "root", + "version": 7 +} diff --git a/flake.nix b/flake.nix new file mode 100644 index 0000000..73d2db5 --- /dev/null +++ b/flake.nix @@ -0,0 +1,96 @@ +{ + description = "A very simple programming language used to map functions to commands"; + inputs = { + # nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable"; + nixpkgs.url = "github:soispha/nixpkgs/licensure"; + + # inputs for following + flake-compat = { + url = "github:edolstra/flake-compat"; + flake = false; + }; + + crane = { + url = "github:ipetkov/crane"; + inputs = { + nixpkgs.follows = "nixpkgs"; + }; + }; + flake-utils = { + url = "github:numtide/flake-utils"; + inputs = {}; + }; + rust-overlay = { + url = "github:oxalica/rust-overlay"; + inputs = { + nixpkgs.follows = "nixpkgs"; + flake-utils.follows = "flake-utils"; + }; + }; + }; + + outputs = { + nixpkgs, + crane, + flake-utils, + rust-overlay, + ... + }: + flake-utils.lib.eachDefaultSystem (system: let + pkgs = import nixpkgs { + inherit system; + overlays = [(import rust-overlay)]; + }; + + nightly = false; + rust = + if nightly + then + (pkgs.rust-bin.selectLatestNightlyWith (toolchain: + toolchain.default)) + .override { + extensions = ["rustc-codegen-cranelift-preview"]; + } + else pkgs.rust-bin.stable.latest.default; + rust_min = + if nightly + then + (pkgs.rust-bin.selectLatestNightlyWith (toolchain: + toolchain.minimal)) + .override { + extensions = ["rustc-codegen-cranelift-preview"]; + } + else pkgs.rust-bin.stable.latest.minimal; + + craneLib = (crane.mkLib pkgs).overrideToolchain rust_min; + + nativeBuildInputs = []; + buildInputs = []; + + craneBuild = craneLib.buildPackage { + src = craneLib.cleanCargoSource ./.; + + doCheck = true; + inherit nativeBuildInputs buildInputs; + }; + in { + checks.default = craneBuild; + packages = { + default = craneBuild; + }; + + devShells.default = pkgs.mkShell { + packages = with pkgs; [ + alejandra + + cocogitto + licensure + + rust + cargo-edit + cargo-expand + ]; + inherit nativeBuildInputs buildInputs; + }; + }); +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..2af4dd3 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,192 @@ +//! This crate is a parser for the 'Trinitry' (not 'Trinity') language, used to map all sort of +//! Functions to a memorable command. +//! +//! This parser is more of a validator, as Trinitry does not support any language features besides +//! the aforementioned commands and arguments. That includes some simple constructs like: '||' (OR) +//! or '&&' (AND). If you need these features, simple write them in the language, you've written your +//! Function in. +//! +//! # General specification +//! ## Command +//! Basically every command can be a series of alphanumeric ASCII values. +//! +//! Correctly spoken, the Language, containing all valid command names, is just the Kleene closure +//! over an Alphabet $\Sigma$, which contains all alphanumeric characters: +//! $$ \Sigma_{cmd} = \\{x | 0 \leqslant x \leqslant 9\\} \cup \\{x | "a" \leqslant x \leqslant "z"\\} \cup \\{x | "A" \leqslant x \leqslant "Z"\\} \cup \\{"\\_", "\text{-}", "."\\} $$ +//! +//! ## Argument +//! Arguments are similar to the command, although they can also contain spaces and quotes, +//! if it's quoted and additional characters (here notated as "$\\dots{}$"): +//! $$ \Sigma_{args-quoted} = \Sigma_{cmd} \cup \\{"\\text{"}", "\\ ", \\dots{}\\} $$ +//! $$ \Sigma_{args-single-quoted} = \Sigma_{cmd} \cup \\{"'", "\\ ", \\dots{}\\} $$ +//! $$ \Sigma_{args} = \Sigma_{cmd} \cup \\{\\dots{}\\} $$ +//! Look at the [trinitry.pest](../../../src/trinitry.pest) file for a full list of the additional +//! allowed characters. +//! +//! # Examples +//! ## Command +//! A valid command would be something like that: +//! ```text +//! quit +//! ``` +//! something like that would not be valid however, as Trinitry does not support these 'complex' +//! language features: +//! ```text +//! write && quit +//! ``` +//! ## Arguments +//! A valid argumented command would be: +//! ```text +//! lua "function() print('Hi!') end" +//! ``` +//! Whilst this would not be valid (that is, it would very likely not be what you want): +//! ```text +//! lua "function() print("Hi!") end" +//! ``` +//! as the double quotes in the print statement actually unquote the argument, leaving you with +//! three arguments: +//! 1. `function() print(` +//! 1. `Hi!` +//! 1. `) end` +use std::fmt::Display; + +use pest::{error::Error, Parser}; +use pest_derive::Parser; + +#[derive(Parser)] +#[grammar = "trinitry.pest"] +pub struct Trinitry { + command: String, + arguments: Vec, +} + +impl Trinitry { + pub fn new(input: &str) -> Result> { + let parsed = Self::parse(Rule::trinitry, input)?; + + let command = { + let command: Vec<_> = parsed.clone().find_tagged("command").collect(); + + // Ensure that we have only one command + // This should be ensured by the grammar, thus the 'debug_assert' + debug_assert_eq!(command.len(), 1); + + // PERFORMANCE(@soispha): Replace this with `mem::take` (when pairs implements Default) + // <2023-11-01> + command + .first() + .expect("This should contain exactly one element") + .to_owned() + }; + let arguments: Vec<_> = parsed.clone().find_tagged("argument").collect(); + + Ok(Trinitry { + command: command.as_str().to_owned(), + arguments: arguments + .iter() + .map(|arg| { + let mut arg = arg.as_str().trim(); + arg = if let Some(new_arg) = arg.strip_prefix("\"") { + new_arg + } else { + arg + }; + arg = if let Some(new_arg) = arg.strip_suffix("\"") { + new_arg + } else { + arg + }; + + arg = if let Some(new_arg) = arg.strip_prefix("'") { + new_arg + } else { + arg + }; + arg = if let Some(new_arg) = arg.strip_suffix("'") { + new_arg + } else { + arg + }; + arg.to_owned() + }) + .collect(), + }) + } +} + +impl Display for Trinitry { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + if self.arguments.is_empty() { + f.write_str(&self.command) + } else { + f.write_fmt(format_args!( + "{} {}", + &self.command, + &self.arguments.join(" ") + )) + } + } +} + +mod tests; + +#[cfg(test)] +mod test { + use crate::Trinitry; + + #[test] + fn parse_cmd() { + let string = "quit"; + let p = Trinitry::new(string).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(&p.command, "quit"); + assert!(&p.arguments.is_empty()); + } + + #[test] + fn parse_arg_clean() { + let string = r##"lua print("Hi")"##; + let p = Trinitry::new(string).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(&p.command, "lua"); + assert_eq!(&p.arguments[0], r#"print("Hi")"#); + } + + #[test] + fn parse_arg_quote() { + let string = r##"write "some 'file' name""##; + let p = Trinitry::new(string).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(&p.command, "write"); + assert_eq!(&p.arguments[0], "some 'file' name"); + } + + #[test] + fn parse_arg_single_quote() { + let string = r##"write 'some "file" name'"##; + let p = Trinitry::new(string).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(&p.command, "write"); + assert_eq!(&p.arguments[0], "some \"file\" name"); + } + + #[test] + fn parse_arg_multi() { + let string = r##"write 'some "file" name' "other name" last"##; + let p = Trinitry::new(string).unwrap_or_else(|e| { + panic!("{}", e); + }); + + let expected_args = vec!["some \"file\" name", "other name", "last"] + .iter() + .map(|str| (*str).to_owned()) + .collect::>(); + + assert_eq!(&p.command, "write"); + assert_eq!(&p.arguments, &expected_args); + } +} diff --git a/src/tests.rs b/src/tests.rs new file mode 100644 index 0000000..4a65b94 --- /dev/null +++ b/src/tests.rs @@ -0,0 +1,1365 @@ +// DO NOT EDIT +// This file is automatically generated by the 'update.sh' file, with data from: +// https://raw.githubusercontent.com/minimaxir/big-list-of-naughty-strings/master/blns.txt + +#[cfg(test)] +mod test { + use crate::Trinitry; + #[test] + fn parse_0() { + let p = Trinitry::new(r##"undefined"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"undefined"##, &p.to_string()); + } + #[test] + fn parse_1() { + let p = Trinitry::new(r##"undef"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"undef"##, &p.to_string()); + } + #[test] + fn parse_2() { + let p = Trinitry::new(r##"null"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"null"##, &p.to_string()); + } + #[test] + fn parse_3() { + let p = Trinitry::new(r##"NULL"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"NULL"##, &p.to_string()); + } + #[test] + fn parse_4() { + let p = Trinitry::new(r##"(null)"##); + assert!(p.is_err()); + } + #[test] + fn parse_5() { + let p = Trinitry::new(r##"nil"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"nil"##, &p.to_string()); + } + #[test] + fn parse_6() { + let p = Trinitry::new(r##"NIL"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"NIL"##, &p.to_string()); + } + #[test] + fn parse_7() { + let p = Trinitry::new(r##"true"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"true"##, &p.to_string()); + } + #[test] + fn parse_8() { + let p = Trinitry::new(r##"True"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"True"##, &p.to_string()); + } + #[test] + fn parse_9() { + let p = Trinitry::new(r##"TRUE"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"TRUE"##, &p.to_string()); + } + #[test] + fn parse_10() { + let p = Trinitry::new(r##"FALSE"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"FALSE"##, &p.to_string()); + } + #[test] + fn parse_11() { + let p = Trinitry::new(r##"None"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"None"##, &p.to_string()); + } + #[test] + fn parse_12() { + let p = Trinitry::new(r##"then"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"then"##, &p.to_string()); + } + #[test] + fn parse_13() { + let p = Trinitry::new(r##"\"##); + assert!(p.is_err()); + } + #[test] + fn parse_14() { + let p = Trinitry::new(r##"\\"##); + assert!(p.is_err()); + } + #[test] + fn parse_15() { + let p = Trinitry::new(r##"0"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"0"##, &p.to_string()); + } + #[test] + fn parse_16() { + let p = Trinitry::new(r##"1"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"1"##, &p.to_string()); + } + #[test] + fn parse_17() { + let p = Trinitry::new(r##"1.00"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"1.00"##, &p.to_string()); + } + #[test] + fn parse_18() { + let p = Trinitry::new(r##"$1.00"##); + assert!(p.is_err()); + } + #[test] + fn parse_19() { + let p = Trinitry::new(r##"1/2"##); + assert!(p.is_err()); + } + #[test] + fn parse_20() { + let p = Trinitry::new(r##"1E2"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"1E2"##, &p.to_string()); + } + #[test] + fn parse_21() { + let p = Trinitry::new(r##"1E02"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"1E02"##, &p.to_string()); + } + #[test] + fn parse_22() { + let p = Trinitry::new(r##"1E+02"##); + assert!(p.is_err()); + } + #[test] + fn parse_23() { + let p = Trinitry::new(r##"-1"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"-1"##, &p.to_string()); + } + #[test] + fn parse_24() { + let p = Trinitry::new(r##"-1.00"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"-1.00"##, &p.to_string()); + } + #[test] + fn parse_25() { + let p = Trinitry::new(r##"-$1.00"##); + assert!(p.is_err()); + } + #[test] + fn parse_26() { + let p = Trinitry::new(r##"-1/2"##); + assert!(p.is_err()); + } + #[test] + fn parse_27() { + let p = Trinitry::new(r##"-1E2"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"-1E2"##, &p.to_string()); + } + #[test] + fn parse_28() { + let p = Trinitry::new(r##"-1E02"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"-1E02"##, &p.to_string()); + } + #[test] + fn parse_29() { + let p = Trinitry::new(r##"-1E+02"##); + assert!(p.is_err()); + } + #[test] + fn parse_30() { + let p = Trinitry::new(r##"1/0"##); + assert!(p.is_err()); + } + #[test] + fn parse_31() { + let p = Trinitry::new(r##"0/0"##); + assert!(p.is_err()); + } + #[test] + fn parse_32() { + let p = Trinitry::new(r##"-2147483648/-1"##); + assert!(p.is_err()); + } + #[test] + fn parse_33() { + let p = Trinitry::new(r##"-9223372036854775808/-1"##); + assert!(p.is_err()); + } + #[test] + fn parse_34() { + let p = Trinitry::new(r##"-0"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"-0"##, &p.to_string()); + } + #[test] + fn parse_35() { + let p = Trinitry::new(r##"-0.0"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"-0.0"##, &p.to_string()); + } + #[test] + fn parse_36() { + let p = Trinitry::new(r##"+0"##); + assert!(p.is_err()); + } + #[test] + fn parse_37() { + let p = Trinitry::new(r##"+0.0"##); + assert!(p.is_err()); + } + #[test] + fn parse_38() { + let p = Trinitry::new(r##"0.00"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"0.00"##, &p.to_string()); + } + #[test] + fn parse_39() { + let p = Trinitry::new(r##"0..0"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"0..0"##, &p.to_string()); + } + #[test] + fn parse_40() { + let p = Trinitry::new(r##"."##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"."##, &p.to_string()); + } + #[test] + fn parse_41() { + let p = Trinitry::new(r##"0.0.0"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"0.0.0"##, &p.to_string()); + } + #[test] + fn parse_42() { + let p = Trinitry::new(r##"0,00"##); + assert!(p.is_err()); + } + #[test] + fn parse_43() { + let p = Trinitry::new(r##"0,,0"##); + assert!(p.is_err()); + } + #[test] + fn parse_44() { + let p = Trinitry::new(r##","##); + assert!(p.is_err()); + } + #[test] + fn parse_45() { + let p = Trinitry::new(r##"0,0,0"##); + assert!(p.is_err()); + } + #[test] + fn parse_46() { + let p = Trinitry::new(r##"0.0/0"##); + assert!(p.is_err()); + } + #[test] + fn parse_47() { + let p = Trinitry::new(r##"1.0/0.0"##); + assert!(p.is_err()); + } + #[test] + fn parse_48() { + let p = Trinitry::new(r##"0.0/0.0"##); + assert!(p.is_err()); + } + #[test] + fn parse_49() { + let p = Trinitry::new(r##"1,0/0,0"##); + assert!(p.is_err()); + } + #[test] + fn parse_50() { + let p = Trinitry::new(r##"0,0/0,0"##); + assert!(p.is_err()); + } + #[test] + fn parse_51() { + let p = Trinitry::new(r##"--1"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"--1"##, &p.to_string()); + } + #[test] + fn parse_52() { + let p = Trinitry::new(r##"-"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"-"##, &p.to_string()); + } + #[test] + fn parse_53() { + let p = Trinitry::new(r##"-."##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"-."##, &p.to_string()); + } + #[test] + fn parse_54() { + let p = Trinitry::new(r##"-,"##); + assert!(p.is_err()); + } + #[test] + fn parse_55() { + let p = Trinitry::new(r##"999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999999"##, &p.to_string()); + } + #[test] + fn parse_56() { + let p = Trinitry::new(r##"NaN"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"NaN"##, &p.to_string()); + } + #[test] + fn parse_57() { + let p = Trinitry::new(r##"Infinity"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"Infinity"##, &p.to_string()); + } + #[test] + fn parse_58() { + let p = Trinitry::new(r##"-Infinity"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"-Infinity"##, &p.to_string()); + } + #[test] + fn parse_59() { + let p = Trinitry::new(r##"INF"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"INF"##, &p.to_string()); + } + #[test] + fn parse_60() { + let p = Trinitry::new(r##"1#INF"##); + assert!(p.is_err()); + } + #[test] + fn parse_61() { + let p = Trinitry::new(r##"-1#IND"##); + assert!(p.is_err()); + } + #[test] + fn parse_62() { + let p = Trinitry::new(r##"1#QNAN"##); + assert!(p.is_err()); + } + #[test] + fn parse_63() { + let p = Trinitry::new(r##"1#SNAN"##); + assert!(p.is_err()); + } + #[test] + fn parse_64() { + let p = Trinitry::new(r##"1#IND"##); + assert!(p.is_err()); + } + #[test] + fn parse_65() { + let p = Trinitry::new(r##"0x0"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"0x0"##, &p.to_string()); + } + #[test] + fn parse_66() { + let p = Trinitry::new(r##"0xffffffff"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"0xffffffff"##, &p.to_string()); + } + #[test] + fn parse_67() { + let p = Trinitry::new(r##"0xffffffffffffffff"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"0xffffffffffffffff"##, &p.to_string()); + } + #[test] + fn parse_68() { + let p = Trinitry::new(r##"0xabad1dea"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"0xabad1dea"##, &p.to_string()); + } + #[test] + fn parse_69() { + let p = Trinitry::new(r##"123456789012345678901234567890123456789"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"123456789012345678901234567890123456789"##, &p.to_string()); + } + #[test] + fn parse_70() { + let p = Trinitry::new(r##"1,000.00"##); + assert!(p.is_err()); + } + #[test] + fn parse_71() { + let p = Trinitry::new(r##"1 000.00"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"1 000.00"##, &p.to_string()); + } + #[test] + fn parse_72() { + let p = Trinitry::new(r##"1'000.00"##); + assert!(p.is_err()); + } + #[test] + fn parse_73() { + let p = Trinitry::new(r##"1,000,000.00"##); + assert!(p.is_err()); + } + #[test] + fn parse_74() { + let p = Trinitry::new(r##"1 000 000.00"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"1 000 000.00"##, &p.to_string()); + } + #[test] + fn parse_75() { + let p = Trinitry::new(r##"1'000'000.00"##); + assert!(p.is_err()); + } + #[test] + fn parse_76() { + let p = Trinitry::new(r##"1.000,00"##); + assert!(p.is_err()); + } + #[test] + fn parse_77() { + let p = Trinitry::new(r##"1 000,00"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"1 000,00"##, &p.to_string()); + } + #[test] + fn parse_78() { + let p = Trinitry::new(r##"1'000,00"##); + assert!(p.is_err()); + } + #[test] + fn parse_79() { + let p = Trinitry::new(r##"1.000.000,00"##); + assert!(p.is_err()); + } + #[test] + fn parse_80() { + let p = Trinitry::new(r##"1 000 000,00"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"1 000 000,00"##, &p.to_string()); + } + #[test] + fn parse_81() { + let p = Trinitry::new(r##"1'000'000,00"##); + assert!(p.is_err()); + } + #[test] + fn parse_82() { + let p = Trinitry::new(r##"01000"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"01000"##, &p.to_string()); + } + #[test] + fn parse_83() { + let p = Trinitry::new(r##"08"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"08"##, &p.to_string()); + } + #[test] + fn parse_84() { + let p = Trinitry::new(r##"09"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"09"##, &p.to_string()); + } + #[test] + fn parse_85() { + let p = Trinitry::new(r##"2.2250738585072011e-308"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"2.2250738585072011e-308"##, &p.to_string()); + } + #[test] + fn parse_86() { + let p = Trinitry::new(r##",./;'[]\-="##); + assert!(p.is_err()); + } + #[test] + fn parse_87() { + let p = Trinitry::new(r##"<>?:"{}|_+"##); + assert!(p.is_err()); + } + #[test] + fn parse_88() { + let p = Trinitry::new(r##"!@#$%^&*()`~"##); + assert!(p.is_err()); + } + #[test] + fn parse_89() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_90() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_91() { + let p = Trinitry::new(r##" "##); + assert!(p.is_err()); + } + #[test] + fn parse_92() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_93() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_94() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_95() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_96() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_97() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_98() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_99() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_100() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_101() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_102() { + let p = Trinitry::new(r##"`"##); + assert!(p.is_err()); + } + #[test] + fn parse_103() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_104() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_105() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_106() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_107() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_108() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_109() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_110() { + let p = Trinitry::new(r##"'"##); + assert!(p.is_err()); + } + #[test] + fn parse_111() { + let p = Trinitry::new(r##"""##); + assert!(p.is_err()); + } + #[test] + fn parse_112() { + let p = Trinitry::new(r##"''"##); + assert!(p.is_err()); + } + #[test] + fn parse_113() { + let p = Trinitry::new(r##""""##); + assert!(p.is_err()); + } + #[test] + fn parse_114() { + let p = Trinitry::new(r##"'"'"##); + assert!(p.is_err()); + } + #[test] + fn parse_115() { + let p = Trinitry::new(r##""''''"'""##); + assert!(p.is_err()); + } + #[test] + fn parse_116() { + let p = Trinitry::new(r##""'"'"''''""##); + assert!(p.is_err()); + } + #[test] + fn parse_117() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_118() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_119() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_120() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_121() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_122() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_123() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_124() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_125() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_126() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_127() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_128() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_129() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_130() { + let p = Trinitry::new(r##"/"##); + assert!(p.is_err()); + } + #[test] + fn parse_131() { + let p = Trinitry::new(r##"A"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"A"##, &p.to_string()); + } + #[test] + fn parse_132() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_133() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_134() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_135() { + let p = Trinitry::new(r##"( )"##); + assert!(p.is_err()); + } + #[test] + fn parse_136() { + let p = Trinitry::new(r##"("##); + assert!(p.is_err()); + } + #[test] + fn parse_137() { + let p = Trinitry::new(r##"__(,_,*)"##); + assert!(p.is_err()); + } + #[test] + fn parse_138() { + let p = Trinitry::new(r##"():*:"##); + assert!(p.is_err()); + } + #[test] + fn parse_139() { + let p = Trinitry::new(r##"()"##); + assert!(p.is_err()); + } + #[test] + fn parse_140() { + let p = Trinitry::new(r##",:*:( ):*:"##); + assert!(p.is_err()); + } + #[test] + fn parse_141() { + let p = Trinitry::new(r##"( )"##); + assert!(p.is_err()); + } + #[test] + fn parse_142() { + let p = Trinitry::new(r##"("##); + assert!(p.is_err()); + } + #[test] + fn parse_143() { + let p = Trinitry::new(r##"( _ )"##); + assert!(p.is_err()); + } + #[test] + fn parse_144() { + let p = Trinitry::new(r##"( )"##); + assert!(p.is_err()); + } + #[test] + fn parse_145() { + let p = Trinitry::new(r##"\_()_/"##); + assert!(p.is_err()); + } + #[test] + fn parse_146() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_147() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_148() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_149() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_150() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_151() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_152() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_153() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_154() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_155() { + let p = Trinitry::new(r##"0 1 2 3 4 5 6 7 8 9"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"0 1 2 3 4 5 6 7 8 9"##, &p.to_string()); + } + #[test] + fn parse_156() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_157() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_158() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_159() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_160() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_161() { + let p = Trinitry::new(r##", . . - . , , ."##); + assert!(p.is_err()); + } + #[test] + fn parse_162() { + let p = Trinitry::new(r##", , ,"##); + assert!(p.is_err()); + } + #[test] + fn parse_163() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_164() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_165() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_166() { + let p = Trinitry::new(r##"(5)"##); + assert!(p.is_err()); + } + #[test] + fn parse_167() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_168() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_169() { + let p = Trinitry::new(r##"ZGO"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"ZGO"##, &p.to_string()); + } + #[test] + fn parse_170() { + let p = Trinitry::new(r##"00$-"##); + assert!(p.is_err()); + } + #[test] + fn parse_171() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_172() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_173() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_174() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_175() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_176() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_177() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_178() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_179() { + let p = Trinitry::new(r##"";alert(15);t=""##); + assert!(p.is_err()); + } + #[test] + fn parse_180() { + let p = Trinitry::new(r##"';alert(16);t='"##); + assert!(p.is_err()); + } + #[test] + fn parse_181() { + let p = Trinitry::new(r##"JavaSCript:alert(17)"##); + assert!(p.is_err()); + } + #[test] + fn parse_182() { + let p = Trinitry::new(r##";alert(18);"##); + assert!(p.is_err()); + } + #[test] + fn parse_183() { + let p = Trinitry::new(r##"">"##); + assert!(p.is_err()); + } + #[test] + fn parse_184() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_185() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_186() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_187() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_188() { + let p = Trinitry::new(r##"<"##); + assert!(p.is_err()); + } + #[test] + fn parse_189() { + let p = Trinitry::new(r##"\";alert('223');//"##); + assert!(p.is_err()); + } + #[test] + fn parse_190() { + let p = Trinitry::new(r##" Copy me"##); + assert!(p.is_err()); + } + #[test] + fn parse_191() { + let p = Trinitry::new(r##" Scroll over me "##); + assert!(p.is_err()); + } + #[test] + fn parse_192() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_193() { + let p = Trinitry::new(r##"http://a/%%30%30"##); + assert!(p.is_err()); + } + #[test] + fn parse_194() { + let p = Trinitry::new(r##"' OR 1=1 -- 1"##); + assert!(p.is_err()); + } + #[test] + fn parse_195() { + let p = Trinitry::new(r##"' OR '1'='1"##); + assert!(p.is_err()); + } + #[test] + fn parse_196() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_197() { + let p = Trinitry::new(r##"%"##); + assert!(p.is_err()); + } + #[test] + fn parse_198() { + let p = Trinitry::new(r##"_"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"_"##, &p.to_string()); + } + #[test] + fn parse_199() { + let p = Trinitry::new(r##"-"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"-"##, &p.to_string()); + } + #[test] + fn parse_200() { + let p = Trinitry::new(r##"--"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"--"##, &p.to_string()); + } + #[test] + fn parse_201() { + let p = Trinitry::new(r##"--help"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"--help"##, &p.to_string()); + } + #[test] + fn parse_202() { + let p = Trinitry::new(r##"$USER"##); + assert!(p.is_err()); + } + #[test] + fn parse_203() { + let p = Trinitry::new(r##"Kernel.exit(1)"##); + assert!(p.is_err()); + } + #[test] + fn parse_204() { + let p = Trinitry::new(r##"$HOME"##); + assert!(p.is_err()); + } + #[test] + fn parse_205() { + let p = Trinitry::new(r##"$ENV{'HOME'}"##); + assert!(p.is_err()); + } + #[test] + fn parse_206() { + let p = Trinitry::new(r##"%d"##); + assert!(p.is_err()); + } + #[test] + fn parse_207() { + let p = Trinitry::new(r##"{0}"##); + assert!(p.is_err()); + } + #[test] + fn parse_208() { + let p = Trinitry::new(r##"%@"##); + assert!(p.is_err()); + } + #[test] + fn parse_209() { + let p = Trinitry::new(r##"%n"##); + assert!(p.is_err()); + } + #[test] + fn parse_210() { + let p = Trinitry::new(r##"File:///"##); + assert!(p.is_err()); + } + #[test] + fn parse_211() { + let p = Trinitry::new(r##"+++ATH0"##); + assert!(p.is_err()); + } + #[test] + fn parse_212() { + let p = Trinitry::new(r##"CON"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"CON"##, &p.to_string()); + } + #[test] + fn parse_213() { + let p = Trinitry::new(r##"PRN"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"PRN"##, &p.to_string()); + } + #[test] + fn parse_214() { + let p = Trinitry::new(r##"AUX"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"AUX"##, &p.to_string()); + } + #[test] + fn parse_215() { + let p = Trinitry::new(r##"CLOCK$"##); + assert!(p.is_err()); + } + #[test] + fn parse_216() { + let p = Trinitry::new(r##"NUL"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"NUL"##, &p.to_string()); + } + #[test] + fn parse_217() { + let p = Trinitry::new(r##"A:"##); + assert!(p.is_err()); + } + #[test] + fn parse_218() { + let p = Trinitry::new(r##"ZZ:"##); + assert!(p.is_err()); + } + #[test] + fn parse_219() { + let p = Trinitry::new(r##"COM1"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"COM1"##, &p.to_string()); + } + #[test] + fn parse_220() { + let p = Trinitry::new(r##"LPT1"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"LPT1"##, &p.to_string()); + } + #[test] + fn parse_221() { + let p = Trinitry::new(r##"LPT2"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"LPT2"##, &p.to_string()); + } + #[test] + fn parse_222() { + let p = Trinitry::new(r##"LPT3"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"LPT3"##, &p.to_string()); + } + #[test] + fn parse_223() { + let p = Trinitry::new(r##"COM2"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"COM2"##, &p.to_string()); + } + #[test] + fn parse_224() { + let p = Trinitry::new(r##"COM3"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"COM3"##, &p.to_string()); + } + #[test] + fn parse_225() { + let p = Trinitry::new(r##"COM4"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"COM4"##, &p.to_string()); + } + #[test] + fn parse_226() { + let p = Trinitry::new(r##"DCC SEND STARTKEYLOGGER 0 0 0"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"DCC SEND STARTKEYLOGGER 0 0 0"##, &p.to_string()); + } + #[test] + fn parse_227() { + let p = Trinitry::new(r##"Lightwater Country Park"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"Lightwater Country Park"##, &p.to_string()); + } + #[test] + fn parse_228() { + let p = Trinitry::new(r##"Jimmy Clitheroe"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"Jimmy Clitheroe"##, &p.to_string()); + } + #[test] + fn parse_229() { + let p = Trinitry::new(r##"http://www.cum.qc.ca/"##); + assert!(p.is_err()); + } + #[test] + fn parse_230() { + let p = Trinitry::new(r##"Linda Callahan"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"Linda Callahan"##, &p.to_string()); + } + #[test] + fn parse_231() { + let p = Trinitry::new(r##"magna cum laude"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"magna cum laude"##, &p.to_string()); + } + #[test] + fn parse_232() { + let p = Trinitry::new(r##"Super Bowl XXX"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"Super Bowl XXX"##, &p.to_string()); + } + #[test] + fn parse_233() { + let p = Trinitry::new(r##"evaluate"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"evaluate"##, &p.to_string()); + } + #[test] + fn parse_234() { + let p = Trinitry::new(r##"mocha"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"mocha"##, &p.to_string()); + } + #[test] + fn parse_235() { + let p = Trinitry::new(r##"Dick Van Dyke"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"Dick Van Dyke"##, &p.to_string()); + } + #[test] + fn parse_236() { + let p = Trinitry::new(r##"The quick brown fox... [Beeeep]"##); + assert!(p.is_err()); + } + #[test] + fn parse_237() { + let p = Trinitry::new(r##"0"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"0"##, &p.to_string()); + } + #[test] + fn parse_238() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_239() { + let p = Trinitry::new(r##""##); + assert!(p.is_err()); + } + #[test] + fn parse_240() { + let p = Trinitry::new(r##"{% print 'x' * 64 * 1024**3 %}"##); + assert!(p.is_err()); + } +} diff --git a/src/trinitry.pest b/src/trinitry.pest new file mode 100644 index 0000000..c868a6d --- /dev/null +++ b/src/trinitry.pest @@ -0,0 +1,25 @@ +chars = { ASCII_ALPHANUMERIC | "_" | "-" | "." } + +// TODO(@soispha): Are these all the valid characters? <2023-11-01> +argument_chars = { chars | "(" | ")" | "{" | "}" | "<" | ">" | "?" | "!" | "+" | "^" | "@" +| "&" | "*" | "~" | "|" | "=" | "," | "\\" | "/" } +whitespace = _{ " " } // lower case to avoid special treatment of 'WHITESPACE' + +quote = _{ "\"" } +q = _{ quote } + +single_quote = _{ "'" } +sq = _{ single_quote } + + + +command = { chars+ } + +arg_quoted = { q ~ (!q ~ (argument_chars | " " | "'" ))+ ~ q } +arg_single_quoted = { sq ~ (!sq ~ (argument_chars | " " | "\"" ))+ ~ sq } +arg = { (argument_chars | "\"" | "'")+ } + +argument = { whitespace+ ~ (arg_quoted | arg_single_quoted | arg )} + + +trinitry = { SOI ~ #command = command ~ (#argument = argument)* ~ EOI } diff --git a/update.sh b/update.sh new file mode 100755 index 0000000..51f1f58 --- /dev/null +++ b/update.sh @@ -0,0 +1,88 @@ +#!/usr/bin/env sh + +# Library {{{ +mktmp() { + ensure_tmp_dir + mktemp -p "$LIB_TEMP_DIR_FOR_SCRIPT" +} +ensure_tmp_dir() { + if ! [ -d "$LIB_TEMP_DIR_FOR_SCRIPT" ]; then + LIB_TEMP_DIR_FOR_SCRIPT="$(mktemp -d)" + export LIB_TEMP_DIR_FOR_SCRIPT + fi +} +remove_tmp_dir() { + # The test is here because some scripts still delete this on their own + if [ -d "$LIB_TEMP_DIR_FOR_SCRIPT" ]; then + rm -r "$LIB_TEMP_DIR_FOR_SCRIPT" + fi +} + +trap remove_tmp_dir EXIT +ensure_tmp_dir # ensure that the variable has been set, even in subshells +# }}} + +tmp="$(mktmp)" + +curl https://raw.githubusercontent.com/minimaxir/big-list-of-naughty-strings/master/blns.txt | + awk '!/^#/' | + awk '!/^[\s\t]*$/' | + awk -v s="'" '!/.*s.*/' | + + # This entry contains duplicated spaces, just ignore it + awk '!/Power/' | + iconv -c -f utf-8 -t ascii \ + >"$tmp" + +counter=0 + +cat <<EOF +// DO NOT EDIT +// This file is automatically generated by the 'update.sh' file, with data from: +// https://raw.githubusercontent.com/minimaxir/big-list-of-naughty-strings/master/blns.txt + +#[cfg(test)] +mod test { + use crate::Trinitry; +EOF + +while read -r name; do + tmp2="$(mktmp)" + printf "%s" "$name" >"$tmp2" + if rg '^[A-Za-z0-9_.-]+$' "$tmp2" -q; then + cat <<EOF + #[test] + fn parse_$counter() { + let p = Trinitry::new(r##"$name"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"$name"##, &p.to_string()); + } +EOF + elif rg '^[A-Za-z0-9_.-]+ [A-Za-z0-9_.(){}<>?!+^@&*~|=,/\\ -]*$' "$tmp2" -q; then + cat <<EOF + #[test] + fn parse_$counter() { + let p = Trinitry::new(r##"$name"##).unwrap_or_else(|e| { + panic!("{}", e); + }); + assert_eq!(r##"$name"##, &p.to_string()); + } +EOF + else + cat <<EOF + #[test] + fn parse_$counter() { + let p = Trinitry::new(r##"$name"##); + assert!(p.is_err()); + } +EOF + fi + counter=$((counter + 1)) +done <"$tmp" + +cat <<EOF +} +EOF + +# vim: ft=sh