commit 0cea153ff90a0550190c04a0e1dcd21e6fa62892 Author: LordMZTE Date: Fri Dec 16 18:06:06 2022 +0100 feat: initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..509ee3b --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +# Zig +zig-* + +# Packages +deps.zig + +# Gyro +.gyro/ +gyro.lock diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8a389d4 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Boxflow + +Boxflow is a layout engine implementing flexboxes as well as others in Zig. +It aims to be universally usable for applications such as GUIs and window managers. + +# Usage + +To compile Boxflow, you need to use the latest master version of the Zig compiler. +If Boxflow stops compiling on master Zig, please bug me about it. + +If you want to use Boxflow, a good starting point is looking at `src/Box.zig`. It's the main interface of Boxflow. +I hope to document all types extensively. + +# Contributing + +If you would like to fix a bug or improve documentation, you're very welcome to open a PR about that. + +If you'd like to add a feature, please open an issue first, so we can discuss it. + +In case you have any questions, feel free to message me on matrix (@lordmzte:mzte.de), +send me an email (lord@mzte.de) or DM me on discord (LordMZTE#9001) if all else fails. + +Boxflow is licensed under GPL-3 to prevent spread of proprietary garbage. diff --git a/build.zig b/build.zig new file mode 100644 index 0000000..4bb3c58 --- /dev/null +++ b/build.zig @@ -0,0 +1,17 @@ +const std = @import("std"); + +pub fn build(b: *std.build.Builder) void { + // Standard release options allow the person running `zig build` to select + // between Debug, ReleaseSafe, ReleaseFast, and ReleaseSmall. + const mode = b.standardReleaseOptions(); + + const lib = b.addStaticLibrary("boxflow", "src/main.zig"); + lib.setBuildMode(mode); + lib.install(); + + const main_tests = b.addTest("src/main.zig"); + main_tests.setBuildMode(mode); + + const test_step = b.step("test", "Run library tests"); + test_step.dependOn(&main_tests.step); +} diff --git a/src/Box.zig b/src/Box.zig new file mode 100644 index 0000000..4f6bb83 --- /dev/null +++ b/src/Box.zig @@ -0,0 +1,68 @@ +//! This struct is the main attraction of boxflow. +//! +//! A box is simply an element which can be laid out. +//! +//! This type is dynamically dispatched, similarly to `std.mem.Allocator`. +//! For some example implementations, see `LinearBox`. + +const Constraints = @import("Constraints.zig"); +const LayoutCtx = @import("LayoutCtx.zig"); +const Size = @import("Size.zig"); +const Position = @import("Position.zig"); +const BoxData = @import("BoxData.zig"); + +pub const LayoutFn = fn (*anyopaque, *LayoutCtx, Constraints) anyerror!void; +pub const PositionFn = fn (*anyopaque, *LayoutCtx, Position) void; + +ctx: *anyopaque, +data: *BoxData, + +layoutFn: *const LayoutFn, +positionFn: *const PositionFn, + +const Self = @This(); + +/// Creates a new dynamic Box object using the given context. +/// The pointee of `data` will be written to by the layouter in order to position the Box, +/// so ensure that the pointer remains valid until layouting is complete. +/// +/// If your widget is flexible, make sure to always return the minimum size you can. +/// If `flex_expand` is > 0, the parent should increase the minimum size. +pub fn init( + comptime T: type, + ctx: *T, + data: *BoxData, + layoutFn: fn (*T, *LayoutCtx, Constraints) anyerror!void, + positionFn: fn (*T, *LayoutCtx, Position) void, +) Self { + return .{ + .ctx = ctx, + .data = data, + + .layoutFn = @ptrCast(*const LayoutFn, &layoutFn), + .positionFn = @ptrCast(*const PositionFn, &positionFn), + }; +} + +/// Performs the layout of the Box. +/// +/// This function will layout a Box, as well as possible children. +/// If this Box has children, it should not set their positions using `position`, +/// but only store them so they can later be set to absolute positions when `position` is called. +/// +/// After the box has determined its position, it should set the +/// `pos` field of its `BoxData` accordingly. +/// +/// This function may be called multiple times during layouting. +pub fn layout(self: *const Self, ctx: *LayoutCtx, constraints: Constraints) anyerror!void { + return self.layoutFn(self.ctx, ctx, constraints); +} + +/// This is called by the parent after layouting is complete. A Box implementing this +/// should set the position data of its `BoxData` field as well as call `position` on its children, +/// adjusting the position passed to them. +/// +/// This function must only be called once as a final step of layouting. +pub fn position(self: *const Self, ctx: *LayoutCtx, pos: Position) void { + self.positionFn(self.ctx, ctx, pos); +} diff --git a/src/BoxData.zig b/src/BoxData.zig new file mode 100644 index 0000000..15e28ce --- /dev/null +++ b/src/BoxData.zig @@ -0,0 +1,16 @@ +//! This struct represents fields a Box must have. +//! These fields are accessed by parents as well as the user for working with the laid out boxes. + +const Position = @import("Position.zig"); +const Size = @import("Size.zig"); + +pos: Position = .{ .x = 0, .y = 0 }, +size: Size = .{ .width = 0, .height = 0 }, + +/// This is boxflow's equivalent to CSS' `flex-expand`. +/// +/// You might be wondering why there's no `flex-shrink` here. +/// The answer is simply that any widget with flex_expand > 0 must always return its minimum +/// possible size (adhering to constraints). This means that the limit of a box being exceeded +/// is simply an overflow. +flex_expand: usize = 0, diff --git a/src/Constraints.zig b/src/Constraints.zig new file mode 100644 index 0000000..1657ed2 --- /dev/null +++ b/src/Constraints.zig @@ -0,0 +1,46 @@ +//! This struct represents the freedom a Box gets when determining its size. +//! It's passed to a Box by it's parent and is used to set limits to the size it can have. +const std = @import("std"); + +const Size = @import("Size.zig"); + +min: Size, +max: Size, + +const Self = @This(); + +/// Clamps a given size to fit the Constraints +pub fn clamp(self: Self, size: Size) Size { + return .{ + .width = std.math.clamp(size.width, self.min.width, self.max.width), + .height = std.math.clamp(size.height, self.min.height, self.max.height), + }; +} + +/// Asserts that a size is within the constraints. +/// It's good practice to call this on children to verify the value they return from `layout`. +pub fn assertFits(self: Self, size: Size) error{ConstraintViolation}!void { + if (!self.fits(size)) + return error.ConstraintViolation; +} + +/// Checks if a size fits the constraints. +pub fn fits(self: Self, size: Size) bool { + return size.width >= self.min.width and + size.height >= self.min.height and + size.width <= self.max.width and + size.height <= self.max.height; +} + +/// Helper for constructing a tight constraint for a given size. +pub fn tight(size: Size) Self { + return .{ + .min = size, + .max = size, + }; +} + +/// Checks if this is a tight constraint. +pub fn isTight(self: Self) bool { + return std.meta.eql(self.min, self.max); +} diff --git a/src/LayoutCtx.zig b/src/LayoutCtx.zig new file mode 100644 index 0000000..f07d062 --- /dev/null +++ b/src/LayoutCtx.zig @@ -0,0 +1,8 @@ +//! This struct is passed to every box during layouting. It's used to keep track +//! of the current state. + +/// This value is set to true by a box to indicate that an overflow has occured, +/// meaning boxes couldn't be fit into their parents. +/// +/// This is mainly useful for checking if something has gone wrong. +overflow: bool = false, diff --git a/src/Position.zig b/src/Position.zig new file mode 100644 index 0000000..289702b --- /dev/null +++ b/src/Position.zig @@ -0,0 +1,2 @@ +x: usize, +y: usize, diff --git a/src/Root.zig b/src/Root.zig new file mode 100644 index 0000000..c61855f --- /dev/null +++ b/src/Root.zig @@ -0,0 +1,29 @@ +//! The root container of a layout tree. +//! Use this type to layout your boxes. +const std = @import("std"); +const Box = @import("Box.zig"); +const Constraints = @import("Constraints.zig"); +const LayoutCtx = @import("LayoutCtx.zig"); +const Size = @import("Size.zig"); + +root_box: Box, +size: Size, + +const Self = @This(); + +/// Performs the layouting of a box tree. +/// +/// Returns the final layout context. +pub fn layout(self: *Self) !LayoutCtx { + const constraints = Constraints{ + .min = .{ .width = 0, .height = 0 }, + .max = self.size, + }; + + var ctx = LayoutCtx{}; + + try self.root_box.layout(&ctx, constraints); + self.root_box.position(&ctx, .{ .x = 0, .y = 0 }); + + return ctx; +} diff --git a/src/Size.zig b/src/Size.zig new file mode 100644 index 0000000..9706907 --- /dev/null +++ b/src/Size.zig @@ -0,0 +1,2 @@ +width: usize, +height: usize, diff --git a/src/boxes.zig b/src/boxes.zig new file mode 100644 index 0000000..e8ac9b6 --- /dev/null +++ b/src/boxes.zig @@ -0,0 +1,7 @@ +pub const Centered = @import("boxes/Centered.zig"); +pub const Clamped = @import("boxes/Clamped.zig"); +pub const Expanded = @import("boxes/Expanded.zig"); +pub const FixedGrid = @import("boxes/FixedGrid.zig"); +pub const FlowBox = @import("boxes/FlowBox.zig"); +pub const Padding = @import("boxes/Padding.zig"); +pub const Simple = @import("boxes/Simple.zig"); diff --git a/src/boxes/Centered.zig b/src/boxes/Centered.zig new file mode 100644 index 0000000..ca145e0 --- /dev/null +++ b/src/boxes/Centered.zig @@ -0,0 +1,79 @@ +//! This box takes up the space used by it's +//! child and then centers the child inside itself. +//! +//! Note that the makes the child box not respect minimum constraints, +//! as it will be centered if it's smaller. This can break flex layouts. +const std = @import("std"); + +const Box = @import("../Box.zig"); +const BoxData = @import("../BoxData.zig"); +const Clamped = @import("Clamped.zig"); +const Constraints = @import("../Constraints.zig"); +const Expanded = @import("Expanded.zig"); +const LayoutCtx = @import("../LayoutCtx.zig"); +const Position = @import("../Position.zig"); +const Root = @import("../Root.zig"); +const Simple = @import("Simple.zig"); +const Size = @import("../Size.zig"); + +data: BoxData = .{}, +child: Box, + +const Self = @This(); + +fn layout(self: *Self, ctx: *LayoutCtx, cons: Constraints) anyerror!void { + const child_cons = Constraints{ + // we take away the minimum constraint, because it's fine if the child is smaller + .min = .{ .width = 0, .height = 0 }, + .max = cons.max, + }; + + try self.child.layout(ctx, child_cons); + try child_cons.assertFits(self.child.data.size); + + // we try to get as close to the child's size as fits within the constraints + self.data.size = cons.clamp(self.child.data.size); +} + +fn position(self: *Self, ctx: *LayoutCtx, pos: Position) void { + const child_pos = Position{ + .x = pos.x + (self.data.size.width - self.child.data.size.width) / 2, + .y = pos.y + (self.data.size.height - self.child.data.size.height) / 2, + }; + + self.child.position(ctx, child_pos); + + self.data.pos = pos; +} + +pub fn box(self: *Self) Box { + return Box.init(Self, self, &self.data, layout, position); +} + +test "clamped centered box" { + var inner = Simple{}; + var clamped = Clamped{ + .child = inner.box(), + .constraints = .{ + .min = .{ .width = 0, .height = 0 }, + .max = .{ .width = 4, .height = 4 }, + }, + }; + var centered = Self{ .child = clamped.box() }; + + // we need to use an Expanded here so the Centered is bigger than its child. + var expanded = Expanded{ .child = centered.box() }; + + var root = Root{ .root_box = expanded.box(), .size = .{ .width = 8, .height = 8 } }; + const fctx = try root.layout(); + + try std.testing.expect(!fctx.overflow); + + try std.testing.expectEqual( + BoxData{ + .pos = .{ .x = 2, .y = 2 }, + .size = .{ .width = 4, .height = 4 }, + }, + inner.data, + ); +} diff --git a/src/boxes/Clamped.zig b/src/boxes/Clamped.zig new file mode 100644 index 0000000..c827fb1 --- /dev/null +++ b/src/boxes/Clamped.zig @@ -0,0 +1,76 @@ +//! This Box clamps the size of the child to some given constraints +const std = @import("std"); + +const Box = @import("../Box.zig"); +const BoxData = @import("../BoxData.zig"); +const Constraints = @import("../Constraints.zig"); +const LayoutCtx = @import("../LayoutCtx.zig"); +const Position = @import("../Position.zig"); +const Root = @import("../Root.zig"); +const Simple = @import("Simple.zig"); +const Size = @import("../Size.zig"); + +data: BoxData = .{}, +child: Box, +constraints: Constraints, + +const Self = @This(); + +fn layout(self: *Self, ctx: *LayoutCtx, cons: Constraints) anyerror!void { + const child_constraints = Constraints{ + .min = cons.clamp(self.constraints.min), + .max = cons.clamp(self.constraints.max), + }; + + try self.child.layout(ctx, child_constraints); + try child_constraints.assertFits(self.child.data.size); + + self.data.size = self.child.data.size; +} + +fn position(self: *Self, ctx: *LayoutCtx, pos: Position) void { + self.child.position(ctx, pos); + self.data.pos = pos; +} + +pub fn box(self: *Self) Box { + return Box.init(Self, self, &self.data, layout, position); +} + +test "limit size" { + var b = Simple{}; + + var lim = Self{ + .child = b.box(), + .constraints = .{ + .min = .{ .width = 0, .height = 0 }, + .max = .{ .width = 5, .height = 5 }, + }, + }; + + var root = Root{ .root_box = lim.box(), .size = .{ .width = 10, .height = 10 } }; + + const fctx = try root.layout(); + + try std.testing.expect(!fctx.overflow); + try std.testing.expectEqual(Size{ .width = 5, .height = 5 }, b.data.size); +} + +test "useless limit" { + var b = Simple{}; + + var lim = Self{ + .child = b.box(), + .constraints = .{ + .min = .{ .width = 0, .height = 0 }, + .max = .{ .width = 10, .height = 10 }, + }, + }; + + var root = Root{ .root_box = lim.box(), .size = .{ .width = 5, .height = 5 } }; + + const fctx = try root.layout(); + + try std.testing.expect(!fctx.overflow); + try std.testing.expectEqual(Size{ .width = 5, .height = 5 }, b.data.size); +} diff --git a/src/boxes/Expanded.zig b/src/boxes/Expanded.zig new file mode 100644 index 0000000..9d0f25b --- /dev/null +++ b/src/boxes/Expanded.zig @@ -0,0 +1,31 @@ +//! This box forces its child to take up all available space. +const std = @import("std"); + +const Box = @import("../Box.zig"); +const BoxData = @import("../BoxData.zig"); +const Constraints = @import("../Constraints.zig"); +const LayoutCtx = @import("../LayoutCtx.zig"); +const Position = @import("../Position.zig"); +const Size = @import("../Size.zig"); + +data: BoxData = .{}, +child: Box, + +const Self = @This(); + +fn layout(self: *Self, ctx: *LayoutCtx, cons: Constraints) anyerror!void { + const child_cons = Constraints.tight(cons.max); + try self.child.layout(ctx, child_cons); + try child_cons.assertFits(self.child.data.size); + + self.data.size = cons.max; +} + +fn position(self: *Self, ctx: *LayoutCtx, pos: Position) void { + self.child.position(ctx, pos); + self.data.pos = pos; +} + +pub fn box(self: *Self) Box { + return Box.init(Self, self, &self.data, layout, position); +} diff --git a/src/boxes/FixedGrid.zig b/src/boxes/FixedGrid.zig new file mode 100644 index 0000000..3809b31 --- /dev/null +++ b/src/boxes/FixedGrid.zig @@ -0,0 +1,116 @@ +//! A Box that lays its children out in a given amount of rows and columns, +//! each with the same size. +//! +//! This Box always uses all available space. +const std = @import("std"); + +const Box = @import("../Box.zig"); +const BoxData = @import("../BoxData.zig"); +const Constraints = @import("../Constraints.zig"); +const LayoutCtx = @import("../LayoutCtx.zig"); +const Position = @import("../Position.zig"); +const Root = @import("../Root.zig"); +const Size = @import("../Size.zig"); +const Simple = @import("Simple.zig"); + +data: BoxData = .{}, + +/// The amount of columns this grid will have. +/// The caller asserts that this is nonzero. +cols: usize, + +/// The children of this grid, in reading order. +/// The caller asserts that `children.len % cols == 0`. +children: []const Box, + +const Self = @This(); + +fn layout(self: *Self, ctx: *LayoutCtx, cons: Constraints) anyerror!void { + const rows = @divExact(self.children.len, self.cols); + + const col_width = cons.max.width / self.cols; + const row_height = cons.max.height / rows; + + const child_cons = Constraints.tight(.{ + .width = col_width, + .height = row_height, + }); + + for (self.children) |child| { + try child.layout(ctx, child_cons); + try child_cons.assertFits(child.data.size); + } + + self.data.size = cons.max; +} + +fn position(self: *Self, ctx: *LayoutCtx, pos: Position) void { + const rows = @divExact(self.children.len, self.cols); + + const col_width = self.data.size.width / self.cols; + const row_height = self.data.size.height / rows; + + for (self.children) |child, i| { + const x = (i % self.cols) * col_width; + const y = @divFloor(i, rows) * row_height; + + child.position(ctx, .{ .x = x, .y = y }); + } + + self.data.pos = pos; +} + +pub fn box(self: *Self) Box { + return Box.init(Self, self, &self.data, layout, position); +} + +test "2x2 simple grid" { + var inners = [1]Simple{.{}} ** 4; + var grid = Self{ + .cols = 2, + .children = &.{ + inners[0].box(), + inners[1].box(), + inners[2].box(), + inners[3].box(), + }, + }; + + var root = Root{ + .root_box = grid.box(), + .size = .{ .width = 10, .height = 10 }, + }; + + const fctx = try root.layout(); + + try std.testing.expect(!fctx.overflow); + + try std.testing.expectEqual( + BoxData{ + .pos = .{ .x = 0, .y = 0 }, + .size = .{ .width = 5, .height = 5 }, + }, + inners[0].data, + ); + try std.testing.expectEqual( + BoxData{ + .pos = .{ .x = 5, .y = 0 }, + .size = .{ .width = 5, .height = 5 }, + }, + inners[1].data, + ); + try std.testing.expectEqual( + BoxData{ + .pos = .{ .x = 0, .y = 5 }, + .size = .{ .width = 5, .height = 5 }, + }, + inners[2].data, + ); + try std.testing.expectEqual( + BoxData{ + .pos = .{ .x = 5, .y = 5 }, + .size = .{ .width = 5, .height = 5 }, + }, + inners[3].data, + ); +} diff --git a/src/boxes/FlowBox.zig b/src/boxes/FlowBox.zig new file mode 100644 index 0000000..386004f --- /dev/null +++ b/src/boxes/FlowBox.zig @@ -0,0 +1,400 @@ +//! This is the main layout box of boxflow. It can arrange Boxes in either a row or a column, +//! taking into account their flex options. +const std = @import("std"); + +const Box = @import("../Box.zig"); +const BoxData = @import("../BoxData.zig"); +const Clamped = @import("Clamped.zig"); +const Constraints = @import("../Constraints.zig"); +const LayoutCtx = @import("../LayoutCtx.zig"); +const Position = @import("../Position.zig"); +const Root = @import("../Root.zig"); +const Simple = @import("Simple.zig"); +const Size = @import("../Size.zig"); + +pub const Direction = enum { + vertical, + horizontal, +}; + +data: BoxData = .{}, +children: []const Box, +direction: Direction, +alloc: std.mem.Allocator, + +// An array containing the offsets of the children. +// This is used by `position` to determine the positions of children. +child_offsets: []usize, + +const Self = @This(); + +pub fn init(alloc: std.mem.Allocator, direction: Direction, children: []const Box) !Self { + var self = .{ + .children = children, + .direction = direction, + .alloc = alloc, + + .child_offsets = try alloc.alloc(usize, children.len), + }; + + std.mem.set(usize, self.child_offsets, 0); + + return self; +} + +pub fn deinit(self: *Self) void { + self.alloc.free(self.child_offsets); + self.* = undefined; +} + +fn layout(self: *Self, ctx: *LayoutCtx, cons: Constraints) anyerror!void { + // TODO: implement horizontal FlowBox + + switch (self.direction) { + .vertical => { + // the maximum width of the children + var max_width: usize = 0; + + var cur_pos: usize = 0; + // first pass, setting initial sizes + { + for (self.children) |child| { + var child_cons = cons; + child_cons.max.height -|= cur_pos; + child_cons.min.height -|= cur_pos; + + try child.layout(ctx, child_cons); + try child_cons.assertFits(child.data.size); + + cur_pos += child.data.size.height; + + if (max_width < child.data.size.width) { + max_width = child.data.size.width; + } + } + } + + // second pass, evaluating flex boxes + { + const remaining_space = cons.max.height - cur_pos; + cur_pos = 0; + + // the amount of extra space that will be added to the flex boxes + const flex_extra_space = try self.alloc.alloc(?f64, self.children.len); + defer self.alloc.free(flex_extra_space); + std.mem.set(?f64, flex_extra_space, null); + + var flex_sum: f64 = 0; + for (self.children) |child| { + flex_sum += @intToFloat(f64, child.data.flex_expand); + } + + // set the extra space to the part of remaining space the boxes will get + for (flex_extra_space) |*fes, i| { + if (self.children[i].data.flex_expand > 0) { + fes.* = @intToFloat(f64, self.children[i].data.flex_expand) / flex_sum; + } + } + + // set the extra space of the widgets to the actual absolute amount of space + for (flex_extra_space) |*espace| { + if (espace.*) |*fes| { + fes.* *= @intToFloat(f64, remaining_space); + } + } + + // re-layout the flex children with tight constraints + for (self.children) |*child, i| { + if (flex_extra_space[i]) |fes| { + const child_height = @floatToInt(usize, fes) + child.data.size.height; + const child_cons = Constraints.tight(.{ + .width = child.data.size.width, + .height = child_height, + }); + + try child.layout(ctx, child_cons); + try child_cons.assertFits(child.data.size); + } + + self.child_offsets[i] = cur_pos; + + cur_pos += child.data.size.height; + } + } + + self.data.size = .{ + .height = cur_pos, + .width = max_width, + }; + }, + // TODO: deduplicate this + .horizontal => { + // the maximum height of the children + var max_height: usize = 0; + + var cur_pos: usize = 0; + // first pass, setting initial sizes + { + for (self.children) |child| { + var child_cons = cons; + child_cons.max.width -|= cur_pos; + child_cons.min.width -|= cur_pos; + + try child.layout(ctx, child_cons); + try child_cons.assertFits(child.data.size); + + cur_pos += child.data.size.width; + + if (max_height < child.data.size.height) { + max_height = child.data.size.height; + } + } + } + + // second pass, evaluating flex boxes + { + const remaining_space = cons.max.width - cur_pos; + cur_pos = 0; + + // the amount of extra space that will be added to the flex boxes + const flex_extra_space = try self.alloc.alloc(?f64, self.children.len); + defer self.alloc.free(flex_extra_space); + std.mem.set(?f64, flex_extra_space, null); + + var flex_sum: f64 = 0; + for (self.children) |child| { + flex_sum += @intToFloat(f64, child.data.flex_expand); + } + + // set the extra space to the part of remaining space the boxes will get + for (flex_extra_space) |*fes, i| { + if (self.children[i].data.flex_expand > 0) { + fes.* = @intToFloat(f64, self.children[i].data.flex_expand) / flex_sum; + } + } + + // set the extra space of the widgets to the actual absolute amount of space + for (flex_extra_space) |*espace| { + if (espace.*) |*fes| { + fes.* *= @intToFloat(f64, remaining_space); + } + } + + // re-layout the flex children with tight constraints + for (self.children) |*child, i| { + if (flex_extra_space[i]) |fes| { + const child_width = @floatToInt(usize, fes) + child.data.size.width; + const child_cons = Constraints.tight(.{ + .width = child_width, + .height = child.data.size.height, + }); + + try child.layout(ctx, child_cons); + try child_cons.assertFits(child.data.size); + } + + self.child_offsets[i] = cur_pos; + + cur_pos += child.data.size.width; + } + } + + self.data.size = .{ + .height = max_height, + .width = cur_pos, + }; + }, + } +} + +fn position(self: *Self, ctx: *LayoutCtx, pos: Position) void { + for (self.children) |child, i| { + const child_pos = switch (self.direction) { + .vertical => .{ .x = pos.x, .y = pos.y + self.child_offsets[i] }, + .horizontal => .{ .x = pos.x + self.child_offsets[i], .y = pos.y }, + }; + child.position(ctx, child_pos); + } + self.data.pos = pos; +} + +pub fn box(self: *Self) Box { + return Box.init(Self, self, &self.data, layout, position); +} + +test "2 vertical boxes with fixed size" { + var box_1 = Simple{}; + var box_2 = Simple{}; + + const clamp_cons = Constraints{ + .min = .{ .width = 0, .height = 0 }, + .max = .{ .width = 5, .height = 5 }, + }; + + var clamp_1 = Clamped{ .child = box_1.box(), .constraints = clamp_cons }; + var clamp_2 = Clamped{ .child = box_2.box(), .constraints = clamp_cons }; + + var fbox = try Self.init( + std.testing.allocator, + .vertical, + &.{ clamp_1.box(), clamp_2.box() }, + ); + defer fbox.deinit(); + + var root = Root{ .root_box = fbox.box(), .size = .{ .width = 10, .height = 20 } }; + const fctx = try root.layout(); + + try std.testing.expect(!fctx.overflow); + + try std.testing.expectEqual( + Size{ .width = 5, .height = 10 }, + fbox.data.size, + ); + + try std.testing.expectEqual( + BoxData{ .size = .{ .width = 5, .height = 5 } }, + box_1.data, + ); + + try std.testing.expectEqual( + BoxData{ + .pos = .{ .x = 0, .y = 5 }, + .size = .{ .width = 5, .height = 5 }, + }, + box_2.data, + ); +} + +test "2 horizontal boxes with fixed size" { + var box_1 = Simple{}; + var box_2 = Simple{}; + + const clamp_cons = Constraints{ + .min = .{ .width = 0, .height = 0 }, + .max = .{ .width = 5, .height = 5 }, + }; + + var clamp_1 = Clamped{ .child = box_1.box(), .constraints = clamp_cons }; + var clamp_2 = Clamped{ .child = box_2.box(), .constraints = clamp_cons }; + + var fbox = try Self.init( + std.testing.allocator, + .horizontal, + &.{ clamp_1.box(), clamp_2.box() }, + ); + defer fbox.deinit(); + + var root = Root{ .root_box = fbox.box(), .size = .{ .width = 20, .height = 10 } }; + const fctx = try root.layout(); + + try std.testing.expect(!fctx.overflow); + + try std.testing.expectEqual( + Size{ .width = 10, .height = 5 }, + fbox.data.size, + ); + + try std.testing.expectEqual( + BoxData{ .size = .{ .width = 5, .height = 5 } }, + box_1.data, + ); + + try std.testing.expectEqual( + BoxData{ + .pos = .{ .x = 5, .y = 0 }, + .size = .{ .width = 5, .height = 5 }, + }, + box_2.data, + ); +} + +test "2 vertical boxes with equal flex" { + var box_1 = Simple{}; + var box_2 = Simple{}; + + const clamp_cons = Constraints{ + .min = .{ .width = 0, .height = 0 }, + .max = .{ .width = 5, .height = 1 }, + }; + + var clamp_1 = Clamped{ .child = box_1.box(), .constraints = clamp_cons }; + var clamp_2 = Clamped{ .child = box_2.box(), .constraints = clamp_cons }; + + clamp_1.data.flex_expand = 1; + clamp_2.data.flex_expand = 1; + + var fbox = try Self.init( + std.testing.allocator, + .vertical, + &.{ clamp_1.box(), clamp_2.box() }, + ); + defer fbox.deinit(); + + var root = Root{ .root_box = fbox.box(), .size = .{ .width = 10, .height = 10 } }; + const fctx = try root.layout(); + + try std.testing.expect(!fctx.overflow); + + try std.testing.expectEqual( + Size{ .width = 5, .height = 10 }, + fbox.data.size, + ); + + try std.testing.expectEqual( + BoxData{ .size = .{ .width = 5, .height = 5 } }, + box_1.data, + ); + + try std.testing.expectEqual( + BoxData{ + .pos = .{ .x = 0, .y = 5 }, + .size = .{ .width = 5, .height = 5 }, + }, + box_2.data, + ); +} + +test "flex and fixed combo" { + var box_1 = Simple{}; + var box_2 = Simple{}; + + const clamp_cons = Constraints{ + .min = .{ .width = 0, .height = 0 }, + .max = .{ .width = 5, .height = 1 }, + }; + + var clamp_1 = Clamped{ .child = box_1.box(), .constraints = clamp_cons }; + var clamp_2 = Clamped{ .child = box_2.box(), .constraints = clamp_cons }; + + clamp_1.data.flex_expand = 1; + + var fbox = try Self.init( + std.testing.allocator, + .vertical, + &.{ clamp_1.box(), clamp_2.box() }, + ); + defer fbox.deinit(); + + var root = Root{ .root_box = fbox.box(), .size = .{ .width = 10, .height = 10 } }; + const fctx = try root.layout(); + + try std.testing.expect(!fctx.overflow); + + try std.testing.expectEqual( + Size{ .width = 5, .height = 10 }, + fbox.data.size, + ); + + try std.testing.expectEqual( + BoxData{ .size = .{ .width = 5, .height = 9 } }, + box_1.data, + ); + + try std.testing.expectEqual( + BoxData{ + .pos = .{ .x = 0, .y = 9 }, + .size = .{ .width = 5, .height = 1 }, + }, + box_2.data, + ); +} diff --git a/src/boxes/Padding.zig b/src/boxes/Padding.zig new file mode 100644 index 0000000..18765ed --- /dev/null +++ b/src/boxes/Padding.zig @@ -0,0 +1,76 @@ +//! This box adds n pixels of padding around all sides of a child box. +const std = @import("std"); + +const Box = @import("../Box.zig"); +const BoxData = @import("../BoxData.zig"); +const Constraints = @import("../Constraints.zig"); +const LayoutCtx = @import("../LayoutCtx.zig"); +const Position = @import("../Position.zig"); +const Root = @import("../Root.zig"); +const Simple = @import("Simple.zig"); +const Size = @import("../Size.zig"); + +data: BoxData = .{}, +child: Box, +padding: usize, + +const Self = @This(); + +fn layout(self: *Self, ctx: *LayoutCtx, cons: Constraints) anyerror!void { + if (cons.max.width <= self.padding * 2 or cons.max.height <= self.padding * 2) { + ctx.overflow = true; + return; + } + + const child_cons = Constraints{ + .min = cons.min, + .max = .{ + .width = cons.max.width - self.padding * 2, + .height = cons.max.height - self.padding * 2, + }, + }; + try self.child.layout(ctx, child_cons); + try child_cons.assertFits(self.child.data.size); + + self.data.size = .{ + .width = self.child.data.size.width + self.padding * 2, + .height = self.child.data.size.height + self.padding * 2, + }; +} + +fn position(self: *Self, ctx: *LayoutCtx, pos: Position) void { + self.data.pos = pos; + self.child.position(ctx, .{ .x = pos.x + self.padding, .y = pos.y + self.padding }); +} + +pub fn box(self: *Self) Box { + return Box.init(Self, self, &self.data, layout, position); +} + +test "simple layout" { + var sbox = Simple{}; + + var padded = Self{ .child = sbox.box(), .padding = 2 }; + + var root = Root{ .root_box = padded.box(), .size = .{ .width = 10, .height = 10 } }; + const fctx = try root.layout(); + + try std.testing.expect(!fctx.overflow); + try std.testing.expectEqual( + BoxData{ + .pos = .{ .x = 2, .y = 2 }, + .size = .{ .width = 6, .height = 6 }, + }, + sbox.data, + ); +} + +test "overflow" { + var child = Simple{}; + var padded = Self{ .child = child.box(), .padding = 2 }; + + var root = Root{ .root_box = padded.box(), .size = .{ .width = 1, .height = 1 } }; + + const fctx = try root.layout(); + try std.testing.expect(fctx.overflow); +} diff --git a/src/boxes/Simple.zig b/src/boxes/Simple.zig new file mode 100644 index 0000000..f73d636 --- /dev/null +++ b/src/boxes/Simple.zig @@ -0,0 +1,41 @@ +//! The simplest of boxes. It simply tries to be as big as the constraints allow. +const std = @import("std"); + +const Box = @import("../Box.zig"); +const BoxData = @import("../BoxData.zig"); +const Constraints = @import("../Constraints.zig"); +const LayoutCtx = @import("../LayoutCtx.zig"); +const Position = @import("../Position.zig"); +const Root = @import("../Root.zig"); +const Size = @import("../Size.zig"); + +data: BoxData = .{}, + +const Self = @This(); + +fn layout(self: *Self, ctx: *LayoutCtx, cons: Constraints) anyerror!void { + _ = ctx; + self.data.size = cons.max; +} + +fn position(self: *Self, ctx: *LayoutCtx, pos: Position) void { + _ = ctx; + self.data.pos = pos; +} + +pub fn box(self: *Self) Box { + return Box.init(Self, self, &self.data, layout, position); +} + +test "simple layout" { + var sbox = Self{}; + + var root = Root{ .root_box = sbox.box(), .size = .{ .width = 10, .height = 10 } }; + const fctx = try root.layout(); + + try std.testing.expect(!fctx.overflow); + try std.testing.expectEqual( + BoxData{ .size = .{ .width = 10, .height = 10 } }, + sbox.data, + ); +} diff --git a/src/main.zig b/src/main.zig new file mode 100644 index 0000000..35ce59c --- /dev/null +++ b/src/main.zig @@ -0,0 +1,18 @@ +const std = @import("std"); + +comptime { + // Make sure all tests run + if (@import("builtin").is_test) { + std.testing.refAllDeclsRecursive(@This()); + } +} + +pub const boxes = @import("boxes.zig"); + +pub const Box = @import("Box.zig"); +pub const BoxData = @import("BoxData.zig"); +pub const Constraints = @import("Constraints.zig"); +pub const LayoutCtx = @import("LayoutCtx.zig"); +pub const Position = @import("Position.zig"); +pub const Root = @import("Root.zig"); +pub const Size = @import("Size.zig");