commit 8a55d0e7cbc7cc5be77ace8cc66bce0b02cce9d3 Author: Pk11 Date: Wed Jan 13 15:51:37 2021 -0600 Initial NDS Universal-Core 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..efd7a24 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# Universal-Core (NDS) by Universal-Team +This contains the GUI & Core part for our DS(i) Applications. + +## Config +Define `BUFFERED_FONT` in `UNIVCORE_CONFIG.h` to have the text be first rendered to a buffer before drawing to the screen with Font::update(). + +Logo created by: [TotallyNotGuy](https://github.com/TotallyNotGuy). + +![Universal-Core-Logo](https://github.com/Universal-Team/Universal-Core/blob/master/universal-core-logo.png) + +Licensing: +This software is licensed under the terms of the GPLv3. You can find a copy of the license in the LICENSE file. diff --git a/include/font.hpp b/include/font.hpp new file mode 100644 index 0000000..5f3955c --- /dev/null +++ b/include/font.hpp @@ -0,0 +1,156 @@ +#ifndef FONT_HPP +#define FONT_HPP + +#include "sprite.hpp" + +#include +#include +#include +#include + +#include "UNIVCORE_CONFIG.h" + +enum class Alignment { + left, + center, + right, +}; + +class Font { +private: +#ifdef TEXT_BUFFERED + static u8 textBuf[2][256 * 192]; +#endif + + u8 tileWidth, tileHeight; + u16 tileSize; + u16 questionMark = 0; + std::vector fontTiles; + std::vector fontWidths; + std::vector fontMap; + + u16 charIndex(char16_t c); + + void print(std::u16string_view text, int x, int y, bool top, int layer, Alignment align, int maxWidth, int color, float scaleX, float scaleY, Sprite *sprite); + +public: + /** + * @brief Converts a UTF-8 string to UCS-2 + * @param text The string to convert + * @return The converted string + */ + static std::u16string utf8to16(std::string_view text); + + /** + * @brief Text printing class + * @param paths The path to load the font from + */ + Font(const std::string &path) : Font(std::vector({path})) {} + /** + * @brief Text printing class + * @param paths The paths to try load the font from, from highest to lowest priority + */ + Font(const std::vector &paths); + + Font() {} + ~Font() {} + + /** + * @brief The height of the font + * @return The font height + */ + u8 height(void) { return tileHeight; } + + /** + * @brief Calculates the width of a given string of text + * @param text The text to calculate the width of + * @return The width of the given string + */ + int calcWidth(std::string_view text) { return calcWidth(utf8to16(text)); } + int calcWidth(std::u16string_view text); + + /** + * @brief Prints an integer value to a background layer + * @param value The value to print + * @param x The X position to print at + * @param y The Y position to print at + * @param top Whether to print on the top or bottom screen + * @param layer (Optional) The layer to print on + * @param align (Optional) The alignment to use + * @param maxWidth (Optional) The maximum width of the string, set to 0 for no max width + * @param color (Optional) The color to print in + * @param scaleX (Optional) The scale on the X axis + * @param scaleY (Optional) The scale on the Y axis + */ + void print(int value, int x, int y, bool top, int layer = 2, Alignment align = Alignment::left, int maxWidth = 0, int color = 0, float scaleX = 1.0f, float scaleY = 1.0f) { print(utf8to16(std::to_string(value)), x, y, top, layer, align, maxWidth, scaleX, scaleY, color, nullptr); } + + /** + * @brief Prints a string to a background layer + * @param text The string to print + * @param x The X position to print at + * @param y The Y position to print at + * @param top Whether to print on the top or bottom screen + * @param layer (Optional) The layer to print on + * @param align (Optional) The alignment to use + * @param maxWidth (Optional) The maximum width of the string, set to 0 for no max width + * @param scaleX (Optional) The scale on the X axis + * @param scaleY (Optional) The scale on the Y axis + * @param color (Optional) The color to print in + */ + void print(std::string_view text, int x, int y, bool top, int layer = 2, Alignment align = Alignment::left, int maxWidth = 0, int color = 0, float scaleX = 1.0f, float scaleY = 1.0f) { print(utf8to16(text), x, y, top, layer, align, maxWidth, color, scaleX, scaleY, nullptr); } + void print(std::u16string_view text, int x, int y, bool top, int layer = 2, Alignment align = Alignment::left, int maxWidth = 0, int color = 0, float scaleX = 1.0f, float scaleY = 1.0f) { print(text, x, y, top, layer, align, maxWidth, color, scaleX, scaleY, nullptr); } + + /** + * @brief Prints an integer value to a sprite + * @param value The value to print + * @param x The X position to print at + * @param y The Y position to print at + * @param sprite The sprite to print to + * @param align (Optional) The alignment to use + * @param maxWidth (Optional) The maximum width of the string, set to 0 for no max width + * @param color (Optional) The color to print in + * @param scaleX (Optional) The scale on the X axis + * @param scaleY (Optional) The scale on the Y axis + */ + void print(int value, int x, int y, Sprite &sprite, Alignment align = Alignment::left, int maxWidth = 0, int color = 0, float scaleX = 1.0f, float scaleY = 1.0f) { print(utf8to16(std::to_string(value)), x, y, false, 0, align, maxWidth, color, scaleX, scaleY, nullptr); } + + /** + * @brief Prints a string to a sprite + * @param text The string to print + * @param x The X position to print at + * @param y The Y position to print at + * @param sprite The sprite to print to + * @param align (Optional) The alignment to use + * @param maxWidth (Optional) The maximum width of the string, set to 0 for no max width + * @param color (Optional) The color to print in + * @param scaleX (Optional) The scale on the X axis + * @param scaleY (Optional) The scale on the Y axis + */ + void print(std::string_view text, int x, int y, Sprite &sprite, Alignment align = Alignment::left, int maxWidth = 0, int color = 0, float scaleX = 1.0f, float scaleY = 1.0f) { print(utf8to16(text), x, y, false, 0, align, maxWidth, color, scaleX, scaleY, &sprite); } + void print(std::u16string_view text, int x, int y, Sprite &sprite, Alignment align = Alignment::left, int maxWidth = 0, int color = 0, float scaleX = 1.0f, float scaleY = 1.0f) { print(text, x, y, false, 0, align, maxWidth, color, scaleX, scaleY, &sprite); } + +#ifdef TEXT_BUFFERED + /** + * @brief Clears all text from both screens + */ + static void clear(void) { clear(true); clear(false); } + /** + * @brief Clears all text from the given screen + * @param Whether to clear the top or bottom screen + */ + static void clear(bool top); + + /** + * @brief Copies all text on both screens from the buffer to actual screen + */ + static void update(void) { update(true); update(false); } + /** + * @brief Copies all text on the given screen from the buffer to actual screen + * @param top Whether to update the top or bottom screen + */ + static void update(bool top); +#endif + +}; + +#endif diff --git a/include/graphics.hpp b/include/graphics.hpp new file mode 100644 index 0000000..f153ad5 --- /dev/null +++ b/include/graphics.hpp @@ -0,0 +1,62 @@ +#ifndef GRAPHICS_HPP +#define GRAPHICS_HPP + +#include "font.hpp" +#include "image.hpp" +#include "sprite.hpp" + +#include + +namespace Graphics { + extern int bg3Main, bg2Main, bg3Sub, bg2Sub; + extern bool wideScreen; + + /** + * @brief Initializes the screens for drawing + */ + void init(void); + + /** + * @brief Clears the given layer + */ + void clear(bool top, int layer); + + /** + * @brief Draws a rectangle outline of a given size at a given position + * @param x The X position + * @param y The Y position + * @param w The Width + * @param h The Height + * @param color The index of the color to use + * @param top Whether to draw to the top or bottom screen + * @param layer The layer to draw to + */ + void drawOutline(int x, int y, int w, int h, u8 color, bool top, int layer); + + /** + * @brief Draws a rectangle of a given size at a given position + * @param x The X position + * @param y The Y position + * @param w The Width + * @param h The Height + * @param color The index of the color to use + * @param top Whether to draw on the top or bottom screen + * @param layer The layer to draw to + */ + void drawRectangle(int x, int y, int w, int h, u8 color, bool top, bool layer); + + /** + * @brief Draws a rectangle of a given size at a given position + * @param x The X position + * @param y The Y position + * @param w The Width + * @param h The Height + * @param color1 The index of the color to use for even rows + * @param color2 The index of the color to use for odd rows + * @param top Whether to draw on the top or bottom screen + * @param layer The layer to draw to + */ + void drawRectangle(int x, int y, int w, int h, u8 color1, u8 color2, bool top, bool layer); +} + +#endif \ No newline at end of file diff --git a/include/image.hpp b/include/image.hpp new file mode 100644 index 0000000..cc757a7 --- /dev/null +++ b/include/image.hpp @@ -0,0 +1,101 @@ +#ifndef IMAGE_HPP +#define IMAGE_HPP + +#include +#include +#include + +class Image { +private: + u16 _width; + u16 _height; + std::vector _bitmap; + std::vector _palette; + u16 _palOfs; + +public: + /** + * Image drawing class + * @param path The path to load the image from + */ + Image(const std::vector &paths); + /** + * @brief Text printing class + * @param paths The paths to try load the image from, from highest to lowest priority + */ + Image(const std::string &path) : Image(std::vector({path})) {}; + + /** + * @brief Text printing class + * @param file The file to load the image from, seeked to the image magic + */ + Image(FILE *file); + + Image() {}; + ~Image(void) {}; + + u16 width(void) const { return _width; } + u16 height(void) const { return _height; } + std::vector bitmap(void) const { return _bitmap; } + std::vector palette(void) const { return _palette; } + u16 palOfs(void) const { return _palOfs; } + + /** + * @brief Draws the image to a background layer, faster but without alpha, scaling, or palette offsetting + * @param x The X position to draw at + * @param y The Y position to draw at + * @param top Whether to draw on teh top or bottom screen, not used for sprites + * @param layer (Optional) The layer to draw on, not used for sprites + * @param channel (Optional) The DMA channel to use + * @param copyPal (Optional) Whether to copy the image's palette into palette VRAM + */ + void draw(int x, int y, bool top, int layer = 3, int channel = 0, bool copyPal = true); + + /** + * @brief Draws the image to a background layer, slower but can skip alpha, scale, and offset the palette + * @param x The X position to draw at + * @param y The Y position to draw at + * @param top Whether to draw on the top or bottom screen + * @param layer (Optional) Which background layer to draw on + * @param scaleX (Optional) The scale for the X axis + * @param scaleY (Optional) The scale for the Y axis + * @param paletteOffset (Optional) How much to offset the palette by + * @param copyPal (Optional) Whether to copy the image's palette into palette VRAM + */ + void drawSpecial(int x, int y, bool top, int layer = 3, float scaleX = 1.0f, float scaleY = 1.0f, int paletteOffset = 0, bool copyPal = true); + + /** + * @brief Draws a segment of an image to a background layer, faster but overwrites alpha and no scaling or palette offsetting + * @param x The X position to draw at + * @param y The Y position to draw at + * @param imageX The X position in the image to draw from + * @param imageY The Y position in the image to draw from + * @param w The width to draw + * @param h The height to draw + * @param top Whether to draw on the top or bottom screen + * @param layer (Optional) Which background layer to draw on + * @param channel (Optional) The DMA channel to use + * @param copyPal (Optional) Whether to copy the image's palette into palette VRAM + */ + void drawSegment(int x, int y, int imageX, int imageY, int w, int h, bool top, int layer = 3, int channel = 0, bool copyPal = true); + + /** + * @brief Draws a segment of an image to a background layer, slower but can skip alpha, scale, and offset the palette + * @param x The X position to draw at + * @param y The Y position to draw at + * @param imageX The X position in the image to draw from + * @param imageY The Y position in the image to draw from + * @param w The width to draw + * @param h The height to draw + * @param top Whether to draw on the top or bottom screen + * @param layer (Optional) Which background layer to draw on + * @param scaleX (Optional) The scale for the X axis + * @param scaleY (Optional) The scale for the Y axis + * @param paletteOffset (Optional) How much to offset the palette by + * @param copyPal (Optional) Whether to copy the image's palette into palette VRAM + */ + void drawSegmentSpecial(int x, int y, int imageX, int imageY, int w, int h, bool top, int layer = 3, float scaleX = 1.0f, float scaleY = 1.0f, int paletteOffset = 0, bool copyPal = true); + +}; + +#endif diff --git a/include/sprite.hpp b/include/sprite.hpp new file mode 100644 index 0000000..7cf9ca7 --- /dev/null +++ b/include/sprite.hpp @@ -0,0 +1,175 @@ +#ifndef SPRITE_HPP +#define SPRITE_HPP + +#include "image.hpp" + +#include + +class Sprite { +private: + bool _top; + OamState *_oam; + SpriteSize _size; + SpriteColorFormat _format; + int _x, _y, _priority, _id, _rotationIndex, _paletteAlpha, _width, _height, _rotation; + float _scaleX, _scaleY; + bool _visibility; + u16* _gfx; + + static bool _assigned[2][256]; + +public: + /** + * @brief A class for easier management of OAM sprites + */ + Sprite() {} + + /** + * @brief A class for easier management of OAM sprites + * @param top Whether to make it on the top or bottom screen + * @param size The size of the sprite + * @param format The color format of the sprite + * @param (Optional) x The starting X position of the sprite + * @param (Optional) y The starting Y position of the sprite + * @param (Optional) priority The starting priority of the sprite, 0 - 3 with 0 on top + * @param (Optional) id The ID to use for the sprite, set to -1 to automatically use the first free one + * @param (Optional) paletteAlpha For paletted sprites, the pallete to use. For bitmap sprites, the alpha + * @param (Optional) rotationIndex The rotation index to use, set to -1 for no rotation + * @param (Optional) doubleSize Whether to double the size for rotation + * @param (Optional) visible Whether the sprite should start visible + * @param (Optional) vFlip Whether to start the sprite flipped vertically + * @param (Optional) hFlip Whether to start the sprite flipped horizontally + * @param (Optional) mosaic Whether to mosaic the sprite // TODO: What is this? + */ + Sprite(bool top, SpriteSize size, SpriteColorFormat format, int x = 0, int y = 0, int priority = 0, int id = -1, int paletteAlpha = 15, int rotationIndex = -1, bool doubleSize = false, bool visible = true, bool vFlip = false, bool hFlip = false, bool mosaic = false); + + ~Sprite(void); + + u16* gfx(void) const { return _gfx; } + SpriteSize size(void) const { return _size; } + SpriteColorFormat format(void) const { return _format; } + bool visibility(void) const { return _visibility; } + int id(void) const { return _id; } + int rotationIndex(void) const { return _rotationIndex; } + int paletteAlpha(void) const { return _paletteAlpha; } + int x(void) const { return _x; } + int y(void) const { return _y; } + int width(void) const { return _width; } + int height(void) const { return _height; } + int rotation(void) const { return _rotation; } + float scaleX(void) const { return _scaleX; } + float scaleY(void) const { return _scaleY; } + + /** + * @brief Sets the alpha of the sprite + * @param alpha The alpha, 0 - 15 + */ + void alpha(int alpha) { oamSetAlpha(_oam, _id, alpha); } + + /** + * @brief Sets the flip of the sprite + * @param hFlip The horizontal flip + * @param vFlip The vertical flip + */ + void flip(bool hFlip, bool vFlip) { oamSetFlip(_oam, _id, hFlip, vFlip); } + + /** + * @brief Sets the position of the sprite + * @param x The X position + * @param y The Y position + */ + void position(int x, int y) { _x = x, _y = y; if(_visibility) oamSetXY(_oam, _id, _x, _y); } + + /** + * @brief Sets the priority of the sprite + * @param priority The priority, 0 - 3 with 0 being on top + */ + void priority(int priority) { oamSetPriority(_oam, _id, priority); } + + /** + * @brief Sets the scale of the sprite + * @param scaleX The scale on the X axis + * @param scaleY The scale on the Y axis + */ + void rotation(int rotation); + + /** + * @brief Sets the scale of the sprite + * @param scaleX The scale on the X axis + * @param scaleY The scale on the Y axis + */ + void scale(float scaleX, float scaleY); + + /** + * @brief Sets the visibility of the sprite + * @param show Whether to show the sprite or not, true to show + */ + void visibility(bool show); + + /** + * @brief Clears the sprite + */ + void clear(void); + + /** + * @brief Fills the sprite with a solid color + * @param color The color to fill with + */ + void fillColor(u16 color); + + /** + * @brief Draws a solid color rectangle to the sprite + * @param x The X position to draw at + * @param y The Y position to draw at + * @param w The width of the rectangle + * @param h The height of the rectangle + * @param color The color of the rectangle + */ + void drawRectangle(int x, int y, int w, int h, u16 color) { drawRectangle(x, y, w, h, color, color); } + /** + * @brief Draws a solid color rectangle to the sprite + * @param x The X position to draw at + * @param y The Y position to draw at + * @param w The width of the rectangle + * @param h The height of the rectangle + * @param color The color of even rows + * @param color The color of odd rows + */ + void drawRectangle(int x, int y, int w, int h, u16 color1, u16 color2); + + /** + * @brief Draws the image to a sprite, can skip alpha and scale the image + * @param x The X position to draw at + * @param y The Y position to draw at + * @param image The image to draw to the sprite + * @param scaleX (Optional) The scale for the X axis + * @param scaleY (Optional) The scale for the Y axis + */ + void drawImage(int x, int y, const Image &image, float scaleX = 1.0f, float scaleY = 1.0f); + + /** + * @brief Draws a segment of an image to a sprite, faster but overwrites alpha and no scaling + * @param x The X position to draw at + * @param y The Y position to draw at + * @param imageX The X position in the image to draw from + * @param imageY The Y position in the image to draw from + * @param w The width to draw + * @param h The height to draw + * @param image The image to draw to the sprite + * @param scaleX (Optional) The scale for the X axis + * @param scaleY (Optional) The scale for the Y axis + */ + void drawImageSegment(int x, int y, int imageX, int imageY, int w, int h, const Image &image, float scaleX = 1.0f, float scaleY = 1.0f); + + /** + * @brief Updates the OAM that this sprite is on, also updates all other sprites on that screen. Avoid calling this excessively, if changing a lot of sprites call it once when they're all done. + */ + void update(void) { oamUpdate(_oam); } + /** + * @brief Updates all sprites on the given screen. Avoid calling this excessively, if changing a lot of sprites call it once when they're all done. + * @param top Whether to update the top or bottom screen + */ + static void update(bool top) { oamUpdate(top ? &oamMain : &oamSub); } +}; + +#endif diff --git a/include/tonccpy.h b/include/tonccpy.h new file mode 100644 index 0000000..843189a --- /dev/null +++ b/include/tonccpy.h @@ -0,0 +1,36 @@ +//# Stuff you may not have yet. + +#ifndef TONCCPY_H +#define TONCCPY_H + + +#ifdef __cplusplus +extern "C" { +#endif + +#include + +typedef unsigned int uint; +#define BIT_MASK(len) ((1<<(len))-1) +static inline u32 quad8(u32 x) { x |= x<<8; return x | x<<16; } + + +//# Declarations and inlines. + +void tonccpy(void *dst, const void *src, uint size); + +void __toncset(void *dst, u32 fill, uint size); + +//! VRAM-safe memset, byte version. Size in bytes. +static inline void toncset(void *dst, u8 src, uint size) { __toncset(dst, quad8(src), size); } + +//! VRAM-safe memset, halfword version. Size in hwords. +static inline void toncset16(void *dst, u16 src, uint size) { __toncset(dst, src|src<<16, size*2); } + +//! VRAM-safe memset, word version. Size in words. +static inline void toncset32(void *dst, u32 src, uint size) { __toncset(dst, src, size*4); } + +#ifdef __cplusplus +} +#endif +#endif diff --git a/source/font.cpp b/source/font.cpp new file mode 100644 index 0000000..dbd388e --- /dev/null +++ b/source/font.cpp @@ -0,0 +1,346 @@ +#include "font.hpp" + +#include "tonccpy.h" + +#ifdef TEXT_BUFFERED +u8 Font::textBuf[2][256 * 192]; +#endif + +Font::Font(const std::vector &paths) { + FILE *file = nullptr; + for(const auto &path : paths) { + file = fopen(path.c_str(), "rb"); + if(file) + break; + } + + if(file) { + // Get file size + fseek(file, 0, SEEK_END); + u32 fileSize = ftell(file); + + // Skip font info + fseek(file, 0x14, SEEK_SET); + fseek(file, fgetc(file) - 1, SEEK_CUR); + + // Load glyph info + u32 chunkSize; + fread(&chunkSize, 4, 1, file); + tileWidth = fgetc(file); + tileHeight = fgetc(file); + fread(&tileSize, 2, 1, file); + + // Load character glyphs + int tileAmount = ((chunkSize - 0x10) / tileSize); + fontTiles = std::vector(tileSize * tileAmount); + fseek(file, 4, SEEK_CUR); + fread(fontTiles.data(), tileSize, tileAmount, file); + + // Fix top row + for(int i = 0; i < tileAmount; i++) { + fontTiles[i * tileSize] = 0; + fontTiles[i * tileSize + 1] = 0; + fontTiles[i * tileSize + 2] = 0; + } + + // Load character widths + fseek(file, 0x24, SEEK_SET); + u32 locHDWC; + fread(&locHDWC, 4, 1, file); + fseek(file, locHDWC - 4, SEEK_SET); + fread(&chunkSize, 4, 1, file); + fseek(file, 8, SEEK_CUR); + fontWidths = std::vector(3 * tileAmount); + fread(fontWidths.data(), 3, tileAmount, file); + + // Load character maps + fontMap = std::vector(tileAmount); + fseek(file, 0x28, SEEK_SET); + u32 locPAMC, mapType; + fread(&locPAMC, 4, 1, file); + + while(locPAMC < fileSize) { + u16 firstChar, lastChar; + fseek(file, locPAMC, SEEK_SET); + fread(&firstChar, 2, 1, file); + fread(&lastChar, 2, 1, file); + fread(&mapType, 4, 1, file); + fread(&locPAMC, 4, 1, file); + + switch(mapType) { + case 0: { + u16 firstTile; + fread(&firstTile, 2, 1, file); + for(unsigned i = firstChar; i <= lastChar; i++) { + fontMap[firstTile + (i - firstChar)] = i; + } + break; + } + case 1: { + for(int i = firstChar; i <= lastChar; i++) { + u16 tile; + fread(&tile, 2, 1, file); + fontMap[tile] = i; + } + break; + } + case 2: { + u16 groupAmount; + fread(&groupAmount, 2, 1, file); + for(int i = 0; i < groupAmount; i++) { + u16 charNo, tileNo; + fread(&charNo, 2, 1, file); + fread(&tileNo, 2, 1, file); + fontMap[tileNo] = charNo; + } + break; + } + } + } + fclose(file); + questionMark = charIndex('?'); + } +} + +u16 Font::charIndex(char16_t c) { + // Try a binary search + int left = 0; + int right = fontMap.size(); + + while(left <= right) { + int mid = left + ((right - left) / 2); + if(fontMap[mid] == c) { + return mid; + } + + if(fontMap[mid] < c) { + left = mid + 1; + } else { + right = mid - 1; + } + } + + // If not found, return a question mark + return questionMark; +} + +std::u16string Font::utf8to16(std::string_view text) { + std::u16string out; + for(uint i = 0; i < text.size();) { + char16_t c; + if(!(text[i] & 0x80)) { + c = text[i++]; + } else if((text[i] & 0xE0) == 0xC0) { + c = (text[i++] & 0x1F) << 6; + c |= text[i++] & 0x3F; + } else if((text[i] & 0xF0) == 0xE0) { + c = (text[i++] & 0x0F) << 12; + c |= (text[i++] & 0x3F) << 6; + c |= text[i++] & 0x3F; + } else { + i++; // out of range or something (This only does up to 0xFFFF since it goes to a U16 anyways) + } + out += c; + } + return out; +} + +int Font::calcWidth(std::u16string_view text) { + uint x = 0; + + for(auto c : text) { + u16 index = charIndex(c); + x += fontWidths[(index * 3) + 2]; + } + + return x; +} + +ITCM_CODE void Font::print(std::u16string_view text, int x, int y, bool top, int layer, Alignment align, int maxWidth, + int color, float scaleX, float scaleY, Sprite *sprite) { + // Adjust x for alignment + switch(align) { + case Alignment::left: { + break; + } + case Alignment::center: { + size_t newline = text.find('\n'); + while(newline != text.npos) { + print(text.substr(0, newline), x, y, top, layer, align, maxWidth, color, scaleX, scaleY, sprite); + text = text.substr(newline + 1); + newline = text.find('\n'); + y += tileHeight; + } + + x += ((sprite ? sprite->width() : 256) - (calcWidth(text) * scaleX)) / 2; + break; + } + case Alignment::right: { + size_t newline = text.find('\n'); + while(newline != text.npos) { + print(text.substr(0, newline), x - (calcWidth(text.substr(0, newline)) * scaleX), y, top, layer, + Alignment::left, maxWidth, color, scaleX, scaleY, sprite); + text = text.substr(newline + 1); + newline = text.find('\n'); + y += tileHeight; + } + x -= calcWidth(text) * scaleX; + break; + } + } + const int xStart = x; + + bool rtl = false; + for(const auto c : text) { + if(c >= 0x0590 && c <= 0x05FF) { + rtl = true; + break; + } + } + auto ltrBegin = text.end(), ltrEnd = text.end(); + + // Loop through string and print it + for(auto it = (rtl ? text.end() - 1 : text.begin()); true; it += (rtl ? -1 : 1)) { + // If we hit the end of the string in an LTR section of an RTL + // string, it may not be done, if so jump back to printing RTL + if(it == (rtl ? text.begin() - 1 : text.end())) { + if(ltrBegin == text.end()) { + break; + } else { + it = ltrBegin; + ltrBegin = text.end(); + rtl = true; + } + } + + // If at the end of an LRT section within RTL, jump back to the RTL + if(it == ltrEnd && ltrBegin != text.end()) { + if(ltrBegin == text.begin()) + break; + + it = ltrBegin; + ltrBegin = text.end(); + rtl = true; + // If in RTL and hit a non-RTL character that's not punctuation, switch to LTR + } else if(rtl && + ((*it < 0x0590 || *it > 0x05FF) && + ((*it >= '0' && *it <= '9') || (*it >= 'A' && *it <= 'Z') || (*it >= 'a' && *it <= 'z') || + *it >= 127))) { + // Save where we are as the end of the LTR section + ltrEnd = it + 1; + // Go back until an RTL character or the start of the string + while((*it < 0x0590 || *it > 0x05FF) && it != text.begin()) + it--; + // Save where we are to return to after printing the LTR section + ltrBegin = it; + // If not at the start, then we're on the first RTL right now, so add one + if(it != text.begin()) + it++; + // Skip all punctuation at the end if not at beginning + while(it != text.begin() && + (*it < '0' || (*it > '9' && *it < 'A') || (*it > 'Z' && *it < 'a') || (*it > 'z' && *it < 127))) { + it++; + ltrBegin++; + } + rtl = false; + } + + if(*it == '\n') { + x = xStart; + y += tileHeight; + continue; + } + + u16 index = charIndex(*it); + + // Brackets are flipped in RTL + if(rtl) { + if(*it == '(') + index = charIndex(')'); + else if(*it == ')') + index = charIndex('('); + else if(*it == '[') + index = charIndex(']'); + else if(*it == ']') + index = charIndex('['); + } + + if(sprite) { + // Don't draw off sprite chars + if(x >= 0 && x < sprite->width() && y >= 0 && y + tileHeight < sprite->height()) { + u16 *dst = sprite->gfx() + x + fontWidths[(index * 3)]; + // Use faster integer math if scale is 1 + if(scaleX == 1.0f && scaleY == 1.0f) { + for(int i = 0; i < tileHeight; i++) { + for(int j = 0; j < tileWidth; j++) { + u8 px = fontTiles[(index * tileSize) + (i * tileWidth + j) / 4] >> + ((3 - ((i * tileWidth + j) % 4)) * 2) & + 3; + if(px) + dst[(y + i) * sprite->width() + j] = px + (color * 4); + } + } + } else { + for(float i = 0.0f; i < tileHeight; i += 1 / scaleY) { + for(float j = 0.0f; j < tileWidth; j += 1 / scaleY) { + u8 px = fontTiles[(index * tileSize) + (i * tileWidth + j) / 4] >> + ((3 - (int(i * tileWidth + j) % 4)) * 2) & + 3; + if(px) + dst[int((y + i) * sprite->width() + j)] = px + (color * 4); + } + } + } + } + } else { + // Don't draw off screen chars + if(x >= 0 && x + fontWidths[(index * 3) + 2] < 256 && y >= 0 && y + tileHeight < 192) { +#ifdef TEXT_BUFFERED + u8 *dst = textBuf[top] + x + fontWidths[(index * 3)]; +#else + u8 *dst = (u8 *)bgGetGfxPtr(top ? layer : layer + 4) + x + fontWidths[(index * 3)]; +#endif + // Use faster integer math if scale is 1 + if(scaleX == 1.0f && scaleY == 1.0f) { + for(int i = 0; i < tileHeight; i++) { + for(int j = 0; j < tileWidth; j++) { + u8 px = fontTiles[(index * tileSize) + (i * tileWidth + j) / 4] >> + ((3 - ((i * tileWidth + j) % 4)) * 2) & + 3; + if(px) +#ifdef TEXT_BUFFERED + dst[(y + i) * 256 + j] = px + (color * 4); +#else + toncset(dst + (y + i) * 256 + j, px + (color * 4), 1); +#endif + } + } + } else { + for(float i = 0.0f; i < tileHeight; i += 1 / scaleY) { + for(float j = 0.0f; j < tileWidth; j += 1 / scaleX) { + u8 px = fontTiles[(index * tileSize) + (i * tileWidth + j) / 4] >> + ((3 - (int(i * tileWidth + j) % 4)) * 2) & + 3; + if(px) +#ifdef TEXT_BUFFERED + dst[(y + i) * 256 + j] = px + (color * 4); +#else + toncset(dst + int((y + i) * 256 + j), px + (color * 4), 1); +#endif + } + } + } + } + } + + x += fontWidths[(index * 3) + 2]; + } +} + +#ifdef TEXT_BUFFERED +void Font::clear(bool top) { dmaFillWords(0, FontGraphic::textBuf[top], 256 * 192); } + +void Font::update(bool top) { + tonccpy(bgGetGfxPtr(top ? TEXT_TOP_LAYER : TEXT_BOTTOM_LAYER + 4), FontGraphic::textBuf[top], 256 * 192); +} +#endif diff --git a/source/graphics.cpp b/source/graphics.cpp new file mode 100644 index 0000000..09a3340 --- /dev/null +++ b/source/graphics.cpp @@ -0,0 +1,65 @@ +#include "graphics.hpp" + +#include "tonccpy.h" + +#include + +int Graphics::bg3Main, Graphics::bg2Main, Graphics::bg3Sub, Graphics::bg2Sub; +bool Graphics::wideScreen = false; + +void Graphics::init(void) { + // Initialize video mode + videoSetMode(MODE_5_2D); + videoSetModeSub(MODE_5_2D); + + // initialize all the VRAM banks + vramSetPrimaryBanks(VRAM_A_MAIN_BG, VRAM_B_MAIN_SPRITE, VRAM_C_SUB_BG, VRAM_D_SUB_SPRITE); + + // Init oam with 1D mapping 128 byte boundary and no external palette support + oamInit(&oamSub, SpriteMapping_Bmp_1D_128, false); + oamInit(&oamMain, SpriteMapping_Bmp_1D_128, false); + + // Init the backgrounds + bg3Main = bgInit(3, BgType_Bmp8, BgSize_B8_256x256, 0, 0); + bgSetPriority(bg3Main, 3); + + bg2Main = bgInit(2, BgType_Bmp8, BgSize_B8_256x256, 3, 0); + bgSetPriority(bg2Main, 2); + + bg3Sub = bgInitSub(3, BgType_Bmp8, BgSize_B8_256x256, 0, 0); + bgSetPriority(bg3Sub, 3); + + bg2Sub = bgInitSub(2, BgType_Bmp8, BgSize_B8_256x256, 3, 0); + bgSetPriority(bg2Sub, 2); + + // Set main background as target for sprite transparency + REG_BLDCNT = 1 << 11; + REG_BLDCNT_SUB = 1 << 11; +} + +void Graphics::clear(bool top, int layer) { toncset(bgGetGfxPtr(top ? layer : layer + 4), 0, 256 * 192); } + +void Graphics::drawOutline(int x, int y, int w, int h, u8 color, bool top, int layer) { + u8 *dst = (u8 *)bgGetGfxPtr(top ? layer : layer + 4); + h += y; + if(y >= 0 && y < 192) + toncset(dst + ((y * 256) + (x < 0 ? 0 : x)), color, (x + w > 256 ? w + (256 - x - w) : w)); + for(y++; y < (h - 1); y++) { + if(y >= 0 && y < 192 && x > 0) + toncset(dst + ((y)*256 + x), color, 1); + if(y >= 0 && y < 192 && x + w < 256) + toncset(dst + ((y)*256 + x + w - 1), color, 1); + } + if(y >= 0 && y < 192) + toncset(dst + ((y * 256) + (x < 0 ? 0 : x)), color, (x + w > 256 ? w + (256 - x - w) : w)); +} + +void Graphics::drawRectangle(int x, int y, int w, int h, u8 color, bool top, bool layer) { + Graphics::drawRectangle(x, y, w, h, color, color, top, layer); +} +void Graphics::drawRectangle(int x, int y, int w, int h, u8 color1, u8 color2, bool top, bool layer) { + u8 *dst = (u8 *)bgGetGfxPtr(top ? layer : layer + 4); + for(int i = 0; i < h; i++) { + toncset(dst + ((y + i) * 256 + x), ((i % 2) ? color1 : color2), w); + } +} diff --git a/source/image.cpp b/source/image.cpp new file mode 100644 index 0000000..dead597 --- /dev/null +++ b/source/image.cpp @@ -0,0 +1,141 @@ +#include "image.hpp" + +#include "tonccpy.h" + +Image::Image(const std::vector &paths) { + // Attempt to load from the given paths + FILE *file = nullptr; + for(const auto &path : paths) { + file = fopen(path.c_str(), "rb"); + if(file) + break; + } + + // Return if no file found + if(!file) + return; + + // Return if not in the correct format + char magic[5] = {0}; + fread(magic, 1, 4, file); + if(strcmp(magic, ".GFX")) + return; + + // Read image + fread(&_width, 1, 2, file); + fread(&_height, 1, 2, file); + _bitmap = std::vector(_width * _height); + fread(_bitmap.data(), 1, _bitmap.size(), file); + u16 palCount; + fread(&palCount, 1, 2, file); + fread(&_palOfs, 1, 2, file); + _palette = std::vector(palCount); + fread(_palette.data(), 2, palCount, file); + fclose(file); +} + +Image::Image(FILE *file) { + // Return if no file + if(!file) + return; + + // Return if not in the correct format + char magic[5]; + fread(magic, 1, 4, file); + if(strcmp(magic, ".GFX")) + return; + + // Read image + fread(&_width, 1, 2, file); + fread(&_height, 1, 2, file); + _bitmap = std::vector(_width * _height); + fread(_bitmap.data(), 1, _bitmap.size(), file); + u16 palCount; + fread(&palCount, 1, 2, file); + fread(&_palOfs, 1, 2, file); + _palette = std::vector(palCount); + fread(_palette.data(), 2, palCount, file); + fclose(file); +} + +void Image::draw(int x, int y, bool top, int layer, int channel, bool copyPal) { + if(copyPal) + tonccpy((top ? BG_PALETTE : BG_PALETTE_SUB) + _palOfs, _palette.data(), _palette.size() * 2); + + u8 *dst = (u8 *)bgGetGfxPtr(top ? layer : layer + 4); + int width = 256; + + // If full width and X is 0, copy it all in one go + if(_width == width && x == 0) { + dmaCopyHalfWords(channel, _bitmap.data(), dst, _width * _height); + } else { + for(int i = 0; i < _height; i++) { + dmaCopyHalfWords(channel, _bitmap.data() + (i * _width), dst + (y + i) * 256 + x, _width); + } + } +} + +void Image::drawSpecial(int x, int y, bool top, int layer, float scaleX, float scaleY, int paletteOffset, + bool copyPal) { + if(copyPal) + tonccpy((top ? BG_PALETTE : BG_PALETTE_SUB) + _palOfs + paletteOffset, _palette.data(), _palette.size() * 2); + + u8 *dst = (u8 *)bgGetGfxPtr(top ? layer : layer + 4); + + // If the scale is 1 use faster integer math + if(scaleX == 1.0f && scaleY == 1.0f) { + for(int i = 0; i < _height; i++) { + for(float j = 0; j < _width; j++) { + u8 px = _bitmap[i * _width + j]; + if(_palette[px - _palOfs] & 0x8000) + toncset(dst + int((y + i) * 256 + x + j), px + paletteOffset, 1); + } + } + } else { + for(float i = 0.0f; i < _height; i += 1 / scaleY) { + for(float j = 0.0f; j < _width; j += 1 / scaleX) { + u8 px = _bitmap[int((i * _width) + j)]; + if(_palette[px - _palOfs] & 0x8000) + toncset(dst + int((y + i) * 256 + x + j), px + paletteOffset, 1); + } + } + } +} + +void Image::drawSegment(int x, int y, int imageX, int imageY, int w, int h, bool top, int layer, int channel, + bool copyPal) { + if(copyPal) + tonccpy((top ? BG_PALETTE : BG_PALETTE_SUB) + _palOfs, _palette.data(), _palette.size() * 2); + + for(int i = 0; i < h; i++) { + dmaCopyHalfWords(channel, _bitmap.data() + ((imageY + i) * _width) + imageX, + (u8 *)bgGetGfxPtr(top ? layer : layer + 4) + ((y + i) * 256) + x, w); + } +} + +void Image::drawSegmentSpecial(int x, int y, int imageX, int imageY, int w, int h, bool top, int layer, float scaleX, + float scaleY, int paletteOffset, bool copyPal) { + if(copyPal) + tonccpy((top ? BG_PALETTE : BG_PALETTE_SUB) + _palOfs + paletteOffset, _palette.data(), _palette.size() * 2); + + u8 *dst = (u8 *)bgGetGfxPtr(top ? layer : layer + 4); + + // If the scale is 1 use faster integer math + if(scaleX == 1.0f && scaleY == 1.0f) { + for(int i = 0; i < h; i++) { + for(int j = 0; j < w; j++) { + u8 px = _bitmap[i * _width + j]; + if(_palette[px - _palOfs] & 0x8000) + toncset(dst + ((y + i) * 256 + x + j), px + paletteOffset, 1); + } + } + } else { + for(float i = 0; i < h; i += 1 / scaleX) { + for(float j = 0; j < _width; j += 1 / scaleY) { + u8 px = _bitmap[i * _width + j]; + if(_palette[px - _palOfs] & 0x8000) + toncset(dst + int((y + i) * 256 + x + j), px + paletteOffset, 1); + } + } + } +} diff --git a/source/sprite.cpp b/source/sprite.cpp new file mode 100644 index 0000000..68fb7aa --- /dev/null +++ b/source/sprite.cpp @@ -0,0 +1,156 @@ +#include "sprite.hpp" + +#include "tonccpy.h" + +bool Sprite::_assigned[2][256]; + +Sprite::Sprite(bool top, SpriteSize size, SpriteColorFormat format, int x, int y, int priority, int id, + int paletteAlpha, int rotationIndex, bool doubleSize, bool visible, bool vFlip, bool hFlip, bool mosaic) + : _top(top), _oam(top ? &oamMain : &oamSub), _size(size), _format(format), _x(x), _y(y), _priority(priority), + _id(id), _rotationIndex(rotationIndex), _paletteAlpha(paletteAlpha) { + // If the ID is -1, set it to the first free one + if(_id == -1) { + for(uint i = 0; i < sizeof(_assigned[top]) / sizeof(_assigned[top][0]); i++) { + if(!_assigned[top][i]) { + _assigned[top][i] = true; + id = i; + break; + } + } + } + + // Get the sprite width and height from the SpriteSize + if(((_size >> 12) & 3) == OBJSHAPE_SQUARE) { + _width = 8 << ((_size >> 14) & 3); + _height = 8 << ((_size >> 14) & 3); + } else if(((_size >> 12) & 3) == OBJSHAPE_WIDE) { + switch(_size & 0xFF) { + case 4: + _width = 16; + _height = 8; + break; + case 8: + _width = 32; + _height = 8; + break; + case 16: + _width = 32; + _height = 16; + break; + case 64: + _width = 64; + _width = 32; + break; + } + } else if(((_size >> 12) & 3) == OBJSHAPE_TALL) { + switch(_size & 0xFF) { + case 4: + _width = 8; + _height = 16; + break; + case 8: + _width = 8; + _height = 32; + break; + case 16: + _width = 16; + _height = 32; + break; + case 64: + _width = 32; + _height = 64; + break; + } + } + + // Allocate memory for graphics + _gfx = oamAllocateGfx(_oam, _size, _format); + + // Set sprite + oamSet(_oam, _id, _x, _y, _priority, _paletteAlpha, _size, _format, _gfx, _rotationIndex, doubleSize, !visible, + vFlip, hFlip, mosaic); +} + +Sprite::~Sprite(void) { + oamFreeGfx(_oam, _gfx); + _assigned[_top][_id] = false; +} + +void Sprite::rotation(int rotation) { + _rotation = rotation; + if(_rotationIndex != -1) + oamRotateScale(_oam, _rotationIndex, _rotation, (1 / _scaleX) * (1 << 8), (1 / _scaleY) * (1 << 8)); +} + +void Sprite::scale(float scaleX, float scaleY) { + _scaleX = scaleX; + _scaleY = scaleY; + if(_rotationIndex != -1) + oamRotateScale(_oam, _rotationIndex, _rotation, (1 / scaleX) * (1 << 8), (1 / scaleY) * (1 << 8)); +} + +void Sprite::visibility(bool show) { + _visibility = show; + if(_rotationIndex == -1) { + oamSetHidden(_oam, _id, !_visibility); + } else { + // Can't hide sprites with rotation / scaling, so move them off screen + if(_visibility) + oamSetXY(_oam, _id, _x, _y); + else + oamSetXY(_oam, _id, -64, -64); + } +} + +void Sprite::clear(void) { toncset16(_gfx, 0, (_size & 0xFF) << 5); } + +void Sprite::fillColor(u16 color) { toncset16(_gfx, color, (_size & 0xFF) << 5); } + +void Sprite::drawRectangle(int x, int y, int w, int h, u16 color1, u16 color2) { + for(int i = 0; i < h; i++) { + toncset(_gfx + ((y + i) * _width + x), ((i % 2) ? color1 : color2), w); + } +} + +void Sprite::drawImage(int x, int y, const Image &image, float scaleX, float scaleY) { + // If the scale is 1 use faster integer math + if(scaleX == 1.0f && scaleY == 1.0f) { + for(int i = 0; i < image.height(); i++) { + for(int j = 0; j < image.width(); j++) { + u16 px = image.palette()[image.bitmap()[i * image.width() + j] - image.palOfs()]; + if(px & 0x8000) + toncset16(_gfx + (y + i) * _height + x + j, px, 1); + } + } + } else { + for(float i = 0.0f; i < image.height(); i += 1 / scaleY) { + for(float j = 0.0f; j < image.width(); j += 1 / scaleX) { + u16 px = image.palette()[image.bitmap()[int(i * image.width() + j)] - image.palOfs()]; + if(px & 0x8000) + toncset16(_gfx + int((y + i) * _height + j) + x, px, 1); + } + } + } +} + +void Sprite::drawImageSegment(int x, int y, int imageX, int imageY, int w, int h, const Image &image, float scaleX, + float scaleY) { + // If the scale is 1 use faster integer math + if(scaleX == 1.0f && scaleY == 1.0f) { + for(int i = 0; i < h; i++) { + for(int j = 0; j < w; j++) { + u16 px = image.palette()[image.bitmap()[i * image.width() + j] - image.palOfs()]; + if(px & 0x8000) + toncset16(_gfx + ((y + i) * _height + x + j), px, 1); + } + } + } else { + for(float i = 0; i < h; i += 1 / scaleX) { + for(float j = 0; j < image.width(); j += 1 / scaleY) { + u16 px = image.palette()[image.bitmap()[i * image.width() + j] - image.palOfs()]; + if(px & 0x8000) + toncset16(_gfx + int((y + i) * _height + x + j), px, 1); + } + } + } +} diff --git a/source/tonccpy.c b/source/tonccpy.c new file mode 100644 index 0000000..9618fc2 --- /dev/null +++ b/source/tonccpy.c @@ -0,0 +1,136 @@ +#include "tonccpy.h" +//# tonccpy.c + +//! VRAM-safe cpy. +/*! This version mimics memcpy in functionality, with + the benefit of working for VRAM as well. It is also + slightly faster than the original memcpy, but faster + implementations can be made. + \param dst Destination pointer. + \param src Source pointer. + \param size Fill-length in bytes. + \note The pointers and size need not be word-aligned. +*/ +void tonccpy(void *dst, const void *src, uint size) { + if(size == 0 || dst == NULL || src == NULL) + return; + + uint count; + u16 *dst16; // hword destination + u8 *src8; // byte source + + // Ideal case: copy by 4x words. Leaves tail for later. + if(((u32)src | (u32)dst) % 4 == 0 && size >= 4) { + u32 *src32 = (u32 *)src, *dst32 = (u32 *)dst; + + count = size / 4; + uint tmp = count & 3; + count /= 4; + + // Duff's Device, good friend! + switch(tmp) { + do { + *dst32++ = *src32++; + case 3: + *dst32++ = *src32++; + case 2: + *dst32++ = *src32++; + case 1: + *dst32++ = *src32++; + case 0:; + } while(count--); + } + + // Check for tail + size &= 3; + if(size == 0) + return; + + src8 = (u8 *)src32; + dst16 = (u16 *)dst32; + } else { // Unaligned. + uint dstOfs = (u32)dst & 1; + src8 = (u8 *)src; + dst16 = (u16 *)(dst - dstOfs); + + // Head: 1 byte. + if(dstOfs != 0) { + *dst16 = (*dst16 & 0xFF) | *src8++ << 8; + dst16++; + if(--size == 0) + return; + } + } + + // Unaligned main: copy by 2x byte. + count = size / 2; + while(count--) { + *dst16++ = src8[0] | src8[1] << 8; + src8 += 2; + } + + // Tail: 1 byte. + if(size & 1) + *dst16 = (*dst16 & ~0xFF) | *src8; +} +//# toncset.c + +//! VRAM-safe memset, internal routine. +/*! This version mimics memset in functionality, with + the benefit of working for VRAM as well. It is also + slightly faster than the original memset. + \param dst Destination pointer. + \param fill Word to fill with. + \param size Fill-length in bytes. + \note The \a dst pointer and \a size need not be + word-aligned. In the case of unaligned fills, \a fill + will be masked off to match the situation. +*/ +void __toncset(void *dst, u32 fill, uint size) { + if(size == 0 || dst == NULL) + return; + + uint left = (u32)dst & 3; + u32 *dst32 = (u32 *)(dst - left); + u32 count, mask; + + // Unaligned head. + if(left != 0) { + // Adjust for very small stint. + if(left + size < 4) { + mask = BIT_MASK(size * 8) << (left * 8); + *dst32 = (*dst32 & ~mask) | (fill & mask); + return; + } + + mask = BIT_MASK(left * 8); + *dst32 = (*dst32 & mask) | (fill & ~mask); + dst32++; + size -= 4 - left; + } + + // Main stint. + count = size / 4; + uint tmp = count & 3; + count /= 4; + + switch(tmp) { + do { + *dst32++ = fill; + case 3: + *dst32++ = fill; + case 2: + *dst32++ = fill; + case 1: + *dst32++ = fill; + case 0:; + } while(count--); + } + + // Tail + size &= 3; + if(size) { + mask = BIT_MASK(size * 8); + *dst32 = (*dst32 & ~mask) | (fill & mask); + } +} diff --git a/universal-core-logo.png b/universal-core-logo.png new file mode 100644 index 0000000..5e8bf1d Binary files /dev/null and b/universal-core-logo.png differ