diff options
| author | Fuwn <[email protected]> | 2022-02-07 04:26:07 -0800 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2025-06-09 00:46:03 -0700 |
| commit | bfa483c6aa5db5c9825faded62176904d516faf7 (patch) | |
| tree | 043b73bdd939f955f2b4d1e6309c8b697d6e0544 | |
| download | archived-divina-bfa483c6aa5db5c9825faded62176904d516faf7.tar.xz archived-divina-bfa483c6aa5db5c9825faded62176904d516faf7.zip | |
feat(divina): pre-release :star:
31 files changed, 2243 insertions, 0 deletions
diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..176a458 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text=auto diff --git a/.github/stale.yml b/.github/stale.yml new file mode 100644 index 0000000..0718720 --- /dev/null +++ b/.github/stale.yml @@ -0,0 +1,11 @@ +daysUntilStale: 30 +daysUntilClose: 7 +exemptLabels: + - pinned + - security +staleLabel: wontfix +markComment: > + This issue has been automatically marked as stale because it has not had + recent activity. It will be closed if no further activity occurs. Thank you + for your contributions. +closeComment: true diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml new file mode 100644 index 0000000..65f896f --- /dev/null +++ b/.github/workflows/release.yaml @@ -0,0 +1,49 @@ +name: Release ⚾ + +on: + push: + tags: + - '*' + +jobs: + release: + runs-on: ubuntu-20.04 + steps: + - name: Checkout 🛒 + uses: actions/checkout@v2 + + - name: Toolchain 🧰 + uses: actions-rs/toolchain@v1 + with: + profile: minimal + toolchain: nightly-2021-12-04 + components: rustfmt, clippy + override: true + + - name: Build 🏗 + uses: actions-rs/cargo@v1 + continue-on-error: false + with: + command: build + args: --release + + - name: Create Release 🏉 + id: create_release + uses: actions/create-release@v1 + env: + GITHUB_TOKEN: ${{ github.token }} + with: + tag_name: ${{ github.ref }} + release_name: ${{ github.ref }} + draft: false + prerelease: false + + - name: Upload Artifacts to Release 💎 + uses: actions/upload-release-asset@v1 + env: + GITHUB_TOKEN: ${{ github.token }} + with: + upload_url: ${{ steps.create_release.outputs.upload_url }} + asset_path: ./target/release/divina + asset_name: divina + asset_content_type: application/x-elf # x-msdownload for Windows diff --git a/.github/workflows/rust.yaml b/.github/workflows/rust.yaml new file mode 100644 index 0000000..ee0218a --- /dev/null +++ b/.github/workflows/rust.yaml @@ -0,0 +1,34 @@ +name: Rust ✅ + +on: + push: + paths: + - "crates/**" + pull_request: + paths: + - "crates/**" + +env: + CARGO_TERM_COLOR: always + +jobs: + check: + runs-on: ubuntu-latest + steps: + - name: Checkout 🛒 + uses: actions/checkout@v2 + + - name: Toolchain 🧰 + uses: actions-rs/toolchain@v1 + with: + profile: minimal + toolchain: nightly-2021-12-04 + components: rustfmt, clippy + override: true + + - name: Check ✅ + uses: actions-rs/cargo@v1 + continue-on-error: false + with: + command: check + args: --verbose diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..00edb81 --- /dev/null +++ b/.gitignore @@ -0,0 +1,19 @@ +# Generated by Cargo +# will have compiled files and executables +/target/ + +# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries +# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html +Cargo.lock + +# These are backup files generated by rustfmt +**/*.rs.bk + +# IDE +/.idea/ +/Divina.iml + +# Development +/src/_*.* +/crates/**/target/ +/out/ diff --git a/.license_template b/.license_template new file mode 100644 index 0000000..0dd6ad5 --- /dev/null +++ b/.license_template @@ -0,0 +1,2 @@ +// Copyright (C) {20\d{2}(-20\d{2})?} Fuwn <[email protected]> +// SPDX-License-Identifier: GPL-3.0-only
\ No newline at end of file diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..e000287 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,14 @@ +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[workspace] +members = [ + "crates/divina", + "crates/divina_config", + "crates/divina_git", + "crates/divina_compile" +] + +# Slower builds, faster executables +[profile.release] +lto = "fat" +codegen-units = 1 diff --git a/Divina.lua b/Divina.lua new file mode 100644 index 0000000..6b3e6b2 --- /dev/null +++ b/Divina.lua @@ -0,0 +1,11 @@ +-- Example Workspace +-- +--- @class Workspace +--- @field public members string[] +Workspace = { + members = { + "examples/greet/", + "examples/greet_from_library/", + "examples/just_return/", + }, +} @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + <program> Copyright (C) <year> <name of author> + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +<https://www.gnu.org/licenses/>. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +<https://www.gnu.org/licenses/why-not-lgpl.html>. diff --git a/Makefile.toml b/Makefile.toml new file mode 100644 index 0000000..af2911f --- /dev/null +++ b/Makefile.toml @@ -0,0 +1,60 @@ +# ------------- +# | Variables | +# ------------- +[env] +CARGO_MAKE_EXTEND_WORKSPACE_MAKEFILE = true + +# ------------ +# | Wrappers | +# ------------ +[tasks.fmt] +command = "cargo" +args = ["fmt"] +private = true + +[tasks.check] +command = "cargo" +args = ["check"] +private = true + +[tasks.clippy] +command = "cargo" +args = ["clippy"] +private = true + +[tasks.test] +command = "cargo" +args = ["test"] +private = true + +[tasks.bench] +command = "cargo" +args = ["bench"] +private = true + +# ------------- +# | Executors | +# ------------- +[tasks.checkf] +workspace = false +dependencies = ["fmt", "check"] + +[tasks.checkfc] +workspace = false +dependencies = ["fmt", "check", "clippy"] + +[tasks.checkall] +workspace = false +dependencies = ["fmt", "check", "clippy", "test", "bench"] + +[tasks.docs] +workspace = false +toolchain = "nightly" +command = "cargo" +args = ["doc", "--open", "--document-private-items", "--no-deps"] + +[tasks.run] +workspace = false +dependencies = ["checkfc"] +command = "cargo" +args = ["run", "--bin", "divina", "${@}"] diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..f947679 --- /dev/null +++ b/README.rst @@ -0,0 +1,51 @@ +🎀 Divina +======== + +What? +----- + +Divina is a modern build system for assembly. + +Why should I use Divina? +------------------------- + +Divina is + +- Simple, +- cool, +- fast, +- and uses Lua as a configuration language! + +Getting up and Running +---------------------- + +Installation +^^^^^^^^^^^^ + +Prebuilt binaries for x86_64-based Linux systems and Windows are available in the +`releases <https://github.com/divinaland/Divina/releases/latest>`_. If you are using +a different operating system or architecture such as macOS, you'll have to build and +install the tool yourself! + +.. code-block:: shell + + $ cargo install --git https://github.com/divinaland/Divina --branch main + +If you are building and installing yourself, you must have +`Rust <https://www.rust-lang.org/>`_ installed! + +Usage +^^^^^ + +Usage documentation is available on `divina.land <divina.land>`_. + +Prebuilt Binaries +""""""""""""""""" + +Prebuilt binaries for the latest release may be found +`here <https://github.com/divinaland/Divina/releases/latest>`_. + +License +------- + +`GNU General Public License v3.0 <./LICENSE>`_ diff --git a/api/Divina.lua b/api/Divina.lua new file mode 100644 index 0000000..f007bf6 --- /dev/null +++ b/api/Divina.lua @@ -0,0 +1,44 @@ +--- @class Divina +--- @field public version string Installed Divina version +--- @field public Type table<string, number> Package type +--- @field public Arch table<string, number> Architecture to compile for +Divina = { + version, + Type = { + Bin = 1, + Lib = 2, + }, + Arch = { + x86 = 1, + x64 = 2, + }, +} + +--- @return void +function test() end + +--- @class Package +--- @field public name string +--- @field public version string +--- @field public description string +--- @field public compile_options string[] +--- @field public minimum_divina_version string +--- @field public sources string[] +--- @field public compiler string +Package = { + name, + version, + description, + compile_options, + minimum_divina_version, + sources, + type, + arch, + compiler, +} + +--- @class Workspace +--- @field public members string[] +Workspace = { + members, +} diff --git a/crates/divina/Cargo.toml b/crates/divina/Cargo.toml new file mode 100644 index 0000000..50eac97 --- /dev/null +++ b/crates/divina/Cargo.toml @@ -0,0 +1,45 @@ +[package] +name = "divina" +version = "0.1.0" +authors = ["Fuwn <[email protected]>"] +edition = "2021" +description = "A modern build system for assembly" +readme = "README.rst" +homepage = "https://divina.land" +repository = "https://github.com/divinaland/Divina" +license = "GPL-3.0-only" +keywords = ["divina", "buildsystem", "build", "assembly", "asm", "nasm", "yasm"] +categories = ["development-tools::build-utils"] +publish = false + +[dependencies] +# CLI +structopt = "0.3.26" + +# Configuration +divina_config = { path = "../divina_config" } + +# Git +divina_git = { path = "../divina_git" } + +# Environment +dotenv = "0.15.0" + +# Async +tokio = { version = "0.3.7", features = ["full"] } + +# Logging +# flexi_logger = "0.22.3" +# log = "0.4.14" +human-panic = "1.0.3" + +# Compilation +divina_compile = { path = "../divina_compile" } + +[target.'cfg(windows)'.dependencies] +# Allocator +mimalloc = { version = "0.1.26", default-features = false } + +[target.'cfg(unix)'.dependencies] +# Allocator +jemallocator = "0.3.2" diff --git a/crates/divina/src/cli.rs b/crates/divina/src/cli.rs new file mode 100644 index 0000000..6034b38 --- /dev/null +++ b/crates/divina/src/cli.rs @@ -0,0 +1,79 @@ +// Copyright (C) 2022-2022 Fuwn <[email protected]> +// SPDX-License-Identifier: GPL-3.0-only + +use structopt::clap::{App, AppSettings, Arg, SubCommand}; + +/// Create CLI +fn cli() -> App<'static, 'static> { + App::new(env!("CARGO_PKG_NAME")) + .about(env!("CARGO_PKG_DESCRIPTION")) + .version(env!("CARGO_PKG_VERSION")) + .author(env!("CARGO_PKG_AUTHORS")) + .setting(AppSettings::SubcommandRequiredElseHelp) + .subcommands(vec![ + SubCommand::with_name("init").about("").args(&[ + Arg::with_name("type") + .long("type") + .takes_value(true) + .possible_values(&["bin", "lib"]), + Arg::with_name("git").long("git").takes_value(true), + Arg::with_name("path") + .required(true) + .index(1) + .takes_value(true), + ]), + SubCommand::with_name("build").about("Build your project"), + SubCommand::with_name("clean") + .about("Cleanup Divina's non-essential temporary files and directories"), + SubCommand::with_name("config") + .about("") + .setting(AppSettings::SubcommandRequiredElseHelp) + .subcommands(vec![ + SubCommand::with_name("show").about("Print your configuration"), + SubCommand::with_name("validate").about("Check if your configuration will compile"), + ]), + ]) + .args(&[ + Arg::with_name("debug").short("d").long("debug"), + Arg::with_name("trace").short("t").long("trace"), + ]) +} + +/// Execute CLI +pub fn execute(divina: &mut crate::Divina) { + let matches = cli().get_matches(); + + match matches.subcommand() { + ("init", Some(s_matches)) => { + let repository = s_matches + .value_of("git") + .unwrap_or("https://github.com/divinaland/init.git"); + let path = s_matches.value_of("path").unwrap_or_else(|| unreachable!()); + + divina_git::clone(repository, &format!("./{}", path)) + .expect("!! could to clone init repository, perhaps the repository is invalid ?"); + } + ("build", Some(_s_matches)) => { + divina + .compiler + .find_sources(&divina.expose_config().clone()) + .compile() + .link(); + } + ("clean", Some(_s_matches)) => + if std::path::Path::new("out/").exists() { + println!(":: removing directory 'out/'"); + std::fs::remove_dir_all("out/") + .expect("!! could not remove directory 'out/', check permissions"); + } else { + println!(":: directory 'out/' does not exist"); + }, + ("config", Some(s_matches)) => + match s_matches.subcommand() { + ("show", _) => divina.print_config(), + ("validate", _) => println!(":: no issues found"), + _ => unreachable!(), + }, + _ => unreachable!(), + } +} diff --git a/crates/divina/src/lib.rs b/crates/divina/src/lib.rs new file mode 100644 index 0000000..675efd2 --- /dev/null +++ b/crates/divina/src/lib.rs @@ -0,0 +1,75 @@ +// Copyright (C) 2022-2022 Fuwn <[email protected]> +// SPDX-License-Identifier: GPL-3.0-only + +#![deny( + warnings, + nonstandard_style, + unused, + future_incompatible, + rust_2018_idioms, + unsafe_code +)] +#![deny(clippy::all, clippy::nursery, clippy::pedantic)] +#![recursion_limit = "128"] +#![doc( + html_logo_url = "https://emojipedia-us.s3.dualstack.us-west-1.amazonaws.com/thumbs/160/twitter/282/ribbon_1f380.png", + html_favicon_url = "https://emojipedia-us.s3.dualstack.us-west-1.amazonaws.com/thumbs/160/twitter/282/ribbon_1f380.png" +)] + +// #[macro_use] +// extern crate log; + +#[cfg(windows)] +#[global_allocator] +static GLOBAL: mimalloc::MiMalloc = mimalloc::MiMalloc; + +#[cfg(unix)] +#[global_allocator] +static GLOBAL: jemallocator::Jemalloc = jemallocator::Jemalloc; + +mod cli; + +use divina_compile::Compiler; +use divina_config::Config; + +#[derive(Default)] +pub struct Divina { + config: Config, + compiler: Compiler, +} +impl Divina { + #[must_use] + pub fn new() -> Self { Self::default() } + + pub fn perform(&mut self) { crate::cli::execute(self); } + + /// Prepare `self.config` for configuration + pub fn new_config(&mut self) -> &mut Self { + self.config = Config::new(); + self + } + + /// Configure `self.config` + pub fn configure_config(&mut self) { self.config.configure("Divina.lua"); } + + /// Print `self.config` + pub fn print_config(&self) { + println!("{:?}", self.config); + } + + #[must_use] + pub const fn expose_config(&self) -> &Config { &self.config } + + pub fn configure_compiler(&mut self, compiler: Compiler) { self.compiler = compiler; } +} + +/// Preliminary setup +pub fn setup() { + dotenv::dotenv().ok(); + human_panic::setup_panic!(Metadata { + version: env!("CARGO_PKG_VERSION"), + name: env!("CARGO_PKG_NAME"), + authors: env!("CARGO_PKG_AUTHORS"), + homepage: env!("CARGO_PKG_HOMEPAGE"), + }); +} diff --git a/crates/divina/src/main.rs b/crates/divina/src/main.rs new file mode 100644 index 0000000..dc7e17e --- /dev/null +++ b/crates/divina/src/main.rs @@ -0,0 +1,22 @@ +// Copyright (C) 2022-2022 Fuwn <[email protected]> +// SPDX-License-Identifier: GPL-3.0-only + +use divina::Divina; + +#[tokio::main] +async fn main() { + // Preliminary pokes + divina::setup(); + + let mut divina = Divina::new(); + // Store 'Divina.lua' configuration + divina.new_config().configure_config(); + // Create a new compiler + divina.configure_compiler(divina_compile::Compiler::new()); + // Handle CLI + divina.perform(); + + // Process doesn't exit on Unix properly, this solves it... + #[cfg(unix)] + std::process::exit(0); +} diff --git a/crates/divina_compile/Cargo.toml b/crates/divina_compile/Cargo.toml new file mode 100644 index 0000000..f46d27d --- /dev/null +++ b/crates/divina_compile/Cargo.toml @@ -0,0 +1,20 @@ +[package] +name = "divina_compile" +version = "0.1.0" +authors = ["Fuwn <[email protected]>"] +edition = "2021" +description = "Divina's compiler wrapper" +readme = "README.rst" +homepage = "https://divina.land" +repository = "https://github.com/divinaland/Divina" +license = "GPL-3.0-only" +keywords = ["divina", "buildsystem", "build", "assembly", "asm", "nasm", "yasm"] +categories = ["development-tools::build-utils"] +publish = false + +[dependencies] +# Configuration +divina_config = { path = "../divina_config" } + +# Command-line +shellfn = "0.1.1" diff --git a/crates/divina_compile/src/lib.rs b/crates/divina_compile/src/lib.rs new file mode 100644 index 0000000..ec37f6d --- /dev/null +++ b/crates/divina_compile/src/lib.rs @@ -0,0 +1,307 @@ +// Copyright (C) 2022-2022 Fuwn <[email protected]> +// SPDX-License-Identifier: GPL-3.0-only + +#![feature(stmt_expr_attributes)] +#![deny( + warnings, + nonstandard_style, + unused, + future_incompatible, + rust_2018_idioms, + unsafe_code +)] +#![deny(clippy::all, clippy::nursery, clippy::pedantic)] +#![recursion_limit = "128"] +#![doc( + html_logo_url = "https://emojipedia-us.s3.dualstack.us-west-1.amazonaws.com/thumbs/160/twitter/282/ribbon_1f380.png", + html_favicon_url = "https://emojipedia-us.s3.dualstack.us-west-1.amazonaws.com/thumbs/160/twitter/282/ribbon_1f380.png" +)] + +use std::{fs, process::Command}; + +use divina_config::Arch; + +#[derive(Debug)] +struct Source { + filename: String, + path: String, +} + +#[derive(Debug)] +struct Package { + name: String, + sources: Vec<Source>, + arch: Arch, + compiler: String, +} + +#[derive(Default, Debug)] +pub struct Compiler { + sources: Vec<Package>, +} +impl Compiler { + #[must_use] + pub fn new() -> Self { Self::default() } + + pub fn find_sources(&mut self, config: &divina_config::Config) -> &Self { + if config.config_type == divina_config::ConfigType::Workspace { + for member in config.members.as_ref().expect( + "!! could not access 'Config.members' from `workspace`, this *shouldn't* be possible", + ) { + let mut package = Package { + name: member.name.clone().expect( + "!! could not access `Config.?.name` from `workspace`, this *shouldn't* be possible", + ), + sources: Vec::new(), + arch: member + .arch + .clone() + .expect("!! could not access 'Config.members.?.arch', this *shouldn't* be possible"), + compiler: member + .compiler + .clone() + .unwrap_or_else(|| "yasm".to_string()), + }; + + member + .sources + .as_ref() + .expect( + "!! could not access 'Config.sources' from 'workspace.members', this *shouldn't* be \ + possible", + ) + .iter() + .for_each(|source| { + if !source.is_empty() { + package.sources.push(Source { + path: format!( + "{}/{}", + member.path.as_ref().expect( + "!! could not access 'Config.members.?.path', this *shouldn't* be possible" + ), + source + ), + filename: { + let mut sources = source.split('.'); + // Remove the file extension + sources.next_back(); + + sources.collect() + }, + }); + } + }); + + self.sources.push(package); + } + } else { + let mut package = Package { + name: config + .name + .clone() + .expect("!! could not access `Config.name` from `Package`, this *shouldn't* be possible"), + sources: Vec::new(), + arch: config + .arch + .clone() + .expect("!! could not access 'Config.arch', this *shouldn't* be possible"), + compiler: if config.compiler.is_some() { + config + .compiler + .clone() + .expect("!! could not access 'Config.compiler', this *shouldn't be possible") + } else { + "yasm".to_string() + }, + }; + + config + .sources + .as_ref() + .expect("!! could not access 'Config.sources' from 'Package', this *shouldn't* be possible") + .iter() + .for_each(|source| { + if !source.is_empty() { + package.sources.push(Source { + path: format!( + "{}/{}", + config + .path + .as_ref() + .expect("!! could not access 'Config.path', this *shouldn't* be possible"), + source + ), + filename: { + let mut sources = source.split('.'); + // Remove the file extension + sources.next_back(); + + sources.collect() + }, + }); + } + }); + + self.sources.push(package); + } + + self + } + + /// # Panics + /// if caller has insufficient permissions to create a directory + #[must_use] + pub fn compile(&self) -> &Self { + if !std::path::Path::new("out/").exists() { + println!(":: creating directory 'out/'"); + fs::create_dir_all("out/").expect("!! could not create directory 'out/', check permissions"); + } + + for package in &self.sources { + if !std::path::Path::new(&format!("out/{}/", package.name)).exists() { + println!( + ":: {} @@ creating directory 'out/{}/'", + package.name, package.name + ); + fs::create_dir_all(&format!("out/{}/", package.name)).unwrap_or_else(|_| { + panic!( + "!! could not create directory 'out/{}/', check permissions", + package.name + ) + }); + } + + for source in &package.sources { + println!( + ":: {} @@ {} ?? compiling source '{}'", + package.name, package.compiler, source.path + ); + + #[cfg(unix)] + Command::new(&package.compiler) + .args([ + "-f", + if package.arch == Arch::X86 { + "elf32" + } else { + "elf64" + }, + &source.path, + "-o", + &format!("out/{}/{}.o", package.name, source.filename), + ]) + .output() + .expect(&format!( + "!! failed to call command `{}` in `Compiler.compile`", + package.compiler + )); + + #[cfg(windows)] + Command::new(&package.compiler) + .args([ + "-f", + if package.arch == Arch::X86 { + "win32" + } else { + "win64" + }, + &source.path, + "-o", + &format!("out/{}/{}.obj", package.name, source.filename), + ]) + .output() + .unwrap_or_else(|_| { + panic!( + "!! failed to call command `{}` in `Compiler.compile`", + package.compiler + ) + }); + } + } + + self + } + + /// # Panics + /// if Visual Studio 2019 is not installed + pub fn link(&self) { + for package in &self.sources { + let mut filenames = Vec::new(); + #[allow(unused)] + let mut arch = &Arch::X86; + + for source in &package.sources { + filenames.push(format!("out/{}/{}.{}", package.name, source.filename, { + if cfg!(windows) { + "obj" + } else { + "o" + } + })); + + #[allow(unused)] + arch = &package.arch; + } + + #[cfg(unix)] + { + println!( + ":: {} @@ linking sources: '{}'", + package.name, + filenames.join("', '") + ); + + Command::new("ld") + .args([ + "-dynamic-linker", + "/lib64/ld-linux-x86-64.so.2", + "-lc", + "-o", + &format!("out/{}/{}", package.name, package.name), + ]) + .args(filenames.iter()) + .output() + .expect("!! failed to call command `ld` in `Compiler.link`"); + } + + #[cfg(windows)] + { + println!( + ":: {} @@ entering visual studio 2019 developer command prompt environment", + package.name + ); + println!( + ":: {} @@ linking sources: '{}'", + package.name, + filenames.join("', '") + ); + if arch == &Arch::X64 { + windows::link_64(&filenames.join(" "), &package.name); + } else { + windows::link_32(&filenames.join(" "), &package.name); + } + } + } + } +} + +#[cfg(windows)] +#[rustfmt::skip] // Preserve raw string literal positions +mod windows { + /// Thank lord for the [shellfn](https://github.com/synek317/shellfn) crate... + /// + /// I unironically spent **SIX** hours -- give or take a few minutes... -- + /// trying to get the Windows linker working. After searching far and wide, + /// the shellfn crate happened to come up in my search results after a + /// random search, and it worked! + /// + /// Thanks, shellfn. + #[shellfn::shell(cmd = "powershell")] + pub fn link_32(objects: &str, filename: &str) -> String { r#" + "link /subsystem:console /out:out/$FILENAME/$FILENAME.exe $OBJECTS kernel32.lib msvcrt.lib legacy_stdio_definitions.lib" | cmd /k "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars32.bat" + "# } + #[shellfn::shell(cmd = "powershell")] + pub fn link_64(objects: &str, filename: &str) -> String { r#" + "link /subsystem:console /out:out/$FILENAME/$FILENAME.exe $OBJECTS kernel32.lib msvcrt.lib legacy_stdio_definitions.lib" | cmd /k "C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\VC\Auxiliary\Build\vcvars64.bat" + "# } +} diff --git a/crates/divina_config/Cargo.toml b/crates/divina_config/Cargo.toml new file mode 100644 index 0000000..d232d68 --- /dev/null +++ b/crates/divina_config/Cargo.toml @@ -0,0 +1,17 @@ +[package] +name = "divina_config" +version = "0.1.0" +authors = ["Fuwn <[email protected]>"] +edition = "2021" +description = "Divina's configuration system" +readme = "README.rst" +homepage = "https://divina.land" +repository = "https://github.com/divinaland/Divina" +license = "GPL-3.0-only" +keywords = ["divina", "buildsystem", "build", "assembly", "asm", "nasm", "yasm"] +categories = ["development-tools::build-utils"] +publish = false + +[dependencies] +# Lua +rlua = "0.19.0" diff --git a/crates/divina_config/src/lib.rs b/crates/divina_config/src/lib.rs new file mode 100644 index 0000000..1df8ddb --- /dev/null +++ b/crates/divina_config/src/lib.rs @@ -0,0 +1,424 @@ +// Copyright (C) 2022-2022 Fuwn <[email protected]> +// SPDX-License-Identifier: GPL-3.0-only + +#![deny( + warnings, + nonstandard_style, + unused, + future_incompatible, + rust_2018_idioms, + unsafe_code +)] +#![deny(clippy::all, clippy::nursery, clippy::pedantic)] +#![recursion_limit = "128"] +#![doc( + html_logo_url = "https://emojipedia-us.s3.dualstack.us-west-1.amazonaws.com/thumbs/160/twitter/282/ribbon_1f380.png", + html_favicon_url = "https://emojipedia-us.s3.dualstack.us-west-1.amazonaws.com/thumbs/160/twitter/282/ribbon_1f380.png" +)] + +use std::{fmt, fmt::Formatter, io::Read}; + +use rlua::{Lua, Table}; + +const VERSION: &str = env!("CARGO_PKG_VERSION"); + +#[allow(unused)] +#[derive(PartialEq)] +enum GetRequired { + Yes, + No, +} + +/// Get and store a variable from Lua context, if it doesn't exist; `None`. +/// +/// With help from: +/// +/// - <https://users.rust-lang.org/t/how-to-use-self-or-any-variable-in-macro-generated-function-body/6264> +/// - <https://github.com/steveklabnik/trpl/blob/master/advanced-macros.md> +/// - <https://www.reddit.com/r/rust/comments/iim7b7/how_to_identify_rust_tyttident_expr_patassociated/> +/// - <https://medium.com/@phoomparin/a-beginners-guide-to-rust-macros-5c75594498f1> +#[macro_export] +macro_rules! get_or_none { + ($table:ident, $key:expr, $key_type:ty, $assign_to:tt, $required:expr) => { + $assign_to = if $required == GetRequired::No { + match $table.get::<_, $key_type>($key) { + Ok(some_value) => Some(some_value), + Err(_) => None, + } + } else { + Some($table.get::<_, $key_type>($key).expect(&format!( + "could not access required global `{}`, perhaps you've forgotten to define it ?", + $key, + ))) + } + }; + ($table:ident, $from_table:expr, $key:expr, $key_type:ty, $assign_to:tt, $required:expr) => { + $assign_to = if $required == GetRequired::No { + match $table.get::<_, $key_type>($key) { + Ok(some_value) => Some(some_value), + Err(_) => None, + } + } else { + Some($table.get::<_, $key_type>($key).expect(&format!( + "could not access required global `{}.{}`, perhaps you've forgotten to define it ?", + $from_table, $key, + ))) + } + }; +} +#[macro_export] +macro_rules! get_table { + ($assign_to:ident, $key:expr, $globals:ident) => { + let $assign_to = $globals.get::<_, Table<'_>>($key).expect(&format!( + "could not get `{}`, perhaps you've made an error ?", + $key + )); + }; +} +#[macro_export] +macro_rules! get_enum_or_none { + ($table:ident, $key:expr, $assign_to:tt, $from_u8:tt, $error_message:expr, $required:expr) => { + $assign_to = if $required == GetRequired::No { + match $table.get::<_, u8>($key) { + Ok(some_value) => Some($from_u8(some_value).expect($error_message)), + Err(_) => None, + } + } else { + Some( + $from_u8($table.get::<_, u8>($key).expect(&format!( + "could not access required global `{}`, perhaps you've forgotten to define it ?", + $key, + ))) + .expect($error_message), + ) + } + }; + ( + $table:ident, + $from_table:expr, + $key:expr, + $assign_to:tt, + $from_u8:tt, + $error_message:expr, + $required:expr + ) => { + $assign_to = if $required == GetRequired::No { + match $table.get::<_, u8>($key) { + Ok(some_value) => Some($from_u8(some_value).expect($error_message)), + Err(_) => None, + } + } else { + Some( + $from_u8($table.get::<_, u8>($key).expect(&format!( + "could not access required global `{}.{}`, perhaps you've forgotten to define it ?", + $from_table, $key, + ))) + .expect($error_message), + ) + } + }; +} + +#[derive(Debug, PartialEq, Clone)] +pub enum ConfigType { + Package, + Workspace, +} +impl fmt::Display for ConfigType { + fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result { + // write!(f, "{:?}", self) + fmt::Debug::fmt(self, f) + } +} + +#[derive(Debug, Clone)] +pub enum PackageType { + Bin = 1, + Lib = 2, +} +impl PackageType { + #[must_use] + pub const fn from_u8(n: u8) -> Option<Self> { + match n { + 1 => Some(Self::Bin), + 2 => Some(Self::Lib), + _ => None, + } + } +} + +#[derive(Debug, Clone, PartialEq)] +pub enum Arch { + X86 = 1, + X64 = 2, +} +impl Arch { + #[must_use] + pub const fn from_u8(n: u8) -> Option<Self> { + match n { + 1 => Some(Self::X86), + 2 => Some(Self::X64), + _ => None, + } + } + + #[must_use] + pub fn from_string(arch: &Self) -> String { + match arch { + Arch::X86 => "32".to_string(), + Arch::X64 => "64".to_string(), + } + } +} + +#[derive(Debug, Clone)] +pub struct Config { + pub name: Option<String>, + pub version: Option<String>, + pub description: Option<String>, + pub license: Option<String>, + pub compile_options: Option<Vec<String>>, + pub minimum_divina_version: Option<String>, + pub sources: Option<Vec<String>>, + pub config_type: ConfigType, + pub members: Option<Vec<Self>>, + pub package_type: Option<PackageType>, + pub path: Option<String>, + pub arch: Option<Arch>, + pub compiler: Option<String>, +} +impl Config { + /// Create a new `Config` + #[must_use] + pub fn new() -> Self { Self::default() } + + /// Grab configuration values from `Divina.lua` and set + /// + /// # Panics + /// if there are any errors + #[allow(clippy::too_many_lines)] + pub fn configure(&mut self, file: &str) { + let mut script = std::fs::File::open(file) + .unwrap_or_else(|_| panic!("!! could not locate `{}`, perhaps it doesn't exist ?", file)); + let mut contents = String::new(); + script.read_to_string(&mut contents).unwrap_or_else(|_| { + panic!( + "!! could not read `{}`, perhaps there's an encoding error ?", + file + ) + }); + + let lua = Lua::new(); + + #[allow(clippy::cognitive_complexity)] + lua.context(|ctx| { + let globals = ctx.globals(); + let test_function = ctx + .create_function(|_, ()| { + println!("test"); + + Ok(()) + }) + .expect("!! could not create function `test`, this *shouldn't* be possible"); + + let divina_table = ctx + .create_table() + .expect("!! could not create table `Divina`, this *shouldn't* be possible"); + let type_table = ctx + .create_table() + .expect("!! could not create table `Divina.Type`, this *shouldn't* be possible"); + let arch_table = ctx + .create_table() + .expect("!! could not create table `Divina.Arch`, this *shouldn't* be possible"); + + type_table + .set("Bin", 1) + .expect("!! could not set field `Divina.Type.Bin`, this *shouldn't* be possible"); + type_table + .set("Lib", 2) + .expect("!! could not set field `Divina.Type.Lib`, this *shouldn't* be possible"); + + arch_table + .set("x86", 1) + .expect("!! could not set field `Divina.Type.x86`, this *shouldn't* be possible"); + arch_table + .set("x64", 2) + .expect("!! could not set field `Divina.Type.x64`, this *shouldn't* be possible"); + + divina_table + .set("version", VERSION) + .expect("!! could not set field `Divina.version`, this *shouldn't* be possible"); + divina_table + .set("Type", type_table) + .expect("!! could not set field `Divina.Type`, this *shouldn't* be possible"); + divina_table + .set("Arch", arch_table) + .expect("!! could not set field `Divina.Arch`, this *shouldn't* be possible"); + + globals + .set("Divina", divina_table) + .expect("!! could not set table `Divina`, this *shouldn't* be possible"); + globals + .set("test", test_function) + .expect("!! could not set function `test`, this *shouldn't* be possible"); + + ctx.load(contents.as_bytes()).exec().unwrap_or_else(|_| { + panic!( + "!! could not execute `{}`, perhaps you've made a syntax error ?", + file + ) + }); + + self.config_type = if globals.get::<_, Table<'_>>("Workspace").is_ok() { + ConfigType::Workspace + } else if globals.get::<_, Table<'_>>("Package").is_ok() { + ConfigType::Package + } else { + println!( + "!! '{}' is neither `Workspace` nor `Package`, perhaps you've forgotten to assign to it \ + ?", + file + ); + std::process::exit(0); + }; + + if self.config_type == ConfigType::Package { + get_table!(config_table, "Package", globals); + + get_or_none!( + config_table, + "Package", + "name", + String, + (self.name), + GetRequired::Yes + ); + get_or_none!( + config_table, + "Package", + "version", + String, + (self.version), + GetRequired::Yes + ); + get_or_none!( + config_table, + "Package", + "description", + String, + (self.description), + GetRequired::No + ); + get_or_none!( + config_table, + "Package", + "license", + String, + (self.license), + GetRequired::No + ); + get_or_none!( + config_table, + "Package", + "compile_options", + Vec<String>, + (self.compile_options), + GetRequired::No + ); + get_or_none!( + config_table, + "Package", + "minimum_divina_version", + String, + (self.minimum_divina_version), + GetRequired::Yes + ); + get_or_none!( + config_table, + "Package", + "sources", + Vec<String>, + (self.sources), + GetRequired::No + ); + get_enum_or_none!( + config_table, + "Package", + "type", + (self.package_type), + (PackageType::from_u8), + "!! could not access `Package.type`, perhaps you've forgotten to assign it ?", + GetRequired::Yes + ); + get_enum_or_none!( + config_table, + "Package", + "arch", + (self.arch), + (Arch::from_u8), + "!! could not access `Package.arch`, perhaps you've forgotten to assign it ?", + GetRequired::Yes + ); + get_or_none!( + config_table, + "Package", + "compiler", + String, + (self.compiler), + GetRequired::No + ); + } else { + get_table!(workspace_table, "Workspace", globals); + + // This sequence of BS actually took about two hours to complete. + // + // With help from: + // + // - <https://github.com/amethyst/rlua/issues/57> + let members; + get_or_none!( + workspace_table, + "Workspace", + "members", + Vec<String>, + members, + GetRequired::No + ); + if let Some(tables) = members { + self.members = Some(Vec::new()); + + for path in tables { + let mut config = Self::new(); + config.configure(&format!("{}/Divina.lua", path)); + config.path = Some(path); + + self + .members + .as_mut() + .expect("!! could not access 'Config.members', this *shouldn't* be possible") + .push(config); + } + } + } + }); + } +} +impl Default for Config { + fn default() -> Self { + Self { + name: None, + version: None, + description: None, + license: None, + compile_options: None, + minimum_divina_version: None, + sources: None, + config_type: ConfigType::Package, + members: None, + package_type: None, + path: None, + arch: None, + compiler: None, + } + } +} diff --git a/crates/divina_git/Cargo.toml b/crates/divina_git/Cargo.toml new file mode 100644 index 0000000..3f38318 --- /dev/null +++ b/crates/divina_git/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "divina_git" +version = "0.1.0" +authors = ["Fuwn <[email protected]>"] +edition = "2021" +description = "Divina's Git wrapper" +readme = "../../README.rst" +homepage = "https://divina.land" +repository = "https://github.com/divinaland/Divina" +license = "GPL-3.0-only" +keywords = ["divina", "buildsystem", "build", "assembly", "asm", "nasm", "yasm"] +categories = ["development-tools::build-utils"] +publish = false + +[dependencies] +git2 = "0.13.25" diff --git a/crates/divina_git/src/lib.rs b/crates/divina_git/src/lib.rs new file mode 100644 index 0000000..e73623f --- /dev/null +++ b/crates/divina_git/src/lib.rs @@ -0,0 +1,112 @@ +// Copyright (C) 2022-2022 Fuwn <[email protected]> +// SPDX-License-Identifier: GPL-3.0-only + +//! Much help from: +//! +//! - <https://github.com/rust-lang/git2-rs/blob/master/examples/clone.rs> + +#![deny( + warnings, + nonstandard_style, + unused, + future_incompatible, + rust_2018_idioms, + unsafe_code +)] +#![deny(clippy::all, clippy::nursery, clippy::pedantic)] +#![recursion_limit = "128"] +#![doc( + html_logo_url = "https://emojipedia-us.s3.dualstack.us-west-1.amazonaws.com/thumbs/160/twitter/282/ribbon_1f380.png", + html_favicon_url = "https://emojipedia-us.s3.dualstack.us-west-1.amazonaws.com/thumbs/160/twitter/282/ribbon_1f380.png" +)] + +use std::{io::Write, path}; + +struct State { + progress: Option<git2::Progress<'static>>, + total: usize, + current: usize, + path: Option<path::PathBuf>, + newline: bool, +} + +fn print(state: &mut State) { + let git_stats = state.progress.as_ref().unwrap(); + let network_pct = (100 * git_stats.received_objects()) / git_stats.total_objects(); + let index_pct = (100 * git_stats.indexed_objects()) / git_stats.total_objects(); + let co_pct = if state.total > 0 { + (100 * state.current) / state.total + } else { + 0 + }; + let kbytes = git_stats.received_bytes() / 1024; + if git_stats.received_objects() == git_stats.total_objects() { + if !state.newline { + println!(); + state.newline = true; + } + print!( + "Resolving deltas {}/{}\r", + git_stats.indexed_deltas(), + git_stats.total_deltas() + ); + } else { + print!( + "net {:3}% ({:4} kb, {:5}/{:5}) / idx {:3}% ({:5}/{:5}) / chk {:3}% ({:4}/{:4}) {}\r", + network_pct, + kbytes, + git_stats.received_objects(), + git_stats.total_objects(), + index_pct, + git_stats.indexed_objects(), + git_stats.total_objects(), + co_pct, + state.current, + state.total, + state + .path + .as_ref() + .map(|s| s.to_string_lossy().into_owned()) + .unwrap_or_default() + ); + } + std::io::stdout().flush().unwrap(); +} + +/// # Errors +/// never +pub fn clone(url: &str, path: &str) -> Result<(), git2::Error> { + let state = std::cell::RefCell::new(State { + progress: None, + total: 0, + current: 0, + path: None, + newline: false, + }); + let mut cb = git2::RemoteCallbacks::new(); + cb.transfer_progress(|stats| { + let mut state = state.borrow_mut(); + state.progress = Some(stats.to_owned()); + print(&mut *state); + true + }); + + let mut co = git2::build::CheckoutBuilder::new(); + co.progress(|path, cur, total| { + let mut state = state.borrow_mut(); + state.path = path.map(path::Path::to_path_buf); + state.current = cur; + state.total = total; + print(&mut *state); + }); + + let mut fo = git2::FetchOptions::new(); + fo.remote_callbacks(cb); + git2::build::RepoBuilder::new() + .fetch_options(fo) + .with_checkout(co) + .clone(url, path::Path::new(path))?; + println!(); + + Ok(()) +} diff --git a/examples/greet/Divina.lua b/examples/greet/Divina.lua new file mode 100644 index 0000000..30649ea --- /dev/null +++ b/examples/greet/Divina.lua @@ -0,0 +1,33 @@ +-- This variable is `local`, meaning Divina cannot see it. +-- +--- @type string +local name = "greet-" .. tostring(os.time()) + +-- This variable is **not** `local`, Divina can see it. +-- +--- @class Package +--- @field public name string +--- @field public version string +--- @field public description string +--- @field public compile_options string[] +--- @field public minimum_divina_version string +--- @field public sources string[] +Package = { + name = name, + version = "0.1.0", + description = "Greet me!", + compile_options = {}, + -- The `Divina` table is a special table that you can access anywhere from + -- the `Divina.lua` script. It contains all sorts of important information. + -- + -- Here we are setting our `minimum_divina_version` to `Divina.version`. + minimum_divina_version = Divina.version, + sources = { + "Main.asm", + }, + type = Divina.Type.Bin, + arch = Divina.Arch.x64, +} + +-- http://lua-users.org/wiki/ModulesTutorial +return Package diff --git a/examples/greet/Main.asm b/examples/greet/Main.asm new file mode 100644 index 0000000..ae425ec --- /dev/null +++ b/examples/greet/Main.asm @@ -0,0 +1,17 @@ +global main +extern printf + +section .rodata +msg: db "Hello World!", 13, 10, 0 + +section .text +main: + sub rsp, 8 + sub rsp, 32 + mov rcx, qword msg + call printf + add rsp, 32 + + xor eax, eax + add rsp, 8 + ret diff --git a/examples/greet_from_library/Divina.lua b/examples/greet_from_library/Divina.lua new file mode 100644 index 0000000..3c628dc --- /dev/null +++ b/examples/greet_from_library/Divina.lua @@ -0,0 +1,22 @@ +--- @class Package +--- @field public name string +--- @field public version string +--- @field public description string +--- @field public compile_options string[] +--- @field public minimum_divina_version string +--- @field public sources string[] +Package = { + name = "greet_from_library", + version = "0.1.0", + description = "Greet me... from a library!", + compile_options = {}, + minimum_divina_version = Divina.version, + sources = { + "Main.asm", + "Library.asm", + }, + type = Divina.Type.Bin, + arch = Divina.Arch.x64, +} + +return Package diff --git a/examples/greet_from_library/Library.asm b/examples/greet_from_library/Library.asm new file mode 100644 index 0000000..a23acf3 --- /dev/null +++ b/examples/greet_from_library/Library.asm @@ -0,0 +1,15 @@ +global library_perform +extern printf + +section .rodata +message: db "Hello World!", 13, 10, 0 + +section .text +library_perform: + sub rsp, 8 + sub rsp, 32 + mov rcx, qword message + call printf + add rsp, 32 + + ret diff --git a/examples/greet_from_library/Main.asm b/examples/greet_from_library/Main.asm new file mode 100644 index 0000000..ff66ee3 --- /dev/null +++ b/examples/greet_from_library/Main.asm @@ -0,0 +1,10 @@ +global main +extern library_perform + +section .text +main: + call library_perform + + xor eax, eax + add rsp, 8 + ret diff --git a/examples/just_return/Divina.lua b/examples/just_return/Divina.lua new file mode 100644 index 0000000..3bfd9ab --- /dev/null +++ b/examples/just_return/Divina.lua @@ -0,0 +1,21 @@ +--- @class Package +--- @field public name string +--- @field public version string +--- @field public license string +--- @field public minimum_divina_version string +--- @field public sources string[] +--- @field public compiler string +Package = { + name = "just_return", + version = "0.1.0", + license = "GPL-3.0-only", + minimum_divina_version = Divina.version, + sources = { + "Main.asm", + }, + type = Divina.Type.Bin, + arch = Divina.Arch.x64, + compiler = "nasm", +} + +return Package diff --git a/examples/just_return/Main.asm b/examples/just_return/Main.asm new file mode 100644 index 0000000..f864099 --- /dev/null +++ b/examples/just_return/Main.asm @@ -0,0 +1,7 @@ +global main + +section .text +main: + xor eax, eax + add rsp, 8 + ret diff --git a/rust-toolchain.toml b/rust-toolchain.toml new file mode 100644 index 0000000..09396e5 --- /dev/null +++ b/rust-toolchain.toml @@ -0,0 +1,2 @@ +[toolchain] +channel = "nightly-2021-12-04" diff --git a/rustfmt.toml b/rustfmt.toml new file mode 100644 index 0000000..cdca26c --- /dev/null +++ b/rustfmt.toml @@ -0,0 +1,29 @@ +condense_wildcard_suffixes = true +edition = "2021" +enum_discrim_align_threshold = 20 +# error_on_line_overflow = true +# error_on_unformatted = true +fn_single_line = true +force_multiline_blocks = true +format_code_in_doc_comments = true +format_macro_matchers = true +format_strings = true +imports_layout = "HorizontalVertical" +# license_template_path = ".license_template" +match_arm_blocks = false +imports_granularity = "Crate" +newline_style = "Unix" +normalize_comments = true +normalize_doc_attributes = true +reorder_impl_items = true +group_imports = "StdExternalCrate" +reorder_modules = true +report_fixme = "Always" +# report_todo = "Always" +struct_field_align_threshold = 20 +struct_lit_single_line = false +tab_spaces = 2 +use_field_init_shorthand = true +use_try_shorthand = true +where_single_line = true +wrap_comments = true |